Merge pull request #33 from foxxyz/master

Updated RateRequest WSDL from v8 to v16

Author: gtaylor

examples/freight_rate_request.py

@@ -1,11 +1,11 @@
 #!/usr/bin/env python
 """
-This example shows how to use the FedEx RateRequest service. 
-The variables populated below represents the minimum required values. 
-You will need to fill all of these, or risk seeing a SchemaValidationError 
+This example shows how to use the FedEx RateRequest 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.
 
-TIP: Near the bottom of the module, see how to check the if the destination 
+TIP: Near the bottom of the module, see how to check the if the destination
      is Out of Delivery Area (ODA).
 """
 import logging
@@ -19,7 +19,7 @@
 # We're using the FedexConfig object from example_config.py in this dir.
 rate_request = FedexRateServiceRequest(CONFIG_OBJ)
 
-rate_request.RequestedShipment.ServiceType = 'FEDEX_FREIGHT'
+rate_request.RequestedShipment.ServiceType = 'FEDEX_FREIGHT_ECONOMY'
 
 rate_request.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
 
@@ -42,11 +42,7 @@
 #include estimated duties and taxes in rate quote, can be ALL or NONE
 rate_request.RequestedShipment.EdtRequestType = 'NONE'
 
-rate_request.RequestedShipment.PackageDetail = 'PACKAGE_SUMMARY'
-
-rate_request.RequestedShipment.FreightShipmentDetail.PaymentType = 'PREPAID'  
-
-# note: in order for this to work in test, you may need to use the 
+# note: in order for this to work in test, you may need to use the
 # specially provided LTL addresses emailed to you when signing up.
 rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Contact.PersonName = 'Sender Name'
 rate_request.RequestedShipment.FreightShipmentDetail.FedExFreightBillingContactAndAddress.Contact.CompanyName = 'Some Company'
@@ -65,9 +61,12 @@
 rate_request.RequestedShipment.ShippingDocumentSpecification = spec
 
 role = rate_request.create_wsdl_object_of_type('FreightShipmentRoleType')
-
 rate_request.RequestedShipment.FreightShipmentDetail.Role = role.SHIPPER
 
+# Designates the terms of the "collect" payment for a Freight
+#Shipment. Can be NON_RECOURSE_SHIPPER_SIGNED or STANDARD
+rate_request.RequestedShipment.FreightShipmentDetail.CollectTermsType = 'STANDARD'
+
 package1_weight = rate_request.create_wsdl_object_of_type('Weight')
 package1_weight.Value = 500.0
 package1_weight.Units = "LB"
@@ -108,7 +107,7 @@
         for surcharge in detail.ShipmentRateDetail.Surcharges:
             if surcharge.SurchargeType == 'OUT_OF_DELIVERY_AREA':
                 print "%s: ODA rate_request charge %s" % (service.ServiceType, surcharge.Amount.Amount)
-            
+
     for rate_detail in service.RatedShipmentDetails:
         print "%s: Net FedEx Charge %s %s" % (service.ServiceType, rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Currency,
                 rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Amount)

examples/rate_request.py

@@ -1,11 +1,11 @@
 #!/usr/bin/env python
 """
-This example shows how to use the FedEx RateRequest service. 
-The variables populated below represents the minimum required values. 
-You will need to fill all of these, or risk seeing a SchemaValidationError 
+This example shows how to use the FedEx RateRequest 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.
 
-TIP: Near the bottom of the module, see how to check the if the destination 
+TIP: Near the bottom of the module, see how to check the if the destination
      is Out of Delivery Area (ODA).
 """
 import logging
@@ -36,10 +36,6 @@
 # FEDEX_BOX, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING
 rate_request.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
 
-# No idea what this is.
-# INDIVIDUAL_PACKAGES, PACKAGE_GROUPS, PACKAGE_SUMMARY 
-rate_request.RequestedShipment.PackageDetail = 'INDIVIDUAL_PACKAGES'
-
 # Shipper's address
 rate_request.RequestedShipment.Shipper.Address.PostalCode = '29631'
 rate_request.RequestedShipment.Shipper.Address.CountryCode = 'US'
