houdini-rails3 0.1.0 → 0.1.2

data/Gemfile

@@ -1,19 +1,16 @@
 source "http://rubygems.org"
 
-gem "rails", "3.0.0"
-gem "capybara", ">= 0.3.9"
-gem "sqlite3-ruby", :require => "sqlite3"
-
+gem "rails", "~>3.0.0"
 gem "tilt", "~> 1.1"
 
 if RUBY_VERSION < '1.9'
   gem "ruby-debug", ">= 0.10.3"
 end
 
-
-gem "rspec-rails", ">= 2.0.0.beta"
-
 group :development do
+  gem "rspec-rails", ">= 2.0.0.beta"
+  gem "capybara", ">= 0.3.9"
+  gem "sqlite3-ruby", :require => "sqlite3"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.0.pre3"
   gem "rcov", ">= 0"

data/Gemfile.lock

@@ -116,7 +116,7 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   capybara (>= 0.3.9)
   jeweler (~> 1.5.0.pre3)
-  rails (= 3.0.0)
+  rails (~> 3.0.0)
   rcov
   rspec-rails (>= 2.0.0.beta)
   ruby-debug (>= 0.10.3)

data/README.markdown

@@ -0,0 +1,71 @@
+# 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://houdinihq.com/documentation) for more info about the API.
+
+# Installation (Rails 2.3.x)
+
+Add the gem to your Gemfile
+
+    gem 'houdini-rails'
+
+Configure a few constants in config/application.rb
+
+    config.after_initialize do
+      ::Houdini::KEY = 'YOUR_API_KEY'
+      ::Houdini::HOST = 'houdinihq.com' # or 'houdini-sandbox.heroku.com' for testing
+      ::Houdini::RAILS_HOST = 'your_app_domain.com'
+    end
+
+You may want to configure the Houdini constants differently for each of you environments.
+
+# Example Usage
+
+Setup Houdini in your ActiveRecord model:
+
+    class Post < ActiveRecord::Base
+      include Houdini::Model
+
+      houdini :image_moderation,
+        :price => '0.01',
+        :title => 'Please moderate image',
+        :form_template => 'app/views/houdini_templates/post.html.erb',
+        :on_task_completion => :process_image_moderation_answer
+
+      after_create :moderate_image
+
+      def moderate_image
+        Houdini.perform!(:image_moderation, self)
+      end
+
+      def process_image_moderation_answer(params)
+        update_attribute(:flagged => params[:flagged])
+      end
+    end
+
+Create a template for the form to be sent to Mechanical Turk:
+
+    <!--app/views/houdini_templates/post.html.erb -->
+
+    <h2>Review the image for offensiveness</h2>
+
+    <h3>Instructions</h3>
+    <p>Please review the image below.</p>
+
+    <img src="<%= post.image_url %>"><br/>
+
+    <input type="radio" name="flagged" value="yes" class="required">
+      Yes, this picture is offensive
+    </input>
+
+    <input type="radio" name="flagged" value="no" class="required">
+      No, this picture is okay
+    </input>
+
+Post.houdini class method options:
+
+* :price - Amount in cents you want to pay for the task to be completed
+* :title - Title that Mechanical Turk workers will see when browsing/searching available tasks
+* :form_template - ERB or HAML template used to render the form html.
+* :on_task_completion - Method that Houdini should call when the answer is posted back to your app. The results of your form will be passed into the method as the only parameter. `{:flagged => 'yes'}` in the example above.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.2

data/houdini-rails3.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{houdini-rails3}
-  s.version = "0.1.0"
+  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-10-08}
+  s.date = %q{2010-10-22}
   s.description = %q{Rails 3 Engine for using the Houdini Mechanical Turk API}
   s.email = %q{chris@chrisconley.me}
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "app/controllers/houdini/postbacks_controller.rb",
@@ -105,12 +105,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, ["= 3.0.0"])
-      s.add_runtime_dependency(%q<capybara>, [">= 0.3.9"])
-      s.add_runtime_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
       s.add_runtime_dependency(%q<tilt>, ["~> 1.1"])
       s.add_runtime_dependency(%q<ruby-debug>, [">= 0.10.3"])
-      s.add_runtime_dependency(%q<rspec-rails>, [">= 2.0.0.beta"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 2.0.0.beta"])
+      s.add_development_dependency(%q<capybara>, [">= 0.3.9"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
@@ -120,12 +120,12 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<rails>, ["= 3.0.0"])
-      s.add_dependency(%q<capybara>, [">= 0.3.9"])
-      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<rails>, ["~> 3.0.0"])
       s.add_dependency(%q<tilt>, ["~> 1.1"])
       s.add_dependency(%q<ruby-debug>, [">= 0.10.3"])
       s.add_dependency(%q<rspec-rails>, [">= 2.0.0.beta"])
+      s.add_dependency(%q<capybara>, [">= 0.3.9"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
       s.add_dependency(%q<rcov>, [">= 0"])
@@ -136,12 +136,12 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rails>, ["= 3.0.0"])
-    s.add_dependency(%q<capybara>, [">= 0.3.9"])
-    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<rails>, ["~> 3.0.0"])
     s.add_dependency(%q<tilt>, ["~> 1.1"])
     s.add_dependency(%q<ruby-debug>, [">= 0.10.3"])
     s.add_dependency(%q<rspec-rails>, [">= 2.0.0.beta"])
+    s.add_dependency(%q<capybara>, [">= 0.3.9"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre3"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/lib/houdini_rails/model.rb

@@ -35,6 +35,7 @@ module Houdini
 
     def generate_form_html(template_path)
       template = Tilt.new(File.join(Rails.root.to_s, template_path))
+      # TODO: don't force the template name
       template.render(self, self.class.name.downcase.to_sym => self)
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: houdini-rails3
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Chris Conley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-08 00:00:00 -04:00
+date: 2010-10-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,7 @@ dependencies:
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 7
         segments: 
@@ -37,80 +37,80 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  name: capybara
+  name: tilt
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 13
         segments: 
-        - 0
-        - 3
-        - 9
-        version: 0.3.9
+        - 1
+        - 1
+        version: "1.1"
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  name: sqlite3-ruby
+  name: ruby-debug
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 49
         segments: 
         - 0
-        version: "0"
+        - 10
+        - 3
+        version: 0.10.3
   requirement: *id003
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   prerelease: false
-  name: tilt
+  name: rspec-rails
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 31098209
         segments: 
-        - 1
-        - 1
-        version: "1.1"
+        - 2
+        - 0
+        - 0
+        - beta
+        version: 2.0.0.beta
   requirement: *id004
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   prerelease: false
-  name: ruby-debug
+  name: capybara
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 49
+        hash: 1
         segments: 
         - 0
-        - 10
         - 3
-        version: 0.10.3
+        - 9
+        version: 0.3.9
   requirement: *id005
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  type: :development
   prerelease: false
-  name: rspec-rails
+  name: sqlite3-ruby
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31098209
+        hash: 3
         segments: 
-        - 2
-        - 0
         - 0
-        - beta
-        version: 2.0.0.beta
+        version: "0"
   requirement: *id006
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -247,7 +247,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
@@ -255,7 +255,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - app/controllers/houdini/postbacks_controller.rb

data/README.rdoc

@@ -1,3 +0,0 @@
-= HoudiniRails
-
-This project rocks and uses MIT-LICENSE.