umlaut 3.0.5 → 3.1.0.pre1

data/test/unit/aws_product_sign_test.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
+require 'aws_product_sign'
+
 # Example used for testing is from
 # http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/rest-signature.html
 # Although that example itself has some bugs as of 12 may 09 doh.

data/test/unit/determine_services_test.rb

@@ -0,0 +1,163 @@
+require 'test_helper'
+
+
+# ServiceStore.determine_services
+# 
+# Loads service definitions into a Collection object, based on services configuration
+# and current &umlaut.service_group param. Tests.
+class DetermineServicesTest <  ActiveSupport::TestCase
+  setup :set_custom_service_store
+
+  def set_custom_service_store
+    dummy = {"type" => "DummyService", "priority" => 3}
+
+    # This would normally be loaded as YAML, we're going to set it
+    # directly.
+    service_declerations = {
+      "default" => {
+        "services" => {
+          "default_a"         => dummy.clone,
+          "default_b"         => dummy.clone,
+          "default_disabled"  => dummy.clone.merge("disabled" => true)
+        }
+      },
+
+      "group1" => {
+        "services" => {
+          "group1_a"        => dummy.clone,
+          "group1_b"        => dummy.clone,
+          "group1_disabled"  => dummy.clone.merge("disabled" => true)
+        }
+      },
+
+      "group2" => {
+        "services" => {
+          "group2_a"        => dummy.clone,
+          "group2_b"        => dummy.clone,
+          "group2_disabled"  => dummy.clone.merge("disabled" => true)
+        }
+      }
+    }
+
+    @service_store = ServiceStore.new
+    @service_store.config = service_declerations
+  end
+
+  def test_basic
+    service_list = @service_store.determine_services
+
+    # default group services
+    assert_include service_list.keys, "default_a"
+    assert_include service_list.keys, "default_b"
+
+    # but not the disabled one
+    assert_not_include service_list.keys, "default_disabled"
+
+    # No group1 or group2
+    assert_nil service_list.keys.find {|key| key.start_with? "group1"}
+    assert_nil service_list.keys.find {|key| key.start_with? "group2"}
+  end
+
+  def test_add_groups
+    service_list = @service_store.determine_services %w[group2 group1]
+
+    ["default_a", "default_b", "group1_a", "group1_b", "group2_a", "group2_b"].each do |service_id|
+      assert_include service_list.keys, service_id
+    end
+
+    ["default_disabled", "group1_disabled", "group2_disabled"].each do |service_id|
+      assert_not_include service_list.keys, service_id
+    end
+  end
+
+  def test_add_group_no_default
+    service_list = @service_store.determine_services %w{group1 -default}
+
+    # does not include default ones
+    assert_nil service_list.keys.find {|id| id.start_with? "default_"}
+
+    # does include group1 ones
+    assert_include service_list.keys, "group1_a"
+    assert_include service_list.keys, "group1_b"
+  end
+
+  # Should this raise a clear error instead? For now, we ignore.
+  def test_missing_service_group_ignored
+    # Not raise
+    service_list = @service_store.determine_services %w{non_existing_group}
+  end
+
+  def test_multi_default_groups
+    store = multi_default_group_store
+
+    service_list = store.determine_services
+
+    assert_include service_list.keys, "default_a"
+    assert_include service_list.keys, "other_default_a"
+  end
+
+  def test_multi_default_disable
+    store = multi_default_group_store
+
+    service_list = store.determine_services %w{-other_default}
+
+    assert_include service_list.keys, "default_a"
+    assert_not_include service_list.keys, "other_default_a"
+  end
+
+
+  # A terrible way and place to test this, but our legacy code is tricky, currently
+  # consider this better than nothing. =
+  #
+  # the Request.co_params_fingerprint must take account of new "umlaut.service_group", to make sure
+  # a cached request same but for different umlaut.service_group is NOT re-used
+  def test_params_fingerprint_includes_service_group
+
+    req_string = "/?issn=12345678&"
+    req     = ActionDispatch::TestRequest.new Rack::MockRequest.env_for(req_string)
+    req_sg1 = ActionDispatch::TestRequest.new Rack::MockRequest.env_for(req_string + "&umlaut.service_group[]=group1")
+    req_sg2 = ActionDispatch::TestRequest.new Rack::MockRequest.env_for(req_string + "&umlaut.service_group[]=groupother")
+
+    fingerprint     = Request.co_params_fingerprint(  Request.context_object_params req  )
+    fingerprint_sg1 = Request.co_params_fingerprint(  Request.context_object_params req_sg1  )
+    fingerprint_sg2 = Request.co_params_fingerprint(  Request.context_object_params req_sg2  )
+
+    assert_not_equal fingerprint, fingerprint_sg1
+    assert_not_equal fingerprint, fingerprint_sg2
+    assert_not_equal fingerprint_sg1, fingerprint_sg2
+  end
+
+
+  def multi_default_group_store
+    dummy = {"type" => "DummyService", "priority" => 3}
+
+    service_declerations = {
+      "default" => {
+        "services" => {
+          "default_a"         => dummy.clone,
+          "default_b"         => dummy.clone,
+          "default_disabled"  => dummy.clone.merge("disabled" => true)
+        }
+      },
+
+      "other_default" => {
+        "default"  => true,
+        "services" => {
+          "other_default_a"        => dummy.clone
+        }
+      },
+
+      "extra_group" => {
+        "services" => {
+          "extra_group_a"        => dummy.clone,
+        }
+      }
+    }
+
+    store = ServiceStore.new
+    store.config = service_declerations
+
+    return store
+  end
+
+end

data/test/unit/google_book_search_test.rb

@@ -1,20 +1,9 @@
 # tests for google book search service
 # Only the the simplest of tests are done so far. To do more advanced tests,
 # request fixtures for more cases should be created.
-
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-require File.dirname(__FILE__) + '/../test_helper'
-
-require 'test/unit'
-require 'rubygems'
-
-#require 'lib/service'
-#require 'lib/metadata_helper'
-#require 'lib/service_adaptors/google_book_search'
-
-require 'yaml'
-
+require 'test_helper'
 class GoogleBookSearchTest < ActiveSupport::TestCase  
+  extend TestWithCassette
   fixtures :requests, :referents
   
   def setup    
@@ -24,9 +13,7 @@ class GoogleBookSearchTest < ActiveSupport::TestCase
       {"totalItems"=>1, "kind"=>"books#volumes", "items"=>[{"accessInfo"=>{"embeddable"=>true, "webReaderLink"=>"http://books.google.com/books/reader?id=QKgVAAAAYAAJ&as_pt=BOOKS&printsec=frontcover&output=reader&source=gbs_api", "epub"=>{"isAvailable"=>true, "downloadLink"=>"http://books.google.com/books/download/Frankenstein.epub?id=QKgVAAAAYAAJ&output=epub&source=gbs_api"}, "viewability"=>"ALL_PAGES", "publicDomain"=>true, "country"=>"US", "pdf"=>{"isAvailable"=>true, "downloadLink"=>"http://books.google.com/books/download/Frankenstein.pdf?id=QKgVAAAAYAAJ&output=pdf&sig=ACfU3U3nhOFhUroWh_b-nMaAulaAV6kjlw&source=gbs_api"}, "textToSpeechPermission"=>"ALLOWED", "accessViewStatus"=>"FULL_PUBLIC_DOMAIN"}, "searchInfo"=>{"textSnippet"=>"FRANKENSTEIN or The Modern Prometheus CHAPTER I. I Am by birth a Genevese; and <br>  my family is one of the most distinguished of that republic. My ancestors had <br>  been for many years counselors and syndics; and my father had filled several <b>...</b>"}, "etag"=>"TUqYf+e+c9k", "kind"=>"books#volume", "volumeInfo"=>{"infoLink"=>"http://books.google.com/books?id=QKgVAAAAYAAJ&dq=OCLC2364071&as_pt=BOOKS&source=gbs_api", "contentVersion"=>"0.0.1.0.full.3", "categories"=>["Fiction"], "title"=>"Frankenstein", "printType"=>"BOOK", "ratingsCount"=>279, "subtitle"=>"or, the Modern Prometheus", "previewLink"=>"http://books.google.com/books?id=QKgVAAAAYAAJ&printsec=frontcover&dq=OCLC2364071&as_pt=BOOKS&cd=1&source=gbs_api", "imageLinks"=>{"smallThumbnail"=>"http://bks6.books.google.com/books?id=QKgVAAAAYAAJ&printsec=frontcover&img=1&zoom=5&edge=curl&source=gbs_api", "thumbnail"=>"http://bks6.books.google.com/books?id=QKgVAAAAYAAJ&printsec=frontcover&img=1&zoom=1&edge=curl&source=gbs_api"}, "pageCount"=>332, "language"=>"en", "canonicalVolumeLink"=>"http://books.google.com/books/about/Frankenstein.html?id=QKgVAAAAYAAJ", "averageRating"=>4.0, "authors"=>["Mary Wollstonecraft Shelley"], "industryIdentifiers"=>[{"type"=>"OTHER", "identifier"=>"PRNC:32101064790353"}], "publishedDate"=>"1922"}, "saleInfo"=>{"isEbook"=>true, "saleability"=>"FREE", "country"=>"US"}, "id"=>"QKgVAAAAYAAJ", "selfLink"=>"https://www.googleapis.com/books/v1/volumes/QKgVAAAAYAAJ"}]}      
     
   end
-  
 
-  
   def test_initialize_minimum
     gbs = GoogleBookSearch.new({"priority"=>1})
     assert_equal(1, gbs.priority)    
@@ -47,29 +34,25 @@ class GoogleBookSearchTest < ActiveSupport::TestCase
   # This doesn't check much of the response, but just enough to know we got
   # something back. The server for the thumbnail changes, so we can't do a 
   # simple match and a huge regexp was making my head hurt.
-  def test_do_query
+  # UPDATE: Use VCR to provide a deterministic GBS search.
+  # TODO: Check more of the response
+  test_with_cassette("frankenstein by OCLC number", :google_book_search) do
     hashified_response = @gbs_default.do_query('OCLC2364071', requests(:frankenstein))
-
     assert_not_nil hashified_response
-    
     assert_not_nil hashified_response["totalItems"]
-    
     assert_operator hashified_response["totalItems"], :>, 0 
   end
 
-  
   def test_create_fulltext_service_response
     # frankenstein's got fulltext now. 
     request = requests(:frankenstein)
-    fulltext_shown = @gbs_default.create_fulltext_service_response(request, 
-      @data_frankenstein)
+    fulltext_shown = 
+      @gbs_default.create_fulltext_service_response(request, @data_frankenstein)
     assert(fulltext_shown)
   end
 
   def test_find_thumbnail_url
-
     url = @gbs_default.find_thumbnail_url(@data_frankenstein)
     assert_not_nil url
   end
-  
-end
+end

data/test/unit/google_scholar_link_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+
+class GoogleScholarLinkTest < ActiveSupport::TestCase
+  extend TestWithCassette
+  
+  # TODO: Fix up umlaut to make it easier to create request/referent
+  # objects for testing!  
+  def build_request(format, hash = {})
+    context_object = OpenURL::ContextObject.new
+    context_object.referent.set_format(format) if format
+    
+    hash.each_pair do |key, value|    
+      context_object.referent.set_metadata(key.to_s, value.to_s)
+    end
+    
+    rft = Referent.create_by_context_object(context_object)
+    
+    req = Request.new
+    req.referent = rft
+    req.save!
+    
+    return req
+  end
+  
+  def setup
+    @service = GoogleScholarLink.new({"priority" => 3, "service_id" => "GoogleScholarLink"})
+  end
+  
+  def test_insufficient_metadata
+    title_level = build_request("journal", :jtitle => "foo", :issn => "12345678")
+    
+    assert ! @service.should_link_out_to?(title_level)
+        
+    no_author = build_request("article", :issn => "12345678", :spage => "12", :volume => "2", :issue => "2", :atitle => "Some Article")
+    
+    assert ! @service.should_link_out_to?(no_author)        
+  end
+  
+  def test_sufficient_metadata
+    proceeding = build_request("journal", :atitle => "Human-Machine Collaborative Planning",
+      :au => "Allen, James F.", :aufirst => "James", :auinitm => "F", :aulast => "Allen",
+      :epage => "29", :genre => "proceeding", :spage => "27")    
+    assert @service.should_link_out_to?(proceeding)
+    
+    article_little_metadata = build_request("journal", :genre => "article", :atitle => "Foo", :au => "Smith")    
+    assert @service.should_link_out_to?(article_little_metadata)
+
+    generic_with_article_level = build_request("journal", :atitle => "foo", 
+      :au => "Smith", :issn => "12345678", :volume => "2", :issue => "2", :spage => "12")
+    assert @service.should_link_out_to?(generic_with_article_level)    
+  end
+  
+  def test_query
+    aulast = build_request("journal", :atitle => "Human-Machine Collaborative Planning",
+      :aulast => "Allen", :au => "Ignore this", :genre => "article")    
+    assert_equal "allintitle: \"Human-Machine Collaborative Planning\" author:Allen", @service.construct_query(aulast)
+    
+    au_only = build_request("journal", :atitle => "Human-Machine Collaborative Planning",
+      :au => "Allen, James P.", :genre => "article")
+    assert_equal "allintitle: \"Human-Machine Collaborative Planning\" author:Allen author:James", @service.construct_query(au_only)        
+  end
+  
+  test_with_cassette("live make a link", :google_scholar_link) do
+    request = build_request("journal", :atitle => "Human-Machine Collaborative Planning",
+      :aulast => "Allen", :au => "Ignore this", :genre => "article")
+    
+    @service.handle(request)
+    
+    assert_present request.service_responses    
+  end
+  
+  test_with_cassette("live no link", :google_scholar_link) do
+    request = build_request("journal", :jtitle => "foo", :issn => "12345678")
+
+    @service.handle(request)
+    
+    assert_blank request.service_responses
+  end
+  
+end

data/test/unit/internet_archive_test.rb

@@ -0,0 +1,33 @@
+# tests for internet archive service
+# Only the the simplest of tests are done so far. To do more advanced tests,
+# request fixtures for more cases should be created.
+require 'test_helper'
+class InternetArchiveTest < ActiveSupport::TestCase  
+  extend TestWithCassette
+  fixtures :requests, :referents, :referent_values
+  
+  def setup    
+    @ia_default = ServiceStore.instantiate_service!("InternetArchive", nil)
+  end
+
+  test_with_cassette("momo by title author", :internet_archive) do
+    request = requests(:momo)
+    # Clear out the current responses.
+    request.service_responses.each do |service_response|
+      service_response.destroy
+    end
+    @ia_default.handle(request)
+    request.referent.referent_values.reset
+    request.dispatched_services.reset
+    request.service_responses.reset
+    fulltexts = request.get_service_type('fulltext')
+    assert((not fulltexts.empty?), "IA didn't return any fulltext")
+    assert_equal(1, fulltexts.length, "IA returned an unexpected number of fulltexts")
+    fulltext = fulltexts.first
+    assert_equal("http://archive.org/details/MomoOvveroLarcanaStoriaDeiLadriDiTempoEDellaBambinaCheRestitu", 
+      fulltext.url, "IA Service constructed an unexpected URL")
+    view_data = fulltext.view_data
+    assert((not view_data.nil?), "IA full text view data is nil")
+    assert_equal("the Internet Archive: Open Source Book", view_data[:display_text], "IA display text is unexpected")
+  end
+end

