active_shipping 0.9.15 → 0.10.0

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

@@ -337,18 +337,22 @@ module ActiveMerchant
         message = response_message(xml)
         
         if success
-          tracking_number, origin, destination, status, status_code, status_description = nil
+          tracking_number, origin, destination, status, status_code, status_description, 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]
 
+          if status_code == 'DL' && tracking_details.get_text('SignatureProofOfDeliveryAvailable').to_s == 'true'
+            delivery_signature = tracking_details.get_text('DeliverySignatureName').to_s
+          end
+
           origin_node = tracking_details.elements['OriginLocationAddress']
-        
+
           if origin_node
             origin = Location.new(
                   :country =>     origin_node.get_text('CountryCode').to_s,
@@ -357,17 +361,7 @@ module ActiveMerchant
             )
           end
 
-          destination_node = tracking_details.elements['DestinationAddress']
-
-          if destination_node.nil?
-            destination_node = tracking_details.elements['ActualDeliveryAddress']
-          end
-
-          destination = Location.new(
-                :country =>     destination_node.get_text('CountryCode').to_s,
-                :province =>    destination_node.get_text('StateOrProvinceCode').to_s,
-                :city =>        destination_node.get_text('City').to_s
-              )
+          destination = extract_destination(tracking_details)
           
           tracking_details.elements.each('Events') do |event|
             address  = event.elements['Address']
@@ -380,11 +374,10 @@ module ActiveMerchant
             
             location = Location.new(:city => city, :state => state, :postal_code => zip_code, :country => country)
             description = event.get_text('EventDescription').to_s
-            
-            # for now, just assume UTC, even though it probably isn't
-            time = Time.parse("#{event.get_text('Timestamp').to_s}")
-            zoneless_time = Time.utc(time.year, time.month, time.mday, time.hour, time.min, time.sec)
-            
+
+            time          = Time.parse("#{event.get_text('Timestamp').to_s}")
+            zoneless_time = time.utc
+
             shipment_events << ShipmentEvent.new(description, zoneless_time, location)
           end
           shipment_events = shipment_events.sort_by(&:time)
@@ -398,6 +391,7 @@ module ActiveMerchant
           :status => status,
           :status_code => status_code,
           :status_description => status_description,
+          :delivery_signature => delivery_signature,
           :shipment_events => shipment_events,
           :origin => origin,
           :destination => destination,
@@ -448,6 +442,26 @@ module ActiveMerchant
         end
         results
       end
+
+      def extract_destination(document)
+        node = document.elements['DestinationAddress'] || document.elements['ActualDeliveryAddress']
+
+        args = if node
+          {
+            :country => node.get_text('CountryCode').to_s,
+            :province => node.get_text('StateOrProvinceCode').to_s,
+            :city => node.get_text('City').to_s
+          }
+        else
+          {
+            :country => ActiveMerchant::Country.new(:alpha2 => 'ZZ', :name => 'Unknown or Invalid Territory', :alpha3 => 'ZZZ', :numeric => '999'),
+            :province => 'unknown',
+            :city => 'unknown'
+          }
+        end
+
+        Location.new(args)
+      end
     end
   end
 end

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

@@ -4,22 +4,22 @@ module ActiveMerchant
   module Shipping
     class UPS < Carrier
       self.retry_safe = true
-      
+
       cattr_accessor :default_options
       cattr_reader :name
       @@name = "UPS"
-      
+
       TEST_URL = 'https://wwwcie.ups.com'
       LIVE_URL = 'https://onlinetools.ups.com'
-      
+
       RESOURCES = {
         :rates => 'ups.app/xml/Rate',
         :track => 'ups.app/xml/Track'
       }
