houdini-rails 0.1.5 → 0.1.6

data/Rakefile

@@ -20,12 +20,13 @@ 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.summary = %Q{Rails engine for interacting with the Houdini Mechanical Turk API}
+    gem.description = %Q{Rails engine 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"
+    gem.add_dependency "tilt", ">= 1.0.1"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/app/controllers/houdini/postbacks_controller.rb

@@ -1,8 +1,9 @@
 class Houdini::PostbacksController < ApplicationController
+  protect_from_forgery :except => [:create]
   def create
-    subject_class = params[:subject_class].classify.constantize
-    subject = subject_class.find(params[:subject_id])
-    if subject.process_postback(params[:answer])
+    object_class = params[:object_class].classify.constantize
+    object = object_class.find(params[:object_id])
+    if object.process_postback(request.request_parameters)
       render :json => {:success => true}
     else
       render :json => {:success => false}, :status => 422

data/config/routes.rb

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

data/houdini-rails.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{houdini-rails}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Conley"]
-  s.date = %q{2010-08-09}
-  s.description = %q{Rails plugin for interacting with the Houdini Mechanical Turk API}
+  s.date = %q{2010-08-16}
+  s.description = %q{Rails engine for interacting with the Houdini Mechanical Turk API}
   s.email = %q{chris@chrisconley.me}
   s.extra_rdoc_files = [
     "README"
@@ -31,12 +31,13 @@ Gem::Specification.new do |s|
      "rails/init.rb",
      "spec/controllers/houdini/postbacks_controller_spec.rb",
      "spec/integration/postbacks_test.rb",
+     "spec/lib/base_spec.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/app/views/posts/houdini_template.html.erb",
      "spec/rails_app/config/boot.rb",
      "spec/rails_app/config/database.yml",
      "spec/rails_app/config/environment.rb",
@@ -53,9 +54,6 @@ Gem::Specification.new do |s|
      "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",
@@ -87,10 +85,11 @@ Gem::Specification.new do |s|
   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.summary = %q{Rails engine for interacting with the Houdini Mechanical Turk API}
   s.test_files = [
     "spec/controllers/houdini/postbacks_controller_spec.rb",
      "spec/integration/postbacks_test.rb",
+     "spec/lib/base_spec.rb",
      "spec/rails_app/app/controllers/application_controller.rb",
      "spec/rails_app/app/helpers/application_helper.rb",
      "spec/rails_app/app/models/post.rb",
@@ -117,11 +116,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<spec>, [">= 1.3.0"])
+      s.add_runtime_dependency(%q<tilt>, [">= 1.0.1"])
     else
       s.add_dependency(%q<spec>, [">= 1.3.0"])
+      s.add_dependency(%q<tilt>, [">= 1.0.1"])
     end
   else
     s.add_dependency(%q<spec>, [">= 1.3.0"])
+    s.add_dependency(%q<tilt>, [">= 1.0.1"])
   end
 end
 

data/lib/houdini-rails.rb

@@ -1,6 +1,15 @@
 require 'net/http'
 require 'uri'
 
+require 'tilt'
+
 require 'houdini-rails/base'
 require 'houdini-rails/model'
-require 'houdini-rails/task'
+require 'houdini-rails/task'
+
+module Houdini
+  # Convenience method
+  def self.perform!(task_name, object)
+    object.send_to_houdini(task_name)
+  end
+end

data/lib/houdini-rails/base.rb

@@ -1,15 +1,21 @@
 module Houdini
-  class Base
-    Undefined = Class.new(NameError)
-    HoudiniRequestError = Class.new(NameError)
+  Undefined = Class.new(NameError)
+  RequestError = Class.new(NameError)
+  AuthenticationError = Class.new(NameError)
 
+  class Base
     def self.request(api, params)
       validate_constants
       return ["200", '{success:"true"}'] if HOST == 'test'
       url = URI.parse("http://#{HOST}/api/v0/#{api}/tasks/")
       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]
+
+      raise(AuthenticationError, "invalid api key") if response.code == '403'
+      if response.code != "200"
+        raise RequestError, "The request to houdini failed with code #{response.code}: #{body}"
+      end
+
+      [response, body]
     end
 
     private

data/lib/houdini-rails/model.rb

@@ -12,30 +12,30 @@ module Houdini
       end
     end
 
-    def send_to_houdini
+    def send_to_houdini(task_name)
+      # TODO: look up task when multiple tasks per model are implemented
       result = Houdini::Base.request(houdini_task.api,
         :api_key => Houdini::KEY,
-        :identifier => houdini_task.identifier,
+        :identifier => houdini_task.name,
         :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)
+
+      call_after_submit
     end
 
     def process_postback(answer)
-      self.send(houdini_task.on_postback, answer)
+      self.send(houdini_task.on_task_completion, answer)
     end
 
-    def call_on_submit(response, body)
-      self.send(houdini_task.on_submit, response, body) if houdini_task.on_submit
+    def call_after_submit
+      self.send(houdini_task.after_submit) if houdini_task.after_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)
+    def generate_form_html(template_path)
+      template = Tilt.new(File.join(RAILS_ROOT, template_path))
+      template.render(self, self.class.name.downcase.to_sym => self)
     end
   end
 end

data/lib/houdini-rails/task.rb

@@ -1,18 +1,17 @@
 module Houdini
   class Task
-    attr_accessor :name, :api, :on, :if, :identifier, :price, :title, :form_template, :on_submit, :on_postback
+    attr_accessor :name, :api, :on, :if, :price, :title, :form_template, :after_submit, :on_task_completion
 
     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
+      @after_submit = options[:after_submit]
+      @on_task_completion = options[:on_task_completion] || :update_attributes
     end
   end
 end

data/spec/controllers/houdini/postbacks_controller_spec.rb

@@ -6,22 +6,22 @@ end
 
 describe Houdini::PostbacksController do
   before do
-    @subject = mock_model(Foo)
-    Foo.stub!(:find).and_return(@subject)
-    @subject.stub!(:process_postback)
+    @object = mock_model(Foo)
+    Foo.stub!(:find).and_return(@object)
+    @object.stub!(:process_postback)
   end
   
   def do_post
-    post :create, :subject_class => 'foo', :subject_id => '1', :task_name => 'review_image'
+    post :create, :object_class => 'foo', :object_id => '1', :task_name => 'review_image'
   end
   
-  it "should find the subject" do
-    Foo.should_receive(:find).with("1").and_return(@subject)
+  it "should find the object" do
+    Foo.should_receive(:find).with("1").and_return(@object)
     do_post
   end
   
   it "should process the answer" do
-    @subject.should_receive(:process_postback)
+    @object.should_receive(:process_postback)
     do_post
   end
 end

data/spec/integration/postbacks_test.rb

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

data/spec/lib/base_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Houdini::Base do
+  it "should raise a Houdini::AuthenticationError" do
+    response = mock('Response')
+    response.stub!(:code).and_return('403')
+    Net::HTTP.stub!(:post_form).and_return([response, ''])
+
+    lambda { Houdini::Base.request('simple', {}) }.should raise_error(Houdini::AuthenticationError)
+  end
+
+  it "should raise a Houdini::RequestError" do
+    response = mock('Response')
+    response.stub!(:code).and_return('422')
+    Net::HTTP.stub!(:post_form).and_return([response, ''])
+
+    lambda { Houdini::Base.request('simple', {}) }.should raise_error(Houdini::RequestError)
+  end
+
+  it "should not raise a error" do
+    response = mock('Response')
+    response.stub!(:code).and_return('200')
+    Net::HTTP.stub!(:post_form).and_return([response, ''])
+
+    lambda { Houdini::Base.request('simple', {}) }.should_not raise_error()
+  end
+
+
+
+end

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

@@ -1,25 +1,24 @@
 class Post < ActiveRecord::Base
   include Houdini::Model
 
-  houdini :moderates_image,
-    :identifier => 'image_moderation',
+  houdini :image_moderation,
     :title => 'Moderate Image',
-    :form_template => File.join(RAILS_ROOT, 'app/views/posts/houdini_template.html.haml'),
-    :on_submit => :update_houdini_attributes,
-    :on_postback => :process_image_moderation_answer,
+    :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
-    send_to_houdini
+    Houdini.perform!(:image_moderation, self)
   end
 
-  def update_houdini_attributes(response, body)
+  def update_houdini_attributes
     update_attribute(:houdini_request_sent_at, Time.now)
   end
 
-  def process_image_moderation_answer(answer)
-    update_attribute(:flagged, true) if answer[:flagged] == 'yes'
+  def process_image_moderation_answer(params)
+    update_attribute(:flagged, true) if params[:flagged] == 'yes'
   end
 end

data/spec/rails_app/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/rails_app/config/environment.rb

@@ -13,7 +13,6 @@ class TestGemLocator < Rails::Plugin::Locator
 end
 
 Rails::Initializer.run do |config|
-  config.gem 'haml'
   config.time_zone = 'UTC'
   config.plugin_locators << TestGemLocator
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Chris Conley
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-09 00:00:00 -04:00
+date: 2010-08-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,7 +31,21 @@ dependencies:
         version: 1.3.0
   type: :development
   version_requirements: *id001
-description: Rails plugin for interacting with the Houdini Mechanical Turk API
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+description: Rails engine for interacting with the Houdini Mechanical Turk API
 email: chris@chrisconley.me
 executables: []
 
@@ -55,12 +69,13 @@ files:
 - rails/init.rb
 - spec/controllers/houdini/postbacks_controller_spec.rb
 - spec/integration/postbacks_test.rb
+- spec/lib/base_spec.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/app/views/posts/houdini_template.html.erb
 - spec/rails_app/config/boot.rb
 - spec/rails_app/config/database.yml
 - spec/rails_app/config/environment.rb
@@ -77,9 +92,6 @@ files:
 - 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
@@ -135,10 +147,11 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Rails plugin for interacting with the Houdini Mechanical Turk API
+summary: Rails engine for interacting with the Houdini Mechanical Turk API
 test_files: 
 - spec/controllers/houdini/postbacks_controller_spec.rb
 - spec/integration/postbacks_test.rb
+- spec/lib/base_spec.rb
 - spec/rails_app/app/controllers/application_controller.rb
 - spec/rails_app/app/helpers/application_helper.rb
 - spec/rails_app/app/models/post.rb

data/spec/rails_app/app/views/posts/houdini_template.html.haml

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