reactive_shipping 3.0.0

data/test/unit/carriers_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class CarriersTest < ActiveSupport::TestCase
+  test ".find searches by string for a carrier and finds USPS" do
+    assert_equal ReactiveShipping::USPS, ReactiveShipping::Carriers.find('usps')
+    assert_equal ReactiveShipping::USPS, ReactiveShipping::Carriers.find('USPS')
+  end
+
+  test ".find searches by symbol for a carrier and finds USPS" do
+    assert_equal ReactiveShipping::USPS, ReactiveShipping::Carriers.find(:usps)
+  end
+
+  test ".find raises with an unknown carrier" do
+    assert_raises(NameError) { ReactiveShipping::Carriers.find(:polar_north) }
+  end
+end

data/test/unit/external_return_label_request_test.rb

@@ -0,0 +1,258 @@
+require 'test_helper'
+
+class ExternalReturnLabelRequestTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Fixtures
+
+  setup do
+    @external_request_label_req =
+      ExternalReturnLabelRequest.from_hash(
+        customer_name: "Test Customer",
+        customer_address1: "122 Hudson St.",
+        customer_city: "New York",
+        customer_state: "NY",
+        customer_zipcode: "10013",
+        label_format: "No Instructions",
+        label_definition: "4X6",
+        service_type_code: "044",
+        merchant_account_id: "12345",
+        mid: "12345678",
+        call_center_or_self_service: "Customer",
+        address_override_notification: "true",
+      )
+    @email = "no-reply@example.com"
+    @invalid_email = "not_a_valid_email"
+    @anything = "Any string"
+    @blank_values = ["", "    "]
+  end
+
+  test "#recipient_bcc raises on an invalid email" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.recipient_bcc = @invalid_email
+    end
+  end
+
+  test "#recipient_bcc assigns the email" do
+    @external_request_label_req.recipient_bcc = @email
+    assert_equal @email, @external_request_label_req.recipient_bcc
+  end
+
+  test "#recipient_email raises if invalid" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.recipient_email = @invalid_email
+    end
+  end
+
+  test "#recipient_email assigns the email" do
+    @external_request_label_req.recipient_email = @email
+    assert_equal @email, @external_request_label_req.recipient_email
+  end
+
+  test "#recipient_name accepts anything" do
+    @external_request_label_req.recipient_name = @anything
+    assert_equal @anything, @external_request_label_req.recipient_name
+  end
+
+  test "#sender_email raises if invalid" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.sender_email = @invalid_email
+    end
+  end
+
+  test "#sender_email assigns the email" do
+    @external_request_label_req.sender_email = @email
+    assert_equal @email, @external_request_label_req.sender_email
+  end
+
+  test "#sender_name assigns the value" do
+    @external_request_label_req.sender_name = @anything
+    assert_equal @anything, @external_request_label_req.sender_name
+  end
+
+  test "#sender_name raises if blank or nil" do
+    @blank_values.each do |blank|
+      assert_raises(USPSValidationError) do
+        @external_request_label_req.sender_name = blank
+      end
+    end
+  end
+
+  test "#sender_name raises if nil" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.sender_name = nil
+    end
+  end
+
+  test "#image_type accepts a valid image type" do
+    ExternalReturnLabelRequest::IMAGE_TYPE.each do |type|
+      @external_request_label_req.image_type = type.downcase
+      assert_equal type, @external_request_label_req.image_type
+    end
+  end
+
+  test "#image_type raises on jpg" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.image_type = "jpg"
+    end
+  end
+
+  test "#call_center_or_self_service accepts the valid values defined" do
+    ExternalReturnLabelRequest::CALL_CENTER_OR_SELF_SERVICE.each do |cc_or_cs|
+      @external_request_label_req.call_center_or_self_service = cc_or_cs
+      assert_equal cc_or_cs, @external_request_label_req.call_center_or_self_service
+    end
+  end
+
+  test "#call_center_or_self_service raises on an invalid value" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.call_center_or_self_service = "Invalid"
+    end
+  end
+
+  test "#packaging_information accepts a value" do
+    @external_request_label_req.packaging_information = @anything
+    assert_equal @anything, @external_request_label_req.packaging_information
+  end
+
+  test "#packaging_information accepts blank values" do
+    @blank_values.each do |blank|
+      @external_request_label_req.packaging_information = blank
+      assert_equal "", @external_request_label_req.packaging_information
+    end
+  end
+
+  test "#packaging_information raises on a value too long" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.packaging_information = "a" * 16
+    end
+  end
+
+  test "#packaging_information2 accepts a value" do
+    @external_request_label_req.packaging_information2 = @anything
+    assert_equal @anything, @external_request_label_req.packaging_information2
+  end
+
+  test "#packaging_information2 accepts blank values" do
+    @blank_values.each do |blank|
+      @external_request_label_req.packaging_information2 = blank
+      assert_equal "", @external_request_label_req.packaging_information2
+    end
+  end
+
+  test "#packaging_information2 raises when a value is too long" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.packaging_information2 = "a" * 16
+    end
+  end
+
+  test "#customer_address2 accepts a value" do
+    @external_request_label_req.customer_address2 = @anything
+    assert_equal @anything, @external_request_label_req.customer_address2
+  end
+
+  test "#customer_address2 accepts blank values" do
+    @blank_values.each do |blank|
+      @external_request_label_req.customer_address2 = blank
+      assert_nil @external_request_label_req.customer_address2
+    end
+  end
+
+  test "#customer_address2 accepts nil" do
+    @external_request_label_req.customer_address2 = nil
+    assert_nil @external_request_label_req.customer_address2
+  end
+
+  test "#sanitize scrubs strings" do
+    assert_equal "", @external_request_label_req.send(:sanitize,'   ')
+    assert_equal 'some string', @external_request_label_req.send(:sanitize, 'some string   ')
+    assert_nil @external_request_label_req.send(:sanitize, {})
+    assert_nil @external_request_label_req.send(:sanitize, nil)
+    assert_nil @external_request_label_req.send(:sanitize, nil)
+    assert_nil @external_request_label_req.send(:sanitize, [])
+    assert_equal ExternalReturnLabelRequest::CAP_STRING_LEN, @external_request_label_req.send(:sanitize, (1..100).to_a.join("_")).size
+  end
+
+  test "#to_bool coerces true values" do
+    assert_equal true, @external_request_label_req.send(:to_bool, 'yes')
+    assert_equal true, @external_request_label_req.send(:to_bool, 'true')
+    assert_equal true, @external_request_label_req.send(:to_bool, true)
+    assert_equal true, @external_request_label_req.send(:to_bool, '1')
+  end
+
+  test "#to_bool coerces false values" do
+    assert_equal false, @external_request_label_req.send(:to_bool, '0')
+    assert_equal false, @external_request_label_req.send(:to_bool, 'false')
+    assert_equal false, @external_request_label_req.send(:to_bool, false)
+    assert_equal false, @external_request_label_req.send(:to_bool, nil, false)
+  end
+
+  test "#validate_range" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_range, '1', 5, 10, __method__)
+    end
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_range, '', 1, 10, __method__)
+    end
+    @external_request_label_req.send(:validate_range, '5 char', 3, 10, __method__)
+    @external_request_label_req.send(:validate_range, '5 char', nil, 10, __method__)
+  end
+
+  test "#validate_string_length" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_string_length, '14 char string', 13, __method__)
+    end
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_string_length, '14 char string', nil, __method__)
+    end
+    @external_request_label_req.send(:validate_string_length, '14 char string', 14, __method__)
+  end
+
+  test "#validate_set_inclusion" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_set_inclusion, 'not_in_set', ['v1','v2','v3'], __method__)
+    end
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_set_inclusion, 'not_in_set', nil, __method__)
+    end
+    @external_request_label_req.send(:validate_set_inclusion, 'v1', ['v1','v2','v3'], __method__)
+  end
+
+  test "#validate_email" do
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_email, @invalid_email, __method__)
+    end
+    assert_raises(USPSValidationError) do
+      @external_request_label_req.send(:validate_email, "    ", __method__)
+    end
+    assert_equal @email, @external_request_label_req.send(:validate_email, @email, __method__)
+    assert_equal @email, @external_request_label_req.send(:validate_email, "    #{@email}    ", __method__)
+  end
+
+  test "#initialize raises with no tag" do
+    assert_raises(USPSMissingRequiredTagError) { ExternalReturnLabelRequest.new }
+  end
+
+  test "#initialize passes with valid values and that every key is necessary" do
+    sample_hash = {
+      :customer_name => "Test Customer",
+      :customer_address1 => "122 Hudson St.",
+      :customer_city => "New York",
+      :customer_state => "NY",
+      :customer_zipcode => "10013",
+      :label_format => "No Instructions",
+      :label_definition => "4X6",
+      :service_type_code => "044",
+      :merchant_account_id => "12345",
+      :mid => "12345678",
+      :call_center_or_self_service => "Customer",
+      :address_override_notification => "true"
+    }
+
+    assert ExternalReturnLabelRequest.from_hash(sample_hash)
+
+    sample_hash.keys.each do |k|
+      assert_raises(USPSMissingRequiredTagError) do
+        ExternalReturnLabelRequest.from_hash(sample_hash.reject {|k, v| k })
+      end
+    end
+  end
+end

data/test/unit/location_test.rb

@@ -0,0 +1,234 @@
+require 'test_helper'
+
+class LocationTest < ActiveSupport::TestCase
+  include ReactiveShipping::Test::Fixtures
+
+  setup do
+    @location = location_fixtures[:ottawa]
+    @address2 = 'Apt 613'
+    @address3 = 'Victory Lane'
+    @attributes_hash = {
+      country: 'CA',
+      zip: '90210',
+      territory_code: 'QC',
+      town: 'Perth',
+      address: '66 Gregory Ave.',
+      phone: '515-555-1212',
+      fax_number: 'none to speak of',
+      email: 'bob.bobsen@gmail.com',
+      address_type: :commercial,
+      name: "Bob Bobsen",
+    }
+  end
+
+  test "#initialize sets a country object" do
+    assert_instance_of ActiveUtils::Country, @location.country
+    assert_equal 'CA', @location.country_code(:alpha2)
+  end
+
+  test ".from sets up the location from a hash" do
+    location = Location.from(@attributes_hash)
+
+    assert_equal @attributes_hash[:country], location.country_code(:alpha2)
+    assert_equal @attributes_hash[:zip], location.zip
+    assert_equal @attributes_hash[:territory_code], location.province
+    assert_equal @attributes_hash[:town], location.city
+    assert_equal @attributes_hash[:address], location.address1
+    assert_equal @attributes_hash[:phone], location.phone
+    assert_equal @attributes_hash[:fax_number], location.fax
+    assert_equal @attributes_hash[:email], location.email
+    assert_equal @attributes_hash[:address_type].to_s, location.address_type
+    assert_equal @attributes_hash[:name], location.name
+  end
+
+  test ".from sets from an object with properties" do
+    object = Class.new do
+      def initialize(hash)
+        @hash = hash
+      end
+      def method_missing(method)
+        @hash[method]
+      end
+      def respond_to?(method)
+        return false if method == :[]
+        true
+      end
+    end.new(@attributes_hash)
+
+    location = Location.from(object)
+
+    assert_equal @attributes_hash[:country], location.country_code(:alpha2)
+    assert_equal @attributes_hash[:zip], location.zip
+    assert_equal @attributes_hash[:territory_code], location.province
+    assert_equal @attributes_hash[:town], location.city
+    assert_equal @attributes_hash[:address], location.address1
+    assert_equal @attributes_hash[:phone], location.phone
+    assert_equal @attributes_hash[:fax_number], location.fax
+    assert_equal @attributes_hash[:email], location.email
+    assert_equal @attributes_hash[:address_type].to_s, location.address_type
+    assert_equal @attributes_hash[:name], location.name
+  end
+
+  test ".from adheres to propery order even if hash access is available" do
+    object = Class.new do
+      def [](index)
+        { province: "California" }[index]
+      end
+
+      def province_code
+        "CA"
+      end
+    end.new
+    assert_equal "CA", Location.from(object).province
+  end
+
+  test ".from sets the name to nil if it is not provided" do
+    location = Location.from({})
+    assert_nil location.name
+  end
+
+  test ".from sets company and company_name from company" do
+    location = Location.from(company: "Mine")
+
+    assert_equal "Mine", location.company
+    assert_equal "Mine", location.company_name
+  end
+
+  test ".from sets company and company_name from company_name" do
+    location = Location.from(company_name: "Mine")
+
+    assert_equal "Mine", location.company
+    assert_equal "Mine", location.company_name
+  end
+
+  test ".from prioritizes company" do
+    location = Location.from(company_name: "from company_name", company: "from company")
+
+    assert_equal "from company", location.company
+    assert_equal "from company", location.company_name
+  end
+
+  test "#prettyprint outputs a readable string" do
+    expected = "110 Laurier Avenue West\nOttawa, ON, K1P 1J1\nCanada"
+    assert_equal expected, @location.prettyprint
+  end
+
+  test "#to_s outputs a readable string without newlines" do
+    expected = "110 Laurier Avenue West Ottawa, ON, K1P 1J1 Canada"
+    assert_equal expected, @location.to_s
+  end
+
+  test "#inspect returns a readable string" do
+    expected = "110 Laurier Avenue West\nOttawa, ON, K1P 1J1\nCanada\nPhone: 1-613-580-2400\nFax: 1-613-580-2495\nEmail: bob.bobsen@gmail.com"
+    assert_equal expected, @location.inspect
+  end
+
+  test "#address_type= assigns a type of address as commercial" do
+    refute @location.commercial?
+
+    @location.address_type = :commercial
+    assert @location.commercial?
+    refute @location.residential?
+    assert_equal "commercial", @location.address_type
+  end
+
+  test "#address_type= assigns a type of address as residential" do
+    refute @location.residential?
+
+    @location.address_type = :residential
+    assert @location.residential?
+    refute @location.commercial?
+    assert_equal "residential", @location.address_type
+  end
+
+  test "#address_type= raises on an invalid assignment" do
+    assert_raises(ArgumentError) do
+      @location.address_type = :new_address_type
+    end
+
+    assert_nil @location.address_type
+  end
+
+  test "#address_type= cannot blank out the value as nil" do
+    @location.address_type = :residential
+    assert @location.residential?
+
+    @location.address_type = nil
+    assert @location.residential?
+    assert_equal "residential", @location.address_type
+  end
+
+  test "#address_type= cannot blank out the value as empty string" do
+    @location.address_type = :residential
+    assert @location.residential?
+
+    @location.address_type = ""
+    assert @location.residential?
+    assert_equal "residential", @location.address_type
+  end
+
+  test "#to_hash has the expected attributes" do
+    expected = %w(address1 address2 address3 address_type city company_name country email fax name phone postal_code province)
+
+    assert_equal expected, @location.to_hash.stringify_keys.keys.sort
+  end
+
+  test "#to_json returns the JSON values" do
+    expected = JSON.parse(@location.to_json).symbolize_keys
+
+    assert_equal @location.to_hash, expected
+  end
+
+  test "#zip_plus_4 nil without the extra four" do
+    zip = "12345"
+    location = Location.from(zip: zip)
+
+    assert_nil location.zip_plus_4
+    assert_equal zip, location.zip
+  end
+
+  test "#zip_plus_4 parses without the dash" do
+    zip = "12345-9999"
+    zip_without_dash = "123459999"
+    location = Location.from(zip: zip_without_dash)
+
+    assert_equal zip, location.zip_plus_4
+    assert_equal zip_without_dash, location.zip
+  end
+
+  test "#zip_plus_4 parses with the dash" do
+    zip = "12345-9999"
+    location = Location.from(zip: zip)
+
+    assert_equal zip, location.zip_plus_4
+    assert_equal zip, location.zip
+  end
+
+  test "#address2_and_3 shows just address2" do
+    location = Location.from(address2: @address2)
+    assert_equal 'Apt 613', location.address2_and_3
+  end
+
+  test "#address2_and_3 shows just address3" do
+    location = Location.from(address3: @address3)
+    assert_equal @address3, location.address2_and_3
+  end
+
+  test "#address2_and_3 shows both address2 and address3" do
+    location = Location.from(address2: @address2, address3: @address3)
+    assert_equal "#{@address2}, #{@address3}", location.address2_and_3
+  end
+
+  test "#address2_and_3 shows an empty string when address2 and address3 are both blank" do
+    assert_nil @location.address2
+    assert_nil @location.address3
+    assert_equal "", @location.address2_and_3
+  end
+
+  test "#== compares locations by attributes" do
+    another_location = Location.from(@location.to_hash)
+
+    assert_equal @location, another_location
+    refute_equal @location, Location.new({})
+  end
+end