rbook-onix 0.5.2 → 0.6.0

data/specs/data/truncated.xml

@@ -0,0 +1,80 @@
+<?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>
+  <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>

data/specs/data/with_ampersands.xml

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ONIXMessage SYSTEM "http://www.editeur.org/onix/2.1/01/reference/onix-international.dtd">
+<ONIXMessage>
+ <Header>
+  <FromCompany>Allen &amp;amp; Unwin</FromCompany>
+  <FromPerson>Allen &amp;amp; Unwin</FromPerson>
+  <SentDate>20071015</SentDate>
+ </Header>
+ <Product>
+  <RecordReference>1741753856</RecordReference>
+  <NotificationType>01</NotificationType>
+  <ProductIdentifier>
+   <ProductIDType>02</ProductIDType>
+   <IDValue>1741753856</IDValue>
+  </ProductIdentifier>
+  <ProductIdentifier>
+   <ProductIDType>03</ProductIDType>
+   <IDValue>9781741753851</IDValue>
+  </ProductIdentifier>
+  <ProductIdentifier>
+   <ProductIDType>15</ProductIDType>
+   <IDValue>9781741753851</IDValue>
+  </ProductIdentifier>
+  <ProductForm>BC</ProductForm>
+  <ProductFormDetail>B105</ProductFormDetail>
+  <Title>
+   <TitleType>00</TitleType>
+   <TitleText>Mr Wong Goes West</TitleText>
+   <Subtitle>A Feng Shui Detective Novel</Subtitle>
+  </Title>
+  <Contributor>
+   <ContributorRole>A01</ContributorRole>
+   <PersonNameInverted>Vittachi, Nury</PersonNameInverted>
+  </Contributor>
+  <EditionNumber>1</EditionNumber>
+  <NumberOfPages>264</NumberOfPages>
+  <BICMainSubject>FF</BICMainSubject>
+  <OtherText>
+   <TextTypeCode>02</TextTypeCode>
+   <Text>Get ready to laugh - the Feng Shui Detective is back in an all new adventure. Feng Shui master CF Wong's skills and charms are again in desperate need, this time in London. But is the West ready for our Feng Shui crime-fighting hero?</Text>
+  </OtherText>
+  <OtherText>
+   <TextTypeCode>03</TextTypeCode>
+   <Text>The world's biggest and most expensive aircraft - Skyparc's 'office in the sky' which apparently runs on 'green' fuel - flies into Hong Kong. The Europeans want to sell the plane to the Chinese and Mr Wong is hired to make sure there is nothing on the plane that might upset visiting Chinese aviation officials. But things go wrong. An oil company executive is murdered and a young greenie, who happens to be a friend of Mr Wong's assistant, Joyce McQuinnie, is arrested.Mr Wong is delighted. The fact that a murder has taken place means that his job is now far more important and he can charge a much higher price. But as he flies to London to confer with officials, Skyparc's wheel assemblages are blown off and it's revealed there is a bomb on board. Wong must not only solve the mystery, but (almost) land the plane himself.Can Wong save the day? And will he make it to London where an anxious royal client awaits him, convinced that some terrible form of bad luck is responsible for years of Windsor family woe? In this third instalment of the eccentric and wildly entertaining Feng Shui Detectiveseries, the stakes for Mr Wong are higher than they've ever been.</Text>
+  </OtherText>
+  <MediaFile>
+   <MediaFileTypeCode>04</MediaFileTypeCode>
+   <MediaFileLinkTypeCode>01</MediaFileLinkTypeCode>
+   <MediaFileLink>http://www.allenandunwin.com/BookCovers/resized_9781741753851_224_297_FitSquare.jpg</MediaFileLink>
+  </MediaFile>
+  <Imprint>
+   <ImprintName>Allen &amp; Unwin</ImprintName>
+  </Imprint>
+  <Publisher>
+   <PublishingRole>01</PublishingRole>
+   <PublisherName>Allen &amp; Unwin</PublisherName>
+  </Publisher>
+  <PublishingStatus>02</PublishingStatus>
+  <PublicationDate>20080201</PublicationDate>
+  <YearFirstPublished>2008</YearFirstPublished>
+  <Measure>
+   <MeasureTypeCode>01</MeasureTypeCode>
+   <Measurement>195</Measurement>
+   <MeasureUnitCode>mm</MeasureUnitCode>
+  </Measure>
+  <Measure>
+   <MeasureTypeCode>02</MeasureTypeCode>
+   <Measurement>130</Measurement>
+   <MeasureUnitCode>mm</MeasureUnitCode>
+  </Measure>
+  <Measure>
+   <MeasureTypeCode>08</MeasureTypeCode>
+   <Measurement>300</Measurement>
+   <MeasureUnitCode>gr</MeasureUnitCode>
+  </Measure>
+  <SupplyDetail>
+   <SupplierName>Alliance Distribution Services</SupplierName>
+   <ProductAvailability>10</ProductAvailability>
+   <ExpectedShipDate>20080201</ExpectedShipDate>
+   <Stock>
+    <OnHand>NYP</OnHand>
+    <OnOrder>No</OnOrder>
+   </Stock>
+   <Price>
+    <PriceTypeCode>02</PriceTypeCode>
+    <PriceAmount>22.95</PriceAmount>
+    <CurrencyCode>AUD</CurrencyCode>
+   </Price>
+   <Price>
+    <PriceTypeCode>01</PriceTypeCode>
+    <PriceAmount>20.86</PriceAmount>
+    <CurrencyCode>AUD</CurrencyCode>
+   </Price>
+   <Price>
+    <PriceTypeCode>02</PriceTypeCode>
+    <PriceAmount>27.99</PriceAmount>
+    <CurrencyCode>NZD</CurrencyCode>
+   </Price>
+  </SupplyDetail>
+  <MarketRepresentation>
+   <AgentName>Allen &amp; Unwin</AgentName>
+   <AgentRole>07</AgentRole>
+   <MarketCountry>AU</MarketCountry>
+   <MarketPublishingStatus>02</MarketPublishingStatus>
+   <MarketDate>
+    <MarketDateRole>01</MarketDateRole>
+    <Date>20080201</Date>
+   </MarketDate>
+  </MarketRepresentation>
+ </Product>
+</ONIXMessage>

