Class: Onyphe::API

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

API client initialization

Parameters:

  • api_key (String) (defaults to: ENV["ONYPHE_API_KEY"]) —

    ONYPHE API key

Raises:

  • (ArgumentError) 


16
17
18
19
 
# File 'lib/onyphe/api.rb', line 16

def initialize(api_key = ENV["ONYPHE_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/onyphe/api.rb', line 9

def api_key
  @api_key
end

Instance Method Details

#search ⇒ Object 



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

def search
  @search ||= Clients::Search.new(api_key)
end