ebsco-eds 0.0.6.pre → 0.0.7.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52a371da7111d83a7616bdd5de68deabd1c6983a
-  data.tar.gz: 00fae54472789a602ad4cd50cab93f88d4778308
+  metadata.gz: d2f5c44d4608f6e09bd9742eb79b651d4eb34bc3
+  data.tar.gz: 92d50beccaef1aff8659f0843a225b2c3c4c38c9
 SHA512:
-  metadata.gz: b195bf1718c6715555487dc15f3d2eaccd62e5a2ec7152fb606a7a07a069b95a66d7758c83b5a04fd7d321b05889965e7e9c75e8eedf7d0933b6244f0ede8207
-  data.tar.gz: a4b22c20bcc5c092dd55414e4cfd4a427049e277e10c2cd4ce76ac8f27184daa9fa69334cd28e4ab2f5afa2885407bb00c0ddabfe55ae319b242b169c9b28daa
+  metadata.gz: af3195f29647ba7182a2e31cc7569b543942681689eadd2ea9ed9d3b4c2018fa09c0a0e365af44efefd8a5242ffe03452fb80cb15330918483831cddf3d0275b
+  data.tar.gz: c67f556bd18164bb666bcdbf0bdafdca4b2e1ca1c48bcd7b993646b82a418380981b7538a1f95b99a8cd2a4ae3166163df5b4bf4a8d3dacaba71e31ff9196cce

data/ebsco-eds.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'climate_control', '~> 0'
   spec.add_dependency 'require_all', '~> 1.3'
   spec.add_dependency 'bibtex-ruby', '~> 4.0'
+  spec.add_dependency 'activesupport', '~> 4.2'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 12.0'

data/lib/ebsco/eds.rb

@@ -4,7 +4,6 @@ require 'ebsco/eds/info'
 require 'ebsco/eds/results'
 require 'ebsco/eds/record'
 require 'ebsco/eds/error'
-require 'ebsco/eds/http_exception'
 
 module EBSCO
 

data/lib/ebsco/eds/record.rb

@@ -13,9 +13,6 @@ module EBSCO
       # Raw record as returned by the \EDS API via search or retrieve
       attr_reader :record
 
-      # Lookup table of databases that have their labels suppressed in the response.
-      DBS = YAML::load_file(File.join(__dir__, 'settings.yml'))['databases']
-
       # Creates a search or retrieval result record
       def initialize(results_record)
 
@@ -530,7 +527,7 @@ module EBSCO
       end
 
       def header_db_label
-        DBS[self.database_id.upcase] || @record['Header']['DbLabel']
+        @record['Header']['DbLabel']
       end
 
       # not sure the rules for when this appears or not - RecordInfo.AccessInfo?

data/lib/ebsco/eds/results.rb

@@ -19,9 +19,6 @@ module EBSCO
 
       attr_accessor :stat_total_hits
 
-      # Lookup table of databases that have their labels suppressed in the response.
-      DBS = YAML::load_file(File.join(__dir__, 'settings.yml'))['databases']
-
       # 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, additional_limiters = {}, raw_options = {})
@@ -344,11 +341,7 @@ module EBSCO
         databases = []
         databases_facet = @results['SearchResult']['Statistics']['Databases']
         databases_facet.each do |database|
-          if DBS.key?(database['Id'].upcase)
-            db_label = DBS[database['Id'].upcase];
-          else
-            db_label = database['Label']
-          end
+          db_label = database['Label']
           databases.push({id: database['Id'], hits: database['Hits'], label: db_label})
         end
         databases

data/lib/ebsco/eds/session.rb

@@ -5,6 +5,8 @@ require 'faraday'
 require 'faraday_middleware'
 require 'logger'
 require 'json'
+require 'active_support'
+require 'faraday_eds_middleware'
 
 module EBSCO
 
@@ -57,6 +59,10 @@ module EBSCO
       #   }
       def initialize(options = {})
 
+
+        cache_dir = File.join(ENV['TMPDIR'] || '/tmp', 'faraday_eds_cache')
+        @cache_store = ActiveSupport::Cache::FileStore.new cache_dir
+
         @session_token = ''
         @auth_token = ''
         @guest = 'y'
@@ -114,7 +120,7 @@ module EBSCO
           @session_token = create_session_token
         end
 
-        @info ||= EBSCO::EDS::Info.new(do_request(:get, path: INFO_URL))
+        @info = EBSCO::EDS::Info.new(do_request(:get, path: INFO_URL))
         @current_page = 0
         @search_options = nil
 
