im_onix 1.1.1 → 1.3.0

data/lib/onix/onix_message.rb

@@ -4,6 +4,7 @@ require 'time'
 require 'onix/subset'
 require 'onix/helper'
 require 'onix/code'
+require 'onix/header'
 require 'onix/sender'
 require 'onix/addressee'
 require 'onix/product'
@@ -11,11 +12,22 @@ require 'onix/product'
 require 'onix/onix21'
 
 module ONIX
-  class ONIXMessage < Subset
-    attr_accessor :sender, :adressee, :sent_date_time,
-                  :default_language_of_text, :default_currency_code,
-                  :products,
-                  :release
+  class ONIXMessage < SubsetDSL
+    extend Forwardable
+    attr_accessor :release
+
+    element "Header", :subset, :cardinality => 1
+    elements "Product", :subset, :cardinality => 0..n
+
+    def_delegator :header, :sender
+    def_delegator :header, :addressee
+    def_delegator :header, :default_language_of_text
+    def_delegator :header, :default_currency_code
+    def_delegator :header, :sent_date_time
+
+    def header
+      @header || Header.new
+    end
 
     def initialize
       @products = []
@@ -53,6 +65,8 @@ module ONIX
         product.identifiers.each do |ident|
           @vault[ident.uniq_id] = product
         end
+        product.default_language_of_text = self.default_language_of_text if @header
+        product.default_currency_code = self.default_currency_code if @header
       end
 
       @products.each do |product|
@@ -75,6 +89,7 @@ module ONIX
     end
 
     # open with arg detection
+    # @param [String, File] arg
     def open(arg, force_encoding = nil)
       data = ONIX::Helper.arg_to_data(arg)
 
@@ -90,6 +105,7 @@ module ONIX
     end
 
     # release as an integer eg: 210, 300, 301
+    # @return [Number]
     def version
       if @release
         @release.gsub(/\./, "").to_i * 10 ** (3 - @release.scan(".").length - 1)
@@ -97,6 +113,7 @@ module ONIX
     end
 
     # detect ONIX version from XML tags
+    # @return [String]
     def detect_release(element)
       if element
         return "3.0" if element.search("//DescriptiveDetail").length > 0
@@ -117,57 +134,32 @@ module ONIX
       end
     end
 
+    def product_klass
+      self.version >= 300 ? Product : ONIX21::Product
+    end
+
+    def get_class(name)
+      if name == "Product"
+        self.product_klass
+      else
+        super(name)
+      end
+    end
+
     # parse filename or file
+    # @param [String, File] arg
     def parse(arg, force_encoding = nil, force_release = nil)
-      xml = open(arg, force_encoding)
       @products = []
+      xml = open(arg, force_encoding)
       root = xml.root
       set_release_from_xml(root, force_release)
       case root
-      when tag_match("ONIXMessage")
-        root.elements.each do |e|
-          case e
-          when tag_match("Header")
-            e.elements.each do |t|
-              case t
-              when tag_match("Sender")
-                @sender = Sender.parse(t)
-              when tag_match("Addressee")
-                @addressee = Addressee.parse(t)
-              when tag_match("SentDateTime")
-                tm = t.text
-                @sent_date_time = Time.strptime(tm, "%Y%m%dT%H%M%S") rescue Time.strptime(tm, "%Y%m%dT%H%M") rescue Time.strptime(tm, "%Y%m%d") rescue nil
-              when tag_match("DefaultLanguageOfText")
-                @default_language_of_text = LanguageCode.parse(t)
-              when tag_match("DefaultCurrencyCode")
-                @default_currency_code = t.text
-              else
-                unsupported(t)
-              end
-            end
-          when tag_match("Product")
-            product = nil
-            if self.version >= 300
-              product = Product.parse(e)
-            else
-              product = ONIX21::Product.parse(e)
-            end
-            product.default_language_of_text = @default_language_of_text
-            product.default_currency_code = @default_currency_code
-            @products << product
-          end
-        end
       when tag_match("Product")
-        product = nil
-        if self.version >= 300
-          product = Product.parse(root)
-        else
-          product = ONIX21::Product.parse(root)
-        end
-        product.default_language_of_text = @default_language_of_text
-        product.default_currency_code = @default_currency_code
-        @products << product
+        @products << self.product_klass.parse(root)
+      else # ONIXMessage
+        super(root)
       end
+
       init_vault
     end
   end

data/lib/onix/page_run.rb

@@ -0,0 +1,6 @@
+module ONIX
+  class PageRun < SubsetDSL
+    element "FirstPageNumber", :text, :cardinality => 1
+    element "LastPageNumber", :text, :cardinality => 0..1
+  end
+end

data/lib/onix/price.rb

@@ -1,23 +1,56 @@
+require 'onix/date'
 require 'onix/tax'
 require 'onix/discount_coded'
-require 'onix/date'
+require 'onix/discount'
+require 'onix/epub_license'
+require 'onix/comparison_product_price'
 
 module ONIX
   class Price < SubsetDSL
-    element "PriceType", :subset, :shortcut => :type
-    element "PriceQualifier", :subset, :shortcut => :qualifier
-    element "DiscountCoded", :subset, :shortcut => :discount
+    # elements "PriceIdentifier", :subset, :cardinality => 0..n
+
+
+    element "PriceType", :subset, :shortcut => :type, :cardinality => 0..1
+    element "PriceQualifier", :subset, :shortcut => :qualifier, :cardinality => 0..1
+    elements "EpubTechnicalProtection", :subset, :cardinality => 0..n
+
+    # elements "PriceConstraint", :subset, :cardinality => 0..n
+
+
+    element "EpubLicense", :subset, :cardinality => 0..1
+    element "PriceTypeDescription", :text, :cardinality => 0..n
+
+    # element "PricePer", :subset, :cardinality => 0..1
+    # elements "PriceCondition", :subset, :cardinality => 0..n
+    # element "MinimumOrderQuantity", :integer, :cardinality => 0..1
+    # elements "BatchBonus", :subset, :cardinality => 0..n
+
+
+    elements "DiscountCoded", :subset, :cardinality => 0..n
+    elements "Discount", :subset, :cardinality => 0..n
     element "PriceStatus", :subset
-    elements "PriceDate", :subset, :shortcut => :dates
     element "PriceAmount", :float,
             {
-                :shortcut => :amount,
-                :parse_lambda => lambda { |v| (v * 100).round },
-                :serialize_lambda => lambda { |v| v / 100.0 }
+              :shortcut => :amount,
+              :parse_lambda => lambda { |v| (v * 100).round },
+              :serialize_lambda => lambda { |v| format("%.2f", v / 100.0) },
+              :cardinality => 0..1
             }
-    element "Tax", :subset
-    element "CurrencyCode", :text, :shortcut => :currency
-    element "Territory", :subset
+    element "Tax", :subset, :cardinality => 0..n
+    element "TaxExempt", :bool, :cardinality => 0..1
+    element "UnpricedItemType", :subset, :cardinality => 0..1
+    element "CurrencyCode", :text, :shortcut => :currency, :cardinality => 0..1
+    element "Territory", :subset, :cardinality => 0..1
+    elements "ComparisonProductPrice", :subset, :cardinality => 0..n
+    elements "PriceDate", :subset, :shortcut => :dates, :cardinality => 0..n
+    element "PrintedOnProduct", :subset, :cardinality => 0..1
+    element "PositionOnProduct", :subset, :cardinality => 0..1
+
+    # FIXME discount_coded != discount
+    # @return [DiscountCoded]
+    def discount
+      self.discount_codeds.first
+    end
 
     # @!group High level
 

data/lib/onix/prize.rb

@@ -0,0 +1,11 @@
+module ONIX
+  class Prize < SubsetDSL
+    elements "PrizeName", :text, :cardinality => 1..n
+    element "PrizeYear", :text, :cardinality => 0..1
+    element "PrizeCountry", :subset, :klass => "CountryCode", :cardinality => 0..1
+    element "PrizeRegion", :subset, :klass => "RegionCode", :cardinality => 0..1
+    element "PrizeCode", :subset, :cardinality => 0..1
+    elements "PrizeStatement", :text, :cardinality => 0..n
+    elements "PrizeJury", :text, :cardinality => 0..n
+  end
+end

data/lib/onix/product.rb

@@ -2,33 +2,45 @@ require 'forwardable'
 require 'onix/helper'
 require 'onix/code'
 require 'onix/entity'
