Class: Iter::Request Private

Inherits:

Object

• Object
• Iter::Request

Defined in:

lib/iter/http_request.rb,
lib/iter/mock_request.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A mock version of HTTPRequest which returns pre-built responses.

Examples:

Updates the email of a user.

path = '/api/users/update'
body = {userId: '666', email: 'iter@example.com'}
response = Iter::Request.new(path: path, body: body).run
response['msg'] # => User successfully created/updated.

Instance Method Summary

• #initialize(options = {}) ⇒ Request constructor private

  Initializes an MockRequest object.

• #run ⇒ Hash private

  Sends the request and returns the body parsed from the JSON response.

Constructor Details

#initialize(options = {}) ⇒ Request

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes an MockRequest object.

Parameters:

• options (Hash) (defaults to: {}) —

  the options for the request.

Options Hash (options):

• :path (String) —

  The path of the request URI.

• :body (Hash) —

  The body of the request.

# File 'lib/iter/http_request.rb', line 22

def initialize(options = {})
  @path = options[:path]
  @body = options[:body]
end

Instance Method Details

#run ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Sends the request and returns the body parsed from the JSON response.

Returns:

• (Hash) —

  the body parsed from the JSON response.

Raises:

• (Iter::ConnectionError) —

  if the request fails.

• (Iter::Error) —

  if parsed body includes errors.

# File 'lib/iter/http_request.rb', line 31

def run
  return {} if response.body.empty?
  JSON(response.body).tap do |data|
    raise Error, "#{data['errMsg']} #{data['Errors']}" unless data['errNo'].zero?
  end
end