bento_search 0.6.0 → 0.7.0

data/app/search_engines/bento_search/google_books_engine.rb

@@ -16,6 +16,17 @@ module BentoSearch
   #
   # Configuration :api_key STRONGLY recommended, or google will severely
   # rate-limit you. 
+  #
+  # == Custom Data
+  # GBS API's "viewability" value is stored at item.custom_data[:viewability]
+  # PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. 
+  # https://developers.google.com/books/docs/v1/reference/volumes#resource
+  #
+  # #link_is_fulltext? is also set appropriately. 
+  #
+  # You may want to use a custom decorator to display the viewability
+  # status somehow (in display_format? In an other_link?). See wiki
+  # for info on decorators. 
   class GoogleBooksEngine
     include BentoSearch::SearchEngine
     include ActionView::Helpers::SanitizeHelper
@@ -66,32 +77,67 @@ module BentoSearch
       results.total_items = json["totalItems"]
 
       
-      (json["items"] || []).each do |j_item|
-        j_item = j_item["volumeInfo"] if j_item["volumeInfo"]
+      (json["items"] || []).each do |item_response|
+        v_info = item_response["volumeInfo"] || {}
 
         item = ResultItem.new
         results << item
         
-        item.title          = j_item["title"] 
-        item.subtitle       = j_item["subtitle"] 
-        item.publisher      = j_item["publisher"]
-        item.link           = j_item["canonicalVolumeLink"]        
-        item.abstract       = sanitize j_item["description"]        
-        item.year           = get_year j_item["publishedDate"]         
-        item.format         = if j_item["printType"] == "MAGAZINE"
+        item.title          = v_info["title"] 
+        item.subtitle       = v_info["subtitle"] 
+        item.publisher      = v_info["publisher"]
+        # previewLink gives you your search results highlighted, preferable
+        # if it exists. 
+        item.link           = v_info["previewLink"] || v_info["canonicalVolumeLink"]        
+        item.abstract       = sanitize v_info["description"]        
+        item.year           = get_year v_info["publishedDate"]
+        # sometimes we have yyyy-mm, but we need a date to make a ruby Date,
+        # we'll just say the 1st. 
+        item.publication_date = case v_info["publishedDate"]
+          when /(\d\d\d\d)-(\d\d)/ then Date.parse "#{$1}-#{$2}-01"
+          when /(\d\d\d\d)-(\d\d)-(\d\d)/ then Date.parse v_info["published_date"]
+          else nil
+        end
+
+          
+        item.format         = if v_info["printType"] == "MAGAZINE"
                               :serial
                             else
                               "Book"
                             end    
                             
-        item.language_code  = j_item["language"]
+
+                            
+        item.language_code  = v_info["language"]
                             
-        (j_item["authors"] || []).each do |author_name|
+        (v_info["authors"] || []).each do |author_name|
           item.authors << Author.new(:display => author_name)
         end
+        
+        # Find ISBN's, prefer ISBN-13
+        item.isbn           = (v_info["industryIdentifiers"] || []).find {|node| node["type"] == "ISBN_13"}.try {|node| node["identifier"]}
+        unless item.isbn
+          # Look for ISBN-10 okay
+          item.isbn         = (v_info["industryIdentifiers"] || []).find {|node| node["type"] == "ISBN_10"}.try {|node| node["identifier"]}
+        end
+        
+
+        # only VERY occasionally does a GBS hit have an OCLC number, but let's look
+        # just in case.
+        item.oclcnum        = (v_info["industryIdentifiers"] || []).
+          find {|node| node["type"] == "OTHER" && node["identifier"].starts_with?("OCLC:") }.
+          try do |node|
+            node =~ /OCLC:(.*)/ ? $1 : nil
+          end
+                  
+        # save viewability status in custom_data. PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. 
+        # https://developers.google.com/books/docs/v1/reference/volumes#resource
+        item.custom_data[:viewability] = item_response["accessInfo"].try {|h| h["viewability"]}
+        item.link_is_fulltext = (item.custom_data[:viewability] == "ALL_PAGES") if item.custom_data[:viewability]        
       end
       
       
+      
       return results
     end
     
@@ -106,8 +152,9 @@ module BentoSearch
       100
     end   
     
