Class: Mihari::Clients::Urlscan

Inherits:
Base
  • Object
show all
Defined in:
lib/mihari/clients/urlscan.rb

Overview

urlscan.io API client

Instance Attribute Summary

Attributes inherited from Base

#base_url, #headers, #pagination_interval, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(base_url = "https://urlscan.io", api_key:, headers: {}, pagination_interval: Mihari.config.pagination_interval, timeout: nil) ⇒ Urlscan

Returns a new instance of Urlscan.

Parameters:

  • base_url (String) (defaults to: "https://urlscan.io")
  • api_key (String, nil)
  • headers (Hash) (defaults to: {})
  • pagination_interval (Integer, nil) (defaults to: Mihari.config.pagination_interval)
  • timeout (Integer, nil) (defaults to: nil)

Raises:

  • (ArgumentError) 


16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/mihari/clients/urlscan.rb', line 16

def initialize(
  base_url = "https://urlscan.io",
  api_key:,
  headers: {},
  pagination_interval: Mihari.config.pagination_interval,
  timeout: nil
)
  raise(ArgumentError, "api_key is required") if api_key.nil?

  headers["api-key"] = api_key

  super(base_url, headers:, pagination_interval:, timeout:)
end

Instance Method Details

#search(q, size: nil, search_after: nil) ⇒ Mihari::Structs::Urlscan::Response

Parameters:

  • q (String)
  • size (Integer, nil) (defaults to: nil)
  • search_after (String, nil) (defaults to: nil)

Returns:



37
38
39
40
 
# File 'lib/mihari/clients/urlscan.rb', line 37

def search(q, size: nil, search_after: nil)
  params = {q:, size:, search_after:}.compact
  Structs::Urlscan::Response.from_dynamic! get_json("/api/v1/search/", params:)
end

#search_with_pagination(q, size: nil, pagination_limit: Mihari.config.pagination_limit) ⇒ Enumerable<Mihari::Structs::Urlscan::Response>

Parameters:

  • q (String)
  • size (Integer, nil) (defaults to: nil)
  • pagination_limit (Integer) (defaults to: Mihari.config.pagination_limit)

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/mihari/clients/urlscan.rb', line 49

def search_with_pagination(q, size: nil, pagination_limit: Mihari.config.pagination_limit)
  search_after = nil

  Enumerator.new do |y|
    pagination_limit.times do
      res = search(q, size:, search_after:)

      y.yield res

      break unless res.has_more

      search_after = res.results.last.sort.join(",")

      sleep_pagination_interval
    end
  end
end