module Infreemation

This module is the main entry point of the Gem

Constants

AuthenticationError

An API authentication error

ConfigurationError
ERROR_MAPPINGS
Exception

A base error

GenericError

A generic error

InvalidParameterError

An invalid parameter error

MissingOrInvalidParameterError

A missing or invalid parameter error

MissingParameterError

A missing parameter error

RequestError

A request error

ResponseError

A response error

VERSION

Attributes

api_key[W]
logger[RW]
url[W]
username[W]

Public Class Methods

api_key() click to toggle source
# File lib/infreemation.rb, line 25
def api_key
  @api_key || raise(
    ConfigurationError, 'Infreemation.api_key not configured'
  )
end
log(level, message) click to toggle source
# File lib/infreemation.rb, line 37
def log(level, message)
  logger&.send(level, name) { message }
end
url() click to toggle source
# File lib/infreemation.rb, line 19
def url
  @url || raise(
    ConfigurationError, 'Infreemation.url not configured'
  )
end
username() click to toggle source
# File lib/infreemation.rb, line 31
def username
  @username || raise(
    ConfigurationError, 'Infreemation.username not configured'
  )
end