umlaut 3.0.0alpha9 → 3.0.0alpha10

data/lib/exlibris/primo/source/distribution/nyu_aleph.rb

@@ -1,6 +1,4 @@
-require 'nokogiri'
-
-module Exlibris::Primo::Source::Local
+module Exlibris::Primo::Source
   # == Overview
   # NYUAleph is an Exlibris::Primo::Source::Aleph that expands Primo availlibrary
   # elements based on of Aleph items return from the Aleph REST APIs.
@@ -96,35 +94,7 @@ module Exlibris::Primo::Source::Local
             ) unless @aleph_helper.nil? or @aleph_item_adm_library.nil?
         @id_one = aleph_collection unless aleph_collection.nil?
         # Set status and status code.
-        aleph_status_code, aleph_status = nil, nil
-        # Loop through source config for statuses
-        aleph_config["statuses"].each { |aleph_config_status_code, aleph_config_status|
-          # Set checked out as Aleph status and code
-          aleph_status_code = aleph_config_status_code and 
-            aleph_status = "Due: " + @aleph_item_circulation_status and
-              break if (aleph_config_status_code == "checked_out" and 
-                aleph_config_status === @aleph_item_circulation_status)
-          # Set circulation statuses like On Shelf, Billed as Lost, as Aleph status and code
-          aleph_status_code = aleph_config_status_code and
-              break if (aleph_config_status.instance_of?(Array) and 
-                aleph_config_status.include?(@aleph_item_circulation_status))
-        } unless aleph_config.nil? or aleph_config["statuses"].nil?
-        if (aleph_status_code.nil?)
-          # Set Aleph web text as Aleph status if we haven't already gotten the Aleph status
-          aleph_status = @aleph_helper.item_web_text(
-            :adm_library_code => @aleph_item_adm_library.downcase,
-            :sub_library_code => @aleph_item_sub_library_code,
-            :item_status_code => @aleph_item_status_code,
-            :item_process_status_code => @aleph_item_process_status_code
-          ) unless @aleph_helper.nil? or @aleph_item_adm_library.nil?
-          # Set code as "overridden_by_nyu_aleph"
-          aleph_status_code = "overridden_by_nyu_aleph" unless aleph_status.nil?
-        end
-        # Set status code if we have it.
-        @status_code = aleph_status_code unless aleph_status_code.nil?
-        # Set status.
-        @status = (aleph_status.nil?) ? 
-          decode(:status, {:address => "statuses"}, true) : aleph_status
+        @status_code, @status = get_status
         # Aleph doesn't work right so we have to push the patron to the Aleph holdings page!
         @request_url = url if requestable?
         # We're through a second time, so we should be alright to 
@@ -171,7 +141,43 @@ module Exlibris::Primo::Source::Local
       return source_data
     end
 
-    def get_coverage(aleph_record)      
+    def get_status
+      # Initialize status and status code.
+      aleph_status_code, aleph_status = nil, nil
+      # Loop through source config for statuses
+      aleph_config["statuses"].each { |aleph_config_status_code, aleph_config_status|
+        # Set checked out as Aleph status and code
+        aleph_status_code = aleph_config_status_code and 
+          aleph_status = "Due: " + @aleph_item_circulation_status and
+            break if (aleph_config_status_code == "checked_out" and 
+              aleph_config_status === @aleph_item_circulation_status)
+        # Set circulation statuses like On Shelf, Billed as Lost, as Aleph status and code
+        aleph_status_code = aleph_config_status_code and
+            break if (aleph_config_status.instance_of?(Array) and 
+              aleph_config_status.include?(@aleph_item_circulation_status))
+      } unless aleph_config.nil? or aleph_config["statuses"].nil?
+      deferred_statuses = (aleph_config["deferred_statuses"].nil?) ? {} : aleph_config["deferred_statuses"]
+      if (aleph_status_code.nil? or deferred_statuses.include?(aleph_status_code))
+        # Set Aleph web text as Aleph status if we haven't already gotten the Aleph status
+        aleph_status = @aleph_helper.item_web_text(
+          :adm_library_code => @aleph_item_adm_library.downcase,
+          :sub_library_code => @aleph_item_sub_library_code,
+          :item_status_code => @aleph_item_status_code,
+          :item_process_status_code => @aleph_item_process_status_code
+        ) unless @aleph_helper.nil? or @aleph_item_adm_library.nil?
+        # Set code as "overridden_by_nyu_aleph"
+        aleph_status_code = "overridden_by_nyu_aleph" unless aleph_status.nil?
+      end
+      # Set status code if we have it.
+      status_code = aleph_status_code unless aleph_status_code.nil?
+      # Set status.
+      status = (aleph_status.nil?) ? 
+        decode(:status, {:address => "statuses"}, true) : aleph_status
+      return status_code, status
+    end
+
+    def get_coverage(aleph_record)
+      require 'nokogiri'
       locations_seen = []
       coverage = []
       return coverage unless display_type.upcase == "JOURNAL"
@@ -180,7 +186,7 @@ module Exlibris::Primo::Source::Local
       raise "Error getting bib from Aleph REST APIs. #{aleph_record.error}" unless aleph_record.error.nil?
       # Parse and process bib XML
       # First look at bib 866 and record sub_library and collection (through aleph config mappings)
-      Nokogiri::XML(aleph_bib).search("//datafield[@tag='866']") do |bib_866|
+      Nokogiri::XML(aleph_bib).search("//datafield[@tag='866']").each do |bib_866|
         bib_866_l = bib_866.at(
           "subfield[@code='l']"
         ).inner_text unless bib_866.at("subfield[@code='l']").nil?
@@ -203,9 +209,20 @@ module Exlibris::Primo::Source::Local
             :sub_library_code => bib_866_sub_library_code,
             :collection_code => bib_866_collection_code
           ) unless @aleph_helper.nil? or bib_866_adm_library.nil?
-          coverage.push(
-            "Available in #{bib_866_collection}: #{build_coverage_string(bib_866_j, bib_866_k)}".strip
-          ) unless bib_866_collection.nil? or bib_866_j.nil? and bib_866_k.nil?
+          unless bib_866_collection.nil?
+            unless bib_866_j.nil? and bib_866_k.nil?
+              coverage.push(
+                "Available in #{bib_866_collection}: #{build_coverage_string(bib_866_j, bib_866_k)}".strip
+              )
+            else
+              bib_866_i = bib_866.at(
+                "subfield[@code='i']"
+              ).inner_text unless bib_866.at("subfield[@code='i']").nil?
+              coverage.push(
+                "#{bib_866_i}".strip
+              ) unless bib_866_i.nil?
+            end
+          end
           locations_seen.push({
             :adm_library => bib_866_adm_library, 
             :sub_library_code => bib_866_sub_library_code })
@@ -216,7 +233,7 @@ module Exlibris::Primo::Source::Local
       # Parse and process holding XML
       # Now look at holding 866 and record sub_library and collection 
       # to see if there is anything we missed
-      Nokogiri::XML(aleph_holdings).search("//holding") do |aleph_holding|
+      Nokogiri::XML(aleph_holdings).search("//holding").each do |aleph_holding|
         holding_sub_library_code = aleph_holding.at(
           "//datafield[@tag='852']/subfield[@code='b']"
         ).inner_text unless aleph_holding.at("//datafield[@tag='852']/subfield[@code='b']").nil?
@@ -230,6 +247,10 @@ module Exlibris::Primo::Source::Local
           next if locations_seen.include?({
             :adm_library => holding_adm_library, 
             :sub_library_code => holding_sub_library_code })
