Module: LogicalModel::ApiKey::ClassMethods

Defined in:
lib/logical_model/api_key.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



8
9
10
 
# File 'lib/logical_model/api_key.rb', line 8

def api_key
  @api_key
end

#api_key_name ⇒ Object

Returns the value of attribute api_key_name.



8
9
10
 
# File 'lib/logical_model/api_key.rb', line 8

def api_key_name
  @api_key_name
end

#use_api_key ⇒ Object

Returns the value of attribute use_api_key.



8
9
10
 
# File 'lib/logical_model/api_key.rb', line 8

def use_api_key
  @use_api_key
end

Instance Method Details

#merge_key(params = {}) ⇒ Object

if needed will merge api_key into given hash returns merged hash



31
32
33
34
35
36
37
 
# File 'lib/logical_model/api_key.rb', line 31

def merge_key(params = {})
  if self.use_api_key
    params.merge({self.api_key_name => self.api_key})
  else
    params
  end
end

#set_api_key(name, value) ⇒ Object

Set api_key

Examples:

class Client < LogicalModel
  set_api_key(:token, 'asdfasdf')
  ...
end

Parameters:

  • name (Symbol) —

    name for api_key. Eg: app_key, token, etc.

  • value (String) —

    value of key. Eg: 1o2u3hqkfd, secret, etc.



19
20
21
22
23
 
# File 'lib/logical_model/api_key.rb', line 19

def set_api_key(name,value)
  @use_api_key = true
  @api_key_name = name
  @api_key = value
end