hci 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+task :default => 'spec:unit'
+
+namespace :spec do
+  desc "Run unit specs"
+  RSpec::Core::RakeTask.new('unit') do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+end

data/hci.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hci/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hci"
+  s.version     = Hci::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sam Oliver"]
+  s.email       = ["sam@samoliver.com"]
+  s.homepage    = ""
+  s.summary     = %q{HCI client}
+  s.description = %q{HCI is a service and simple API for human intelligence tasks}
+
+  s.rubyforge_project = "hci"
+  
+  s.add_dependency "rest-client"
+  s.add_dependency "json"
+  s.add_development_dependency "rspec", ">= 1.2.9"
+  s.add_development_dependency "webmock"
+  
+  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"]
+end

data/lib/hci/client.rb

@@ -0,0 +1,34 @@
+module Hci
+  class Client
+  
+    @http_end_point = "http://hci.heroku.com"
+    @load_path = "hits"
+  
+    class << self
+      attr_accessor :api_key
+      attr_accessor :load_path
+      attr_accessor :http_end_point
+      attr_accessor :callback_host
+      attr_accessor :callback_path
+      
+      def version
+        Hci::VERSION
+      end
+    
+      def load!
+        Dir[File.join(load_path, "*.rb")].each do |file|
+          load file
+        end
+      end
+      
+      def callback_url
+        callback_host + '/' + callback_path
+      end
+      
+      def callback_path
+        "hci_hit_result"
+      end
+    end
+  
+  end
+end

data/lib/hci/end_point.rb

@@ -0,0 +1,34 @@
+module Hci
+  class EndPoint
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env["PATH_INFO"] =~ /^\/#{Client.callback_path}/
+        process_request(env)
+      else
+        @app.call(env)
+      end
+
+    end
+
+    private
+
+    def process_request(env)
+      req = Rack::Request.new(env)
+      body = JSON.parse(req.body.read)
+      puts "processing hit callback"
+      puts body.inspect
+      Hci::HitResult.new(body).process!
+    
+      [ 200,
+        { "Content-Type"   => "text/html",
+          "Content-Length" => "0" },
+        [""]  
+      ]
+    end
+
+  end
+end

data/lib/hci/exceptions.rb

@@ -0,0 +1,4 @@
+module Hci
+  class Error < RuntimeError; end
+  class ConfigurationError < Error; end
+end

data/lib/hci/frameworks/rails.rb

@@ -0,0 +1,4 @@
+Hci::Client.load_path = Rails.root + Hci::Client.load_path
+Rails.configuration.after_initialize do
+  Hci::Client.load!
+end

data/lib/hci/hit.rb

@@ -0,0 +1,86 @@
+module Hci
+  class Hit
+    
+    class << self
+    
+      attr_accessor :hits
+    
+      def hits
+        @hits ||= {}
+      end
+
+      def define(name, &block)
+        raise ConfigurationError, "Please set your Hci api key with Hci::Client.api_key = 'your-api-key-here'" unless Client.api_key
+        raise ConfigurationError, "Please set your callback URL with Hci::Client.callback_host = 'www.your-domain-name.com'" unless Client.callback_host
+        
+        hit = self.new
+        hit.name = name
+        yield hit
+        self.hits[name] = hit
+      end
+    
+      def request(name, resource_id)
+        @hits[name].request(resource_id)
+      end
+    
+      def find(name)
+        self.hits[name]
+      end
+    
+      def clear!
+        @hits = {}
+      end
+  
+    end
+  
+    attr_accessor :name
+    attr_accessor :directions
+    attr_accessor :image_url
+    attr_accessor :answer_options
+    attr_accessor :answer_type
+    attr_accessor :responses_required
+    attr_accessor :replace # whether hits with the same resource id and name should be overwritten
+
+    def replace
+      @replace ||= false
+    end
+  
+    def request(options)
+      hit_request = HitRequest.new(self, options)
+      hit_request.invoke
+    end
+  
+    def to_hash
+      {
+        :name=>name,
+        :directions => directions,
+        :image_url => image_url,
+        :answer_options => answer_options,
+        :responses_required => responses_required,
+        :answer_type => answer_type.to_s,
+        :callback_url => Client.callback_url,
+        :replace => replace
+      }
+    end
+  
+    # Callbacks
+  
+    def on_completion(&block)
+      @on_complete_proc = block
+    end
+  
+    def complete!(results)
+      @on_complete_proc.call(results) if @on_complete_proc
+    end
+  
+    def on_failure(&block)
+      @on_failure_proc = block
+    end
+  
+    def fail!(results)
+      @on_failure_proc.call(results) if @on_failure_proc
+    end
+  
+  
+  end
+end

