Module: FREDAPI::Request

Included in:
Client
Defined in:
lib/fredapi/request.rb

Overview

Request module to handle all requests to API

Instance Method Summary collapse

Instance Method Details

#delete(path, opts = {}) ⇒ Hashie::Mash

Perform a delete request

Parameters:

  • path (String) —

    URL path to send request

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

    Request parameters

Returns:

  • (Hashie::Mash) —

    Response body



21
22
23
 
# File 'lib/fredapi/request.rb', line 21

def delete path, opts={}
  request(:delete, path, opts).body
end

#get(path, opts = {}) ⇒ Hashie::Mash

Perform a get request

Parameters:

  • path (String) —

    URL path to send request

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

    Request parameters

Returns:

  • (Hashie::Mash) —

    Response body



12
13
14
 
# File 'lib/fredapi/request.rb', line 12

def get path, opts={}
  request(:get, path, opts).body
end

#patch(path, opts = {}) ⇒ Hashie::Mash

Perform a patch request

Parameters:

  • path (String) —

    URL path to send request

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

    Request parameters

Returns:

  • (Hashie::Mash) —

    Response body



48
49
50
 
# File 'lib/fredapi/request.rb', line 48

def patch path, opts={}
  request(:patch, path, opts).body
end

#post(path, opts = {}) ⇒ Hashie::Mash

Perform a post request

Parameters:

  • path (String) —

    URL path to send request

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

    Request parameters

Returns:

  • (Hashie::Mash) —

    Response body



30
31
32
 
# File 'lib/fredapi/request.rb', line 30

def post path, opts={}
  request(:post, path, opts).body
end

#put(path, opts = {}) ⇒ Hashie::Mash

Perform a put request

Parameters:

  • path (String) —

    URL path to send request

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

    Request parameters

Returns:

  • (Hashie::Mash) —

    Response body



39
40
41
 
# File 'lib/fredapi/request.rb', line 39

def put path, opts={}
  request(:put, path, opts).body
end