data/specs/message_class_spec.rb

@@ -91,10 +91,17 @@ context "The message class" do
   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")
+  specify "should parse as much data as possible when a tag has been left open" do
+    str = File.read(File.dirname(__FILE__)+"/data/invalid_xml.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))
     
-    lambda { msg = RBook::Onix::Message.load_from_string(doc) }.should raise_error(LoadError)
+    #check product count
+    msg.products.size.should eql(1)
   end
 
   # test loading a non XML file

data/specs/message_with_data_spec.rb

@@ -20,7 +20,7 @@ context "A message object with valid data" do
     product.product_identifier = '0977616606'
     msg.add_product(product)
 
-    doc = msg.to_xml
+    doc = REXML::Document.new(msg.to_s)
 
     REXML::XPath.first(doc, '/ONIXMessage/Header/FromPerson').should_not be_nil
     REXML::XPath.first(doc, '/ONIXMessage/Header/FromPerson').text.should eql("James Healy")
@@ -39,10 +39,10 @@ context "A message object with valid data" do
     msg.to_person = "RSpec"
 
     # TODO: fix this to use a RBook custom error
-    lambda { msg.to_xml }.should raise_error(RuntimeError)
+    lambda { msg.to_s }.should raise_error(RuntimeError)
   end
 
-  specify "should output a valid string" do
+  specify "should output a valid string with the correct indentation" do
     msg = RBook::Onix::Message.new
     msg.from_person = "James Healy"
     msg.from_company = "Healy Inc."
@@ -52,7 +52,28 @@ context "A message object with valid data" do
     product.product_identifier = '0977616606'
     msg.add_product(product)
 
+    # check string generation
     msg.to_s.should be_a_kind_of(String)
+
+    # check indenting
+    lines = msg.to_s.split("\n")
+    (lines.size > 3).should eql(true)
+    lines[0][0,5].should eql("<?xml")
+    lines[1][0,9].should eql("<!DOCTYPE")
+    lines[2][0,13].should eql("<ONIXMessage>")
+  end
+
+  specify "should output a valid REXML::Document object" 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_xml.should be_a_kind_of(REXML::Document)
   end
 
   specify "should output a valid string with no line breaks between tags and content" do
@@ -102,6 +123,6 @@ context "A message object with valid data" do
     product.product_identifier = '0977616606'
     msg.add_product(product)
 
-    msg.to_s[0,128].include?("encoding='UTF-8'").should be_true
+    msg.to_s[0,128].include?("encoding=\"UTF-8\"").should be_true
   end
 end

data/specs/product_class_spec.rb

@@ -31,6 +31,16 @@ context "The product class" do
     product.supply_details.size.should eql(1)
   end
 
+  specify "should return the correct ID when there are multiple IDs specified" do
+    product = nil
+    File.open(File.dirname(__FILE__)+"/data/2_ids.xml", "r") do |f|
+      doc = REXML::Document.new(f) 
+      product = RBook::Onix::Product.load_from_element(REXML::XPath.first(doc, '/ONIXMessage/Product'))
+    end
+    
+    product.product_identifier.should eql("9789900036708")
+  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'

data/specs/product_with_data_spec.rb

@@ -28,16 +28,37 @@ context "A product object with valid data" do
     supply_detail.price = 29.95
     product.add_supply_detail(supply_detail)
 
-    doc = product.to_element
+    doc = REXML::Document.new(product.to_s)
     
-    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
+    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
+
+  specify "should output to a valid REXML::Element object" 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)
+
+    product.to_element.should be_a_kind_of(REXML::Element)
   end
 
   # ensure all output is cleansed UTF-8

