ruby_omx 0.0.7 → 0.0.8

data/lib/ruby_omx/orders.rb

@@ -1,75 +1,48 @@
 module RubyOmx
   module Orders
     
-    def build_udoa_request(params)
+    # Universal Direct Order Appending (UDOA)
+    
+    def build_udoa_request(params={})
 		  UDOARequest.new(params.merge({:http_biz_id=>@http_biz_id, :udi_auth_token=>@udi_auth_token}))
 		end
 		
-		def send_udoa_request(params)
+		def send_udoa_request(params={})
 		  request = build_udoa_request(params)
       response = post(request.to_xml.to_s)
-      if request.raw_xml==true || request.raw_xml==1
-      	return response
-      end
+      return response if request.raw_xml==true || request.raw_xml==1
       UDOAResponse.format(response)		  
 		end
+		alias_method :append_order, :send_udoa_request
+		
+
+		# Order Information
 		
-		def append_order(params={})
-		  send_udoa_request(params)
+		def build_info_request(params={})
+		  OrderInformationRequest.new(params.merge({:http_biz_id=>@http_biz_id}))
 		end
 
-=begin		
-		#UniversalDirectOrderAppending (UDOA200)	This request type is used to create orders in the application.
-		def append_order(params ={})
-			
-			required_fields = [
-				params[:keycode],
-				params[:queue_flag],
-				params[:verify_flag],
-				params[:order_date],
-				params[:order_id],
-				params[:last_name],
-				params[:line_items],
-				params[:method_code],
-				params[:total_amount]
-			]
-			raise MissingOrderOptions if required_fields.any? {|option| option.nil?}			        
-			
-			raw_xml = params[:raw_xml] ||= false
+    def send_info_request(params={})
+		  request = build_info_request(params)
+      response = post(request.to_xml.to_s)
+      return response if request.raw_xml==true || request.raw_xml==1
+      OrderInformationResponse.format(response)
+    end
+
+
+    # Smart Report Information
+
+    def send_smart_report_request(params={})
+      schedule_id = params[:schedule_id] ||= 1
+      response = get("https://omx.ordermotion.com/en/net/SmartReports.aspx?HTTPBizID=#{@http_biz_id}&ScheduleID=#{schedule_id}")
+      SmartReportResponse.format(response)
+    end
+
+  end
+end
 
-			doc = Nokogiri::XML::Document.new
-			root_tag = RubyOmx.add_child_helper(doc,'UDOARequest','version','2.00',nil)
-			
-			udi_parameter = RubyOmx.add_child_helper(root_tag,'UDIParameter',nil,nil,nil)
-			RubyOmx.add_child_helper(udi_parameter,'Parameter','key','HTTPBizID',@http_biz_id)
-			RubyOmx.add_child_helper(udi_parameter,'Parameter','key','UDIAuthToken',@udi_auth_token)
-			RubyOmx.add_child_helper(udi_parameter,'Parameter','key','QueueFlag',params[:queue_flag] ||= 'False')		# Determines whether any orders with errors will be stored in the OrderMotion "Outside Order Queue",  to be corrected by an OrderMotion user before resubmission. If set to "True", almost all orders will be   accepted by OrderMotion, but additional order information will only be returned in the response if the order   is successfully placed. Otherwise, any order with any error (eg invalid ZIP code) will be rejected.
-			RubyOmx.add_child_helper(udi_parameter,'Parameter','key','Keycode',params[:keycode])
-			RubyOmx.add_child_helper(udi_parameter,'Parameter','key','VerifyFlag',params[:verify_flag] ||= 'True')		# Determines whether a successful order should be saved, or only verified/calculated. When set to "True", OrderMotion will behave as if the order was placed, but not return an Order Number in the response.
-			RubyOmx.add_child_helper(udi_parameter,'Parameter','key','Vendor',params[:vendor] ||= nil)
-			
-			header = RubyOmx.add_child_helper(root_tag,'Header',nil,nil,nil)
-			RubyOmx.add_child_helper(header,'StoreCode',nil,nil,params[:store_code] ||= '')
-			RubyOmx.add_child_helper(header,'OrderID',nil,nil,params[:order_id])
-			RubyOmx.add_child_helper(header,'OrderDate',nil,nil,params[:order_date]) # 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.
-			RubyOmx.add_child_helper(header,'OriginType',nil,nil,params[:origin_type] ||= '2') # 2 = phone order, 3 = internet order
-			
-			customer = RubyOmx.add_child_helper(root_tag,'Customer',nil,nil,nil)			
-			address = RubyOmx.add_child_helper(customer,'Address','type','BillTo',nil)
-			RubyOmx.add_child_helper(address,'TitleCode',nil,nil,params[:title_code] ||= '0')
-			RubyOmx.add_child_helper(address,'Firstname',nil,nil,params[:first_name] ||= 'Test')
-			RubyOmx.add_child_helper(address,'Lastname',nil,nil,params[:last_name] ||= 'Test')
-			RubyOmx.add_child_helper(address,'Address1',nil,nil,params[:address1] ||= nil)
-			RubyOmx.add_child_helper(address,'Address2',nil,nil,params[:address2] ||= nil)
-			RubyOmx.add_child_helper(address,'City',nil,nil,params[:city] ||=nil)
-			RubyOmx.add_child_helper(address,'State',nil,nil,params[:state] ||= nil)
-			RubyOmx.add_child_helper(address,'ZIP',nil,nil,params[:zip] ||=nil)
-			RubyOmx.add_child_helper(address,'TLD',nil,nil,params[:tld] ||=nil)
-			RubyOmx.add_child_helper(address,'PhoneNumber',nil,nil,params[:phone] ||= nil)
-			RubyOmx.add_child_helper(address,'Email',nil,nil,params[:email] ||= nil)
-						
-			shipping_info = RubyOmx.add_child_helper(root_tag,'ShippingInformation',nil,nil,nil)
-			
+
+=begin
   		# Shipping Methods (numeric inputs to MethodCode)
   		# 0	UPS Ground (1-4 Days Transit Time)	 	0.00	
   		# 2	Drop-Ship Montague	1	40.00	
@@ -93,72 +66,12 @@ module RubyOmx
   		# 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			
-			RubyOmx.add_child_helper(shipping_info,'MethodCode',nil,nil,params[:method_code])
-			
-			#	address = RubyOmx.add_child_helper(shipping_info,'Address','type','ShipTo',nil)
-			#		RubyOmx.add_child_helper(address,'TitleCode',nil,nil,'0')
-			#		RubyOmx.add_child_helper(address,'Firstname',nil,nil,'Test') #TODO capture the first and last name for billing, not just shipping
-			#		RubyOmx.add_child_helper(address,'Lastname',nil,nil,'Test')
-			#		RubyOmx.add_child_helper(address,'Address1',nil,nil,'251 West 30th St')
-			#		RubyOmx.add_child_helper(address,'Address2',nil,nil,'Apt 12E')
-			#		RubyOmx.add_child_helper(address,'City',nil,nil,'New York')
-			#		RubyOmx.add_child_helper(address,'State',nil,nil,'NY')
-			#		RubyOmx.add_child_helper(address,'ZIP',nil,nil,'10001')
-			#		RubyOmx.add_child_helper(address,'TLD',nil,nil,'US')
-				#	RubyOmx.add_child_helper(address,'PhoneNumber',nil,nil,nil)
-				#	RubyOmx.add_child_helper(address,'Email',nil,nil,nil)
-			RubyOmx.add_child_helper(shipping_info,'ShippingAmount',nil,nil,params[:shipping_amount] ||= '0.00')		
-				#RubyOmx.add_child_helper(shipping_info,'HandlingAmount',nil,nil,'0')		
-				#RubyOmx.add_child_helper(shipping_info,'SpecialInstructions',nil,nil,'0')
-			RubyOmx.add_child_helper(shipping_info,'GiftWrapping',nil,nil,params[:gift_wrapping] ||= 'False')								
-			RubyOmx.add_child_helper(shipping_info,'GiftMessage',nil,nil,params[:gift_message] ||= nil)				
-							
-			payment_type = RubyOmx.add_child_helper(root_tag,'Payment','type',params[:payment_type] ||= '6',nil) #6 for open invoice
-			#	RubyOmx.add_child_helper(payment_type,'CardNumber',nil,nil,'4111111111111111')
-			#	RubyOmx.add_child_helper(payment_type,'CardVerification',nil,nil,'222')
-			#	RubyOmx.add_child_helper(payment_type,'CardExpDateMonth',nil,nil,'09')
-			#	RubyOmx.add_child_helper(payment_type,'CardExpDateYear',nil,nil,'2011')
-			#	RubyOmx.add_child_helper(payment_type,'CardStatus',nil,nil,'11')
-			#	RubyOmx.add_child_helper(payment_type,'CardAuthCode',nil,nil,'11')
-			#	RubyOmx.add_child_helper(payment_type,'CardTransactionID',nil,nil,'123456789')
-				
-			order_detail = RubyOmx.add_child_helper(root_tag,'OrderDetail',nil,nil,nil)
-				
-			i=1
-			params[:line_items].each do |item|
-				raise MissingItemOptions if item[:item_code].nil?
-				line_item = RubyOmx.add_child_helper(order_detail,'LineItem','lineNumber',i.to_s,nil) 	
-					RubyOmx.add_child_helper(line_item,'ItemCode',nil,nil,item[:item_code])
-					RubyOmx.add_child_helper(line_item,'Quantity',nil,nil,item[:quantity] ||= '1')
-					if !item[:unit_price].nil?
-						RubyOmx.add_child_helper(line_item,'UnitPrice',nil,nil,item[:unit_price])
-					end
-					#RubyOmx.add_child_helper(line_item,'StandingOrder','configurationID','5',nil)
-					#customization = RubyOmx.add_child_helper(line_item,'ItemCustomizationData',nil,nil,nil)
-					#field = RubyOmx.add_child_helper(customization,'CustomizationField','fieldID','127',nil)
-					#RubyOmx.add_child_helper(field,'Value',nil,nil,'demoText')
-					i+=1
-			end
-			
-			check = RubyOmx.add_child_helper(root_tag,'Check',nil,nil,nil)
-			RubyOmx.add_child_helper(check,'TotalAmount',nil,nil,params[:total_amount])
-								    
-      response = post(doc.to_xml)
-      if raw_xml==true || raw_xml==1
-      	return response
-      else
-       	UDOAResponse.format(response)
-      end
-    end
     
     #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.		
-		#OrderInformationRequest (OIR200)	This request type provides the ShippingInformationRequest (SIR) result for the order as a whole.
 		#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.  
-=end
-  end
-end
+=end

data/lib/ruby_omx/response/order_info_request.rb

@@ -0,0 +1,31 @@
+#$wtf = "https://api.omx.ordermotion.com/hdde/xml/udi.asp?Wrapper=1&RequestType=OrderInformationRequest&RequestVersion=1.00&HTTPBizID=".BIZ_ID."&OrderNumber=".$OMorderid."&level=$level";
+module RubyOmx
+
+  class UDIParameter < Response
+    xml_name "Parameter"
+    xml_accessor :key, :from => '@key'
+    xml_accessor :value, :from => :content
+  end
+
+  class OrderInformationRequest < 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)
+      
+		  required_fields = [:order_number]
+		  raise MissingOrderOptions if required_fields.any? { |option| a[option].nil? }
+      super
+      self.version = a[:version] ||= '1.00'
+      self.udi_parameters = [ RubyOmx::UDIParameter.new({:key=>'HTTPBizID', :value=>http_biz_id}),
+                              RubyOmx::UDIParameter.new({:key=>'OrderNumber', :value=>a[:order_number]}),
+                              RubyOmx::UDIParameter.new({:key=>'level', :value=>a[:level] ||=0 })]
+    end
+    
+    attr_accessor :order_number, :raw_xml
+    
+    xml_name "OrderInformationRequest"
+    xml_accessor :version, :from => '@version'
+    xml_accessor :udi_parameters, :as => [RubyOmx::UDIParameter], :in => 'UDIParameter'
+  end
+end

data/lib/ruby_omx/response/order_info_response.rb

@@ -0,0 +1,55 @@
+#OrderInformationRequest (OIR200)	This request type provides the ShippingInformationRequest (SIR) result for the order as a whole.
+
+module RubyOmx
+
+  class OrderInfoLineStatus < Response
+    xml_name "LineStatus"
+    #<LineStatus date="2/9/2006 2:47:00 PM" text="OK">40</LineStatus>
+    xml_reader :text, :from => '@text'  # C/L means cancelled, OK with a date means processing
+    xml_reader :date, :from => '@date', :as=>DateTime # cancellation date if cancelled, processing date if processing
+    xml_reader :value, :from => :content, :as=>Integer
+  end
+  
+  class OrderInfoOrderHeader < Response
+    xml_name "OrderHeader"
+    xml_reader :order_id
+    xml_reader :order_number
+    xml_reader :order_date, :as=>DateTime
+  end
+      
+  class OrderInfoLineItem < Response
+    xml_name "LineItem"
+    xml_reader :item_code
+    xml_reader :product_name
+    xml_reader :quantity
+    xml_reader :price
+    xml_reader :line_status, :as=>OrderInfoLineStatus
+    xml_reader :warehouse_reference
+    xml_reader :tracking_number
+    xml_reader :line_cogs, :from=>'LineCOGS', :as=>Float
+    xml_reader :unit_cogs, :from=>'UnitCOGS', :as=>Float
+    xml_reader :supplier_item_code
+    
+        
+    # OMX Status Codes
+    # 0 complete?, Order cancelled at
+    # 1 cancelled?
+    # 2
+    # 3
+    # 4 Order entered processing at
+    # 5
+    # 6 complete?, All items shipped
+    # 7 shipped?
+  end
+
+  class OrderInformationResponse < Response
+    xml_name "OrderInformationResponse"
+    xml_reader :order_header, :as=>OrderInfoOrderHeader
+    #xml_reader :shipping_information, :as=>OrderInfoShippingInfo
+    xml_reader :line_items, :as => [OrderInfoLineItem], :in=>'OrderDetail'
+
+    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
+    
+end

data/lib/ruby_omx/response/smart_result_response.rb

@@ -0,0 +1,30 @@
+module RubyOmx
+
+  class SmartReportField < Response
+    xml_name "Field"
+    xml_reader :id, :from=>'@fieldID'
+    xml_reader :value, :from=>:content
+  end
+  
+  class SmartReportRow < Response
+    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

data/lib/ruby_omx/response/udoa_request.rb

@@ -1,10 +1,4 @@
 module RubyOmx
-
-  class UDIParameter < Response
-    xml_name "Parameter"
-    xml_accessor :key, :from => '@key'
-    xml_accessor :value, :from => :content
-  end
     
   class Address < Response
     xml_name "Address"
@@ -75,7 +69,7 @@ module RubyOmx
       
     xml_name "UDOARequest"
     xml_accessor :version, :from => '@version'
-    xml_accessor :udi_parameters, :as => [UDIParameter], :in => 'UDIParameter'
+    xml_accessor :udi_parameters, :as => [RubyOmx::UDIParameter], :in => 'UDIParameter'
     xml_accessor :order_date, :in => 'Header', :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 :order_id, :in => 'Header', :from => 'OrderID'
     xml_accessor :origin_type, :in => 'Header'

data/lib/ruby_omx/response.rb

@@ -5,10 +5,8 @@ module RubyOmx
     xml_convention :camelcase
     
     def initialize(object_attribute_hash=nil)
-      if !object_attribute_hash.nil?
-        object_attribute_hash.map { |(k, v)| send("#{k}=", v) }
-      end
-     end
+      object_attribute_hash.map { |(k, v)| send("#{k}=", v) } if object_attribute_hash.present?
+   end
 
     # This is the factoryish method that is called!, not new
     def self.format(response)

data/lib/ruby_omx/version.rb

@@ -1,3 +1,3 @@
 module RubyOmx
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/test/orders_test.rb

@@ -164,7 +164,6 @@ class OrdersTest < MiniTest::Unit::TestCase
   	rescue MissingOrderOptions
   	end
     
-    # Should work
     order_data[:line_items][0].merge!({ :item_code => 'SKU' })
 		response = @connection.send_udoa_request(order_data)
 
@@ -183,4 +182,38 @@ class OrdersTest < MiniTest::Unit::TestCase
 		assert_kind_of UDOAResponse, response
 		assert_equal 'OMX-ofyccytnacrtnedlldmyed', response.OMX
   end
+  
+  def test_send_info_request
+  	@connection.stubs(:post).returns(xml_for('OrderInformationResponse(1.00)',200))
+		response = @connection.send_info_request({ :order_number => '16651' })
+		assert_kind_of OrderInformationResponse, response
+		assert !response.accessors.include?("code")
+
+    assert_equal DateTime.parse('2006-02-09 14:47:00'), response.ship_date
+    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
+    assert_equal 1, response.line_items.length
+    assert_equal 6.52, response.line_items[0].line_cogs
+    assert_equal 6.52, response.line_items[0].unit_cogs
+    assert_equal '01-113', response.line_items[0].supplier_item_code
+    assert_equal '01-113', response.line_items[0].item_code
+    assert_instance_of OrderInfoLineStatus, response.line_items[0].line_status
+    assert_equal "OK", response.line_items[0].line_status.text
+    assert_equal 40, response.line_items[0].line_status.value  
+    assert_equal DateTime.parse('2/9/2006 2:47:00 PM'), response.line_items[0].line_status.date
+		assert_kind_of Hash, response.as_hash
+  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
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_omx
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roxml
@@ -73,7 +73,10 @@ files:
 - lib/ruby_omx/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/response_error.rb
+- lib/ruby_omx/response/smart_result_response.rb
 - lib/ruby_omx/response/udoa_request.rb
 - lib/ruby_omx/response/udoa_response.rb
 - lib/ruby_omx/response.rb
@@ -107,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for OrderMotion (OMX)