add location serivce wsdl, base, test and example

Author: radzhome

examples/location_request.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+"""
+This example shows how to use the FedEx Location service.
+The variables populated below represents the minimum required values.
+You will need to fill all of these, or risk seeing a SchemaValidationError
+exception thrown by suds.
+
+"""
+import logging
+from example_config import CONFIG_OBJ
+from fedex.services.location_service import FedexSearchLocationRequest
+
+# Set this to the INFO level to see the response from Fedex printed in stdout.
+logging.basicConfig(level=logging.INFO)
+
+
+# This is the object that will be handling our request.
+# We're using the FedexConfig object from example_config.py in this dir.
+customer_transaction_id = "*** LocationService Request v3 using Python ***"  # Optional transaction_id
+location_request = FedexSearchLocationRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
+
+# Specify the type of search and search criteria.
+location_request.LocationsSearchCriterion = 'PHONE_NUMBER'
+location_request.PhoneNumber = '4169297819'
+location_request.MultipleMatchesAction = 'RETURN_ALL'
+
+# Set constraints, see SearchLocationConstraints definition.
+location_request.Constraints.LocationTypesToInclude = ['FEDEX_SELF_SERVICE_LOCATION',
+                                                       'FEDEX_AUTHORIZED_SHIP_CENTER']
+
+location_request.Address.PostalCode = '38119'
+location_request.Address.CountryCode = 'US'
+
+# If you'd like to see some documentation on the ship service WSDL, un-comment
+# this line. (Spammy).
+# print(rate_request.client)
+
+# Un-comment this to see your complete, ready-to-send request as it stands
+# before it is actually sent. This is useful for seeing what values you can
+# change.
+# print(location_request.LocationsSearchCriterion)
+
+# Fires off the request, sets the 'response' attribute on the object.
+location_request.send_request()
+
+# This will show the reply to your request 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(location_request.response)
+
+# Here is the overall end result of the query.
+print("HighestSeverity:", location_request.response.HighestSeverity)
+

fedex/services/location_service.py

@@ -0,0 +1,79 @@
+"""
+Location Service Module
+=================================
+This package contains the shipping methods defined by Fedex's 
+LocationService 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 FedexSearchLocationRequest(FedexBaseService):
+    """
+    This class allows you validate service availability
+    """
+
+    def __init__(self, config_obj, *args, **kwargs):
+        """
+        @type config_obj: L{FedexConfig}
+        @param config_obj: A valid FedexConfig object.        
+        """
+
+        self._config_obj = config_obj
+        # Holds version info for the VersionId SOAP object.
+        self._version_info = {
+            'service_id': 'locs',
+            'major': '3',
+            'intermediate': '0',
+            'minor': '0'
+        }
+
+        """@ivar: set default objects."""
+        self.Address = None
+        self.PhoneNumber = None
+        self.MultipleMatchesAction = None
+        self.Constraints = []
+        self.LocationsSearchCriterion = None
+
+        """@ivar: Holds the WSDL object."""
+
+        super(FedexSearchLocationRequest, self).__init__(
+            self._config_obj, 'LocationsService_v3.wsdl', *args, **kwargs)
+
+    def _prepare_wsdl_objects(self):
+        """
+        Create the data structure and get it ready for the WSDL request.
+        """
+        self.MultipleMatchesAction = 'RETURN_ALL'
+        self.Constraints = self.create_wsdl_object_of_type('SearchLocationConstraints')
+        self.Address = self.create_wsdl_object_of_type('Address')
+
+    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.
+        """
+
+        # We get an exception like this when specifying an IntegratorId:
+        # suds.TypeNotFound: Type not found: 'IntegratorId'
+        # Setting it to None does not seem to appease it.
+        del self.ClientDetail.IntegratorId
+        self.logger.debug(self.WebAuthenticationDetail)
+        self.logger.debug(self.ClientDetail)
+        self.logger.debug(self.TransactionDetail)
+        self.logger.debug(self.VersionId)
+        # Fire off the query.
+        return self.client.service.searchLocations(
+            WebAuthenticationDetail=self.WebAuthenticationDetail,
+            ClientDetail=self.ClientDetail,
+            TransactionDetail=self.TransactionDetail,
+            Version=self.VersionId,
+            LocationsSearchCriterion=self.LocationsSearchCriterion,
+            PhoneNumber=self.PhoneNumber,
+            MultipleMatchesAction=self.MultipleMatchesAction,
+            Constraints=self.Constraints,
+            Address=self.Address)