reactive_shipping 3.0.0

data/test/unit/carriers/canada_post_pws_register_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+class CanadaPostPwsRegisterTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Fixtures
+
+  def setup
+    @cp = CanadaPostPWS.new(platform_id: 123, api_key: '456', secret: '789')
+  end
+
+  def test_register_merchant
+    endpoint = @cp.endpoint + "ot/token"
+    response = xml_fixture('canadapost_pws/register_token_response')
+    @cp.expects(:ssl_post).with(endpoint, anything, anything).returns(response)
+
+    response = @cp.register_merchant
+    assert response.is_a?(CPPWSRegisterResponse)
+    assert_equal "34536456345353534535", response.token_id
+  end
+
+  def test_register_merchant_with_error
+    endpoint = @cp.endpoint + "ot/token"
+    response = xml_fixture('canadapost_pws/register_token_error')
+    http_response = mock
+    http_response.stubs(:code).returns('400')
+    http_response.stubs(:body).returns(response)
+    response_error = ActiveUtils::ResponseError.new(http_response)
+    @cp.expects(:ssl_post).with(endpoint, anything, anything).raises(response_error)
+
+    exception = assert_raises ReactiveShipping::ResponseError do
+      @cp.register_merchant
+    end
+
+    assert_equal "Platform not active", exception.message
+  end
+
+  def test_register_response_redirect_url
+    endpoint = @cp.endpoint + "ot/token"
+    response = xml_fixture('canadapost_pws/register_token_response')
+    @cp.expects(:ssl_post).with(endpoint, anything, anything).returns(response)
+    url = 'http://localhost:3000/cp-register/'
+    customer_id = "12345"
+
+    response = @cp.register_merchant
+    assert_equal "http://www.canadapost.ca/cpotools/apps/drc/merchant?return-url=#{customer_id}&token-id=#{response.token_id}&platform-id=#{url}", response.redirect_url(url, customer_id)
+  end
+
+  def test_retrieve_merchant_details
+    endpoint = @cp.endpoint + "ot/token/1234567890"
+    response = xml_fixture('canadapost_pws/merchant_details_response')
+    @cp.expects(:ssl_get).with(endpoint, anything).returns(response)
+
+    response = @cp.retrieve_merchant_details(:token_id => '1234567890')
+    assert response.is_a?(CPPWSMerchantDetailsResponse)
+    assert_equal "1234567890", response.customer_number
+    assert_equal "1234567890-", response.contract_number
+    assert_equal "1234567890123456", response.username
+    assert_equal "12343567890123456789012", response.password
+    assert_equal false, response.has_default_credit_card
+  end
+
+  def test_retrieve_merchant_with_error
+    endpoint = @cp.endpoint + "ot/token/1234567890"
+    response = xml_fixture('canadapost_pws/merchant_details_error')
+    http_response = mock
+    http_response.stubs(:code).returns('400')
+    http_response.stubs(:body).returns(response)
+    response_error = ActiveUtils::ResponseError.new(http_response)
+    @cp.expects(:ssl_get).with(endpoint, anything).raises(response_error)
+
+    exception = assert_raises ReactiveShipping::ResponseError do
+      @cp.retrieve_merchant_details(:token_id => '1234567890')
+    end
+
+    assert_equal "Merchant Details Error", exception.message
+  end
+end

data/test/unit/carriers/canada_post_pws_shipping_test.rb

@@ -0,0 +1,258 @@
+require 'test_helper'
+class CanadaPostPwsShippingTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Fixtures
+
+  def setup
+    # 100 grams, 93 cm long, 10 cm diameter, cylinders have different volume calculations
+    @pkg1 = Package.new(25, [93, 10], :cylinder => true)
+
+    # 7.5 lbs, times 16 oz/lb., 15x10x4.5 inches, not grams, not centimetres
+    @pkg2 = Package.new(  (7.5 * 16), [15, 10, 4.5], :units => :imperial)
+
+    @line_item1 = line_item_fixture
+
+    @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'
+    }
+
+    @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'
+    }
+
+    @us_params = {
+      :name        => "John Smith",
+      :company     => "test",
+      :phone       => "613-555-1212",
+      :address1    => "123 Elm St.",
+      :address2    => "",
+      :city        => 'Beverly Hills',
+      :province    => 'CA',
+      :country     => 'US',
+      :postal_code => '90210'
+    }
+
+    @paris_params = {
+      :name        => "John Smith",
+      :company     => "test",
+      :phone       => "613-555-1212",
+      :address1    => "5 avenue Anatole France - Champ de Mars",
+      :address2    => "",
+      :city        => 'Paris',
+      :province    => '',
+      :country     => 'FR',
+      :postal_code => '75007'
+    }
+
+    @shipping_opts1 = {:dc => true, :cod => :true, :cod_amount => 50.00, :cod_includes_shipping => true,
+                       :cod_method_of_payment => 'CSH', :cov => true, :cov_amount => 100.00,
+                       :so => true, :pa18 => true}
+
+    @default_options = {:customer_number => '123456'}
+
+    @DEFAULT_RESPONSE = {
+      :shipping_id => "406951321983787352",
+      :tracking_number => "11111118901234",
+      :label_url => "https://ct.soa-gw.canadapost.ca/ers/artifact/c70da5ed5a0d2c32/20238/0"
+    }
+
+    @cp = CanadaPostPWS.new(platform_id: 123, api_key: '456', secret: '789')
+  end
+
+  def test_build_shipment_customs_node
+    options = @default_options.dup
+    destination = Location.new(@us_params)
+    builder = Nokogiri::XML::Builder.new do |xml|
+      response = @cp.shipment_customs_node(xml, destination, @line_item1, options)
+    end
+    doc = builder.doc
+    assert root_node = doc.at('customs')
+    assert_equal "CAD", root_node.at('currency').text
+    assert items_node = root_node.at('sku-list')
+    assert_equal 2, items_node.xpath('item').size
+    assert_equal 199.0, items_node.at('item/customs-value-per-unit').text.to_f
+  end
+
+  def test_build_shipment_request_for_domestic
+    options = @default_options.dup
+    request = @cp.build_shipment_request(@home_params, @dom_params, @pkg1, @line_item1, options)
+    refute request.blank?
+  end
+
+  def test_build_shipment_request_for_US
+    options = @default_options.dup
+    request = @cp.build_shipment_request(@home_params, @us_params, @pkg1, @line_item1, options)
+    refute request.blank?
+
+    doc = Nokogiri.XML(request)
+    doc.remove_namespaces!
+
+    assert root_node = doc.at('non-contract-shipment')
+    assert delivery_spec = root_node.at('delivery-spec')
+    assert destination = delivery_spec.at('destination')
+    assert address_details = destination.at('address-details')
+    assert_equal 'US', address_details.at('country-code').text
+  end
+
+  def test_build_shipment_request_for_international
+    options = @default_options.dup
+    request = @cp.build_shipment_request(@home_params, @paris_params, @pkg1, @line_item1, options)
+    refute request.blank?
+  end
+
+  def test_build_shipment_request_location_object
+    options = @default_options.dup
+    request = @cp.build_shipment_request(Location.new(@home_params), Location.new(@dom_params), @pkg1, @line_item1, options)
+    refute request.blank?
+  end
+
+  def test_create_shipment_request_with_options
+    options = @default_options.merge(@shipping_opts1)
+    request = @cp.build_shipment_request(@home_params, @paris_params, @pkg1, @line_item1, options)
+    refute request.blank?
+
+    doc = Nokogiri.XML(request)
+    doc.remove_namespaces!
+
+    assert root_node = doc.at('non-contract-shipment')
+    assert delivery_spec = root_node.at('delivery-spec')
+    assert options = delivery_spec.at('options')
+    assert_equal 5, options.xpath('*').size
+  end
+
+  def test_build_shipping_request_with_zero_weight
+    options = @default_options.merge(@shipping_opts1)
+    package = Package.new(0, [93, 10])
+    request = @cp.build_shipment_request(@home_params, @dom_params, package, @line_item1, options)
+    refute request.blank?
+
+    doc = Nokogiri.XML(request)
+    doc.remove_namespaces!
+
+    assert root_node = doc.at('non-contract-shipment')
+    assert delivery_spec = root_node.at('delivery-spec')
+    assert parcel_node = delivery_spec.at('parcel-characteristics')
+    assert_equal '0.001', parcel_node.at('weight').text
+  end
+
+  def test_create_shipment_domestic
+    options = @default_options.dup
+    response = xml_fixture('canadapost_pws/shipment_response')
+    @cp.expects(:ssl_post).once.returns(response)
+    response = @cp.create_shipment(@home_params, @dom_params, @pkg1, @line_item1, options)
+    assert response.is_a?(CPPWSShippingResponse)
+    assert_equal @DEFAULT_RESPONSE[:shipping_id], response.shipping_id
+    assert_equal @DEFAULT_RESPONSE[:tracking_number], response.tracking_number
+    assert_equal @DEFAULT_RESPONSE[:label_url], response.label_url
+  end
+
+  def test_create_shipment_us
+    options = @default_options.dup
+    response = xml_fixture('canadapost_pws/shipment_response')
+    @cp.expects(:ssl_post).once.returns(response)
+    response = @cp.create_shipment(@home_params, @us_params, @pkg1, @line_item1, options)
+    assert response.is_a?(CPPWSShippingResponse)
+    assert_equal @DEFAULT_RESPONSE[:shipping_id], response.shipping_id
+    assert_equal @DEFAULT_RESPONSE[:tracking_number], response.tracking_number
+    assert_equal @DEFAULT_RESPONSE[:label_url], response.label_url
+  end
+
+  def test_create_shipment_international
+    options = @default_options.dup
+    response = xml_fixture('canadapost_pws/shipment_response')
+    @cp.expects(:ssl_post).once.returns(response)
+    response = @cp.create_shipment(@home_params, @us_params, @pkg1, @line_item1, options)
+    assert response.is_a?(CPPWSShippingResponse)
+    assert_equal @DEFAULT_RESPONSE[:shipping_id], response.shipping_id
+    assert_equal @DEFAULT_RESPONSE[:tracking_number], response.tracking_number
+    assert_equal @DEFAULT_RESPONSE[:label_url], response.label_url
+  end
+
+  def test_retrieve_shipping_label
+    shipping_response = CPPWSShippingResponse.new(true, '', {}, @DEFAULT_RESPONSE)
+    @cp.expects(:ssl_get).once.returns(file_fixture('label1.pdf'))
+    response = @cp.retrieve_shipping_label(shipping_response)
+    assert_equal "%PDF", response[0...4]
+  end
+
+  def test_retrieve_shipment
+    options = @default_options.dup
+    shipping_response = CPPWSShippingResponse.new(true, '', {}, @DEFAULT_RESPONSE)
+    response = xml_fixture('canadapost_pws/shipment_response')
+    @cp.expects(:ssl_post).once.returns(response)
+    response = @cp.retrieve_shipment(shipping_response.shipping_id, options)
+    assert response.is_a?(CPPWSShippingResponse)
+    assert_equal @DEFAULT_RESPONSE[:shipping_id], response.shipping_id
+    assert_equal @DEFAULT_RESPONSE[:tracking_number], response.tracking_number
+    assert_equal @DEFAULT_RESPONSE[:label_url], response.label_url
+  end
+
+  def test_parse_find_shipment_receipt_response
+    body = xml_fixture('canadapost_pws/receipt_response')
+    response = @cp.parse_shipment_receipt_response(body)
+    assert_equal "J4W4T0", response[:final_shipping_point]
+    assert_equal "BP BROSSARD", response[:shipping_point_name]
+    assert_equal "DOM.EP", response[:service_code]
+    assert_equal 15.000, response[:rated_weight]
+    assert_equal 18.10, response[:base_amount]
+    assert_equal 19.46, response[:pre_tax_amount]
+    assert_equal 0.00, response[:gst_amount]
+    assert_equal 0.00, response[:pst_amount]
+    assert_equal 2.53, response[:hst_amount]
+    assert_equal 1, response[:priced_options].size
+    assert_equal 0.0, response[:priced_options]['DC']
+    assert_equal 21.99, response[:charge_amount]
+    assert_equal 'CAD', response[:currency]
+    assert_equal 1, response[:expected_transit_days]
+    assert_equal '2012-03-14', response[:expected_delivery_date]
+  end
+
+  def test_find_shipment_receipt
+    options = @default_options.dup
+    xml_response = xml_fixture('canadapost_pws/receipt_response')
+    @cp.expects(:ssl_get).once.returns(xml_response)
+    response = @cp.find_shipment_receipt('1234567', options)
+    assert_equal @cp.parse_shipment_receipt_response(xml_response), response
+  end
+
+  def test_character_limit_on_customs_description
+    @line_item1.first.stubs(:name).returns("Some super long description that exceeds the 44 character limit")
+    options = @default_options.dup
+
+    response = xml_fixture('canadapost_pws/shipment_response')
+    @cp.expects(:ssl_post).with do |_url, request|
+      request_hash = Hash.from_xml(request)
+
+      assert_equal 44, request_hash['non_contract_shipment']['delivery_spec']['customs']['sku_list']['item'].first['customs_description'].length
+      true
+    end.once.returns(response)
+
+    response = @cp.create_shipment(@home_params, @us_params, @pkg1, @line_item1, options)
+    assert response.is_a?(CPPWSShippingResponse)
+  end
+
+  def test_parse_find_shipment_receipt_doesnt_break_without_priced_options
+    body = xml_fixture('canadapost_pws/receipt_response_no_priced_options')
+    response = @cp.parse_shipment_receipt_response(body)
+
+    assert_equal 0, response[:priced_options].size
+  end
+
+  def test_maximum_address_field_length
+    assert_equal 44, @cp.maximum_address_field_length
+  end
+end

data/test/unit/carriers/canada_post_pws_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class CanadaPostPwsTest < ActiveSupport::TestCase
+
+  def setup
+    credentials = { platform_id: 123, api_key: '456', secret: '789' }
+    @cp = CanadaPostPWS.new(credentials)
+  end
+
+  def test_get_sanitized_postal_code_location_nil
+    postal_code = @cp.send(:get_sanitized_postal_code, nil)
+
+    assert_equal nil, postal_code
+  end
+
+  def test_get_sanitized_postal_code_postal_code_nil
+    location = Location.new(name: 'Test test')
+
+    assert_equal nil, location.postal_code
+
+    postal_code = @cp.send(:get_sanitized_postal_code, location)
+
+    assert_equal nil, postal_code
+  end
+
+  def test_get_sanitized_postal_code_spaces
+    location = Location.new(postal_code: '    K2P     1L4    ')
+
+    postal_code = @cp.send(:get_sanitized_postal_code, location)
+
+    assert_equal 'K2P1L4', postal_code
+  end
+
+  def test_get_sanitized_postal_code_lowercase
+    location = Location.new(postal_code: 'k2p 1l4')
+
+    postal_code = @cp.send(:get_sanitized_postal_code, location)
+
+    assert_equal 'K2P1L4', postal_code
+  end
+
+  def test_get_sanitzied_postal_code_proper
+    location = Location.new(postal_code: 'K2P1L4')
+
+    postal_code = @cp.send(:get_sanitized_postal_code, location)
+
+    assert_equal 'K2P1L4', postal_code
+  end
+
+  def test_get_sanitzied_postal_code_does_not_alter_original
+    location = Location.new(postal_code: 'K2P  1l4')
+
+    assert_equal 'K2P  1l4', location.postal_code
+
+    @cp.send(:get_sanitized_postal_code, location)
+
+    assert_equal 'K2P  1l4', location.postal_code
+  end
+end

data/test/unit/carriers/canada_post_pws_tracking_test.rb

@@ -0,0 +1,154 @@
+require 'test_helper'
+
+class CanadaPostPwsTrackingTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Fixtures
+
+  def setup
+    # 100 grams, 93 cm long, 10 cm diameter, cylinders have different volume calculations
+    @pkg1 = Package.new(25, [93, 10], :cylinder => true)
+    # 7.5 lbs, times 16 oz/lb., 15x10x4.5 inches, not grams, not centimetres
+    @pkg2 = Package.new((7.5 * 16), [15, 10, 4.5], :units => :imperial)
+
+    @home = Location.new(
+      :name        => "John Smith",
+      :company     => "test",
+      :phone       => "613-555-1212",
+      :address1    => "123 Elm St.",
+      :city        => 'Ottawa',
+      :province    => 'ON',
+      :country     => 'CA',
+      :postal_code => 'K1P1J1'
+    )
+
+    @dest = Location.new(
+      :name     => "Frank White",
+      :address1 => '999 Wiltshire Blvd',
+      :city     => 'Beverly Hills',
+      :state    => 'CA',
+      :country  => 'US',
+      :zip      => '90210'
+    )
+
+    @cp = CanadaPostPWS.new(platform_id: 123, api_key: '456', secret: '789')
+  end
+
+  def test_find_tracking_info_with_valid_pin
+    pin = '1371134583769923'
+    endpoint = @cp.endpoint + "vis/track/pin/%s/detail" % pin
+    response = xml_fixture('canadapost_pws/tracking_details_en')
+    @cp.expects(:ssl_get).with(endpoint, anything).returns(response)
+
+    response = @cp.find_tracking_info(pin)
+    assert response.is_a?(CPPWSTrackingResponse)
+  end
+
+  def test_find_tracking_info_with_15_digit_dnc
+    dnc = "315052413796541"
+    endpoint = @cp.endpoint + "vis/track/dnc/%s/detail" % dnc
+    response = xml_fixture('canadapost_pws/dnc_tracking_details_en')
+    @cp.expects(:ssl_get).with(endpoint, anything).returns(response)
+
+    response = @cp.find_tracking_info(dnc)
+    assert response.is_a?(CPPWSTrackingResponse)
+  end
+
+  def test_find_tracking_info_when_pin_doesnt_exist
+    pin = '1371134583769924'
+    response = xml_fixture('canadapost_pws/tracking_details_en_error')
+    http_response = mock
+    http_response.stubs(:code).returns('400')
+    http_response.stubs(:body).returns(response)
+    response_error = ActiveUtils::ResponseError.new(http_response)
+    @cp.expects(:ssl_get).raises(response_error)
+
+    exception = assert_raises ReactiveShipping::ResponseError do
+      @cp.find_tracking_info(pin)
+    end
+
+    assert_equal "No Pin History", exception.message
+  end
+
+  def test_find_tracking_info_with_invalid_pin_format
+    pin = '123'
+    @cp.expects(:ssl_get).never
+
+    exception = assert_raises ReactiveShipping::ResponseError do
+      @cp.find_tracking_info(pin)
+    end
+    assert_equal "Invalid Pin Format", exception.message
+  end
+
+  # parse_tracking_response
+
+  def test_parse_tracking_response
+    @response = xml_fixture('canadapost_pws/tracking_details_en')
+    @cp.expects(:ssl_get).returns(@response)
+
+    response = @cp.find_tracking_info('1371134583769923', {})
+
+    assert_equal CPPWSTrackingResponse, response.class
+    assert_equal "Xpresspost", response.service_name
+    assert_equal Date.parse("2011-02-01"), response.expected_date
+    assert_equal "Customer addressing error found; attempting to correct", response.change_reason
+    assert_equal "1371134583769923", response.tracking_number
+    assert_equal 10, response.shipment_events.size
+
+    assert_equal response.origin.city, "LACHINE"
+    assert_equal response.origin.province, "QC"
+
+    assert response.origin.is_a?(Location)
+    assert response.destination.is_a?(Location)
+    assert_equal "G1K4M7", response.destination.to_s
+    assert_equal "0001371134", response.customer_number
+    assert_equal true, response.delivered?
+    assert_equal Time.parse('2011-02-03 16:59:59 UTC'), response.actual_delivery_time
+  end
+
+  def test_parse_tracking_response_no_expected_delivery_date
+    @response = xml_fixture('canadapost_pws/tracking_details_no_expected_delivery_date')
+    @cp.expects(:ssl_get).returns(@response)
+
+    response = @cp.find_tracking_info('1371134583769923', {})
+
+    assert_equal CPPWSTrackingResponse, response.class
+    assert_equal "Expedited Parcels", response.service_name
+    assert_nil response.expected_date
+    assert_equal "8213295707205355", response.tracking_number
+    assert_equal 1, response.shipment_events.size
+    assert_equal response.origin.city, "MAPLE"
+    assert_equal response.origin.province, "ON"
+    assert response.origin.is_a?(Location)
+    assert response.destination.is_a?(Location)
+    assert_equal "J7Y0E4", response.destination.to_s
+    assert_equal "0008213295", response.customer_number
+    assert_equal false, response.delivered?
+  end
+
+  def test_parse_undelivered_tracking_response
+    @response = xml_fixture('canadapost_pws/tracking_details_en_undelivered')
+    @cp.expects(:ssl_get).returns(@response)
+    response = @cp.find_tracking_info('1371134583769923', {})
+
+    assert_equal false, response.delivered?
+    assert_nil response.actual_delivery_time
+  end
+
+  def test_parse_tracking_response_shipment_events
+    @response = xml_fixture('canadapost_pws/tracking_details_en')
+    @cp.expects(:ssl_get).returns(@response)
+
+    response = @cp.find_tracking_info('1371134583769923', {})
+    events = response.shipment_events
+
+    event = events.first
+    assert_equal ShipmentEvent, event.class
+    assert_equal "1496", event.name
+    assert_equal "SAINTE-FOY, QC", event.location
+    assert event.time.is_a?(Time)
+    assert_equal "Item successfully delivered", event.message
+
+    timestamps = events.map(&:time)
+    ordered = timestamps.dup.sort.reverse # newest => oldest
+    assert_equal ordered, timestamps
+  end
+end