cxml-ruby 0.5.0 → 0.8.1

data/spec/fixtures/document_node_with_unknown_attribute.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.020/cXML.dtd">
+<cXML xml:lang="en-US" payloadID="test-id" timestamp="2020-09-10T20:32:26+00:00">
+  <Response invalid="invalid">
+    <Status code="200" text="Ok">123456</Status>
+  </Response>
+</cXML>

data/spec/fixtures/invoice_taxes_at_line_multiple_taxes.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.0.11/InvoiceDetail.dtd">
+<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.037/InvoiceDetail.dtd">
 
 <cXML version="1.0" payloadID="1240598937@SUBDOMAIN.coupahost.com" timestamp="2018-05-04T01:24:51-07:00">
 
@@ -176,11 +176,9 @@
 
                         <DiscountPercent percent="1" />
 
-                        <DiscountDueDays>1</DiscountDueDays>
 
                     </Discount>
 
-                    <NetDueDays>1</NetDueDays>
 
                 </PaymentTerm>
 

data/spec/fixtures/item_in.xml

@@ -4,8 +4,9 @@
     <SupplierPartAuxiliaryID>lkajsdflsdf</SupplierPartAuxiliaryID>
   </ItemID>
   <ItemDetail>
-    <Description xml:lang="en">AGENDA MAGAZINE RACK A4 CHARCOAL 25990</Description>
+    <Description xml:lang="en"><![CDATA[AGENDA MAGAZINE RACK A4 CHARCOAL 25990]]></Description>
     <UnitOfMeasure>EA</UnitOfMeasure>
     <UnitPrice> <Money currency="GBP">5.35</Money> </UnitPrice>
+    <Classification domain="UNSPSC">44000000</Classification>
   </ItemDetail>
 </ItemIn>

data/spec/fixtures/punch_out_order_message_doc.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-  <cxml version="1.2.011" payloadID="1346769469000.process.162998590@officedepot.com" timestamp="2012-09-04T02:37:49-05:00">
+  <cxml version="1.2.020" payloadID="1346769469000.process.162998590@officedepot.com" timestamp="2012-09-04T02:37:49-05:00">
     <Header>
         <From>
           <Credential domain="NetworkID">

data/spec/fixtures/punch_out_setup_request_doc_with_ship_to.xml

@@ -39,6 +39,13 @@
 <Country isoCountryCode="US">United States</Country>
 </PostalAddress>
 <Email name="default">jmadden@coupa1.com</Email>
+<Phone name="work">
+  <TelephoneNumber>
+    <CountryCode isoCountryCode="US">1</CountryCode>
+    <AreaOrCityCode>855</AreaOrCityCode>
+    <Number>8671234</Number>
+  </TelephoneNumber>
+</Phone>
 </Address>
 </ShipTo>
 </PunchOutSetupRequest>

data/spec/fixtures/response_status_200.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<cXML version="1.2.011" payloadID="1346769469000.process.162998590@officedepot.com" timestamp="2012-09-04T02:37:49-05:00">
+<cXML version="1.2.020" payloadID="1346769469000.process.162998590@officedepot.com" timestamp="2012-09-04T02:37:49-05:00">
     <Response>
         <Status code="200" text="OK"/>
         <PunchOutSetupResponse>

data/spec/fixtures/response_status_400.xml

@@ -1,5 +1,5 @@
-<cXML version="1.2.011" payloadID="1352382581000.process.454701738@domain.com" timestamp="2012-11-08T01:49:41-05:00">
+<cXML version="1.2.020" payloadID="1352382581000.process.454701738@domain.com" timestamp="2012-11-08T01:49:41-05:00">
 <Response>
 <Status code="400" text="java.lang.Exception: missing required parameter 'document'"/>
 </Response>
-</cXML>
+</cXML>

data/spec/invoice_detail_request_spec.rb

@@ -50,34 +50,54 @@ describe CXML::InvoiceDetailRequest do
       data = CXML::Parser.new(data: fixture('invoice_taxes_at_line.xml')).parse
       doc = CXML::Document.new(data)
       CXML::Parser.new(data: doc.to_xml).parse.should eq(data)
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(doc).should be true
     end
     it 'serializes the same output' do
       data = CXML::Parser.new(data: fixture('invoice_backed_and_unbacked_by_pos.xml')).parse
       doc = CXML::Document.new(data)
       CXML::Parser.new(data: doc.to_xml).parse.should eq(data)
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(doc).should be true
     end
     it 'serializes the same output' do
       data = CXML::Parser.new(data: fixture('invoice_backed_by_multiple_pos.xml')).parse
       doc = CXML::Document.new(data)
       CXML::Parser.new(data: doc.to_xml).parse.should eq(data)
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(doc).should be true
     end
     it 'serializes the same output' do
       data = CXML::Parser.new(data: fixture('invoice_taxes_at_line_multiple_taxes.xml')).parse
       doc = CXML::Document.new(data)
       CXML::Parser.new(data: doc.to_xml).parse.should eq(data)
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(doc).should be true
     end
     it 'serializes the same output' do
       fixture_xml = fixture('invoice_taxes_at_total.xml')
       data = CXML::Parser.new(data: fixture_xml).parse
       doc = CXML::Document.new(data)
       CXML::Parser.new(data: doc.to_xml).parse.should eq(data)
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(doc).should be true
     end
     it 'serializes from an instance' do
       money = CXML::Money.new(amount: '5', currency: 'USD')
       summary = CXML::InvoiceDetailSummary.new(gross_amount: CXML::GrossAmount.new(money: money))
       instance = described_class.new(invoice_detail_summary: summary)
       data = CXML::Request.new(invoice_detail_request: instance)
