rturk 2.11.3 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8340134a49fa75d173bc34485ff52da8421200e
-  data.tar.gz: 928921b6345bda869c5f06825389d3979fefa71b
+  metadata.gz: 2a5d40c077e746e2315f00c8886519a0d8b59600
+  data.tar.gz: 3008275723e4f5afb357d0109f67330c74290592
 SHA512:
-  metadata.gz: 0d13326f34a04614d0053e70721f9a63b7a4a5c8f9ed76ad59cade6648f3b75e9feb282907b9c2a014f92b020dfd1aa6a5b50ddfeecd2175ad1e6d08f240e9d5
-  data.tar.gz: 91975acfb39692b1b39c334dc29b389eb588c8abb4ae12b1b4eeebc40f49b0551c10505a5b1bb674795908ceaa3e80a0824d120a1dc8c2ecd2369a8982401292
+  metadata.gz: 836fbf1a3465e727b7e18e69c10caee29811d1ad6837e277b5d1fa414d2c1718445e7cb28bb6e5e8058b555dd67fcd1bd48e6f3b9b797b30cbea0bad91a9ff04
+  data.tar.gz: 1eeaf3d566060f401da4b38bcbc8509837a9a38c047fa6d015cd1fad3f4f9a98c3788c73f2b5c9e7da42c1992f4e7e039c6cd5c4b15da6d9d3b885162c8bfd99

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+2.12.0
+---
+* Add UpdateQualificationsScore [#41] [eggie5]
+* Add GetQualificationScore [#42] [c0r0nel]
+* Add AnswerKey Builder [#42] [c0r0nel]
+
 2.11.3
 ---
 * Fix erroneous variable [#32] [george-xing]

data/lib/rturk/builders/answer_key_builder.rb

@@ -1,11 +1,20 @@
+require 'cgi'
+require 'uri'
 require "erector/xml_widget"
 
-# see http://docs.amazonwebservices.com/AWSMechTurk/2008-08-02/AWSMturkAPI/index.html?ApiReference_CreateQualificationTypeOperation.html
-class RTurk::AnswerKey < Erector::XMLWidget
+module RTurk
+  # see http://docs.amazonwebservices.com/AWSMechTurk/2008-08-02/AWSMturkAPI/index.html?ApiReference_CreateQualificationTypeOperation.html
+  class AnswerKey < Erector::XMLWidget
 
-  XMLNS = "http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/AnswerKey.xsd"
+    XMLNS = "http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/AnswerKey.xsd"
 
-  %w{
+    needs :xml => nil
+
+    def to_params
+      to_xml #create a new output string and call 'content' via Erector
+    end
+
+    %w{
   AnswerKey
     Question
       QuestionIdentifier
@@ -24,16 +33,26 @@ class RTurk::AnswerKey < Erector::XMLWidget
           InclusiveUpperBound
           QualificationValue
         OutOfRangeQualificationValue
-  }.uniq.each do |element_name|
-    tag element_name
-    tag element_name, :snake_case
-  end
+    }.uniq.each do |element_name|
+      tag element_name
+      tag element_name, :snake_case unless element_name =='Text'
+    end
 
-  def content
-    answer_key :xmlns => XMLNS do
-      answer_key_content
+    tag "Text", "text_element"  # very sticky since 'text' is a core Erector method
+
+    def content
+      if @xml and @xml.strip =~ /^<AnswerKey/
+        rawtext @xml
+      else
+        answer_key :xmlns => XMLNS do
+          answer_key_content
+        end
+      end
     end
-  end
 
+    def answer_key_content
+      rawtext @xml  # by default, use the parameter
+    end
+  end
 end
 

data/lib/rturk/operations/get_qualification_score.rb

@@ -0,0 +1,20 @@
+# Operation to get info about qualification score
+
+module RTurk
+  class GetQualificationScore < Operation
+    attr_accessor :qualification_type_id, :subject_id
+    require_params :qualification_type_id, :subject_id
+
+    def parse(xml)
+      RTurk::GetQualificationScoreResponse.new(xml)
+    end
+
+    def to_params
+      {'QualificationTypeId' => qualification_type_id, 'SubjectId' => subject_id}
+    end
+  end
+
+  def self.GetQualificationScore(*args)
+    RTurk::GetQualificationScore.create(*args)
+  end
+end

data/lib/rturk/operations/update_qualification_score.rb

@@ -0,0 +1,26 @@
+# Operation to update a qualification score
+# http://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_UpdateQualificationScoreOperation.html
+
+module RTurk
+  class UpdateQualificationScore < Operation
+    attr_accessor :qualification_type_id, :qualification_type_score, :subject_id, :integer_value
+    require_params :qualification_type_id, :subject_id, :integer_value
+
+    def parse(xml)
+      RTurk::GetQualificationScoreResponse.new(xml)
+    end
+
+    def to_params
+      params = {
+        'QualificationTypeId' => qualification_type_id,
+        'SubjectId' => subject_id,
+        'IntegerValue'=> integer_value
+      }
+    end
+  end
+
+  def self.UpdateQualificationScore(*args)
+    RTurk::UpdateQualificationScore.create(*args)
+  end
+end
+

data/lib/rturk/parsers/responses/get_qualification_score_response.rb

@@ -0,0 +1,28 @@
+# Parses the GetQualificationType Response
+#
+#  <GetQualificationScoreResult>
+#    <Qualification>
+#      <QualificationTypeId>789RVWYBAZW00EXAMPLE</QualificationTypeId>
+#      <SubjectId>AZ3456EXAMPLE</SubjectId>
+#      <GrantTime>2005-01-31T23:59:59Z</GrantTime>
+#      <IntegerValue>95</IntegerValue>
+#    </Qualification>
+#  </GetQualificationScoreResult>
+
+module RTurk
+  class GetQualificationScoreResponse < Response
+    attr_reader :qualification_type_id, :grant_time, :subject_id, :integer_value
+
+    def initialize(response)
+      @raw_xml = response.body
+      @xml = Nokogiri::XML(@raw_xml)
+      map_content(@xml.xpath('//Qualification'),
+        :qualification_type_id => 'QualificationTypeId',
+        :subject_id => 'SubjectId',
+        :grant_time => 'GrantTime',
+        :integer_value => 'IntegerValue'
+      )
+
+    end
+  end
+end

data/lib/rturk/parsers/responses/get_qualifications_for_qualification_type_response.rb

@@ -16,7 +16,7 @@ module RTurk
     end
 
     def qualifications
-      @qualifications ||= []
+      @qualifications = []
       @xml.xpath('//Qualification').each do |qualification_xml|
         @qualifications << QualificationParser.new(qualification_xml)
       end

data/lib/rturk/parsers/responses/update_qualification_score_response.rb

@@ -0,0 +1,14 @@
+# Parses the GetQualificationType Response
+
+module RTurk
+  class UpdateQualificationScoreResponse < Response
+    attr_reader :is_valid
+
+    def initialize(response)
+      @raw_xml = response.body
+      @xml = Nokogiri::XML(@raw_xml)
+      raise_errors
+      map_content(@xml.xpath('//QualificationScore'), :is_valid => 'IsValid')
+    end
+  end
+end

data/lib/rturk/version.rb

@@ -1,3 +1,3 @@
 module RTurk
-  VERSION = "2.11.3"
+  VERSION = "2.12.0"
 end

data/spec/fake_responses/get_qualification_score.xml

@@ -0,0 +1,8 @@
+<GetQualificationScoreResult>
+  <Qualification>
+    <QualificationTypeId>789RVWYBAZW00EXAMPLE</QualificationTypeId>
+    <SubjectId>AZ3456EXAMPLE</SubjectId>
+    <GrantTime>2005-01-31T23:59:59Z</GrantTime>
+    <IntegerValue>95</IntegerValue>
+  </Qualification>
+</GetQualificationScoreResult>

data/spec/fake_responses/update_qualification_score.xml

@@ -0,0 +1,6 @@
+<UpdateQualificationScoreResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</UpdateQualificationScoreResult>
+

data/spec/operations/get_qualification_score_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::GetQualificationScore do
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('get_qualification_score', :operation => 'GetQualificationScore')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::GetQualificationScore()}.should raise_error RTurk::MissingParameters
+  end
+
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'GetQualificationScore'))
+    RTurk::GetQualificationScore(:qualification_type_id => '789RVWYBAZW00EXAMPLE',
+                                  :subject_id => "ABCDEF1234") rescue RTurk::InvalidRequest
+  end
+
+  it "should parse and return the result" do
+    RTurk::GetQualificationScore(:qualification_type_id => '789RVWYBAZW00EXAMPLE',
+                                  :subject_id => "ABCDEF1234").elements.should eql(
+      {"GetQualificationScoreResult"=>
+       {
+        "Qualification" =>{
+          "QualificationTypeId" => "789RVWYBAZW00EXAMPLE",
+          "SubjectId" => "AZ3456EXAMPLE",
+          "GrantTime" => "2005-01-31T23:59:59Z",
+          "IntegerValue"=>"95"
+        }
+       }
+      })
+  end
+
+  it "should pull out the attributes" do
+    results = RTurk::GetQualificationScore(:qualification_type_id => '789RVWYBAZW00EXAMPLE',
+                                  :subject_id => "AZ3456EXAMPLE")
+    results.qualification_type_id.should eql('789RVWYBAZW00EXAMPLE')
+    results.subject_id.should eql('AZ3456EXAMPLE')
+    results.integer_value.should eql(95)
+  end
+end
+

data/spec/operations/update_qualification_score_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::UpdateQualificationScore do
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('update_qualification_score', :operation => 'UpdateQualificationScore')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::UpdateQualificationScore()}.should raise_error RTurk::MissingParameters
+  end
+
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'UpdateQualificationScore'))
+    RTurk::UpdateQualificationScore(:qualification_type_id => '789RVWYBAZW00EXAMPLE',
+                                  :subject_id => "ABCDEF1234",
+                                  :integer_value => 80) rescue RTurk::InvalidRequest
+  end
+
+  it "should parse and return the result" do
+    RTurk::UpdateQualificationScore(:qualification_type_id => '789RVWYBAZW00EXAMPLE',
+                                  :subject_id => "ABCDEF1234",
+                                  :integer_value => 80).elements.should eql(
+      {"UpdateQualificationScoreResult"=>{"Request"=>{"IsValid"=>"True"}}})
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rturk
 version: !ruby/object:Gem::Version
