reactive_shipping 3.0.0

data/test/remote/usps_returns_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class RemoteUSPSReturnsTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Credentials
+  include ReactiveShipping::Test::Fixtures
+
+  def setup
+    begin
+      creds = credentials(:usps_returns)
+      @carrier = USPSReturns.new
+      @external_return_label_request =
+        ExternalReturnLabelRequest.from_hash(
+          :merchant_account_id => creds[:merchant_account_id],
+          :mid => creds[:mid],
+          :customer_name => 'Joe Dirt',
+          :customer_address1 => '122 W Hudson St',
+          :customer_address2 => 'Unit 2',
+          :customer_city => 'New York',
+          :customer_state => 'NY',
+          :customer_zipcode => '10013',
+          :label_format => 'No Instructions',
+          :label_definition => '4X6',
+          :recipient_bcc => 'test@gmail.com',
+          :service_type_code => '020',
+          :address_override_notification => 'true',
+          :address_validation => 'true',
+          :call_center_or_self_service => 'Customer'
+        )
+    rescue NoCredentialsFound => e
+      skip(e.message)
+    end
+  end
+
+  def test_external_return_label_request
+    assert_silent do
+      @carrier.external_return_label_request(@external_return_label_request, :test => true)
+    end
+  end
+
+  def test_external_return_label_with_bad_account
+    assert_raises ResponseError do
+      @external_return_label_request.merchant_account_id = "1234"
+      @carrier.external_return_label_request(@external_return_label_request, :test => true)
+    end
+  end
+
+  def test_external_return_label_with_address_validation_false
+    assert_silent do
+      @external_return_label_request.address_validation = false
+      @carrier.external_return_label_request(@external_return_label_request, :test => true)
+    end
+  end
+
+  def test_external_return_label_with_address_validation_false_and_bad_address
+    assert_silent do
+      @external_return_label_request.address_validation = false
+      @external_return_label_request.customer_state = 'NJ'
+      @external_return_label_request.customer_zipcode = '08829'
+      @carrier.external_return_label_request(@external_return_label_request, :test => true)
+    end
+  end
+
+  def test_external_return_label_with_address_validation_true_and_bad_address
+    assert_raises ResponseError do
+      @external_return_label_request.address_validation = true
+      @external_return_label_request.customer_state = 'NJ'
+      @external_return_label_request.customer_zipcode = '08829'
+      @carrier.external_return_label_request(@external_return_label_request, :test => true)
+    end
+  end
+
+end

data/test/remote/usps_test.rb

@@ -0,0 +1,243 @@
+require 'test_helper'
+
+class RemoteUSPSTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Credentials
+  include ReactiveShipping::Test::Fixtures
+
+  def setup
+    @usps_credentials = credentials(:usps)
+    @carrier = USPS.new(@usps_credentials)
+  rescue NoCredentialsFound => e
+    skip(e.message)
+  end
+
+  def test_tracking_with_bad_number
+    assert_raises(ResponseError) do
+      @carrier.find_tracking_info('abc123xyz', test: false)
+    end
+  end
+
+  def test_zip_to_zip
+    response = @carrier.find_rates(
+      Location.new(:zip => 40524),
+      Location.new(:zip => 40515),
+      Package.new(16, [12, 6, 2], :units => :imperial)
+    )
+
+    assert response.success?, response.message
+    refute response.rates.empty?
+  end
+
+  def test_just_country_given
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      Location.new(:country => 'CZ'),
+      Package.new(100, [5, 10, 20])
+    )
+    assert response.success?, response.message
+    refute response.rates.empty?
+  end
+
+  def test_us_to_canada
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      location_fixtures[:ottawa],
+      package_fixtures.values_at(:american_wii),
+      :test => true
+    )
+
+    assert response.success?, response.message
+    refute response.rates.empty?
+  end
+
+  def test_domestic_rates
+    response = @carrier.find_rates(
+      location_fixtures[:new_york],
+      location_fixtures[:beverly_hills],
+      package_fixtures.values_at(:book, :american_wii),
+      :test => true
+    )
+
+    assert response.success?, response.message
+    assert_instance_of Hash, response.params
+    assert_instance_of String, response.xml
+    assert_instance_of Array, response.rates
+    refute response.rates.empty?
+
+    rate = response.rates.first
+    assert_equal 'USPS', rate.carrier
+    assert_equal 'USD', rate.currency
+    assert_kind_of Integer, rate.total_price
+    assert_kind_of Integer, 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 package_fixtures.values_at(:book, :american_wii), rate.packages
+
+    package_rate = rate.package_rates.first
+    assert_instance_of Hash, package_rate
+    assert_instance_of Package, package_rate[:package]
+    refute_nil package_rate[:rate]
+
+    other_than_two = response.rates.map(&:package_count).reject { |n| n == 2 }
+    assert_equal [], other_than_two, "Some RateEstimates do not refer to the right number of packages (#{other_than_two.inspect})"
+  end
+
+  def test_international_rates
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      location_fixtures[:ottawa],
+      package_fixtures.values_at(:book, :american_wii),
+      :test => true
+    )
+
+    assert response.success?, response.message
+    assert_instance_of Hash, response.params
+    assert_instance_of String, response.xml
+    assert_instance_of Array, response.rates
+    refute response.rates.empty?
+
+    rate = response.rates.first
+    assert_equal 'USPS', rate.carrier
+    assert_equal 'USD', rate.currency
+    assert_kind_of Integer, rate.total_price
+    assert_kind_of Integer, 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 package_fixtures.values_at(:book, :american_wii), rate.packages
+
+    package_rate = rate.package_rates.first
+    assert_instance_of Hash, package_rate
+    assert_instance_of Package, package_rate[:package]
+    refute_nil package_rate[:rate]
+
+    other_than_two = response.rates.map(&:package_count).reject { |n| n == 2 }
+    assert_equal [], other_than_two, "Some RateEstimates do not refer to the right number of packages (#{other_than_two.inspect})"
+  end
+
+  def test_us_to_us_possession
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills],
+      location_fixtures[:puerto_rico],
+      package_fixtures.values_at(:american_wii),
+      :test => true
+    )
+
+    assert response.success?, response.message
+    refute response.rates.empty?
+  end
+
+  def test_bare_packages_domestic
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills], # imperial (U.S. origin)
+      location_fixtures[:new_york],
+      Package.new(0, 0),
+      :test => true
+    )
+
+    assert response.success?, response.message
+    refute response.rates.empty?
+  end
+
+  def test_bare_packages_international
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills], # imperial (U.S. origin)
+      location_fixtures[:ottawa],
+      Package.new(0, 0),
+      :test => true
+    )
+
+    assert response.success?, response.message
+    refute response.rates.empty?
+  end
+
+  def test_first_class_packages_with_mail_type
+    response = @carrier.find_rates(
+      location_fixtures[:beverly_hills], # imperial (U.S. origin)
+      location_fixtures[:new_york],
+      Package.new(0, 0),
+
+      :test => true,
+      :service => :first_class,
+      :first_class_mail_type => :parcel
+    )
+
+    assert response.success?, response.message
+    refute response.rates.empty?
+  end
+
+  def test_first_class_packages_without_mail_type
+    assert_raises(ResponseError, "Invalid First Class Mail Type.") do
+      @carrier.find_rates(
+        location_fixtures[:beverly_hills], # imperial (U.S. origin)
+        location_fixtures[:new_york],
+        Package.new(0, 0),
+
+        :test => true,
+        :service => :first_class
+      )
+    end
+  end
+
+  def test_first_class_packages_with_invalid_mail_type
+    assert_raises(ResponseError, "Invalid First Class Mail Type.") do
+      @carrier.find_rates(
+        location_fixtures[:beverly_hills], # imperial (U.S. origin)
+        location_fixtures[:new_york],
+        Package.new(0, 0),
+
+        :test => true,
+        :service => :first_class,
+        :first_class_mail_tpe => :invalid
+      )
+    end
+  end
+
+  def test_correct_login_passes_valid_credentials?
+    assert USPS.new(@usps_credentials.merge(:test => true)).valid_credentials?
+  end
+
+  def test_wrong_login_fails_in_valid_credentials?
+    refute USPS.new(:login => 'ABCDEFGHIJKL', :test => true).valid_credentials?
+  end
+
+  def test_blank_login_fails_in_valid_credentials?
+    refute USPS.new(:login => '', :test => true).valid_credentials?
+  end
+
+  def test_nil_login_fails_in_valid_credentials?
+    refute USPS.new(:login => nil, :test => true).valid_credentials?
+  end
+
+  def test_must_provide_login_creds_when_instantiating
+    assert_raises ArgumentError do
+      USPS.new(:test => true)
+    end
+  end
+
+  # Uncomment and switch out SPECIAL_COUNTRIES with some other batch to see which
+  # countries are currently working. Commented out here just because it's a lot of
+  # hits to their server at once:
+
+  # ALL_COUNTRIES = ActiveUtils::Country.const_get('COUNTRIES').map {|c| c[:alpha2]}
+  # SPECIAL_COUNTRIES = USPS.const_get('COUNTRY_NAME_CONVERSIONS').keys.sort
+  # NORMAL_COUNTRIES = (ALL_COUNTRIES - SPECIAL_COUNTRIES)
+  #
+  # SPECIAL_COUNTRIES.each do |code|
+  #   unless ActiveUtils::Country.find(code).name == USPS.const_get('COUNTRY_NAME_CONVERSIONS')[code]
+  #     define_method("test_country_#{code}") do
+  #       response = nil
+  #       begin
+  #         response = @carrier.find_rates( location_fixtures[:beverly_hills],
+  #                                         Location.new(:country => code),
+  #                                         package_fixtures.values_at(:american_wii),
+  #                                         :test => true)
+  #       rescue Exception => e
+  #         flunk(e.inspect + "\nrequest: " + @carrier.last_request)
+  #       end
+  #       assert_not_equal [], response.rates.length
+  #     end
+  #   end
+  # end
+end

data/test/test_helper.rb

@@ -0,0 +1,296 @@
+require 'bundler/setup'
+
+require 'minitest/autorun'
+require "minitest/reporters"
+require 'mocha/mini_test'
+require 'timecop'
+require 'business_time'
+
+require 'reactive_shipping'
+require 'logger'
+require 'erb'
+require 'pry'
+require 'vcr'
+require 'webmock/minitest'
+
+Minitest::Reporters.use! Minitest::Reporters::ProgressReporter.new(detailed_skip: !!ENV["CI"])
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/remote/vcr_cassettes'
+  config.allow_http_connections_when_no_cassette = true
+  config.hook_into :webmock
+end
+
+class ActiveSupport::TestCase
+  include ReactiveShipping
+
+  def logger
+    @logger ||= Logger.new(STDERR)
+  end
+end
+
+module ReactiveShipping::Test
+  module Credentials
+    class NoCredentialsFound < StandardError
+      def initialize(key)
+        super("No credentials were found for '#{key}'")
+      end
+    end
+
+    LOCAL_CREDENTIALS = ENV['HOME'] + '/.reactive_shipping/credentials.yml'
+    DEFAULT_CREDENTIALS = File.dirname(__FILE__) + '/credentials.yml'
+
+    def credentials(key)
+      data = all_credentials[key]
+      if data.nil? || data.all? { |k,v| v.nil? || v.to_s.empty? }
+        raise NoCredentialsFound.new(key)
+      end
+      data.symbolize_keys
+    end
+
+    private
+
+    def all_credentials
+      @@all_credentials ||= begin
+        [DEFAULT_CREDENTIALS, LOCAL_CREDENTIALS].inject({}) do |credentials, file_name|
+          if File.exist?(file_name)
+            yaml_data = YAML.load(ERB.new(File.read(file_name)).result(binding)).symbolize_keys
+            credentials.merge!(yaml_data)
+          end
+          credentials
+        end
+      end
+    end
+  end
+
+  module Fixtures
+    include ReactiveShipping
+
+    def xml_fixture(path) # where path is like 'usps/beverly_hills_to_ottawa_response'
+      File.read(File.join(File.dirname(__FILE__), 'fixtures', 'xml', "#{path}.xml"))
+    end
+
+    def json_fixture(path) # where path is like 'usps/beverly_hills_to_ottawa_response'
+      File.read(File.join(File.dirname(__FILE__), 'fixtures', 'json', "#{path}.json"))
+    end
+
+    def file_fixture(filename)
+      File.read(File.join(File.dirname(__FILE__), 'fixtures', 'files', filename), mode: "rb")
+    end
+
+    def package_fixtures
+      @package_fixtures ||= {
+        :just_ounces => Package.new(16, nil, :units => :imperial),
+        :just_grams => Package.new(1000, nil),
+        :just_zero_grams => Package.new(0, nil),
+        :all_imperial => Package.new(16, [1, 8, 12], :units => :imperial),
+        :all_metric => Package.new(1000, [2, 20, 40]),
+        :book => Package.new(250, [14, 19, 2]),
+        :wii => Package.new((7.5 * 16), [15, 10, 4.5], :units => :imperial, :value => 269.99, :currency => 'GBP'),
+        :american_wii => Package.new((7.5 * 16), [15, 10, 4.5], :units => :imperial, :value => 269.99, :currency => 'USD'),
+        :new_zealand_wii => Package.new((7.5 * 16), [15, 10, 4.5], :units => :imperial, :value => 269.99, :currency => 'NZD'),
+        :worthless_wii => Package.new((7.5 * 16), [15, 10, 4.5], :units => :imperial, :value => 0.0, :currency => 'USD'),
+        :poster => Package.new(100, [93, 10], :cylinder => true),
+        :small_half_pound => Package.new(8, [1, 1, 1], :units => :imperial),
+        :big_half_pound => Package.new((16 * 50), [24, 24, 36], :units => :imperial),
+        :chocolate_stuff => Package.new(80, [2, 6, 12], :units => :imperial),
+        :frozen_stuff => Package.new(80, [2, 6, 12], :units => :imperial, :dry_ice => {weight: 1.4}),
+        :declared_value => Package.new(80, [2, 6, 12], :units => :imperial, :currency => 'USD', :value => 999.99),
+        :insured_value => Package.new(80, [2, 6, 12], :units => :imperial, :currency => 'USD', :insured_value => 999.99),
+        :tshirts => Package.new(10 * 16, nil, :units => :imperial),
+        :shipping_container => Package.new(2200000, [2440, 2600, 6058], :description => '20 ft Standard Container', :units => :metric),
+        :largest_gold_bar => Package.new(250000, [45.5, 22.5, 17], :value => 15300000),
+        :books => Package.new(64, [4, 8, 6], :units => :imperial, :value => 15300000, :description => 'Books')
+      }
+    end
+
+    def location_fixtures
+      @location_fixtures ||= {
+        :bare_ottawa => Location.new(:country => 'CA', :postal_code => 'K1P 1J1'),
+        :bare_beverly_hills => Location.new(:country => 'US', :zip => '90210'),
+        :ottawa => Location.new( :country => 'CA',
+                                 :province => 'ON',
+                                 :city => 'Ottawa',
+                                 :address1 => '110 Laurier Avenue West',
+                                 :postal_code => 'K1P 1J1',
+                                 :phone => '1-613-580-2400',
+                                 :fax => '1-613-580-2495',
+                                 :email => 'bob.bobsen@gmail.com'),
+        :ottawa_with_name => Location.new( :country => 'CA',
+                                           :province => 'ON',
+                                           :city => 'Ottawa',
+                                           :name => 'Paul Ottawa',
+                                           :address1 => '110 Laurier Avenue West',
+                                           :postal_code => 'K1P 1J1',
+                                           :phone => '1-613-580-2400',
+                                           :fax => '1-613-580-2495'),
+        :beverly_hills_with_name => Location.new(
+                                      :name => 'JP Silvashy',
+                                      :country => 'US',
+                                      :state => 'CA',
+                                      :city => 'Beverly Hills',
+                                      :address1 => '455 N. Rexford Dr.',
+                                      :address2 => '3rd Floor',
+                                      :zip => '90210',
+                                      :phone => '1-310-285-1013',
+                                      :fax => '1-310-275-8159'),
+        :beverly_hills => Location.new(
+                                      :country => 'US',
+                                      :state => 'CA',
+                                      :city => 'Beverly Hills',
+                                      :address1 => '455 N. Rexford Dr.',
+                                      :address2 => '3rd Floor',
+                                      :zip => '90210',
+                                      :phone => '1-310-285-1013',
+                                      :fax => '1-310-275-8159'),
+        :beverly_hills_9_zip => Location.new(
+                                      :country => 'US',
+                                      :state => 'CA',
+                                      :city => 'Beverly Hills',
+                                      :address1 => '455 N. Rexford Dr.',
+                                      :address2 => '3rd Floor',
+                                      :zip => '90210-1234',
+                                      :phone => '1-310-285-1013',
+                                      :fax => '1-310-275-8159'),
+        :real_home_as_commercial => Location.new(
+                                      :country => 'US',
+                                      :city => 'Tampa',
+                                      :state => 'FL',
+                                      :company => 'Tampa Company',
+                                      :address1 => '7926 Woodvale Circle',
+                                      :zip => '33615',
+                                      :address_type => 'commercial'), # means that UPS will default to commercial if it doesn't know
+        :fake_home_as_commercial => Location.new(
+                                      :country => 'US',
+                                      :state => 'FL',
+                                      :address1 => '123 fake st.',
+                                      :zip => '33615',
+                                      :address_type => 'commercial'),
+        :real_google_as_commercial => Location.new(
+                                      :country => 'US',
+                                      :city => 'Mountain View',
+                                      :state => 'CA',
+                                      :address1 => '1600 Amphitheatre Parkway',
+                                      :zip => '94043',
+                                      :address_type => 'commercial'),
+        :real_google_with_name_phone => Location.new(
+                                      :name => 'Sergey Brin',
+                                      :country => 'US',
+                                      :city => 'Mountain View',
+                                      :state => 'CA',
+                                      :address1 => '1600 Amphitheatre Parkway',
+                                      :zip => '94043',
+                                      :phone => '1-650-253-0000',
+                                      :address_type => 'commercial'),
+        :real_google_as_residential => Location.new(
+                                      :country => 'US',
+                                      :city => 'Mountain View',
+                                      :state => 'CA',
+                                      :address1 => '1600 Amphitheatre Parkway',
+                                      :zip => '94043',
+                                      :address_type => 'residential'), # means that will default to residential if it doesn't know
+        :fake_google_as_commercial => Location.new(
+                                      :country => 'US',
+                                      :city => 'Mountain View',
+                                      :state => 'CA',
+                                      :address1 => '123 bogusland dr.',
+                                      :zip => '94043',
+                                      :address_type => 'commercial'),
+        :fake_google_as_residential => Location.new(
+                                      :country => 'US',
+                                      :city => 'Mountain View',
+                                      :state => 'CA',
+                                      :address1 => '123 bogusland dr.',
+                                      :zip => '94043',
+                                      :address_type => 'residential'), # means that will default to residential if it doesn't know
+        :fake_home_as_residential => Location.new(
+                                      :country => 'US',
+                                      :state => 'FL',
+                                      :address1 => '123 fake st.',
+                                      :zip => '33615',
+                                      :address_type => 'residential'),
+        :real_home_as_residential => Location.new(
+                                      :country => 'US',
+                                      :city => 'Tampa',
+                                      :state => 'FL',
+                                      :address1 => '7926 Woodvale Circle',
+                                      :zip => '33615',
+                                      :address_type => 'residential'),
+        :london => Location.new(
+                                      :country => 'GB',
+                                      :city => 'London',
+                                      :address1 => '170 Westminster Bridge Rd.',
+                                      :zip => 'SE1 7RW'),
+        :new_york => Location.new(
+                                      :country => 'US',
+                                      :city => 'New York',
+                                      :state => 'NY',
+                                      :address1 => '780 3rd Avenue',
+                                      :address2 => 'Suite  2601',
+                                      :zip => '10017'),
+        :new_york_with_name => Location.new(
+                                      :name => "Bob Bobsen",
+                                      :country => 'US',
+                                      :city => 'New York',
+                                      :state => 'NY',
+                                      :address1 => '780 3rd Avenue',
+                                      :address2 => 'Suite  2601',
+                                      :zip => '10017',
+                                      :phone => '123-123-1234'),
+        :wellington => Location.new(
+                                      :country => 'NZ',
+                                      :city => 'Wellington',
+                                      :address1 => '85 Victoria St',
+                                      :address2 => 'Te Aro',
+                                      :postal_code => '6011'),
+        :auckland => Location.new(
+                                      :country => 'NZ',
+                                      :city => 'Auckland',
+                                      :address1 => '192 Victoria St West',
+                                      :postal_code => '1010'),
+        :puerto_rico => Location.new(
+                                      :country => 'PR',
+                                      :city => 'Barceloneta',
+                                      :address1 => '1 Nueva St',
+                                      :postal_code => '00617'),
+        :annapolis => Location.new(
+                                      :name => 'Big Red',
+                                      :country => 'US',
+                                      :city => 'Annapolis',
+                                      :address1 => '1 Park Place',
+                                      :address2 => '#7',
+                                      :postal_code => '21401'),
+        :netherlands => Location.new( :country => 'NL',
+                                      :city => 'Groningen',
+                                      :address1 => 'Aquamarijnstraat 349',
+                                      :postal_code => '9743 PJ',
+                                      :state => 'Groningen'),
+        :sydney => Location.new(
+                                      :country => 'AUS',
+                                      :city => 'Sydney',
+                                      :state => 'NSW',
+                                      :address1 => '192 George Street',
+                                      :postal_code => '2000'),
+        :melbourne => Location.new(
+                                      :country => 'AUS',
+                                      :city => 'Melbourne',
+                                      :state => 'VIC',
+                                      :address1 => '192 George Street',
+                                      :postal_code => '3108'),
+        :kosovo => Location.new(
+                                      :country => 'XK',
+                                      :city => 'Prishtinë',
+                                      :address1 => 'Ahmet Krasniqi',
+                                      :postal_code => '10000')
+      }
+
+    end
+
+    def line_item_fixture
+      @line_item_fixture ||= [
+        PackageItem.new("IPod Nano - 8gb - green", 200, 199.00, 2, :sku => "IPOD2008GREEN", :hs_code => "1234.12.12.12"),
+        PackageItem.new("IPod Nano - 8gb - black", 200, 199.00, 1, :sku => "IPOD2008GREEN", :hs_code => "1234.12.12.12")
+      ]
+    end
+  end
+end