im_onix 1.0.2

data/lib/onix/code.rb

@@ -0,0 +1,543 @@
+# -*- encoding : utf-8 -*-
+require 'yaml'
+
+module ONIX
+  module CodeHelper
+    def parse(n)
+      @code=n.text
+      @human=self.class.hash[n.text]
+    end
+
+    # Humanized string code
+    def human
+      @human
+    end
+
+    # ONIX code
+    def onix
+      @code
+    end
+  end
+
+  class Code < Subset
+    # code as defined in ONIX documentation codelist
+    attr_accessor :code
+    # humanized string (eg: "Digital watermarking" become DigitalWatermarking, "PDF" become Pdf, "BISAC Subject Heading" become BisacSubjectHeading, etc)
+    attr_accessor :human
+
+    include CodeHelper
+
+    # create Code from string ONIX code
+    def self.from_code(code)
+      o=self.new
+      o.code=code
+      o.human=self.hash[code]
+      o
+    end
+
+    # create Code from humanized string code
+    def self.from_human(human)
+      o=self.new
+      o.human=human
+      o.code=self.hash.key(human)
+      o
+    end
+
+    private
+    def self.hash
+      {}
+    end
+
+  end
+
+  class CodeFromYaml < Code
+    def self.hash
+      @hash||=YAML.load(File.open(File.dirname(__FILE__) + "/../../data/codelists/codelist-#{self.code_ident}.yml"))[:codelist]
+    end
+
+    def self.list
+      self.hash.to_a.map{|h| h.first}
+    end
+
+    def self.code_ident
+      nil
+    end
+  end
+
+  class CodeFromYamlWithMime < CodeFromYaml
+    # main formats
+    def mimetype
+      case self.human
+        when "Epub"
+          "application/epub"
+        when "Pdf"
+          "application/pdf"
+        when "Mobipocket"
+          "application/x-mobipocket-ebook"
+        when "Gif"
+          "image/gif"
+        when "Jpeg"
+          "image/jpeg"
+        when "Png"
+          "image/png"
+      end
+    end
+  end
+
+  class NotificationType < CodeFromYaml
+    private
+    def self.code_ident
+      1
+    end
+  end
+
+  class ProductComposition < CodeFromYaml
+    private
+    def self.code_ident
+      2
+    end
+  end
+
+  class ProductIDType < CodeFromYaml
+    private
+    def self.code_ident
+      5
+    end
+  end
+
+  class CollectionIDType < CodeFromYaml
+    private
+    def self.code_ident
+      13
+    end
+  end
+
+  class TitleType < CodeFromYaml
+    private
+    def self.code_ident
+      15
+    end
+  end
+
+  class WorkIDType < CodeFromYaml
+    private
+    def self.code_ident
+      16
+    end
+  end
+
+  class ContributorRole < CodeFromYaml
+    private
+    def self.code_ident
+      17
+    end
+  end
+
+  class EditionType < CodeFromYaml
+    private
+    def self.code_ident
+      21
+    end
+  end
+
+  class LanguageRole < CodeFromYaml
+    private
+    def self.code_ident
+      22
+    end
+  end
+
+  class ExtentType < CodeFromYaml
+    private
+    def self.code_ident
+      23
+    end
+  end
+
+  class ExtentUnit < CodeFromYaml
+    private
+    def self.code_ident
+      24
+    end
+  end
+
+  class SubjectSchemeIdentifier < CodeFromYaml
+    private
+    def self.code_ident
+      27
+    end
+  end
+
+  class AudienceCode < CodeFromYaml
+    private
+    def self.code_ident
+      28
+    end
+  end
+
+  class IDType < CodeFromYaml
+    private
+    def self.code_ident
+      44
+    end
+  end
+
+  class SenderIDType < IDType
+  end
+
+  class AddresseeIDType < IDType
+  end
+
+  class PublisherIDType < IDType
+  end
+
+  class ImprintIDType < IDType
+  end
+
+  class NameIDType < IDType
+  end
+
+  class PublishingRole < CodeFromYaml
+    private
+    def self.code_ident
+      45
+    end
+  end
+
+  class SalesRightsType < CodeFromYaml
+    private
+    def self.code_ident
+      46
+    end
+  end
+
+  class RegionCode < CodeFromYaml
+    private
+    def self.code_ident
+      49
+    end
+  end
+
+  class ProductRelationCode < CodeFromYaml
+    private
+    def self.code_ident
+      51
+    end
+  end
+
+  class DateFormat < CodeFromYaml
+    private
+    def self.code_ident
+      55
+    end
+  end
+
+  class UnpricedItemType < CodeFromYaml
+    private
+    def self.code_ident
+      57
+    end
+  end
+
+  class PriceType < CodeFromYaml
+    private
+    def self.code_ident
+      58
+    end
+  end
+
+  class PriceQualifier < CodeFromYaml
+    private
+    def self.code_ident
+      59
+    end
+  end
+
+  class PriceStatus < CodeFromYaml
+    private
+    def self.code_ident
+      61
+    end
+  end
+
+  class TaxRateCode < CodeFromYaml
+    private
+    def self.code_ident
+      62
+    end
+  end
+
+  class PublishingStatus < CodeFromYaml
+    private
+    def self.code_ident
+      64
+    end
+  end
+
+  class ProductAvailability < CodeFromYaml
+    private
+    def self.code_ident
+      65
+    end
+  end
+
+  class MarketPublishingStatus < CodeFromYaml
+    private
+    def self.code_ident
+      68
+    end
+  end
+
+  class AgentRole < CodeFromYaml
+    private
+    def self.code_ident
+      69
+    end
+  end
+
+  class SalesRestrictionType < CodeFromYaml
+    private
+    def self.code_ident
+      71
+    end
+  end
+
+  class WebsiteRole < CodeFromYaml
+    private
+    def self.code_ident
+      73
+    end
+  end
+
+  class LanguageCode < CodeFromYaml
+    private
+    def self.code_ident
+      74
+    end
+  end
+
+  class ProductFormFeatureType < CodeFromYaml
+    private
+    def self.code_ident
+      79
+    end
+  end
+
+  class ProductContentType < CodeFromYaml
+    private
+    def self.code_ident
+      81
+    end
+  end
+
+  class CountryCode < CodeFromYaml
+    private
+    def self.code_ident
+      91
+    end
+  end
+
+  class SupplierIDType < CodeFromYaml
+    private
+    def self.code_ident
+      92
+    end
+  end
+
+  class AgentIDType < CodeFromYaml
+    private
+    def self.code_ident
+      92
+    end
+  end
+
+  class SupplierRole < CodeFromYaml
+    private
+    def self.code_ident
+      93
+    end
+  end
+
+  class SalesOutletIDType < CodeFromYaml
+    private
+    def self.code_ident
+      102
+    end
+  end
+
+  class EpubTechnicalProtection < CodeFromYaml
+    private
+    def self.code_ident
+      144
+    end
+  end
+
+  class EpubUsageType < CodeFromYaml
+    private
+    def self.code_ident
+      145
+    end
+  end
+
+  class EpubUsageStatus < CodeFromYaml
+    private
+    def self.code_ident
+      146
+    end
+  end
+
+  class EpubUsageUnit < CodeFromYaml
+    private
+    def self.code_ident
+      147
+    end
+  end
+
+  class CollectionType < CodeFromYaml
+    private
+    def self.code_ident
+      148
+    end
+  end
+
+  class CollectionSequenceType < CodeFromYaml
+    private
+    def self.code_ident
+      197
+    end
+  end
+
+  class TitleElementLevel < CodeFromYaml
+    private
+    def self.code_ident
+      149
+    end
+  end
+
+  class ProductForm < CodeFromYaml
+    private
+    def self.code_ident
+      150
+    end
+  end
+
+  class ContributorPlaceRelator < CodeFromYaml
+    private
+    def self.code_ident
+      151
+    end
+  end
+
+  class TextType < CodeFromYaml
+    private
+    def self.code_ident
+      153
+    end
+  end
+
+  class ContentAudience < CodeFromYaml
+    private
+    def self.code_ident
+      154
+    end
+  end
+
+  class ContentDateRole < CodeFromYaml
+    private
+    def self.code_ident
+      155
+    end
+  end
+
+  class ResourceContentType < CodeFromYaml
+    private
+    def self.code_ident
+      158
+    end
+  end
+
+  class ResourceMode < CodeFromYaml
+    private
+    def self.code_ident
+      159
+    end
+  end
+
+  class ResourceFeatureType < CodeFromYaml
+    private
+    def self.code_ident
+      160
+    end
+  end
+
+  class ResourceForm < CodeFromYaml
+    private
+    def self.code_ident
+      161
+    end
+  end
+
+  class ResourceVersionFeatureType < CodeFromYaml
+    private
+    def self.code_ident
+      162
+    end
+  end
+
+  class MarketDateRole < CodeFromYaml
+    private
+    def self.code_ident
+      163
+    end
+  end
+
+  class PublishingDateRole < CodeFromYaml
+    private
+    def self.code_ident
+      163
+    end
+  end
+
+  class WorkRelationCode < CodeFromYaml
+    private
+    def self.code_ident
+      164
+    end
+  end
+
+  class SupplyDateRole < CodeFromYaml
+    private
+    def self.code_ident
+      166
+    end
+  end
+
+  class TaxType < CodeFromYaml
+    private
+    def self.code_ident
+      171
+    end
+  end
+
+  class PriceDateRole < CodeFromYaml
+    private
+    def self.code_ident
+      173
+    end
+  end
+
+  class ProductFormDetail < CodeFromYamlWithMime
+    private
+    def self.code_ident
+      175
+    end
+  end
+
+  class SupportingResourceFileFormat < CodeFromYamlWithMime
+    private
+    def self.code_ident
+      178
+    end
+  end
+
+end

data/lib/onix/collateral_detail.rb

@@ -0,0 +1,94 @@
+module ONIX
+  class TextContent < SubsetDSL
+    element "TextType", :subset
+    element "ContentAudience", :subset
+    element "Text", :text
+    element "TextAuthor", :text
+    element "SourceTitle", :text
+
+    scope :description, lambda { human_code_match(:text_type, "Description")}
+    scope :short_description, lambda { human_code_match(:text_type, "ShortDescriptionannotation")}
+
+    # shortcuts
+    def type
+      @text_type
+    end
+  end
+
+  class CollateralDetail < SubsetDSL
+    elements "TextContent", :subset
+    elements "SupportingResource", :subset
+
+    def description
+      desc_contents=@text_contents.description + @text_contents.short_description
+      if desc_contents.length > 0
+        desc_contents.first.text
+      else
+        nil
+      end
+    end
+
+    # largest frontcover if multiple
+    def frontcover_resource
+      fc=@supporting_resources.front_cover
+      if fc.length > 0
+        if fc.length > 1
+          best_found=fc.select{|c| c.versions.last and c.versions.last.image_width}.sort { |c1, c2| c2.versions.last.image_width <=> c1.versions.last.image_width }.first
+          if best_found
+            # we take larger one
+            best_found.versions.last
+          else
+            # we try first that is not gif
+            fc.select{|sr| not sr.versions.last.file_format=="Gif"}.first.versions.last
+          end
+        else
+          fc.first.versions.last
+        end
+      end
+    end
+
+    def frontcover_url
+      if self.frontcover_resource
+        self.frontcover_resource.links.first.strip
+      end
+    end
+
+    def frontcover_last_updated
+      if self.frontcover_resource
+          self.frontcover_resource.last_updated
+      end
+    end
+
+    def frontcover_mimetype
+      if self.frontcover_resource
+        self.frontcover_resource.file_mimetype
+      end
+    end
+
+    def epub_sample_resource
+      es=@supporting_resources.sample_content.select{|sr| sr.versions.last and sr.versions.last.file_format=="Epub"}.first
+      if es
+        es.versions.last
+      end
+    end
+
+    def epub_sample_url
+      if self.epub_sample_resource
+        self.epub_sample_resource.links.first.strip
+      end
+    end
+
+    def epub_sample_last_updated
+      if self.epub_sample_resource
+        self.epub_sample_resource.last_updated
+      end
+    end
+
+    def epub_sample_mimetype
+      if self.epub_sample_resource
+        self.epub_sample_resource.file_mimetype
+      end
+    end
+
+  end
+end

