typingpool 0.8.11 → 0.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554974b6b35f179d3f50deb682ab0e5f9fd0964a
-  data.tar.gz: 0b67e2cdbb110c4f05bb820f2ad06241ead2fd7c
+  metadata.gz: b7f1162da9010eea09066f72b78c40eacc342d34
+  data.tar.gz: 4243222ed91a427012291a3be392ca5de6d5bc70
 SHA512:
-  metadata.gz: 8463b4059f24d13d4d6245e155a0db3d7d6dde459e1612d698b6a12a95a57c1fa15d240763530e9b883948fd7f04e2d41bab968675af6e25eb072b476b87bfb1
-  data.tar.gz: 4848802256545cb9b3149f57ef0d7f9a63b251fb3ed90d05db1b13f8a396353e0600fd3f65eb3be2ac9d1ffbc855c0b770d0ba8c7deffbe88a2308bfd2449f1c
+  metadata.gz: 982e426847cad2182163ab13d8832e70f64c84ee6f2ffe3bdcc712c346d8655cda67eb8c116fe22a761010f0e780f0c62c9fe9e76eacffe4d2abf8517ee50686
+  data.tar.gz: 063621305ccb40f636fd1f8234bf5f97d7584ff81d62220bc47c64ce30e259be8e6278ed773828c078f8980f9d88c8ef074adbe645c0e916eff34cdfb99d7d4d

data/bin/tp-assign

@@ -2,9 +2,11 @@
 
 require 'optparse'
 require 'typingpool'
+require 'typingpool/utility/test'
 require 'highline/import'
 include Typingpool::App::FriendlyExceptions
 include Typingpool::App::CLI::Formatter
