ebsco-eds 0.1.9.pre → 0.2.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9322677a3b97bef467b3d279b234faa7f781ac19
-  data.tar.gz: ca5db0366fda7a4b726f029eb72b28a9395f4445
+  metadata.gz: 0ec5b5c854dfdf57d04d9488a7ef07de40711f46
+  data.tar.gz: f05a30ba9788834a16d85924188fd012f402ad45
 SHA512:
-  metadata.gz: 3f526a7dd1c6b4d2f83d0f0d96d7bebd2a9c9f1c3560478cc86315109e929bf4c8f5c076885c04fd8ae573124005da87c4d3d1f954009e7c99a88f1290b8f0fd
-  data.tar.gz: 53927107a26b31dc85dc6c764547d537d48822c59d0fb164c35b1cf6973df01bbf1986d0a71d23fd017b20fcf15293477dbb75a9bf5d21789ca4f3e48d0fe7eb
+  metadata.gz: 9991eae7323bacd2151f17ed9ad4ea57a89c6898553ca0e47ae16599c25b8d1e03503e0cd4a8445eddd668bfa9c0412434f94f411d2db84bdf17e491624b3cac
+  data.tar.gz: 657d974a39dc5d75ca716f1691e134f0c251fee8284d6c0a881564cfa86974721ab700b5b7914fdf9cd88c1d4c909a3cf099bfba0fb60823ba24ae3fec1ef31d

data/.env.test

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

data/lib/ebsco/eds/configuration.rb

@@ -32,7 +32,9 @@ module EBSCO
             :max_results_per_page => 100,
             :ebook_preferred_format => 'ebook-pdf',
             :use_cache => true,
-            :eds_cache_dir => ENV['TMPDIR'] || '/tmp'
+            :eds_cache_dir => ENV['TMPDIR'] || '/tmp',
+            :timeout => 60,
+            :open_timeout => 2
         }
         @valid_config_keys = @config.keys
       end

data/lib/ebsco/eds/record.rb

@@ -27,6 +27,9 @@ module EBSCO
           :eds_subjects,
           :eds_subjects_geographic,
           :eds_subjects_person,
+          :eds_subjects_company,
+          :eds_subjects_mesh,
+          :eds_subjects_bisac,
           :eds_subjects_genre,
           :eds_author_supplied_keywords,
           :eds_descriptors,
@@ -41,6 +44,7 @@ module EBSCO
           :eds_publication_date,
           :eds_publication_year,
           :eds_publication_info,
+          :eds_publisher,
           :eds_document_type,
           :eds_document_doi,
           :eds_document_oclc,
@@ -70,9 +74,48 @@ module EBSCO
           :eds_publication_id,
           :eds_publication_is_searchable,
           :eds_publication_scope_note
+      ]
 
+      KNOWN_ITEM_NAMES = %w(
+          URL
+          Title
+          TitleSource
+          TitleAlt
+          Abstract
+          Note
+          Author
+          AffiliationAuthor
+          Subject
+          SubjectGeographic
+          SubjectPerson
+          SubjectCompany
+          SubjectMESH
+          SubjectBISAC
+          SubjectGenre
+          Subset
+          Language
+          PhysDesc
+          TypePub
+          DatePub
+          TypeDocument
+          DOI
+          ISSN
+          SeriesInfo
+          FullTextWordCount
+          AbstractSuppliedCopyright
+          CodeNAICS
+          NoteScope
+          Publisher
+        )
+
+      KNOWN_ITEM_LABELS = [
+          'OCLC',
+          'Descriptors',
+          'Publication Information',
+          'Related ISBNs'
       ]
 
+
       # Raw record as returned by the \EDS API via search or retrieve
       attr_accessor(*ATTRIBUTES)
 
@@ -111,18 +154,21 @@ module EBSCO
         @id = @eds_database_id + '__' + @eds_accession_number.gsub(/\./,'_')
         @eds_title = title
         @eds_source_title = source_title
-        @eds_composed_title = source_title_composed
-        @eds_other_titles = other_titles
-        @eds_abstract = abstract
+        @eds_composed_title = get_item_data_by_name('TitleSource')
+        @eds_other_titles = get_item_data_by_name('TitleAlt')
+        @eds_abstract = get_item_data_by_name('Abstract')
         @eds_authors = bib_authors_list
         @eds_authors_composed = get_item_data_by_name('Author')
         @eds_author_affiliations = get_item_data_by_name('AffiliationAuthor')
         @eds_subjects = bib_subjects || get_item_data_by_name('Subject')
         @eds_subjects_geographic = get_item_data_by_name('SubjectGeographic')
         @eds_subjects_person = get_item_data_by_name('SubjectPerson')
+        @eds_subjects_company = get_item_data_by_name('SubjectCompany')
+        @eds_subjects_bisac = get_item_data_by_name('SubjectBISAC')
+        @eds_subjects_mesh = get_item_data_by_name('SubjectMESH')
         @eds_subjects_genre = get_item_data_by_name('SubjectGenre')
         @eds_author_supplied_keywords = get_item_data_by_name('Keyword')
-        @eds_notes = notes
+        @eds_notes = get_item_data_by_name('Note')
         @eds_subset = get_item_data_by_name('Subset')
         @eds_languages = get_item_data_by_name('Language') || bib_languages
         @eds_page_count = bib_page_count
@@ -133,6 +179,7 @@ module EBSCO
         @eds_publication_date = bib_publication_date || get_item_data_by_name('DatePub')
         @eds_publication_year = bib_publication_year || get_item_data_by_name('DatePub')
         @eds_publication_info = get_item_data_by_label('Publication Information')
+        @eds_publisher = get_item_data_by_name('Publisher')
         @eds_document_type = get_item_data_by_name('TypeDocument')
         @eds_document_doi = get_item_data_by_name('DOI') || bib_doi
         @eds_document_oclc = get_item_data_by_label('OCLC')
@@ -157,11 +204,17 @@ module EBSCO
         @eds_code_naics = get_item_data_by_name('CodeNAICS')
         @eds_abstract_supplied_copyright = get_item_data_by_name('AbstractSuppliedCopyright')
         @eds_descriptors = get_item_data_by_label('Descriptors')
-
         @eds_publication_id = @record['Header']['PublicationId']
         @eds_publication_is_searchable = @record['Header']['IsSearchable']
         @eds_publication_scope_note = get_item_data_by_name('NoteScope')
 
+        # add item metadata
+        @items.each do |item|
+          unless KNOWN_ITEM_NAMES.include?(item['Name']) || KNOWN_ITEM_LABELS.include?(item['Label'])
+            add_extra_item_accessors(item)
+          end
+        end
+
       end
 
       # --
@@ -186,38 +239,14 @@ module EBSCO
         if _retval.nil?
           _retval = 'This title is unavailable for guests, please login to see more information.'
         end
-        CGI.unescapeHTML(_retval)
+        _retval
       end
 
       # The source title (example: 'Salem Press Encyclopedia')
       def source_title
         _retval = bib_source_title || get_item_data_by_name('TitleSource')
         _reval = nil? if _retval == title # suppress if it's identical to title
-        _retval.nil?? nil : CGI.unescapeHTML(_retval)
-      end
-
-      # composed title (example: 'Salem Press Encyclopedia, January, 2017. 2p.')
-      def source_title_composed
-        _retval = get_item_data_by_name('TitleSource')
-        _retval.nil?? nil : CGI.unescapeHTML(_retval)
-      end
-
-      # Other alternative titles.
-      def other_titles
-        _retval = get_item_data_by_name('TitleAlt')
-        _retval.nil?? nil : CGI.unescapeHTML(_retval)
-      end
-
-      # The abstract
-      def abstract
-        _retval = get_item_data_by_name('Abstract')
-        _retval.nil?? nil : CGI.unescapeHTML(_retval)
-      end
-
-      # Notes
-      def notes
-        _retval = get_item_data_by_name('Note')
-        _retval.nil?? nil : CGI.unescapeHTML(_retval)
+        _retval.nil?? nil : _retval
       end
 
       # Cover image - thumbnail size link
@@ -406,38 +435,6 @@ module EBSCO
         links
       end
 
-      # ====================================================================================
-      # ITEM DATA HELPERS
-      # ====================================================================================
-
-      # look up by 'Name' and return 'Data'
-      def get_item_data_by_name(name)
-        if @items.empty?
-          nil
-        else
-          _item_property = @items.find{|item| item['Name'] == name}
-          if _item_property.nil?
-            nil
-          else
-            _item_property['Data']
-          end
-        end
-      end
-
-      # look up by 'Label' and return 'Data'
-      def get_item_data_by_label(label)
-        if @items.empty?
-          nil
-        else
-          _item_property = @items.find{|item| item['Label'] == label}
-          if _item_property.nil?
-            nil
-          else
-            _item_property['Data']
-          end
-        end
-      end
-
       # ====================================================================================
       # BIB ENTITY
       # ====================================================================================
@@ -702,74 +699,7 @@ module EBSCO
         hash
       end
 
-      # this is used to generate solr fields
-      # def to_hash(type = 'compact')
-      #   hash = {}
-      #
-      #   # information typically required by all views
-      #   if database_id && accession_number
-      #     safe_an = accession_number.gsub(/\./,'_')
-      #     hash['eds_id'] = database_id + '__' + safe_an
-      #   end
-      #   unless title.nil?
-      #     hash['eds_title'] = title.gsub('<highlight>', '').gsub('</highlight>', '')
-      #   end
-      #   if source_title
-      #     hash['eds_source_title'] = source_title
-      #   end
-      #   if publication_year
-      #     hash['eds_publication_year'] = publication_year
-      #   end
-      #   if authors
-      #     hash['eds_authors'] = authors.to_s
-      #   end
-      #   if publication_type
-      #     hash['eds_publication_type'] = publication_type.to_s
-      #   end
-      #   if languages
-      #     if languages.kind_of?(Array)
-      #       hash['eds_language'] = languages.join(', ')
-      #     else
-      #       hash['eds_language'] = languages.to_s
-      #     end
-      #   end
-      #   if publisher_info
-      #     hash['eds_publisher_info'] = publisher_info
-      #   end
-      #   if abstract
-      #     hash['eds_abstract'] = abstract
-      #   end
-      #   if cover_thumb_url
-      #     hash['eds_cover_thumb_url'] = cover_thumb_url
-      #   end
-      #   if cover_medium_url
-      #     hash['eds_cover_medium_url'] = cover_medium_url
-      #   end
-      #   if all_links
-      #     hash['eds_fulltext_link'] = { 'id' => database_id + '__' + safe_an, 'links' => all_links}
-      #   end
-      #
-      #   # extra information typically required by detailed item views
-      #   if type == 'verbose'
-      #     if all_links
-      #       hash['eds_links'] = all_links
-      #     end
-      #     if doi
-      #       hash['eds_doi'] = doi
-      #     end
-      #     if html_fulltext
-      #       hash['eds_html_fulltext'] = html_fulltext
-      #     end
-      #   end
-      #
-      #   hash
-      # end
-
       def to_solr
-        # solr response
-        # item_hash = to_hash 'verbose'
-        item_hash = to_attr_hash
-        solr_response =
         {
             'responseHeader' => {
                 'status' => 0
@@ -777,13 +707,55 @@ module EBSCO
             'response' => {
                 'numFound' => 1,
                 'start' => 0,
-                'docs' => [item_hash]
+                'docs' => to_attr_hash
             }
         }
-        # puts 'SOLR RESPONSE: ' + solr_response.inspect
-        solr_response
       end
 
+      # ====================================================================================
+      # ITEM DATA HELPERS
+      # ====================================================================================
+
+      # look up by 'Name' and return 'Data'
+      def get_item_data_by_name(name)
+        if @items.empty?
+          nil
+        else
+          _item_property = @items.find{|item| item['Name'] == name}
+          if _item_property.nil?
+            nil
+          else
+            CGI.unescapeHTML(_item_property['Data'])
+          end
+        end
+      end
+
+      # look up by 'Label' and return 'Data'
+      def get_item_data_by_label(label)
+        if @items.empty?
+          nil
+        else
+          _item_property = @items.find{|item| item['Label'] == label}
+          if _item_property.nil?
+            nil
+          else
+            CGI.unescapeHTML(_item_property['Data'])
+          end
+        end
+      end
+
+      # dynamically add item metadata as 'eds_extra_ItemNameOrLabel'
+      def add_extra_item_accessors(item)
+        key = item['Name'] ? item['Name'] : item['Label'].gsub(/\s+/, '_')
+        value = item['Data']
+        unless key.nil?
+          key = "eds_extras_#{key}"
+          unless value.nil?
+            class_eval { attr_accessor key }
+            instance_variable_set "@#{key}", CGI.unescapeHTML(value)
+          end
+        end
+      end
 
     end # Class Record
   end # Module EDS

data/lib/ebsco/eds/session.rb

@@ -104,15 +104,13 @@ module EBSCO
         @use_cache =  (ENV.has_key? 'EDS_USE_CACHE') ? ENV['EDS_USE_CACHE'] : @config[:use_cache]
         @cache_dir =  (ENV.has_key? 'EDS_CACHE_DIR') ? ENV['EDS_CACHE_DIR'] : @config[:eds_cache_dir]
 
-        if ENV.has_key? 'EDS_GUEST'
-          if ['n', 'N', 'no', 'No'].include?(ENV['EDS_GUEST'])
-            @guest = false
-          else
-            @guest = true
-          end
-        else
-          @guest = @config[:guest]
-        end
+        (ENV.has_key? 'EDS_GUEST') ?
+            if %w(n N no No).include?(ENV['EDS_GUEST'])
+              @guest = false
+            else
+              @guest = true
+            end :
+            @guest = @config[:guest]
 
         # use cache for auth token and info calls?
         if @use_cache
@@ -685,6 +683,8 @@ module EBSCO
           conn.use :eds_exception_middleware
           conn.response :json, content_type: /\bjson$/
           conn.response :detailed_logger, logger if @debug
+          conn.options[:open_timeout] = @config[:open_timeout]
+          conn.options[:timeout] = @config[:timeout]
           conn.adapter Faraday.default_adapter
         end
       end

data/lib/ebsco/eds/version.rb

@@ -1,5 +1,5 @@
 module EBSCO
   module EDS
-    VERSION = '0.1.9.pre'
+    VERSION = '0.2.0.pre'
   end
 end

metadata

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