Sha256: a53d9f4d9e740f3c3df4b01ba967de75ab7de633639cb4f718fe6bed64a5b192
Contents?: true
Size: 1.74 KB
Versions: 10
Compression:
Stored size: 1.74 KB
Contents
# frozen_string_literal: true
module Mihari
module Clients
#
# BinaryEdge API client
#
class BinaryEdge < Base
#
# @param [String] base_url
# @param [String, nil] api_key
# @param [Hash] headers
# @param [Integer, nil] timeout
# @param [Integer] pagination_interval
#
def initialize(
base_url = "https://api.binaryedge.io",
api_key:,
headers: {},
pagination_interval: Mihari.config.pagination_interval,
timeout: nil
)
headers["x-key"] = api_key
super(base_url, headers:, timeout:, pagination_interval:)
end
#
# @param [String] query String used to query our data
# @param [Integer] page Default 1, Maximum: 500
# @param [Integer, nil] only_ips If selected, only output IP addresses, ports and protocols.
#
# @return [Mihari::Structs::BinaryEdge::Response]
#
def search(query, page: 1, only_ips: nil)
params = {
query:,
page:,
only_ips:
}.compact
Structs::BinaryEdge::Response.from_dynamic! get_json("/v2/query/search", params:)
end
#
# @param [String] query
# @param [Integer, nil] only_ips
# @param [Integer] pagination_limit
#
# @return [Enumerable<Mihari::Structs::BinaryEdge::Response>]
#
def search_with_pagination(query, only_ips: nil, pagination_limit: Mihari.config.pagination_limit)
Enumerator.new do |y|
(1..pagination_limit).each do |page|
res = search(query, page:, only_ips:)
y.yield res
break if res.events.length < res.pagesize
sleep_pagination_interval
end
end
end
end
end
end
Version data entries
10 entries across 10 versions & 1 rubygems