umlaut 3.0.0beta5 → 3.0.0beta6

data/app/views/admin/service_errors/_dispatched_service.html.erb

@@ -2,8 +2,10 @@
   <td><%= dispatched_service.updated_at.localtime.to_s(:short) %></td>
   <td><%= dispatched_service.service_id %></td>    
   <td><%= dispatched_service.status %></td>
-  <td><%= link_to "[Re-request live]", url_for_with_co({:controller => "/resolve", :action => :index, "umlaut.force_new_request" => "true"},  dispatched_service.request.to_context_object) %></td>
-  <td><%= link_to "[View cached request]", url_for(:controller => "/resolve", :action => :index, "umlaut.request_id" => dispatched_service.request_id ) %></td>
+  <% if dispatched_service.request %>
+    <td><%= link_to "[Re-request live]", url_for_with_co({:controller => "/resolve", :action => :index, "umlaut.force_new_request" => "true"},  dispatched_service.request.to_context_object) %></td>
+    <td><%= link_to "[View cached request]", url_for(:controller => "/resolve", :action => :index, "umlaut.request_id" => dispatched_service.request_id ) %></td>
+  <% end %>
 </tr>
 <tr>
 <% if dispatched_service.exception_info %>

data/app/views/admin/service_errors/index.html.erb

@@ -13,7 +13,7 @@
   
   <% if params[:service_id] %>
     <h2>Service: <%= params[:service_id] %></h2>
-    <%= link_to "[View All]", params.merge(:service_id => nil) %>
+    <%= link_to "[View All]", params.merge(:service_id => nil, :offset => nil) %>
   <% else %>
     <h2>By service</h2>
     
@@ -37,9 +37,14 @@
   
   <p>
   <%= @offset + 1 %> - <%= [@offset + @limit, @dispatched_services_count].min  %> of <%= @dispatched_services_count %>. <%= link_to "[Next]", params.merge("offset" => @offset + @limit ) %>
+  </p>
   
   <table>
   <%= render  :partial => "dispatched_service", :collection => @dispatched_services %>  
   </table>
+
+  <p>
+  <%= @offset + 1 %> - <%= [@offset + @limit, @dispatched_services_count].min  %> of <%= @dispatched_services_count %>. <%= link_to "[Next]", params.merge("offset" => @offset + @limit ) %>
+  </p>
   
 </div>

data/lib/service_adaptors/amazon.rb

@@ -94,8 +94,15 @@ class Amazon < Service
     isbn = request.referent.metadata['isbn']
     isbn = isbn.gsub(/[^0-9X]/,'') if isbn
     
-    return request.dispatched(self, true) if isbn.blank?
+    # does it look like a good ISBN?
+    return request.dispatched(self, true) if isbn.blank? || ! [10,13].include?(isbn.length)
 
+    # Make sure it's REALLY a good ISBN, and 
+    # Convert 13 to 10 if neccesary, cause we're using it as an ASIN.     
+    # An ISBN-13 is never an ASIN.    
+    isbn = ISBN.ten( isbn )
+    
+    
     begin
 
       selected_aws_vals = {}
@@ -137,10 +144,7 @@ class Amazon < Service
     # We're assuming the ISBN is the ASIN Amazon ID. Not neccesarily valid
     # assumption, but works enough of the time and there's no easy
     # alternative.
