umlaut 4.0.3 → 4.1.0.pre.2

data/app/service_adaptors/internet_archive.rb

@@ -108,31 +108,30 @@ class InternetArchive < Service
     timeout(@http_timeout.to_i) {
       response = open(link).read
     }
+
     if response.blank?
       raise Exception.new("InternetArchive returned empty response for #{link}")      
     end
     
-    
     doc = MultiJson.load(response)
     results = doc['response']['docs']
     
     @mediatypes.each do |type|
-     type_results = get_results_by_type(results, type)
-
-
+      hits = matching_hits(request, search_terms, results, type)
 
      
       # if we have more results than we want to show in the main view
       # we can ceate a link (highlighted_link) to the search in the sidebar 
-      num_found = type_results.length #doc['response']['numFound']
-      if (@show_web_link and not type_results.empty? and @num_results_for_types[type] < num_found )
+
+      num_found = hits.length #doc['response']['numFound']
+      if (@show_web_link and not hits.empty? and @num_results_for_types[type] < num_found )
         do_web_link(request, search_terms, type, num_found) 
       end
 
       # Check for search inside only for first result of type 'text'
       if (@include_search_inside &&
           type == 'texts' &&
-          (first_hit = type_results[0]) && 
+          (first_hit = hits[0]) && 
           (identifier = first_hit["identifier"])
           )
         direct_url = URI.parse("http://www.archive.org/stream/" + identifier)
@@ -152,21 +151,21 @@ class InternetArchive < Service
           )
         end        
       end
-      
+
+
+
       # add a service response for each result for this mediatype
-      type_results.each_with_index do |result, index|
-        break if index == @num_results_for_types[type] 
+      hits.each_with_index do |result, index|
+        break if index >= @num_results_for_types[type] 
+
         display_name = @display_name
         
-        if ( result["collection"] && COLLECTION_LABELS[result["collection"][0]])
+        if result["contributor"] && result["contributor"].first
+          display_name += ": " + result["contributor"].first
+        elsif ( result["collection"] && COLLECTION_LABELS[result["collection"][0]])
           display_name += ": " + COLLECTION_LABELS[result["collection"][0]]
-        elsif ( result["collection"])
-          display_name += ": " + result["collection"][0].titlecase
         end
         
-        #note = result['title']
-        #note << " by " << result['creator'].join(', ') if result['creator']
-
         service_type = SERVICE_TYPE_MAP[type]
         request.add_service_response(
             :service=>self, 
@@ -175,7 +174,7 @@ class InternetArchive < Service
             :url=>create_result_url(result),
             :match_reliability => ServiceResponse::MatchUnsure,
             :edition_str => edition_str(result),
-            :service_type_value => service_type )
+            :service_type_value => service_type )        
       end  
     end
   end
@@ -262,20 +261,54 @@ class InternetArchive < Service
     
     return output
   end
-
   
-  def get_results_by_type(results, type)
-    results.map{|doc| doc if doc["mediatype"] == type}.compact
+  def matching_hits(request, search_terms, results, type)    
+    full_title = raw_search_title(request.referent)
+
+    hits =  results.find_all do |r|      
+      r["mediatype"] == type &&
+      titles_sufficiently_matched(search_terms[:title], full_title, r["title"])   
+    end
+
+    return hits
+  end
+
+  # Some obtuse code to heuristically decide if our query title and a result
+  # title fuzzily match sufficiently to be considered a match. 
+  def titles_sufficiently_matched(query_title, full_title, result)    
+    normalized_query      = normalize_title(query_title)
+    normalized_full_title = normalize_title(full_title)
+    # If the title has more than 3 words, and our IA query returned
+    # a result for it -- that's probably good enough. 
+    return true if normalized_query.split(" ").length > 3
+
+
+    # Otherwise, make multiple versions of the candidate
+    # title -- the whole thing, the title until the first colon,
+    # and the title until the first comma or semi-colon or other punct. Normalize
+    # them all. See if any of them match EITHER our search title or
+    # our full title. 
+    candidates = [
+      result,
+      result.split(":").first,
+      result.split(/[\;\,\(\)]/).first
+    ].compact.uniq.collect {|a| normalize_title(a)}
+    
+    return (candidates & [normalized_query, normalized_full_title]).present?
   end
 
   def edition_str(result)
-    parts = []
+    edition_str = ""
     
-    parts.push( result['title']) unless result['title'].blank?
-    parts.push( result['publisher'] ) unless result['publisher'].blank?
-    parts.push( result['year']) unless result['year'].blank?
+    edition_str << result['title'] unless result['title'].blank?
 
-    edition_str = parts.join(', ')
+    edition_str << " / #{result['creator'].first}" unless result['creator'].blank?
+    edition_str << ". #{result["publisher"].first}" unless result['publisher'].blank?
+    unless result['date'].blank?
+      year = result['date'].slice(0,4)
+      edition_str << ": #{year}"
+    end
+    
     edition_str = nil if edition_str.blank?
 
     return edition_str

data/app/service_adaptors/isi.rb

@@ -11,8 +11,9 @@
 # (LAMR) service api, which is used here. To register, see:
 # http://wokinfo.com/products_tools/products/related/amr/
 #
-# You register by IP address, so no API key is needed once your registration
-# goes through. 
+# You can register by IP address, so no auth key is needed once your registration
+# goes through -- or fill out 'username' and 'password' config elements in service
+# setup, and they will be used.
 #
 # If you later need to change the IP addresses entitled to use this API, use
 # http://scientific.thomson.com/scientific/techsupport/cpe/form.html.
@@ -126,8 +127,17 @@ class Isi < Service
     builder.request(:xmlns => "http://www.isinet.com/xrpc41", :src => "app.id=Umlaut") do
       builder.fn(:name => "LinksAMR.retrieve") do
         builder.list do
-          # first map is authentication info. empty 'map' element since we are IP authenticated. 
-          builder.map
+          # first map is authentication info. empty 'map' element if we are IP authenticated.
+          if @username && @password
+            builder.map do
+              builder.val(@username, :name => "username")
+              builder.val(@password, :name => "password")
+            end
+          else
+            builder.map
+          end
+
+
           # specify what we're requesting
           builder.map do
             builder.list(:name=>"WOS") do

data/app/service_adaptors/jcr.rb

@@ -12,8 +12,9 @@
 # register, see:
 # http://wokinfo.com/products_tools/products/related/amr/
 #
-# You register by IP address, so no API key is needed once your registration
-# goes through. 
+# You register by IP address, so no auth info is needed once your registration
+# goes through -- or you can receive a username and password, in which case
+# you should configure keys 'username' and 'password'
 #
 # If you later need to change the IP addresses entitled to use this API, use
 # http://scientific.thomson.com/scientific/techsupport/cpe/form.html.
@@ -76,8 +77,16 @@ class Jcr < Service
     builder.request(:xmlns => "http://www.isinet.com/xrpc41", :src => "app.id=Umlaut") do
       builder.fn(:name => "LinksAMR.retrieve") do
         builder.list do
-          # first map is authentication info. empty 'map' element since we are IP authenticated. 
-          builder.map
+          # first map is authentication info. empty 'map' element if we are IP authenticated.
+          if @username && @password
+            builder.map do
+              builder.val(@username, :name => "username")
+              builder.val(@password, :name => "password")
+            end
+          else
+            builder.map
+          end
+
           # specify what we're requesting
           builder.map do
             builder.list(:name=>"JCR") do

data/app/views/resolve/_fulltext.html.erb

@@ -6,7 +6,7 @@ end
 # order em with full fulltxt before title_level_fulltxt
 all_responses = fulltxt + title_level_fulltxt
 %>
