Class: SplititWebApiV4::ApiKey

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

Overview

Utility class for custom header authorization.

Instance Method Summary collapse

Constructor Details

#initialize(api_key_credentials) ⇒ ApiKey

Initialization constructor.



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

def initialize(api_key_credentials)
  auth_params = {}
  auth_params['X-Splitit-Api-Key'] = api_key_credentials.x_splitit_api_key unless
    api_key_credentials.nil? || api_key_credentials.x_splitit_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/splitit_web_api_v4/http/auth/api_key.rb', line 11

def error_message
  'ApiKey: x_splitit_api_key is undefined.'
end