onix 0.4.0

data/lib/onix/sales_restriction.rb

@@ -0,0 +1,7 @@
+module ONIX
+  class SalesRestriction
+    include ROXML
+
+    xml_accessor :sales_restriction_type, :twodigit, :from =>"SalesRestrictionType"
+  end
+end

data/lib/onix/sender_identifier.rb

@@ -0,0 +1,9 @@
+module ONIX
+  class SenderIdentifier
+    include ROXML
+
+    xml_accessor :sender_id_type, :from => "SenderIDType"
+    xml_accessor :id_type_name,   :from => "IDTypeName"
+    xml_accessor :id_value,       :from => "IDValue"
+  end
+end

data/lib/onix/simple_product.rb

@@ -0,0 +1,41 @@
+require 'forwardable'
+
+module ONIX
+  # super class for some simplified ONIX::Product wrappers
+  class SimpleProduct
+
+    def initialize(product = nil)
+      @product = product || ::ONIX::Product.new
+    end
+
+    class << self
+      
+      include Forwardable
+
+      def parse_file(filename)
+        self.new(::ONIX::Product.parse(File.read(filename)))
+      end
+
+      def parse(xml)
+        self.new(::ONIX::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/onix/stock.rb

@@ -0,0 +1,10 @@
+module ONIX
+  class Stock
+    include ROXML
+
+    # NOTE: these *should* be numeric fields according to the spec,
+    #       but heaps of ONIX files in the wild use text
+    xml_accessor :on_hand, :from => "OnHand"
+    xml_accessor :on_order, :from => "OnOrder"
+  end
+end

data/lib/onix/subject.rb

@@ -0,0 +1,11 @@
+module ONIX
+  class Subject
+    include ROXML
+
+    xml_accessor :subject_scheme_id,   :twodigit, :from => "SubjectSchemeIdentifier"
+    xml_accessor :subject_scheme_name,            :from => "SubjectSchemeName"
+    xml_accessor :subject_scheme_version,         :from => "SubjectSchemeVersion"
+    xml_accessor :subject_code,                   :from => "SubjectCode"
+    xml_accessor :subject_heading_text,           :from => "SubjectHeadingText"
+  end
+end

data/lib/onix/supply_detail.rb

@@ -0,0 +1,21 @@
+module ONIX
+  class SupplyDetail
+    include ROXML
+
+    xml_accessor :supplier_ean_location_number, :from => "SupplierEANLocationNumber"
+    xml_accessor :supplier_san, :from => "SupplierSAN"
+    xml_accessor :supplier_name, :from => "SupplierName"
+    xml_accessor :telephone_number, :from => "TelephoneNumber"
+    xml_accessor :fax_number, :from => "FaxNumber"
+    xml_accessor :email_address, :from => "EmailAddress"
+    xml_accessor :websites, [ONIX::Website], :from => "Website"
+    xml_accessor :supplier_role, :twodigit, :from => "SupplierRole"
+    xml_accessor :supply_to_country, :from => "SupplyToCountry"
+    xml_accessor :supply_to_territory, :from => "SupplyToTerritory"
+    xml_accessor :availability_status_code, :twodigit, :from => "AvailabilityStatusCode"
+    xml_accessor :product_availability, :twodigit, :from => "ProductAvailability"
+    xml_accessor :stock, [ONIX::Stock], :from => "Stock"
+    xml_accessor :prices, [ONIX::Price], :from => "Price"
+
+  end
+end

data/lib/onix/title.rb

@@ -0,0 +1,10 @@
+module ONIX
+  class Title
+    include ROXML 
+
+    xml_accessor :title_type, :twodigit, :from => "TitleType"
+    xml_accessor :title_text, :etext,    :from => "TitleText"
+    xml_accessor :subtitle,   :etext,    :from => "Subtitle"
+
+  end
+end

data/lib/onix/two_digit_type.rb

@@ -0,0 +1,57 @@
+
+module ONIX
+
+  # Internal class representing 2-digit XML content
+  #
+  # In context:
+  #  <element attribute="XMLAttributeRef">
+  #   XMLTwoDigitRef
+  #  </element>
+  class TwoDigitType < ROXML::XMLRef # ::nodoc::
+    attr_reader :cdata, :content
+
+    def initialize(accessor, args, &block)
+      super(accessor, args, &block)
+      @content = args.content?
+      @cdata = args.cdata?
+    end
+
+    # Updates the text in the given _xml_ block to
+    # the _value_ provided.
+    def update_xml(xml, value)
+      parent = wrap(xml)
+      value = value.to_i
+      if value < 10
+        value = "0#{value}"
+      elsif value < 100
+        value = value.to_s
+      else
+        value = "00"
+      end
+      add(parent.child_add(LibXML::XML::Node.new_element(name)), value)
+      xml
+    end
+
+    def value(xml)
+      if content
+        value = xml.content.to_i
+      else
+        child = xml.search(name).first
+        value = child.content.to_i if child
+      end
+      block ? block.call(value) : value
+    end
+
+    private
+
+    def add(dest, value)
+      if cdata
+        dest.child_add(LibXML::XML::Node.new_cdata(value.to_utf))
+      else
+        dest.content = value.to_utf
+      end
+    end
+  end
+end
+
+ROXML::TypeRegistry.register(:twodigit, ONIX::TwoDigitType)

data/lib/onix/website.rb

@@ -0,0 +1,9 @@
+module ONIX
+  class Website
+    include ROXML
+
+    xml_accessor :website_role,        :twodigit, :from => "WebsiteRole"
+    xml_accessor :website_description,            :from => "WebsiteDescription"
+    xml_accessor :website_link,                   :from => "WebsiteLink"
+  end
+end

data/lib/onix/writer.rb

@@ -0,0 +1,87 @@
+module ONIX
+  # 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 = ONIX::Header.new
+  #     ONIX::Writer.open(output, header) do |writer|
+  #       writer << ONIX::Product.new
+  #       writer << ONIX::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 = ONIX::Header.new
+  #     ONIX::Writer.open(output, header) do |writer|
+  #       writer << ONIX::APAProduct.new
+  #       writer << ONIX::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 ONIX::Header object' unless header.kind_of?(ONIX::Header)
+      @output = output
+      @header = header
+      @finished = false
+
+      start_document
+    end
+
+    # deprecated
+    def start_document
+      puts "ONIX::StreamWriter#start_document is no longer required"
+    end
+
+    def << (product)
+      unless product.kind_of?(ONIX::Product) || product.kind_of?(ONIX::SimpleProduct)
+        raise ArgumentError, 'product must be an ONIX::Product or ONIX::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
+      decl = REXML::XMLDecl.new
+      doctype = REXML::DocType.new('ONIXMessage', "SYSTEM \"#{DOCTYPE}\"")
+      decl.encoding = "utf-8"
+      @output.write(decl.to_s+"\n")
+      @output.write(doctype.to_s+"\n")
+      @output.write("<ONIXMessage>\n")
+      @output.write(@header.to_xml.to_s)
+      @output.write("\n")
+    end
+
+  end
+end

data/spec/header_spec.rb

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'onix'
+
+context "ONIX::Header" do
+
+  before(:each) do
+    data_path = File.join(File.dirname(__FILE__),"..","data")
+    file1    = File.join(data_path, "header.xml")
+    @doc = LibXML::XML::Document.file(file1)
+    @header_node = @doc.root
+  end
+
+  specify "should correctly convert to a string" do
+    header = ONIX::Header.parse(@header_node.to_s)
+    header.to_xml.to_s[0,8].should eql("<Header>")
+  end
+
+  specify "should provide read access to first level attibutes" do
+    header = ONIX::Header.parse(@header_node.to_s)
+
+    header.from_ean_number.should eql("1111111111111")
+    header.from_san.should eql("1111111")
+    header.from_company.should eql("Text Company")
+    header.from_email.should eql("james@rainbowbooks.com.au")
+    header.from_person.should eql("James")
+
+    header.to_ean_number.should eql("2222222222222")
+    header.to_san.should eql("2222222")
+    header.to_company.should eql("Company 2")
+    header.to_person.should eql("Chris")
+
+    header.message_note.should eql("A Message")
+    header.message_repeat.should eql(1)
+    header.sent_date.should eql(Date.civil(2008,5,19))
+
+    header.default_language_of_text.should eql("aaa")
+    header.default_price_type_code.should eql(1)
+    header.default_currency_code.should eql("ccc")
+    header.default_linear_unit.should eql("dd")
+    header.default_weight_unit.should eql("ee")
+    header.default_class_of_trade.should eql("f")
+  end
+
+  specify "should provide write access to first level attibutes" do
+    header = ONIX::Header.new
+
+    header.from_ean_number = "1111111111111"
+    header.from_ean_number.should eql("1111111111111")
+
+    header.from_san = "1111111"
+    header.from_san.should eql("1111111")
+
+    header.from_company = "Text Company"
+    header.from_company.should eql("Text Company")
+
+    header.from_email = "james@rainbowbooks.com.au"
+    header.from_email.should eql("james@rainbowbooks.com.au")
+
+    header.from_person = "James"
+    header.from_person.should eql("James")
+
+    header.to_ean_number = "2222222222222"
+    header.to_ean_number.should eql("2222222222222")
+
+    header.to_san = "2222222"
+    header.to_san.should eql("2222222")
+
+    header.to_company = "Company 2"
+    header.to_company.should eql("Company 2")
+
+    header.to_person = "Chris"
+    header.to_person.should eql("Chris")
+
+    header.message_note = "A Message"
+    header.message_note.should eql("A Message")
+
+    header.message_repeat = 1
+    header.message_repeat.should eql(1)
+
+    header.sent_date = Date.civil(2008,5,19)
+    header.sent_date.should eql(Date.civil(2008,5,19))
+
+    header.default_language_of_text = "aaa"
+    header.default_language_of_text.should eql("aaa")
+
+    header.default_price_type_code = 1
+    header.default_price_type_code.should eql(1)
+
+    header.default_currency_code = "ccc"
+    header.default_currency_code.should eql("ccc")
+
+    header.default_class_of_trade = "f"
+    header.default_class_of_trade.should eql("f")
+  end
+
+  specify "should correctly handle text with & < and >" do
+    header = ONIX::Header.new
+
+    header.from_company = "James & Healy"
+    header.to_xml.to_s.include?("James &amp; Healy").should be_true
+
+    header.from_company = "James < Healy"
+    header.to_xml.to_s.include?("James &lt; Healy").should  be_true
+
+    header.from_company = "James > Healy"
+    header.to_xml.to_s.include?("James &gt; Healy").should  be_true
+  end
+end

data/spec/product_spec.rb

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'onix'
+require 'date'
+
+context "ONIX::Product" do
+
+  before(:each) do
+    data_path = File.join(File.dirname(__FILE__),"..","data")
+    file1    = File.join(data_path, "product.xml")
+    @doc = LibXML::XML::Document.file(file1)
+    @product_node = @doc.root
+  end
+
+  specify "should provide read access to first level attibutes" do
+    product = ONIX::Product.parse(@product_node.to_s)
+
+    product.record_reference.should eql("365-9780194351898")
+    product.notification_type.should eql(3)
+    product.product_form.should eql("BC")
+    product.edition_number.should eql(1)
+    product.number_of_pages.should eql(100)
+    product.bic_main_subject.should eql("EB")
+    product.publishing_status.should eql(4)
+    product.publication_date.should eql(Date.civil(1998,9,1))
+    product.year_first_published.should eql(1998)
+  end
+
+  specify "should provide read access to product IDs" do
+    product = ONIX::Product.parse(@product_node.to_s)
+    product.product_identifiers.size.should eql(3)
+  end
+
+  specify "should provide read access to titles" do
+    product = ONIX::Product.parse(@product_node.to_s)
+    product.titles.size.should eql(1)
+  end
+
+  specify "should provide read access to subjects" do
+    product = ONIX::Product.parse(@product_node.to_s)
+    product.subjects.size.should eql(1)
+  end
+
+  specify "should provide write access to first level attibutes" do
+    product = ONIX::Product.new
+
+    product.notification_type = 3
+    product.notification_type.should eql(3)
+    product.record_reference = "365-9780194351898"
+    product.record_reference.should eql("365-9780194351898")
+
+    product.product_form = "BC"
+    product.product_form.should eql("BC")
+
+    product.edition_number = 1
+    product.edition_number.should eql(1)
+
+    product.number_of_pages = 100
+    product.number_of_pages.should eql(100)
+
+    product.bic_main_subject = "EB"
+    product.bic_main_subject.should eql("EB")
+
+    product.publishing_status = 4
+    product.publishing_status.should eql(4)
+
+    product.publication_date = Date.civil(1998,9,1)
+    product.publication_date.should eql(Date.civil(1998,9,1))
+
+    product.year_first_published = 1998
+    product.year_first_published.should eql(1998)
+  end
+end