-  version: 2.11.3
+  version: 2.12.0
 platform: ruby
 authors:
 - Mark Percival
@@ -254,6 +254,7 @@ files:
 - lib/rturk/operations/get_bonus_payments.rb
 - lib/rturk/operations/get_hit.rb
 - lib/rturk/operations/get_qualification_requests.rb
+- lib/rturk/operations/get_qualification_score.rb
 - lib/rturk/operations/get_qualification_type.rb
 - lib/rturk/operations/get_qualifications_for_qualification_type.rb
 - lib/rturk/operations/get_reviewable_hits.rb
@@ -270,6 +271,7 @@ files:
 - lib/rturk/operations/set_hit_as_reviewing.rb
 - lib/rturk/operations/set_hit_type_notification.rb
 - lib/rturk/operations/unblock_worker.rb
+- lib/rturk/operations/update_qualification_score.rb
 - lib/rturk/operations/update_qualification_type.rb
 - lib/rturk/parser.rb
 - lib/rturk/parsers/answer_parser.rb
@@ -287,12 +289,14 @@ files:
 - lib/rturk/parsers/responses/get_bonus_payments_response.rb
 - lib/rturk/parsers/responses/get_hit_response.rb
 - lib/rturk/parsers/responses/get_qualification_requests_response.rb
