ebsco-eds 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 623b81079a6dd743fc4fe392364d27349a780860
-  data.tar.gz: d4aae67d364928d8e90ed76e1e89bc595b66633b
+SHA256:
+  metadata.gz: a98621f9b0ef365e1fca3f814127d8a1a20ff7fa70113d254c2ff90d33b62777
+  data.tar.gz: 639b960e78cbe5c01aaaefc88b524286371a7c6aca32c9c16dc26e70b99b3b97
 SHA512:
-  metadata.gz: '0962c36f6e6e9c6df244d9dec9589911b82b9cb5287b74e35070d5a1a80a6e6434d378a28769cdcd8f91b6e32340cbc99668e6ba5c571056a6c9b746cb6fbe85'
-  data.tar.gz: 71f3cf8e55486123ffdbec5b7962fbf38fb128a64c859997fe38bc6f2a83c0979b0dd1228c9bb8f5eff27da0b4ea27025c1fb6b0e8e42ea369def3cc6f9ca6c0
+  metadata.gz: 4b50c885e10fd0c126736c69af927e5d69e76eb3af3c3985f63acdcf49c385f9285bbee9bd4185b177d64279ad8778218a665fd51c01efd957113c75431ef0c1
+  data.tar.gz: 848222290962eec5901b0bf0f871e64ed8066a375aea7785a8ca1066ac3d84a03f1f513388886049b33958eeb8d9e4230911b276c6fdac7a13eaffcdf080ace0

data/.travis.yml

@@ -1,5 +1,4 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.13.7
+  - 2.4.0

data/CHANGELOG.md

@@ -4,12 +4,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). 
 
