pybossa-api 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+doc/*
+pkg/*

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in scraperwiki-api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Open North Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# The PyBossa API Ruby Gem
+
+A Ruby wrapper for the PyBossa API.
+
+[![Build Status](https://secure.travis-ci.org/opennorth/pybossa-api-ruby.png)](http://travis-ci.org/opennorth/pybossa-api-ruby)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/opennorth/pybossa-api-ruby)
+
+## Installation
+
+    gem install pybossa-api
+
+## API Examples
+
+    >> require 'pybossa-api'
+
+    >> PyBossa::App.list limit: 100 # default limit is 20
+    => [{"info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...}, ...]
+
+    >> PyBossa::App.list short_name: 'flickrperson'
+    => [{"info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...}, ...]
+
+    >> PyBossa::App.get 128
+    => {"info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...}
+
+    >> PyBossa::App.api_key = '21ec2020-3aea-1069-a2dd-08002b30309d'
+
+    >> app = PyBossa::App.create "info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...
+    => {"info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...}
+
+    >> PyBossa::App.update app['id'], description: "An example API call"
+    => nil # raises an error on failure
+
+    >> PyBossa::App.delete app['id']
+    => nil # raises an error on failure
+
+You can perform similar operations on `PyBossa::Task` and `PyBossa::TaskRun`.
+
+More documentation at [RubyDoc.info](http://rdoc.info/gems/pybossa-api/PyBossa/API).
+
+## Bugs? Questions?
+
+This gem's main repository is on GitHub: [http://github.com/opennorth/pybossa-api-ruby](http://github.com/opennorth/pybossa-api-ruby), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed.
+
+Copyright (c) 2012 Open North Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/USAGE

@@ -0,0 +1 @@
+See README.md for full usage details.

data/lib/pybossa-api.rb

@@ -0,0 +1,106 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'httparty'
+require 'sanitize'
+require 'yajl'
+
+module PyBossa
+  autoload :App, 'pybossa-api/app'
+  autoload :Task, 'pybossa-api/task'
+  autoload :TaskRun, 'pybossa-api/task_run'
+
+  # A Ruby wrapper for the PyBossa API.
+  # @see http://docs.pybossa.com/en/latest/model.html#restful-api
+  class API
+    include HTTParty
+    base_uri 'pybossa.com/api'
+
+    class Error < StandardError; end
+
+    class << self
+      attr_accessor :api_key
+
+      # 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+.
+      #
+      # @param [String] klass one of "app", "task" or "taskrun"
+      # @param [Hash] opts optional arguments
+      # @option opts [Integer] :limit number of results to return [default 20]
+      # @option opts [String] :api_key an API key
+      # @return [Array] a list of objects
+      def many(klass, opts = {})
+        request :get, "/#{klass}", opts
+      end
+
+      # Gets an object by ID.
+      #
+      # @param [String] klass one of "app", "task" or "taskrun"
+      # @param [Integer] id an object ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      # @return [Hash] an object
+      def retrieve(klass, id, opts = {})
+        request :get, "/#{klass}/#{id}", opts
+      end
+
+      # Creates an object.
+      #
+      # @param [String] klass one of "app", "task" or "taskrun"
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      # @return [Hash] an object
+      # @raise [PyBossa::API::Error] if operation failed
+      #
+      # @see https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L91
+      def create(klass, opts = {})
+        request :post, "/#{klass}", opts
+      end
+
+      # Updates an object.
+      #
+      # @param [String] klass one of "app", "task" or "taskrun"
+      # @param [Integer] id an object ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      # @raise [PyBossa::API::Error] if operation failed
+      #
+      # @see https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L129
+      def update(klass, id, opts = {})
+        request :put, "/#{klass}/#{id}", opts
+      end
+
+      # Deletes an object.
+      #
+      # @param [String] klass one of "app", "task" or "taskrun"
+      # @param [Integer] id an object ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      # @raise [PyBossa::API::Error] if operation failed
+      #
+      # @see https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L108
+      def destroy(klass, id, opts = {})
+        request :delete, "/#{klass}/#{id}", opts
+      end
+
+      # @todo new_task user_progress
+      # https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L198
+      # https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L238
+
+    private
+
+      def request(http_method, path, opts)
+        opts[:api_key] ||= api_key if api_key
+        response = if [:get, :delete].include? http_method
+          send http_method, path, :query => opts
+        else
+          send http_method, path, :query => {:api_key => opts.delete(:api_key)}, :body => Yajl::Encoder.encode(opts), :headers => {'Content-type' => 'application/json'}
+        end
+        unless [200, 204].include? response.response.code.to_i
+          raise PyBossa::API::Error.new Sanitize.clean(response.response.body)
+        end
+        response.parsed_response
+      end
+    end
+  end
+end

data/lib/pybossa-api/app.rb

@@ -0,0 +1,67 @@
+module PyBossa
+  class App
+    class << self
+      # @param [Hash] opts optional arguments
+      # @option opts [Integer] :limit number of results to return [default 20]
+      # @option opts [String] :api_key an API key
+      # @return [Array] a list of apps
+      def list(opts = {})
+        PyBossa::API.many 'app', opts
+      end
+
+      # @param [Integer] id an app ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      # @return [Hash] an app
+      def get(id, opts = {})
+        PyBossa::API.retrieve 'app', id, opts
+      end
+
+      # Creates an app.
+      #
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :name a name
+      # @option opts [String] :short_name a URL slug
+      # @option opts [String] :description a short description
+      # @option opts [String] :long_description a long HTML description
+      # @option opts [Integer] :long_tasks [not in use]
+      # @option opts [Boolean] :hidden whether to hide the app from the public
+      # @option opts [Integer] :time_estimate estimated time to complete [not in use]
+      # @option opts [Integer] :time_limit time limit to complete task [not in use]
+      # @option opts [Float] :calibration_frac [not in use]
+      # @option opts [Integer] :bolt_course_id [not in use]
+      # @option opts [Hash] :info all other task details
+      # @option opts [String] :api_key an API key
+      # @return [Hash] an app
+      #
+      # @see https://github.com/PyBossa/pybossa/blob/master/pybossa/model.py#L133
+      def create(opts = {})
+        if opts.has_key? :hidden
+          opts[:hidden] = opts[:hidden] ? 1 : 0
+        end
+        PyBossa::API.create 'app', opts
+      end
+
+      # Updates an app.
+      #
+      # @param [Integer] id an app ID
+      #
+      # @see PyBossa::App#create
+      def update(id, opts = {})
+        if opts.has_key? :calibration
+          opts[:calibration] = opts[:calibration] ? 1 : 0
+        end
+        PyBossa::API.update 'app', id, opts
+      end
+
+      # Deletes an app.
+      #
+      # @param [Integer] id an app ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      def delete(id, opts = {})
+        PyBossa::API.destroy 'app', id, opts
+      end
+    end
+  end
+end

data/lib/pybossa-api/task.rb

@@ -0,0 +1,68 @@
+module PyBossa
+  class Task
+    class << self
+      # @param [Hash] opts optional arguments
+      # @option opts [Integer] :limit number of results to return [default 20]
+      # @option opts [String] :api_key an API key
+      # @return [Array] a list of tasks
+      def list(opts = {})
+        PyBossa::API.many 'task', opts
+      end
+
+      # @param [Integer] id a task ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      # @return [Hash] a task
+      def get(id, opts = {})
+        PyBossa::API.retrieve 'task', id, opts
+      end
+
+      # Creates a task.
+      #
+      # @param [Hash] opts optional arguments
+      # @option opts [Integer] :app_id the app ID to which this object belongs
+      # @option opts [String] :state one of:
+      #   * "all": Default state
+      #   * "in_progress": A user is running the task
+      #   * "pending": The task is completed but requires validation
+      #   * "valid": The task is completed and valid
+      #   * "invalid": The task is completed and invalid
+      #   * "error": The task has an error
+      # @option opts [Integer] :quorum number of users who should do this task [not in use]
+      # @option opts [Boolean] :calibration whether this is a calibration task [not in use]
+      # @option opts [Float] :priority_0 between 0 (low) and 1 (high) [not in use]
+      # @option opts [Hash] :info all other task details
+      # @option opts [String] :api_key an API key
+      # @return [Hash] a task
+      #
+      # @see https://github.com/PyBossa/pybossa/blob/master/pybossa/model.py#L214
+      def create(opts = {})
+        if opts.has_key? :calibration
+          opts[:calibration] = opts[:calibration] ? 1 : 0
+        end
+        PyBossa::API.create 'task', opts
+      end
+
+      # Updates a task.
+      #
+      # @param [Integer] id a task ID
+      #
+      # @see PyBossa::Task#create
+      def update(id, opts = {})
+        if opts.has_key? :calibration
+          opts[:calibration] = opts[:calibration] ? 1 : 0
+        end
+        PyBossa::API.update 'task', id, opts
+      end
+
+      # Deletes a task.
+      #
+      # @param [Integer] id a task ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      def delete(id, opts = {})
+        PyBossa::API.destroy 'task', id, opts
+      end
+    end
+  end
+end

data/lib/pybossa-api/task_run.rb

@@ -0,0 +1,62 @@
+module PyBossa
+  class TaskRun
+    class << self
+      # @param [Hash] opts optional arguments
+      # @option opts [Integer] :limit number of results to return [default 20]
+      # @option opts [String] :api_key an API key
+      # @return [Array] a list of task runs
+      def list(opts = {})
+        PyBossa::API.many 'taskrun', opts
+      end
+
+      # @param [Integer] id a task run ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      # @return [Hash] a task run
+      def get(id, opts = {})
+        PyBossa::API.retrieve 'taskrun', id, opts
+      end
+
+      # Creates a task run.
+      #
+      # @param [Hash] opts optional arguments
+      # @option opts [Integer] :app_id the app ID to which this object belongs
+      # @option opts [Integer] :task_id the task ID to which this object belongs
+      # @option opts [Boolean] :timeout timeout for completing a task [not in use]
+      # @option opts [Boolean] :calibration whether this is a calibration task [not in use]
+      # @option opts [Hash] :info all other task run details
+      # @option opts [String] :api_key an API key
+      # @return [Hash] a task run
+      #
+      # @see https://github.com/PyBossa/pybossa/blob/master/pybossa/model.py#L261
+      # @see https://github.com/PyBossa/pybossa/blob/master/pybossa/api.py#L169
+      def create(opts = {})
+        if opts.has_key? :calibration
+          opts[:calibration] = opts[:calibration] ? 1 : 0
+        end
+        PyBossa::API.create 'taskrun', opts
+      end
+
+      # Updates a task run.
+      #
+      # @param [Integer] id a task run ID
+      #
+      # @see PyBossa::TaskRun#create
+      def update(id, opts = {})
+        if opts.has_key? :calibration
+          opts[:calibration] = opts[:calibration] ? 1 : 0
+        end
+        PyBossa::API.update 'taskrun', id, opts
+      end
+
+      # Deletes a task run.
+      #
+      # @param [Integer] id a task run ID
+      # @param [Hash] opts optional arguments
+      # @option opts [String] :api_key an API key
+      def delete(id, opts = {})
+        PyBossa::API.destroy 'taskrun', id, opts
+      end
+    end
+  end
+end

data/lib/pybossa-api/version.rb

@@ -0,0 +1,5 @@
+module PyBossa
+  class API
+    VERSION = "0.0.1"
+  end
+end

data/pybossa-api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pybossa-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pybossa-api"
+  s.version     = PyBossa::API::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Open North"]
+  s.email       = ["info@opennorth.ca"]
+  s.homepage    = "http://github.com/opennorth/pybossa-api-ruby"
+  s.summary     = %q{The PyBossa API Ruby Gem}
+  s.description = %q{A Ruby wrapper for the PyBossa API}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('yajl-ruby', '~> 1.0')
+  s.add_runtime_dependency('httparty', '~> 0.8.0')
+  s.add_runtime_dependency('sanitize', '~> 2.0.2')
+  s.add_development_dependency('rspec', '~> 2.10')
+  s.add_development_dependency('rake')
+end

data/spec/pybossa-api/app_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class PyBossa::App
+  describe PyBossa::App do
+    describe '#list' do
+      it 'should return a list of apps' do
+        response = PyBossa::App.list
+        response.each{|x| x.should have_key('name')}
+      end
+    end
+
+    describe '#get' do
+      it 'should get an app' do
+        response = PyBossa::App.get PyBossa::App.list.first['id']
+        response.should have_key('name')
+      end
+    end
+
+    describe '#create' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#update' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#delete' do
+      pending "Must use API key to test this method"
+    end
+  end
+end

data/spec/pybossa-api/task_run_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class PyBossa::TaskRun
+  describe PyBossa::TaskRun do
+    describe '#list' do
+      it 'should return a list of task runs' do
+        response = PyBossa::TaskRun.list
+        response.each{|x| x.should have_key('task_id')}
+      end
+    end
+
+    describe '#get' do
+      it 'should get an task run' do
+        response = PyBossa::TaskRun.get PyBossa::TaskRun.list.first['id']
+        response.should have_key('task_id')
+      end
+    end
+
+    describe '#create' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#update' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#delete' do
+      pending "Must use API key to test this method"
+    end
+  end
+end

data/spec/pybossa-api/task_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class PyBossa::Task
+  describe PyBossa::Task do
+    describe '#list' do
+      it 'should return a list of tasks' do
+        response = PyBossa::Task.list
+        response.each{|x| x.should have_key('state')}
+      end
+    end
+
+    describe '#get' do
+      it 'should get an task' do
+        response = PyBossa::Task.get PyBossa::Task.list.first['id']
+        response.should have_key('state')
+      end
+    end
+
+    describe '#create' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#update' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#delete' do
+      pending "Must use API key to test this method"
+    end
+  end
+end

data/spec/pybossa-api_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class PyBossa::API
+  # We don't want to test the PyBossa API. We just want to check that the
+  # wrapper works.
+  describe PyBossa::API do
+    EXAMPLE_SHORT_NAME = PyBossa::API.many('app').first['short_name']
+
+    describe '#many' do
+      it 'should return a non-empty array of hashes' do
+        response = PyBossa::API.many 'app'
+        response.should be_an(Array)
+        response.should have_at_least(1).item
+        response.each{|x| x.should be_a(Hash)}
+      end
+
+      it 'should respect the :limit argument' do
+        PyBossa::API.many('app', limit: 1).should have(1).item
+      end
+
+      it 'should respect a field argument' do
+        PyBossa::API.many('app', short_name: EXAMPLE_SHORT_NAME).find{|result|
+          result['short_name'] == EXAMPLE_SHORT_NAME
+        }.should_not be_nil
+      end
+    end
+
+    describe '#one' do
+      it 'should return a hash' do
+        PyBossa::API.one('app', PyBossa::API.many('app').first['id']).should be_a(Hash)
+      end
+    end
+
+    describe '#create' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#update' do
+      pending "Must use API key to test this method"
+    end
+
+    describe '#delete' do
+      pending "Must use API key to test this method"
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'rspec'
+require File.dirname(__FILE__) + '/../lib/pybossa-api'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: pybossa-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Open North
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70306081612580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306081612580
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70306081611700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306081611700
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: &70306081611140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70306081611140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70306081610460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70306081610460
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70306081629380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70306081629380
+description: A Ruby wrapper for the PyBossa API
+email:
+- info@opennorth.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- USAGE
+- lib/pybossa-api.rb
+- lib/pybossa-api/app.rb
+- lib/pybossa-api/task.rb
+- lib/pybossa-api/task_run.rb
+- lib/pybossa-api/version.rb
+- pybossa-api.gemspec
+- spec/pybossa-api/app_spec.rb
+- spec/pybossa-api/task_run_spec.rb
+- spec/pybossa-api/task_spec.rb
+- spec/pybossa-api_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/opennorth/pybossa-api-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: The PyBossa API Ruby Gem
+test_files:
+- spec/pybossa-api/app_spec.rb
+- spec/pybossa-api/task_run_spec.rb
+- spec/pybossa-api/task_spec.rb
+- spec/pybossa-api_spec.rb
+- spec/spec_helper.rb
+has_rdoc: