ruby_omx 0.0.35 → 0.0.36

data/lib/ruby_omx/orders.rb

@@ -21,7 +21,8 @@ module RubyOmx
     PENDING_STATUS = ['0','2']                  # item is pending an OMX data delivery
     BACKORDER_STATUS = [ '3', '20','5','8']     # item needs fulfillment attention
     SHIPPED_STATUS = ['30','40','50','52']      # item has or will soon ship (may come back)
-    CANCEL_STATUS = ['50','52','90','95','96']  # item has come back or been cancelled
+    RETURN_STATUS = ['50','52']
+    CANCEL_STATUS = ['90','95','96']  # item has come back or been cancelled
     
     # Universal Direct Order Appending (UDOA)
     
@@ -53,14 +54,23 @@ module RubyOmx
     end
 
 
-    # Smart Report Information
-    def send_smart_report_request(attrs={})
-      schedule_id = attrs[:schedule_id] ||= 1
-      response = get("https://omx.ordermotion.com/en/net/SmartReports.aspx?HTTPBizID=#{@http_biz_id}&ScheduleID=#{schedule_id}")
-      SmartReportResponse.format(response)
+		#CancellationHistoryRequest (CHR100)	This request type lists all the cancellations that have occurred between two dates.
+    def send_cancellation_history_request(attrs={})
+      request = CancellationHistoryRequest.new(attrs.merge({:http_biz_id=>@http_biz_id, :udi_auth_token=>@udi_auth_token}))
+      response = get(request.to_xml.to_s)
+      return response if request.raw_xml==true || request.raw_xml==1
+      CancellationHistoryResponse.format(response)
+    end
+    
+    # ReturnHistoryRequest (RHR100)  This request returns a list of all the product returns that have happened within a target date/time range, with basic information about these returns.
+    def send_return_history_request(attrs={})
+      request = ReturnHistoryRequest.new(attrs.merge({:http_biz_id=>@http_biz_id, :udi_auth_token=>@udi_auth_token}))
+      response = get(request.to_xml.to_s)
+      return response if request.raw_xml==true || request.raw_xml==1
+      ReturnHistoryResponse.format(response)
     end
-
   end
+
 end
 
 
@@ -87,13 +97,5 @@ end
   		# 18	USPS International Global Express	 	39.99	
   		# 19	Next Day Air (USA Only)	 	0.00	
   		# 20	2nd Day Air (USA Only)	 	0.00	
-  		# 21	Priority Mail (Free $74.99 and above), 3-6 days 0.00			
-    
-    #OrderDetailUpdateRequest (ODUR100)	This request type enables you to update certain data for orders.
-		#CancellationHistoryRequest (CHR100)	This request type lists all the cancellations that have occurred between two dates.
-		#InvoiceProcessRequest (IPR100)	This command takes an order number, and runs the invoicing and credit memo processes against the order if there are any order lines that can be subject to an invoice or credit memo, or if there are returns on the order.
-		#OrderCancellationRequest (OCR100)	This request type enables you to cancel some or all the line items in an order.		
-		#OrderSecondaryStatusUpdateRequest (OSSUR100)	This request type enables you to set the secondary status of the OrderLines.
-		#OrderUpdateRequest (OUR200)	This request type enables you to change the Payment Plan of an order, as well as the basis date for payment plan calculation, and also update the "Alt ID 2" (a.k.a "Reference") field of the order.
-		#OrderWaitDateUpdateRequest (OWDUR100)	This request type enables you to change the Wait Date of an existing order.  
+  		# 21	Priority Mail (Free $74.99 and above), 3-6 days 0.00    
 =end

data/lib/ruby_omx/request/cancellation_history_request.rb

@@ -0,0 +1,17 @@
+module RubyOmx
+
+  class CancellationHistoryRequest < Request
+
+    def initialize(attrs={})
+      return super unless attrs.any?
+      raise MissingRequestOptions if attrs[:start_date].nil? || attrs[:end_date].nil?
+      super
+      self.version = attrs[:version] ||= '1.00'  		
+      self.udi_parameters << RubyOmx::UDIParameter.new({:key=>'StartDate', :value=>attrs[:start_date]})
+      self.udi_parameters << RubyOmx::UDIParameter.new({:key=>'EndDate', :value=>attrs[:end_date] })
+    end
+    
+    attr_accessor :start_date, :end_date
+    xml_name "CancellationHistoryRequest"
+  end
+end

data/lib/ruby_omx/request/return_history_request.rb

@@ -0,0 +1,17 @@
+module RubyOmx
+
+  class ReturnHistoryRequest < Request
+
+    def initialize(attrs={})
+      return super unless attrs.any?      
+      raise MissingRequestOptions if attrs[:start_date].nil? || attrs[:end_date].nil?
+      super
+      self.version = attrs[:version] ||= '1.00'  		
+      self.udi_parameters << RubyOmx::UDIParameter.new({:key=>'StartDate', :value=>attrs[:start_date]})
+      self.udi_parameters << RubyOmx::UDIParameter.new({:key=>'EndDate', :value=>attrs[:end_date] })
+    end
+    
+    attr_accessor :start_date, :end_date
+    xml_name "ReturnHistoryRequest"
+  end
+end

data/lib/ruby_omx/response/cancellation_history_response.rb

@@ -0,0 +1,49 @@
+module RubyOmx
+
+  class CancellationHistoryLineItem < Node
+    xml_name "LineItem"
+    xml_reader :cancellation_date, :as=>DateTime
+    xml_reader :line_number, :from => '@lineNumber'
+    xml_reader :item_code
+    xml_reader :quantity, :as=>Integer      # <Quantity>1</Quantity>
+  	xml_reader :price, :as=>Float           # <Price type="U">4.95</Price>
+    xml_reader :tax, :as=>Float 	          #	<Tax percent="8.75">0.43</Tax>
+  	xml_reader :total_amount, :as=>Float    #	<TotalAmount>5.38</TotalAmount>
+    xml_reader :sh, :as=>Float, :from=>"SH"
+    xml_reader :sh_tax, :as=>Float, :from=>"SHTax"
+  end
+
+  class CancellationHistoryOrder < Node
+    xml_name "Order"
+    xml_reader :order_number, :from=>"@orderNumber"
+    xml_reader :order_id, :in=>"Header", :from=>"OrderID"
+    xml_reader :store_code, :in=>"Header"
+    xml_reader :line_items, :as => [CancellationHistoryLineItem], :in=>"OrderDetail"
+  end
+
+  class CancellationHistoryResponse < StandardResponse
+    xml_name "CancellationHistoryResponse>"
+    xml_reader :orders, :as => [CancellationHistoryOrder]    
+  end
+
+	#<Order orderNumber="18602">
+	#	<Header>
+	#		<OrderID/>
+	#		<StoreCode/>
+	#	</Header>
+	#	<OrderDetail>
+	#		<LineItem lineNumber="4">
+	#			<CancellationDate>2005-08-04 10:46:00</CancellationDate>
+	#			<ItemCode>SUMTRACOFFEE</ItemCode>
+	#			<Quantity>1</Quantity>
+	#			<Price type="U">4.95</Price>
+	#			<Tax percent="8.75">0.43</Tax>
+	#			<TotalAmount>5.38</TotalAmount>
+	#			<SH>0</SH>
+	#			<Info/>
+	#			<SHTax>0</SHTax>
+	#		</LineItem>
+	#	</OrderDetail>
+	#</Order>
+
+end

data/lib/ruby_omx/response/return_history_response.rb

@@ -0,0 +1,61 @@
+module RubyOmx
+
+  class ReturnHistoryLineItem < Node
+    xml_name "LineItem"
+    xml_reader :item_code
+    xml_reader :line_number, :from=>"@lineNumber"    
+    xml_reader :ordered_quantity, :as=>Integer      #	<OrderedQuantity>4</OrderedQuantity>
+  	xml_reader :return_quantity, :as=>Integer       #	<ReturnQuantity>1</ReturnQuantity>
+  	xml_reader :return_amount, :as=>Float           #	<ReturnAmount>3.00</ReturnAmount>
+  	xml_reader :return_tax_amount, :as=>Float       # <ReturnTaxAmount>0.00</ReturnTaxAmount>
+  	xml_reader :return_reason   	                  # <ReturnReason code="BADE" type="Replacement">Exchange - Add Inv</ReturnReason>
+  end
+
+  class ReturnHistoryItem < Node
+    xml_name "Return"
+    xml_reader :return_id, :from=>"@returnID"
+    xml_reader :return_type, :from=>"@type"
+    xml_reader :return_date, :as=>DateTime
+    xml_reader :return_amount, :as=>Float
+    xml_reader :return_tax_amount, :as=>Float
+    xml_reader :line_items, :as=>[ReturnHistoryLineItem], :in=>"LineDetail"    
+  end
+
+  class ReturnHistoryOrder < Node
+    xml_name "Order"
+    xml_reader :order_number, :from=>"@orderNumber"
+    xml_reader :order_id, :in=>"Header", :from=>"OrderID"
+    xml_reader :store_code, :in=>"Header"
+    xml_reader :returns, :as => [ReturnHistoryItem], :in=>"ReturnDetail"
+  end
+
+  class ReturnHistoryResponse < StandardResponse
+    xml_name "ReturnHistoryResponse"
+    xml_reader :orders, :as => [ReturnHistoryOrder]    
+  end
+
+	#<Order orderNumber="12992">
+	#	<Header>
+	#		<OrderID/>
+	#		<StoreCode/>
+	#	</Header>
+	#	<ReturnDetail>
+	#		<Return returnID="1" type="Return">
+	#			<ReturnDate>2006-02-16 12:16:00</ReturnDate>
+	#			<ReturnAmount>3.00</ReturnAmount>
+	#			<ReturnTaxAmount>0.00</ReturnTaxAmount>
+	#			<LineDetail>
+	#				<LineItem lineNumber="3">
+	#					<ItemCode>1112</ItemCode>
+	#					<OrderedQuantity>4</OrderedQuantity>
+	#					<ReturnQuantity>1</ReturnQuantity>
+	#					<ReturnAmount>3.00</ReturnAmount>
+	#					<ReturnTaxAmount>0.00</ReturnTaxAmount>
+	#					<ReturnReason code="BADE" type="Replacement">Exchange - Add Inv</ReturnReason>
+	#				</LineItem>
+	#			</LineDetail>
+	#		</Return>
+	#	</ReturnDetail>
+	#</Order>
+
+end

data/lib/ruby_omx/version.rb

@@ -1,3 +1,3 @@
 module RubyOmx
-  VERSION = "0.0.35"
+  VERSION = "0.0.36"
 end

data/test/orders_test.rb

@@ -261,20 +261,68 @@ class OrdersTest < MiniTest::Unit::TestCase
     assert_equal '40', response.line_items[0].line_status.value  
     assert_equal '5/31/2010 5:36:00 AM', response.line_items[0].line_status.date
 		assert_kind_of Hash, response.as_hash
+		assert_kind_of String, response.to_s
 		
 		response = @connection_alt.send_info_request({ :order_id=> 'AZ-43253-234', :store_code=>'XX01' })
 		assert_kind_of OrderInfoResponse, response
   end
   
-  def test_send_smart_report_request
-  	@connection.stubs(:get).returns(xml_for('SmartReports',200))
-		response = @connection.send_smart_report_request
-		assert_kind_of SmartReportResponse, response
-		assert_equal 2, response.rows.length
-		assert_equal 12, response.rows[0].fields.length
-		assert_equal '1', response.rows[0].fields[0].id
-		assert_equal '12432343', response.rows[0].fields[0].value
-		assert_kind_of Hash, response.as_hash
+  def test_cancellation_history_request
+  	@connection.stubs(:get).returns(xml_for('CancellationHistoryResponse(1.00)',200))
+		response = @connection.send_cancellation_history_request({:start_date=>Time.now, :end_date=>Time.now})
+		assert_kind_of CancellationHistoryResponse, response
+
+    assert_equal 15, response.orders.count
+    o = response.orders[8]
+    assert_equal "19661", o.order_number
+    assert_equal 3, o.line_items.count
+    li = o.line_items.first
+    assert_equal '1', li.line_number
+    assert_equal DateTime.parse('2005-08-04 10:46:00'), li.cancellation_date
+    assert_equal "GIFTBASKET04", li.item_code
+    assert_equal 1, li.quantity
+    assert_equal 79.99, li.price
+    assert_equal 0, li.tax
+    assert_equal 79.99, li.total_amount
+    assert_equal 0, li.sh
+    assert_equal 0, li.sh_tax
+
+		assert_kind_of Hash, response.as_hash		
   end
   
+  def test_return_history_request
+    @connection.stubs(:get).returns(xml_for('ReturnHistoryResponse(1.00)',200))
+		response = @connection.send_return_history_request({:start_date=>Time.now, :end_date=>Time.now})
+		assert_kind_of ReturnHistoryResponse, response
+
+    assert_equal 3, response.orders.count
+    o = response.orders[1]
+
+    assert_equal "18016", o.order_number
+    assert_equal 5, o.returns.count
+
+    r = o.returns.first
+    assert_equal '1', r.return_id
+    assert_equal 'Return', r.return_type
+    assert_equal DateTime.parse('2006-02-15 14:35:00'), r.return_date
+    assert_equal 20.02, r.return_amount
+    assert_equal 0, r.return_tax_amount
+    assert_equal 3, r.line_items.count
+    
+    li = r.line_items.first
+    assert_equal '1', li.line_number
+    assert_equal '01-112', li.item_code
+    assert_equal 1, li.ordered_quantity
+    assert_equal 1, li.return_quantity
+    assert_equal 10.00, li.return_amount
+    assert_equal 0, li.return_tax_amount
+    assert_equal "Return - Broken during Delievery on the way", li.return_reason
+
+    # Not implemented
+    #assert_equal "BADD", li.return_reason_code
+    #assert_equal "Regular", li.return_reason_type
+  
+		assert_kind_of Hash, response.as_hash
+  end
+    
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_omx
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.36
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roxml
@@ -74,6 +74,7 @@ files:
 - lib/ruby_omx/node.rb
 - lib/ruby_omx/orders.rb
 - lib/ruby_omx/purchase_orders.rb
+- lib/ruby_omx/request/cancellation_history_request.rb
 - lib/ruby_omx/request/custom_item_info_request.rb
 - lib/ruby_omx/request/inventory_info_request.rb
 - lib/ruby_omx/request/item_info_request.rb
@@ -82,9 +83,11 @@ files:
 - lib/ruby_omx/request/memo_submission_request.rb
 - lib/ruby_omx/request/order_info_request.rb
 - lib/ruby_omx/request/purchase_order_update_request.rb
+- lib/ruby_omx/request/return_history_request.rb
 - lib/ruby_omx/request/supplier_item_update_request.rb
 - lib/ruby_omx/request/udoa_request.rb
 - lib/ruby_omx/request.rb
+- lib/ruby_omx/response/cancellation_history_response.rb
 - lib/ruby_omx/response/custom_item_info_response.rb
 - lib/ruby_omx/response/inventory_info_response.rb
 - lib/ruby_omx/response/item_info_response.rb
@@ -94,7 +97,7 @@ files:
 - lib/ruby_omx/response/order_info_response.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/return_history_response.rb
 - lib/ruby_omx/response/supplier_item_update_response.rb
 - lib/ruby_omx/response/udoa_response.rb
 - lib/ruby_omx/response.rb

data/lib/ruby_omx/response/smart_report_response.rb

@@ -1,30 +0,0 @@
-module RubyOmx
-
-  class SmartReportField < Node
-    xml_name "Field"
-    xml_reader :id, :from=>'@fieldID'
-    xml_reader :value, :from=>:content
-  end
-  
-  class SmartReportRow < Node
-    xml_name "Row"
-    xml_reader :fields, :as=>[SmartReportField]
-    #1 Order Number
-    #2 Alt ID
-    #3 Product SKU
-    #4 Product Name
-    #5 Quantity
-    #6 Price
-    #7 Customer Number
-    #8 Customer Name
-    #10 Shipping Type
-    #11 Supplier Id
-    #12 Supplier Name
-  end
-
-  class SmartReportResponse < Response
-    xml_name "SmartReportResultXml"
-    xml_reader :rows, :as=>[SmartReportRow], :in=>'Detail'
-  end
-  
-end