module ShippingEasy

Configuration class that stores configuration options for the ShippingEasy API.

ShippingEasy requires an API key and secret combination to authenticate against its API. At the very least these must be supplied in the configuration.

Configuration options are typically set via the ShippingEasy.config method. @see ShippingEasy.configure @example

ShippingEasy.configure do |config|
  config.api_key = "12345"
  config.api_secret = "XXXXXXXXXXXXXXXXXXXXXXXX"
end

Constants

VERSION

Attributes

configuration[RW]

Public Class Methods

api_key() click to toggle source

# File lib/shipping_easy.rb, line 39
def api_key
  return nil if configuration.nil?
  configuration.api_key
end

api_secret() click to toggle source

# File lib/shipping_easy.rb, line 34
def api_secret
  return nil if configuration.nil?
  configuration.api_secret
end

base_url() click to toggle source

# File lib/shipping_easy.rb, line 54
def base_url
  return nil if configuration.nil?
  configuration.base_url
end

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

# File lib/shipping_easy.rb, line 28
def configure
  configuration = ShippingEasy::Configuration.new
  yield(configuration)
  self.configuration = configuration
end

partner_api_key() click to toggle source

# File lib/shipping_easy.rb, line 49
def partner_api_key
  return nil if configuration.nil?
  configuration.partner_api_key
end

partner_api_secret() click to toggle source

# File lib/shipping_easy.rb, line 44
def partner_api_secret
  return nil if configuration.nil?
  configuration.partner_api_secret
end