Class: SecurityTrails::API
- Inherits:
-
Object
- Object
- SecurityTrails::API
- Extended by:
- Forwardable
- Defined in:
- lib/securitytrails/api.rb
Instance Attribute Summary collapse
-
#api_key ⇒ Object
readonly
Returns the value of attribute api_key.
Instance Method Summary collapse
-
#domain ⇒ SecurityTrails::Clients::Domain
Domain API client.
-
#domains ⇒ SecurityTrails::Clients::Domains
Domains API client.
-
#feeds ⇒ SecurityTrails::Clients::Feeds
Feed API client.
-
#general ⇒ SecurityTrails::Clients::General
General API client.
-
#history ⇒ SecurityTrails::Clients::History
History API client.
-
#initialize(api_key = ENV["SECURITYTRAILS_API_KEY"]) ⇒ API
constructor
A new instance of API.
-
#ips ⇒ SecurityTrails::Clients::IPs
IPs API client.
Constructor Details
#initialize(api_key = ENV["SECURITYTRAILS_API_KEY"]) ⇒ API
Returns a new instance of API.
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_key ⇒ Object (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
#domain ⇒ SecurityTrails::Clients::Domain
Domain API client
35 36 37 |
# File 'lib/securitytrails/api.rb', line 35 def domain @domain ||= Clients::Domain.new(api_key) end |
#domains ⇒ SecurityTrails::Clients::Domains
Domains API client
44 45 46 |
# File 'lib/securitytrails/api.rb', line 44 def domains @domains ||= Clients::Domains.new(api_key) end |
#feeds ⇒ SecurityTrails::Clients::Feeds
Feed API client
71 72 73 |
# File 'lib/securitytrails/api.rb', line 71 def feeds @feeds ||= Clients::Feeds.new(api_key) end |
#general ⇒ SecurityTrails::Clients::General
General API client
21 22 23 |
# File 'lib/securitytrails/api.rb', line 21 def general @general ||= Clients::General.new(api_key) end |
#history ⇒ SecurityTrails::Clients::History
History API client
53 54 55 |
# File 'lib/securitytrails/api.rb', line 53 def history @history ||= Clients::History.new(api_key) end |
#ips ⇒ SecurityTrails::Clients::IPs
IPs API client
62 63 64 |
# File 'lib/securitytrails/api.rb', line 62 def ips @ips ||= Clients::IPs.new(api_key) end |