ebsco-eds 0.2.8.pre → 0.2.9.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d7e8263996ac2590dc36a49873794a1740e86d0
-  data.tar.gz: 2665e08e2b58fcc2097ef26888b3f514373d0973
+  metadata.gz: c181e960b6639886aa6ef318e40e78f9f8db0846
+  data.tar.gz: b56327ab29bb0032bc6914cc674f41cf330d3609
 SHA512:
-  metadata.gz: 5838084f1135e91be2041fbe72a65b608744a2f2a3aa455297d59d339398b58a56be8580239d3ffa5fca7bdb2d6e43096b0e87300313cdaaa0e2b3852509629d
-  data.tar.gz: edb0d711e2d58f84770c2374c8f4c533b4dec61fb10fdbfc336a22c9d2af4e72c468942c3bca1184553bc3b9d6c1c2f75249409b318e4de4cddc1e9e9d60bfa0
+  metadata.gz: 578554408924a621087faeb1d83ee418f7238ce9fc9fd171084853b9566620c03ccfeeeb20ae320fb08f7798b2959b7305d101862fa3205bd46521bfb4a19719
+  data.tar.gz: 9cc7a39fd98a1d6cb67e99d41e71c8befe0105b90655a2427be75d46f6dbabbdb02431afd9d75563af5a10ef58b3d1cd3458dba90dbc990838a4c3afe9b02ab0

data/lib/ebsco/eds/options.rb

@@ -228,8 +228,79 @@ module EBSCO
       #     false
       #   end
       # end
-  
-    end
+
+
+      # query-1=AND,volcano&sort=relevance&includefacets=y&searchmode=all&autosuggest=n&view=brief&resultsperpage=20&pagenumber=1&highlight=y
+      def to_query_string
+        qs = ''
+
+        # SEARCH CRITERIA:
+
+        # query
+        #  if @SearchCriteria.Queries[0].has_key? :BooleanOperator
+        #   qs << 'query=' + @SearchCriteria.Queries[0][:BooleanOperator]
+        # else
+        #   qs << 'query=AND'
+        # end
+        # if @SearchCriteria.Queries[0].has_key? :FieldCode
+        #   qs << ',' + @SearchCriteria.Queries[0][:FieldCode]
+        # end
+        qs << 'query=' + @SearchCriteria.Queries[0][:Term]
+
+        # mode
+        qs << '&searchmode=' + @SearchCriteria.SearchMode
+
+        # facets
+        qs << '&includefacets=' + @SearchCriteria.IncludeFacets
+
+        # sort
+        qs << '&sort=' + @SearchCriteria.Sort
+
+        # auto-suggest
+        qs << '&autosuggest=' + @SearchCriteria.AutoSuggest
+
+        # limiters
+        unless @SearchCriteria.Limiters.nil?
+          qs << '&limiter=' + @SearchCriteria.Limiters
+        end
+
+        # expanders
+        qs << '&expander=' + @SearchCriteria.Expanders.join(',')
+
+        # facet filters
+        unless @SearchCriteria.FacetFilters.nil?
+          qs << '&facetfilter=1,' + @SearchCriteria.FacetFilters
+        end
+
+        # related content
+        unless @SearchCriteria.RelatedContent.nil?
+          qs << '&relatedcontent=' + @SearchCriteria.RelatedContent.join(',')
+        end
+
+        # Retrieval Criteria
+        unless @RetrievalCriteria.View.nil?
+          qs << '&view=' + @RetrievalCriteria.View
+        end
+        unless @RetrievalCriteria.ResultsPerPage.nil?
+          qs << '&resultsperpage=' + @RetrievalCriteria.ResultsPerPage.to_s
+        end
+        unless @RetrievalCriteria.PageNumber.nil?
+          qs << '&pagenumber=' + @RetrievalCriteria.PageNumber.to_s
+        end
+        unless @RetrievalCriteria.Highlight.nil?
+          qs << '&highlight=' + @RetrievalCriteria.Highlight
+        end
+
+        unless @Actions.nil?
+          @Actions.each do |action|
+            qs << '&action=' + action
+          end
+        end
+        qs
+
+      end
+
+      end
   
     class SearchCriteria
       include JSONable

data/lib/ebsco/eds/results.rb

@@ -1,5 +1,6 @@
 require 'ebsco/eds/record'
 require 'yaml'
+require 'cgi'
 
 module EBSCO
 
@@ -9,7 +10,7 @@ module EBSCO
     class Results
 
       # Raw results as Hash
-      attr_reader :results
+      attr_accessor :results
       # Array of EBSCO::EDS::Record results
       attr_accessor :records
       # Array of EBSCO::EDS::Record Research Starters
@@ -19,13 +20,15 @@ module EBSCO
 
       attr_accessor :stat_total_hits
 
+      attr_reader :raw_options
+
       # Creates search results from the \EDS API search response. It includes information about the results and a list
       # of Record items.
-      def initialize(search_results, additional_limiters = {}, raw_options = {})
+      def initialize(search_results, additional_limiters = {}, options = {})
 
         @results = search_results
         @limiters = additional_limiters
-        @raw_options = raw_options
+        @raw_options = options
 
         # convert all results to a list of records
         @records = []
@@ -286,7 +289,21 @@ module EBSCO
       #      "AutoSuggest"=>"n"
       #    }
       def search_criteria
-        @results['SearchRequest']['SearchCriteria']
+        if @results['SearchRequestGet']['QueryString']
+          params = CGI::parse(@results['SearchRequestGet']['QueryString'])
+          sc = {}
+          sc['SearchMode'] = params['searchmode'].nil? ? 'all' : params['searchmode'][0].to_s
+          sc['IncludeFacets'] = params['includefacets'].nil? ? 'y' : params['includefacets'][0].to_s
+          sc['Sort'] = params['sort'].nil? ? 'relevance' : params['sort'][0].to_s
+          sc['AutoSuggest'] = params['autosuggest'].nil? ? 'n' : params['autosuggest'][0].to_s
+          sc['Expanders'] = params['expander'].nil? ? [] : params['expander'][0].to_s.split(',')
+          sc['RelatedContent'] = params['relatedcontent'].nil? ? [] : params['relatedcontent'][0].to_s.split(',')
+          query1 = params['query-1'][0].to_s.split(',')
+          sc['Queries'] = [{'BooleanOperator'=>query1[0], 'Term'=>query1[1]}]
+          sc
+        else
+          @results['SearchRequest']['SearchCriteria']
+        end
       end
 
       # Search criteria actions applied.
@@ -304,24 +321,43 @@ module EBSCO
       # ==== Example
       #   {"View"=>"brief", "ResultsPerPage"=>20, "PageNumber"=>1, "Highlight"=>"y"}
       def retrieval_criteria
-        @results['SearchRequest']['RetrievalCriteria']
+
+        # GET METHOD: requires the hash to be built from scratch
+        rc = {}
+        if @results['SearchRequestGet']
+          if @results['SearchRequestGet']['QueryString']
+            params = CGI::parse(@results['SearchRequestGet']['QueryString'])
+            rc['PageNumber'] = params['pagenumber'].nil? ? 1 : params['pagenumber'][0].to_i
+            rc['ResultsPerPage'] = params['resultsperpage'].nil? ? 20 : params['resultsperpage'][0].to_i
+            rc['Highlight'] = params['highlight'].nil? ? 'n' : params['highlight'][0].to_s
+            rc['View'] = params['view'].nil? ? 'brief' : params['view'][0].to_s
+          end
+        else
+          if @results['SearchRequest']
+            if @results['SearchRequest']['RetrievalCriteria']
+              rc = @results['SearchRequest']['RetrievalCriteria']
+            end
+          end
+        end
+        rc
+
       end
 
       # Queries used to produce the results. Returns an array of query hashes.
       # ==== Example
       #    [{"BooleanOperator"=>"AND", "Term"=>"volcano"}]
       def search_queries
-        @results['SearchRequest']['SearchCriteria']['Queries']
+        search_criteria['Queries']
       end
 
       # Current page number for the results. Returns an integer.
       def page_number
-        @results['SearchRequest']['RetrievalCriteria']['PageNumber'] || 1
+        retrieval_criteria['PageNumber'] || 1
       end
 
       # Results per page. Returns an integer.
       def results_per_page
-        @results['SearchRequest']['RetrievalCriteria']['ResultsPerPage'] || 20
+        retrieval_criteria['ResultsPerPage'] || 20
       end
 
       # List of facets applied to the search.

data/lib/ebsco/eds/session.rb

@@ -9,6 +9,7 @@ require 'json'
 require 'active_support'
 require 'faraday_eds_middleware'
 require 'ebsco/eds/configuration'
+require 'digest/md5'
 
 module EBSCO
 
@@ -188,16 +189,17 @@ module EBSCO
       #
       #   results = session.search({query: 'abraham lincoln', results_per_page: 5, related_content: ['rs','emp']})
       #   results = session.search({query: 'volcano', results_per_page: 1, publication_id: 'eric', include_facets: false})
-      def search(options = {}, add_actions = false)
-
+      def search(options = {}, add_actions = false, increment_page = true)
         # use existing/updated SearchOptions
         if options.empty?
           if @search_options.nil?
             @search_results = EBSCO::EDS::Results.new(empty_results)
           else
-            _response = do_request(:post, path: @config[:search_url], payload: @search_options)
+            _response = do_request(:post, path: '/edsapi/rest/Search', payload: @search_options)
             @search_results = EBSCO::EDS::Results.new(_response, @info.available_limiters, options)
-            @current_page = @search_results.page_number
+            if increment_page
+              @current_page = @search_results.page_number
+            end
             @search_results
           end
         else
@@ -208,9 +210,11 @@ module EBSCO
             if @search_options.nil? || !add_actions
               @search_options = EBSCO::EDS::Options.new(options, @info)
             end
-            _response = do_request(:post, path: @config[:search_url], payload: @search_options)
+            _response = do_request(:post, path: '/edsapi/rest/Search', payload: @search_options)
             @search_results = EBSCO::EDS::Results.new(_response, @info.available_limiters, options)
-            @current_page = @search_results.page_number
+            if increment_page
+              @current_page = @search_results.page_number
+            end
             @search_results
           else
             @search_results = EBSCO::EDS::Results.new(empty_results)
@@ -218,6 +222,8 @@ module EBSCO
         end
       end
 
+      # todo: need a lookahead and lookbehind option for blacklight next/previous detail page - do search but don't change the current_page
+
       # :category: Search & Retrieve Methods
       # Performs a simple search. All other search options assume default values.
       #
@@ -250,7 +256,9 @@ module EBSCO
       #
       def retrieve(dbid:, an:, highlight: nil, ebook: 'ebook-pdf')
         payload = { DbId: dbid, An: an, HighlightTerms: highlight, EbookPreferredFormat: ebook }
-        retrieve_response = do_request(:post, path: @config[:retrieve_url], payload: payload)
+        # retrieve_response = do_request(:post, path: @config[:retrieve_url], payload: payload)
+        retrieve_params = "?an=#{an}&dbid=#{dbid}&ebookpreferredformat=#{ebook}"
+        retrieve_response = do_request(:get, path: @config[:retrieve_url] + retrieve_params)
         record = EBSCO::EDS::Record.new(retrieve_response)
         # puts 'RECORD: ' + record.pretty_inspect
         record
@@ -258,21 +266,64 @@ module EBSCO
 
       # Create a result set with just the record before and after the current detailed record
       def solr_retrieve_previous_next(options = {})
-        records = []
-        hits = search(options).stat_total_hits
-        # don't try to return a previous result if it's the first record
-        if options['previous-next-index'].to_i > 1
-          options.update(:results_per_page => 1,
-                         'page' => (options['previous-next-index'].to_i) - 1)
-          records.push  search(options).records.first
+
+        rid = options['previous-next-index']
+
+        # set defaults if missing
+        if options['page'].nil?
+          options['page'] = '1'
         end
-        options.update(:results_per_page => 1,
-                       'page' => (options['previous-next-index'].to_i) + 1)
-        records.push  search(options).records.first
-        r = empty_results(hits)
+        if options['per_page'].nil?
+          options['per_page'] = '20'
+        end
+
+        rpp = options['per_page'].to_i
+
+        # determine result page and update options
+        goto_page = rid / rpp
+        if (rid % rpp) > 0
+          goto_page += 1
+        end
+        options['page'] = goto_page.to_s
+        pnum = options['page'].to_i
+
+        max = rpp * pnum
+        min = max - rpp + 1
+        result_index = rid - min
+        cached_results = search(options)
+
+        # last result in set, get next result
+        if rid == max
+          @search_options.add_actions("GoToPage(#{cached_results.page_number+1})", @info)
+          next_result_set = search({}, true, false)
+          result_next = next_result_set.records.first
+        else
+          result_next = cached_results.records[result_index+1]
+        end
+
+        if result_next.nil?
+          puts 'ERROR: result_next is nil'
+        end
+
+        # first result in set that's not the very first result, get previous result
+        if result_index == 0 and rid != 1
+          @search_options.add_actions("GoToPage(#{cached_results.page_number-1})", @info)
+          previous_result_set = search({}, true, false)
+          result_prev = previous_result_set.records.last
+        else
+          result_prev = cached_results.records[result_index-1]
+        end
+
+        if result_prev.nil?
+          puts 'ERROR: result_prev is nil'
+        end
+
+        # return json result set with just the previous and next records in it
+        r = empty_results(cached_results.stat_total_hits)
         results = EBSCO::EDS::Results.new(r)