+## [1.0.8] - 2019-08-12
+### Fixed
+- Throws error when query fails with a 200 status code and html error message (query = `the meaning of life or 4=2`), see #90.
+- Raises a specific "record not found" error instead of a generic "bad request" error when a record cannot be retrieved, see #88.
+
+## [1.0.7] - 2018-12-05
+### Changed
+- logger dependency removed since it's been part of the standard library.
+
+## [1.0.6] - 2018-11-14
+### Fixed
+- Fixed a bug where the cached auth key isn't deleted if it expires before its cache expiration. This should only occur in rare cases where the auth token cache expiration exceeds 30 minutes.
+### Added
+- Cache expiration is configurable for individual EDS API calls (time unit = seconds).
+### Changed
+- Default cache expiration for auth keys is now 25 minutes instead of 30 to make sure they are always refreshed before their 30 minute expiration. If an expiration is configured longer than 25 minutes, it is reset to 25 minutes automatically.
+
 ## [1.0.5] - 2018-11-02
 ### Fixed
 - Fixed a bug where fulltext html becomes nil after sanitizing. [#85](https://github.com/ebsco/edsapi-ruby/issues/85) 
 - Fixed a bug where the url protocol is missing from fulltext custom links. [#86](https://github.com/ebsco/edsapi-ruby/issues/86)
 
-
 ## [1.0.4] - 2018-10-29
 ### Fixed
 - List retrieval returns a repeating list of just the first record. 
@@ -81,6 +97,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Adds KW (keywords) and SH (subject heading) to solr search fields
 
+[1.0.8]: https://github.com/ebsco/edsapi-ruby/compare/1.0.7...1.0.8
+[1.0.7]: https://github.com/ebsco/edsapi-ruby/compare/1.0.6...1.0.7
+[1.0.6]: https://github.com/ebsco/edsapi-ruby/compare/1.0.5...1.0.6
 [1.0.5]: https://github.com/ebsco/edsapi-ruby/compare/1.0.4...1.0.5
 [1.0.4]: https://github.com/ebsco/edsapi-ruby/compare/1.0.3...1.0.4
 [1.0.3]: https://github.com/ebsco/edsapi-ruby/compare/1.0.2...1.0.3

data/README.md

@@ -8,7 +8,7 @@ A Ruby interface to the EBSCO Discovery Services API.
 
 ## Dependencies
 
-* Ruby 2.2+
+* Ruby 2.4+
 
 ## Installation
 

data/ebsco-eds.gemspec

@@ -6,8 +6,8 @@ require 'ebsco/eds/version'
 Gem::Specification.new do |spec|
   spec.name          = 'ebsco-eds'
   spec.version       = EBSCO::EDS::VERSION
-  spec.authors       = ['Bill McKinney','Eric Frierson']
-  spec.email         = ['bmckinney@ebsco.com, efrierson@ebsco.com']
+  spec.authors       = ['Madeline Dale','Eric Frierson']
+  spec.email         = ['mdale@ebsco.com, efrierson@ebsco.com']
   spec.summary       = 'Summary: EBSCO EDS API'
   spec.description   = 'Description: EBSCO EDS API'
   spec.homepage      = 'https://github.com/ebsco/edsapi-ruby'
@@ -29,31 +29,31 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.4'
 
   spec.add_dependency 'faraday', '~> 0'
   spec.add_dependency 'faraday-detailed_logger', '~> 2.0'
   spec.add_dependency 'faraday_middleware', '~> 0.11'
-  spec.add_dependency 'logger', '~> 1.2'
   spec.add_dependency 'dotenv', '~> 2.2'
   spec.add_dependency 'climate_control', '~> 0'
-  spec.add_dependency 'require_all', '~> 1.3'
-  spec.add_dependency 'bibtex-ruby', '~> 4.0'
+  spec.add_dependency 'require_all', '~> 2.0'
+  spec.add_dependency 'bibtex-ruby', '~> 5.1', '>= 5.1.0'
   spec.add_dependency 'citeproc', '>= 1.0.4', '< 2.0'
   spec.add_dependency 'csl', '~> 1.4'
   spec.add_dependency 'citeproc-ruby', '~> 1.0', '>= 1.0.2'
   spec.add_dependency 'csl-styles', '~> 1.0', '>= 1.0.1.5'
-  spec.add_dependency 'activesupport', '~> 5.0'
-  spec.add_dependency 'net-http-persistent', '~> 2.9'
-  spec.add_dependency 'sanitize', '~> 4.5', '>= 4.5.0'
+  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'net-http-persistent', '~> 3.1'
+  spec.add_dependency 'sanitize', '~> 5.0'
+  spec.add_dependency 'public_suffix', '~>4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
   spec.add_development_dependency 'codecov', '~> 0.1'
-  spec.add_development_dependency 'vcr', '~> 2.8'
-  spec.add_development_dependency 'minitest-vcr', '~> 0.1.1'
-  spec.add_development_dependency 'webmock', '~> 1.17'
+  spec.add_development_dependency 'vcr', '~> 5.0', '>= 5.0.0'
+  spec.add_development_dependency 'minitest-vcr', '~> 1.4', '>= 1.4.0'
+  spec.add_development_dependency 'webmock', '~> 3.6'
 
 end

data/lib/ebsco/eds/configuration.rb

@@ -38,6 +38,12 @@ module EBSCO
             :ebook_preferred_format => 'ebook-pdf',
             :use_cache => true,
             :eds_cache_dir => ENV['TMPDIR'] || '/tmp',
+            :auth_cache_expires_in => 1500,
+            :info_cache_expires_in => 86400,
+            :retrieve_cache_expires_in => 1800,
+            :search_cache_expires_in => 1800,
+            :export_format_cache_expires_in => 86400,
+            :citation_styles_cache_expires_in => 86400,
             :timeout => 60,
             :open_timeout => 12,
             :max_page_jumps => 6,
@@ -53,7 +59,8 @@ module EBSCO
             :ris_link_find => '',
             :ris_link_replace => '',
             :ris_db_find => '',
-            :ris_db_replace => ''
+            :ris_db_replace => '',
+            :smarttext_failover => false
         }
         @valid_config_keys = @config.keys
       end

data/lib/ebsco/eds/record.rb

@@ -961,7 +961,12 @@ module EBSCO
           html = html.gsub(/\\n /, '')
         end
 
-        Sanitize.fragment(html, sanitize_config)
+        sanitized_html = Sanitize.fragment(html, sanitize_config)
+        # sanitize 5.0 fails to restore element case after doing lowercase
+        sanitized_html = sanitized_html.gsub(/<searchlink/, '<searchLink')
+        sanitized_html = sanitized_html.gsub(/<\/searchlink>/, '</searchLink>')
+        sanitized_html
+
       end
 
       # dynamically add item metadata as 'eds_extra_ItemNameOrLabel'

data/lib/ebsco/eds/results.rb

@@ -29,76 +29,87 @@ module EBSCO
 
       # 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, eds_config = {}, additional_limiters = {}, options = {})
+      def initialize(search_results, eds_config = {}, additional_limiters = {}, options = {}, smarttext_failover = false)
 
         @results = search_results
-        @limiters = additional_limiters
-        @raw_options = options
-
-        # titleize facets?
-        (ENV.has_key? 'EDS_TITLEIZE_FACETS') ?
-            if %w(y Y yes Yes true True).include?(ENV['EDS_TITLEIZE_FACETS'])
-              @titleize_facets_on = true
-            else
-              @titleize_facets_on = false
-            end :
-            @titleize_facets_on = eds_config[:titleize_facets]
-
-        # convert all results to a list of records
-        @records = []
-        if @results['SearchResult']['Data']['Records']
-          @results['SearchResult']['Data']['Records'].each { |record|
-
-            @records.push(EBSCO::EDS::Record.new(record, eds_config))
-
-            # # records hidden in guest mode
-            # if record['Header']['AccessLevel']
-            #   if record['Header']['AccessLevel'].to_i > 1
-            #     @records.push(EBSCO::EDS::Record.new(record))
-            #   else
-            #     @records.push(EBSCO::EDS::Record.new(record))
-            #   end
-            # else
-            #   @records.push(EBSCO::EDS::Record.new(record))
-            # end
 
-          }
-        end
+        if @results.is_a?(Hash)
+
+          @limiters = additional_limiters
+          @raw_options = options
+
+          # titleize facets?
+          (ENV.has_key? 'EDS_TITLEIZE_FACETS') ?
+              if %w(y Y yes Yes true True).include?(ENV['EDS_TITLEIZE_FACETS'])
+                @titleize_facets_on = true
+              else
+                @titleize_facets_on = false
+              end :
+              @titleize_facets_on = eds_config[:titleize_facets]
+
+          # convert all results to a list of records
+          @records = []
+          if @results['SearchResult']['Data']['Records']
+            @results['SearchResult']['Data']['Records'].each { |record|
+
+              @records.push(EBSCO::EDS::Record.new(record, eds_config))
+
+              # # records hidden in guest mode
+              # if record['Header']['AccessLevel']
+              #   if record['Header']['AccessLevel'].to_i > 1
+              #     @records.push(EBSCO::EDS::Record.new(record))
+              #   else
+              #     @records.push(EBSCO::EDS::Record.new(record))
+              #   end
+              # else
+              #   @records.push(EBSCO::EDS::Record.new(record))
+              # end
+
+            }
+          end
 
-        # create a special list of research starter records
-        @research_starters = []
-        _related_records = @results.fetch('SearchResult',{}).fetch('RelatedContent',{}).fetch('RelatedRecords',{})
-        if _related_records.count > 0
-          _related_records.each do |related_item|
-            if related_item['Type'] == 'rs'
-              rs_entries = related_item.fetch('Records',{})
-              if rs_entries.count > 0
-                rs_entries.each do |rs_record|
-                  @research_starters.push(EBSCO::EDS::Record.new(rs_record, eds_config))
+          # create a special list of research starter records
+          @research_starters = []
+          _related_records = @results.fetch('SearchResult',{}).fetch('RelatedContent',{}).fetch('RelatedRecords',{})
+          if _related_records.count > 0
+            _related_records.each do |related_item|
+              if related_item['Type'] == 'rs'
+                rs_entries = related_item.fetch('Records',{})
+                if rs_entries.count > 0
+                  rs_entries.each do |rs_record|
+                    @research_starters.push(EBSCO::EDS::Record.new(rs_record, eds_config))
+                  end
                 end
               end
             end
           end
-        end
 
-        # create a special list of exact match publications
-        @publication_match = []
-        _related_publications = @results.fetch('SearchResult',{}).fetch('RelatedContent',{}).fetch('RelatedPublications',{})
-        if _related_publications.count > 0
-          _related_publications.each do |related_item|
-            if related_item['Type'] == 'emp'
-              _publication_matches = related_item.fetch('PublicationRecords',{})
-              if _publication_matches.count > 0
-                _publication_matches.each do |publication_record|
-                  @publication_match.push(EBSCO::EDS::Record.new(publication_record, eds_config))
+          # create a special list of exact match publications
+          @publication_match = []
+          _related_publications = @results.fetch('SearchResult',{}).fetch('RelatedContent',{}).fetch('RelatedPublications',{})
+          if _related_publications.count > 0
+            _related_publications.each do |related_item|
+              if related_item['Type'] == 'emp'
+                _publication_matches = related_item.fetch('PublicationRecords',{})
+                if _publication_matches.count > 0
+                  _publication_matches.each do |publication_record|
+                    @publication_match.push(EBSCO::EDS::Record.new(publication_record, eds_config))
+                  end
                 end
               end
             end
           end
-        end
 
-        # titleize facets
-        @titleize_facets = %w[Language Journal SubjectEDS SubjectGeographic Publisher]
+          # titleize facets
+          @titleize_facets = %w[Language Journal SubjectEDS SubjectGeographic Publisher]
+
+          # set flag that query was rerun with smarttext after no results were found
+          @smarttext_failover = smarttext_failover
+
+        else
+          # response isn't a hash (eg, html error page)
+          raise EBSCO::EDS::ApiError, 'EBSCO API error: Query failed.'
+        end
 
       end
 

data/lib/ebsco/eds/session.rb

@@ -105,9 +105,17 @@ module EBSCO
         raise EBSCO::EDS::InvalidParameter, 'Session must specify a valid api profile.' if blank?(@profile)
 
         # these config options can be overridden by environment vars
-        @auth_type =  (ENV.has_key? 'EDS_AUTH') ? ENV['EDS_AUTH'] : @config[:auth]
-        @org =        (ENV.has_key? 'EDS_ORG') ? ENV['EDS_ORG'] : @config[:org]
-        @cache_dir =  (ENV.has_key? 'EDS_CACHE_DIR') ? ENV['EDS_CACHE_DIR'] : @config[:eds_cache_dir]
+        @auth_type              =  (ENV.has_key? 'EDS_AUTH') ? ENV['EDS_AUTH'] : @config[:auth]
+        @org                    =  (ENV.has_key? 'EDS_ORG') ? ENV['EDS_ORG'] : @config[:org]
+        @cache_dir              =  (ENV.has_key? 'EDS_CACHE_DIR') ? ENV['EDS_CACHE_DIR'] : @config[:eds_cache_dir]
+        @auth_expire            =  (ENV.has_key? 'EDS_AUTH_CACHE_EXPIRES_IN') ? ENV['EDS_AUTH_CACHE_EXPIRES_IN'] : @config[:auth_cache_expires_in]
+        @info_expire            =  (ENV.has_key? 'EDS_INFO_CACHE_EXPIRES_IN') ? ENV['EDS_INFO_CACHE_EXPIRES_IN'] : @config[:info_cache_expires_in]
+        @retrieve_expire        =  (ENV.has_key? 'EDS_RETRIEVE_CACHE_EXPIRES_IN') ? ENV['EDS_RETRIEVE_CACHE_EXPIRES_IN'] : @config[:retrieve_cache_expires_in]
+        @search_expire          =  (ENV.has_key? 'EDS_SEARCH_CACHE_EXPIRES_IN') ? ENV['EDS_SEARCH_CACHE_EXPIRES_IN'] : @config[:search_cache_expires_in]
+        @export_format_expire   =  (ENV.has_key? 'EDS_EXPORT_FORMAT_CACHE_EXPIRES_IN') ? ENV['EDS_EXPORT_FORMAT_CACHE_EXPIRES_IN'] : @config[:export_format_cache_expires_in]
+        @citation_styles_expire =  (ENV.has_key? 'EDS_CITATION_STYLES_CACHE_EXPIRES_IN') ? ENV['EDS_CITATION_STYLES_CACHE_EXPIRES_IN'] : @config[:citation_styles_cache_expires_in]
+
+
         @log_level =  (ENV.has_key? 'EDS_LOG_LEVEL') ? ENV['EDS_LOG_LEVEL'] : @config[:log_level]
 
         (ENV.has_key? 'EDS_GUEST') ?
@@ -235,11 +243,15 @@ module EBSCO
             if @search_options.nil? || !add_actions
               @search_options = EBSCO::EDS::Options.new(options, @info)
             end
-
             _response = do_request(:post, path: '/edsapi/rest/Search', payload: @search_options)
             @search_results = EBSCO::EDS::Results.new(_response, @config,
                                                       @info.available_limiters, options)
-
+            if @search_results.stat_total_hits.to_i == 0 && @config[:smarttext_failover] == true
+              @search_options.add_actions('SetSearchMode(smart)', @info)
+              _response = do_request(:post, path: '/edsapi/rest/Search', payload: @search_options)
+              @search_results = EBSCO::EDS::Results.new(_response, @config,
+                                                      @info.available_limiters, options, true)
+            end
             # create temp format facet results if needed
             if options['f']
               if options['f'].key?('eds_publication_type_facet')
@@ -332,21 +344,24 @@ module EBSCO
          citation_exports_params = "?an=#{an}&dbid=#{dbid}&format=#{format}"
          citation_exports_response = do_request(:get, path: @config[:citation_exports_url] + citation_exports_params)
          EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: citation_exports_response, eds_config: @config)
-        rescue EBSCO::EDS::BadRequest => e
-          custom_error_message = JSON.parse e.message.gsub('=>', ':')
-          # ErrorNumber 112 - Invalid Argument Value
-          # ErrorNumber 132 - Record not found
-          if custom_error_message['ErrorNumber'] == '112'
-            unknown_export_format = {"Format"=>format, "Label"=>"", "Data"=>"", "Error"=>"Invalid citation export format"}
-            EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: unknown_export_format, eds_config: @config)
-          elsif custom_error_message['ErrorNumber'] == '132'
-            record_not_found = {"Format"=>format, "Label"=>"", "Data"=>"", "Error"=>"Record not found"}
-            EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: record_not_found, eds_config: @config)
-          else
-            unknown_error = {"Format"=>format, "Label"=>"", "Data"=>"", "Error"=>custom_error_message['ErrorDescription']}
-            EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: unknown_error, eds_config: @config)
+         rescue EBSCO::EDS::NotFound => e
+           custom_error_message = JSON.parse e.message.gsub('=>', ':')
+           # ErrorNumber 132 - Record not found
+           if custom_error_message['ErrorNumber'] == '132'
+             record_not_found = {"Format"=>format, "Label"=>"", "Data"=>"", "Error"=>"Record not found"}
+             EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: record_not_found, eds_config: @config)
+           end
+         rescue EBSCO::EDS::BadRequest => e
+            custom_error_message = JSON.parse e.message.gsub('=>', ':')
+            # ErrorNumber 112 - Invalid Argument Value
+            if custom_error_message['ErrorNumber'] == '112'
+              unknown_export_format = {"Format"=>format, "Label"=>"", "Data"=>"", "Error"=>"Invalid citation export format"}
+              EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: unknown_export_format, eds_config: @config)
+            else
+              unknown_error = {"Format"=>format, "Label"=>"", "Data"=>"", "Error"=>custom_error_message['ErrorDescription']}
+              EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: unknown_error, eds_config: @config)
+            end
           end
-        end
       end
 
       # fetch the citation from the citation rest endpoint
@@ -355,6 +370,13 @@ module EBSCO
           citation_styles_params = "?an=#{an}&dbid=#{dbid}&styles=#{format}"
           citation_styles_response = do_request(:get, path: @config[:citation_styles_url] + citation_styles_params)
           EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: citation_styles_response, eds_config: @config)
+        rescue EBSCO::EDS::NotFound => e
+          custom_error_message = JSON.parse e.message.gsub('=>', ':')
+          # ErrorNumber 132 - Record not found
+          if custom_error_message['ErrorNumber'] == '132'
+            record_not_found = {"Format"=>format, "Label"=>"", "Data"=>"", "Error"=>"Record not found"}
+            EBSCO::EDS::Citations.new(dbid: dbid, an: an, citation_result: record_not_found, eds_config: @config)
+          end
         rescue EBSCO::EDS::BadRequest => e
           custom_error_message = JSON.parse e.message.gsub('=>', ':')
           unknown_error = {"Id"=>format, "Label"=>"", "Data"=>"", "Error"=>custom_error_message['ErrorDescription']}
@@ -462,9 +484,13 @@ module EBSCO
           list.each.with_index(1) { |id, index|
             dbid = id.split('__',2).first
             accession = id.split('__',2).last
-            current_rec = retrieve(dbid: dbid, an: accession, highlight: highlight, ebook: @config[:ebook_preferred_format])
-            current_rec.eds_result_id = index
-            records.push current_rec
+            begin
+              current_rec = retrieve(dbid: dbid, an: accession, highlight: highlight, ebook: @config[:ebook_preferred_format])
+              current_rec.eds_result_id = index
+              records.push current_rec
+            rescue EBSCO::EDS::BadRequest, EBSCO::EDS::NotFound => e
+              puts "Request for #{id} in #{self.class.name}#solr_retrieve_list failed with #{e}" if @debug
+            end
           }
         end
         r = empty_results(records.length)
@@ -847,6 +873,11 @@ module EBSCO
                   do_request(method, path: path, payload: payload, attempt: attempt+1)
                 # auth token invalid
                 when '104', '107'
+                  # delete the auth cache to make sure we have an unexpired auth token
+                  if @use_cache
+                    puts 'DELETING AUTH CACHE...' if @debug
+                    @cache_store.delete_matched('https://' + @api_hosts_list[@api_host_index] + @config[:uid_auth_url])
+                  end
                   @auth_token = nil
                   @auth_token = create_auth_token
                   do_request(method, path: path, payload: payload, attempt: attempt+1)
@@ -1069,7 +1100,15 @@ module EBSCO
           conn.headers['x-authenticationToken'] = @auth_token ? @auth_token : ''
           conn.headers['User-Agent'] = @config[:user_agent]
           conn.request :url_encoded
-          conn.use :eds_caching_middleware, store: @cache_store, logger: @debug ? logger : nil if @use_cache
+          conn.use :eds_caching_middleware,
+                   store: @cache_store,
+                   auth_expire: @auth_expire,
+                   info_expire: @info_expire,
+                   search_expire: @search_expire,
+                   retrieve_expire: @retrieve_expire,
+                   export_format_expire: @export_format_expire,
+                   citation_styles_expire: @citation_styles_expire,
+                   logger: @debug ? logger : nil if @use_cache
           conn.use :eds_exception_middleware
           conn.response :json, content_type: /\bjson$/
           conn.response :detailed_logger, logger if @debug
@@ -1109,7 +1148,15 @@ module EBSCO
           conn.headers['x-authenticationToken'] = @auth_token ? @auth_token : ''
           conn.headers['User-Agent'] = @config[:user_agent]
           conn.request :url_encoded
-          conn.use :eds_caching_middleware, store: @cache_store, logger: @debug ? logger : nil if @use_cache
+          conn.use :eds_caching_middleware,
+                   store: @cache_store,
+                   auth_expire: @auth_expire,
+                   info_expire: @info_expire,
+                   search_expire: @search_expire,
+                   retrieve_expire: @retrieve_expire,
+                   export_format_expire: @export_format_expire,
+                   citation_styles_expire: @citation_styles_expire,
+                   logger: @debug ? logger : nil if @use_cache
           conn.use :eds_exception_middleware
           conn.response :json, content_type: /\bjson$/
           conn.response :detailed_logger, logger if @debug
@@ -1222,4 +1269,4 @@ module EBSCO
 
     end
   end
-end
+end

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '1.0.5'
+    VERSION = '1.1.0'
   end
 end

data/lib/faraday/eds_caching_middleware.rb

@@ -9,11 +9,16 @@ module Faraday
     def initialize(app, *args)
       super(app)
       options = args.first || {}
-      @expires_in    = options.fetch(:expires_in, 30)
-      @logger        = options.fetch(:logger, nil)
-      @namespace     = options.fetch(:namespace, 'faraday-eds-cache')
-      @store         = options.fetch(:store, :memory_store)
-      @store_options = options.fetch(:store_options, {})
+      @auth_expire            = options.fetch(:auth_expire, 1500)
+      @info_expire            = options.fetch(:info_expire, 86400)
+      @retrieve_expire        = options.fetch(:retrieve_expire, 1800)
+      @search_expire          = options.fetch(:search_expire, 1800)
+      @export_format_expire   = options.fetch(:export_format_expire, 86400)
+      @citation_styles_expire = options.fetch(:citation_styles_expire, 86400)
+      @logger                 = options.fetch(:logger, nil)
+      @namespace              = options.fetch(:namespace, 'faraday-eds-cache')
+      @store                  = options.fetch(:store, :memory_store)
+      @store_options          = options.fetch(:store_options, {})
 
       @store_options[:namespace] ||= @namespace
 