-      doc = CXML::Document.new(request: data)
+      doc = CXML::Document.new(
+        request: data,
+        header: CXML::Header.new,
+        dtd: 'InvoiceDetail',
+        payload_id: 'foo'
+      )
       parsed = CXML::Parser.new(data: doc.to_xml).parse
       parsed[:request][:invoice_detail_request]
         .should eq(instance.serializable_hash)

data/spec/item_in_spec.rb

@@ -35,5 +35,10 @@ describe CXML::ItemIn do
       item_in_output_data[:item_id].should_not be_empty
       item_in_output_data[:item_detail].should_not be_empty
     end
+    it 'validates against the DTD' do
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(CXML::Document.new.from_xml(output_xml)).should be true
+    end
   end
 end

data/spec/punch_out_order_message_spec.rb

@@ -36,5 +36,10 @@ describe CXML::PunchOutOrderMessage do
       punch_out_order_message_output_data[:buyer_cookie].should_not be_empty
       punch_out_order_message_output_data.should include(:item_in)
     end
+    it 'validates against the DTD' do
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(CXML::Document.new.from_xml(output_xml)).should be true
+    end
   end
 end

data/spec/punch_out_setup_request_spec.rb

@@ -38,6 +38,8 @@ describe CXML::PunchOutSetupRequest do
       doc = CXML::Document.new(data)
       doc.request.punch_out_setup_request.ship_to.should_not be_nil
       doc.request.punch_out_setup_request.ship_to.address.name.should_not be_nil
+      doc.request.punch_out_setup_request.ship_to.address.phone.should_not be_nil
+      doc.request.punch_out_setup_request.ship_to.address.phone.telephone_number.should_not be_nil
     end
   end
 

data/spec/purchase_order_request_spec.rb

@@ -19,6 +19,11 @@ describe CXML::OrderRequest do
       order_request_output_data[:item_out].should be_a Array
       order_request_output_data[:item_out].length.should eq 2
     end
+    it 'validates against the DTD' do
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(doc).should be true
+    end
   end
   describe '#initialize' do
     it 'sets the required nodes' do
@@ -27,7 +32,7 @@ describe CXML::OrderRequest do
       order_request.items_out.first.should_not be_nil
     end
     it 'sets the required nodes via another  order request' do
-      request = CXML::Document.new.from_xml(fixture('order_request.cxml')).request
+      request = CXML::Document.new.from_xml(fixture('order_request.xml')).request
       request.order_request.order_request_header.should_not be_nil
       request.order_request.order_request_header.order_id.should_not be_nil
       request.order_request.items_out.first.should_not be_nil

data/spec/sender_spec.rb

@@ -26,5 +26,11 @@ describe CXML::Sender do
       sender_output_data[:user_agent].should_not be_empty
       sender_output_data[:credential].should_not be_empty
     end
+
+    it 'validates against the DTD' do
+      next unless test_for_xmllint
+
+      lint_doc_with_dtd(CXML::Document.new.from_xml(output_xml)).should be true
+    end
   end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.expect_with(:rspec) { |c| c.syntax = :should }
+  config.default_formatter = 'doc' if config.files_to_run.one?
 end
 
 def fixture_path(filename = nil)
@@ -19,3 +20,29 @@ end
 def fixture(file)
   File.read(File.join(fixture_path, file))
 end
+
+def dtd_path_from_url(url)
+  return 'spec/fixtures/1.2.037-cXML.dtd' unless url
+
+  match = url.match(%r{/(\d+\.\d+\.\d+)/(\w+\.dtd)}).to_a
+  file = "spec/fixtures/#{match.last(2).join('-')}"
+  return file if File.exist?(file)
+
+  system("curl #{url} -O && mv #{match.last} #{file}")
+  file
+end
+
+def test_for_xmllint
+  return true if system('type xmllint > /dev/null 2>&1')
+
+  puts 'skipping DTD validation without xmllint'
+  false
+end
+
+def lint_doc_with_dtd(doc)
+  file = "spec/output/#{rand}.xml"
+  File.open(file, 'w') { |f| f.puts doc.to_xml }
+  linted = system("xmllint --noout --dtdvalid #{dtd_path_from_url(doc.dtd_url)} #{file}")
+  File.delete(file) if File.exist?(file)
+  linted
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cxml-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Josh Beckman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -108,16 +108,19 @@ files:
 - lib/cxml/browser_form_post.rb
 - lib/cxml/charge.rb
 - lib/cxml/classification.rb