-<div class="<%= section_css_classes(@user_request, "fulltext", all_responses).join(" ") %>">
+<div class="<%= section_css_classes(@user_request, "fulltext").join(" ") %>">
   <%= render 'section_heading', :presenter => renderer, :force_render => true %>
   <div class="umlaut_section_content">
     <%= list_with_limit('umlaut_fulltext', all_responses,

data/app/views/resolve/_section_display.html.erb

@@ -4,7 +4,7 @@
 -%>
 <% if presenter.visible? %>
   <% unless presenter.show_partial_only? %>
-    <div class="<%= section_css_classes(@user_request, presenter.div_id, []).join(" ") %>">
+    <div class="<%= section_css_classes(@user_request, presenter.div_id).join(" ") %>">
   <% end %>
   <%= render 'section_heading', :presenter => presenter %>
   <% unless presenter.show_partial_only? %>

data/app/views/resolve/_service_errors.html.erb

@@ -1,14 +1,14 @@
 <% 
 failed_dispatches = failed_service_dispatches()
 unless ( failed_dispatches.nil? || failed_dispatches.empty? ) %>
-  <div id="service_errors_content">
+  <div id="service_errors_content" class="alert alert-danger">
     <h5 class="warning"><i class="umlaut_icons-famfamfam-error"></i> <%= t 'umlaut.error.service_errors_title' %></h5>
     <ul class="list-unstyled">
       <% failed_dispatches.each do | dispatch | %>
         <li class="text-small">
           <%= t 'umlaut.error.services_missing' %><strong> <%= dispatch.service.service_types_generated.collect { |type|
-            type.display_name_pluralize}.join(", ")%></strong>
-          <%= t 'umlaut.resolve.from_service' %> <a class="collapse-toggle" data-target="<%= "#failed_dispatch_#{dispatch.id}"%>" data-toggle="collapse"><strong><%= dispatch.service.display_name %></strong></a>
+            type.display_name_pluralize}.uniq.join(", ")%></strong>
+          <%= t 'umlaut.resolve.from_service' %> <a class="collapse-toggle alert-link" data-target="<%= "#failed_dispatch_#{dispatch.id}"%>" data-toggle="collapse"><strong><%= dispatch.service.display_name %></strong></a>
           <% exception_info = dispatch.exception_info %>
           <div id="<%= "failed_dispatch_#{dispatch.id}"%>" class="collapse">
             <ul class="nav nav-list">

data/app/views/search/books.html.erb

@@ -3,7 +3,7 @@
   <h1>Books</h1>
   <%= form_tag({:controller=>'resolve', :action=>@submit_action}, {:method=>'get', :class=>"form-horizontal"}) %>
     <fieldset class="citationLinker">                                      
-      <%= hidden_field_tag "rfr_id", "info:sid/umlaut.code4lib.org:citation" %> 
+      <%= hidden_field_tag "rfr_id", umlaut_config.lookup!("rfr_ids.citation") %> 
       <%= hidden_field_tag "url_ver", "Z39.88-2004" %> 
       <%= hidden_field_tag "url_ctx_fmt", "info:ofi/fmt:kev:mtx:ctx" %> 
       <%= hidden_field_tag "ctx_ver", "Z39.88-2004" %> 

data/app/views/search/journal_search.html.erb

@@ -2,7 +2,8 @@
 <%= form_tag({:controller=>'search', :action=>'journal_search'}, {:method=>'get', :name=>'OpenURL', :id=>'OpenURL', :class => "form-inline form-very-inline"})  %>
   <div class="umlaut-search-form">
     <fieldset>
-      <%= hidden_field_tag "rfr_id", "info:sid/sfxit.com:citation" %> 
+
+      <%= hidden_field_tag "rfr_id", umlaut_config.lookup!("rfr_ids.citation") %> 
       <%= hidden_field_tag "rft.title", "", {:class => "rft_title"} %> 
       <%= hidden_field_tag "rft.object_id", "", {:class => "rft_object_id"} %> 
       <%= hidden_field_tag "rft.issn", "" %> 