@@ -44,40 +49,45 @@ module Faraday
     end
 
     def cache_response(env)
+
       return unless cacheable?(env) && !env.request_headers['x-faraday-eds-cache']
 
       info "Cache WRITE: #{key(env)}"
-      custom_expires_in = @expires_in
+      custom_expires_in = 1800 # 30 mins
       uri = env.url
 
       if uri.request_uri.include?('/authservice/rest/uidauth')
-        custom_expires_in = 1800 # 30 minutes
-        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+        custom_expires_in = @auth_expire
+        # don't allow expiration to exceed 25 minutes since auth tokens always expire in 30 minutes
+        if custom_expires_in > 1500
+          custom_expires_in = 1500
+        end
+        info "#{uri} - Setting expires: #{custom_expires_in}"
       end
 
       if uri.request_uri.include?('/edsapi/rest/Info')
-        custom_expires_in = 86400 # 24 hours
-        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+        custom_expires_in = @info_expire
+        info "#{uri} - Setting /edsapi/rest/Info expires: #{custom_expires_in}"
       end
 
       if uri.request_uri.include?('/edsapi/rest/Search?')
-        custom_expires_in = 1800 # 30 minutes
-        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+        custom_expires_in = @search_expire
+        info "#{uri} - Setting /edsapi/rest/Search expires: #{custom_expires_in}"
       end
 
       if uri.request_uri.include?('/edsapi/rest/Retrieve?')
-        custom_expires_in = 1800 # 30 minutes
-        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+        custom_expires_in = @retrieve_expire
+        info "#{uri} - Setting /edsapi/rest/Retrieve expires: #{custom_expires_in}"
       end
 
       if uri.request_uri.include?('/edsapi/rest/ExportFormat')
-        custom_expires_in = 86400 # 24 hours
-        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+        custom_expires_in = @export_format_expire
+        info "#{uri} - Setting /edsapi/rest/ExportFormat expires: #{custom_expires_in}"
       end
 
       if uri.request_uri.include?('/edsapi/rest/CitationStyles')
-        custom_expires_in = 86400 # 24 hours
-        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+        custom_expires_in = @citation_styles_expire
+        info "#{uri} - Setting /edsapi/rest/CitationStyles expires: #{custom_expires_in}"
       end
 
       @store.write(key(env), env, expires_in: custom_expires_in)

data/lib/faraday/eds_exception_middleware.rb

@@ -14,15 +14,19 @@ module Faraday
           case response.status
             when 200
             when 400
-              raise EBSCO::EDS::BadRequest.new(error_message(response))
-            # when 401
-            #   raise EBSCO::EDS::Unauthorized.new
-            # when 403
-            #   raise EBSCO::EDS::Forbidden.new
-            # when 404
-            #   raise EBSCO::EDS::NotFound.new
-            # when 429
-            #   raise EBSCO::EDS::TooManyRequests.new
+              if response.body['ErrorNumber'] == '132'
+                raise EBSCO::EDS::NotFound.new(error_message(response))
+              else
+                raise EBSCO::EDS::BadRequest.new(error_message(response))
+              end
+              # when 401
+              #   raise EBSCO::EDS::Unauthorized.new
+              # when 403
+              #   raise EBSCO::EDS::Forbidden.new
+              # when 404
+              #   raise EBSCO::EDS::NotFound.new
+              # when 429
+              #   raise EBSCO::EDS::TooManyRequests.new
             when 500
               raise EBSCO::EDS::InternalServerError.new
             when 503

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
-- Bill McKinney
+- Madeline Dale
 - Eric Frierson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -101,28 +87,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: citeproc
   requirement: !ruby/object:Gem::Requirement
@@ -203,76 +195,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
-    - - ">="
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.5.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -293,14 +293,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -319,47 +319,59 @@ dependencies:
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.6'
 description: 'Description: EBSCO EDS API'
 email:
-- bmckinney@ebsco.com, efrierson@ebsco.com
+- mdale@ebsco.com, efrierson@ebsco.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -406,15 +418,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: 'Summary: EBSCO EDS API'