Contents

module DocusignRest
  module Configuration
    VALID_CONNECTION_KEYS  = [:endpoint, :api_version, :user_agent, :method].freeze
    VALID_OPTIONS_KEYS     = [:access_token, :username, :password, :integrator_key, :account_id, :format, :ca_file, :open_timeout, :read_timeout].freeze
    VALID_CONFIG_KEYS      = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS

    DEFAULT_ENDPOINT       = 'https://demo.docusign.net/restapi'
    DEFAULT_API_VERSION    = 'v2'
    DEFAULT_USER_AGENT     = "DocusignRest API Ruby Gem #{DocusignRest::VERSION}".freeze
    DEFAULT_METHOD         = :get

    DEFAULT_ACCESS_TOKEN   = nil

    DEFAULT_USERNAME       = nil
    DEFAULT_PASSWORD       = nil
    DEFAULT_INTEGRATOR_KEY = nil
    DEFAULT_ACCOUNT_ID     = nil
    DEFAULT_CA_FILE        = nil # often found at: '/etc/ssl/certs/cert.pem'
    DEFAULT_FORMAT         = :json
    DEFAULT_OPEN_TIMEOUT   = 5
    DEFAULT_READ_TIMEOUT   = 10

    # Build accessor methods for every config options so we can do this, for example:
    #   DocusignRest.format = :xml
    attr_accessor *VALID_CONFIG_KEYS

    # Make sure we have the default values set when we get 'extended'
    def self.extended(base)
      base.reset
    end

    def reset
      self.endpoint       = DEFAULT_ENDPOINT
      self.api_version    = DEFAULT_API_VERSION
      self.user_agent     = DEFAULT_USER_AGENT
      self.method         = DEFAULT_METHOD
      self.access_token   = DEFAULT_ACCESS_TOKEN
      self.username       = DEFAULT_USERNAME
      self.password       = DEFAULT_PASSWORD
      self.integrator_key = DEFAULT_INTEGRATOR_KEY
      self.account_id     = DEFAULT_ACCOUNT_ID
      self.format         = DEFAULT_FORMAT
      self.ca_file        = DEFAULT_CA_FILE
      self.open_timeout   = DEFAULT_OPEN_TIMEOUT
      self.read_timeout   = DEFAULT_READ_TIMEOUT
    end

    # Allow configuration via a block
    def configure
      yield self
    end

    def options
      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
docusign_rest-0.4.4	lib/docusign_rest/configuration.rb
docusign_rest-0.4.3	lib/docusign_rest/configuration.rb
docusign_rest-0.4.2	lib/docusign_rest/configuration.rb
docusign_rest-0.4.1	lib/docusign_rest/configuration.rb
docusign_rest-0.4.0	lib/docusign_rest/configuration.rb
docusign_rest-0.3.9	lib/docusign_rest/configuration.rb
docusign_rest-0.3.8	lib/docusign_rest/configuration.rb
docusign_rest-0.3.7	lib/docusign_rest/configuration.rb
docusign_rest-0.3.6	lib/docusign_rest/configuration.rb
docusign_rest-0.3.5	lib/docusign_rest/configuration.rb
docusign_rest-0.3.4	lib/docusign_rest/configuration.rb