Module: BWAPI::Request

Included in:
Client
Defined in:
lib/bwapi/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



22
23
24
 
# File 'lib/bwapi/request.rb', line 22

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



13
14
15
 
# File 'lib/bwapi/request.rb', line 13

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



49
50
51
 
# File 'lib/bwapi/request.rb', line 49

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



31
32
33
 
# File 'lib/bwapi/request.rb', line 31

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



40
41
42
 
# File 'lib/bwapi/request.rb', line 40

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