Module: HTTP::RestClient::CRUD

Defined in:
lib/http/rest_client/crud.rb

Overview

Create/Read/Update/Delete helpers.

Instance Method Summary collapse

Instance Method Details

#all(params = {}) ⇒ Array

Resource collection finder, uses the default limit

Parameters:

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

    URI parameters to pass to the endpoint.

Returns:

  • (Array) —

    of [Object] instances



9
10
11
 
# File 'lib/http/rest_client/crud.rb', line 9

def all(params = {})
  objectify(request(:get, uri, params: params))
end

#create(params = {}) ⇒ Object

Resource creation helper

Parameters:

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

    request parameters to pass to the endpoint as JSON.

Returns:

  • (Object) —

    instance



34
35
36
 
# File 'lib/http/rest_client/crud.rb', line 34

def create(params = {})
  objectify(request(:post, uri, json: params))
end

#delete(id) ⇒ Object

Resource deletion handler

Parameters:

  • id (String) —

    resource indentifier

Returns:

  • (Object) —

    instance



26
27
28
 
# File 'lib/http/rest_client/crud.rb', line 26

def delete(id)
  objectify(request(:delete, uri(id)))
end

#find(id, params = {}) ⇒ Object

Resource finder

Parameters:

  • id (String) —

    resource indentifier

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

    URI parameters to pass to the endpoint.

Returns:

  • (Object) —

    instance



18
19
20
 
# File 'lib/http/rest_client/crud.rb', line 18

def find(id, params = {})
  objectify(request(:get, uri(id), params: params))
end

#update(id, params = {}) ⇒ Object

Resource update helper

Parameters:

  • id (String) —

    resource indentifier

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

    request parameters to pass to the endpoint as JSON.

Returns:

  • (Object) —

    instance



43
44
45
 
# File 'lib/http/rest_client/crud.rb', line 43

def update(id, params = {})
  objectify(request(:patch, uri(id), json: params))
end