Class: MultiAuthSample::ApiKey

Inherits:
CoreLibrary::QueryAuth
  • Object
show all
Defined in:
lib/multi_auth_sample/http/auth/api_key.rb

Overview

Utility class for custom query_parameter authorization.

Instance Method Summary collapse

Constructor Details

#initialize(api_key_credentials) ⇒ ApiKey

Initialization constructor.



16
17
18
19
20
21
22
23
24
 
# File 'lib/multi_auth_sample/http/auth/api_key.rb', line 16

def initialize(api_key_credentials)
  auth_params = {}
  auth_params['token'] = api_key_credentials.token unless
    api_key_credentials.nil? || api_key_credentials.token.nil?
  auth_params['api-key'] = api_key_credentials.api_key unless
    api_key_credentials.nil? || api_key_credentials.api_key.nil?

  super auth_params
end

Instance Method Details

#error_message ⇒ Object

Display error message on occurrence of authentication failure.



11
12
13
 
# File 'lib/multi_auth_sample/http/auth/api_key.rb', line 11

def error_message
  'ApiKey: token or api_key is undefined.'
end