ebsco-eds 0.0.4.pre → 0.0.5.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81a61b693843d786e5274cf56b1799c439f07586
-  data.tar.gz: cd7e51b21d87a8d7dac6c1dd1d306d81b5105316
+  metadata.gz: 43e9ebad04e9e0aaa2b87f2e25d10e1cfad40934
+  data.tar.gz: 94e000ec7b6f2ccac3514dfa6fce6c567df90d76
 SHA512:
-  metadata.gz: 0078e01f8ca86d2d84f8720a4f70ff983e4c02f8e929f29f76b8214e7bb08d3d4feb13a557ef32bb864b621e19212a0e00bddb1f754f839ddb737bb220dcf289
-  data.tar.gz: 3ecbc29fd10cf728fcad1ea885b65fef5cd14d4003b0f8797d76e00b76944e91a153e3d34df4d8dcf7b0929f54487fb3e85da859d8c8f7e535665da56c640ed8
+  metadata.gz: debbac1ad692666481d61fafe2c67fb667bd44f6c3f6de810720f96caea1da7569632193e20760a7abb151a9eb63baf2de7fe3ed168ffdf64816eea6c3fc7496
+  data.tar.gz: 8c30c14fee4443d7403985ccb9fa58c7e5c21c49666813c0836378439eeebb91ce4f655a028b8764f1a31a8230cab485cb1987f758a2d42d16d685af32503f5b

data/.env.test

@@ -1,6 +1,6 @@
-EDS_PROFILE=eds-api
-EDS_USER=billmckinn
-EDS_PASS=4n~r1me86y
+EDS_PROFILE=edsapi
+EDS_USER=user
+EDS_PASS=secret
 EDS_AUTH=user
 EDS_GUEST=n
 EDS_ORG=none

data/lib/ebsco/eds/record.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'json'
 require 'bibtex'
+require 'cgi'
 
 module EBSCO
 
@@ -35,9 +36,9 @@ module EBSCO
                                  .fetch('BibRelationships', {})
 
         @bib_part = @record.fetch('RecordInfo', {})
-                          .fetch('BibRecord', {})
-                          .fetch('BibRelationships', {})
-                          .fetch('IsPartOfRelationships', {})[0]
+                        .fetch('BibRecord', {})
+                        .fetch('BibRelationships', {})
+                        .fetch('IsPartOfRelationships', {})[0]
 
         @bibtex = BibTeX::Entry.new
       end
@@ -77,31 +78,35 @@ module EBSCO
 
       # The title.
       def 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.'
+        _retval = get_item_data_by_name('Title') || bib_title
+        # todo: make this configurable
+        if _retval.nil?
+          _retval = 'This title is unavailable for guests, please login to see more information.'
         end
-        _title
+        CGI.unescapeHTML(_retval)
       end
 
       # The source title (e.g., Journal)
       def source_title
-        bib_source_title || get_item_data_by_name('TitleSource')
+        _retval = bib_source_title || get_item_data_by_name('TitleSource')
+        _retval.nil?? nil : CGI.unescapeHTML(_retval)
       end
 
       # Other alternative titles.
       def other_titles
-        get_item_data_by_name('TitleAlt')
+        _retval = get_item_data_by_name('TitleAlt')
+        _retval.nil?? nil : CGI.unescapeHTML(_retval)
       end
 
       # The abstract
       def abstract
-        get_item_data_by_name('Abstract')
+        _retval = get_item_data_by_name('Abstract')
+        _retval.nil?? nil : CGI.unescapeHTML(_retval)
       end
 
       # The list of authors
       def authors
-         bib_authors || get_item_data_by_name('Author')
+        bib_authors || get_item_data_by_name('Author')
       end
 
       # The author affiliations
@@ -131,7 +136,8 @@ module EBSCO
 
       # Notes
       def notes
-        get_item_data_by_name('Note')
+        _retval = get_item_data_by_name('Note')
+        _retval.nil?? nil : CGI.unescapeHTML(_retval)
       end
 
       # Languages
@@ -241,12 +247,20 @@ module EBSCO
 
       # Cover image - thumbnail size link
       def cover_thumb_url
-        images('thumb').first[:src]
+        if images('thumb').any?
+          images('thumb').first[:src]
+        else
+          nil
+        end
       end
 
       # Cover image - medium size link
       def cover_medium_url
-        images('medium').first[:src]
+        if images('medium').any?
+          images('medium').first[:src]
+        else
+          nil
+        end
       end
 
       # Word count for fulltext.
@@ -417,7 +431,7 @@ module EBSCO
 
         links
       end
-      
+
       #:nodoc: all
       # No need to document methods below
 
@@ -768,7 +782,7 @@ module EBSCO
           hash['id'] = database_id + '__' + safe_an
         end
         if !title.nil?
