Class: SecurityTrails::API

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/securitytrails/api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key = ENV["SECURITYTRAILS_API_KEY"]) ⇒ API

Returns a new instance of API.

Raises:

  • (ArgumentError)


11
12
13
14
# File 'lib/securitytrails/api.rb', line 11

def initialize(api_key = ENV["SECURITYTRAILS_API_KEY"])
  @api_key = api_key
  raise ArgumentError, "'api_key' argument is required" unless api_key
end

Instance Attribute Details

#api_keyObject (readonly)

Returns the value of attribute api_key.



9
10
11
# File 'lib/securitytrails/api.rb', line 9

def api_key
  @api_key
end

Instance Method Details

#domainSecurityTrails::Clients::Domain

Domain API client



35
36
37
# File 'lib/securitytrails/api.rb', line 35

def domain
  @domain ||= Clients::Domain.new(api_key)
end

#domainsSecurityTrails::Clients::Domains

Domains API client



44
45
46
# File 'lib/securitytrails/api.rb', line 44

def domains
  @domains ||= Clients::Domains.new(api_key)
end

#feedsSecurityTrails::Clients::Feeds

Feed API client



71
72
73
# File 'lib/securitytrails/api.rb', line 71

def feeds
  @feeds ||= Clients::Feeds.new(api_key)
end

#generalSecurityTrails::Clients::General

General API client



21
22
23
# File 'lib/securitytrails/api.rb', line 21

def general
  @general ||= Clients::General.new(api_key)
end

#historySecurityTrails::Clients::History

History API client



53
54
55
# File 'lib/securitytrails/api.rb', line 53

def history
  @history ||= Clients::History.new(api_key)
end

#ipsSecurityTrails::Clients::IPs

IPs API client



62
63
64
# File 'lib/securitytrails/api.rb', line 62

def ips
  @ips ||= Clients::IPs.new(api_key)
end