+require 'onix/identifier'
+require 'onix/barcode'
 require 'onix/descriptive_detail'
 require 'onix/publishing_detail'
 require 'onix/collateral_detail'
 require 'onix/related_material'
 require 'onix/supporting_resource'
 require 'onix/product_supply'
+require 'onix/content_detail'
 require 'onix/territory'
 require 'onix/error'
-require 'onix/product_supplies_extractor'
+require 'onix/product_supplies_methods'
 
 module ONIX
   class Product < SubsetDSL
     extend Forwardable
-    include EanMethods
-    include IsbnMethods
-    include ProprietaryIdMethods
-    include ProductSuppliesExtractor
-
-    element "RecordReference", :text
-    element "NotificationType", :subset
-    element "RecordSourceName", :text
-    elements "ProductIdentifier", :subset, :shortcut => :identifiers
-    element "DescriptiveDetail", :subset
-    element "CollateralDetail", :subset
-    element "PublishingDetail", :subset
-    element "RelatedMaterial", :subset
-    elements "ProductSupply", :subset
+    include IdentifiersMethods::Ean
+    include IdentifiersMethods::Isbn
+    include IdentifiersMethods::ProprietaryId
+    include ProductSuppliesMethods
+
+    element "RecordReference", :text, :cardinality => 1
+    element "NotificationType", :subset, :cardinality => 1
+    elements "DeletionText", :text, :cardinality => 0..n
+    element "RecordSourceType", :subset, :cardinality => 0..1
+    elements "RecordSourceIdentifier", :subset, :cardinality => 0..n
+    element "RecordSourceName", :text, :cardinality => 0..1
+    elements "ProductIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
+    elements "Barcode", :subset, :cardinality => 0..n
+    element "DescriptiveDetail", :subset, :cardinality => 0..1
+    element "CollateralDetail", :subset, :cardinality => 0..1
+
+    # element "PromotionDetail", :subset, :cardinality => 0..1
+
+
+    element "ContentDetail", :subset, :cardinality => 0..1
+    element "PublishingDetail", :subset, :cardinality => 0..1
+    element "RelatedMaterial", :subset, :cardinality => 0..1
+    elements "ProductSupply", :subset, :cardinality => 0..n
 
     # default LanguageCode from ONIXMessage
     attr_accessor :default_language_of_text
@@ -91,7 +103,23 @@ module ONIX
     def_delegator :publishing_detail, :imprint
     def_delegator :publishing_detail, :publisher
 
+    # @return [CollateralDetail]
+    def collateral_detail
+      @collateral_detail || CollateralDetail.new
+    end
+
+    # @return [DescriptiveDetail]
+    def descriptive_detail
+      @descriptive_detail || DescriptiveDetail.new
+    end
+
+    # @return [PublishingDetail]
+    def publishing_detail
+      @publishing_detail || PublishingDetail.new
+    end
+
     # product LanguageCode of text
+    # @return [String]
     def language_of_text
       @descriptive_detail.language_of_text || @default_language_of_text
     end
@@ -274,7 +302,7 @@ module ONIX
     def excerpts
       return [] unless @collateral_detail && @collateral_detail.supporting_resources
 
-      @collateral_detail.supporting_resources.sample_content.human_code_match(:resource_mode, ["Text", "Multimode"]).map do |resource|
+      @collateral_detail.supporting_resources.sample_content.human_code_match(:resource_mode, ["Text", "MultiMode"]).map do |resource|
         {
             :url => resource.versions.last.links.first.strip,
             :form => resource.versions.last.form.human,
@@ -328,7 +356,7 @@ module ONIX
                 (!sales_restriction.end_date or sales_restriction.end_date >= Date.today)
           }.map { |sale_right|
             sale_right.sales_outlets.select { |sale_outlet|
-              sale_outlet.identifier and sale_outlet.identifier.type.human == "OnixSalesOutletIdCode" }.map { |sale_outlet|
+              sale_outlet.identifier and sale_outlet.identifier.type.human == "OnixRetailSalesOutletIdCode" }.map { |sale_outlet|
               sale_outlet.identifier.value
             }
           }

data/lib/onix/product_classification.rb