data/lib/hci/hit_request.rb

@@ -0,0 +1,17 @@
+require 'rest_client'
+require 'json'
+module Hci
+  class HitRequest
+  
+    def initialize(hit, params)
+      @hit = hit
+      @params = params
+      @http_end_point = Client.http_end_point
+    end
+  
+    def invoke
+      RestClient.post("#{@http_end_point}/hits", {:hit=>@hit.to_hash.merge(@params).merge(:callback_url=>Client.callback_url), :api_key=>Client.api_key}.to_json, :content_type => :json, :accept => :json)
+    end
+  
+  end
+end

data/lib/hci/hit_response.rb

@@ -0,0 +1,17 @@
+module Hci
+  class HitResponse
+    
+    def self.create_collection_from_array(ary)
+      ary.collect {|r| HitResponse.new(r) }
+    end
+  
+    attr_accessor :answer, :callback_params, :username
+    
+    def initialize(params)
+      @answer = params['answer']
+      @callback_params = params['callback_params']
+      @username = params['username']
+    end
+  
+  end
+end

data/lib/hci/hit_result.rb

@@ -0,0 +1,32 @@
+module Hci
+  class HitResult
+   
+    attr_accessor :callback_params
+    attr_accessor :responses
+    attr_accessor :name
+    attr_accessor :status
+    
+    def initialize(params)
+      self.callback_params = params['callback_params']
+      self.responses = HitResponse.create_collection_from_array(params['responses'])
+      self.name = params['name']
+    end
+    
+    def answers
+      responses.map(&:answer).flatten
+    end
+    
+    def usernames
+      responses.map(&:username).flatten
+    end
+    
+    def process!
+      if hit = Hit.find(name)
+        hit.complete!(self)
+      else
+        raise "The hit #{name} could not be found"
+      end
+    end
+   
+  end
+end

data/lib/hci/version.rb

@@ -0,0 +1,4 @@
+module Hci
+  VERSION = "0.0.1"
+
+end

data/lib/hci.rb

@@ -0,0 +1,9 @@
+require 'hci/exceptions'
+require 'hci/client'
+require 'hci/version'
+require 'hci/hit'
+require 'hci/hit_request'
+require 'hci/hit_result'
+require 'hci/hit_response'
+require 'hci/end_point'
+require 'hci/frameworks/rails' if defined?(Rails)

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/hci_client_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Client" do
+  it "should load hits" do
+    Hci::Client.load_path = File.dirname(__FILE__) + '/hits'
+    Hci::Client.load!
+    
+    Hci::Hit.find("Approve photo").should_not == nil
+  end
+  
+  it "should return the current version number" do
+    Hci::Client.version.should == Hci::VERSION
+  end
+end
+
+