@@ -634,43 +640,47 @@ module EBSCO
       private
 
       def connection
-        Faraday.new(url: EDS_API_BASE) do |faraday|
-          faraday.headers['Content-Type'] = 'application/json;charset=UTF-8'
-          faraday.headers['Accept'] = 'application/json'
-          faraday.headers['x-sessionToken'] = @session_token ? @session_token : ''
-          faraday.headers['x-authenticationToken'] = @auth_token ? @auth_token : ''
-          faraday.headers['User-Agent'] = USER_AGENT
-          faraday.request :url_encoded
-          faraday.use FaradayMiddleware::RaiseHttpException
-          faraday.response :json, :content_type => /\bjson$/
-          #faraday.response :logger, Logger.new(LOG)
-          faraday.adapter Faraday.default_adapter
+        logger = Logger.new(LOG)
+        logger.level = Logger::DEBUG
+        Faraday.new(url: EDS_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'] = USER_AGENT
+          conn.request :url_encoded
+          conn.use :eds_middleware, store: @cache_store
+          conn.response :json, content_type: /\bjson$/
+          conn.response :logger, logger
+          conn.adapter Faraday.default_adapter
         end
       end
 
       def create_auth_token
         if blank?(@auth_token)
           # ip auth
-          if (blank?(@user) && blank?(@pass)) || @auth_type.casecmp('ip') == 0
-            _response = do_request(:post, path: IP_AUTH_URL)
-            @auth_token = _response['AuthToken']
+          if (blank?(@user) && blank?(@pass)) || @auth_type.casecmp('ip').zero?
+            resp = do_request(:post, path: IP_AUTH_URL)
           # user auth
           else
-            _response = do_request(:post, path: UID_AUTH_URL, payload: {:UserId => @user, :Password => @pass})
-            @auth_token = _response['AuthToken']
+            resp = do_request(:post, path: UID_AUTH_URL, payload:
+                { UserId: @user, Password: @pass })
           end
         end
+        @auth_token = resp['AuthToken']
         @auth_token
       end
 
       def create_session_token
-        _response = do_request(:post, path: CREATE_SESSION_URL, payload: {:Profile => @profile, :Guest => @guest})
-        @session_token = _response['SessionToken']
+        resp = do_request(:get, path: CREATE_SESSION_URL +
+            '?profile=' + @profile + '&guest=' + @guest +
+            '&displaydatabasename=y')
+        @session_token = resp['SessionToken']
       end
 
       # helper methods
       def blank?(var)
-        var.nil? || var.respond_to?(:length) && var.length == 0
+        var.nil? || var.respond_to?(:length) && var.empty?
       end
 
       # used to reliably create empty results when there are no search terms provided

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.0.6.pre'
+    VERSION = '0.0.7.pre'
   end
 end

data/lib/faraday/eds_middleware.rb

@@ -0,0 +1,143 @@
+require 'faraday'
+
+module Faraday
+
+  class EdsMiddleware < 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')
+
+    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, {})
+
+      @store_options[:namespace] ||= @namespace
+
+      initialize_store
+    end
+
+    def call(env)
+      dup.call!(env)
+    end
+
+    protected
+
+    def call!(env)
+      response_env = cached_response(env)
+
+      if response_env
+        response_env.response_headers['x-faraday-eds-cache'] = 'HIT'
+        to_response(response_env)
+      else
+        @app.call(env).on_complete do |response_env|
+          case response_env.status
+            when 200
+              response_env.response_headers['x-faraday-eds-cache'] = 'MISS'
+              cache_response(response_env)
+            when 400
+              raise EBSCO::EDS::BadRequest.new(error_message(response_env))
+            # 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_env))
+          end
+        end
+      end
+    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
+      uri = env.url
+
+      if uri == AUTH_URI
+        custom_expires_in = 1800 # 30 minutes
+        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+      end
+
+      if uri == INFO_URI
+        custom_expires_in = 86400 # 24 hours
+        info "#{uri} - Setting custom expires: #{custom_expires_in}"
+      end
+
+      @store.write(key(env), env, expires_in: custom_expires_in)
+    end
+
+    def cacheable?(env)
+      uri = env.url
+      if uri == AUTH_URI || uri == INFO_URI
+        info "CACHEABLE URI: #{uri}"
+        true
+      else
+        info "NOT CACHEABLE URI: #{uri}"
+        false
+      end
+    end
+
+    def cached_response(env)
+      if cacheable?(env) && !env.request_headers['x-faraday-eds-cache']
+        response_env = @store.fetch(key(env))
+      end
+
+      if response_env
+        info "Cache HIT: #{key(env)}"
+      else
+        info "Cache MISS: #{key(env)}"
+      end
+
+      # info "CACHE: #{response_env.inspect}"
+
+      response_env
+    end
+
+    def info(message)
+      @logger.info(message) unless @logger.nil?
+    end
+
+    def key(env)
+      env.url
+    end
+
+    def initialize_store
+      return unless @store.is_a? Symbol
+
+      require 'active_support/cache'
+      @store = ActiveSupport::Cache.lookup_store(@store, @store_options)
+    end
+
+    def to_response(env)
+      env = env.dup
+      env.response_headers['x-faraday-eds-cache'] = 'HIT'
+      response = Response.new
+      response.finish(env) unless env.parallel?
+      env.response = response
+    end
+
+    def error_message(response)
+      # puts response.inspect
+      {
+        method: response.method,
+        url: response.url,
+        status: response.status,
+        error_body: response.body
+      }
+    end
+  end
+end

