cxml 0.1.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=nested

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Dan Sosedoff.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# cXML
+
+Ruby implementation of cXML protocol. 
+
+## Documentation
+
+Procotol specifications could be found here [http://xml.cxml.org/current/cXMLUsersGuide.pdf](http://xml.cxml.org/current/cXMLUsersGuide.pdf)
+
+## Parsing cXML
+
+To parse cXML, simply pass the raw text of the document to CXML.parse
+
+    CXML.parse("<xml namespace=...")
+
+This will return a well-constructed hash based on the conents of the document.
+
+## Commerce
+
+cXML library can be used to handle inbound cXML requests via the Commerce.dispatch function.  E.g.
+
+    class CommerceController < ApplicationController
+    
+      def handle
+        Commerce.dispatch(request.raw_post) do
+          order_request do |order_request|
+            respond_to do |format|
+              format.xml { render xml: Commerce::Response.success }
+            end
+          end
+        end
+      end
+    
+    end
+
+## Building documents
+
+To build request documents, you can use the document builder.  E.g.
+
+    ConfirmationRequest.new(type: 'reject').render
+
+or send the response to a server (via RestClient)
+
+    ShipNoticeRequest.new.send("http://example.com/cxml")
+
+## Running Tests
+
+Install dependencies:
+
+```
+bundle install
+```
+
+Run suite:
+
+```
+rake test
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/cxml.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/cxml/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "cxml"
+  s.version     = CXML::VERSION
+  s.summary     = "Ruby library to work with cXML protocol"
+  s.description = "Ruby library to work with cXML protocol"
+  s.homepage    = "http://github.com/sosedoff/cxml"
+  s.authors     = ["Dan Sosedoff","Geoff Hayes"]
+  s.email       = ["dan.sosedoff@gmail.com", "hayesgm@gmail.com"]
+  
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec',     '~> 2.11'
+  s.add_development_dependency 'simplecov', '~> 0.4'
+
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'xml-simple'
+  s.add_dependency 'hashr'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths = ["lib"]
+end

data/lib/commerce.rb

@@ -0,0 +1,90 @@
+# The Commerce module is used for quickly building documents and dispatching inbound requests
+module Commerce
+    
+  # Define errors
+  module CommerceError
+    class CommerceError < StandardError; end
+    class UnableToProcessError < CommerceError; end
+    class InvalidRequestError < CommerceError; end
+  end
+
+  # Block object used for binding in dispatch blocks
+  class BlockObject
+    def initialize
+      @procs = {}
+    end
+
+    def procs
+      @procs
+    end
+
+    def method_missing(method, *args, &block)
+      raise CommerceError::CommerceError, "Missing dispatch block" unless block_given?
+
+      @procs[method.to_sym] = block
+    end
+  end
+
+  # Response used for status-responses
+  # TODO: Move to cxml/documents
+  class Response
+    def self.success
+      d = CXML::Document.new('Response' => { 'Status' => { 'code' => 200, 'text' => 'OK' } } )
+      d.setup
+      d.render
+    end
+
+    def self.failure(message)
+      # TODO: Get failure up to specs
+      d = CXML::Document.new('Response' => { 'Status' => { 'code' => 400, 'text' => message } } )
+      d.setup
+      d.render
+    end
+  end
+
+  # Dispatch can be used to handle incoming cXML requests
+  # 
+  # E.g.
+  # Commerce.dispatch(request.raw_post) do
+  #   order_request do |order_request|
+  #     # Process order request
+  #     render xml: Commerce::Response.success
+  #   end
+  # end
+  def self.dispatch(xml, &block)
+    raise CommerceError::CommerceError, "Missing xml" if xml.blank?
+    raise CommerceError::CommerceError, "Missing dispatch block" unless block_given?
+
+    cxml = CXML.parse(xml)
+    request = cxml['Request']
+
+    raise CommerceError::InvalidRequestError, "No request element" if request.nil?
+    
+    deployment_mode = request.delete('deploymentMode')
+    id = request.delete('Id')
+
+    raise CommerceError::InvalidRequestError, "Invalid request object: #{request}" if request.keys.count != 1
+
+    request_type, request_item = request.first
+
+    Commerce.debug [ 'Commerce::Dispatch', 'Received request item', request_type, request_item ]
+    
+    block_object = Commerce::BlockObject.new
+    block_object.instance_eval(&block)
+    
+    processor = block_object.procs[request_type.underscore.to_sym]
+    
+    raise CommerceError::CommerceError, "Missing handler for #{request_type.underscore}" unless processor
+    
+    obj = block.binding.eval("self") # Grab self of caller
+    obj.instance_exec(request_item, &processor)
+  end
+
+  # Send debug messages
+  def self.debug(*args)
+    if defined?(Rails)
+      Rails.logger.debug *args if Rails.logger
+      p *args if Rails.env && Rails.env.development?
+    end
+  end
+end

data/lib/cxml.rb

@@ -0,0 +1,29 @@
+require 'cxml/version'
+require 'cxml/errors'
+require 'time'
+require 'nokogiri'
+require 'commerce'
+require 'cxml/documents/request_doc'
+require 'cxml/documents/confirmation_request'
+require 'cxml/documents/ship_notice_request'
+
+module CXML
+  autoload :Protocol,      'cxml/protocol'
+  autoload :Document,      'cxml/document'
+  autoload :Header,        'cxml/header'
+  autoload :Credential,    'cxml/credential'
+  autoload :CredentialMac, 'cxml/credential_mac'
+  autoload :Sender,        'cxml/sender'
+  autoload :Status,        'cxml/status'
+  autoload :Request,       'cxml/request'
+  autoload :Response,      'cxml/response'
+  autoload :Parser,        'cxml/parser'
+
+  def self.parse(str)
+    CXML::Parser.new.parse(str)
+  end
+
+  def self.builder
+    Nokogiri::XML::Builder.new(:encoding => "UTF-8")
+  end
+end

data/lib/cxml/credential.rb

@@ -0,0 +1,62 @@
+# This element contains identification and authentication values.
+# Credential contains an Identity element and optionally a SharedSecret or a CredentialMac
+# element. The Identity element states who the Credential represents, while the optional 
+# authentication elements verify the identity of the party
+#
+# Credential has the following attributes:
+# 
+# *domain*
+# Specifies the type of credential. This attribute allows 
+# documents to contain multiple types of credentials for multiple 
+# authentication domains.
+# For messages sent on the Ariba Supplier Network, for 
+# instance, the domain can be AribaNetworkUserId to indicate an 
+# email address, DUNS for a D-U-N-S number, or NetworkId for a 
+# preassigned ID.
+#
+# *type* - optional
+# Requests to or from a marketplace identify both the 
+# marketplace and the member company in From or To Credential
+# elements. In this case, the credential for the marketplace uses 
+# the type attribute, which is set to the value “marketplace”
+#
+# *SharedSecred*
+# The SharedSecret element is used when the Sender has a password that the requester recognizes.
+#
+# *CredentialMac*
+# 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.
+
+module CXML
+  class Credential
+    attr_accessor :domain
+    attr_accessor :type
+    attr_accessor :shared_secret
+    attr_accessor :credential_mac
+    attr_accessor :identity
+
+    # Initialize a new Credential instance
+    # @param data [Hash] optional initial data
+    def initialize(data={})
+      if data.kind_of?(Hash) && !data.empty?
+        @domain        = data['domain']
+        @type          = data['type']
+        @identity      = data['Identity']
+        @shared_secret = data['SharedSecret']
+      end
+    end
+
+    def render(node)
+      node.Credential('domain' => domain) do |c|
+        c.Identity(@identity)
+        c.SharedSecret(@shared_secret) if @shared_secret
+      end
+      node
+    end
+  end
+end

data/lib/cxml/credential_mac.rb

@@ -0,0 +1,22 @@
+# 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
+    attr_accessor :type
+    attr_accessor :algorithm
+    attr_accessor :creation_date
+    attr_accessor :expiration_date
+  end
+end

data/lib/cxml/document.rb

@@ -0,0 +1,62 @@
+module CXML
+  class Document
+    attr_accessor :version
+    attr_accessor :payload_id
+    attr_accessor :timestamp
+
+    attr_accessor :header
+    attr_accessor :request
+    attr_accessor :response
+
+    def initialize(data={})
+      if data.kind_of?(Hash) && !data.empty?
+        @version = data['version']
+        @payload_id = data['payloadID']
+
+        if data['timestamp']
+          @timestamp = Time.parse(data['timestamp'])
+        end
+
+        if data['Header']
+          @header = CXML::Header.new(data['Header'])
+        end
+
+        if data['Request']
+          @request = CXML::Request.new(data['Request'])
+        end
+
+        if data['Response']
+          @response = CXML::Response.new(data['Response'])
+        end
+      end
+    end
+
+    def setup
+      @version    = CXML::Protocol.version
+      @timestamp  = Time.now.utc
+      @payload_id = "#{@timestamp.to_i}.process.#{Process.pid}@domain.com"
+    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
+
+    def render
+      node = CXML.builder
+      node.cXML('version' => version, 'payloadID' => payload_id, 'timestamp' => timestamp.iso8601) do |doc|
+        doc.Header { |n| @header.render(n) } if @header
+        @request.render(node) if @request
+        @response.render(node) if @response
+      end
+      node
+    end
+  end
+end

data/lib/cxml/documents/confirmation_request.rb

@@ -0,0 +1,19 @@
+# Builder for ConfirmationRequest object
+class ConfirmationRequest < RequestDoc
+  @@defaults = {
+    type: 'accept',
+    payload_id: nil,
+    confirm_id: nil,
+    invoice_id: nil
+  }
+
+  def features(node)
+    node.ConfirmationRequest({}.merge(@opts[:confirm_id] ? { confirmID: @opts[:confirm_id] } : {}).merge(@opts[:invoice_id] ? { invoice_id: @opts[:invoice_id] } : {})) {
+      node.ConfirmationHeader(type: @opts[:type], noticeDate: Time.now.iso8601)
+      node.OrderReference {
+        node.DocumentReference(@opts[:payload_id] ? { payloadID: @opts[:payload_id] } : {})
+      }
+    }
+  end
+
+end

data/lib/cxml/documents/request_doc.rb

@@ -0,0 +1,36 @@
+# Default parent for all Request builders
+class RequestDoc
+  attr_accessor :opts
+  class_attribute :defaults
+
+  def initialize(opts={})
+    @opts = opts.with_indifferent_access.reverse_merge(self.class.class_variable_defined?("@@defaults") ? self.class.class_variable_get("@@defaults") : {})
+  end
+
+  def [](key)
+    @opts[key]
+  end
+
+  def []=(key,val)
+    @opts[key] = val
+  end
+
+  def render
+    doc = CXML::Document.new('Request' => { 'builder' => proc { |node|
+      features(node)
+    }})
+
+    doc.setup
+    doc.render.to_xml
+  end
+
+  def features
+    raise NotImplementedError, "Missing features function for #{self.class.name}"
+  end
+
+  def send(endpoint)
+    RestClient.post endpoint, self.render, content_type: :xml
+
+    # TODO: Abstract and verify response
+  end
+end

data/lib/cxml/documents/ship_notice_request.rb

@@ -0,0 +1,12 @@
+# Builder for ShipNoticeRequest object
+class ShipNoticeRequest < RequestDoc
+  @@defaults = {
+    shipment_id: nil
+  }
+
+  def features(node)
+    node.ShipNoticeRequest {
+      node.ShipNoticeHeader({noticeDate: Time.now.iso8601, shipmentDate: Time.now.iso8601}.merge(@opts[:shipment_id] ? { shipmentID: @opts[:shipment_id]} : {}))
+    }
+  end
+end

data/lib/cxml/errors.rb

@@ -0,0 +1,4 @@
+module CXML
+  class Error < StandardError ; end
+  class ParseError < Error ; end
+end

data/lib/cxml/header.rb

@@ -0,0 +1,41 @@
+# 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
+    attr_accessor :from
+    attr_accessor :to
+    attr_accessor :sender
+
+    def initialize(data={})
+      if data.kind_of?(Hash) && !data.empty?
+        @from       = CXML::Credential.new(data['From']['Credential'])
+        @to         = CXML::Credential.new(data['To']['Credential'])
+        @sender     = CXML::Sender.new(data['Sender'])
+      end
+    end
+
+    def render(node)
+      node.From   { |n| @from.render(n) }
+      node.To     { |n| @to.render(n) }
+
+      @sender.render(node)
+      node
+    end
+  end
+end

data/lib/cxml/money.rb

@@ -0,0 +1,23 @@
+# 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
+
+module CXML
+  class Money
+    attr_accessor :currency
+    attr_accessor :amount
+    attr_accessor :alternative_currency
+    attr_accessor :alternative_amount
+  end
+end

data/lib/cxml/parser.rb

@@ -0,0 +1,10 @@
+require 'nokogiri'
+require 'xmlsimple'
+
+module CXML
+  class Parser
+    def parse(data)
+      XmlSimple.xml_in(data, {'ForceArray' => false})
+    end
+  end
+end

data/lib/cxml/protocol.rb

@@ -0,0 +1,55 @@
+module CXML
+  module Protocol
+    VERSION = '1.2.011'
+
+    REQUEST_ELEMENTS = [
+      'OrderRequest',
+      'ProfileRequest',
+      'PunchOutSetupRequest',
+      'StatusUpdateRequest',
+      'GetPendingRequest',
+      'ConfirmationRequest',
+      'ShipNoticeRequest',
+      'ProviderSetupRequest',
+      'PaymentRemittanceRequest',
+    ]
+
+    RESPONSE_ELEMENTS = [
+      'ProfileResponse',
+      'PunchOutSetupResponse',
+      'GetPendingResponse',
+    ]
+
+    STATUS_CODES = [
+      200, 201, 204, 280, 281,
+      400, 401, 402, 403, 406, 409, 412, 417, 450, 475, 476, 477,
+      500, 550, 551, 560
+    ]
+
+    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/request.rb

@@ -0,0 +1,24 @@
+# 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
+    attr_accessor :id
+    attr_accessor :deployment_mode
+    attr_accessor :builder
+
+    def initialize(data={})
+      if data.kind_of?(Hash) && !data.empty?
+        @id = data['id']
+        @deployment_mode = data['deploymentMode']
+        @builder = data['builder']
+      end
+    end
+
+    def render(node)
+      @builder.yield(node) if @builder
+    end
+  end
+end

data/lib/cxml/response.rb

@@ -0,0 +1,24 @@
+# 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
+    attr_accessor :id
+    attr_accessor :status
+
+    def initialize(data={})
+      if data.kind_of?(Hash) && !data.empty?
+        @status = CXML::Status.new(data['Status'])
+      end
+    end
+
+    def render(node)
+      options = {:id => @id}
+      options.keep_if { |k,v| !v.nil? }
+      node.Response(options) { |n| @status.render(n) }
+    end
+  end
+end

data/lib/cxml/sender.rb

@@ -0,0 +1,21 @@
+module CXML
+  class Sender
+    attr_accessor :credential
+    attr_accessor :user_agent
+
+    def initialize(data={})
+      if data.kind_of?(Hash) && !data.empty?
+        @credential = CXML::Credential.new(data['Credential'])
+        @user_agent = data['UserAgent']
+      end
+    end
+
+    def render(node)
+      node.Sender do |n|
+        n.UserAgent(@user_agent)
+        @credential.render(n)
+      end
+      node
+    end
+  end
+end

data/lib/cxml/status.rb

@@ -0,0 +1,35 @@
+module CXML
+  class Status
+    attr_accessor :code
+    attr_accessor :text
+    attr_accessor :xml_lang
+
+    # Initialize a new Status instance
+    # @params data [Hash] optional hash with attributes
+    def initialize(data={})
+      data = CXML.parse(data) if data.kind_of?(String)
+
+      if data.kind_of?(Hash) && !data.empty?
+        @code     = data['code'].to_i
+        @text     = data['text']
+        @xml_lang = data['xml:lang']
+      end
+    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
+
+    def render(node)
+      node.Status(:code => @code, :text => @text)
+    end
+  end
+end

data/lib/cxml/version.rb

@@ -0,0 +1,3 @@
+module CXML
+  VERSION = '0.1.0'
+end

data/spec/cxml_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CXML do
+  
+end

data/spec/document_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe CXML::Document do
+  let(:parser) { CXML::Parser.new }
+
+  it { should respond_to :version }
+  it { should respond_to :payload_id }
+  it { should respond_to :timestamp }
+
+  describe '#parse' do
+    it 'sets document attributes' do
+      data = parser.parse(fixture('envelope3.xml'))
+      doc = nil
+
+      expect { doc = CXML::Document.new(data) }.not_to raise_error
+
+      doc.version.should eq(CXML::Protocol::VERSION)
+      doc.payload_id.should_not be_nil
+      doc.timestamp.should be_a Time
+      doc.timestamp.should eq(Time.parse('2012-09-04T02:37:49-05:00'))
+
+      doc.header.should be_a CXML::Header
+      doc.request.should be_a CXML::Request
+      doc.response.should be_nil
+    end
+  end
+
+  describe '#render' do
+    it 'returns and xml result' do
+      doc = CXML::Document.new(parser.parse(fixture('envelope3.xml')))
+      expect { doc.render }.not_to raise_error
+    end
+  end
+end

data/spec/fixtures/envelope.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
+<cXML timestamp="2000-12-28T16:56:03-08:00" payloadID="12345666@10.10.83.39">
+<Header>
+<From>
+<Credential domain="DUNS">
+<Identity>123456789</Identity>
+</Credential>
+</From>
+<To>
+<Credential domain="NetworkID">
+<Identity>AN01000000001</Identity>
+</Credential>
+</To>
+<Sender>
+<Credential domain="DUNS">
+<Identity>123456789</Identity>
+<SharedSecret>abracadabra</SharedSecret>
+</Credential>
+</Sender>
+</Header>
+<Request>
+<CatalogUploadRequest operation="new">
+<CatalogName xml:lang="en">Winter Prices</CatalogName>
+<Description xml:lang="en">premiere-level prices</Description>
+<Attachment>
+<URL>cid:part2.PCO28.975@saturn.workchairs.com</URL>
+</Attachment>
+</CatalogUploadRequest>
+</Request>
+</cXML>

data/spec/fixtures/envelope2.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.014/cXML.dtd">
+<cXML payloadID="123@sendercompany.com"
+timestamp="2003-11-20T23:59:45-07:00">
+<Header>
+<From>
+<!-- Sender -->
+<Credential domain="AribaNetworkUserId">
+<Identity>sender@sendercompany.com</Identity>
+</Credential>
+</From>
+<To>
+<!-- Recipient -->
+<Credential domain="AribaNetworkUserId">
+<Identity>recipient@recipientcompany.com</Identity>
+</Credential>
+</To>
+<Sender>
+<!-- Sender -->
+<Credential domain="AribaNetworkUserId">
+<Identity>sender@sendercompany.com</Identity>
+<SharedSecret>abracadabra</SharedSecret>
+</Credential>
+<UserAgent>Sender Application 1.0</UserAgent>
+</Sender>
+</Header>
+<Request deploymentMode="production">
+<CopyRequest>
+<cXMLAttachment>
+<Attachment>
+<URL>cid:222@sendercompany.com</URL>
+</Attachment>
+</cXMLAttachment>
+</CopyRequest>
+</Request>
+</cXML>

data/spec/fixtures/envelope3.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0"?>
+<cXML version="1.2.011" payloadID="1346769469000.process.162998590@officedepot.com" timestamp="2012-09-04T02:37:49-05:00">
+  <Header>
+    <From>
+      <Credential domain="NetworkID">
+        <Identity>AN01000000147</Identity>
+      </Credential>
+    </From>
+    <To>
+      <Credential domain="NetworkId">
+        <Identity>customerID</Identity>
+      </Credential>
+    </To>
+    <Sender>
+      <Credential domain="NetworkID">
+        <Identity>AN01000000147</Identity>
+        <SharedSecret>welcome</SharedSecret>
+      </Credential>
+      <UserAgent>BSD 8.12</UserAgent>
+    </Sender>
+  </Header>
+  <Request deploymentMode="production">
+    <ConfirmationRequest>
+      <ConfirmationHeader confirmID="" operation="new" type="detail" noticeDate="2012-09-04T02:37:49-05:00" invoiceID="623612976001">
+        <Contact role="shipTo" addressID="0170-74629-00">
+          <Name xml:lang="en-US">HOSPITAL BUILDING</Name>
+          <PostalAddress>
+            <DeliverTo>Yvonne Smith</DeliverTo>
+            <DeliverTo>541813031</DeliverTo>
+            <Street>3601 Mile Road</Street>
+            <Street>BUILDING: 0170-74629-00</Street>
+            <City>Royal Oak</City>
+            <State>MI</State>
+            <PostalCode>48073</PostalCode>
+            <Country isoCountryCode="US">United States</Country>
+          </PostalAddress>
+        </Contact>
+      </ConfirmationHeader>
+      <OrderReference orderID="400-2591453-0">
+        <DocumentReference payloadID="20120904023747.cXMLPurchaseOrder.984556224@eprosvcs.com"/>
+      </OrderReference>
+      <ConfirmationItem quantity="20" lineNumber="1">
+        <UnitOfMeasure>RM</UnitOfMeasure>
+        <ConfirmationStatus quantity="20" type="accept" shipmentDate="2012-09-05T12:00:00-05:00" deliveryDate="2012-09-05T12:00:00-05:00">
+          <UnitOfMeasure>RM</UnitOfMeasure>
+          <UnitPrice>
+            <Money currency="USD">4.44</Money>
+          </UnitPrice>
+          <Comments></Comments>
+          <Extrinsic name="SupplierPartID">751441</Extrinsic>
+        </ConfirmationStatus>
+      </ConfirmationItem>
+      <ConfirmationItem quantity="12" lineNumber="2">
+        <UnitOfMeasure>BX</UnitOfMeasure>
+        <ConfirmationStatus quantity="12" type="accept" shipmentDate="2012-09-05T12:00:00-05:00" deliveryDate="2012-09-05T12:00:00-05:00">
+          <UnitOfMeasure>BX</UnitOfMeasure>
+          <UnitPrice>
+            <Money currency="USD">1.52</Money>
+          </UnitPrice>
+          <Comments></Comments>
+          <Extrinsic name="SupplierPartID">429175</Extrinsic>
+        </ConfirmationStatus>
+      </ConfirmationItem>
+      <ConfirmationItem quantity="2" lineNumber="3">
+        <UnitOfMeasure>EA</UnitOfMeasure>
+        <ConfirmationStatus quantity="2" type="accept" shipmentDate="2012-09-05T12:00:00-05:00" deliveryDate="2012-09-05T12:00:00-05:00">
+          <UnitOfMeasure>EA</UnitOfMeasure>
+          <UnitPrice>
+            <Money currency="USD">4.14</Money>
+          </UnitPrice>
+          <Comments></Comments>
+          <Extrinsic name="SupplierPartID">908194</Extrinsic>
+        </ConfirmationStatus>
+      </ConfirmationItem>
+    </ConfirmationRequest>
+  </Request>
+</cXML>

data/spec/fixtures/response_status_400.xml

@@ -0,0 +1,5 @@
+<cXML version="1.2.011" 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>

data/spec/parser_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe CXML::Parser do
+end

data/spec/protocol_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe CXML::Protocol do
+  it { should respond_to :version }
+  it { should respond_to :request_elements }
+  it { should respond_to :response_elements }
+  it { should respond_to :status_codes }
+
+  context '#version' do
+    it 'returns current protocol version' do
+      subject.version.should eq('1.2.011')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'cxml'
+
+RSpec.configure do |conf|
+end
+
+def fixture_path(filename=nil)
+  path = File.expand_path("../fixtures", __FILE__)
+  filename.nil? ? path : File.join(path, filename)
+end
+
+def fixture(file)
+  File.read(File.join(fixture_path, file))
+end

data/spec/status_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe CXML::Status do
+  describe 'instance' do
+    it { should respond_to :code }
+    it { should respond_to :text }
+    it { should respond_to :xml_lang }
+    it { should respond_to :success? }
+    it { should respond_to :failure? }
+  end
+
+  describe '#initialize' do
+    it 'assigns attributes from string' do
+      str = '<Status xml:lang="en-US" code="200" text="OK"></Status>'
+      status = CXML::Status.new(str)
+
+      status.code.should eq(200)
+      status.xml_lang.should eq('en-US')
+      status.text.should eq('OK')
+    end
+
+    it 'assigns attributes from hash' do
+      hash = {'xml:lang' => 'en-US', 'code' => "200", 'text' => 'OK'}
+      status = CXML::Status.new(hash)
+
+      status.code.should eq(200)
+      status.xml_lang.should eq('en-US')
+      status.text.should eq('OK')
+    end
+  end
+
+  describe '#success?' do
+    it 'returns true on 2xx codes' do
+      CXML::Status.new('code' => '200').success?.should be_true
+      CXML::Status.new('code' => '201').success?.should be_true
+      CXML::Status.new('code' => '281').success?.should be_true
+    end
+
+    it 'returns false on non 2xx codes' do
+      CXML::Status.new('code' => '400').success?.should be_false
+      CXML::Status.new('code' => '475').success?.should be_false
+      CXML::Status.new('code' => '500').success?.should be_false
+    end
+  end
+
+  describe '#failure?' do
+    it 'returns false on 2xx codes' do
+      CXML::Status.new('code' => '200').failure?.should be_false
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: cxml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Sosedoff
+- Geoff Hayes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby library to work with cXML protocol
+email:
+- dan.sosedoff@gmail.com
+- hayesgm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cxml.gemspec
+- lib/commerce.rb
+- lib/cxml.rb
+- lib/cxml/credential.rb
+- lib/cxml/credential_mac.rb
+- lib/cxml/document.rb
+- lib/cxml/documents/confirmation_request.rb
+- lib/cxml/documents/request_doc.rb
+- lib/cxml/documents/ship_notice_request.rb
+- lib/cxml/errors.rb
+- lib/cxml/header.rb
+- lib/cxml/money.rb
+- lib/cxml/parser.rb
+- lib/cxml/protocol.rb
+- lib/cxml/request.rb
+- lib/cxml/response.rb
+- lib/cxml/sender.rb
+- lib/cxml/status.rb
+- lib/cxml/version.rb
+- spec/cxml_spec.rb
+- spec/document_spec.rb
+- spec/fixtures/.gitkeep
+- spec/fixtures/envelope.xml
+- spec/fixtures/envelope2.xml
+- spec/fixtures/envelope3.xml
+- spec/fixtures/response_status_400.xml
+- spec/parser_spec.rb
+- spec/protocol_spec.rb
+- spec/spec_helper.rb
+- spec/status_spec.rb
+homepage: http://github.com/sosedoff/cxml
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby library to work with cXML protocol
+test_files:
+- spec/cxml_spec.rb
+- spec/document_spec.rb
+- spec/fixtures/.gitkeep
+- spec/fixtures/envelope.xml
+- spec/fixtures/envelope2.xml
+- spec/fixtures/envelope3.xml
+- spec/fixtures/response_status_400.xml
+- spec/parser_spec.rb
+- spec/protocol_spec.rb
+- spec/spec_helper.rb
+- spec/status_spec.rb