data/spec/hci_hit_request_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HitRequest" do
+  
+  it "should invoke a hit request" do
+    
+    hit = Hci::Hit.define "Approve photo" do |h|
+
+      h.directions = "Please classify this photo by choosing the appropriate tickboxes."
+      h.image_url = "http://www.google.com/logo.png"
+      h.answer_type = "tags"
+      h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
+      h.responses_required = 3
+      h.replace = false
+      
+      h.on_completion do |result|
+        puts "Complete"
+      end
+
+      h.on_failure do |result|
+        puts "Failed"
+      end
+
+    end
+    
+    hit_request = Hci::HitRequest.new(hit, :callback_params=>{:resource_id=>'1234'})
+    
+    stub_request(:post, "hci.heroku.com/hits")
+    hit_request.invoke
+    a_request(:post, "http://hci.heroku.com/hits").with(:body=>{'hit'=>
+      {
+        'name'=>"Approve photo",
+        'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
+        'image_url'=>"http://www.google.com/logo.png",
+        'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
+        'responses_required'=>3,
+        'answer_type'=>'tags',
+        'callback_url'=>"#{Hci::Client.callback_host}/hci_hit_result",
+        'callback_params'=>{'resource_id'=>'1234'},
+        'replace'=>false
+      }, :api_key=>'test-api-key'}).should have_been_made.once
+    
+  end
+  
+  it "should allow options to be overridden when making the request" do
+    
+    hit = Hci::Hit.define "Approve photo" do |h|
+
+      h.directions = "Please classify this photo by choosing the appropriate tickboxes."
+      h.image_url = "http://www.google.com/logo.png"
+      h.answer_type = "tags"
+      h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
+      h.responses_required = 3
+
+      h.on_completion do |result|
+        puts "Complete"
+      end
+
+      h.on_failure do |result|
+        puts "Failed"
+      end
+
+    end
+    
+    hit_request = Hci::HitRequest.new(hit, {:callback_params=>{:resource_id=>'1234'}, :image_url=>"http://www.example.com/image.jpg"})
+    
+    stub_request(:post, "hci.heroku.com/hits")
+    hit_request.invoke
+    a_request(:post, "http://hci.heroku.com/hits").with(:body=>{'hit'=>
+      {
+        'name'=>"Approve photo",
+        'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
+        'image_url'=>"http://www.example.com/image.jpg",
+        'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
+        'responses_required'=>3,
+        'answer_type'=>'tags',
+        'callback_url'=>"#{Hci::Client.callback_host}/hci_hit_result",
+        'callback_params'=>{'resource_id'=>'1234'},
+        'replace'=>false,
+      }, :api_key=>'test-api-key'}).should have_been_made.once
+  end
+  
+end
+
+

data/spec/hci_hit_response_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HitResponse" do
+  it "should create responses from an array" do
+    r = Hci::HitResponse.create_collection_from_array([{'answer'=>'answer 1'}, {'answer'=>'answer 2'}])
+    r[0].answer.should == "answer 1"
+    r[1].answer.should == "answer 2"
+  end
+  
+  it "should accept and store a username" do
+    r = Hci::HitResponse.create_collection_from_array([{'answer'=>'answer 1', 'username'=>'bilbo'}, {'answer'=>'answer 2', 'username'=>'frodo'}])
+    r[0].username.should == "bilbo"
+    r[1].username.should == "frodo"
+  end
+end

data/spec/hci_hit_result_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HitResult" do
+  
+  it "should invoke a hits complete callback" do
+    
+    resources = {}
+    resources['1'] = OpenStruct.new(:approved=>false)
+    resources['2'] = OpenStruct.new(:approved=>false)
+    resources['3'] = OpenStruct.new(:approved=>false)
+      
+    hit = Hci::Hit.define("Approve photo") do |h|
+      
+      h.on_completion do |result|
+        if result.responses.first.answer == 'yes'
+          resources[result.callback_params['resource_id']].approved = true
+        end
+      end
+      
+    end
+    
+    Hci::HitResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes'}], 'name'=>"Approve photo"}).process!
+    
+    resources['1'].approved.should == false
+    resources['2'].approved.should == true
+    resources['3'].approved.should == false
+    
+  end
+  
+  it "should collect the answers" do  
+    r = Hci::HitResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes'}, {'answer'=>'no'}, {'answer'=>'yes'}], 'name'=>"Approve photo"})
+    r.answers.should == ['yes', 'no', 'yes']
+  end
+  
+  it "should collect the usernames" do  
+    r = Hci::HitResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes', 'username'=>'bilbo'}, {'answer'=>'no', 'username'=>'frodo'}, {'answer'=>'yes', 'username'=>'sam'}], 'name'=>"Approve photo"})
+    r.usernames.should == ['bilbo', 'frodo', 'sam']
+  end
+  
+end

