Bringing the source code in.

Author: Greg Taylor

example.py

@@ -0,0 +1,24 @@
+import logging
+from fedex.services.ship_service import FedexTrackRequest
+from fedex.config import FedexConfig
+
+# Set this to the INFO level to see the response from Fedex printed in stdout.
+logging.basicConfig(level=logging.INFO)
+
+# FedexConfig objects should generally only be instantiated once and re-used
+# amongst different queries. They hold static data like account number.
+config_obj = FedexConfig(key='ZyNQQFdcxUATOx9L',
+                         password='GtngmKzs4Dk4RYmrlAjrLykwi',
+                         account_number='510087780',
+                         meter_number='118501898')
+
+# This is the object that will be handling our tracking request.
+track = FedexTrackRequest(config_obj, '1777768882')
+# Fires off the request, sets the 'response' attribute on the object.
+track.send_request()
+
+# Look through the matches (there should only be one for a tracking number
+# query), and show a few details about each shipment.
+for match in track.response.TrackDetails:
+    print "TRACKING #:", match.TrackingNumber
+    print "STATUS:", match.StatusDescription

fedex/__init__.py

@@ -0,0 +1,91 @@
+import os
+import logging
+from suds.client import Client
+
+class FedexBaseService(object):
+    def __init__(self, config_obj, wsdl_name, *args, **kwargs):
+        self.config_obj = config_obj
+        self.wsdl_path = os.path.join(config_obj.wsdl_path, wsdl_name)
+        self.client = Client('file://%s' % self.wsdl_path)
+        self.logger = logging.getLogger('fedex')
+        
+        self.logger.debug(self.client)
+        self.set_web_authentication_detail()
+        self.set_client_detail()
+        self.set_version_id()
+        self.set_carrier_code_type(*args, **kwargs)
+        self.set_transaction_detail(*args, **kwargs)
+        
+    def set_web_authentication_detail(self):
+        """
+        Sets up the WebAuthenticationDetail node. This is required for all
+        requests.
+        """
+        # Start of the authentication stuff.
+        WebAuthenticationCredential = self.client.factory.create('WebAuthenticationCredential')
+        WebAuthenticationCredential.Key = self.config_obj.key
+        WebAuthenticationCredential.Password = self.config_obj.password
+        
+        # Encapsulates the auth credentials.
+        WebAuthenticationDetail = self.client.factory.create('WebAuthenticationDetail')
+        WebAuthenticationDetail.UserCredential = WebAuthenticationCredential
+        self.logger.debug(WebAuthenticationDetail)
+        self.WebAuthenticationDetail = WebAuthenticationDetail
+        
+    def set_client_detail(self):
+        """
+        Sets up the ClientDetail node, which is required for all shipping
+        related requests.
+        """
+        ClientDetail = self.client.factory.create('ClientDetail')
+        ClientDetail.AccountNumber = self.config_obj.account_number
+        ClientDetail.MeterNumber = self.config_obj.meter_number
+        ClientDetail.IntegratorId = self.config_obj.integrator_id
+        self.logger.debug(ClientDetail)
+        self.ClientDetail = ClientDetail
+        
+    def set_transaction_detail(self, *args, **kwargs):
+        """
+        Checks kwargs for 'customer_transaction_id' and sets it if present.
+        """
+        customer_transaction_id = kwargs.get('customer_transaction_id', False)
+        if customer_transaction_id:
+            TransactionDetail = client.factory.create('TransactionDetail')
+            TransactionDetail.CustomerTransactionId = customer_transaction_id
+            self.logger.debug(TransactionDetail)
+            self.TransactionDetail = TransactionDetail
+        else:
+            self.TransactionDetail = None
+            
+    def set_carrier_code_type(self, *args, **kwargs):
+        """
+        Checks kwargs for 'carrier_code' and sets it if present. 
+        """
+        carrier_code = kwargs.get('carrier_code', False)
+        if carrier_code:
+            CarrierCodeType = self.client.factory.create('CarrierCodeType')
+            CarrierCodeType.Type = carrier_code
+            self.logger.debug(CarrierCodeType)
+            self.CarrierCodeType = CarrierCodeType
+        else:
+            self.CarrierCodeType = None
+    
+    def set_version_id(self):
+        """
+        Pulles the versioning info for the request from the child request.
+        """
+        VersionId = self.client.factory.create('VersionId')
+        VersionId.ServiceId = self.version_info['service_id']
+        VersionId.Major = self.version_info['major']
+        VersionId.Intermediate = self.version_info['intermediate']
+        VersionId.Minor = self.version_info['minor']
+        self.logger.debug(VersionId)
+        self.VersionId = VersionId
+        
+    def send_request(self):
+        """
+        Sends the assembled request on the child object.
+        """
+        self.response = self.assemble_and_send_request()
+        self.logger.info("== FEDEX QUERY RESULT ==")
+        self.logger.info(self.response)

fedex/base_service.py

@@ -0,0 +1,21 @@
+import os
+import sys
+
+class FedexConfig(object):
+    """
+    Base configuration class that is used for the different Fedex SOAP calls.
+    """
+    def __init__(self, key, password, account_number=None, meter_number=None,
+                 integrator_id=None, wsdl_path=None):
+        self.key = key
+        self.password = password
+        self.account_number = account_number
+        self.meter_number = meter_number
+        self.integrator_id = integrator_id
+        
+        # Allow overriding of the WDSL path.
+        if wsdl_path == None:
+            self.wsdl_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 
+                                          'wsdl')
+        else:
+            self.wsdl_path = wsdl_path

fedex/config.py

@@ -0,0 +1,55 @@
+from .. base_service import FedexBaseService
+
+class FedexTrackRequest(FedexBaseService):
+    def __init__(self, config_obj, tracking_value,
+                 package_identifier='TRACKING_NUMBER_OR_DOORTAG',
+                 *args, **kwargs):
+        """
+        Sends a shipment tracking request.
+        
+        package_identifier: (str) Determines what you are using to query for
+                                  the shipment. The default assumes that
+                                  tracking_value will be a Fedex tracking #.
+        tracking_value: (str) Based on the value of package_identifier, this
+                              will be anything from a tracking number to 
+                              a purchase order 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__(config_obj, 
+                                                'TrackService_v4.wsdl',
+                                                *args, **kwargs)
+        # Start preparing the Fedex-specific things.
+        self.tracking_value = tracking_value
+        self.package_identifier = package_identifier
+        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
+        
+    def assemble_and_send_request(self):
+        """
+        Fires off the Fedex request.
+        NEVER CALL THIS METHOD DIRECTLY. CALL SEND_REQUEST(), WHICH RESIDES
+        ON FedexBaseService AND IS INHERITED.
+        """
+        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