Class: SwaggerPetstore::Configuration

Inherits:
CoreLibrary::HttpClientConfiguration
  • Object
show all
Defined in:
lib/swagger_petstore/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::SERVER1 => 'https://petstore.swagger.io/v2',
    Server::SERVER2 => 'http://petstore.swagger.io/v2',
    Server::AUTH_SERVER => 'https://petstore.swagger.io/oauth'
  }
}.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: 'TODO: Replace', o_auth_redirect_uri: 'TODO: Replace', o_auth_token: nil, o_auth_scopes: nil) ⇒ Configuration

Returns a new instance of Configuration.



41
42
43
44
45
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
 
# File 'lib/swagger_petstore/configuration.rb', line 41

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: 'TODO: Replace',
               o_auth_redirect_uri: 'TODO: Replace', o_auth_token: nil,
               o_auth_scopes: 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 Redirection endpoint or Callback Uri
  @o_auth_redirect_uri = o_auth_redirect_uri

  # 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

  # TODO: Replace
  @o_auth_scopes = o_auth_scopes

  # 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.



38
39
40
 
# File 'lib/swagger_petstore/configuration.rb', line 38

def environments
  @environments
end

Instance Attribute Details

#environment ⇒ Object (readonly)

The attribute readers for properties.



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

def environment
  @environment
end

#o_auth_client_id ⇒ Object (readonly)

The attribute readers for properties.



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

def o_auth_client_id
  @o_auth_client_id
end

#o_auth_redirect_uri ⇒ Object (readonly)

The attribute readers for properties.



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

def o_auth_redirect_uri
  @o_auth_redirect_uri
end

#o_auth_scopes ⇒ Object (readonly)

The attribute readers for properties.



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

def o_auth_scopes
  @o_auth_scopes
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_redirect_uri: nil, o_auth_token: nil, o_auth_scopes: nil) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/swagger_petstore/configuration.rb', line 78

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_redirect_uri: nil, o_auth_token: nil,
               o_auth_scopes: 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
  o_auth_client_id ||= self.o_auth_client_id
  o_auth_redirect_uri ||= self.o_auth_redirect_uri
  o_auth_token ||= self.o_auth_token
  o_auth_scopes ||= self.o_auth_scopes

  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,
                    o_auth_client_id: o_auth_client_id,
                    o_auth_redirect_uri: o_auth_redirect_uri,
                    o_auth_token: o_auth_token,
                    o_auth_scopes: o_auth_scopes)
end

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

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

Parameters:

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

    The server enum for which the base URI is

Returns:

  • (String) —

    The base URI.



125
126
127
 
# File 'lib/swagger_petstore/configuration.rb', line 125

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

#o_auth_token ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/swagger_petstore/configuration.rb', line 29

def o_auth_token
  if @o_auth_token.is_a? OAuthToken
    OAuthToken.from_hash @o_auth_token.to_hash
  else
    @o_auth_token
  end
end