reactive_shipping 3.0.0

data/test/remote/canada_post_pws_test.rb

@@ -0,0 +1,169 @@
+require 'test_helper'
+
+class RemoteCanadaPostPWSTest < ActiveSupport::TestCase
+  # All remote tests require Canada Post development environment credentials
+  include ReactiveShipping::Test::Credentials
+  include ReactiveShipping::Test::Fixtures
+
+  def setup
+    @login = credentials(:canada_post_pws)
+    refute @login.key?(:platform_id), "The 'canada_post_pws' credentials should NOT include a platform ID"
+
+    # 1000 grams, 93 cm long, 10 cm diameter, cylinders have different volume calculations
+    @pkg1 = Package.new(1000, [93, 10, 10], :value => 10.00)
+
+    @line_item1 = line_item_fixture
+
+    @shipping_opts1 = { :dc => true, :cov => true, :cov_amount => 100.00, :aban => true }
+
+    @home_params = {
+      :name        => "John Smith",
+      :company     => "test",
+      :phone       => "613-555-1212",
+      :address1    => "123 Elm St.",
+      :city        => 'Ottawa',
+      :province    => 'ON',
+      :country     => 'CA',
+      :postal_code => 'K1P 1J1'
+    }
+    @home = Location.new(@home_params)
+
+    @dom_params = {
+      :name        => "John Smith Sr.",
+      :company     => "",
+      :phone       => '123-123-1234',
+      :address1    => "5500 Oak Ave",
+      :city        => 'Vancouver',
+      :province    => 'BC',
+      :country     => 'CA',
+      :postal_code => 'V5J 2T4'
+    }
+
+    @dest_params = {
+      :name     => "Frank White",
+      :phone    => '123-123-1234',
+      :address1 => '999 Wiltshire Blvd',
+      :city     => 'Beverly Hills',
+      :state    => 'CA',
+      :country  => 'US',
+      :zip      => '90210'
+    }
+    @dest = Location.new(@dest_params)
+
+    @dom_params = {
+      :name        => "Mrs. Smith",
+      :company     => "",
+      :phone       => "604-555-1212",
+      :address1    => "5000 Oak St.",
+      :address2    => "",
+      :city        => 'Vancouver',
+      :province    => 'BC',
+      :country     => 'CA',
+      :postal_code => 'V5J 2N2'
+    }
+
+    @intl_params = {
+      :name        => "Mrs. Yamamoto",
+      :company     => "",
+      :phone       => "011-123-123-1234",
+      :address1    => "123 Yokohama Road",
+      :address2    => "",
+      :city        => 'Tokyo',
+      :province    => '',
+      :country     => 'JP'
+    }
+
+    @cp = CanadaPostPWS.new(@login.merge(:endpoint => "https://ct.soa-gw.canadapost.ca/"))
+    @cp.logger = Logger.new(StringIO.new)
+
+    @customer_number = @login[:customer_number]
+
+    @DEFAULT_RESPONSE = {
+      :shipping_id => "406951321983787352",
+      :tracking_number => "123456789012",
+      :label_url => "https://ct.soa-gw.canadapost.ca/ers/artifact/#{@login[:api_key]}/20238/0"
+    }
+  rescue NoCredentialsFound => e
+    skip(e.message)
+  end
+
+  def test_rates
+    opts = {:customer_number => @customer_number}
+    rate_response = @cp.find_rates(@home_params, @dom_params, [@pkg1], opts)
+    assert_kind_of ReactiveShipping::RateResponse, rate_response
+    assert_kind_of ReactiveShipping::RateEstimate, rate_response.rates.first
+  end
+
+  def test_rates_with_invalid_customer_raises_exception
+    opts = {:customer_number => "0000000000", :service => "DOM.XP"}
+    assert_raises(ResponseError) do
+      @cp.find_rates(@home_params, @dom_params, [@pkg1], opts)
+    end
+  end
+
+  def test_tracking
+    pin = "1371134583769923" # valid pin
+    response = @cp.find_tracking_info(pin, {})
+    assert_equal 'Xpresspost', response.service_name
+    assert response.expected_date.is_a?(Date)
+    assert response.customer_number
+    assert_equal 13, response.shipment_events.count
+  end
+
+  def test_tracking_when_no_tracking_info_raises_exception
+    pin = "4442172020196022" # valid pin
+
+    error = assert_raises(ReactiveShipping::ResponseError) do
+      @cp.find_tracking_info(pin, {})
+    end
+
+    assert_match /No Tracking/, error.message
+  end
+
+  def test_create_shipment
+    skip "Failing with 'Contract Number is a required field' after API change, skipping because no clue how to fix, might need different creds"
+    opts = {:customer_number => @customer_number, :service => "DOM.XP"}
+    response = @cp.create_shipment(@home_params, @dom_params, @pkg1, @line_item1, opts)
+    assert_kind_of CPPWSShippingResponse, response
+    assert_match /\A\d{17}\z/, response.shipping_id
+    assert_equal "123456789012", response.tracking_number
+    assert_match "https://ct.soa-gw.canadapost.ca/ers/artifact/", response.label_url
+    assert_match @login[:api_key], response.label_url
+  end
+
+  def test_create_shipment_with_options
+    skip "Failing with 'Contract Number is a required field' after API change, skipping because no clue how to fix, might need different creds"
+    opts = {:customer_number => @customer_number, :service => "USA.EP"}.merge(@shipping_opts1)
+    response = @cp.create_shipment(@home_params, @dest_params, @pkg1, @line_item1, opts)
+
+    assert_kind_of CPPWSShippingResponse, response
+    assert_match /\A\d{17}\z/, response.shipping_id
+    assert_equal "123456789012", response.tracking_number
+    assert_match "https://ct.soa-gw.canadapost.ca/ers/artifact/", response.label_url
+    assert_match @login[:api_key], response.label_url
+  end
+
+  def test_retrieve_shipping_label
+    skip "Failing with 'Contract Number is a required field' after API change, skipping because no clue how to fix, might need different creds"
+    opts = {:customer_number => @customer_number, :service => "DOM.XP"}
+    shipping_response = @cp.create_shipment(@home_params, @dom_params, @pkg1, @line_item1, opts)
+
+    # Looks like it takes Canada Post some time to actually generate the PDF.
+    response = nil
+    10.times do
+      response = @cp.retrieve_shipping_label(shipping_response)
+      break unless response == ""
+      sleep(0.5)
+    end
+
+    assert_equal "%PDF", response[0...4]
+  end
+
+  def test_create_shipment_with_invalid_customer_raises_exception
+    skip "Failing with 'Contract Number is a required field' after API change, skipping because no clue how to fix, might need different creds"
+    opts = {:customer_number => "0000000000", :service => "DOM.XP"}
+    assert_raises(ResponseError) do
+      @cp.create_shipment(@home_params, @dom_params, @pkg1, @line_item1, opts)
+    end
+  end
+end

data/test/remote/canada_post_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class RemoteCanadaPostTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Credentials
+
+  def setup
+    @carrier        = CanadaPost.new(credentials(:canada_post))
+    @french_carrier = CanadaPost.new(credentials(:canada_post).merge(:french => true))
+
+    @origin      = {:address1 => "61A York St", :city => "Ottawa", :province => "Ontario", :country => "Canada", :postal_code => "K1N 5T2"}
+    @destination = {:city => "Beverly Hills", :state => "CA", :country => "United States", :postal_code => "90210"}
+    @line_items  = [Package.new(500, [2, 3, 4], :description => "a box full of stuff", :value => 25)]
+  rescue NoCredentialsFound => e
+    skip(e.message)
+  end
+
+  def test_valid_credentials
+    assert @carrier.valid_credentials?
+  end
+
+  def test_find_rates_french
+    rates = @french_carrier.find_rates(@origin, @destination, @line_items)
+    assert_instance_of CanadaPost::CanadaPostRateResponse, rates
+  end
+
+  def test_postal_outlets_french
+    rates = @french_carrier.find_rates(@origin, @destination, @line_items)
+
+    rates.postal_outlets.each do |outlet|
+      assert_instance_of CanadaPost::PostalOutlet, outlet
+    end
+  end
+
+  def test_find_rates
+    rates = @carrier.find_rates(@origin, @destination, @line_items)
+    assert_instance_of CanadaPost::CanadaPostRateResponse, rates
+  end
+
+  def test_postal_outlets
+    rates = @carrier.find_rates(@origin, @destination, @line_items)
+
+    rates.postal_outlets.each do |outlet|
+      assert_instance_of CanadaPost::PostalOutlet, outlet
+    end
+  end
+
+  def test_illegal_origin
+    @origin = @destination
+
+    assert_raises(ReactiveShipping::ResponseError) do
+      rates = @carrier.find_rates(@origin, @destination, @line_items)
+      refute rates.success?
+    end
+  end
+end

data/test/remote/fedex_test.rb

@@ -0,0 +1,400 @@
+require 'test_helper'
+
+class RemoteFedExTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Credentials
+  include ReactiveShipping::Test::Fixtures
+
+  def setup
+    @carrier = FedEx.new(credentials(:fedex).merge(:test => true))
+  rescue NoCredentialsFound => e
+    skip(e.message)
+  end
+
+  ### valid_credentials?
+
+  def test_valid_credentials
+    valid_carrier = FedEx.new(credentials(:fedex))
+    assert valid_carrier.valid_credentials?
+
+    invalid_carrier = FedEx.new(credentials(:fedex).merge(password: 'invalid'))
+    refute invalid_carrier.valid_credentials?
+  end
+
+  ### find_rates
+
+  def test_us_to_canada
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      location_fixtures[:ottawa],
+      package_fixtures.values_at(:wii)
+    )
+
+    assert_instance_of Array, response.rates
+    assert response.rates.length > 0
+    response.rates.each do |rate|
+      assert_instance_of String, rate.service_name
+      assert_kind_of Integer, rate.price
+    end
+  end
+
+  def test_freight
+    skip 'Cannot find the fedex freight creds. Whomp, whomp.'
+    freight = credentials(:fedex_freight)
+
+    shipping_location = Location.new( address1: freight[:shipping_address1],
+                                      address2: freight[:shipping_address2],
+                                      city: freight[:shipping_city],
+                                      state: freight[:shipping_state],
+                                      postal_code: freight[:shipping_postal_code],
+                                      country: freight[:shipping_country])
+
+    billing_location = Location.new(  address1: freight[:billing_address1],
+                                      address2: freight[:billing_address2],
+                                      city: freight[:billing_city],
+                                      state: freight[:billing_state],
+                                      postal_code: freight[:billing_postal_code],
+                                      country: freight[:billing_country])
+
+    freight_options = {
+      account: freight[:account],
+      billing_location: billing_location,
+      payment_type: freight[:payment_type],
+      freight_class: freight[:freight_class],
+      packaging: freight[:packaging],
+      role: freight[:role]
+    }
+
+    response = @carrier.find_rates(
+      shipping_location,
+      location_fixtures[:ottawa],
+      package_fixtures.values_at(:wii),
+      freight: freight_options
+    )
+
+    assert_instance_of Array, response.rates
+    assert response.rates.length > 0
+    response.rates.each do |rate|
+      assert_instance_of String, rate.service_name
+      assert_kind_of Integer, rate.price
+    end
+  end
+
+  def test_zip_to_zip_fails
+    @carrier.find_rates(
+      Location.new(:zip => 40524),
+      Location.new(:zip => 40515),
+      package_fixtures[:wii]
+    )
+  rescue ResponseError => e
+    assert_match /country\s?code/i, e.message
+    assert_match /(missing|invalid)/, e.message
+  end
+
+  # FedEx requires a valid origin and destination postal code
+  def test_rates_for_locations_with_only_zip_and_country
+    response = @carrier.find_rates(
+                 location_fixtures[:bare_beverly_hills],
+                 location_fixtures[:bare_ottawa],
+                 package_fixtures.values_at(:wii)
+               )
+
+    assert response.rates.size > 0
+  end
+
+  def test_rates_for_location_with_only_country_code
+    @carrier.find_rates(
+      location_fixtures[:bare_beverly_hills],
+      Location.new(:country => 'CA'),
+      package_fixtures.values_at(:wii)
+    )
+  rescue ResponseError => e
+    assert_match /postal code/i, e.message
+    assert_match /(missing|invalid)/i, e.message
+  end
+
+  def test_invalid_recipient_country
+    @carrier.find_rates(
+      location_fixtures[:bare_beverly_hills],
+      Location.new(:country => 'JP', :zip => '108-8361'),
+      package_fixtures.values_at(:wii)
+    )
+  rescue ResponseError => e
+    assert_match /postal code/i, e.message
+    assert_match /(missing|invalid)/i, e.message
+  end
+
+  def test_ottawa_to_beverly_hills
+    response = @carrier.find_rates(
+      location_fixtures[:ottawa],
+      location_fixtures[:beverly_hills],
+      package_fixtures.values_at(:book, :wii)
+    )
+
+    assert_instance_of Array, response.rates
+    assert response.rates.length > 0
+    response.rates.each do |rate|
+      assert_instance_of String, rate.service_name
+      assert_kind_of Integer, rate.price
+    end
+  end
+
+  def test_ottawa_to_london
+    response = @carrier.find_rates(
+      location_fixtures[:ottawa],
+      location_fixtures[:london],
+      package_fixtures.values_at(:book, :wii)
+    )
+
+    assert_instance_of Array, response.rates
+    assert response.rates.length > 0
+    response.rates.each do |rate|
+      assert_instance_of String, rate.service_name
+      assert_kind_of Integer, rate.price
+    end
+  end
+
+  def test_beverly_hills_to_netherlands
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      location_fixtures[:netherlands],
+      package_fixtures.values_at(:book, :wii)
+    )
+
+    assert_instance_of Array, response.rates
+    assert response.rates.length > 0
+    response.rates.each do |rate|
+      assert_instance_of String, rate.service_name
+      assert_kind_of Integer, rate.price
+    end
+  end
+
+  def test_beverly_hills_to_new_york
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      location_fixtures[:new_york],
+      package_fixtures.values_at(:book, :wii)
+    )
+
+    assert_instance_of Array, response.rates
+    assert response.rates.length > 0
+    response.rates.each do |rate|
+      assert_instance_of String, rate.service_name
+      assert_kind_of Integer, rate.price
+    end
+  end
+
+  def test_beverly_hills_to_london
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      location_fixtures[:london],
+      package_fixtures.values_at(:book, :wii)
+    )
+
+    assert_instance_of Array, response.rates
+    assert response.rates.length > 0
+    response.rates.each do |rate|
+      assert_instance_of String, rate.service_name
+      assert_kind_of Integer, rate.price
+    end
+  end
+
+  def test_different_rates_for_commercial
+    residential_response = @carrier.find_rates(
+                             location_fixtures[:beverly_hills],
+                             location_fixtures[:ottawa],
+                             package_fixtures.values_at(:chocolate_stuff)
+                           )
+    commercial_response  = @carrier.find_rates(
+                             location_fixtures[:beverly_hills],
+                             Location.from(location_fixtures[:ottawa].to_hash, :address_type => :commercial),
+                             package_fixtures.values_at(:chocolate_stuff)
+                           )
+
+    refute_equal residential_response.rates.map(&:price), commercial_response.rates.map(&:price)
+  end
+
+  ### find_tracking_info
+
+  def test_find_tracking_info_for_delivered_shipment
+    response = @carrier.find_tracking_info('122816215025810')
+    assert response.success?
+    assert response.delivered?
+    assert_equal '122816215025810', response.tracking_number
+    assert_equal :delivered, response.status
+    assert_equal 'DL', response.status_code
+    assert_equal "Delivered", response.status_description
+
+    assert_equal Time.parse('Fri, 03 Jan 2014'), response.ship_time
+    assert_nil response.scheduled_delivery_date
+    assert_equal Time.parse('2014-01-09 18:31:00 +0000'), response.actual_delivery_date
+
+    origin_address = ReactiveShipping::Location.new(
+      city: 'SPOKANE',
+      country: 'US',
+      state: 'WA'
+    )
+    assert_equal origin_address.to_hash, response.origin.to_hash
+
+    destination_address = ReactiveShipping::Location.new(
+      city: 'NORTON',
+      country: 'US',
+      state: 'VA'
+    )
+    assert_equal destination_address.to_hash, response.destination.to_hash
+    assert_equal 11, response.shipment_events.length
+    assert_equal 'OC', response.shipment_events.first.type_code
+    assert_equal 'PU', response.shipment_events.second.type_code
+    assert_equal 'AR', response.shipment_events.third.type_code
+  end
+
+  def test_find_tracking_info_for_in_transit_shipment_1
+    # unfortunately, we have to use Fedex unique identifiers, because the test tracking numbers are overloaded.
+    response = @carrier.find_tracking_info('920241085725456')
+    assert response.success?
+    refute response.delivered?
+    assert_equal '920241085725456', response.tracking_number
+    assert_equal :at_fedex_destination, response.status
+    assert_equal 'FD', response.status_code
+    assert_equal "At FedEx destination facility", response.status_description
+    assert_equal 7, response.shipment_events.length
+    assert_equal 'PU', response.shipment_events.first.type_code
+    assert_equal 'OC', response.shipment_events.second.type_code
+    assert_equal 'AR', response.shipment_events.third.type_code
+    assert_nil response.actual_delivery_date
+    assert_nil response.scheduled_delivery_date
+  end
+
+  def test_find_tracking_info_for_in_transit_shipment_2
+    # unfortunately, we have to use Fedex unique identifiers, because the test tracking numbers are overloaded.
+    response = @carrier.find_tracking_info('403934084723025')
+    assert response.success?
+    refute response.delivered?
+    assert_equal '403934084723025', response.tracking_number
+    assert_equal :at_fedex_facility, response.status
+    assert_equal 'AR', response.status_code
+    assert_equal "Arrived at FedEx location", response.status_description
+
+    assert_equal Time.parse('Fri, 03 Jan 2014'), response.ship_time
+    assert_nil response.scheduled_delivery_date
+    assert_nil response.actual_delivery_date
+
+    origin_address = ReactiveShipping::Location.new(
+      city: 'CAMBRIDGE',
+      country: 'US',
+      state: 'OH'
+    )
+    assert_equal origin_address.to_hash, response.origin.to_hash
+
+    destination_address = ReactiveShipping::Location.new(
+      city: 'Spokane Valley',
+      country: 'US',
+      state: 'WA'
+    )
+    assert_equal destination_address.to_hash, response.destination.to_hash
+    assert_equal 3, response.shipment_events.length
+    assert_equal 'PU', response.shipment_events.first.type_code
+    assert_equal 'OC', response.shipment_events.second.type_code
+    assert_equal 'AR', response.shipment_events.third.type_code
+  end
+
+  def test_find_tracking_info_with_multiple_matches
+    exception = assert_raises(ReactiveShipping::Error) do
+      response = @carrier.find_tracking_info('123456789012')
+    end
+    assert_match 'Multiple matches were found.', exception.message
+  end
+
+  def test_find_tracking_info_not_found
+    assert_raises(ReactiveShipping::ShipmentNotFound) do
+      @carrier.find_tracking_info('199997777713')
+    end
+  end
+
+  def test_find_tracking_info_with_invalid_tracking_number
+    assert_raises(ReactiveShipping::ResponseError) do
+      @carrier.find_tracking_info('abc')
+    end
+  end
+
+  ### create_shipment
+
+  def test_cant_obtain_multiple_shipping_labels
+    assert_raises(ReactiveShipping::Error,"Multiple packages are not supported yet.") do
+      @carrier.create_shipment(
+        location_fixtures[:beverly_hills_with_name],
+        location_fixtures[:new_york_with_name],
+        [package_fixtures[:wii],package_fixtures[:wii]],
+        :test => true,
+        :reference_number => {
+          :value => "FOO-123",
+          :code => "PO"
+        }
+      )
+    end
+  end
+
+  def test_obtain_shipping_label_with_single_element_array
+    response = @carrier.create_shipment(
+      location_fixtures[:beverly_hills_with_name],
+      location_fixtures[:new_york_with_name],
+      [package_fixtures[:wii]],
+        :test => true,
+        :reference_number => {
+          :value => "FOO-123",
+          :code => "PO"
+        }
+    )
+
+    assert response.success?
+    refute_empty response.labels
+    refute_empty response.labels.first.img_data
+  end
+
+  def test_obtain_shipping_label
+    response = @carrier.create_shipment(
+      location_fixtures[:beverly_hills_with_name],
+      location_fixtures[:new_york_with_name],
+      package_fixtures[:wii],
+        :test => true,
+        :reference_number => {
+          :value => "FOO-123",
+          :code => "PO"
+        }
+    )
+
+    assert response.success?
+    refute_empty response.labels
+    refute_empty response.labels.first.img_data
+  end
+
+  def test_obtain_shipping_label_with_signature_option
+    packages = package_fixtures.values_at(:wii)
+    packages.each {|p| p.options[:signature_option] = :adult }
+
+    response = @carrier.create_shipment(
+      location_fixtures[:beverly_hills_with_name],
+      location_fixtures[:new_york_with_name],
+      packages,
+      {:test => true}
+    )
+
+    signature_option = response.params["ProcessShipmentReply"]["CompletedShipmentDetail"]["CompletedPackageDetails"]["SignatureOption"]
+    assert_equal FedEx::SIGNATURE_OPTION_CODES[:adult], signature_option
+  end
+
+  def test_obtain_shipping_label_with_label_format_option
+    response = @carrier.create_shipment(
+      location_fixtures[:beverly_hills_with_name],
+      location_fixtures[:new_york_with_name],
+      package_fixtures[:wii],
+        :test => true,
+        :label_format => 'PDF'
+    )
+
+    assert response.success?
+    refute_empty response.labels
+    data = response.labels.first.img_data
+    refute_empty data
+    assert data[0...4] == '%PDF'
+  end
+end