data/test/unit/permalink_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+class PermalinkTest < ActiveSupport::TestCase
+  fixtures :referents, :referent_values
+  test "new with values" do
+    referent = referents(:nytimes)
+    permalink = nil
+    assert_difference('Permalink.count') {
+      permalink = Permalink.new_with_values!(referent, "info:sid/sfxit.com:citation")
+    }
+    assert_equal(referent.id, permalink.referent_id)
+    assert_equal("info:sid/sfxit.com:citation", permalink.orig_rfr_id)
+    assert_not_nil(permalink.context_obj_serialized)
+    assert_equal("The New York times", permalink.restore_context_object.referent.jtitle)
+  end
+end

data/test/unit/service_store_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+class ServiceStoreTest < ActiveSupport::TestCase
+  setup :reset_service_store
+  teardown :reset_service_store, :force_lazy_load_service_store
+  
+
+  test "missing umlaut services yaml" do
+    FileUtils.mv(File.join(Rails.root, "config", "umlaut_services.yml"), File.join(Rails.root, "config", "umlaut_services.yml.moved"))
+    assert_nothing_raised{ ServiceStore.config }
+    FileUtils.mv(File.join(Rails.root, "config", "umlaut_services.yml.moved"), File.join(Rails.root, "config", "umlaut_services.yml"))
+  end
+
+  test "group added to service" do
+    sfx_definition = ServiceStore.service_definition_for("SFX")
+    assert_equal("default", sfx_definition["group"])
+    assert_equal("default", ServiceStore.instantiate_service!(sfx_definition, nil).group)
+  end
+
+  test "manually set services" do
+    # force original from disk  to load
+    ServiceStore.config 
+    ServiceStore.service_definitions
+
+    # But then set our own instead
+    ServiceStore.config = {
+      "default" => {
+        "services" => {
+          "dummy" => {"type" => "DummyService", "priority" => 3}
+        }
+      }
+    }
+
+    assert_length 1, ServiceStore.service_definitions
+    assert_present ServiceStore.service_definition_for("dummy")
+  end
+
+  
+  def reset_service_store
+    ServiceStore.reset!    
+  end
+  def force_lazy_load_service_store
+    ServiceStore.config
+    ServiceStore.service_definitions
+  end
+
+
+end

data/test/unit/service_test.rb

@@ -2,18 +2,33 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class ServiceTest < ActiveSupport::TestCase
   fixtures :requests
-  
-      # A service that does nothing!
-      class DummyService < Service
-        def handle(request)
-          return request.dispatched(self, true)
-        end
-      end      
-  
-    def setup
-      @dummy_config =  {"priority" => 1}
-      @umlaut_request = requests(:simple_request)
+
+  # A service that does nothing!
+  class DummyService < Service
+    def handle(request)
+      return request.dispatched(self, true)
+    end
+  end
+
+  # A preempted by service that does nothing!
+  class PreemptedByDummyService < Service
+    def initialize(config)
+      @preempted_by = ["existing_service" => "DummyService"]
+      super(config)
     end
 
-    
-end
+    def handle(request)
+      return request.dispatched(self, true)
+    end
+  end
+
+  def setup
+    @dummy_config =  {"priority" => 1, "service_id" => "DummyService"}
+    @umlaut_request = requests(:simple_request)
+  end
+
+  test "preempted by wildcard other type" do
+    DummyService.new(@dummy_config).handle(@umlaut_request)
+    assert(PreemptedByDummyService.new(@dummy_config).preempted_by(@umlaut_request))
+  end
+end