rturk 2.3.2 → 2.3.3

data/VERSION

@@ -1 +1 @@
-2.3.2
+2.3.3

data/lib/rturk/adapters/hit.rb

@@ -55,8 +55,9 @@ module RTurk
 
     attr_accessor :id, :source
 
-    def initialize(id, source = nil)
+    def initialize(id, source = nil, options={})
       @id, @source = id, source
+      @include_assignment_summary = options[:include_assignment_summary]
     end
 
     # memoing
@@ -68,7 +69,8 @@ module RTurk
     end
 
     def details
-      @details ||= RTurk::GetHIT(:hit_id => self.id)
+      @details ||= RTurk::GetHIT(:hit_id => self.id,
+                                 :include_assignment_summary => !!@include_assignment_summary)
     end
 
     def extend!(options = {})

data/lib/rturk/operations/get_hit.rb

@@ -2,17 +2,29 @@ module RTurk
   class GetHIT < Operation
 
     require_params :hit_id
-    attr_accessor :hit_id
-    
+    attr_accessor :hit_id, :include_assignment_summary
+
     def parse(xml)
       RTurk::GetHITResponse.new(xml)
     end
-    
+
     def to_params
-      {"HITId" => self.hit_id}
+      params = {"HITId" => self.hit_id}
+
+      if @include_assignment_summary
+        params["ResponseGroup"] = {
+          0 => "HITDetail", # default
+          1 => "HITQuestion", # default
+          2 => "Minimal", # default
+          3 => "HITAssignmentSummary" # added
+        }
+      end
+
+      params
     end
-    
+
   end
+
   def self.GetHIT(*args, &blk)
     RTurk::GetHIT.create(*args, &blk)
   end

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

@@ -44,9 +44,11 @@
 
 module RTurk
   class GetHITResponse < Response
-    attr_reader :hit_id, :type_id, :status, :review_status, :title, :created_at, :expires_at,
-                :assignments_duration, :reward_amount, :max_assignments, :auto_approval_delay,
-                :keywords
+    attr_reader :hit_id, :type_id, :keywords, :status, :review_status, :title, :created_at,
+                :expires_at, :assignments_duration, :reward_amount, :max_assignments,
+                :auto_approval_delay, :description, :reward, :lifetime, :annotation,
+                :similar_hits_count, :assignments_pending_count, :assignments_available_count,
+                :assignments_completed_count
 
     def initialize(response)
       @raw_xml = response.body
@@ -70,9 +72,9 @@ module RTurk
         :lifetime => 'LifetimeInSeconds',
         :annotation => 'RequesterAnnotation',
         :similar_hits_count => 'NumberOfSimilarHITs',
-        :assignments_pending_count => 'NumberofAssignmentsPending',
-        :assignments_available_count => 'NumberofAssignmentsAvailable',
-        :assignments_completed_count => 'NumberofAssignmentsCompleted'
+        :assignments_pending_count => 'NumberOfAssignmentsPending',
+        :assignments_available_count => 'NumberOfAssignmentsAvailable',
+        :assignments_completed_count => 'NumberOfAssignmentsCompleted'
       )
 
       @keywords = @keywords.split(', ') if @keywords

data/lib/rturk/requester.rb

@@ -34,6 +34,10 @@ module RTurk
             value.each do |multi_value|
               pairs << [CGI.escape(key.to_s), CGI.escape(multi_value.to_s)].join('=')
             end
+          elsif value.is_a?(Hash)
+            value.each do |multi_key, multi_value|
+              pairs << [CGI.escape("#{key}.#{multi_key}"), CGI.escape(multi_value.to_s)].join('=')
+            end
           else
             pairs << [CGI.escape(key.to_s), CGI.escape(value.to_s)].join('=')
           end

data/rturk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rturk}
-  s.version = "2.3.2"
+  s.version = "2.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Percival"]
-  s.date = %q{2010-11-03}
+  s.date = %q{2010-11-17}
   s.email = %q{mark@mpercival.com}
   s.extra_rdoc_files = [
     "LICENSE",

data/spec/adapters/hit_spec.rb

@@ -72,4 +72,17 @@ describe "HIT adapter" do
     hits.first.completed_assignments.should eql(1)
   end
 
+  it "should get normal details without specifying" do
+    hit = RTurk::Hit.new(12345)
+    RTurk.should_receive(:GetHIT).with(:hit_id => 12345,
+                                       :include_assignment_summary => false)
+    hit.details
+  end
+
+  it "should include assignment summary attributes in details if specified in initialize" do
+    hit = RTurk::Hit.new(12345, nil, :include_assignment_summary => true)
+    RTurk.should_receive(:GetHIT).with(:hit_id => 12345,
+                                       :include_assignment_summary => true)
+    hit.details
+  end
 end

data/spec/operations/get_hit_spec.rb

@@ -1,6 +1,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
-
 describe RTurk::GetHIT do
 
   before(:all) do
@@ -14,5 +13,19 @@ describe RTurk::GetHIT do
     response.status.should eql('Reviewable')
   end
 
+  it "should not specify the ResponseGroup by default" do
+    request = RTurk::GetHIT.new(:hit_id => '1234abcd')
+    request.to_params["ResponseGroup"].should be_nil
+  end
+
+  it "should include the assignment summary in the response group if specified" do
+    request = RTurk::GetHIT.new(:hit_id => '1234abcd', :include_assignment_summary => true)
+    request.to_params["ResponseGroup"].should == {
+      0 => "HITDetail", # default
+      1 => "HITQuestion", # default
+      2 => "Minimal", # default
+      3 => "HITAssignmentSummary" # added
+    }
+  end
 
 end

data/spec/requester_spec.rb

@@ -24,7 +24,7 @@ describe RTurk::Requester do
     RTurk::Requester.request(params)
   end
 
-  it "Should build a correct querystring with two values per key" do
+  it "should build a correct querystring with two values per key" do
     params = {
       :Operation => 'GetHIT',
       'Param1' => 'test1',
@@ -34,4 +34,15 @@ describe RTurk::Requester do
       /(?=.*Operation=GetHIT)(?=.*Param1=test1)(?=.*Param2=test2a)(?=.*Param2=test2b)/)
     RTurk::Requester.request(params)
   end
+
+  it "should build a correct querystring with a hash of values" do
+    params = {
+      :Operation => 'GetHIT',
+      'Param1' => 'test1',
+      'Param2' => {0 => 'test2a', 1 => 'test2b'}
+    }
+    RestClient.should_receive(:get).with(
+      /(?=.*Operation=GetHIT)(?=.*Param1=test1)(?=.*Param2.0=test2a)(?=.*Param2.1=test2b)/)
+    RTurk::Requester.request(params)
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rturk
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 2
   - 3
-  - 2
-  version: 2.3.2
+  - 3
+  version: 2.3.3
 platform: ruby
 authors: 
 - Mark Percival
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 -07:00
+date: 2010-11-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency