ebsco-eds 0.3.11.pre → 0.3.12.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7931e60abeb2fed82632dccfe5b7b3937bf7e229
-  data.tar.gz: d3fea8cf70ddb89b4586e63f3654ecd936995def
+  metadata.gz: d4f34a2f1413eab073c1b0b2f2509338af1a5c3e
+  data.tar.gz: deff1b5f31a7da1d4004b369b943bcb8942fb32e
 SHA512:
-  metadata.gz: 58480532fdc34fccb7c107fe0186398241e27ade6383735faac8f066318ab421efc80ec414478d8f533f41d2f8d463d100ca38be697baca792583b68a55fff94
-  data.tar.gz: de346b5df45bae11ee26916e339795a8b05ada807efdfac0eb32605c4b8cd07921fb4caf1684e5d017fc6c3d0aaa1cc48a0aceb7a356577e6f76ba373082e1a5
+  metadata.gz: 1f960b731df8741229d42f13809a6ded2cde56d717eab644603ee5d9cd31025b01aad317bb99b311014df38edf4fb281c29d2bc8b82c66cffd55da4d2d57dc11
+  data.tar.gz: 687cb32c89a654aecbe0a73d7ef9afa08047a29bb8149dd6a24ade108ab70df7ad2b89129687ee5a0465b442f903a55ac5e1d91a95aacba80754e09c76ed50d1

data/ebsco-eds.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'csl-styles', '~> 1.0', '>= 1.0.1.5'
   spec.add_dependency 'activesupport', '~> 5.0'
   spec.add_dependency 'net-http-persistent', '~> 2.9'
-  spec.add_dependency 'sanitize', '~> 4.5.0'
+  spec.add_dependency 'sanitize', '~> 4.5', '>= 4.5.0'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 12.0'

data/lib/ebsco/eds/options.rb

@@ -24,25 +24,6 @@ module EBSCO
         #   end
         # end
 
-        # blacklight year range slider input
-        # "range"=>{"pub_year_tisim"=>{"begin"=>"1970", "end"=>"1980"}}
-        if options.has_key?('range')
-          if options['range'].has_key?('pub_year_tisim')
-            begin_year = nil
-            end_year = nil
-            if options['range']['pub_year_tisim'].has_key?('begin')
-              begin_year = options['range']['pub_year_tisim']['begin']
-            end
-            if options['range']['pub_year_tisim'].has_key?('end')
-              end_year = options['range']['pub_year_tisim']['end']
-            end
-            unless begin_year.nil? or end_year.nil?
-              pub_year_tisim_range = begin_year + '-01/' + end_year + '-01'
-              @Actions.push "addlimiter(DT1:#{pub_year_tisim_range})"
-            end
-          end
-        end
-
         # add page default of 1
         unless options.has_key?('page') || options.has_key?('page_number')
           options['page'] = 1
@@ -60,145 +41,6 @@ module EBSCO
             when 'page', 'page_number'
               @Actions.push "GoToPage(#{value.to_i})"
 
