onix2 1.0.0

data/lib/onix2/market_representation.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+module ONIX2
+  class MarketRepresentation
+    include Virtus.model
+
+    attribute :agent_name
+    attribute :agent_role, Integer
+    attribute :market_country
+    attribute :market_territory
+    attribute :market_country_excluded
+    attribute :market_restriction_detail
+    attribute :market_publishing_status, Integer
+
+    def to_xml
+      MarketRepresentationRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      MarketRepresentationRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class MarketRepresentationRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :MarketRepresentation
+
+    property :agent_name, as: "AgentName"
+    property :agent_role, as: "AgentRole", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :market_country, as: "MarketCountry"
+    property :market_territory, as: "MarketTerritory"
+    property :market_country_excluded, as: "MarketCountryExcluded"
+    property :market_restriction_detail, as: "MarketRestrictionDetail"
+    property :market_publishing_status, as: "MarketPublishingStatus", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+  end
+end
+

data/lib/onix2/measure.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module ONIX2
+  class Measure
+    include Virtus.model
+
+    attribute :measure_type_code, Integer
+    attribute :measurement #Integer or Decimal
+    attribute :measure_unit_code
+
+    def to_xml
+      MeasureRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      MeasureRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class MeasureRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Measure
+
+    property :measure_type_code, as: "MeasureTypeCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :measurement, as: "Measurement", render_filter: ::ONIX2::Formatters::DECIMAL, parse_filter: ->(value, *context) { value.is_a?(Integer) ? value.to_i : BigDecimal.new(value) }
+    property :measure_unit_code, as: "MeasureUnitCode"
+  end
+end

data/lib/onix2/media_file.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+module ONIX2
+  class MediaFile
+    include Virtus.model
+
+    attribute :media_file_type_code, Integer
+    attribute :media_file_format_code, Integer
+    attribute :image_resolution
+    attribute :media_file_link_type_code, Integer
+    attribute :media_file_link
+
+    def to_xml
+      MediaFileRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      MediaFileRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class MediaFileRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :MediaFile
+
+    property :media_file_type_code, as: "MediaFileTypeCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :media_file_format_code, as: "MediaFileFormatCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :image_resolution, as: "ImageResolution"
+    property :media_file_link_type_code, as: "MediaFileLinkTypeCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :media_file_link, as: "MediaFileLink"
+  end
+end

data/lib/onix2/other_text.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+module ONIX2
+  class OtherText
+    include Virtus.model
+
+    attribute :text_type_code, Integer
+    attribute :text_format
+    attribute :text
+    attribute :text_link_type,Integer
+    attribute :text_link
+    attribute :text_author
+
+    def to_xml
+      OtherTextRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      OtherTextRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class OtherTextRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :OtherText
+
+    property :text_type_code, as: "TextTypeCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :text_format, as: "TextFormat"
+    property :text, as: "Text"
+    property :text_link_type, as: "TextLinkType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :text_link, as: "TextLink"
+    property :text_author, as: "TextAuthor"
+  end
+end

data/lib/onix2/price.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+module ONIX2
+  class Price
+    include Virtus.model
+
+    attribute :price_type_code, Integer
+    attribute :price_type_qualifier, Integer
+    attribute :price_type_description
+    attribute :price_per, Integer
+    attribute :minimum_order_qty, Integer
+    attribute :class_of_trade
+    attribute :bic_discount_group_code
+    attribute :discounts_coded, Array[DiscountCoded]
+    attribute :price_status, Integer
+    attribute :price_amount, Decimal
+    attribute :currency_code
+    attribute :discount_percent, Decimal
+
+    def to_xml
+      PriceRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      PriceRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class PriceRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Price
+
+    property :price_type_code, as: "PriceTypeCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :price_type_qualifier, as: "PriceQualifier", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :price_type_description, as: "PriceTypeDescription"
+    property :price_per, as: "PricePer", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :minimum_order_qty, as: "MinimumOrderQuantity"
+    property :class_of_trade, as: "ClassOfTrade"
+    property :bic_discount_group_code, as: "BICDiscountGroupCode"
+    collection :discounts_coded, as: "DiscountCoded", extend: ONIX2::DiscountCodedRepresenter, class: ONIX2::DiscountCoded
+    property :price_status, as: "PriceStatus", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :price_amount, as: "PriceAmount", render_filter: ::ONIX2::Formatters::DECIMAL
+    property :currency_code, as: "CurrencyCode"
+    property :discount_percent, as: "DiscountPercent"
+  end
+end

