ebsco-eds 0.3.19.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05125cb00685ec2a83b1a72ff1a2620aa61b3ca5
-  data.tar.gz: 76bc4aa46094211f3495097648da67411613b046
+  metadata.gz: 3be68963a219aa4dd86acf2b408b432f2d8e9de7
+  data.tar.gz: 859682c8f1051b9066d8ba2c3c8d3eb907d00327
 SHA512:
-  metadata.gz: 9533c1f746ccfada25772fce193d31cbdd3698c403ce3a0a35314ad5333f4b0c7c9b302ab4432b24b592bc2a2993b9307a4bba5ab6387eb56ddbb16f914590b6
-  data.tar.gz: c9d4e27019c7137121697b2151ea15a25dc5fa9adcad39430c11d0807455ece135ae6eba9dc3fe2ece10bc1b7fe4f886d3bc569a0f8f3388cb7a1ec88ccec24e
+  metadata.gz: 93a9aa9296c9319dbae1ca448ac70e0377b4b64c00a818cebd3193ddff229d94ed392d772d8123b0e472eeffc7351802a4001401e0132757c6423ed19ab066d5
+  data.tar.gz: d943f5bb8b41edfe53f5ca5aa29c9d766bbfea8486a108918f37a0fdd62cb501ba2fb3834188342794e5b8f876257587d12f45d184eaa2cda7d5b31d607618db

data/.gitignore

@@ -19,3 +19,4 @@ faraday.log
 yaml-sample-records
 *.gem
 .idea
+test/cache

data/Rakefile

@@ -1,10 +1,24 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/*_test.rb']
+  t.warning = false
+end
+
+Rake::TestTask.new(:test_caching) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/caching/*_test.rb']
+  t.warning = false
+end
+
+Rake::TestTask.new(:test_session_using_env_vars) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/sessions/*_test.rb']
   t.warning = false
 end
 

data/lib/ebsco/eds/info.rb

@@ -167,6 +167,10 @@ module EBSCO
         true
       end
 
+      def default_include_image_quick_view
+        false
+      end
+
       # ====================================================================================
       # API SETTINGS
       # ====================================================================================

data/lib/ebsco/eds/options.rb

@@ -534,11 +534,12 @@ module EBSCO
 
     class RetrievalCriteria
       include JSONable
-      attr_accessor :View, :ResultsPerPage, :PageNumber, :Highlight
+      attr_accessor :View, :ResultsPerPage, :PageNumber, :Highlight, :IncludeImageQuickView
       def initialize(options = {}, info)
 
         # defaults
         @View = info.default_result_list_view
+        @IncludeImageQuickView = info.default_include_image_quick_view
         @ResultsPerPage = info.default_results_per_page
         @PageNumber = 1
 
@@ -588,6 +589,12 @@ module EBSCO
                 @Highlight = 'y' # API bug: if set to 'n' you won't get research starter abstracts!
               end
 
+            # ====================================================================================
+            # image quick view
+            # ====================================================================================
+            when :include_image_quick_view, 'include_image_quick_view'
+              @IncludeImageQuickView = value ? 'y' : 'n'
+
             else
 
           end

data/lib/ebsco/eds/record.rb

@@ -71,6 +71,7 @@ module EBSCO
           :eds_html_fulltext_available,
           :eds_html_fulltext,
           :eds_images,
+          :eds_quick_view_images,
           :eds_all_links,
           :eds_fulltext_links,
           :eds_non_fulltext_links,
@@ -166,6 +167,8 @@ module EBSCO
                         .fetch('BibRelationships', {})
                         .fetch('IsPartOfRelationships', {})[0]
 
+        @image_quick_view_items = @record.fetch('ImageQuickViewItems', {})
+
         # accessors:
         @eds_result_id = @record['ResultId']
         @eds_plink = @record['PLink']
@@ -229,6 +232,7 @@ module EBSCO
         @eds_html_fulltext_available = html_fulltext_available
         @eds_html_fulltext = html_fulltext
         @eds_images = images
+        @eds_quick_view_images = quick_view_images
         @eds_all_links = all_links
         # init fulltext available props, reset by fulltext_links method later
         @eds_pdf_fulltext_available = false
@@ -366,6 +370,23 @@ module EBSCO
         returned_images
       end
 
+      # List of image quick view
+      def quick_view_images
+        returned_images = []
+        images = @record.fetch('ImageQuickViewItems', {})
+        if images.count > 0
+          images.each do |quick_view_item|
+            image_id = quick_view_item['DbId']
+            image_accession = quick_view_item['An']
+            image_type = quick_view_item['Type']
+            # todo: change to https, large/small url?
+            image_url = quick_view_item['Url']
+            returned_images.push({url: image_url, id: image_id, accession_number: image_accession, type: image_type})
+          end
+        end
+        returned_images
+      end
+
       # related ISBNs
       def item_related_isbns
         isbns = get_item_data({label: 'Related ISBNs'})
@@ -767,7 +788,8 @@ module EBSCO
               var != :@items &&
               var != :@bib_entity &&
               var != :@bib_part &&
-              var != :@bib_relationships
+              var != :@bib_relationships &&
+              var != :@image_quick_view_items
             hash[var.to_s.sub(/^@/, '')] = instance_variable_get(var)
           end
         end

data/lib/ebsco/eds/results.rb

@@ -29,7 +29,7 @@ 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, eds_config = {}, additional_limiters = {}, options = {})
+      def initialize(search_results, eds_config = nil, additional_limiters = {}, options = {})
 
         @results = search_results
         @limiters = additional_limiters

data/lib/ebsco/eds/session.rb

@@ -265,7 +265,7 @@ module EBSCO
             end
             @search_results
           else
-            @search_results = EBSCO::EDS::Results.new(empty_results, @config)
+            @search_results = EBSCO::EDS::Results.new(empty_results)
           end
         end
       end
@@ -501,6 +501,12 @@ module EBSCO
         add_actions "includerelatedcontent(#{val})"
       end
 
+      # Not available currently.
+      # TODO: ask for this to be added for consistency with other criteria
+      # def set_include_image_quick_view(val)
+      #   add_actions "includeimagequickview(#{val})"
+      # end
+
       # :category: Setter Methods
       # Specify to include facets in the results or not. Either 'y' or 'n'.
       # Returns search Results.
@@ -1049,7 +1055,8 @@ module EBSCO
                         {
                             'View'=>'brief',
                             'ResultsPerPage'=>20,
-                            'Highlight'=>'y'
+                            'Highlight'=>'y',
+                            'IncludeImageQuickView'=>'n'
                         },
                     'SearchCriteriaWithActions'=>
                         {

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.3.19.pre'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebsco-eds
 version: !ruby/object:Gem::Version
-  version: 0.3.19.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Bill McKinney
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -407,9 +407,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8