@@ -0,0 +1,8 @@
+module ONIX
+  class ProductClassification < SubsetDSL
+    element "ProductClassificationType", :subset, :cardinality => 1
+    element "ProductClassificationTypeName", :text, :cardinality => 0..1
+    element "ProductClassificationCode", :text, :cardinality => 1
+    element "Percent", :text, :cardinality => 0..1
+  end
+end

data/lib/onix/product_contact.rb

@@ -0,0 +1,11 @@
+require 'onix/identifier'
+
+module ONIX
+  class ProductContact < SubsetDSL
+    element "ProductContactRole", :subset, :cardinality => 1
+    elements "ProductContactIdentifier", :subset, :cardinality => 0..n
+    element "ProductContactName", :text, :cardinality => 0..1
+    element "ContactName", :text, :cardinality => 0..1
+    element "EmailAddress", :text, :cardinality => 0..1
+  end
+end

data/lib/onix/product_part.rb

@@ -1,21 +1,36 @@
 module ONIX
   # product part use full Product to provide file protection and file size
   class ProductPart < SubsetDSL
-    include EanMethods
-    include ProprietaryIdMethods
+    include IdentifiersMethods::Ean
+    include IdentifiersMethods::ProprietaryId
 
-    elements "ProductIdentifier", :subset, :shortcut => :identifiers
-    element "ProductForm", :subset, :shortcut => :form
-    element "ProductFormDescription", :text, :shortcut => :file_description
-    elements "ProductFormDetail", :subset, :shortcut => :form_details
-    elements "ProductContentType", :subset, :shortcut => :content_types
-    element "NumberOfCopies", :integer
+    element "PrimaryPart", :bool, :cardinality => 0..1
+    elements "ProductIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
+    element "ProductForm", :subset, :shortcut => :form, :cardinality => 1
+    elements "ProductFormDetail", :subset, :shortcut => :form_details, :cardinality => 0..n
+    elements "ProductFormFeature", :subset, :cardinality => 0..n
+
+    # element "ProductPackaging", :subset, :cardinality => 0..1
+
+
+    elements "ProductFormDescription", :text, :shortcut => :file_description, :cardinality => 0..n
+    elements "ProductContentType", :subset, :shortcut => :content_types, :cardinality => 0..n
+    elements "Measure", :subset, :cardinality => 0..n
+    element "NumberOfItemsOfThisForm", :integer, :cardinality => 0..1
+    element "NumberOfCopies", :integer, :cardinality => 0..1
+    element "CountryOfManufacture", :subset, :cardinality => 0..1
 
     def file_formats
       @product_form_details.select { |fd| fd.code =~ /^E1.*/ }
     end
 
+    # @return [ProductFormDescription]
+    def product_form_description
+      product_form_descriptions.first
+    end
+
     # full Product if referenced in ONIXMessage
+    # @return [Product]
     attr_accessor :product
 
     # this ProductPart is part of Product
@@ -47,8 +62,8 @@ module ONIX
     # raw part file description string without HTML
     # @return [String]
     def raw_file_description
-      if @product_form_description
-        Helper.strip_html(@product_form_description).gsub(/\s+/, " ").strip
+      if product_form_description
+        Helper.strip_html(product_form_description).gsub(/\s+/, " ").strip
       end
     end
 

data/lib/onix/{product_supplies_extractor.rb → product_supplies_methods.rb}

@@ -1,6 +1,6 @@
 module ONIX
   # flattened supplies extractor
-  module ProductSuppliesExtractor
+  module ProductSuppliesMethods
     # class must define a product_supplies returning an Array of objects responding to :
     # - availability_date (Date)
     # - countries (country code Array)
@@ -112,7 +112,7 @@ module ONIX
 
       # merge by territories
       grouped_territories_supplies = {}
-      grouped_supplies.each do |ksup, supply|
+      grouped_supplies.values.each do |supply|
         fsupply = supply.first
         pr_key = "#{fsupply[:available]}_#{fsupply[:including_tax]}_#{fsupply[:currency]}"
         supply.each do |s|
@@ -124,7 +124,7 @@ module ONIX
 
       supplies = []
 
-      grouped_territories_supplies.each do |ksup, supply|
+      grouped_territories_supplies.values.each do |supply|
         fsupply = supply.first.first
         supplies << {:including_tax => fsupply[:including_tax], :currency => fsupply[:currency],
                      :territory => supply.map { |fs| fs.map { |s| s[:territory] } }.flatten.uniq,

data/lib/onix/product_supply.rb

@@ -5,9 +5,9 @@ require 'onix/supply_detail'
 
 module ONIX
   class ProductSupply < SubsetDSL
-    elements "Market", :subset
-    element "MarketPublishingDetail", :subset
-    elements "SupplyDetail", :subset
+    elements "Market", :subset, :cardinality => 0..n
+    element "MarketPublishingDetail", :subset, :cardinality => 0..1
+    elements "SupplyDetail", :subset, :cardinality => 1..n
 
     # availability date from market
     # @return [Date]
@@ -41,6 +41,7 @@ module ONIX
       @supply_details.delete_if { |supply_detail| supply_detail.available? }
     end
 
+    # @return [Boolean]
     def available?
       self.available_supply_details.length > 0
     end

data/lib/onix/professional_affiliation.rb

@@ -0,0 +1,6 @@
+module ONIX
+  class ProfessionalAffiliation < SubsetDSL
+    elements "ProfessionalPosition", :text, :cardinality => 0..n
+    element "Affiliation", :text, :cardinality => 0..1
+  end
+end

data/lib/onix/publisher_representative.rb

@@ -0,0 +1,11 @@
+module ONIX
+  class PublisherRepresentative < SubsetDSL
+    element "AgentRole", :subset, :cardinality => 1
+    elements "AgentIdentifier", :subset, :cardinality => 0..n
+    element "AgentName", :text, :cardinality => 0..1
+    elements "TelephoneNumber", :text, :cardinality => 0..n
+    elements "FaxNumber", :text, :cardinality => 0..n
+    elements "EmailAddress", :text, :cardinality => 0..n
+    elements "Website", :subset, :cardinality => 0..n
+  end
+end

data/lib/onix/publishing_detail.rb

@@ -1,19 +1,27 @@
+require 'onix/product_contact'
 require 'onix/sales_rights'
+require 'onix/copyright_statement'
 require 'onix/date'
+
 module ONIX
   class PublishingDetail < SubsetDSL
-    elements "Imprint", :subset
-    elements "Publisher", :subset
-    element "CityOfPublication", :text, :shortcut => :city
-    element "CountryOfPublication", :text, :shortcut => :country
-    element "PublishingStatus", :subset, :shortcut => :status
-    elements "PublishingDate", :subset
-    elements "SalesRights", :subset, {:pluralize => false}
-    element "ROWSalesRightsType", :subset, {:klass => "SalesRightsType"}
-    element "SalesRestriction", :subset
+    elements "Imprint", :subset, :cardinality => 0..n
+    elements "Publisher", :subset, :cardinality => 0..n
+    element "CityOfPublication", :text, :shortcut => :city, :cardinality => 0..n
+    element "CountryOfPublication", :text, :shortcut => :country, :cardinality => 0..1
+    elements "ProductContact", :subset, :cardinality => 0..n
+    element "PublishingStatus", :subset, :shortcut => :status, :cardinality => 0..1
+    elements "PublishingStatusNote", :text, :cardinality => 0..n
+    elements "PublishingDate", :subset, :cardinality => 0..n
+    element "LatestReprintNumber", :integer, :cardinality => 0..1
+    elements "CopyrightStatement", :subset, :cardinality => 0..n
+    elements "SalesRights", :subset, :pluralize => false, :cardinality => 0..n
+    element "ROWSalesRightsType", :subset, :klass => "SalesRightsType", :cardinality => 0..1
+    element "SalesRestriction", :subset, :cardinality => 0..n
 
     # @!group High level
 
+    # @return [Publisher]
     def publisher
       main_publishers = @publishers.select { |p| p.role.human == "Publisher" }
       return nil if main_publishers.empty?
@@ -24,6 +32,7 @@ module ONIX
       end
     end
 
+    # @return [Imprint]
     def imprint
       if @imprints.length > 0
         if @imprints.length == 1
@@ -35,6 +44,7 @@ module ONIX
     end
 
     # date of publication
+    # @return [Date]
     def publication_date
       pub = @publishing_dates.publication.first
       if pub
@@ -43,6 +53,7 @@ module ONIX
     end
 
     # date of embargo
+    # @return [Date]
     def embargo_date
       pub = @publishing_dates.embargo.first
       if pub
@@ -50,6 +61,7 @@ module ONIX
       end
     end
 
+    # @return [Date]
     def preorder_embargo_date
       pub = @publishing_dates.preorder_embargo.first
       if pub
@@ -57,6 +69,7 @@ module ONIX
       end
     end
 
+    # @return [Date]
     def public_announcement_date
       pub = @publishing_dates.public_announcement.first
       if pub

data/lib/onix/related_material.rb

@@ -2,26 +2,30 @@ require 'onix/related_product'
 require 'onix/related_work'
 module ONIX
   class RelatedMaterial < SubsetDSL
-    elements "RelatedWork", :subset
-    elements "RelatedProduct", :subset
+    elements "RelatedWork", :subset, :cardinality => 0..n
+    elements "RelatedProduct", :subset, :cardinality => 0..n
 
     # @!group High level
 
+    # @return [Array<RelatedProduct>]
     def linking(human)
       @related_products.select{|rp| rp.code.human==human}
     end
 
     # print products RelatedProduct array
+    # @return [Array<RelatedProduct>]
     def print_products
       linking("EpublicationBasedOnPrintProduct") + self.alternative_format_products.select{|rp| rp.form && rp.form.code=~/^B/}
     end
 
     # is part of products RelatedProduct array
+    # @return [Array<RelatedProduct>]
     def part_of_products
       linking("IsPartOf")
     end
 
     # alternative format products RelatedProduct array
+    # @return [Array<RelatedProduct>]
     def alternative_format_products
       linking("AlternativeFormat")
     end

data/lib/onix/related_product.rb

@@ -1,23 +1,31 @@
 module ONIX
   class RelatedProduct < SubsetDSL
-    include EanMethods
-    include ProprietaryIdMethods
+    include IdentifiersMethods::Ean
+    include IdentifiersMethods::ProprietaryId
 
-    element "ProductRelationCode", :subset, :shortcut => :code
-    elements "ProductIdentifier", :subset, :shortcut => :identifiers
-    element "ProductForm", :subset, :shortcut => :form
-    elements "ProductFormDetail", :subset, :shortcut => :form_details
+    elements "ProductRelationCode", :subset, :shortcut => :codes, :cardinality => 1..n
+    elements "ProductIdentifier", :subset, :shortcut => :identifiers, :cardinality => 1..n
+    element "ProductForm", :subset, :shortcut => :form, :cardinality => 0..1
+    elements "ProductFormDetail", :subset, :shortcut => :form_details, :cardinality => 0..n
 
     # full Product if referenced in ONIXMessage
+    # @return [Product]
     attr_accessor :product
 
+    # @return [ProductRelationCode]
+    def code
+      self.codes.first
+    end
+
     # @!group High level
+    # @return [String]
     def file_format
       file_formats.first.human if file_formats.first
     end
 
     # @!endgroup
 
+    # @return [Array<ProductFormDetail>]
     def file_formats
       @product_form_details.select { |fd| fd.code =~ /^E1.*/ }
     end

data/lib/onix/related_work.rb

@@ -1,10 +1,12 @@
 module ONIX
   class RelatedWork < SubsetDSL
-    include EanMethods
-    element "WorkRelationCode", :subset, :shortcut => :code
-    elements "WorkIdentifier", :subset, :shortcut => :identifiers
+    include IdentifiersMethods::Ean
+
+    element "WorkRelationCode", :subset, :shortcut => :code, :cardinality => 0..n
+    elements "WorkIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
 
     # full Product if referenced in ONIXMessage
+    # @return [Product]
     attr_accessor :product
   end
 end

data/lib/onix/resource_feature.rb

@@ -0,0 +1,9 @@
+module ONIX
+  class ResourceFeature < SubsetDSL
+    element "ResourceFeatureType", :subset, :shortcut => :type, :cardinality => 1
+    element "FeatureValue", :text, :shortcut => :value, :cardinality => 0..1
+    elements "FeatureNote", :text, :shortcut => :notes, :cardinality => 0..n
+
+    scope :caption, lambda { human_code_match(:resource_feature_type, "Caption") }
+  end
+end