houdini-rails 0.1.2

data/.gitignore

@@ -0,0 +1,2 @@
+spec/rails_app/log/*.log
+pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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

@@ -0,0 +1,13 @@
+Houdini
+=======
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2010 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'spec/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => [:spec, :test]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "houdini-rails"
+    gem.summary = %Q{Rails plugin for interacting with the Houdini Mechanical Turk API}
+    gem.description = %Q{Rails plugin for interacting with the Houdini Mechanical Turk API}
+    gem.email = "chris@chrisconley.me"
+    gem.homepage = "http://github.com/chrisconley/houdini-rails"
+    gem.authors = ["Chris Conley"]
+    gem.add_development_dependency "spec", ">= 1.3.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/app/controllers/houdini/postbacks_controller.rb

@@ -0,0 +1,11 @@
+class Houdini::PostbacksController < ApplicationController
+  def create
+    subject_class = params[:subject_class].classify.constantize
+    subject = subject_class.find(params[:subject_id])
+    if subject.process_postback(params[:answer])
+      render :json => {:success => true}
+    else
+      render :json => {:success => false}, :status => 422
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :postbacks,
+    :name_prefix => 'houdini_',
+    :controller => 'houdini/postbacks',
+    :only => [:create],
+    :path_prefix => "houdini/:subject_class/:subject_id/:task_name" 
+end

data/houdini-rails.gemspec

@@ -0,0 +1,129 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{houdini-rails}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Conley"]
+  s.date = %q{2010-08-06}
+  s.description = %q{Rails plugin for interacting with the Houdini Mechanical Turk API}
+  s.email = %q{chris@chrisconley.me}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/houdini/postbacks_controller.rb",
+     "config/routes.rb",
+     "houdini-rails.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/houdini.rb",
+     "lib/houdini/base.rb",
+     "lib/houdini/model.rb",
+     "lib/houdini/task.rb",
+     "spec/controllers/houdini/postbacks_controller_spec.rb",
+     "spec/integration/postbacks_test.rb",
+     "spec/rails_app/README",
+     "spec/rails_app/Rakefile",
+     "spec/rails_app/app/controllers/application_controller.rb",
+     "spec/rails_app/app/helpers/application_helper.rb",
+     "spec/rails_app/app/models/post.rb",
+     "spec/rails_app/app/views/posts/houdini_template.html.haml",
+     "spec/rails_app/config/boot.rb",
+     "spec/rails_app/config/database.yml",
+     "spec/rails_app/config/environment.rb",
+     "spec/rails_app/config/environments/development.rb",
+     "spec/rails_app/config/environments/production.rb",
+     "spec/rails_app/config/environments/test.rb",
+     "spec/rails_app/config/initializers/backtrace_silencers.rb",
+     "spec/rails_app/config/initializers/inflections.rb",
+     "spec/rails_app/config/initializers/mime_types.rb",
+     "spec/rails_app/config/initializers/new_rails_defaults.rb",
+     "spec/rails_app/config/initializers/session_store.rb",
+     "spec/rails_app/config/locales/en.yml",
+     "spec/rails_app/config/routes.rb",
+     "spec/rails_app/db/migrate/20100517231810_create_posts.rb",
+     "spec/rails_app/db/seeds.rb",
+     "spec/rails_app/doc/README_FOR_APP",
+     "spec/rails_app/log/development.log",
+     "spec/rails_app/log/production.log",
+     "spec/rails_app/log/server.log",
+     "spec/rails_app/public/404.html",
+     "spec/rails_app/public/422.html",
+     "spec/rails_app/public/500.html",
+     "spec/rails_app/public/favicon.ico",
+     "spec/rails_app/public/images/rails.png",
+     "spec/rails_app/public/index.html",
+     "spec/rails_app/public/javascripts/application.js",
+     "spec/rails_app/public/javascripts/controls.js",
+     "spec/rails_app/public/javascripts/dragdrop.js",
+     "spec/rails_app/public/javascripts/effects.js",
+     "spec/rails_app/public/javascripts/prototype.js",
+     "spec/rails_app/public/robots.txt",
+     "spec/rails_app/script/about",
+     "spec/rails_app/script/console",
+     "spec/rails_app/script/dbconsole",
+     "spec/rails_app/script/destroy",
+     "spec/rails_app/script/generate",
+     "spec/rails_app/script/performance/benchmarker",
+     "spec/rails_app/script/performance/profiler",
+     "spec/rails_app/script/plugin",
+     "spec/rails_app/script/runner",
+     "spec/rails_app/script/server",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/test_helper.rb",
+     "tasks/houdini_tasks.rake",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/chrisconley/houdini-rails}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Rails plugin for interacting with the Houdini Mechanical Turk API}
+  s.test_files = [
+    "spec/controllers/houdini/postbacks_controller_spec.rb",
+     "spec/integration/postbacks_test.rb",
+     "spec/rails_app/app/controllers/application_controller.rb",
+     "spec/rails_app/app/helpers/application_helper.rb",
+     "spec/rails_app/app/models/post.rb",
+     "spec/rails_app/config/boot.rb",
+     "spec/rails_app/config/environment.rb",
+     "spec/rails_app/config/environments/development.rb",
+     "spec/rails_app/config/environments/production.rb",
+     "spec/rails_app/config/environments/test.rb",
+     "spec/rails_app/config/initializers/backtrace_silencers.rb",
+     "spec/rails_app/config/initializers/inflections.rb",
+     "spec/rails_app/config/initializers/mime_types.rb",
+     "spec/rails_app/config/initializers/new_rails_defaults.rb",
+     "spec/rails_app/config/initializers/session_store.rb",
+     "spec/rails_app/config/routes.rb",
+     "spec/rails_app/db/migrate/20100517231810_create_posts.rb",
+     "spec/rails_app/db/seeds.rb",
+     "spec/spec_helper.rb",
+     "spec/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<spec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<spec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<spec>, [">= 1.3.0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'houdini'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/houdini.rb

@@ -0,0 +1,6 @@
+require 'net/http'
+require 'uri'
+
+require 'houdini/base'
+require 'houdini/model'
+require 'houdini/task'

data/lib/houdini/base.rb

@@ -0,0 +1,26 @@
+module Houdini
+  class Base
+    Undefined = Class.new(NameError)
+    HoudiniRequestError = Class.new(NameError)
+
+    def self.request(api, params)
+      validate_constants
+      return ["200", '{success:"true"}'] if HOST == 'test'
+      url = URI.parse("http://#{HOST}/api/v0/#{api}/tasks/")
+      puts url.inspect
+      response, body = Net::HTTP.post_form(url, params)
+      raise HoudiniRequestError, "The request to houdini failed with code #{response.code}: #{body}" if response.code != "200"
+      [response.code, body]
+    end
+
+    private
+
+    def self.validate_constants
+      raise Undefined, "Houdini::KEY is not defined"  if Houdini::KEY.blank?
+      raise Undefined, "Houdini::HOST is not defined" if Houdini::HOST.blank?
+      raise Undefined, "Houdini::RAILS_HOST is not defined" if Houdini::RAILS_HOST.blank?
+    end
+  end
+
+
+end

data/lib/houdini/model.rb

@@ -0,0 +1,41 @@
+module Houdini
+  module Model
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def houdini(name, options)
+        include ActionController::UrlWriter
+        cattr_accessor :houdini_task
+        self.houdini_task = Houdini::Task.new(name, options)
+      end
+    end
+
+    def send_to_houdini
+      result = Houdini::Base.request(houdini_task.api,
+        :api_key => Houdini::KEY,
+        :identifier => houdini_task.identifier,
+        :price => houdini_task.price,
+        :title => houdini_task.title,
+        :form_html => generate_form_html(houdini_task.form_template),
+        :postback_url => houdini_postbacks_url(self.class.name, self.id, self.houdini_task.name, :host => Houdini::RAILS_HOST))
+      call_on_submit(*result)
+    end
+
+    def process_postback(answer)
+      self.send(houdini_task.on_postback, answer)
+    end
+
+    def call_on_submit(response, body)
+      self.send(houdini_task.on_submit, response, body) if houdini_task.on_submit
+    end
+
+    def generate_form_html(template)
+      #TODO: look into including Rails::Renderer
+      template = File.read(template)
+      haml_engine = Haml::Engine.new(template)
+      haml_engine.render(Object.new, self.class.name.underscore => self)
+    end
+  end
+end

data/lib/houdini/task.rb

@@ -0,0 +1,18 @@
+module Houdini
+  class Task
+    attr_accessor :name, :api, :on, :if, :identifier, :price, :title, :form_template, :on_submit, :on_postback
+
+    def initialize(name, options)
+      @name = name
+      @api = "simple" # options[:strategy]
+      @on = options[:on] || :after_create
+      @if = options[:if] || true
+      @identifier = options[:identifier] || name
+      @price = options[:price]
+      @title = options[:title]
+      @form_template = options[:form_template]
+      @on_submit = options[:on_submit]
+      @on_postback = options[:on_postback] || :update_attributes
+    end
+  end
+end

data/spec/controllers/houdini/postbacks_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+class Foo < ActiveRecord::Base
+  
+end
+
+describe Houdini::PostbacksController do
+  before do
+    @subject = mock_model(Foo)
+    Foo.stub!(:find).and_return(@subject)
+    @subject.stub!(:process_postback)
+  end
+  
+  def do_post
+    post :create, :subject_class => 'foo', :subject_id => '1', :task_name => 'review_image'
+  end
+  
+  it "should find the subject" do
+    Foo.should_receive(:find).with("1").and_return(@subject)
+    do_post
+  end
+  
+  it "should process the answer" do
+    @subject.should_receive(:process_postback)
+    do_post
+  end
+end

data/spec/integration/postbacks_test.rb

@@ -0,0 +1,11 @@
+require 'spec/test_helper'
+
+class PostbacksTest < ActionController::IntegrationTest
+  def test_should_do_something
+    post = Post.create(:image_url => 'http://google.com', :flagged => nil)
+    visit 'houdini/post/1/review_image/postbacks', :post, :answer => {:flagged => "yes"}
+    assert_response :success
+    assert_equal true, post.reload.flagged
+    assert_equal Time.now.to_date, post.houdini_request_sent_at.to_date
+  end
+end

data/spec/rails_app/README

@@ -0,0 +1,243 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.