Module: FreeMusicArchive::Configuration

Included in:
FreeMusicArchive
Defined in:
lib/freemusicarchive/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,
  :api_key,
  :endpoint,
  :format,
  :user_agent,
  :proxy
].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_API_KEY =

By default, don’t set an application ID

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

'http://freemusicarchive.org'.freeze
DEFAULT_FORMAT =

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

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

"Free Music Archive Ruby Gem #{FreeMusicArchive::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



43
44
45
 
# File 'lib/freemusicarchive/configuration.rb', line 43

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:



48
49
50
 
# File 'lib/freemusicarchive/configuration.rb', line 48

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



53
54
55
56
57
 
# File 'lib/freemusicarchive/configuration.rb', line 53

def options
  options = {}
  VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
  options
end

#reset ⇒ Object

Reset all configuration options to defaults



60
61
62
63
64
65
66
67
 
# File 'lib/freemusicarchive/configuration.rb', line 60

def reset
  self.adapter        = DEFAULT_ADAPTER
  self.api_key        = DEFAULT_API_KEY
  self.endpoint       = DEFAULT_ENDPOINT
  self.format         = DEFAULT_FORMAT
  self.user_agent     = DEFAULT_USER_AGENT
  self.proxy          = DEFAULT_PROXY
end