class Hubscreen::APIRequest

Public Class Methods

new(builder: nil) click to toggle source

A new API request must pass in a Hubscreen::Request Object

# File lib/hubscreen/api_request.rb, line 7
def initialize(builder: nil)
  @request_builder = builder
  @return_encapuslated_object = Hubscreen::Config.encapsulate_response
end

Public Instance Methods

delete(params: nil, headers: nil) click to toggle source
# File lib/hubscreen/api_request.rb, line 64
def delete(params: nil, headers: nil)
  validate_api_key

  begin
    response = self.rest_client.delete do |request|
      configure_request(request: request, params: params, headers: headers)
    end
    parse_response(response.body)
  rescue => e
    handle_error(e)
  end
end
get(params: nil, headers: nil) click to toggle source
# File lib/hubscreen/api_request.rb, line 51
def get(params: nil, headers: nil)
  validate_api_key

  begin
    response = self.rest_client.get do |request|
      configure_request(request: request, params: params, headers: headers)
    end
    parse_response(response.body)
  rescue => e
    handle_error(e)
  end
end
patch(params: nil, headers: nil, body: nil) click to toggle source
# File lib/hubscreen/api_request.rb, line 25
def patch(params: nil, headers: nil, body: nil)
  validate_api_key

  begin
    response = self.rest_client.patch do |request|
      configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
    end
    parse_response(response.body)
  rescue => e
    handle_error(e)
  end
end
post(params: nil, headers: nil, body: nil) click to toggle source
# File lib/hubscreen/api_request.rb, line 12
def post(params: nil, headers: nil, body: nil)
  validate_api_key

  begin
    response = self.rest_client.post do |request|
      configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
    end
    parse_response(response.body)
  rescue => e
    handle_error(e)
  end
end
put(params: nil, headers: nil, body: nil) click to toggle source
# File lib/hubscreen/api_request.rb, line 38
def put(params: nil, headers: nil, body: nil)
  validate_api_key

  begin
    response = self.rest_client.put do |request|
      configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
    end
    parse_response(response.body)
  rescue => e
    handle_error(e)
  end
end

Protected Instance Methods

adapter() click to toggle source
# File lib/hubscreen/api_request.rb, line 97
def adapter
  @request_builder.faraday_adapter
end
api_endpoint() click to toggle source
# File lib/hubscreen/api_request.rb, line 85
def api_endpoint
  @request_builder.api_endpoint
end
api_key() click to toggle source

Convenience accessors

# File lib/hubscreen/api_request.rb, line 81
def api_key
  @request_builder.api_key
end
api_url() click to toggle source
# File lib/hubscreen/api_request.rb, line 187
def api_url
  base_api_url + @request_builder.path
end
base_api_url() click to toggle source
# File lib/hubscreen/api_request.rb, line 191
def base_api_url
  @request_builder.api_endpoint 
end
configure_request(request: nil, params: nil, headers: nil, body: nil) click to toggle source
# File lib/hubscreen/api_request.rb, line 128
def configure_request(request: nil, params: nil, headers: nil, body: nil)
  if request
    request.options.params_encoder = Faraday::FlatParamsEncoder
    request.params.merge!(params) if params
    request.headers['Content-Type'] = 'application/json'
    request.headers.merge!(headers) if headers
    request.body = body if body
    request.options.timeout = self.timeout        
  end
end
handle_error(error) click to toggle source

Helpers

# File lib/hubscreen/api_request.rb, line 103
def handle_error(error)
  error_params = {}

  begin
    if error.is_a?(Faraday::Error::ClientError) && error.response
      error_params[:status_code] = error.response[:status]
      error_params[:raw_body] = error.response[:body]
      
      parsed_response = MultiJson.load(error.response[:body])

      if parsed_response
        error_params[:body] = parsed_response
        error_params[:title] = parsed_response["title"] if parsed_response["title"]
        error_params[:detail] = parsed_response["detail"] if parsed_response["detail"]
      end

    end
  rescue MultiJson::ParseError
  end

  error_to_raise = Hubscreen::RequestError.new(error.message, error_params)

  raise error_to_raise
end
parse_response(response_body) click to toggle source
# File lib/hubscreen/api_request.rb, line 156
def parse_response(response_body)
  parsed_response = nil

  if response_body && !response_body.empty?
    begin
      parsed_response = MultiJson.load(response_body)
    rescue MultiJson::ParseError
      error = ApiError.new("Unparseable response: #{response_body}")
      error.title = "UNPARSEABLE_RESPONSE"
      error.status_code = 500
      raise error
    end
  end
  if @return_encapuslated_object
    return Hubscreen::Response.new(parsed_response)
  else
    return parsed_response
  end
end
proxy() click to toggle source
# File lib/hubscreen/api_request.rb, line 93
def proxy
  @request_builder.proxy
end
rest_client() click to toggle source

Note REST Client has been modified for Flat Parameter Encoding to support Hubspot's batch search functionality. This however limit's Faraday's ability to accept nested parameters

# File lib/hubscreen/api_request.rb, line 141
def rest_client
  client = Faraday.new(self.api_url, proxy: self.proxy) do |faraday|
    
    faraday.response :raise_error
    faraday.adapter adapter
    if @request_builder.debug
      faraday.response :logger, ::Logger.new(STDOUT), bodies: true
    end
  end
  # Hubspot expects the API key in the Query Params (WTF!!)
  client.params['hapikey'] = self.api_key
  #client.basic_auth('hapikey', self.api_key)
  client
end
timeout() click to toggle source
# File lib/hubscreen/api_request.rb, line 89
def timeout
  @request_builder.timeout
end
validate_api_key() click to toggle source
# File lib/hubscreen/api_request.rb, line 176
def validate_api_key
  api_key = self.api_key
  api_endpoint = self.api_endpoint
  unless !api_key.blank?
    raise Hubscreen::ApiError, "You must set an api_key prior to making a call"
  end
  unless !api_endpoint.blank?
    raise Hubscreen::ApiError, "You must set an api_endpoint prior to making a call"
  end
end