active_shipping 0.12.4 → 0.12.5

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

@@ -4,29 +4,28 @@
 require 'date'
 module ActiveMerchant
   module Shipping
-    
     # :key is your developer API key
     # :password is your API password
     # :account is your FedEx account number
     # :login is your meter number
     class FedEx < Carrier
       self.retry_safe = true
-      
+
       cattr_reader :name
       @@name = "FedEx"
-      
+
       TEST_URL = 'https://gatewaybeta.fedex.com:443/xml'
       LIVE_URL = 'https://gateway.fedex.com:443/xml'
-      
-      CarrierCodes = {
+
+      CARRIER_CODES = {
         "fedex_ground" => "FDXG",
         "fedex_express" => "FDXE"
       }
 
       DELIVERY_ADDRESS_NODE_NAMES = %w(DestinationAddress ActualDeliveryAddress)
       SHIPPER_ADDRESS_NODE_NAMES  = %w(ShipperAddress)
-      
-      ServiceTypes = {
+
+      SERVICE_TYPES = {
         "PRIORITY_OVERNIGHT" => "FedEx Priority Overnight",
         "PRIORITY_OVERNIGHT_SATURDAY_DELIVERY" => "FedEx Priority Overnight Saturday Delivery",
         "FEDEX_2_DAY" => "FedEx 2 Day",
@@ -55,7 +54,7 @@ module ActiveMerchant
         "FEDEX_FREIGHT_ECONOMY" => "FedEx Freight Economy"
       }
 
-      PackageTypes = {
+      PACKAGE_TYPES = {
         "fedex_envelope" => "FEDEX_ENVELOPE",
         "fedex_pak" => "FEDEX_PAK",
         "fedex_box" => "FEDEX_BOX",
@@ -65,7 +64,7 @@ module ActiveMerchant
         "your_packaging" => "YOUR_PACKAGING"
       }
 
-      DropoffTypes = {
+      DROPOFF_TYPES = {
         'regular_pickup' => 'REGULAR_PICKUP',
         'request_courier' => 'REQUEST_COURIER',
         'dropbox' => 'DROP_BOX',
@@ -73,14 +72,14 @@ module ActiveMerchant
         'station' => 'STATION'
       }
 
-      PaymentTypes = {
+      PAYMENT_TYPES = {
         'sender' => 'SENDER',
         'recipient' => 'RECIPIENT',
         'third_party' => 'THIRDPARTY',
         'collect' => 'COLLECT'
       }
-      
-      PackageIdentifierTypes = {
+
+      PACKAGE_IDENTIFIER_TYPES = {
         'tracking_number' => 'TRACKING_NUMBER_OR_DOORTAG',
         'door_tag' => 'TRACKING_NUMBER_OR_DOORTAG',
         'rma' => 'RMA',
@@ -92,12 +91,11 @@ module ActiveMerchant
         'express_mps_master' => 'EXPRESS_MPS_MASTER'
       }
 
-
-      TransitTimes = ["UNKNOWN","ONE_DAY","TWO_DAYS","THREE_DAYS","FOUR_DAYS","FIVE_DAYS","SIX_DAYS","SEVEN_DAYS","EIGHT_DAYS","NINE_DAYS","TEN_DAYS","ELEVEN_DAYS","TWELVE_DAYS","THIRTEEN_DAYS","FOURTEEN_DAYS","FIFTEEN_DAYS","SIXTEEN_DAYS","SEVENTEEN_DAYS","EIGHTEEN_DAYS"]
+      TRANSIT_TIMES = %w(UNKNOWN ONE_DAY TWO_DAYS THREE_DAYS FOUR_DAYS FIVE_DAYS SIX_DAYS SEVEN_DAYS EIGHT_DAYS NINE_DAYS TEN_DAYS ELEVEN_DAYS TWELVE_DAYS THIRTEEN_DAYS FOURTEEN_DAYS FIFTEEN_DAYS SIXTEEN_DAYS SEVENTEEN_DAYS EIGHTEEN_DAYS)
 
       # FedEx tracking codes as described in the FedEx Tracking Service WSDL Guide
       # All delays also have been marked as exceptions
-      TRACKING_STATUS_CODES = HashWithIndifferentAccess.new({
+      TRACKING_STATUS_CODES = HashWithIndifferentAccess.new(
         'AA' => :at_airport,
         'AD' => :at_delivery,
         'AF' => :at_fedex_facility,
@@ -129,31 +127,31 @@ module ActiveMerchant
         'SF' => :at_sort_facility,
         'SP' => :split_status,
         'TR' => :transfer
-      })
+      )
 
       def self.service_name_for_code(service_code)
-        ServiceTypes[service_code] || "FedEx #{service_code.titleize.sub(/Fedex /, '')}"
+        SERVICE_TYPES[service_code] || "FedEx #{service_code.titleize.sub(/Fedex /, '')}"
       end
-      
+
       def requirements
         [:key, :password, :account, :login]
       end
-      
+
       def find_rates(origin, destination, packages, options = {})
         options = @options.update(options)
         packages = Array(packages)
-        
+
         rate_request = build_rate_request(origin, destination, packages, options)
-        
+
         xml = commit(save_request(rate_request), (options[:test] || false))
         response = remove_version_prefix(xml)
 
         parse_rate_response(origin, destination, packages, response, options)
       end
-      
-      def find_tracking_info(tracking_number, options={})
+
+      def find_tracking_info(tracking_number, options = {})
         options = @options.update(options)
-        
+
         tracking_request = build_tracking_request(tracking_number, options)
         xml = commit(save_request(tracking_request), (options[:test] || false))
         response = remove_version_prefix(xml)
@@ -161,36 +159,30 @@ module ActiveMerchant
       end
 
       protected
-      def build_rate_request(origin, destination, packages, options={})
-        imperial = ['US','LR','MM'].include?(origin.country_code(:alpha2))
+
+      def build_rate_request(origin, destination, packages, options = {})
+        imperial = %w(US LR MM).include?(origin.country_code(:alpha2))
 
         xml_request = XmlNode.new('RateRequest', 'xmlns' => 'http://fedex.com/ws/rate/v13') do |root_node|
           root_node << build_request_header
+          root_node << build_version_node
 
-          # Version
-          root_node << XmlNode.new('Version') do |version_node|
-            version_node << XmlNode.new('ServiceId', 'crs')
-            version_node << XmlNode.new('Major', '13')
-            version_node << XmlNode.new('Intermediate', '0')
-            version_node << XmlNode.new('Minor', '0')
-          end
-          
           # Returns delivery dates
           root_node << XmlNode.new('ReturnTransitAndCommit', true)
           # Returns saturday delivery shipping options when available
           root_node << XmlNode.new('VariableOptions', 'SATURDAY_DELIVERY')
-          
+
           root_node << XmlNode.new('RequestedShipment') do |rs|
             rs << XmlNode.new('ShipTimestamp', ship_timestamp(options[:turn_around_time]))
 
             freight = has_freight?(options)
 
-            if !freight
+            unless freight
               # fedex api wants this up here otherwise request returns an error
               rs << XmlNode.new('DropoffType', options[:dropoff_type] || 'REGULAR_PICKUP')
               rs << XmlNode.new('PackagingType', options[:packaging_type] || 'YOUR_PACKAGING')
             end
-            
+
             rs << build_location_node('Shipper', (options[:shipper] || origin))
             rs << build_location_node('Recipient', destination)
             if options[:shipper] and options[:shipper] != origin
@@ -211,21 +203,25 @@ module ActiveMerchant
               end
 
               rs << build_rate_request_types_node
-
               rs << XmlNode.new('PackageCount', packages.size)
-              packages.each do |pkg|
-                rs << XmlNode.new('RequestedPackageLineItems') do |rps|
-                  rps << XmlNode.new('GroupPackageCount', 1)
-                  rps << build_package_weight_node(pkg, imperial)
-                  rps << build_package_dimensions_node(pkg, imperial)
-                end
-              end
+              rs << build_packages_nodes(packages, imperial)
+
             end
           end
         end
         xml_request.to_s
       end
 
+      def build_packages_nodes(packages, imperial)
+        packages.map do |pkg|
+          XmlNode.new('RequestedPackageLineItems') do |rps|
+            rps << XmlNode.new('GroupPackageCount', 1)
+            rps << build_package_weight_node(pkg, imperial)
+            rps << build_package_dimensions_node(pkg, imperial)
+          end
+        end
+      end
+
       def build_shipping_charges_payment_node(freight_options)
         XmlNode.new('ShippingChargesPayment') do |shipping_charges_payment|
           shipping_charges_payment << XmlNode.new('PaymentType', freight_options[:payment_type])
@@ -263,14 +259,23 @@ module ActiveMerchant
       def build_package_weight_node(pkg, imperial)
         XmlNode.new('Weight') do |tw|
           tw << XmlNode.new('Units', imperial ? 'LB' : 'KG')
-          tw << XmlNode.new('Value', [((imperial ? pkg.lbs : pkg.kgs).to_f*1000).round/1000.0, 0.1].max)
+          tw << XmlNode.new('Value', [((imperial ? pkg.lbs : pkg.kgs).to_f * 1000).round / 1000.0, 0.1].max)
+        end
+      end
+
+      def build_version_node
+        XmlNode.new('Version') do |version_node|
+          version_node << XmlNode.new('ServiceId', 'crs')
+          version_node << XmlNode.new('Major', '13')
+          version_node << XmlNode.new('Intermediate', '0')
+          version_node << XmlNode.new('Minor', '0')
         end
       end
 
       def build_package_dimensions_node(pkg, imperial)
         XmlNode.new('Dimensions') do |dimensions|
-          [:length,:width,:height].each do |axis|
-            value = ((imperial ? pkg.inches(axis) : pkg.cm(axis)).to_f*1000).round/1000.0 # 3 decimals
+          [:length, :width, :height].each do |axis|
+            value = ((imperial ? pkg.inches(axis) : pkg.cm(axis)).to_f * 1000).round / 1000.0 # 3 decimals
             dimensions << XmlNode.new(axis.to_s.capitalize, value.ceil)
           end
           dimensions << XmlNode.new('Units', imperial ? 'IN' : 'CM')
@@ -280,11 +285,11 @@ module ActiveMerchant
       def build_rate_request_types_node(type = 'ACCOUNT')
         XmlNode.new('RateRequestTypes', type)
       end
-      
-      def build_tracking_request(tracking_number, options={})
+
+      def build_tracking_request(tracking_number, options = {})
         xml_request = XmlNode.new('TrackRequest', 'xmlns' => 'http://fedex.com/ws/track/v3') do |root_node|
           root_node << build_request_header
-          
+
           # Version
           root_node << XmlNode.new('Version') do |version_node|
             version_node << XmlNode.new('ServiceId', 'trck')
@@ -292,19 +297,19 @@ module ActiveMerchant
             version_node << XmlNode.new('Intermediate', '0')
             version_node << XmlNode.new('Minor', '0')
           end
-          
+
           root_node << XmlNode.new('PackageIdentifier') do |package_node|
             package_node << XmlNode.new('Value', tracking_number)
-            package_node << XmlNode.new('Type', PackageIdentifierTypes[options['package_identifier_type'] || 'tracking_number'])
+            package_node << XmlNode.new('Type', PACKAGE_IDENTIFIER_TYPES[options['package_identifier_type'] || 'tracking_number'])
           end
-          
+
           root_node << XmlNode.new('ShipDateRangeBegin', options['ship_date_range_begin']) if options['ship_date_range_begin']
           root_node << XmlNode.new('ShipDateRangeEnd', options['ship_date_range_end']) if options['ship_date_range_end']
           root_node << XmlNode.new('IncludeDetailedScans', 1)
         end
         xml_request.to_s
       end
-      
+
       def build_request_header
         web_authentication_detail = XmlNode.new('WebAuthenticationDetail') do |wad|
           wad << XmlNode.new('UserCredential') do |uc|
@@ -312,19 +317,19 @@ module ActiveMerchant
             uc << XmlNode.new('Password', @options[:password])
           end
         end
-        
+
         client_detail = XmlNode.new('ClientDetail') do |cd|
           cd << XmlNode.new('AccountNumber', @options[:account])
           cd << XmlNode.new('MeterNumber', @options[:login])
         end
-        
+
         trasaction_detail = XmlNode.new('TransactionDetail') do |td|
-          td << XmlNode.new('CustomerTransactionId', 'ActiveShipping') # TODO: Need to do something better with this..
+          td << XmlNode.new('CustomerTransactionId', @options[:transaction_id] || 'ActiveShipping') # TODO: Need to do something better with this..
         end
-        
+
         [web_authentication_detail, client_detail, trasaction_detail]
       end
-            
+
       def build_location_node(name, location)
         XmlNode.new(name) do |xml_node|
           xml_node << XmlNode.new('Address') do |address_node|
@@ -338,22 +343,23 @@ module ActiveMerchant
           end
         end
       end
-      
+
       def parse_rate_response(origin, destination, packages, response, options)
         rate_estimates = []
-        success, message = nil
-        
+
         xml = build_document(response)
         root_node = xml.elements['RateReply']
-        
+
         success = response_success?(xml)
         message = response_message(xml)
-        
+
+        raise ActiveMerchant::Shipping::ResponseContentError.new(StandardError.new('Invalid document'), xml) unless root_node
+
         root_node.elements.each('RateReplyDetails') do |rated_shipment|
           service_code = rated_shipment.get_text('ServiceType').to_s
           is_saturday_delivery = rated_shipment.get_text('AppliedOptions').to_s == 'SATURDAY_DELIVERY'
           service_type = is_saturday_delivery ? "#{service_code}_SATURDAY_DELIVERY" : service_code
-          
+
           transit_time = rated_shipment.get_text('TransitTime').to_s if service_code == "FEDEX_GROUND"
           max_transit_time = rated_shipment.get_text('MaximumTransitTime').to_s if service_code == "FEDEX_GROUND"
 
@@ -363,14 +369,14 @@ module ActiveMerchant
 
           currency = rated_shipment.get_text('RatedShipmentDetails/ShipmentRateDetail/TotalNetCharge/Currency').to_s
           rate_estimates << RateEstimate.new(origin, destination, @@name,
-                              self.class.service_name_for_code(service_type),
-                              :service_code => service_code,
-                              :total_price => rated_shipment.get_text('RatedShipmentDetails/ShipmentRateDetail/TotalNetCharge/Amount').to_s.to_f,
-                              :currency => currency,
-                              :packages => packages,
-                              :delivery_range => delivery_range)
+                                             self.class.service_name_for_code(service_type),
+                                             :service_code => service_code,
+                                             :total_price => rated_shipment.get_text('RatedShipmentDetails/ShipmentRateDetail/TotalNetCharge/Amount').to_s.to_f,
+                                             :currency => currency,
+                                             :packages => packages,
+                                             :delivery_range => delivery_range)
         end
-		
+
         if rate_estimates.empty?
           success = false
           message = "No shipping rates could be found for the destination address" if message.blank?
@@ -381,11 +387,11 @@ module ActiveMerchant
 
       def delivery_range_from(transit_time, max_transit_time, delivery_timestamp, options)
         delivery_range = [delivery_timestamp, delivery_timestamp]
-        
-        #if there's no delivery timestamp but we do have a transit time, use it
+
+        # if there's no delivery timestamp but we do have a transit time, use it
         if delivery_timestamp.blank? && transit_time.present?
-          transit_range  = parse_transit_times([transit_time,max_transit_time.presence || transit_time])
-          delivery_range = transit_range.map{|days| business_days_from(ship_date(options[:turn_around_time]), days)}
+          transit_range  = parse_transit_times([transit_time, max_transit_time.presence || transit_time])
+          delivery_range = transit_range.map { |days| business_days_from(ship_date(options[:turn_around_time]), days) }
         end
 
         delivery_range
@@ -410,19 +416,17 @@ module ActiveMerchant
       def parse_tracking_response(response, options)
         xml = build_document(response)
         root_node = xml.elements['TrackReply']
-        
+
         success = response_success?(xml)
         message = response_message(xml)
-        
+
         if success
-          tracking_number, shipper_address, origin, destination, status = nil
-          status_code, status_description, ship_time = nil
-          scheduled_delivery_time, actual_delivery_time, delivery_signature = nil
+          origin = nil
+          delivery_signature = nil
           shipment_events = []
 
           tracking_details = root_node.elements['TrackDetails']
           tracking_number = tracking_details.get_text('TrackingNumber').to_s
-
           status_code = tracking_details.get_text('StatusCode').to_s
           status_description = tracking_details.get_text('StatusDescription').to_s
           status = TRACKING_STATUS_CODES[status_code]
@@ -447,7 +451,7 @@ module ActiveMerchant
           ship_time = extract_timestamp(tracking_details, 'ShipTimestamp')
           actual_delivery_time = extract_timestamp(tracking_details, 'ActualDeliveryTimestamp')
           scheduled_delivery_time = extract_timestamp(tracking_details, 'EstimatedDeliveryTimestamp')
-          
+
           tracking_details.elements.each('Events') do |event|
             address  = event.elements['Address']
 
@@ -456,7 +460,7 @@ module ActiveMerchant
             zip_code = address.get_text('PostalCode').to_s
             country  = address.get_text('CountryCode').to_s
             next if country.blank?
-            
+
             location = Location.new(:city => city, :state => state, :postal_code => zip_code, :country => country)
             description = event.get_text('EventDescription').to_s
 
@@ -468,23 +472,23 @@ module ActiveMerchant
           shipment_events = shipment_events.sort_by(&:time)
 
         end
-        
+
         TrackingResponse.new(success, message, Hash.from_xml(response),
-          :carrier => @@name,
-          :xml => response,
-          :request => last_request,
-          :status => status,
-          :status_code => status_code,
-          :status_description => status_description,
-          :ship_time => ship_time,
-          :scheduled_delivery_date => scheduled_delivery_time,
-          :actual_delivery_date => actual_delivery_time,
-          :delivery_signature => delivery_signature,
-          :shipment_events => shipment_events,
-          :shipper_address => (shipper_address.nil? || shipper_address.unknown?) ? nil : shipper_address,
-          :origin => origin,
-          :destination => destination,
-          :tracking_number => tracking_number
+                             :carrier => @@name,
+                             :xml => response,
+                             :request => last_request,
+                             :status => status,
+                             :status_code => status_code,
+                             :status_description => status_description,
+                             :ship_time => ship_time,
+                             :scheduled_delivery_date => scheduled_delivery_time,
+                             :actual_delivery_date => actual_delivery_time,
+                             :delivery_signature => delivery_signature,
+                             :shipment_events => shipment_events,
+                             :shipper_address => (shipper_address.nil? || shipper_address.unknown?) ? nil : shipper_address,
+                             :origin => origin,
+                             :destination => destination,
+                             :tracking_number => tracking_number
         )
       end
 
@@ -501,24 +505,29 @@ module ActiveMerchant
       def response_status_node(document)
         document.elements['/*/Notifications/']
       end
-      
+
       def response_success?(document)
-        %w{SUCCESS WARNING NOTE}.include? response_status_node(document).get_text('Severity').to_s
+        response_node = response_status_node(document)
+        return false if response_node.nil?
+
+        %w(SUCCESS WARNING NOTE).include? response_node.get_text('Severity').to_s
       end
-      
+
       def response_message(document)
         response_node = response_status_node(document)
-        "#{response_status_node(document).get_text('Severity')} - #{response_node.get_text('Code')}: #{response_node.get_text('Message')}"
+        return "" if response_node.nil?
+
+        "#{response_node.get_text('Severity')} - #{response_node.get_text('Code')}: #{response_node.get_text('Message')}"
       end
-      
+
       def commit(request, test = false)
-        ssl_post(test ? TEST_URL : LIVE_URL, request.gsub("\n",''))        
+        ssl_post(test ? TEST_URL : LIVE_URL, request.gsub("\n", ''))
       end
-      
+
       def parse_transit_times(times)
         results = []
         times.each do |day_count|
-          days = TransitTimes.index(day_count.to_s.chomp)
+          days = TRANSIT_TIMES.index(day_count.to_s.chomp)
           results << days.to_i
         end
         results