data/spec/hci_hit_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Hit" do
+  it "should define a hit" do
+    
+    Hci::Hit.define "Approve photo" do |h|
+      
+      h.directions = "Please classify this photo by choosing the appropriate tickboxes."
+      h.image_url = "http://www.google.com/logo.png"
+      h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
+      h.responses_required = 3
+
+      h.on_completion do |result|
+        puts "Complete"
+      end
+
+      h.on_failure do |result|
+        puts "Failed"
+      end
+
+    end
+    
+    Hci::Hit.hits.first[1].directions.should == "Please classify this photo by choosing the appropriate tickboxes."
+    
+  end
+  
+  it "should run a completion callback" do
+    
+    object = OpenStruct.new(:test=>nil)
+    
+    hit = Hci::Hit.define "Approve photo" do |h|
+      
+      h.on_completion do |result|
+        object.test = "Complete"
+      end
+      
+    end
+    
+    object.test.should == nil
+    hit.complete!({})
+    object.test.should == "Complete"
+  end
+  
+  it "should run a failure callback" do
+    
+    object = OpenStruct.new(:test=>nil)
+    
+    hit = Hci::Hit.define "Approve photo" do |h|
+      
+      h.on_failure do |result|
+        object.test = "Failed"
+      end
+      
+    end
+    
+    object.test.should == nil
+    hit.fail!({})
+    object.test.should == "Failed"
+  end
+  
+  it "should not raise an error if there is no callback defined" do
+    lambda {
+      hit = Hci::Hit.define("Approve photo") { }
+      hit.fail!({})
+    }.should_not raise_error
+  end
+  
+  it "should request a hit" do
+    
+    hit = Hci::Hit.define("Approve photo") { }
+    hit.should_receive(:request).with(:request_id=>'123')
+    Hci::Hit.request("Approve photo", :request_id=>'123')
+    
+  end
+  
+  it "should find a hit" do
+    Hci::Hit.define("Approve photo") { }
+    Hci::Hit.define("Check profile text") { }
+    Hci::Hit.define("Check content") { }
+    
+    
+    Hci::Hit.find("Check profile text").name.should == "Check profile text"
+    
+  end
+  
+  it "should raise a ConfigurationError if a callback host is not set" do
+    Hci::Client.callback_host = nil
+    lambda {
+      Hci::Hit.define("Approve photo") { }
+    }.should raise_error Hci::ConfigurationError
+  end
+  
+  it "should raise a ConfigurationError if an API key is not set" do
+    Hci::Client.api_key = nil
+    lambda {
+      Hci::Hit.define("Approve photo") { }
+    }.should raise_error Hci::ConfigurationError
+  end
+end
+
+

data/spec/hits/approve_photo.rb

@@ -0,0 +1,16 @@
+Hci::Hit.define "Approve photo" do |h|
+  
+  h.directions = "Please classify this photo by choosing the appropriate tickboxes."
+  h.image_url = "http://www.google.com/logo.png"
+  h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
+  h.responses_required = 3
+
+  h.on_completion do |result|
+    puts "Complete"
+  end
+
+  h.on_failure do |result|
+    puts "Failed"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hci'
+require 'rspec'
+require 'rspec/autorun'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.after :each do
+    Hci::Hit.clear!
+  end
+  
+  config.before :each do
+    Hci::Client.api_key = "test-api-key"
+    Hci::Client.callback_host = "www.example.com"
+  end
+end
+
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: hci
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sam Oliver
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-28 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: HCI is a service and simple API for human intelligence tasks
+email: 
+- sam@samoliver.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- hci.gemspec
+- lib/hci.rb
+- lib/hci/client.rb
+- lib/hci/end_point.rb
+- lib/hci/exceptions.rb
+- lib/hci/frameworks/rails.rb
+- lib/hci/hit.rb
+- lib/hci/hit_request.rb
+- lib/hci/hit_response.rb
+- lib/hci/hit_result.rb
+- lib/hci/version.rb
+- spec/.rspec
+- spec/hci_client_spec.rb
+- spec/hci_hit_request_spec.rb
+- spec/hci_hit_response_spec.rb
+- spec/hci_hit_result_spec.rb
+- spec/hci_hit_spec.rb
+- spec/hits/approve_photo.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+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: hci
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: HCI client
+test_files: 
+- spec/hci_client_spec.rb
+- spec/hci_hit_request_spec.rb
+- spec/hci_hit_response_spec.rb
+- spec/hci_hit_result_spec.rb
+- spec/hci_hit_spec.rb
+- spec/hits/approve_photo.rb
+- spec/spec_helper.rb