Class: Blackbird::Retoure::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/blackbird/retoure/configuration.rb

Overview

Public: Configure Blackbird::Retoure within a given block.

username - Depending on the environment this is either your DHL username

found in your dev account or the AppId of your application.

password - The password of your system user or your developer account.

This depends on the environment you are using

environment - The environment you want to use. Can be :production or

:sandbox

app_token - The token of the application for the CIG authentication

(only needed in an production environment)

app_id - The application id for the CIG authentication

Examples

# Sandbox environment
Blackbird::Retoure.configure do |config|
  config.username = '<DHL Username>'
  config.password = '<DHL User Password>'
  config.environment = :sandbox
end

# Production environment
Blackbird::Retoure.configure do |config|
  config.username = '<DHL Username>'
  config.password = '<DHL User Password>'
  config.app_token = 'Application token for the CIG authentication'
  config.app_id = 'Application ID for the CIG authentication'
  config.environment = :sandbox
end

Returns nothing.

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ Object

Returns the value of attribute app_id.



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

def app_id
  @app_id
end

#app_token ⇒ Object

Returns the value of attribute app_token.



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

def app_token
  @app_token
end

#environment ⇒ Object

Returns the value of attribute environment.



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

def environment
  @environment
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end