data/app/views/search/journals.html.erb

@@ -8,7 +8,8 @@
   <div class="umlaut-search-form">
     <fieldset>                                      
       <legend><%=t 'umlaut.search.journals_instructions' %></legend>
-      <%= hidden_field_tag "rfr_id", "info:sid/sfxit.com:citation" %> 
+
+      <%= hidden_field_tag "rfr_id", umlaut_config.lookup!("rfr_ids.citation") %> 
       <%= hidden_field_tag "rft.date", "" %> 
       <%= hidden_field_tag "rft.title", "", {:class => "rft_title"} %> 
       <%= hidden_field_tag "rft.object_id", "", {:class => "rft_object_id"} %> 

data/db/orig_fixed_data/service_type_values.yml

@@ -3,129 +3,107 @@
 #
 # Which makes this file at present just a list of names and ids; if we had
 # to do it over, we'd do this differently. 
+#
+# You can add your own additional service types in a local app config/service_type_values.yml, 
+# or by calling ServiceTypeValue.merge_yml_file!(path_to_yml_file)
 fulltext:
-  id: 1
-  display_name: electronic_version
-  display_name_plural: electronic_versions
+  display_name: Electronic Version
+  display_name_plural: Electronic Versions
   
 holding:
-  id: 2
   display_name: Copy in Library
-  display_name_plural: copies_in_library
+  display_name_plural: Copies in Library
   
 document_delivery:
-  id: 3
   display_name: Request Service
-  display_name_plural: request_services
+  display_name_plural: Request Services
   
 help:
-  id: 4
   display_name: Help Link
-  display_name_plural: help_links
+  display_name_plural: Help Links
 
 # Not currently used
 web_link:
-  id: 5
   display_name: Web Result
-  display_name_plural: web_results
+  display_name_plural: Web Results
 
 # Not currently used. 
 relevant_link:
-  id: 6
   display_name: Closest Web Result
   
 abstract:
-  id: 11
   display_name: Abstract
-  display_name_plural: abstracts
+  display_name_plural: Abstracts
   
 table_of_contents:
-  id: 12
   display_name: Table of Contents
-  display_name_plural: tables_of_content
+  display_name_plural: Tables of Contents
 
 cover_image:
-  id: 13
   display_name: Cover Image
-  display_name_plural: cover_images
+  display_name_plural: Cover Images
 
 # "See also" links to known destinations, like Amazon or OCLC
 highlighted_link:
-  id: 14
   display_name: See Also Link
-  display_name_plural: see_also_links
+  display_name_plural: See Also Links
   
 # Link to search holdings, generally with a count given, ie "5 possible matches". 
 holding_search:
-  id: 15
   display_name: Copy in Library
-  display_name_plural: copies_in_library
+  display_name_plural: Copies in Library
   
 # This is meant for 'fulltext' from such sources as the OPAC/ILS, where
 # it will always be a title-level link, and dates of coverage usually
 # aren't checked. DEPRECATED. No longer used, use a fulltext wtih :coverage_checked
 # and/or :can_link_to_article set to false. 
 fulltext_title_level:
-  id: 16
   display_name: Electronic Text Version
   
 audio:
-  id: 17
   display_name: Digital Audio
 
 # A search inside tool, presented with a search box for user. 
 search_inside:
-  id: 18
   display_name: Search Inside Tool
 
 # A tool that will enhance the Referent metadata. Not always advertised
 # properly yet. 
 referent_enhance:
-  id: 19
   display_name: More Information
 
 # Link to partial text, as in Amazon or Google Books that don't have
 # full text, only excerpts. 
 excerpts:
-  id: 20
   display_name: Limited Excerpts
   
 cited_by:
-  id: 21
   display_name: Article that cites this
   display_name_plural: Articles that cite this
 
 # Used by ISI and Scopus at present. Maybe more later. 
 # "More like this" links. 
 similar:
