Contents

# frozen_string_literal: true

module Mihari
  module Clients
    class Onyphe < Base
      PAGE_SIZE = 10

      # @return [String]
      attr_reader :api_key

      #
      # @param [String] base_url
      # @param [String, nil] api_key
      # @param [Hash] headers
      #
      def initialize(base_url = "https://www.onyphe.io", api_key:, headers: {}, interval: nil)
        raise(ArgumentError, "'api_key' argument is required") if api_key.nil?

        super(base_url, headers: headers, interval: interval)

        @api_key = api_key
      end

      #
      # @param [String] query
      # @param [Integer] page
      #
      # @return [Structs::Onyphe::Response]
      #
      def datascan(query, page: 1)
        params = { page: page, apikey: api_key }
        res = get("/api/v2/simple/datascan/#{query}", params: params)
        Structs::Onyphe::Response.from_dynamic! JSON.parse(res.body.to_s)
      end

      #
      # @param [String] query
      # @param [Integer] pagination_limit
      #
      # @return [Enumerable<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: page)

            y.yield res

            break if res.total <= page * PAGE_SIZE

            sleep_interval
          end
        end
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
mihari-5.4.7	lib/mihari/clients/onyphe.rb
mihari-5.4.6	lib/mihari/clients/onyphe.rb
mihari-5.4.5	lib/mihari/clients/onyphe.rb
mihari-5.4.4	lib/mihari/clients/onyphe.rb
mihari-5.4.3	lib/mihari/clients/onyphe.rb