+- lib/rturk/parsers/responses/get_qualification_score_response.rb
 - lib/rturk/parsers/responses/get_qualification_type_response.rb
 - lib/rturk/parsers/responses/get_qualifications_for_qualification_type_response.rb
 - lib/rturk/parsers/responses/get_reviewable_hits_response.rb
 - lib/rturk/parsers/responses/register_hit_type_response.rb
 - lib/rturk/parsers/responses/search_hits_response.rb
 - lib/rturk/parsers/responses/search_qualification_types_response.rb
+- lib/rturk/parsers/responses/update_qualification_score_response.rb
 - lib/rturk/requester.rb
 - lib/rturk/utilities.rb
 - lib/rturk/version.rb
@@ -327,6 +331,7 @@ files:
 - spec/fake_responses/get_bonus_payments.xml
 - spec/fake_responses/get_hit.xml
 - spec/fake_responses/get_qualification_requests.xml
+- spec/fake_responses/get_qualification_score.xml
 - spec/fake_responses/get_qualification_type.xml
 - spec/fake_responses/get_qualifications_for_qualification_type.xml
 - spec/fake_responses/get_rejected_assignments.xml
@@ -344,6 +349,7 @@ files:
 - spec/fake_responses/search_qualification_types.xml
 - spec/fake_responses/set_hit_as_reviewing.xml
 - spec/fake_responses/unblock_worker.xml
+- spec/fake_responses/update_qualification_score.xml
 - spec/fake_responses/update_qualification_type.xml
 - spec/mturk.yml
 - spec/operations/approve_assignment_spec.rb
@@ -363,6 +369,7 @@ files:
 - spec/operations/get_bonus_payments_spec.rb
 - spec/operations/get_hit_spec.rb
 - spec/operations/get_qualification_requests_spec.rb
+- spec/operations/get_qualification_score_spec.rb
 - spec/operations/get_qualification_type_spec.rb
 - spec/operations/get_qualifications_for_qualification_type_spec.rb
 - spec/operations/get_reviewable_hits_spec.rb
@@ -378,6 +385,7 @@ files:
 - spec/operations/set_hit_as_reviewing_spec.rb
 - spec/operations/set_hit_type_notification_spec.rb
 - spec/operations/unblock_worker_spec.rb
+- spec/operations/update_qualification_score_spec.rb
 - spec/operations/update_qualification_type_spec.rb
 - spec/parsers/answer_parser_spec.rb
 - spec/parsers/hit_parser_spec.rb