Module: YouVersion::Configuration

Included in:
YouVersion
Defined in:
lib/youversion/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_version,
  :token,
  :language,
  :endpoint,
  :user_agent,
  :proxy,
  :ca_path,
  :ca_file,
  :middlewares
].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_TOKEN =

By default, don’t set an token

nil
DEFAULT_LANGUAGE =

By default, set english language

'en'
API_VERSION =

YouVersion API version

'3.1'
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://nodejs.bible.com/api_auth/'.freeze
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

"YouVersion Ruby Gem #{YouVersion::VERSION}".freeze
DEFAULT_CA_PATH =

Default openssl CA_PATH and CA_FILE path

%x[ openssl version -a | grep OPENSSLDIR | awk '{print $2}'|sed -e 's/\"//g' ]
DEFAULT_CA_FILE = 
"#{DEFAULT_CA_PATH}/ca-certificates.crt"
DEFAULT_MIDDLEWARES = 
[]

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



56
57
58
 
# File 'lib/youversion/configuration.rb', line 56

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:



61
62
63
 
# File 'lib/youversion/configuration.rb', line 61

def configure
  yield self
end

#options ⇒ Object

Create a hash of options and their values



66
67
68
69
70
 
# File 'lib/youversion/configuration.rb', line 66

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

#reset ⇒ Object

Reset all configuration options to defaults



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/youversion/configuration.rb', line 73

def reset
  self.adapter     = DEFAULT_ADAPTER
  self.api_version = API_VERSION
  self.token       = DEFAULT_TOKEN
  self.language    = DEFAULT_LANGUAGE
  self.endpoint    = DEFAULT_ENDPOINT
  self.user_agent  = DEFAULT_USER_AGENT
  self.proxy       = DEFAULT_PROXY
  self.ca_path     = DEFAULT_CA_PATH
  self.ca_file     = DEFAULT_CA_FILE
  self.middlewares = DEFAULT_MIDDLEWARES
end