cxml-ruby 0.4.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b4bf64619173383fb1d6bbb76d1877bc70746752d884b6f9d79f967fcb70c0
-  data.tar.gz: 2f42907da9ebe23561a44f0a39ac1143e32660b465c5b19cea13dbbcd1328ee4
+  metadata.gz: 125ea774cb74155d9512b222d1d47a06945558d87d441dd1491d53caf8e9ca9a
+  data.tar.gz: 986ef57d03cf1706eedf08618dc5b52931171f42b147e1d81dfabaf6a6c32df8
 SHA512:
-  metadata.gz: 18ab3bad5fb8231724c14e29eb19c71ed1abdca1c9efd45832de27d46125070a705790a7813926f2f21273fdc010238de30d2405a251bcc28af389f5e075db76
-  data.tar.gz: 5b3206398d10770f12215be79a4f6877db2d6efafc9679e31cc08a756384247466c90cd061b3f044befbfc39e631f35cb0029f83792dce69220e9ca75e05347d
+  metadata.gz: ebfe04583c735c1635a14d89cc49d4f1494b1d49b79efa7d072d261b1d91d0831a5f5d644fcfde75c54c572528fcca499288b4393dfdf86b33958d065b167d3b
+  data.tar.gz: 3a97f6bcc16715eae27f2ef9a8f4ade47281f092116458fc784224bd46d97cdae1f29e65234d07946ef7027accdce0e91dd9635003f8064c8b4af7730d0c1857

data/.github/workflows/ruby.yml

@@ -15,6 +15,7 @@ jobs:
         ruby-version: 2.6.x
     - name: Test with Rake
       run: |
+        sudo apt-get install libxml2-utils
         gem install bundler
         bundle install --jobs 4 --retry 3
         bundle exec rake

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   Exclude:
     - Gemfile
     - vendor/**/*
+  NewCops: enable
 
 # # Disable checking for block length
 Metrics/BlockLength:
@@ -54,6 +55,9 @@ Style/Documentation:
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Style/ArrayCoercion:
+  Enabled: false
+
 Style/HashEachMethods:
   Enabled: true
 

data/CHANGELOG.md

@@ -14,9 +14,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
-## [0.4.1] - 2020-04-20
+## [0.8.0] - 2021-04-25
 ### Changed
-- Cast all node content values to strings before passing to Ox serializer.
+- Support continued parsing of child nodes if unknown attribute is encountered with `raise_unknown_elements` set to `false`.
+
+## [0.7.0] - 2021-01-12
+### Added
+- Support parsing Phone tags.
+
+## [0.6.1] - 2020-09-04
+### Fixed
+- Handle parsing CDATA tags in cXML content (Thanks @CRiva!).
+
+## [0.6.0] - 2020-05-01
+### Fixed
+- Conform to cXML DTD spec for ordered output of child nodes.
+### Added
+- Support parsing and validating output against DTDs in specs.
+
+## [0.5.0] - 2020-04-30
+### Added
+- Support parsing and specifying different DTDs.
 
 ## [0.4.0] - 2020-04-20
 ### Changed

data/cxml-ruby.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.authors     = ['Josh Beckman', 'Eleni Chappen']
   s.email       = ['josh@officeluv.com', 'eleni@officeluv.com']
 
+  s.required_ruby_version = '>= 2.4'
   s.add_dependency('ox', '~> 2.13')
 
   s.add_development_dependency('pry', '~> 0.12')

data/lib/cxml-ruby.rb

@@ -26,7 +26,7 @@ module CXML
   def self.logger
     return @logger if @logger
 
-    @logger ||= Logger.new(STDOUT, level: :warn)
+    @logger ||= Logger.new($stdout, level: :warn)
   end
 
   def self.logger=(new_logger)

data/lib/cxml/address.rb

@@ -8,9 +8,12 @@ module CXML
       iso_country_code
     ]
     accessible_nodes %i[
-      email
       name
       postal_address
+      email
+      phone
+      fax
+      url
     ]
   end
 end

data/lib/cxml/comment.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CXML
+  class Comments < DocumentNode
+    accessible_attributes %i[
+      xml_lang
+    ]
+  end
+end

data/lib/cxml/contact.rb

@@ -8,9 +8,12 @@ module CXML
       address_id
     ]
     accessible_nodes %i[
-      email
       name
       postal_address
+      email
+      phone
+      fax
+      url
     ]
   end
 end

