ebsco-eds 0.3.6.pre → 0.3.7.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a58056a9b170977e96d0538c7c656e7d8809cb8d
-  data.tar.gz: 51d4f45f67dfbf40efbf512298053351e6c5e06a
+  metadata.gz: 318f90b31dc58e67ca6276ab181e871ce2616378
+  data.tar.gz: 57bad731d288837bb5618e580007f097220a7e91
 SHA512:
-  metadata.gz: 42ffb1d9f4516cd381f4f66e0ffc8c2e89249f9073e966fb3a5467aa26ff3b78e0566ebbcd7835087c98ba83d096e76ba129371b941c07e4a6e5fb4826e82631
-  data.tar.gz: 199c710a0e5d9bf105a53ba800c606531e71e638a4461e71f5c7e138f0906a444102bd783b4acdbf6afde321b7178b4b0c9e13f9f5869ed28e0ac6cc87116eb9
+  metadata.gz: db4f93c0f4e5af5f125eae40e51e8ef1a869aa03c0a856bbe0b28b12900e53c5b998385a0fb316667204cab1adaa1788fc4461ba30a711620dbfc95e947762dc
+  data.tar.gz: b8c6a81124f2dada7caebf6a813e9b85f87e89dffc25acffd71975f070ee1999cce9ce7f85f875c7895ac474bea63b6aec513faa24cb697859453b9f37991ca0

data/.env.test

@@ -1,7 +1,6 @@
 EDS_PROFILE=edsapi
-EDS_USER=stanford
-EDS_PASS=trial
+EDS_USER=user
+EDS_PASS=secret
 EDS_AUTH=user
 EDS_GUEST=n
-EDS_ORG=none
-EDS_DEBUG=false
+EDS_ORG=none

data/lib/ebsco/eds/configuration.rb

@@ -17,7 +17,7 @@ module EBSCO
             :auth => 'user',
             :auth_token => '',
             :session_token => '',
-            :eds_api_base => 'https://eds-api-b.ebscohost.com',
+            :api_hosts_list => ['eds-api.ebscohost.com'],
             :uid_auth_url => '/authservice/rest/uidauth',
             :ip_auth_url => '/authservice/rest/ipauth',
             :create_session_url => '/edsapi/rest/CreateSession',

data/lib/ebsco/eds/error.rb

@@ -43,5 +43,8 @@ module EBSCO
     # Raised when EDS returns the HTTP status code 503
     class ServiceUnavailable < Error; end
 
+    # raised when connection fails
+    class ConnectionFailed < Error; end
+
   end
 end

data/lib/ebsco/eds/options.rb

@@ -220,7 +220,7 @@ module EBSCO
       end
 
       def eds_sanitize(str)
-        pattern = /(\'|\"|\*|\/|\\|\)|\$|\+|\(|\^|\?|\!|\~|\`|\:)/
+        pattern = /([)(:,])/
         str = str.gsub(pattern){ |match| '\\' + match }
         str
       end

data/lib/ebsco/eds/session.rb

@@ -70,7 +70,8 @@ module EBSCO
         @auth_token = ''
         @config = {}
         @guest = true
-        @api_base = ''
+        @api_hosts_list = ''
+        @api_host_index = 0
 
         eds_config = EBSCO::EDS::Configuration.new
         if options[:config]
@@ -130,7 +131,7 @@ module EBSCO
             end :
             @debug = @config[:debug]
 
-        (ENV.has_key? 'EDS_API_BASE') ? @api_base = ENV['EDS_API_BASE'] : @api_base = @config[:eds_api_base]
+        (ENV.has_key? 'EDS_HOSTS') ? @api_hosts_list = ENV['EDS_HOSTS'].split(',') : @api_hosts_list = @config[:api_hosts_list]
 
         # use cache for auth token, info, search and retrieve calls?
         if @use_cache
@@ -710,7 +711,19 @@ module EBSCO
           end
           resp.body
         rescue Error => e
+
+          # try alternate EDS hosts
+          if e.is_a?(EBSCO::EDS::InternalServerError) || e.is_a?(EBSCO::EDS::ServiceUnavailable) || e.is_a?(EBSCO::EDS::ConnectionFailed)
+            if @api_hosts_list.length > @api_host_index+1
+              @api_host_index = @api_host_index+1
+              do_request(method, path: path, payload: payload, attempt: attempt+1)
+            else
+              raise EBSCO::EDS::ApiError, 'EBSCO API error: Unable to establish a connection to any EDS host.'
+            end
+          end
+
           if e.respond_to? 'fault'
+
             error_code = e.fault[:error_body]['ErrorNumber'] || e.fault[:error_body]['ErrorCode']
             unless error_code.nil?
               case error_code
@@ -727,8 +740,6 @@ module EBSCO
                 # trying to paginate in results list beyond 250 results
                 when '138'
 
-                  puts 'JUMP ERROR: ' + e.inspect
-
                   is_jump_retry = false
                   is_orig_retry = false
 
@@ -828,9 +839,9 @@ module EBSCO
         begin
           if @debug
             if payload.instance_variable_defined?(:@Actions)
-              puts 'JUMP ACTION: ' + payload.Actions.inspect
+              puts 'JUMP ACTION: ' + payload.Actions.inspect if @debug
             end
-            puts 'JUMP ATTEMPT: ' + attempt.to_s
+            puts 'JUMP ATTEMPT: ' + attempt.to_s if @debug
           end
           # turn off caching
           resp = jump_connection.send(method) do |req|
@@ -908,7 +919,7 @@ module EBSCO
       def connection
         logger = Logger.new(@config[:log])
         logger.level = Logger.const_get(@config[:log_level])
-        Faraday.new(url: @api_base) do |conn|
+        Faraday.new(url: 'https://' + @api_hosts_list[@api_host_index]) do |conn|
           conn.headers['Content-Type'] = 'application/json;charset=UTF-8'
           conn.headers['Accept'] = 'application/json'
           conn.headers['x-sessionToken'] = @session_token ? @session_token : ''
@@ -929,7 +940,7 @@ module EBSCO
       def jump_connection
         logger = Logger.new(@config[:log])
         logger.level = Logger.const_get(@config[:log_level])
-        Faraday.new(url: @api_base) do |conn|
+        Faraday.new(url: 'https://' + @api_hosts_list[@api_host_index]) do |conn|
           conn.headers['Content-Type'] = 'application/json;charset=UTF-8'
           conn.headers['Accept'] = 'application/json'
           conn.headers['x-sessionToken'] = @session_token ? @session_token : ''
@@ -1021,7 +1032,7 @@ module EBSCO
       end
 
       def eds_sanitize(str)
-        pattern = /(\'|\"|\*|\/|\\|\)|\$|\+|\(|\^|\?|\!|\~|\`|\:)/
+        pattern = /([)(:,])/
         str = str.gsub(pattern){ |match| '\\' + match }
         str
       end
@@ -1031,7 +1042,6 @@ module EBSCO
         jump_incr = 250/search_options.RetrievalCriteria.ResultsPerPage.to_i
         attempts = dest_page/jump_incr
         jump_pages = []
-        puts 'CURRENT PAGE: ' + @current_page.inspect
         (1..attempts).to_a.each do |n|
           jump_pages.push(jump_incr*n)
         end

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.3.6.pre'
+    VERSION = '0.3.7.pre'
   end
 end

data/lib/faraday/eds_caching_middleware.rb

@@ -19,19 +19,7 @@ module Faraday
 
       initialize_store
 
-      eds_config = EBSCO::EDS::Configuration.new
-      if options[:config]
-        @config = eds_config.configure_with(options[:config])
-        @config = eds_config.configure if @config.nil?
-      else
-        @config = eds_config.configure(options)
-      end
-      (ENV.has_key? 'EDS_API_BASE') ? @api_base = ENV['EDS_API_BASE'] : @api_base = @config[:eds_api_base]
-
-      @info_uri = URI.parse(@api_base + '/edsapi/rest/Info')
-      @auth_uri = URI.parse(@api_base + '/authservice/rest/uidauth')
-      @search_uri = URI.parse(@api_base + '/edsapi/rest/Search?')
-      @retrieve_uri = URI.parse(@api_base + '/edsapi/rest/Retrieve?')
+      @cacheable_paths = %w(/edsapi/rest/Info /authservice/rest/uidauth /authservice/rest/uidauth /edsapi/rest/Retrieve? /edsapi/rest/Search?)
 
     end
 
@@ -56,29 +44,28 @@ module Faraday
     end
 
     def cache_response(env)
-      #puts 'ENV: ' + env.inspect
       return unless cacheable?(env) && !env.request_headers['x-faraday-eds-cache']
 
-      puts "Cache WRITE: #{key(env)}"
+      info "Cache WRITE: #{key(env)}"
       custom_expires_in = @expires_in
       uri = env.url
 
-      if uri == @auth_uri
+      if uri.request_uri.include?('/authservice/rest/uidauth')
         custom_expires_in = 1800 # 30 minutes
         info "#{uri} - Setting custom expires: #{custom_expires_in}"
       end
 
-      if uri == @info_uri
+      if uri.request_uri.include?('/edsapi/rest/Info')
         custom_expires_in = 86400 # 24 hours
         info "#{uri} - Setting custom expires: #{custom_expires_in}"
       end
 
-      if uri.request_uri.start_with?(@search_uri.request_uri)
+      if uri.request_uri.include?('/edsapi/rest/Search?')
         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)
+      if uri.request_uri.include?('/edsapi/rest/Retrieve?')
         custom_expires_in = 1800 # 30 minutes
         info "#{uri} - Setting custom expires: #{custom_expires_in}"
       end
@@ -88,20 +75,19 @@ module Faraday
 
     def cacheable?(env)
       uri = env.url
-      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)
-        if !env.body.nil? && env.body.include?('"jump_request"')
-          puts "NOT CACHEABLE URI (jump_request): #{uri}"
-          false
-        else
-          puts "CACHEABLE URI: #{uri}"
-          true
+      @cacheable_paths.any? { |path|
+        if  uri.request_uri.include?(path)
+          if !env.body.nil? && env.body.include?('"jump_request"')
+            info "NOT CACHEABLE URI (jump_request): #{uri}"
+            return false
+          else
+            info "CACHEABLE URI: #{uri}"
+            return true
+          end
         end
-      else
-        puts "NOT CACHEABLE URI: #{uri}"
-        false
-      end
+      }
+      info "NOT CACHEABLE URI: #{uri}"
+      false
     end
 
     def cached_response(env)
@@ -111,9 +97,9 @@ module Faraday
       end
 
       if response_env
-        puts "Cache HIT: #{key(env)}"
+        info "Cache HIT: #{key(env)}"
       else
-        puts "Cache MISS: #{key(env)}"
+        info "Cache MISS: #{key(env)}"
       end
       response_env
     end

data/lib/faraday/eds_exception_middleware.rb

@@ -9,26 +9,30 @@ module Faraday
     end
 
     def call(env)
-      @app.call(env).on_complete do |response|
-        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
-          # when 500
-          #   raise EBSCO::EDS::InternalServerError.new
-          # when 503
-          #   raise EBSCO::EDS::ServiceUnavailable.new
-          else
-            raise EBSCO::EDS::BadRequest.new(error_message(response))
+      begin
+        @app.call(env).on_complete do |response|
+          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
+            when 500
+              raise EBSCO::EDS::InternalServerError.new
+            when 503
+              raise EBSCO::EDS::ServiceUnavailable.new
+            else
+              raise EBSCO::EDS::BadRequest.new(error_message(response))
+          end
         end
+        rescue Faraday::ConnectionFailed
+          raise EBSCO::EDS::ConnectionFailed.new
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.3.6.pre
+  version: 0.3.7.pre
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday