houdini 0.1.1

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+.rvmrc
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    houdini (0.1.1)
+      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)
+      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)
+      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)
+      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)
+      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)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    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)
+      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
+      rubyzip
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.25)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.1)
+  houdini!
+  rspec-rails (>= 2.5.0)
+  sqlite3-ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Conley
+
+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.markdown

@@ -0,0 +1,59 @@
+# Overview
+
+This ruby gem is a Rails Engine for using the Houdini Mechanical Turk API. It provides easy integration into your models and sets up the necessary controllers to receive answers posted back to your app from Houdini.
+
+Check out the [Houdini Documentation](http://houdiniapi.com/documentation) for more info about the API.
+
+# Installation (Rails 3.0.x)
+
+Add the gem to your Gemfile
+
+    gem 'houdini'
+
+Configure a few constants in config/application.rb
+
+    config.after_initialize do
+      Houdini.setup(:sandbox, :api_key => 'YOUR_API_KEY', :app_host => 'https://your-app-domain.com')
+    end
+
+You may want to configure Houdini differently for each of you environments.
+
+# Example Usage
+
+Create a task design at https://admin.houdiniapi.com
+
+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"
+        },
+        :version => 1,
+        :after_submit => :update_houdini_attributes,
+        :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')
+      end
+    end
+
+
+Post.houdini class method options:
+
+* :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.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "houdini-rails3 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/houdini/postbacks_controller.rb

@@ -0,0 +1,12 @@
+class Houdini::PostbacksController < ApplicationController
+  protect_from_forgery :except => [:create]
+  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
+  end
+end

data/config/routes.rb

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

data/houdini.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "houdini/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{houdini}
+  s.version = Houdini::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors = ["Chris Conley"]
+  s.email = %q{chris@houdiniapi.com}
+  s.summary = %q{Rails 3 Engine for using the Houdini Mechanical Turk API}
+  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_development_dependency "capybara", ">= 0.4.1"
+  s.add_development_dependency "sqlite3-ruby"
+
+  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/houdini/base.rb

@@ -0,0 +1,36 @@
+module Houdini
+  Undefined = Class.new(NameError)
+  RequestError = Class.new(NameError)
+  AuthenticationError = Class.new(NameError)
+  HostError = Class.new(NameError)
+
+  HOST = 'houdini2-staging.heroku.com'
+
+  class Base
+    def self.request(params)
+
+      puts "sending #{params.to_json} to houdini"
+      validate_config
+
+      url = File.join("https://", HOST, "tasks")
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      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
+
+      [response, body]
+    end
+
+    private
+
+    def self.validate_config
+      raise HostError, "Houdini.app_host should not include http://" if Houdini.app_host.match(/http/)
+    end
+  end
+
+
+end

data/lib/houdini/engine.rb

@@ -0,0 +1,4 @@
+module Houdini
+  class Engine < Rails::Engine
+  end
+end

data/lib/houdini/model.rb

@@ -0,0 +1,58 @@
+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_tasks
+        @houdini_tasks ||= {}
+      end
+
+    end
+
+    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, :host => Houdini.app_host)
+      }
+
+      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
+      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

data/lib/houdini/task.rb

@@ -0,0 +1,15 @@
+module Houdini
+  class Task
+    attr_accessor :short_name, :version, :task_info, :on, :if, :after_submit, :on_task_completion
+
+    def initialize(short_name, options)
+      @short_name = short_name.to_s
+      @version = options[:version]
+      @task_info = options[:task_info]
+      @on = options[:on] || :after_create
+      @if = options[:if] || true
+      @after_submit = options[:after_submit]
+      @on_task_completion = options[:on_task_completion] || :update_attributes
+    end
+  end
+end

data/lib/houdini/version.rb

@@ -0,0 +1,3 @@
+module Houdini
+  VERSION = "0.1.1"
+end

data/lib/houdini.rb

@@ -0,0 +1,23 @@
+require 'net/https'
+require 'uri'
+
+require 'houdini/base'
+require 'houdini/model'
+require 'houdini/task'
+
+require 'houdini/engine'
+
+
+module Houdini
+  mattr_accessor :environment, :api_key, :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
+    self.api_key = options[:api_key]
+    self.app_host = options[:app_host]
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/article.rb

@@ -0,0 +1,25 @@
+class Article < ActiveRecord::Base
+  include Houdini::Model
+
+  houdini :edit_for_grammar,
+    :version => 1,
+    :task_info => {
+      'original_text' => :original_text,
+    },
+    :after_submit => :update_houdini_attributes,
+    :on_task_completion => :process_houdini_edited_text
+
+  after_create :moderate_image, :if => :original_text
+
+  def moderate_image
+    Houdini.perform!(:edit_for_grammar, self)
+  end
+
+  def update_houdini_attributes
+    update_attribute(:houdini_request_sent_at, Time.now)
+  end
+
+  def process_houdini_edited_text(params)
+    update_attribute(:edited_text, params[:edited_text])
+  end
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,24 @@
+class Post < ActiveRecord::Base
+  include Houdini::Model
+
+  houdini :image_moderation,
+    :title => 'Moderate Image',
+    :form_template => 'app/views/posts/houdini_template.html.erb',
+    :after_submit => :update_houdini_attributes,
+    :on_task_completion => :process_image_moderation_answer,
+    :price => '0.01'
+
+  after_create :moderate_image, :if => :image_url
+
+  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[:flagged] == 'yes')
+  end
+end

data/spec/dummy/app/models/product_review.rb

@@ -0,0 +1,23 @@
+class ProductReview < ActiveRecord::Base
+  include Houdini::Model
+
+  houdini :text_classification,
+    :text => :original_text,
+    :api => "classification",
+    :after_submit => :update_houdini_attributes,
+    :on_task_completion => :process_image_moderation_answer
+
+  after_create :moderate_image, :if => :original_text
+
+  def moderate_image
+    Houdini.perform!(:text_classification, self)
+  end
+
+  def update_houdini_attributes
+    update_attribute(:houdini_request_sent_at, Time.now)
+  end
+
+  def process_image_moderation_answer(params)
+    update_attribute(:category, params[:category])
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/posts/houdini_template.html.erb

@@ -0,0 +1,6 @@
+<h2>Should this image be flagged?</h2>
+
+<img src="<%= post.image_url %>">
+
+<input type="radio" name="flagged" value="yes", class="required">Yes</input>
+<input type="radio" name="flagged" value="no", class="required">No</input>

data/spec/dummy/config/application.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "houdini"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    Houdini.setup(:sandbox,
+      :api_key => "wOVK7OFeRJVfmjqBk603",
+      :app_host => 'example.com'
+    )
+
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!