onix2 1.0.0

data/lib/onix2/sales_restriction.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+module ONIX2
+  class SalesRestriction
+    include Virtus.model
+
+    attribute :sales_restriction_type, Integer
+
+    def to_xml
+      SalesRestrictionRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      SalesRestrictionRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class SalesRestrictionRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :SalesRestriction
+
+    property :sales_restriction_type, as: "SalesRestrictionType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+  end
+end

data/lib/onix2/sales_rights.rb

@@ -0,0 +1,28 @@
+module ONIX2
+  class SalesRights
+    include Virtus.model
+
+    attribute :sales_rights_type
+    attribute :rights_country
+    attribute :rights_territory
+
+    def to_xml
+      SalesRightsRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      SalesRightsRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class SalesRightsRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :SalesRights
+
+    property :sales_rights_type, as: "SalesRightsType"
+    property :rights_country, as: "RightsCountry"
+    property :rights_territory, as: "RightsTerritory"
+  end
+end
+

data/lib/onix2/sender_identifier.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module ONIX2
+  class SenderIdentifier
+    include Virtus.model
+
+    attribute :sender_id_type, Integer
+    attribute :id_type_name
+    attribute :id_value
+
+    def to_xml
+      SenderIdentifierRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      SenderIdentifierRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class SenderIdentifierRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :SenderIdentifier
+
+    property :sender_id_type, as: "SenderIDType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :id_type_name, as: "IDTypeName"
+    property :id_value, as: "IDValue"
+  end
+end

data/lib/onix2/series.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+module ONIX2
+  class Series
+    include Virtus.model
+
+    attribute :series_identifiers, Array[ONIX2::SeriesIdentifier]
+    attribute :title_of_series
+
+    def to_xml
+      SeriesRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      SeriesRepresenter.new(self.new).from_xml(data)
+    end
+
+  end
+
+  class SeriesRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Series
+
+    collection :series_identifiers, as: "SeriesIdentifier", extend: ONIX2::SeriesIdentifierRepresenter, class: ONIX2::SeriesIdentifier
+    property :title_of_series, as: "TitleOfSeries"
+  end
+end

data/lib/onix2/series_identifier.rb

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

data/lib/onix2/simple_product.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+require 'forwardable'
+
+module ONIX2
+  # super class for some simplified ONIX2::Product wrappers
+  class SimpleProduct
+
+    def initialize(product = nil)
+      @product = product || ::ONIX2::Product.new
+    end
+
+    class << self
+
+      include Forwardable
+
+      def from_xml(xml)
+        self.new(::ONIX2::Product.from_xml(xml))
+      end
+
+      def parse_file(filename)
+        self.new(::ONIX2::Product.parse(File.read(filename)))
+      end
+
+      def parse(xml)
+        self.new(::ONIX2::Product.parse(xml))
+      end
+
+      protected
+
+      def delegate(*args)
+        def_delegators :@product, *args
+      end
+    end
+
+    def product
+      @product
+    end
+
+    def to_xml
+      product.to_xml
+    end
+
+    # TODO: add method missing magic to proxy through to the underlying product?
+
+  end
+end

data/lib/onix2/stock.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module ONIX2
+  class Stock
+    include Virtus.model
+
+    # NOTE: these *should* be numeric fields according to the spec,
+    #       but heaps of ONIX files in the wild use text
+    attribute :on_hand
+    attribute :on_order
+
+    def to_xml
+      StockRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      StockRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class StockRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Stock
+
+    property :on_hand, as: "OnHand"
+    property :on_order, as: "OnOrder"
+  end
+end

data/lib/onix2/subject.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+module ONIX2
+  class Subject
+    include Virtus.model
+
+    attribute :subject_scheme_id, Integer
+    attribute :subject_scheme_name
+    attribute :subject_scheme_version
+    attribute :subject_code
+    attribute :subject_heading_text
+
+    def to_xml
+      SubjectRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      SubjectRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class SubjectRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Subject
+
+    property :subject_scheme_id, as: "SubjectSchemeIdentifier", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :subject_scheme_name, as: "SubjectSchemeName"
+    property :subject_scheme_version, as: "SubjectSchemeVersion"
+    property :subject_code, as: "SubjectCode"
+    property :subject_heading_text, as: "SubjectHeadingText"
+  end
+end

