ups-ruby 0.14.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fc9c4d705a7e2b8af7c6cac249f53e6907a91937c1a48beaa3304e1c39577c
-  data.tar.gz: 20f50696539dcedf51233307ce029612a6087b61b4151146a1cc4be81c2f3cae
+  metadata.gz: 2a1733aa1ac4da9f295b01e07f0041d3de24a69df86e376a6e36f4bbd4114a45
+  data.tar.gz: 60cd995558755b4ae0a1cd5764d17f57502be21734fdbdd4ec81d353aab413b0
 SHA512:
-  metadata.gz: 441652f86d95832337057fda51f3cf13ae8d2b24dc4fa58eb5f7f15b332cbd312c033c3bbe2836e2f6f36a83f02703c1585c8436e8aca3806a0e93323520bd1c
-  data.tar.gz: 5d9e1509a67f97a54e1cb6e1363f1739945566c97d104b89fbbde30520110376c2c6d094fba614a43f6a8ef5ade6640ebe3c42d8e158fb011626287f392eecce
+  metadata.gz: 1a3e526f3189c142034e65f789cace831865e2f6acc7d43b4e2d3292b859d45f833bef80f3143246d6795914b876175b6dcddfd1b83f08e4b594f3d1103f663c
+  data.tar.gz: e4a123acb383f2ead01ed9a2a874a8570243bf8c14176348aeacb820a1a5d9c6a5c60d2f8de09e6b90f22654488cbf2014139b2bb660ab7ac111a246e1cf46cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ups-ruby (0.14.1)
+    ups-ruby (0.23.0)
       excon (~> 0.45, >= 0.45.3)
       insensitive_hash (~> 0.3.3)
       levenshtein-ffi (~> 1.1)
@@ -13,8 +13,8 @@ GEM
     codeclimate-test-reporter (1.0.5)
       simplecov
     docile (1.1.5)
-    excon (0.69.1)
-    ffi (1.11.3)
+    excon (0.83.0)
+    ffi (1.15.3)
     insensitive_hash (0.3.3)
     json (1.8.6)
     levenshtein-ffi (1.1.0)
@@ -23,7 +23,7 @@ GEM
     minitest (5.7.0)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
-    ox (2.11.0)
+    ox (2.14.5)
     rake (12.0.0)
     simplecov (0.10.0)
       docile (~> 1.1.0)

data/lib/ups/builders/builder_base.rb

@@ -69,10 +69,14 @@ module UPS
       # @param [String] action The UPS API Action requested
       # @param [String] option The UPS API Option
       # @return [void]
-      def add_request(action, option)
+      def add_request(action, option, sub_version: nil)
         root << Element.new('Request').tap do |request|
           request << element_with_value('RequestAction', action)
           request << element_with_value('RequestOption', option)
+
+          unless sub_version.nil?
+            request << element_with_value('SubVersion', sub_version)
+          end
         end
       end
 
@@ -143,12 +147,7 @@ module UPS
       # @param [Hash] opts A Hash of data to build the requested section
       # @return [void]
       def add_package(opts = {})
-        shipment_root << Element.new('Package').tap do |org|
-          org << packaging_type
-          org << element_with_value('Description', 'Rate')
-          org << package_weight(opts[:weight], opts[:unit])
-          org << package_dimensions(opts[:dimensions]) if opts[:dimensions]
-        end
+        shipment_root << PackageBuilder.new('Package', opts).to_xml
       end
 
       # Adds a PaymentInformation section to the XML document being built
@@ -165,6 +164,12 @@ module UPS
         end
       end
 
+      def add_itemized_payment_information(ship_number)
+        shipment_charge << Element.new('BillShipper').tap do |bill_shipper|
+          bill_shipper << element_with_value('AccountNumber', ship_number)
+        end
+      end
+
       # Adds a RateInformation/NegotiatedRatesIndicator section to the XML
       # document being built
       #
@@ -186,6 +191,27 @@ module UPS
           end
       end
 
+      # Adds Direct Delivery Only indicator to the shipment service options
+      #
+      # @return [void]
+      def add_shipment_direct_delivery_only
+        shipment_service_options << Element.new('DirectDeliveryOnlyIndicator')
+      end
+
+      # Adds MasterCartonIndicator to the shipment
+      #
+      # @return [void]
+      def add_master_carton_indicator
+        shipment_root << Element.new('MasterCartonIndicator')
+      end
+
+      # Adds MasterCartonID to the shipment
+      #
+      # @return [void]
+      def add_master_carton_id(master_carton_id)
+        shipment_root << element_with_value('MasterCartonID', master_carton_id)
+      end
+
       # Returns a String representation of the XML document being built
       #
       # @return [String]
@@ -211,23 +237,11 @@ module UPS
         end
       end
 
-      def packaging_type
-        code_description 'PackagingType', '02', 'Customer Supplied'
-      end
-
-      def package_weight(weight, unit)
-        Element.new('PackageWeight').tap do |org|
-          org << unit_of_measurement(unit)
-          org << element_with_value('Weight', weight)
-        end
-      end
-
-      def package_dimensions(dimensions)
-        Element.new('Dimensions').tap do |org|
-          org << unit_of_measurement(dimensions[:unit])
-          org << element_with_value('Length', dimensions[:length].to_s[0..8])
-          org << element_with_value('Width', dimensions[:width].to_s[0..8])
-          org << element_with_value('Height', dimensions[:height].to_s[0..8])
+      def shipment_charge
+        @shipment_charge ||= begin
+          element = Element.new('ShipmentCharge')
+          shipment_root << (Element.new('ItemizedPaymentInformation') << element)
+          element
         end
       end
 

data/lib/ups/builders/international_invoice_builder.rb

@@ -23,13 +23,21 @@ module UPS
       end
 
       def invoice_number
-        element_with_value('InvoiceNumber', opts[:invoice_number]) if opts[:invoice_number]
+        element_with_value('InvoiceNumber', opts[:invoice_number])
       end
 
       def invoice_date
         element_with_value('InvoiceDate', opts[:invoice_date])
       end
 
+      def terms_of_shipment
+        element_with_value('TermsOfShipment', opts[:terms_of_shipment])
+      end
+
+      def declaration_statement
+        element_with_value('DeclarationStatement', opts[:declaration_statement])
+      end    
+
       def reason_for_export
         element_with_value('ReasonForExport', opts[:reason_for_export])
       end
@@ -62,8 +70,10 @@ module UPS
       def to_xml
         Element.new(name).tap do |international_form|
           international_form << form_type
-          international_form << invoice_number
+          international_form << invoice_number if opts[:invoice_number]
           international_form << invoice_date
+          international_form << terms_of_shipment if opts[:terms_of_shipment]
+          international_form << declaration_statement if opts[:declaration_statement]
           international_form << reason_for_export
           international_form << currency_code
           international_form << freight_charge

data/lib/ups/builders/organisation_builder.rb

@@ -58,6 +58,13 @@ module UPS
         element_with_value('TaxIdentificationNumber', opts[:sender_vat_number] || '')
       end
 
+      # Returns an XML representation of the email address of the company
+      #
+      # @return [Ox::Element] XML representation of email address
+      def email_address
+        element_with_value('EMailAddress', opts[:email_address].to_s[0..50])
+      end
+
       # Returns an XML representation of address
       #
       # @return [Ox::Element] An instance of {AddressBuilder} containing the
@@ -66,6 +73,19 @@ module UPS
         AddressBuilder.new(opts).to_xml
       end
 
+      # Returns an XML representation of vendor info (ioss number and more) of the company
+      #
+      # @return [Ox::Element] XML representation of sender_ioss_number
+      def vendor_info
+        ioss_vendor_collect_id = '0356'
+
+        Element.new('VendorInfo').tap do |vendor_info|
+          vendor_info << element_with_value('VendorCollectIDNumber', opts[:sender_ioss_number] || '')
+          vendor_info << element_with_value('VendorCollectIDTypeCode', ioss_vendor_collect_id)
+          vendor_info << element_with_value('ConsigneeType', '02')
+        end
+      end
+
       # Returns an XML representation of a UPS Organization
       #
       # @return [Ox::Element] XML representation of the current object
@@ -76,6 +96,8 @@ module UPS
           org << attention_name
           org << address
           org << tax_identification_number
+          org << email_address
+          org << vendor_info unless opts[:sender_ioss_number].to_s.empty?
         end
       end
     end

data/lib/ups/builders/package_builder.rb

@@ -0,0 +1,69 @@
+require 'ox'
+
+module UPS
+  module Builders
+    class PackageBuilder < BuilderBase
+      include Ox
+
+      attr_accessor :name, :opts
+
+      def initialize(name, opts = {})
+        self.name = name
+        self.opts = opts
+      end
+
+      def packaging_type(packaging_options_hash)
+        code_description 'PackagingType', packaging_options_hash[:code], packaging_options_hash[:description]
+      end
+
+      def reference_number
+        Element.new('ReferenceNumber').tap do |org|
+          org << element_with_value('Code', opts[:reference_number][:type]) if opts[:reference_number][:type]
+          org << element_with_value('Value', opts[:reference_number][:value])
+        end
+      end
+
+      def reference_number_2
+        Element.new('ReferenceNumber').tap do |org|
+          org << element_with_value('Code', opts[:reference_number_2][:type]) if opts[:reference_number_2][:type]
+          org << element_with_value('Value', opts[:reference_number_2][:value])
+        end
+      end
+
+      def description
+        element_with_value('Description', 'Rate')
+      end
+
+      def package_weight(weight, unit)
+        Element.new('PackageWeight').tap do |org|
+          org << unit_of_measurement(unit)
+          org << element_with_value('Weight', weight)
+        end
+      end
+
+      def customer_supplied_packaging
+        { code: '02', description: 'Customer Supplied Package' }
+      end
+
+      def package_dimensions(dimensions)
+        Element.new('Dimensions').tap do |org|
+          org << unit_of_measurement(dimensions[:unit])
+          org << element_with_value('Length', dimensions[:length].to_s[0..8])
+          org << element_with_value('Width', dimensions[:width].to_s[0..8])
+          org << element_with_value('Height', dimensions[:height].to_s[0..8])
+        end
+      end
+
+      def to_xml
+        Element.new(name).tap do |product|
+          product << reference_number if opts[:reference_number]
+          product << reference_number_2 if opts[:reference_number_2]
+          product << packaging_type(opts[:packaging_type] || customer_supplied_packaging)
+          product << description
+          product << package_weight(opts[:weight], opts[:unit])
+          product << package_dimensions(opts[:dimensions]) if opts[:dimensions]
+        end
+      end
+    end
+  end
+end

data/lib/ups/builders/ship_confirm_builder.rb

@@ -16,7 +16,7 @@ module UPS
       def initialize
         super 'ShipmentConfirmRequest'
 
-        add_request 'ShipConfirm', 'validate'
+        add_request 'ShipConfirm', 'validate', sub_version: '1807'
       end
 
       # Adds a LabelSpecification section to the XML document being built
@@ -54,6 +54,10 @@ module UPS
                                           service_description)
       end
 
+      def add_invoice_line_total(value, currency_code)
+        shipment_root << invoice_line_total(value, currency_code)
+      end
+
       # Adds Description to XML document being built
       #
       # @param [String] description The description for goods being sent
@@ -74,6 +78,31 @@ module UPS
         shipment_root << reference_number(opts[:code], opts[:value])
       end
 
+      def update_and_validate_for_worldwide_economy!
+        shipment_charge << element_with_value('Type', '01')
+
+        packages = document.locate('ShipmentConfirmRequest/Shipment/Package')
+
+        bill_shipper_account_number = document.locate(
+          'ShipmentConfirmRequest/Shipment/ItemizedPaymentInformation/ShipmentCharge/BillShipper/AccountNumber/*'
+        ).first
+
+        unless packages.count == 1
+          raise InvalidAttributeError,
+            'Worldwide Economy shipment must be single-piece'
+        end
+
+        unless packages.first.locate('PackagingType/Code/*').first == '02'
+          raise InvalidAttributeError,
+            'Worldwide Economy shipment must use Customer Supplied Package'
+        end
+
+        unless bill_shipper_account_number.to_s.length > 0
+          raise InvalidAttributeError,
+            'Worldwide Economy shipment must have "Bill Shipper" Itemized Payment Information'
+        end
+      end
+
       private
 
       def gif?(string)
@@ -107,6 +136,16 @@ module UPS
                      'Code' => code.to_s,
                      'Value' => value.to_s)
       end
+
+      def invoice_line_total(value, currency_code)
+        multi_valued('InvoiceLineTotal',
+                     'CurrencyCode' => currency_code.to_s,
+                     'MonetaryValue' => value.to_s)
+      end
+
+      def service_code
+        document.locate('ShipmentConfirmRequest/Shipment/Service/Code/*').first
+      end
     end
   end
 end

data/lib/ups/builders/track_builder.rb

@@ -0,0 +1,37 @@
+require 'ox'
+
+module UPS
+  module Builders
+    # The {TrackBuilder} class builds UPS XML Track Objects.
+    #
+    # @author Stephan van Diepen
+    # @since 0.17.1
+    class TrackBuilder < BuilderBase
+      include Ox
+
+      # Initializes a new {TrackBuilder} object
+      #
+      def initialize
+        super 'TrackRequest'
+      end
+
+      # Adds an TrackingNumber to the XML document being built
+      # according to user inputs
+      #
+      # @return [void]
+      def add_tracking_number(number)
+        root << element_with_value('TrackingNumber', number)
+      end
+
+      # Adds an OptionCode to the XML document being built
+      # according to user inputs
+      #
+      # @return [void]
+      def add_option_code(option_code)
+        root << Element.new('Request').tap do |request|
+          request << element_with_value('RequestOption', option_code)
+        end
+      end
+    end
+  end
+end

data/lib/ups/connection.rb

@@ -21,6 +21,7 @@ module UPS
     SHIP_CONFIRM_PATH = '/ups.app/xml/ShipConfirm'
     SHIP_ACCEPT_PATH = '/ups.app/xml/ShipAccept'
     ADDRESS_PATH = '/ups.app/xml/XAV'
+    TRACK_PATH = '/ups.app/xml/Track'
 
     DEFAULT_PARAMS = {
       test_mode: false
@@ -79,6 +80,27 @@ module UPS
       make_accept_request(accept_builder)
     end
 
+    # Makes a request to Track the status for a shipment.
+    #
+    # A pre-configured {Builders::TrackBuilder} object can be passed as the first
+    # option or a block yielded to configure a new {Builders::TrackBuilder}
+    # object.
+    #
+    # @param [Builders::TrackBuilder] track_builder A pre-configured
+    #   {Builders::TrackBuilder} object to use
+    # @yield [track_builder] A TrackBuilder object for configuring
+    #   the shipment information sent
+    def track(track_builder = nil)
+      if track_builder.nil? && block_given?
+        track_builder = UPS::Builders::TrackBuilder.new
+        yield track_builder
+      end
+
+      response = get_response(TRACK_PATH, track_builder.to_xml)
+
+      UPS::Parsers::TrackParser.new(response.body)
+    end
+
     private
 
     def build_url(path)

data/lib/ups/parsers/ship_accept_parser.rb

@@ -42,8 +42,34 @@ module UPS
         [UPS::Models::PackageResult.new(package_results)]
       end
 
+      def master_carton_id
+        shipment_results[:MasterCartonID]
+      end
+
+      def total_charge
+        return shipment_charge unless negotiated_rate
+
+        negotiated_rate
+      end
+
+      def negotiated_rate
+        negotiated_rate_response && negotiated_rate_response[:NetSummaryCharges][:GrandTotal][:MonetaryValue].to_f
+      end
+
+      def currency_code
+        shipment_results[:ShipmentCharges][:TotalCharges][:CurrencyCode]
+      end
+
       private
 
+      def negotiated_rate_response
+        shipment_results[:NegotiatedRates]
+      end
+
+      def shipment_charge
+        shipment_results[:ShipmentCharges][:TotalCharges][:MonetaryValue].to_f
+      end
+
       def form_graphic
         shipment_results[:Form]
       end