ebsco-eds 0.0.1.pre

data/lib/ebsco/eds/jsonable.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module JSONable
+  module ClassMethods
+    attr_accessor :attributes
+
+    def attr_accessor(*attrs)
+      self.attributes = Array attrs
+      super
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def as_json
+    serialized = Hash.new
+    self.class.attributes.each do |attribute|
+      serialized[attribute] = self.public_send attribute
+    end
+    serialized
+  end
+
+  def to_json(*a)
+    as_json.to_json(*a)
+  end
+end

data/lib/ebsco/eds/options.rb

@@ -0,0 +1,339 @@
+require 'ebsco/eds/jsonable'
+
+module EBSCO
+
+  module EDS
+
+    class Options
+      include JSONable
+      attr_accessor :SearchCriteria, :RetrievalCriteria, :Actions
+      def initialize(options = {}, info)
+  
+        @SearchCriteria = EBSCO::EDS::SearchCriteria.new(options, info)
+
+        @RetrievalCriteria = EBSCO::EDS::RetrievalCriteria.new(options, info)
+  
+        @Actions = []
+
+        options.each do |key, value|
+
+          case key
+
+            when :actions
+              add_actions(options[:actions], info)
+
+            # solr facet translation
+            # "f"=>{"format"=>["eBooks"]}
+            when 'f'
+              if value.has_key?('format')
+                format_list = value['format']
+                format_list.each do |item|
+                  @Actions.push "addfacetfilter(SourceType:#{item})"
+                end
+              end
+              if value.has_key?('language_facet')
+                lang_list = value['language_facet']
+                lang_list.each do |item|
+                  @Actions.push "addfacetfilter(Language:#{item})"
+                end
+              end
+              if value.has_key?('subject_topic_facet')
+                subj_list = value['subject_topic_facet']
+                subj_list.each do |item|
+                  @Actions.push "addfacetfilter(SubjectEDS:#{item})"
+                end
+              end
+
+              puts 'ACTIONS: ' + @Actions.inspect
+
+            else
+
+          end
+        end
+  
+      end
+  
+      def add_actions(actions, info)
+        if actions.kind_of?(Array) && actions.count > 0
+          actions.each do |item|
+            #if is_valid_action(item, info)
+            @Actions.push item
+            #end
+          end
+        else
+          #if is_valid_action(actions, info)
+          @Actions = [actions]
+          #else
+          #end
+        end
+      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
+      #   _defined_action = _available_actions.include? action
+      #   # actions not enumerated in info (e.g., GoToPage(3))
+      #   _available_standard_actions = ['GoToPage']
+      #   _standard_action = _available_standard_actions.any? { |std| action.include? std }
+      #   # actions in info that require a user supplied value (e.g., addlimiter(TI:value))
+      #   _available_value_actions = %w{PG4 CS1 FM FT FR RV DT1 SO}
+      #   _value_action = _available_value_actions.any? { |type| action.include? type }
+      #
+      #   if _value_action || _defined_action || _standard_action
+      #     true
+      #   else
+      #     false
+      #   end
+      # end
+  
+    end
+  
+    class SearchCriteria
+      include JSONable
+      attr_accessor :Queries, :SearchMode, :IncludeFacets, :FacetFilters, :Limiters, :Sort, :PublicationId,
+                    :RelatedContent, :AutoSuggest, :Expanders
+  
+      def initialize(options = {}, info)
+
+        # defaults
+        @SearchMode = info.default_search_mode
+        @IncludeFacets = 'y'
+        @Sort = 'relevance'
+        @AutoSuggest = info.default_auto_suggest
+        _has_query = false
+
+        @Expanders = info.default_expander_ids
+        _my_expanders = []
+        _available_expander_ids = info.available_expander_ids
+
+        @Limiter = nil
+        _my_limiters = []
+
+        @RelatedContent = info.default_related_content_types
+        _my_related_content = []
+        _available_related_content_types = info.available_related_content_types
+
+        options.each do |key, value|
+
+          case key
+
+            # ====================================================================================
+            # query
+            # ====================================================================================
+            when :query, 'q'
+
+              # add blacklight search_fields
+              _field_code = ''
+              if options.has_key? 'search_field'
+                _field = options['search_field']
+                case _field
+                  when 'author'
+                    _field_code = 'AU'
+                  when 'subject'
+                    _field_code = 'SU'
+                  when 'title'
+                    _field_code = 'TI'
+                end
+              end
+
+              if not _field_code == ''
+                @Queries =  [{:FieldCode => _field_code, :Term => value}]
+              else
+                @Queries =  [{:Term => value}]
+              end
+              _has_query = true
+
+            # ====================================================================================
+            # mode
+            # ====================================================================================
+            when :mode
+              if info.available_search_mode_types.include? value.downcase
+                @SearchMode = value.downcase
+              else
+                @SearchMode = info.default_search_mode
+              end
+
+            # ====================================================================================
+            # facets
+            # ====================================================================================
+            when :include_facets
+                @IncludeFacets = value ? 'y' : 'n'
+
+            when :facet_filters
+              @FacetFilters = value
+
+            # ====================================================================================
+            # sort
+            # ====================================================================================
+            when :sort, 'sort'
+              if info.available_sorts(value.downcase).empty?
+                if value.downcase == 'newest' || value.downcase == 'pub_date_sort desc'
+                  @Sort = 'date'
+                elsif value.downcase == 'oldest' || value.downcase == 'pub_date_sort asc'
+                  @Sort = 'date2'
+                elsif value.downcase == 'score desc'
+                  @Sort = 'relevance'
+                else
+                  @Sort = 'relevance'
+                end
+              else
+                @Sort = value.downcase
+              end
+
+            # ====================================================================================
+            # publication id
+            # ====================================================================================
+            when :publication_id
+              @PublicationId = value
+
+            when :auto_suggest
+              @AutoSuggest = value ? 'y' : 'n'
+
+            # ====================================================================================
+            # expanders
+            # ====================================================================================
+            when :expanders
+              value.each do |item|
+                if _available_expander_ids.include? item.downcase
+                  _my_expanders.push(item)
+                end
+              end
+              if _my_expanders.empty?
+                _my_expanders = info.default_expander_ids
+              end
+              @Expanders = _my_expanders
+
+            # ====================================================================================
+            # limiters
+            # ====================================================================================
+            when :limiters
+              value.each do |item|
+                _key = item.split(':',2).first.upcase
+                _values = item.split(':',2).last
+                # is limiter id available?
+                if info.available_limiter_ids.include? _key
+                  _limiter = info.available_limiters(_key)
+                  # if multi-value, add the values if they're available
+                  if _limiter['Type'] == 'multiselectvalue'
+                    _available_values = info.available_limiter_values(_key)
+                    _multi_values = []
+                    _values.split(',').each do |val|
+                      # todo: make case insensitive?
+                      if _available_values.include? val
+                        _multi_values.push(val)
+                      end
+                    end
+                    if _multi_values.empty?
+                      # do nothing, none of the values are available
+                    else
+                      _my_limiters.push({:Id => _key, :Values => _multi_values})
+                    end
+                    # single value, just pass it on
+                  else
+                    _my_limiters.push({:Id => _key, :Values => [_values]})
+                  end
+                end
+              end
+              @Limiters = _my_limiters
+
+            # ====================================================================================
+            # related content
+            # ====================================================================================
+            when :related_content
+              value.each do |item|
+                if _available_related_content_types.include? item.downcase
+                  _available_related_content_types.push(item)
+                else
+                  # silently ignore
+                end
+              end
+              if _my_related_content.empty?
+                _my_related_content = info.default_related_content_types
+              end
+              @RelatedContent = _my_related_content
+
+            # ====================================================================================
+            # unsupported parameters, ignore
+            # ====================================================================================
+            else
+              # ignore
+
+          end
+
+
+        end
+
+      end
+    end
+
+    class RetrievalCriteria
+      include JSONable
+      attr_accessor :View, :ResultsPerPage, :PageNumber, :Highlight
+      def initialize(options = {}, info)
+
+        # defaults
+        @View = info.default_result_list_view
+        @ResultsPerPage = info.default_results_per_page
+        @PageNumber = 1
+
+        options.each do |key, value|
+
+          case key
+
+            # ====================================================================================
+            # view
+            # ====================================================================================
+            when :view
+              if info.available_result_list_views.include? value.downcase
+                @View = value.downcase
+              else
+                @View = info.default_result_list_view
+              end
+
+            # ====================================================================================
+            # results per page
+            # ====================================================================================
+            when :results_per_page, 'rows', 'per_page'
+              if value.to_i > info.max_results_per_page
+                @ResultsPerPage = info.max_results_per_page
+              else
+                @ResultsPerPage = value.to_i
+              end
+
+            # ====================================================================================
+            # page number
+            # ====================================================================================
+            when :page_number, 'page'
+              @PageNumber = value.to_i
+              # puts 'NEW PAGE: ' + @PageNumber.inspect
+            # solr starts at page 0
+            when 'start'
+              @PageNumber = value.to_i + 1
+
+            # ====================================================================================
+            # highlight
+            # ====================================================================================
+            when :highlight
+              @Highlight = value ? 'y' : 'n'
+            # solr/blacklight version
+            when 'hl'
+              if value == 'on'
+                @Highlight = 'y'
+              else
+                @Highlight = 'n'
+              end
+
+
+            else
+
+          end
+
+        end
+
+  
+      end
+  
+    end
+
+  end
+end