data/lib/cxml/country_code.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CXML
+  class CountryCode < DocumentNode
+    accessible_attributes %i[
+      iso_country_code
+    ]
+  end
+end

data/lib/cxml/credential.rb

@@ -41,8 +41,8 @@ module CXML
       type
     ]
     accessible_nodes %i[
-      shared_secret
       identity
+      shared_secret
       credential_mac
     ]
   end

data/lib/cxml/deposit_amount.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CXML
+  class DepositAmount < DocumentNode
+    accessible_nodes %i[
+      money
+    ]
+  end
+end

data/lib/cxml/document.rb

@@ -2,11 +2,13 @@
 
 module CXML
   class Document < DocumentNode
+    attr_writer :dtd
+
     accessible_attributes %i[
-      version
       payload_id
-      xml_lang
       timestamp
+      version
+      xml_lang
     ]
     accessible_nodes %i[
       header
@@ -27,6 +29,10 @@ module CXML
       @version ||= '1.2.037'
     end
 
+    def dtd
+      @dtd ||= 'cXML'
+    end
+
     # Check if document is request
     # @return [Boolean]
     def request?
@@ -59,18 +65,17 @@ module CXML
       'cXML'
     end
 
-    private
-
     def dtd_url
-      "http://xml.cxml.org/schemas/cXML/#{version}/cXML.dtd"
+      "http://xml.cxml.org/schemas/cXML/#{version}/#{dtd}.dtd"
     end
 
+    private
+
     def ox_doc
       doc = Ox::Document.new
       instruct = Ox::Instruct.new(:xml)
       instruct[:version] = '1.0'
       instruct[:encoding] = 'UTF-8'
-      instruct[:standalone] = 'yes'
       doc << instruct
       doc << Ox::DocType.new("cXML SYSTEM \"#{dtd_url}\"")
       doc

data/lib/cxml/document_node.rb

@@ -108,7 +108,7 @@ module CXML
         string_attr = if attr.to_sym == :xml_lang
                         'xml:lang'
                       else
-                        camelize(attr, false)
+                        camelize(attr, uppercase_first_letter: false)
                       end
         obj[string_attr] = value
       end
@@ -121,9 +121,7 @@ module CXML
       klass = "CXML::#{camelize(key)}"
       send("#{key}=", Object.const_get(klass).new(val))
     rescue NoMethodError => e
-      raise(UnknownAttributeError, e) if CXML.raise_unknown_elements
-
-      CXML.logger.warn(e)
+      handle_unknown_elements_error(e)
     rescue NameError => e
       raise(e) unless e.to_s.match?(klass)
 
@@ -136,9 +134,11 @@ module CXML
       else
         send("#{key}=", val)
       end
+    rescue NoMethodError => e
+      handle_unknown_elements_error(e)
     end
 
-    def camelize(string, uppercase_first_letter = true)
+    def camelize(string, uppercase_first_letter: true)
       string = if uppercase_first_letter
                  string.to_s.sub(/^[a-z\d]*/, &:capitalize)
                else
@@ -150,5 +150,11 @@ module CXML
         "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
       end.gsub('/', '::')
     end
+
+    def handle_unknown_elements_error(error)
+      raise(UnknownAttributeError, error) if CXML.raise_unknown_elements
+
+      CXML.logger.warn(error)
+    end
   end
 end

data/lib/cxml/invoice_detail_item.rb

@@ -14,28 +14,28 @@ module CXML
       reference_date
     ]
     accessible_nodes %i[
-      comments
-      distribution
-      extrinsics
+      unit_of_measure
+      unit_price
+      invoice_detail_item_reference
+      subtotal_amount
+      tax
+      invoice_detail_line_special_handling
+      invoice_detail_line_shipping
       gross_amount
       invoice_detail_discount
+      net_amount
+      distribution
+      comments
+      extrinsics
       invoice_detail_item_industry
-      invoice_detail_item_reference
-      invoice_detail_line_shipping
-      invoice_detail_line_special_handling
       invoice_item_modifications
-      net_amount
       packaging
       price_basis_quantity
       ship_notice_id_info
       ship_notice_line_item_reference
-      subtotal_amount
-      tax
       total_allowances
       total_amount_without_tax
       total_charges
-      unit_of_measure
-      unit_price
     ]
 
     def initialize_extrinsic(value)