+include Typingpool::Utility::Test
 
 options = {
   :keyword => [],
@@ -97,7 +99,6 @@ OptionParser.new do |opts|
   opts.on('--testfixture=PATH',
           'For testing purposes only. Ignore.',
           'A VCR fixture for running with mock data.') do |fixture|
-    require 'typingpool/app/test'
     options[:fixture] = fixture
   end
 
@@ -214,11 +215,11 @@ STDERR.puts "#{needed_assignments.count} assignments to assign"
 Typingpool::Amazon.setup(:sandbox => options[:sandbox], :config => config)
 
 if options[:fixture]
-  Typingpool::App.vcr_load(options[:fixture], config, not(options[:fixturerecord]), {
+  vcr_load(options[:fixture], config, not(options[:fixturerecord]), {
                              :preserve_exact_body_bytes => true,
-                             :match_requests_on => [:method, Typingpool::App.vcr_core_host_matcher]
+                             :match_requests_on => [:method, vcr_core_host_matcher]
                            })
-  at_exit{ Typingpool::App.vcr_stop }
+  at_exit{ vcr_stop }
 end
 
 #Are there enough funds for this assignment?

data/bin/tp-collect

@@ -2,6 +2,8 @@
 
 require 'typingpool'
 require 'optparse'
+require 'typingpool/utility/test'
+include Typingpool::Utility::Test
 
 options = {}
 OptionParser.new do |commands|
@@ -15,12 +17,19 @@ OptionParser.new do |commands|
               "A config file") do |path|
     options[:config] = path
   end
-  commands.on('--fixture=PATH',
-              "Optional. For testing purposes only.",
+  commands.on('--testfixture=PATH',
+              "For testing purposes only. Ignore.",
               "A VCR ficture for running with mock data.") do |fixture|
-    require 'typingpool/app/test'
     options[:fixture] = fixture
   end
+
+  commands.on('--testfixturerecord',
+          'For testing purposes only. Ignore.',
+          'Allows recording of a new fixture',
+          'to --testfixture path.') do
+    options[:fixturerecord] = true
+  end
+  
   commands.on('--help',
               "Display this screen") do
     STDERR.puts commands
@@ -31,14 +40,15 @@ end.parse!
 config = Typingpool::App::CLI.config_from_arg(options[:config]) or abort "No config file at '#{options[:config]}'"
 
 if options[:fixture]
-  Typingpool::App.vcr_load(options[:fixture], config, true)
-  at_exit{ Typingpool::App.vcr_stop }
+  vcr_load(options[:fixture], config, not(options[:fixturerecord]), {
+
+           })
+  at_exit{ vcr_stop }
 end
 
 STDERR.puts "Collecting results from Amazon"
 Typingpool::Amazon.setup(:sandbox => options[:sandbox], :config => config)
 hits = Typingpool::Amazon::HIT.all_approved
-
 STDERR.puts "Looking for local project folders to receive results" unless hits.empty?
 Typingpool::App.find_projects_waiting_for_hits(hits, config) do |project, hits|
   assignments_file = Typingpool::App.assignments_file_for_sandbox_status(options[:sandbox], project)

data/bin/tp-finish

@@ -3,6 +3,8 @@
 require 'optparse'
 require 'typingpool'
 require 'fileutils'
+require 'typingpool/utility/test'
+include Typingpool::Utility::Test
 
 options = {}
 OptionParser.new do |commands|
@@ -31,7 +33,6 @@ OptionParser.new do |commands|
   commands.on('--testfixture=PATH',
               'For testing purposes only. Ignore.',
               'A VCR fixture for running with mock data.') do |fixture|
-    require 'typingpool/app/test'
     options[:fixture] = fixture
   end
 
@@ -65,11 +66,11 @@ end
 
 Typingpool::Amazon.setup(:sandbox => options[:sandbox], :config => config)
 if options[:fixture]
-  Typingpool::App.vcr_load(options[:fixture], config, not(options[:fixturerecord]), {
+  vcr_load(options[:fixture], config, not(options[:fixturerecord]), {
                              :preserve_exact_body_bytes => true,
-                             :match_requests_on => [:method, Typingpool::App.vcr_core_host_matcher]
+                             :match_requests_on => [:method, vcr_core_host_matcher]
                            })
-  at_exit{ Typingpool::App.vcr_stop }
+  at_exit{ vcr_stop }
 end
 STDERR.puts "Removing from Amazon"
 STDERR.puts "  Collecting all results"

data/bin/tp-make

@@ -2,10 +2,12 @@
 
 require 'optparse'
 require 'typingpool'
+require 'typingpool/utility/test'
 require 'fileutils'
 require 'tempfile'
 require 'tmpdir'
 include Typingpool::App::FriendlyExceptions
+include Typingpool::Utility::Test
 
 options = {
   :files => [],
@@ -88,7 +90,6 @@ OptionParser.new do |opts|
   opts.on('--testfixture=PATH',
           'For testing purposes only. Ignore.',
           'A VCR fixture for running with mock data.') do |fixture|
-    require 'typingpool/app/test'
     options[:fixture] = fixture
   end
 
@@ -194,14 +195,14 @@ else
 end #if project.local
 
 unless options[:noupload]
-  Typingpool::App.vcr_load(options[:fixture], config, not(options[:fixturerecord]), {
+  vcr_load(options[:fixture], config, not(options[:fixturerecord]), {
                              :preserve_exact_body_bytes => true,
-                             :match_requests_on => [:method, Typingpool::App.vcr_core_host_matcher]
+                             :match_requests_on => [:method, vcr_core_host_matcher]
                            }) if options[:fixture]
   Typingpool::App.upload_audio_for_project(project) do |file, as|
     STDERR.puts "Uploading #{File.basename(file)} to #{project.remote.host}/#{project.remote.path} as #{as}"
   end
-  Typingpool::App.vcr_stop if options [:fixture]
+  vcr_stop if options [:fixture]
 end
 
 if STDOUT.tty? && Typingpool::Utility.os_x?

data/bin/tp-review

@@ -1,9 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'typingpool'
+require 'typingpool/utility/test'
 require 'highline/import'
 require 'optparse'
 include Typingpool::App::CLI::Formatter
+include Typingpool::Utility::Test
 
 options = {}
 OptionParser.new do |commands|
@@ -26,12 +28,19 @@ OptionParser.new do |commands|
               'Test in Mechanical Turk\'s sandbox') do |sandbox|
     options[:sandbox] = true
   end
-  commands.on('--fixture=PATH',
-              "Optional. For testing purposes only.",
-              "A VCR fixture for running with mock data") do |fixture|
-    require 'typingpool/app/test'
+  commands.on('--testfixture=PATH',
+              "For testing purposes only. Ignore.",
+              "A VCR ficture for running with mock data.",
+              "Path should NOT include file extension, e.g. '.yml'") do |fixture|
     options[:fixture] = fixture
   end
+
+  commands.on('--testfixturerecord',
+          'For testing purposes only. Ignore.',
+          'Allows recording of a new fixture',
+          'to --testfixture path.') do
+    options[:fixturerecord] = true
+  end
   commands.on('--help',
               "Display this screen") do
     STDERR.puts commands
@@ -55,8 +64,8 @@ if options[:project]
 end
 
 if options[:fixture]
-  Typingpool::App.vcr_load(options[:fixture], config, true)
-  at_exit{ Typingpool::App.vcr_stop }
+  vcr_load(options[:fixture], config, not(options[:fixturerecord]))
+  at_exit{ vcr_stop }
 end
 
 Typingpool::Amazon.setup(:sandbox => options[:sandbox], :config => config)
@@ -64,29 +73,47 @@ Typingpool::Amazon.setup(:sandbox => options[:sandbox], :config => config)
 assignments = Typingpool::App.assignments_file_for_sandbox_status(options[:sandbox], options[:project]) if options[:project]
 STDERR.puts "Gathering submissions from Amazon"
 hits = if options[:project] && ((hit_ids = assignments.map{|assignment| assignment['hit_id'] }.select{|hit_id| hit_id }).count > 0)
-         Typingpool::Amazon::HIT.with_ids(hit_ids).select{|hit| hit.submitted? }
+         Typingpool::Amazon::HIT.with_ids(hit_ids).select{|hit| hit.submitted? || hit.approved? }
        else
-         hits = Typingpool::Amazon::HIT.all_reviewable{|hit| hit.submitted? && hit.ours? }
+         hits = Typingpool::Amazon::HIT.all_reviewable{|hit| (hit.submitted? || hit.approved?) && hit.ours? }
          if options[:project]
            #code path for projects assigned through RUI
            hits.select!{|hit| hit.project_id == options[:project].local.id }
          end
          hits
        end
-
 STDERR.puts "Matching submissions with local projects"
+project_with_hits_needing_decision = []
+hits_needing_decision_count = 0
+Typingpool::App.find_projects_waiting_for_hits(hits, config).each do |project_with_hits|
+  hits = project_with_hits[:hits]
+  project = project_with_hits[:project]
+  assignments = Typingpool::App.assignments_file_for_sandbox_status(options[:sandbox], project)
+  hits.sort!{|a, b| a.url <=> b.url }
+  hits_needing_decision=[]
+  hits.each do |hit|
+    if hit.approved?
+      #collect auto-approved hits so people don't have to run tp-collect
+      Typingpool::App.record_approved_hits_in_assignments_file(assignments, [hit])
+      Typingpool::App.create_transcript(project, assignments)
+    else
+      hits_needing_decision.push(hit)
+      hits_needing_decision_count += 1
+    end
+  end #hits.each do...
+  if hits_needing_decision.count > 0
+    project_with_hits_needing_decision.push({project: project, hits: hits_needing_decision})
+  end
+end #Typingpool::App::find_projects_waiting_for_hits.each do ...
 choices = %w(approve reject quit skip)
+hits_decided_count = 0
 catch :quitting do
-  project_hits = Typingpool::App.find_projects_waiting_for_hits(hits, config) 
-  all_hits = project_hits.map{|hash| hash[:hits] }.flatten
-  i = 0
-  project_hits.each do |hash|
-    hits = hash[:hits]
-    project = hash[:project]
+  project_with_hits_needing_decision.each do |project_with_hits|
+    hits = project_with_hits[:hits]
+    project = project_with_hits[:project]
     assignments = Typingpool::App.assignments_file_for_sandbox_status(options[:sandbox], project)
-    hits.sort!{|a, b| a.url <=> b.url }
     hits.each do |hit|
-      i += 1
+      hits_decided_count += 1
       say(cli_bold("\nTranscript for: ") + hit.url)
       project_info = cli_bold("Project: ") + project.name
       if project.local.subtitle
@@ -106,8 +133,8 @@ catch :quitting do
       prompt << cli_reverse('[') + prompt.pop + cli_reverse(']')
       prompt = prompt.join(cli_reverse(', ')) 
       prompt += cli_reverse('? ')
-      prompt += cli_reverse("(#{i}/#{all_hits.count}) ")
-
+      prompt += cli_reverse("(#{hits_decided_count}/#{hits_needing_decision_count}) ")
+      
       choice=nil
       until choice
         input = ask(prompt)
@@ -117,15 +144,15 @@ catch :quitting do
           say("Invalid selection '#{input}'.")
         end
       end #until choice
-
+      
       case choice
       when 'approve'
         begin
           hit.assignment.at_amazon.approve!
         rescue RTurk::InvalidRequest => exception
-            #assignment may have passed its approval deadline since
-            #the session started and has been auto approved. In that
-            #case, add to the transcript; no need to tell the user.
+          #assignment may have passed its approval deadline since
+          #the session started and has been auto approved. In that
+          #case, add to the transcript; no need to tell the user.
           unless exception.message.match(/AWS.MechanicalTurk.InvalidAssignmentState\b.+\bstatus of:\s*Submitted/i)
             #different issue than auto approval; raise exception
             raise exception
@@ -161,9 +188,8 @@ catch :quitting do
         say(cli_bold("Skipping\n"))
         next
       end #case choice
-    end #hits.each_with_index
-
-  end #find_projects_waiting_for(...) do
+    end #hits.each do....
+  end # project_with_hits_needing_decision.each do
 end #catch :quitting do
 
 #Put project path on STDOUT so script can be pipelined, e.g.

data/lib/typingpool/test.rb

@@ -1,71 +1,18 @@
 module Typingpool
   require 'minitest'
-  require 'typingpool/app/test'
-
+  require 'typingpool/utility/test'
+  
   class Test < Minitest::Test 
+    include Utility::Test
+    
     class << self
       attr_accessor :live
       attr_accessor :record
-
-      def app_dir
-        Utility.app_dir
-      end
-
     end #class << self
 
     self.record = ARGV.delete('--record')
     self.live = ARGV.delete('--live')
 
-    def fixtures_dir
-      File.join(Utility.lib_dir, 'test', 'fixtures')
-    end
-
-    def audio_dir
-      File.join(fixtures_dir, 'audio')
-    end
-
-    def vcr_dir
-      File.join(fixtures_dir, 'vcr')
-    end
-
-    def delete_vcr_fixture(fixture_name)
-      fixture_path = File.join(vcr_dir, [fixture_name, '.yml'].join)
-      File.delete(fixture_path) if File.exist? fixture_path
-    end
-
-    def cleared_vcr_fixture_path_for(fixture_name)
-      if Typingpool::Test.record
-        delete_vcr_fixture(fixture_name)
-      end
-      if (Typingpool::Test.record || not(Typingpool::Test.live))
-        File.join(vcr_dir, fixture_name)
-      end
-    end
-
-    def with_vcr(fixture_name, config, opts={})
-      if fixture = cleared_vcr_fixture_path_for(fixture_name)
-        read_only = not(Typingpool::Test.record)
-        Typingpool::App.vcr_load(fixture, config, read_only, opts)
-      end
-      begin
-        yield
-      ensure
-        Typingpool::App.vcr_stop
-      end
-    end
-
-    def config
-      if File.exist?(File.expand_path(Config.default_file))
-        Config.file
-      else
-        Config.from_bundled_template
-      end
-    end
-
-    def amazon_credentials?(config=self.config)
-      config.amazon && config.amazon.key && config.amazon.secret
-    end
-
     def skip_with_message(reason, skipping_what='')
       skipping_what = " #{skipping_what}" unless skipping_what.empty?
       skip ("Skipping#{skipping_what}: #{reason}")
@@ -78,10 +25,6 @@ module Typingpool
       end
     end
 
-    def s3_credentials?(config)
-      amazon_credentials?(config) && config.amazon.bucket
-    end
-
     def skip_if_no_s3_credentials(skipping_what='', config=self.config)
       if not (skip_if_no_amazon_credentials(skipping_what, config))
         if not(s3_credentials?(config))
@@ -90,10 +33,6 @@ module Typingpool
       end #if not(skip_if_no_amazon_credentials...)
     end
 
-    def sftp_credentials?(config)
-      config.sftp && config.sftp.user && config.sftp.host && config.sftp.url
-    end
-
     def skip_if_no_sftp_credentials(skipping_what='', config=self.config)
       if not(sftp_credentials?(config))
         skip_with_message('No SFTP credentials', skipping_what)
@@ -110,67 +49,6 @@ module Typingpool
       end #if not(s3_credentials?...
     end
 
-    def add_goodbye_message(msg)
-      at_exit do
-        STDERR.puts msg
-      end
-    end
-
-    def dummy_config(number=1)
-      Typingpool::Config.file(File.join(fixtures_dir, "config-#{number}"))
-    end
-
-
-    def project_default
-      Hash[
-           :config_filename => '.config',
-           :subtitle => "Typingpool's test interview transcription",
-           :title => "Typingpool's Test & Interview",
-           :chunks => '0:22',
-           :unusual => ['Hack Day', 'Sunnyvale', 'Chad D'],
-           :voice => ['Ryan', 'Havi, hacker'],
-          ]
-    end
-
-
-    def in_temp_dir
-      Typingpool::Utility.in_temp_dir{|dir| yield(dir) }
-    end
-
-    def working_url?(*args)
-      Typingpool::Utility.working_url?(*args)
-    end
-
-
-    def works_eventually?(max_seconds=10, min_tries=2)
-      start = Time.now.to_i
-      tries = 0
-      wait = 0
-      until ((tries >= min_tries) && ((Time.now.to_i + wait - start) >= max_seconds)) do
-        sleep wait
-        return true if yield
-        wait = wait > 0 ? wait * 2 : 1
-        tries += 1
-      end
-      false
-    end
-
-    def working_url_eventually?(url, max_seconds=10, min_tries=2, max_redirects=6)
-      works_eventually?(max_seconds, min_tries) do
-        working_url?(url, max_redirects)
-      end
-    end
-
-    def broken_url_eventually?(url, max_seconds=10, min_tries=2, max_redirects=6)
-      works_eventually?(max_seconds, min_tries) do
-        not(working_url?(url, max_redirects))
-      end
-    end
-
-    def fetch_url(*args)
-      Typingpool::Utility.fetch_url(*args)
-    end
-
     require 'typingpool/test/script'
   end #Test
 end #Typingpool