cxml-ruby 0.2.0

data/lib/cxml/punch_out_setup_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CXML
+  class PunchOutSetupRequest < DocumentNode
+    accessible_attributes %i[
+      operation
+    ]
+    accessible_nodes %i[
+      browser_form_post
+      supplier_setup
+      buyer_cookie
+      ship_to
+      extrinsics
+      contact
+    ]
+
+    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/punch_out_setup_response.rb

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

data/lib/cxml/request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Clients send requests for operations. Only one Request element is allowed for each
+# cXML envelope element, which simplifies the server implementations, because no
+# demultiplexing needs to occur when reading cXML documents. The Request element
+# can contain virtually any type of XML data.
+
+module CXML
+  class Request < DocumentNode
+    accessible_attributes %i[
+      deployment_mode
+      id
+    ]
+    accessible_nodes %i[
+      confirmation_request
+      invoice_detail_request
+      order_request
+      punch_out_setup_request
+    ]
+  end
+end

data/lib/cxml/response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Servers send responses to inform clients of the results of operations. Because the
+# result of some requests might not have any data, the Response element can optionally
+# contain nothing but a Status element. A Response element can also contain any
+# application-level data. During PunchOut for example, the application-level data is
+# contained in a PunchOutSetupResponse element.
+
+module CXML
+  class Response < DocumentNode
+    accessible_attributes %i[
+      deployment_mode
+      id
+    ]
+    accessible_nodes %i[
+      status
+      punch_out_setup_response
+    ]
+  end
+end

data/lib/cxml/segment.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CXML
+  # details for accounting objects
+  class Segment < DocumentNode
+    accessible_attributes %i[
+      id
+      description
+      type
+    ]
+  end
+end

data/lib/cxml/sender.rb

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

data/lib/cxml/ship_to.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  # shipping details object within punchout setup request
+  class ShipTo < DocumentNode
+    accessible_nodes %i[
+      address
+    ]
+  end
+end

data/lib/cxml/shipping.rb

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

data/lib/cxml/shipping_amount.rb

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

data/lib/cxml/special_handling_amount.rb

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

data/lib/cxml/start_page.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CXML
+  class StartPage < DocumentNode
+    accessible_nodes %i[
+      url
+    ]
+
+    def render_nodes(node)
+      node.URL(url)
+    end
+  end
+end

data/lib/cxml/state.rb

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

data/lib/cxml/status.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CXML
+  class Status < DocumentNode
+    accessible_attributes %i[
+      code
+      text
+      xml_lang
+    ]
+
+    def code
+      @code&.to_i
+    end
+
+    # Check if status is success
+    # @return [Boolean]
+    def success?
+      [200, 201, 204, 280, 281].include?(code)
+    end
+
+    # Check if status is failure
+    # @return [Boolean]
+    def failure?
+      !success?
+    end
+  end
+end

data/lib/cxml/subtotal_amount.rb

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

data/lib/cxml/supplier_setup.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CXML
+  class SupplierSetup < DocumentNode
+    accessible_nodes %i[
+      url
+    ]
+
+    def render_nodes(node)
+      node.URL(url)
+    end
+  end
+end

data/lib/cxml/tax.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module CXML
+  class Tax < DocumentNode
+    accessible_nodes %i[
+      money
+      tax_adjustment_amount
+      description
+      tax_details
+      distribution
+      extrinsics
+    ]
+
+    def initialize_tax_detail(value)
+      value = [value] unless value.is_a?(Array)
+      @tax_details = value.map do |item|
+        TaxDetail.new(item)
+      end
+    end
+
+    def initialize_tax_details(value)
+      value = [value] unless value.is_a?(Array)
+      @tax_details = value.map do |item|
+        TaxDetail.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/tax_adjustment_amount.rb

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

data/lib/cxml/tax_amount.rb

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

data/lib/cxml/tax_detail.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module CXML
+  class TaxDetail < DocumentNode
+    accessible_attributes %i[
+      purpose
+      category
+      percentage_rate
+      is_vat_recoverable
+      tax_point_date
+      payment_date
+      is_triangular_transaction
+      exempt_detail
+      is_withholding_tax
+      tax_rate_type
+      base_percentage_rate
+      is_included_in_price
+    ]
+    accessible_nodes %i[
+      taxable_amount
+      tax_amount
+      tax_location
+      tax_adjustment_amount
+      description
+      tax_regime
+      tax_exemption
+      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/tax_location.rb

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

data/lib/cxml/taxable_amount.rb

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

data/lib/cxml/to.rb

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

data/lib/cxml/total.rb

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

data/lib/cxml/total_allowances.rb

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

data/lib/cxml/total_amount_without_tax.rb

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

data/lib/cxml/total_charges.rb

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

data/lib/cxml/unit_price.rb

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

data/lib/cxml/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CXML
+  VERSION = '0.2.0'
+end

data/lib/cxml.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require('time')
+require('nokogiri')
+require('logger')
+require('cxml/document_node')
+Dir[File.join(__dir__, 'cxml', '*.rb')].sort.each { |file| require file }
+
+module CXML
+  def self.parse(str)
+    CXML::Parser.new.parse(str)
+  end
+
+  def self.builder
+    Nokogiri::XML::Builder.new(encoding: 'UTF-8')
+  end
+
+  def self.configure
+    yield(self)
+  end
+
+  def self.raise_unknown_elements
+    @raise_unknown_elements.nil? ? @raise_unknown_elements ||= true : @raise_unknown_elements
+  end
+
+  def self.raise_unknown_elements=(setting)
+    @raise_unknown_elements = setting
+  end
+
+  def self.logger
+    return @logger if @logger
+
+    @logger ||= Logger.new(STDOUT, level: :warn)
+  end
+
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+end

data/spec/credential_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CXML::Credential do
+  it { should respond_to :domain }
+  it { should respond_to :type }
+  it { should respond_to :shared_secret }
+  it { should respond_to :credential_mac }
+  it { should respond_to :identity }
+
+  let(:parser) { CXML::Parser.new }
+  let(:data) { parser.parse(fixture('punch_out_order_message_doc.xml')) }
+  let(:doc) { CXML::Document.new(data) }
+  let(:sender) { doc.header.sender }
+  let(:credential) { sender.credential }
+  let(:builder) { doc.render }
+
+  describe '#initialize' do
+    it 'sets the attributes that are passed' do
+      credential.shared_secret.should_not be_nil
+      credential.identity.should_not be_nil
+    end
+  end
+
+  describe '#render' do
+    let(:output_xml) { builder.to_xml }
+    let(:output_data) { parser.parse(output_xml) }
+    let(:sender_output_data) { output_data[:header][:sender] }
+    let(:credential_output_data) { sender_output_data[:credential] }
+
+    it 'contains the required nodes' do
+      credential_output_data[:shared_secret].should_not be_empty
+      credential_output_data[:identity].should_not be_empty
+    end
+  end
+end

data/spec/cxml_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CXML do
+end

data/spec/document_spec.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CXML::Document do
+  shared_examples_for :document_has_mandatory_values do
+    it 'sets the mandatory attributes' do
+      doc.version.should eq(CXML::Protocol::VERSION)
+      doc.payload_id.should_not be_nil
+    end
+  end
+
+  shared_examples_for :document_has_a_header do
+    it 'sets the header attributes' do
+      doc.header.should be_a CXML::Header
+    end
+  end
+
+  shared_examples_for :document_has_a_timestamp do
+    it 'sets the timestamp attributes' do
+      doc.timestamp.should be_a Time
+      doc.timestamp.should eq(Time.parse('2012-09-04T02:37:49-05:00'))
+    end
+  end
+
+  shared_examples_for :document_render_defaults do
+    it 'returns xml content' do
+      output_xml.should_not be_nil
+    end
+
+    it 'returns xml content with a header xml node' do
+      output_data[:header].should_not be_empty
+    end
+  end
+
+  let(:parser) { CXML::Parser.new }
+
+  it { should respond_to :version }
+  it { should respond_to :payload_id }
+  it { should respond_to :timestamp }
+  it { should respond_to :header }
+  it { should respond_to :request }
+  it { should respond_to :response }
+  it { should respond_to :message }
+  it { should respond_to :xml_lang }
+  it { should respond_to :request? }
+  it { should respond_to :response? }
+  it { should respond_to :message? }
+
+  describe '#initialize' do
+    let(:doc) { CXML::Document.new(data) }
+
+    it 'can ingest from_xml' do
+      doc = described_class.new.from_xml(fixture('response_status_200.xml'))
+      doc.response.status.code.should eq(200)
+    end
+
+    context 'when a request document is passed' do
+      let(:data) { parser.parse(fixture('request_doc.xml')) }
+      include_examples :document_has_mandatory_values
+      include_examples :document_has_a_header
+      include_examples :document_has_a_timestamp
+
+      it 'sets the correct document node attributes' do
+        doc.header.should be_a CXML::Header
+        doc.request.should be_a CXML::Request
+
+        doc.response.should be_nil
+        doc.message.should be_nil
+      end
+    end
+
+    context 'when a response document is passed' do
+      let(:data) { parser.parse(fixture('response_status_200.xml')) }
+      include_examples :document_has_mandatory_values
+      include_examples :document_has_a_timestamp
+
+      it 'sets the correct document node attributes' do
+        doc.response.should be_a CXML::Response
+
+        doc.header.should be_nil
+        doc.request.should be_nil
+        doc.message.should be_nil
+      end
+    end
+
+    context 'when a punch out order message is passed' do
+      let(:data) { parser.parse(fixture('punch_out_order_message_doc.xml')) }
+      include_examples :document_has_mandatory_values
+      include_examples :document_has_a_header
+      include_examples :document_has_a_timestamp
+
+      it 'sets the correct document node attributes' do
+        doc.header.should be_a CXML::Header
+        doc.message.punch_out_order_message.should be_a CXML::PunchOutOrderMessage
+
+        doc.request.should be_nil
+        doc.response.should be_nil
+      end
+    end
+  end
+
+  describe '#render' do
+    let(:doc) { CXML::Document.new(data) }
+    let(:builder) { doc.render }
+    let(:output_xml) { builder.to_xml }
+    let(:output_data) { parser.parse(output_xml) }
+
+    it { should respond_to :render }
+
+    context 'when a request document is rendered' do
+      let(:data) { parser.parse(fixture('request_doc.xml')) }
+      include_examples :document_render_defaults
+    end
+
+    context 'when a valid response is rendered' do
+      let(:data) { parser.parse(fixture('response_status_200.xml')) }
+      it 'returns xml content' do
+        output_xml.should_not be_nil
+      end
+
+      it 'outputs the response with a valid status code' do
+        output_data[:response].should_not be_empty
+        output_data[:response][:status][:code].should eq('200')
+        output_data[:response][:status].should eq(data[:response][:status])
+      end
+
+      it 'outputs the punch out setup response' do
+        output_data[:response][:punch_out_setup_response].should_not be_empty
+      end
+    end
+
+    context 'when a invalid response is rendered' do
+      let(:data) { parser.parse(fixture('response_status_400.xml')) }
+      it 'returns xml content' do
+        output_xml.should_not be_nil
+      end
+
+      it 'outputs the response with a valid status code' do
+        output_data[:response].should_not be_empty
+        output_data[:response][:status][:code].should eq('400')
+      end
+    end
+
+    context 'when a punch out order message document is rendered' do
+      let(:data) { parser.parse(fixture('punch_out_order_message_doc.xml')) }
+      include_examples :document_render_defaults
+
+      it 'outputs the punch out order message xml' do
+        output_data[:message].should_not be_empty
+        output_data[:message][:punch_out_order_message].should_not be_empty
+      end
+    end
+  end
+end