-          hash['title_display'] = title.gsub('<highlight>', '').gsub('</highlight>', '')
+          hash['title_display'] = title.gsub('<highlight>', '').gsub('</highlight>', '')
         end
         if publication_year
           hash['pub_date'] = publication_year
@@ -792,6 +806,12 @@ module EBSCO
         if abstract
           hash['abstract'] = abstract
         end
+        if cover_thumb_url
+          hash['cover_thumb_url'] = cover_thumb_url
+        end
+        if cover_medium_url
+          hash['cover_medium_url'] = cover_medium_url
+        end
         hash
       end
 
@@ -800,7 +820,7 @@ module EBSCO
         {
             'responseHeader' => {
                 'status' => 0
-           },
+            },
             'response' => {
                 'numFound' => 1,
                 'start' => 0,

data/lib/ebsco/eds/results.rb

@@ -11,26 +11,28 @@ module EBSCO
       # Raw results as Hash
       attr_reader :results
       # Array of EBSCO::EDS::Record results
-      attr_reader :records
+      attr_accessor :records
       # Array of EBSCO::EDS::Record Research Starters
       attr_reader :research_starters
       # Array of EBSCO::EDS::Record Exact Publication Matches
       attr_reader :publication_match
 
+      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 = {})
-  
+
         @results = search_results
         @limiters = additional_limiters
         @raw_options = raw_options
 
         # convert all results to a list of records
         @records = []
-        if stat_total_hits > 0
+        if @results['SearchResult']['Data']['Records']
           @results['SearchResult']['Data']['Records'].each { |record|
 
             @records.push(EBSCO::EDS::Record.new(record))
@@ -48,7 +50,7 @@ module EBSCO
 
           }
         end
-  
+
         # create a special list of research starter records
         @research_starters = []
         _related_records = @results.fetch('SearchResult',{}).fetch('RelatedContent',{}).fetch('RelatedRecords',{})
@@ -64,7 +66,7 @@ module EBSCO
             end
           end
         end
-  
+
         # create a special list of exact match publications
         @publication_match = []
         _related_publications = @results.fetch('SearchResult',{}).fetch('RelatedContent',{}).fetch('RelatedPublications',{})
@@ -80,7 +82,7 @@ module EBSCO
             end
           end
         end
-  
+
       end
 
       # returns solr search response format
@@ -90,55 +92,69 @@ module EBSCO
         hl_hash = {}
         solr_docs = []
 
-        if stat_total_hits > 0
+        if @records.any?
           @records.each { |record|
 
             # todo: add solr hl.tag.pre and hl.tag.post to retrieval criteria
-            if retrieval_criteria.fetch('Highlight',{}) == 'y'
-              hl_title = record.title.gsub('&lt;highlight&gt;', '<em>').gsub('&lt;/highlight&gt;', '</em>')
+            if retrieval_criteria && retrieval_criteria.fetch('Highlight',{}) == 'y'
+              hl_title = record.title.gsub('<highlight>', '<em>').gsub('</highlight>', '</em>')
               hl_hash.update({ record.database_id + '__' + record.accession_number => { 'title_display' => [hl_title]} })
               #hl_hash.merge title_hl
             end
-
             solr_docs.push(record.to_hash)
           }
         end
 
+        status = 0
+        wt = 'ruby'
+        qtime = stat_total_time
+        qterms = search_terms.join(' ')
+        rows = results_per_page
+        num_found = stat_total_hits.to_i
+        search_limiters = solr_search_limiters
+        format = solr_facets('SourceType')
+        language_facet = solr_facets('Language')
+        subject_topic_facet = solr_facets('SubjectEDS')
+        publisher_facet = solr_facets('Publisher')
+        journal_facet = solr_facets('Journal')
+        geographic_facet = solr_facets('SubjectGeographic')
+        category_facet = solr_facets('Category')
+        content_provider_facet = solr_facets('ContentProvider')
+        library_location_facet = solr_facets('LocationLibrary')
+        facet = true
+
         # solr response
         {
             'responseHeader' => {
-              'status' => 0,
-              'QTime' => stat_total_time,
-              'params' => {
-                  'q' => search_terms.join(' '),
-                  'wt' => 'ruby',
-                  'start' => solr_start,
-                  'rows' => results_per_page,
-                  'facet' => true,
-                  'f.subject_topic_facet.facet.limit' => 21,
-                  'f.language_facet.facet.limit' => 11,
-
-              }
+                'status' => status,
+                'QTime' => qtime,
+                'params' => {
+                    'q' => qterms,
+                    'wt' => wt,
+                    'start' => solr_start,
+                    'rows' => rows,
+                    'facet' => facet
+                }
             },
             'response' => {
-               'numFound' => stat_total_hits.to_i,
-               'start' => solr_start,
-               'docs' => solr_docs
+                'numFound' => num_found,
+                'start' => solr_start,
+                'docs' => solr_docs
             },
             'highlighting' => hl_hash,
             'facet_counts' =>
                 {
                     'facet_fields' => {
-                        'search_limiters' => solr_search_limiters,
-                        'format' => solr_facets('SourceType'),
-                        'language_facet' => solr_facets('Language'),
-                        'subject_topic_facet' => solr_facets('SubjectEDS'),
-                        'publisher_facet' => solr_facets('Publisher'),
-                        'journal_facet' => solr_facets('Journal'),
-                        'geographic_facet' => solr_facets('SubjectGeographic'),
-                        'category_facet' => solr_facets('Category'),
-                        'content_provider_facet' => solr_facets('ContentProvider'),
-                        'library_location_facet' => solr_facets('LocationLibrary')
+                        'search_limiters' => search_limiters,
+                        'format' => format,
+                        'language_facet' => language_facet,
+                        'subject_topic_facet' => subject_topic_facet,
+                        'publisher_facet' => publisher_facet,
+                        'journal_facet' => journal_facet,
+                        'geographic_facet' => geographic_facet,
+                        'category_facet' => category_facet,
+                        'content_provider_facet' => content_provider_facet,
+                        'library_location_facet' => library_location_facet
                     }
                 }
         }
