module Nearmiss::Default

Default configuration options for {Client}

Constants

API_ENDPOINT

Default API endpoint

API_KEY
USER_AGENT

Default User Agent header string

Public Class Methods

access_token() click to toggle source

Default access token from ENV @return [String]

# File lib/nearmiss-ruby/default.rb, line 34
def access_token
  ENV['NEARMISS_ACCESS_TOKEN']
end
api_endpoint() click to toggle source

Default API endpoint from ENV or {API_ENDPOINT} @return [String]

# File lib/nearmiss-ruby/default.rb, line 61
def api_endpoint
  ENV['NEARMISS_API_ENDPOINT'] || API_ENDPOINT
end
api_key() click to toggle source
# File lib/nearmiss-ruby/default.rb, line 130
def api_key
  ENV['NEARMISS_API_KEY'] || API_KEY
end
auto_paginate() click to toggle source

Default pagination preference from ENV @return [String]

# File lib/nearmiss-ruby/default.rb, line 111
def auto_paginate
  ENV['NEARMISS_AUTO_PAGINATE'] || true
end
client_id() click to toggle source
# File lib/nearmiss-ruby/default.rb, line 38
def client_id

end
config() click to toggle source
# File lib/nearmiss-ruby/default.rb, line 55
def config
  @config ||= {}
end
connection_options() click to toggle source

Default options for Faraday::Connection @return [Hash]

# File lib/nearmiss-ruby/default.rb, line 89
def connection_options
  {
    :headers => {
      # :accept => default_media_type,
      :user_agent => user_agent
    }
  }
end
email() click to toggle source

Default BIM360-Field username for Basic Auth from ENV @return [String]

# File lib/nearmiss-ruby/default.rb, line 67
def email
  ENV['NEARMISS_EMAIL'] || config['email']
end
expiry() click to toggle source
# File lib/nearmiss-ruby/default.rb, line 46
def expiry

end
middleware() click to toggle source

Default middleware stack for Faraday::Connection from {MIDDLEWARE} @return [String]

# File lib/nearmiss-ruby/default.rb, line 102
def middleware
  Faraday::RackBuilder.new do |builder|
    builder.use Nearmiss::Response::RaiseError
    builder.adapter Faraday.default_adapter
  end
end
options() click to toggle source

Configuration options @return [Hash]

# File lib/nearmiss-ruby/default.rb, line 28
def options
  Hash[Nearmiss::Configurable.keys.map{|key| [key, send(key)]}]
end
password() click to toggle source

Default BIM360-Field password for Basic Auth from ENV @return [String]

# File lib/nearmiss-ruby/default.rb, line 73
def password
  ENV['NEARMISS_PASSWORD'] || config['password']
end
per_page() click to toggle source

Default pagination page size from ENV @return [Fixnum] Page size

# File lib/nearmiss-ruby/default.rb, line 117
def per_page
  page_size = ENV['NEARMISS_PER_PAGE']

  page_size.to_i if page_size
end
proxy() click to toggle source

Default proxy server URI for Faraday connection from ENV @return [String]

# File lib/nearmiss-ruby/default.rb, line 83
def proxy
  ENV['NEARMISS_PROXY']
end
uid() click to toggle source
# File lib/nearmiss-ruby/default.rb, line 42
def uid

end
user() click to toggle source
# File lib/nearmiss-ruby/default.rb, line 50
def user

end
user_agent() click to toggle source

Default User-Agent header string from ENV or {USER_AGENT} @return [String]

# File lib/nearmiss-ruby/default.rb, line 126
def user_agent
  ENV['NEARMISS_USER_AGENT'] || USER_AGENT
end