data/specs/sales_restriction_with_data_spec.rb

@@ -12,12 +12,12 @@ context "A sales restriction object with valid data" do
     restriction.type = '00'
     restriction.detail = 'Unknown'
     
-    doc = restriction.to_element
+    doc = REXML::Document.new(restriction.to_s)
 
-    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")
+    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
@@ -26,6 +26,13 @@ context "A sales restriction object with valid data" do
     restriction.detail = 'Unknown'
     
     restriction.to_s.should be_a_kind_of(String)
+  end
 
+  specify "should output a valid REXML::Element object" do
+    restriction = RBook::Onix::SalesRestriction.new
+    restriction.type = '00'
+    restriction.detail = 'Unknown'
+    
+    restriction.to_element.should be_a_kind_of(REXML::Element)
   end
 end

data/specs/stream_reader_spec.rb

@@ -28,4 +28,61 @@ context "The stream reader class" do
 
     counter.should eql(10)
   end
+
+  specify "should read in all the objects from an ONIX file with ampersands in the data" do
+    counter = 0
+
+    reader = RBook::Onix::StreamReader.new(File.dirname(__FILE__)+"/data/with_ampersands.xml")
+    reader.each do |product|
+      product.should be_a_kind_of(RBook::Onix::Product)
+      counter += 1
+    end
+
+    counter.should eql(1)
+  end
+
+  specify "should handle non-XML files gracefully" do
+    counter = 0
+
+    reader = RBook::Onix::StreamReader.new(File.dirname(__FILE__)+"/data/not_xml.csv")
+    reader.each do |product|
+      counter += 1
+    end
+
+    counter.should eql(0)
+  end
+
+  specify "should handle XML files that aren't ONIX gracefully" do
+    counter = 0
+
+    reader = RBook::Onix::StreamReader.new(File.dirname(__FILE__)+"/data/xml_not_onix.xml")
+    reader.each do |product|
+      counter += 1
+    end
+
+    counter.should eql(0)
+  end
+
+  specify "should read in as many products as possible if a file has been truncated" do
+    counter = 0
+
+    reader = RBook::Onix::StreamReader.new(File.dirname(__FILE__)+"/data/truncated.xml")
+    reader.each do |product|
+      product.should be_a_kind_of(RBook::Onix::Product)
+      counter += 1
+    end
+
+    counter.should eql(1)
+  end
+
+  specify "should fail gracefully if an xml declaration is found in the middle of the file" do
+    counter = 0
+
+    reader = RBook::Onix::StreamReader.new(File.dirname(__FILE__)+"/data/leading_garbage.xml")
+    reader.each do |product|
+      counter += 1
+    end
+
+    counter.should eql(0)
+  end
 end

data/specs/supply_detail_with_data_spec.rb

@@ -17,16 +17,16 @@ context "A product object with valid data" do
     supply_detail.availability_code = 'CS'
     supply_detail.price = 38.05
 
-    doc = supply_detail.to_element
+    doc = REXML::Document.new(supply_detail.to_s)
     
-    REXML::XPath.first(doc, '/SupplierName').should_not be_nil
-    REXML::XPath.first(doc, '/SupplierName').text.should eql("Walker")
-    REXML::XPath.first(doc, '/AvailabilityCode').should_not be_nil
-    REXML::XPath.first(doc, '/AvailabilityCode').text.should eql("CS")
-    REXML::XPath.first(doc, '/Price/PriceAmount').should_not be_nil
-    REXML::XPath.first(doc, '/Price/PriceAmount').text.should eql("38.05")
-    REXML::XPath.first(doc, '/Price/PriceTypeCode').should_not be_nil
-    REXML::XPath.first(doc, '/Price/PriceTypeCode').text.should eql("02")
+    REXML::XPath.first(doc, '//SupplierName').should_not be_nil
+    REXML::XPath.first(doc, '//SupplierName').text.should eql("Walker")
+    REXML::XPath.first(doc, '//AvailabilityCode').should_not be_nil
+    REXML::XPath.first(doc, '//AvailabilityCode').text.should eql("CS")
+    REXML::XPath.first(doc, '//Price/PriceAmount').should_not be_nil
+    REXML::XPath.first(doc, '//Price/PriceAmount').text.should eql("38.05")
+    REXML::XPath.first(doc, '//Price/PriceTypeCode').should_not be_nil
+    REXML::XPath.first(doc, '//Price/PriceTypeCode').text.should eql("02")
     
   end
 
@@ -37,6 +37,15 @@ context "A product object with valid data" do
     supply_detail.price = 38.05
     
     supply_detail.to_s.should be_a_kind_of(String)
+  end
 
+  specify "should output a valid REXML::Element object" do
+    supply_detail = RBook::Onix::SupplyDetail.new
+    supply_detail.supplier_name = 'Walker'
+    supply_detail.availability_code = 'CS'
+    supply_detail.price = 38.05
+    
+    supply_detail.to_element.should be_a_kind_of(REXML::Element)
   end
+
 end