ebsco-eds 0.0.1.pre → 0.0.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62e553aee7daa0edd9d2d8090dc1e26140970f10
-  data.tar.gz: a52fcb3d33dfc8e7bb41a5046c49fb031fb9d92c
+  metadata.gz: 7caadfc342d7546949d09b98622721f2cf462a6c
+  data.tar.gz: 2f14eb30a58b209d49baeff48b8a73ec1b79f6c7
 SHA512:
-  metadata.gz: def2d87b7779bf26805eca8978d464997ede09095140cc83b16e179282d4dd49c396ef45c752d5e93edfb44f79d5137c34e36e3760c2dfbcf6d2d239564dde71
-  data.tar.gz: 76e6cbc75bffbca076c435725c5e5fab389b1712c5e4504fb621bf4f4707bc49db2ba12cb0ac6676c812bf1034974170e6ee05378a7bf9932dd1aaa02347389a
+  metadata.gz: 2b49a04e893451ff0fd50864507060e12057cd68d3912757a1242b8daa49310ebe37b68aa5e955e861991cdf8dd9b741dec56ba34a4bba8e5112ecd4189bf532
+  data.tar.gz: 35abec0b5ba811a3542857626f4e639ee17f22726d4e5bef935b6941e24bb03d200750e5f84b2c1f91644473100fd1adf86749230cf6a096865f9cdd86eb7e47

data/.env.test

@@ -1,12 +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
-
-# bmckinney repo
-# CODECOV_TOKEN=cfc86a29-02eb-43f3-9903-7fd46f9a510d
-
-# ebsco repo
-CODECOV_TOKEN=d72eb958-f826-40eb-8112-e77a965dc94e
+EDS_ORG=none

data/README.md