@@ -55,8 +51,8 @@
 
 # Who pays for the rate_request?
 # RECIPIENT, SENDER or THIRD_PARTY
-rate_request.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER' 
-rate_request.RequestedShipment.ShippingChargesPayment.Payor.AccountNumber = CONFIG_OBJ.account_number
+rate_request.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+
 package1_weight = rate_request.create_wsdl_object_of_type('Weight')
 # Weight, in LB.
 package1_weight.Value = 1.0
@@ -66,6 +62,10 @@
 package1.Weight = package1_weight
 #can be other values this is probably the most common
 package1.PhysicalPackaging = 'BOX'
+# Required, but according to FedEx docs:
+# "Used only with PACKAGE_GROUPS, as a count of packages within a
+# group of identical packages" whatever that means
+package1.GroupPackageCount = 1
 # Un-comment this to see the other variables you may set on a package.
 #print package1
 
@@ -99,7 +99,7 @@
         for surcharge in detail.ShipmentRateDetail.Surcharges:
             if surcharge.SurchargeType == 'OUT_OF_DELIVERY_AREA':
                 print "%s: ODA rate_request charge %s" % (service.ServiceType, surcharge.Amount.Amount)
-            
+
     for rate_detail in service.RatedShipmentDetails:
         print "%s: Net FedEx Charge %s %s" % (service.ServiceType, rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Currency,
                 rate_detail.ShipmentRateDetail.TotalNetFedExCharge.Amount)

fedex/base_service.py

@@ -41,9 +41,13 @@ class SchemaValidationError(FedexBaseServiceException):
     """
     Exception: There is probably a problem in the data you provided.
     """
-    def __init__(self):
+    def __init__(self, fault):
         self.error_code = -1
         self.value = "suds encountered an error validating your data against this service's WSDL schema. Please double-check for missing or invalid values, filling all required fields."
+        try:
+            self.value += ' Details: {}'.format(fault.detail.desc)
+        except AttributeError:
+            pass
 
 class FedexBaseService(object):
     """
@@ -212,11 +216,11 @@ def send_request(self, send_function=None):
             else:
                 # Default scenario, business as usual.
                 self.response = self._assemble_and_send_request()
-        except suds.WebFault:
+        except suds.WebFault as fault:
             # When this happens, throw an informative message reminding the
             # user to check all required variables, making sure they are
-            # populated and valid.
-            raise SchemaValidationError()
+            # populated and valid
+            raise SchemaValidationError(fault.fault)
 
         # Check the response for general Fedex errors/failures that aren't
         # specific to any given WSDL/request.

fedex/services/rate_service.py

@@ -25,14 +25,14 @@ def __init__(self, config_obj, *args, **kwargs):
         self._config_obj = config_obj
 
         # Holds version info for the VersionId SOAP object.
-        self._version_info = {'service_id': 'crs', 'major': '8', 
+        self._version_info = {'service_id': 'crs', 'major': '16', 
                              'intermediate': '0', 'minor': '0'}
 
         self.RequestedShipment = None
         """@ivar: Holds the RequestedShipment WSDL object."""
         # Call the parent FedexBaseService class for basic setup work.
         super(FedexRateServiceRequest, self).__init__(self._config_obj, 
-                                                         'RateService_v8.wsdl',
+                                                         'RateService_v16.wsdl',
                                                          *args, **kwargs)
         self.ClientDetail.Region = config_obj.express_region_code
 
@@ -80,9 +80,6 @@ def _prepare_wsdl_objects(self):
         # Assume US.
         Payor.CountryCode = 'US'
 
-        # ACCOUNT or LIST
-        self.RequestedShipment.RateRequestTypes = ['ACCOUNT'] 
-        
         # Start with no packages, user must add them.
         self.RequestedShipment.PackageCount = 0
         self.RequestedShipment.RequestedPackageLineItems = []