ebsco-eds 1.0.8 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cd3df278b8f54b8391e1fab578b2c268c4ba0611
-  data.tar.gz: 63aa813ab6adcfb15f21c70392d6127841ec440b
+SHA256:
+  metadata.gz: e0260317849a9ed9937f14bfb1bce691d11bc37dc031a9707c99aed1239bbc0b
+  data.tar.gz: 4549287d4f9f12edaf968d5439870682c26e91a2334e6145d7d323440f577056
 SHA512:
-  metadata.gz: e534bf012f442328a9cd6df94a7a22d32cd3d63e33199ddb9c238f826add23e739d0192ad887ff5144944bf965960d5d654b65a708a30bbd54ecf405e50f9465
-  data.tar.gz: f94b92153adfb5c485ecb1edfe65696085da2bb656fe81b77df96f1431c3ea87a22e19b2b748a1937e22863f3695c6ef11b4041b5e9bfc6f944db84835cf5862
+  metadata.gz: 7a2fcddd103f0e2aa20699e30445e6b3681dafd43564e628d36fcf80d691e6df76861951e5647aa0f760f4f7c22a8b960caa1731acdc710fabd57fe013cb7cd2
+  data.tar.gz: 4f34ec5977c344bf917b52102ea01bdf1dbc34db7b9f005fc5faca5019c808079446d21f1037f009866e9fddc15ee8504182e688b7c303bd02fc22dda74a845b

data/.gitignore

@@ -20,3 +20,4 @@ yaml-sample-records
 *.gem
 .idea
 test/cache
+.env.test

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

@@ -1,100 +1,172 @@
 # Changelog
+
 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). 
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [1.1.1] - 2021-03-05
 
-## [1.0.8] - 2019-08-12
 ### Fixed
+
+- Some tests had incorrect VCR cassettes that were erroneously causing our build to fail.
+
+### Changed
+
+- Loosened various dependencies, including on activesupport. Activesupport now can use either version 5 or 6. Many thanks to @sandbergja for help on that.
+- Added an attribute read option for smarttext_failover on EBSCO::EDS::Results. If this is true, it's an indication that the search results come from a failed-over smarttext search; if it's false, no smarttext failover occurred.
+
+## [1.1.0] - 2020-09-04
+
+### Added
+
+- Added an option to the session intializer to accept a smarttext_failover parameter. Setting this to true will instruct the gem to issue a SECOND search with mode=smarttext if the original search had zero results. This mirrors behavior available in the native EDS interface.
+
+## [1.0.9] - 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.8] - 2019-08-12
+
+### Fixed
+
+- Access issues for EBSCO contributors fixed.
+
 ## [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 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. 
+
+- List retrieval returns a repeating list of just the first record.
 - List retrieval fails to increment the EDS result id.
 
 ## [1.0.3] - 2018-10-18
+
 ### Changed
+
 - Citation style and export links can now be removed entirely or replaced by specifying regular expressions in several configuration options that can include ruby erb variable expressions for an item's `dbid` and `an`. This was added to address situations where customer proxy urls are returned. See: [Citation link replacement](https://github.com/ebsco/edsapi-ruby/wiki/Citation-link-replacement)
 
 ## [1.0.2] - 2018-10-15
+
 ### Added
+
 - EBSCOhost links are removed from citation styles and exports by default
 
 ## [1.0.1] - 2018-10-10
+
 ### Added
+
 - Citation styles/exports are added to Records
 - Retrieve citation styles/exports for a Record ID or list of Record IDs
 - Retrieve a list of available citation styles/exports from Info
 - Citation styles/exports available in guest mode
+
 ### Fixed
+
 - Double-unescapes data with an ephtml section (sul-dlss/SearchWorks #1504)
 - Adds searchlinks to subject items when they don't exist #80 (sul-dlss/SearchWorks #1791)
+
 ### Changed
+
 - Updates test cassettes with new citation styles/exports API calls
 
 ## [1.0.0] - 2018-03-05
+
 ### Changed
+
 - Increments version to reflect production ready status
 
 ## [0.3.19.pre] - 2018-03-05
+
 ### Added
+
 - Optionally (default=off) include quick view images with Records
+
 ### Changed
+
 - Reorganizes VCR tests
 
 ## [0.3.18.pre] - 2017-10-10
+
 ### Fixed
+
 - Fixes session config bug #84
 
 ## [0.3.17.pre] - 2017-09-27
+
 ### Changed
+
 - Optionally (default=off) titleize facets via `titleize_facets` in config
 
 ## [0.3.16.pre] - 2017-09-20
+
 ### Added
+
 - Titleize facets
 - Autocorrect feature
 
 ## [0.3.15.pre] - 2017-09-18
+
 ### Added
+
 - Optionally (default=off) converts all searchLink field codes to DE via `all_subjects_search_links` in config
 - Optionally (default=off) decodes/sanitizes html in item data and fulltext html via `decode_sanitize_html` in config
 
 ## [0.3.14.pre] - 2017-09-14
+
 ### Fixed
+
 - Fixes 250+ pagination issues with SourceType and ContentProvider facets
 
 ## [0.3.13.pre] - 2017-09-13
+
 ### Fixed
+
 - Includes additional Subject and Geographic Subject metadata
 
 ## [0.3.12.pre] - 2017-09-11
+
 ### Fixed
+
 - Fixes some 250+ pagination issues
+
 ### Changed
+
 - Updates tests
 
 ## [0.3.11.pre] - 2017-09-06
+
 ### 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

data/README.md

@@ -1,4 +1,4 @@
-<img src="https://discovery.ebsco.com/files/pulse-images/EDS-logo_1LINE.png"/>
+![image](https://user-images.githubusercontent.com/13452564/110336225-a7440c80-7ff2-11eb-996d-6b4395438a22.png)
 
 A Ruby interface to the EBSCO Discovery Services API.
 
@@ -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       = ['Mike Abrahamson','Ellie Collier','Madeline Dale','Eric Frierson','Carolyn Clini']
+  spec.email         = ['mabrahamson@ebsco.com','ecollier@ebsco.com','mdale@ebsco.com', 'efrierson@ebsco.com', 'cclini@ebsco.com']
   spec.summary       = 'Summary: EBSCO EDS API'
   spec.description   = 'Description: EBSCO EDS API'
   spec.homepage      = 'https://github.com/ebsco/edsapi-ruby'
@@ -29,7 +29,7 @@ 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'
@@ -37,17 +37,16 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dotenv', '~> 2.2'
   spec.add_dependency 'climate_control', '~> 0'
   spec.add_dependency 'require_all', '~> 2.0'
-  spec.add_dependency 'bibtex-ruby', '~> 5.0', '>= 5.0.0'
+  spec.add_dependency 'bibtex-ruby', '>= 5.1.0', '< 7.0'
   spec.add_dependency 'citeproc', '>= 1.0.4', '< 2.0'
-  spec.add_dependency 'csl', '~> 1.4'
+  spec.add_dependency 'csl', '>= 1.4.0', '< 1.6'
   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.2'
+  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 'bundler'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'simplecov', '~> 0.17.0'
@@ -55,5 +54,6 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'sanitize', '~> 5.0'
 
 end

data/lib/ebsco/eds/configuration.rb

@@ -59,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/error.rb

@@ -46,5 +46,8 @@ module EBSCO
     # raised when connection fails
     class ConnectionFailed < Error; end
 
+    # raised when missing a dependency
+    class MissingDependency < Error; end
+
   end
 end

data/lib/ebsco/eds/record.rb

@@ -1,7 +1,6 @@
 require 'yaml'
 require 'json'
 require 'cgi'
-require 'sanitize'
 
 module EBSCO
 
@@ -152,6 +151,9 @@ module EBSCO
           @decode_sanitize_html = ENV['EDS_DECODE_SANITIZE_HTML']
         end
 
+        require_sanitize if @decode_sanitize_html
+
+
         if results_record.key? 'Record'
           @record = results_record['Record'] # single record returned by retrieve api
         else
@@ -997,7 +999,13 @@ module EBSCO
       # add searchlinks when they don't exist
       def add_subject_searchlinks(data)
         subjects = data
-        unless data.include? 'searchLink'
+        if data.include? '<link '
+          subjects = bib_subjects
+          subjects = subjects.map do |su|
+            '<searchLink fieldCode="DE" term="%22' + su + '%22">' + su + '</searchLink>'
+          end.join('<br />')
+        end
+        unless subjects.include? 'searchLink'
           subjects = subjects.split('<br />').map do |su|
             '<searchLink fieldCode="DE" term="%22' + su + '%22">' + su + '</searchLink>'
           end.join('<br />')
@@ -1005,6 +1013,12 @@ module EBSCO
         subjects
       end
 
+      def require_sanitize
+        require 'sanitize'
+      rescue Gem::LoadError, LoadError
+        raise EBSCO::EDS::MissingDependency.new 'Sanitize is turned on, but the sanitize gem is not loaded'
+      end
+
     end # Class Record
   end # Module EDS
 end # Module EBSCO

data/lib/ebsco/eds/results.rb

@@ -17,6 +17,8 @@ module EBSCO
       attr_accessor :records
       # Array of EBSCO::EDS::Record Research Starters
       attr_reader :research_starters
+      # Bool
+      attr_reader :smarttext_failover
       # Array of EBSCO::EDS::Record Exact Publication Matches
       attr_reader :publication_match
 
@@ -29,7 +31,7 @@ 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
 
@@ -103,6 +105,9 @@ module EBSCO
           # 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.'

data/lib/ebsco/eds/session.rb

@@ -243,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')
@@ -480,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)
@@ -1261,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.8'
+    VERSION = '1.1.3'
   end
 end

metadata

@@ -1,15 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.3
 platform: ruby
 authors:
-- Bill McKinney
+- Mike Abrahamson
+- Ellie Collier
+- Madeline Dale
 - Eric Frierson
+- Carolyn Clini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,22 +102,22 @@ dependencies:
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: citeproc
   requirement: !ruby/object:Gem::Requirement
@@ -139,16 +142,22 @@ dependencies:
   name: csl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -193,14 +202,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
@@ -217,20 +226,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: sanitize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -249,16 +244,16 @@ dependencies:
   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
@@ -319,42 +314,42 @@ dependencies:
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -369,9 +364,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: 'Description: EBSCO EDS API'
 email:
-- bmckinney@ebsco.com, efrierson@ebsco.com
+- mabrahamson@ebsco.com
+- ecollier@ebsco.com
+- mdale@ebsco.com
+- efrierson@ebsco.com
+- cclini@ebsco.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -418,15 +431,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'