Module: RTurk

Defined in:

lib/rturk/parsers/hit_parser.rb,
lib/rturk.rb,
lib/rturk/logger.rb,
lib/rturk/parser.rb,
lib/rturk/errors.rb,
lib/rturk/adapter.rb,
lib/rturk/operation.rb,
lib/rturk/requester.rb,
lib/rturk/adapters/hit.rb,
lib/rturk/adapters/worker.rb,
lib/rturk/parsers/response.rb,
lib/rturk/operations/get_hit.rb,
lib/rturk/adapters/assignment.rb,
lib/rturk/operations/create_hit.rb,
lib/rturk/parsers/answer_parser.rb,
lib/rturk/operations/extend_hit.rb,
lib/rturk/operations/search_hits.rb,
lib/rturk/operations/grant_bonus.rb,
lib/rturk/operations/dispose_hit.rb,
lib/rturk/operations/disable_hit.rb,
lib/rturk/operations/block_worker.rb,
lib/rturk/builders/question_builder.rb,
lib/rturk/parsers/assignment_parser.rb,
lib/rturk/operations/unblock_worker.rb,
lib/rturk/operations/notify_workers.rb,
lib/rturk/operations/force_expire_hit.rb,
lib/rturk/operations/reject_assignment.rb,
lib/rturk/operations/register_hit_type.rb,
lib/rturk/parsers/bonus_payment_parser.rb,
lib/rturk/parsers/qualification_parser.rb,
lib/rturk/operations/approve_assignment.rb,
lib/rturk/builders/notification_builder.rb,
lib/rturk/operations/get_bonus_payments.rb,
lib/rturk/builders/qualification_builder.rb,
lib/rturk/operations/get_account_balance.rb,
lib/rturk/operations/get_reviewable_hits.rb,
lib/rturk/operations/revoke_qualification.rb,
lib/rturk/builders/qualifications_builder.rb,
lib/rturk/operations/assign_qualification.rb,
lib/rturk/operations/get_qualification_type.rb,
lib/rturk/parsers/responses/get_hit_response.rb,
lib/rturk/operations/get_assignments_for_hit.rb,
lib/rturk/operations/create_qualification_type.rb,
lib/rturk/operations/update_qualification_type.rb,
lib/rturk/operations/set_hit_type_notification.rb,
lib/rturk/operations/dispose_qualification_type.rb,
lib/rturk/parsers/responses/create_hit_response.rb,
lib/rturk/parsers/responses/search_hits_response.rb,
lib/rturk/operations/send_test_event_notification.rb,
lib/rturk/parsers/responses/register_hit_type_response.rb,
lib/rturk/parsers/responses/get_bonus_payments_response.rb,
lib/rturk/parsers/responses/get_account_balance_response.rb,
lib/rturk/parsers/responses/get_reviewable_hits_response.rb,
lib/rturk/parsers/responses/get_qualification_type_response.rb,
lib/rturk/parsers/responses/get_assignments_for_hit_response.rb,
lib/rturk/operations/get_qualifications_for_qualification_type.rb,
lib/rturk/parsers/responses/get_qualifications_for_qualification_type_response.rb

Overview

Defined Under Namespace

Modules: Macros, Utilities, XMLUtilities Classes: Adapter, AnswerParser, ApproveAssignment, AssignQualification, Assignment, AssignmentParser, BlockWorker, BonusPaymentParser, CreateHIT, CreateHITResponse, CreateQualificationType, DisableHIT, DisposeHIT, DisposeQualificationType, ExtendHIT, ForceExpireHIT, GetAccountBalance, GetAccountBalanceResponse, GetAssignmentsForHIT, GetAssignmentsForHITResponse, GetBonusPayments, GetBonusPaymentsResponse, GetHIT, GetHITResponse, GetQualificationType, GetQualificationTypeResponse, GetQualificationsForQualificationType, GetQualificationsForQualificationTypeResponse, GetReviewableHITs, GetReviewableHITsResponse, GrantBonus, HITParser, Hit, InvalidRequest, Logger, MissingParameters, Notification, NotifyWorkers, Operation, Parser, Qualification, QualificationParser, Qualifications, Question, RTurkError, RegisterHITType, RegisterHITTypeResponse, RejectAssignment, Requester, Response, RevokeQualification, SearchHITs, SearchHITsResponse, SendTestEventNotification, SetHITTypeNotification, UnblockWorker, UpdateQualificationType, Worker

Constant Summary

SANDBOX =

'http://mechanicalturk.sandbox.amazonaws.com/'

PRODUCTION =

'http://mechanicalturk.amazonaws.com/'

API_VERSION =

'2008-08-02'

OLD_API_VERSION =

'2006-05-05'

Class Attribute Summary (collapse)

• + (Object) access_key readonly

  Returns the value of attribute access_key.

• + (Object) host readonly

  Returns the value of attribute host.

• + (Object) secret_key readonly

  Returns the value of attribute secret_key.

Class Method Summary (collapse)

• + (Object) ApproveAssignment(*args)
• + (Object) AssignQualification(*args)
• + (Object) BlockWorker(*args)
• + (Object) CreateHIT(*args, &blk)
• + (Object) CreateQualificationType(*args)
• + (Object) DisableHIT(*args, &blk)
• + (Object) DisposeHIT(*args, &blk)
• + (Object) DisposeQualificationType(*args)
• + (Object) ExtendHIT(*args, &blk)
• + (Object) ForceExpireHIT(*args, &blk)
• + (Object) GetAccountBalance
• + (Object) GetAssignmentsForHIT(*args, &blk)
• + (Object) GetBonusPayments(*args, &block)
• + (Object) GetHIT(*args, &blk)
• + (Object) GetQualificationsForQualificationType(*args)
• + (Object) GetQualificationType(*args)
• + (Object) GetReviewableHITs(*args, &blk)
• + (Object) GrantBonus(*args)
• + (Object) logger
• + (Object) Logger(*args)
• + (Object) NotifyWorkers(*args)
• + (Object) RegisterHITType(*args, &blk)
• + (Object) RejectAssignment(*args)
• + (Object) Request(*args)
• + (Object) RevokeQualification(*args)
• + (Boolean) sandbox?
• + (Object) SearchHITs
• + (Object) SendTestEventNotification(*args)
• + (Object) SetHITTypeNotification(*args)
• + (Object) setup(access_key, secret_key, opts = {})
• + (Object) UnblockWorker(*args)
• + (Object) UpdateQualificationType(*args)

10
11
12

# File 'lib/rturk.rb', line 10

def access_key
  @access_key
end

10
11
12

# File 'lib/rturk.rb', line 10

def host
  @host
end

10
11
12

# File 'lib/rturk.rb', line 10

def secret_key
  @secret_key
end

23
24
25

# File 'lib/rturk/operations/approve_assignment.rb', line 23

def self.ApproveAssignment(*args)
  RTurk::ApproveAssignment.create(*args)
end

15
16
17

# File 'lib/rturk/operations/assign_qualification.rb', line 15

def self.AssignQualification(*args)
  RTurk::AssignQualification.create(*args)
end

19
20
21

# File 'lib/rturk/operations/block_worker.rb', line 19

def self.BlockWorker(*args)
  RTurk::BlockWorker.create(*args)
end

50
51
52

# File 'lib/rturk/operations/create_hit.rb', line 50

def self.CreateHIT(*args, &blk)
  RTurk::CreateHIT.create(*args, &blk)
end

31
32
33

# File 'lib/rturk/operations/create_qualification_type.rb', line 31

def self.CreateQualificationType(*args)
  RTurk::CreateQualificationType.create(*args)
end

14
15
16

# File 'lib/rturk/operations/disable_hit.rb', line 14

def self.DisableHIT(*args, &blk)
  RTurk::DisableHIT.create(*args, &blk)
end

14
15
16

# File 'lib/rturk/operations/dispose_hit.rb', line 14

def self.DisposeHIT(*args, &blk)
  RTurk::DisposeHIT.create(*args, &blk)
end

13
14
15

# File 'lib/rturk/operations/dispose_qualification_type.rb', line 13

def self.DisposeQualificationType(*args)
  RTurk::DisposeQualificationType.create(*args)
end

19
20
21

# File 'lib/rturk/operations/extend_hit.rb', line 19

def self.ExtendHIT(*args, &blk)
  RTurk::ExtendHIT.create(*args, &blk)
