Sha256: 75923f40b4ae1812ab72986c037277fa74362e52a4c3999d751c34170db2a806
Contents?: true
Size: 1.6 KB
Versions: 11
Compression:
Stored size: 1.6 KB
Contents
# frozen_string_literal: true
module Mihari
module Clients
#
# Onyphe API client
#
class Onyphe < Base
PAGE_SIZE = 10
# @return [String]
attr_reader :api_key
#
# @param [String] base_url
# @param [String, nil] api_key
# @param [Hash] headers
# @param [Integer] pagination_interval
# @param [Integer, nil] timeout
#
def initialize(
base_url = "https://www.onyphe.io",
api_key:,
headers: {},
pagination_interval: Mihari.config.pagination_interval,
timeout: nil
)
raise(ArgumentError, "api_key is required") if api_key.nil?
super(base_url, headers:, pagination_interval:, timeout:)
@api_key = api_key
end
#
# @param [String] query
# @param [Integer] page
#
# @return [Mihari::Structs::Onyphe::Response]
#
def datascan(query, page: 1)
params = {page:, apikey: api_key}
Structs::Onyphe::Response.from_dynamic! get_json("/api/v2/simple/datascan/#{query}", params:)
end
#
# @param [String] query
# @param [Integer] pagination_limit
#
# @return [Enumerable<Mihari::Structs::Onyphe::Response>]
#
def datascan_with_pagination(query, pagination_limit: Mihari.config.pagination_limit)
Enumerator.new do |y|
(1..pagination_limit).each do |page|
res = datascan(query, page:)
y.yield res
break if res.total <= page * PAGE_SIZE
sleep_pagination_interval
end
end
end
end
end
end
Version data entries
11 entries across 11 versions & 1 rubygems