module Nearmiss::Configurable

Attributes

api_endpoint[W]
api_key[RW]
auto_paginate[RW]
connection_options[RW]
email[W]
middleware[RW]
password[W]
per_page[RW]
proxy[RW]
user_agent[RW]

Public Class Methods

keys() click to toggle source
# File lib/nearmiss-ruby/configurable.rb, line 10
def keys
  @keys ||= [
    :middleware,
    :proxy,
    :user_agent,
    :connection_options,
    :password,
    :api_endpoint,
    :api_key,
    :email,
    :auto_paginate,
    :per_page
  ]
end

Public Instance Methods

api_endpoint() click to toggle source
# File lib/nearmiss-ruby/configurable.rb, line 40
def api_endpoint
  File.join(@api_endpoint, "")
end
configure() { |self| ... } click to toggle source

Set configuration options using a block

# File lib/nearmiss-ruby/configurable.rb, line 27
def configure
  yield self
end
options() click to toggle source
# File lib/nearmiss-ruby/configurable.rb, line 44
def options
  Hash[Nearmiss::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
end
reset!() click to toggle source

Reset configuration options to default values

# File lib/nearmiss-ruby/configurable.rb, line 32
def reset!
  Nearmiss::Configurable.keys.each do |key|
    instance_variable_set(:"@#{key}", Nearmiss::Default.options[key])
  end
  self
end
Also aliased as: setup
setup()
Alias for: reset!