-  id: 22
   display_name: "Similar Articles"
   
   
 # Not sure what this is used for. Think it's a typo for abstract. 
 description:
-  id: 100
   display_name: Description
   
 # Not sure if this is used for anything yet, but some services generate
 subject:
-  id: 101
   display_name: Subject
   
 # Not used yet by views
 similar_item:
-  id: 102
   display_name: Similar Item
 
 # Used to save/send the citation/holdings
 export_citation:
-  id: 103
   display_name: Export tool
-  display_name_plural: export_tools
+  display_name_plural: Export Tools
 
 primo_source:
-  id: 104
   display_name: Primo Source
 
-# If you want to add your own custom ones, make them start with ids at 100000,
-# to leave plenty of space for future standard umlaut ones. 

data/lib/aws_product_sign.rb

@@ -85,7 +85,7 @@ class AwsProductSign
     
     # chomp is important!  the base64 encoded version will have a newline at the end
     # which amazon does not want. 
-    digest  = OpenSSL::Digest::Digest.new('sha256')
+    digest  = OpenSSL::Digest.new('sha256')
     signature = Base64.encode64(OpenSSL::HMAC.digest(digest, secret_key, string_to_sign)).chomp
     
     params["Signature"] = signature

data/lib/generators/templates/umlaut_services.yml

@@ -1,4 +1,3 @@
-
   # Configure what service plugins are used by Umlaut. This skeleton file
   # has been generated into your app to help you get started. 
   #
@@ -8,10 +7,14 @@
   # Most services take other options for custom configuration too, not
   # all options are neccesarily listed as examples here, see source
   # or source-generated docs for more info.   
-
+  #
   # The services in the 'default' group are loaded every time. 
   # You can optionally create other groups of services, that can be loaded
   # by URL query params, or based on other request params. More info?
+  #
+  # This file is run through ERB, so you can use <%= %> tags for dynamic
+  # ruby content if you like. 
+  # 
 
 default:
     services:

data/lib/generators/umlaut/install_generator.rb

@@ -1,3 +1,4 @@
+require 'umlaut'
 require 'rails/generators'
 
 module Umlaut

data/{app/models → lib}/service_type_value.rb

@@ -2,7 +2,11 @@ require 'yaml'
 
 
 # This model is the actual list of valid service types. Not ActiveRecord,
-# just load from config files into memory (loaded on file load). 
+# just load from config/service_type_values.yml into memory (loaded on file load, initialization)
+#
+# This is stored in lib/ intentionally, to avoid Rails dev-mode auto-reloading, 
+# because we store state in this class, and reloading was losing state we
+# intentionally set, eg for plugins adding new service types. 
 #
 # ServiceTypeValues have human-displayable names, that are controlled by Rails I18n, 
 # using standard Rails I18n pluralization forms, so for instance:
@@ -13,6 +17,10 @@ require 'yaml'
 #
 # Other languages may have more complex pluralization rules, but Umlaut at present only
 # looks up a plural form for 10 items, so 'other' is probably all that is used. 
+#
+# If you want to load additional custom service type values from your own custom .yml file
+# (say in a plugin), do `ServiceTypeValue.merge_yml_file!( filepath_to_yml )`, perhaps
+# in an initializer. 
 class ServiceTypeValue   
   attr_accessor :name, :id
   attr_writer :display_name, :display_name_plural
@@ -25,10 +33,10 @@ class ServiceTypeValue
     end
   end
   
-  def self.find(name)
-    load_values! if values.nil?
+  def self.find(name)    
     values[name.to_sym] or raise ArgumentError.new("No ServiceTypeValue found for #{name}")
   end
+
   def self.[](name)
     find(name)
   end
@@ -52,24 +60,30 @@ class ServiceTypeValue
   
   # Loads from config files, distro and local, into memory.   
   def self.load_values!