data/lib/onix2/product.rb

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+module ONIX2
+  class Product
+    include Virtus.model
+
+    attribute :record_reference
+    attribute :notification_type, Integer
+    attribute :product_identifiers, Array[ONIX2::ProductIdentifier]
+    attribute :product_form
+    attribute :product_form_detail
+    attribute :series, Array[ONIX2::Series]
+    attribute :titles, Array[ONIX2::Title]
+    attribute :websites, Array[ONIX2::Website]
+    attribute :contributors, Array[ONIX2::Contributor]
+    attribute :edition_number, Integer
+    attribute :languages, Array[ONIX2::Language]
+    attribute :number_of_pages, Integer
+    attribute :basic_main_subject
+    attribute :bic_main_subject
+    attribute :subjects, Array[ONIX2::Subject]
+    attribute :audience_code
+    attribute :audience_ranges, Array[ONIX2::AudienceRange]
+    attribute :text, Array[ONIX2::OtherText]
+    attribute :media_files, Array[ONIX2::MediaFile]
+    attribute :imprints, Array[ONIX2::Imprint]
+    attribute :publishers, Array[ONIX2::Publisher]
+    attribute :publishing_status, Integer
+    attribute :publication_date
+    attribute :copyright_year, Integer
+    attribute :year_first_published, Integer
+    attribute :sales_restrictions, Array[ONIX2::SalesRestriction]
+    attribute :measurements, Array[ONIX2::Measure]
+    attribute :supply_details, Array[ONIX2::SupplyDetail]
+    attribute :market_representations, Array[ONIX2::MarketRepresentation]
+    attribute :sales_rights, Array[ONIX2::SalesRights]
+
+    # some deprecated attributes. Read only
+    # - See the measures array for the current way of specifying
+    #   various measurements of the product
+    attribute :height, Decimal
+    attribute :width, Decimal
+    attribute :thickness, Decimal
+    attribute :weight, Decimal
+    attribute :dimensions
+
+    def to_xml
+      ProductRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      ProductRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class ProductRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Product
+
+    property :record_reference, as: "RecordReference"
+    property :notification_type, as: "NotificationType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    collection :product_identifiers, as: "ProductIdentifier", extend: ONIX2::ProductIdentifierRepresenter, class: ONIX2::ProductIdentifier
+    property :product_form, as: "ProductForm"
+    property :product_form_detail, as: "ProductFormDetail", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    collection :series, as: "Series", extend: ONIX2::SeriesRepresenter, class: ONIX2::Series
+    collection :titles, as: "Title", extend: ONIX2::TitleRepresenter, class: ONIX2::Title
+    collection :websites, as: "Website", extend: ONIX2::WebsiteRepresenter, class: ONIX2::Website
+    collection :contributors, as: "Contributor", extend: ONIX2::ContributorRepresenter, class: ONIX2::Contributor
+    property :edition_number, as: "EditionNumber"
+    collection :languages, as: "Language", extend: ONIX2::LanguageRepresenter, class: ONIX2::Language
+    property :number_of_pages, as: "NumberOfPages"
+    property :basic_main_subject, as: "BASICMainSubject"
+    property :bic_main_subject, as: "BICMainSubject"
+    collection :subjects, as: "Subject", extend: ONIX2::SubjectRepresenter, class: ONIX2::Subject
+    property :audience_code, as: "AudienceCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    collection :audience_ranges, as: "AudienceRange", extend: ONIX2::AudienceRangeRepresenter, class: ONIX2::AudienceRange
+    collection :text, as: "OtherText", extend: ONIX2::OtherTextRepresenter, class: ONIX2::OtherText
+    collection :media_files, as: "MediaFile", extend: ONIX2::MediaFileRepresenter, class: ONIX2::MediaFile
+    collection :imprints, as: "Imprint", extend: ONIX2::ImprintRepresenter, class: ONIX2::Imprint
+    collection :publishers, as: "Publisher", extend: ONIX2::PublisherRepresenter, class: ONIX2::Publisher
+    property :publishing_status, as: "PublishingStatus", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :publication_date, as: "PublicationDate", render_filter: ::ONIX2::Formatters::YYYYMMDD, parse_filter: ->(value, *context) { Date.parse(value) rescue nil }
+    property :copyright_year, as: "CopyrightYear"
+    property :year_first_published, as: "YearFirstPublished"
+    collection :sales_restrictions, as: "SalesRestriction", extend: ONIX2::SalesRestrictionRepresenter, class: ONIX2::SalesRestriction
+    collection :measurements, as: "Measure", extend: ONIX2::MeasureRepresenter, class: ONIX2::Measure
+    collection :supply_details, as: "SupplyDetail", extend: ONIX2::SupplyDetailRepresenter, class: ONIX2::SupplyDetail
+    collection :market_representations, as: "MarketRepresentation", extend: ONIX2::MarketRepresentationRepresenter, class: ONIX2::MarketRepresentation
+    property :height, as: "Height"
+    property :width, as: "Width"
+    property :thickness, as: "Thickness"
+    property :weight, as: "Weight"
+    property :dimensions, as: "Dimensions"
+    collection :sales_rights, as: "SalesRights", extend: ONIX2::SalesRightsRepresenter, class: ONIX2::SalesRights
+  end
+end

data/lib/onix2/product_identifier.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+module ONIX2
+  class ProductIdentifier
+    include Virtus.model
+
+    attribute :product_id_type, Integer
+    attribute :id_value
+
+    def to_xml
+      ProductIdentifierRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      ProductIdentifierRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class ProductIdentifierRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :ProductIdentifier
+
+    property :product_id_type, as: "ProductIDType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :id_value, as: "IDValue"
+  end
+end

data/lib/onix2/publisher.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+module ONIX2
+  class Publisher
+    include Virtus.model
+
+    attribute :publishing_role, Integer
+    attribute :name_code_type, Integer
+    attribute :name_code_type_name
+    attribute :name_code_type_value
+    attribute :publisher_name
+
+    def to_xml
+      PublisherRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      PublisherRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class PublisherRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Publisher
+
+    property :publishing_role, as: "PublishingRole", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :name_code_type, as: "NameCodeType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :name_code_type_name, as: "NameCodeTypeName"
+    property :name_code_type_value, as: "NameCodeTypeValue"
+    property :publisher_name, as: "PublisherName"
+  end
+end

data/lib/onix2/reader.rb

@@ -0,0 +1,157 @@
+# coding: utf-8
+
+require 'stringio'
+
+module ONIX2
+
+  # This is the primary class for reading data from an ONIX file, and there's
+  # really not much to it
+  #
+  # Each file should contain a single header, and 1 or more products:
+  #
+  #   reader = ONIX2::Reader.new("somefile.xml")
+  #
+  #   puts reader.header.inspect
+  #
+  #   reader.each do |product|
+  #     puts product.inspect
+  #   end
+  #
+  # The header will be returned as an ONIX2::Header object, and the product will
+  # be an ONIX2::Product.
+  #
+  # The ONIX2::Product class can be a bit of a hassle to work with, as data can be
+  # nested in it fairly deeply. To wrap all the products returned by the reader
+  # in a shim that provides simple accessor access to common attributes, pass the
+  # shim class as a second argument
+  #
+  #   reader = ONIX2::Reader.new("somefile.xml", :product_class => ONIX2::APAProduct)
+  #
+  #   puts reader.header.inspect
+  #
+  #   reader.each do |product|
+  #     puts product.inspect
+  #   end
+  #
+  # APAProduct stands for Australian Publishers Association and provides simple
+  # access to the ONIX attributes that are commonly used in the Australian market.
+  #
+  # As well as accessing the file header, there are handful of other read only
+  # attributes that might be useful
+  #
+  #   reader = ONIX2::Reader.new("somefile.xml")
+  #
+  #   puts reader.version
+  #   puts reader.xml_lang
+  #   puts reader.xml_version
+  #   puts reader.encoding
+  #
+  # The version attribute is particuarly useful. There are multiple revisions of the
+  # ONIX spec, and you may need to handle the file differently based on what
+  # version it is.
+  #
+  # == File Encoding
+  #
+  # ONIX2::Reader returns all strings as UTF-8. Source file encoding is detected by
+  # the encoding declaration at the top of the file, like so:
+  #
+  #   <?xml version="1.0" encoding="iso-8859-1"?>
+  #
+  # If the encoding declaration is missing the file is assumed to be UTF-8.
+  #
+  # If the encoding declaration is missing or wrong and the file isn't UTF-8,
+  # you can manually set or override it like so:
+  #
+  #   reader = ONIX2::Reader.new("somefile.xml", :encoding => "iso-8859-1")
+  #
+  # If the file contains invalid bytes for the source encoding an exception will
+  # be raised. This isn't ideal, but I'm still looking for ways to make this
+  # behaviour configurable.
+  #
+  # If you're running 1.9, you might imagine passing an IO stream that auto
+  # transcodes to UTF-8 into ONIX2::Reader might have the same effect, but that
+  # isn't the case. Nokogiri is used to parse the file, and it seems to ignore
+  # IO encoding and just read raw bytes.
+  #
+  class Reader
+    include Enumerable
+
+    attr_reader :header, :release
+
+    def initialize(input, *args)
+      opts = args.last.kind_of?(Hash) ? args.pop : {}
+      if args.size > 0
+        ActiveSupport::Deprecation.warn("Passing a klass as ONIX2::Reader's second argument is deprecated, use the :product_class option instead", caller)
+      end
+      @product_klass = opts[:product_class] || args.pop || ::ONIX2::Product
+
+      if input.kind_of?(String)
+        @file   = File.open(input, "r")
+        @reader = Nokogiri::XML::Reader(@file, nil, opts[:encoding]) { |cfg| cfg.dtdload.noent }
+      elsif input.kind_of?(IO)
+        @reader = Nokogiri::XML::Reader(input, nil, opts[:encoding]) { |cfg| cfg.dtdload.noent }
+      else
+        raise ArgumentError, "Unable to read from file or IO stream"
+      end
+
+      @release = find_release
+      @header = find_header
+
+      @xml_lang    ||= @reader.lang
+      @xml_version ||= @reader.xml_version.to_f
+    end
+
+    # Iterate over all the products in an ONIX file
+    #
+    def each(&block)
+      @reader.each do |node|
+        if @reader.node_type == 1 && @reader.name == "Product"
+          str = @reader.outer_xml
+          if str.nil?
+            yield @product_klass.new
+          else
+            yield @product_klass.from_xml(str)
+          end
+        end
+      end
+    end
+
+    def close
+      @reader.close if @reader
+    end
+
+    private
+
+    def find_release
+      2.times do
+        @reader.read
+        if @reader.node_type == 1 && @reader.name == "ONIXMessage"
+          value = @reader.attributes["release"]
+          if value
+            return BigDecimal.new(value)
+          else
+            return nil
+          end
+        elsif @reader.node_type == 14
+          return nil
+        end
+      end
+      return nil
+    end
+
+    def find_header
+      100.times do
+        @reader.read
+        if @reader.node_type == 1 &&  @reader.name == "Header"
+          str = @reader.outer_xml
+          if str.nil?
+            return ONIX2::Header.new
+          else
+            return ONIX2::Header.from_xml(str)
+          end
+        end
+      end
+      return nil
+    end
+  end
+end