pybossa-api 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dca31965b81e141edf2e9a561480383d9cea36e2
+  data.tar.gz: 7c7e56826febfa2d691e99744d017e3c3e23ae71
+SHA512:
+  metadata.gz: 3d320a66d03db7522a2a106bb7860c2e069bf6040fbc2020996fbe293c85b0cb172efe17a4b93031f3e6830cf49a7323a2f60f1ed8d2896e36ec66ded441d5f9
+  data.tar.gz: 68c1d0173266e1df701b286819f7baac1275dbb2981a1edb3e6432d53f7b381d7c7701eea873f54e0553e8f2ddff1e4729fd89afe2bc840b450898012fe17b84

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
+  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/Gemfile

@@ -1,4 +1,9 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in scraperwiki-api.gemspec
+# Nokogiri 1.6.0 requires Ruby >= 1.9.2
+gem 'nokogiri', '~> 1.5.10'
+# Sanitize 2.0.4 requires Nokogiri >= 1.6.0 or Ruby >= 1.9.2
+gem 'sanitize', '2.0.3'
+
+# Specify your gem's dependencies in the gemspec
 gemspec

data/README.md

@@ -1,9 +1,12 @@
 # The PyBossa API Ruby Gem
 
-A Ruby wrapper for the PyBossa API.
+A Ruby wrapper for the [PyBossa](http://pybossa.com/) [API](http://docs.pybossa.com/en/latest/model.html).
 
+[![Gem Version](https://badge.fury.io/rb/pybossa-api.svg)](http://badge.fury.io/rb/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)
+[![Dependency Status](https://gemnasium.com/opennorth/pybossa-api-ruby.png)](https://gemnasium.com/opennorth/pybossa-api-ruby)
+[![Coverage Status](https://coveralls.io/repos/opennorth/pybossa-api-ruby/badge.png?branch=master)](https://coveralls.io/r/opennorth/pybossa-api-ruby)
+[![Code Climate](https://codeclimate.com/github/opennorth/pybossa-api-ruby.png)](https://codeclimate.com/github/opennorth/pybossa-api-ruby)
 
 ## Installation
 
@@ -22,7 +25,7 @@ A Ruby wrapper for the PyBossa API.
     >> PyBossa::App.get 128
     => {"info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...}
 
-    >> PyBossa::App.api_key = '21ec2020-3aea-1069-a2dd-08002b30309d'
+    >> PyBossa::API.api_key = '21ec2020-3aea-1069-a2dd-08002b30309d'
 
     >> app = PyBossa::App.create "info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...
     => {"info"=>{"task_presenter"=>"...", "thumbnail"=>"..."}, ...}
@@ -35,7 +38,7 @@ A Ruby wrapper for the PyBossa API.
 
 You can perform similar operations on `PyBossa::Task` and `PyBossa::TaskRun`.
 
-More documentation at [RubyDoc.info](http://rdoc.info/gems/pybossa-api/PyBossa/API).
+More documentation at [RubyDoc.info](http://rdoc.info/gems/pybossa-api/PyBossa).
 
 ## Bugs? Questions?
 

data/lib/pybossa-api.rb

@@ -1,19 +1,14 @@
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+require 'json'
 
 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'
+    base_uri 'crowdcrafting.org/api'
 
     class Error < StandardError; end
 
@@ -94,7 +89,7 @@ module PyBossa
         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'}
+          send http_method, path, :query => {:api_key => opts.delete(:api_key)}, :body => JSON.dump(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)
@@ -104,3 +99,7 @@ module PyBossa
     end
   end
 end
+
+require 'pybossa-api/app'
+require 'pybossa-api/task'
+require 'pybossa-api/task_run'

data/lib/pybossa-api/app.rb

@@ -1,5 +1,5 @@
 module PyBossa
-  class App
+  module App
     class << self
       # @param [Hash] opts optional arguments
       # @option opts [Integer] :limit number of results to return [default 20]

data/lib/pybossa-api/task.rb

@@ -1,5 +1,5 @@
 module PyBossa
-  class Task
+  module Task
     class << self
       # @param [Hash] opts optional arguments
       # @option opts [Integer] :limit number of results to return [default 20]

data/lib/pybossa-api/task_run.rb

@@ -1,5 +1,5 @@
 module PyBossa
-  class TaskRun
+  module TaskRun
     class << self
       # @param [Hash] opts optional arguments
       # @option opts [Integer] :limit number of results to return [default 20]

data/lib/pybossa-api/version.rb

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

data/pybossa-api.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "pybossa-api/version"
+require File.expand_path('../lib/pybossa-api/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "pybossa-api"
@@ -11,15 +10,16 @@ Gem::Specification.new do |s|
   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.license     = 'MIT'
 
   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_runtime_dependency('httparty', '~> 0.10.0')
+  s.add_runtime_dependency('sanitize', '~> 2.0.3')
+  s.add_development_dependency('rspec', '~> 3.1.0')
   s.add_development_dependency('rake')
+  s.add_development_dependency('coveralls')
 end

data/spec/pybossa-api/app_spec.rb

@@ -1,31 +1,29 @@
 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
+describe PyBossa::App do
+  describe '#list' do
+    it 'should return a list of apps' do
+      response = PyBossa::App.list
+      response.each{|x| expect(x).to 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
+  describe '#get' do
+    it 'should get an app' do
+      response = PyBossa::App.get PyBossa::App.list.last['id']
+      expect(response).to have_key('name')
     end
+  end
 
-    describe '#create' do
-      pending "Must use API key to test this method"
-    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 '#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
+  describe '#delete' do
+    pending "Must use API key to test this method"
   end
 end

data/spec/pybossa-api/task_run_spec.rb

@@ -1,31 +1,29 @@
 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
+describe PyBossa::TaskRun do
+  describe '#list' do
+    it 'should return a list of task runs' do
+      response = PyBossa::TaskRun.list
+      response.each{|x| expect(x).to 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
+  describe '#get' do
+    it 'should get an task run' do
+      response = PyBossa::TaskRun.get PyBossa::TaskRun.list.first['id']
+      expect(response).to have_key('task_id')
     end
+  end
 
-    describe '#create' do
-      pending "Must use API key to test this method"
-    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 '#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
+  describe '#delete' do
+    pending "Must use API key to test this method"
   end
 end

data/spec/pybossa-api/task_spec.rb

@@ -1,31 +1,29 @@
 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
+describe PyBossa::Task do
+  describe '#list' do
+    it 'should return a list of tasks' do
+      response = PyBossa::Task.list
+      response.each{|x| expect(x).to 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
+  describe '#get' do
+    it 'should get an task' do
+      response = PyBossa::Task.get PyBossa::Task.list.first['id']
+      expect(response).to have_key('state')
     end
+  end
 
-    describe '#create' do
-      pending "Must use API key to test this method"
-    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 '#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
+  describe '#delete' do
+    pending "Must use API key to test this method"
   end
 end

data/spec/pybossa-api_spec.rb

@@ -9,38 +9,38 @@ class PyBossa::API
     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)}
+        expect(response).to be_an(Array)
+        expect(response.size).to be >= 1
+        response.each{|x| expect(x).to be_a(Hash)}
       end
 
       it 'should respect the :limit argument' do
-        PyBossa::API.many('app', limit: 1).should have(1).item
+        expect(PyBossa::API.many('app', :limit => 1).size).to eq(1)
       end
 
       it 'should respect a field argument' do
-        PyBossa::API.many('app', short_name: EXAMPLE_SHORT_NAME).find{|result|
+        expect(PyBossa::API.many('app', :short_name => EXAMPLE_SHORT_NAME).find{|result|
           result['short_name'] == EXAMPLE_SHORT_NAME
-        }.should_not be_nil
+        }).to_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)
+        expect(PyBossa::API.retrieve('app', PyBossa::API.many('app').last['id'])).to be_a(Hash)
       end
     end
 
     describe '#create' do
-      pending "Must use API key to test this method"
+      pending "Must use API key. See http://about.travis-ci.org/docs/user/build-configuration/#Secure-environment-variables"
     end
 
     describe '#update' do
-      pending "Must use API key to test this method"
+      pending "Must use API key. See http://about.travis-ci.org/docs/user/build-configuration/#Secure-environment-variables"
     end
 
     describe '#delete' do
-      pending "Must use API key to test this method"
+      pending "Must use API key. See http://about.travis-ci.org/docs/user/build-configuration/#Secure-environment-variables"
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
 require 'rubygems'
+
+require 'coveralls'
+Coveralls.wear!
+
 require 'rspec'
 require File.dirname(__FILE__) + '/../lib/pybossa-api'

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: pybossa-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Open North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-18 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: &70306081612580 !ruby/object:Gem::Requirement
-    none: false
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70306081612580
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: &70306081611700 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70306081611700
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: sanitize
-  requirement: &70306081611140 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70306081611140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70306081610460 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 3.1.0
   type: :development
   prerelease: false
-  version_requirements: *70306081610460
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70306081629380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70306081629380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby wrapper for the PyBossa API
 email:
 - info@opennorth.ca
@@ -73,8 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -92,28 +107,28 @@ files:
 - spec/pybossa-api_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/opennorth/pybossa-api-ruby
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: The PyBossa API Ruby Gem
 test_files:
 - spec/pybossa-api/app_spec.rb