houdini 0.2.4 → 0.3.0

data/.gitignore

@@ -4,4 +4,6 @@ log/*.log
 pkg/
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
-spec/dummy/tmp/
+spec/dummy/tmp/
+*.swp
+*.swo

data/Gemfile.lock

@@ -1,115 +1,123 @@
 PATH
   remote: .
   specs:
-    houdini (0.2.4)
-      rails (~> 3.0.0)
+    houdini (0.3.0)
+      rails (> 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.5)
-      actionpack (= 3.0.5)
-      mail (~> 2.2.15)
-    actionpack (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.5)
-      activesupport (= 3.0.5)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-    activesupport (3.0.5)
-    arel (2.0.9)
-    builder (2.1.2)
-    capybara (0.4.1.2)
-      celerity (>= 0.7.9)
-      culerity (>= 0.2.4)
+    actionmailer (3.2.1)
+      actionpack (= 3.2.1)
+      mail (~> 2.4.0)
+    actionpack (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    capybara (1.1.2)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
-      selenium-webdriver (>= 0.0.27)
-      xpath (~> 0.1.3)
-    celerity (0.8.8)
-    childprocess (0.1.8)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.0)
       ffi (~> 1.0.6)
-    culerity (0.2.15)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    ffi (1.0.7)
-      rake (>= 0.8.7)
-    i18n (0.5.0)
-    json_pure (1.5.1)
-    mail (2.2.15)
-      activesupport (>= 2.3.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.0.11)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.1)
+    json (1.6.5)
+    mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    nokogiri (1.4.4)
-    polyglot (0.3.1)
-    rack (1.2.2)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.5)
-      actionmailer (= 3.0.5)
-      actionpack (= 3.0.5)
-      activerecord (= 3.0.5)
-      activeresource (= 3.0.5)
-      activesupport (= 3.0.5)
+    rails (3.2.1)
+      actionmailer (= 3.2.1)
+      actionpack (= 3.2.1)
+      activerecord (= 3.2.1)
+      activeresource (= 3.2.1)
+      activesupport (= 3.2.1)
       bundler (~> 1.0)
-      railties (= 3.0.5)
-    railties (3.0.5)
-      actionpack (= 3.0.5)
-      activesupport (= 3.0.5)
+      railties (= 3.2.1)
+    railties (3.2.1)
+      actionpack (= 3.2.1)
+      activesupport (= 3.2.1)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
-      thor (~> 0.14.4)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
     rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    rspec-rails (2.5.0)
-      actionpack (~> 3.0)
-      activesupport (~> 3.0)
-      railties (~> 3.0)
-      rspec (~> 2.5.0)
-    rubyzip (0.9.4)
-    selenium-webdriver (0.1.4)
-      childprocess (>= 0.1.7)
-      ffi (>= 1.0.7)
-      json_pure
+    rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
+    rubyzip (0.9.5)
+    selenium-webdriver (2.18.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0.9)
+      multi_json (~> 1.0.4)
       rubyzip
-    sqlite3 (1.3.3)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
     thor (0.14.6)
-    treetop (1.4.9)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.25)
-    xpath (0.1.3)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
       nokogiri (~> 1.3)
 
 PLATFORMS
@@ -118,5 +126,6 @@ PLATFORMS
 DEPENDENCIES
   capybara (>= 0.4.1)
   houdini!
-  rspec-rails (>= 2.5.0)
+  rake (~> 0.8.7)
+  rspec-rails (>= 2.8.1)
   sqlite3-ruby

data/README.markdown

@@ -4,56 +4,60 @@ This ruby gem is a Rails Engine for using the Houdini Mechanical Turk API. It pr
 
 Check out the [Houdini Documentation](http://houdiniapi.com/documentation) for more info about the API.
 
-# Installation (Rails 3.0.x)
+# Installation (Rails 3.x)
 
 Add the gem to your Gemfile
 
     gem 'houdini'
 
-Configure a few constants in config/application.rb
+Configure a few constants in config/initializers/houdini.rb
 
-    config.after_initialize do
-      Houdini.setup(:sandbox, :api_key => 'YOUR_API_KEY', :app_host => 'https://your-app-domain.com')
-    end
+    Houdini.setup :sandbox, :api_key => 'YOUR_API_KEY', :app_host => 'https://your-app-domain.com'
 
 You may want to configure Houdini differently for each of you environments.
 
 # Example Usage
 
-Create a task design at https://admin.houdiniapi.com
+Request a beta account at http://houdiniapi.com to gain access to the Houdini Blueprint Editor.
 
 Setup Houdini in your ActiveRecord model:
 
     class Post < ActiveRecord::Base
       include Houdini::Model
 
-      houdini :image_moderation, # short_name of task_design
-        :task_info => {
-          :image_url => "http://example.com/image12345.jpg"
+      houdini :image_moderation,
+        :input => {
+          :image_url => :image_url,                          # call the input_url method for
+          :image_caption => lambda{ self.caption.titleize }, # use a lambda, called in the model's context
+          :image_size => "100x100"                           # just send this string 
         },
-        :version => 1,
-        :after_submit => :update_houdini_attributes,
+        :on => :after_create,
         :on_task_completion => :process_image_moderation_answer
 
-      after_create :moderate_image
-
-      def moderate_image
-        Houdini.perform!(:image_moderation, self)
-      end
-
-      def update_houdini_attributes
-        update_attribute(:houdini_request_sent_at, Time.now)
-      end
-
       def process_image_moderation_answer(params)
-        update_attribute(:flagged => params[:category] == 'flagged')
+        update_attribute :flagged => params[:category] == 'flagged'
       end
     end
 
+# Usage
+
+`houdini(blueprint, options)`
+
+* `blueprint` - The name of the Houdini blueprint to use. Must be symbol or string.
+* `options` - Hash of options to use.
+
+## Options
+* `:input` - Rqeuired. Hash: any task specific info needed to populate your blueprint. Keys must match the blueprint's required input, and values must a `Symbol` of the method to call, a lambdas/procs to be called in the model's context, or just a value to send along.
+* `:on_task_completion` - Method that should be called when the answer is posted back to your app. Can by a symbol or a lambda/proc. The method will be called with a hash of the returned output from Houdini.
+* `:on` - Name of a callback to use in order to trigger the submission to Houdini. Must be a symbol/string. If you don't want to use a callback, call the model instance's `houdini_submit_#{blueprint}!` method, where `blueprint` is the first argument you provided for the `houdini` method.
+* `:after_submit` - Method that should be called after submitting the task to Houdini. Can by a symbol or a lambda/proc.
+* `:id_method` - Method to get an identifier for the object. It is `id` by default, but you may want to use `to_param` with your app. Can be a symbol or lambda/proc. Use this in conjunction with `:finder`.
+* `:finder` - Method by which to find the model by an identifier. It is `find` by default. Can be a symbol or lambda/proc.  Use this in conjunction with `:id_method`.
+
+## Credits
+
+* Thanks to Mike Nicholaides (https://github.com/nicholaides) for a huge refactoring to bring the gem up to date with the new version of Houdini.
 
-Post.houdini class method options:
+## License
 
-* :task_info - Any task specific info needed to populate your template you created when you created the task design.
-* :version - Version of the task design to use
-* :after_submit - Method that should be called after submitting the task to Houdini.
-* :on_task_completion - Method that should be called when the answer is posted back to your app.
+MIT License. Copyright 2012 Houdini Inc. http://houdiniapi.com

data/app/controllers/houdini/postbacks_controller.rb

@@ -1,12 +1,10 @@
 class Houdini::PostbacksController < ApplicationController
-  protect_from_forgery :except => [:create]
+  skip_before_filter :protect_from_forgery
+
   def create
-    object_class = params[:object_class].classify.constantize
-    object = object_class.find(params[:object_id])
-    if object.process_postback(params[:task_name], HashWithIndifferentAccess.new(ActiveSupport::JSON.decode(request.raw_post)))
-      render :json => {:success => true}
-    else
-      render :json => {:success => false}, :status => 422
-    end
+    task_results = HashWithIndifferentAccess.new ActiveSupport::JSON.decode(request.raw_post)
+
+    Houdini::PostbackProcessor.process params[:object_class], params[:object_id], task_results
+    render :json => { :success => true }
   end
-end
+end

data/config/routes.rb

@@ -1,8 +1,8 @@
 Rails.application.routes.draw do
-  scope "houdini/:object_class/:object_id/:task_name" do
+  scope "houdini/:object_class/:object_id" do
     resources :postbacks,
       :as => 'houdini_postbacks',
       :controller => 'houdini/postbacks',
       :only => [:create]
   end
-end
+end

data/houdini.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |s|
   s.description = %q{Rails 3 Engine for using the Houdini Mechanical Turk API}
   s.homepage = %q{http://github.com/chrisconley/houdini-gem}
 
-  s.add_runtime_dependency "rails", "~> 3.0.0"
-  s.add_development_dependency "rspec-rails", ">= 2.5.0"
+  s.add_runtime_dependency "rails", "> 3.0.0"
+  s.add_development_dependency "rspec-rails", ">= 2.8.1"
   s.add_development_dependency "capybara", ">= 0.4.1"
   s.add_development_dependency "sqlite3-ruby"
+  s.add_development_dependency "rake", "~> 0.8.7"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/houdini.rb

@@ -1,19 +1,15 @@
 require 'net/https'
 require 'uri'
 
-require 'houdini/base'
 require 'houdini/model'
 require 'houdini/task'
+require 'houdini/task_manager'
+require 'houdini/postback_processor'
 
 require 'houdini/engine'
 
-
 module Houdini
   mattr_accessor :environment, :api_key, :app_url, :app_uri, :app_host
-  # Convenience methods
-  def self.perform!(task_name, object)
-    object.send_to_houdini(task_name)
-  end
 
   def self.setup(environment, options)
     self.environment = environment.to_s
@@ -21,4 +17,36 @@ module Houdini
     self.app_url = options[:app_host] || options[:app_url]
     self.app_uri = URI.parse(self.app_url)
   end
-end
+
+  RequestError = Class.new(NameError)
+  HostError = Class.new(NameError)
+
+  HOST = 'v1.houdiniapi.com'
+
+  def self.submit!(blueprint, class_name, object_id, input_params)
+    unless environment.to_s == 'test'
+      request(
+        :environment  => environment,
+        :api_key      => api_key,
+        :blueprint    => blueprint,
+        :input        => input_params,
+        :postback_url => "#{app_uri.scheme}://#{app_uri.host}:#{app_uri.port}/houdini/#{class_name}/#{object_id}/postbacks"
+      )
+    end
+  end
+
+  def self.request(params)
+    # TODO: this should validate sooner
+    raise HostError, "Houdini.app_url should specify http:// or https://" unless app_url.match(/^https?\:\/\//)
+
+    url = File.join("https://", HOST, "tasks.json")
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    response, body = http.post(uri.path, params.to_json)
+    if response.code != "200"
+      raise RequestError, "The request to houdini failed with code #{response.code}: #{body}"
+    end
+  end
+end

data/lib/houdini/model.rb

@@ -1,62 +1,27 @@
 module Houdini
   module Model
-    # def self.included(base)
-    #   base.extend ClassMethods
-    #   base.include Rails.application.routes.url_helpers
-    # end
-
     extend ActiveSupport::Concern
 
-    included do
-      include Rails.application.routes.url_helpers
-      extend ClassMethods
-    end
-
     module ClassMethods
-      def houdini(name, options)
-        houdini_tasks[name.to_sym] = Houdini::Task.new(name.to_sym, options)
-      end
+      def houdini(blueprint, options={})
+        task_manager = options.delete(:task_manager) || TaskManager
+        callback = options.delete(:on)
 
-      def houdini_tasks
-        @houdini_tasks ||= {}
-      end
+        task_manager.register self, blueprint.to_sym, options
 
-    end
+        submit_method_name = "houdini_submit_#{blueprint}!".to_sym
 
-    def send_to_houdini(task_name)
-      houdini_task = self.class.houdini_tasks[task_name.to_sym]
-      params = {
-        :environment => Houdini.environment,
-        :api_key => Houdini.api_key,
-        :task_design => houdini_task.short_name,
-        :task_design_version => houdini_task.version,
-        :postback_url => houdini_postbacks_url(self.class.name, self.id, houdini_task.short_name, {
-          :protocol => Houdini.app_uri.scheme,
-          :host => Houdini.app_uri.host,
-          :port => Houdini.app_uri.port
-        })
-      }
+        # Using a module so that you can use override/modify the method via `super`
+        m = Module.new do
+          define_method submit_method_name do
+            task_manager.submit! self, blueprint
+          end
+        end
+        include m
 
-      params[:task_info] = houdini_task.task_info.inject({}) do |hash, (info_name, model_attribute)|
-        hash[info_name] = model_attribute
-        hash[info_name] = model_attribute.call if model_attribute.respond_to?(:call)
-        hash[info_name] = self.send(model_attribute) if self.respond_to?(model_attribute)
-        hash
+        # attach the submit method via the callback
+        send callback, submit_method_name if callback
       end
-
-      result = Houdini::Base.request(params)
-
-      call_after_submit(task_name)
-    end
-
-    def process_postback(task_name, answer)
-      houdini_task = self.class.houdini_tasks[task_name.to_sym]
-      self.send(houdini_task.on_task_completion, answer)
-    end
-
-    def call_after_submit(task_name)
-      houdini_task = self.class.houdini_tasks[task_name.to_sym]
-      self.send(houdini_task.after_submit) if houdini_task.after_submit
     end
   end
 end