Adding shipment validation on FedexProcessShipmentRequest objects via send_validation_request(). This is a good way to make sure you've got valid data before actually committing to creating a shipment with it. Works almost exactly like just sending the request. Also adding the beginnings of shipment deletion (not at all functional yet).

Author: Greg Taylor

examples/create_shipment.py

@@ -114,13 +114,18 @@
 # change.
 #print shipment.RequestedShipment
 
+# If you want to make sure that all of your entered details are valid, you
+# can call this and parse it just like you would via send_request(). If
+# shipment.response.HighestSeverity == "SUCCESS", your shipment is valid.
+#shipment.send_validation_request()
+
 # Fires off the request, sets the 'response' attribute on the object.
 shipment.send_request()
 
 # This will show the reply to your shipment being sent. You can access the
 # attributes through the response attribute on the request object. This is
 # good to un-comment to see the variables returned by the Fedex reply.
-print shipment.response
+#print shipment.response
 
 # Here is the overall end result of the query.
 print "HighestSeverity:", shipment.response.HighestSeverity

fedex/base_service.py

@@ -194,13 +194,25 @@ def create_wsdl_object_of_type(self, type_name):
         """
         return self.client.factory.create(type_name)
 
-    def send_request(self):
+    def send_request(self, send_function=None):
         """
         Sends the assembled request on the child object.
+        @type send_function: L{function}
+        @keyword send_function: A function reference (passed without the
+            parenthesis) to a function that will send the request. This
+            allows for overriding the default function in cases such as
+            validation requests.
         """
         # Send the request and get the response back.
         try:
-            self.response = self._assemble_and_send_request()
+            # If the user has overridden the send function, use theirs
+            # instead of the default.
+            if send_function:
+                # Follow the overridden function.
+                self.response = send_function()
+            else:
+                # Default scenario, business as usual.
+                self.response = self._assemble_and_send_request()
         except suds.WebFault:
             # When this happens, throw an informative message reminding the
             # user to check all required variables, making sure they are
@@ -215,5 +227,5 @@ def send_request(self):
         self._check_response_for_request_errors()
 
         # Debug output.
-        self.logger.info("== FEDEX QUERY RESULT ==")
-        self.logger.info(self.response)
+        self.logger.debug("== FEDEX QUERY RESULT ==")
+        self.logger.debug(self.response)

fedex/services/ship_service.py

@@ -112,6 +112,30 @@ def __set_requested_shipment(self):
         # looks like.
         self.logger.info(self.RequestedShipment)
 
+    def send_validation_request(self):
+        """
+        This is very similar to just sending the shipment via the typical
+        send_request() function, but this doesn't create a shipment. It is
+        used to make sure "good" values are given by the user or the
+        application using the library.
+        """
+        self.send_request(send_function=self._assemble_and_send_validation_request)
+        
+    def _assemble_and_send_validation_request(self):
+        """
+        Fires off the Fedex request.
+        
+        @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
+            ON FedexBaseService AND IS INHERITED.
+        """
+        # Fire off the query.
+        response = self.client.service.processShipment(WebAuthenticationDetail=self.WebAuthenticationDetail,
+                                        ClientDetail=self.ClientDetail,
+                                        TransactionDetail=self.TransactionDetail,
+                                        Version=self.VersionId,
+                                        RequestedShipment=self.RequestedShipment)
+        return response
+    
     def _assemble_and_send_request(self):
         """
         Fires off the Fedex request.
@@ -140,4 +164,89 @@ def add_package(self, package_item):
         self.RequestedShipment.RequestedPackageLineItems.append(package_item)
         package_weight = package_item.Weight.Value
         self.RequestedShipment.TotalWeight.Value += package_weight
-        self.RequestedShipment.PackageCount += 1
+        self.RequestedShipment.PackageCount += 1
+        
+class FedexDeleteShipmentRequest(FedexBaseService):
+    """
+    This class allows you to delete a shipment, given a tracking number.
+    """
+    def __init__(self, config_obj, tracking_value,
+                 package_identifier='TRACKING_NUMBER_OR_DOORTAG',
+                 *args, **kwargs):
+        """
+        Sends a shipment tracking request. The optional keyword args
+        detailed on L{FedexBaseService} apply here as well.
+        
+        @type config_obj: L{FedexConfig}
+        @param config_obj: A valid FedexConfig object.
+        @type  tracking_value: L{str} 
+        @param tracking_value: Based on the value of package_identifier, 
+            this will be anything from a tracking number to a purchase order 
+            number.
+        @type    package_identifier: L{str}
+        @keyword package_identifier: Determines what you are using to query for
+            the shipment. The default assumes that tracking_value will be a Fedex 
+            tracking number.
+        """
+        self._config_obj = config_obj
+        
+        # Holds version info for the VersionId SOAP object.
+        self._version_info = {'service_id': 'trck', 'major': '4', 
+                             'intermediate': '0', 'minor': '0'}
+        # Call the parent FedexBaseService class for basic setup work.
+        super(FedexTrackRequest, self).__init__(self._config_obj, 
+                                                'TrackService_v4.wsdl',
+                                                *args, **kwargs)
+
+        # Important request-specific instance variables.
+        self.package_identifier = package_identifier
+        """@ivar: Determines what L{tracking_value} is, be it a tracking number,
+            purchase order, or other things."""
+        self.tracking_value = tracking_value
+        """@ivar: This is typically a Fedex tracking number, but setting 
+            L{package_identifier} to other values makes this change."""
+        
+    def __set_track_package_identifier(self):
+        """
+        This sets the package identifier information. This may be a tracking
+        number or a few different things as per the Fedex spec.
+        """
+        TrackPackageIdentifier = self.client.factory.create('TrackPackageIdentifier')
+        TrackPackageIdentifier.Type = self.package_identifier
+        TrackPackageIdentifier.Value = self.tracking_value
+        self.logger.debug(TrackPackageIdentifier)
+        self.TrackPackageIdentifier = TrackPackageIdentifier
+        
+    def _check_response_for_request_errors(self):
+        """
+        Checks the response to see if there were any errors specific to
+        this WSDL.
+        """
+        if self.response.HighestSeverity == "ERROR":
+            for notification in self.response.Notifications:
+                if notification.Severity == "ERROR":
+                    if "Invalid tracking number" in notification.Message:
+                        raise FedexInvalidTrackingNumber(notification.Code,
+                                                         notification.Message)
+                    else:
+                        raise FedexError(notification.Code,
+                                         notification.Message)
+        
+    def _assemble_and_send_request(self):
+        """
+        Fires off the Fedex request.
+        
+        @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
+            ON FedexBaseService AND IS INHERITED.
+        """
+        self.__set_track_package_identifier()
+        client = self.client
+        # Fire off the query.
+        response = client.service.track(WebAuthenticationDetail=self.WebAuthenticationDetail,
+                                        ClientDetail=self.ClientDetail,
+                                        TransactionDetail=self.TransactionDetail,
+                                        Version=self.VersionId,
+                                        CarrierCodeType=self.CarrierCodeType,
+                                        PackageIdentifier=self.TrackPackageIdentifier)
+
+        return response

fedex/services/track_service.py

@@ -58,17 +58,17 @@ def __init__(self, config_obj, tracking_value,
         self.tracking_value = tracking_value
         """@ivar: This is typically a Fedex tracking number, but setting 
             L{package_identifier} to other values makes this change."""
+        # Get the object ready for manipulation.
+        self.__set_track_package_identifier()
 
     def __set_track_package_identifier(self):
         """
         This sets the package identifier information. This may be a tracking
         number or a few different things as per the Fedex spec.
         """
-        TrackPackageIdentifier = self.client.factory.create('TrackPackageIdentifier')
-        TrackPackageIdentifier.Type = self.package_identifier
-        TrackPackageIdentifier.Value = self.tracking_value
-        self.logger.debug(TrackPackageIdentifier)
-        self.TrackPackageIdentifier = TrackPackageIdentifier
+        self.TrackPackageIdentifier = self.client.factory.create('TrackPackageIdentifier')
+        self.TrackPackageIdentifier.Type = self.package_identifier
+        self.TrackPackageIdentifier.Value = self.tracking_value
 
     def _check_response_for_request_errors(self):
         """
@@ -92,7 +92,6 @@ def _assemble_and_send_request(self):
         @warning: NEVER CALL THIS METHOD DIRECTLY. CALL send_request(), WHICH RESIDES
             ON FedexBaseService AND IS INHERITED.
         """
-        self.__set_track_package_identifier()
         client = self.client
         # Fire off the query.
         response = client.service.track(WebAuthenticationDetail=self.WebAuthenticationDetail,