Class: PyBossa::API

Inherits:

Object

• Object
• PyBossa::API

Includes:

HTTParty

Defined in:

lib/pybossa-api.rb,
lib/pybossa-api/version.rb

Overview

A Ruby wrapper for the PyBossa API.

See Also:

• http://docs.pybossa.com/en/latest/model.html#restful-api

Defined Under Namespace

Classes: Error

Constant Summary

VERSION =

"0.0.1"

Class Attribute Summary

• .api_key ⇒ Object

  Returns the value of attribute api_key.

Class Method Summary

• .create(klass, opts = {}) ⇒ Hash

  Creates an object.

• .destroy(klass, id, opts = {}) ⇒ Object

  Deletes an object.

• .many(klass, opts = {}) ⇒ Array

  Lists objects.

• .retrieve(klass, id, opts = {}) ⇒ Hash

  Gets an object by ID.

• .update(klass, id, opts = {}) ⇒ Object

  Updates an object.

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.

# File 'lib/pybossa-api.rb', line 21

def api_key
  @api_key
end

Class Method Details

.create(klass, opts = {}) ⇒ Hash

Creates an object.

Parameters:

• klass (String) —

  one of “app”, “task” or “taskrun”

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

  optional arguments

Options Hash (opts):

• :api_key (String) —

  an API key

Returns:

• (Hash) —

  an object

Raises:

• (PyBossa::API::Error) —

  if operation failed

See Also:

• https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L91

# File 'lib/pybossa-api.rb', line 56

def create(klass, opts = {})
  request :post, "/#{klass}", opts
end

.destroy(klass, id, opts = {}) ⇒ Object

Deletes an object.

Parameters:

• klass (String) —

  one of “app”, “task” or “taskrun”

• id (Integer) —

  an object ID

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

  optional arguments

Options Hash (opts):

• :api_key (String) —

  an API key

Raises:

• (PyBossa::API::Error) —

  if operation failed

See Also:

• https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L108

# File 'lib/pybossa-api.rb', line 82

def destroy(klass, id, opts = {})
  request :delete, "/#{klass}/#{id}", opts
end

.many(klass, opts = {}) ⇒ Array

Lists objects. To filter objects, add key-value pairs to the :opts argument in which each key is the name of a field on which you want to filter. For example, you may want to filter tasks by app_id.

Parameters:

• klass (String) —

  one of “app”, “task” or “taskrun”

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

  optional arguments

Options Hash (opts):

• :limit (Integer) —

  number of results to return [default 20]

• :api_key (String) —

  an API key

Returns:

• (Array) —

  a list of objects

# File 'lib/pybossa-api.rb', line 32

def many(klass, opts = {})
  request :get, "/#{klass}", opts
end

.retrieve(klass, id, opts = {}) ⇒ Hash

Gets an object by ID.

Parameters:

• klass (String) —

  one of “app”, “task” or “taskrun”

• id (Integer) —

  an object ID

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

  optional arguments

Options Hash (opts):

• :api_key (String) —

  an API key

Returns:

• (Hash) —

  an object

# File 'lib/pybossa-api.rb', line 43

def retrieve(klass, id, opts = {})
  request :get, "/#{klass}/#{id}", opts
end

.update(klass, id, opts = {}) ⇒ Object

Updates an object.

Parameters:

• klass (String) —

  one of “app”, “task” or “taskrun”

• id (Integer) —

  an object ID

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

  optional arguments

Options Hash (opts):

• :api_key (String) —

  an API key

Raises:

• (PyBossa::API::Error) —

  if operation failed

See Also:

• https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L129

# File 'lib/pybossa-api.rb', line 69

def update(klass, id, opts = {})
  request :put, "/#{klass}/#{id}", opts
end