module EPayCo::Configuration

Defines constants and methods related to configuration

Constants

DEFAULT_ADAPTER

The adapter that will be used to connect if none is set

@note The default faraday adapter is Net::HTTP.

DEFAULT_CONNECTION_OPTIONS

By default, don't set any connection options

DEFAULT_ENDPOINT

The endpoint that will be used to connect if none is set

@note There is no reason to use any other endpoint at this time

DEFAULT_PRIVATE_KEY

By default, don't set a user private key

DEFAULT_PROXY

By default, don't use a proxy server

DEFAULT_PUBLIC_KEY

By default, don't set a user public key

DEFAULT_TEST_MODE

Test param that will be send in the POST requets

DEFAULT_USER_AGENT

The user agent that will be sent to the API endpoint if none is set

VALID_OPTIONS_KEYS

An array of valid keys in the options hash when configuring a {EPayCo::API}

Public Class Methods

extended(base) click to toggle source

When this module is extended, set all configuration options to their default values

# File lib/epayco/configuration.rb, line 51
def self.extended(base)
  base.reset
end

Public Instance Methods

configure() { |self| ... } click to toggle source

Convenience method to allow configuration options to be set in a block

# File lib/epayco/configuration.rb, line 56
def configure
  yield self
end
options() click to toggle source

Create a hash of options and their values

# File lib/epayco/configuration.rb, line 61
def options
  VALID_OPTIONS_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end
reset() click to toggle source

Reset all configuration options to defaults

# File lib/epayco/configuration.rb, line 68
def reset
  self.public_key         = DEFAULT_PUBLIC_KEY
  self.private_key        = DEFAULT_PRIVATE_KEY
  self.adapter            = DEFAULT_ADAPTER
  self.connection_options = DEFAULT_CONNECTION_OPTIONS
  self.endpoint           = DEFAULT_ENDPOINT
  self.proxy              = DEFAULT_PROXY
  self.user_agent         = DEFAULT_USER_AGENT
  self.test_mode          = DEFAULT_TEST_MODE
end