Class: ShellEv::Configuration

Inherits:
CoreLibrary::HttpClientConfiguration
  • Object
show all
Defined in:
lib/shell_ev/configuration.rb

Overview

All configuration including auth info and base URI for the API access are configured in this class.

Constant Summary collapse

ENVIRONMENTS =

All the environments the SDK can run in.

{
  Environment::PRODUCTION => {
    Server::DEFAULT => 'https://api.shell.com'
  },
  Environment::ENVIRONMENT2 => {
    Server::DEFAULT => 'https://api-test.shell.com'
  }
}.freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection: nil, adapter: :net_http_persistent, timeout: 60, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put],, http_callback: nil, environment: Environment::PRODUCTION, o_auth_client_id: nil, o_auth_client_secret: nil, o_auth_token: nil, client_credentials_auth_credentials: nil) ⇒ Configuration

Returns a new instance of Configuration.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/shell_ev/configuration.rb', line 46

def initialize(
  connection: nil, adapter: :net_http_persistent, timeout: 60,
  max_retries: 0, retry_interval: 1, backoff_factor: 2,
  retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
  retry_methods: %i[get put], http_callback: nil,
  environment: Environment::PRODUCTION, o_auth_client_id: nil,
  o_auth_client_secret: nil, o_auth_token: nil,
  client_credentials_auth_credentials: nil
)

  super connection: connection, adapter: adapter, timeout: timeout,
        max_retries: max_retries, retry_interval: retry_interval,
        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
        retry_methods: retry_methods, http_callback: http_callback

  # Current API environment
  @environment = String(environment)

  # OAuth 2 Client ID
  @o_auth_client_id = o_auth_client_id

  # OAuth 2 Client Secret
  @o_auth_client_secret = o_auth_client_secret

  # Object for storing information about the OAuth token
  @o_auth_token = if o_auth_token.is_a? OAuthToken
                    OAuthToken.from_hash o_auth_token.to_hash
                  else
                    o_auth_token
                  end

  # Initializing OAuth 2 Client Credentials Grant credentials with the provided auth parameters
  @client_credentials_auth_credentials = create_auth_credentials_object(
    o_auth_client_id, o_auth_client_secret, o_auth_token,
    client_credentials_auth_credentials
  )

  # The Http Client to use for making requests.
  set_http_client CoreLibrary::FaradayClient.new(self)
end

Class Attribute Details

.environments ⇒ Object (readonly)

Returns the value of attribute environments.



43
44
45
 
# File 'lib/shell_ev/configuration.rb', line 43

def environments
  @environments
end

Instance Attribute Details

#client_credentials_auth_credentials ⇒ Object (readonly)

The attribute readers for properties.



40
41
42
 
# File 'lib/shell_ev/configuration.rb', line 40

def client_credentials_auth_credentials
  @client_credentials_auth_credentials
end

#environment ⇒ Object (readonly)

The attribute readers for properties.



40
41
42
 
# File 'lib/shell_ev/configuration.rb', line 40

def environment
  @environment
end

Instance Method Details

#clone_with(connection: nil, adapter: nil, timeout: nil, max_retries: nil, retry_interval: nil, backoff_factor: nil, retry_statuses: nil, retry_methods: nil, http_callback: nil, environment: nil, o_auth_client_id: nil, o_auth_client_secret: nil, o_auth_token: nil, client_credentials_auth_credentials: nil) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/shell_ev/configuration.rb', line 87

def clone_with(connection: nil, adapter: nil, timeout: nil,
               max_retries: nil, retry_interval: nil, backoff_factor: nil,
               retry_statuses: nil, retry_methods: nil, http_callback: nil,
               environment: nil, o_auth_client_id: nil,
               o_auth_client_secret: nil, o_auth_token: nil,
               client_credentials_auth_credentials: nil)
  connection ||= self.connection
  adapter ||= self.adapter
  timeout ||= self.timeout
  max_retries ||= self.max_retries
  retry_interval ||= self.retry_interval
  backoff_factor ||= self.backoff_factor
  retry_statuses ||= self.retry_statuses
  retry_methods ||= self.retry_methods
  http_callback ||= self.http_callback
  environment ||= self.environment
  client_credentials_auth_credentials = create_auth_credentials_object(
    o_auth_client_id, o_auth_client_secret, o_auth_token,
    client_credentials_auth_credentials || self.client_credentials_auth_credentials
  )

  Configuration.new(
    connection: connection, adapter: adapter, timeout: timeout,
    max_retries: max_retries, retry_interval: retry_interval,
    backoff_factor: backoff_factor, retry_statuses: retry_statuses,
    retry_methods: retry_methods, http_callback: http_callback,
    environment: environment,
    client_credentials_auth_credentials: client_credentials_auth_credentials
  )
end

#create_auth_credentials_object(o_auth_client_id, o_auth_client_secret, o_auth_token, client_credentials_auth_credentials) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/shell_ev/configuration.rb', line 118

def create_auth_credentials_object(o_auth_client_id, o_auth_client_secret,
                                   o_auth_token,
                                   client_credentials_auth_credentials)
  return client_credentials_auth_credentials if o_auth_client_id.nil? &&
                                                o_auth_client_secret.nil? &&
                                                o_auth_token.nil?

  warn('The \'o_auth_client_id\', \'o_auth_client_secret\', \'o_auth_token'\
       '\' params are deprecated. Use \'client_credentials_auth_credential'\
       's\' param instead.')

  unless client_credentials_auth_credentials.nil?
    return client_credentials_auth_credentials.clone_with(
      o_auth_client_id: o_auth_client_id,
      o_auth_client_secret: o_auth_client_secret,
      o_auth_token: o_auth_token
    )
  end

  ClientCredentialsAuthCredentials.new(
    o_auth_client_id: o_auth_client_id,
    o_auth_client_secret: o_auth_client_secret, o_auth_token: o_auth_token
  )
end

#get_base_uri(server = Server::DEFAULT) ⇒ String

Generates the appropriate base URI for the environment and the server. required.

Parameters:

  • server (Configuration::Server) (defaults to: Server::DEFAULT) —

    The server enum for which the base URI is

Returns:

  • (String) —

    The base URI.



157
158
159
 
# File 'lib/shell_ev/configuration.rb', line 157

def get_base_uri(server = Server::DEFAULT)
  ENVIRONMENTS[environment][server].clone
end

#o_auth_client_id ⇒ Object 



27
28
29
 
# File 'lib/shell_ev/configuration.rb', line 27

def o_auth_client_id
  @client_credentials_auth_credentials.o_auth_client_id
end

#o_auth_client_secret ⇒ Object 



31
32
33
 
# File 'lib/shell_ev/configuration.rb', line 31

def o_auth_client_secret
  @client_credentials_auth_credentials.o_auth_client_secret
end

#o_auth_token ⇒ Object 



35
36
37
 
# File 'lib/shell_ev/configuration.rb', line 35

def o_auth_token
  @client_credentials_auth_credentials.o_auth_token
end