active_shipping 1.8.6 → 1.9.0

data/lib/active_shipping/carriers/ups.rb

@@ -257,6 +257,25 @@ module ActiveShipping
       xml_builder.to_xml
     end
 
+    # Builds an XML node to request UPS shipping rates for the given packages
+    #
+    # @param origin [ActiveShipping::Location] Where the shipment will originate from
+    # @param destination [ActiveShipping::Location] Where the package will go
+    # @param packages [Array<ActiveShipping::Package>] The list of packages that will
+    #   be in the shipment
+    # @options options [Hash] rate-specific options
+    # @return [ActiveShipping::RateResponse] The response from the UPS, which
+    #   includes 0 or more rate estimates for different shipping products
+    #
+    # options:
+    # * service: name of the service
+    # * pickup_type: symbol for PICKUP_CODES
+    # * customer_classification: symbol for CUSTOMER_CLASSIFICATIONS
+    # * shipper: who is sending the package and where it should be returned
+    #     if it is undeliverable.
+    # * imperial: if truthy, measurements will use the metric system
+    # * negotiated_rates: if truthy, negotiated rates will be requested from
+    #     UPS. Only valid if shipper account has negotiated rates.
     def build_rate_request(origin, destination, packages, options = {})
       xml_builder = Nokogiri::XML::Builder.new do |xml|
         xml.RatingServiceSelectionRequest do

data/lib/active_shipping/package.rb

@@ -1,78 +1,4 @@
 module ActiveShipping #:nodoc:
-  # A package item is a unique item(s) that is physically in a package.
-  # A single package can have many items. This is only required
-  # for shipping methods (label creation) right now.
-  class PackageItem
-    include Quantified
-
-    attr_reader :sku, :hs_code, :value, :name, :weight, :quantity, :options
-
-    def initialize(name, grams_or_ounces, value, quantity, options = {})
-      @name = name
-
-      imperial = (options[:units] == :imperial) ||
-                 (grams_or_ounces.respond_to?(:unit) && m.unit.to_sym == :imperial)
-
-      @unit_system = imperial ? :imperial : :metric
-
-      @weight = attribute_from_metric_or_imperial(grams_or_ounces, Mass, :grams, :ounces)
-
-      @value = Package.cents_from(value)
-      @quantity = quantity > 0 ? quantity : 1
-
-      @sku = options[:sku]
-      @hs_code = options[:hs_code]
-      @options = options
-    end
-
-    def weight(options = {})
-      case options[:type]
-      when nil, :actual
-        @weight
-      when :volumetric, :dimensional
-        @volumetric_weight ||= begin
-          m = Mass.new((centimetres(:box_volume) / 6.0), :grams)
-          @unit_system == :imperial ? m.in_ounces : m
-        end
-      when :billable
-        [weight, weight(:type => :volumetric)].max
-      end
-    end
-    alias_method :mass, :weight
-
-    def ounces(options = {})
-      weight(options).in_ounces.amount
-    end
-    alias_method :oz, :ounces
-
-    def grams(options = {})
-      weight(options).in_grams.amount
-    end
-    alias_method :g, :grams
-
-    def pounds(options = {})
-      weight(options).in_pounds.amount
-    end
-    alias_method :lb, :pounds
-    alias_method :lbs, :pounds
-
-    def kilograms(options = {})
-      weight(options).in_kilograms.amount
-    end
-    alias_method :kg, :kilograms
-    alias_method :kgs, :kilograms
-
-    private
-
-    def attribute_from_metric_or_imperial(obj, klass, metric_unit, imperial_unit)
-      if obj.is_a?(klass)
-        return value
-      else
-        return klass.new(obj, (@unit_system == :imperial ? imperial_unit : metric_unit))
-      end
-    end
-  end
-
   class Package
     include Quantified
 
@@ -136,7 +62,9 @@ module ActiveShipping #:nodoc:
     end
     alias_method :tube?, :cylinder?
 
-    def gift?; @gift end
+    def gift?
+      @gift
+    end
 
     def ounces(options = {})
       weight(options).in_ounces.amount

data/lib/active_shipping/package_item.rb

@@ -0,0 +1,72 @@
+module ActiveShipping #:nodoc:
+  class PackageItem
+    include Quantified
+
+    attr_reader :sku, :hs_code, :value, :name, :weight, :quantity, :options
+
+    def initialize(name, grams_or_ounces, value, quantity, options = {})
+      @name = name
+
+      imperial = (options[:units] == :imperial) ||
+                 (grams_or_ounces.respond_to?(:unit) && m.unit.to_sym == :imperial)
+
+      @unit_system = imperial ? :imperial : :metric
+
+      @weight = attribute_from_metric_or_imperial(grams_or_ounces, Mass, :grams, :ounces)
+
+      @value = Package.cents_from(value)
+      @quantity = quantity > 0 ? quantity : 1
+
+      @sku = options[:sku]
+      @hs_code = options[:hs_code]
+      @options = options
+    end
+
+    def weight(options = {})
+      case options[:type]
+      when nil, :actual
+        @weight
+      when :volumetric, :dimensional
+        @volumetric_weight ||= begin
+          m = Mass.new((centimetres(:box_volume) / 6.0), :grams)
+          @unit_system == :imperial ? m.in_ounces : m
+        end
+      when :billable
+        [weight, weight(:type => :volumetric)].max
+      end
+    end
+    alias_method :mass, :weight
+
+    def ounces(options = {})
+      weight(options).in_ounces.amount
+    end
+    alias_method :oz, :ounces
+
+    def grams(options = {})
+      weight(options).in_grams.amount
+    end
+    alias_method :g, :grams
+
+    def pounds(options = {})
+      weight(options).in_pounds.amount
+    end
+    alias_method :lb, :pounds
+    alias_method :lbs, :pounds
+
+    def kilograms(options = {})
+      weight(options).in_kilograms.amount
+    end
+    alias_method :kg, :kilograms
+    alias_method :kgs, :kilograms
+
+    private
+
+    def attribute_from_metric_or_imperial(obj, klass, metric_unit, imperial_unit)
+      if obj.is_a?(klass)
+        return value
+      else
+        return klass.new(obj, (@unit_system == :imperial ? imperial_unit : metric_unit))
+      end
+    end
+  end
+end

data/lib/active_shipping/version.rb

@@ -1,3 +1,3 @@
 module ActiveShipping
-  VERSION = "1.8.6"
+  VERSION = "1.9.0"
 end

data/test/remote/fedex_test.rb

@@ -225,7 +225,7 @@ class RemoteFedExTest < Minitest::Test
     assert_equal "Delivered", response.status_description
 
     assert_equal Time.parse('Fri, 03 Jan 2014'), response.ship_time
