mturk 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (78) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +0 -0
  3. data.tar.gz.sig +2 -0
  4. data/.gemtest +0 -0
  5. data/History.md +105 -0
  6. data/LICENSE.txt +202 -0
  7. data/Manifest.txt +72 -0
  8. data/NOTICE.txt +4 -0
  9. data/README.md +100 -0
  10. data/Rakefile +33 -0
  11. data/bin/mturk +9 -0
  12. data/lib/amazon/util.rb +10 -0
  13. data/lib/amazon/util/binder.rb +48 -0
  14. data/lib/amazon/util/data_reader.rb +169 -0
  15. data/lib/amazon/util/filter_chain.rb +79 -0
  16. data/lib/amazon/util/hash_nesting.rb +93 -0
  17. data/lib/amazon/util/lazy_results.rb +59 -0
  18. data/lib/amazon/util/logging.rb +23 -0
  19. data/lib/amazon/util/paginated_iterator.rb +70 -0
  20. data/lib/amazon/util/proactive_results.rb +116 -0
  21. data/lib/amazon/util/threadpool.rb +129 -0
  22. data/lib/amazon/util/user_data_store.rb +100 -0
  23. data/lib/amazon/webservices/mechanical_turk.rb +123 -0
  24. data/lib/amazon/webservices/mechanical_turk_requester.rb +285 -0
  25. data/lib/amazon/webservices/mturk/mechanical_turk_error_handler.rb +153 -0
  26. data/lib/amazon/webservices/mturk/question_generator.rb +58 -0
  27. data/lib/amazon/webservices/util/amazon_authentication_relay.rb +72 -0
  28. data/lib/amazon/webservices/util/command_line.rb +155 -0
  29. data/lib/amazon/webservices/util/convenience_wrapper.rb +90 -0
  30. data/lib/amazon/webservices/util/filter_proxy.rb +45 -0
  31. data/lib/amazon/webservices/util/mock_transport.rb +70 -0
  32. data/lib/amazon/webservices/util/request_signer.rb +42 -0
  33. data/lib/amazon/webservices/util/rest_transport.rb +120 -0
  34. data/lib/amazon/webservices/util/soap_simplifier.rb +48 -0
  35. data/lib/amazon/webservices/util/soap_transport.rb +20 -0
  36. data/lib/amazon/webservices/util/soap_transport_header_handler.rb +27 -0
  37. data/lib/amazon/webservices/util/unknown_result_exception.rb +27 -0
  38. data/lib/amazon/webservices/util/validation_exception.rb +55 -0
  39. data/lib/amazon/webservices/util/xml_simplifier.rb +61 -0
  40. data/lib/mturk.rb +19 -0
  41. data/lib/mturk/version.rb +6 -0
  42. data/run_rcov.sh +1 -0
  43. data/samples/best_image/BestImage.rb +61 -0
  44. data/samples/best_image/best_image.properties +39 -0
  45. data/samples/best_image/best_image.question +82 -0
  46. data/samples/blank_slate/BlankSlate.rb +63 -0
  47. data/samples/blank_slate/BlankSlate_multithreaded.rb +67 -0
  48. data/samples/helloworld/MTurkHelloWorld.rb +56 -0
  49. data/samples/helloworld/mturk.yml +8 -0
  50. data/samples/review_policy/ReviewPolicy.rb +139 -0
  51. data/samples/review_policy/review_policy.question +30 -0
  52. data/samples/reviewer/Reviewer.rb +103 -0
  53. data/samples/reviewer/mturk.yml +8 -0
  54. data/samples/simple_survey/SimpleSurvey.rb +98 -0
  55. data/samples/simple_survey/simple_survey.question +30 -0
  56. data/samples/site_category/SiteCategory.rb +87 -0
  57. data/samples/site_category/externalpage.htm +71 -0
  58. data/samples/site_category/site_category.input +6 -0
  59. data/samples/site_category/site_category.properties +56 -0
  60. data/samples/site_category/site_category.question +9 -0
  61. data/test/mturk/test_changehittypeofhit.rb +130 -0
  62. data/test/mturk/test_error_handler.rb +403 -0
  63. data/test/mturk/test_mechanical_turk_requester.rb +178 -0
  64. data/test/mturk/test_mock_mechanical_turk_requester.rb +205 -0
  65. data/test/test_mturk.rb +21 -0
  66. data/test/unit/test_binder.rb +89 -0
  67. data/test/unit/test_data_reader.rb +135 -0
  68. data/test/unit/test_exceptions.rb +32 -0
  69. data/test/unit/test_hash_nesting.rb +99 -0
  70. data/test/unit/test_lazy_results.rb +89 -0
  71. data/test/unit/test_mock_transport.rb +132 -0
  72. data/test/unit/test_paginated_iterator.rb +58 -0
  73. data/test/unit/test_proactive_results.rb +108 -0
  74. data/test/unit/test_question_generator.rb +55 -0
  75. data/test/unit/test_threadpool.rb +50 -0
  76. data/test/unit/test_user_data_store.rb +80 -0
  77. metadata +225 -0
  78. metadata.gz.sig +0 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2824ace506e32d3d0b6cba0806e4472e0c8a374f
