rturk 1.0.5 → 2.0.0

data/spec/operations/get_assignments_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe "getting assignments" 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_assignments', :operation => 'GetAssignmentsForHIT')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::GetAssignmentsForHIT(:page_number => 5)}.should raise_error RTurk::MissingParameters
+  end
+  
+  it "should successfully request an assignment" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'GetAssignmentsForHIT'))
+    RTurk::GetAssignmentsForHIT(:hit_id => "abcd") rescue RTurk::InvalidRequest
+  end
+  
+  it "should parse and return and answer" do
+    assignments = RTurk::GetAssignmentsForHIT(:hit_id => "abcd").assignments
+    assignments.first.answers['tweet'].should eql("This is my tweet!")
+  end
+
+end

data/spec/operations/get_hit_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+
+describe RTurk::GetHIT do
+
+  before(:all) do
+    faker('get_hit', :operation => 'GetHIT')
+  end
+
+  it "should fetch the details of a HIT" do
+    response = RTurk.GetHIT(:hit_id => '1234abcd')
+    response.type_id.should eql('YGKZ2W5X6YFZ08ZRXXZZ')
+    response.auto_approval.should eql(3600)
+    response.status.should eql('Reviewable')
+  end
+
+
+end

data/spec/operations/grant_bonus_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::GrantBonus do
+
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('grant_bonus', :operation => 'GrantBonus')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::GrantBonus(:assignment_id => "123456789")}.should raise_error RTurk::MissingParameters
+  end
+  
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'GrantBonus'))
+    RTurk::GrantBonus(:assignment_id => "123456789", 
+                      :feedback => "Here's a quarter",
+                      :worker_id => 'jerry',
+                      :amount => 0.25) rescue RTurk::InvalidRequest
+  end
+  
+  it "should parse and return the result" do
+    RTurk::GrantBonus(:assignment_id => "123456789", 
+                      :feedback => "Here's a quarter",
+                      :worker_id => 'jerry',
+                      :amount => 0.25).should
+                      be_a_kind_of RTurk::Response
+  end
+
+end

data/spec/operations/reject_assignment_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::RejectAssignment do
+
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('reject_assignment', :operation => 'RejectAssignment')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::RejectAssignment(:assignment_id => "123456789")}.should raise_error RTurk::MissingParameters
+  end
+  
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'RejectAssignment'))
+    RTurk::RejectAssignment(:assignment_id => "123456789", :feedback => "This work of your, it is terrible!") rescue RTurk::InvalidRequest
+  end
+  
+  it "should parse and return the result" do
+    RTurk::RejectAssignment(:assignment_id => "123456789", :feedback => "This work of your, it is terrible!").should
+      be_a_kind_of RTurk::Response
+  end
+
+end

data/spec/requester_spec.rb

@@ -3,27 +3,16 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe RTurk::Requester do
 
   before(:all) do
+    FakeWeb.clean_registry
     aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
