active_shipping 0.0.1

data/test/unit/base_test.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class BaseTest < Test::Unit::TestCase
+  include ActiveMerchant::Shipping
+
+  def test_get_usps_by_string
+    assert_equal USPS, Base.carrier('usps')
+    assert_equal USPS, Base.carrier('USPS')
+  end
+
+  def test_get_usps_by_name
+    assert_equal USPS, Base.carrier(:usps)
+  end
+  
+  def test_get_unknown_carrier
+    assert_raise(NameError){ Base.carrier(:polar_north) }
+  end
+end

data/test/unit/carriers/fedex_test.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class FedExTest < Test::Unit::TestCase
+  def setup
+    @packages               = TestFixtures.packages
+    @locations              = TestFixtures.locations
+    @carrier                = FedEx.new(:key => '1111', :password => '2222', :account => '3333', :login => '4444')
+  end
+  
+  def test_initialize_options_requirements
+    assert_raises ArgumentError do FedEx.new end
+    assert_raises ArgumentError do FedEx.new(:login => '999999999') end
+    assert_raises ArgumentError do FedEx.new(:password => '7777777') end
+    assert_nothing_raised { FedEx.new(:key => '999999999', :password => '7777777', :account => '123', :login => '123')}
+  end
+  
+  # def test_no_rates_response
+  #   @carrier.expects(:commit).returns(xml_fixture('fedex/empty_response'))
+  # 
+  #   response = @carrier.find_rates(
+  #     @locations[:ottawa],                                
+  #     @locations[:beverly_hills],            
+  #     @packages.values_at(:book, :wii)
+  #   )
+  #   assert_equal "WARNING - 556: There are no valid services available. ", response.message
+  # end
+  
+  def test_find_tracking_info_should_return_a_tracking_response
+    @carrier.expects(:commit).returns(xml_fixture('fedex/tracking_response'))
+    assert_instance_of ActiveMerchant::Shipping::TrackingResponse, @carrier.find_tracking_info('077973360403984', :test => true)
+  end
+  
+  def test_find_tracking_info_should_parse_response_into_correct_number_of_shipment_events
+    @carrier.expects(:commit).returns(xml_fixture('fedex/tracking_response'))
+    response = @carrier.find_tracking_info('077973360403984', :test => true)
+    assert_equal 7, response.shipment_events.size
+  end
+  
+  def test_find_tracking_info_should_return_shipment_events_in_ascending_chronological_order
+    @carrier.expects(:commit).returns(xml_fixture('fedex/tracking_response'))
+    response = @carrier.find_tracking_info('077973360403984', :test => true)
+    assert_equal response.shipment_events.map(&:time).sort, response.shipment_events.map(&:time)
+  end
+  
+  def test_building_request_and_parsing_response
+    expected_request = xml_fixture('fedex/ottawa_to_beverly_hills_rate_request')
+    mock_response = xml_fixture('fedex/ottawa_to_beverly_hills_rate_response')
+    Time.any_instance.expects(:to_xml_value).returns("2009-07-20T12:01:55-04:00")
+    
+    @carrier.expects(:commit).with {|request, test_mode| Hash.from_xml(request) == Hash.from_xml(expected_request) && test_mode}.returns(mock_response)
+    response = @carrier.find_rates( @locations[:ottawa],
+                                    @locations[:beverly_hills],
+                                    @packages.values_at(:book, :wii), :test => true)
+    assert_equal ["FedEx Ground"], response.rates.map(&:service_name)
+    assert_equal [3836], response.rates.map(&:price)
+    
+    assert response.success?, response.message
+    assert_instance_of Hash, response.params
+    assert_instance_of String, response.xml
+    assert_instance_of Array, response.rates
+    assert_not_equal [], response.rates
+    
+    rate = response.rates.first
+    assert_equal 'FedEx', rate.carrier
+    assert_equal 'CAD', rate.currency
+    assert_instance_of Fixnum, rate.total_price
+    assert_instance_of Fixnum, rate.price
+    assert_instance_of String, rate.service_name
+    assert_instance_of String, rate.service_code
+    assert_instance_of Array, rate.package_rates
+    assert_equal @packages.values_at(:book, :wii), rate.packages
+    
+    package_rate = rate.package_rates.first
+    assert_instance_of Hash, package_rate
+    assert_instance_of Package, package_rate[:package]
+    assert_nil package_rate[:rate]
+  end
+end

data/test/unit/carriers/shipwire_test.rb

@@ -0,0 +1,130 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class ShipwireTest < Test::Unit::TestCase
+
+  def setup
+    @packages  = TestFixtures.packages
+    @locations = TestFixtures.locations
+    @carrier   = Shipwire.new(:login => 'l', :password => 'p')
+    @items = [ { :sku => 'AF0001', :quantity => 1 }, { :sku => 'AF0002', :quantity => 2 } ]
+  end
+  
+  def test_invalid_credentials
+    @carrier.expects(:ssl_post).returns(xml_fixture('shipwire/invalid_credentials_response'))
+    
+    begin
+      @carrier.find_rates(
+        @locations[:ottawa],
+        @locations[:beverly_hills],
+        @packages.values_at(:book, :wii),
+        :order_id => '#1000',
+        :items => @items
+      )
+    rescue ResponseError => e
+      assert_equal "Could not verify e-mail/password combination", e.message
+    end
+  end
+  
+  def test_response_with_no_rates_is_unsuccessful
+    @carrier.expects(:ssl_post).returns(xml_fixture('shipwire/no_rates_response'))
+
+    assert_raises(ResponseError) do
+      response = @carrier.find_rates(
+                   @locations[:ottawa],
+                   @locations[:beverly_hills],
+                   @packages.values_at(:book, :wii),
+                   :order_id => '#1000',
+                   :items => @items
+                 )
+    end
+  end
+  
+  def test_successfully_get_international_rates
+    @carrier.expects(:ssl_post).returns(xml_fixture('shipwire/international_rates_response'))
+    
+    response = @carrier.find_rates(
+                 @locations[:ottawa],
+                 @locations[:london],
+                 @packages.values_at(:book, :wii),
+                 :order_id => '#1000',
+                 :items => @items
+               )
+               
+    assert response.success?
+    
+    assert_equal 1, response.rates.size
+    
+    assert international = response.rates.first
+    assert_equal "INTL", international.service_code
+    assert_equal "UPS", international.carrier
+    assert_equal "UPS Standard", international.service_name
+    assert_equal 2806, international.total_price
+  end
+
+  def test_successfully_get_domestic_rates
+    @carrier.expects(:ssl_post).returns(xml_fixture('shipwire/rates_response'))
+    
+    response = @carrier.find_rates(
+                 @locations[:ottawa],
+                 @locations[:beverly_hills],
+                 @packages.values_at(:book, :wii),
+                 :order_id => '#1000',
+                 :items => @items
+               )
+               
+    assert response.success?
+    
+    assert_equal 3, response.rates.size
+    
+    assert ground  = response.rates.find{|r| r.service_code == "GD" }
+    assert_equal "UPS", ground.carrier
+    assert_equal "UPS Ground", ground.service_name
+    assert_equal 773, ground.total_price
+
+    assert two_day = response.rates.find{|r| r.service_code == "2D" }
+    assert_equal "UPS", two_day.carrier
+    assert_equal "UPS Second Day Air", two_day.service_name
+    assert_equal 1364, two_day.total_price
+        
+    assert one_day = response.rates.find{|r| r.service_code == "1D" }
+    assert_equal "USPS", one_day.carrier
+    assert_equal "USPS Express Mail", one_day.service_name
+    assert_equal 2525, one_day.total_price
+  end
+  
+  def test_gracefully_handle_new_carrier
+    @carrier.expects(:ssl_post).returns(xml_fixture('shipwire/new_carrier_rate_response'))
+    
+    response = @carrier.find_rates(
+                 @locations[:ottawa],
+                 @locations[:beverly_hills],
+                 @packages.values_at(:book, :wii),
+                 :order_id => '#1000',
+                 :items => @items
+               )
+    assert response.success?    
+    assert_equal 1, response.rates.size
+    assert ground = response.rates.first
+    assert_equal "FESCO", ground.carrier
+  end
+  
+  def test_find_rates_requires_items_option
+    assert_raises(ArgumentError) do
+      @carrier.find_rates(
+        @locations[:ottawa],
+        @locations[:beverly_hills],
+        @packages.values_at(:book, :wii)
+      )
+    end
+  end
+  
+  def test_validate_credentials_with_valid_credentials
+    @carrier.expects(:ssl_post).returns(xml_fixture('shipwire/no_rates_response'))
+    assert @carrier.valid_credentials?
+  end
+  
+  def test_validate_credentials_with_invalid_credentials
+    @carrier.expects(:ssl_post).returns(xml_fixture('shipwire/invalid_credentials_response'))
+    assert !@carrier.valid_credentials?
+  end
+end

data/test/unit/carriers/ups_test.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class UPSTest < Test::Unit::TestCase
+  
+  def setup
+    @packages  = TestFixtures.packages
+    @locations = TestFixtures.locations
+    @carrier   = UPS.new(
+                   :key => 'key',
+                   :login => 'login',
+                   :password => 'password'
+                 )
+    @tracking_response = xml_fixture('ups/shipment_from_tiger_direct')
+  end
+  
+  def test_initialize_options_requirements
+    assert_raises(ArgumentError) { UPS.new }
+    assert_raises(ArgumentError) { UPS.new(:login => 'blah', :password => 'bloo') }
+    assert_raises(ArgumentError) { UPS.new(:login => 'blah', :key => 'kee') }
+    assert_raises(ArgumentError) { UPS.new(:password => 'bloo', :key => 'kee') }
+    assert_nothing_raised { UPS.new(:login => 'blah', :password => 'bloo', :key => 'kee') }
+  end
+  
+  def test_find_tracking_info_should_return_a_tracking_response
+    @carrier.expects(:commit).returns(@tracking_response)
+    assert_equal 'ActiveMerchant::Shipping::TrackingResponse', @carrier.find_tracking_info('1Z5FX0076803466397').class.name
+  end
+  
+  def test_find_tracking_info_should_parse_response_into_correct_number_of_shipment_events
+    @carrier.expects(:commit).returns(@tracking_response)
+    response = @carrier.find_tracking_info('1Z5FX0076803466397')
+    assert_equal 8, response.shipment_events.size
+  end
+  
+  def test_find_tracking_info_should_return_shipment_events_in_ascending_chronological_order
+    @carrier.expects(:commit).returns(@tracking_response)
+    response = @carrier.find_tracking_info('1Z5FX0076803466397')
+    assert_equal response.shipment_events.map(&:time).sort, response.shipment_events.map(&:time)
+  end
+  
+  def test_find_tracking_info_should_have_correct_names_for_shipment_events
+    @carrier.expects(:commit).returns(@tracking_response)
+    response = @carrier.find_tracking_info('1Z5FX0076803466397')
+    assert_equal [ "BILLING INFORMATION RECEIVED",
+                   "IMPORT SCAN",
+                   "LOCATION SCAN",
+                   "LOCATION SCAN",
+                   "DEPARTURE SCAN",
+                   "ARRIVAL SCAN",
+                   "OUT FOR DELIVERY",
+                   "DELIVERED" ], response.shipment_events.map(&:name)
+  end
+  
+  def test_add_origin_and_destination_data_to_shipment_events_where_appropriate
+    @carrier.expects(:commit).returns(@tracking_response)
+    response = @carrier.find_tracking_info('1Z5FX0076803466397')
+    assert_equal '175 AMBASSADOR', response.shipment_events.first.location.address1
+    assert_equal 'K1N5X8', response.shipment_events.last.location.postal_code
+  end
+  
+  def test_response_parsing
+    mock_response = xml_fixture('ups/test_real_home_as_residential_destination_response')
+    @carrier.expects(:commit).returns(mock_response)
+    response = @carrier.find_rates( @locations[:beverly_hills],
+                                    @locations[:real_home_as_residential],
+                                    @packages.values_at(:chocolate_stuff))
+    assert_equal [ "UPS Ground",
+                   "UPS Three-Day Select",
+                   "UPS Second Day Air",
+                   "UPS Next Day Air Saver",
+                   "UPS Next Day Air Early A.M.",
+                   "UPS Next Day Air"], response.rates.map(&:service_name)
+    assert_equal [992, 2191, 3007, 5509, 9401, 6124], response.rates.map(&:price)
+  end
+  
+  def test_maximum_weight
+    assert Package.new(150 * 16, [5,5,5], :units => :imperial).mass == @carrier.maximum_weight
+    assert Package.new((150 * 16) + 0.01, [5,5,5], :units => :imperial).mass > @carrier.maximum_weight
+    assert Package.new((150 * 16) - 0.01, [5,5,5], :units => :imperial).mass < @carrier.maximum_weight
+  end
+end

data/test/unit/carriers/usps_test.rb

@@ -0,0 +1,206 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class USPSTest < Test::Unit::TestCase
+  
+  def setup
+    @packages  = TestFixtures.packages
+    @locations = TestFixtures.locations
+    @carrier   = USPS.new(:login => 'login')
+    @international_rate_responses = {
+      :vanilla => xml_fixture('usps/beverly_hills_to_ottawa_book_rate_response')
+    }
+
+  end
+  
+  # TODO: test_parse_domestic_rate_response
+  # TODO: test_build_us_rate_request
+  # TODO: test_build_world_rate_request
+  
+  def test_initialize_options_requirements
+    assert_raises ArgumentError do USPS.new end
+    assert_nothing_raised { USPS.new(:login => 'blah')}
+  end
+  
+  def test_find_tracking_info_should_return_a_tracking_response
+    @carrier.expects(:commit).returns(xml_fixture('usps/example_tracking_response'))
+    assert_instance_of ActiveMerchant::Shipping::TrackingResponse, 
+      @carrier.find_tracking_info(['EJ958083578US'], :test => true)
+  end
+
+  def test_find_tracking_info_should_return_a_tracking_number
+    @carrier.expects(:commit).returns(xml_fixture('usps/example_tracking_response'))
+    info = @carrier.find_tracking_info(['EJ958083578US'], :test => true)
+    
+    assert_equal 'EJ958083578US', info.tracking_number
+  end
+
+  def test_find_tracking_info_should_return_correct_number_of_shipment_events
+    @carrier.expects(:commit).returns(xml_fixture('usps/example_tracking_response'))
+    info = @carrier.find_tracking_info(['EJ958083578US'], :test => true)
+
+    assert_equal 3, info.shipment_events.size
+  end
+
+  def test_find_tracking_info_should_return_proper_order
+    @carrier.expects(:commit).returns(xml_fixture('usps/example_tracking_response'))
+    info = @carrier.find_tracking_info(['EJ958083578US'], :test => true)
+
+    assert_equal "NOTICE LEFT", info.shipment_events.first.name
+    assert_equal "ACCEPTANCE", info.shipment_events.last.name
+  end
+
+  def test_find_multiple_returns_two_seperate_tracking_responses
+    @carrier.expects(:commit).returns(xml_fixture('usps/multi_tracking_example'))
+    info = @carrier.find_tracking_info(['EJ958083578US', 'EJ958088694US'], :test => true)
+    assert_equal 2, info.size
+    assert_equal 'EJ958083578US', info.first.tracking_number
+    assert_equal 'EJ958088694US', info.last.tracking_number
+  end
+
+  def test_parse_international_rate_response
+    fixture_xml = @international_rate_responses[:vanilla]
+    @carrier.expects(:commit).returns(fixture_xml)
+    
+    response = begin
+      @carrier.find_rates(
+        @locations[:beverly_hills], # imperial (U.S. origin)
+        @locations[:ottawa],
+        @packages[:book],
+        :test => true
+      )
+    rescue ResponseError => e
+      e.response
+    end
+    
+    
+    expected_xml_hash = Hash.from_xml(fixture_xml)
+    actual_xml_hash = Hash.from_xml(response.xml)
+    
+    assert_equal expected_xml_hash, actual_xml_hash
+    
+    assert_not_equal [],response.rates
+    assert_equal response.rates.sort_by(&:price), response.rates
+    assert_equal ["1", "2", "3", "4", "6", "7", "9"], response.rates.map(&:service_code).sort
+    
+    ordered_service_names = ["USPS Express Mail International (EMS)", "USPS First-Class Mail International", "USPS Global Express Guaranteed", "USPS Global Express Guaranteed Non-Document Non-Rectangular", "USPS Global Express Guaranteed Non-Document Rectangular", "USPS Priority Mail International", "USPS Priority Mail International Flat Rate Box"]
+    assert_equal ordered_service_names, response.rates.map(&:service_name).sort
+    
+    
+    assert_equal [376, 1600, 2300, 2325, 4100, 4100, 4100], response.rates.map(&:total_price)
+  end
+  
+  def test_parse_max_dimension_sentences
+    limits = {
+      "Max. length 46\", width 35\", height 46\" and max. length plus girth 108\"" =>
+        [{:length => 46.0, :width => 46.0, :height => 35.0, :length_plus_girth => 108.0}],
+      "Max.length 42\", max. length plus girth 79\"" =>
+        [{:length => 42.0, :length_plus_girth => 79.0}],
+      "9 1/2\" X 12 1/2\"" =>
+        [{:length => 12.5, :width => 9.5, :height => 0.75}, "Flat Rate Envelope"],
+      "Maximum length and girth combined 108\"" =>
+        [{:length_plus_girth => 108.0}],
+      "USPS-supplied Priority Mail flat-rate envelope 9 1/2\" x 12 1/2.\" Maximum weight 4 pounds." =>
+        [{:length => 12.5, :width => 9.5, :height => 0.75}, "Flat Rate Envelope"],
+      "Max. length 24\", Max. length, height, depth combined 36\"" =>
+        [{:length => 24.0, :length_plus_width_plus_height => 36.0}]
+    }
+    p = @packages[:book]
+    limits.each do |sentence,hashes|
+      dimensions = hashes[0].update(:weight => 50.0)
+      service_node = build_service_node(
+        :name => hashes[1],
+        :max_weight => 50,
+        :max_dimensions => sentence )
+      @carrier.expects(:package_valid_for_max_dimensions).with(p, dimensions)
+      @carrier.send(:package_valid_for_service, p, service_node)
+    end
+  
+    service_node = build_service_node(
+        :name => "flat-rate box",
+        :max_weight => 50,
+        :max_dimensions => "USPS-supplied Priority Mail flat-rate box. Maximum weight 20 pounds." )
+    
+    # should test against either kind of flat rate box:
+    dimensions = [{:weight => 50.0, :length => 11.0, :width => 8.5, :height => 5.5}, # or...
+      {:weight => 50.0, :length => 13.625, :width => 11.875, :height => 3.375}]
+    @carrier.expects(:package_valid_for_max_dimensions).with(p, dimensions[0])
+    @carrier.expects(:package_valid_for_max_dimensions).with(p, dimensions[1])
+    @carrier.send(:package_valid_for_service, p, service_node)
+    
+  end
+  
+  def test_package_valid_for_max_dimensions
+    p = Package.new(70 * 16, [10,10,10], :units => :imperial)
+    limits = {:weight => 70.0, :length => 10.0, :width => 10.0, :height => 10.0, :length_plus_girth => 50.0, :length_plus_width_plus_height => 30.0}
+    assert_equal true, @carrier.send(:package_valid_for_max_dimensions, p, limits)
+    
+    limits.keys.each do |key|
+      dimensions = {key => (limits[key] - 1)}
+      assert_equal false, @carrier.send(:package_valid_for_max_dimensions, p, dimensions)
+    end
+    
+  end
+  
+  def test_strip_9_digit_zip_codes
+    request = URI.decode(@carrier.send(:build_us_rate_request, @packages[:book], "90210-1234", "123456789"))
+    assert !(request =~ /\>90210-1234\</)
+    assert request =~ /\>90210\</
+    assert !(request =~ /\>123456789\</)
+    assert request =~ /\>12345\</
+  end
+  
+  def test_xml_logging_to_file
+    mock_response = @international_rate_responses[:vanilla]
+    @carrier.expects(:commit).times(2).returns(mock_response)
+    @carrier.find_rates(
+      @locations[:beverly_hills],
+      @locations[:ottawa],
+      @packages[:book],
+      :test => true
+    )
+    @carrier.find_rates(
+      @locations[:beverly_hills],
+      @locations[:ottawa],
+      @packages[:book],
+      :test => true
+    )
+  end
+  
+  def test_maximum_weight
+    assert Package.new(70 * 16, [5,5,5], :units => :imperial).mass == @carrier.maximum_weight
+    assert Package.new((70 * 16) + 0.01, [5,5,5], :units => :imperial).mass > @carrier.maximum_weight
+    assert Package.new((70 * 16) - 0.01, [5,5,5], :units => :imperial).mass < @carrier.maximum_weight
+  end
+  
+  private
+  
+  def build_service_node(options = {})
+    XmlNode.new('Service') do |service_node|
+      service_node << XmlNode.new('Pounds', options[:pounds] || "0")
+      service_node << XmlNode.new('SvcCommitments', options[:svc_commitments] || "Varies")
+      service_node << XmlNode.new('Country', options[:country] || "CANADA")
+      service_node << XmlNode.new('ID', options[:id] || "3")
+      service_node << XmlNode.new('MaxWeight', options[:max_weight] || "64")
+      service_node << XmlNode.new('SvcDescription', options[:name] || "First-Class Mail International")
+      service_node << XmlNode.new('MailType', options[:mail_type] || "Package")
+      service_node << XmlNode.new('Postage', options[:postage] || "3.76")
+      service_node << XmlNode.new('Ounces', options[:ounces] || "9")
+      service_node << XmlNode.new('MaxDimensions', options[:max_dimensions] || 
+          "Max. length 24\", Max. length, height, depth combined 36\"")
+    end.to_xml_element
+  end
+  
+  def build_service_hash(options = {})
+    {"Pounds"=> options[:pounds] || "0",                                                                         # 8
+         "SvcCommitments"=> options[:svc_commitments] || "Varies",                                                            
+         "Country"=> options[:country] || "CANADA",
+         "ID"=> options[:id] || "3",
+         "MaxWeight"=> options[:max_weight] || "64",
+         "SvcDescription"=> options[:name] || "First-Class Mail International",
+         "MailType"=> options[:mail_type] || "Package",
+         "Postage"=> options[:postage] || "3.76",
+         "Ounces"=> options[:ounces] || "9",
+         "MaxDimensions"=> options[:max_dimensions] || 
+          "Max. length 24\", Max. length, height, depth combined 36\""}
+  end
+end