Class: SplititWebApiV4::ApiKeyCredentials

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

Overview

Data class for ApiKeyCredentials. Data class for ApiKeyCredentials.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(x_splitit_api_key:) ⇒ ApiKeyCredentials

Returns a new instance of ApiKeyCredentials.

Raises:

  • (ArgumentError) 


30
31
32
33
34
 
# File 'lib/splitit_web_api_v4/http/auth/api_key.rb', line 30

def initialize(x_splitit_api_key:)
  raise ArgumentError, 'x_splitit_api_key cannot be nil' if x_splitit_api_key.nil?

  @x_splitit_api_key = x_splitit_api_key
end

Instance Attribute Details

#x_splitit_api_key ⇒ Object (readonly)

Returns the value of attribute x_splitit_api_key.



28
29
30
 
# File 'lib/splitit_web_api_v4/http/auth/api_key.rb', line 28

def x_splitit_api_key
  @x_splitit_api_key
end

Class Method Details

.from_env ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/splitit_web_api_v4/http/auth/api_key.rb', line 36

def self.from_env
  x_splitit_api_key = ENV['API_KEY_X_SPLITIT_API_KEY']
  all_nil = [
    x_splitit_api_key
  ].all?(&:nil?)
  return nil if all_nil

  new(x_splitit_api_key: x_splitit_api_key)
end

Instance Method Details

#clone_with(x_splitit_api_key: nil) ⇒ Object 



46
47
48
49
50
 
# File 'lib/splitit_web_api_v4/http/auth/api_key.rb', line 46

def clone_with(x_splitit_api_key: nil)
  x_splitit_api_key ||= self.x_splitit_api_key

  ApiKeyCredentials.new(x_splitit_api_key: x_splitit_api_key)
end