active_shipping 1.0.0.pre2 → 1.0.0.pre3

data/test/fixtures/xml/usps/delivered_tracking_response.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <TrackInfo ID="9361289949034102283511">
+    <TrackSummary>Your item was delivered at 2:16 pm on October 12, 2013 in BROOKLYN, NY 11201.</TrackSummary>
+    <TrackDetail>Out for Delivery, October 12, 2013, 10:16 am, BROOKLYN, NY 11201</TrackDetail>
+    <TrackDetail>Sorting Complete, October 12, 2013, 10:06 am, BROOKLYN, NY 11201</TrackDetail>
+    <TrackDetail>Arrival at Post Office, October 12, 2013, 6:32 am, BROOKLYN, NY 11201</TrackDetail>
+    <TrackDetail>Acceptance, October 12, 2013, 6:26 am, BROOKLYN, NY 11201</TrackDetail>
+    <TrackDetail>Electronic Shipping Info Received, October 12, 2013</TrackDetail>
+  </TrackInfo>
+</TrackResponse>

data/test/fixtures/xml/usps/first_class_packages_with_invalid_mail_type_response.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+<RateV4Response>
+  <Package ID="0">
+    <Error>
+      <Number>-2147219428</Number>
+      <Source>DomesticRatesV4;clsRateV4.ValidateFirstClassMailType;RateEngineV4.ProcessRequest</Source>
+      <Description>Invalid First Class Mail Type.</Description>
+      <HelpFile/>
+      <HelpContext>1000440</HelpContext>
+    </Error>
+  </Package>
+</RateV4Response>

data/test/fixtures/xml/usps/first_class_packages_with_mail_type_response.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" ?>
+<RateV4Response>
+  <Package ID="0">
+    <ZipOrigination>90210</ZipOrigination>
+    <ZipDestination>10017</ZipDestination>
+    <Pounds>0</Pounds>
+    <Ounces>1.0</Ounces>
+    <Size>REGULAR</Size>
+    <Machinable>FALSE</Machinable>
+    <Zone>8</Zone>
+    <Postage CLASSID="0">
+      <MailService>First-Class Mail</MailService>
+      <Rate>2.07</Rate>
+    </Postage>
+  </Package>
+</RateV4Response>

data/test/fixtures/xml/usps/first_class_packages_without_mail_type_response.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+<RateV4Response>
+  <Package ID="0">
+    <Error>
+      <Number>-2147219428</Number>
+      <Source>DomesticRatesV4;clsRateV4.ValidateFirstClassMailType;RateEngineV4.ProcessRequest</Source>
+      <Description>Invalid First Class Mail Type.</Description>
+      <HelpFile/>
+      <HelpContext>1000440</HelpContext>
+    </Error>
+  </Package>
+</RateV4Response>

data/test/fixtures/xml/usps/invalid_xml_tracking_response_error.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?><Error><Number>-2147219067</Number><Source>;SOLServer.Track2_Respond</Source><Description>Invalid XML A name contained an invalid character.
+</Description><HelpFile></HelpFile><HelpContext></HelpContext></Error>

data/test/fixtures/xml/usps/tracking_request.xml

@@ -0,0 +1,3 @@
+<TrackRequest USERID="xxxxxxxx">
+<TrackID ID="EJ958083578US"></TrackID>
+</TrackRequest>

data/test/fixtures/xml/usps/tracking_response.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <TrackInfo ID="9102901000462189604217">
+    <TrackSummary>Your item is out for delivery at 8:13 am on January 27, 2012 in DES MOINES, IA 50311.</TrackSummary>
+    <TrackDetail>Sorting Complete, January 27, 2012, 8:03 am, DES MOINES, IA 50311</TrackDetail>
+    <TrackDetail>Electronic Shipping Info Received, January 27, 2012</TrackDetail>
+    <TrackDetail>Arrival at Post Office, January 26, 2012, 11:21 am, DES MOINES, IA 50311</TrackDetail>
+    <TrackDetail>Departed Shipping Partner Facility, January 24, 2012, 7:45 am, GRAND PRAIRIE, TX 75050</TrackDetail>
+    <TrackDetail>Departed Shipping Partner Facility, January 23, 2012, 2:49 am, PHOENIX, AZ 85043</TrackDetail>
+    <TrackDetail>Arrived Shipping Partner Facility, January 22, 2012, 5:00 pm, PHOENIX, AZ 85043</TrackDetail>
+    <TrackDetail>Picked Up by Shipping Partner, January 22, 2012, 4:30 pm, PHOENIX, AZ 85043</TrackDetail>
+  </TrackInfo>
+</TrackResponse>

data/test/fixtures/xml/usps/tracking_response_failure.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0"?>
+<TrackResponse><TrackInfo ID="ABC123XYZ"><TrackSummary>There is no record of that mail item. If it was mailed recently, it may not yet be tracked. Please try again later.</TrackSummary></TrackInfo>
+</TrackResponse>

data/test/fixtures/xml/usps/tracking_response_not_available.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<TrackResponse>
+  <TrackInfo ID="9574211957289221353248">
+    <Error>
+      <Number>-2147219301</Number>
+      <Description>Delivery status information is not available for your item via this web site.</Description>
+      <HelpFile/>
+      <HelpContext/>
+    </Error>
+  </TrackInfo>
+</TrackResponse>
+

data/test/fixtures/xml/usps/tracking_response_test_error.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<Error>
+  <Number>-2147219040</Number>
+  <Source>SOLServerTest;SOLServerTest.Track_Respond</Source>
+  <Description>This Information has not been included in this Test Server.</Description>
+  <HelpFile></HelpFile>
+  <HelpContext></HelpContext>
+</Error>

data/test/fixtures/xml/usps/us_rate_request.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<RateV4Request USERID="login">
+  <Package ID="0">
+    <Service>ALL</Service>
+    <FirstClassMailType/>
+    <ZipOrigination>90210</ZipOrigination>
+    <ZipDestination>10017</ZipDestination>
+    <Pounds>0</Pounds>
+    <Ounces>8.8</Ounces>
+    <Container>RECTANGULAR</Container>
+    <Size>REGULAR</Size>
+    <Width>5.51</Width>
+    <Length>7.48</Length>
+    <Height>0.79</Height>
+    <Girth>12.60</Girth>
+    <Machinable>TRUE</Machinable>
+  </Package>
+</RateV4Request>

data/test/fixtures/xml/usps/world_rate_request_with_value.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<IntlRateV2Request USERID="login">
+  <Package ID="0">
+    <Pounds>0</Pounds>
+    <Ounces>120</Ounces>
+    <MailType>Package</MailType>
+    <GXG>
+      <POBoxFlag>N</POBoxFlag>
+      <GiftFlag>N</GiftFlag>
+    </GXG>
+    <ValueOfContents>269.99</ValueOfContents>
+    <Country>Canada</Country>
+    <Container>RECTANGULAR</Container>
+    <Size>LARGE</Size>
+    <Width>10.00</Width>
+    <Length>15.00</Length>
+    <Height>4.50</Height>
+    <Girth>29.00</Girth>
+  </Package>
+</IntlRateV2Request>

data/test/fixtures/xml/usps/world_rate_request_without_value.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<IntlRateV2Request USERID="login">
+  <Package ID="0">
+    <Pounds>0</Pounds>
+    <Ounces>9</Ounces>
+    <MailType>Package</MailType>
+    <GXG>
+      <POBoxFlag>N</POBoxFlag>
+      <GiftFlag>N</GiftFlag>
+    </GXG>
+    <ValueOfContents>0.0</ValueOfContents>
+    <Country>Canada</Country>
+    <Container>RECTANGULAR</Container>
+    <Size>REGULAR</Size>
+    <Width>5.51</Width>
+    <Length>7.48</Length>
+    <Height>0.79</Height>
+    <Girth>12.60</Girth>
+  </Package>
+</IntlRateV2Request>

data/test/remote/canada_post_pws_platform_test.rb

@@ -0,0 +1,246 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+# All remote tests require Canada Post development environment credentials
+class CanadaPostPWSPlatformTest < Minitest::Test
+  include ActiveShipping::Test::Credentials
+  include ActiveShipping::Test::Fixtures
+
+  def setup
+    @login = credentials(:canada_post_pws)
+
+    # 100 grams, 93 cm long, 10 cm diameter, cylinders have different volume calculations
+    # @pkg1 = Package.new(1000, [93,10], :value => 10.00)
+    @pkg1 = Package.new(10, nil, :value => 10.00)
+    @pkg2 = Package.new(10, [20.0, 10.0, 1.0], :value => 10.00)
+
+    @line_item1 = line_item_fixture
+
+    @shipping_opts1 = {:dc => true, :cod => true, :cod_amount => 500.00, :cov => true, :cov_amount => 100.00,
+                       :so => true, :pa18 => 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'
+    }
+
+    @usa_params = {
+      :name        => "John Smith",
+      :company     => "",
+      :phone       => "555-555-5555",
+      :address1    => "123 Fake Street",
+      :address2    => "",
+      :city        => 'New York',
+      :province    => 'NY',
+      :country     => 'US',
+      :zip         => '12345'
+    }
+
+    @cp = CanadaPostPWS.new(@login)
+    @cp.logger = Logger.new(StringIO.new)
+
+    @customer_number  = @login[:customer_number]
+    @customer_api_key = @login[:customer_api_key]
+    @customer_secret  = @login[:customer_secret]
+  end
+
+  def build_options
+    {
+      :customer_number => @customer_number,
+      :customer_api_key => @customer_api_key,
+      :customer_secret => @customer_secret
+    }
+  end
+
+  def test_rates
+    rates = @cp.find_rates(@home_params, @dom_params, [@pkg1], build_options)
+    assert_equal RateResponse, rates.class
+    assert_equal RateEstimate, rates.rates.first.class
+  end
+
+  def test_rates_with_insurance_changes_price
+    rates = @cp.find_rates(@home_params, @dom_params, [@pkg1], build_options)
+    insured_rates = @cp.find_rates(@home_params, @dom_params, [@pkg1], build_options.merge(@shipping_opts1))
+    assert_not_equal rates.rates.first.price, insured_rates.rates.first.price
+  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_rates_USA_returns_small_packet_rates
+    rates = @cp.find_rates(@home_params, @usa_params, [@pkg1], build_options, @pkg2, ['USA.SP.AIR'])
+    assert_equal CPPWSRateResponse, rates.class
+    assert_equal RateEstimate, rates.rates.first.class
+    assert rates.rates.map(&:service_code).include? "USA.SP.AIR"
+  end
+
+  def test_tracking
+    pin = "1371134583769923" # valid pin
+    response = @cp.find_tracking_info(pin, build_options)
+    assert_equal 'Xpresspost', response.service_name
+    assert response.expected_date.is_a?(Date)
+    assert response.customer_number
+    assert_equal 10, response.shipment_events.count
+  end
+
+  def test_tracking_invalid_pin_raises_exception
+    pin = "000000000000000"
+    exception = assert_raises(ResponseError) do
+      @cp.find_tracking_info(pin, build_options)
+    end
+    assert_equal "No Pin History", exception.message
+  end
+
+  def test_create_shipment_with_invalid_customer_raises_exception
+    opts = {:customer_number => "0000000000", :service => "DOM.XP"}
+    assert_raises(ResponseError) do
+      @cp.create_shipment(@home_params, @dom_params, @pkg1, @line_item1, opts)
+    end
+  end
+
+  def test_register_merchant
+    response = @cp.register_merchant
+    assert response.is_a?(CPPWSRegisterResponse)
+    assert_match /^(\d|[a-f]){22}$/, response.token_id
+  end
+
+  def test_merchant_details_empty_details
+    response = @cp.register_merchant
+    exception = assert_raises(ResponseError) do
+      response = @cp.retrieve_merchant_details(:token_id => response.token_id)
+    end
+    assert_equal "No Merchant Info", exception.message
+  end
+
+  def test_find_services_no_country
+    response = @cp.find_services(nil, build_options)
+    assert response
+  end
+
+  def test_find_services_country_JP
+    response = @cp.find_services('JP', build_options)
+    assert response
+  end
+
+  def test_find_services_invalid_country
+    exception = assert_raises(ResponseError) do
+      @cp.find_services('XX', build_options)
+    end
+    assert_equal "A valid destination country must be supplied.", exception.message
+  end
+
+  def test_find_service_options_no_country
+    assert response = @cp.find_service_options("INT.XP", nil, build_options)
+    assert_equal "INT.XP", response[:service_code]
+    assert_equal "Xpresspost International", response[:service_name]
+    assert_equal 4, response[:options].size
+    assert_equal "COV", response[:options][0][:code]
+    assert_equal false, response[:options][0][:required]
+    assert_equal true, response[:options][0][:qualifier_required]
+    assert_equal 5000, response[:options][0][:qualifier_max]
+    assert_equal 0, response[:restrictions][:min_weight]
+    assert_equal 30000, response[:restrictions][:max_weight]
+    assert_equal 0.1, response[:restrictions][:min_length]
+    assert_equal 150, response[:restrictions][:max_length]
+    assert_equal 0.1, response[:restrictions][:min_height]
+    assert_equal 150, response[:restrictions][:max_height]
+    assert_equal 0.1, response[:restrictions][:min_width]
+    assert_equal 150, response[:restrictions][:max_width]
+  end
+
+  def test_find_service_options
+    assert response = @cp.find_service_options("INT.XP", "JP", build_options)
+    assert_equal "INT.XP", response[:service_code]
+    assert_equal "Xpresspost International", response[:service_name]
+    assert_equal 3, response[:options].size
+    assert_equal "COV", response[:options][0][:code]
+    assert_equal false, response[:options][0][:required]
+    assert_equal true, response[:options][0][:qualifier_required]
+    assert_equal 1000, response[:options][0][:qualifier_max]
+    assert_equal 0, response[:restrictions][:min_weight]
+    assert_equal 30000, response[:restrictions][:max_weight]
+    assert_equal 0.1, response[:restrictions][:min_length]
+    assert_equal 150, response[:restrictions][:max_length]
+    assert_equal 0.1, response[:restrictions][:min_height]
+    assert_equal 150, response[:restrictions][:max_height]
+    assert_equal 0.1, response[:restrictions][:min_width]
+    assert_equal 150, response[:restrictions][:max_width]
+  end
+
+  def test_find_option_details
+    assert response = @cp.find_option_details("SO", build_options)
+    assert_equal "SO", response[:code]
+    assert_equal "Signature option", response[:name]
+    assert_equal "FEAT", response[:class]
+    assert_equal true, response[:prints_on_label]
+    assert_equal false, response[:qualifier_required]
+    assert_equal 1, response[:conflicting_options].size
+    assert_equal "LAD", response[:conflicting_options][0]
+    assert_equal 1, response[:prerequisite_options].size
+    assert_equal "DC", response[:prerequisite_options][0]
+  end
+
+  def test_find_option_details_french
+    cp = CanadaPostPWS.new(@login.merge(:language => 'fr'))
+    assert response = cp.find_option_details("LAD", build_options)
+    assert_equal "LAD", response[:code]
+    assert_equal "Laisser à la porte (pas d'avis)", response[:name]
+  end
+end

data/test/remote/canada_post_pws_test.rb

@@ -0,0 +1,171 @@
+require 'test_helper'
+
+class CanadaPostPWSTest < Minitest::Test
+  # All remote tests require Canada Post development environment credentials
+  include ActiveShipping::Test::Credentials
+  include ActiveShipping::Test::Fixtures
+
+  def setup
+    @login = credentials(:canada_post_pws)
+
+    # 100 grams, 93 cm long, 10 cm diameter, cylinders have different volume calculations
+    # @pkg1 = Package.new(1000, [93,10], :value => 10.00)
+    @pkg1 = Package.new(1000, nil, :value => 10.00)
+
+    @line_item1 = line_item_fixture
+
+    @shipping_opts1 = {:dc => true, :cod => true, :cod_amount => 500.00, :cov => true, :cov_amount => 100.00,
+                       :so => true, :pa18 => 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 => "11111118901234",
+      :label_url => "https://ct.soa-gw.canadapost.ca/ers/artifact/#{@login[:api_key]}/20238/0"
+    }
+  end
+
+  def test_rates
+    opts = {:customer_number => @customer_number}
+    rates = @cp.find_rates(@home_params, @dom_params, [@pkg1], opts)
+    assert_equal RateResponse, rates.class
+    assert_equal RateEstimate, rates.rates.first.class
+  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 10, response.shipment_events.count
+  end
+
+  def test_tracking_when_no_tracking_info_raises_exception
+    pin = "4442172020196022" # valid pin
+
+    error = assert_raises(ActiveShipping::ResponseError) do
+      @cp.find_tracking_info(pin, {})
+    end
+
+    assert_match /No Tracking/, error.message
+  end
+
+  def test_create_shipment
+    opts = {:customer_number => @customer_number, :service => "DOM.XP"}
+    response = @cp.create_shipment(@home_params, @dom_params, @pkg1, @line_item1, opts)
+    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_with_options
+    opts = {:customer_number => @customer_number, :service => "USA.EP"}
+    opts.merge! @shipping_opts1
+    response = @cp.create_shipment(@home_params, @dest_params, @pkg1, @line_item1, opts)
+    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)
+    response = @cp.retrieve_shipping_label(shipping_response)
+    assert_not_nil response
+    assert_equal "%PDF", response[0...4]
+  end
+
+  def test_create_shipment_with_invalid_customer_raises_exception
+    opts = {:customer_number => "0000000000", :service => "DOM.XP"}
+    assert_raises(ResponseError) do
+      @cp.create_shipment(@home_params, @dom_params, @pkg1, @line_item1, opts)
+    end
+  end
+
+  def test_register_merchant
+    response = @cp.register_merchant
+    assert response.is_a?(CPPWSRegisterResponse)
+    assert_equal "1111111111111111111111", response.token_id
+  end
+
+  def test_merchant_details
+    token_id = "1111111111111111111111"
+    response = @cp.retrieve_merchant_details(:token_id => token_id)
+    assert response.is_a?(CPPWSMerchantDetailsResponse)
+    assert_equal "0000000000", response.customer_number
+    assert_equal "1234567890", response.contract_number
+    assert_equal "0000000000000000", response.username
+    assert_equal "1a2b3c4d5e6f7a8b9c0d12", response.password
+    assert_equal true, response.has_default_credit_card
+  end
+end