-    assert_equal nil, response.scheduled_delivery_date
+    assert_nil response.scheduled_delivery_date
     assert_equal Time.parse('2014-01-09 18:31:00 +0000'), response.actual_delivery_date
 
     origin_address = ActiveShipping::Location.new(
@@ -261,7 +261,7 @@ class RemoteFedExTest < Minitest::Test
     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_equal nil, response.scheduled_delivery_date
+    assert_nil response.scheduled_delivery_date
   end
 
   def test_find_tracking_info_for_in_transit_shipment_2
@@ -275,8 +275,8 @@ class RemoteFedExTest < Minitest::Test
     assert_equal "Arrived at FedEx location", response.status_description
 
     assert_equal Time.parse('Fri, 03 Jan 2014'), response.ship_time
-    assert_equal nil, response.scheduled_delivery_date
-    assert_equal nil, response.actual_delivery_date
+    assert_nil response.scheduled_delivery_date
+    assert_nil response.actual_delivery_date
 
     origin_address = ActiveShipping::Location.new(
       city: 'CAMBRIDGE',
@@ -391,7 +391,7 @@ class RemoteFedExTest < Minitest::Test
 
     assert response.success?
     refute_empty response.labels
-    data = response.labels.first.img_data 
+    data = response.labels.first.img_data
     refute_empty data
     assert data[0...4] == '%PDF'
   end

data/test/remote/ups_test.rb

@@ -373,6 +373,7 @@ class RemoteUPSTest < Minitest::Test
 
   def test_delivery_date_estimates_intl
     today = Date.current
+
     response = @carrier.get_delivery_date_estimates(
       location_fixtures[:new_york_with_name],
       location_fixtures[:ottawa_with_name],
@@ -386,7 +387,7 @@ class RemoteUPSTest < Minitest::Test
     assert response.success?
     refute_empty response.delivery_estimates
     ww_express_estimate = response.delivery_estimates.select {|de| de.service_name == "UPS Worldwide Express"}.first
-    assert_equal Date.parse(1.day.from_now.to_s), ww_express_estimate.date
+    assert_equal 1.business_days.after(today), ww_express_estimate.date
   end
 
   def test_void_shipment

data/test/test_helper.rb

@@ -8,6 +8,7 @@ require 'business_time'
 require 'active_shipping'
 require 'logger'
 require 'erb'
+require 'pry'
 
 # This makes sure that Minitest::Test exists when an older version of Minitest
 # (i.e. 4.x) is required by ActiveSupport.

data/test/unit/carriers/canada_post_pws_tracking_test.rb

@@ -112,7 +112,7 @@ class CanadaPostPwsTrackingTest < Minitest::Test
 
     assert_equal CPPWSTrackingResponse, response.class
     assert_equal "Expedited Parcels", response.service_name
-    assert_equal nil, response.expected_date
+    assert_nil response.expected_date
     assert_equal "8213295707205355", response.tracking_number
     assert_equal 1, response.shipment_events.size
     assert_equal response.origin.city, "MAPLE"
@@ -130,7 +130,7 @@ class CanadaPostPwsTrackingTest < Minitest::Test
     response = @cp.find_tracking_info('1371134583769923', {})
 
     assert_equal false, response.delivered?
-    assert_equal nil, response.actual_delivery_time
+    assert_nil response.actual_delivery_time
   end
 
   def test_parse_tracking_response_shipment_events

data/test/unit/carriers/fedex_test.rb

@@ -379,7 +379,7 @@ class FedExTest < Minitest::Test
     refute response.exception?
 
     assert_equal Date.parse('2013-12-30'), response.ship_time
-    assert_equal nil, response.scheduled_delivery_date
+    assert_nil response.scheduled_delivery_date
     assert_equal Time.parse('2014-01-02T18:23:29Z'), response.actual_delivery_date
 
     origin_address = ActiveShipping::Location.new(
@@ -417,7 +417,7 @@ class FedExTest < Minitest::Test
     assert_equal 'AR', response.shipment_events.third.type_code
     assert_equal 'Delivered', response.latest_event.name
     assert_equal 'DL', response.latest_event.type_code
-    assert_equal nil, response.delivery_signature
+    assert_nil response.delivery_signature
   end
 
   def test_state_degrades_to_unknown
@@ -449,13 +449,13 @@ class FedExTest < Minitest::Test
     assert_equal :in_transit, response.status
     assert_equal 'IT', response.status_code
     assert_equal "Package available for clearance", response.status_description
-    assert_equal nil, response.delivery_signature
+    assert_nil response.delivery_signature
 
     assert_equal Time.parse('2014-11-17T22:39:00+11:00'), response.ship_time
-    assert_equal nil, response.scheduled_delivery_date
-    assert_equal nil, response.actual_delivery_date
+    assert_nil response.scheduled_delivery_date
+    assert_nil response.actual_delivery_date
 
-    assert_equal nil, response.origin
+    assert_nil response.origin
 
     destination_address = ActiveShipping::Location.new(
       city: 'GRAFTON',
@@ -481,8 +481,8 @@ class FedExTest < Minitest::Test
     assert_equal "Unable to deliver", response.status_description
 
     assert_equal Date.parse('2014-01-27'), response.ship_time
-    assert_equal nil, response.scheduled_delivery_date
-    assert_equal nil, response.actual_delivery_date
+    assert_nil response.scheduled_delivery_date
+    assert_nil response.actual_delivery_date
 
     origin_address = ActiveShipping::Location.new(
       city: 'AUSTIN',

data/test/unit/carriers/kunaki_test.rb

@@ -43,7 +43,7 @@ class KunakiTest < Minitest::Test
 
     assert rate = response.rates.first
     assert_equal "USPS Priority Mail", rate.service_name
-    assert_equal nil, rate.service_code
+    assert_nil rate.service_code
     assert_equal "USPS", rate.carrier
     assert_equal 800, rate.total_price
     assert_equal ["UPS 2nd Day Air", "UPS Ground", "UPS Next Day Air Saver", "USPS Priority Mail"], response.rates.collect(&:service_name).sort

data/test/unit/carriers/stamps_test.rb

@@ -68,7 +68,7 @@ class StampsTest < Minitest::Test
     assert_equal 'ActiveShipping::StampsPurchasePostageResponse', purchase_status.class.name
 
     assert_equal 'Success', purchase_status.purchase_status
-    assert_equal nil, purchase_status.transaction_id
+    assert_nil purchase_status.transaction_id
   end
 
   def test_validate_address

data/test/unit/carriers/usps_test.rb

@@ -160,13 +160,13 @@ class USPSTest < Minitest::Test
     # USPS API doesn't tell where it's going
     @carrier.expects(:commit).returns(@tracking_response)
     response = @carrier.find_tracking_info('9102901000462189604217', :test => true)
-    assert_equal response.destination, nil
+    assert_nil response.destination
   end
 
   def test_find_tracking_info_tracking_number
     @carrier.expects(:commit).returns(@tracking_response)
     response = @carrier.find_tracking_info('9102901000462189604217', :test => true)
-    assert_equal response.tracking_number, '9102901000462189604217'
+    assert_equal '9102901000462189604217', response.tracking_number
   end
 
   def test_find_tracking_info_should_have_correct_status

data/test/unit/external_return_label_request_test.rb

@@ -118,24 +118,24 @@ class ExternalReturnLabelRequestTest < Minitest::Test
   end
 
   def test_sanitize
-    assert_equal @external_request_label_req.send(:sanitize,'   ').length, 0
-    assert_equal @external_request_label_req.send(:sanitize, 'some string   '), 'some string'
-    assert_equal @external_request_label_req.send(:sanitize, {}), nil
-    assert_equal @external_request_label_req.send(:sanitize, nil), nil
-    assert_equal @external_request_label_req.send(:sanitize, nil), nil
-    assert_equal @external_request_label_req.send(:sanitize, []), nil
-    assert_equal @external_request_label_req.send(:sanitize, (1..100).to_a.join("_")).size, ExternalReturnLabelRequest::CAP_STRING_LEN
+    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
 
   def test_to_bool
-    assert_equal @external_request_label_req.send(:to_bool, 'yes'), true
-    assert_equal @external_request_label_req.send(:to_bool, 'true'), true
-    assert_equal @external_request_label_req.send(:to_bool, true), true
-    assert_equal @external_request_label_req.send(:to_bool, '1'), true
-    assert_equal @external_request_label_req.send(:to_bool, '0'), false
-    assert_equal @external_request_label_req.send(:to_bool, 'false'), false
-    assert_equal @external_request_label_req.send(:to_bool, false), false
-    assert_equal @external_request_label_req.send(:to_bool, nil, false), false
+    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')
+    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
 
   def test_validate_range
@@ -176,8 +176,8 @@ class ExternalReturnLabelRequestTest < Minitest::Test
     assert_raises(USPSValidationError) do
       @external_request_label_req.send(:validate_email, '    ', __method__)
     end
-    assert_equal @external_request_label_req.send(:validate_email, 'no-reply@example.com', __method__), 'no-reply@example.com'
-    assert_equal @external_request_label_req.send(:validate_email, '  no-reply@example.com  ', __method__), 'no-reply@example.com'
+    assert_equal 'no-reply@example.com', @external_request_label_req.send(:validate_email, 'no-reply@example.com', __method__)
+    assert_equal 'no-reply@example.com', @external_request_label_req.send(:validate_email, '  no-reply@example.com  ', __method__)
   end
 
   def test_tag_required

data/test/unit/package_item_test.rb

@@ -0,0 +1,237 @@
+require 'test_helper'
+
+class PackageItemTest < Minitest::Test
+  def setup
+    @name = "Fancy Pants"
+    @weight = 100
+    @value = 1299
+    @quantity = 3
+    @sku = "1234567890"
+    @hs_code = "1234.56.78"
+    @options = {
+      units: :metric,
+      sku: @sku,
+      hs_code: @hs_code,
+      type: :actual,
+    }
+
+    @item = PackageItem.new(@name, @weight, @value, @quantity, @options)
+    @mass = ::Quantified::Mass.new(@weight, :grams)
+  end
+
+  def test_initialize_with_all_attributes
+    assert_equal @name, @item.name
+    assert_equal @options, @item.options
+    assert_equal @hs_code, @item.hs_code
+    assert_equal @sku, @item.sku
+    assert_equal @value, @item.value
+    assert_equal @quantity, @item.quantity
+  end
+
+  def test_initialize_assumes_symbol_keys
+    options = {
+      "units" => :imperial,
+      "sku" => @sku,
+      "hs_code" => @hs_code,
+    }
+    @item = PackageItem.new(@name, @weight, @value, @quantity, options)
+
+    assert_nil @item.hs_code
+    assert_nil @item.sku
+    refute_equal @weight, @item.ounces
+    assert_equal @weight, @item.grams
+  end
+
+  def test_initialize_negative_quantity
+    assert_equal 1, PackageItem.new(@name, @weight, @value, -1).quantity
+    assert_equal 1, PackageItem.new(@name, @weight, @value, 0).quantity
+  end
+
+  def test_initialize_weight_mass_object
+    begin
+      @item = PackageItem.new(@name, @mass, @value, @quantity, @options)
+      assert_equal @mass, @item.weight
+      flunk "This code path is broken but passed unexpectedly"
+    rescue NameError
+      skip "This code path is broken"
+    end
+  end
+
+  def test_initialize_weight_default_metric
+    assert_equal @weight, @item.grams
+    refute_equal @weight, @item.ounces
+  end
+
+  def test_initialize_weight_accepts_imperial
+    @item = PackageItem.new(@name, @weight, @value, @quantity, @options.merge(units: :imperial))
+
+    assert_equal @weight, @item.ounces
+    refute_equal @weight, @item.grams
+  end
+
+  def test_initialize_weight_accepts_metric
+    @item = PackageItem.new(@name, @weight, @value, @quantity, @options.merge(units: :metric))
+
+    assert_equal @weight, @item.grams
+    refute_equal @weight, @item.ounces
+  end
+
+  def test_initialize_weight_does_not_accept_strings
+    @item = PackageItem.new(@name, @weight, @value, @quantity, @options.merge(units: "imperial"))
+
+    assert_equal @weight, @item.grams
+    refute_equal @weight, @item.ounces
+  end
+
+  def test_initialize_value_from_cents
+    @item = PackageItem.new(@name, @weight, "1.23", @quantity, @options)
+
+    assert_equal 123, @item.value
+  end
+
+  def test_weight
+    assert_equal @mass, @item.weight
+    assert_instance_of ::Quantified::Mass, @item.weight
+  end
+
+  def test_weight_actual
+    assert_equal @mass, @item.weight(type: :actual)
+    assert_instance_of ::Quantified::Mass, @item.weight(type: :actual)
+  end
+
+  def test_weight_volumetric
+    begin
+      assert_equal :todo, @item.weight(type: :volumetric)
+      assert_instance_of ::Quantified::Mass, @item.weight(type: :volumetric)
+      flunk "This code path is broken but passed unexpectedly"
+    rescue NoMethodError
+      skip "This code path is broken"
+    end
+  end
+
+  def test_weight_dimensional
+    begin
+      assert_equal :todo, @item.weight(type: :dimensional)
+      assert_instance_of ::Quantified::Mass, @item.weight(type: :dimensional)
+      flunk "This code path is broken but passed unexpectedly"
+    rescue NoMethodError
+      skip "This code path is broken"
+    end
+  end
+
+  def test_weight_billable_max_weight_and_volumetric
+    begin
+      assert_equal :todo, @item.weight(type: :billable)
+      assert_instance_of ::Quantified::Mass, @item.weight(type: :billable)
+      flunk "This code path is broken but passed unexpectedly"
+    rescue NoMethodError
+      skip "This code path is broken"
+    end
+  end
+
+  def test_grams_value
+    assert_equal 100, @item.grams
+  end
+
+  def test_grams_accepts_options_with_type
+    begin
+      assert_equal :todo, @item.grams(type: :volumetric)
+      flunk "This code path is broken but passed unexpectedly"
+    rescue NoMethodError
+      skip "This code path is broken"
+    end
+  end
+
+  def test_grams_converts
+    @item = PackageItem.new(@name, 100, @value, @quantity, @options.merge(units: :imperial))
+
+    assert_in_delta 2834.9, @item.grams, 0.1
+  end
+
+  def test_grams_alias_g
+    assert_equal @item.grams, @item.g
+  end
+
+  def test_ounces_value
+    @item = PackageItem.new(@name, @weight, @value, @quantity, @options.merge(units: :imperial))
+
+    assert_equal 100, @item.ounces
+  end
+
+  def test_ounces_accepts_options_with_type
+    begin
+      assert_equal :todo, @item.ounces(type: :volumetric)
+      flunk "This code path is broken but passed unexpectedly"
+    rescue NoMethodError
+      skip "This code path is broken"
+    end
+  end
+
+  def test_ounces_converts
+    @item = PackageItem.new(@name, @weight, @value, @quantity, @options.merge(units: :metric))
+
+    assert_in_delta 3.5, @item.ounces, 0.1
+  end
+
+  def test_ounces_alias_oz
+    assert_equal @item.ounces, @item.oz
+  end
+
+  def test_pounds_value
+    @item = PackageItem.new(@name, 32, @value, @quantity, @options.merge(units: :imperial))
+
+    assert_equal 2, @item.pounds
+  end
+
+  def test_pounds_accepts_options_with_type
+    begin
+      assert_equal :todo, @item.pounds(type: :volumetric)
+      flunk "This code path is broken but passed unexpectedly"
+    rescue
+      skip "This code path is broken"
+    end
+  end
+
+  def test_pounds_converts
+    @item = PackageItem.new(@name, 1000, @value, @quantity, @options.merge(units: :metric))
+
+    assert_in_delta 2.2, @item.pounds, 0.1
+  end
+
+  def test_pounds_alias_lb
+    assert_equal @item.pounds, @item.lb
+  end
+
+  def test_pounds_alias_lbs
+    assert_equal @item.pounds, @item.lbs
+  end
+
+  def test_kilograms_value
+    @item = PackageItem.new(@name, 1000, @value, @quantity, @options.merge(units: :metric))
+
+    assert_equal 1, @item.kilograms
+  end
+
+  def test_kilograms_accepts_options_with_type
+    begin
+      assert_equal :todo, @item.kilograms(type: :volumetric)
+      flunk "This code path is broken but passed unexpectedly"
+    rescue
+      skip "This code path is broken"
+    end
+  end
+
+  def test_kilograms_converts
+    @item = PackageItem.new(@name, 1000, @value, @quantity, @options.merge(units: :imperial))
+
+    assert_in_delta 28.3, @item.kilograms, 0.1
+  end
+
+  def test_kilograms_alias_kg
+    assert_equal @item.kilograms, @item.kg
+  end
+
+  def test_kilograms_alias_kgs
+    assert_equal @item.kilograms, @item.kgs
+  end
+end