Class: Onyphe::API

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

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) 


10
11
12
13
 
# File 'lib/onyphe/api.rb', line 10

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

Instance Method Details

#alert ⇒ Object 



23
24
25
 
# File 'lib/onyphe/api.rb', line 23

def alert
  @alert ||= Clients::Alert.new(@api_key)
end

#search(oql) ⇒ Object 



27
28
29
 
# File 'lib/onyphe/api.rb', line 27

def search(oql)
  _search.search(oql)
end

#simple ⇒ Object 



19
20
21
 
# File 'lib/onyphe/api.rb', line 19

def simple
  @simple ||= Clients::Simple.new(@api_key)
end

#summary ⇒ Object 



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

def summary
  @summary ||= Clients::Summary.new(@api_key)
end