module Ohanakapa::Default

Default configuration options for {Client}

Constants

API_ENDPOINT

Default API endpoint

MEDIA_TYPE

Default media type

MIDDLEWARE

Default Faraday middleware stack

RACK_BUILDER_CLASS

In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder

USER_AGENT

Default User Agent header string

Public Class Methods

api_endpoint() click to toggle source

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

# File lib/ohanakapa/default.rb, line 34
def api_endpoint
  ENV['OHANA_API_ENDPOINT'] || API_ENDPOINT
end
api_token() click to toggle source

Default api token for Ohana API @return [String]

# File lib/ohanakapa/default.rb, line 84
def api_token
  ENV['OHANAKAPA_API_TOKEN']
end
auto_paginate() click to toggle source

Default pagination preference from ENV @return [String]

# File lib/ohanakapa/default.rb, line 40
def auto_paginate
  ENV['OHANAKAPA_AUTO_PAGINATE']
end
connection_options() click to toggle source

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

# File lib/ohanakapa/default.rb, line 54
def connection_options
  {
    headers: {
      accept: default_media_type,
      user_agent: user_agent
    }
  }
end
default_media_type() click to toggle source

Default media type from ENV or {MEDIA_TYPE} @return [String]

# File lib/ohanakapa/default.rb, line 65
def default_media_type
  ENV['OHANAKAPA_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
end
middleware() click to toggle source

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

# File lib/ohanakapa/default.rb, line 72
def middleware
  MIDDLEWARE
end
options() click to toggle source

Configuration options @return [Hash]

# File lib/ohanakapa/default.rb, line 28
def options
  Hash[Ohanakapa::Configurable.keys.map { |key| [key, send(key)] }]
end
per_page() click to toggle source

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

# File lib/ohanakapa/default.rb, line 46
def per_page
  page_size = ENV['OCTOKIT_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/ohanakapa/default.rb, line 78
def proxy
  ENV['OHANAKAPA_PROXY']
end
user_agent() click to toggle source

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

# File lib/ohanakapa/default.rb, line 90
def user_agent
  ENV['OHANAKAPA_USER_AGENT'] || USER_AGENT
end