data/lib/onix2/supply_detail.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+module ONIX2
+  class SupplyDetail
+    include Virtus.model
+
+    attribute :supplier_ean_location_number
+    attribute :supplier_san
+    attribute :supplier_name
+    attribute :telephone_number
+    attribute :fax_number
+    attribute :email_address
+    attribute :websites, Array[ONIX2::Website]
+    attribute :supplier_role, Integer
+    attribute :supply_to_country
+    attribute :supply_to_territory
+    attribute :availability_status_code, Integer
+    attribute :product_availability, Integer
+    attribute :stock, Array[ONIX2::Stock]
+    attribute :pack_quantity, Integer
+    attribute :prices, Array[ONIX2::Price]
+
+    def to_xml
+      SupplyDetailRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      SupplyDetailRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class SupplyDetailRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :SupplyDetail
+
+    property :supplier_ean_location_number, as: "SupplierEANLocationNumber"
+    property :supplier_san, as: "SupplierSAN"
+    property :supplier_name, as: "SupplierName"
+    property :telephone_number, as: "TelephoneNumber"
+    property :fax_number, as: "FaxNumber"
+    property :email_address, as: "EmailAddress"
+    collection :websites, as: "Website", extend: ONIX2::WebsiteRepresenter, class: ONIX2::Website
+    property :supplier_role, as: "SupplierRole", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :supply_to_country, as: "SupplyToCountry"
+    property :supply_to_territory, as: "SupplyToTerritory"
+    property :availability_status_code, as: "AvailabilityStatusCode", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :product_availability, as: "ProductAvailability", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    collection :stock, as: "Stock", extend: ONIX2::StockRepresenter, class: ONIX2::Stock
+    property :pack_quantity, as: "PackQuantity"
+    collection :prices, as: "Price", extend: ONIX2::PriceRepresenter, class: ONIX2::Price
+  end
+end

data/lib/onix2/title.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+module ONIX2
+  class Title
+    include Virtus.model
+
+    attribute :title_type, Integer
+    attribute :title_text
+    attribute :title_prefix
+    attribute :title_without_prefix
+    attribute :subtitle
+
+    def to_xml
+      TitleRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      TitleRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class TitleRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Title
+
+    property :title_type, as: "TitleType", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :title_text, as: "TitleText"
+    property :title_prefix, as: "TitlePrefix"
+    property :title_without_prefix, as: "TitleWithoutPrefix"
+    property :subtitle, as: "Subtitle"
+  end
+end

data/lib/onix2/version.rb

@@ -0,0 +1,3 @@
+module ONIX2
+  VERSION = "1.0.0"
+end

data/lib/onix2/website.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+module ONIX2
+  class Website
+    include Virtus.model
+
+    attribute :website_role, Integer
+    attribute :website_description
+    attribute :website_link
+
+    def to_xml
+      WebsiteRepresenter.new(self).to_xml
+    end
+
+    def self.from_xml(data)
+      WebsiteRepresenter.new(self.new).from_xml(data)
+    end
+  end
+
+  class WebsiteRepresenter < Representable::Decorator
+    include Representable::XML
+
+    self.representation_wrap = :Website
+
+    property :website_role, as: "WebsiteRole", render_filter: ::ONIX2::Formatters::TWO_DIGITS
+    property :website_description, as: "WebsiteDescription"
+    property :website_link, as: "WebsiteLink"
+  end
+end

data/lib/onix2/writer.rb

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+module ONIX2
+  # The primary way to write a new ONIX file.
+  #
+  # Heres a quick example. The generated file will be nice and boring, as the
+  # header and product objects have no data in them, but you get the idea.
+  #
+  #   File.open("output.xml","w") do |output|
+  #     header = ONIX2::Header.new
+  #     ONIX2::Writer.open(output, header) do |writer|
+  #       writer << ONIX2::Product.new
+  #       writer << ONIX2::Product.new
+  #     end
+  #   end
+  #
+  # If you prefer, you can build your products using the APAProduct shim layer.
+  #
+  #   File.open("output.xml","w") do |output|
+  #     header = ONIX2::Header.new
+  #     ONIX2::Writer.open(output, header) do |writer|
+  #       writer << ONIX2::APAProduct.new
+  #       writer << ONIX2::APAProduct.new
+  #     end
+  #   end
+  #
+  class Writer
+
+    DOCTYPE = "http://www.editeur.org/onix/2.1/03/reference/onix-international.dtd"
+
+    # Default constructor.
+    def initialize(output, header)
+      raise ArgumentError, 'msg must be an ONIX2::Header object' unless header.kind_of?(ONIX2::Header)
+      @output = output
+      @header = header
+      @finished = false
+
+      start_document
+    end
+
+    # deprecated
+    def start_document
+      puts "ONIX2::StreamWriter#start_document is no longer required"
+    end
+
+    def << (product)
+      unless product.kind_of?(ONIX2::Product) || product.kind_of?(ONIX2::SimpleProduct)
+        raise ArgumentError, 'product must be an ONIX2::Product or ONIX2::SimpleProduct'
+      end
+      raise "Can't add products to a finished writer" if finished?
+
+      @output.write(product.to_xml.to_s)
+      @output.write("\n")
+    end
+
+    def end_document
+      @output.write("</ONIXMessage>\n")
+      @finished = true
+    end
+
+    def finished?
+      @finished
+    end
+
+    def self.open(output, header)
+      if block_given?
+        writer = self.new(output, header)
+        yield writer
+        writer.end_document
+      else
+        self.new(output, header)
+      end
+    end
+
+    private
+
+    def start_document
+      @output.write("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n")
+      @output.write("<!DOCTYPE ONIXMessage SYSTEM \"#{DOCTYPE}\">\n")
+      @output.write("<ONIXMessage release=\"2.1\">\n")
+      @output.write(@header.to_xml.to_s)
+      @output.write("\n")
+    end
+
+  end
+end