ups-ruby 0.9.6 → 0.11.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae8eb61dda03ca960a88a1214bc5c6abe98a6efb
-  data.tar.gz: 5a99fe38d9629c931c8a321c163c0318a2500ad4
+SHA256:
+  metadata.gz: ce31214234663e90d8d7ce00b51e518ce19e65cd6accc3b340b63f77b57c00a4
+  data.tar.gz: 0aaca2ab7195698e301cdfd5090de7eac7bde4da97121e7a862b18b44093da78
 SHA512:
-  metadata.gz: ac5aaa642c66ace7d48869bd03e1db9140c7ab0af1480e9a734f8237ecd84558395d98d4b18396d8a6c22033e9309f4df3abc530f027405604e0155d404f4ca9
-  data.tar.gz: eeb86df6170b12351baaaaa637f7e0e75d726cef2fbed025aa181b4b714c9d68463906d48ff3fd40d49597c6b7681520f182faddf603b6ab6e0c2d12c43a83ec
+  metadata.gz: 499730f5860fd137c4bc58e34b4411e0b07573262532acdd8abf20b1495490a05aa1eebe74192b021550fb2094aabcade89664e1e50d98ff4a0480e74c5873c0
+  data.tar.gz: 53f17acb18c5476a36b83a799b3599501ed1c56aa12178d9ec477ee448b948dd6fe833cec37258be4072b336a44f2a0fd3451ebfc93543f4826c7bc6454569d1

data/.travis.yml

@@ -1,8 +1,8 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.6
-  - 2.2.2
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
   - ruby-head
 cache: bundler
 matrix:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ups-ruby (0.9.6)
+    ups-ruby (0.11.8)
       excon (~> 0.45, >= 0.45.3)
       insensitive_hash (~> 0.3.3)
       levenshtein-ffi (~> 1.1)
@@ -13,17 +13,17 @@ GEM
     codeclimate-test-reporter (1.0.5)
       simplecov
     docile (1.1.5)
-    excon (0.59.0)
-    ffi (1.9.18)
+    excon (0.68.0)
+    ffi (1.11.1)
     insensitive_hash (0.3.3)
-    json (1.8.3)
+    json (1.8.6)
     levenshtein-ffi (1.1.0)
       ffi (~> 1.9)
-    mini_portile (0.6.2)
+    mini_portile2 (2.4.0)
     minitest (5.7.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    ox (2.6.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    ox (2.11.0)
     rake (12.0.0)
     simplecov (0.10.0)
       docile (~> 1.1.0)
@@ -41,6 +41,3 @@ DEPENDENCIES
   rake
   simplecov
   ups-ruby!
-
-BUNDLED WITH
-   1.15.4

data/README.md

@@ -60,7 +60,7 @@ end
 ```ruby
 require 'ups-ruby'
 server = UPS::Connection.new(test_mode: true)
-ship_response = server.ship do |shipment_builder|
+response = server.ship do |shipment_builder|
   shipment_builder.add_access_request 'API_KEY', 'USERNAME', 'PASSWORD'
   shipment_builder.add_shipper company_name: 'Veeqo Limited',
     phone_number: '01792 123456',
@@ -110,7 +110,7 @@ response.tracking_number
 ```ruby
 require 'ups-ruby'
 server = UPS::Connection.new(test_mode: true)
-ship_response = server.ship do |shipment_builder|
+response = server.ship do |shipment_builder|
   shipment_builder.add_access_request 'API_KEY', 'USERNAME', 'PASSWORD'
   shipment_builder.add_shipper company_name: 'Veeqo Limited',
     phone_number: '01792 123456',

data/lib/ups.rb

@@ -6,6 +6,8 @@ module UPS
   autoload :Connection,            'ups/connection'
   autoload :Exceptions,            'ups/exceptions'
 
+  autoload :Utils,                 'ups/utils'
+
   autoload :Data,                  'ups/data'
   module Data
     autoload :US_STATES,           'ups/data/us_states'
@@ -14,9 +16,15 @@ module UPS
     autoload :IE_COUNTY_PREFIXES,  'ups/data/ie_county_prefixes'
   end
 
+  module Models
+    autoload :PackageResult,       'ups/models/package_result'
+  end
+
   module Parsers
+    autoload :BaseParser,          'ups/parsers/base_parser'
     autoload :ParserBase,          'ups/parsers/parser_base'
     autoload :RatesParser,         'ups/parsers/rates_parser'
+    autoload :RateParser,          'ups/parsers/rate_parser'
     autoload :ShipConfirmParser,   'ups/parsers/ship_confirm_parser'
     autoload :ShipAcceptParser,    'ups/parsers/ship_accept_parser'
   end

data/lib/ups/builders/address_builder.rb

@@ -34,15 +34,19 @@ module UPS
       # @return [void]
       def validate
         opts[:state] = case opts[:country].downcase
-                       when 'us'
-                         normalize_us_state(opts[:state])
-                       when 'ca'
-                         normalize_ca_state(opts[:state])
-                       when 'ie'
-                         UPS::Data.ie_state_matcher(opts[:state])
-                       else
-                         ''
-                       end
+        when 'us'
+          normalize_us_state(opts[:state])
+        when 'ca'
+          normalize_ca_state(opts[:state])
+        when 'ie'
+          if opts[:skip_ireland_state_validation]
+            '_' # UPS requires at least one character for Ireland
+          else
+            UPS::Data.ie_state_matcher(opts[:state])
+          end
+        else
+          ''
+        end
       end
 
       # Changes :state based on UPS requirements for US Addresses

data/lib/ups/builders/organisation_builder.rb

@@ -26,6 +26,7 @@ module UPS
       def initialize(name, opts = {})
         self.name = name
         self.opts = opts
+        self.opts[:skip_ireland_state_validation] = (name == 'SoldTo')
       end
 
       # Returns an XML representation of company_name

data/lib/ups/connection.rb

@@ -52,10 +52,8 @@ module UPS
         yield rate_builder
       end
 
-      response = get_response_stream RATE_PATH, rate_builder.to_xml
-      UPS::Parsers::RatesParser.new.tap do |parser|
-        Ox.sax_parse(parser, response)
-      end
+      response = get_response(RATE_PATH, rate_builder.to_xml)
+      UPS::Parsers::RatesParser.new(response.body)
     end
 
     # Makes a request to ship a package
@@ -77,9 +75,8 @@ module UPS
       confirm_response = make_confirm_request(confirm_builder)
       return confirm_response unless confirm_response.success?
 
-      accept_builder = build_accept_request_from_confirm(confirm_builder,
-                                                         confirm_response)
-      make_accept_request accept_builder
+      accept_builder = build_accept_request_from_confirm(confirm_builder, confirm_response)
+      make_accept_request(accept_builder)
     end
 
     private
@@ -88,28 +85,21 @@ module UPS
       "#{url}#{path}"
     end
 
-    def get_response_stream(path, body)
-      response = Excon.post(build_url(path), body: body)
-      StringIO.new(response.body)
+    def get_response(path, body)
+      Excon.post(build_url(path), body: body)
     end
 
     def make_confirm_request(confirm_builder)
-      make_ship_request confirm_builder,
-                        SHIP_CONFIRM_PATH,
-                        Parsers::ShipConfirmParser.new
+      make_ship_request(confirm_builder, SHIP_CONFIRM_PATH, Parsers::ShipConfirmParser)
     end
 
     def make_accept_request(accept_builder)
-      make_ship_request accept_builder,
-                        SHIP_ACCEPT_PATH,
-                        Parsers::ShipAcceptParser.new
+      make_ship_request(accept_builder, SHIP_ACCEPT_PATH, Parsers::ShipAcceptParser)
     end
 
     def make_ship_request(builder, path, ship_parser)
-      response = get_response_stream path, builder.to_xml
-      ship_parser.tap do |parser|
-        Ox.sax_parse(parser, response)
-      end
+      response = get_response(path, builder.to_xml)
+      ship_parser.new(response.body)
     end
 
     def build_accept_request_from_confirm(confirm_builder, confirm_response)

data/lib/ups/models/package_result.rb

@@ -0,0 +1,27 @@
+module UPS
+  module Models
+    class PackageResult
+      attr_reader :package_result
+
+      def initialize(package_result)
+        @package_result = package_result
+      end
+
+      def tracking_number
+        package_result[:TrackingNumber]
+      end
+
+      def label_graphic_extension
+        ".#{package_result[:LabelImage][:LabelImageFormat][:Code].downcase}"
+      end
+
+      def label_graphic_image
+        Utils.base64_to_file(package_result[:LabelImage][:GraphicImage], label_graphic_extension)
+      end
+
+      def label_html_image
+        Utils.base64_to_file(package_result[:LabelImage][:HTMLImage], label_graphic_extension)
+      end
+    end
+  end
+end

data/lib/ups/parsers/base_parser.rb

@@ -0,0 +1,50 @@
+require 'uri'
+require 'ox'
+
+module UPS
+  module Parsers
+    class BaseParser
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def success?
+        status_code == '1'
+      end
+
+      def status_code
+        root_response[:Response][:ResponseStatusCode]
+      end
+
+      def status_description
+        root_response[:Response][:ResponseStatusDescription]
+      end
+
+      def error_description
+        build_error_description(error_response)
+      end
+
+      def parsed_response
+        @parsed_response ||= Ox.load(response, mode: :hash)
+      end
+
+      private
+
+      def normalize_response_into_array(response_node)
+        [response_node].flatten
+      end
+
+      def build_error_description(errors_node)
+        return errors_node.last[:ErrorDescription] if errors_node.is_a?(Array)
+
+        errors_node[:ErrorDescription]
+      end
+
+      def error_response
+        root_response[:Response][:Error]
+      end
+    end
+  end
+end

data/lib/ups/parsers/rate_parser.rb

@@ -0,0 +1,59 @@
+require 'uri'
+require 'ox'
+
+module UPS
+  module Parsers
+    class RateParser
+      attr_reader :rate
+
+      def initialize(rate)
+        @rate = rate
+      end
+
+      def to_h
+        {
+          service_code: rate_service_code,
+          service_name: rate_service_name,
+          warnings:     rate_warnings,
+          total:        rate_total
+        }
+      end
+
+      def rate_service_name
+        UPS::SERVICES[rate_service_code]
+      end
+
+      def rate_service_code
+        rate_service[:Code]
+      end
+
+      private
+
+      def rate_total
+        return total_charges[:MonetaryValue] unless negotiated_rates
+
+        negotiated_rates[:NetSummaryCharges][:GrandTotal][:MonetaryValue]
+      end
+
+      def rate_warnings
+        rated_shipment_warning.is_a?(Array) ? rated_shipment_warning : [rated_shipment_warning]
+      end
+
+      def rate_service
+        rate[:Service]
+      end
+
+      def rated_shipment_warning
+        rate[:RatedShipmentWarning]
+      end
+
+      def total_charges
+        rate[:TotalCharges]
+      end
+
+      def negotiated_rates
+        rate[:NegotiatedRates]
+      end
+    end
+  end
+end

data/lib/ups/parsers/rates_parser.rb

@@ -1,59 +1,21 @@
 module UPS
   module Parsers
-    class RatesParser < ParserBase
-      attr_accessor :rated_shipments
+    class RatesParser < BaseParser
 
-      def initialize
-        super
-        self.rated_shipments = []
-        @current_rate = {}
-      end
-
-      def start_element(name)
-        super
-      end
-
-      def end_element(name)
-        super
-        return unless name == :RatedShipment
-        rated_shipments << @current_rate.tap do |c|
-          if c.key? :negotiated_rate
-            c[:total] = c[:negotiated_rate]
-            c.delete :negotiated_rate
-          end
-        end
-        @current_rate = {}
-      end
-
-      def value(value)
-        super
-        if switch_active?(:RatedShipment, :Service, :Code)
-          parse_service_code value
-        elsif switch_active?(:RatedShipment, :TotalCharges)
-          parse_total_charges value
-        elsif switch_active?(:RatedShipment, :NegotiatedRates, :MonetaryValue)
-          parse_negotiated_rate value
-        elsif switch_active?(:RatedShipment, :RatedShipmentWarning)
-          parse_rated_shipment_warning value
+      def rated_shipments
+        rates.map do |rated_shipment|
+          RateParser.new(rated_shipment).to_h
         end
       end
 
-      def parse_negotiated_rate(value)
-        @current_rate[:negotiated_rate] = value.as_s
-      end
-
-      def parse_rated_shipment_warning(value)
-        @current_rate[:warnings] ||= []
-        @current_rate[:warnings] << value.as_s
-      end
+      private
 
-      def parse_service_code(value)
-        @current_rate[:service_code] = value.as_s
-        @current_rate[:service_name] = UPS::SERVICES[value.as_s]
+      def rates
+        normalize_response_into_array(root_response[:RatedShipment])
       end
 
-      def parse_total_charges(value)
-        @current_rate[:total] = value.as_s
+      def root_response
+        parsed_response[:RatingServiceSelectionResponse]
       end
     end
   end

data/lib/ups/parsers/ship_accept_parser.rb

@@ -3,82 +3,65 @@ require 'tempfile'
 
 module UPS
   module Parsers
-    class ShipAcceptParser < ParserBase
-      attr_accessor :label_root_path,
-                    :form_root_path,
-                    :graphic_image,
-                    :graphic_extension,
-                    :html_image,
-                    :label_graphic_image,
-                    :label_graphic_extension,
-                    :label_html_image,
-                    :form_graphic_image,
-                    :form_graphic_extension,
-                    :tracking_number
-
-      def value(value)
-        initialize_document_root_paths
-
-        parse_document_data(value, 'label')
-        parse_document_data(value, 'form')
-        parse_tracking_number(value)
-
-        super
+    class ShipAcceptParser < BaseParser
+      def tracking_number
+        packages[0].tracking_number
       end
 
-      def initialize_document_root_paths
-        self.label_root_path = [:ShipmentResults, :PackageResults, :LabelImage]
-        self.form_root_path  = [:ShipmentResults, :Form, :Image]
+      def label_graphic_extension
+        packages[0].label_graphic_extension
       end
 
-      def parse_document_data(value, type)
-        root_path = self.send("#{type}_root_path")
+      def label_graphic_image
+        packages[0].label_graphic_image
+      end
+
+      def label_html_image
+        packages[0].label_html_image
+      end
+
+      alias_method :graphic_extension, :label_graphic_extension
+      alias_method :graphic_image, :label_graphic_image
+      alias_method :html_image, :label_html_image
 
-        parse_graphic_extension(root_path, value, type)
-        parse_graphic_image(root_path, value, type)
-        parse_html_image(root_path, value, type)
+      def form_graphic_extension
+        return unless has_form_graphic?
+
+        ".#{form_graphic[:Image][:ImageFormat][:Code].downcase}"
       end
 
-      def parse_graphic_image(root_path, value, type)
-        switch_path = build_switch_path(root_path, :GraphicImage)
-        return unless switch_active?(switch_path)
+      def form_graphic_image
+        return unless has_form_graphic?
 
-        self.send("#{type}_graphic_image=".to_sym, base64_to_file(value.as_s, type))
-        self.send("graphic_image=".to_sym, base64_to_file(value.as_s, type)) if type == 'label'
+        Utils.base64_to_file(form_graphic[:Image][:GraphicImage], form_graphic_extension)
       end
 
-      def parse_html_image(root_path, value, type)
-        switch_path = build_switch_path(root_path, :HTMLImage)
-        return unless switch_active?(switch_path)
+      def packages
+        return package_results.map { |package_result| UPS::Models::PackageResult.new(package_result) } if package_results.is_a?(Array)
 
-        self.send("#{type}_html_image=".to_sym, base64_to_file(value.as_s, type))
-        self.send("html_image=".to_sym, base64_to_file(value.as_s, type)) if type == 'label'
+        [UPS::Models::PackageResult.new(package_results)]
       end
 
-      def parse_graphic_extension(root_path, value, type)
-        graphic_extension_subpath = (type == 'label' ? :LabelImageFormat : :ImageFormat)
+      private
+
+      def form_graphic
+        shipment_results[:Form]
+      end
 
-        switch_path = build_switch_path(root_path, graphic_extension_subpath, :Code)
-        return unless switch_active?(switch_path)
+      def has_form_graphic?
+        shipment_results.key?(:Form)
+      end
 
-        self.send("#{type}_graphic_extension=".to_sym, ".#{value.as_s.downcase}")
-        self.send("graphic_extension=".to_sym, ".#{value.as_s.downcase}") if type == 'label'
+      def package_results
+        shipment_results[:PackageResults]
       end
 
-      def parse_tracking_number(value)
-        return unless switch_active?(:ShipmentIdentificationNumber)
-        self.tracking_number = value.as_s
+      def shipment_results
+        root_response[:ShipmentResults]
       end
 
-      def base64_to_file(contents, type)
-        file_config = ['ups', self.send("#{type}_graphic_extension".to_sym)]
-        Tempfile.new(file_config, nil, encoding: 'ascii-8bit').tap do |file|
-          begin
-            file.write Base64.decode64(contents)
-          ensure
-            file.rewind
-          end
-        end
+      def root_response
+        parsed_response[:ShipmentAcceptResponse]
       end
     end
   end