ebsco-eds 0.0.2.pre → 0.0.3.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7caadfc342d7546949d09b98622721f2cf462a6c
-  data.tar.gz: 2f14eb30a58b209d49baeff48b8a73ec1b79f6c7
+  metadata.gz: 93c8529d7f55e30b625581f9074b9d27ff617cec
+  data.tar.gz: aa1aadfb6d45692fe10f1078de4be8dbd8869077
 SHA512:
-  metadata.gz: 2b49a04e893451ff0fd50864507060e12057cd68d3912757a1242b8daa49310ebe37b68aa5e955e861991cdf8dd9b741dec56ba34a4bba8e5112ecd4189bf532
-  data.tar.gz: 35abec0b5ba811a3542857626f4e639ee17f22726d4e5bef935b6941e24bb03d200750e5f84b2c1f91644473100fd1adf86749230cf6a096865f9cdd86eb7e47
+  metadata.gz: 8943fd15a565759b35c94e7fb1e16a98c3738096ab7bfa536513ffa43fb7ddb862010d08b5202466585b920d7c07def39c115f25f7b4431353809d14fc1af11f
+  data.tar.gz: ba2907cf2de2004c6a026f568395144aff62f83b6fe166d76efcd9cb0c680eac0efee8bc84f96b79172c63d517639a1396c53b227361fc31f444fab30ff94bd4

data/README.md

@@ -5,7 +5,7 @@ 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)
-[![Gem Version](https://badge.fury.io/rb/ebsco-eds.svg)](https://badge.fury.io/rb/ebsco-eds)
+[![Gem Version](https://img.shields.io/gem/v/ebsco-eds.svg?style=flat)](http://rubygems.org/gems/ebsco-eds)
 [![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

data/lib/ebsco/eds/options.rb

@@ -22,6 +22,11 @@ module EBSCO
             when :actions
               add_actions(options[:actions], info)
 
+            # SOLR: Need to add page actions whenever other actions are present since the other actions
+            # will always reset the page to 1 even though a PageNumber is present in RetrievalCriteria.
+            when 'page'
+              @Actions.push "GoToPage(#{value.to_i})"
+
             # solr facet translation
             # "f"=>{"format"=>["eBooks"]}
             when 'f'
@@ -140,7 +145,7 @@ module EBSCO
       include JSONable
       attr_accessor :Queries, :SearchMode, :IncludeFacets, :FacetFilters, :Limiters, :Sort, :PublicationId,
                     :RelatedContent, :AutoSuggest, :Expanders
-  
+
       def initialize(options = {}, info)
 
         # defaults
@@ -352,7 +357,6 @@ module EBSCO
             # ====================================================================================
             when :page_number, 'page'
               @PageNumber = value.to_i
-              # puts 'NEW PAGE: ' + @PageNumber.inspect
             # solr starts at page 0
             when 'start'
               @PageNumber = value.to_i + 1

data/lib/ebsco/eds/record.rb

@@ -77,7 +77,11 @@ module EBSCO
 
       # The title.
       def title
-        get_item_data_by_name('Title') || bib_title
+        _title = get_item_data_by_name('Title') || bib_title
+        if _title.nil?
+          _title = 'This title is unavailable for guests, please login to see more information.'
+        end
+        _title
       end
 
       # The source title (e.g., Journal)
@@ -553,23 +557,43 @@ module EBSCO
       # ====================================================================================
 
       def bib_title
-        @bib_entity.fetch('Titles', {}).find{|item| item['Type'] == 'main'}['TitleFull']
+        if @bib_entity
+          @bib_entity.fetch('Titles', {}).find{|item| item['Type'] == 'main'}['TitleFull']
+        else
+          nil
+        end
       end
 
       def bib_authors
-        @bib_relationships.deep_find('NameFull').join('; ')
+        if @bib_relationships
+          @bib_relationships.deep_find('NameFull').join('; ')
+        else
+          nil
+        end
       end
 
       def bib_authors_list
-        @bib_relationships.deep_find('NameFull')
+        if @bib_relationships
+          @bib_relationships.deep_find('NameFull')
+        else
+          nil
+        end
       end
 
       def bib_subjects
-        @bib_entity.deep_find('SubjectFull')
+        if @bib_entity
+          @bib_entity.deep_find('SubjectFull')
+        else
+          nil
+        end
       end
 
       def bib_languages
-        @bib_entity.fetch('Languages', {}).map{|lang| lang['Text']}
+        if @bib_entity
+          @bib_entity.fetch('Languages', {}).map{|lang| lang['Text']}
+        else
+          nil
+        end
       end
 
       # def bib_pages
@@ -577,15 +601,27 @@ module EBSCO
       # end
 
       def bib_page_count
-        @bib_entity.deep_find('PageCount').first
+        if @bib_entity
+          @bib_entity.deep_find('PageCount').first
+        else
+          nil
+        end
       end
 
       def bib_page_start
-        @bib_entity.deep_find('StartPage').first
+        if @bib_entity
+          @bib_entity.deep_find('StartPage').first
+        else
+          nil
+        end
       end
 
       def bib_doi
-        @bib_entity.fetch('Identifiers',{}).find{|item| item['Type'] == 'doi'}['Value']
+        if @bib_entity
+          @bib_entity.fetch('Identifiers',{}).find{|item| item['Type'] == 'doi'}['Value']
+        else
+          nil
+        end
       end
 
       # ====================================================================================
@@ -593,51 +629,79 @@ module EBSCO
       # ====================================================================================
 
       def bib_source_title
-        @bib_part.fetch('BibEntity',{}).fetch('Titles',{}).find{|item| item['Type'] == 'main'}['TitleFull']
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Titles',{}).find{|item| item['Type'] == 'main'}['TitleFull']
+        else
+          nil
+        end
       end
 
       def bib_issn_print
-        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'issn-print'}['Value']
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'issn-print'}['Value']
+        else
+          nil
+        end
       end
 
       def bib_issn_electronic
-        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'issn-electronic'}['Value']
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'issn-electronic'}['Value']
+        else
+          nil
+        end
       end
 
       def bib_issns
         issns = []
-        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).each do |id|
-          if id['Type'].include?('issn') && !id['Type'].include?('locals')
-            issns.push(id['Value'])
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).each do |id|
+            if id['Type'].include?('issn') && !id['Type'].include?('locals')
+              issns.push(id['Value'])
+            end
           end
         end
         issns
       end
 
       def bib_isbn_print
