Sha256: 66c9f484da079c70693d9174b4b0175424cc85fbe2281e3512cbe9af69ecf51a

Contents?: true

Size: 1.08 KB

Versions: 14

Compression:

Stored size: 1.08 KB

Contents

# frozen_string_literal: true

module Mihari
  module Clients
    class GreyNoise < Base
      #
      # @param [String] base_url
      # @param [String, nil] api_key
      # @param [Hash] headers
      #
      def initialize(base_url = "https://api.greynoise.io", api_key:, headers: {})
        raise(ArgumentError, "'api_key' argument is required") unless api_key

        headers["key"] = api_key
        super(base_url, headers: headers)
      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, nil] size Maximum amount of results to grab
      # @param [Integer, nil] scroll Scroll token to paginate through results
      #
      # @return [Hash]
      #
      def gnql_search(query, size: nil, scroll: nil)
        params = { query: query, size: size, scroll: scroll }.compact
        res = get("/v2/experimental/gnql", params: params)
        Structs::GreyNoise::Response.from_dynamic! JSON.parse(res.body.to_s)
      end
    end
  end
end

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
mihari-5.4.2 lib/mihari/clients/greynoise.rb
mihari-5.4.1 lib/mihari/clients/greynoise.rb
mihari-5.4.0 lib/mihari/clients/greynoise.rb
mihari-5.3.2 lib/mihari/clients/greynoise.rb
mihari-5.3.1 lib/mihari/clients/greynoise.rb
mihari-5.3.0 lib/mihari/clients/greynoise.rb
mihari-5.2.4 lib/mihari/clients/greynoise.rb
mihari-5.2.3 lib/mihari/clients/greynoise.rb
mihari-5.2.2 lib/mihari/clients/greynoise.rb
mihari-5.2.1 lib/mihari/clients/greynoise.rb
mihari-5.2.0 lib/mihari/clients/greynoise.rb
mihari-5.1.4 lib/mihari/clients/greynoise.rb
mihari-5.1.3 lib/mihari/clients/greynoise.rb
mihari-5.1.2 lib/mihari/clients/greynoise.rb