get_humanoid 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Speakertext 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.rdoc

@@ -0,0 +1,57 @@
+== Humanoid REST API Wrapper for Ruby
+
+Welcome to Humanoid, the easiest way to get work done without the hassle of hiring and managing a workforce. Design a task, and we’ll send it to our 30,000+ person workforce. Our innovative software ensures that you receive quality results quickly and inexpensively.
+
+This Ruby gem wraps our simple REST API to make sending work and receiving results even easier.  For further details, you can read our {API documentation}[https://gethumanoid.com/v3/docs/tasks].
+
+== Getting Started
+
+First, you'll need to initialize an instance of the GetHumanoid class with your configuration details.  You can find your public and private key on your {account page}[https://gethumanoid.com/account].  For example:
+
+    config = {
+      'public_key'   => 'foo',
+      'private_key'  => 'bar,
+      'callback_url' => 'http://send.me/results,
+    }
+
+    client = GetHumanoid::Client.new(config)
+
+That's it!  Now you're ready to use Humanoid.
+
+If you're using Rails, you'll want to put this in an initializer and store your config in a standard rails config YAML file.  An example config/initializers/humanoid.rb might contain:
+
+    config = YAML.load_file("#{Rails.root}/config/humanoid.yml")[Rails.env]
+    
+    HUMANOID = GetHumanoid::Client.new(config)
+
+== Usage
+
+After creating a template on https://gethumanoid.com, you'll be able to send work and receive results via our API.  To fetch a list of your templates, simply call:
+
+    client.templates
+
+Now you're ready to send data to our workers.  Let's assume you want them to tag a set of two images.  Your data might look something like this:
+
+    resources = [
+      {
+        :identifier => 1,
+        :image_url  => 'http://images.com/foo',
+      },
+      {
+        :identifier => 2,
+        :image_url  => 'http://images.com/bar',
+      },
+    ]
+
+To create a task using your template, just call:
+
+    GetHumanoid::Task.create(
+      client,
+      template_id,
+      resources
+    )
+
+You can find the template ID on the {templates page}[https://gethumanoid.com/templates].  When your task is complete, Humanoid will POST your results to the callback URL specified in your initial config.  You can read further about this process over on our {API documentation}[https://gethumanoid.com/v3/docs/tasks].
+
+== Copyright
+Copyright (c) 2012 Speakertext, Inc.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/get_humanoid.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "get_humanoid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "get_humanoid"
+  s.version     = GetHumanoid::VERSION
+  s.authors     = ["Jason Snell"]
+  s.email       = ["jason@gethumanoid.com"]
+  s.homepage    = "https://gethumanoid.com"
+  s.summary     = %q{Official Humanoid Gem}
+  s.description = %q{Humanoid is an on-demand human workforce API}
+
+  s.rubyforge_project = "get_humanoid"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+
+  s.add_runtime_dependency "httparty"
+end

data/lib/get_humanoid.rb

@@ -0,0 +1,5 @@
+require "get_humanoid/version"
+require "get_humanoid/errors"
+require "get_humanoid/client"
+require "get_humanoid/task"
+require "get_humanoid/template"

data/lib/get_humanoid/client.rb

@@ -0,0 +1,75 @@
+require 'httparty'
+
+module GetHumanoid
+  class Client
+    include HTTParty
+
+    attr_reader :callback_url
+
+    format :json
+
+    class ResponseParser < HTTParty::Parser
+      SupportedFormats = {
+        'application/json'       => :json,
+        'text/json'              => :json,
+        'application/javascript' => :json,
+        'text/javascript'        => :json,
+      }
+
+      def parse
+        decoded_body = MultiJson.decode(body)
+
+        # Catch and raise errors as necessary
+        if decoded_body.is_a?(Hash) and decoded_body['error']
+          raise GetHumanoid::Error, decoded_body
+        end
+
+        return decoded_body
+      end
+    end
+
+    parser ResponseParser
+
+    def initialize(config)
+      @public_key   = config['public_key']
+      @private_key  = config['private_key']
+      @path         = config['path'] || 'https://gethumanoid.com/v3'
+      @callback_url = config['callback_url']
+
+      self.class.basic_auth @public_key, @private_key
+      self.class.base_uri @path
+    end
+
+    # Fetch a list of tasks
+    def tasks
+      return self.class.get('/tasks').parsed_response.map do |task|
+        Task.new(
+          task['task_id'],
+          task['template_id'],
+          task['status'],
+          task['started_at']
+        )
+      end
+    end
+
+    # Fetch a single task
+    def task(task_id)
+      task = self.class.get("/tasks/%s" % task_id).parsed_response
+
+      return Task.new(
+        task['task_id'],
+        task['template_id'],
+        task['status'],
+        task['started_at']
+      )
+    end
+
+    # Fetch a list of templates
+    def templates
+      return self.class.get('/templates').parsed_response.map do |template|
+        Template.new(template['template_id'], template['name'])
+      end
+    end
+
+  end
+end

data/lib/get_humanoid/errors.rb

@@ -0,0 +1,14 @@
+module GetHumanoid
+  class Error < StandardError
+    attr_reader :code, :status
+
+    def initialize(error)
+      # Pass the text message through, adding code and status
+      @code   = error['code']
+      @status = error['status']
+
+      super error['error']
+    end
+
+  end
+end

data/lib/get_humanoid/task.rb

@@ -0,0 +1,33 @@
+module GetHumanoid
+  class Task
+    attr_accessor :task_id, :template_id, :status, :started_at
+    
+    def initialize(task_id, template_id, status, started_at)
+      @task_id    = task_id
+      @template   = template_id
+      @status     = status
+      @started_at = started_at
+    end
+
+    # Send a batch of data to Humanoid.  See
+    # https://gethumanoid.com/v3/docs/tasks for details.
+    def self.create(client, template_id, resources, callback_url = nil, sandbox = false)
+      post_data = {
+        :template_id  => template_id,
+        :callback_url => callback_url || client.callback_url,
+        :resources    => resources,
+        :sandbox      => sandbox,
+      }
+
+      response = client.class.post('/tasks', :query => post_data).parsed_response
+
+      return Task.new(
+        response['task_id'],
+        response['template_id'],
+        response['status'],
+        response['started_at']
+      )
+    end
+
+  end
+end

data/lib/get_humanoid/template.rb

@@ -0,0 +1,15 @@
+module GetHumanoid
+  class Template
+    attr_accessor :template_id, :name
+
+    def initialize(template_id, name = nil)
+      @template_id = template_id
+      @name        = name
+    end
+
+    def create_task(client, resources, callback_url = nil, sandbox = false)
+      Task.create(client, @template_id, resources, callback_url = nil, sandbox = false)
+    end
+
+  end
+end

data/lib/get_humanoid/version.rb

@@ -0,0 +1,3 @@
+module GetHumanoid
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: get_humanoid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Snell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &9824480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9824480
+description: Humanoid is an on-demand human workforce API
+email:
+- jason@gethumanoid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- get_humanoid.gemspec
+- lib/get_humanoid.rb
+- lib/get_humanoid/client.rb
+- lib/get_humanoid/errors.rb
+- lib/get_humanoid/task.rb
+- lib/get_humanoid/template.rb
+- lib/get_humanoid/version.rb
+homepage: https://gethumanoid.com
+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: get_humanoid
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Official Humanoid Gem
+test_files: []