ebsco-eds 0.3.15.pre → 0.3.16.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0ed32f227645931d31d5ee595ca1b8793f4be7f
-  data.tar.gz: b5085f8c0c463f7bf5b084104119baf15befff4a
+  metadata.gz: 6206f86a831177ab81411229592b72dd87fbfeb0
+  data.tar.gz: d0e3f92c58dd4e6b2e04c1a5bfcef6f0176f16d2
 SHA512:
-  metadata.gz: 72e23e4ee620db0170f53541684aa44d83f33822a44ec1d896f258c32908eeab0accf8041a860438e631e5dc0fe7b5366a48c205d68e8b293236c37abf1c8fcb
-  data.tar.gz: 929364e6faa8bebaa6f30288806cca3dff1d06bb3319c6603fab2091cf2ca7f76b36b9c9d2481fdf4dc8ff5ad2a489f4f62b2edcff5a0e598b1c465499237a3f
+  metadata.gz: ee47135ece9be172b171db28893b4114c9446db9321d8a2eb2e855f11d518c9927196bf9c583fe860d788e00b3cdeb3245159fa8e507fa5625e363bec6789f4b
+  data.tar.gz: 8ddcac147ee1523a013de97b8aba02cf4cf941ab2236b5db93b6bf2a5d2c32635bd1f91de643897317410361bed6cf660ea7ef5b9236f9b14d0b9e12d77251a5

data/lib/ebsco/eds/facet_titleize.rb

@@ -0,0 +1,79 @@
+module EBSCO
+  module EDS
+    class Titleize
+
+      SMALL_WORDS = %w{a an and as at but by en for if in of on or the to v v. via vs vs.}
+      ACRONYMS = %w{u.s. usa npr ieee llc g.p.o. n.y. n.c. b.v.}
+
+      def titleize(title, opts={})
+        title = title.dup
+        title.downcase! unless title[/[[:lower:]]/]  # assume all-caps need fixing
+
+        small_words = SMALL_WORDS + (opts[:small_words] || [])
+        small_words = small_words + small_words.map { |small| small.capitalize }
+
+        acronyms = ACRONYMS + (opts[:acronyms] || [])
+        acronyms = acronyms + acronyms.map { |acronym| acronym.downcase }
+
+        phrases(title).map do |phrase|
+          words = phrase.split
+          words.map.with_index do |word, index|
+
+            if acronyms.include?(word.gsub(/[()]/,''))
+              word.upcase
+            else
+
+              def word.capitalize
+                # like String#capitalize, but it starts with the first letter
+                self.sub(/[[:alpha:]].*/) {|subword| subword.capitalize}
+              end
+
+              case word
+                when /[[:alpha:]]\.[[:alpha:]]/  # words with dots in, like "example.com"
+                  word
+                when /[-‑]/  # hyphenated word (regular and non-breaking)
+                  word.split(/([-‑])/).map do |part|
+                    SMALL_WORDS.include?(part) ? part : part.capitalize
+                  end.join
+                when /^[[:alpha:]].*[[:upper:]]/ # non-first letter capitalized already
+                  word
+                when /^[[:digit:]]/  # first character is a number
+                  word
+                when *small_words
+                  if index == 0 || index == words.size - 1
+                    word.capitalize
+                  else
+                    word.downcase
+                  end
+                else
+                  word.capitalize
+              end
+
+            end
+
+          end.join(' ')
+        end.join(' ')
+      end
+
+      def phrases(title)
+        phrases = [[]]
+        title.split.each do |word|
+          phrases.last << word
+          phrases << [] if ends_with_punctuation?(word) && !small_word?(word)
+        end
+        phrases.reject(&:empty?).map { |phrase| phrase.join ' ' }
+      end
+
+      private
+
+      def small_word?(word)
+        SMALL_WORDS.include? word.downcase
+      end
+
+      def ends_with_punctuation?(word)
+        word =~ /[:.;?!]$/
+      end
+    end
+
+  end
+end

data/lib/ebsco/eds/info.rb