-    # Convert 13 to 10 if neccesary. 
-    
-    # got to try converting to 10. An ISBN-13 is never an ASIN.    
-    isbn = ISBN.ten( isbn )
+
               
 
     query_params = {

data/lib/service_adaptors/google_book_search.rb

@@ -217,7 +217,7 @@ class GoogleBookSearch < Service
 
     Rails.logger.debug("GoogleBookSearch requesting: #{link}")        
     response = http_fetch(link, :headers => headers, :raise_on_http_error_code => false)        
-    data = MultiJson.decode(response.body)
+    data = MultiJson.load(response.body)
     
     # If Google gives us an error cause it says it can't geo-locate, 
     # remove the IP, log warning, and try again. 
@@ -227,7 +227,7 @@ class GoogleBookSearch < Service
       Rails.logger.warn("GoogleBookSearch: geo-locate error, retrying without X-Forwarded-For: '#{link}' headers: #{headers.inspect} #{response.inspect}\n    #{data.inspect}")
       
       response = http_fetch(link, :raise_on_http_error_code => false)        
-      data = MultiJson.decode(response.body)
+      data = MultiJson.load(response.body)
         
     end
     

data/lib/service_adaptors/hathi_trust.rb

@@ -133,9 +133,9 @@ class HathiTrust < Service
   end
   
   # conducts query and parses the JSON
-  def do_query(params)    
+  def do_query(params)        
     link = @api_url + "/brief/json/" + params
-    return MultiJson.decode( open(link).read )
+    return MultiJson.load( open(link).read )
   end
   
     

data/lib/service_adaptors/internet_archive.rb

@@ -104,25 +104,16 @@ class InternetArchive < Service
     
     # using open() conveniently follows the redirect for us. Alas, it
     # doesn't give us access to the IA http status code response though.
-    begin
-      response = nil
-      timeout(@http_timeout.to_i) {
-        response = open(link).read
-      }
-    rescue Exception => e
-      # Log more info for exception, and then just forward exception on,
-      # we don't have any way to handle it. 
-      Rails.logger.error("InternetArchive exception, for url[[#{link}]] , Exception #{e.class}")
-      raise e
-    end
-    
+    response = nil
+    timeout(@http_timeout.to_i) {
+      response = open(link).read
+    }
     if response.blank?
-      Rails.logger.warn("InternetArchive returned empty response for #{link}")
-      return nil
+      raise Exception.new("InternetArchive returned empty response for #{link}")      
     end
     
     
-    doc = MultiJson.decode(response)
+    doc = MultiJson.load(response)
     results = doc['response']['docs']
     
     @mediatypes.each do |type|
@@ -258,14 +249,14 @@ class InternetArchive < Service
     # commands even within quotes. 
     output = string.downcase
     
-    # Remove parens, semi-colons, and brackets -- they all mess
+    # Remove parens, semi-colons, brackets, hyphens -- they all mess
     # up IA, which thinks they are special chars. Remove double quote,
     # special char, which sometimes we want to use ourselves. Replace
     # all with spaces to avoid accidentally conjoining words. 
     # (could be
     # escaping instead? Not worth it, we don't want to search
     # on these anyway. Remove ALL punctuation? Not sure.)
-    output.gsub!(/[)(\]\[;"\=]/, ' ')
+    output.gsub!(/[)(\]\[;"\=\-]/, ' ')
     
     return output
   end
@@ -485,4 +476,4 @@ end
 # The Snow-Image: http://www.worldcat.org/oclc/5020610
 # Les Canadiens-Français: http://www.worldcat.org/oclc/186641188
 #   FIXME should match 1 record and doesn't. character encoding problems?
-# John L. Stoddard's Lectures: http://www.worldcat.org/oclc/2181690
+# John L. Stoddard's Lectures: http://www.worldcat.org/oclc/2181690

data/lib/service_adaptors/primo_service.rb

@@ -261,7 +261,9 @@ class PrimoService < Service
         service_data[:match_reliability] = 
           (reliable_match?(:title => holding.title, :author => holding.author)) ? 
             ServiceResponse::MatchExact : ServiceResponse::MatchUnsure
-        service_data[:request_link_supports_ajax_call] = false
+        service_data[:request_link_supports_ajax_call] = 
+          (holding.respond_to?(:request_link_supports_ajax_call)) ? 
+            holding.request_link_supports_ajax_call : false
         # Only add one service type, either "primo_source" OR "holding", not both.
         service_type = (@service_types.include?("primo_source")) ? "primo_source" : "holding"
         # Add some other holding information for compatibility with default holding partial
@@ -447,4 +449,4 @@ class PrimoService < Service
     return false if @identifier.nil?
     return @identifier.start_with?('info:sid/primo.exlibrisgroup.com')
   end
-end
+end

data/lib/service_adaptors/primo_source.rb

@@ -30,6 +30,7 @@ class PrimoSource < PrimoService
   # Overwrites PrimoService#new.
   def initialize(config)
     @service_types = ["holding"]
+    @source_attributes = []
     super(config)
   end
 
@@ -52,6 +53,9 @@ class PrimoSource < PrimoService
         @holding_attributes.each do |attr|
           service_data[attr] = holding.method(attr).call
         end
+        @source_attributes.each do |attr|
+          service_data[attr.to_sym] = holding.method(attr.to_sym).call
+        end
         service_data.merge!({
           :call_number => holding.call_number, :collection => holding.collection,
           :collection_str => "#{holding.library} #{holding.collection}",

data/lib/service_adaptors/scopus.rb

@@ -110,7 +110,7 @@ class Scopus < Service
     
     # Take the first hit from scopus's results, hope they relevancy ranked it
     # well. For DOI/pmid search, there should ordinarly be only one hit!
-    results = MultiJson.decode(response)
+    results = MultiJson.load(response)
 
     if ( results["ERROR"])
       Rails.logger.error("Error from Scopus API: #{results["ERROR"].inspect}   openurl: ?#{request.referent.to_context_object.kev}")

data/lib/umlaut/routes.rb

@@ -53,7 +53,7 @@ module Umlaut
       def a_z
         add_routes do |options|
           # Special one for alpha list
-          match 'journal_list/:id/:page' => 'search#journal_list', :defaults => { :page => 1, :id => 'A' }
+          match 'journal_list(/:id(/:page))' => 'search#journal_list', :defaults => { :page => '1', :id => 'A' }
           
           
           # Catch redirected from SFX A-Z and citation linker urls

data/lib/umlaut/version.rb

@@ -1,3 +1,3 @@
 module Umlaut
-  VERSION = "3.0.0beta5"
+  VERSION = "3.0.0beta6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: umlaut
 version: !ruby/object:Gem::Version
-  version: 3.0.0beta5
+  version: 3.0.0beta6
   prerelease: 5
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-12 00:00:00.000000000 Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &17186100 !ruby/object:Gem::Requirement
+  requirement: &102344040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *17186100
+  version_requirements: *102344040
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &17185560 !ruby/object:Gem::Requirement
+  requirement: &102355740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17185560
+  version_requirements: *102355740
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &17184800 !ruby/object:Gem::Requirement
+  requirement: &102351520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *17184800
+  version_requirements: *102351520
 - !ruby/object:Gem::Dependency
   name: openurl
-  requirement: &17184180 !ruby/object:Gem::Requirement
+  requirement: &102374560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *17184180
+  version_requirements: *102374560
 - !ruby/object:Gem::Dependency
   name: marc
-  requirement: &17183420 !ruby/object:Gem::Requirement
+  requirement: &102378660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *17183420
+  version_requirements: *102378660
 - !ruby/object:Gem::Dependency
   name: isbn
-  requirement: &17182120 !ruby/object:Gem::Requirement
+  requirement: &102376760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17182120
+  version_requirements: *102376760
 - !ruby/object:Gem::Dependency
   name: htmlentities
-  requirement: &17180260 !ruby/object:Gem::Requirement
+  requirement: &102385880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17180260
+  version_requirements: *102385880
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &17179300 !ruby/object:Gem::Requirement
+  requirement: &102404440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17179300
+  version_requirements: *102404440
 - !ruby/object:Gem::Dependency
   name: confstruct
-  requirement: &17132240 !ruby/object:Gem::Requirement
+  requirement: &102501700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: '0.2'
   type: :runtime
   prerelease: false
-  version_requirements: *17132240
+  version_requirements: *102501700
 - !ruby/object:Gem::Dependency
   name: exlibris-primo
-  requirement: &17130980 !ruby/object:Gem::Requirement
+  requirement: &102514240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *17130980
+  version_requirements: *102514240
 - !ruby/object:Gem::Dependency
   name: single_test
-  requirement: &17129720 !ruby/object:Gem::Requirement
+  requirement: &102512120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.5.1
   type: :development
   prerelease: false
-  version_requirements: *17129720
+  version_requirements: *102512120
 - !ruby/object:Gem::Dependency
   name: uglifier
-  requirement: &17128300 !ruby/object:Gem::Requirement
+  requirement: &102509700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17128300
+  version_requirements: *102509700
 - !ruby/object:Gem::Dependency
   name: therubyracer
-  requirement: &17126180 !ruby/object:Gem::Requirement
+  requirement: &102507660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17126180
+  version_requirements: *102507660
 - !ruby/object:Gem::Dependency
   name: ruby-prof
-  requirement: &17523620 !ruby/object:Gem::Requirement
+  requirement: &102522180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17523620
+  version_requirements: *102522180
 description: 
 email:
 - umlaut-general@rubyforge.org
@@ -213,13 +213,11 @@ files:
 - app/assets/javascripts/umlaut_ui.js
 - app/assets/javascripts/umlaut.js
 - app/assets/javascripts/umlaut/update_html.js
-- app/assets/javascripts/umlaut/#simple_visible_toggle.js#
 - app/assets/javascripts/umlaut/ajax_windows.js
 - app/assets/javascripts/umlaut/simple_visible_toggle.js
 - app/assets/javascripts/umlaut/ensure_window_size.js.erb
 - app/assets/javascripts/umlaut/expand_contract_toggle.js
 - app/assets/javascripts/umlaut/search_autocomplete.js
-- app/assets/javascripts/umlaut/#update_html.js#
 - app/assets/stylesheets/umlaut.css
 - app/models/sfx_url.rb
 - app/models/crossref_lookup.rb
@@ -323,7 +321,6 @@ files:
 - lib/opensearch_feed.rb
 - lib/holding.rb
 - lib/umlaut_configurable.rb
-- lib/umlaut/#routes.rb#
 - lib/umlaut/routes.rb
 - lib/umlaut/version.rb
 - lib/umlaut/default_configuration.rb
@@ -336,7 +333,6 @@ files:
 - lib/service_adaptors/primo_service.rb
 - lib/service_adaptors/open_library.rb
 - lib/service_adaptors/elsevier_cover.rb
-- lib/service_adaptors/#blacklight.rb#
 - lib/service_adaptors/ulrichs_link.rb
 - lib/service_adaptors/ulrichs_cover.rb
 - lib/service_adaptors/scopus.rb
@@ -485,7 +481,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -986297622485492728
+      hash: 367390304893023156
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/app/assets/javascripts/umlaut/#simple_visible_toggle.js#

@@ -1,8 +0,0 @@
-/* simple_visible_toggle.js.  Used for toggling visibility of error information. Can possibly be combined with more powerful expand_contract_toggle.js */
-jQuery(document).ready(function($) {
-   
-    $("a.simple_visible_toggle").live("click", function() {
-       $(this).next().toggle(); 
-    });
-    
-});

data/app/assets/javascripts/umlaut/#update_html.js#

@@ -1,181 +0,0 @@
-/* update_html.js:  Provide functions to update content on page with background responses from Umlaut. Used by Umlaut itself, as well as by third party callers.*/
-(function($) {
-   
-    function SectionTarget(config) {
-       //Add properties from config to ourself
-       $.extend(this, config);
-       
-       //Defaults
-       if (this.selector == undefined)
-         this.selector = "#" + this.umlaut_section_id;
-       if (this.position == undefined)
-         this.position = "html";
-              
-    }
-    //Callback default to no-op function please.    
-    var noop = function() {};
-    SectionTarget.prototype.before_update = noop;
-    SectionTarget.prototype.after_update = noop;
-    SectionTarget.prototype.complete = noop;
-    
-    SectionTarget.prototype.ensure_placement_destination = function() {
-        if ( this.selector == undefined) {
-          return null; 
-        }
-        
-        //Already have it cached?
-        if ( this.host_div_element ) {
-          return this.host_div_element;
-        }                        
-        
-        var new_div = $('<div class="umlaut" style="display:none"></div>');        
-        // Find the first thing matched by selector, and call the
-        // method specified in "action" string on it, giving it our
-        // HTML to replace. This works because our actions are
-        // all arguments that will take one method: html, before, after, append,
-        // prepend.                       
-        $(this.selector).eq(0)[ this.position  ]( new_div );
-        
-        //Cache for later
-        this.host_div_element = new_div;
-        return this.host_div_element;
-      };
-    
-
-  // Define an object constructor on the global window object
-  // For our UmlautHtmlUpdater object. 
-  function HtmlUpdater(umlaut_base, context_object) {
-    if (context_object == undefined)
-      context_object = "";      
-    
-    umlaut_base = umlaut_base.replace(/\/$/,'');
-    this.umlaut_uri =  umlaut_base + '/resolve/partial_html_sections?umlaut.response_format=json&' + context_object;
-        
-    this.section_targets = [];
-           
-    this.add_section_target = function(config) {
-      this.section_targets.push( new SectionTarget(config) ); 
-    };
-    
-    //default no-op call-backs
-    this.complete = noop;
-    this.before_update = noop;
-    this.after_update = noop;
-    
-    
-    //Code for seeing if a URI is same origin or not borrowed from jQuery
-    this.is_remote_url = function(url) {
-      var regexp = /^(\w+:)?\/\/([^\/?#]+)/;
-      var parts = regexp.exec( url );
-      return (parts && (parts[1] && parts[1] !== location.protocol || parts[2] !== location.host));
-    }
-    
-    this.update = function() {
-      // Need to capture because we won't have 'this' inside the ajax
-      // success handler. 
-      var myself = this;       
-      var dataType = this.is_remote_url( this.umlaut_uri ) ? "jsonp" : "json";
-       $.ajax({
-             url: myself.umlaut_uri,
-             dataType: dataType,
-             jsonp: "umlaut.jsonp",
-             error: function() {
-               $.error("Problem loading background elements.");
-             },
-             success: function(umlaut_response) {
-              for (var i = 0; i < myself.section_targets.length; i++) {
-                  var section_target = myself.section_targets[i];                                
-                 
-                  var umlaut_html_section = myself.find_umlaut_response_section(umlaut_response, section_target.umlaut_section_id);
-                                    
-                  if (umlaut_html_section == undefined) {
-                    continue;
-                  }                  
-                  var count = null;
-                  if (typeof umlaut_html_section.response_count != "undefined") { 
-                    count = parseInt(umlaut_html_section.response_count.value);
-                  }
-                  var existing_element = section_target.ensure_placement_destination();
-                  var new_element = $('<div class="umlaut" style="display:none" class="' + section_target.umlaut_section_id +'"></div>');
-                  new_element.html(umlaut_html_section.html_content);
-
-                  
-                  var should_continue = section_target.before_update(new_element, count, section_target);
-                  if (should_continue != false) {
-                    should_continue = myself.before_update(new_element, count, section_target);
-                  }
-                                    
-                  if (should_continue != false) {                    
-                    existing_element.replaceWith(new_element);
-                    
-                    section_target.host_div_element = new_element;
-
-                    new_element.show();
-                  
-                    section_target.after_update(new_element, count, section_target);
-                    myself.after_update(new_element, count, section_target);
-                    
-                  }
-               }
-               
-               //Do we need to update again?
-               if (umlaut_response.partial_html_sections.in_progress) {   
-                  //Fix our update URI to be the one umlaut suggests
-                  //Except strip out the umlaut.jsonp parameter, jquery is
-                  //going to add that back in as desired. 
-                  myself.umlaut_uri = 
-                    umlaut_response.partial_html_sections.in_progress.refresh_url.replace(/[?;&]umlaut\.jsonp=[^;&]+/, '');
-                  
-                  
-                  var refresh_seconds = 
-                    umlaut_response.partial_html_sections.in_progress.requested_wait_seconds;
-                  window.setTimeout(function() { myself.update();  }, refresh_seconds * 1000); 
-                  
-               } else {
-                 myself.complete();
-                 for (var i = 0; i < myself.section_targets.length; i++) {
-                   var section_target = myself.section_targets[i];
-                   section_target.complete(section_target);
-                 }
-               }
-               
-             }
-       });
-    };
-    this.find_umlaut_response_section = function(response, id) {
-      return $.grep(response.partial_html_sections.html_section, function(section) {
-        return section.id == id;
-      })[0];
-    };
-    
-  };
-  
-  //Put it in a global object, leave space for other things in "Umlaut" later.
-  if (window.Umlaut == undefined)
-    window.Umlaut = new Object();
-  window.Umlaut.HtmlUpdater = HtmlUpdater; 
-  
-  /* LEGACY Loader was recommended for loading Umlaut JS behaviors
-     in an external page, for JQuery Content Utility. 
-     
-     var loader = new Umlaut.Loader();
-     loader.load();
-     
-     We will provide just enough code to keep that from
-     error'ing (and halting js execution), although at present it does not 
-     actually load the JS behaviors using new style, app wont' have
-     JS behaviors. */
-        
-    window.Umlaut.Loader = function() {
-      this.load = function(option_list) {
-        // log problem in browsers that support it. 
-        if (typeof console != "undefined" && typeof console.log != "undefined") {
-          console.log("WARN: Umlaut.Loader no longer supported in Umlaut 3.x, you may have not loaded Umlaut JS Behaviors as desired. See Umlaut documentation for new way.");
-          
-        }                 
-      }
-    }
-  
-  
-})(jQuery);
-

data/lib/service_adaptors/#blacklight.rb#

@@ -1,327 +0,0 @@
-require 'nokogiri'
-require 'open-uri'
-require 'base64'
-require 'marc'
-
-# Searches a Blacklight with the cql extension installed.
-#
-# 
-# Params include:
-# [base_url]
-#    required. Complete URL to catalog.atom action. Eg "https://blacklight.mse.jhu.edu/catalog.atom"
-# [bl_fields]
-#    required with at least some entries if you want this to do anything. Describe the names of given semantic fields in your BL instance.
-#    * issn
-#    * isbn
-#    * lccn
-#    * oclcnum
-#    * id (defaults to 'id')
-#    * title
-#    * author
-#    * serials_limit_clause => not an index name, full URL clause for a limit to apply to known serials searches, for instance "f[format][]=Serial"
-# [identifier_search]
-#    Do catalog search on issn/isbn/oclcnum/lccn/bibId. Default true.
-# [keyword_search]
-#    Do catalog search on title/author keywords where applicable. Generally only used when identifier_search finds no hits, if identifier_search is on. Default true. 
-# [keyword_per_page]
-#    How many records to fetch from blacklight when doing keyword searches.
-# [exclude_holdings]
-#    Can be used to exclude certain 'dummy' holdings that have certain collection, location, or other values. Eg:
-#    exclude_holdings:
-#      collection_str:
-#        - World Wide Web
-#        - Internet
-# [rft_id_bibnum_prefixes]
-#    Array of URI prefixes in an rft_id that indicate that the actual solr id comes next. For instance, if your blacklight will send "http://blacklight.com/catalog/some_id" in an rft_id, then include "http://blacklight.com/catalog/". Optional.
-class Blacklight < Service
-  required_config_params :base_url, :display_name
-  attr_reader :base_url, :cql_search_field
-  attr_reader :bl_fields, :issn
-
-  include UmlautHttp
-  include MetadataHelper
-  include MarcHelper
-  include XmlSchemaHelper
-
-  def initialize(config)
-    # defaults    
-    # If you are sending an OpenURL from a library service, you may
-    # have the HIP bibnum, and include it in the OpenURL as, eg.
-    # rft_id=http://catalog.library.jhu.edu/bib/343434 (except URL-encoded)
-    # Then you'd set rft_id_bibnum_prefix to http://catalog.library.jhu.edu/bib/
-    @rft_id_bibnum_prefixes = []
-    @cql_search_field = "cql"
-    @keyword_per_page = 10
-    @identifier_search = true
-    @keyword_search = true
-    @link_to_search = true
-    super(config)
-    @bl_fields = { "id" => "id "}.merge(@bl_fields)
-  end
-
-  # Standard method, used by background service updater. See Service docs. 
-  def service_types_generated    
-    types = [ ServiceTypeValue[:fulltext], ServiceTypeValue[:holding], ServiceTypeValue[:table_of_contents], ServiceTypeValue[:relevant_link] ]
-    
-    return types
-  end
-
-
-  def handle(request)
-    ids_processed = []
-    holdings_added = 0
-
-    if (@identifier_search && url = blacklight_precise_search_url(request) )
-      doc = Nokogiri::XML( http_fetch(url).body )
-      
-      ids_processed.concat( bib_ids_from_atom_entries( doc.xpath("atom:feed/atom:entry", xml_ns) ) )
-  
-      # namespaces make xpath harder than it should be, but css
-      # selector still easy, thanks nokogiri! Grab the marc from our
-      # results. 
-      marc_matches = doc.xpath("atom:feed/atom:entry/atom:content[@type='application/marc']", xml_ns).collect do |encoded_marc21|
-        MARC::Reader.decode( Base64.decode64(encoded_marc21.text) )        
-      end
-  
-      add_856_links(request, marc_matches )
-  
-      # Got to make a second fetch for dlf_expanded info, cause BL doens't
-      # (yet) let us ask for more than one at once
-      holdings_url = blacklight_precise_search_url( request, "dlf_expanded" )
-      holdings_added += add_holdings( holdings_url ) if holdings_url
-    end
-    #keyword search.    
-    if (@keyword_search &&
-        url = blacklight_keyword_search_url(request))
-        
-        doc = Nokogiri::XML( http_fetch(url).body )
-        # filter out matches whose titles don't really match at all, or
-        # which have already been seen in identifier search. 
-        entries = filter_keyword_entries( doc.xpath("atom:feed/atom:entry", xml_ns) , :exclude_ids => ids_processed, :remove_subtitle => (! title_is_serial?(request.referent)) )
-
-        marc_by_atom_id = {}
-        
-        # Grab the marc from our entries. Important not to do a // xpath
-        # search, or we'll wind up matching parent elements not actually
-        # included in our 'entries' list. 
-        marc_matches = entries.xpath("atom:content[@type='application/marc']", xml_ns).collect do |encoded_marc21|
-          marc = MARC::Reader.decode( Base64.decode64(encoded_marc21.text) )
-
-          marc_by_atom_id[ encoded_marc21.at_xpath("ancestor::atom:entry/atom:id/text()", xml_ns).to_s  ] = marc
-          
-          marc
-        end
-       
-        # We've filtered out those we consider just plain bad
-        # matches, everything else we're going to call
-        # an approximate match. Sort so that those with
-        # a date close to our request date are first.
-        if ( year = get_year(request.referent))
-          marc_matches = marc_matches.partition {|marc| get_years(marc).include?( year )}.flatten
-        end
-        # And add in the 856's
-        add_856_links(request, marc_matches, :match_reliability => ServiceResponse::MatchUnsure)
-
-        # Fetch and add in the holdings
-        url = blacklight_url_for_ids(bib_ids_from_atom_entries(entries))
-        
-        holdings_added += add_holdings( url, :match_reliability => ServiceResponse::MatchUnsure, :marc_data => marc_by_atom_id ) if url
-        
-        if (@link_to_search && holdings_added ==0)
-          hit_count = doc.at_xpath("atom:feed/opensearch:totalResults/text()", xml_ns).to_s.to_i
-          html_result_url = doc.at_xpath("atom:feed/atom:link[@rel='alternate'][@type='text/html']/attribute::href", xml_ns).to_s
-
-          if hit_count > 0          
-            request.add_service_response(             
-              :service => self,
-              :source_name => @display_name,
-              :count => hit_count,
-              :display_text => "#{hit_count} possible #{case; when hit_count > 1 ; 'matches' ; else; 'match' ; end} in #{@display_name}", 
-              :url => html_result_url,
-              :service_type_value => :holding_search )
-          end
-        end
-    end
-
-
-    
-    
-    return request.dispatched(self, true)
-
-
-  end
-
-  # Send a CQL request for any identifiers present. 
-  # Ask for for an atom response with embedded marc21 back. 
-  def blacklight_precise_search_url(request, format = "marc")
-    # Add search clauses for our identifiers, if we have them and have a configured search field for them. 
-    clauses = []
-    added = []
-    ["lccn", "isbn", "oclcnum"].each do |key|
-      if bl_fields[key] && request.referent.send(key)
-        clauses.push( "#{bl_fields[key]} = \"#{request.referent.send(key)}\"")
-        added << key
-      end
-    end
-    # Only add ISSN if we don't have an ISBN, reduces false matches
-    if ( !added.include?("isbn") &&
-         bl_fields["issn"] && 
-         request.referent.issn)
-       clauses.push("#{bl_fields["issn"]} = \"#{request.referent.issn}\"")
-    end
-      
-    
-    # Add Solr document identifier if we can get one from the URL
-    
-    if (id = get_solr_id(request.referent))
-      clauses.push("#{bl_fields['id']} = \"#{id}\"")
-    end
-    
-    # if we have nothing, we can do no search.
-    return nil if clauses.length == 0
-    
-    cql = clauses.join(" OR ")
-    
-    return base_url + "?search_field=#{@cql_search_field}&content_format=#{format}&q=#{CGI.escape(cql)}"             
-  end
-
-  # Construct a CQL search against blacklight for author and title,
-  # possibly with serial limit. Ask for Atom with embedded MARC back. 
-  def blacklight_keyword_search_url(request, options = {})
-    options[:format] ||= "atom"
-    options[:content_format] ||= "marc"
-    
-    clauses = []
-
-    # We need both title and author to search keyword style, or
-    # we get too many false positives. Except serials we'll do
-    # title only. sigh, logic tree. 
-    title = get_search_title(request.referent)
-    author = get_top_level_creator(request.referent)
-    return nil unless title && (author || (@bl_fields["serials_limit_clause"] && title_is_serial?(request.referent)))
-    # phrase search for title, just raw dismax for author
-    # Embed quotes inside the quoted value, need to backslash-quote for CQL,
-    # and backslash the backslashes for ruby literal. 
-    clauses.push("#{@bl_fields["title"]} = \"\\\"#{title}\\\"\"")    
-    clauses.push("#{@bl_fields["author"]} = \"#{author}\"") if author
-    
-
-    
-    url = base_url + "?search_field=#{@cql_search_field}&content_format=#{options[:content_format]}&q=#{CGI.escape(clauses.join(" AND "))}"
-
-    if (@bl_fields["serials_limit_clause"] &&
-        title_is_serial?(request.referent))        
-      url += "&" + @bl_fields["serials_limit_clause"]
-    end
-    
-    return url
-  end
-
-  # Takes a url that will return atom response of dlf_expanded content.
-  # Adds Umlaut "holding" ServiceResponses for dlf_expanded, as appropriate.
-  # Returns number of holdings added.  
-  def add_holdings(holdings_url, options = {})
-    options[:match_reliability] ||= ServiceResponse::MatchExact
-    options[:marc_data] ||= {}
-    
-    atom = Nokogiri::XML( http_fetch(holdings_url).body )
-    content_entries = atom.search("/atom:feed/atom:entry/atom:content", xml_ns)
-    
-    # For each atom entry, find the dlf_expanded record. For each dlf_expanded
-    # record, take all of it's holdingsrec's if it has them, or all of it's
-    # items if it doesn't, and add them to list. We wind up with a list
-    # of mixed holdingsrec's and items. 
-    holdings_xml = content_entries.collect do |dlf_expanded|      
-      copies = dlf_expanded.xpath("dlf:record/dlf:holdings/dlf:holdingset/dlf:holdingsrec", xml_ns)
-      copies.length > 0 ? copies : dlf_expanded.xpath("dlf:record/dlf:items/dlf:item", xml_ns)
-    end.flatten
-    
-    service_data = holdings_xml.collect do | xml_metadata |
-      atom_entry = xml_metadata.at_xpath("ancestor::atom:entry", xml_ns)
-      atom_id = atom_entry.at_xpath("atom:id/text()", xml_ns).to_s
-
-      edition_str = edition_statement(options[:marc_data][atom_id])
-      url = atom_entry.at_xpath("atom:link[@rel='alternate'][@type='text/html']/attribute::href", xml_ns).to_s
-      
-      xml_to_holdings( xml_metadata ).merge(
-        :service => self,
-        :match_reliability => options[:match_reliability],
-        :edition_str => edition_str,
-        :url => url
-      )
-    end
-    
-    # strip out holdings that aren't really holdings
-    service_data.delete_if do |data|
-      @exclude_holdings.collect do |key, values|
-        values.include?(data[key.to_sym])
-      end.include?(true)
-    end
-
-    # Sort by "collection"
-    service_data.sort do |a, b|
-      a[:collection_str] <=> b[:collection_str]
-    end
-    
-    service_data.each do |data|
-      request.add_service_response(data.merge(:service => self, :service_type_value =>"holding"))
-    end
-
-    return service_data.length
-  end
-
-  def filter_keyword_entries(atom_entries, options = {})
-    options[:exclude_ids] ||= []
-    options[:remove_subtitle] ||= true
-    request_title_forms = [
-        raw_search_title(request.referent).downcase,        
-        normalize_title( raw_search_title(request.referent) )
-    ]
-    request_title_forms << normalize_title( raw_search_title(request.referent), :remove_subtitle => true) if options[:remove_subtitle]
-    request_title_forms.compact
-
-    # Only keep entries with title match, and that aren't in the
-    # exclude_ids list. 
-    good_entries = atom_entries.find_all do |atom_entry|
-      title = atom_entry.xpath("atom:title/text()", xml_ns).to_s  
-   
-      entry_title_forms = [
-        title.downcase,
-        normalize_title(title)
-      ]
-      entry_title_forms << normalize_title(title, :remove_subtitle=>true) if options[:remove_subtitle]
-      entry_title_forms.compact
-      
-      ((entry_title_forms & request_title_forms).length > 0 &&
-       (bib_ids_from_atom_entries(atom_entry) & options[:exclude_ids]).length == 0)
-    end
-    return Nokogiri::XML::NodeSet.new( atom_entries.document, good_entries)
-  end
-
-  def bib_ids_from_atom_entries(entries)
-    entries.xpath("atom:id/text()", xml_ns).to_a.collect do |atom_id|
-          atom_id.to_s =~ /([^\/]+)$/
-          $1
-    end.compact
-  end
-  
-  def blacklight_url_for_ids(ids, format="dlf_expanded")
-    return nil unless ids.length > 0  
-  
-    return base_url + "?search_field=#{@cql_search_field}&content_format=#{format}&q=" + CGI.escape("#{@bl_fields["id"]} any \"#{ids.join(" ")}\"")
-  end
-    
-
-  def get_solr_id(rft)
-    rft.identifiers.each do |id|
-      @rft_id_bibnum_prefixes.each do |prefix|
-        if id[0, prefix.length] == prefix
-          return id[prefix.length, id.length]
-        end
-      end
-    end
-
-    return nil    
-  end
-
-end

data/lib/umlaut/#routes.rb#

@@ -1,164 +0,0 @@
-# -*- encoding : utf-8 -*-
-module Umlaut
-  # Class to inject Umlaut routes, design copied from Blacklight project. 
-  # you would do a:
-  #    Umlaut::Routes.new(self, optional_args).draw 
-  # in local
-  # 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
-
-    def initialize(router, options ={})
-      @router = router
-      @options = options
-    end
-
-    def draw
-      route_sets.each do |r|
-        self.send(r)
-      end
-    end
-
-    protected
-
-    def add_routes &blk
-      @router.instance_exec(@options, &blk)
-    end
-
-    def route_sets
-      # :admin is not included by default, needs to be turned on. 
-      (@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]
-    end
-
-    module RouteSets
-      # for now include root generation in Umlaut auto-generation
-      def root
-        add_routes do |options|
-          root :to => "search#index"
-        end
-      end
-      
-      def permalinks
-        add_routes do |options|
-          match 'go/:id' => 'store#index'
-        end
-      end
-  
-      # some special direct links to A-Z type searches, including
-      # legacy redirects for SFX-style urls, to catch any bookmarks. 
-      def a_z
-        add_routes do |options|
-          # Special one for alpha list
-          match 'journal_list/:id/:page' => 'search#journal_list', :defaults => { :page => 1, :id => 'A' }
-          
-          
-          # Catch redirected from SFX A-Z and citation linker urls
-          # v2 A-Z links redirected to umlaut, point to journal_list
-          # code in journal_list filter picks out SFX URL vars for
-          # letter. 
-          match '/resolve/azlist/default' => 'search#journal_list', :page => 1, :id => 'A'
-          
-          # SFX v3 A-Z list url format
-          match 'resolve/az' => 'search#journal_list', :page => 1, :id => 'A'          
-        end
-      end
-      
-        # This is a legacy wild controller route that's not recommended for RESTful applications.
-        # Note: This route will make all actions in every controller accessible via GET requests.
-        # match ':controller(/:action(/:id(.:format)))'
-        
-      def resolve
-        add_routes do |options|
-          # ResolveController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'resolve(/:action(/:id(.:format)))' => "resolve"
-        end
-      end
-      
-      def open_search
-        add_routes do |options|
-          # OpenSearchController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'open_search(/:action(/:id(.:format)))' => "open_search"
-        end
-      end
-      
-      def link_router
-        add_routes do |options|
-          # LinkRouterController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'link_router(/:action(/:id(.:format)))' => "link_router"
-        end
-      end
-      
-      def export_email
-        add_routes do |options|
-          # ExportEmailController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'export_email(/:action(/:id(.:format)))' => "export_email"
-        end
-      end
-      
-      def resources
-        add_routes do |options|
-          # ResourceController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'resource(/:action(/:id(.:format)))' => "resource"
-        end
-      end
-      
-      def search
-        add_routes do |options|
-          # SearchController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'search(/:action(/:id(.:format)))' => "search"
-        end
-      end
-      
-      def javascript
-        add_routes do |options|
-          # Legacy location for update_html.js used by JQuery Content Utility
-          # to embed JS on external sites. Redirect to new location. 
-          # Intentionally non-fingerprinted, most efficient thing
-          # we can do in this case is let the web server take care
-          # of Last-modified-by etc headers. 
-          match 'javascripts/jquery/umlaut/update_html.js' => redirect("/assets/umlaut/update_html.js", :status => 301)
-          
-          # The loader doens't work _exactly_ like the new umlaut-ui.js, but
-          # it's close enough that it'll work better redirecting than just
-          # 404'ing. 
-          match 'js_helper/loader' => redirect("/assets/umlaut_ui.js")
-          
-          
-          match 'images/spinner.gif' => redirect("/assets/spinner.gif")
-        end
-      end
-      
-      def admin
-        add_routes do |options|
-          namespace "admin" do
-            match 'service_errors(/:service_id)' => "service_errors#index"
-          end
-        end
-      end
-   
-    end
-    include RouteSets
-  end
-end