cxml-ruby 0.2.0

data/lib/cxml/credential_mac.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# The CredentialMac element is used for the Message Authentication Code (MAC)
+# authentication method. This authentication method is used in situations where the
+# sender must prove to the receiver that it has been authenticated by shared secret by a
+# trusted third party. For example, a direct PunchOut request can travel directly from a
+# buyer to a supplier without going through a network commerce hub, because it
+# contains a MAC (generated by the network commerce hub) that allows the supplier to
+# authenticate it.
+# The trusted third party computes the MAC and transfers it to the sender through the
+# Profile transaction. The MAC is opaque to the sender (it is secure and non-reversible).
+# To see how the MAC is transmitted from the trusted third party to the sender, see
+# "ProfileResponse" on page 63.
+#
+# Page 45 cXML reference
+
+module CXML
+  class CredentialMac < DocumentNode
+    accessible_attributes %i[
+      type
+      algorithm
+      creation_date
+      expiration_date
+    ]
+  end
+end

data/lib/cxml/deducted_price.rb

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

data/lib/cxml/deduction_amount.rb

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

data/lib/cxml/description.rb

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

data/lib/cxml/discount.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  class Discount < DocumentNode
+    accessible_nodes %i[
+      discount_percent
+      discount_due_days
+    ]
+  end
+end

data/lib/cxml/discount_percent.rb

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

data/lib/cxml/distribution.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CXML
+  # accounting info for ItemOut
+  class Distribution < DocumentNode
+    accessible_nodes %i[
+      accounting
+      charge
+    ]
+  end
+end

data/lib/cxml/document.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require('time')
+
+module CXML
+  class Document < DocumentNode
+    accessible_attributes %i[
+      version
+      payload_id
+      xml_lang
+      timestamp
+    ]
+    accessible_nodes %i[
+      header
+      message
+      request
+      response
+    ]
+
+    def initialize_timestamp(value)
+      @timestamp = Time.parse(value)
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.utc
+    end
+
+    def version
+      @version ||= '1.2.037'
+    end
+
+    def from_xml(xml_string)
+      initialize(Parser.new.parse(xml_string))
+      self
+    end
+
+    # Check if document is request
+    # @return [Boolean]
+    def request?
+      !request.nil?
+    end
+
+    # Check if document is a response
+    # @return [Boolean]
+    def response?
+      !response.nil?
+    end
+
+    # Check if document is a message
+    # @return [Boolean]
+    def message?
+      !message.nil?
+    end
+
+    def render
+      node = CXML.builder
+      node.doc.create_internal_subset(
+        'cXML',
+        nil,
+        "http://xml.cxml.org/schemas/cXML/#{version}/cXML.dtd"
+      )
+      node.cXML(node_attributes) do |doc|
+        header&.render(doc)
+        request&.render(doc)
+        response&.render(doc)
+        message&.render(doc)
+      end
+      node
+    end
+  end
+end

data/lib/cxml/document_node.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module CXML
+  # base class for document nodes
+  class DocumentNode
+    attr_accessor :content
+
+    def self.accessible_attributes(attrs)
+      raise(ArgumentError) unless attrs.is_a?(Array)
+
+      @attributes = attrs
+      attr_accessor(*attrs)
+    end
+
+    def self.attributes
+      @attributes || []
+    end
+
+    def self.accessible_nodes(new_nodes)
+      raise(ArgumentError) unless new_nodes.is_a?(Array)
+
+      @nodes = new_nodes
+      attr_accessor(*new_nodes)
+    end
+
+    def self.nodes
+      @nodes || []
+    end
+
+    def initialize(data = {})
+      if data.is_a?(String)
+        @content = data
+        return
+      end
+      data = data.serializable_hash if data.is_a?(self.class)
+      return unless data.is_a?(Hash)
+
+      data.each(&method(:initialize_attribute))
+    end
+
+    def serializable_hash
+      (self.class.attributes + self.class.nodes + [:content]).each_with_object({}) do |attr, obj|
+        value = send(attr)
+        value = value.iso8601 if value.is_a?(Time)
+        next if value.respond_to?(:empty?) ? value.empty? : !value
+
+        obj[attr] = value.is_a?(DocumentNode) ? value.serializable_hash : value
+      end
+    end
+
+    def render(node = CXML.builder)
+      node.send(self.class.name.split('::').last, node_attributes) do |n|
+        n.text(content) if content
+        render_nodes(n)
+      end
+      node
+    end
+
+    def render_nodes(node)
+      self.class.nodes.each do |child_node_name|
+        child_value = send(child_node_name)
+        if child_value.is_a?(Array)
+          child_value.each do |child_value_n|
+            render_child_node(node, child_node_name, child_value_n)
+          end
+        else
+          render_child_node(node, child_node_name, child_value)
+        end
+      end
+    end
+
+    private
+
+    def render_child_node(node, name, value)
+      return if value.respond_to?(:empty?) ? value.empty? : !value
+
+      if value.is_a?(DocumentNode)
+        value.render(node)
+      else
+        node.send(camelize(name), value)
+      end
+    end
+
+    def node_attributes
+      self.class.attributes.each_with_object({}) do |attr, obj|
+        value = send(attr)
+        value = value.iso8601 if value.is_a?(Time)
+        next if value.respond_to?(:empty?) ? value.empty? : !value
+
+        string_attr = if attr.to_sym == :xml_lang
+                        'xml:lang'
+                      else
+                        camelize(attr, false)
+                      end
+        obj[string_attr] = value
+      end
+    end
+
+    def initialize_attribute(key, val)
+      return send("initialize_#{key}", val) if respond_to?("initialize_#{key}")
+      return send("#{key}=", val) if self.class.attributes.include?(key)
+
+      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)
+    rescue NameError => e
+      raise(e) unless e.to_s.match?(klass)
+
+      send("#{key}=", val)
+    end
+
+    def camelize(string, uppercase_first_letter = true)
+      string = if uppercase_first_letter
+                 string.to_s.sub(/^[a-z\d]*/, &:capitalize)
+               else
+                 string.to_s.sub(/^(?:(?=\b|[A-Z_])|\w)/, &:downcase)
+               end
+      string.gsub(/_id(_)?$/, '_ID\1').gsub(%r{(?:_|(/))([a-z\d]*)}) do
+        "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+      end.gsub('/', '::')
+    end
+  end
+end

data/lib/cxml/document_reference.rb

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

data/lib/cxml/due_amount.rb

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

data/lib/cxml/email.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  # address, typically in a purchase order message
+  class Email < DocumentNode
+    accessible_attributes %i[
+      name
+    ]
+  end
+end

data/lib/cxml/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CXML
+  class Error < StandardError; end
+  class ParseError < Error; end
+  class UnknownAttributeError < ParseError; end
+end

data/lib/cxml/extrinsic.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  # class for extrinsic data in punchout setup request
+  class Extrinsic < DocumentNode
+    accessible_attributes %i[
+      name
+    ]
+  end
+end

data/lib/cxml/from.rb

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

data/lib/cxml/gross_amount.rb

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

data/lib/cxml/header.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# The Header element contains addressing and authentication information. The Header
+# element is the same regardless of the specific Request or Response within the body of
+# the cXML message. Applications need the requestor's identity, but not validation that
+# the information provided for identity is correct.
+#
+# The From and To elements are synonymous with From and To in SMTP mail
+# messages; they are the logical source and destination of the messages. Sender is the
+# party that opens the HTTP connection and sends the cXML document.
+# Sender contains the Credential element, which allows the receiving party to authenticate
+# the sending party. This credential allows strong authentication without requiring a
+# public-key end-to-end digital certificate infrastructure. Only a user name and
+# password need to be issued by the receiving party to allow the sending party to
+# perform Requests.
+#
+# When the document is initially sent, Sender and From are the same, However, if the
+# cXML document travels through e-commerce network hubs, the Sender element
+# changes to indicate current sending party.
+
+module CXML
+  class Header < DocumentNode
+    accessible_nodes %i[
+      from
+      to
+      sender
+    ]
+  end
+end

data/lib/cxml/id_reference.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CXML
+  class IdReference < DocumentNode
+    accessible_attributes %i[
+      domain
+      identifier
+    ]
+    accessible_nodes %i[
+      description
+    ]
+  end
+end

data/lib/cxml/invoice_detail_discount.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailDiscount < DocumentNode
+    accessible_attributes %i[
+      percentage_rate
+    ]
+    accessible_nodes %i[
+      money
+      distribution
+    ]
+  end
+end

data/lib/cxml/invoice_detail_header_indicator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailHeaderIndicator < DocumentNode
+    accessible_attributes %i[
+      is_header_invoice
+      is_vat_recoverable
+      price_based_line_level_credit_memo
+    ]
+  end
+end

