active_shipping 0.12.4 → 0.12.5

data/lib/active_shipping/shipping/carriers/usps.rb

@@ -3,7 +3,6 @@ require 'cgi'
 
 module ActiveMerchant
   module Shipping
-
     # After getting an API login from USPS (looks like '123YOURNAME456'),
     # run the following test:
     #
@@ -26,7 +25,7 @@ module ActiveMerchant
       LIVE_DOMAIN = 'production.shippingapis.com'
       LIVE_RESOURCE = 'ShippingAPI.dll'
 
-      TEST_DOMAINS = { #indexed by security; e.g. TEST_DOMAINS[USE_SSL[:rates]]
+      TEST_DOMAINS = { # indexed by security; e.g. TEST_DOMAINS[USE_SSL[:rates]]
         true => 'secure.shippingapis.com',
         false => 'testing.shippingapis.com'
       }
@@ -45,10 +44,23 @@ module ActiveMerchant
         :test => true,
         :track => false
       }
+
       CONTAINERS = {
-        :envelope => 'Flat Rate Envelope',
-        :box => 'Flat Rate Box'
+        rectangular: 'RECTANGULAR',
+        variable: 'VARIABLE',
+        box: 'FLAT RATE BOX',
+        box_large: 'LG FLAT RATE BOX',
+        box_medium: 'MD FLAT RATE BOX',
+        box_small: 'SM FLAT RATE BOX',
+        envelope: 'FLAT RATE ENVELOPE',
+        envelope_legal: 'LEGAL FLAT RATE ENVELOPE',
+        envelope_padded: 'PADDED FLAT RATE ENVELOPE',
+        envelope_gift_card: 'GIFT CARD FLAT RATE ENVELOPE',
+        envelope_window: 'WINDOW FLAT RATE ENVELOPE',
+        envelope_small: 'SM FLAT RATE ENVELOPE',
+        package_service: 'PACKAGE SERVICE'
       }
+
       MAIL_TYPES = {
         :package => 'Package',
         :postcard => 'Postcards or aerogrammes',
@@ -81,8 +93,25 @@ module ActiveMerchant
         :media => 'MEDIA',
         :library => 'LIBRARY',
         :online => 'ONLINE',
+        :plus => 'PLUS',
         :all => 'ALL'
       }
+      DEFAULT_SERVICE = Hash.new(:all).update(
+        :base => :online,
+        :plus => :plus
+      )
+      DOMESTIC_RATE_FIELD = Hash.new('Rate').update(
+        :base => 'CommercialRate',
+        :plus => 'CommercialPlusRate'
+      )
+      INTERNATIONAL_RATE_FIELD = Hash.new('Postage').update(
+        :base => 'CommercialPostage',
+        :plus => 'CommercialPlusPostage'
+      )
+      COMMERCIAL_FLAG_NAME = {
+        :base => 'CommercialFlag',
+        :plus => 'CommercialPlusFlag'
+      }
       FIRST_CLASS_MAIL_TYPES = {
         :letter => 'LETTER',
         :flat => 'FLAT',
@@ -92,7 +121,7 @@ module ActiveMerchant
       }
 
       # Array of U.S. possessions according to USPS: https://www.usps.com/ship/official-abbreviations.htm
-      US_POSSESSIONS = ["AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI"]
+      US_POSSESSIONS = %w(AS FM GU MH MP PW PR VI)
 
       # TODO: figure out how USPS likes to say "Ivory Coast"
       #
@@ -141,7 +170,12 @@ module ActiveMerchant
         /Delivery status information is not available/
       ]
 
-      def find_tracking_info(tracking_number, options={})
+      ESCAPING_AND_SYMBOLS = /<\S*>/
+      LEADING_USPS = /^USPS/
+      TRAILING_ASTERISKS = /\*+$/
+      SERVICE_NAME_SUBSTITUTIONS = /#{ESCAPING_AND_SYMBOLS}|#{LEADING_USPS}|#{TRAILING_ASTERISKS}/
+
+      def find_tracking_info(tracking_number, options = {})
         options = @options.update(options)
         tracking_request = build_tracking_request(tracking_number, options)
         response = commit(:track, tracking_request, (options[:test] || false))
@@ -160,7 +194,7 @@ module ActiveMerchant
       #
       # package.options[:books] -- 25 lb. limit instead of 35 for books or other printed matter.
       #                             Defaults to false.
-      def self.package_machinable?(package, options={})
+      def self.package_machinable?(package, options = {})
         at_least_minimum =  package.inches(:length) >= 6.0 &&
                             package.inches(:width) >= 3.0 &&
                             package.inches(:height) >= 0.25 &&
@@ -183,12 +217,8 @@ module ActiveMerchant
         destination = Location.from(destination)
         packages = Array(packages)
 
-        #raise ArgumentError.new("USPS packages must originate in the U.S.") unless ['US',nil].include?(origin.country_code(:alpha2))
-
-        # domestic or international?
-
         domestic_codes = US_POSSESSIONS + ['US', nil]
-        response = if domestic_codes.include?(destination.country_code(:alpha2))
+        if domestic_codes.include?(destination.country_code(:alpha2))
           us_rates(origin, destination, packages, options)
         else
           world_rates(origin, destination, packages, options)
@@ -205,7 +235,7 @@ module ActiveMerchant
       end
 
       def extract_event_details(message)
-        return EventDetails.new unless EVENT_MESSAGE_PATTERNS.any?{|pattern| message =~ pattern}
+        return EventDetails.new unless EVENT_MESSAGE_PATTERNS.any? { |pattern| message =~ pattern }
         description = $1.upcase
         timestamp = $2
         city = $3
@@ -215,66 +245,77 @@ module ActiveMerchant
         time = Time.parse(timestamp)
         zoneless_time = Time.utc(time.year, time.month, time.mday, time.hour, time.min, time.sec)
         location = Location.new(city: city, state: state, postal_code: zip_code, country: 'USA')
-        EventDetails.new($1.upcase, time, zoneless_time, location)
+        EventDetails.new(description, time, zoneless_time, location)
       end
 
       protected
 
-      def build_tracking_request(tracking_number, options={})
+      def build_tracking_request(tracking_number, options = {})
         xml_request = XmlNode.new('TrackRequest', 'USERID' => @options[:login]) do |root_node|
           root_node << XmlNode.new('TrackID', :ID => tracking_number)
         end
         URI.encode(xml_request.to_s)
       end
 
-      def us_rates(origin, destination, packages, options={})
+      def us_rates(origin, destination, packages, options = {})
         request = build_us_rate_request(packages, origin.zip, destination.zip, options)
-         # never use test mode; rate requests just won't work on test servers
-        parse_rate_response origin, destination, packages, commit(:us_rates,request,false), options
+        # never use test mode; rate requests just won't work on test servers
+        parse_rate_response origin, destination, packages, commit(:us_rates, request, false), options
       end
 
-      def world_rates(origin, destination, packages, options={})
-        request = build_world_rate_request(packages, destination)
-         # never use test mode; rate requests just won't work on test servers
-        parse_rate_response origin, destination, packages, commit(:world_rates,request,false), options
+      def world_rates(origin, destination, packages, options = {})
+        request = build_world_rate_request(packages, destination, options)
+        # never use test mode; rate requests just won't work on test servers
+        parse_rate_response origin, destination, packages, commit(:world_rates, request, false), options
       end
 
       # Once the address verification API is implemented, remove this and have valid_credentials? build the request using that instead.
       def canned_address_verification_works?
         return false unless @options[:login]
-        request = "%3CCarrierPickupAvailabilityRequest%20USERID=%22#{URI.encode(@options[:login])}%22%3E%20%0A%3CFirmName%3EABC%20Corp.%3C/FirmName%3E%20%0A%3CSuiteOrApt%3ESuite%20777%3C/SuiteOrApt%3E%20%0A%3CAddress2%3E1390%20Market%20Street%3C/Address2%3E%20%0A%3CUrbanization%3E%3C/Urbanization%3E%20%0A%3CCity%3EHouston%3C/City%3E%20%0A%3CState%3ETX%3C/State%3E%20%0A%3CZIP5%3E77058%3C/ZIP5%3E%20%0A%3CZIP4%3E1234%3C/ZIP4%3E%20%0A%3C/CarrierPickupAvailabilityRequest%3E%0A"
-        # expected_hash = {"CarrierPickupAvailabilityResponse"=>{"City"=>"HOUSTON", "Address2"=>"1390 Market Street", "FirmName"=>"ABC Corp.", "State"=>"TX", "Date"=>"3/1/2004", "DayOfWeek"=>"Monday", "Urbanization"=>nil, "ZIP4"=>"1234", "ZIP5"=>"77058", "CarrierRoute"=>"C", "SuiteOrApt"=>"Suite 777"}}
-        xml = REXML::Document.new(commit(:test, request, true))
-        xml.get_text('/CarrierPickupAvailabilityResponse/City').to_s == 'HOUSTON' &&
-        xml.get_text('/CarrierPickupAvailabilityResponse/Address2').to_s == '1390 Market Street'
+        request = <<-EOF
+        <?xml version="1.0" encoding="UTF-8"?>
+        <CarrierPickupAvailabilityRequest USERID="#{URI.encode(@options[:login])}">
+          <FirmName>Shopifolk</FirmName>
+          <SuiteOrApt>Suite 0</SuiteOrApt>
+          <Address2>18 Fair Ave</Address2>
+          <Urbanization />
+          <City>San Francisco</City>
+          <State>CA</State>
+          <ZIP5>94110</ZIP5>
+          <ZIP4>9411</ZIP4>
+        </CarrierPickupAvailabilityRequest>
+        EOF
+        xml = REXML::Document.new(commit(:test, URI.encode(request), true))
+        xml.get_text('/CarrierPickupAvailabilityResponse/City').to_s == 'SAN FRANCISCO' && xml.get_text('/CarrierPickupAvailabilityResponse/Address2').to_s == '18 FAIR AVE'
       end
 
       # options[:service] --    One of [:first_class, :priority, :express, :bpm, :parcel,
-      #                          :media, :library, :all]. defaults to :all.
-      # options[:container] --  One of [:envelope, :box]. defaults to neither (this field has
-      #                          special meaning in the USPS API).
+      #                          :media, :library, :online, :plus, :all]. defaults to :all.
       # options[:books] --      Either true or false. Packages of books or other printed matter
       #                          have a lower weight limit to be considered machinable.
+      # package.options[:container] --  Can be :rectangular, :variable, or a flat rate container
+      #                                 defined in CONTAINERS.
       # package.options[:machinable] -- Either true or false. Overrides the detection of
       #                                  "machinability" entirely.
-      def build_us_rate_request(packages, origin_zip, destination_zip, options={})
+      def build_us_rate_request(packages, origin_zip, destination_zip, options = {})
         packages = Array(packages)
         request = XmlNode.new('RateV4Request', :USERID => @options[:login]) do |rate_request|
-          packages.each_with_index do |p,id|
+          packages.each_with_index do |p, id|
             rate_request << XmlNode.new('Package', :ID => id.to_s) do |package|
-              if @options[:commercial_base] == true
-                raise ArgumentError.new("Commercial Base rates are only provided with the :online method.") if !options[:service].blank? && options[:service] != :online
-                default_service = :online
-              else
-                default_service = :all
+              commercial_type = commercial_type(options)
+              default_service = DEFAULT_SERVICE[commercial_type]
+              service         = options.fetch(:service, default_service).to_sym
+
+              if commercial_type && service != default_service
+                raise ArgumentError, "Commercial #{commercial_type} rates are only provided with the #{default_service.inspect} service."
               end
 
-              package << XmlNode.new('Service', US_SERVICES[options[:service] || default_service])
-              package << XmlNode.new('FirstClassMailType', FIRST_CLASS_MAIL_TYPES[options[:first_class_mail_type]])
+              package << XmlNode.new('Service', US_SERVICES[service])
+              package << XmlNode.new('FirstClassMailType', FIRST_CLASS_MAIL_TYPES[options[:first_class_mail_type].try(:to_sym)])
               package << XmlNode.new('ZipOrigination', strip_zip(origin_zip))
               package << XmlNode.new('ZipDestination', strip_zip(destination_zip))
               package << XmlNode.new('Pounds', 0)
-              package << XmlNode.new('Ounces', "%0.1f" % [p.ounces,1].max)
+              package << XmlNode.new('Ounces', "%0.1f" % [p.ounces, 1].max)
               package << XmlNode.new('Container', CONTAINERS[p.options[:container]])
               package << XmlNode.new('Size', USPS.size_code_for(p))
               package << XmlNode.new('Width', "%0.2f" % p.inches(:width))
@@ -302,14 +343,14 @@ module ActiveMerchant
       #
       # package.options[:mail_type] -- one of [:package, :postcard, :matter_for_the_blind, :envelope].
       #                                 Defaults to :package.
-      def build_world_rate_request(packages, destination)
+      def build_world_rate_request(packages, destination, options)
         country = COUNTRY_NAME_CONVERSIONS[destination.country.code(:alpha2).value] || destination.country.name
         request = XmlNode.new('IntlRateV2Request', :USERID => @options[:login]) do |rate_request|
           packages.each_index do |id|
             p = packages[id]
             rate_request << XmlNode.new('Package', :ID => id.to_s) do |package|
               package << XmlNode.new('Pounds', 0)
-              package << XmlNode.new('Ounces', [p.ounces,1].max.ceil) #takes an integer for some reason, must be rounded UP
+              package << XmlNode.new('Ounces', [p.ounces, 1].max.ceil) # takes an integer for some reason, must be rounded UP
               package << XmlNode.new('MailType', MAIL_TYPES[p.options[:mail_type]] || 'Package')
               package << XmlNode.new('GXG') do |gxg|
                 gxg << XmlNode.new('POBoxFlag', destination.po_box? ? 'Y' : 'N')
@@ -330,14 +371,16 @@ module ActiveMerchant
               package << XmlNode.new('Length', "%0.2f" % [p.inches(:length), 0.01].max)
               package << XmlNode.new('Height', "%0.2f" % [p.inches(:height), 0.01].max)
               package << XmlNode.new('Girth', "%0.2f" % [p.inches(:girth), 0.01].max)
-              package << XmlNode.new('CommercialFlag', 'Y') if @options[:commercial_base]
+              if commercial_type = commercial_type(options)
+                package << XmlNode.new(COMMERCIAL_FLAG_NAME.fetch(commercial_type), 'Y')
+              end
             end
           end
         end
         URI.encode(save_request(request.to_s))
       end
 
-      def parse_rate_response(origin, destination, packages, response, options={})
+      def parse_rate_response(origin, destination, packages, response, options = {})
         success = true
         message = ''
         rate_hash = {}
@@ -357,7 +400,7 @@ module ActiveMerchant
           end
 
           if success
-            rate_hash = rates_from_response_node(xml, packages)
+            rate_hash = rates_from_response_node(xml, packages, options)
             unless rate_hash
               success = false
               message = "Unknown root node in XML response: '#{xml.root.name}'"
@@ -368,31 +411,28 @@ module ActiveMerchant
 
         if success
           rate_estimates = rate_hash.keys.map do |service_name|
-            RateEstimate.new(origin,destination,@@name,"USPS #{service_name}",
-                                      :package_rates => rate_hash[service_name][:package_rates],
-                                      :service_code => rate_hash[service_name][:service_code],
-                                      :currency => 'USD')
+            RateEstimate.new(origin, destination, @@name, "USPS #{service_name}",
+                             :package_rates => rate_hash[service_name][:package_rates],
+                             :service_code => rate_hash[service_name][:service_code],
+                             :currency => 'USD')
           end
-          rate_estimates.reject! {|e| e.package_count != packages.length}
+          rate_estimates.reject! { |e| e.package_count != packages.length }
           rate_estimates = rate_estimates.sort_by(&:total_price)
         end
 
         RateResponse.new(success, message, Hash.from_xml(response), :rates => rate_estimates, :xml => response, :request => last_request)
       end
 
-      def rates_from_response_node(response_node, packages)
+      def rates_from_response_node(response_node, packages, options = {})
         rate_hash = {}
         return false unless (root_node = response_node.elements['/IntlRateV2Response | /RateV4Response'])
-        domestic = (root_node.name == 'RateV4Response')
 
-        if @options[:commercial_base]
-          domestic_elements = ['Postage', 'CLASSID', 'MailService', 'CommercialRate']
-          international_elements = ['Service', 'ID', 'SvcDescription', 'CommercialPostage']
+        commercial_type = commercial_type(options)
+        service_node, service_code_node, service_name_node, rate_node = if root_node.name == 'RateV4Response'
+          %w(Postage CLASSID MailService) << DOMESTIC_RATE_FIELD[commercial_type]
         else
-          domestic_elements = ['Postage', 'CLASSID', 'MailService', 'Rate']
-          international_elements = ['Service', 'ID', 'SvcDescription', 'Postage']
+          %w(Service ID SvcDescription)   << INTERNATIONAL_RATE_FIELD[commercial_type]
         end
-        service_node, service_code_node, service_name_node, rate_node = domestic ? domestic_elements : international_elements
 
         root_node.each_element('Package') do |package_node|
           this_package = packages[package_node.attributes['ID'].to_i]
@@ -400,13 +440,7 @@ module ActiveMerchant
           package_node.each_element(service_node) do |service_response_node|
             service_name = service_response_node.get_text(service_name_node).to_s
 
-            # strips the double-escaped HTML for trademark symbols from service names
-            service_name.gsub!(/&amp;lt;\S*&amp;gt;/,'')
-            # ...leading "USPS"
-            service_name.gsub!(/^USPS/,'')
-            # ...trailing asterisks
-            service_name.gsub!(/\*+$/,'')
-            # ...surrounding spaces
+            service_name.gsub!(SERVICE_NAME_SUBSTITUTIONS, '')
             service_name.strip!
 
             # aggregate specific package rates into a service-centric RateEstimate
@@ -416,9 +450,9 @@ module ActiveMerchant
             this_service[:service_code] ||= service_response_node.attributes[service_code_node]
             package_rates = this_service[:package_rates] ||= []
             this_package_rate = {:package => this_package,
-                                 :rate => Package.cents_from(service_response_node.get_text(rate_node).to_s.to_f)}
+                                 :rate => Package.cents_from(rate_value(rate_node, service_response_node, commercial_type))}
 
-            package_rates << this_package_rate if package_valid_for_service(this_package,service_response_node)
+            package_rates << this_package_rate if package_valid_for_service(this_package, service_response_node)
           end
         end
         rate_hash
@@ -429,38 +463,38 @@ module ActiveMerchant
         max_weight = service_node.get_text('MaxWeight').to_s.to_f
         name = service_node.get_text('SvcDescription | MailService').to_s.downcase
 
-        if name =~ /flat.rate.box/ #domestic or international flat rate box
+        if name =~ /flat.rate.box/ # domestic or international flat rate box
           # flat rate dimensions from http://www.usps.com/shipping/flatrate.htm
           return (package_valid_for_max_dimensions(package,
-                      :weight => max_weight, #domestic apparently has no weight restriction
-                      :length => 11.0,
-                      :width => 8.5,
-                      :height => 5.5) or
+                                                   :weight => max_weight, # domestic apparently has no weight restriction
+                                                   :length => 11.0,
+                                                   :width => 8.5,
+                                                   :height => 5.5) or
                  package_valid_for_max_dimensions(package,
-                      :weight => max_weight,
-                      :length => 13.625,
-                      :width => 11.875,
-                      :height => 3.375))
+                                                  :weight => max_weight,
+                                                  :length => 13.625,
+                                                  :width => 11.875,
+                                                  :height => 3.375))
         elsif name =~ /flat.rate.envelope/
           return package_valid_for_max_dimensions(package,
-                      :weight => max_weight,
-                      :length => 12.5,
-                      :width => 9.5,
-                      :height => 0.75)
+                                                  :weight => max_weight,
+                                                  :length => 12.5,
+                                                  :width => 9.5,
+                                                  :height => 0.75)
         elsif service_node.elements['MailService'] # domestic non-flat rates
           return true
-        else #international non-flat rates
+        else # international non-flat rates
           # Some sample english that this is required to parse:
           #
           # 'Max. length 46", width 35", height 46" and max. length plus girth 108"'
           # 'Max. length 24", Max. length, height, depth combined 36"'
           #
           sentence = CGI.unescapeHTML(service_node.get_text('MaxDimensions').to_s)
-          tokens = sentence.downcase.split(/[^\d]*"/).reject {|t| t.empty?}
+          tokens = sentence.downcase.split(/[^\d]*"/).reject(&:empty?)
           max_dimensions = {:weight => max_weight}
           single_axis_values = []
           tokens.each do |token|
-            axis_sum = [/length/,/width/,/height/,/depth/].sum {|regex| (token =~ regex) ? 1 : 0}
+            axis_sum = [/length/, /width/, /height/, /depth/].sum { |regex| (token =~ regex) ? 1 : 0 }
             unless axis_sum == 0
               value = token[/\d+$/].to_f
               if axis_sum == 3
@@ -473,15 +507,15 @@ module ActiveMerchant
             end
           end
           single_axis_values.sort!.reverse!
-          [:length, :width, :height].each_with_index do |axis,i|
+          [:length, :width, :height].each_with_index do |axis, i|
             max_dimensions[axis] = single_axis_values[i] if single_axis_values[i]
           end
-          return package_valid_for_max_dimensions(package, max_dimensions)
+          package_valid_for_max_dimensions(package, max_dimensions)
         end
       end
 
-      def package_valid_for_max_dimensions(package,dimensions)
-        valid = ((not ([:length,:width,:height].map {|dim| dimensions[dim].nil? || dimensions[dim].to_f >= package.inches(dim).to_f}.include?(false))) and
+      def package_valid_for_max_dimensions(package, dimensions)
+        ((not ([:length, :width, :height].map { |dim| dimensions[dim].nil? || dimensions[dim].to_f >= package.inches(dim).to_f }.include?(false))) and
                 (dimensions[:weight].nil? || dimensions[:weight] >= package.pounds) and
                 (dimensions[:length_plus_girth].nil? or
                     dimensions[:length_plus_girth].to_f >=
@@ -489,8 +523,6 @@ module ActiveMerchant
                 (dimensions[:length_plus_width_plus_height].nil? or
                     dimensions[:length_plus_width_plus_height].to_f >=
                     package.inches(:length) + package.inches(:width) + package.inches(:height)))
-
-        return valid
       end
 
       def parse_tracking_response(response, options)
@@ -502,11 +534,11 @@ module ActiveMerchant
         message = response_message(xml)
 
         if success
-          tracking_number, origin, destination = nil
+          destination = nil
           shipment_events = []
-          tracking_details = xml.elements.collect('*/*/TrackDetail'){ |e| e }
+          tracking_details = xml.elements.collect('*/*/TrackDetail') { |e| e }
 
-          tracking_summary = xml.elements.collect('*/*/TrackSummary'){ |e| e }.first
+          tracking_summary = xml.elements.collect('*/*/TrackSummary') { |e| e }.first
           tracking_details << tracking_summary
 
           tracking_number = root_node.elements['TrackInfo'].attributes['ID'].to_s
@@ -525,14 +557,14 @@ module ActiveMerchant
         end
 
         TrackingResponse.new(success, message, Hash.from_xml(response),
-          :carrier => @@name,
-          :xml => response,
-          :request => last_request,
-          :shipment_events => shipment_events,
-          :destination => destination,
-          :tracking_number => tracking_number,
-          :status => status,
-          :actual_delivery_date => actual_delivery_date
+                             :carrier => @@name,
+                             :xml => response,
+                             :request => last_request,
+                             :shipment_events => shipment_events,
+                             :destination => destination,
+                             :tracking_number => tracking_number,
+                             :status => status,
+                             :actual_delivery_date => actual_delivery_date
         )
       end
 
@@ -595,6 +627,19 @@ module ActiveMerchant
         zip.to_s.scan(/\d{5}/).first || zip
       end
 
+      private
+
+      def rate_value(rate_node, service_response_node, commercial_type)
+        service_response_node.get_text(rate_node).to_s.to_f
+      end
+
+      def commercial_type(options)
+        if options[:commercial_plus] == true
+          :plus
+        elsif options[:commercial_base] == true
+          :base
+        end
+      end
     end
   end
 end