Class: AdvancedBilling::Configuration

Inherits:
CoreLibrary::HttpClientConfiguration
  • Object
show all
Defined in:
lib/advanced_billing/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://{subdomain}.{domain}'
  },
  Environment::ENVIRONMENT2 => {
    Server::DEFAULT => 'https://events.chargify.com'
  }
}.freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection: nil, adapter: :net_http_persistent, timeout: 120, 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, subdomain: 'subdomain', domain: 'chargify.com', basic_auth_credentials: nil) ⇒ Configuration

Returns a new instance of Configuration.



34
35
36
37
38
39
40
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
 
# File 'lib/advanced_billing/configuration.rb', line 34

def initialize(
  connection: nil, adapter: :net_http_persistent, timeout: 120,
  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, subdomain: 'subdomain',
  domain: 'chargify.com', basic_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)

  # The subdomain for your Advanced Billing site.
  @subdomain = subdomain

  # The Advanced Billing server domain.
  @domain = domain

  # The object holding Basic Authentication credentials
  @basic_auth_credentials = basic_auth_credentials

  # Initializing Basic Authentication credentials with the provided auth parameters
 @basic_auth_credentials = basic_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.



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

def environments
  @environments
end

Instance Attribute Details

#basic_auth_credentials ⇒ Object (readonly)

The attribute readers for properties.



28
29
30
 
# File 'lib/advanced_billing/configuration.rb', line 28

def basic_auth_credentials
  @basic_auth_credentials
end

#domain ⇒ Object (readonly)

The attribute readers for properties.



28
29
30
 
# File 'lib/advanced_billing/configuration.rb', line 28

def domain
  @domain
end

#environment ⇒ Object (readonly)

The attribute readers for properties.



28
29
30
 
# File 'lib/advanced_billing/configuration.rb', line 28

def environment
  @environment
end

#subdomain ⇒ Object (readonly)

The attribute readers for properties.



28
29
30
 
# File 'lib/advanced_billing/configuration.rb', line 28

def subdomain
  @subdomain
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, subdomain: nil, domain: nil, basic_auth_credentials: nil) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/advanced_billing/configuration.rb', line 67

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, subdomain: nil, domain: nil,
               basic_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
  subdomain ||= self.subdomain
  domain ||= self.domain
  basic_auth_credentials ||= basic_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,
                    subdomain: subdomain, domain: domain,
                    basic_auth_credentials: basic_auth_credentials)
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.



112
113
114
115
116
117
118
119
120
 
# File 'lib/advanced_billing/configuration.rb', line 112

def get_base_uri(server = Server::DEFAULT)
  parameters = {
    'subdomain' => { 'value' => subdomain, 'encode' => false },
    'domain' => { 'value' => domain, 'encode' => false }
  }
  APIHelper.append_url_with_template_parameters(
    ENVIRONMENTS[environment][server], parameters
  )
end