data/lib/cxml/invoice_detail_item_reference.rb

@@ -6,12 +6,14 @@ module CXML
       line_number
     ]
     accessible_nodes %i[
-      description
       item_id
+      description
       classification
       manufacturer_part_id
       manufacturer_name
       country
+      serial_number
+      supplier_batch_id
     ]
   end
 end

data/lib/cxml/invoice_detail_request_header.rb

@@ -11,16 +11,16 @@ module CXML
       purpose
     ]
     accessible_nodes %i[
-      comments
-      document_reference
-      extrinsics
       invoice_detail_header_indicator
       invoice_detail_line_indicator
-      invoice_detail_shipping
-      invoice_id_info
       invoice_partners
+      document_reference
+      invoice_id_info
+      invoice_detail_shipping
       payment_term
       period
+      comments
+      extrinsics
     ]
 
     def initialize_invoice_partner(value)

data/lib/cxml/invoice_detail_summary.rb

@@ -3,13 +3,15 @@
 module CXML
   class InvoiceDetailSummary < DocumentNode
     accessible_nodes %i[
+      subtotal_amount
+      tax
+      special_handling_amount
+      shipping_amount
       gross_amount
       invoice_detail_discount
       net_amount
-      shipping_amount
-      special_handling_amount
-      subtotal_amount
-      tax
+      deposit_amount
+      due_amount
       total_allowances
       total_amount_without_tax
       total_charges

data/lib/cxml/item_detail.rb

@@ -3,10 +3,14 @@
 module CXML
   class ItemDetail < DocumentNode
     accessible_nodes %i[
+      unit_price
       description
       unit_of_measure
-      unit_price
       classification
+      manufacturer_part_id
+      manufacturer_name
+      url
+      lead_time
       extrinsics
     ]
 

data/lib/cxml/order_request_header.rb

@@ -23,26 +23,27 @@ module CXML
       type
     ]
     accessible_nodes %i[
+      total
+      ship_to
       bill_to
-      comments
+      shipping
+      tax
+      payment
+      payment_term
       contact
-      control_keys
-      delivery_period
+      comments
+      followup
       document_reference
+      supplier_order_info
       extrinsics
+      control_keys
+      delivery_period
       followup
       id_reference
       legal_identity
       order_request_header_industry
       organizational_unit
-      payment
-      payment_term
-      ship_to
-      shipping
-      supplier_order_info
-      tax
       terms_of_delivery
-      total
     ]
 
     def type

data/lib/cxml/parser.rb

@@ -11,28 +11,55 @@ module CXML
 
     def parse
       @parsed_data = node_to_hash document
+      if dtd_url
+        @parsed_data[:version] = version
+        @parsed_data[:dtd] = dtd
+      end
+      @parsed_data
     end
 
     def document
       doc = Ox.load(data)
+      @doc_type_string = doc.nodes.detect do |node|
+        node.value&.match?(/^cXML /)
+      end&.value
       doc.nodes.detect do |node|
         node.value&.match?(/^cxml$/i)
       end || doc
     end
 
+    def version
+      dtd_url&.match(%r{cXML/(.*)/.*\.dtd})&.to_a&.last
+    end
+
+    def dtd
+      dtd_url&.match(%r{cXML/.*/(.*)\.dtd})&.to_a&.last
+    end
+
+    def dtd_url
+      return nil unless @doc_type_string
+
+      @doc_type_string.match(/http.*\.dtd/)&.to_a&.first
+    end
+
     private
 
-    def node_to_hash(node) # rubocop:disable Metrics/AbcSize
+    def node_to_hash(node)
+      return node.value if node.is_a?(Ox::CData)
       return node if node.is_a? String
       return node.nodes.first if node.nodes.all?(String) && node.attributes.empty?
 
+      transform_node_to_hash node
+    end
+
+    def transform_node_to_hash(node)
       hash = node.attributes
       hash.transform_keys!(&method(:underscore_key))
       node.nodes.reduce(hash) do |acc, child_node|
         next acc if child_node.is_a?(Ox::Comment)
 
         node_hash = {}
-        name = child_node.is_a?(String) ? :content : child_node.value
+        name = child_node.is_a?(String) || child_node.is_a?(Ox::CData) ? :content : child_node.value
         node_hash[underscore_key(name)] = node_to_hash(child_node)
         acc.merge(node_hash) do |_key, val1, val2|
           [val1, val2].flatten