-      # Load in starting set of ServiceTypeValue, merge in local defines. 
-      
-      service_type_values = YAML.load_file( @@distro_conf_file )
-      local_overrides = File.exists?( @@local_conf_file ) ?
-            YAML.load_file(@@local_conf_file) :
-            nil
-      # Merge in the params for each service type with possible
-      # existing params.
-      if ( local_overrides )
-        local_overrides.each do |name, params|
-          service_type_values[name] ||= {}          
-          service_type_values[name].merge!( params )          
-        end
-      end
-      
-      self.values = {}
-      service_type_values.each_pair do |name, hash|
-        self.values[name.to_sym] = ServiceTypeValue.new(hash.merge(:name => name))                              
-      end            
+    # Load in starting set of ServiceTypeValue, merge in local defines.       
+    self.merge_yml_file! @@distro_conf_file 
+    
+
+    if File.exists?( @@local_conf_file )
+      self.merge_yml_file! @@local_conf_file
+    end
+
+  end
+
+  def self.merge_hash!(definition_hash)
+    self.values ||= {}
+
+    definition_hash.each_pair do |name, value_hash|
+      self.values[name.to_sym] = ServiceTypeValue.new(value_hash.merge(:name =>  name))
+    end
   end
+
+  def self.merge_yml_file!(filepath)
+    self.merge_hash! YAML.load_file(filepath)
+  end
+
+  # We're doing this outside of a method body on purpose, when this
+  # file gets loaded, immediately load the default values. 
+  self.load_values!
+
 end

data/lib/umlaut/routes.rb

@@ -7,6 +7,8 @@ module Umlaut
   # app routes.rb, that line is generated into local app by Umlaut generator.
   # options include :only and :except to limit what route groups are generated. 
   class Routes
+    class_attribute :default_route_sets
+    self.default_route_sets = [:root, :permalinks, :a_z, :resolve, :open_search, :link_router, :export_email, :resources, :search, :javascript, :feedback]
 
     def initialize(router, options ={})
       @router = router
@@ -19,6 +21,37 @@ module Umlaut
       end
     end
 
+
+    # Experimental functionality for a plugin to add routes that automatically
+    # will get applied by Umlaut::Routes
+    #
+    #     Umlaut::Routes.register_routes( YourPlugin::RouteSets )
+    #
+    # Where YourPlugin::RouteSets is a module containing methods that defines
+    # routes similar to Umlaut::Routes::RouteSets below. 
+    #
+    # If some methods included in the module are not route-defining methods,
+    # pass a second arg listing just those that are:
+    #
+    #     Umlaut::Routes.register_routes(YourPlugin::RouteSets, [:magic, :underwater])
+    #
+    # All route_set_methods will be applied by default, but can be excluded
+    # on application with the standard Umlaut::RouteSet :only and :except args. 
+    #
+    # This design is somewhat experimental, we'll see if it meets real world use cases
+    # with maintainable code. 
+    def self.register_routes(module_obj, route_set_methods = nil)
+      if route_set_methods.nil?
+        # default to all methods defined in module
+        route_set_methods = module_obj.instance_methods
+      end
+
+      include module_obj
+      self.default_route_sets.concat route_set_methods
+
+      return self
+    end
+
     protected
 
     def add_routes &blk
@@ -30,10 +63,6 @@ module Umlaut
       (@options[:only] || default_route_sets) - (@options[:except] || []) + (@options[:admin] == true ? [:admin] : [])
     end
 
-    def default_route_sets
-      [:root, :permalinks, :a_z, :resolve, :open_search, :link_router, :export_email, :resources, :search, :javascript, :feedback]
-    end
-
     module RouteSets
       # for now include root generation in Umlaut auto-generation
       def root
@@ -101,7 +130,7 @@ module Umlaut
           # legacy with the index, to keep old bookmarks working, needs to come first
           get 'link_router/index(/:id)' => "link_router#index"
 
-          get 'link_router/:id'        => "link_router#index"
+          get 'link_router/:id'        => "link_router#index", :as => "link_router"
 
         end
       end