@@ -5,6 +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)
 [![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
@@ -31,6 +32,7 @@ Or install it yourself as:
 
 - [Configuration](https://github.com/ebsco/edsapi-ruby/wiki/Configuration)
 - [Quick Start](https://github.com/ebsco/edsapi-ruby/wiki/Quick-Start)
+- [Blacklight Support](https://github.com/ebsco/edsapi-ruby/wiki/Solr-and-Blacklight-Support)
 
 ### Models
 

data/lib/ebsco/eds/options.rb

@@ -43,8 +43,56 @@ module EBSCO
                   @Actions.push "addfacetfilter(SubjectEDS:#{item})"
                 end
               end
-
-              puts 'ACTIONS: ' + @Actions.inspect
+              if value.has_key?('geographic_facet')
+                subj_list = value['geographic_facet']
+                subj_list.each do |item|
+                  @Actions.push "addfacetfilter(SubjectGeographic:#{item})"
+                end
+              end
+              if value.has_key?('publisher_facet')
+                subj_list = value['publisher_facet']
+                subj_list.each do |item|
+                  @Actions.push "addfacetfilter(Publisher:#{item})"
+                end
+              end
+              if value.has_key?('journal_facet')
+                subj_list = value['journal_facet']
+                subj_list.each do |item|
+                  @Actions.push "addfacetfilter(Journal:#{item})"
+                end
+              end
+              if value.has_key?('category_facet')
+                subj_list = value['category_facet']
+                subj_list.each do |item|
+                  @Actions.push "addfacetfilter(Category:#{item})"
+                end
+              end
+              if value.has_key?('content_provider_facet')
+                subj_list = value['content_provider_facet']
+                subj_list.each do |item|
+                  @Actions.push "addfacetfilter(ContentProvider:#{item})"
+                end
+              end
+              if value.has_key?('library_location_facet')
+                subj_list = value['library_location_facet']
+                subj_list.each do |item|
+                  @Actions.push "addfacetfilter(LocationLibrary:#{item})"
+                end
+              end
+              if value.has_key?('search_limiters')
+                subj_list = value['search_limiters']
+                subj_list.each do |item|
+                  if item == 'Full Text'
+                    @Actions.push "addlimiter(FT:y)"
+                  end
+                  if item == 'Peer Reviewed'
+                    @Actions.push "addlimiter(RV:y)"
+                  end
+                  if item == 'Available in Library Collection'
+                    @Actions.push "addlimiter(FT1:y)"
+                  end
+                end
+              end
 
             else
 
@@ -260,7 +308,6 @@ module EBSCO
 
           end
 
-
         end
 
       end
@@ -323,14 +370,12 @@ module EBSCO
                 @Highlight = 'n'
               end
 
-
             else
 
           end
 
         end
 
-  
       end
   
     end

data/lib/ebsco/eds/record.rb

@@ -672,14 +672,55 @@ module EBSCO
         @bib_part.fetch('BibEntity',{}).fetch('Numbering',{}).find{|item| item['Type'] == 'issue'}['Value']
       end
 
+      # this is used to generate solr fields
       def to_hash
         hash = {}
-        hash['id'] = database_id + '-' + accession_number
-        hash['title_display'] = title.gsub('<highlight>', '').gsub('</highlight>', '')
-        hash['pub_date'] = publication_year
+        if database_id && accession_number
+          safe_an = accession_number.gsub(/\./,'_')
+          hash['id'] = database_id + '__' + safe_an
+        end
+        if !title.nil?
+          hash['title_display'] = title.gsub('<highlight>', '').gsub('</highlight>', '')
+        end
+        if publication_year
+          hash['pub_date'] = publication_year
+        end
+        if authors
+          hash['author_display'] = authors.to_s
+        end
+        if publication_type
+          hash['format'] = publication_type.to_s
+        end
+        if languages
+          if languages.kind_of?(Array)
+            hash['language_facet'] = languages.join(', ')
+          else
+            hash['language_facet'] = languages.to_s
+          end
+        end
+        if publisher_info
+          hash['pub_info'] = publisher_info
+        end
+        if abstract
+          hash['abstract'] = abstract
+        end
         hash
       end
 
+      def to_solr
+        # solr response
+        {
+            'responseHeader' => {
+                'status' => 0
+           },
+            'response' => {
+                'numFound' => 1,
+                'start' => 0,
+                'docs' => [to_hash]
+            }
+        }
+      end
+
     end # Class Record
   end # Module EDS
 end # Module EBSCO

data/lib/ebsco/eds/results.rb

@@ -22,9 +22,10 @@ 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)
+      def initialize(search_results, additional_limiters = {})
   
         @results = search_results
+        @limiters = additional_limiters
 
         # convert all results to a list of records
         @records = []
@@ -79,7 +80,7 @@ module EBSCO
             # 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>')
-              hl_hash.update({ record.database_id + '-' + record.accession_number => { 'title_display' => [hl_title]} })
+              hl_hash.update({ record.database_id + '__' + record.accession_number => { 'title_display' => [hl_title]} })
               #hl_hash.merge title_hl
             end
 
@@ -112,15 +113,42 @@ module EBSCO
             'facet_counts' =>
                 {
                     'facet_fields' => {
+                        'search_limiters' => solr_search_limiters,
                         'format' => solr_facets('SourceType'),
                         'language_facet' => solr_facets('Language'),
-                        'subject_topic_facet' => solr_facets('SubjectEDS')
+                        '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')
                     }
                 }
         }
 
       end
 
+      # Translate limiters found in calls to Info endpoint into solr facet fields if they are turned on
+      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('')
+          end
+        end
+        search_limiters
+      end
+
       # Total number of results found.
       def stat_total_hits
         _hits = @results.fetch('SearchResult',{}).fetch('Statistics',{}).fetch('TotalHits',{})

data/lib/ebsco/eds/session.rb

@@ -57,8 +57,8 @@ module EBSCO
       #   }
       def initialize(options = {})
 
-        @auth_token = ''
         @session_token = ''
+        @auth_token = ''
 
         if options.has_key? :user
           @user = options[:user]
@@ -100,8 +100,19 @@ module EBSCO
         end
 
         @max_retries = MAX_ATTEMPTS
-        @auth_token = create_auth_token
-        @session_token = create_session_token
+
+        if options.has_key? :auth_token
+          @auth_token = options[:auth_token]
+        else
+          @auth_token = create_auth_token
+        end
+
+        if options.has_key? :session_token
+          @session_token = options[:session_token]
+        else
+          @session_token = create_session_token
+        end
+
         @info = EBSCO::EDS::Info.new(do_request(:get, path: INFO_URL))
         @current_page = 0
         @search_options = nil
@@ -143,7 +154,7 @@ module EBSCO
         end
         #puts JSON.pretty_generate(@search_options)
         _response = do_request(:post, path: SEARCH_URL, payload: @search_options)
-        @search_results = EBSCO::EDS::Results.new(_response)
+        @search_results = EBSCO::EDS::Results.new(_response, @info.available_limiters)
         @current_page = @search_results.page_number
         @search_results
       end

data/lib/ebsco/eds/version.rb

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

metadata

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