Module: EmpireAvenue::Default

Defined in:
lib/empireavenue/default.rb

Constant Summary collapse

ENDPOINT =
'https://api.empireavenue.com'
CONNECTION_OPTIONS =
{
  :headers => {
    :accept => 'application/json',
    :user_agent => "EmpireAvenue Ruby Gem #{EmpireAvenue::Version}",
  },
  :request => {
    :open_timeout => 5,
    :timeout => 10,
  },
  :params => {
  },
  :ssl => {
    :verify => false
  },
}
IDENTITY_MAP =
false
MIDDLEWARE =
Faraday::Builder.new do |builder|
  # Convert file uploads to Faraday::UploadIO objects
  #builder.use EmpireAvenue::Request::MultipartWithFile
  # Checks for files in the payload
  #builder.use Faraday::Request::Multipart
  # Convert request params to "www-form-urlencoded"
  builder.use Faraday::Request::UrlEncoded
  # Handle 4xx server responses
  builder.use EmpireAvenue::Response::RaiseError, EmpireAvenue::Error::ClientError
  # Parse JSON response bodies using MultiJson
  builder.use EmpireAvenue::Response::ParseJson
  # Handle 5xx server responses
  builder.use EmpireAvenue::Response::RaiseError, EmpireAvenue::Error::ServerError
  # Set Faraday's HTTP adapter
  builder.adapter Faraday.default_adapter
end

Class Method Summary collapse

Class Method Details

.client_idString

Returns sferik.

Returns:

  • (String)

    sferik



55
56
57
# File 'lib/empireavenue/default.rb', line 55

def client_id
  ENV['EMPIRE_AVENUE_CLIENT_ID']
end

.client_secretString

Returns:

  • (String)


60
61
62
# File 'lib/empireavenue/default.rb', line 60

def client_secret
  ENV['EMPIRE_AVENUE_CLIENT_SECRET']
end

.connection_optionsObject



80
81
82
# File 'lib/empireavenue/default.rb', line 80

def connection_options
  CONNECTION_OPTIONS
end

.endpointString

Note:

This is configurable in case you want to use a Empire Avenue-compatible endpoint.

Returns:

  • (String)


76
77
78
# File 'lib/empireavenue/default.rb', line 76

def endpoint
  ENDPOINT
end

.identity_mapObject



84
85
86
# File 'lib/empireavenue/default.rb', line 84

def identity_map
  IDENTITY_MAP
end

.middlewareFaraday::Builder

Note:

Faraday’s middleware stack implementation is comparable to that of Rack middleware. The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.

Returns:

  • (Faraday::Builder)

See Also:



91
92
93
# File 'lib/empireavenue/default.rb', line 91

def middleware
  MIDDLEWARE
end

.oauth_tokenString

Returns:

  • (String)


65
66
67
# File 'lib/empireavenue/default.rb', line 65

def oauth_token
  ENV['EMPIRE_AVENUE_OAUTH_TOKEN']
end

.oauth_token_secretString

Returns:

  • (String)


70
71
72
# File 'lib/empireavenue/default.rb', line 70

def oauth_token_secret
  ENV['EMPIRE_AVENUE_OAUTH_TOKEN_SECRET']
end

.optionsHash

Returns:

  • (Hash)


50
51
52
# File 'lib/empireavenue/default.rb', line 50

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