Module: Nearmiss::Default

Defined in:
lib/nearmiss-ruby/default.rb

Overview

Default configuration options for Client

Constant Summary collapse

API_ENDPOINT =

Default API endpoint

"http://nearmissapp.com".freeze
USER_AGENT =

Default User Agent header string

"Nearmiss Ruby Gem #{Nearmiss::VERSION}".freeze
API_KEY = 
"WEBCOR".freeze

Class Method Summary collapse

Class Method Details

.access_token ⇒ String

Default access token from ENV

Returns:

  • (String) 


34
35
36
 
# File 'lib/nearmiss-ruby/default.rb', line 34

def access_token
  ENV['NEARMISS_ACCESS_TOKEN']
end

.api_endpoint ⇒ String

Default API endpoint from ENV or API_ENDPOINT

Returns:

  • (String) 


61
62
63
 
# File 'lib/nearmiss-ruby/default.rb', line 61

def api_endpoint
  ENV['NEARMISS_API_ENDPOINT'] || API_ENDPOINT
end

.api_key ⇒ Object 



130
131
132
 
# File 'lib/nearmiss-ruby/default.rb', line 130

def api_key
  ENV['NEARMISS_API_KEY'] || API_KEY
end

.auto_paginate ⇒ String

Default pagination preference from ENV

Returns:

  • (String) 


111
112
113
 
# File 'lib/nearmiss-ruby/default.rb', line 111

def auto_paginate
  ENV['NEARMISS_AUTO_PAGINATE'] || true
end

.client_id ⇒ Object 



38
39
40
 
# File 'lib/nearmiss-ruby/default.rb', line 38

def client_id

end

.config ⇒ Object 



55
56
57
 
# File 'lib/nearmiss-ruby/default.rb', line 55

def config
  @config ||= {}
end

.connection_options ⇒ Hash

Default options for Faraday::Connection

Returns:

  • (Hash) 


89
90
91
92
93
94
95
96
 
# File 'lib/nearmiss-ruby/default.rb', line 89

def connection_options
  {
    :headers => {
      # :accept => default_media_type,
      :user_agent => user_agent
    }
  }
end

.email ⇒ String

Default BIM360-Field username for Basic Auth from ENV

Returns:

  • (String) 


67
68
69
 
# File 'lib/nearmiss-ruby/default.rb', line 67

def email
  ENV['NEARMISS_EMAIL'] || config['email']
end

.expiry ⇒ Object 



46
47
48
 
# File 'lib/nearmiss-ruby/default.rb', line 46

def expiry

end

.middleware ⇒ String

Default middleware stack for Faraday::Connection from MIDDLEWARE

Returns:

  • (String) 


102
103
104
105
106
107
 
# 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 ⇒ Hash

Configuration options

Returns:

  • (Hash) 


28
29
30
 
# File 'lib/nearmiss-ruby/default.rb', line 28

def options
  Hash[Nearmiss::Configurable.keys.map{|key| [key, send(key)]}]
end

.password ⇒ String

Default BIM360-Field password for Basic Auth from ENV

Returns:

  • (String) 


73
74
75
 
# File 'lib/nearmiss-ruby/default.rb', line 73

def password
  ENV['NEARMISS_PASSWORD'] || config['password']
end

.per_page ⇒ Fixnum

Default pagination page size from ENV

Returns:

  • (Fixnum) —

    Page size



117
118
119
120
121
 
# 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 ⇒ String

Default proxy server URI for Faraday connection from ENV

Returns:

  • (String) 


83
84
85
 
# File 'lib/nearmiss-ruby/default.rb', line 83

def proxy
  ENV['NEARMISS_PROXY']
end

.uid ⇒ Object 



42
43
44
 
# File 'lib/nearmiss-ruby/default.rb', line 42

def uid

end

.user ⇒ Object 



50
51
52
 
# File 'lib/nearmiss-ruby/default.rb', line 50

def user

end

.user_agent ⇒ String

Default User-Agent header string from ENV or USER_AGENT

Returns:

  • (String) 


126
127
128
 
# File 'lib/nearmiss-ruby/default.rb', line 126

def user_agent
  ENV['NEARMISS_USER_AGENT'] || USER_AGENT
end