cxml-ruby 0.2.0

data/lib/cxml/invoice_detail_request_header.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailRequestHeader < DocumentNode
+    accessible_attributes %i[
+      invoice_date
+      invoice_id
+      invoice_origin
+      is_information_only
+      operation
+      purpose
+    ]
+    accessible_nodes %i[
+      comments
+      document_reference
+      extrinsics
+      invoice_detail_header_indicator
+      invoice_detail_line_indicator
+      invoice_detail_shipping
+      invoice_id_info
+      invoice_partners
+      payment_term
+      period
+    ]
+
+    def initialize_invoice_partner(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_partners = value.map do |item|
+        InvoicePartner.new(item)
+      end
+    end
+
+    def initialize_invoice_partners(value)
+      value = [value] unless value.is_a?(Array)
+      @invoice_partners = value.map do |item|
+        InvoicePartner.new(item)
+      end
+    end
+
+    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_shipping.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailShipping < DocumentNode
+    accessible_attributes %i[
+      shipping_date
+    ]
+    accessible_nodes %i[
+      contacts
+      document_reference
+    ]
+
+    def initialize_contact(value)
+      value = [value] unless value.is_a?(Array)
+      @contacts = value.map do |item|
+        Contact.new(item)
+      end
+    end
+
+    def initialize_contacts(value)
+      value = [value] unless value.is_a?(Array)
+      @contacts = value.map do |item|
+        Contact.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/invoice_detail_summary.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceDetailSummary < DocumentNode
+    accessible_nodes %i[
+      gross_amount
+      invoice_detail_discount
+      net_amount
+      shipping_amount
+      special_handling_amount
+      subtotal_amount
+      tax
+      total_allowances
+      total_amount_without_tax
+      total_charges
+    ]
+  end
+end

data/lib/cxml/invoice_id_info.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoiceIDInfo < DocumentNode
+    accessible_attributes %i[
+      invoice_id
+      invoice_date
+    ]
+  end
+end

data/lib/cxml/invoice_partner.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  class InvoicePartner < DocumentNode
+    accessible_nodes %i[
+      contact
+      id_reference
+    ]
+  end
+end

data/lib/cxml/item_detail.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CXML
+  class ItemDetail < DocumentNode
+    accessible_nodes %i[
+      description
+      unit_of_measure
+      unit_price
+      classification
+      extrinsics
+    ]
+
+    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/item_id.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  class ItemID < DocumentNode
+    accessible_nodes %i[
+      supplier_part_id
+      supplier_part_auxiliary_id
+    ]
+  end
+end

data/lib/cxml/item_in.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CXML
+  class ItemIn < DocumentNode
+    accessible_attributes %i[
+      quantity
+      line_number
+    ]
+    accessible_nodes %i[
+      item_id
+      item_detail
+    ]
+  end
+end

data/lib/cxml/item_out.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CXML
+  # items in purchase order message
+  class ItemOut < DocumentNode
+    accessible_attributes %i[
+      quantity
+      line_number
+    ]
+    accessible_nodes %i[
+      item_id
+      item_detail
+      distribution
+      comments
+    ]
+  end
+end

data/lib/cxml/master_agreement_reference.rb

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

data/lib/cxml/message.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CXML
+  class Message < DocumentNode
+    accessible_attributes %i[
+      deployment_mode
+      id
+    ]
+    accessible_nodes %i[
+      punch_out_order_message
+    ]
+  end
+end

data/lib/cxml/modification.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CXML
+  class Modification < DocumentNode
+    accessible_attributes %i[
+      level
+    ]
+    accessible_nodes %i[
+      original_price
+      additional_cost
+      additional_deduction
+      modification_detail
+    ]
+  end
+end

data/lib/cxml/modification_detail.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CXML
+  class ModificationDetail < DocumentNode
+    accessible_attributes %i[
+      name
+      start_date
+      end_date
+      code
+    ]
+    accessible_nodes %i[
+      description
+      extrinsic
+    ]
+  end
+end

data/lib/cxml/modifications.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CXML
+  class Modifications < DocumentNode
+    accessible_nodes %i[
+      modifications
+    ]
+
+    def initialize_modification(value)
+      value = [value] unless value.is_a?(Array)
+      @modifications = value.map do |item|
+        Modification.new(item)
+      end
+    end
+
+    def initialize_modifications(value)
+      value = [value] unless value.is_a?(Array)
+      @modifications = value.map do |item|
+        Modification.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/money.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# The Money element has three possible attributes: currency, alternateAmount,
+# alternateCurrency. The attributes currency and alternateCurrecy must be a three-letter ISO
+# 4217 currency code. The content of the Money element and of the aternateAmount
+# attribute should be a numeric value. For example:
+# <Money currency="USD">12.34</Money>
+# The optional alternateCurrency and alternateAmount attributes are used together to specify
+# an amount in an alternate currency. These can be used to support dual-currency
+# requirements such as the euro. For example:
+# <Money currency="USD" alternateCurrency=”EUR” alternateAmount=”14.28”>12.34
+# </Money>
+# Note:  You can optionally use commas as thousands separators. Do not use
+# commas as decimal separators.
+#
+# Page: 59
+# <Money currency="GBP">5.35</Money>
+
+module CXML
+  class Money < DocumentNode
+    accessible_attributes %i[
+      alternate_amount
+      alternate_currency
+      currency
+    ]
+
+    def amount
+      content
+    end
+
+    def amount=(value)
+      self.content = value
+    end
+  end
+end

data/lib/cxml/name.rb

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

data/lib/cxml/net_amount.rb

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

data/lib/cxml/order_reference.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CXML
+  class OrderReference < DocumentNode
+    accessible_attributes %i[
+      order_id
+    ]
+    accessible_nodes %i[
+      document_reference
+    ]
+  end
+end

data/lib/cxml/order_request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module CXML
+  # body of purchase order request
+  class OrderRequest < DocumentNode
+    accessible_nodes %i[
+      order_request_header
+      items_out
+    ]
+
+    def initialize_item_out(value)
+      value = [value] unless value.is_a?(Array)
+      @items_out = value.map do |item|
+        CXML::ItemOut.new(item)
+      end
+    end
+
+    def initialize_items_out(value)
+      value = [value] unless value.is_a?(Array)
+      @items_out = value.map do |item|
+        CXML::ItemOut.new(item)
+      end
+    end
+
+    def add_item(item_in_data)
+      items_out << CXML::ItemOut.new(item_in_data)
+    end
+
+    def items_out
+      @items_out ||= []
+    end
+  end
+end

data/lib/cxml/order_request_header.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module CXML
+  # body header of purchase order request
+  class OrderRequestHeader < DocumentNode
+    accessible_attributes %i[
+      agreement_id
+      agreement_payload_id
+      effective_date
+      expiration_date
+      is_internal_version
+      order_date
+      order_id
+      order_type
+      order_version
+      parent_agreement_id
+      parent_agreement_payload_id
+      pick_up_date
+      release_required
+      requested_delivery_date
+      requisition_id
+      ship_complete
+      type
+    ]
+    accessible_nodes %i[
+      bill_to
+      comments
+      contact
+      control_keys
+      delivery_period
+      document_reference
+      extrinsics
+      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
+      @type || 'new'
+    end
+
+    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/parser.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require('nokogiri')
+require('xmlsimple')
+
+module CXML
+  class Parser
+    def parse(data)
+      hash = XmlSimple.xml_in(data, { 'ForceArray' => false })
+      hash.transform_keys!(&method(:underscore_key))
+      hash.transform_values!(&method(:underscore_hash_values))
+      hash
+    end
+
+    private
+
+    def underscore_hash_values(value)
+      return value.map(&method(:underscore_hash_values)) if value.is_a?(Array)
+      return value unless value.is_a?(Hash)
+
+      value.transform_keys!(&method(:underscore_key))
+      value.transform_values!(&method(:underscore_hash_values))
+      value
+    end
+
+    def underscore_key(key)
+      return key.to_s.to_sym unless /[A-Z-]|:/.match?(key)
+
+      word = key.to_s.gsub(':', '_')
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
+      word.downcase!
+      word.to_sym
+    end
+  end
+end

data/lib/cxml/payment_term.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module CXML
+  class PaymentTerm < DocumentNode
+    accessible_attributes %i[
+      pay_in_number_of_days
+    ]
+    accessible_nodes %i[
+      discount
+      extrinsics
+      net_due_days
+    ]
+
+    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/period.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  class Period < DocumentNode
+    accessible_attributes %i[
+      start_date
+      end_date
+    ]
+  end
+end

data/lib/cxml/postal_address.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CXML
+  # postal address, typically in a purchase order message
+  class PostalAddress < DocumentNode
+    accessible_attributes %i[
+      name
+    ]
+    accessible_nodes %i[
+      deliver_to
+      state
+      street
+      municipality
+      city
+      postal_code
+      country
+    ]
+
+    def initialize_deliver_to(value)
+      @deliver_to = if value.is_a?(Array)
+                      value
+                    else
+                      [value]
+                    end
+    end
+
+    def initialize_street(value)
+      @street = if value.is_a?(Array)
+                  value
+                else
+                  [value]
+                end
+    end
+  end
+end

data/lib/cxml/protocol.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module CXML
+  module Protocol
+    VERSION = '1.2.011'
+
+    REQUEST_ELEMENTS = %w[
+      OrderRequest
+      ProfileRequest
+      PunchOutSetupRequest
+      StatusUpdateRequest
+      GetPendingRequest
+      ConfirmationRequest
+      ShipNoticeRequest
+      ProviderSetupRequest
+      PaymentRemittanceRequest
+    ].freeze
+
+    RESPONSE_ELEMENTS = %w[
+      ProfileResponse
+      PunchOutSetupResponse
+      GetPendingResponse
+    ].freeze
+
+    STATUS_CODES = [
+      200, 201, 204, 280, 281,
+      400, 401, 402, 403, 406, 409, 412, 417, 450, 475, 476, 477,
+      500, 550, 551, 560,
+    ].freeze
+
+    class << self
+      # Get current protocol version
+      # @return [String]
+      def version
+        VERSION
+      end
+
+      # Get available request elements
+      # @return [Array<String>]
+      def request_elements
+        REQUEST_ELEMENTS
+      end
+
+      # Get available response elements
+      # @return [Array<String>]
+      def response_elements
+        RESPONSE_ELEMENTS
+      end
+
+      # Get available status codes
+      # @return [Array<Fixnum>]
+      def status_codes
+        STATUS_CODES
+      end
+    end
+  end
+end

data/lib/cxml/punch_out_order_message.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module CXML
+  class PunchOutOrderMessage < DocumentNode
+    accessible_nodes %i[
+      buyer_cookie
+      punch_out_order_message_header
+      items_in
+    ]
+
+    def initialize_item_in(value)
+      value = [value] unless value.is_a?(Array)
+      @items_in = value.map do |item|
+        CXML::ItemIn.new(item)
+      end
+    end
+
+    def initialize_items_in(value)
+      value = [value] unless value.is_a?(Array)
+      @items_in = value.map do |item|
+        CXML::ItemIn.new(item)
+      end
+    end
+
+    def add_item(item_in_data)
+      items_in << CXML::ItemIn.new(item_in_data)
+    end
+
+    def items_in
+      @items_in ||= []
+    end
+  end
+end

data/lib/cxml/punch_out_order_message_header.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CXML
+  # punchout order message header
+  class PunchOutOrderMessageHeader < DocumentNode
+    accessible_attributes %i[
+      operation_allowed
+    ]
+    accessible_nodes %i[
+      total
+      shipping
+      tax
+      ship_to
+    ]
+
+    def operation_allowed
+      @operation_allowed || 'create'
+    end
+  end
+end