active_shipping 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab948e86e9c144422b55594fc95f88034607cec2
-  data.tar.gz: 41d45d0e901d21086d43ec7be167ae90653a2bf6
+  metadata.gz: a721187cba1984ab9a456dea8c660c81d2a1aa68
+  data.tar.gz: 4b6ba4b2a8bedd5434f611d81d2ba74df92fab5e
 SHA512:
-  metadata.gz: 6e0984b2657b841ea40c6d98a3362fc5390d0c9ccaac2946202df6635211486738a623a425a10f1d7b5adc058028e890588035b7797403d1eba5e7cf7bb987fe
-  data.tar.gz: c0e2bd4ffa66008a1915002c509412884aae77b3485c922e20a8078ae45934af52e3f22b2dcc741f6a26e2e266805b7b4c7b81a4d8b09b297b4c2dcc1f22d327
+  metadata.gz: 7fecbfa0feaf36671db206bb30fb3e981b5c079183d45ebd8a2c096a41ba4d66f516b69d443ed3e08b54c1af4fa070ce618fb9f3fc89ce48bf2e19fafcec0d2b
+  data.tar.gz: 80a224c59f08ba748989a2aacc4ddcacd529296c43c4d0caa370339a26d60d1d2c29d860ce4e0c1d5719e2f791aef2b05589b44055b45228400fd47fef24fae7

data/dev.yml

@@ -2,8 +2,8 @@ name: active_shipping
 
 up:
   - ruby:
-      version: 2.2.4
-      build: true
+      package: homebrew/version/ruby22
+      version: 2.2.5p319
   - bundler
 
 commands:

data/lib/active_shipping/carrier.rb

@@ -7,6 +7,7 @@ module ActiveShipping
   #
   # @see #find_rates
   # @see #create_shipment
+  # @see #cancel_shipment
   # @see #find_tracking_info
   #
   # @!attribute test_mode
@@ -67,6 +68,20 @@ module ActiveShipping
       raise NotImplementedError, "#create_shipment is not supported by #{self.class.name}."
     end
 
+    # Cancels a shipment with a carrier.
+    #
+    # @note Override with whatever you need to cancel a shipping label
+    #
+    # @param shipment_id [String] The unique identifier of the shipment to cancel. 
+    #  This can be shipment_id or tracking number depending on carrier. Up to you and 
+    #  the carrier
+    # @param options [Hash] Carrier-specific parameters.
+    # @return [ActiveShipping::ShipmentResponse] The response from the carrier. This
+    #   response in most cases has a cancellation id.
+    def cancel_shipment(shipment_id, options = {})
+      raise NotImplementedError, "#cancel_shipment is not supported by #{self.class.name}."
+    end
+
     # Retrieves tracking information for a previous shipment
     #
     # @note Override with whatever you need to get a shipping label

data/lib/active_shipping/carriers/fedex.rb

@@ -134,6 +134,8 @@ module ActiveShipping
       'TR' => :transfer
     )
 
+    DEFAULT_LABEL_STOCK_TYPE = 'PAPER_7X4.75'
+
     def self.service_name_for_code(service_code)
       SERVICE_TYPES[service_code] || "FedEx #{service_code.titleize.sub(/Fedex /, '')}"
     end
@@ -218,7 +220,7 @@ module ActiveShipping
             xml.LabelSpecification do
               xml.LabelFormatType('COMMON2D')
               xml.ImageType('PNG')
-              xml.LabelStockType('PAPER_7X4.75')
+              xml.LabelStockType(options[:label_stock_type] || DEFAULT_LABEL_STOCK_TYPE)
             end
 
             xml.RateRequestTypes('ACCOUNT')

data/lib/active_shipping/carriers/ups.rb

@@ -318,7 +318,7 @@ module ActiveShipping
     # Build XML node to request a shipping label for the given packages.
     #
     # options:
-    # * origin_account: who will pay for the shipping label
+    # * origin_account: account number for the shipper
     # * customer_context: a "guid like substance" -- according to UPS
     # * shipper: who is sending the package and where it should be returned
     #     if it is undeliverable.
@@ -332,6 +332,7 @@ module ActiveShipping
     # * prepay: if truthy the shipper will be bill immediatly. Otherwise the shipper is billed when the label is used.
     # * negotiated_rates: if truthy negotiated rates will be requested from ups. Only valid if shipper account has negotiated rates.
     # * delivery_confirmation: Can be set to any key from SHIPMENT_DELIVERY_CONFIRMATION_CODES. Can also be set on package level via package.options
