umlaut 3.3.1 → 4.0.0.beta1

data/test/unit/aws_product_sign_test.rb

@@ -7,7 +7,7 @@ require 'aws_product_sign'
 # Although that example itself has some bugs as of 12 may 09 doh.
 # it's output isn't actually valid.
 #
-class AwsProductSignTest < Test::Unit::TestCase
+class AwsProductSignTest < ActiveSupport::TestCase
 
   def setup
     @example_params = {
@@ -61,7 +61,7 @@ class AwsProductSignTest < Test::Unit::TestCase
   def test_add_signature
     new_params = @test_obj.add_signature( @example_params )
 
-    assert_not_nil( new_params["Timestamp"], "Adds timestamp" )
+    refute_nil( new_params["Timestamp"], "Adds timestamp" )
     assert_equal( @access_key, new_params["AWSAccessKeyId"], "Adds access key")
     assert_equal("F3xmBlY91rML36hkQTZn/N2Bk3ABIVB8NI+e/JCYpDQ=" ,     
         new_params["Signature"],
@@ -75,7 +75,7 @@ class AwsProductSignTest < Test::Unit::TestCase
 
     @test_obj.add_signature!(params)
 
-    assert_not_nil( params["Signature"], "Mutates input")
+    refute_nil( params["Signature"], "Mutates input")
     
   end
 

data/test/unit/collection_test.rb

@@ -1,6 +1,12 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require 'test_helper'
 
 class CollectionTest < ActiveSupport::TestCase
+    self.use_transactional_fixtures = false
+    extend TestWithCassette
+
+
+
+
     fixtures :requests, :referents, :referent_values, :sfx_urls
      
     def setup
@@ -34,6 +40,7 @@ class CollectionTest < ActiveSupport::TestCase
     end
 
     def test_service_level
+
       collection = Collection.new(@request , @services)
 
       services = collection.instantiate_services!(:level => 'c')
@@ -69,7 +76,36 @@ class CollectionTest < ActiveSupport::TestCase
 
       null_services = collection.instantiate_services!(:task => :no_such_task, :level => 1)
 
-      assert_equal [], null_services
-      
+      assert_equal [], null_services      
     end
+
+    # Allowing new episodes because some of our outgoing requests in current
+    # demo config are to non-existing hostnames, which VCR can't properly record. 
+    test_with_cassette("live dispatch", :collection, :record => :new_episodes, :match_requests_on => [:method, :uri_without_ctx_tim]) do        
+      request = fake_umlaut_request('/resolve?sid=google&auinit=S&aulast=Madsbad&atitle=Mechanisms+of+changes+in+glucose+metabolism+and+bodyweight+after+bariatric+surgery&id=doi:10.1016/S2213-8587(13)70218-3&title=The+Lancet+Diabetes+%26+Endocrinology&volume=2&issue=2&date=2014&spage=152&issn=2213-8587')
+
+      collection = Collection.new(request , @services)
+      # We don't care about exceptions for now
+      collection.forward_background_exceptions = false
+
+      bg_thread = collection.dispatch_services!
+
+      # some are still in background
+      bg_thread.join
+
+      # Check to make sure all services were recorded as
+      # dispatched, and with a completion status. We don't care
+      # if they were succesful or not, we're not testing the actual
+      # services, and some may have failed lacking api keys etc. We just
+      # care they are registered as finished. 
+
+      @services.each do |service|
+        dispatch = request.dispatched_services.to_a.find {|ds| ds.service_id = service[0]}
+
+        assert_present dispatch, "Dispatch not recorded for #{service[0]}"
+
+        assert dispatch.completed?, "Dispatch status '#{dispatch.status}' is not a finished status for #{service[0]}"
+      end
+    end   
+
 end

data/test/unit/determine_services_test.rb

@@ -47,11 +47,11 @@ class DetermineServicesTest <  ActiveSupport::TestCase
     service_list = @service_store.determine_services
 
     # default group services
-    assert_include service_list.keys, "default_a"
-    assert_include service_list.keys, "default_b"
+    assert service_list.keys.include? "default_a"
+    assert service_list.keys.include? "default_b"
 
     # but not the disabled one
-    assert_not_include service_list.keys, "default_disabled"
+    refute service_list.keys.include? "default_disabled"
 
     # No group1 or group2
     assert_nil service_list.keys.find {|key| key.start_with? "group1"}
@@ -62,11 +62,11 @@ class DetermineServicesTest <  ActiveSupport::TestCase
     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
+      assert service_list.keys.include? service_id
     end
 
     ["default_disabled", "group1_disabled", "group2_disabled"].each do |service_id|
-      assert_not_include service_list.keys, service_id
+      refute service_list.keys.include? service_id
     end
   end
 
@@ -77,8 +77,8 @@ class DetermineServicesTest <  ActiveSupport::TestCase
     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"
+    assert service_list.keys.include? "group1_a"
+    assert service_list.keys.include? "group1_b"
   end
 
   # Should this raise a clear error instead? For now, we ignore.
@@ -92,8 +92,8 @@ class DetermineServicesTest <  ActiveSupport::TestCase
 
     service_list = store.determine_services
 
-    assert_include service_list.keys, "default_a"
-    assert_include service_list.keys, "other_default_a"
+    assert service_list.keys.include? "default_a"
+    assert service_list.keys.include? "other_default_a"
   end
 
   def test_multi_default_disable
@@ -101,8 +101,8 @@ class DetermineServicesTest <  ActiveSupport::TestCase
 
     service_list = store.determine_services %w{-other_default}
 
-    assert_include service_list.keys, "default_a"
-    assert_not_include service_list.keys, "other_default_a"
+    assert service_list.keys.include? "default_a"
+    refute service_list.keys.include? "other_default_a"
   end
 
 

data/test/unit/dispatched_service_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class DispatchedServiceTest < ActiveSupport::TestCase
+
+  def test_can_generate_service_types
+    request = fake_umlaut_request("?title=foo")
+    ds      = DispatchedService.new(:service_id => "Ulrichs")
+    assert_equal ServiceStore.instantiate_service!("Ulrichs", request).service_types_generated, ds.can_generate_service_types
+  end
+
+  def test_can_generate_service_types_with_bum_service
+    ds = DispatchedService.new(:service_id => "no_such_service")
+    assert_equal [], ds.can_generate_service_types
+  end
+
+end

data/test/unit/dissertation_catch_test.rb

@@ -9,10 +9,9 @@ class DissertationCatchTest <  ActiveSupport::TestCase
   def test_blank_atitle
     context_object = OpenURL::ContextObject.new_from_kev("atitle=&title=Between+Us+and+Artistic+Appreciation%3a+Nabokov+and+the+Problem+of+Distortion&issn=04194209")
 
-    # Not sure how we get a blank atitle in there, but we want DissertationCatch to handle it
     referent       = Referent.new
     referent.set_values_from_context_object(context_object)
-    referent.ensure_value!("atitle", "")
+    referent.save!
     referent.referent_values(true) # reload
 
     DissertationCatch.new.filter(referent)

data/test/unit/google_book_search_test.rb

@@ -4,7 +4,6 @@
 require 'test_helper'
 class GoogleBookSearchTest < ActiveSupport::TestCase  
   extend TestWithCassette
-  fixtures :requests, :referents
   
   def setup    
     @gbs_default = ServiceStore.instantiate_service!("GoogleBookSearch", nil)
@@ -12,6 +11,7 @@ class GoogleBookSearchTest < ActiveSupport::TestCase
     @data_frankenstein = 
       {"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"}]}      
     