-        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'isbn-print'}['Value']
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'isbn-print'}['Value']
+        else
+          nil
+        end
       end
 
       def bib_isbn_electronic
-        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'isbn-electronic'}['Value']
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'isbn-electronic'}['Value']
+        else
+          nil
+        end
       end
 
       # todo: make this generic and take an optional parameter for type
       def bib_isbns
         isbns = []
-        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).each do |id|
-          if id['Type'].include?('isbn') && !id['Type'].include?('locals')
-            isbns.push(id['Value'])
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).each do |id|
+            if id['Type'].include?('isbn') && !id['Type'].include?('locals')
+              isbns.push(id['Value'])
+            end
           end
         end
         isbns
       end
 
       def bib_publication_date
-        _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
-        if _date
-          if _date.has_key?('Y') && _date.has_key?('M') && _date.has_key?('D')
-            _date['Y'] + '-' + _date['M'] + '-' + _date['D']
+        if @bib_part
+          _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
+          if _date
+            if _date.has_key?('Y') && _date.has_key?('M') && _date.has_key?('D')
+              _date['Y'] + '-' + _date['M'] + '-' + _date['D']
+            else
+              nil
+            end
           else
             nil
           end
@@ -647,29 +711,45 @@ module EBSCO
       end
 
       def bib_publication_year
-        _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
-        if _date
-          _date.has_key?('Y') ? _date['Y'] : nil
+        if @bib_part
+          _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
+          if _date
+            _date.has_key?('Y') ? _date['Y'] : nil
+          else
+            nil
+          end
         else
           nil
         end
       end
 
       def bib_publication_month
-        _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
-        if _date
-          _date.has_key?('M') ? _date['M'] : nil
+        if @bib_part
+          _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
+          if _date
+            _date.has_key?('M') ? _date['M'] : nil
+          else
+            nil
+          end
         else
           nil
         end
       end
 
       def bib_volume
-        @bib_part.fetch('BibEntity',{}).fetch('Numbering',{}).find{|item| item['Type'] == 'volume'}['Value']
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Numbering',{}).find{|item| item['Type'] == 'volume'}['Value']
+        else
+          nil
+        end
       end
 
       def bib_issue
-        @bib_part.fetch('BibEntity',{}).fetch('Numbering',{}).find{|item| item['Type'] == 'issue'}['Value']
+        if @bib_part
+          @bib_part.fetch('BibEntity',{}).fetch('Numbering',{}).find{|item| item['Type'] == 'issue'}['Value']
+        else
+          nil
+        end
       end
 
       # this is used to generate solr fields

data/lib/ebsco/eds/results.rb

@@ -22,15 +22,31 @@ module EBSCO
 
       # 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 = {})
+      def initialize(search_results, additional_limiters = {}, raw_options = {})
   
         @results = search_results
         @limiters = additional_limiters
+        @raw_options = raw_options
 
         # convert all results to a list of records
         @records = []
         if stat_total_hits > 0