-        results.records = records
+        results.records = [result_prev, result_next]
         results.to_solr
+
       end
 
       def solr_retrieve_list(list: [], highlight: nil)
@@ -608,12 +659,27 @@ module EBSCO
           resp = connection.send(method) do |req|
             case method
               when :get
+                unless payload.nil?
+                  qs = CGI.escape(payload.to_query_string)
+                  path << '?' + qs
+                end
                 req.url path
               when :post
-                req.url path
                 unless payload.nil?
-                  req.body = JSON.generate(payload)
+                  json_payload = JSON.generate(payload)
+                  # add a cache_id to post search requests to make them cacheable
+                  if path == '/edsapi/rest/Search'
+                    # replacements to avoid duplicate caches
+                    json_payload = json_payload.gsub(/"PageNumber":[0-9]+,/,'')
+                    json_payload = json_payload.gsub(/"ResultsPerPage":"([0-9]+)"/,'"ResultsPerPage":\1')
+                    json_payload = json_payload.gsub(/"Actions":\[]/,'"Actions":["GoToPage(1)"]')
+                    # puts 'CHECKSUM PAYLOAD: ' + json_payload.inspect
+                    checksum = Digest::MD5.hexdigest json_payload
+                    path << '?cache_id=' + checksum
+                  end
+                  req.body = json_payload
                 end
+                req.url path
               else
                 raise EBSCO::EDS::ApiError, "EBSCO API error: Method #{method} not supported for endpoint #{path}"
             end

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.2.8.pre'
+    VERSION = '0.2.9.pre'
   end
 end

data/lib/faraday/eds_caching_middleware.rb

@@ -7,6 +7,8 @@ module Faraday
 
     INFO_URI = URI.parse('https://eds-api.ebscohost.com/edsapi/rest/Info')
     AUTH_URI = URI.parse('https://eds-api.ebscohost.com/authservice/rest/uidauth')
+    SEARCH_URI = URI.parse('https://eds-api.ebscohost.com/edsapi/rest/Search?')
+    RETRIEVE_URI = URI.parse('https://eds-api.ebscohost.com/edsapi/rest/Retrieve?')
 
     def initialize(app, *args)
       super(app)
@@ -43,6 +45,7 @@ module Faraday
     end
 
     def cache_response(env)
+      #puts 'ENV: ' + env.inspect
       return unless cacheable?(env) && !env.request_headers['x-faraday-eds-cache']
 
       info "Cache WRITE: #{key(env)}"
@@ -59,12 +62,24 @@ module Faraday
         info "#{uri} - Setting custom expires: #{custom_expires_in}"
       end
 
+      if uri.request_uri.start_with?(SEARCH_URI.request_uri)
+        custom_expires_in = 1800 # 30 minutes
+        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+      end
+
+      if uri.request_uri.start_with?(RETRIEVE_URI.request_uri)
+        custom_expires_in = 1800 # 30 minutes
+        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+      end
+
       @store.write(key(env), env, expires_in: custom_expires_in)
     end
 
     def cacheable?(env)
       uri = env.url
-      if uri == AUTH_URI || uri == INFO_URI
+      if uri == AUTH_URI || uri == INFO_URI ||
+          uri.request_uri.start_with?(SEARCH_URI.request_uri) ||
+          uri.request_uri.start_with?(RETRIEVE_URI.request_uri)
         info "CACHEABLE URI: #{uri}"
         true
       else
@@ -74,6 +89,7 @@ module Faraday
     end
 
     def cached_response(env)
+
       if cacheable?(env) && !env.request_headers['x-faraday-eds-cache']
         response_env = @store.fetch(key(env))
       end
@@ -83,9 +99,6 @@ module Faraday
       else
         info "Cache MISS: #{key(env)}"
       end
-
-      # info "CACHE: #{response_env.inspect}"
-
       response_env
     end
 
@@ -99,7 +112,6 @@ module Faraday
 
     def initialize_store
       return unless @store.is_a? Symbol
-
       require 'active_support/cache'
       @store = ActiveSupport::Cache.lookup_store(@store, @store_options)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.2.8.pre
+  version: 0.2.9.pre
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday