Module: Pocket::Configuration

Included in:
Pocket
Defined in:
lib/pocket/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,
  :access_token,
  :endpoint,
  :redirect_uri,
  :format,
  :user_agent,
  :proxy
].freeze
VALID_FORMATS =
Note:

Not all methods support the XML format.

An array of valid request/response formats

[
:json].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 ID

nil
DEFAULT_REDIRECT_URI =

By default, don't set an application redirect uri

nil
DEFAULT_ACCESS_TOKEN =

By default, don't set a user access token

nil
DEFAULT_ENDPOINT =
Note:

There is no reason to use any other endpoint at this time

The endpoint that will be used to connect if none is set

'https://getpocket.com/v3/'.freeze
DEFAULT_FORMAT =
Note:

JSON is the only available format at this time

The response format appended to the path and sent in the 'Accept' header if none is set

:json
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

"Pocket Ruby Gem #{Pocket::VERSION}".freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

When this module is extended, set all configuration options to their default values



59
60
61
 
# File 'lib/pocket/configuration.rb', line 59

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

Yields:

  • (_self)

Yield Parameters:



64
65
66
 
# File 'lib/pocket/configuration.rb', line 64

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



69
70
71
72
73
 
# File 'lib/pocket/configuration.rb', line 69

def options
  VALID_OPTIONS_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end

#reset ⇒ Object

Reset all configuration options to defaults



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/pocket/configuration.rb', line 76

def reset
  self.adapter        = DEFAULT_ADAPTER
  self.consumer_key   = DEFAULT_CONSUMER_KEY
  self.access_token   = DEFAULT_ACCESS_TOKEN
  self.endpoint       = DEFAULT_ENDPOINT
  self.redirect_uri   = DEFAULT_REDIRECT_URI
  self.format         = DEFAULT_FORMAT
  self.user_agent     = DEFAULT_USER_AGENT
  self.proxy          = DEFAULT_PROXY
end