rturk 2.1.1 → 2.2.0

data/VERSION

@@ -1 +1 @@
-2.1.1
+2.2.0

data/lib/rturk/adapters/hit.rb

@@ -64,6 +64,10 @@ module RTurk
       @details ||= RTurk::GetHIT(:hit_id => self.id)
     end
 
+    def extend!(options = {})
+      RTurk::ExtendHIT(options.merge({:hit_id => self.id}))
+    end
+
     def expire!
       RTurk::ForceExpireHIT(:hit_id => self.id)
     end

data/lib/rturk/operations/extend_hit.rb

@@ -1,17 +1,17 @@
 module RTurk
   class RTurk::ExtendHIT < RTurk::Operation
     
-    attr_accessor :hit_id, :max_assignments_increment, :expiration_increment_in_seconds 
+    attr_accessor :hit_id, :assignments, :seconds
     require_params :hit_id
 
     def to_params
-      if max_assignments_increment.nil? && expiration_increment_in_seconds.nil?
+      if assignments.nil? && seconds.nil?
         raise MissingParameters, 'Must add to either the HIT assignment count or expiration time.'
       end
       
       {'HITId' => self.hit_id,
-       'MaxAssignmentsIncrement' => self.max_assignments_increment,
-       'ExpirationIncrementInSeconds' => self.expiration_increment_in_seconds}
+       'MaxAssignmentsIncrement' => self.assignments,
+       'ExpirationIncrementInSeconds' => self.seconds}
     end
 
   end

data/lib/rturk/parsers/assignment_parser.rb

@@ -39,11 +39,18 @@ module RTurk
                   :auto_approval_time => 'AutoApprovalTime'
                   )
     end
-    
+
     def answers
       AnswerParser.parse(@xml_obj.xpath('Answer').children)
     end
+
+    # Normalizes a hash of answers that include nested params
+    # such as the ones you'll find in Rails
+    # Example 'tweet[text]' => 'Tweet!' becomes
+    # {'tweet' => {'text' => 'Tweet!'}}
+    def normalized_answers
+      normalize_nested_params(answers)
+    end
     
   end
-  
 end

data/lib/rturk/xml_utilities.rb

@@ -31,4 +31,19 @@ module RTurk::XMLUtilities
     end
   end
 
+  # Takes a Rails-like nested param hash and normalizes it.
+  def normalize_nested_params(hash)
+    new_hash = {}
+    hash.each do |k,v|
+      inner_hash = new_hash
+      keys = k.split(/[\[\]]/).reject{|s| s.nil? || s.empty? }
+      keys[0...keys.size-1].each do |key|
+        inner_hash[key] ||= {}
+        inner_hash = inner_hash[key]
+      end
+      inner_hash[keys.last] = v
+    end
+    new_hash
+  end
+
 end

data/rturk.gemspec

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

data/spec/adapters/hit_spec.rb

@@ -9,6 +9,7 @@ describe "HIT adapter" do
     faker('get_hit', :operation => 'GetHIT')
     faker('get_reviewable_hits', :operation => 'GetReviewableHITs')
     faker('get_assignments', :operation => 'GetAssignments')
+    faker('extend_hit', :operation => 'ExtendHIT')
     faker('force_expire_hit', :operation => 'ForceExpireHIT')
     faker('dispose_hit', :operation => 'DisposeHIT')
     faker('search_hits', :operation => 'SearchHITs')
@@ -34,6 +35,16 @@ describe "HIT adapter" do
     hits.first.assignments.first.answers["tweet"].should eql('This is my tweet!')
   end
   
+  it "should add time to a hit" do 
+    hits = RTurk::Hit.all_reviewable
+    hits.first.extend! :seconds => 3600
+  end
+  
+  it "should add assignments a hit" do 
+    hits = RTurk::Hit.all_reviewable
+    hits.first.extend! :assignments => 100
+  end
+  
   it "should expire a hit" do
     hits = RTurk::Hit.all_reviewable
     hits.first.expire!

data/spec/operations/extend_hit_spec.rb

@@ -15,11 +15,11 @@ describe RTurk::ExtendHIT do
   it "should successfully request the operation" do
     RTurk::Requester.should_receive(:request).once.with(
       hash_including('Operation' => 'ExtendHIT'))
-    RTurk::ExtendHIT(:hit_id => "123456789", :max_assignments_increment => 1) rescue RTurk::InvalidRequest
+    RTurk::ExtendHIT(:hit_id => "123456789", :assignments=> 1) rescue RTurk::InvalidRequest
   end
   
   it "should parse and return the result" do
-    RTurk::ExtendHIT(:hit_id => "123456789", :expiration_increment_in_seconds => 3600).should
+    RTurk::ExtendHIT(:hit_id => "123456789", :seconds => 3600).should
       be_a_kind_of RTurk::Response
   end
 

data/spec/parsers/answer_parser_spec.rb

@@ -8,10 +8,14 @@ describe RTurk::AnswerParser do
 <?xml version="1.0" encoding="UTF-8"?>
 <QuestionFormAnswers xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd">
 <Answer>
-<QuestionIdentifier>tweet</QuestionIdentifier>
+<QuestionIdentifier>tweet[content]</QuestionIdentifier>
 <FreeText>This is my tweet!</FreeText>
 </Answer>
 <Answer>
+<QuestionIdentifier>tweet[time]</QuestionIdentifier>
+<FreeText>12345678</FreeText>
+</Answer>
+<Answer>
 <QuestionIdentifier>Submit</QuestionIdentifier>
 <FreeText>Submit</FreeText>
 </Answer>
@@ -20,8 +24,13 @@ XML
   end
   
   it "should parse a answer" do
-    RTurk::AnswerParser.parse(@answer).to_hash.should == {"Submit"=>"Submit", "tweet"=>"This is my tweet!"}
+    RTurk::AnswerParser.parse(@answer).to_hash.should == {"Submit"=>"Submit", "tweet[content]"=>"This is my tweet!", "tweet[time]" => "12345678"}
   end
 
+	it "should parse an answer into a param hash" do
+		hash = RTurk::AnswerParser.parse(@answer).to_hash
+		RTurk::Parser.new.normalize_nested_params(hash).should == {"Submit"=>"Submit", "tweet"=> {"content" => "This is my tweet!", "time" => "12345678"}}
+	end
+
   
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
-  - 1
-  - 1
-  version: 2.1.1
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Mark Percival
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-26 00:00:00 -07:00
+date: 2010-06-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency