Class: MistApi::ApiTokenCredentials

Inherits:
Object
  • Object
show all
Defined in:
lib/mist_api/http/auth/api_token.rb

Overview

Data class for ApiTokenCredentials. Data class for ApiTokenCredentials.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authorization:) ⇒ ApiTokenCredentials

Returns a new instance of ApiTokenCredentials.

Raises:

  • (ArgumentError) 


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

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

  @authorization = authorization
end

Instance Attribute Details

#authorization ⇒ Object (readonly)

Returns the value of attribute authorization.



28
29
30
 
# File 'lib/mist_api/http/auth/api_token.rb', line 28

def authorization
  @authorization
end

Class Method Details

.from_env ⇒ Object 



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

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

  new(authorization: authorization)
end

Instance Method Details

#clone_with(authorization: nil) ⇒ Object 



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

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

  ApiTokenCredentials.new(authorization: authorization)
end