module SalesforceChatter::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_CONSUMER_KEY
By default, don’t set an application key
- DEFAULT_CONSUMER_SECRET
By default, don’t set an application secret
- DEFAULT_ENDPOINT
The endpoint that will be used to connect if none is set
- DEFAULT_FORMAT
The response format appended to the path and sent in the ‘Accept’ header if none is set
@note JSON is preferred over XML because it is more concise and faster to parse.
- DEFAULT_GATEWAY
- DEFAULT_OAUTH_TOKEN
By default, don’t set a user oauth token
- DEFAULT_OAUTH_TOKEN_SECRET
By default, don’t set a user oauth secret
- DEFAULT_PROXY
By default, don’t use a proxy server
- DEFAULT_USER_AGENT
The user agent that will be sent to the
API
endpoint if none is set- VALID_FORMATS
An array of valid request/response formats
@note Not all methods support the XML format.
- VALID_OPTIONS_KEYS
An array of valid keys in the options hash when configuring a {SalesforceChatter::API}
Public Class Methods
When this module is extended, set all configuration options to their default values
# File lib/salesforce-chatter/configuration.rb, line 68 def self.extended(base) base.reset end
Public Instance Methods
Convenience method to allow configuration options to be set in a block
# File lib/salesforce-chatter/configuration.rb, line 73 def configure yield self end
Create a hash of options and their values
# File lib/salesforce-chatter/configuration.rb, line 78 def options options = {} VALID_OPTIONS_KEYS.each{|k| options[k] = send(k) } options end
Reset all configuration options to defaults
# File lib/salesforce-chatter/configuration.rb, line 85 def reset self.adapter = DEFAULT_ADAPTER self.consumer_key = DEFAULT_CONSUMER_KEY self.consumer_secret = DEFAULT_CONSUMER_SECRET self.endpoint = DEFAULT_ENDPOINT self.format = DEFAULT_FORMAT self.oauth_token = DEFAULT_OAUTH_TOKEN self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET self.proxy = DEFAULT_PROXY self.user_agent = DEFAULT_USER_AGENT self.gateway = DEFAULT_GATEWAY self end