-          @results['SearchResult']['Data']['Records'].each { |record| @records.push(EBSCO::EDS::Record.new(record)) }
+          @results['SearchResult']['Data']['Records'].each { |record|
+
+            @records.push(EBSCO::EDS::Record.new(record))
+
+            # # records hidden in guest mode
+            # if record['Header']['AccessLevel']
+            #   if record['Header']['AccessLevel'].to_i > 1
+            #     @records.push(EBSCO::EDS::Record.new(record))
+            #   else
+            #     @records.push(EBSCO::EDS::Record.new(record))
+            #   end
+            # else
+            #   @records.push(EBSCO::EDS::Record.new(record))
+            # end
+
+          }
         end
   
         # create a special list of research starter records

data/lib/ebsco/eds/session.rb

@@ -59,6 +59,7 @@ module EBSCO
 
         @session_token = ''
         @auth_token = ''
+        @guest = 'y'
 
         if options.has_key? :user
           @user = options[:user]
@@ -148,15 +149,32 @@ module EBSCO
       #   results = session.search({query: 'volcano', results_per_page: 1, publication_id: 'eric', include_facets: false})
       def search(options = {}, add_actions = false)
 
-        # create/recreate the search options if nil or not passing actions
-        if @search_options.nil? || !add_actions
-          @search_options = EBSCO::EDS::Options.new(options, @info)
+        # use existing/updated SearchOptions
+        if options.empty?
+          if @search_options.nil?
+            @search_results = EBSCO::EDS::Results.new(empty_results)
+          else
+            _response = do_request(:post, path: SEARCH_URL, payload: @search_options)
+            @search_results = EBSCO::EDS::Results.new(_response, @info.available_limiters, options)
+            @current_page = @search_results.page_number
+            @search_results
+          end
+        else
+          # Only perform a search when there are query terms since certain EDS profiles will throw errors when
+          # given empty queries
+          if (options.keys & %w[query q]).any? || options.has_key?(:query)
+            # create/recreate the search options if nil or not passing actions
+            if @search_options.nil? || !add_actions
+              @search_options = EBSCO::EDS::Options.new(options, @info)
+            end
+            _response = do_request(:post, path: SEARCH_URL, payload: @search_options)
+            @search_results = EBSCO::EDS::Results.new(_response, @info.available_limiters, options)
+            @current_page = @search_results.page_number
+            @search_results
+          else
+            @search_results = EBSCO::EDS::Results.new(empty_results)
+          end
         end
-        #puts JSON.pretty_generate(@search_options)
-        _response = do_request(:post, path: SEARCH_URL, payload: @search_options)
-        @search_results = EBSCO::EDS::Results.new(_response, @info.available_limiters)
-        @current_page = @search_results.page_number
-        @search_results
       end
 
       # :category: Search & Retrieve Methods
@@ -244,8 +262,8 @@ module EBSCO
       # ==== Examples
       #   results = session.add_actions('addfacetfilter(SubjectGeographic:massachusetts)')
       def add_actions(actions)
-        # todo: create search options if nil?
-        search(@search_options.add_actions(actions, @info), true)
+        @search_options.add_actions(actions, @info)
+        search()
       end
 
       # :category: Setter Methods
@@ -629,6 +647,44 @@ module EBSCO
         var.nil? || var.respond_to?(:length) && var.length == 0
       end
 
+      # used to reliably create empty results when there are no search terms provided
+      def empty_results
+        {
+            'SearchRequest'=>
+                {
+                    'SearchCriteria'=>
+                        {
+                            'Queries'=>nil,
+                            'SearchMode'=>'',
+                            'IncludeFacets'=>'y',
+                            'Sort'=>'relevance',
+                            'AutoSuggest'=>'n'
+                        },
+                    'RetrievalCriteria'=>
+                        {
+                            'View'=>'brief',
+                            'ResultsPerPage'=>20,
+                            'Highlight'=>'y'
+                        },
+                    'SearchCriteriaWithActions'=>
+                        {
+                            'QueriesWithAction'=>nil
+                        }
+                },
+            'SearchResult'=>
+                {
+                    'Statistics'=>
+                        {
+                            'TotalHits'=>0,
+                            'TotalSearchTime'=>62,
+                            'Databases'=>[]
+                        },
+                    'Data'=> {'RecordFormat'=>'EP Display'},
+                    'AvailableCriteria'=>{'DateRange'=>{'MinDate'=>'0001-01', 'MaxDate'=>'0001-01'}}
+                }
+        }
+      end
+
     end
 
   end

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.0.2.pre'
+    VERSION = '0.0.3.pre'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre
+  version: 0.0.3.pre
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday