Class: Doconomy::Api::Configuration

Inherits:
Base
  • Object
show all
Defined in:
lib/doconomy/api/configuration.rb

Constant Summary collapse

PRODUCTION_URL = 
'https://services.doconomy.com'
SANDBOX_URL = 
'https://services-sandbox.doconomy.com'
SCOPE = 
'urn:aland-index:calculations,urn:aland-index:calculations:water-use'

Instance Attribute Summary collapse

Attributes inherited from Base

#attributes

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

client, #errors

Constructor Details

#initialize(attributes = {}) ⇒ Configuration

Returns a new instance of Configuration.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/doconomy/api/configuration.rb', line 23

def initialize(attributes = {})
  @attributes = attributes.deep_symbolize_keys
  @url = @attributes[:url]
  @environment = @attributes[:environment]
  @api_key = @attributes[:api_key]
  @api_version = @attributes[:api_version]
  @client_id = @attributes[:client_id]
  @client_secret = @attributes[:client_secret]
  @scope = @attributes[:scope]
  @digital_signature_private_key = @attributes[:digital_signature_private_key]
  @digital_signature_certificate_serial_number = @attributes[:digital_signature_certificate_serial_number]
  @digital_signature_certificate = @attributes[:digital_signature_certificate]
  @pem = @attributes[:pem]
  @pem_password = @attributes[:pem_password]
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def api_key
  @api_key
end

#api_version ⇒ Object

Returns the value of attribute api_version.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def api_version
  @api_version
end

#client_id ⇒ Object

Returns the value of attribute client_id.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def client_id
  @client_id
end

#client_secret ⇒ Object

Returns the value of attribute client_secret.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def client_secret
  @client_secret
end

#digital_signature_certificate ⇒ Object

Returns the value of attribute digital_signature_certificate.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def digital_signature_certificate
  @digital_signature_certificate
end

#digital_signature_certificate_serial_number ⇒ Object

Returns the value of attribute digital_signature_certificate_serial_number.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def digital_signature_certificate_serial_number
  @digital_signature_certificate_serial_number
end

#digital_signature_private_key ⇒ Object

Returns the value of attribute digital_signature_private_key.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def digital_signature_private_key
  @digital_signature_private_key
end

#environment ⇒ Object

Returns the value of attribute environment.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def environment
  @environment
end

#pem ⇒ Object

Returns the value of attribute pem.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def pem
  @pem
end

#pem_password ⇒ Object

Returns the value of attribute pem_password.



10
11
12
 
# File 'lib/doconomy/api/configuration.rb', line 10

def pem_password
  @pem_password
end

#scope ⇒ String

Return the scope

Returns:

  • (String) 


53
54
55
 
# File 'lib/doconomy/api/configuration.rb', line 53

def scope
  @scope
end

#url ⇒ String

Return the server URL

Returns:

  • (String) 


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

def url
  @url
end

Class Method Details

.default ⇒ Doconomy::Api::Configuration

Returns a default configuration instance

Returns:



77
78
79
 
# File 'lib/doconomy/api/configuration.rb', line 77

def default
  new(default_options)
end

.default_options ⇒ Hash

Default attributes for Doconomy::Api::Configuration instance

Returns:

  • (Hash) 


84
85
86
87
88
89
90
91
 
# File 'lib/doconomy/api/configuration.rb', line 84

def default_options
  {
    environment: :production,
    api_version: Doconomy::Api::VERSION,
    scope: Doconomy::Api::Configuration::SCOPE,
    pem_password: nil
  }
end

Instance Method Details

#production? ⇒ Boolean

Returns true if the configuration environment is `production'

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/doconomy/api/configuration.rb', line 61

def production?
  self.environment.downcase.to_sym == :production
end

#sandbox? ⇒ Boolean

Returns true if the configuration environment is `sandbox'

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/doconomy/api/configuration.rb', line 69

def sandbox?
  self.environment.downcase.to_sym == :sandbox
end