module NHKProgram::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_API_KEY

By default, don’t set an application api key

DEFAULT_ENDPOINT

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

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

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_OPTIONS_KEYS

An array of valid keys in the options hash when configuring a {NHKProgram::Client}

Public Class Methods

extended(base) click to toggle source

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

# File lib/nhk_program/configuration.rb, line 41
def self.extended(base)
  base.reset
end

Public Instance Methods

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

Convenience method to allow configuration options to be set in a block

# File lib/nhk_program/configuration.rb, line 46
def configure
  yield self
  self
end
options() click to toggle source

Create a hash of options and their values

# File lib/nhk_program/configuration.rb, line 52
def options
  VALID_OPTIONS_KEYS.inject({}) do |options, key|
    options.merge!(key => send(key))
  end
end
reset() click to toggle source

Reset all configuration options to defaults

# File lib/nhk_program/configuration.rb, line 59
def reset
  self.adapter    = DEFAULT_ADAPTER
  self.api_key    = DEFAULT_API_KEY
  self.endpoint   = DEFAULT_ENDPOINT
  self.proxy      = DEFAULT_PROXY
  self.user_agent = DEFAULT_USER_AGENT
  self
end