@@ -139,6 +139,10 @@ module EBSCO
         @available_search_criteria.fetch('AvailableDidYouMeanOptions',{}).find{|item| item['Id'] == 'AutoSuggest'}['DefaultOn']
       end
 
+      def default_auto_correct
+        @available_search_criteria.fetch('AvailableDidYouMeanOptions',{}).find{|item| item['Id'] == 'AutoCorrect'}['DefaultOn']
+      end
+
       # ====================================================================================
       # RESULTS VIEW SETTINGS
       # ====================================================================================

data/lib/ebsco/eds/options.rb

@@ -61,12 +61,6 @@ module EBSCO
         end
       end
 
-      def eds_sanitize(str)
-        pattern = /([)(:,])/
-        str = str.gsub(pattern){ |match| '\\' + match }
-        str
-      end
-
       # def is_valid_action(action, info)
       #   # actions in info that require an enumerated value (e.g., addlimiter(LA99:Bulgarian))
       #   _available_actions = info.available_actions
@@ -116,6 +110,9 @@ module EBSCO
         # auto-suggest
         qs << '&autosuggest=' + @SearchCriteria.AutoSuggest
 
+        # auto-correct
+        qs << '&autocorrect=' + @SearchCriteria.AutoCorrect
+
         # limiters
         unless @SearchCriteria.Limiters.nil?
           qs << '&limiter=' + @SearchCriteria.Limiters.join(',')
@@ -162,7 +159,7 @@ module EBSCO
     class SearchCriteria
       include JSONable
       attr_accessor :Queries, :SearchMode, :IncludeFacets, :FacetFilters, :Limiters, :Sort, :PublicationId,
-                    :RelatedContent, :AutoSuggest, :Expanders
+                    :RelatedContent, :AutoSuggest, :Expanders, :AutoCorrect
 
       def initialize(options = {}, info)
 
@@ -171,6 +168,7 @@ module EBSCO
         @IncludeFacets = 'y'
         @Sort = 'relevance'
         @AutoSuggest = info.default_auto_suggest
+        @AutoCorrect = info.default_auto_correct
         _has_query = false
 
         @Expanders = info.default_expander_ids
@@ -275,20 +273,6 @@ module EBSCO
             when :facet_filters
               @FacetFilters = value
 
-            # # handle solr facets without causing the page to reset to 1 again?
-            # when 'f'
-            #
-            #   if value.has_key?('content_provider_facet')
-            #     f_filter = {'FilterId' => 1, 'FacetValues' => []}
-            #     flist = value['content_provider_facet']
-            #     flist.each do |item|
-            #       item = eds_sanitize item
-            #       f_filter['FacetValues'].push({'Id' => 'ContentProvider', 'Value' => item})
-            #     end
-            #     @FacetFilters.push f_filter
-            #     puts 'FACET FILTERS: ' + @FacetFilters.inspect
-            #   end
-
             # ====================================================================================
             # sort
             # ====================================================================================
@@ -313,9 +297,15 @@ module EBSCO
             when :publication_id
               @PublicationId = value
 
-            when :auto_suggest
+            # ====================================================================================
+            # auto suggest & correct
+            # ====================================================================================
+            when :auto_suggest, 'auto_suggest'
               @AutoSuggest = value ? 'y' : 'n'
 
+            when :auto_correct, 'auto_correct'
+              @AutoCorrect = value ? 'y' : 'n'
+
             # ====================================================================================
             # expanders
             # ====================================================================================