-      
+
       PICKUP_CODES = HashWithIndifferentAccess.new({
         :daily_pickup => "01",
-        :customer_counter => "03", 
+        :customer_counter => "03",
         :one_time_pickup => "06",
         :on_call_air => "07",
         :suggested_retail_rates => "11",
@@ -29,7 +29,7 @@ module ActiveMerchant
 
       CUSTOMER_CLASSIFICATIONS = HashWithIndifferentAccess.new({
         :wholesale => "01",
-        :occasional => "03", 
+        :occasional => "03",
         :retail => "04"
       })
 
@@ -44,7 +44,7 @@ module ActiveMerchant
           :occasional
         end
       end
-      
+
       DEFAULT_SERVICES = {
         "01" => "UPS Next Day Air",
         "02" => "UPS Second Day Air",
@@ -64,24 +64,24 @@ module ActiveMerchant
         "85" => "UPS Today Express",
         "86" => "UPS Today Express Saver"
       }
-      
+
       CANADA_ORIGIN_SERVICES = {
         "01" => "UPS Express",
         "02" => "UPS Expedited",
         "14" => "UPS Express Early A.M."
       }
-      
+
       MEXICO_ORIGIN_SERVICES = {
         "07" => "UPS Express",
         "08" => "UPS Expedited",
         "54" => "UPS Express Plus"
       }
-      
+
       EU_ORIGIN_SERVICES = {
         "07" => "UPS Express",
         "08" => "UPS Expedited"
       }
-      
+
       OTHER_NON_US_ORIGIN_SERVICES = {
         "07" => "UPS Express"
       }
@@ -96,13 +96,13 @@ module ActiveMerchant
 
       # From http://en.wikipedia.org/w/index.php?title=European_Union&oldid=174718707 (Current as of November 30, 2007)
       EU_COUNTRY_CODES = ["GB", "AT", "BE", "BG", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "GR", "HU", "IE", "IT", "LV", "LT", "LU", "MT", "NL", "PL", "PT", "RO", "SK", "SI", "ES", "SE"]
-      
+
       US_TERRITORIES_TREATED_AS_COUNTRIES = ["AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI"]
-      
+
       def requirements
         [:key, :login, :password]
       end
-      
+
       def find_rates(origin, destination, packages, options={})
         origin, destination = upsified_location(origin), upsified_location(destination)
         options = @options.merge(options)
@@ -112,7 +112,7 @@ module ActiveMerchant
         response = commit(:rates, save_request(access_request + rate_request), (options[:test] || false))
         parse_rate_response(origin, destination, packages, response, options)
       end
-      
+
       def find_tracking_info(tracking_number, options={})
         options = @options.update(options)
         access_request = build_access_request
@@ -120,9 +120,9 @@ module ActiveMerchant
         response = commit(:track, save_request(access_request + tracking_request), (options[:test] || false))
         parse_tracking_response(response, options)
       end
-      
+
       protected
-      
+
       def upsified_location(location)
         if location.country_code == 'US' && US_TERRITORIES_TREATED_AS_COUNTRIES.include?(location.state)
           atts = {:country => location.state}
@@ -134,7 +134,7 @@ module ActiveMerchant
           location
         end
       end
-      
+
       def build_access_request
         xml_request = XmlNode.new('AccessRequest') do |access_request|
           access_request << XmlNode.new('AccessLicenseNumber', @options[:key])
@@ -143,7 +143,7 @@ module ActiveMerchant
         end
         xml_request.to_s
       end
-      
+
       def build_rate_request(origin, destination, packages, options={})
         packages = Array(packages)
         xml_request = XmlNode.new('RatingServiceSelectionRequest') do |root_node|
@@ -153,9 +153,9 @@ module ActiveMerchant
             # not implemented: 'Rate' RequestOption to specify a single service query
             # request << XmlNode.new('RequestOption', ((options[:service].nil? or options[:service] == :all) ? 'Shop' : 'Rate'))
           end
-          
+
           pickup_type = options[:pickup_type] || :daily_pickup
-          
+
           root_node << XmlNode.new('PickupType') do |pickup_type_node|
             pickup_type_node << XmlNode.new('Code', PICKUP_CODES[pickup_type])
             # not implemented: PickupType/PickupDetails element
@@ -164,7 +164,7 @@ module ActiveMerchant
           root_node << XmlNode.new('CustomerClassification') do |cc_node|
             cc_node << XmlNode.new('Code', CUSTOMER_CLASSIFICATIONS[cc])
           end
-          
+
           root_node << XmlNode.new('Shipment') do |shipment|
             # not implemented: Shipment/Description element
             shipment << build_location_node('Shipper', (options[:shipper] || origin), options)
@@ -172,28 +172,28 @@ module ActiveMerchant
             if options[:shipper] and options[:shipper] != origin
               shipment << build_location_node('ShipFrom', origin, options)
             end
-            
+
             # not implemented:  * Shipment/ShipmentWeight element
-            #                   * Shipment/ReferenceNumber element                    
-            #                   * Shipment/Service element                            
-            #                   * Shipment/PickupDate element                         
-            #                   * Shipment/ScheduledDeliveryDate element              
-            #                   * Shipment/ScheduledDeliveryTime element              
-            #                   * Shipment/AlternateDeliveryTime element              
-            #                   * Shipment/DocumentsOnly element                      
-            
+            #                   * Shipment/ReferenceNumber element
+            #                   * Shipment/Service element
+            #                   * Shipment/PickupDate element
+            #                   * Shipment/ScheduledDeliveryDate element
+            #                   * Shipment/ScheduledDeliveryTime element
+            #                   * Shipment/AlternateDeliveryTime element
+            #                   * Shipment/DocumentsOnly element
+
             packages.each do |package|
               imperial = ['US','LR','MM'].include?(origin.country_code(:alpha2))
-              
+
               shipment << XmlNode.new("Package") do |package_node|
-                
+
                 # not implemented:  * Shipment/Package/PackagingType element
                 #                   * Shipment/Package/Description element
-                
+
                 package_node << XmlNode.new("PackagingType") do |packaging_type|
                   packaging_type << XmlNode.new("Code", '02')
                 end
-                
+
                 package_node << XmlNode.new("Dimensions") do |dimensions|
                   dimensions << XmlNode.new("UnitOfMeasurement") do |units|
                     units << XmlNode.new("Code", imperial ? 'IN' : 'CM')
@@ -203,33 +203,35 @@ module ActiveMerchant
                     dimensions << XmlNode.new(axis.to_s.capitalize, [value,0.1].max)
                   end
                 end
-              
+
                 package_node << XmlNode.new("PackageWeight") do |package_weight|
                   package_weight << XmlNode.new("UnitOfMeasurement") do |units|
                     units << XmlNode.new("Code", imperial ? 'LBS' : 'KGS')
                   end
-                  
+
                   value = ((imperial ? package.lbs : package.kgs).to_f*1000).round/1000.0 # 3 decimals
                   package_weight << XmlNode.new("Weight", [value,0.1].max)
                 end
-              
+
                 # not implemented:  * Shipment/Package/LargePackageIndicator element
                 #                   * Shipment/Package/ReferenceNumber element
                 #                   * Shipment/Package/PackageServiceOptions element
-                #                   * Shipment/Package/AdditionalHandling element  
+                #                   * Shipment/Package/AdditionalHandling element
               end
-              
+
             end
-            
+
             # not implemented:  * Shipment/ShipmentServiceOptions element
-            #                   * Shipment/RateInformation element
-            
+            if options[:origin_account]
+              shipment << XmlNode.new("RateInformation") do |rate_info_node|
+                rate_info_node << XmlNode.new("NegotiatedRatesIndicator")
+              end
+            end
           end
-          
         end
         xml_request.to_s
       end
-      
+
       def build_tracking_request(tracking_number, options={})
         xml_request = XmlNode.new('TrackRequest') do |root_node|
           root_node << XmlNode.new('Request') do |request|
@@ -240,7 +242,7 @@ module ActiveMerchant
         end
         xml_request.to_s
       end
-      
+
       def build_location_node(name,location,options={})
         # not implemented:  * Shipment/Shipper/Name element
         #                   * Shipment/(ShipTo|ShipFrom)/CompanyName element
@@ -249,13 +251,13 @@ module ActiveMerchant
         location_node = XmlNode.new(name) do |location_node|
           location_node << XmlNode.new('PhoneNumber', location.phone.gsub(/[^\d]/,'')) unless location.phone.blank?
           location_node << XmlNode.new('FaxNumber', location.fax.gsub(/[^\d]/,'')) unless location.fax.blank?
-          
+
           if name == 'Shipper' and (origin_account = @options[:origin_account] || options[:origin_account])
             location_node << XmlNode.new('ShipperNumber', origin_account)
           elsif name == 'ShipTo' and (destination_account = @options[:destination_account] || options[:destination_account])
             location_node << XmlNode.new('ShipperAssignedIdentificationNumber', destination_account)
           end
-          
+
           location_node << XmlNode.new('Address') do |address|
             address << XmlNode.new("AddressLine1", location.address1) unless location.address1.blank?
             address << XmlNode.new("AddressLine2", location.address2) unless location.address2.blank?
@@ -270,17 +272,17 @@ module ActiveMerchant
           end
         end
       end
-      
+
       def parse_rate_response(origin, destination, packages, response, options={})
         rates = []
-        
+
         xml = REXML::Document.new(response)
         success = response_success?(xml)
         message = response_message(xml)
-        
+
         if success
           rate_estimates = []
-          
+
           xml.elements.each('/*/RatedShipment') do |rated_shipment|
             service_code = rated_shipment.get_text('Service/Code').to_s
             days_to_delivery = rated_shipment.get_text('GuaranteedDaysToDelivery').to_s.to_i
@@ -292,17 +294,18 @@ module ActiveMerchant
                                 :currency => rated_shipment.get_text('TotalCharges/CurrencyCode').to_s,
                                 :service_code => service_code,
                                 :packages => packages,
-                                :delivery_range => [timestamp_from_business_day(days_to_delivery)])
+                                :delivery_range => [timestamp_from_business_day(days_to_delivery)],
+                                :negotiated_rate =>                               rated_shipment.get_text('NegotiatedRates/NetSummaryCharges/GrandTotal/MonetaryValue').to_s.to_f)
           end
         end
         RateResponse.new(success, message, Hash.from_xml(response).values.first, :rates => rate_estimates, :xml => response, :request => last_request)
       end
-      
+
       def parse_tracking_response(response, options={})
         xml = REXML::Document.new(response)
         success = response_success?(xml)
         message = response_message(xml)
-        
+
         if success
           tracking_number, origin, destination, status_code, status_description = nil
           delivered, exception = false
@@ -314,7 +317,7 @@ module ActiveMerchant
           first_shipment = xml.elements['/*/Shipment']
           first_package = first_shipment.elements['Package']
           tracking_number = first_shipment.get_text('ShipmentIdentificationNumber | Package/TrackingNumber').to_s
-          
+
           # Build status hash
           status_node = first_package.elements['Activity/Status/StatusType']
           status_code = status_node.get_text('Code').to_s
@@ -351,10 +354,10 @@ module ActiveMerchant
               location = location_from_address_node(activity.elements['ActivityLocation/Address'])
               ShipmentEvent.new(description, zoneless_time, location)
             end
-            
+
             shipment_events = shipment_events.sort_by(&:time)
-            
-            # UPS will sometimes archive a shipment, stripping all shipment activity except for the delivery 
+
+            # UPS will sometimes archive a shipment, stripping all shipment activity except for the delivery
             # event (see test/fixtures/xml/delivered_shipment_without_events_tracking_response.xml for an example).
             # This adds an origin event to the shipment activity in such cases.
             if origin && !(shipment_events.count == 1 && status == :delivered)
@@ -377,7 +380,7 @@ module ActiveMerchant
               shipment_events[-1] = ShipmentEvent.new(shipment_events.last.name, shipment_events.last.time, destination)
             end
           end
-          
+
         end
         TrackingResponse.new(success, message, Hash.from_xml(response).values.first,
           :carrier => @@name,
@@ -395,7 +398,7 @@ module ActiveMerchant
           :destination => destination,
           :tracking_number => tracking_number)
       end
-      
+
       def location_from_address_node(address)
         return nil unless address
         Location.new(
@@ -408,7 +411,7 @@ module ActiveMerchant
                 :address3 =>    node_text_or_nil(address.elements['AddressLine3'])
               )
       end
-      
+
       def parse_ups_datetime(options = {})
         time, date = options[:time].to_s, options[:date].to_s
         if time.nil?
@@ -424,29 +427,29 @@ module ActiveMerchant
       def response_success?(xml)
         xml.get_text('/*/Response/ResponseStatusCode').to_s == '1'
       end
-      
+
       def response_message(xml)
         xml.get_text('/*/Response/Error/ErrorDescription | /*/Response/ResponseStatusDescription').to_s
       end
-      
+
       def commit(action, request, test = false)
         ssl_post("#{test ? TEST_URL : LIVE_URL}/#{RESOURCES[action]}", request)
       end
-      
-      
+
+
       def service_name_for(origin, code)
         origin = origin.country_code(:alpha2)
-        
+
         name = case origin
         when "CA" then CANADA_ORIGIN_SERVICES[code]
         when "MX" then MEXICO_ORIGIN_SERVICES[code]
         when *EU_COUNTRY_CODES then EU_ORIGIN_SERVICES[code]
         end
-        
+
         name ||= OTHER_NON_US_ORIGIN_SERVICES[code] unless name == 'US'
         name ||= DEFAULT_SERVICES[code]
       end
-      
+
     end
   end
 end