markpercival-rturk 1.0.1 → 1.0.2

data/README.markdown

@@ -17,6 +17,8 @@ You'd be better off with amazon's official library, in all its XML cruftiness.
 
 Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers can add some tags to items in your catalogue.
 
+### Creating HIT's
+
     require 'rturk'
 
     props = {:Title=>"Add tags to an item", 
@@ -39,6 +41,37 @@ Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers c
     page = RTurk::ExternalQuestionBuilder.build(
       "http://myapp.com/turkers/add_tags", :item_id => '1234')
     
-    # Turkers will be directed to http://myapp.com/turkers/add_tags?item_id=1234
+    # Turkers will be directed to http://myapp.com/turkers/add_tags?item_id=1234&AssignmentId=abcd12345
+
+    p @turk.create_hit(props, page)
+    
+### Reviewing HIT's
+
+    require 'rturk'
+    @turk = RTurk::Requester.new(AWSAccessKeyId, AWSAccessKey, :sandbox => true)
+
+    p @turk.getAssignmentsForHIT(:HITId => 'abcde1234567890')
+    
+## Nitty Gritty
+
+Here's a quick peak at what happens on the Mechanical Turk side.
+
+A worker takes a look at your hit. The page will contain an iframe with your external URL loaded inside of it.
+
+Amazon will append the AssignmentID parameter to the URL for your own information. In preview mode this will look like
+    http://myapp.com/turkers/add_tags?item_id=1234&AssignmentId=ASSIGNMENT_ID_NOT_AVAILABLE
+    
+If the Turker accepts the HIT, the page will reload and the iframe URL will resemble
+
+    http://myapp.com/turkers/add_tags?item_id=1234&AssignmentId=1234567890123456789ABC
+    
+The form in your page MUST CONTAIN the AssignmentID in a hidden input element. You could do this on the server side with a rails app, or on the client side with javascript(check the examples)
 
-    p @turk.create_hit(props, page)
+Anything submitted in this form will be sent to Amazon and saved for your review later.
+
+## More information
+
+Take a look at the [Amazon MTurk developer docs](http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMechanicalTurkRequester/) for more information. They have a complete list of API operations, all of which can be called with this library.
+
+    
+    

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: markpercival-rturk
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Mark Percival
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.12
     version: 
-description: Twitter API wrapper - super simple
+description: Mechanical Turk API wrapper - super simple
 email: mark@markpercival.us
 executables: []
 
@@ -42,7 +42,7 @@ extra_rdoc_files: []
 
 files: 
 - README.markdown
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/markpercival/rturk
 post_install_message: 
 rdoc_options: []
@@ -59,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.3"
   version: 
 requirements: []