@@ -379,7 +369,6 @@ module EBSCO
               if value.has_key?('eds_language_facet')
                 lang_list = value['eds_language_facet']
                 lang_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'Language', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -388,7 +377,6 @@ module EBSCO
               if value.has_key?('eds_subject_topic_facet')
                 subj_list = value['eds_subject_topic_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'SubjectEDS', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -397,7 +385,6 @@ module EBSCO
               if value.has_key?('eds_subjects_geographic_facet')
                 subj_list = value['eds_subjects_geographic_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'SubjectGeographic', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -406,7 +393,6 @@ module EBSCO
               if value.has_key?('eds_publisher_facet')
                 subj_list = value['eds_publisher_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'Publisher', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -415,7 +401,6 @@ module EBSCO
               if value.has_key?('eds_journal_facet')
                 subj_list = value['eds_journal_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'Journal', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -424,7 +409,6 @@ module EBSCO
               if value.has_key?('eds_category_facet')
                 subj_list = value['eds_category_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'Category', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -433,7 +417,6 @@ module EBSCO
               if value.has_key?('eds_library_location_facet')
                 subj_list = value['eds_library_location_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'LocationLibrary', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -442,7 +425,6 @@ module EBSCO
               if value.has_key?('eds_library_collection_facet')
                 subj_list = value['eds_library_collection_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'CollectionLibrary', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -451,7 +433,6 @@ module EBSCO
               if value.has_key?('eds_author_university_facet')
                 subj_list = value['eds_author_university_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'AuthorUniversity', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -471,7 +452,6 @@ module EBSCO
               if value.has_key?('eds_publication_type_facet')
                 f_list = value['eds_publication_type_facet']
                 f_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'SourceType', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -480,7 +460,6 @@ module EBSCO
               if value.has_key?('eds_content_provider_facet')
                 subj_list = value['eds_content_provider_facet']
                 subj_list.each do |item|
-                  item = eds_sanitize item
                   @FacetFilters.push({'FilterId' => filter_id, 'FacetValues' => [{'Id' => 'ContentProvider', 'Value' => item}]})
                   filter_id += 1
                 end
@@ -551,12 +530,6 @@ module EBSCO
 
       end
 
-      def eds_sanitize(str)
-        pattern = /([)(:,])/
-        str = str.gsub(pattern){ |match| '\\' + match }
-        str
-      end
-
     end
 
     class RetrievalCriteria

data/lib/ebsco/eds/results.rb

@@ -1,4 +1,5 @@
 require 'ebsco/eds/record'
+require 'ebsco/eds/facet_titleize'
 require 'yaml'
 require 'cgi'
 require 'date'
@@ -87,6 +88,9 @@ module EBSCO
           end
         end
 
+        # titleize facets
+        @titleize_facets = %w[Language Journal SubjectEDS SubjectGeographic Publisher]
+
       end
 
       # returns solr search response format
@@ -207,24 +211,47 @@ module EBSCO
       #                           "freq":1}]}],
       #     "correctlySpelled":false}}
       def solr_spellcheck
+
+        suggestions = []
         unless did_you_mean.nil?
+          suggestions = [
+              search_terms.first.to_s, {
+                'numFound' => 1,
+                'startOffset' => 0,
+                'endOffset' => 7,
+                'origFreq' => 0,
+                'suggestion' => [{
+                 'word' => did_you_mean.to_s,
+                 'freq' => 1 }]
+            }
+          ]
+        end
+
+        corrections = []
+        unless auto_corrections.nil?
+          corrections = [
+              search_terms.first.to_s, {
+                'numFound' => 1,
+                'startOffset' => 0,
+                'endOffset' => 7,
+                'origFreq' => 0,
+                'correction' => [{
+                 'word' => auto_corrections.to_s,
+                 'freq' => 1 }]
+              }
+            ]
+        end
+
+        unless did_you_mean.nil? && auto_corrections.nil?
           {
               'spellcheck' => {
-                  'suggestions' => [
-                      search_terms.first.to_s, {
-                      'numFound' => 1,
-                      'startOffset' => 0,
-                      'endOffset' => 7,
-                      'origFreq' => 0,
-                      'suggestion' => [{
-                          'word' => did_you_mean.to_s,
-                          'freq' => 1 }]
-                    }
-                  ],
+                  'suggestions' => suggestions,
+                  'corrections' => corrections,
                       'correctlySpelled' => false
               }
           }
         end
+
       end
 
       # Publication date facets:
@@ -292,7 +319,8 @@ module EBSCO
       #      "Expanders"=>["fulltext", "thesaurus", "relatedsubjects"],
       #      "Sort"=>"relevance",
       #      "RelatedContent"=>["rs"],
-      #      "AutoSuggest"=>"n"
+      #      "AutoSuggest"=>"n",
+      #      "AutoCorrect"=>"n"
       #    }
       def search_criteria
         if @results['SearchRequestGet'] && @results['SearchRequestGet']['QueryString']
@@ -302,6 +330,7 @@ module EBSCO
           sc['IncludeFacets'] = params['includefacets'].nil? ? 'y' : params['includefacets'][0].to_s
           sc['Sort'] = params['sort'].nil? ? 'relevance' : params['sort'][0].to_s
           sc['AutoSuggest'] = params['autosuggest'].nil? ? 'n' : params['autosuggest'][0].to_s
+          sc['AutoCorrect'] = params['autocorrect'].nil? ? 'n' : params['autocorrect'][0].to_s
           sc['Expanders'] = params['expander'].nil? ? [] : params['expander'][0].to_s.split(',')
           sc['RelatedContent'] = params['relatedcontent'].nil? ? [] : params['relatedcontent'][0].to_s.split(',')
           query1 = params['query-1'][0].to_s.split(',')
@@ -489,6 +518,10 @@ module EBSCO
             facet_values = []
             available_facet['AvailableFacetValues'].each do |available_facet_value|
               facet_value = available_facet_value['Value']
+              if @titleize_facets.include?(facet_id)
+                title = EBSCO::EDS::Titleize.new
+                facet_value = title.titleize(facet_value)
+              end
               facet_count = available_facet_value['Count']
               facet_action = available_facet_value['AddAction']
               facet_values.push({value: facet_value, hitcount: facet_count, action: facet_action})
@@ -514,6 +547,10 @@ module EBSCO
           if available_facet['Id'] == facet_provided_id || facet_provided_id == 'all'
             available_facet['AvailableFacetValues'].each do |available_facet_value|
               facet_value = available_facet_value['Value']
+              if @titleize_facets.include?(facet_provided_id)
+                title = EBSCO::EDS::Titleize.new
+                facet_value = title.titleize(facet_value)
+              end
               facet_count = available_facet_value['Count']
               facet_values.push(facet_value, facet_count)
             end
@@ -554,6 +591,14 @@ module EBSCO
         nil
       end
 
+      def auto_corrections
+        auto_corrected_terms = @results.fetch('SearchResult', {}).fetch('AutoCorrectedTerms',{})
+        auto_corrected_terms.each do |term|
+          return term
+        end
+        nil
+      end
+
       # Returns a simple list of the search terms used. Boolean operators are not indicated.
       # ==== Example
       #   ["earthquakes", "california"]

data/lib/ebsco/eds/session.rb

@@ -788,6 +788,9 @@ module EBSCO
                     if jump_payload.SearchCriteria.instance_variable_defined?(:@AutoSuggest)
                       jump_payload.SearchCriteria.remove_instance_variable(:@AutoSuggest)
                     end
+                    if jump_payload.SearchCriteria.instance_variable_defined?(:@AutoCorrect)
+                      jump_payload.SearchCriteria.remove_instance_variable(:@AutoCorrect)
+                    end
                     if jump_payload.SearchCriteria.instance_variable_defined?(:@Expanders)
                       jump_payload.SearchCriteria.remove_instance_variable(:@Expanders)
                     end
@@ -1039,7 +1042,8 @@ module EBSCO
                             'SearchMode'=>'',
                             'IncludeFacets'=>'y',
                             'Sort'=>'relevance',
-                            'AutoSuggest'=>'n'
+                            'AutoSuggest'=>'n',
+                            'AutoCorrect'=>'n'
                         },
                     'RetrievalCriteria'=>
                         {

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.3.15.pre'
+    VERSION = '0.3.16.pre'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.3.15.pre
+  version: 0.3.16.pre
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -381,6 +381,7 @@ files:
 - lib/ebsco/eds/csl/styles/chicago-author-date.csl
 - lib/ebsco/eds/csl/styles/modern-language-association.csl
 - lib/ebsco/eds/error.rb
+- lib/ebsco/eds/facet_titleize.rb
 - lib/ebsco/eds/info.rb
 - lib/ebsco/eds/jsonable.rb
 - lib/ebsco/eds/options.rb