+    @frankenstein_request = fake_umlaut_request("/resolve?isbn=9780393964585&oclcnum=33045872&aufirst=Mary&auinitm=Wollstonecraft&aulast=Shelley&btitle=Frankenstein+%3A+the+1818+text%2C+contexts%2C+nineteenth-century+responses%2C+modern+criticism&date=1997&edition=1st+ed.&genre=book&place=New+York&pub=W.W.+Norton")
   end
 
   def test_initialize_minimum
@@ -23,9 +23,8 @@ class GoogleBookSearchTest < ActiveSupport::TestCase
     assert_equal('standard', gbs.task)
   end
   
-  def test_get_bibkeys
-    f = referents(:frankenstein)
-    keys = @gbs_default.get_bibkeys(f)
+  def test_get_bibkeys    
+    keys = @gbs_default.get_bibkeys(@frankenstein_request.referent)
     expected = CGI.escape('isbn:9780393964585 OR "OCLC33045872"')
     assert_equal(expected, keys)
   end
@@ -37,17 +36,16 @@ class GoogleBookSearchTest < ActiveSupport::TestCase
   # 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))
+    hashified_response = @gbs_default.do_query('OCLC2364071', @frankenstein_request)
     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)
+    # frankenstein's got fulltext now.     
     fulltext_shown = 
-      @gbs_default.create_fulltext_service_response(request, @data_frankenstein)
+      @gbs_default.create_fulltext_service_response(@frankenstein_request, @data_frankenstein)
     assert(fulltext_shown)
   end
 

data/test/unit/internet_archive_test.rb

@@ -4,14 +4,14 @@
 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)
+  test_with_cassette("momo by title author", :internet_archive) do    
+    request = fake_umlaut_request("/resolve?isbn=038519093X&aufirst=Michael&aulast=Ende&btitle=Momo&genre=book&isbn=038519093X&pub=Doubleday")
+    
     # Clear out the current responses.
     request.service_responses.each do |service_response|
       service_response.destroy
@@ -28,6 +28,7 @@ class InternetArchiveTest < ActiveSupport::TestCase
       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")
+
+    assert_equal("the Internet Archive: Open Source Books", view_data[:display_text], "IA display text is unexpected")
   end
 end

data/test/unit/permalink_test.rb

@@ -1,8 +1,10 @@
 require 'test_helper'
 class PermalinkTest < ActiveSupport::TestCase
   fixtures :referents, :referent_values
-  test "new with values" do
-    referent = referents(:nytimes)
+  test "new with values" do    
+    request  = fake_umlaut_request("/resolve?format=journal&issn=0362-4331&jtitle=The+New+York+times&sid=info%3Asid%2Fsfxit.com%3Acitation")
+    referent = request.referent
+
     permalink = nil
     assert_difference('Permalink.count') {
       permalink = Permalink.new_with_values!(referent, "info:sid/sfxit.com:citation")

data/test/unit/referent_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+
+class ReferentTest < ActiveSupport::TestCase
+
+
+  def test_enhance_referent
+    referent = Referent.new
+    referent.build_referent_value("title", "this is a title")  
+    referent.save!
+
+    another_reference = Referent.find(referent.id)
+    refute_same referent, another_reference
+
+    Rails.logger.info("----ENHANCE BEGIN----")
+
+    another_reference.enhance_referent("title", "new title")
+
+    Rails.logger.info("----ENHANCE END----")
+
+    # Make sure there's only one referent_value with key 'title', and it has
+    # our new value
+    rvs = another_reference.referent_values(true)
+
+    assert_length 1, rvs
+
+    assert_equal "title", rvs.first.key_name
+    assert_equal "new title", rvs.first.value
+  end
+
+  def test_create_by_context_object
+    url = "url_ver=Z39.88-2004&url_ctx_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Actx&ctx_ver=Z39.88-2004&ctx_tim=2014-09-03T09%3A56%3A22-04%3A00&ctx_id=&ctx_enc=info%3Aofi%2Fenc%3AUTF-8&rft.genre=article&rft.au=Chen%2C+Yu-Hui&rft.date=2009-05-01&rft.volume=60&rft.issue=5&rft.spage=953&rft.jtitle=Journal+of+the+American+Society+for+Information+Science+%26+Technology&rft.issn=15322882&rft.pub=Wiley-Blackwell&rft.atitle=An+exploration+into+the+practices+of+library+Web+usability+in+ARL+academic+libraries.&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft_id=info%3Adoi%2F10.1002%2Fasi.21032&rfr_id=http%3A%2F%2Fcatalyst.library.jhu.edu%2Fsearch%2Farticles"
+    co  = OpenURL::ContextObject.new_from_kev(url)    
+    rft = Referent.create_by_context_object(co)
+
+    assert rft.persisted?
+
+    rft_values = rft.referent_values
+    assert rft_values.all? {|rv| rv.persisted?}
+
+    [
+      ["atitle", "An exploration into the practices of library Web usability in ARL academic libraries."],
+      ['au', 'Chen, Yu-Hui'],
+      ['date', '2009-05-01'],
+      ['format', 'journal'],
+      ['genre', 'article'],
+      ['identifier', 'info:doi/10.1002/asi.21032'],
+      ['issn', '15322882'],
+      ['issue', '5'],
+      ['jtitle', 'Journal of the American Society for Information Science & Technology'],
+      ['pub', 'Wiley-Blackwell'],
+      ['spage', '953'],
+      ['volume', '60'],
+    ].each do |key, value|
+      assert (rft_values.find {|rv| rv.key_name == key && rv.value == value}), "Missing expected referent_value with key #{key}"
+    end
+  end
+
+
+end

data/test/unit/referent_to_citation_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 # Some basic tests for referent.to_citation, which returns a hash of various citation
 # information. 
-class ReferentToCitationTest < Test::Unit::TestCase
+class ReferentToCitationTest < ActiveSupport::TestCase
   # referent = make_test_referent("title=foo&au=bar&genre=book")
   def make_test_referent(openurl_kev)
     co = OpenURL::ContextObject.new_from_kev( openurl_kev )
@@ -19,7 +19,7 @@ class ReferentToCitationTest < Test::Unit::TestCase
     assert_equal "The monk",      cit_hash[:title]
     assert_equal "1797",          cit_hash[:date]
     assert_equal "Lewis, M. G.",  cit_hash[:author]
-    assert_equal "Book",    cit_hash[:title_label]
+    assert_equal "Book Title",    cit_hash[:title_label]
     assert_equal "Printed by William Porter", cit_hash[:pub]
   end
 
@@ -40,6 +40,33 @@ class ReferentToCitationTest < Test::Unit::TestCase
     assert_equal "Madsbad, S", cit_hash[:author]
     assert_equal "152", cit_hash[:page]
     assert_equal ["info:doi/10.1016/S2213-8587(13)70218-3"], cit_hash[:identifiers]
+  end
+
+  def test_type_of_thing
+    I18n.locale = "en"
+
+    ref = make_test_referent("&genre=dissertation&title=Foo&au=Smith")
+    assert_equal I18n.t("umlaut.citation.genre.dissertation"), ref.type_of_thing
+    assert_equal I18n.t("umlaut.citation.genre.dissertation"), ref.container_type_of_thing
 
+    ref = make_test_referent("rft_val_fmt=info:ofi/fmt:kev:mtx:dissertation&title=Foo")
+    assert_equal I18n.t("umlaut.citation.genre.dissertation"), ref.type_of_thing
+
+    ref = make_test_referent("sid=google&auinit=S&aulast=Madsbad&atitle=Mechanisms+of+changes+in+glucose+metabolism+and+bodyweight+after+bariatric+surgery&id=doi:10.1016/S2213-8587(13)70218-3&title=The+Lancet+Diabetes+%26+Endocrinology&volume=2&issue=2&date=2014&spage=152&issn=2213-8587")
+    assert_equal I18n.t("umlaut.citation.genre.article"), ref.type_of_thing
+    assert_equal I18n.t("umlaut.citation.genre.journal"), ref.container_type_of_thing
+
+    ref = make_test_referent("genre=bookitem&atitle=a+chapter&title=a+book")
+    assert_equal I18n.t("umlaut.citation.genre.bookitem"), ref.type_of_thing
+    assert_equal I18n.t("umlaut.citation.genre.book"), ref.container_type_of_thing
+
+    ref = make_test_referent("genre=unknown&atitle=a+chapter&title=a+book")
+    assert_nil ref.type_of_thing
+    assert_nil ref.container_type_of_thing
+
+    ref = make_test_referent("genre=invalid_made_up&atitle=a+chapter&title=a+book")
+    assert_nil ref.type_of_thing
+    assert_nil ref.container_type_of_thing
   end
+
 end

data/test/unit/request_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+# Some basic tests for referent.to_citation, which returns a hash of various citation
+# information. 
+class RequestTest < ActiveSupport::TestCase
+
+  test "add_service_response" do
+    request = fake_umlaut_request("/resolve?title=foo&author=bar")
+    request.service_responses.to_a
+    service = DummyService.new("priority" => 3, "service_id" => "DummyService")
+
+    request.add_service_response(
+      :service=>service, 
+      :url=>"http://example.com",
+      :display_text=>"something",      
+      :service_type_value => :highlighted_link
+    )
+
+    assert_length 1, request.service_responses
+
+    response = request.service_responses.first
+
+    assert_equal service.service_id, response.service_id
+
+    assert_equal request.id,           response.request.id
+    assert_equal ServiceTypeValue[:highlighted_link], response.service_type_value
+
+    assert_equal "http://example.com", response.view_data[:url]
+    assert_equal "something",          response.view_data[:display_text]
+
+  end
+
+  test "get_service_type_with_bum_response" do
+    request = fake_umlaut_request("/resolve?title=foo&author=bar")
+    request.add_service_response(
+      :service => Service.new('service_id' => "NO_SUCH", "priority" => 3),      
+      :service_type_value => :highlighted_link
+    )
+    request.add_service_response(
+      :service => ServiceStore.instantiate_service!('DummyService', request),
+      :service_type_value => :highlighted_link
+    )
+
+    assert_length 1, request.get_service_type(:highlighted_link)
+
+  end
+
+end

data/test/unit/service_response_test.rb

@@ -1,9 +1,68 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class ServiceResponseTest < Test::Unit::TestCase
+class ServiceResponseTest < ActiveSupport::TestCase
 
-  # Replace this with your real tests.
-  def test_truth
-    assert true
+  def test_view_data
+    sr = ServiceResponse.new
+    sr.take_key_values(
+      :service_id => "DummyService",
+      :display_text => "Display text",
+      :notes => "notes",
+      :my_own_key => "my_own_key",
+      :service_type_value => :fulltext
+    )
+
+    assert_equal "Display text", sr.view_data[:display_text]
+    assert_equal "Display text", sr.view_data['display_text']
+
+    assert_equal "notes", sr.view_data[:notes]
+    assert_equal "notes", sr.view_data["notes"]
+
+    assert_equal "my_own_key", sr.view_data[:my_own_key]
+    assert_equal "my_own_key", sr.view_data['my_own_key']
+
+    assert sr.view_data[:service_type_value].present?
+    assert_equal "fulltext", sr.view_data[:service_type_value]
+  end
+
+  # A service that does nothing!
+  class DummyService < Service
+    def handle(request)
+      return request.dispatched(self, true)
+    end
+
+    # Optional method for display-time transformations
+    # of view_datahash
+    def transform_view_data(hash)
+      hash[:added_by_transform_view_data] = "added by transform"
+      return hash
+    end
   end
+
+  def test_view_data_i18n
+    I18n.backend.store_translations("en", 
+        {"umlaut" => 
+          {"services" => 
+            { "service_response_test/dummy_service" => 
+                {"localized_text" => "localized text value"},
+            }
+          }
+        }
+      )
+
+    I18n.with_locale("en") do
+      sr = ServiceResponse.new
+      sr.instance_variable_set("@service", DummyService.new({'service_id' => "dummy", 'priority' => '3'}))      
+      sr.take_key_values(:display_text => "raw text", :display_text_i18n => "localized_text")
+
+      assert_equal "localized text value", sr.view_data[:display_text]
+    end
+  end
+
+  def test_transform_view_data
+    sr = ServiceResponse.new
+    sr.instance_variable_set("@service", DummyService.new({'service_id' => "dummy", 'priority' => '3'}))      
+    assert_equal "added by transform", sr.view_data[:added_by_transform_view_data]      
+  end
+
 end