Re-arranging to more intelligently name stuff. Handle Fedex server errors. Beginnings of the Shipment module.

Author: Greg Taylor

examples/track_shipment.py

@@ -3,7 +3,7 @@
 This example shows how to track shipments.
 """
 import logging
-from fedex.services.ship_service import FedexTrackRequest
+from fedex.services.track_service import FedexTrackRequest
 from fedex.config import FedexConfig
 
 # Set this to the INFO level to see the response from Fedex printed in stdout.

fedex/base_service.py

@@ -10,6 +10,24 @@
 import logging
 from suds.client import Client
 
+class FedexBaseServiceException(Exception):
+    """
+    Serves as the base exception that other service-related exception objects
+    are sub-classed from.
+    """
+    def __init__(self, value):
+        self.value = value
+    def __str__(self):
+        return repr(self.value)
+    
+class FedexFailure(FedexBaseServiceException):
+    """
+    The request could not be handled at this time. This is generally a server
+    problem.
+    """
+    def __init__(self):
+        self.value = "Your request could not be handled at this time. This is likely Fedex server problems, try again later."
+
 class FedexBaseService(object):
     """
     This class is the master class for all Fedex request objects. It gets all
@@ -124,10 +142,19 @@ def __set_version_id(self):
         self.logger.debug(VersionId)
         self.VersionId = VersionId
 
+    def __check_response_for_fedex_error(self):
+        """
+        This checks the response for general Fedex errors that aren't related
+        to any one WSDL.
+        """
+        if self.response.HighestSeverity == "FAILURE":
+            raise FedexFailure()
+        
     def send_request(self):
         """
         Sends the assembled request on the child object.
         """
         self.response = self._assemble_and_send_request()
+        self.__check_response_for_fedex_error()
         self.logger.info("== FEDEX QUERY RESULT ==")
         self.logger.info(self.response)

fedex/services/ship_service.py

@@ -1,13 +1,13 @@
 """
 Ship Service Module
 ===================
-This package contains the shipping and tracking methods defined by Fedex's 
+This package contains the shipping methods defined by Fedex's 
 ShipService WSDL file. Each is encapsulated in a class for easy access. 
 For more details on each, refer to the respective class's documentation.
 """
 from .. base_service import FedexBaseService
 
-class FedexTrackRequest(FedexBaseService):
+class FedexShipRequest(FedexBaseService):
     """
     This class allows you to track shipments by providing a tracking
     number or other identifying features. By default, you
@@ -35,31 +35,19 @@ def __init__(self, config_obj, tracking_value,
         self._config_obj = config_obj
 
         # Holds version info for the VersionId SOAP object.
-        self._version_info = {'service_id': 'trck', 'major': '4', 
+        self._version_info = {'service_id': 'trck', 'major': '7', 
                              'intermediate': '0', 'minor': '0'}
         # Call the parent FedexBaseService class for basic setup work.
-        super(FedexTrackRequest, self).__init__(self._config_obj, 
-                                                'TrackService_v4.wsdl',
+        super(FedexShipRequest, self).__init__(self._config_obj, 
+                                                'ShipService_v7.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):
+    def __set_transactional_detail(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
+        TransactionDetail = self.client.factory.create('TransactionDetail')
+        self.logger.info(TransactionDetail)
+        self.TransactionDetail = TransactionDetail
 
     def _assemble_and_send_request(self):
         """
@@ -68,13 +56,14 @@ 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()
+        self.__set_transactional_detail()
         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
+        """
+        processShipment(WebAuthenticationDetail WebAuthenticationDetail, 
+                        ClientDetail ClientDetail, 
+                        TransactionDetail TransactionDetail, 
+                        VersionId Version, 
+                        RequestedShipment RequestedShipment)
+        """
+        #return response

fedex/services/track_service.py

@@ -0,0 +1,82 @@
+"""
+Tracking Service Module
+=======================
+This package contains the shipment tracking methods defined by Fedex's 
+TrackService WSDL file. Each is encapsulated in a class for easy access. 
+For more details on each, refer to the respective class's documentation.
+"""
+import logging
+from .. base_service import FedexBaseService
+
+class FedexTrackRequest(FedexBaseService):
+    """
+    This class allows you to track shipments by providing a tracking
+    number or other identifying features. By default, you
+    can simply pass a tracking number to the constructor. If you would like
+    to query shipments based on something other than tracking number, you will
+    want to read the documentation for the L{__init__} method. 
+    Particularly, the tracking_value and package_identifier arguments.
+    """
+    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  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 _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

test_runner.py

@@ -4,12 +4,12 @@
 this before any release and after patch submissions.
 """
 import unittest
-from tests import t_ship_service
+from tests import t_track_service
 
 # A list of the modules under the tests package that should be ran.
-test_modules = [t_ship_service]
+test_modules = [t_track_service]
 
 # Fire off all of the tests.
 for mod in test_modules:
     suite = unittest.TestLoader().loadTestsFromModule(mod)
-    unittest.TextTestRunner(verbosity=2).run(suite)
+    unittest.TextTestRunner(verbosity=3).run(suite)

tests/t_ship_service.py tests/t_track_service.pytests/t_ship_service.py renamed to tests/t_track_service.py

@@ -2,13 +2,13 @@
 Test module for the Fedex ShipService WSDL.
 """
 import unittest
-from fedex.services.ship_service import FedexTrackRequest
+from fedex.services.track_service import FedexTrackRequest
 import common
 
 # Common global config object for testing.
 CONFIG_OBJ = common.get_test_config()
 
-class ShipServiceTests(unittest.TestCase):
+class TrackServiceTests(unittest.TestCase):
     """
     These tests verify that the shipping service WSDL is in good shape.
     """
@@ -19,7 +19,7 @@ def test_track(self):
         """
         track_request = FedexTrackRequest(CONFIG_OBJ, '1777768882')
         track_request.send_request()
-        
+            
         for match in track_request.response.TrackDetails:
             # This should be the same tracking number on the response that we
             # asked for in the request.