Module: Vindi::Request

Includes:
Connection
Included in:
Client
Defined in:
lib/vindi/request.rb

Instance Method Summary collapse

Methods included from Connection

#http_client, #last_response

Instance Method Details

#delete(url, options = {}) ⇒ Object

Make a HTTP DELETE request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Body and header params for request

Returns:

  • Hash



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

def delete(url, options = {})
  request :delete, url, options
end

#get(url, options = {}) ⇒ Hash

Make a HTTP GET request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Query and header params for request

Returns:

  • (Hash) 


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

def get(url, options = {})
  request :get, url, options
end

#head(url, options = {}) ⇒ Object

Make a HTTP HEAD request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Body and header params for request

Returns:

  • Hash



57
58
59
 
# File 'lib/vindi/request.rb', line 57

def head(url, options = {})
  request :head, url, options
end

#patch(url, options = {}) ⇒ Object

Make a HTTP PATCH request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Body and header params for request

Returns:

  • Hash



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

def patch(url, options = {})
  request :patch, url, options
end

#post(url, options = {}) ⇒ Object

Make a HTTP POST request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Query and header params for request

Returns:

  • Hash



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

def post(url, options = {})
  request :post, url, options
end

#put(url, options = {}) ⇒ Object

Make a HTTP PUT request

Parameters:

  • url (String) —

    The path, relative to #api_endpoint

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

    Query and header params for request

Returns:

  • Hash



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

def put(url, options = {})
  request :put, url, options
end