-    @turk = RTurk::Requester.new(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
   end
 
-  it "should perform raw operations" do
-    response = @turk.request(:Operation => 'GetHIT', 'HITId' => 'test')
-    response['HIT']['Request'].include?('Errors').should be_true
-  end
-  
-  it "should also interpret methods as operations" do
-    @turk.getHIT(:HITId => 'test')
-  end
-  
-  it "should return its environment" do 
-    @turk.environment.should == 'sandbox'
-  end
-  
-  it "should return its environment as production, the default" do
-    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
-    @turk = RTurk::Requester.new(aws['AWSAccessKeyId'], aws['AWSAccessKey'])
-    @turk.environment.should == 'production'
+  it "should send the request to Amazon" do
+    RestClient.should_receive(:get).with(/amazonaws.*Operation=GetHIT.*$/)
+    RTurk::Requester.request(:Operation => 'GetHIT', 'HITId' => 'test')
   end
+
+
   
 end

data/spec/response_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe RTurk::Response do
+  
+  context "given an invalid response" do
+  
+    before(:all) do
+      @invalid_credentials_xml = File.read(File.join(SPEC_ROOT,'fake_responses','invalid_credentials.xml'))
+      
+    end
+    
+    it "should know it failed" do
+      lambda{RTurk::Response.new(@invalid_credentials_xml)}.should raise_error RTurk::InvalidRequest
+    end
+    
+    it "should know why" do
+      begin
+        RTurk::Response.new(@invalid_credentials_xml)
+      rescue RTurk::InvalidRequest => e
+        e.message.should eql("AWS.NotAuthorized: The identity contained in the request is not authorized to use this AWSAccessKeyId")
+      end
+
+    end
+    
+  end
+  
+  context "given a valid response" do
+  
+    before(:all) do
+      @response = RTurk::Response.new(File.read(File.join(SPEC_ROOT,'fake_responses','create_hit.xml')))
+    end
+    
+    it "should know it succeded" do
+      @response.success?.should be_true
+    end
+    
+    it "should not have errors attached" do
+      @response.errors.should be_empty
+    end
+    
+    it "should give back the xml as a hash" do
+      @response.elements['CreateHITResponse']['HIT']['HITId'].should == 'GBHZVQX3EHXZ2AYDY2T0'
+    end
+    
+  end
+  
+end

data/spec/rturk_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe RTurk do
+  
+  before(:all) do
+    @aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+  end
+  
+  it 'should allow me to set it up with credentials' do
+    RTurk.setup(@aws['AWSAccessKeyId'], @aws['AWSAccessKey'], :sandbox => true)
+    RTurk.secret_key.should eql @aws['AWSAccessKey']
+  end
+  
+  
+  it "should be able to tell when it's in sandbox" do 
+    RTurk.setup(@aws['AWSAccessKeyId'], @aws['AWSAccessKey'], :sandbox => true)
+    RTurk.secret_key.should eql @aws['AWSAccessKey']
+    RTurk.sandbox?
+  end
+  
+  it "should return its environment as production, the default" do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'])
+    RTurk.sandbox?.should be_false
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,9 +1,34 @@
+SPEC_ROOT = File.expand_path(File.dirname(__FILE__)) unless defined? SPEC_ROOT
+$: << SPEC_ROOT
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
 require 'spec'
+require 'fakeweb'
+module FakeWeb
+  class Registry
+    # Comment out this override if you're using a quantum computer 
+    def variations_of_uri_as_strings(uri)
+      [uri.to_s]
+    end
+    
+  end
+end
 
-SPEC_ROOT = File.expand_path(File.dirname(__FILE__))
-$LOAD_PATH.unshift(SPEC_ROOT)
-$LOAD_PATH.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib'))
 require 'rturk'
+# RTurk.log.level = Logger::DEBUG
+
+@aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+RTurk.setup(@aws['AWSAccessKeyId'], @aws['AWSAccessKey'], :sandbox => true)
+
+def faker(response_name, opts = {})
+  if opts[:operation]
+    match = %r[amazonaws\.com\/?\?.*Operation=#{opts[:operation]}.*$]
+  else
+    match = %r[amazonaws\.com]
+  end
+  response = File.read(File.join(SPEC_ROOT, 'fake_responses', "#{response_name.to_s}.xml"))
+  FakeWeb.register_uri(:get, match, :body => response)
+end
 
 Spec::Runner.configure do |config|
   

data/spec/tmp

@@ -0,0 +1,2 @@
+RestClient.get "http://mechanicalturk.sandbox.amazonaws.com/?Keywords=&Signature=Gin96lmyTW%2FSJsO67GUtxjfpNRY%3D&Version=2008-08-02&RequesterAnnotation=&AWSAccessKeyId=0W304Z7TWY999N8ZXCG2&AssignmentDurationInSeconds=3600&Reward.Amount=&QualificationRequirement.1.RequiredToPreview=true&Timestamp=2009-10-06T23%3A28%3A51-04%3A00&MaxAssignments=5&Title=Look+at+some+dirty+pictures+from+4Chan&QualificationRequirement.2.RequiredToPreview=true&QualificationRequirement.1.QualificationTypeId=00000000000000000071&QualificationRequirement.2.Comparator=EqualTo&QualificationRequirement.1.Comparator=NotEqualTo&Reward.CurrencyCode=USD&QualificationRequirement.2.QualificationTypeId=00000000000000000060&Description=&AutoApprovalDelayInSeconds=3600&QualificationRequirement.2.IntegerValue=1&Service=AWSMechanicalTurkRequester&LifetimeInSeconds=&QualificationRequirement.1.LocaleValue.Country=PH"
+# => 200 OK | text/xml 316 bytes

data/spec/xml_parse_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe RTurk::XmlUtilities do
+  
+  before(:all) do
+    class XMLTest
+      include RTurk::XmlUtilities
+      def xml
+      <<-XML
+      <foo>
+        <bar>
+          <baz>
+            <fuck>content!!!</fuck>
+          </baz>
+        </bar>
+      </foo>
+      XML
+      end
+      def parse
+        xml_to_hash(Nokogiri::XML(xml))
+      end
+    end
+  end
+  
+  it "should parse a answer" do
+    
+    XMLTest.new.parse.should eql({'foo' => { 'bar' => {'baz' => {'fuck' => 'content!!!'}}}})
+  end
+
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rturk
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors: 
 - Mark Percival
@@ -9,29 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-09 00:00:00 -04:00
+date: 2009-10-26 00:00:00 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rest-client
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.9"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: xml-simple
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.12
-    version: 
+dependencies: []
+
 description: 
 email: mark@mpercival.com
 executables: []
@@ -43,25 +24,86 @@ extra_rdoc_files:
 - README.markdown
 files: 
 - .gitignore
+- .gitmodules
+- .yardoc
+- LICENSE
 - README.markdown
+- Rakefile
+- TODO.markdown
 - VERSION
 - examples/blank_slate.rb
-- examples/external_page.rb
+- examples/create_hit.rb
 - examples/mturk.sample.yml
 - examples/newtweet.html
 - examples/review_answer.rb
 - lib/rturk.rb
-- lib/rturk/answer.rb
-- lib/rturk/custom_operations.rb
-- lib/rturk/external_question_builder.rb
+- lib/rturk/adapters/answers.rb
+- lib/rturk/adapters/assignment.rb
+- lib/rturk/adapters/hit.rb
+- lib/rturk/builders/qualification_builder.rb
+- lib/rturk/builders/qualifications_builder.rb
+- lib/rturk/builders/question_builder.rb
+- lib/rturk/errors.rb
+- lib/rturk/logger.rb
+- lib/rturk/macros.rb
+- lib/rturk/operation.rb
+- lib/rturk/operations/approve_assignment.rb
+- lib/rturk/operations/create_hit.rb
+- lib/rturk/operations/disable_hit.rb
+- lib/rturk/operations/dispose_hit.rb
+- lib/rturk/operations/force_expire_hit.rb
+- lib/rturk/operations/get_account_balance.rb
+- lib/rturk/operations/get_assignments_for_hit.rb
+- lib/rturk/operations/get_hit.rb
+- lib/rturk/operations/get_reviewable_hits.rb
+- lib/rturk/operations/grant_bonus.rb
+- lib/rturk/operations/reject_assignment.rb
 - lib/rturk/requester.rb
+- lib/rturk/response.rb
+- lib/rturk/responses/create_hit_response.rb
+- lib/rturk/responses/get_account_balance_response.rb
+- lib/rturk/responses/get_assignments_for_hit_response.rb
+- lib/rturk/responses/get_hit_response.rb
+- lib/rturk/responses/get_reviewable_hits_response.rb
 - lib/rturk/utilities.rb
-- spec/answer_spec.rb
-- spec/external_question_spec.rb
+- lib/rturk/xml_utilities.rb
+- rturk.gemspec
+- spec/adapters/answers_spec.rb
+- spec/adapters/assignment_spec.rb
+- spec/adapters/hit_spec.rb
+- spec/builders/qualification_spec.rb
+- spec/builders/qualifications_spec.rb
+- spec/builders/question_spec.rb
+- spec/fake_responses/approve_assignment.xml
+- spec/fake_responses/create_hit.xml
+- spec/fake_responses/disable_hit.xml
+- spec/fake_responses/dispose_hit.xml
+- spec/fake_responses/force_expire_hit.xml
+- spec/fake_responses/get_account_balance.xml
+- spec/fake_responses/get_assignments.xml
+- spec/fake_responses/get_hit.xml
+- spec/fake_responses/get_reviewable_hits.xml
+- spec/fake_responses/grant_bonus.xml
+- spec/fake_responses/invalid_credentials.xml
+- spec/fake_responses/reject_assignment.xml
 - spec/mturk.sample.yml
+- spec/operations/approve_assignment_spec.rb
+- spec/operations/create_hit_spec.rb
+- spec/operations/disable_hit_spec.rb
+- spec/operations/dispose_hit_spec.rb
+- spec/operations/force_expire_hit_spec.rb
+- spec/operations/get_account_balance_spec.rb
+- spec/operations/get_assignments_spec.rb
+- spec/operations/get_hit_spec.rb
+- spec/operations/get_reviewable_hits_spec.rb
+- spec/operations/grant_bonus_spec.rb
+- spec/operations/reject_assignment_spec.rb
 - spec/requester_spec.rb
+- spec/response_spec.rb
+- spec/rturk_spec.rb
 - spec/spec_helper.rb
-- LICENSE
+- spec/tmp
+- spec/xml_parse_spec.rb
 has_rdoc: true
 homepage: http://github.com/markpercival/rturk
 licenses: []
@@ -88,13 +130,31 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Mechanical Turk API Wrapper
 test_files: 
-- spec/answer_spec.rb
-- spec/external_question_spec.rb
+- spec/adapters/answers_spec.rb
+- spec/adapters/assignment_spec.rb
+- spec/adapters/hit_spec.rb
+- spec/builders/qualification_spec.rb
+- spec/builders/qualifications_spec.rb
+- spec/builders/question_spec.rb
+- spec/operations/approve_assignment_spec.rb
+- spec/operations/create_hit_spec.rb
+- spec/operations/disable_hit_spec.rb
+- spec/operations/dispose_hit_spec.rb
+- spec/operations/force_expire_hit_spec.rb
+- spec/operations/get_account_balance_spec.rb
+- spec/operations/get_assignments_spec.rb
+- spec/operations/get_hit_spec.rb
+- spec/operations/get_reviewable_hits_spec.rb
+- spec/operations/grant_bonus_spec.rb
+- spec/operations/reject_assignment_spec.rb
 - spec/requester_spec.rb
+- spec/response_spec.rb
+- spec/rturk_spec.rb
 - spec/spec_helper.rb
+- spec/xml_parse_spec.rb
 - examples/blank_slate.rb
-- examples/external_page.rb
+- examples/create_hit.rb
 - examples/review_answer.rb