data/lib/faraday_eds_middleware.rb

@@ -0,0 +1,7 @@
+require 'faraday/eds_middleware'
+
+if Faraday.respond_to?(:register_middleware)
+  Faraday.register_middleware eds_middleware: Faraday::EdsMiddleware
+elsif Faraday::Middleware.respond_to?(:register_middleware)
+  Faraday::Middleware.register_middleware eds_middleware: Faraday::EdsMiddleware
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.0.6.pre
+  version: 0.0.7.pre
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -212,15 +226,15 @@ files:
 - ebsco-eds.gemspec
 - lib/ebsco/eds.rb
 - lib/ebsco/eds/error.rb
-- lib/ebsco/eds/http_exception.rb
 - lib/ebsco/eds/info.rb
 - lib/ebsco/eds/jsonable.rb
 - lib/ebsco/eds/options.rb
 - lib/ebsco/eds/record.rb
 - lib/ebsco/eds/results.rb
 - lib/ebsco/eds/session.rb
-- lib/ebsco/eds/settings.yml
 - lib/ebsco/eds/version.rb
+- lib/faraday/eds_middleware.rb
+- lib/faraday_eds_middleware.rb
 homepage: https://github.com/ebsco/edsapi-ruby
 licenses:
 - MIT

data/lib/ebsco/eds/http_exception.rb

@@ -1,49 +0,0 @@
-require 'faraday'
-
-module FaradayMiddleware
-
-  class RaiseHttpException < Faraday::Middleware
-
-    def initialize(app)
-      super app
-    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))
-        end
-      end
-    end
-
-    private
-
-    def error_message(response)
-      #puts response.inspect
-      {
-          method: response.method,
-          url: response.url,
-          status: response.status,
-          error_body: response.body
-      }
-    end
-
-  end
-
-end

data/lib/ebsco/eds/settings.yml

@@ -1,35 +0,0 @@
-
-databases:
-  EDB: Publisher Provided Full Text Searching File,
-  EDO: Supplemental Index,
-  ASX: Academic Search Index,
-  A9H: Academic Search Complete,
-  APH: Academic Search Premier,
-  AFH: Academic Search Elite,
-  A2H: Academic Search Alumni Edition,
-  ASM: Academic Search Main Edition,
-  ASR: STM Source,
-  BSX: Business Source Index,
-  EDSEBK: Discovery eBooks,
-  VTH: Art & Architecture Complete,
-  IIH: Computers & Applied Sciences Complete,
-  CMH: Consumer Health Complete - CHC Platform,
-  C9H: Consumer Health Complete - EBSCOhost,
-  EOAH: E-Journals Database,
-  EHH: Education Research Complete,
-  HCH: Health Source - Nursing/Academic,
-  HXH: Health Source - Consumer Edition,
-  HLH: Humanities International Complete,
-  LGH: Legal Collection,
-  SLH: Sociological Collection,
-  CPH: Computer Source,
-  PBH: Psychology & Behavioral Sciences Collection,
-  RLH: Religion & Philosophy Collection,
-  NFH: Newspaper Source,
-  N5H: Newspaper Source Plus,
-  BWH: Regional Business News,
-  OFM: OmniFile Full Text Mega,
-  RSS: Rehabilitation & Sports Medicine Source,
-  SYH: Science & Technology Collection,
-  SCF: Science Full Text Select,
-  HEH: Health Business Elite