Merge pull request #66 from python-fedex-devs/location_v3

Location v3 add location serivce wsdl, base, test and example

Author: radzhome

examples/README.txt examples/README.rstexamples/README.txt renamed to examples/README.rst

@@ -1,5 +1,12 @@
 python-fedex Examples
 =====================
+
 This directory contains a number of examples of how to use python-fedex. For
 these examples to work, you must open example_config.py and enter your
 testing account credentials there.
+
+To run all tests from bash, type:
+
+    for f in *.py; do python "$f"; done
+    # Or use the below to only see response errors:
+    for f in *.py; do python "$f"; done | grep -i error

examples/address_validation.py

@@ -4,14 +4,16 @@
 class can handle up to 100 addresses for validation.
 """
 import logging
+import sys
+
 from example_config import CONFIG_OBJ
 from fedex.services.address_validation_service import FedexAddressValidationRequest
 
 # NOTE: TO USE ADDRESS VALIDATION SERVICES, YOU NEED TO REQUEST FEDEX TO ENABLE THIS SERVICE FOR YOUR ACCOUNT.
 # BY DEFAULT, THE SERVICE IS DISABLED AND YOU WILL RECEIVE AUTHENTICATION FAILED, 1000 RESPONSE.
 
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
 
 # This is the object that will be handling our avs request.
 # We're using the FedexConfig object from example_config.py in this dir.
@@ -47,7 +49,6 @@ class can handle up to 100 addresses for validation.
 address2.Address.CountryCode = 'US'
 avs_request.add_address(address2)
 
-
 # If you'd like to see some documentation on the ship service WSDL, un-comment
 # this line. (Spammy).
 # print(avs_request.client)
@@ -63,7 +64,16 @@ class can handle up to 100 addresses for validation.
 avs_request.send_request()
 
 # good to un-comment to see the variables returned by the Fedex reply.
-print(avs_request.response)
+# print(avs_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.response_tools import basic_sobject_to_dict
+# print(basic_sobject_to_dict(avs_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.response_tools import sobject_to_json
+# print(sobject_to_json(avs_request.response))
 
 # Overall end result of the query
 for i in range(len(avs_request.response.AddressResults)):

examples/country_postal_inquiry.py

@@ -9,18 +9,18 @@
 label data that is returned with the reply.
 """
 import logging
+import sys
 import binascii
+
 from example_config import CONFIG_OBJ
 from fedex.services.ship_service import FedexProcessShipmentRequest
 
 # What kind of file do you want this example to generate?
 # Valid choices for this example are PDF, PNG
 GENERATE_IMAGE_TYPE = 'PDF'
 
-
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-# logging.basicConfig(filename="suds.log", level=logging.DEBUG)
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
 
 # NOTE: A VALID 'freight_account_number' REQUIRED IN YOUR 'CONFIB_OBJ' FOR THIS SERVICE TO WORK.
 # OTHERWISE YOU WILL GET FEDEX FREIGHT OR ASSOCIATED ADDRESS IS REQUIRED, ERROR 3619.
@@ -87,7 +87,6 @@
 shipment.RequestedShipment.FreightShipmentDetail.Role = role.SHIPPER
 shipment.RequestedShipment.FreightShipmentDetail.CollectTermsType = 'STANDARD'
 
-
 # Specifies the label type to be returned.
 shipment.RequestedShipment.LabelSpecification.LabelFormatType = 'FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING'
 
@@ -147,7 +146,18 @@
 # 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)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with. Also see basic_sobject_to_dict, it's faster but lacks options.
+# from fedex.tools.response_tools import sobject_to_dict
+# response_dict = sobject_to_dict(shipment.response)
+# response_dict['CompletedShipmentDetail']['ShipmentDocuments'][0]['Parts'][0]['Image'] = ''
+# print(response_dict)  # Image is empty string for display purposes.
+
+# This will dump the response data dict to json.
+# from fedex.tools.response_tools import sobject_to_json
+# print(sobject_to_json(shipment.response))
 
 # Here is the overall end result of the query.
 print("HighestSeverity: {}".format(shipment.response.HighestSeverity))
@@ -160,7 +170,6 @@
 amount = shipment.response.CompletedShipmentDetail.ShipmentRating.ShipmentRateDetails[0].TotalNetCharge.Amount
 print("Net Shipping Cost (US$): {}".format(amount))
 
-
 # # Get the label image in ASCII format from the reply. Note the list indices
 # we're using. You'll need to adjust or iterate through these if your shipment
 # has multiple packages.

examples/create_freight_shipment.py

@@ -10,6 +10,7 @@
 import logging
 import binascii
 import datetime
+import sys
 
 from example_config import CONFIG_OBJ
 from fedex.services.ship_service import FedexProcessShipmentRequest
@@ -18,9 +19,8 @@
 # Valid choices for this example are PDF, PNG
 GENERATE_IMAGE_TYPE = 'PDF'
 
-
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, level=logging.INFO)
 
 # This is the object that will be handling our shipment request.
 # We're using the FedexConfig object from example_config.py in this dir.
@@ -147,7 +147,18 @@
 # 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)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with. Also see basic_sobject_to_dict, it's faster but lacks options.
+# from fedex.tools.response_tools import sobject_to_dict
+# response_dict = sobject_to_dict(shipment.response)
+# response_dict['CompletedShipmentDetail']['CompletedPackageDetails'][0]['Label']['Parts'][0]['Image'] = ''
+# print(response_dict)  # Image is empty string for display purposes.
+
+# This will dump the response data dict to json.
+# from fedex.tools.response_tools import sobject_to_json
+# print(sobject_to_json(shipment.response))
 
 # Here is the overall end result of the query.
 print("HighestSeverity: {}".format(shipment.response.HighestSeverity))

examples/create_shipment.py

@@ -3,11 +3,14 @@
 This example shows how to delete existing shipments.
 """
 import logging
+import sys
+
 from example_config import CONFIG_OBJ
 from fedex.services.ship_service import FedexDeleteShipmentRequest
+from fedex.base_service import FedexError
 
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, 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.
@@ -19,15 +22,33 @@
 del_request.DeletionControlType = "DELETE_ALL_PACKAGES"
 
 # The tracking number of the shipment to delete.
-del_request.TrackingId.TrackingNumber = '794798682968'
+del_request.TrackingId.TrackingNumber = '794798682968'  # '111111111111' will also not delete
 
 # What kind of shipment the tracking number used.
 # Docs say this isn't required, but the WSDL won't validate without it.
 # EXPRESS, GROUND, or USPS
 del_request.TrackingId.TrackingIdType = 'EXPRESS'
 
 # Fires off the request, sets the 'response' attribute on the object.
-del_request.send_request()
+try:
+    del_request.send_request()
+except FedexError as e:
+    if 'Unable to retrieve record' in str(e):
+        print "WARNING: Unable to delete the shipment with the provided tracking number."
+    else:
+        print(e)
 
 # See the response printed out.
-print(del_request.response)
+# print(del_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.response_tools import basic_sobject_to_dict
+# print(basic_sobject_to_dict(del_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.response_tools import sobject_to_json
+# print(sobject_to_json(del_request.response))
+
+# Here is the overall end result of the query.
+print("HighestSeverity: {}".format(del_request.response.HighestSeverity))

examples/delete_shipment.py

@@ -5,6 +5,7 @@
 """
 import os
 import sys
+
 # Use the fedex directory included in the downloaded package instead of
 # any globally installed versions.
 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

examples/example_config.py

@@ -9,11 +9,13 @@
      is Out of Delivery Area (ODA).
 """
 import logging
+import sys
+
 from example_config import CONFIG_OBJ
 from fedex.services.rate_service import FedexRateServiceRequest
 
-# Set this to the INFO level to see the response from Fedex printed in stdout.
-logging.basicConfig(level=logging.INFO)
+# Un-comment to see the response from Fedex printed in stdout.
+logging.basicConfig(stream=sys.stdout, 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.
@@ -29,7 +31,6 @@
 
 rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightAccountNumber = CONFIG_OBJ.freight_account_number
 
-
 # Shipper
 rate_request.RequestedShipment.Shipper.AccountNumber = CONFIG_OBJ.freight_account_number
 rate_request.RequestedShipment.Shipper.Contact.PersonName = 'Sender Name'
@@ -113,17 +114,26 @@
 # This will show the reply to your rate_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(rate_request.response)
+# print(rate_request.response)
+
+# This will convert the response to a python dict object. To
+# make it easier to work with.
+# from fedex.tools.response_tools import basic_sobject_to_dict
+# print(basic_sobject_to_dict(rate_request.response))
+
+# This will dump the response data dict to json.
+# from fedex.tools.response_tools import sobject_to_json
+# print(sobject_to_json(rate_request.response))
 
 # Here is the overall end result of the query.
-print("HighestSeverity:", rate_request.response.HighestSeverity)
+print("HighestSeverity: {}".format(rate_request.response.HighestSeverity))
 
 # RateReplyDetails can contain rates for multiple ServiceTypes if ServiceType was set to None
 for service in rate_request.response.RateReplyDetails:
     for detail in service.RatedShipmentDetails:
         for surcharge in detail.ShipmentRateDetail.Surcharges:
             if surcharge.SurchargeType == 'OUT_OF_DELIVERY_AREA':
-                print("%s: ODA rate_request charge {}".format(service.ServiceType, surcharge.Amount.Amount))
+                print("{}: ODA rate_request charge {}".format(service.ServiceType, surcharge.Amount.Amount))
 
     for rate_detail in service.RatedShipmentDetails:
         print("{}: Net FedEx Charge {} {}".format(service.ServiceType,