4
+ data.tar.gz: 77f5276b908ee6eea5ab1557012a40bd0b054aee
5
+ SHA512:
6
+ metadata.gz: 9b8ed5e600b26db8465470a385ea4b09873c7c9aaa91fc8643347cddbac6c560b1b0a132dc240a4aaead75d35c463b35d179db59a73b37c441b47f6d6a39dad6
7
+ data.tar.gz: 43c7b5bf39c6a8e07037a3affd2cc75317cf6da84c1b175baa0d63aa3211ad5982532f4784ff0f6dc699fc5df6ccf29de24c8d4f0f54ed5c28c2fb3324276701
Binary file
@@ -0,0 +1,2 @@
1
+ �u+��n(��%IoU�sƆ��2m�m��戮y���)d��Ï���Y%�#��K �d�@�R4��Y#�PUu��~ �f�C�c'�t^Q
2
+ ��-B땞\^
File without changes
@@ -0,0 +1,105 @@
1
+ == 1.8.1 / 2015-02-16
2
+
3
+ === 1 minor update
4
+ * Fix namespacing in command line tool
5
+
6
+ == 1.8.0 / 2015-02-16
7
+
8
+ === 2 major enhancement
9
+ * New name!
10
+ * Update MechanicalTurk WSDL version to 2014-08-15
11
+
12
+ == 1 minor enhancement
13
+ * Update sample ExternalQuestion URLs to HTTPS
14
+
15
+ == 1.7.1 / 2014-10-20
16
+
17
+ === 1 minor update
18
+ * Correctly generate version.rb
19
+
20
+ == 1.7.0 / 2014-10-17
21
+
22
+ === 1 major enhancement
23
+ * Update MechanicalTurk WSDL version to 2013-11-15 (Qualification Requirement Set Comparators: In/NotIn/DoesNotExist)
24
+
25
+ === 4 minor updates
26
+ * Improve retriable error detection
27
+ * Add constants for new QualificationTypeIds
28
+ * Updates for Hoe and Ruby deprecations
29
+ * Rename markdown files w/ .md extension
30
+
31
+ == 1.6.0 / 2012-08-23
32
+
33
+ === 1 major enhancement
34
+ * Remove support for SOAP transport (will fallback to REST if SOAP is requested)
35
+
36
+ == 1.5.0 / 2012-03-28
37
+
38
+ === 1 major enhancement
39
+ * Update MechanicalTurk WSDL version to 2012-03-25 (getBlockedWorkers, getAssignment, approveRejectedAssignment)
40
+
41
+ === 1 minor enhancements
42
+ * Address unused variable warnings
43
+
44
+ == 1.4.0 / 2011-12-01
45
+
46
+ === 2 major enhancements
47
+ * Update MechanicalTurk WSDL version to 2011-10-01 (getReviewResultsForHIT, disposeQualificationType, getRequesterWorkerStatistic)
48
+ * Add Review Policy Sample Application
49
+
50
+ === 7 minor enhancements
51
+ * Switch from REXML to Nokogiri
52
+ * Add Rails configuration option
53
+ * Make MechanicalTurkErrorHandler more robust
54
+ * ErrorHandler will retry on AWS.ServiceUnavailable
55
+ * Fix XmlSimplifier to support negative numbers
56
+ * Improve robustness of MechanicalTurkRequester#createHITs
57
+ * Confirm before saving authentication information
58
+
59
+ == 1.3.1 / 2011-05-05
60
+
61
+ === 2 major enhancements
62
+ * Ruby 1.9 compatibility
63
+ * Add support for :UseSSL option (Default enabled for MechanicalTurk)
64
+
65
+ === 1 minor enhacement
66
+ * Upgrade to latest Hoe spec
67
+
68
+ == 1.2.0 / 2007-10-11
69
+
70
+ === 3 major enhancements
71
+ * Threading optimizations for bulk convenience operations:
72
+ createHITs, updateHITs, and getHITResults
73
+ * Paginated extension xxxAllProactive -- retrieves results proactively
74
+ via a threadpool
75
+ * Paginated extension xxxIterator -- hands back an iterator instead
76
+ of buffered results, for streaming large result sets
77
+
78
+ === 2 minor enhancements
79
+ * Enhanced test coverage
80
+ * Rest transport now default (previously SOAP)
81
+
82
+ == 1.1.1 / 2007-08-28
83
+
84
+ === 0 major enhancements
85
+
86
+ === 3 minor enhancements
87
+ * createHITs now supports MaxAssignments correctly
88
+ * Generate .zip file
89
+ * Documentation correction
90
+
91
+ == 1.1.0 / 2007-08-06
92
+
93
+ === 2 major enhancements
94
+ * Updated for Mechanical Turk's 2007-06-21 WSDL (updateHIT, blockWorker)
95
+ * Added enhanced error handling system with retry logic
96
+
97
+ == 3 minor enhancements
98
+ * Samples try to require rubygems
99
+ * BlankSlate now disposes hits with pending assignments (approves them)
100
+ * BlankSlate now aborts when it gets an Interrupt (CTRL-C)
101
+
102
+ == 1.0.0 / 2007-07-13
103
+
104
+ === 1 major enhancement
105
+ * Birthday!
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,72 @@
1
+ History.md
2
+ LICENSE.txt
3
+ Manifest.txt
4
+ NOTICE.txt
5
+ README.md
6
+ Rakefile
7
+ bin/mturk
8
+ lib/amazon/util.rb
9
+ lib/amazon/util/binder.rb
10
+ lib/amazon/util/data_reader.rb
11
+ lib/amazon/util/filter_chain.rb
12
+ lib/amazon/util/hash_nesting.rb
13
+ lib/amazon/util/lazy_results.rb
14
+ lib/amazon/util/logging.rb
15
+ lib/amazon/util/paginated_iterator.rb
16
+ lib/amazon/util/proactive_results.rb
17
+ lib/amazon/util/threadpool.rb
18
+ lib/amazon/util/user_data_store.rb
19
+ lib/amazon/webservices/mechanical_turk.rb
20
+ lib/amazon/webservices/mechanical_turk_requester.rb
21
+ lib/amazon/webservices/mturk/mechanical_turk_error_handler.rb
22
+ lib/amazon/webservices/mturk/question_generator.rb
23
+ lib/amazon/webservices/util/amazon_authentication_relay.rb
24
+ lib/amazon/webservices/util/command_line.rb
25
+ lib/amazon/webservices/util/convenience_wrapper.rb
26
+ lib/amazon/webservices/util/filter_proxy.rb
27
+ lib/amazon/webservices/util/mock_transport.rb
28
+ lib/amazon/webservices/util/request_signer.rb
29
+ lib/amazon/webservices/util/rest_transport.rb
30
+ lib/amazon/webservices/util/soap_simplifier.rb
31
+ lib/amazon/webservices/util/soap_transport.rb
32
+ lib/amazon/webservices/util/soap_transport_header_handler.rb
33
+ lib/amazon/webservices/util/unknown_result_exception.rb
34
+ lib/amazon/webservices/util/validation_exception.rb
35
+ lib/amazon/webservices/util/xml_simplifier.rb
36
+ lib/mturk.rb
37
+ lib/mturk/version.rb
38
+ run_rcov.sh
39
+ samples/best_image/BestImage.rb
40
+ samples/best_image/best_image.properties
41
+ samples/best_image/best_image.question
42
+ samples/blank_slate/BlankSlate.rb
43
+ samples/blank_slate/BlankSlate_multithreaded.rb
44
+ samples/helloworld/MTurkHelloWorld.rb
45
+ samples/helloworld/mturk.yml
46
+ samples/review_policy/ReviewPolicy.rb
47
+ samples/review_policy/review_policy.question
48
+ samples/reviewer/Reviewer.rb
49
+ samples/reviewer/mturk.yml
50
+ samples/simple_survey/SimpleSurvey.rb
51
+ samples/simple_survey/simple_survey.question
52
+ samples/site_category/SiteCategory.rb
53
+ samples/site_category/externalpage.htm
54
+ samples/site_category/site_category.input
55
+ samples/site_category/site_category.properties
56
+ samples/site_category/site_category.question
57
+ test/mturk/test_changehittypeofhit.rb
58
+ test/mturk/test_error_handler.rb
59
+ test/mturk/test_mechanical_turk_requester.rb
60
+ test/mturk/test_mock_mechanical_turk_requester.rb
61
+ test/test_mturk.rb
62
+ test/unit/test_binder.rb
63
+ test/unit/test_data_reader.rb
64
+ test/unit/test_exceptions.rb
65
+ test/unit/test_hash_nesting.rb
66
+ test/unit/test_lazy_results.rb
67
+ test/unit/test_mock_transport.rb
68
+ test/unit/test_paginated_iterator.rb
69
+ test/unit/test_proactive_results.rb
70
+ test/unit/test_question_generator.rb
71
+ test/unit/test_threadpool.rb
72
+ test/unit/test_user_data_store.rb
@@ -0,0 +1,4 @@
1
+ Mechanical Turk Ruby Libraries
2
+ Copyright 2007-2014 Amazon Technologies, Inc.
3
+
4
+ This product includes software developed by Amazon Technologies, Inc.
@@ -0,0 +1,100 @@
1
+ Mechanical Turk Ruby Libraries (mturk)
2
+
3
+ == Description
4
+
5
+ Mechanical Turk Ruby Libraries (mturk) is a set of libraries and tools
6
+ designed to make it easier for you to build solutions leveraging Amazon
7
+ Mechanical Turk. The goals of the libraries are:
8
+
9
+ * To abstract you from the "muck" of using web services
10
+ * To simplify using the Mechanical Turk APIs
11
+ * To allow you to focus more on solving the business problem
12
+ and less on managing technical details
13
+
14
+ == Usage
15
+
16
+ require 'mturk'
17
+ @mturk = Amazon::WebServices::MechanicalTurkRequester.new
18
+ puts "I have $#{@mturk.availableFunds} in Sandbox"
19
+ @mturk_prod = Amazon::WebServices::MechanicalTurkRequester.new :Host => :Production
20
+ puts "I have $#{@mturk_prod.availableFunds} in Production"
21
+
22
+ For more in-depth example code, check out the samples folder included in this
23
+ distribution.
24
+
25
+ == Prerequisites
26
+
27
+ To use the Libraries and successfully run the samples,
28
+ you must meet these prerequisites:
29
+
30
+ * You must have an Amazon Web Services (AWS) account. You can sign up at
31
+ the {AWS web site}[http://aws.amazon.com].
32
+ * You must have an Amazon Mechanical Turk Requester account.
33
+ Be sure to use the same e-mail address and password you used when creating
34
+ your Amazon Web Services account.
35
+ You can sign up at the {Requester web site}[http://requester.mturk.com].
36
+ * You must have Ruby 1.8.3 or later. You can download Ruby at the following
37
+ web site: http://www.ruby-lang.org.
38
+ * You must have RubyGems installed and configured correctly for your Ruby installation.
39
+ Review the installation instructions here[http://docs.rubygems.org].
40
+
41
+ (Note: If installing RubyGems for the first time, you may need to restart your console
42
+ to pick up environment changes. To execute code that is dependent on Ruby Gems, the
43
+ command to execute is: "ruby -rubygems program_that_uses_gems". The "-rubygems"
44
+ command line parameter should be a default parameter that is always included. To do this,
45
+ Ruby can utilize the "RUBYOPT" environment label that should be set to "RUBYOPT=-rubygems".
46
+ Please refer to documentation specific to your OS on defining environment labels.)
47
+
48
+ == Installation
49
+
50
+ 1. Execute the following command:
51
+ gem install mturk
52
+
53
+ (Note: Some Unix-based systems may require root access to install Ruby libraries. You
54
+ may need to execute the above command as the following:
55
+ sudo gem install
56
+ and enter in the password to successfully install the Gem)
57
+
58
+ 2. Installation of the mturk gem will prompt to install the following dependent gems
59
+ if not already installed:
60
+ * Hoe
61
+ * Highline
62
+
63
+ 3. (Optional) Download and expand the corresponding tarball/zip file from the project
64
+ homepage to an installation directory. This will
65
+ provide you access to the source files, test files and sample code.
66
+
67
+ 4. Configure the Libraries to use your Amazon Web Services authentication credentials by
68
+ executing the following command:
69
+ mturk
70
+
71
+ 5. Verify your installation by running the automated tests by executing the following
72
+ command in the installation path:
73
+ rake test
74
+
75
+ == Running Sample Applications
76
+
77
+ 1. Navigate to the samples directory of the installation path.
78
+ 2. Run the various samples
79
+
80
+ == Comments, Questions or Feedback
81
+
82
+ If you have any comments, questions, or feedback concerning the Mechanical
83
+ Turk service in general, please visit the {Amazon Mechanical Turk discussion
84
+ forums}[https://forums.aws.amazon.com/forum.jspa?forumID=11]
85
+
86
+ == License
87
+
88
+ Copyright (c) 2007-2015 Amazon Technologies, Inc.
89
+
90
+ Licensed under the Apache License, Version 2.0 (the "License");
91
+ you may not use this file except in compliance with the License.
92
+ You may obtain a copy of the License at
93
+
94
+ http://www.apache.org/licenses/LICENSE-2.0
95
+
96
+ Unless required by applicable law or agreed to in writing, software
97
+ distributed under the License is distributed on an "AS IS" BASIS,
98
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
99
+ See the License for the specific language governing permissions and
100
+ limitations under the License.