+- lib/cxml/comment.rb
 - lib/cxml/confirmation_header.rb
 - lib/cxml/confirmation_item.rb
 - lib/cxml/confirmation_request.rb
 - lib/cxml/confirmation_status.rb
 - lib/cxml/contact.rb
 - lib/cxml/country.rb
+- lib/cxml/country_code.rb
 - lib/cxml/credential.rb
 - lib/cxml/credential_mac.rb
 - lib/cxml/deducted_price.rb
 - lib/cxml/deduction_amount.rb
+- lib/cxml/deposit_amount.rb
 - lib/cxml/description.rb
 - lib/cxml/discount.rb
 - lib/cxml/discount_percent.rb
@@ -168,6 +171,7 @@ files:
 - lib/cxml/parser.rb
 - lib/cxml/payment_term.rb
 - lib/cxml/period.rb
+- lib/cxml/phone.rb
 - lib/cxml/postal_address.rb
 - lib/cxml/protocol.rb
 - lib/cxml/punch_out_order_message.rb
@@ -193,6 +197,7 @@ files:
 - lib/cxml/tax_detail.rb
 - lib/cxml/tax_location.rb
 - lib/cxml/taxable_amount.rb
+- lib/cxml/telephone_number.rb
 - lib/cxml/to.rb
 - lib/cxml/total.rb
 - lib/cxml/total_allowances.rb
@@ -204,6 +209,11 @@ files:
 - spec/cxml_spec.rb
 - spec/document_spec.rb
 - spec/fixtures/.gitkeep
+- spec/fixtures/1.2.014-cXML.dtd
+- spec/fixtures/1.2.020-InvoiceDetail.dtd
+- spec/fixtures/1.2.020-cXML.dtd
+- spec/fixtures/1.2.037-InvoiceDetail.dtd
+- spec/fixtures/document_node_with_unknown_attribute.xml
 - spec/fixtures/envelope.xml
 - spec/fixtures/envelope2.xml
 - spec/fixtures/invoice_backed_and_unbacked_by_pos.xml
@@ -212,7 +222,7 @@ files:
 - spec/fixtures/invoice_taxes_at_line_multiple_taxes.xml
 - spec/fixtures/invoice_taxes_at_total.xml
 - spec/fixtures/item_in.xml
-- spec/fixtures/order_request.cxml
+- spec/fixtures/order_request.xml
 - spec/fixtures/punch_out_order_message_doc.xml
 - spec/fixtures/punch_out_setup_request_doc.xml
 - spec/fixtures/punch_out_setup_request_doc_coupa.xml
@@ -227,6 +237,7 @@ files:
 - spec/item_id_spec.rb
 - spec/item_in_spec.rb
 - spec/money_spec.rb
+- spec/output/.gitkeep
 - spec/parser_spec.rb
 - spec/protocol_spec.rb
 - spec/punch_out_order_message_header_spec.rb
@@ -251,7 +262,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -267,6 +278,11 @@ test_files:
 - spec/cxml_spec.rb
 - spec/document_spec.rb
 - spec/fixtures/.gitkeep
+- spec/fixtures/1.2.014-cXML.dtd
+- spec/fixtures/1.2.020-InvoiceDetail.dtd
+- spec/fixtures/1.2.020-cXML.dtd
+- spec/fixtures/1.2.037-InvoiceDetail.dtd
+- spec/fixtures/document_node_with_unknown_attribute.xml
 - spec/fixtures/envelope.xml
 - spec/fixtures/envelope2.xml
 - spec/fixtures/invoice_backed_and_unbacked_by_pos.xml
@@ -275,7 +291,7 @@ test_files:
 - spec/fixtures/invoice_taxes_at_line_multiple_taxes.xml
 - spec/fixtures/invoice_taxes_at_total.xml
 - spec/fixtures/item_in.xml
-- spec/fixtures/order_request.cxml
+- spec/fixtures/order_request.xml
 - spec/fixtures/punch_out_order_message_doc.xml
 - spec/fixtures/punch_out_setup_request_doc.xml
 - spec/fixtures/punch_out_setup_request_doc_coupa.xml
@@ -290,6 +306,7 @@ test_files:
 - spec/item_id_spec.rb
 - spec/item_in_spec.rb
 - spec/money_spec.rb
+- spec/output/.gitkeep
 - spec/parser_spec.rb
 - spec/protocol_spec.rb
 - spec/punch_out_order_message_header_spec.rb