improved output for location service example, updated doc

Author: radzhome

examples/location_request.py

@@ -11,6 +11,7 @@
 
 from example_config import CONFIG_OBJ
 from fedex.services.location_service import FedexSearchLocationRequest
+from fedex.tools.response_tools import sobject_to_dict
 
 # Set this to the INFO level to see the response from Fedex printed in stdout.
 logging.basicConfig(stream=sys.stdout, level=logging.INFO)
@@ -26,6 +27,7 @@
 location_request.MultipleMatchesAction = 'RETURN_ALL'
 
 # Set constraints, see SearchLocationConstraints definition.
+# For LocationTypesToInclude, see FedExLocationType definition.
 location_request.Constraints.LocationTypesToInclude = ['FEDEX_SELF_SERVICE_LOCATION',
                                                        'FEDEX_AUTHORIZED_SHIP_CENTER']
 
@@ -49,5 +51,54 @@
 # good to un-comment to see the variables returned by the FedEx reply.
 # print(location_request.response)
 
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+print(sobject_to_dict(location_request.response))
+
 # Here is the overall end result of the query.
-print("HighestSeverity:", location_request.response.HighestSeverity)
+print("HighestSeverity: {}".format(location_request.response.HighestSeverity))
+print("TotalResultsAvailable: {}".format(location_request.response.TotalResultsAvailable))
+print("ResultsReturned: {}".format(location_request.response.ResultsReturned))
+
+result = location_request.response.AddressToLocationRelationships[0]
+print("MatchedAddress: {}, {} Residential: {}".format(result.MatchedAddress.PostalCode,
+                                                      result.MatchedAddress.CountryCode,
+                                                      result.MatchedAddress.Residential))
+print("MatchedAddressGeographicCoordinates: {}".format(result.MatchedAddressGeographicCoordinates.strip("/")))
+
+# Locations sorted by closest found to furthest.
+locations = result.DistanceAndLocationDetails
+for location in locations:
+    print("Distance: {}{}".format(location.Distance.Value, location.Distance.Units))
+
+    location_detail = location.LocationDetail
+    print("LocationID: {}".format(location_detail.LocationId))
+    print("StoreNumber: {}".format(location_detail.StoreNumber))
+
+    if hasattr(location_detail, 'LocationContactAndAddress'):
+        contact_and_address = location_detail.LocationContactAndAddress
+        contact_and_address = sobject_to_dict(contact_and_address)
+        print("LocationContactAndAddress Dict: {}".format(contact_and_address))
+
+    print("GeographicCoordinates {}".format(getattr(location_detail, 'GeographicCoordinates')))
+    print("LocationType {}".format(getattr(location_detail, 'LocationType')))
+
+    if hasattr(location_detail, 'Attributes'):
+        for attribute in location_detail.Attributes:
+            print "Attribute: {}".format(attribute)
+
+    print("MapUrl {}".format(getattr(location_detail, 'MapUrl')))
+
+    if hasattr(location_detail, 'NormalHours'):
+        for open_time in location_detail.NormalHours:
+            print("NormalHours Dict: {}".format(sobject_to_dict(open_time)))
+
+    if hasattr(location_detail, 'HoursForEffectiveDate'):
+        for effective_open_time in location_detail.HoursForEffectiveDate:
+            print("HoursForEffectiveDate Dict: {}".format(sobject_to_dict(effective_open_time)))
+
+    if hasattr(location_detail, 'CarrierDetails'):
+        for carrier_detail in location_detail.CarrierDetails:
+            print("CarrierDetails Dict: {}".format(sobject_to_dict(carrier_detail)))
+
+    print("")

fedex/services/location_service.py

@@ -12,7 +12,9 @@
 
 class FedexSearchLocationRequest(FedexBaseService):
     """
-    This class allows you validate service availability
+    This class allows you to figure out a FedEx location closest
+    to a specified location, based on location type. The response includes
+    location details like operating times, directions and a map link.
     """
 
     def __init__(self, config_obj, *args, **kwargs):

fedex/tools/__init__.py

@@ -0,0 +1,53 @@
+"""Response output conversion tools to help parse suds
+response object output.
+"""
+from suds.sudsobject import asdict
+from suds.sax.text import Text
+
+
+def object_to_dict(obj):
+    """ Converts a suds object to a dictionary.
+    :param o: object
+    :return: dictionary
+    """
+    out = {}
+    for k, v in asdict(obj).items():
+        k = k.lower()
+        if hasattr(v, '__keylist__'):
+            out[k] = object_to_dict(v)
+        elif isinstance(v, list):
+            out[k] = []
+            for item in v:
+                if hasattr(item, '__keylist__'):
+                    out[k].append(object_to_dict(item))
+                else:
+                    out[k].append(
+                        item.title() if isinstance(item, Text) else item)
+        else:
+            out[k] = v.title() if isinstance(v, Text) else v
+    return out
+#
+# import datetime
+#
+# def object_to_dict(obj):
+#     """ Converts an object to a dictionary.
+#     :param o: object
+#     :return: dictionary
+#     """
+#     if isinstance(obj, (str, unicode, bool, int, long, float, datetime.datetime, datetime.date, datetime.time)):
+#         return obj
+#     data_dict = {}
+#     try:
+#         all_keys = obj.__dict__.keys()  # vars(obj).keys()
+#     except AttributeError:
+#         return obj
+#     fields = [k for k in all_keys if not k.startswith('_')]
+#     for field in fields:
+#         val = getattr(obj, field)
+#         if isinstance(val, (list, tuple)):
+#             data_dict[field] = []
+#             for item in val:
+#                 data_dict[field].append(object_to_dict(item))
+#         else:
+#             data_dict[field] = object_to_dict(val)
+#     return data_dict