+          holding_852_z = aleph_holding.at(
+            "//datafield[@tag='852']/subfield[@code='z']"
+          ).inner_text unless aleph_holding.at("//datafield[@tag='852']/subfield[@code='z']").nil?
+          coverage.push("Note: #{holding_852_z}") unless holding_852_z.nil?
           holding_collection = @aleph_helper.collection_text(
             :adm_library_code => holding_adm_library.downcase,
             :sub_library_code => holding_sub_library_code,

data/lib/exlibris/primo_ws.rb

@@ -1,7 +1,7 @@
 # Module for calling Primo Web Services
 # Please note the following:
 # * Be sure to configure the Primo Back Office with the relevant IPs to enable interaction via the Web Services
-# * This module does not parse the response but instead stores it as an Hpricot::Doc for the calling classes to parse
+# * This module does not parse the response but instead stores it as an Nokogiri::XML::Document for the calling classes to parse
 module Exlibris::PrimoWS
   require 'nokogiri'
 

data/lib/service.rb

@@ -67,7 +67,7 @@ class Service
           # handle both cases.
           raise NameError if value.nil?          
       rescue NameError
-      raise ArgumentError.new("Missing Service configuration parameter. Service type #{self.class} (id: #{self.id}) requires a config parameter named '#{param}'. Check your config/umlaut_config/services.yml file.")
+      raise ArgumentError.new("Missing Service configuration parameter. Service type #{self.class} (id: #{self.service_id}) requires a config parameter named '#{param}'. Check your config/umlaut_config/services.yml file.")
       end      
     end    
   end

data/lib/service_adaptors/primo_service.rb

@@ -24,6 +24,7 @@
 # * table_of_contents - parsed from links/linktotoc elements in the PNX record
 # * referent_enhance - metadata parsed from the addata section of the PNX record when the record was found by Primo id
 # * cover_image - parsed from first addata/lad02 element in the PNX record
+# * highlighted_link - parsed from links/addlink elements in the PNX record
 #
 # ==Available Parameters
 # Several configurations parameters are available to be set in services.yml, e.g.
@@ -44,6 +45,7 @@
 #       - table_of_contents
 #       - referent_enhance
 #       - cover_image
+#       - highlighted_link
 # base_url:: _required_ host and port of Primo server; used for Primo web services, deep links and holding_search
 # base_path:: *DEPRECATED* previous name of base_url
 # vid:: _required_ view id for Primo deep links and holding_search.
@@ -127,6 +129,7 @@ class PrimoService < Service
     @holding_attributes = Exlibris::Primo::Holding.base_attributes
     @rsrc_attributes = Exlibris::Primo::Rsrc.base_attributes
     @toc_attributes = Exlibris::Primo::Toc.base_attributes
+    @related_link_attributes = Exlibris::Primo::RelatedLink.base_attributes
     # TODO: Run these decisions by Bill M. to see if they make sense.
     @referent_enhancements = {
       # Prefer SFX journal titles to Primo journal titles
@@ -143,6 +146,7 @@ class PrimoService < Service
     }
     @suppress_urls = []
     @suppress_tocs = []
+    @suppress_related_links = []
     @suppress_holdings = []
     @service_types = [ "fulltext", "holding", "holding_search",
       "table_of_contents", "referent_enhance", "cover_image" ] if @service_types.nil?
@@ -164,7 +168,7 @@ class PrimoService < Service
     # Set holding_search_institution to vid and print warning in the logs.
     if @service_types.include?("holding_search") and @holding_search_institution.nil?
       @holding_search_institution = @institution
-      RAILS_DEFAULT_LOGGER.warn("Required parameter 'holding_search_institution' was not set.  Please set the appropriate value in services.yml.  Defaulting institution to view id, #{@vid}.")
+      Rails.logger.warn("Required parameter 'holding_search_institution' was not set.  Please set the appropriate value in services.yml.  Defaulting institution to view id, #{@vid}.")
     end # End backward compatibility maintenance
     raise ArgumentError.new(
       "Missing Service configuration parameter. Service type #{self.class} (id: #{self.id}) requires a config parameter named 'holding_search_institution'. Check your config/umlaut_config/services.yml file."
@@ -211,7 +215,7 @@ class PrimoService < Service
       Rails.logger.error(
         "Error in Exlibris::Primo::Searcher. "+ 
         "Returning 0 Primo services for search #{search_params.inspect}. "+ 
-        "Exlibris::Primo::Searcher raised the following exception:\n#{e}")
+        "Exlibris::Primo::Searcher raised the following exception:\n#{e}\n#{e.backtrace.inspect}")
       return request.dispatched(self, true)
     end
     # Enhance the referent with metadata from Primo Searcher if primo id is present
@@ -226,7 +230,9 @@ class PrimoService < Service
       end
     end
     # Get cover image only if primo_id is defined
-    if primo_id and @service_types.include?("referent_enhance")
+    # TODO: make cover image service smarter and only 
+    # include things that are actually URLs.
+    if primo_id and @service_types.include?("cover_image")
       cover_image = primo_searcher.cover_image
       unless cover_image.nil?
         request.add_service_response(
@@ -344,6 +350,33 @@ class PrimoService < Service
         )
       end
     end
+    if @service_types.include?("highlighted_link")
+      # Let's find any related links, and add highlighted link responses for those.
+      related_links_seen = [] # for de-duplicating urls from catalog.
+      primo_searcher.related_links.each do |related_link|
+        url = related_link.url # actual url
+        next if related_links_seen.include?(related_link.url)
+        # We have our own list of URLs to suppress, array of strings
+        # or regexps.
+        next if @suppress_related_links.find {|suppress| suppress === related_link.url}
+        # No url? Forget it.
+        next if related_link.url.nil?
+        related_links_seen.push(related_link.url)
+        service_data = {}
+        @related_link_attributes.each do |attr|
+          service_data[attr] = related_link.method(attr).call
+        end
+        # Default display text to URL.
+        service_data[:display_text] = (service_data[:display].nil?) ? service_data[:url] : service_data[:display]
+        # Add the response
+        request.add_service_response(
+          service_data.merge(
+            :service => self,
+            :service_type_value => 'highlighted_link'
+          )
+        )
+      end
+    end
     return request.dispatched(self, true)
   end
 
@@ -358,8 +391,8 @@ class PrimoService < Service
   
   private
   def primo_config
-    default_file = "#{Rails.root}/config/umlaut_config/primo.yml"
-    config_file = @primo_config.nil? ? default_file : "#{Rails.root}/config/umlaut_config/"+ @primo_config
+    default_file = "#{Rails.root}/config/primo.yml"
+    config_file = @primo_config.nil? ? default_file : "#{Rails.root}/config/"+ @primo_config
     Rails.logger.warn("Primo config file not found: #{config_file}.") and return {} unless File.exists?(config_file)
     config_hash = YAML.load_file(config_file)
     return (config_hash.nil?) ? {} : config_hash

data/lib/service_adaptors/primo_source.rb

@@ -3,7 +3,7 @@
 # This mechanism allows linking to original data sources and expanded holdings information
 # based on those sources and can be implemented per source.
 # To create a Primo source holding, you first must create a local class representing the source in
-# module Exlibris::Primo::Source::Local which extends Exlibris::Primo::Holding.
+# module Exlibris::Primo::Source which extends Exlibris::Primo::Holding.
 # Two methods are then available for overriding:
 #     :expand -   expand holdings that may have been collapsed into a single availlibrary element 
 #                 in Primo based on information from the source
@@ -24,7 +24,7 @@
 # ==Examples
 # Two examples of customized sources are:
 # * Exlibris::Primo::Source::Aleph 
-# * Exlibris::Primo::Source::Local::NYUAleph 
+# * Exlibris::Primo::Source::NYUAleph 
 class PrimoSource < PrimoService
 
   # Overwrites PrimoService#new.

data/lib/service_adaptors/sfx.rb

@@ -109,6 +109,17 @@ class Sfx < Service
     transport = OpenURL::Transport.new(@base_url, nil, :open_timeout => @sfx_timeout, :read_timeout => @sfx_timeout)
     
     context_object = request.to_context_object
+    
+    ## SFX HACK WORKAROUND
+    # SFX will parse private_data/pid/rft_dat containing ERIC, when sid/rfr_id
+    # is CSA. But it only expects an OpenURL 0.1 to do this. We send it a
+    # 1.0. To get it to recognize it anyway, we need to send it a blank
+    # url_ver/ctx_ver
+    if ( context_object.referrer.identifiers.find {|i| i.start_with? "info:sid/CSA"} &&
+         context_object.referent.private_data != nil)
+      context_object.openurl_ver = ""
+    end
+    
     transport.add_context_object(context_object)
     transport.extra_args["sfx.response_type"]="multi_obj_xml"
       

data/lib/term_color.rb

@@ -3,8 +3,15 @@
 
 module TermColor
   mattr_accessor :colorize_logging
-  self.colorize_logging = Rails.application.config.colorize_logging
-  
+  # is nil in dev in rails 3.2, but supposed to default to true. okay. 
+  self.colorize_logging = if Rails.application.config.colorize_logging.nil?
+    # In Rails 3.2, somehow we can't count on config.colorize_logging being
+    # set, okay, as a default colorize in development only. 
+    Rails.env == "development"
+  else
+    Rails.application.config.colorize_logging
+  end
+
     # Embed in a String to clear all previous ANSI sequences.
     CLEAR   = "\e[0m"
     BOLD    = "\e[1m"

data/lib/umlaut/version.rb

@@ -1,3 +1,3 @@
 module Umlaut
-  VERSION = "3.0.0alpha9"
+  VERSION = "3.0.0alpha10"
 end

data/lib/umlaut_configurable.rb

@@ -72,6 +72,9 @@ module UmlautConfigurable
       # (see lib/referent_filters )        
       add_referent_filters!( :match => /.*/, :filter => DissertationCatch.new ) 
       
+      
+      # Create a permalink short URL for every request?
+      create_permalinks true
         
       # skip_resolve_menu can be used to control 'direct' linking, skipping
       # the resolve menu to deliver a full text link or other resource
@@ -206,6 +209,12 @@ module UmlautConfigurable
       # Output timing of service execution to logs
       log_service_timing (Rails.env == "development")
       
+      # Execute service wave concurrently with threads?
+      # Set to false to execute serially one after the other with
+      # no threads instead. At this point, believed only useful
+      # for debugging and analysis. 
+      threaded_service_wave true
+      
       
       #####
       # Pieces of content on a Resolve page can be declaritively configured. 

data/test/dummy/config/umlaut_services.yml

@@ -27,6 +27,26 @@ default:
         base_url: YOUR_SFX_BASE_URL
         priority: 3      
       
+      Primo:
+        type: PrimoService
+        disabled: false
+        display_name: Primo
+        priority: 3      
+        base_url: http://bobcat.library.nyu.edu
+        vid: NYU
+        institution: NYU
+        holding_search_institution: NYU
+        holding_search_text: Search for this title in Primo.
+        suppress_holdings: [ !ruby/regexp '/\$\$LBWEB/', !ruby/regexp '/\$\$LNWEB/', !ruby/regexp '/\$\$LTWEB/', !ruby/regexp '/\$\$LWEB/', !ruby/regexp '/\$\$1Restricted Internet Resources/' ]
+        ez_proxy: !ruby/regexp '/https\:\/\/ezproxy\.library\.nyu\.edu\/login\?url=/'
+        service_types:
+          - holding
+          - holding_search
+          - fulltext
+          - table_of_contents
+          - referent_enhance
+          - cover_image
+
         
       # First half of Amazon, run in foreground, get metadata and cover images.
       Amazon:

data/test/unit/aleph_patron_test.rb

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../test_helper'
-class AlephPatronTest < ActiveSupport::TestCase
+require 'test_helper'
+class AlephPatronTest < Test::Unit::TestCase
   def setup
-    @primo_config = YAML.load_file("#{Rails.root}/config/umlaut_config/primo.yml")
+    @primo_config = YAML.load_file("#{Rails.root}/config/primo.yml")
     @nyu_aleph_config = @primo_config["sources"]["nyu_aleph"]
     @rest_url = @nyu_aleph_config["rest_url"]
     @aleph_doc_library = "NYU01"
@@ -17,9 +17,9 @@ class AlephPatronTest < ActiveSupport::TestCase
   # Test exception handling for bogus response.
   def test_bogus_response
     patron = Exlibris::Aleph::Patron.new(@nyuidn, @bogus_url)
-    assert_raise(REXML::ParseException) { patron.loans }
-    assert_raise(REXML::ParseException) { patron.renew_loans() }
-    assert_raise(REXML::ParseException) { patron.renew_loans(@aleph_renew_item_id) }
+    assert_raise(MultiXml::ParseError) { patron.loans }
+    assert_raise(MultiXml::ParseError) { patron.renew_loans() }
+    assert_raise(MultiXml::ParseError) { patron.renew_loans(@aleph_renew_item_id) }
     assert_raise(RuntimeError) { patron.place_hold(@aleph_adm_library, @aleph_doc_library, @aleph_doc_number, @aleph_item_id, {:pickup_location => @pickup_location}) }
   end
 

data/test/unit/aleph_record_benchmarks.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../test_helper'
-class AlephRecordBenchMarks < ActiveSupport::TestCase
+class AlephRecordBenchMarks < Test::Unit::TestCase
   def setup
     @primo_config = YAML.load_file("#{Rails.root}/config/umlaut_config/primo.yml")
     @nyu_aleph_config = @primo_config["sources"]["nyu_aleph"]

data/test/unit/aleph_record_test.rb

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../test_helper'
-class AlephRecordTest < ActiveSupport::TestCase
+require 'test_helper'
+class AlephRecordTest < Test::Unit::TestCase
   def setup
-    @primo_config = YAML.load_file("#{Rails.root}/config/umlaut_config/primo.yml")
+    @primo_config = YAML.load_file("#{Rails.root}/config/primo.yml")
     @nyu_aleph_config = @primo_config["sources"]["nyu_aleph"]
     @rest_url = @nyu_aleph_config["rest_url"]
     @aleph_doc_library = "NYU01"
@@ -14,7 +14,7 @@ class AlephRecordTest < ActiveSupport::TestCase
     aleph_record = Exlibris::Aleph::Record.new(@aleph_doc_library, @aleph_doc_number, @bogus_url)
     assert_raise(RuntimeError) { aleph_record.bib }
     assert_raise(RuntimeError) { aleph_record.holdings }
-    assert_raise(REXML::ParseException) { aleph_record.items }
+    assert_raise(MultiXml::ParseError) { aleph_record.items }
   end
 
   # Test search for a single Primo document.