data/lib/onix/contributor.rb

@@ -0,0 +1,87 @@
+require 'onix/subset'
+require 'onix/website'
+
+module ONIX
+  class Contributor < SubsetDSL
+    element "SequenceNumber", :integer
+    element "ContributorRole", :subset
+    elements "NameIdentifier", :subset
+
+    element "PersonName", :text
+    element "PersonNameInverted", :text
+
+    element "NamesBeforeKey", :text
+    element "KeyNames", :text
+
+    element "BiographicalNote", :text
+    elements "Website", :subset
+    element "ContributorPlace", :subset
+
+    def role
+      @contributor_role
+    end
+
+    def identifiers
+      @name_identifiers
+    end
+
+    def place
+      @contributor_place
+    end
+
+    def name_before_key
+      @names_before_key
+    end
+
+    # :category: High level
+    # flatten person name (firstname lastname)
+    def name
+      if @person_name
+        @person_name
+      else
+        if @key_names
+          if @names_before_key
+            "#{@names_before_key} #{@key_names}"
+          else
+            @key_names
+          end
+        end
+      end
+    end
+
+    # :category: High level
+    # inverted flatten person name
+    def inverted_name
+      @person_name_inverted
+    end
+
+    # :category: High level
+    # biography string with HTML
+    def biography
+      @biographical_note
+    end
+
+    # :category: High level
+    # raw biography string without HTML
+    def raw_biography
+      if self.biography
+        Helper.strip_html(self.biography).gsub(/\s+/, " ")
+      else
+        nil
+      end
+    end
+  end
+
+  class ContributorPlace < SubsetDSL
+    element "ContributorPlaceRelator", :subset
+    element "CountryCode", :subset
+
+    def relator
+      @contributor_place_relator
+    end
+
+    def country_code
+      @country_code.code
+    end
+  end
+end