ebsco-eds 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 623b81079a6dd743fc4fe392364d27349a780860
-  data.tar.gz: d4aae67d364928d8e90ed76e1e89bc595b66633b
+  metadata.gz: 17ca746dd64cbcc74b2832b6c633b884b2cfc605
+  data.tar.gz: 8bb98ab1b49f849604895798437097e9c27128b0
 SHA512:
-  metadata.gz: '0962c36f6e6e9c6df244d9dec9589911b82b9cb5287b74e35070d5a1a80a6e6434d378a28769cdcd8f91b6e32340cbc99668e6ba5c571056a6c9b746cb6fbe85'
-  data.tar.gz: 71f3cf8e55486123ffdbec5b7962fbf38fb128a64c859997fe38bc6f2a83c0979b0dd1228c9bb8f5eff27da0b4ea27025c1fb6b0e8e42ea369def3cc6f9ca6c0
+  metadata.gz: fa43d9717b7d22d512d9dfb4de457736d0fa0e68a86eafc4d6de6d748ac51a9a3707699e4568065d387587fc90e2d664d8d6b74bdedcd758bde63788ecf55f0e
+  data.tar.gz: 37e46ab2f6e194e6a5d3e333e63e95a4fb81f8b839dd3ad57327d65e8e8110e8c2a58b3a263378bb52345f25a94b7ad29c358ca0cd24c65cccbc8e51a84a6bc2

data/CHANGELOG.md

@@ -4,12 +4,19 @@ 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.6] - 2018-14-02
+### 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 +88,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.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/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,

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') ?
@@ -847,6 +855,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 +1082,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 +1130,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

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '1.0.5'
+    VERSION = '1.0.6'
   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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday