module OpenCalais::Configuration

Constants

DEFAULT_ADAPTER

Adapters are whatever Faraday supports - I like excon alot, so I'm defaulting it

DEFAULT_API_KEY

this you need to get from open calais - go register!

DEFAULT_ENDPOINT

The api endpoint to get REST info from opencalais

DEFAULT_USER_AGENT

The value sent in the http header for 'User-Agent' if none is set

VALID_OPTIONS_KEYS

Public Class Methods

extended(base) click to toggle source
# File lib/open_calais/configuration.rb, line 31
def self.extended(base)
  base.reset!
end
keys() click to toggle source
# File lib/open_calais/configuration.rb, line 36
def keys
  VALID_OPTIONS_KEYS
end

Public Instance Methods

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

Convenience method to allow for global setting of configuration options

# File lib/open_calais/configuration.rb, line 27
def configure
  yield self
end
options() click to toggle source
# File lib/open_calais/configuration.rb, line 41
def options
  options = {}
  VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
  options
end
reset!() click to toggle source

Reset configuration options to their defaults

# File lib/open_calais/configuration.rb, line 48
def reset!
  self.api_key                  = DEFAULT_API_KEY
  self.adapter            = DEFAULT_ADAPTER
  self.endpoint           = DEFAULT_ENDPOINT
  self.user_agent         = DEFAULT_USER_AGENT
  self
end