ebsco-eds 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62e553aee7daa0edd9d2d8090dc1e26140970f10
+  data.tar.gz: a52fcb3d33dfc8e7bb41a5046c49fb031fb9d92c
+SHA512:
+  metadata.gz: def2d87b7779bf26805eca8978d464997ede09095140cc83b16e179282d4dd49c396ef45c752d5e93edfb44f79d5137c34e36e3760c2dfbcf6d2d239564dde71
+  data.tar.gz: 76e6cbc75bffbca076c435725c5e5fab389b1712c5e4504fb621bf4f4707bc49db2ba12cb0ac6676c812bf1034974170e6ee05378a7bf9932dd1aaa02347389a

data/.env.test

@@ -0,0 +1,12 @@
+EDS_PROFILE=eds-api
+EDS_USER=billmckinn
+EDS_PASS=4n~r1me86y
+EDS_AUTH=user
+EDS_GUEST=n
+EDS_ORG=none
+
+# bmckinney repo
+# CODECOV_TOKEN=cfc86a29-02eb-43f3-9903-7fd46f9a510d
+
+# ebsco repo
+CODECOV_TOKEN=d72eb958-f826-40eb-8112-e77a965dc94e

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+faraday.log
+.idea/.rakeTasks
+.idea/ebsco.iml
+.idea/misc.xml
+.idea/modules.xml
+.idea/vcs.xml
+.idea/workspace.xml
+.idea/dictionaries
+.env
+yaml-sample-records
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 EBSCO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+<img src="https://discovery.ebsco.com/files/pulse-images/EDS-logo_1LINE.png"/>
+
+A Ruby interface to the EBSCO Discovery Services API.
+
+[![Build Status](https://travis-ci.org/ebsco/edsapi-ruby.svg)](https://travis-ci.org/ebsco/edsapi-ruby)
+[![codecov](https://codecov.io/gh/ebsco/edsapi-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/ebsco/edsapi-ruby/branch/master)
+[![Dependency Status](https://gemnasium.com/badges/github.com/ebsco/edsapi-ruby.svg)](https://gemnasium.com/github.com/ebsco/edsapi-ruby)
+[![Gitter](https://badges.gitter.im/ebsco/edsapi-ruby.svg)](https://gitter.im/ebsco/edsapi-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+## Dependencies
+
+* Ruby 2.1+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ebsco-eds'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ebsco-eds
+
+## Documentation
+
+- [Configuration](https://github.com/ebsco/edsapi-ruby/wiki/Configuration)
+- [Quick Start](https://github.com/ebsco/edsapi-ruby/wiki/Quick-Start)
+
+### Models
+
+- [Session](https://github.com/ebsco/edsapi-ruby/wiki/Session)
+- [Results](https://github.com/ebsco/edsapi-ruby/wiki/Results)
+- [Records](https://github.com/ebsco/edsapi-ruby/wiki/Records)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ebsco/edsapi-ruby.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 
+
+You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+#### Running the tests
+- `git clone git://github.com/ebsco/edsapi-ruby && cd edsapi-ruby`
+- `bundle`
+- Create a `.env.test` file
+  - It should look like the following:
+```ruby
+EDS_PROFILE=profile_name
+EDS_GUEST=n
+EDS_USER=your_user_id
+EDS_PASS=secret
+EDS_AUTH=ip
+EDS_ORG=your_institution
+```
+- `rake test`
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ebsco"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ebsco-eds.gemspec

@@ -0,0 +1,47 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ebsco/eds/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ebsco-eds'
+  spec.version       = EBSCO::EDS::VERSION
+  spec.authors       = ['Bill McKinney','Eric Frierson']
+  spec.email         = ['bmckinney@ebsco.com, efrierson@ebsco.com']
+  spec.summary       = 'Summary: EBSCO EDS API'
+  spec.description   = 'Description: EBSCO EDS API'
+  spec.homepage      = 'https://github.com/ebsco/edsapi-ruby'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files        += Dir.glob('lib/**/*')
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0'
+  spec.add_dependency 'faraday-detailed_logger', '~> 2.0'
+  spec.add_dependency 'faraday_middleware', '~> 0.11'
+  spec.add_dependency 'logger', '~> 1.2'
+  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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'codecov', '~> 0.1'
+
+end

data/lib/ebsco/eds.rb

@@ -0,0 +1,27 @@
+require 'ebsco/eds/version'
+require 'ebsco/eds/session'
+require 'ebsco/eds/info'
+require 'ebsco/eds/results'
+require 'ebsco/eds/record'
+require 'ebsco/eds/error'
+require 'ebsco/eds/http_exception'
+
+module EBSCO
+
+  module EDS
+    EDS_API_BASE = 'https://eds-api.ebscohost.com'
+    UID_AUTH_URL = '/authservice/rest/uidauth'
+    IP_AUTH_URL = '/authservice/rest/ipauth'
+    CREATE_SESSION_URL = '/edsapi/rest/CreateSession'
+    END_SESSION_URL = '/edsapi/rest/EndSession'
+    INFO_URL = '/edsapi/rest/Info'
+    SEARCH_URL = '/edsapi/rest/Search'
+    RETRIEVE_URL = '/edsapi/rest/Retrieve'
+    USER_AGENT = 'EBSCO EDS GEM v0.0.1'
+    INTERFACE_ID = 'EBSCO EDS GEM v0.0.1'
+    LOG = 'faraday.log'
+    MAX_ATTEMPTS = 2
+    MAX_RESULTS_PER_PAGE = 100
+  end
+
+end

data/lib/ebsco/eds/error.rb

@@ -0,0 +1,47 @@
+module EBSCO
+
+  module EDS
+    class Error < StandardError
+      attr_reader :fault
+      def initialize(errors = nil)
+        if errors
+          @fault = errors
+          super(errors[:error_body])
+        end
+      end
+    end
+
+    # raised with passing in invalid or unsupported parameter
+    class InvalidParameter < StandardError; end
+
+    # raised when attempting an action that is invalid/unsupported
+    class ApiError < StandardError; end
+
+    # Raised when trying an action that is not supported
+    class NotImplemented < StandardError; end
+
+    # HTTP related errors
+
+    # raised when EDS returns the HTTP status code 400
+    class BadRequest < Error; end
+
+    # raised when EDS returns the HTTP status code 401
+    class Unauthorized < Error; end
+
+    # raised when EDS returns the HTTP status code 403
+    class Forbidden < Error; end
+
+    # raised when EDS returns the HTTP status code 404
+    class NotFound < Error; end
+
+    # Raised when EDS returns the HTTP status code 429
+    class TooManyRequests < Error; end
+
+    # Raised when EDS returns the HTTP status code 500
+    class InternalServerError < Error; end
+
+    # Raised when EDS returns the HTTP status code 503
+    class ServiceUnavailable < Error; end
+
+  end
+end

data/lib/ebsco/eds/http_exception.rb

@@ -0,0 +1,49 @@
+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/info.rb

@@ -0,0 +1,193 @@
+require 'ebsco/eds/options'
+
+module EBSCO
+
+  module EDS
+    class Info
+
+      attr_accessor :available_search_criteria, :view_result_settings, :application_settings, :api_settings
+
+      def initialize(info)
+        @available_search_criteria = info['AvailableSearchCriteria']
+        @view_result_settings = info['ViewResultSettings']
+        @application_settings = info['ApplicationSettings']
+        @api_settings = info['ApiSettings']
+      end
+
+      # ====================================================================================
+      # SORTS
+      # ====================================================================================
+
+      def available_sorts (id = 'all')
+        @available_search_criteria.fetch('AvailableSorts',{}).select{|item| item['Id'] == id || id == 'all'}
+      end
+
+      # ====================================================================================
+      # SEARCH FIELDS
+      # ====================================================================================
+
+      def search_fields (code = 'all')
+        @available_search_criteria.fetch('AvailableSearchFields',{}).select{|item| item['FieldCode'] == code || code == 'all'}
+      end
+
+      # ====================================================================================
+      # SEARCH MODES
+      # ====================================================================================
+
+      def available_search_modes (mode = 'all_available')
+        @available_search_criteria.fetch('AvailableSearchModes',{}).select{|item| item['Mode'] == mode || mode == 'all_available'}
+      end
+
+      def available_search_mode_types
+        available_search_modes.map{|hash| hash['Mode']}
+      end
+
+      def default_search_mode
+        @available_search_criteria.fetch('AvailableSearchModes',{}).find{|item| item['DefaultOn'] == 'y'}['Mode']
+      end
+
+      # ====================================================================================
+      # EXPANDERS
+      # ====================================================================================
+
+      def available_expander_ids
+        @available_search_criteria.fetch('AvailableExpanders',{}).map{|hash| hash['Id']}
+      end
+
+      def default_expander_ids
+        @available_search_criteria.fetch('AvailableExpanders',{}).select{|item| item['DefaultOn'] == 'y'}.map{|hash| hash['Id']}
+      end
+
+      def available_expanders (id = 'all')
+        if id == 'all'
+          @available_search_criteria.fetch('AvailableExpanders',{})
+        else
+          @available_search_criteria.fetch('AvailableExpanders',{}).find{|item| item['Id'] == id}
+        end
+      end
+
+      # ====================================================================================
+      # LIMITERS
+      # ====================================================================================
+
+      def available_limiter_ids
+        @available_search_criteria.fetch('AvailableLimiters',{}).map{|hash| hash['Id']}
+      end
+
+      def default_limiter_ids
+        @available_search_criteria.fetch('AvailableLimiters',{}).select{|item| item['DefaultOn'] == 'y'}.map{|hash| hash['Id']}
+      end
+
+      def available_limiters (id = 'all')
+        if id == 'all'
+          @available_search_criteria.fetch('AvailableLimiters',{})
+        else
+          @available_search_criteria.fetch('AvailableLimiters',{}).find{|item| item['Id'] == id}
+        end
+      end
+
+      # get an array of limiter values for a Type=multiselectvalue limiter
+      def available_limiter_values (id)
+        _limiter = @available_search_criteria.fetch('AvailableLimiters',{}).find{|item| item['Id'] == id}
+        if _limiter['Type'] == 'multiselectvalue'
+          _limiter['LimiterValues'].map{|hash| hash['Value']}
+        end
+      end
+
+      # ====================================================================================
+      # RELATED CONTENT
+      # ====================================================================================
+
+      def available_related_content_types
+        available_related_content.map{|hash| hash['Type'] }
+      end
+
+      def default_related_content_types
+        @available_search_criteria.fetch('AvailableRelatedContent',{}).select{|item| item['DefaultOn'] == 'y'}.map{|hash| hash['Type']}
+      end
+
+      def available_related_content (type = 'all')
+        if type == 'all'
+          @available_search_criteria.fetch('AvailableRelatedContent',{})
+        else
+          @available_search_criteria.fetch('AvailableRelatedContent',{}).find{|item| item['Type'] == type}
+        end
+      end
+
+      # ====================================================================================
+      # AUTO SUGGEST
+      # ====================================================================================
+
+      def did_you_mean (id = 'all')
+        @available_search_criteria.fetch('AvailableDidYouMeanOptions',{}).select{|item| item['Id'] == id || id == 'all'}
+      end
+
+      def default_auto_suggest
+        @available_search_criteria.fetch('AvailableDidYouMeanOptions',{}).find{|item| item['Id'] == 'AutoSuggest'}['DefaultOn']
+      end
+
+      # ====================================================================================
+      # RESULTS VIEW SETTINGS
+      # ====================================================================================
+
+      def default_results_per_page
+        @view_result_settings['ResultsPerPage']
+      end
+
+      def max_results_per_page
+        MAX_RESULTS_PER_PAGE
+      end
+
+      def available_result_list_views
+        %w{brief title detailed}
+      end
+
+      def default_result_list_view
+        @view_result_settings['ResultListView']
+      end
+
+      def default_highlight
+        true
+      end
+
+      # ====================================================================================
+      # API SETTINGS
+      # ====================================================================================
+
+      def max_record_jump
+        @api_settings['MaxRecordJumpAhead']
+      end
+
+      # ====================================================================================
+      # APPLICATION SETTINGS
+      # ====================================================================================
+
+      def session_timeout
+        @application_settings['SessionTimeout']
+      end
+
+      # ====================================================================================
+      # AVAILABLE ACTIONS
+      # ====================================================================================
+
+      def available_actions
+        @available_search_criteria.deep_find_results('AddAction')
+      end
+
+    end
+
+  end
+end
+
+# monkey patch
+class Hash
+  def deep_find_results(key, object=self, found=[])
+    if object.respond_to?(:key?) && object.key?(key)
+      found << object[key]
+    end
+    if object.is_a? Enumerable
+      found << object.collect { |*a| deep_find(key, a.last) }
+    end
+    found.flatten.compact
+  end
+end