onix2 1.0.0

data/spec/reader_spec.rb

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe ONIX2::Reader do
+
+  before(:each) do
+    @data_path = File.join(File.dirname(__FILE__),"..","data")
+    @file1    = File.join(@data_path, "9780194351898.xml")
+    @file2    = File.join(@data_path, "two_products.xml")
+    @long_file   = File.join(@data_path, "Bookwise_July_2008.xml")
+    @entity_file = File.join(@data_path, "entities.xml")
+    @utf_16_file = File.join(@data_path, "utf_16.xml")
+    @iso_8859_1_file = File.join(@data_path, "iso_8859_1.xml")
+    @no_encoding_decl_file = File.join(@data_path, "aau.xml")
+  end
+
+  it "should initialize with a filename" do
+    reader = ONIX2::Reader.new(@file1)
+    expect(reader.instance_variable_get("@reader")).to be_a_kind_of(Nokogiri::XML::Reader)
+  end
+
+  it "should initialize with an IO object" do
+    File.open(@file1,"rb") do |f|
+      reader = ONIX2::Reader.new(f)
+      expect(reader.instance_variable_get("@reader")).to be_a_kind_of(Nokogiri::XML::Reader)
+    end
+  end
+
+  it "should provide access to various XML metadata from file" do
+    filename = File.join(@data_path, "reference_with_release_attrib.xml")
+    reader = ONIX2::Reader.new(filename)
+    expect(reader.release).to eql(BigDecimal.new("2.1"))
+  end
+
+  it "should provide access to the header in an ONIX file" do
+    reader = ONIX2::Reader.new(@file1)
+    expect(reader.header).to be_a_kind_of(ONIX2::Header)
+  end
+
+  it "should iterate over all product records in an ONIX file" do
+    reader = ONIX2::Reader.new(@file1)
+    counter = 0
+    reader.each do |product|
+      expect(product).to be_a_kind_of(ONIX2::Product)
+      counter += 1
+    end
+
+    expect(counter).to be_eql(1)
+  end
+
+  it "should iterate over all product records in an ONIX file" do
+    reader = ONIX2::Reader.new(@file2)
+    products = []
+    reader.each do |product|
+      products << product
+    end
+
+    expect(products.size).to be_eql(2)
+    expect(products[0].record_reference).to be_eql("365-9780194351898")
+    expect(products[1].record_reference).to be_eql("9780754672326")
+  end
+
+  # libxml can handle the 3 standard entities fine (&amp; &lt; and ^gt;) but
+  # barfs when it encounters others. In theory other entities are defined in the
+  # ONIX DTD, but I can't work out how to get libxml to recognise them
+  it "should correctly parse a file that has an entity in it" do
+    reader = ONIX2::Reader.new(@entity_file)
+
+    products = []
+    reader.each do |product|
+      products << product
+    end
+
+    expect(products.size).to be_eql(1)
+    expect(products.first.titles.size).to be_eql(1)
+    expect(products.first.titles.first.title_text).to be_eql("High Noon\342\200\223in Nimbin")
+    expect(products.first.record_reference).to be_eql("9780732287573")
+  end
+
+  # for some reason I'm getting segfaults when I read a file with more than 7 records
+  it "should correctly parse a file with more than 7 records in in" do
+    reader = ONIX2::Reader.new(@long_file)
+    counter = 0
+    reader.each do |product|
+      counter += 1
+    end
+
+    expect(counter).to be_eql(346)
+  end
+
+  it "should transparently convert a iso-8859-1 file to utf-8" do
+    reader = ONIX2::Reader.new(@iso_8859_1_file)
+    reader.each do |product|
+      if RUBY_VERSION >= "1.9"
+        utf8 = Encoding.find("utf-8")
+        expect(product.contributors[0].person_name_inverted.encoding).to be_eql(utf8)
+      end
+
+      expect(product.contributors[0].person_name_inverted).to be_eql("Küng, Hans")
+    end
+  end
+
+  # This isn't ideal behaviour, but i'm somewhat hamstrung by nokogiri API. It'd
+  # be nice to have the option to replace unrecognised bytes with a valid char.
+  it "should raise an exception when an iso-8859-1 file isn't declared as such" do
+    reader = ONIX2::Reader.new(@no_encoding_decl_file)
+    expect {
+      reader.each do |product|
+      end
+    }.to raise_error(Nokogiri::XML::SyntaxError)
+  end
+
+  it "should transparently convert an iso-8859-1 file to utf-8 when there's no declaration but the user manually specifies iso-8859-1" do
+    reader = ONIX2::Reader.new(@no_encoding_decl_file, :encoding => "iso-8859-1")
+    reader.each do |product|
+      if RUBY_VERSION >= "1.9"
+        utf8 = Encoding.find("utf-8")
+        expect(product.contributors[0].person_name_inverted.encoding).to be_eql(utf8)
+      end
+
+      expect(product.contributors[0].person_name_inverted).to be_eql("Melo,Patr¡cia")
+    end
+  end
+
+  it "should transparently convert a utf-16 file to utf-8" do
+    reader = ONIX2::Reader.new(@utf_16_file)
+    product = nil
+    reader.each do |p|
+      product = p
+    end
+
+    # ROXML appears to munge the string encodings
+    if RUBY_VERSION >= "1.9"
+      utf8 = Encoding.find("utf-8")
+      expect(product.contributors[0].person_name_inverted.encoding).to be_eql(utf8)
+    end
+
+    expect(product.contributors[0].person_name_inverted).to be_eql("Küng, Hans")
+  end
+
+  it "should support returning an APAProduct using deprecated API" do
+    reader = ONIX2::Reader.new(@file1, ONIX2::APAProduct)
+    reader.each do |product|
+      expect(product).to be_a_kind_of(ONIX2::APAProduct)
+    end
+  end
+
+  it "should support returning an APAProduct using new API" do
+    reader = ONIX2::Reader.new(@file1, :product_class => ONIX2::APAProduct)
+    reader.each do |product|
+      expect(product).to be_a_kind_of(ONIX2::APAProduct)
+    end
+  end
+end

data/spec/sales_restriction_spec.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe "ONIX2::SalesRestriction" do
+
+  Given(:doc) { load_xml "sales_restriction.xml" }
+
+  describe "should correctly convert to a string" do
+    Given(:sr) { ONIX2::SalesRestriction.from_xml(doc) }
+    Then { sr.to_xml.to_s.start_with? "<SalesRestriction>" }
+  end
+
+  describe "should provide read access to first level attributes" do
+    Given(:sr) { ONIX2::SalesRestriction.from_xml(doc) }
+    Then { sr.sales_restriction_type == 0 }
+  end
+
+  context "should provide write access to first level attributes" do
+    Given(:sr) { ONIX2::SalesRestriction.new }
+    describe :sales_restriction_type= do
+      When { sr.sales_restriction_type = 1 }
+      Then { sr.to_xml.to_s.include? "<SalesRestrictionType>01</SalesRestrictionType>" }
+    end
+  end
+
+end

data/spec/sender_identifier.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ONIX2::SenderIdentifier do
+
+  Given(:doc) { load_xml "sender_identifier.xml" }
+
+  describe "should correctly convert to a string" do
+    Given(:id) { ONIX2::SenderIdentifier.from_xml(doc) }
+    Then { id.to_xml.to_s.start_with? "<SenderIdentifier>" }
+  end
+
+  describe "should provide read access to first level attributes" do
+    Given(:id) { ONIX2::SenderIdentifier.from_xml(doc) }
+
+    Then { id.sender_id_type == 1 }
+    Then { id.id_value == "123456" }
+  end
+
+  context "should provide write access to first level attributes" do
+    Given(:id) { ONIX2::SenderIdentifier.new }
+    describe :sender_id_type= do
+      When { id.sender_id_type = 1 }
+      Then { id.to_xml.to_s.include? "<SenderIDType>01</SenderIDType>" }
+    end
+    describe :id_value= do
+      When { id.id_value = "54321" }
+      Then { id.to_xml.to_s.include? "<IDValue>54321</IDValue>" }
+    end
+  end
+
+end

data/spec/series_identifier_spec.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ONIX2::SeriesIdentifier do
+
+  Given(:doc) { load_xml "series_identifier.xml" }
+
+  describe "should correctly convert to a string" do
+    Given(:series) { ONIX2::SeriesIdentifier.from_xml(doc) }
+    Then { series.to_xml.to_s.start_with? "<SeriesIdentifier>" }
+  end
+
+  describe "should provide read access to first level attributes" do
+    Given(:series) { ONIX2::SeriesIdentifier.from_xml(doc) }
+
+    Then { series.series_id_type == 1 }
+    Then { series.id_value == "10001" }
+  end
+
+  context "should provide write access to first level attributes" do
+    Given(:series) { ONIX2::SeriesIdentifier.new }
+    describe :series_id_type= do
+      When { series.series_id_type = 9 }
+      Then { series.to_xml.to_s.include? "<SeriesIDType>09</SeriesIDType>" }
+    end
+    describe :id_value= do
+      When { series.id_value = 999 }
+      Then { series.to_xml.to_s.include? "<IDValue>999</IDValue>" }
+    end
+  end
+
+end

data/spec/series_spec.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ONIX2::Series do
+
+  Given(:doc) { load_xml "series.xml" }
+
+  describe "should correctly convert to a string" do
+    Given(:series) { ONIX2::Series.from_xml(doc) }
+
+    Then{ series.to_xml.to_s.start_with? "<Series>" }
+  end
+
+  describe "should provide read access to first level attributes" do
+    Given(:series) { ONIX2::Series.from_xml(doc) }
+
+    Then{  series.title_of_series == "Citizens and Their Governments" }
+  end
+
+  context "should provide write access to first level attributes" do
+    Given(:series) { ONIX2::Series.new }
+    describe :title_of_series= do
+      When { series.title_of_series = "Cool Science Careers" }
+      Then { series.to_xml.to_s.include? "<TitleOfSeries>Cool Science Careers</TitleOfSeries>" }
+    end
+  end
+
+  describe "should provide read access to series IDs" do
+    Given(:series) { ONIX2::Series.from_xml(doc) }
+    Then { series.series_identifiers.size == 2 }
+  end
+
+  context "should provide write access to series IDs" do
+    Given(:series_identifier1) { ONIX2::SeriesIdentifier.new(series_id_type: 1, id_value: 10001) }
+    Given(:series_identifier2) { ONIX2::SeriesIdentifier.new(series_id_type: 2, id_value: 20002) }
+    Given(:series) { ONIX2::Series.new }
+
+    describe :series_identifiers= do
+      When { series.series_identifiers = [series_identifier1, series_identifier2] }
+
+      Then { series.to_xml.to_s.include? "<SeriesIDType>01</SeriesIDType>" }
+      Then { series.to_xml.to_s.include? "<IDValue>20002</IDValue>" }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+require "rubygems"
+require "bundler/setup"
+
+require "pry"
+require 'date'
+require 'stringio'
+require 'rubygems'
+require 'onix2'
+require 'rspec/given'
+
+def load_xml(file)
+  File.read(File.join(File.dirname(__FILE__), "..", "data", file))
+end

data/spec/stock_spec.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ONIX2::Stock do
+
+  Given(:doc) { load_xml "stock.xml" }
+
+  describe "should correctly convert to a string" do
+    Given(:s) { ONIX2::Stock.from_xml(doc) }
+    Then { s.to_xml.to_s.start_with? "<Stock>" }
+  end
+
+  describe "should provide read access to first level attributes" do
+    Given(:s) { ONIX2::Stock.from_xml(doc) }
+
+    # note that these fields *should* be numeric according to the ONIX spec,
+    # however heaps of ONIX files in the wild have strings there.
+    Then { s.on_hand == "2862" }
+    Then { s.on_order == "0" }
+  end
+
+  context "should provide write access to first level attributes" do
+    Given(:s) { ONIX2::Stock.new }
+    describe :on_hand= do
+      When { s.on_hand = "123" }
+      Then { s.to_xml.to_s.include? "<OnHand>123</OnHand>" }
+    end
+    describe :on_order= do
+      When { s.on_order = "011" }
+      Then { s.to_xml.to_s.include? "<OnOrder>011</OnOrder>" }
+    end
+    describe :on_order= do
+      When { s.on_order = 11 }
+      Then { s.to_xml.to_s.include? "<OnOrder>11</OnOrder>" }
+    end
+  end
+
+end

data/spec/subject_spec.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ONIX2::Subject do
+
+  Given(:doc) { load_xml "subject.xml" }
+
+  describe "should correctly convert to a string" do
+    Given(:sub) { ONIX2::Subject.from_xml(doc) }
+    Then { sub.to_xml.to_s.start_with? "<Subject>" }
+  end
+
+  describe "should provide read access to first level attributes" do
+    Given(:sub) { ONIX2::Subject.from_xml(doc) }
+
+    Then { sub.subject_scheme_id == 3 }
+    Then { sub.subject_scheme_name == "RBA Subjects" }
+    Then { sub.subject_code == "AABB" }
+  end
+
+  context "should provide write access to first level attributes" do
+    Given(:sub) { ONIX2::Subject.new }
+    describe :subject_scheme_id= do
+      When { sub.subject_scheme_id = 2 }
+      Then { sub.to_xml.to_s.include? "<SubjectSchemeIdentifier>02</SubjectSchemeIdentifier>" }
+    end
+    describe :subject_code= do
+      When { sub.subject_code = "ABCD" }
+      Then { sub.to_xml.to_s.include? "<SubjectCode>ABCD</SubjectCode>" }
+    end
+  end
+
+end

data/spec/supply_detail_spec.rb

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ONIX2::SupplyDetail do
+
+  Given(:doc) { load_xml "supply_detail.xml" }
+
+  describe "should correctly convert to a string" do
+    Given(:sd) { ONIX2::SupplyDetail.from_xml(doc) }
+    Then { sd.to_xml.to_s.start_with? "<SupplyDetail>" }
+  end
+
+  describe "should provide read access to first level attributes" do
+    Given(:sd) { ONIX2::SupplyDetail.from_xml(doc) }
+
+    Then { sd.supplier_name == "Rainbow Book Agencies" }
+    Then { sd.product_availability == 21 }
+    Then { sd.stock.is_a? Array }
+    Then { sd.stock.size == 1 }
+    Then { sd.pack_quantity == 16 }
+    Then { sd.prices.is_a? Array }
+    Then { sd.prices.size == 1 }
+  end
+
+  context "should provide write access to first level attributes" do
+    Given(:sd) { ONIX2::SupplyDetail.new }
+    describe :supplier_name= do
+      When { sd.supplier_name = "RBA" }
+      Then { sd.to_xml.to_s.include? "<SupplierName>RBA</SupplierName>" }
+    end
+    describe :supplier_role= do
+      When { sd.supplier_role = 1 }
+      Then { sd.to_xml.to_s.include? "<SupplierRole>01</SupplierRole>" }
+    end
+    describe :availability_status_code= do
+      When { sd.availability_status_code = 2 }
+      Then { sd.to_xml.to_s.include? "<AvailabilityStatusCode>02</AvailabilityStatusCode>" }
+    end
+    describe :product_availability= do
+      When { sd.product_availability = 3 }
+      Then { sd.to_xml.to_s.include? "<ProductAvailability>03</ProductAvailability>" }
+    end
+    describe :pack_quantity= do
+      When { sd.pack_quantity = 12 }
+      Then { sd.to_xml.to_s.include? "<PackQuantity>12</PackQuantity>" }
+    end
+  end
+
+  describe "should provide read access to website IDs" do
+    Given(:sd) { ONIX2::SupplyDetail.from_xml(doc) }
+    Then { sd.websites.size == 2 }
+  end
+
+  context "should provide write access to website IDs" do
+    Given(:website) { ONIX2::Website.new(website_role: 1) }
+    Given(:sd) { ONIX2::SupplyDetail.new }
+
+    describe :series_identifiers= do
+      When { sd.websites = [website] }
+      Then { sd.to_xml.to_s.include? "<WebsiteRole>01</WebsiteRole>" }
+    end
+  end
+
+  describe "should provide read access to stock IDs" do
+    Given(:sd) { ONIX2::SupplyDetail.from_xml(doc) }
+    Then { sd.stock.size == 1 }
+  end
+
+  context "should provide write access to stock IDs" do
+    Given(:stock1) { ONIX2::Stock.new(on_hand: 1251) }
+    Given(:stock2) { ONIX2::Stock.new(on_hand: 52458, on_order: 0) }
+    Given(:sd) { ONIX2::SupplyDetail.new }
+
+    describe :series_identifiers= do
+      When { sd.stock = [stock1, stock2] }
+      Then { sd.to_xml.to_s.include? "<OnHand>1251</OnHand>" }
+      Then { sd.to_xml.to_s.include? "<OnOrder>0</OnOrder>" }
+    end
+  end
+
+  describe "should provide read access to price IDs" do
+    Given(:sd) { ONIX2::SupplyDetail.from_xml(doc) }
+    Then { sd.prices.size == 1 }
+  end
+
+  context "should provide write access to price IDs" do
+    Given(:price) { ONIX2::Price.new(price_amount: BigDecimal.new("0.59")) }
+    Given(:sd) { ONIX2::SupplyDetail.new }
+
+    describe :series_identifiers= do
+      When { sd.prices = [price] }
+      Then { sd.to_xml.to_s.include? "<PriceAmount>0.59</PriceAmount>" }
+    end
+  end
+
+end