ebsco-eds 0.3.5.pre → 0.3.6.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b01d52fab1ebf5ad7dff691dc253ae50fef72e97
-  data.tar.gz: ce5af9c7d9ad9a251964b555518a170d8319f226
+  metadata.gz: a58056a9b170977e96d0538c7c656e7d8809cb8d
+  data.tar.gz: 51d4f45f67dfbf40efbf512298053351e6c5e06a
 SHA512:
-  metadata.gz: 79d7be540a8d86ad94311655d3dd132cd4d39cc34f98241cc9a0284725f4ba0c38681ab5fe062be3bd059c721dad704ef896fa214502ed2bfe385b29c7c22b07
-  data.tar.gz: c21bddfbcca4af8ee6e7a1b4f914fdca7cf1f201454d145d74693baf81006a6f19114521c75ac9fb1c55ff2878875d685004496e6cfb8bf81ca6d1989a817aa6
+  metadata.gz: 42ffb1d9f4516cd381f4f66e0ffc8c2e89249f9073e966fb3a5467aa26ff3b78e0566ebbcd7835087c98ba83d096e76ba129371b941c07e4a6e5fb4826e82631
+  data.tar.gz: 199c710a0e5d9bf105a53ba800c606531e71e638a4461e71f5c7e138f0906a444102bd783b4acdbf6afde321b7178b4b0c9e13f9f5869ed28e0ac6cc87116eb9

data/.env.test

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

data/lib/ebsco/eds/configuration.rb

@@ -17,7 +17,7 @@ module EBSCO
             :auth => 'user',
             :auth_token => '',
             :session_token => '',
-            :eds_api_base => 'https://eds-api.ebscohost.com',
+            :eds_api_base => 'https://eds-api-b.ebscohost.com',
             :uid_auth_url => '/authservice/rest/uidauth',
             :ip_auth_url => '/authservice/rest/ipauth',
             :create_session_url => '/edsapi/rest/CreateSession',
@@ -29,13 +29,15 @@ module EBSCO
             :interface_id => 'edsapi_ruby_gem',
             :log => 'faraday.log',
             :log_level => 'INFO',
-            :max_attempts => 2,
+            :max_attempts => 3,
             :max_results_per_page => 100,
             :ebook_preferred_format => 'ebook-pdf',
             :use_cache => true,
             :eds_cache_dir => ENV['TMPDIR'] || '/tmp',
             :timeout => 60,
-            :open_timeout => 12
+            :open_timeout => 12,
+            :max_page_jumps => 6,
+            :max_page_jump_attempts => 10
         }
         @valid_config_keys = @config.keys
       end

data/lib/ebsco/eds/options.rb

@@ -6,7 +6,7 @@ module EBSCO
 
     class Options
       include JSONable
-      attr_accessor :SearchCriteria, :RetrievalCriteria, :Actions
+      attr_accessor :SearchCriteria, :RetrievalCriteria, :Actions, :Comment
       def initialize(options = {}, info)
   
         @SearchCriteria = EBSCO::EDS::SearchCriteria.new(options, info)
@@ -15,6 +15,8 @@ module EBSCO
   
         @Actions = []
 
+        @Comment = ''
+
         # add DefaultOn=y Type=select limiters
         # info.available_limiters.each do |limiter|
         #   if limiter['DefaultOn'] == 'n' and limiter['Type'] == 'select'

data/lib/ebsco/eds/session.rb

@@ -70,6 +70,7 @@ module EBSCO
         @auth_token = ''
         @config = {}
         @guest = true
+        @api_base = ''
 
         eds_config = EBSCO::EDS::Configuration.new
         if options[:config]
@@ -129,6 +130,8 @@ module EBSCO
             end :
             @debug = @config[:debug]
 
+        (ENV.has_key? 'EDS_API_BASE') ? @api_base = ENV['EDS_API_BASE'] : @api_base = @config[:eds_api_base]
+
         # use cache for auth token, info, search and retrieve calls?
         if @use_cache
           cache_dir = File.join(@cache_dir, 'faraday_eds_cache')
@@ -720,6 +723,68 @@ module EBSCO
                   @auth_token = nil
                   @auth_token = create_auth_token
                   do_request(method, path: path, payload: payload, attempt: attempt+1)
+
+                # trying to paginate in results list beyond 250 results
+                when '138'
+
+                  puts 'JUMP ERROR: ' + e.inspect
+
+                  is_jump_retry = false
+                  is_orig_retry = false
+
+                  # create a jump request payload
+                  jump_payload = payload.clone
+
+                  # retry failed jump requests (known API issue)
+                  if jump_payload.instance_variable_defined?(:@Comment)
+                    if jump_payload.Comment == 'jump_request'
+                      is_jump_retry = true
+                      puts '138 JUMP RETRY ================================================================' if @debug
+                      sleep Random.new.rand(1..3)
+                      do_jump_request(method, path: path, payload: jump_payload, attempt: attempt+1)
+                    elsif jump_payload.Comment == 'jump_request_orig'
+                      is_orig_retry = true
+                      puts '138 ORIG RETRY ================================================================' if @debug
+                      sleep Random.new.rand(1..3)
+                      jump_response = do_jump_request(method, path: path, payload: payload, attempt: attempt+1)
+                      if jump_response.success?
+                        return jump_response.body
+                      end
+                    else
+                      puts '138 ERROR =====================================================================' if @debug
+                    end
+                  end
+
+                  # only perform these steps if it's the original 138 error
+                  unless is_jump_retry or is_orig_retry
+                    # remove these variables since they prevent a jump request (they continue to cause more 138 errors)
+                    if jump_payload.SearchCriteria.instance_variable_defined?(:@AutoSuggest)
+                      jump_payload.SearchCriteria.remove_instance_variable(:@AutoSuggest)
+                    end
+                    if jump_payload.SearchCriteria.instance_variable_defined?(:@Expanders)
+                      jump_payload.SearchCriteria.remove_instance_variable(:@Expanders)
+                    end
+                    if jump_payload.SearchCriteria.instance_variable_defined?(:@RelatedContent)
+                      jump_payload.SearchCriteria.remove_instance_variable(:@RelatedContent)
+                    end
+                    if jump_payload.SearchCriteria.instance_variable_defined?(:@Limiters)
+                      jump_payload.SearchCriteria.remove_instance_variable(:@Limiters)
+                    end
+
+                    # get list of jump pages and make requests for each one before requesting the original request
+                    jump_pages = get_jump_pages(payload)
+                    # todo: truncate to @confi[:max_page_jumps]
+                    jump_pages.each { |page|
+                      jump_payload.Actions = ["GoToPage(#{page})"]
+                      jump_payload.Comment = 'jump_request' # comment the request so we can retry if necessary
+                      do_jump_request(method, path: path, payload: jump_payload, attempt: attempt+1)
+                    }
+
+                    # now make the original request (which can also require retries)
+                    payload.Comment = 'jump_request_orig'
+                    do_request(method, path: path, payload: payload, attempt: attempt+1)
+                  end
+
                 # invalid source type, attempt to recover gracefully
                 # when '130'
                 #   bad_source_type = e.fault[:error_body]['DetailedErrorDescription']
@@ -743,6 +808,8 @@ module EBSCO
                 #   }
                 #   payload.Actions = new_actions
                 #   do_request(method, path: path, payload: payload, attempt: attempt+1)
+
+
                 else
                   raise e
               end
@@ -753,6 +820,50 @@ module EBSCO
         end
       end
 
+      def do_jump_request(method, path:, payload: nil, attempt: 0) # :nodoc:
+
+        if attempt > @config[:max_page_jump_attempts]
+          raise EBSCO::EDS::ApiError, 'EBSCO API error: Multiple attempts to perform request failed.'
+        end
+        begin
+          if @debug
+            if payload.instance_variable_defined?(:@Actions)
+              puts 'JUMP ACTION: ' + payload.Actions.inspect
+            end
+            puts 'JUMP ATTEMPT: ' + attempt.to_s
+          end
+          # turn off caching
+          resp = jump_connection.send(method) do |req|
+            case method
+              when :get
+                req.url path
+              when :post
+                req.url path
+                unless payload.nil?
+                  req.body = JSON.generate(payload)
+                end
+              else
+                raise EBSCO::EDS::ApiError, "EBSCO API error: Method #{method} not supported for endpoint #{path}"
+            end
+          end
+          resp
+        rescue Error => e
+          if e.respond_to? 'fault'
+            error_code = e.fault[:error_body]['ErrorNumber'] || e.fault[:error_body]['ErrorCode']
+            unless error_code.nil?
+              case error_code
+                when '138'
+                  sleep Random.new.rand(1..3)
+                  do_jump_request(method, path: path, payload: payload, attempt: attempt+1)
+                else
+                  raise e
+              end
+            end
+          end
+
+        end
+      end
+
       # --
       # attempts to query profile capabilities
       # dummy search just to get the list of available databases
@@ -797,7 +908,7 @@ module EBSCO
       def connection
         logger = Logger.new(@config[:log])
         logger.level = Logger.const_get(@config[:log_level])
-        Faraday.new(url: @config[:eds_api_base]) do |conn|
+        Faraday.new(url: @api_base) do |conn|
           conn.headers['Content-Type'] = 'application/json;charset=UTF-8'
           conn.headers['Accept'] = 'application/json'
           conn.headers['x-sessionToken'] = @session_token ? @session_token : ''
@@ -814,6 +925,26 @@ module EBSCO
         end
       end
 
+      # same as above but no caching
+      def jump_connection
+        logger = Logger.new(@config[:log])
+        logger.level = Logger.const_get(@config[:log_level])
+        Faraday.new(url: @api_base) do |conn|
+          conn.headers['Content-Type'] = 'application/json;charset=UTF-8'
+          conn.headers['Accept'] = 'application/json'
+          conn.headers['x-sessionToken'] = @session_token ? @session_token : ''
+          conn.headers['x-authenticationToken'] = @auth_token ? @auth_token : ''
+          conn.headers['User-Agent'] = @config[:user_agent]
+          conn.request :url_encoded
+          conn.use :eds_exception_middleware
+          conn.response :json, content_type: /\bjson$/
+          conn.response :detailed_logger, logger if @debug
+          conn.options[:open_timeout] = @config[:open_timeout]
+          conn.options[:timeout] = @config[:timeout]
+          conn.adapter :net_http_persistent
+        end
+      end
+
       def create_auth_token
         if blank?(@auth_token)
           # ip auth
@@ -895,7 +1026,19 @@ module EBSCO
         str
       end
 
-    end
+      def get_jump_pages(search_options)
+        dest_page = search_options.RetrievalCriteria.PageNumber.to_i
+        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
+        puts 'JUMP PAGES: ' + jump_pages.inspect if @debug
+        jump_pages
+      end
 
+    end
   end
 end

data/lib/ebsco/eds/version.rb

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

data/lib/faraday/eds_caching_middleware.rb

@@ -1,15 +1,11 @@
 require 'faraday'
 require 'uri'
+require 'ebsco/eds/configuration'
 
 module Faraday
 
   class EdsCachingMiddleware < Faraday::Middleware
 
-    INFO_URI = URI.parse('https://eds-api.ebscohost.com/edsapi/rest/Info')
-    AUTH_URI = URI.parse('https://eds-api.ebscohost.com/authservice/rest/uidauth')
-    SEARCH_URI = URI.parse('https://eds-api.ebscohost.com/edsapi/rest/Search?')
-    RETRIEVE_URI = URI.parse('https://eds-api.ebscohost.com/edsapi/rest/Retrieve?')
-
     def initialize(app, *args)
       super(app)
       options = args.first || {}
@@ -22,6 +18,21 @@ module Faraday
       @store_options[:namespace] ||= @namespace
 
       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?')
+
     end
 
     def call(env)
@@ -48,26 +59,26 @@ module Faraday
       #puts 'ENV: ' + env.inspect
       return unless cacheable?(env) && !env.request_headers['x-faraday-eds-cache']
 
-      info "Cache WRITE: #{key(env)}"
+      puts "Cache WRITE: #{key(env)}"
       custom_expires_in = @expires_in
       uri = env.url
 
-      if uri == AUTH_URI
+      if uri == @auth_uri
         custom_expires_in = 1800 # 30 minutes
         info "#{uri} - Setting custom expires: #{custom_expires_in}"
       end
 
-      if uri == INFO_URI
+      if uri == @info_uri
         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.start_with?(@search_uri.request_uri)
         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.start_with?(@retrieve_uri.request_uri)
         custom_expires_in = 1800 # 30 minutes
         info "#{uri} - Setting custom expires: #{custom_expires_in}"
       end
@@ -77,13 +88,18 @@ 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)
-        info "CACHEABLE URI: #{uri}"
-        true
+      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
+        end
       else
-        info "NOT CACHEABLE URI: #{uri}"
+        puts "NOT CACHEABLE URI: #{uri}"
         false
       end
     end
@@ -95,9 +111,9 @@ module Faraday
       end
 
       if response_env
-        info "Cache HIT: #{key(env)}"
+        puts "Cache HIT: #{key(env)}"
       else
-        info "Cache MISS: #{key(env)}"
+        puts "Cache MISS: #{key(env)}"
       end
       response_env
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.3.5.pre
+  version: 0.3.6.pre
 platform: ruby
 authors:
 - Bill McKinney