ups-ruby 0.14.1 → 0.23.0

data/spec/support/shipping_options.rb

@@ -23,12 +23,21 @@ module ShippingOptions
       city: 'London',
       state: 'England',
       postal_code: 'WC2H 8AG',
+      email_address: 'test@example.com',
       country: 'GB'
     }
   end
 
   def package
     {
+      reference_number: {
+        value: 'GB393023098',
+        type: 'TN'
+      },
+      reference_number_2: {
+        value: '#3403',
+        type: 'IK'
+      },
       weight: '0.5',
       unit: 'KGS',
       dimensions: {
@@ -42,6 +51,9 @@ module ShippingOptions
 
   def large_package
     {
+      reference_number: {
+        value: 'GB393023098'
+      },
       weight: '1',
       unit: 'KGS',
       dimensions: {
@@ -53,6 +65,34 @@ module ShippingOptions
     }
   end
 
+  def package_with_carrier_packaging
+    {
+      weight: '1',
+      unit: 'KGS',
+      packaging_type:{
+        code: '01',
+        description: 'Tube'
+      }
+    }
+  end
+
+  def package_with_carrier_packaging_and_dimensions
+    {
+      weight: '1',
+      unit: 'KGS',
+      dimensions: {
+        length: 40,
+        width: 30,
+        height: 20,
+        unit: 'CM'
+      },
+      packaging_type:{
+        code: '01',
+        description: 'Tube'
+      }
+    }
+  end
+
   def reference_number
     {
       code: 'IK',
@@ -65,6 +105,8 @@ module ShippingOptions
       invoice_number: '#P-1234',
       invoice_date: '20170816',
       reason_for_export: '',
+      terms_of_shipment: 'DDP',
+      declaration_statement: 'U.S Customs (Freeform text)',
       currency_code: 'USD',
       discount: '1',
       freight_charge: '1',

data/spec/support/xsd_validator.rb

@@ -2,7 +2,7 @@ require 'minitest/assertions'
 
 module Minitest::Assertions
   def assert_passes_validation(schema_path, xml_to_validate)
-    schema = Nokogiri::XML::Schema(File.read(schema_path))
+    schema = Nokogiri::XML::Schema(File.open(schema_path))
     document = Nokogiri::XML::Document.parse(xml_to_validate)
     schema.validate(document)
   end

data/spec/ups/builders/organisation_builder_spec.rb

@@ -18,4 +18,55 @@ describe UPS::Builders::OrganisationBuilder do
       subject.opts[:skip_ireland_state_validation].must_equal false
     end
   end
+
+  describe "#to_xml" do
+    let(:ioss_id) { 'IOSS32341313' }
+    let(:vat_id) { 'GB800909000' }
+
+    let(:address_hash) do
+      {
+        address_line_1: 'Googleplex',
+        address_line_2: '1600 Amphitheatre Parkway',
+        city: 'Mountain View',
+        state: 'California',
+        postal_code: '94043',
+        country: 'US',
+      }
+    end
+
+    let(:organisation_hash) do
+      {
+        company_name: 'Company LTD',
+        phone_number: '07452444345',
+        attention_name: 'John Smith',
+        sender_vat_number: vat_id,
+        sender_ioss_number: ioss_id,
+        email_address: 'john.smith@company.com',
+      }
+    end
+
+    let(:opts) { organisation_hash.merge(address_hash) }
+
+    subject { Ox.dump UPS::Builders::OrganisationBuilder.new('SoldTo', opts).to_xml }
+
+    it 'populates the xml with the correct elements' do
+      subject.must_include '<CompanyName>Company LTD</CompanyName>'
+      subject.must_include '<PhoneNumber>07452444345</PhoneNumber>'
+      subject.must_include '<AttentionName>John Smith</AttentionName>'
+      subject.must_include '<Address>'
+      subject.must_include '<TaxIdentificationNumber>GB800909000</TaxIdentificationNumber>'
+      subject.must_include '<EMailAddress>john.smith@company.com</EMailAddress>'
+      subject.must_include '<VendorCollectIDNumber>IOSS32341313</VendorCollectIDNumber>'
+      subject.must_include '<VendorCollectIDTypeCode>0356</VendorCollectIDTypeCode>'
+    end
+
+    describe 'when there is no IOSS id' do
+      let(:ioss_id) { nil }
+
+      it 'does not send the VendorInfo element at all' do
+        subject.wont_include '<VendorInfo>'
+        subject.wont_include '<VendorCollectIDNumber>IOSS32341313</VendorCollectIDNumber>'
+      end
+    end
+  end
 end

data/spec/ups/builders/rate_builder_spec.rb

@@ -13,6 +13,7 @@ class UPS::Builders::TestRateBuilder < Minitest::Test
       builder.add_package package
       builder.add_insurance_charge '5.00'
       builder.add_shipment_delivery_confirmation '2'
+      builder.add_shipment_direct_delivery_only
     end
   end
 

data/spec/ups/builders/ship_confirm_builder_spec.rb

@@ -17,6 +17,8 @@ class UPS::Builders::TestShipConfirmBuilder < Minitest::Test
       builder.add_reference_number reference_number
       builder.add_insurance_charge '5.00'
       builder.add_shipment_delivery_confirmation '2'
+      builder.add_shipment_direct_delivery_only
+      builder.add_invoice_line_total('12', "GBP")
     end
   end
 

data/spec/ups/connection/rates_standard_spec.rb

@@ -14,6 +14,7 @@ describe UPS::Connection do
 
   let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
   let(:server) { UPS::Connection.new(test_mode: true) }
+  let(:supplied_package) { package }
 
   describe 'if requesting rates' do
     subject do
@@ -22,7 +23,7 @@ describe UPS::Connection do
         rate_builder.add_shipper shipper
         rate_builder.add_ship_from shipper
         rate_builder.add_ship_to ship_to
-        rate_builder.add_package package
+        rate_builder.add_package supplied_package
       end
     end
 
@@ -96,6 +97,98 @@ describe UPS::Connection do
       end
     end
 
+    describe 'when ups packaging type is specified' do
+      let(:supplied_package) { package_with_carrier_packaging }
+
+      before do
+        Excon.stub(method: :post) do |params|
+          case params[:path]
+          when UPS::Connection::RATE_PATH
+            { body: File.read("#{stub_path}/rates_success_with_packaging_type.xml"), status: 200 }
+          end
+        end
+      end
+
+      it 'returns rates' do
+        expect(subject.rated_shipments).wont_be_empty
+          expect(subject.rated_shipments).must_equal [
+            {
+              service_code: '07',
+              service_name: 'Express',
+              warnings: [
+                ' The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using the weight. ',
+                ' Your invoice may vary from the displayed reference rates '
+              ],
+              total: '171.04'
+            },
+            {
+              service_code: '65',
+              service_name: 'Express Saver',
+              warnings: [
+                ' The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using the weight. ',
+                ' Your invoice may vary from the displayed reference rates '
+              ],
+              total: '160.76'
+            },
+            {
+              service_code: '54',
+              service_name: 'Express Plus',
+              warnings: [
+                ' The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using the weight. ',
+                ' Your invoice may vary from the displayed reference rates '
+              ],
+              total: '226.89'
+            }
+          ]
+      end
+    end
+
+    describe 'when both ups packaging type and dimensions are specified' do
+      let(:supplied_package) { package_with_carrier_packaging }
+
+      before do
+        Excon.stub(method: :post) do |params|
+          case params[:path]
+          when UPS::Connection::RATE_PATH
+            { body: File.read("#{stub_path}/rates_success_with_packaging_type_and_dimensions.xml"), status: 200 }
+          end
+        end
+      end
+
+      it 'returns rates' do
+        expect(subject.rated_shipments).wont_be_empty
+          expect(subject.rated_shipments).must_equal [
+            {
+              service_code: '07',
+              service_name: 'Express',
+              warnings: [
+                ' The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using the weight. ',
+                ' Your invoice may vary from the displayed reference rates '
+              ],
+              total: '170.27'
+            },
+            {
+              service_code: '65',
+              service_name: 'Express Saver',
+              warnings: [
+                ' The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using the weight. ',
+                ' Your invoice may vary from the displayed reference rates '
+              ],
+              total: '160.76'
+            },
+            {
+              service_code: '54',
+              service_name: 'Express Plus',
+              warnings: [
+                ' The weight exceeds the limit for the UPS Letter/Envelope rate and will be rated using the weight. ',
+                ' Your invoice may vary from the displayed reference rates '
+              ],
+              total: '226.89'
+            }
+          ]
+      end
+    end
+
     describe 'error rates response' do
       describe 'with single error response' do
         before do

data/spec/ups/connection/ship_spec.rb

@@ -15,6 +15,7 @@ describe UPS::Connection do
 
   let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
   let(:server) { UPS::Connection.new(test_mode: true) }
+  let(:ship_accept_stub_file) { 'ship_accept_success' }
 
   describe 'if requesting a shipment' do
     describe 'single package shipment' do
@@ -27,7 +28,7 @@ describe UPS::Connection do
             }
           when UPS::Connection::SHIP_ACCEPT_PATH
             {
-              body: File.read("#{stub_path}/ship_accept_success.xml"), status: 200
+              body: File.read("#{stub_path}/#{ship_accept_stub_file}.xml"), status: 200
             }
           end
         end
@@ -80,6 +81,59 @@ describe UPS::Connection do
       it 'should return the tracking number' do
         subject.tracking_number.must_equal '1Z2220060292353829'
       end
+
+      describe 'total shipment cost' do
+        describe 'with negotiated rates' do
+          it 'returns the total shipment cost' do
+            subject.total_charge.must_equal 115.14
+            subject.currency_code.must_equal 'USD'
+          end
+        end 
+
+        describe 'without negotiated rates' do
+          let(:ship_accept_stub_file) { 'ship_accept_success_without_negotiated_price' }
+
+          it 'returns the total shipment cost' do
+            subject.total_charge.must_equal 118.48
+            subject.currency_code.must_equal 'USD'
+          end
+        end
+      end
+    end
+
+    describe 'when packaging type is specified' do
+      before do
+        Excon.stub(method: :post) do |params|
+          case params[:path]
+          when UPS::Connection::SHIP_CONFIRM_PATH
+            {
+              body: File.read("#{stub_path}/ship_confirm_success_with_packaging_type.xml"), status: 200
+            }
+          when UPS::Connection::SHIP_ACCEPT_PATH
+            {
+              body: File.read("#{stub_path}/ship_accept_success_with_packaging_type.xml"), status: 200
+            }
+          end
+        end
+      end
+
+      subject do
+        server.ship do |shipment_builder|
+          shipment_builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+          shipment_builder.add_shipper shipper
+          shipment_builder.add_ship_from shipper
+          shipment_builder.add_ship_to ship_to
+          shipment_builder.add_package package_with_carrier_packaging_and_dimensions
+          shipment_builder.add_payment_information ENV['UPS_ACCOUNT_NUMBER']
+          shipment_builder.add_service '07'
+        end
+      end
+
+      let(:supplied_package) { package_with_carrier_packaging }
+
+      it 'should return the tracking number' do
+        subject.tracking_number.must_equal '1Z2R466A6790676189'
+      end
     end
 
     describe 'multi package shipment' do

data/spec/ups/connection/track_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'support/shipping_options'
+
+describe UPS::Connection do
+  include ShippingOptions
+
+  before do
+    Excon.defaults[:mock] = true
+  end
+
+  after do
+    Excon.stubs.clear
+  end
+
+  let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
+  let(:server) { UPS::Connection.new(test_mode: true) }
+  let(:supplied_package) { package }
+
+  describe 'if tracking shipment' do
+    subject do
+      server.track do |track_builder|
+        track_builder.add_access_request ENV['UPS_LICENSE_NUMBER'], ENV['UPS_USER_ID'], ENV['UPS_PASSWORD']
+        track_builder.add_tracking_number '1Z12345E6692804405'
+      end
+    end
+
+    describe 'successful track response' do
+      before do
+        Excon.stub(method: :post) do |params|
+          case params[:path]
+          when UPS::Connection::TRACK_PATH
+            { body: File.read("#{stub_path}/track_success.xml"), status: 200 }
+          end
+        end
+      end
+
+      it 'returns the tracking status' do
+        expect(subject.to_h).wont_be_empty
+        expect(subject.to_h).must_equal(
+          status_date: Date.parse('2010-06-10'),
+          status_type_description: 'DELIVERED',
+          status_type_code: 'D'
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ups-ruby
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.23.0
 platform: ruby
 authors:
 - Veeqo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -101,10 +101,12 @@ files:
 - lib/ups/builders/international_invoice_builder.rb
 - lib/ups/builders/international_invoice_product_builder.rb
 - lib/ups/builders/organisation_builder.rb
+- lib/ups/builders/package_builder.rb
 - lib/ups/builders/rate_builder.rb
 - lib/ups/builders/ship_accept_builder.rb
 - lib/ups/builders/ship_confirm_builder.rb
 - lib/ups/builders/shipper_builder.rb
+- lib/ups/builders/track_builder.rb
 - lib/ups/connection.rb
 - lib/ups/data.rb
 - lib/ups/data/canadian_states.rb
@@ -119,6 +121,7 @@ files:
 - lib/ups/parsers/rates_parser.rb
 - lib/ups/parsers/ship_accept_parser.rb
 - lib/ups/parsers/ship_confirm_parser.rb
+- lib/ups/parsers/track_parser.rb
 - lib/ups/services.rb
 - lib/ups/utils.rb
 - lib/ups/version.rb
@@ -130,10 +133,18 @@ files:
 - spec/stubs/rates_negotiated_success.xml
 - spec/stubs/rates_success.xml
 - spec/stubs/rates_success_single_rate.xml
+- spec/stubs/rates_success_with_packaging_type.xml
+- spec/stubs/rates_success_with_packaging_type_and_dimensions.xml
 - spec/stubs/ship_accept_failure.xml
 - spec/stubs/ship_accept_success.xml
+- spec/stubs/ship_accept_success_with_packaging_type.xml
+- spec/stubs/ship_accept_success_without_negotiated_price.xml
 - spec/stubs/ship_confirm_failure.xml
 - spec/stubs/ship_confirm_success.xml
+- spec/stubs/ship_confirm_success_with_packaging_type.xml
+- spec/stubs/track_success.xml
+- spec/support/AccessRequest.xsd
+- spec/support/IF.xsd
 - spec/support/RateRequest.xsd
 - spec/support/ShipAcceptRequest.xsd
 - spec/support/ShipConfirmRequest.xsd
@@ -148,6 +159,7 @@ files:
 - spec/ups/connection/rates_negotiated_spec.rb
 - spec/ups/connection/rates_standard_spec.rb
 - spec/ups/connection/ship_spec.rb
+- spec/ups/connection/track_spec.rb
 - spec/ups/connection_spec.rb
 - ups.gemspec
 homepage: https://github.com/veeqo/ups-ruby
@@ -169,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: UPS