end

13
14
15

# File 'lib/rturk/operations/force_expire_hit.rb', line 13

def self.ForceExpireHIT(*args, &blk)
  RTurk::ForceExpireHIT.create(*args, &blk)
end

9
10
11

# File 'lib/rturk/operations/get_account_balance.rb', line 9

def self.GetAccountBalance
  RTurk::GetAccountBalance.create
end

19
20
21

# File 'lib/rturk/operations/get_assignments_for_hit.rb', line 19

def self.GetAssignmentsForHIT(*args, &blk)
  RTurk::GetAssignmentsForHIT.create(*args, &blk)
end

23
24
25

# File 'lib/rturk/operations/get_bonus_payments.rb', line 23

def self.GetBonusPayments(*args, &block)
  RTurk::GetBonusPayments.create(*args, &block)
end

28
29
30

# File 'lib/rturk/operations/get_hit.rb', line 28

def self.GetHIT(*args, &blk)
  RTurk::GetHIT.create(*args, &blk)
end

23
24
25

# File 'lib/rturk/operations/get_qualifications_for_qualification_type.rb', line 23

def self.GetQualificationsForQualificationType(*args)
  RTurk::GetQualificationsForQualificationType.create(*args)
end

17
18
19

# File 'lib/rturk/operations/get_qualification_type.rb', line 17

def self.GetQualificationType(*args)
  RTurk::GetQualificationType.create(*args)
end

23
24
25

# File 'lib/rturk/operations/get_reviewable_hits.rb', line 23

def self.GetReviewableHITs(*args, &blk)
  RTurk::GetReviewableHITs.create(*args, &blk)
end

22
23
24

# File 'lib/rturk/operations/grant_bonus.rb', line 22

def self.GrantBonus(*args)
  RTurk::GrantBonus.create(*args)
end

22
23
24

# File 'lib/rturk.rb', line 22

def logger
  RTurk::Logger.logger
end

20
21
22

# File 'lib/rturk/logger.rb', line 20

def self.Logger(*args)
  RTurk::Logger.logger(*args)
end

36
37
38

# File 'lib/rturk/operations/notify_workers.rb', line 36

def self.NotifyWorkers(*args)
  RTurk::NotifyWorkers.create(*args)
end

61
62
63

# File 'lib/rturk/operations/register_hit_type.rb', line 61

def self.RegisterHITType(*args, &blk)
  RTurk::RegisterHITType.create(*args, &blk)
end

18
19
20

# File 'lib/rturk/operations/reject_assignment.rb', line 18

def self.RejectAssignment(*args)
  RTurk::RejectAssignment.create(*args)
end

82
83
84

# File 'lib/rturk/requester.rb', line 82

def self.Request(*args)
  RTurk::Requester.request(*args)
end

18
19
20

# File 'lib/rturk/operations/revoke_qualification.rb', line 18

def self.RevokeQualification(*args)
  RTurk::RevokeQualification.create(*args)
end

18
19
20

# File 'lib/rturk.rb', line 18

def sandbox?
  @host == SANDBOX
end

40
41
42

# File 'lib/rturk/operations/search_hits.rb', line 40

def self.SearchHITs
  RTurk::SearchHITs.create
end

14
15
16

# File 'lib/rturk/operations/send_test_event_notification.rb', line 14

def self.SendTestEventNotification(*args)
  RTurk::SendTestEventNotification.create(*args)
end

15
16
17

# File 'lib/rturk/operations/set_hit_type_notification.rb', line 15

def self.SetHITTypeNotification(*args)
  RTurk::SetHITTypeNotification.create(*args)
end

12
13
14
15
16

# File 'lib/rturk.rb', line 12

def setup(access_key, secret_key, opts ={})
  @access_key = access_key
  @secret_key = secret_key
  @host = opts[:sandbox] ? SANDBOX : PRODUCTION
end

19
20
21

# File 'lib/rturk/operations/unblock_worker.rb', line 19

def self.UnblockWorker(*args)
  RTurk::UnblockWorker.create(*args)
end

33
34
35

# File 'lib/rturk/operations/update_qualification_type.rb', line 33

def self.UpdateQualificationType(*args)
  RTurk::UpdateQualificationType.create(*args)
end