kempelen 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +19 -0
  3. data/.travis.yml +4 -0
  4. data/CODE_OF_CONDUCT.md +22 -0
  5. data/Gemfile +5 -0
  6. data/Guardfile +42 -0
  7. data/LICENSE.txt +21 -0
  8. data/README.md +59 -0
  9. data/Rakefile +27 -0
  10. data/bin/console +14 -0
  11. data/bin/setup +7 -0
  12. data/examples/approve_assignment.rb +16 -0
  13. data/examples/create_hit.rb +20 -0
  14. data/examples/force_expire_hit.rb +16 -0
  15. data/examples/get_account_balance.rb +16 -0
  16. data/examples/get_assignments_for_hit.rb +16 -0
  17. data/examples/get_hit.rb +16 -0
  18. data/examples/get_reviewable_hits.rb +16 -0
  19. data/examples/reject_assignment.rb +16 -0
  20. data/examples/set_hit_as_reviewing.rb +16 -0
  21. data/kempelen.gemspec +35 -0
  22. data/lib/kempelen.rb +35 -0
  23. data/lib/kempelen/API/client.rb +45 -0
  24. data/lib/kempelen/API/common/answers.rb +34 -0
  25. data/lib/kempelen/API/common/assignment.rb +37 -0
  26. data/lib/kempelen/API/common/price.rb +26 -0
  27. data/lib/kempelen/API/common/question_form_answers.rb +57 -0
  28. data/lib/kempelen/API/operations/approve_assignment.rb +17 -0
  29. data/lib/kempelen/API/operations/assignment_operation.rb +36 -0
  30. data/lib/kempelen/API/operations/base.rb +71 -0
  31. data/lib/kempelen/API/operations/create_hit.rb +55 -0
  32. data/lib/kempelen/API/operations/force_expire_hit.rb +25 -0
  33. data/lib/kempelen/API/operations/get_account_balance.rb +30 -0
  34. data/lib/kempelen/API/operations/get_assignments_for_hit.rb +42 -0
  35. data/lib/kempelen/API/operations/get_hit.rb +25 -0
  36. data/lib/kempelen/API/operations/get_reviewable_hits.rb +64 -0
  37. data/lib/kempelen/API/operations/hit_operation.rb +23 -0
  38. data/lib/kempelen/API/operations/parameters.rb +40 -0
  39. data/lib/kempelen/API/operations/register_hit_type.rb +47 -0
  40. data/lib/kempelen/API/operations/reject_assignment.rb +17 -0
  41. data/lib/kempelen/API/operations/set_hit_as_reviewing.rb +34 -0
  42. data/lib/kempelen/API/responses/account_balance_response.rb +27 -0
  43. data/lib/kempelen/API/responses/base.rb +32 -0
  44. data/lib/kempelen/API/responses/empty_response.rb +17 -0
  45. data/lib/kempelen/API/responses/error_response.rb +32 -0
  46. data/lib/kempelen/API/responses/get_assignments_response.rb +31 -0
  47. data/lib/kempelen/API/responses/hit_response.rb +66 -0
  48. data/lib/kempelen/API/responses/reviewable_hits_response.rb +38 -0
  49. data/lib/kempelen/version.rb +3 -0
  50. metadata +260 -0