@@ -149,17 +165,19 @@ module EBSCO
       def solr_search_limiters
         search_limiters = []
         if stat_total_hits.to_i > 0
-          _ft_limiter = @limiters.find{|item| item['Id'] == 'FT'}
-          if _ft_limiter['DefaultOn'] == 'y'
-            search_limiters.push('Full Text').push('')
-          end
-          _rv_limiter = @limiters.find{|item| item['Id'] == 'RV'}
-          if _rv_limiter['DefaultOn'] == 'y'
-            search_limiters.push('Peer Reviewed').push('')
-          end
-          _ft1_limiter = @limiters.find{|item| item['Id'] == 'FT1'}
-          if _ft1_limiter['DefaultOn'] == 'y'
-            search_limiters.push('Available in Library Collection').push('')
+          if @limiters.any?
+            _ft_limiter = @limiters.find{|item| item['Id'] == 'FT'}
+            if _ft_limiter['DefaultOn'] == 'y'
+              search_limiters.push('Full Text').push('')
+            end
+            _rv_limiter = @limiters.find{|item| item['Id'] == 'RV'}
+            if _rv_limiter['DefaultOn'] == 'y'
+              search_limiters.push('Peer Reviewed').push('')
+            end
+            _ft1_limiter = @limiters.find{|item| item['Id'] == 'FT1'}
+            if _ft1_limiter['DefaultOn'] == 'y'
+              search_limiters.push('Available in Library Collection').push('')
+            end
           end
         end
         search_limiters
@@ -209,7 +227,7 @@ module EBSCO
       def retrieval_criteria
         @results['SearchRequest']['RetrievalCriteria']
       end
-  
+
       # Queries used to produce the results. Returns an array of query hashes.
       # ==== Example
       #    [{"BooleanOperator"=>"AND", "Term"=>"volcano"}]
@@ -412,7 +430,7 @@ module EBSCO
         end
         terms
       end
-  
+
     end
 
   end

data/lib/ebsco/eds/session.rb

@@ -213,6 +213,22 @@ module EBSCO
         EBSCO::EDS::Record.new(retrieve_response)
       end
 
+      def solr_retrieve_list(list: [], highlight: nil, ebook: 'ebook-pdf')
+        records = []
+        if list.any?
+          list.each { |id|
+            dbid = id.split('__').first
+            accession = id.split('__').last
+            accession.gsub!(/_/, '.')
+            records.push retrieve(dbid: dbid, an: accession, highlight: highlight, ebook: ebook)
+          }
+        end
+        r = empty_results(records.length)
+        results = EBSCO::EDS::Results.new(r)
+        results.records = records
+        results.to_solr
+      end
+
       # :category: Search & Retrieve Methods
       # Invalidates the session token. End Session should be called when you know a user has logged out.
       def end
@@ -648,7 +664,7 @@ module EBSCO
       end
 
       # used to reliably create empty results when there are no search terms provided
-      def empty_results
+      def empty_results(hits = 0)
         {
             'SearchRequest'=>
                 {
@@ -675,8 +691,8 @@ module EBSCO
                 {
                     'Statistics'=>
                         {
-                            'TotalHits'=>0,
-                            'TotalSearchTime'=>62,
+                            'TotalHits'=>hits,
+                            'TotalSearchTime'=>0,
                             'Databases'=>[]
                         },
                     'Data'=> {'RecordFormat'=>'EP Display'},

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.0.4.pre'
+    VERSION = '0.0.5.pre'
   end
 end

metadata

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