Module: SalesforceChatter::Configuration
- Included in:
- SalesforceChatter
- Defined in:
- lib/salesforce-chatter/configuration.rb
Overview
Defines constants and methods related to configuration
Constant Summary collapse
- VALID_OPTIONS_KEYS =
An array of valid keys in the options hash when configuring a API
[ :adapter, :consumer_key, :consumer_secret, :endpoint, :format, :gateway, :oauth_token, :oauth_token_secret, :proxy, :username, :password, :security_token, :oauth_token, :user_agent].freeze
- VALID_FORMATS =
Note:
Not all methods support the XML format.
An array of valid request/response formats
[ :json, :xml].freeze
- DEFAULT_ADAPTER =
Note:
The default faraday adapter is Net::HTTP.
The adapter that will be used to connect if none is set
Faraday.default_adapter
- DEFAULT_CONSUMER_KEY =
By default, don’t set an application key
nil
- DEFAULT_CONSUMER_SECRET =
By default, don’t set an application secret
nil
- DEFAULT_ENDPOINT =
The endpoint that will be used to connect if none is set
'https://login.salesforce.com/'.freeze
- DEFAULT_FORMAT =
Note:
JSON is preferred over XML because it is more concise and faster to parse.
The response format appended to the path and sent in the ‘Accept’ header if none is set
:json
- DEFAULT_OAUTH_TOKEN =
By default, don’t set a user oauth token
nil
- DEFAULT_OAUTH_TOKEN_SECRET =
By default, don’t set a user oauth secret
nil
- DEFAULT_PROXY =
By default, don’t use a proxy server
nil
- DEFAULT_USER_AGENT =
The user agent that will be sent to the API endpoint if none is set
"SalesforceChatter Ruby Gem #{SalesforceChatter::VERSION}".freeze
- DEFAULT_GATEWAY =
nil
Class Method Summary collapse
-
.extended(base) ⇒ Object
When this module is extended, set all configuration options to their default values.
Instance Method Summary collapse
-
#configure {|_self| ... } ⇒ Object
Convenience method to allow configuration options to be set in a block.
-
#options ⇒ Object
Create a hash of options and their values.
-
#reset ⇒ Object
Reset all configuration options to defaults.
Class Method Details
.extended(base) ⇒ Object
When this module is extended, set all configuration options to their default values
68 69 70 |
# File 'lib/salesforce-chatter/configuration.rb', line 68 def self.extended(base) base.reset end |
Instance Method Details
#configure {|_self| ... } ⇒ Object
Convenience method to allow configuration options to be set in a block
73 74 75 |
# File 'lib/salesforce-chatter/configuration.rb', line 73 def configure yield self end |
#options ⇒ Object
Create a hash of options and their values
78 79 80 81 82 |
# File 'lib/salesforce-chatter/configuration.rb', line 78 def = {} VALID_OPTIONS_KEYS.each{|k| [k] = send(k) } end |
#reset ⇒ Object
Reset all configuration options to defaults
85 86 87 88 89 90 91 92 93 94 95 96 97 |
# 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 |