-    def search_field_definitions
-      { "intitle"     => {:semantic => :title},
+    def search_field_definitions      
+      { nil           => {:semantic => :general},
+        "intitle"     => {:semantic => :title},
         "inauthor"    => {:semantic => :author},
         "inpublisher" => {:semantic => :publisher},
         "subject"     => {:semantic => :subject},
@@ -155,7 +202,7 @@ module BentoSearch
       if arguments[:sort] && 
           (defn = sort_definitions[arguments[:sort]]) &&
           (value = defn[:implementation])
-        query_url += "&sort=#{CGI.escape(value)}" 
+        query_url += "&orderBy=#{CGI.escape(value)}" 
       end
       
       

data/app/search_engines/bento_search/google_site_search_engine.rb

@@ -77,8 +77,10 @@ class BentoSearch::GoogleSiteSearchEngine
       else
         item.title          = json_item["title"]
         item.abstract       = json_item["snippet"]
-        item.source_title  = json_item["formattedUrl"]
+        item.source_title   = json_item["formattedUrl"]
       end
+            
+      item.format_str       = json_item["fileFormat"]
       
       item.link             = json_item["link"]
       

data/app/search_engines/bento_search/mock_engine.rb

@@ -53,4 +53,8 @@ class BentoSearch::MockEngine
       configuration.sort_definitions || {}
     end
     
+    def search_field_definitions
+      configuration.search_field_definitions || {}
+    end
+    
 end

data/app/search_engines/bento_search/primo_engine.rb

@@ -150,9 +150,7 @@ class BentoSearch::PrimoEngine
         
         item.format         = map_format fmt_str
       end
-                  
-      #TODO highlighting
-      
+                        
       results << item
     end
     
@@ -281,6 +279,7 @@ class BentoSearch::PrimoEngine
   def search_field_definitions
     # others are avail too, this is not exhaustive. 
     {
+      nil         => {:semantic => :general},
       "creator"   => {:semantic => :author},
       "title"     => {:semantic => :title},
       "sub"       => {:semantic => :subject},      

data/app/search_engines/bento_search/scopus_engine.rb

@@ -186,6 +186,7 @@ module BentoSearch
     
     def search_field_definitions
       {
+        nil           => {:semantic => :general},
         "AUTH"        => {:semantic => :author},
         "TITLE"       => {:semantic => :title},
         # controlled and author-assigned keywords

data/app/search_engines/bento_search/summon_engine.rb

@@ -125,7 +125,11 @@ class BentoSearch::SummonEngine
       item.subtitle = handle_highlighting( first_if_present doc_hash["Subtitle"] )# TODO is this right?
       item.custom_data["raw_subtitle"] = handle_highlighting( first_if_present(doc_hash["Subtitle"]), :strip => true )
       
-      item.link = doc_hash["link"]
+      item.link             = doc_hash["link"]
+      # Don't understand difference between hasFullText and
+      # isFullTextHit. ??. We'll use hasFullText for now, that's
+      # the documented one. 
+      item.link_is_fulltext = doc_hash["hasFullText"] 
       
       if configuration.use_summon_openurl      
         item.openurl_kev_co = doc_hash["openUrl"] # Summon conveniently gives us pre-made OpenURL

data/app/search_engines/bento_search/worldcat_sru_dc_engine.rb

@@ -19,6 +19,9 @@ require 'httpclient'
 # readable semantic #format is often defaulted to "Book", which may not
 # always be right. 
 #
+# WorldCat doesn't let you paginate past start_record 9999. If client asks,
+# this engine will silenly reset to 9999. 
+#
 # == API Docs
 # * http://oclc.org/developer/documentation/worldcat-search-api/using-api
 # * http://oclc.org/developer/documentation/worldcat-search-api/sru
@@ -38,7 +41,7 @@ require 'httpclient'
 #
 # == Extra search args
 #
-# [auth]           default false. Set to true to assume all users are authenticated
+# [auth]           default false. Set to true to specify current user is authenticated
 #                  and servicelevel=full for OCLC. Overrides config 'auth' value.  
 #
 class BentoSearch::WorldcatSruDcEngine
@@ -47,27 +50,42 @@ class BentoSearch::WorldcatSruDcEngine
   extend HTTPClientPatch::IncludeClient
   include_http_client
   
+  MaxStartRecord = 9999 # at least as of Sep 2012, worldcat errors if you ask for pagination beyond this
+  
   def search_implementation(args)
     url = construct_query_url(args)
 
     results = BentoSearch::Results.new
-    
+
     response = http_client.get(url)
     
+    # check for http errors
     if response.status != 200
-      response.error ||= {}
-      response.error[:status] = response.status
-      response.error[:info] = response.body
-      response.error[:url] = url
+      results.error ||= {}
+      results.error[:status] = response.status
+      results.error[:info] = response.body
+      results.error[:url] = url
+      
+      return results    
     end
     
     xml = Nokogiri::XML(response.body)
     # namespaces only get in the way
     xml.remove_namespaces!
     
+    
     results.total_items = xml.at_xpath("//numberOfRecords").try {|n| n.text.to_i }
     
     
+    # check for SRU fatal errors, no results AND a diagnostic message
+    # is a fatal error always, I think. 
+    if (results.total_items == 0 && 
+        error_xml = xml.at_xpath("./searchRetrieveResponse/diagnostics/diagnostic"))
+    
+      results.error ||= {}
+      results.error[:info] = error_xml.children.to_xml
+    end    
+    
     (xml.xpath("/searchRetrieveResponse/records/record/recordData/oclcdcs") || []).each do |record|
       item = BentoSearch::ResultItem.new
       
@@ -125,13 +143,22 @@ class BentoSearch::WorldcatSruDcEngine
     return results
   end
   
+  # Note, if pagination start record is beyond what we think is worldcat's
+  # max, it will silently reset to max, and mutate the args passed in
+  # so pagination appears to be at max too!
   def construct_query_url(args)
     url = configuration.base_url
     url += "&wskey=#{CGI.escape configuration.api_key}"
     url += "&recordSchema=#{CGI.escape 'info:srw/schema/1/dc'}"
     
-    # pagination, WorldCat 'start' is 1-based, ours is 0-based. 
+     
     url += "&maximumRecords=#{args[:per_page]}" if args[:per_page]
+    
+    # pagination, WorldCat 'start' is 1-based, ours is 0-based. Catch max.    
+    if args[:start] && args[:start] > (MaxStartRecord-1)
+      args[:start]  = MaxStartRecord - 1
+      args[:page] = (args[:start] / (args[:per_page] || 10)) + 1
+    end
     url += "&startRecord=#{args[:start] + 1}" if args[:start]
     
     url += "&query=#{CGI.escape construct_cql_query(args)}"
@@ -264,8 +291,9 @@ class BentoSearch::WorldcatSruDcEngine
   # we're listing now are available even at 'default' service level. 
   def search_field_definitions
     {
-      "srw.au"      => {:semantic => :author},
+      nil           => {:semantic => :general},
       "srw.ti"      => {:semantic => :title},
+      "srw.au"      => {:semantic => :author},
       "srw.su"      => {:semantic => :subject},
       "srw.bn"      => {:semantic => :isbn},
       # Oddly no ISSN index, all we get is 'number'

data/app/views/bento_search/_item_title.html.erb

@@ -0,0 +1,29 @@
+<%# 
+  # Prepare a title in an H4, with formats in parens in a <small> (for
+  # bootstrap), linked, etc.
+  #
+  # Pass in local `item` with BentoSearch::ResultItem (can use :as arg to
+  # Rails render). 
+  #
+  # Optionally pass in a local "index" with result set index to display
+  # in front of title. 1. 2. etc. 
+  #  
+  # %>
+  <h4 class="bento_item_title">
+    <% if local_assigns[:index] %>
+      <span class="bento_index"><%= index%>.</span>
+    <% end %>
+  
+    <%= link_to_unless(item.link.blank?, item.complete_title, item.link) %>
+    
+    <% if item.display_format.present? || item.display_language.present? %>
+    
+      <small class="bento_item_about">
+        <%# sorry, no whitespace so parens are flush %>
+        (<%- if item.display_format.present? -%><span class="bento_format"><%= item.display_format -%></span><%- end -%><%- if item.display_language.present? -%><span class="bento_language"> in <%= item.display_language -%></span><%- end -%>)
+      </small>
+      
+    <% end %>  
+  </h4>
+  
+

data/app/views/bento_search/_no_results.html.erb

@@ -0,0 +1,3 @@
+<p class="bento_search_no_results">
+  <%= I18n.translate("bento_search.no_results") %>
+</p>

data/app/views/bento_search/_search_error.html.erb

@@ -2,21 +2,25 @@
   <p>
     <%= t("bento_search.search_error") %>
   </p>
+
+  <% if Rails.application.config.consider_all_requests_local  %>
   
-  <div style="overflow-x:scroll">
-    <p>
-      <%= results.error %>
-    </p>
-    <p>
-    
-      <% if Rails.application.config.consider_all_requests_local && results.error["exception"] %>
-        <ul>
-        <% results.error["exception"].backtrace.each do |line| %>
-          <li><%= line %></li>
-        <% end %>  
-        <ul>
-      <% end %>
-    </p>
-  </div>
+      <div style="overflow-x:scroll">
+        <p>
+          <%= results.error %>
+        </p>
+
+      
+        <% if results.error["exception"] %>
+          <ul>        
+          <% results.error["exception"].backtrace.each do |line| %>
+            <li><%= line %></li>
+          <% end %>  
+          <ul>
+        <% end %>
+
+      </div>
+  
+  <% end %>
   
 </div>

data/app/views/bento_search/_std_item.html.erb

@@ -1,38 +1,63 @@
-<% #  must pass in local 'item' that's a BentoSearch::ResultItem
-   #
+<% #  must pass in locals:
+   #    * 'item' that's a BentoSearch::ResultItem
+   #    * 'results' that's the BentoSearch::Results (optional, actually)
+   #    * 'item_counter', 1-based collection counter, passed in automatically
+   #       by rails render collection (little known rails feature), 
+   #       can be used with results.start to calculate actual result set
+   #       index. 
+   #   
    # Custom partials meant to take this place of this one should
    # use same convention, local 'item'. 
+   #
+   # By default we're passing index to item_title partial to display
+   # counter for results, not sure if that's going to be generally
+   # wanted, but to begin with I'm often taking what I need locally
+   # based on user-testing and stuff for my use cases, and making
+   # it default.
 %>
 
-<div class="bento_item">
-  <%= bento_item_title(item) %>
-    
-  <div class="bento_item_body">
-    
+
+
+<% bento_decorate(item) do |item| %>
     
-    <% if item.authors.length > 0 %>
-      <p class="bento_item_authors">  
-        <%= bento_item_authors(item) %>            
-      </p>
-    <% end %>      
+  <div class="bento_item">
+    <%= render :partial => "bento_search/item_title", :object => item, :as => 'item', :locals => {:index => bento_item_counter(local_assigns[:item_counter], local_assigns[:results]) } %>
+      
+    <div class="bento_item_body">
+      
+      
+      <% if item.authors.length > 0 || item.year.present? %>
+        <p class="bento_item_row first_about">
+            
+          <% if item.authors.length > 0 %>
+            <%= bento_item_authors(item) %>
+          <% end %>
           
-    <% if item.published_in %>
-      <p class="bento_item_row published_in">
-        <span class="bento_value"><%= item.published_in %> </span>
-      </p>
-    <% end %>
-    
-    <% if item.abstract %>
-      <p class="bento_item_abstract">
-        <%= bento_abstract_truncate( item.abstract ) %>
-      </p>
-    <% end %>
+          <% if item.year.present? %>
+            <span class="date"> — <%= item.year %> </span>
+          <% end %>
+                
+        </p>
+      <% end %>      
+                    
+      <% if item.abstract %>
+        <p class="bento_item_row abstract">
+          <%= bento_truncate( item.abstract ) %>
+        </p>
+      <% end %>
+      
+      <% if item.published_in %>
+        <p class="bento_item_row second_about">
+          <%= item.published_in %>
+        </p>
+      <% end %>
+      
+      <% if item.other_links.present? %>
+        <p class="bento_item_other_links">
+          <%= render :partial => "bento_search/link", :collection => item.other_links %>
+        </p>
+      <% end %>
+    </div>
     
-    <% if item.other_links.present? %>
-      <p class="bento_item_other_links">
-        <%= render :partial => "bento_search/link", :collection => item.other_links %>
-      </p>
-    <% end %>
   </div>
-  
-</div>
+<% end %>