Class: Mihari::Clients::Base

Inherits:

Object

• Object
• Mihari::Clients::Base

Defined in:

lib/mihari/clients/base.rb

Overview

Base class for API clients

Direct Known Subclasses

CIRCL, Censys::V2, Censys::V3, Crtsh, DNSTwister, Fofa, GooglePublicDNS, GreyNoise, HunterHow, MISP, MMDB, OTX, Onyphe, PassiveTotal, PulseDive, SecurityTrails, Shodan, ShodanInternetDB, TheHive, Urlscan, Validin, VirusTotal, Yeti, ZoomEye

Instance Attribute Summary

• #base_url ⇒ String readonly
• #headers ⇒ Hash readonly
• #pagination_interval ⇒ Integer readonly
• #timeout ⇒ Integer^? readonly

Instance Method Summary

• #initialize(base_url, headers: {}, pagination_interval: Mihari.config.pagination_interval, timeout: nil) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(base_url, headers: {}, pagination_interval: Mihari.config.pagination_interval, timeout: nil) ⇒ Base

Returns a new instance of Base.

Parameters:

• base_url (String)
• headers (Hash) (defaults to: {})
• pagination_interval (Integer) (defaults to: Mihari.config.pagination_interval)
• timeout (Integer, nil) (defaults to: nil)

# File 'lib/mihari/clients/base.rb', line 27

def initialize(base_url, headers: {}, pagination_interval: Mihari.config.pagination_interval, timeout: nil)
  @base_url = base_url
  @headers = headers || {}
  @pagination_interval = pagination_interval
  @timeout = timeout
end

Instance Attribute Details

#base_url ⇒ String (readonly)

Returns:

• (String)

# File 'lib/mihari/clients/base.rb', line 10

def base_url
  @base_url
end

#headers ⇒ Hash (readonly)

Returns:

• (Hash)

# File 'lib/mihari/clients/base.rb', line 13

def headers
  @headers
end

#pagination_interval ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/mihari/clients/base.rb', line 16

def pagination_interval
  @pagination_interval
end

#timeout ⇒ Integer^? (readonly)

Returns:

• (Integer, nil)

# File 'lib/mihari/clients/base.rb', line 19

def timeout
  @timeout
end