@@ -0,0 +1,31 @@
1
+ module Kempelen
2
+ module API
3
+ module Responses
4
+ class GetAssignmentsResponse < Base
5
+ attr_accessor :number_of_results
6
+ attr_accessor :page_number
7
+ attr_accessor :total_number_of_results
8
+ attr_accessor :assignment
9
+
10
+ def initialize(response)
11
+ super()
12
+
13
+ load_from_response(response)
14
+ end
15
+
16
+ def load_from_response(response)
17
+ super(response)
18
+
19
+ result = response["GetAssignmentsForHITResult"]
20
+ unless result.nil?
21
+ @number_of_results = result["NumResults"].to_i
22
+ @page_number = result["PageNumber"].to_i
23
+ @total_number_of_results = result["TotalNumResults"].to_i
24
+
25
+ @assignment = Kempelen::API::Common::Assignment.create_from_response(result["Assignment"])
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,66 @@
1
+ module Kempelen
2
+ module API
3
+ module Responses
4
+ # noinspection RubyTooManyInstanceVariablesInspection
5
+ class HitResponse < Base
6
+ attr_reader :hit_id
7
+ attr_reader :hit_type_id
8
+ attr_reader :hit_group_id
9
+ attr_reader :hit_layout_id
10
+ attr_reader :creation_time
11
+ attr_reader :expiration
12
+ attr_reader :hit_status
13
+ attr_reader :max_assignments
14
+ attr_reader :assignments_pending
15
+ attr_reader :assignments_available
16
+ attr_reader :assignments_completed
17
+ attr_reader :similar_hits
18
+ attr_reader :auto_approval_delay
19
+ attr_reader :lifetime
20
+ attr_reader :reward
21
+ attr_reader :title
22
+ attr_reader :description
23
+ attr_reader :keywords
24
+ attr_reader :question
25
+ attr_reader :requester_annotation
26
+ attr_reader :review_status
27
+ attr_reader :qualification_requirement
28
+
29
+ def initialize(response)
30
+ super()
31
+
32
+ load_from_response(response)
33
+ end
34
+
35
+ def load_from_response(response)
36
+ super(response)
37
+
38
+ hit_response = response["HIT"]
39
+ unless hit_response.nil?
40
+ @hit_id = hit_response["HITId"]
41
+ @hit_type_id = hit_response["HITTypeId"]
42
+ @hit_group_id = hit_response["HITGroupId"]
43
+ @hit_layout_id = hit_response["HITLayoutId"]
44
+ @creation_time = DateTime.parse(hit_response["CreationTime"]) rescue nil
45
+ @expiration = DateTime.parse(hit_response["Expiration"]) rescue nil
46
+ @hit_status = hit_response["HITStatus"]
47
+ @max_assignments = hit_response["MaxAssignments"].to_i
48
+ @assignments_pending = hit_response["NumberofAssignmentsPending"].to_i
49
+ @assignments_available = hit_response["NumberofAssignmentsAvailable"].to_i
50
+ @assignments_completed = hit_response["NumberofAssignmentsCompleted"].to_i
51
+ @similar_hits = hit_response["NumberOfSimilarHITs"].to_i
52
+ @auto_approval_delay = hit_response["AutoApprovalDelayInSeconds"].to_i
53
+ @lifetime = hit_response["LifetimeInSeconds"].to_i
54
+ @title = hit_response["Title"]
55
+ @description = hit_response["Description"]
56
+ @keywords = hit_response["Keywords"]
57
+ @question = hit_response["Question"]
58
+ @review_status = hit_response["HITReviewStatus"]
59
+ @requester_annotation = hit_response["RequesterAnnotation"]
60
+ end
61
+ end
62
+
63
+ end
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,38 @@
1
+ module Kempelen
2
+ module API
3
+ module Responses
4
+ class ReviewableHitsResponse < Base
5
+ attr_accessor :number_of_results
6
+ attr_accessor :page_number
7
+ attr_accessor :total_number_of_results
8
+ attr_accessor :hits
9
+
10
+ def initialize(response)
11
+ super()
12
+
13
+ @hits = []
14
+
15
+ load_from_response(response)
16
+ end
17
+
18
+ def load_from_response(response)
19
+ super(response)
20
+
21
+ hit_response = response["GetReviewableHITsResult"]
22
+ unless hit_response.nil?
23
+ @number_of_results = hit_response["NumResults"].to_i
24
+ @page_number = hit_response["PageNumber"].to_i
25
+ @total_number_of_results = hit_response["TotalNumResults"].to_i
26
+
27
+ hits_response = hit_response["HIT"]
28
+ unless hits_response.nil?
29
+ hits_response.each do |hit|
30
+ @hits << hit["HITId"] unless hit.nil? or !hit.is_a?(Hash)
31
+ end
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,3 @@
1
+ module Kempelen
2
+ VERSION = "1.0.0"
3
+ end
metadata ADDED
@@ -0,0 +1,260 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kempelen
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Brian Nelson
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-09-24 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: ruby-hmac
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.4.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.4.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: nori
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 2.6.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 2.6.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: httparty
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.13.6
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.13.6
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.9'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.9'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '10.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '10.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: minitest
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 5.8.0
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 5.8.0
97
+ - !ruby/object:Gem::Dependency
98
+ name: minitest-reporters
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 1.0.20
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 1.0.20
111
+ - !ruby/object:Gem::Dependency
112
+ name: pry
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: pry-byebug
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: guard
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ - !ruby/object:Gem::Dependency
154
+ name: guard-minitest
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: '0'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ - !ruby/object:Gem::Dependency
168
+ name: coveralls
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: '0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - ">="
179
+ - !ruby/object:Gem::Version
180
+ version: '0'
181
+ description: Modern Ruby integration with Amazon's Mechanical Turk.
182
+ email:
183
+ - brian@forefrontlabs.com
184
+ executables: []
185
+ extensions: []
186
+ extra_rdoc_files: []
187
+ files:
188
+ - ".gitignore"
189
+ - ".travis.yml"
190
+ - CODE_OF_CONDUCT.md
191
+ - Gemfile
192
+ - Guardfile
193
+ - LICENSE.txt
194
+ - README.md
195
+ - Rakefile
196
+ - bin/console
197
+ - bin/setup
198
+ - examples/approve_assignment.rb
199
+ - examples/create_hit.rb
200
+ - examples/force_expire_hit.rb
201
+ - examples/get_account_balance.rb
202
+ - examples/get_assignments_for_hit.rb
203
+ - examples/get_hit.rb
204
+ - examples/get_reviewable_hits.rb
205
+ - examples/reject_assignment.rb
206
+ - examples/set_hit_as_reviewing.rb
207
+ - kempelen.gemspec
208
+ - lib/kempelen.rb
209
+ - lib/kempelen/API/client.rb
210
+ - lib/kempelen/API/common/answers.rb
211
+ - lib/kempelen/API/common/assignment.rb
212
+ - lib/kempelen/API/common/price.rb
213
+ - lib/kempelen/API/common/question_form_answers.rb
214
+ - lib/kempelen/API/operations/approve_assignment.rb
215
+ - lib/kempelen/API/operations/assignment_operation.rb
216
+ - lib/kempelen/API/operations/base.rb
217
+ - lib/kempelen/API/operations/create_hit.rb
218
+ - lib/kempelen/API/operations/force_expire_hit.rb
219
+ - lib/kempelen/API/operations/get_account_balance.rb
220
+ - lib/kempelen/API/operations/get_assignments_for_hit.rb
221
+ - lib/kempelen/API/operations/get_hit.rb
222
+ - lib/kempelen/API/operations/get_reviewable_hits.rb
223
+ - lib/kempelen/API/operations/hit_operation.rb
224
+ - lib/kempelen/API/operations/parameters.rb
225
+ - lib/kempelen/API/operations/register_hit_type.rb
226
+ - lib/kempelen/API/operations/reject_assignment.rb
227
+ - lib/kempelen/API/operations/set_hit_as_reviewing.rb
228
+ - lib/kempelen/API/responses/account_balance_response.rb
229
+ - lib/kempelen/API/responses/base.rb
230
+ - lib/kempelen/API/responses/empty_response.rb
231
+ - lib/kempelen/API/responses/error_response.rb
232
+ - lib/kempelen/API/responses/get_assignments_response.rb
233
+ - lib/kempelen/API/responses/hit_response.rb
234
+ - lib/kempelen/API/responses/reviewable_hits_response.rb
235
+ - lib/kempelen/version.rb
236
+ homepage: https://github.com/forefrontlabs/kempelen
237
+ licenses:
238
+ - MIT
239
+ metadata: {}
240
+ post_install_message:
241
+ rdoc_options: []
242
+ require_paths:
243
+ - lib
244
+ required_ruby_version: !ruby/object:Gem::Requirement
245
+ requirements:
246
+ - - ">="
247
+ - !ruby/object:Gem::Version
248
+ version: '0'
249
+ required_rubygems_version: !ruby/object:Gem::Requirement
250
+ requirements:
251
+ - - ">="
252
+ - !ruby/object:Gem::Version
253
+ version: '0'
254
+ requirements: []
255
+ rubyforge_project:
256
+ rubygems_version: 2.4.8
257
+ signing_key:
258
+ specification_version: 4
259
+ summary: Ruby integration with Amazon's Mechanical Turk
260
+ test_files: []