rbook-onix 0.5

data/specs/data/invalid_no_product.xml

@@ -0,0 +1,9 @@
+<?xml version='1.0'?>
+<!DOCTYPE ONIXMessage SYSTEM "http://www.editeur.org/onix/2.1/reference/onix-international.dtd">
+<ONIXMessage>
+  <Header>
+    <FromCompany>Schwartz Publishing Pty Ltd</FromCompany>
+    <FromPerson>James Healy</FromPerson>
+    <SentDate>20060522</SentDate>
+  </Header>
+</ONIXMessage>

data/specs/data/invalid_xml.xml

@@ -0,0 +1,24 @@
+<?xml version='1.0'?>
+<!DOCTYPE ONIXMessage SYSTEM "http://www.editeur.org/onix/2.1/reference/onix-international.dtd">
+<ONIXMessage>
+  <Header>
+    <FromCompany>Chalice</FromCompany>
+    <FromPerson>James Healy</FromPerson>
+    <SentDate>20060521</SentDate>
+  </Header>
+  <Product>
+    <RecordReference>0827200528</RecordReference>
+    <NotificationType>03</NotificationType>
+    <ProductIdentifier>
+      <ProductIDType>02</ProductIDType>
+      <IDValue>0827200528</IDValue>
+    </ProductIdentifier>
+    <ProductForm>BA</ProductForm>
+    <NoSeries/>
+    <Title>
+      <TitleType>01</TitleType>
+      <TitleText>And Their Eyes Are Opened</TitleText>
+      <Subtitle>Story Sermons Embracing the World</Subtitle>
+    </Title>
+    <Contributor>
+</ONIXMessage>

data/specs/data/not_xml.csv

@@ -0,0 +1 @@
+"this file is not XML","Remind you of 1990?"

data/specs/data/single_product.xml

@@ -0,0 +1,55 @@
+<?xml version='1.0'?>
+<!DOCTYPE ONIXMessage SYSTEM "http://www.editeur.org/onix/2.1/reference/onix-international.dtd">
+<ONIXMessage>
+  <Header>
+    <FromCompany>Chalice</FromCompany>
+    <FromPerson>James Healy</FromPerson>
+    <SentDate>20060521</SentDate>
+  </Header>
+  <Product>
+    <RecordReference>0827200528</RecordReference>
+    <NotificationType>03</NotificationType>
+    <ProductIdentifier>
+      <ProductIDType>02</ProductIDType>
+      <IDValue>0827200528</IDValue>
+    </ProductIdentifier>
+    <ProductForm>BA</ProductForm>
+    <NoSeries/>
+    <Title>
+      <TitleType>01</TitleType>
+      <TitleText>And Their Eyes Are Opened</TitleText>
+      <Subtitle>Story Sermons Embracing the World</Subtitle>
+    </Title>
+    <Contributor>
+      <SequenceNumber>0</SequenceNumber>
+      <ContributorRole>A01</ContributorRole>
+      <PersonNameInverted>Healy, James</PersonNameInverted>
+    </Contributor>
+    <NoEdition/>
+    <BICMainSubject>YFH</BICMainSubject>
+    <MediaFile>
+      <MediaFileTypeCode>04</MediaFileTypeCode>
+      <MediaFileLinkTypeCode>01</MediaFileLinkTypeCode>
+      <MediaFileLink>http://www.example.com/0827200528.jpg</MediaFileLink>
+    </MediaFile>
+    <NumberOfPages>0</NumberOfPages>
+    <Publisher>
+      <PublishingRole>01</PublishingRole>
+      <PublisherName>Chalice</PublisherName>
+    </Publisher>
+    <PublicationDate>20050303</PublicationDate>
+    <SalesRestriction>
+      <SalesRestrictionType>00</SalesRestrictionType>
+      <SalesRestrictionDetail>Unknown</SalesRestrictionDetail>
+    </SalesRestriction>
+    <SupplyDetail>
+      <SupplierName>Chalice</SupplierName>
+      <AvailabilityCode>CS</AvailabilityCode>
+      <IntermediaryAvailabilityCode>99</IntermediaryAvailabilityCode>
+      <Price>
+        <PriceTypeCode>02</PriceTypeCode>
+        <PriceAmount>29.95</PriceAmount>
+      </Price>
+    </SupplyDetail>
+  </Product>
+</ONIXMessage>

data/specs/data/xml_not_onix.xml

@@ -0,0 +1,7 @@
+<?xml version='1.0'?>
+<root>
+  <tag1/>
+  <tag2>Some Data</tag2>
+  <tag3 attr1="cliche">Hello World</tag3>
+  <tag4 attr2="for completeness" />
+</root>

data/specs/message_class_spec.rb

@@ -0,0 +1,110 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/onix'
+include RBook
+
+context "The message class" do
+
+  #setup do
+  #end
+
+  # test loading a valid onix file. Make sure the correct number of products
+  # exist, but don't worry about the content. The product unit tests can check them
+  specify "should create a object tree from an xmldoc object" do
+    msg = nil
+    File.open(File.dirname(__FILE__)+"/data/single_product.xml", "r") do |f|
+      doc = REXML::Document.new(f) 
+      msg = RBook::Onix::Message.load_from_xmldoc(doc)
+    end
+    
+    #check header elements
+    msg.from_company.should eql("Chalice")
+    msg.from_person.should eql("James Healy")
+    msg.sent_date.should eql(Date.civil(2006, 5, 21))
+    
+    #check product count
+    msg.products.size.should eql(1)
+  end
+
+  # load a UTF-16 XML file into memory, converting it to UTF-8 on the fly
+  specify "should create a object tree from a UTF-16 xmldoc object" do
+    msg = nil
+    File.open(File.dirname(__FILE__)+"/data/2_products_utf16.xml", "r") do |f|
+      doc = REXML::Document.new(f) 
+      msg = RBook::Onix::Message.load_from_xmldoc(doc)
+    end
+    
+    #check header elements
+    msg.from_company.should eql("HarperCollins Publishers")
+    msg.sent_date.should eql(Date.civil(2007, 4, 23))
+    
+    #check product count
+    msg.products.size.should eql(2)
+  end
+
+  # test loading a valid onix file. Make sure the correct number of products
+  # exist, but don't worry about the content. The product unit tests can check them
+  specify "should create a object tree from a string" do
+    str = File.read(File.dirname(__FILE__)+"/data/single_product.xml")
+    msg = RBook::Onix::Message.load_from_string(str)
+    
+    #check header elements
+    msg.from_company.should eql("Chalice")
+    msg.from_person.should eql("James Healy")
+    msg.sent_date.should eql(Date.civil(2006, 5, 21))
+    
+    #check product count
+    msg.products.size.should eql(1)
+  end
+
+  # load a UTF-16 XML file into memory, converting it to UTF-8 on the fly
+  specify "should create an object tree from a UTF-16 string" do
+    str = File.read(File.dirname(__FILE__)+"/data/2_products_utf16.xml")
+    msg = RBook::Onix::Message.load_from_string(str)
+    
+    #check header elements
+    msg.from_company.should eql("HarperCollins Publishers")
+    msg.sent_date.should eql(Date.civil(2007, 4, 23))
+    
+    #check product count
+    msg.products.size.should eql(2)
+  end
+
+  # try loading an onix file with no products
+  specify "should raise an exception if attempting to load an ONIX file with no products" do
+    doc = nil
+    File.open(File.dirname(__FILE__)+"/data/invalid_no_product.xml", "r") do |f|
+      doc = REXML::Document.new(f)
+    end
+    
+    lambda { msg = RBook::Onix::Message.load_from_xmldoc(doc) }.should raise_error(LoadError)
+  end
+
+  # test loading an xml file that's not an onix file
+  specify "should raise an exception if attempting to load an invalid ONIX file" do
+    doc = nil
+    File.open(File.dirname(__FILE__)+"/data/xml_not_onix.xml", "r") do |f|
+      doc = REXML::Document.new(f)
+    end
+    
+    lambda { msg = RBook::Onix::Message.load_from_xmldoc(doc) }.should raise_error(LoadError)
+  end
+
+  # test loading an xml file that's is invalid (an open tag)
+  specify "should raise an exception if attempting to load an XML file with an open tag" do
+    doc = File.read(File.dirname(__FILE__)+"/data/invalid_xml.xml")
+    
+    lambda { msg = RBook::Onix::Message.load_from_string(doc) }.should raise_error(LoadError)
+  end
+
+  # test loading a non XML file
+  specify "should raise an exception if attempting to load a non XML file" do
+    doc = nil
+    File.open(File.dirname(__FILE__)+"/data/not_xml.csv", "r") do |f|
+      doc = REXML::Document.new(f)
+    end
+    
+    lambda { msg = RBook::Onix::Message.load_from_xmldoc(doc) }.should raise_error(LoadError)
+  end
+
+end

data/specs/message_with_data_spec.rb

@@ -0,0 +1,81 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/onix'
+include RBook
+
+context "A message object with valid data" do
+
+  #setup do
+  #end
+
+  # ensure header information is output to xml correctly and that a 
+  # product is created
+  specify "should output a valid ONIX file" do
+    msg = RBook::Onix::Message.new
+    msg.from_person = "James Healy"
+    msg.from_company = "Healy Inc."
+    msg.to_person = "RSpec"
+
+    product = RBook::Onix::Product.new
+    product.product_identifier = '0977616606'
+    msg.add_product(product)
+
+    doc = msg.to_xml
+
+    REXML::XPath.first(doc, '/ONIXMessage/Header/FromPerson').should_not be_nil
+    REXML::XPath.first(doc, '/ONIXMessage/Header/FromPerson').text.should eql("James Healy")
+    REXML::XPath.first(doc, '/ONIXMessage/Header/FromCompany').should_not be_nil
+    REXML::XPath.first(doc, '/ONIXMessage/Header/FromCompany').text.should eql("Healy Inc.")
+    REXML::XPath.first(doc, '/ONIXMessage/Header/ToPerson').should_not be_nil
+    REXML::XPath.first(doc, '/ONIXMessage/Header/ToPerson').text.should eql("RSpec")
+    REXML::XPath.first(doc, '/ONIXMessage/Product').should_not be_nil
+  end
+
+  # test for an exception when a onixmessage with no products is converted to an xml document
+  specify "should raise an exception if the user attempts to convert a message with no products to XML" do
+    msg = RBook::Onix::Message.new
+    msg.from_person = "James Healy"
+    msg.from_company = "Healy Inc."
+    msg.to_person = "RSpec"
+
+    # TODO: fix this to use a RBook custom error
+    lambda { msg.to_xml }.should raise_error(RuntimeError)
+  end
+
+  specify "should output a valid string" do
+    msg = RBook::Onix::Message.new
+    msg.from_person = "James Healy"
+    msg.from_company = "Healy Inc."
+    msg.to_person = "RSpec"
+
+    product = RBook::Onix::Product.new
+    product.product_identifier = '0977616606'
+    msg.add_product(product)
+
+    msg.to_s.should be_a_kind_of(String)
+  end
+
+  # ensure all output is cleansed UTF-8
+  specify "should output valid UTF-8, regardless of the input" do
+    msg = RBook::Onix::Message.new
+    msg.from_person = "James Healy\x00"
+    msg.from_company = "Healy Inc.\x11"
+    msg.from_email = "someone@example.com\x11"
+    msg.to_person = "RSpec"
+    msg.to_company = "Sample Company\x11"
+    msg.message_note = "This is a sample ONIX message\x11"
+
+    product = RBook::Onix::Product.new
+    product.product_identifier = '0977616606'
+    product.title = 'Test Title'
+    msg.add_product(product)
+
+    doc = msg.to_s
+
+    doc.each_byte do |c|
+      n = XChar::CP1252[c] || c
+      n = nil unless XChar::VALID.find {|range| range.include? n}
+      n.should_not be_nil
+    end
+  end
+end

data/specs/product_class_spec.rb

@@ -0,0 +1,42 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/onix'
+include RBook
+
+context "The product class" do
+
+  #setup do
+  #end
+
+  # test loading a valid onix file. Make sure the correct number of products
+  # exist, but don't worry about the content. The product unit tests can check them
+  specify "should create a object tree from an xmldoc object" do
+    product = nil
+    File.open(File.dirname(__FILE__)+"/data/single_product.xml", "r") do |f|
+      doc = REXML::Document.new(f) 
+      product = RBook::Onix::Product.load_from_element(REXML::XPath.first(doc, '/ONIXMessage/Product'))
+    end
+    
+    product.notification_type.should eql("03")
+    product.record_reference.should eql("0827200528")
+    product.form.should eql("BA")
+    product.pages.should eql("0")
+    product.bicmainsubject.should eql("YFH")
+    product.title.should eql("And Their Eyes Are Opened")
+    product.subtitle.should eql("Story Sermons Embracing the World")
+    product.publisher.should eql("Chalice")
+    product.publication_date.should eql(Date.civil(2005, 3, 3))
+
+    product.contributors.size.should eql(1)
+    product.supply_details.size.should eql(1)
+  end
+
+  specify "should raise an exception when atytempting to load from a non Product XML fragment" do
+    element = REXML::Element.new('NonProduct')
+    element.add_element('NonContributor').text = 'blah'
+
+    # TODO: change this to a custom RBook error
+    lambda {RBook::Onix::Product.load_from_element(element) }.should raise_error(LoadError)
+    
+  end
+end

data/specs/product_with_data_spec.rb

@@ -0,0 +1,66 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/onix'
+include RBook
+
+context "A product object with valid data" do
+
+  #setup do
+  #end
+
+  # ensure product information is output to xml correctly
+  # TODO: test more than just IDValue and TitleText
+  specify "should output to a valid XML fragment" do
+    product = RBook::Onix::Product.new
+    product.product_identifier = '0977616606'
+    product.title = 'This is a title'
+    product.publisher = 'Chalice'
+
+    contributor = RBook::Onix::Contributor.new
+    contributor.sequence_number = '0'
+    contributor.name_inverted = 'Healy, James'
+    contributor.role = 'A01'
+    product.add_contributor(contributor)
+
+    supply_detail = RBook::Onix::SupplyDetail.new
+    supply_detail.supplier_name = 'Walker'
+    supply_detail.availability_code = 'CS'
+    supply_detail.price = 29.95
+    product.add_supply_detail(supply_detail)
+
+    doc = product.to_element
+    
+    REXML::XPath.first(doc, '/ProductIdentifier/IDValue').should_not be_nil
+    REXML::XPath.first(doc, '/ProductIdentifier/IDValue').text.should eql("0977616606")
+    REXML::XPath.first(doc, '/Title/TitleText').should_not be_nil
+    REXML::XPath.first(doc, '/Title/TitleText').text.should eql("This is a title")
+    REXML::XPath.first(doc, '/Contributor').should_not be_nil
+    REXML::XPath.first(doc, '/Publisher/PublisherName').should_not be_nil
+    REXML::XPath.first(doc, '/Publisher/PublisherName').text.should eql("Chalice")
+    REXML::XPath.first(doc, '/SupplyDetail').should_not be_nil
+  end
+
+  # ensure all output is cleansed UTF-8
+  specify "should output valid UTF-8, regardless of the input" do
+    # create an Onix::Product fragment
+    product = RBook::Onix::Product.new
+    product.product_identifier = "0977616606"
+    product.title = "Test Title\x00"
+    product.subtitle = "Test Subtitle\x11"
+    product.website = "http://www.google.com\x11"
+    product.form = "BA\x11"
+    product.bicmainsubject = "FGD\x11"
+    product.description = "This is a sample description\x11"
+    product.publisher = "Publisher\x11"
+
+    fragment = product.to_s
+
+    # loop over each byte in the product element and check it's
+    # a valid UTF-8 character
+    fragment.each_byte do |c|
+      n = XChar::CP1252[c] || c
+      n = nil unless XChar::VALID.find {|range| range.include? n}
+      n.should_not be_nil
+    end
+  end
+end

data/specs/sales_restriction_class_spec.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/onix'
+include RBook
+
+context "The sales restriction class" do
+
+  #setup do
+  #end
+
+  # test loading a valid onix file. Make sure the correct number of products
+  # exist, but don't worry about the content. The product unit tests can check them
+  specify "should create a object tree from an xmldoc object" do
+    restriction = nil
+    File.open(File.dirname(__FILE__)+"/data/single_product.xml", "r") do |f|
+      doc = REXML::Document.new(f) 
+      restriction = RBook::Onix::SalesRestriction.load_from_element(REXML::XPath.first(doc, '/ONIXMessage/Product/SalesRestriction'))
+    end
+    
+    restriction.type.should eql("00")
+    restriction.detail.should eql("Unknown")
+  end
+
+  specify "should raise an exception when atytempting to load from a non Product XML fragment" do
+    element = REXML::Element.new('NonRestriction')
+    element.add_element('Type').text = 'blah'
+
+    # TODO: change this to a custom RBook error
+    lambda {RBook::Onix::SalesRestriction.load_from_element(element) }.should raise_error(LoadError)
+    
+  end
+end

data/specs/sales_restriction_with_data_spec.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rbook/onix'
+include RBook
+
+context "A sales restriction object with valid data" do
+
+  # ensure product information is output to xml correctly
+  # TODO: test more than just IDValue and TitleText
+  specify "should output to a valid XML fragment" do
+    restriction = RBook::Onix::SalesRestriction.new
+    restriction.type = '00'
+    restriction.detail = 'Unknown'
+    
+    doc = restriction.to_element
+
+    REXML::XPath.first(doc, '/SalesRestrictionType').should_not be_nil
+    REXML::XPath.first(doc, '/SalesRestrictionType').text.should eql("00")
+    REXML::XPath.first(doc, '/SalesRestrictionDetail').should_not be_nil
+    REXML::XPath.first(doc, '/SalesRestrictionDetail').text.should eql("Unknown")
+  end
+
+  specify "should output a valid string" do
+    restriction = RBook::Onix::SalesRestriction.new
+    restriction.type = '00'
+    restriction.detail = 'Unknown'
+    
+    restriction.to_s.should be_a_kind_of(String)
+
+  end
+end