data/lib/cxml/invoice_detail_header_order.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailHeaderOrder < DocumentNode
+    accessible_nodes %i[
+      invoice_detail_order_info
+      invoice_detail_order_summaries
+    ]
+
+    def initialize_invoice_detail_order_summary(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_order_summaries = value.map do |item|
+        InvoiceDetailOrderSummary.new(item)
+      end
+    end
+
+    def initialize_invoice_detail_order_summaries(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_order_summaries = value.map do |item|
+        InvoiceDetailOrderSummary.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/invoice_detail_item.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailItem < DocumentNode
+    accessible_attributes %i[
+      composite_item_type
+      inspection_date
+      invoice_line_number
+      is_ad_hoc
+      item_type
+      parent_invoice_line_number
+      quantity
+      reason
+      reference_date
+    ]
+    accessible_nodes %i[
+      comments
+      distribution
+      extrinsics
+      gross_amount
+      invoice_detail_discount
+      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)
+      value = [value] unless value.is_a?(Array)
+      @extrinsics = value.map do |item|
+        Extrinsic.new(item)
+      end
+    end
+
+    def initialize_extrinsics(value)
+      value = [value] unless value.is_a?(Array)
+      @extrinsics = value.map do |item|
+        Extrinsic.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/invoice_detail_item_reference.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailItemReference < DocumentNode
+    accessible_attributes %i[
+      line_number
+    ]
+    accessible_nodes %i[
+      description
+      item_id
+      classification
+      manufacturer_part_id
+      manufacturer_name
+      country
+    ]
+  end
+end

data/lib/cxml/invoice_detail_line_indicator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailLineIndicator < DocumentNode
+    accessible_attributes %i[
+      is_tax_in_line
+      is_special_handling_in_line
+      is_shipping_in_line
+      is_discount_in_line
+      is_accounting_in_line
+      is_price_adjustment_in_line
+    ]
+  end
+end

data/lib/cxml/invoice_detail_line_shipping.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailLineShipping < DocumentNode
+    accessible_nodes %i[
+      invoice_detail_shipping
+      money
+      distribution
+    ]
+  end
+end

data/lib/cxml/invoice_detail_line_special_handling.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailLineSpecialHandling < DocumentNode
+    accessible_nodes %i[
+      description
+      money
+      distribution
+    ]
+  end
+end

data/lib/cxml/invoice_detail_order.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailOrder < DocumentNode
+    accessible_nodes %i[
+      invoice_detail_order_info
+      invoice_detail_items
+    ]
+
+    def initialize_invoice_detail_item(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_items = value.map do |item|
+        InvoiceDetailItem.new(item)
+      end
+    end
+
+    def initialize_invoice_detail_items(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_items = value.map do |item|
+        InvoiceDetailItem.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/invoice_detail_order_info.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailOrderInfo < DocumentNode
+    accessible_nodes %i[
+      order_reference
+      master_agreement_reference
+    ]
+  end
+end

data/lib/cxml/invoice_detail_order_summary.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailOrderSummary < DocumentNode
+    accessible_attributes %i[
+      invoice_line_number
+      inspection_date
+    ]
+    accessible_nodes %i[
+      subtotal_amount
+      period
+      tax
+      invoice_detail_line_special_handling
+      invoice_detail_line_shipping
+      gross_amount
+    ]
+
+    def initialize_invoice_detail_order_summary(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_order_summaries = value.map do |item|
+        InvoiceDetailOrderSummary.new(item)
+      end
+    end
+
+    def initialize_invoice_detail_order_summaries(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_order_summaries = value.map do |item|
+        InvoiceDetailOrderSummary.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/invoice_detail_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailRequest < DocumentNode
+    accessible_nodes %i[
+      invoice_detail_request_header
+      invoice_detail_header_orders
+      invoice_detail_orders
+      invoice_detail_summary
+    ]
+
+    def initialize_invoice_detail_orders(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_orders = value.map do |item|
+        InvoiceDetailOrder.new(item)
+      end
+    end
+
+    def initialize_invoice_detail_order(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_orders = value.map do |item|
+        InvoiceDetailOrder.new(item)
+      end
+    end
+
+    def initialize_invoice_detail_header_orders(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_header_orders = value.map do |item|
+        InvoiceDetailHeaderOrder.new(item)
+      end
+    end
+
+    def initialize_invoice_detail_header_order(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_detail_header_orders = value.map do |item|
+        InvoiceDetailHeaderOrder.new(item)
+      end
+    end
+  end
+end