active_fulfillment 2.0.2 → 2.1.0

data/lib/active_fulfillment/fulfillment/services/webgistix.rb

@@ -3,30 +3,32 @@ module ActiveMerchant
     class WebgistixService < Service
       SERVICE_URLS = {
         :fulfillment => 'https://www.webgistix.com/XML/CreateOrder.asp',
-        :inventory => 'https://www.webgistix.com/XML/GetInventory.asp',
-        :tracking  => 'https://www.webgistix.com/XML/GetTracking.asp'
-      } 
+        :inventory   => 'https://www.webgistix.com/XML/GetInventory.asp',
+        :tracking    => 'https://www.webgistix.com/XML/GetTracking.asp'
+      }
       TEST_URLS = SERVICE_URLS.merge({
         :fulfillment => 'https://www.webgistix.com/XML/CreateOrderTest.asp'
       })
-      
+
       SUCCESS, DUPLICATE, FAILURE = 'True', 'Duplicate', 'False'
 
       SUCCESS_MESSAGE = 'Successfully submitted the order'
       FAILURE_MESSAGE = 'Failed to submit the order'
       DUPLICATE_MESSAGE = 'This order has already been successfully submitted'
-      
+
       INVALID_LOGIN = 'Invalid Credentials'
       NOT_SHIPPED = 'Not Shipped'
 
-      # If a request is detected as a duplicate only the original data will be 
+      TRACKING_COMPANIES = %w(UPS FedEx USPS)
+
+      # If a request is detected as a duplicate only the original data will be
       # used by Webgistix, and the subsequent responses will have a
       # :duplicate parameter set in the params hash.
       self.retry_safe = true
-      
+
       # The first is the label, and the last is the code
       def self.shipping_methods
-        [ 
+        [
           ["UPS Ground Shipping", "Ground"],
           ["UPS Ground", "Ground"],
           ["UPS Standard Shipping (Canada Only)", "Standard"],
@@ -63,7 +65,7 @@ module ActiveMerchant
           ["USPS Media Mail", "Media Mail"]
         ].inject(ActiveSupport::OrderedHash.new){|h, (k,v)| h[k] = v; h}
       end
-      
+
       # Pass in the login and password for the shipwire account.
       # Optionally pass in the :test => true to force test mode
       def initialize(options = {})
@@ -71,8 +73,8 @@ module ActiveMerchant
         super
       end
 
-      def fulfill(order_id, shipping_address, line_items, options = {})  
-        requires!(options, :shipping_method) 
+      def fulfill(order_id, shipping_address, line_items, options = {})
+        requires!(options, :shipping_method)
         commit :fulfillment, build_fulfillment_request(order_id, shipping_address, line_items, options)
       end
 
@@ -80,60 +82,60 @@ module ActiveMerchant
         commit :inventory, build_inventory_request(options)
       end
 
-      def fetch_tracking_numbers(order_ids, options = {})
+      def fetch_tracking_data(order_ids, options = {})
         commit :tracking, build_tracking_request(order_ids, options)
       end
-      
+
       def valid_credentials?
         response = fulfill('', {}, [], :shipping_method => '')
         response.message != INVALID_LOGIN
       end
-   
+
       def test_mode?
         true
       end
 
       private
-      #<?xml version="1.0"?> 
-      # <OrderXML> 
-      #   <Password>Webgistix</Password> 
-      #   <CustomerID>3</CustomerID> 
-      #   <Order> 
-      #     <ReferenceNumber></ReferenceNumber> 
-      #     <Company>Test Company</Company> 
-      #     <Name>Joe Smith</Name> 
-      #     <Address1>123 Main St.</Address1> 
-      #     <Address2></Address2> 
-      #     <Address3></Address3> 
-      #     <City>Olean</City> 
-      #     <State>NY</State> 
-      #     <ZipCode>14760</ZipCode> 
-      #     <Country>United States</Country> 
-      #     <Email>info@webgistix.com</Email> 
-      #     <Phone>1-123-456-7890</Phone> 
-      #     <ShippingInstructions>Ground</ShippingInstructions> 
-      #     <OrderComments>Test Order</OrderComments> 
-      #     <Approve>0</Approve> 
-      #     <Item> 
-      #      <ItemID>testitem</ItemID> 
-      #      <ItemQty>2</ItemQty> 
-      #     </Item> 
-      #   </Order> 
+      #<?xml version="1.0"?>
+      # <OrderXML>
+      #   <Password>Webgistix</Password>
+      #   <CustomerID>3</CustomerID>
+      #   <Order>
+      #     <ReferenceNumber></ReferenceNumber>
+      #     <Company>Test Company</Company>
+      #     <Name>Joe Smith</Name>
+      #     <Address1>123 Main St.</Address1>
+      #     <Address2></Address2>
+      #     <Address3></Address3>
+      #     <City>Olean</City>
+      #     <State>NY</State>
+      #     <ZipCode>14760</ZipCode>
+      #     <Country>United States</Country>
+      #     <Email>info@webgistix.com</Email>
+      #     <Phone>1-123-456-7890</Phone>
+      #     <ShippingInstructions>Ground</ShippingInstructions>
+      #     <OrderComments>Test Order</OrderComments>
+      #     <Approve>0</Approve>
+      #     <Item>
+      #      <ItemID>testitem</ItemID>
+      #      <ItemQty>2</ItemQty>
+      #     </Item>
+      #   </Order>
       # </OrderXML>
       def build_fulfillment_request(order_id, shipping_address, line_items, options)
         xml = Builder::XmlMarkup.new :indent => 2
         xml.instruct!
         xml.tag! 'OrderXML' do
           add_credentials(xml)
-          add_order(xml, order_id, shipping_address, line_items, options) 
+          add_order(xml, order_id, shipping_address, line_items, options)
         end
         xml.target!
       end
-      
-      #<?xml version="1.0"?> 
-      # <InventoryXML> 
-      #   <Password>Webgistix</Password> 
-      #   <CustomerID>3</CustomerID> 
+
+      #<?xml version="1.0"?>
+      # <InventoryXML>
+      #   <Password>Webgistix</Password>
+      #   <CustomerID>3</CustomerID>
       # </InventoryXML>
       def build_inventory_request(options)
         xml = Builder::XmlMarkup.new :indent => 2
@@ -145,8 +147,8 @@ module ActiveMerchant
 
       #<?xml version="1.0"?>
       # <TrackingXML>
-      #   <Password>Webgistix</Password> 
-      #   <CustomerID>3</CustomerID> 
+      #   <Password>Webgistix</Password>
+      #   <CustomerID>3</CustomerID>
       #   <Tracking>
       #     <Order>AB12345</Order>
       #   </Tracking>
@@ -159,7 +161,7 @@ module ActiveMerchant
         xml.instruct!
         xml.tag! 'TrackingXML' do
           add_credentials(xml)
-          
+
           order_ids.each do |o_id|
             xml.tag! 'Tracking' do
               xml.tag! 'Order', o_id
@@ -179,7 +181,7 @@ module ActiveMerchant
           xml.tag! 'ShippingInstructions', options[:shipping_method]
           xml.tag! 'Approve', 1
           xml.tag! 'OrderComments', options[:comment] unless options[:comment].blank?
-    
+
           add_address(xml, shipping_address, options)
 
           Array(line_items).each_with_index do |line_item, index|
@@ -187,7 +189,7 @@ module ActiveMerchant
           end
         end
       end
-      
+
       def add_address(xml, address, options)
         xml.tag! 'Name', address[:name]
         xml.tag! 'Address1', address[:address1]
@@ -197,12 +199,12 @@ module ActiveMerchant
         xml.tag! 'State', address[:state]
         xml.tag! 'ZipCode', address[:zip]
         xml.tag! 'Company', address[:company]
-          
+
         unless address[:country].blank?
           country = Country.find(address[:country])
           xml.tag! 'Country', country.name
         end
-        
+
         xml.tag! 'Phone', address[:phone]
         xml.tag! 'Email', options[:email] unless options[:email].blank?
       end
@@ -216,20 +218,20 @@ module ActiveMerchant
 
       def commit(action, request)
         url = test? ? TEST_URLS[action] : SERVICE_URLS[action]
-        
+
         data = ssl_post(url, request,
           'EndPointURL'  => url,
           'Content-Type' => 'text/xml; charset="utf-8"'
         )
-        
+
         response = parse_response(action, data)
         Response.new(success?(response), message_from(response), response, :test => test?)
       end
-      
+
       def success?(response)
         response[:success] == SUCCESS || response[:success] == DUPLICATE
       end
-      
+
       def message_from(response)
         if response[:duplicate]
           DUPLICATE_MESSAGE
@@ -241,9 +243,9 @@ module ActiveMerchant
           FAILURE_MESSAGE
         end
       end
-      
+
       def parse_response(action, xml)
-        begin 
+        begin
           document = REXML::Document.new("<response>#{xml}</response>")
         rescue REXML::ParseException
           return {:success => FAILURE}
@@ -260,10 +262,10 @@ module ActiveMerchant
           raise ArgumentError, "Unknown action #{action}"
         end
       end
-      
+
       def parse_fulfillment_response(document)
         response = parse_errors(document)
-        
+
         # Check if completed
         if completed = REXML::XPath.first(document, '//Completed')
           completed.elements.each do |e|
@@ -272,9 +274,9 @@ module ActiveMerchant
         else
           response[:success] = FAILURE
         end
-        
+
         response[:duplicate] = response[:success] == DUPLICATE
-        
+
         response
       end
 
@@ -295,6 +297,8 @@ module ActiveMerchant
       def parse_tracking_response(document)
         response = parse_errors(document)
         response[:tracking_numbers] = {}
+        response[:tracking_companies] = {}
+        response[:tracking_urls] = {}
 
         document.root.each_element('//Shipment') do |node|
           # {InvoiceNumber => 'SOME-ID', ShipmentTrackingNumber => 'SOME-TRACKING-NUMBER'}
@@ -306,21 +310,27 @@ module ActiveMerchant
             response[:tracking_numbers][params['InvoiceNumber']] ||= []
             response[:tracking_numbers][params['InvoiceNumber']] << tracking
           end
+
+          company = params['Method'].split[0] if params['Method']
+          if TRACKING_COMPANIES.include? company
+            response[:tracking_companies][params['InvoiceNumber']] ||= []
+            response[:tracking_companies][params['InvoiceNumber']] << company
+          end
         end
 
         response
       end
-      
+
       def parse_errors(document)
         response = {}
-        
+
         REXML::XPath.match(document, "//Errors/Error").to_a.each_with_index do |e, i|
           response["error_#{i}".to_sym] = e.text
         end
-        
+
         response[:success] = response.empty? ? SUCCESS : FAILURE
         response
-      end        
+      end
     end
   end
 end

data/lib/active_fulfillment/fulfillment/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module ActiveMerchant
   module Fulfillment
-    VERSION = "2.0.2"
+    VERSION = "2.1.0"
   end
 end

data/test/remote/amazon_mws_test.rb

@@ -20,7 +20,7 @@ class RemoteAmazonMarketplaceWebservicesTest < Test::Unit::TestCase
       :country => 'US',
       :zip => '90210'
     }
-    
+
     @line_items = [
                    { :sku => 'SETTLERS',
                      :quantity => 1 #,
@@ -50,13 +50,13 @@ class RemoteAmazonMarketplaceWebservicesTest < Test::Unit::TestCase
       :login => 'y',
       :password => 'p',
       :seller_id => 'o')
-    
+
     response = service.fulfill(ActiveMerchant::Utils.generate_unique_id, @address, @line_items, @options)
     assert !response.success?
-    
+
     assert_equal "InvalidAccessKeyId: The AWS Access Key Id you provided does not exist in our records.", response.response_comment
   end
-  
+
   def test_list_orders
     response = @service.fetch_current_orders
     assert response.success?
@@ -73,23 +73,30 @@ class RemoteAmazonMarketplaceWebservicesTest < Test::Unit::TestCase
     assert response.success?
     assert_equal 0, response.stock_levels['SETTLERS']
   end
-  
+
+  def test_fetch_tracking_data
+    response = @service.fetch_tracking_data(['123456']) # an actual order
+    assert response.success?
+    assert_equal Hash.new, response.tracking_numbers # no tracking numbers in testing
+    assert_equal Hash.new, response.tracking_companies
+  end
+
   def test_fetch_tracking_numbers
     response = @service.fetch_tracking_numbers(['123456']) # an actual order
     assert response.success?
     assert_equal Hash.new, response.tracking_numbers # no tracking numbers in testing
   end
-  
+
   def test_fetch_tracking_numbers_ignores_not_found
     response = @service.fetch_tracking_numbers(['1337-1'])
     assert response.success?
     assert_equal Hash.new, response.tracking_numbers
   end
-  
+
   def test_valid_credentials
     assert @service.valid_credentials?
   end
-  
+
   def test_invalid_credentials
     service = AmazonMarketplaceWebService.new(
       :login => 'your@email.com',
@@ -97,7 +104,7 @@ class RemoteAmazonMarketplaceWebservicesTest < Test::Unit::TestCase
       :seller_id => 'SellerNumber1')
     assert !service.valid_credentials?
   end
-  
+
   def test_get_status_does_not_require_valid_credentials
     service = AmazonMarketplaceWebService.new(
       :login => 'your@email.com',
@@ -105,7 +112,7 @@ class RemoteAmazonMarketplaceWebservicesTest < Test::Unit::TestCase
     response = service.status
     assert response.success?
   end
-  
+
   def test_get_status
     service = AmazonMarketplaceWebService.new(fixtures(:amazon))
     response = service.status

data/test/remote/amazon_test.rb

@@ -9,12 +9,12 @@ class RemoteAmazonTest < Test::Unit::TestCase
   def setup
     @service = AmazonService.new( fixtures(:amazon) )
 
-    @options = { 
+    @options = {
       :shipping_method => 'Standard',
       :order_date => Time.now.utc.yesterday,
       :comment => "Delayed due to tornados"
      }
-     
+
      @address = { :name => 'Johnny Chase',
                   :address1 => '100 Information Super Highway',
                   :address2 => 'Suite 66',
@@ -23,7 +23,7 @@ class RemoteAmazonTest < Test::Unit::TestCase
                   :country => 'US',
                   :zip => '90210'
                 }
-     
+
      @line_items = [
        { :sku => 'SETTLERS8',
          :quantity => 1 #,
@@ -37,28 +37,28 @@ class RemoteAmazonTest < Test::Unit::TestCase
     assert response.success?
     assert !response.test?
   end
-  
+
   def test_order_multiple_line_items
     @line_items.push(
       { :sku => 'CARCASSONNE',
         :quantity => 2
        }
     )
-    
+
     response = @service.fulfill(ActiveMerchant::Utils.generate_unique_id, @address, @line_items, @options)
     assert response.success?
   end
-  
+
   def test_invalid_credentials_during_fulfillment
     service = AmazonService.new(
       :login => 'y',
       :password => 'p')
-    
+
     response = service.fulfill(ActiveMerchant::Utils.generate_unique_id, @address, @line_items, @options)
     assert !response.success?
     assert_equal "aws:Client.InvalidClientTokenId The AWS Access Key Id you provided does not exist in our records.", response.message
   end
-  
+
   def test_list_orders
     response = @service.fetch_current_orders
     assert response.success?
@@ -75,30 +75,37 @@ class RemoteAmazonTest < Test::Unit::TestCase
     assert response.success?
     assert_equal 0, response.stock_levels['SETTLERS']
   end
-  
+
+  def test_fetch_tracking_numbers
+    response = @service.fetch_tracking_data['123456']) # an actual order
+    assert response.success?
+    assert_equal Hash.new, response.tracking_numbers # no tracking numbers in testing
+    assert_equal Hash.new, response.tracking_companies
+  end
+
   def test_fetch_tracking_numbers
     response = @service.fetch_tracking_numbers(['123456']) # an actual order
     assert response.success?
     assert_equal Hash.new, response.tracking_numbers # no tracking numbers in testing
   end
-  
+
   def test_fetch_tracking_numbers_ignores_not_found
     response = @service.fetch_tracking_numbers(['#1337-1'])
     assert response.success?
     assert_equal Hash.new, response.tracking_numbers
   end
-  
+
   def test_valid_credentials
     assert @service.valid_credentials?
   end
-  
+
   def test_invalid_credentials
     service = AmazonService.new(
       :login => 'your@email.com',
       :password => 'password')
     assert !service.valid_credentials?
   end
-  
+
   def test_get_status_fails
     service = AmazonService.new(
       :login => 'your@email.com',
@@ -107,11 +114,11 @@ class RemoteAmazonTest < Test::Unit::TestCase
     assert !response.success?
     assert_equal "aws:Client.InvalidClientTokenId The AWS Access Key Id you provided does not exist in our records.", response.message
   end
-  
+
   def test_get_status
     service = AmazonService.new(fixtures(:amazon))
     response = service.status
     assert response.success?
   end
-  
+
 end

data/test/remote/shipwire_test.rb

@@ -5,14 +5,14 @@ class RemoteShipwireTest < Test::Unit::TestCase
     Base.mode = :test
 
     @shipwire = ShipwireService.new( fixtures(:shipwire) )
-    
-    @options = { 
+
+    @options = {
       :warehouse => 'LAX',
       :shipping_method => 'UPS Ground',
       :email => 'cody@example.com'
     }
-    
-    @us_address = { 
+
+    @us_address = {
       :name     => 'Steve Jobs',
       :company  => 'Apple Computer Inc.',
       :address1 => '1 Infinite Loop',
@@ -22,8 +22,8 @@ class RemoteShipwireTest < Test::Unit::TestCase
       :zip      => '95014',
       :email    => 'steve@apple.com'
     }
-    
-    @uk_address = { 
+
+    @uk_address = {
       :name     => 'Bob Diamond',
       :company  => 'Barclays Bank PLC',
       :address1 => '1 Churchill Place',
@@ -32,22 +32,22 @@ class RemoteShipwireTest < Test::Unit::TestCase
       :zip      => 'E14 5HP',
       :email    => 'bob@barclays.co.uk'
     }
-    
+
     @line_items = [ { :sku => 'AF0001', :quantity => 25 } ]
   end
-  
+
   def test_invalid_credentials_during_fulfillment
     shipwire = ShipwireService.new(
       :login => 'your@email.com',
       :password => 'password')
-      
+
     response = shipwire.fulfill('123456', @us_address, @line_items, @options)
     assert !response.success?
     assert response.test?
     assert_equal 'Error', response.params['status']
     assert_equal "Could not verify Username/EmailAddress and Password combination", response.message
   end
-  
+
   def test_successful_order_submission_to_us
     response = @shipwire.fulfill('123456', @us_address, @line_items, @options)
     assert response.success?
@@ -58,7 +58,7 @@ class RemoteShipwireTest < Test::Unit::TestCase
     assert_equal '0', response.params['status']
     assert_equal 'Successfully submitted the order', response.message
   end
-  
+
   def test_successful_order_submission_to_uk
     response = @shipwire.fulfill('123456', @uk_address, @line_items, @options)
     assert response.success?
@@ -69,10 +69,10 @@ class RemoteShipwireTest < Test::Unit::TestCase
     assert_equal '0', response.params['status']
     assert_equal 'Successfully submitted the order', response.message
   end
-  
+
   def test_order_multiple_line_items
     @line_items.push({ :sku => 'AF0002', :quantity => 25 })
-    
+
     response = @shipwire.fulfill('123456', @us_address, @line_items, @options)
     assert response.success?
     assert response.test?
@@ -80,41 +80,41 @@ class RemoteShipwireTest < Test::Unit::TestCase
     assert_equal '1', response.params['total_orders']
     assert_equal '2', response.params['total_items']
     assert_equal '0', response.params['status']
-    assert_equal 'Successfully submitted the order', response.message  
+    assert_equal 'Successfully submitted the order', response.message
   end
-  
+
   def test_no_sku_is_sent_with_fulfillment
-      options = { 
+      options = {
         :shipping_method => 'UPS Ground'
       }
-    
+
     line_items = [ { :quantity => 1, :description => 'Libtech Snowboard' } ]
-    
+
     response = @shipwire.fulfill('123456', @us_address, line_items, options)
-    
+
     assert response.success?
     assert response.test?
     assert_not_nil response.params['transaction_id']
     assert_equal "1", response.params['total_orders']
     assert_equal "0", response.params['total_items']
     assert_equal "0", response.params['status']
-    assert_equal 'Successfully submitted the order', response.message  
+    assert_equal 'Successfully submitted the order', response.message
   end
-  
+
   def test_invalid_credentials_during_inventory
     shipwire = ShipwireService.new(
                  :login => 'your@email.com',
                  :password => 'password'
                )
-      
+
     response = shipwire.fetch_stock_levels
-    
+
     assert !response.success?
     assert response.test?
     assert_equal 'Error', response.params['status']
     assert_equal "Error with Valid Username/EmailAddress and Password Required. There is an error in XML document.", response.message
   end
-  
+
   def test_get_inventory
     response = @shipwire.fetch_stock_levels
     assert response.success?
@@ -123,18 +123,26 @@ class RemoteShipwireTest < Test::Unit::TestCase
     assert_equal 32, response.stock_levels["GD201-500"]
     assert_equal "2", response.params["total_products"]
   end
-  
+
+  def test_fetch_tracking_data
+    response = @shipwire.fetch_tracking_data(['123456'])
+    assert response.success?
+    assert response.test?
+    assert_equal Hash.new, response.tracking_numbers # no tracking numbers in testing
+    assert_equal Hash.new, response.tracking_companies
+  end
+
   def test_fetch_tracking_numbers
     response = @shipwire.fetch_tracking_numbers(['123456'])
-    assert response.success?    
+    assert response.success?
     assert response.test?
     assert_equal Hash.new, response.tracking_numbers # no tracking numbers in testing
   end
-  
+
   def test_valid_credentials
     assert @shipwire.valid_credentials?
   end
-  
+
   def test_invalid_credentials
     service = ShipwireService.new(
                 :login => 'your@email.com',