Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added contributors

  • Loading branch information...
commit 2d093c90fbbd8b01a066760f1917b206245b2a35 1 parent 6f9c061
Mark Percival authored
Showing with 19 additions and 13 deletions.
  1. +19 −13 README.markdown
View
32 README.markdown
@@ -11,7 +11,7 @@ If your integrating RTurk with a Rails app, do yourself a favor and check out [T
## Installation
gem install rturk
-
+
## Use
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.
@@ -29,9 +29,9 @@ Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers c
hit.reward = 0.05
hit.qualifications.add :approval_rate, { :gt => 80 }
end
-
+
p hit.url #=> 'https://workersandbox.mturk.com:443/mturk/preview?groupId=Q29J3XZQ1ASZH5YNKZDZ'
-
+
### Reviewing and Approving hits HIT's
hits = RTurk::Hit.all_reviewable
@@ -40,7 +40,7 @@ Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers c
unless hits.empty?
puts "Reviewing all assignments"
-
+
hits.each do |hit|
hit.assignments.each do |assignment|
puts assignment.answers['tags']
@@ -48,7 +48,7 @@ Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers c
end
end
end
-
+
### Wiping all your hits out
hits = RTurk::Hit.all_reviewable
@@ -57,7 +57,7 @@ Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers c
unless hits.empty?
puts "Approving all assignments and disposing of each hit!"
-
+
hits.each do |hit|
hit.expire!
hit.assignments.each do |assignment|
@@ -66,13 +66,13 @@ Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers c
hit.dispose!
end
end
-
-
+
+
### Logging
Want to see what's going on - enable logging.
RTurk::logger.level = Logger::DEBUG
-
+
## Nitty Gritty
Here's a quick peak at what happens on the Mechanical Turk side.
@@ -82,11 +82,11 @@ A worker takes a look at your hit. The page will contain an iframe with your que
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)
Anything submitted in this form will be sent to Amazon and saved for your review later.
@@ -95,5 +95,11 @@ Anything submitted in this form will be sent to Amazon and saved for your review
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.
-
-
+## Contributors
+[Zach Hale](http://github.com/zachhale)
+[David Balatero](http://github.com/dbalatero)
+[Rob Hanlon](http://github.com/ohwillie)
+[Haris Amin](http://github.com/hamin)
+[Tyler](http://github.com/tkieft)
+[David Dai](http://github.com/newtonsapple)
+
Please sign in to comment.
Something went wrong with that request. Please try again.