Sha256: 429aabd0b7e27dcbf1d5efd8d654a234ca0cb7ed5a016c1a8342154b557702d8
Contents?: true
Size: 1.92 KB
Versions: 8
Compression:
Stored size: 1.92 KB
Contents
# frozen_string_literal: true
module Mihari
module Clients
#
# GreyNoise API client
#
class GreyNoise < Base
PAGE_SIZE = 10_000
#
# @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://api.greynoise.io",
api_key:,
headers: {},
pagination_interval: Mihari.config.pagination_interval,
timeout: nil
)
raise(ArgumentError, "api_key is required") unless api_key
headers["key"] = api_key
super(base_url, headers:, pagination_interval:, timeout:)
end
#
# GNQL (GreyNoise Query Language) is a domain-specific query language that uses Lucene deep under the hood
#
# @param [String] query GNQL query string
# @param [Integer] size Maximum amount of results to grab
# @param [Integer, nil] scroll Scroll token to paginate through results
#
# @return [Mihari::Structs::GreyNoise::Response]
#
def gnql_search(query, size: PAGE_SIZE, scroll: nil)
params = {query:, size:, scroll:}.compact
Structs::GreyNoise::Response.from_dynamic! get_json("/v2/experimental/gnql", params:)
end
#
# @param [String] query
# @param [Integer] size
# @param [Integer] pagination_limit
#
# @return [Enumerable<Mihari::Structs::GreyNoise::Response>]
#
def gnql_search_with_pagination(query, size: PAGE_SIZE, pagination_limit: Mihari.config.pagination_limit)
scroll = nil
Enumerator.new do |y|
pagination_limit.times do
res = gnql_search(query, size:, scroll:)
y.yield res
scroll = res.scroll
break if scroll.nil?
sleep_pagination_interval
end
end
end
end
end
end
Version data entries
8 entries across 8 versions & 1 rubygems