data/lib/ebsco/eds/record.rb

@@ -0,0 +1,700 @@
+require 'yaml'
+require 'json'
+require 'bibtex'
+
+module EBSCO
+
+  module EDS
+
+    # A single search result
+    class Record
+
+      # Raw record as returned by the \EDS API via search or retrieve
+      attr_reader :record
+
+      # Lookup table of databases that have their labels suppressed in the response.
+      DBS = YAML::load_file(File.join(__dir__, 'settings.yml'))['databases']
+
+      # Creates a search or retrieval result record
+      def initialize(results_record)
+
+        if results_record.key? 'Record'
+          @record = results_record['Record'] # single record returned by retrieve api
+        else
+          @record = results_record  # set of records returned by search api
+        end
+
+        @items = @record.fetch('Items', {})
+
+        @bib_entity = @record.fetch('RecordInfo', {})
+                          .fetch('BibRecord', {})
+                          .fetch('BibEntity', {})
+
+        @bib_relationships = @record.fetch('RecordInfo', {})
+                                 .fetch('BibRecord', {})
+                                 .fetch('BibRelationships', {})
+
+        @bib_part = @record.fetch('RecordInfo', {})
+                          .fetch('BibRecord', {})
+                          .fetch('BibRelationships', {})
+                          .fetch('IsPartOfRelationships', {})[0]
+
+        @bibtex = BibTeX::Entry.new
+      end
+
+      # \Options hash containing accession number and database ID. This can be passed to the retrieve method.
+      def retrieve_options
+        options = {}
+        options['an'] = self.accession_number
+        options['dbid'] = self.database_id
+        options
+      end
+
+      # The accession number.
+      def accession_number
+        header_an
+      end
+
+      # The database ID.
+      def database_id
+        header_db_id
+      end
+
+      # The database name or label.
+      def database_name
+        header_db_label
+      end
+
+      # The access level.
+      def access_level
+        header_access_level
+      end
+
+      # The search relevancy score.
+      def relevancy_score
+        header_score
+      end
+
+      # The title.
+      def title
+        get_item_data_by_name('Title') || bib_title
+      end
+
+      # The source title (e.g., Journal)
+      def source_title
+        bib_source_title || get_item_data_by_name('TitleSource')
+      end
+
+      # Other alternative titles.
+      def other_titles
+        get_item_data_by_name('TitleAlt')
+      end
+
+      # The abstract
+      def abstract
+        get_item_data_by_name('Abstract')
+      end
+
+      # The list of authors
+      def authors
+         bib_authors || get_item_data_by_name('Author')
+      end
+
+      # The author affiliations
+      def author_affiliations
+        get_item_data_by_name('AffiliationAuthor')
+      end
+
+      # The list of subject terms.
+      def subjects
+        bib_subjects || get_item_data_by_name('Subject')
+      end
+
+      # The list of geographic subjects
+      def subjects_geographic
+        get_item_data_by_name('SubjectGeographic')
+      end
+
+      # The list of person subjects
+      def subjects_person
+        get_item_data_by_name('SubjectPerson')
+      end
+
+      # Author supplied keywords
+      def author_supplied_keywords
+        get_item_data_by_label('Author-Supplied Keywords')
+      end
+
+      # Notes
+      def notes
+        get_item_data_by_name('Note')
+      end
+
+      # Languages
+      def languages
+        get_item_data_by_name('Language') || bib_languages
+      end
+
+      # Total number of pages.
+      def page_count
+        bib_page_count
+      end
+
+      # Starting page number.
+      def page_start
+        bib_page_start
+      end
+
+      # Physical description.
+      def physical_description
+        get_item_data_by_name('PhysDesc')
+      end
+
+      # Publication type.
+      def publication_type
+        header_publication_type || get_item_data_by_name('TypePub')
+      end
+
+      # Publication type ID.
+      def publication_type_id
+        header_publication_type_id
+      end
+
+      # Publication date.
+      def publication_date
+        bib_publication_date || get_item_data_by_name('DatePub')
+      end
+
+      # Publication year.
+      def publication_year
+        bib_publication_year || get_item_data_by_name('DatePub')
+      end
+
+      # Publisher information.
+      def publisher_info
+        get_item_data_by_label('Publication Information')
+      end
+
+      # Document type.
+      def document_type
+        get_item_data_by_name('TypeDocument')
+      end
+
+      # DOI identifier.
+      def doi
+        get_item_data_by_name('DOI') || bib_doi
+      end
+
+      # OCLC identifier.
+      def oclc
+        get_item_data_by_label('OCLC')
+      end
+
+      #  Prind ISSN
+      def issn_print
+        get_item_data_by_name('ISSN') || bib_issn_print
+      end
+
+      # List of ISSNs
+      def issns
+        bib_issns
+      end
+
+      # List of ISBNs
+      def isbns
+        bib_isbns | item_related_isbns
+      end
+
+      # Print ISBN
+      def isbn_print
+        bib_isbn_print
+      end
+
+      # Electronic ISBN
+      def isbn_electronic
+        bib_isbn_electronic
+      end
+
+      # Series information.
+      def series
+        get_item_data_by_name('SeriesInfo')
+      end
+
+      # Volume
+      def volume
+        bib_volume
+      end
+
+      # Issue
+      def issue
+        bib_issue
+      end
+
+      # Cover images
+      def covers
+        images
+      end
+
+      # Cover image - thumbnail size link
+      def cover_thumb_url
+        images('thumb').first[:src]
+      end
+
+      # Cover image - medium size link
+      def cover_medium_url
+        images('medium').first[:src]
+      end
+
+      # Word count for fulltext.
+      def fulltext_word_count
+        get_item_data_by_name('FullTextWordCount').to_i
+      end
+
+      # --
+      # ====================================================================================
+      # GENERAL: ResultId, PLink, ImageInfo, CustomLinks, FullText
+      # ====================================================================================
+      # ++
+
+      # Result ID.
+      def result_id
+        @record['ResultId']
+      end
+
+      # EBSCO's persistent link.
+      def plink
+        @record['PLink']
+      end
+
+      # Fulltext.
+      def html_fulltext
+        if @record.fetch('FullText',{}).fetch('Text',{}).fetch('Availability',0) == '1'
+          @record.fetch('FullText',{}).fetch('Text',{})['Value']
+        else
+          nil
+        end
+      end
+
+      # List of cover images.
+      def images (size_requested = 'all')
+        returned_images = []
+        images = @record.fetch('ImageInfo', {})
+        if images.count > 0
+          images.each do |image|
+            if size_requested == image['Size'] || size_requested == 'all'
+              returned_images.push({size: image['Size'], src: image['Target']})
+            end
+          end
+        end
+        returned_images
+      end
+
+      # --
+      # ====================================================================================
+      # LINK HELPERS
+      # ====================================================================================
+      # ++
+
+      # A list of all available links.
+      def all_links
+        self.fulltext_links + self.non_fulltext_links
+      end
+
+      # The first fulltext link.
+      def fulltext_link
+        self.fulltext_links.first || {}
+      end
+
+      # All available fulltext links.
+      def fulltext_links
+
+        links = []
+
+        ebscolinks = @record.fetch('FullText',{}).fetch('Links',{})
+        if ebscolinks.count > 0
+          ebscolinks.each do |ebscolink|
+            if ebscolink['Type'] == 'pdflink'
+              link_label = 'PDF Full Text'
+              link_icon = 'PDF Full Text Icon'
+              link_url = ebscolink['Url'] || 'detail'
+              links.push({url: link_url, label: link_label, icon: link_icon, type: 'pdf'})
+            end
+          end
+        end
+
+        htmlfulltextcheck = @record.fetch('FullText',{}).fetch('Text',{}).fetch('Availability',{})
+        if htmlfulltextcheck == '1'
+          link_url = 'detail'
+          link_label = 'Full Text in Browser'
+          link_icon = 'Full Text in Browser Icon'
+          links.push({url: link_url, label: link_label, icon: link_icon, type: 'html'})
+        end
+
+        if ebscolinks.count > 0
+          ebscolinks.each do |ebscolink|
+            if ebscolink['Type'] == 'ebook-pdf'
+              link_label = 'PDF eBook Full Text'
+              link_icon = 'PDF eBook Full Text Icon'
+              link_url = ebscolink['Url'] || 'detail'
+              links.push({url: link_url, label: link_label, icon: link_icon, type: 'ebook-pdf'})
+            end
+          end
+        end
+
+        if ebscolinks.count > 0
+          ebscolinks.each do |ebscolink|
+            if ebscolink['Type'] == 'ebook-epub'
+              link_label = 'ePub eBook Full Text'
+              link_icon = 'ePub eBook Full Text Icon'
+              link_url = ebscolink['Url'] || 'detail'
+              links.push({url: link_url, label: link_label, icon: link_icon, type: 'ebook-epub'})
+            end
+          end
+        end
+
+        items = @record.fetch('Items',{})
+        if items.count > 0
+          items.each do |item|
+            if item['Group'] == 'Url'
+              if item['Data'].include? 'linkTerm="'
+                link_start = item['Data'].index('linkTerm="')+15
+                link_url = item['Data'][link_start..-1]
+                link_end = link_url.index('"')-1
+                link_url = link_url[0..link_end]
+                link_label_start = item['Data'].index('link>')+8
+                link_label = item['Data'][link_label_start..-1]
+                link_label = link_label.strip
+              else
+                link_url = item['Data']
+                link_label = item['Label']
+              end
+              link_icon = 'Catalog Link Icon'
+              links.push({url: link_url, label: link_label, icon: link_icon, type: 'cataloglink'})
+            end
+          end
+        end
+
+        if ebscolinks.count > 0
+          ebscolinks.each do |ebscolink|
+            if ebscolink['Type'] == 'other'
+              link_label = 'Linked Full Text'
+              link_icon = 'Linked Full Text Icon'
+              link_url = ebscolink['Url'] || 'detail'
+              links.push({url: link_url, label: link_label, icon: link_icon, type: 'smartlinks+'})
+            end
+          end
+        end
+
+        ft_customlinks = @record.fetch('FullText',{}).fetch('CustomLinks',{})
+        if ft_customlinks.count > 0
+          ft_customlinks.each do |ft_customlink|
+            link_url = ft_customlink['Url']
+            link_label = ft_customlink['Text']
+            link_icon = ft_customlink['Icon']
+            links.push({url: link_url, label: link_label, icon: link_icon, type: 'customlink-fulltext'})
+          end
+        end
+
+        links
+      end
+
+      # All available non-fulltext links.
+      def non_fulltext_links
+        links = []
+        other_customlinks = @record.fetch('CustomLinks',{})
+        if other_customlinks.count > 0
+          other_customlinks.each do |other_customlink|
+            link_url = other_customlink['Url']
+            link_label = other_customlink['Text']
+            link_icon = other_customlink['Icon']
+            links.push({url: link_url, label: link_label, icon: link_icon, type: 'customlink-other'})
+          end
+        end
+
+        links
+      end
+      
+      #:nodoc: all
+      # No need to document methods below
+
+      # Experimental bibtex support.
+      def retrieve_bibtex
+
+        @bibtex.key = self.accession_number
+        @bibtex.title = self.title
+        if self.bib_authors_list.length > 0
+          @bibtex.author = self.bib_authors_list.join(' and ').chomp
+        end
+        @bibtex.year = self.publication_year.to_i
+
+        # bibtex type
+        _type = self.publication_type
+        case _type
+          when 'Academic Journal'
+            @bibtex.type = :article
+            @bibtex.journal = self.source_title
+            if self.issue
+              @bibtex.issue = self.issue
+            end
+            if self.volume
+              @bibtex.number = self.volume
+            end
+            if self.page_start && self.page_count
+              @bibtex.pages = self.page_start + '-' + (self.page_start.to_i + self.page_count.to_i-1).to_s
+            end
+            if self.bib_publication_month
+              @bibtex.month = self.bib_publication_month.to_i
+            end
+          when 'Conference'
+            @bibtex.type = :conference
+            @bibtex.booktitle = self.source_title
+            if self.issue
+              @bibtex.issue = self.issue
+            end
+            if self.volume
+              @bibtex.number = self.volume
+            end
+            if self.page_start && self.page_count
+              @bibtex.pages = self.page_start + '-' + (self.page_start.to_i + self.page_count.to_i-1).to_s
+            end
+            if self.bib_publication_month
+              @bibtex.month = self.bib_publication_month.to_i
+            end
+            if self.publisher_info
+              @bibtex.publisher = self.publisher_info
+            end
+            if self.series
+              @bibtex.series = self.series
+            end
+          when 'Book', 'eBook'
+            @bibtex.type = :book
+            if self.publisher_info
+              @bibtex.publisher = self.publisher_info
+            end
+            if self.series
+              @bibtex.series = self.series
+            end
+            if self.bib_publication_month
+              @bibtex.month = self.bib_publication_month.to_i
+            end
+            if self.isbns
+              @bibtex.isbn = self.isbns.first
+            end
+          else
+            @bibtex.type = :other
+        end
+        @bibtex
+      end
+
+      # ====================================================================================
+      # HEADER: DbId, DbLabel, An, PubType, PubTypeId, AccessLevel
+      # ====================================================================================
+
+      def header_an
+        @record['Header']['An'].to_s
+      end
+
+      def header_db_id
+        @record['Header']['DbId'].to_s
+      end
+
+      # only available from search not retrieve
+      def header_score
+        @record['Header']['RelevancyScore']
+      end
+
+      def header_publication_type
+        @record['Header']['PubType']
+      end
+
+      def header_publication_type_id
+        @record['Header']['PubTypeId']
+      end
+
+      def header_db_label
+        DBS[self.database_id.upcase] || @record['Header']['DbLabel']
+      end
+
+      # not sure the rules for when this appears or not - RecordInfo.AccessInfo?
+      def header_access_level
+        @record['Header']['AccessLevel']
+      end
+
+      # ====================================================================================
+      # ITEMS
+      # ====================================================================================
+
+      # look up by 'Name' and return 'Data'
+      def get_item_data_by_name(name)
+        _item_property = @items.find{|item| item['Name'] == name}
+        if _item_property.nil?
+          nil
+        else
+          _item_property['Data']
+        end
+      end
+
+      # look up by 'Label' and return 'Data'
+      def get_item_data_by_label(label)
+        _item_property = @items.find{|item| item['Label'] == label}
+        if _item_property.nil?
+          nil
+        else
+          _item_property['Data']
+        end
+      end
+
+      def item_related_isbns
+        get_item_data_by_label('Related ISBNs').split(' ').map!{|item| item.gsub(/\.$/, '')}
+      end
+
+      # ====================================================================================
+      # BIB ENTITY
+      # ====================================================================================
+
+      def bib_title
+        @bib_entity.fetch('Titles', {}).find{|item| item['Type'] == 'main'}['TitleFull']
+      end
+
+      def bib_authors
+        @bib_relationships.deep_find('NameFull').join('; ')
+      end
+
+      def bib_authors_list
+        @bib_relationships.deep_find('NameFull')
+      end
+
+      def bib_subjects
+        @bib_entity.deep_find('SubjectFull')
+      end
+
+      def bib_languages
+        @bib_entity.fetch('Languages', {}).map{|lang| lang['Text']}
+      end
+
+      # def bib_pages
+      #   @bib_entity.fetch('PhysicalDescription', {})['Pagination']
+      # end
+
+      def bib_page_count
+        @bib_entity.deep_find('PageCount').first
+      end
+
+      def bib_page_start
+        @bib_entity.deep_find('StartPage').first
+      end
+
+      def bib_doi
+        @bib_entity.fetch('Identifiers',{}).find{|item| item['Type'] == 'doi'}['Value']
+      end
+
+      # ====================================================================================
+      # BIB - IS PART OF (journal, book)
+      # ====================================================================================
+
+      def bib_source_title
+        @bib_part.fetch('BibEntity',{}).fetch('Titles',{}).find{|item| item['Type'] == 'main'}['TitleFull']
+      end
+
+      def bib_issn_print
+        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'issn-print'}['Value']
+      end
+
+      def bib_issn_electronic
+        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'issn-electronic'}['Value']
+      end
+
+      def bib_issns
+        issns = []
+        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).each do |id|
+          if id['Type'].include?('issn') && !id['Type'].include?('locals')
+            issns.push(id['Value'])
+          end
+        end
+        issns
+      end
+
+      def bib_isbn_print
+        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'isbn-print'}['Value']
+      end
+
+      def bib_isbn_electronic
+        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).find{|item| item['Type'] == 'isbn-electronic'}['Value']
+      end
+
+      # todo: make this generic and take an optional parameter for type
+      def bib_isbns
+        isbns = []
+        @bib_part.fetch('BibEntity',{}).fetch('Identifiers',{}).each do |id|
+          if id['Type'].include?('isbn') && !id['Type'].include?('locals')
+            isbns.push(id['Value'])
+          end
+        end
+        isbns
+      end
+
+      def bib_publication_date
+        _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
+        if _date
+          if _date.has_key?('Y') && _date.has_key?('M') && _date.has_key?('D')
+            _date['Y'] + '-' + _date['M'] + '-' + _date['D']
+          else
+            nil
+          end
+        else
+          nil
+        end
+      end
+
+      def bib_publication_year
+        _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
+        if _date
+          _date.has_key?('Y') ? _date['Y'] : nil
+        else
+          nil
+        end
+      end
+
+      def bib_publication_month
+        _date = @bib_part.fetch('BibEntity',{}).fetch('Dates',{}).find{|item| item['Type'] == 'published'}
+        if _date
+          _date.has_key?('M') ? _date['M'] : nil
+        else
+          nil
+        end
+      end
+
+      def bib_volume
+        @bib_part.fetch('BibEntity',{}).fetch('Numbering',{}).find{|item| item['Type'] == 'volume'}['Value']
+      end
+
+      def bib_issue
+        @bib_part.fetch('BibEntity',{}).fetch('Numbering',{}).find{|item| item['Type'] == 'issue'}['Value']
+      end
+
+      def to_hash
+        hash = {}
+        hash['id'] = database_id + '-' + accession_number
+        hash['title_display'] = title.gsub('<highlight>', '').gsub('</highlight>', '')
+        hash['pub_date'] = publication_year
+        hash
+      end
+
+    end # Class Record
+  end # Module EDS
+end # Module EBSCO
+
+
+# monkey patches
+class Hash
+  def deep_find(key, object=self, found=[])
+    if object.respond_to?(:key?) && object.key?(key)
+      found << object[key]
+    end
+    if object.is_a? Enumerable
+      found << object.collect { |*a| deep_find(key, a.last) }
+    end
+    found.flatten.compact
+  end
+end
+