ruby_omx 0.0.17 → 0.0.18

data/lib/ruby_omx/memos.rb

@@ -0,0 +1,17 @@
+module RubyOmx
+  module Memos
+    
+    def build_memo_submission_request(params={})
+		  MemoSubmissionRequest.new(params.merge({:udi_auth_token=>@udi_auth_token, :http_biz_id=>@http_biz_id}))
+		end
+		
+		def send_memo_submission_request(params={})
+		  request = build_memo_submission_request(params)
+      response = post(request.to_xml.to_s)
+      return response if request.raw_xml==true || request.raw_xml==1
+      MemoSubmissionResponse.format(response)		  
+		end
+		alias_method :send_memo, :send_memo_submission_request
+
+  end
+end

data/lib/ruby_omx/purchase_orders.rb

@@ -1,8 +1,6 @@
 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

data/lib/ruby_omx/response/memo_submission_request.rb

@@ -0,0 +1,33 @@
+module RubyOmx
+
+  class MemoSubmissionRequest < 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)
+
+      self.version = a[:version] ||= '1.00'
+      super
+      
+      self.udi_parameters = []
+      self.udi_parameters << RubyOmx::UDIParameter.new({:key=>'UDIAuthToken', :value=>udi_auth_token})
+      self.udi_parameters << RubyOmx::UDIParameter.new({:key=>'HTTPBizID', :value=>http_biz_id})
+    end
+    
+    attr_accessor :order_number, :order_id, :store_code, :raw_xml
+    
+    xml_name "MemoSubmissionRequest"
+    xml_accessor :version, :from => '@version'
+    xml_accessor :udi_parameters, :as => [RubyOmx::UDIParameter], :in => 'UDIParameter'
+   
+    xml_accessor :lead_number, :in=>'Memo'
+    xml_accessor :customer_number, :in=>'Memo'
+    xml_accessor :order_number, :in=>'Memo'
+    xml_accessor :shipment_number, :in=>'Memo'
+    xml_accessor :reminder_date, :in=>'Memo', :as=>DateTime # Dates are almost the same as the W3C Schema "date" type, but with a space instead of the "T" separating the date from the time.
+    xml_accessor :memo_type, :in=>'Memo', :as=>Integer
+    xml_accessor :memo_text, :in=>'Memo'
+    xml_accessor :memo_transmission_date, :in=>'Memo', :as=>DateTime
+    
+  end
+end

data/lib/ruby_omx/response/memo_submission_response.rb

@@ -0,0 +1,11 @@
+#OrderInformationRequest (OIR200)	This request type provides the ShippingInformationRequest (SIR) result for the order as a whole.
+
+module RubyOmx
+
+  class MemoSubmissionResponse < Response
+    xml_name "MemoSubmissionResponse"
+    xml_reader :success
+    xml_accessor :errors, :as=>[RubyOmx::ErrorData], :in=>'ErrorData'
+  end
+    
+end

data/lib/ruby_omx/response/order_info_response.rb

@@ -55,6 +55,7 @@ module RubyOmx
     #xml_reader :shipping_information, :as=>OrderInfoShippingInfo
     xml_reader :line_items, :as => [OrderInfoLineItem], :in=>'OrderDetail'
 
+    xml_reader :customer_number, :from=>'@number', :in=>'Customer'
     xml_reader :tracking_number, :in=>'ShippingInformation/Shipment'
     xml_reader :ship_date, :in=>'ShippingInformation/Shipment',:as=>DateTime # if populated, it means all items have shipped
   end

data/lib/ruby_omx/version.rb

@@ -1,3 +1,3 @@
 module RubyOmx
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

data/lib/ruby_omx.rb

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

data/test/memos_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class MemosTest < MiniTest::Unit::TestCase
+  def setup
+		@config = YAML.load_file( File.join(File.dirname(__FILE__), 'test_config.yml') )['test']
+		@connection = RubyOmx::Base.new(@config)		
+  end
+  
+  def test_request_from_xml
+    request = RubyOmx::MemoSubmissionRequest.format(xml_for('MemoSubmissionRequest(1.00)',200))
+    assert_equal '1.00', request.version
+    assert_equal '949538', request.order_number
+    assert_equal 'Test Memo', request.memo_text
+    assert_equal DateTime.parse('2003-04-01 22:15:10'), request.reminder_date
+    assert_equal DateTime.parse('2003-03-01 22:15:10'), request.memo_transmission_date
+
+    assert_equal 'UDIAuthToken', request.udi_parameters[0].key
+    assert_equal @config['udi_auth_token'], request.udi_parameters[0].value
+  end
+  
+  def test_send_memo_submission_request
+  	@connection.stubs(:post).returns(xml_for('MemoSubmissionResponse(1.00)',200))
+  	request = MemoSubmissionRequest.new
+  	
+  	memo_data = { :order_number => '949538',
+                  :memo_text=>'Test Memo',
+                  :reminder_date=>Time.now + 1.month,
+                  :memo_transmission_date=>Time.now }
+
+	  r = @connection.build_memo_submission_request(memo_data)
+    assert_instance_of String, r.to_xml.to_s
+		
+  	response = @connection.send_memo_submission_request(memo_data)
+  	assert_kind_of MemoSubmissionResponse, response
+  	assert_equal '1', response.success
+  	assert_kind_of Hash, response.as_hash
+
+  	response = @connection.send_memo_submission_request(memo_data.merge({:raw_xml => true}))
+  	assert_kind_of Net::HTTPOK, response
+	
+  	# old alias should still work
+  	response = @connection.send_memo(memo_data)		
+  	assert_kind_of MemoSubmissionResponse, response
+  end
+end

data/test/orders_test.rb

@@ -194,6 +194,7 @@ class OrdersTest < MiniTest::Unit::TestCase
 		assert !response.accessors.include?("code")
 
     assert_equal DateTime.parse('2006-02-09 14:47:00'), response.ship_date
+    assert_equal '11229', response.customer_number
     assert_equal "", response.tracking_number
     assert_equal '16651', response.order_header.order_number
     assert_equal DateTime.parse('2005-06-20 14:25:00'), response.order_header.order_date
@@ -224,7 +225,7 @@ class OrdersTest < MiniTest::Unit::TestCase
     assert_equal DateTime.parse('2010-05-31 05:36:00'), response.order_header.order_status_date
     assert_equal '4', response.order_header.order_status_code
 
-    
+    assert_equal '11552', response.customer_number
     assert_equal 2, response.line_items.length
     assert_equal '24603-0', response.line_items[0].shipment_number
     assert_equal 10, response.line_items[0].line_cogs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_omx
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -70,10 +70,13 @@ files:
 - lib/ruby_omx/connection.rb
 - lib/ruby_omx/exceptions.rb
 - lib/ruby_omx/items.rb
+- lib/ruby_omx/memos.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/memo_submission_request.rb
+- lib/ruby_omx/response/memo_submission_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
@@ -90,6 +93,7 @@ files:
 - README.rdoc
 - test/base_test.rb
 - test/items_test.rb
+- test/memos_test.rb
 - test/orders_test.rb
 - test/purchase_orders_test.rb
 - test/test_config.yml
@@ -121,6 +125,7 @@ summary: Ruby wrapper for OrderMotion (OMX)
 test_files:
 - test/base_test.rb
 - test/items_test.rb
+- test/memos_test.rb
 - test/orders_test.rb
 - test/purchase_orders_test.rb
 - test/test_config.yml