-            # solr facet translation
-            # "f"=>{"format"=>["eBooks"]}
-            when 'f'
-              if value.has_key?('eds_publication_type_facet')
-                format_list = value['eds_publication_type_facet']
-                format_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(SourceType:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_language_facet')
-                lang_list = value['eds_language_facet']
-                lang_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(Language:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_subject_topic_facet')
-                subj_list = value['eds_subject_topic_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(SubjectEDS:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_subjects_geographic_facet')
-                subj_list = value['eds_subjects_geographic_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(SubjectGeographic:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_publisher_facet')
-                subj_list = value['eds_publisher_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(Publisher:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_journal_facet')
-                subj_list = value['eds_journal_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(Journal:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_category_facet')
-                subj_list = value['eds_category_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(Category:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_content_provider_facet')
-                subj_list = value['eds_content_provider_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(ContentProvider:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_library_location_facet')
-                subj_list = value['eds_library_location_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(LocationLibrary:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_library_collection_facet')
-                subj_list = value['eds_library_collection_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(CollectionLibrary:#{item})"
-                end
-              end
-
-              if value.has_key?('eds_author_university_facet')
-                subj_list = value['eds_author_university_facet']
-                subj_list.each do |item|
-                  item = eds_sanitize item
-                  @Actions.push "addfacetfilter(AuthorUniversity:#{item})"
-                end
-              end
-
-              # translate solr search limiters into EDS API addLimiter calls
-              # matches are determined by the limiter labels passed in by solr
-              _search_limiter_list = []
-              if value.has_key?('eds_search_limiters_facet')
-                _search_limiter_list = value['eds_search_limiters_facet']
-              end
-              info.available_limiters.each do |limiter|
-                # only handle 'select' limiters (ones with values of 'y' or 'n')
-                if ( _search_limiter_list.include? limiter['Label'] or _search_limiter_list.include? limiter['Id']) and limiter['Type'] == 'select'
-                  @Actions.push "addLimiter(#{limiter['Id']}:y)"
-                end
-              end
-
-              if value.has_key?('eds_publication_year_range_facet')
-                _list = value['eds_publication_year_range_facet']
-                _this_year = Date.today.year
-                _this_month = Date.today.month
-                _list.each do |item|
-                  if item == 'This year'
-                    _range = _this_year.to_s + '-01/' + _this_year.to_s + '-' + _this_month.to_s
-                    @Actions.push "addlimiter(DT1:#{_range})"
-                  end
-                  if item == 'Last 3 years'
-                    _range = (_this_year-3).to_s + '-' + _this_month.to_s + '/' + _this_year.to_s + '-' + _this_month.to_s
-                    @Actions.push "addlimiter(DT1:#{_range})"
-                  end
-                  if item == 'Last 10 years'
-                    _range = (_this_year-10).to_s + '-' + _this_month.to_s + '/' + _this_year.to_s + '-' + _this_month.to_s
-                    @Actions.push "addlimiter(DT1:#{_range})"
-                  end
-                  if item == 'Last 50 years'
-                    _range = (_this_year-50).to_s + '-' + _this_month.to_s + '/' + _this_year.to_s + '-' + _this_month.to_s
-                    @Actions.push "addlimiter(DT1:#{_range})"
-                  end
-                  if item == 'More than 50 years ago'
-                    _range = '0000-01/' + (_this_year-50).to_s + '-12'
-                    @Actions.push "addlimiter(DT1:#{_range})"
-                  end
-                end
-              end
-
-              if value.has_key?('eds_publication_year_facet')
-                year_list = value['eds_publication_year_facet']
-                year_list.each do |item|
-                  @Actions.push "addfacetfilter(PublicationYear:#{item})"
-                end
-              end
-
           end
         end
   
@@ -334,13 +176,35 @@ module EBSCO
         _my_expanders = []
         _available_expander_ids = info.available_expander_ids
 
-        @Limiter = nil
+        @Limiters = nil
         _my_limiters = []
 
+        @FacetFilters = []
+        _my_filters = {'FilterId' => 1, 'FacetValues' => []}
+
         @RelatedContent = info.default_related_content_types
         _my_related_content = []
         _available_related_content_types = info.available_related_content_types
 
+        # blacklight year range slider input
+        # "range"=>{"pub_year_tisim"=>{"begin"=>"1970", "end"=>"1980"}}
+        if options.has_key?('range')
+          if options['range'].has_key?('pub_year_tisim')
+            begin_year = nil
+            end_year = nil
+            if options['range']['pub_year_tisim'].has_key?('begin')
+              begin_year = options['range']['pub_year_tisim']['begin']
+            end
+            if options['range']['pub_year_tisim'].has_key?('end')
+              end_year = options['range']['pub_year_tisim']['end']
+            end
+            unless begin_year.nil? or end_year.nil?
+              pub_year_tisim_range = begin_year + '-01/' + end_year + '-01'
+              _my_limiters.push({:Id => 'DT1', :Values => [pub_year_tisim_range]})
+            end
+          end
+        end
+
         options.each do |key, value|
 
           case key
@@ -463,9 +327,152 @@ module EBSCO
               end
               @Expanders = _my_expanders
 
+            # ====================================================================================
+            # solr limiters & facets
+            # ====================================================================================
+
+            when 'f'
+              _search_limiter_list = []
+              if value.has_key?('eds_search_limiters_facet')
+                _search_limiter_list = value['eds_search_limiters_facet']
+              end
+              info.available_limiters.each do |limiter|
+                # only handle 'select' limiters (ones with values of 'y' or 'n')
+                if ( _search_limiter_list.include? limiter['Label'] or _search_limiter_list.include? limiter['Id']) and limiter['Type'] == 'select'
+                  _my_limiters.push({:Id => limiter['Id'], :Values => ['y']})
+                end
+              end
+
+              # date limiters
+              if value.has_key?('eds_publication_year_range_facet')
+                _list = value['eds_publication_year_range_facet']
+                _this_year = Date.today.year
+                _this_month = Date.today.month
+                _list.each do |item|
+                  if item == 'This year'
+                    _range = _this_year.to_s + '-01/' + _this_year.to_s + '-' + _this_month.to_s
+                    _my_limiters.push({:Id => 'DT1', :Values => [_range]})
+                  end
+                  if item == 'Last 3 years'
+                    _range = (_this_year-3).to_s + '-' + _this_month.to_s + '/' + _this_year.to_s + '-' + _this_month.to_s
+                    _my_limiters.push({:Id => 'DT1', :Values => [_range]})
+                  end
+                  if item == 'Last 10 years'
+                    _range = (_this_year-10).to_s + '-' + _this_month.to_s + '/' + _this_year.to_s + '-' + _this_month.to_s
+                    _my_limiters.push({:Id => 'DT1', :Values => [_range]})
+                  end
+                  if item == 'Last 50 years'
+                    _range = (_this_year-50).to_s + '-' + _this_month.to_s + '/' + _this_year.to_s + '-' + _this_month.to_s
+                    _my_limiters.push({:Id => 'DT1', :Values => [_range]})
+                  end
+                  if item == 'More than 50 years ago'
+                    _range = '0000-01/' + (_this_year-50).to_s + '-12'
+                    _my_limiters.push({:Id => 'DT1', :Values => [_range]})
+                  end
+                end
+              end
+
+              # SourceType
+              if value.has_key?('eds_publication_type_facet')
+                f_list = value['eds_publication_type_facet']
+                f_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'SourceType', 'Value' => item})
+                end
+              end
+              # Language
+              if value.has_key?('eds_language_facet')
+                lang_list = value['eds_language_facet']
+                lang_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'Language', 'Value' => item})
+                end
+              end
+              # SubjectEDS
+              if value.has_key?('eds_subject_topic_facet')
+                subj_list = value['eds_subject_topic_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'SubjectEDS', 'Value' => item})
+                end
+              end
+              # SubjectGeographic
+              if value.has_key?('eds_subjects_geographic_facet')
+                subj_list = value['eds_subjects_geographic_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'SubjectGeographic', 'Value' => item})
+                end
+              end
+              # Publisher
+              if value.has_key?('eds_publisher_facet')
+                subj_list = value['eds_publisher_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'Publisher', 'Value' => item})
+                end
+              end
+              # Journal
+              if value.has_key?('eds_journal_facet')
+                subj_list = value['eds_journal_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'Journal', 'Value' => item})
+                end
+              end
+              # Category
+              if value.has_key?('eds_category_facet')
+                subj_list = value['eds_category_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'Category', 'Value' => item})
+                end
+              end
+              # ContentProvider
+              if value.has_key?('eds_content_provider_facet')
+                subj_list = value['eds_content_provider_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'ContentProvider', 'Value' => item})
+                end
+              end
+              # LocationLibrary
+              if value.has_key?('eds_library_location_facet')
+                subj_list = value['eds_library_location_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'LocationLibrary', 'Value' => item})
+                end
+              end
+              # CollectionLibrary
+              if value.has_key?('eds_library_collection_facet')
+                subj_list = value['eds_library_collection_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'CollectionLibrary', 'Value' => item})
+                end
+              end
+              # AuthorUniversity
+              if value.has_key?('eds_author_university_facet')
+                subj_list = value['eds_author_university_facet']
+                subj_list.each do |item|
+                  item = eds_sanitize item
+                  _my_filters['FacetValues'].push({'Id' => 'AuthorUniversity', 'Value' => item})
+                end
+              end
+              # PublicationYear
+              if value.has_key?('eds_publication_year_facet')
+                year_list = value['eds_publication_year_facet']
+                year_list.each do |item|
+                  _my_filters['FacetValues'].push({'Id' => 'PublicationYear', 'Value' => item})
+                end
+              end
+
+
             # ====================================================================================
             # limiters
             # ====================================================================================
+
             when :limiters
               value.each do |item|
                 _key = item.split(':',2).first.upcase
@@ -520,9 +527,24 @@ module EBSCO
 
           end
 
+        end # end options parsing
+
+        # set solr facet filters, if any
+        if _my_filters['FacetValues'].length > 0
+          @FacetFilters = [_my_filters]
         end
 
+        # set solr limiters, if any
+        @Limiters = _my_limiters
+
+      end
+
+      def eds_sanitize(str)
+        pattern = /([)(:,])/
+        str = str.gsub(pattern){ |match| '\\' + match }
+        str
       end
+
     end
 
     class RetrievalCriteria

data/lib/ebsco/eds/record.rb

@@ -770,6 +770,67 @@ module EBSCO
         end
       end
 
+      def get_item_data(options)
+
+        if @items.empty?
+          nil
+        else
+
+          if options[:name] and options[:label] and options[:group]
+
+            @items.each do |item|
+              if item['Name'] == options[:name] && item['Label'] == options[:label] && item['Group'] == options[:group]
+                return sanitize_data(item['Data'])
+              end
+            end
+
+          elsif options[:name] and options[:label]
+
+            @items.each do |item|
+              if item['Name'] == options[:name] && item['Label'] == options[:label]
+                return sanitize_data(item['Data'])
+              end
+            end
+
+          elsif options[:name] and options[:group]
+
+            @items.each do |item|
+              if item['Name'] == options[:name] && item['Group'] == options[:group]
+                return sanitize_data(item['Data'])
+              end
+            end
+
+          elsif options[:label] and options[:group]
+
+            @items.each do |item|
+              if item['Label'] == options[:label] && item['Group'] == options[:group]
+                return sanitize_data(item['Data'])
+              end
+            end
+
+          elsif options[:label]
+
+            @items.each do |item|
+              if item['Label'] == options[:label]
+                return sanitize_data(item['Data'])
+              end
+            end
+
+          elsif options[:name]
+
+            @items.each do |item|
+              if item['Name'] == options[:name]
+                return sanitize_data(item['Data'])
+              end
+            end
+
+          else
+            nil
+          end
+
+        end
+      end
+
       # sanitize html, allow custom links
       def sanitize_data(data)
         html = CGI.unescapeHTML(data.to_s)

data/lib/ebsco/eds/session.rb

@@ -106,6 +106,7 @@ module EBSCO
         @auth_type =  (ENV.has_key? 'EDS_AUTH') ? ENV['EDS_AUTH'] : @config[:auth]
         @org =        (ENV.has_key? 'EDS_ORG') ? ENV['EDS_ORG'] : @config[:org]
         @cache_dir =  (ENV.has_key? 'EDS_CACHE_DIR') ? ENV['EDS_CACHE_DIR'] : @config[:eds_cache_dir]
+        @log_level =  (ENV.has_key? 'EDS_LOG_LEVEL') ? ENV['EDS_LOG_LEVEL'] : @config[:log_level]
 
         (ENV.has_key? 'EDS_GUEST') ?
             if %w(n N no No false False).include?(ENV['EDS_GUEST'])
@@ -230,9 +231,10 @@ module EBSCO
             # create temp format facet results if needed
             if options['f']
               if options['f'].key?('eds_publication_type_facet')
-                format_options = options
+                format_options = options.dup
                 format_options['f'] = options['f'].except('eds_publication_type_facet')
                 format_search_options = EBSCO::EDS::Options.new(format_options, @info)
+                format_search_options.Comment = 'temp source type facets'
                 _format_response = do_request(:post, path: '/edsapi/rest/Search', payload: format_search_options)
                 @search_results.temp_format_facet_results = EBSCO::EDS::Results.new(_format_response, @info.available_limiters, format_options)
               end
@@ -241,9 +243,10 @@ module EBSCO
             # create temp content provider facet results if needed
             if options['f']
               if options['f'].key?('eds_content_provider_facet')
-                content_options = options
+                content_options = options.dup
                 content_options['f'] = options['f'].except('eds_content_provider_facet')
                 content_search_options = EBSCO::EDS::Options.new(content_options, @info)
+                content_search_options.Comment = 'temp content provider facet'
                 _content_response = do_request(:post, path: '/edsapi/rest/Search', payload: content_search_options)
                 @search_results.temp_content_provider_facet_results = EBSCO::EDS::Results.new(_content_response, @info.available_limiters, content_options)
               end
@@ -928,7 +931,7 @@ module EBSCO
 
       def connection
         logger = Logger.new(@config[:log])
-        logger.level = Logger.const_get(@config[:log_level])
+        logger.level = Logger.const_get(@log_level)
         Faraday.new(url: 'https://' + @api_hosts_list[@api_host_index]) do |conn|
           conn.headers['Content-Type'] = 'application/json;charset=UTF-8'
           conn.headers['Accept'] = 'application/json'
@@ -949,7 +952,7 @@ module EBSCO
       # same as above but no caching
       def jump_connection
         logger = Logger.new(@config[:log])
-        logger.level = Logger.const_get(@config[:log_level])
+        logger.level = Logger.const_get(@log_level)
         Faraday.new(url: 'https://' + @api_hosts_list[@api_host_index]) do |conn|
           conn.headers['Content-Type'] = 'application/json;charset=UTF-8'
           conn.headers['Accept'] = 'application/json'

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.3.11.pre'
+    VERSION = '0.3.12.pre'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.3.11.pre
+  version: 0.3.12.pre
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -230,6 +230,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.5.0
   type: :runtime
@@ -237,6 +240,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.5.0
 - !ruby/object:Gem::Dependency