+    # * bill_third_party: When truthy, bill an account other than the shipper's. Specified by billing_(account, zip and country)
     def build_shipment_request(origin, destination, packages, options={})
       packages = Array(packages)
       shipper = options[:shipper] || origin
@@ -381,7 +382,7 @@ module ActiveShipping
               end
             end
 
-            if options[:origin_account]
+            if options[:negotiated_rates]
               xml.RateInformation do
                 xml.NegotiatedRatesIndicator
               end
@@ -397,23 +398,7 @@ module ActiveShipping
             if options[:prepay]
               xml.PaymentInformation do
                 xml.Prepaid do
-                  xml.BillShipper do
-                    xml.AccountNumber(options[:origin_account])
-                  end
-                end
-              end
-            elsif options[:bill_third_party]
-              xml.PaymentInformation do
-                xml.BillThirdParty do
-                  xml.BillThirdPartyShipper do
-                    xml.AccountNumber(options[:billing_account])
-                    xml.ThirdParty do
-                      xml.Address do
-                        xml.PostalCode(options[:billing_zip])
-                        xml.CountryCode(options[:billing_country])
-                      end
-                    end
-                  end
+                  build_billing_info_node(xml, options)
                 end
               end
             else
@@ -422,18 +407,14 @@ module ActiveShipping
                   # Type '01' means 'Transportation'
                   # This node specifies who will be billed for transportation.
                   xml.Type('01')
-                  xml.BillShipper do
-                    xml.AccountNumber(options[:origin_account])
-                  end
+                  build_billing_info_node(xml, options)
                 end
-                if options[:terms_of_shipment] == 'DDP'
+                if options[:terms_of_shipment] == 'DDP' && options[:international]
                   # DDP stands for delivery duty paid and means the shipper will cover duties and taxes
                   # Otherwise UPS will charge the receiver
                   xml.ShipmentCharge do
                     xml.Type('02') # Type '02' means 'Duties and Taxes'
-                    xml.BillShipper do
-                      xml.AccountNumber(options[:origin_account])
-                    end
+                    build_billing_info_node(xml, options.merge(bill_to_consignee: true))
                   end
                 end
               end
@@ -762,6 +743,27 @@ module ActiveShipping
       end
     end
 
+    def build_billing_info_node(xml, options={})
+      if options[:bill_third_party]
+        xml.BillThirdParty do
+          node_type = options[:bill_to_consignee] ? :BillThirdPartyConsignee : :BillThirdPartyShipper
+          xml.public_send(node_type) do
+            xml.AccountNumber(options[:billing_account])
+            xml.ThirdParty do
+              xml.Address do
+                xml.PostalCode(options[:billing_zip])
+                xml.CountryCode(options[:billing_country])
+              end
+            end
+          end
+        end
+      else
+        xml.BillShipper do
+          xml.AccountNumber(options[:origin_account])
+        end
+      end
+    end
+
     def build_document(xml, expected_root_tag)
       document = Nokogiri.XML(xml)
       if document.root.nil? || document.root.name != expected_root_tag

data/lib/active_shipping/location.rb

@@ -140,5 +140,9 @@ module ActiveShipping #:nodoc:
     def address2_and_3
       [address2, address3].reject(&:blank?).join(", ")
     end
+
+    def ==(other)
+      to_hash == other.to_hash
+    end
   end
 end

data/lib/active_shipping/shipment_event.rb

@@ -13,5 +13,10 @@ module ActiveShipping
     def status
       @status ||= name.downcase.gsub("\s", "_").to_sym
     end
+
+    def ==(other)
+      attributes = %i(name time location message type_code)
+      attributes.all? { |attr| self.public_send(attr) == other.public_send(attr) }
+    end
   end
 end

data/lib/active_shipping/tracking_response.rb

@@ -31,7 +31,7 @@ module ActiveShipping
   #
   # @!attribute attempted_delivery_date
   #   @return [Date, Time]
-  #  
+  #
   # @!attribute delivery_signature
   #   @return [String]
   #
@@ -101,5 +101,20 @@ module ActiveShipping
     alias_method :scheduled_delivery_time, :scheduled_delivery_date
     alias_method :actual_delivery_time, :actual_delivery_date
     alias_method :attempted_delivery_time, :attempted_delivery_date
+
+    def ==(other)
+      attributes = %i(carrier carrier_name status status_code status_description ship_time scheduled_delivery_date
+        actual_delivery_date attempted_delivery_date delivery_signature tracking_number shipper_address
+        origin destination
+      )
+
+      attributes.all? { |attr| self.public_send(attr) == other.public_send(attr) } && compare_shipment_events(other)
+    end
+
+    private
+    # Ensure order doesn't matter when comparing shipment_events
+    def compare_shipment_events(other)
+      shipment_events.sort_by(&:time) == other.shipment_events.sort_by(&:time)
+    end
   end
 end

data/lib/active_shipping/version.rb

@@ -1,3 +1,3 @@
 module ActiveShipping
-  VERSION = "1.7.1"
+  VERSION = "1.7.2"
 end

data/test/remote/ups_test.rb

@@ -267,6 +267,35 @@ class RemoteUPSTest < Minitest::Test
     assert_instance_of ActiveShipping::LabelResponse, response
   end
 
+  def test_obtain_international_shipping_label_with_bill_third_party
+    begin
+      bill_third_party_credentials = credentials(:ups_third_party_billing)
+    rescue NoCredentialsFound => e
+      skip(e.message)
+    end
+
+    response = @carrier.create_shipment(
+      location_fixtures[:new_york_with_name],
+      location_fixtures[:ottawa_with_name],
+      package_fixtures.values_at(:books),
+      {
+       :service_code => '07',
+       :bill_third_party => true,
+       :billing_account => bill_third_party_credentials[:account],
+       :billing_zip => bill_third_party_credentials[:zip],
+       :billing_country => bill_third_party_credentials[:country_code],
+       :test => true,
+      }
+    )
+    assert response.success?
+
+    # All behavior specific to how a LabelResponse behaves in the
+    # context of UPS label data is a matter for unit tests.  If
+    # the data changes substantially, the create_shipment
+    # ought to raise an exception and this test will fail.
+    assert_instance_of ActiveShipping::LabelResponse, response
+  end
+
   def test_delivery_date_estimates_within_zip
     today = Date.current
 

data/test/unit/carriers/fedex_test.rb

@@ -601,6 +601,32 @@ class FedExTest < Minitest::Test
     assert_equal result.search('RequestedPackageLineItems/CustomerReferences/Value').text, "FOO-123"
   end
 
+  def test_create_shipment_default_label_stock_type
+    packages = package_fixtures.values_at(:wii)
+
+    result = Nokogiri::XML(@carrier.send(:build_shipment_request,
+                                         location_fixtures[:beverly_hills],
+                                         location_fixtures[:annapolis],
+                                         packages,
+                                         :test => true))
+
+    assert_equal result.search('RequestedShipment/LabelSpecification/LabelStockType').text, FedEx::DEFAULT_LABEL_STOCK_TYPE
+  end
+
+  def test_create_shipment_label_stock_type
+    label_stock_type = 'PAPER_4X6'
+    packages = package_fixtures.values_at(:wii)
+
+    result = Nokogiri::XML(@carrier.send(:build_shipment_request,
+                                         location_fixtures[:beverly_hills],
+                                         location_fixtures[:annapolis],
+                                         packages,
+                                         :test => true,
+                                         :label_stock_type => label_stock_type))
+
+    assert_equal result.search('RequestedShipment/LabelSpecification/LabelStockType').text, label_stock_type
+  end
+
   def test_maximum_address_field_length
     assert_equal 35, @carrier.maximum_address_field_length
   end

data/test/unit/carriers/ups_test.rb

@@ -365,9 +365,9 @@ class UPSTest < Minitest::Test
                                            :billing_zip => expected_postal_code_number,
                                            :billing_country => expected_country_code)
 
-    assert_equal expected_account_number, response.search('ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty/BillThirdPartyShipper/AccountNumber').text
-    assert_equal expected_postal_code_number, response.search('/ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty/BillThirdPartyShipper/ThirdParty/Address/PostalCode').text
-    assert_equal expected_country_code, response.search('/ShipmentConfirmRequest/Shipment/PaymentInformation/BillThirdParty/BillThirdPartyShipper/ThirdParty/Address/CountryCode').text
+    assert_equal expected_account_number, response.search('ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillThirdParty/BillThirdPartyShipper/AccountNumber').text
+    assert_equal expected_postal_code_number, response.search('/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillThirdParty/BillThirdPartyShipper/ThirdParty/Address/PostalCode').text
+    assert_equal expected_country_code, response.search('/ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillThirdParty/BillThirdPartyShipper/ThirdParty/Address/CountryCode').text
   end
 
   def test_label_request_negotiated_rates_presence
@@ -377,7 +377,8 @@ class UPSTest < Minitest::Test
                                            package_fixtures.values_at(:chocolate_stuff),
                                            :test => true,
                                            :saturday_delivery => true,
-                                           :origin_account => 'A01B23' # without this option, a negotiated rate will not be requested
+                                           :origin_account => 'A01B23', # without this option, a negotiated rate will not be requested
+                                           :negotiated_rates => true,
                              )
 
     negotiated_rates = response.search '/ShipmentConfirmRequest/Shipment/RateInformation/NegotiatedRatesIndicator'

data/test/unit/location_test.rb

@@ -125,4 +125,11 @@ class LocationTest < Minitest::Test
     location = Location.from(:address3 => address3)
     assert_equal 'Victory Lane', location.address2_and_3
   end
+
+  def test_equality
+    location_1 = location_fixtures[:ottawa]
+    location_2 = Location.from(location_1.to_hash)
+
+    assert_equal location_1, location_2
+  end
 end

data/test/unit/shipment_event_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class ShipmentEventTest < Minitest::Test
+  def test_equality
+    options1 = [
+      'ARRIVED AT UNIT',
+      DateTime.new(2016, 5, 12, 5, 45),
+      Location.new(city: 'SAN JOSE', state: 'CA', postal_code: '90001', country: 'US'),
+      'ARRIVED AT UNIT',
+      '07'
+    ]
+    # Copies options to create new DateTime and Location objects to check for similar distinct objects
+    options2 = options1.dup
+
+    shipment_event_1 = ShipmentEvent.new(*options1)
+    shipment_event_2 = ShipmentEvent.new(*options2)
+
+    assert_equal shipment_event_1, shipment_event_2
+  end
+end

data/test/unit/tracking_response_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class TrackingResponseTest < Minitest::Test
+  def test_equality
+    options1 = {
+      carrier: 'usps',
+      status: 'DELIVERED',
+      status_code: 'I0',
+      status_description: 'DELIVERED',
+      actual_delivery_date: DateTime.new(2016, 5, 14, 13, 20),
+      tracking_number: 'TRACKINGNUMBER1234ABC',
+      shipment_events: [
+        ShipmentEvent.new(
+          'DELIVERED',
+          DateTime.new(2016, 5, 14, 13, 20),
+          Location.new(city: 'LOS ANGELES', state: 'CA', postal_code: '90210', country: 'US'),
+          'DELIVERED',
+          'I0'
+        ),
+        ShipmentEvent.new(
+          'ARRIVED AT UNIT',
+          DateTime.new(2016, 5, 12, 5, 45),
+          Location.new(city: 'SAN JOSE', state: 'CA', postal_code: '90001', country: 'US'),
+          'ARRIVED AT UNIT',
+          '07'
+        )
+      ],
+      destination: Location.new(postal_code: '90210'),
+      origin: Location.new(postal_code: '00001')
+    }
+    # Deep copies options1 to create new ShipmentEvent, Location, etc. objects to check for similar distinct objects
+    options2 = Marshal.load(Marshal.dump(options1))
+    options2[:shipment_events][0], options2[:shipment_events][1] =
+      options2[:shipment_events][1], options2[:shipment_events][0]
+
+    tracking_response_1 = TrackingResponse.new(true, nil, {}, options1)
+    tracking_response_2 = TrackingResponse.new(true, nil, {}, options2)
+
+    assert_equal tracking_response_1, tracking_response_2
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_shipping
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - James MacAulay
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: quantified
@@ -399,7 +399,9 @@ files:
 - test/unit/package_test.rb
 - test/unit/rate_estimate_test.rb
 - test/unit/response_test.rb
+- test/unit/shipment_event_test.rb
 - test/unit/shipment_packer_test.rb
+- test/unit/tracking_response_test.rb
 homepage: http://github.com/shopify/active_shipping
 licenses:
 - MIT
@@ -606,4 +608,6 @@ test_files:
 - test/unit/package_test.rb
 - test/unit/rate_estimate_test.rb
 - test/unit/response_test.rb
+- test/unit/shipment_event_test.rb
 - test/unit/shipment_packer_test.rb
+- test/unit/tracking_response_test.rb