ebsco-eds 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04ae52bf63d655fd51a4bfdcc2fdbb348e11f4a6
-  data.tar.gz: e76592a2f496ad46710f3e99b9be940b4131e282
+  metadata.gz: cd3df278b8f54b8391e1fab578b2c268c4ba0611
+  data.tar.gz: 63aa813ab6adcfb15f21c70392d6127841ec440b
 SHA512:
-  metadata.gz: ced20aafdae50f01ae80047cc2975818498e1539cfd8347c3e75c82751adf331f0526039a1a194488ce4ac67bba1ef8c542f15e6ebe8982dcc46d5f352e20761
-  data.tar.gz: 564aff455ec90a31bfc0218e257ca5268e260126aacd0900b28d42661ae351e85345aa8857ac7951f90eaa55653aa4ac571deb0e143e710d5af477ab6f5d5050
+  metadata.gz: e534bf012f442328a9cd6df94a7a22d32cd3d63e33199ddb9c238f826add23e739d0192ad887ff5144944bf965960d5d654b65a708a30bbd54ecf405e50f9465
+  data.tar.gz: f94b92153adfb5c485ecb1edfe65696085da2bb656fe81b77df96f1431c3ea87a22e19b2b748a1937e22863f3695c6ef11b4041b5e9bfc6f944db84835cf5862

data/CHANGELOG.md

@@ -4,6 +4,11 @@ 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.
@@ -92,6 +97,7 @@ 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

data/ebsco-eds.gemspec

@@ -36,23 +36,24 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday_middleware', '~> 0.11'
   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.0', '>= 5.0.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 '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/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

@@ -32,73 +32,81 @@ module EBSCO
       def initialize(search_results, eds_config = {}, additional_limiters = {}, options = {})
 
         @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]
+
+        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

@@ -340,21 +340,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
@@ -363,6 +366,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']}

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '1.0.7'
+    VERSION = '1.0.8'
   end
 end

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,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: '4.0'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: citeproc
   requirement: !ruby/object:Gem::Requirement
@@ -189,48 +195,56 @@ 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.5.0
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -251,14 +265,14 @@ dependencies:
     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
@@ -279,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
@@ -307,42 +321,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: minitest-vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !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