module QboApi::Connection

Public Instance Methods

authorized_json_connection(url, headers: nil) click to toggle source
# File lib/qbo_api/connection.rb, line 7
def authorized_json_connection(url, headers: nil)
  headers ||= {}
  headers['Accept'] ||= 'application/json'
  headers['Content-Type'] ||= 'application/json;charset=UTF-8'
  build_connection(url, headers: headers) do |conn|
    add_authorization_middleware(conn)
    add_exception_middleware(conn)
    conn.request :url_encoded
    add_connection_adapter(conn)
  end
end
authorized_multipart_connection(url) click to toggle source
# File lib/qbo_api/connection.rb, line 19
def authorized_multipart_connection(url)
  headers = {
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json'
  }
  build_connection(url, headers: headers) do |conn|
    add_authorization_middleware(conn)
    add_exception_middleware(conn)
    conn.request :multipart
    add_connection_adapter(conn)
  end
end
build_connection(url, headers: nil) { |conn| ... } click to toggle source
# File lib/qbo_api/connection.rb, line 32
def build_connection(url, headers: nil)
  Faraday.new(url: url) { |conn|
    conn.response :detailed_logger, QboApi.logger, LOG_TAG if QboApi.log
    conn.headers.update(headers) if headers
    yield conn if block_given?
  }
end
parse_response_body(resp) click to toggle source
# File lib/qbo_api/connection.rb, line 67
def parse_response_body(resp)
  body = resp.body
  case resp.headers['Content-Type']
  when /json/ then JSON.parse(body)
  else body
  end
end
raw_request(method, conn:, path:, payload: nil, params: nil) click to toggle source
# File lib/qbo_api/connection.rb, line 45
def raw_request(method, conn:, path:, payload: nil, params: nil)
  path = finalize_path(path, method: method, params: params)
  conn.public_send(method) do |req|
    case method
    when :get, :delete
      req.url path
    when :post, :put
      req.url path
      req.body = payload.to_json
    else raise ArgumentError, "Unhandled request method '#{method.inspect}'"
    end
  end
end
request(method, path:, entity: nil, payload: nil, params: nil) click to toggle source
# File lib/qbo_api/connection.rb, line 40
def request(method, path:, entity: nil, payload: nil, params: nil)
  raw_response = raw_request(method, conn: connection, path: path, params: params, payload: payload)
  response(raw_response, entity: entity)
end
response(resp, entity: nil) click to toggle source
# File lib/qbo_api/connection.rb, line 59
def response(resp, entity: nil)
  data = parse_response_body(resp)
  entity ? entity_response(data, entity) : data
rescue => e
  QboApi.logger.debug { "#{LOG_TAG} response parsing error: entity=#{entity.inspect} body=#{resp.body.inspect} exception=#{e.inspect}" }
  data
end

Private Instance Methods

add_authorization_middleware(conn) click to toggle source
# File lib/qbo_api/connection.rb, line 104
def add_authorization_middleware(conn)
  conn.request :oauth2, access_token, token_type: 'bearer'
end
add_connection_adapter(conn) click to toggle source
# File lib/qbo_api/connection.rb, line 96
def add_connection_adapter(conn)
  conn.adapter Faraday.default_adapter
end
add_exception_middleware(conn) click to toggle source
# File lib/qbo_api/connection.rb, line 100
def add_exception_middleware(conn)
  conn.use FaradayMiddleware::RaiseHttpException
end
entity_name(entity) click to toggle source
# File lib/qbo_api/connection.rb, line 108
def entity_name(entity)
  singular(entity)
end
entity_response(data, entity) click to toggle source
# File lib/qbo_api/connection.rb, line 77
def entity_response(data, entity)
  entity_name = entity_name(entity)
  if data.key?('QueryResponse')
    entity_body = data['QueryResponse']
    return nil if entity_body.empty?
    entity_body.fetch(entity_name, data)
  elsif data.key?('AttachableResponse')
    entity_body = data['AttachableResponse']
    entity_body &&= entity_body.first
    entity_body.fetch(entity_name, data)
  else
    entity_body = data
    entity_body.fetch(entity_name) do
      QboApi.logger.debug { "#{LOG_TAG} entity name not in response body: entity=#{entity.inspect} entity_name=#{entity_name.inspect} body=#{data.inspect}" }
      data
    end
  end
end