ruby_omx 0.0.10 → 0.0.11

data/lib/ruby_omx/exceptions.rb

@@ -22,6 +22,10 @@ module RubyOmx
   
   class MissingOrderOptions < RubyOmxException
   end
+
+  class MissingPurchaseOrderOptions < RubyOmxException
+  end
+  
   
   class MissingItemOptions < RubyOmxException
   end

data/lib/ruby_omx/purchase_orders.rb

@@ -0,0 +1,19 @@
+module RubyOmx
+  module PurchaseOrders
+    
+    # Universal Direct Order Appending (UDOA)
+    
+    def build_purchase_order_update_request(params={})
+		  PurchaseOrderUpdateRequest.new(params.merge({:udi_auth_token=>@udi_auth_token, :http_biz_id=>@http_biz_id}))
+		end
+		
+		def send_purchase_order_update_request(params={})
+		  request = build_purchase_order_update_request(params)
+      response = post(request.to_xml.to_s)
+      return response if request.raw_xml==true || request.raw_xml==1
+      PurchaseOrderUpdateResponse.format(response)		  
+		end
+		alias_method :append_po, :send_purchase_order_update_request
+		
+  end
+end

data/lib/ruby_omx/response/purchase_order_update_request.rb

@@ -0,0 +1,43 @@
+module RubyOmx
+
+  class PurchaseOrderLineItem < Response
+    xml_name 'LineItem'
+    xml_accessor :line_number, :from=>'@lineNumber'
+    xml_accessor :item_code # 
+    xml_accessor :quantity # required for new line, optional for update (if omitted, existing value is not changed)
+    xml_accessor :price # required for new line, optional for update (if omitted, existing value is not changed)
+  end
+
+  class PurchaseOrder < Response
+    xml_name 'PurchaseOrder'
+    xml_accessor :po_number, :from=>'@PONumber' #<PurchaseOrder PONumber="16651" supplierID="76">
+    xml_accessor :supplier_id, :from=>'@supplierID'
+    xml_accessor :line_items, :as=>[PurchaseOrderLineItem], :in => 'LineDetail'
+  end
+
+  class PurchaseOrderUpdateRequest < Response
+    def initialize(a=nil)
+      return super unless a.present? # bail if no array of options has been given
+      http_biz_id = a.delete(:http_biz_id)
+      udi_auth_token = a.delete(:udi_auth_token)
+      #udi_auth_token = a.delete(:udi_auth_token)
+      
+		  required_fields = [:purchase_order]
+		  raise MissingPurchaseOrderOptions if required_fields.any? { |option| a[option].nil? }
+		  raise MissingPurchaseOrderOptions if a[:purchase_order][:po_number].nil? && a[:purchase_order][:supplier_id].nil?
+		  raise MissingPurchaseOrderOptions if a[:purchase_order][:line_items].nil?
+      super
+      self.version = a[:version] ||= '1.00'
+      self.udi_parameters = []
+      self.udi_parameters << UDIParameter.new({:key=>'UDIAuthToken', :value=>udi_auth_token})
+      self.udi_parameters << UDIParameter.new({:key=>'HTTPBizID', :value=>http_biz_id})      
+    end
+    
+    attr_accessor :raw_xml
+    
+    xml_name "PurchaseOrderUpdateRequest"
+    xml_accessor :version, :from => '@version'
+    xml_accessor :udi_parameters, :as => [RubyOmx::UDIParameter], :in => 'UDIParameter'
+    xml_accessor :purchase_order, :as => PurchaseOrder
+  end
+end

data/lib/ruby_omx/response/purchase_order_update_response.rb

@@ -0,0 +1,28 @@
+#<PurchaseOrderUpdateResponse>
+# <Success>1</Success>
+# <PurchaseOrder PONumber="16651" SupplierID="76"/>
+# <PODate>2008-09-21 12:32:27</PODate>
+# <TotalAmount>26.50</TotalAmount>
+# <Action>New</Action> <!-- "New" if a new PO number was just assigned, "Update" if a PO number was supplied and the PO's header properties were changed, and/or a PO line was added or updated. -->
+#</PurchaseOrderUpdateResponse>
+
+#OrderInformationRequest (OIR200)	This request type provides the ShippingInformationRequest (SIR) result for the order as a whole.
+
+module RubyOmx
+
+  class PurchaseOrderResponse < Response
+    xml_name 'PurchaseOrder'
+    xml_accessor :po_number, :from=>'@PONumber' #<PurchaseOrder PONumber="16651" SupplierID="76">
+    xml_accessor :supplier_id, :from=>'@SupplierID'
+  end
+
+  class PurchaseOrderUpdateResponse < Response
+    xml_name "PurchaseOrderUpdateResponse"
+    xml_reader :success
+    xml_accessor :purchase_order, :as => RubyOmx::PurchaseOrderResponse
+    xml_accessor :po_date, :from=>'PODate', :as=>DateTime
+    xml_accessor :total_amount, :as=>Float
+    xml_accessor :action    
+  end
+    
+end

data/lib/ruby_omx/response/response_error.rb

@@ -1,13 +1,25 @@
 module RubyOmx
 
+  class ErrorMessage < Response
+    xml_name "Error"
+    xml_reader :message, :in => "Error", :from => :content
+  end
+
   class ResponseError < Response
     xml_name "ErrorResponse"
       
-    xml_reader :type, :in => "Error"
-    xml_reader :code, :in => "Error"    
-    xml_reader :message, :in => "Error"    
-    xml_reader :detail, :in => "Error"
-    xml_reader :request_id   
+    #xml_reader :type, :in => "Error"
+    #xml_reader :code, :in => "Error"    
+    #xml_reader :message, :in => "Error"    
+    #xml_reader :detail, :in => "Error"
+    #xml_reader :request_id
+    xml_reader :success
+    xml_reader :errors, :as=>[ErrorMessage]
+
+    def to_s
+      self.errors.join(',')
+    end
+
   end
    
 end

data/lib/ruby_omx/response.rb

@@ -44,6 +44,8 @@ module RubyOmx
 
   end
 
+  # Shared classes
+
   class UDIParameter < Response
     xml_name "Parameter"
     xml_accessor :key, :from => '@key'

data/lib/ruby_omx/version.rb

@@ -1,3 +1,3 @@
 module RubyOmx
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/ruby_omx.rb

@@ -32,6 +32,7 @@ end
 require 'ruby_omx/response'
 require 'ruby_omx/orders'
 require 'ruby_omx/items'
+require 'ruby_omx/purchase_orders'
 Dir.glob(File.join(File.dirname(__FILE__), 'ruby_omx/response/*.rb')).each {|f| require f }
 
 require 'ruby_omx/base'
@@ -42,4 +43,5 @@ require 'ruby_omx/connection'
 RubyOmx::Base.class_eval do
   include RubyOmx::Orders
   include RubyOmx::Items
+  include RubyOmx::PurchaseOrders
 end

data/test/purchase_orders_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class PurchaseOrdersTest < MiniTest::Unit::TestCase
+  def setup
+		@config = YAML.load_file( File.join(File.dirname(__FILE__), 'test_config.yml') )['test']
+		@connection = RubyOmx::Base.new(@config)
+		
+		@line1 = { :item_code=>'WATCH-1', :quantity => 1, :price => 122.50 }
+		@line2 = { :item_code=>'APPLE-12', :quantity => 31, :price => 1.50 }
+  end
+  
+  def test_request_from_xml
+    request = RubyOmx::PurchaseOrderUpdateRequest.format(xml_for('PurchaseOrderUpdateRequest(1.00)',200))
+    assert_equal '1.00', request.version
+    assert_equal '16651', request.purchase_order.po_number
+    assert_equal '76', request.purchase_order.supplier_id
+    assert_equal 2, request.purchase_order.line_items.length
+    assert_equal @line1[:item_code], request.purchase_order.line_items[0].item_code
+    assert_equal @line2[:item_code], request.purchase_order.line_items[1].item_code
+  
+    assert_equal 'UDIAuthToken', request.udi_parameters[0].key
+    assert_equal @config['udi_auth_token'], request.udi_parameters[0].value
+  end
+  
+  def test_send_purchase_order_update_request
+  	@connection.stubs(:post).returns(xml_for('PurchaseOrderUpdateResponse(1.00)',200))
+  	request = PurchaseOrderUpdateRequest.new
+  	po_data = { :purchase_order => {
+  	              :po_number => '16651',
+  	              :supplier_id => '76',
+  	              :line_items => [@line1, @line2]
+  	            }
+  	          }
+	
+  	# Missing Order Options
+  	begin
+  	  response = @connection.send_purchase_order_update_request({})
+  	rescue MissingPurchaseOrderOptions
+  	end
+  
+  	response = @connection.send_purchase_order_update_request(po_data)
+  	assert_kind_of PurchaseOrderUpdateResponse, response
+  	assert_equal '1', response.success
+  	assert_equal DateTime.parse('2008-09-21 12:32:27'), response.po_date
+  	assert_equal '16651', response.purchase_order.po_number
+  	assert_equal '76', response.purchase_order.supplier_id
+  	assert_kind_of Hash, response.as_hash
+
+  	response = @connection.send_purchase_order_update_request(po_data.merge({:raw_xml => true}))
+  	assert_kind_of Net::HTTPOK, response
+	
+  	# old alias should still work
+  	response = @connection.append_po(po_data)		
+  	assert_kind_of PurchaseOrderUpdateResponse, response
+  	assert_equal '16651', response.purchase_order.po_number
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_omx
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roxml
@@ -71,10 +71,13 @@ files:
 - lib/ruby_omx/exceptions.rb
 - lib/ruby_omx/items.rb
 - lib/ruby_omx/orders.rb
+- lib/ruby_omx/purchase_orders.rb
 - lib/ruby_omx/response/custom_item_attr_info_response.rb
 - lib/ruby_omx/response/item_info_response.rb
 - lib/ruby_omx/response/order_info_request.rb
 - lib/ruby_omx/response/order_info_response.rb
+- lib/ruby_omx/response/purchase_order_update_request.rb
+- lib/ruby_omx/response/purchase_order_update_response.rb
 - lib/ruby_omx/response/response_error.rb
 - lib/ruby_omx/response/smart_report_response.rb
 - lib/ruby_omx/response/udoa_request.rb
@@ -88,6 +91,7 @@ files:
 - test/base_test.rb
 - test/items_test.rb
 - test/orders_test.rb
+- test/purchase_orders_test.rb
 - test/test_config.yml
 - test/test_helper.rb
 homepage: http://github.com/aew/ruby_omx
@@ -118,5 +122,6 @@ test_files:
 - test/base_test.rb
 - test/items_test.rb
 - test/orders_test.rb
+- test/purchase_orders_test.rb
 - test/test_config.yml
 - test/test_helper.rb