added avc service, updated version, readme, change log

Author: radzhome

CHANGES.rst

@@ -1,18 +1,27 @@
 Change Log
 ==========
 
+2.1.0
+-----
+
+* Added Validation, Availability and Commitment (AVC) service. (radzhome)
+* Added [Validation]AvailabilityAndCommitmentService_v4.wsdl for AVC service. (radzhome)
+* Added examples and unit tests for AVC service.
+* Refactored examples and documentation. (radzhome)
+
+
 2.0.0
 -----
 
-* Bump ShipService WSDL to v17 for create and delete shipment. (radlws)
-* Bump AddressValidation WSDL to v4. (radlws)
-* Bump RateService WSDL to v18. (radlws)
-* Bump TrackService WSDL to v10. (radlws)
-* General improvements to base class. (radlws)
-* Refactoring and updates to examples. (radlws)
-* Added test classes. (radlws)
-* Remove old and unused WSDLs. (radlws)
-* Change dependency to suds-jurko to include python 3 support. (radlws)
+* Bump ShipService WSDL to v17 for create and delete shipment. (radzhome)
+* Bump AddressValidation WSDL to v4. (radzhome)
+* Bump RateService WSDL to v18. (radzhome)
+* Bump TrackService WSDL to v10. (radzhome)
+* General improvements to base class. (radzhome)
+* Refactoring and updates to examples. (radzhome)
+* Added test classes. (radzhome)
+* Remove old and unused WSDLs. (radzhome)
+* Change dependency to suds-jurko to include python 3 support. (radzhome)
 
 1.1.1
 -----
@@ -24,7 +33,7 @@ Change Log
 -----
 
 * A quick PEP8 pass on most of the codebase. Yucky. (gtaylor)
-* Changing recommended install method to use pip + PyPi. (radlws)
+* Changing recommended install method to use pip + PyPi. (radzhome)
 * Updated rate_request and freight_rate_request examples for WSDL v16
   compatibility. (foxxyz)
 * Updated rate service WSDL from v8 to v16. (foxxyz)

README.rst

@@ -4,7 +4,6 @@ Python FedEx SOAP API Module
 :Author: Greg Taylor
 :License: BSD
 :Status: Stable
-:Maintained: Quasi-maintained, looking for new maintainer
 
 What is it?
 -----------
@@ -49,8 +48,8 @@ Fedex Support and Documentation
 Fedex Support Email: websupport@fedex.com
 Developer Portal: http://www.fedex.com/us/developer/
 
-Legal Mumbo Jumbo
------------------
+Legal
+-----
 
 Copyright (C) 2015 Gregory Taylor
 

examples/service_availability_request.py

@@ -0,0 +1,114 @@
+#!/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
+exception thrown by suds.
+
+TIP: Near the bottom of the module, see how to check the if the destination
+     is Out of Delivery Area (ODA).
+"""
+import logging
+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)
+
+
+# This is the object that will be handling our tracking request.
+# We're using the FedexConfig object from example_config.py in this dir.
+customer_transaction_id = "*** RateService Request v18 using Python ***"  # Optional transaction_id
+rate_request = FedexRateServiceRequest(CONFIG_OBJ, customer_transaction_id=customer_transaction_id)
+
+# If you wish to have transit data returned with your request you
+# need to uncomment the following
+# rate_request.ReturnTransitAndCommit = True
+
+# This is very generalized, top-level information.
+# REGULAR_PICKUP, REQUEST_COURIER, DROP_BOX, BUSINESS_SERVICE_CENTER or STATION
+rate_request.RequestedShipment.DropoffType = 'REGULAR_PICKUP'
+
+# See page 355 in WS_ShipService.pdf for a full list. Here are the common ones:
+# STANDARD_OVERNIGHT, PRIORITY_OVERNIGHT, FEDEX_GROUND, FEDEX_EXPRESS_SAVER
+# To receive rates for multiple ServiceTypes set to None.
+rate_request.RequestedShipment.ServiceType = 'FEDEX_GROUND'
+
+# What kind of package this will be shipped in.
+# FEDEX_BOX, FEDEX_PAK, FEDEX_TUBE, YOUR_PACKAGING
+rate_request.RequestedShipment.PackagingType = 'YOUR_PACKAGING'
+
+# Shipper's address
+rate_request.RequestedShipment.Shipper.Address.PostalCode = '29631'
+rate_request.RequestedShipment.Shipper.Address.CountryCode = 'US'
+rate_request.RequestedShipment.Shipper.Address.Residential = False
+
+# Recipient address
+rate_request.RequestedShipment.Recipient.Address.PostalCode = '27577'
+rate_request.RequestedShipment.Recipient.Address.CountryCode = 'US'
+# This is needed to ensure an accurate rate quote with the response.
+#rate_request.RequestedShipment.Recipient.Address.Residential = True
+#include estimated duties and taxes in rate quote, can be ALL or NONE
+rate_request.RequestedShipment.EdtRequestType = 'NONE'
+
+# Who pays for the rate_request?
+# RECIPIENT, SENDER or THIRD_PARTY
+rate_request.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER'
+
+package1_weight = rate_request.create_wsdl_object_of_type('Weight')
+# Weight, in LB.
+package1_weight.Value = 1.0
+package1_weight.Units = "LB"
+
+package1 = rate_request.create_wsdl_object_of_type('RequestedPackageLineItem')
+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". In practice you can use this to get rates
+# for a shipment with multiple packages of an identical package size/weight
+# on rate request without creating multiple RequestedPackageLineItem elements.
+# You can OPTIONALLY specify a package group:
+# package1.GroupNumber = 0  # default is 0
+# The result will be found in RatedPackageDetail, with specified GroupNumber.
+package1.GroupPackageCount = 1
+# Un-comment this to see the other variables you may set on a package.
+#print(package1)
+
+# This adds the RequestedPackageLineItem WSDL object to the rate_request. It
+# increments the package count and total weight of the rate_request for you.
+rate_request.add_package(package1)
+
+# 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(rate_request.RequestedShipment)
+
+# Fires off the request, sets the 'response' attribute on the object.
+rate_request.send_request()
+
+# 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)
+
+# Here is the overall end result of the query.
+print("HighestSeverity:", 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 %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/__init__.py

@@ -52,4 +52,4 @@
 our U{Google Code project<http://code.google.com/p/python-fedex/>} and enter
 an issue in the U{Issue Tracker<http://code.google.com/p/python-fedex/issues/list>}.
 """
-VERSION = __version__ = '2.0.0'
+VERSION = __version__ = '2.1.0'

fedex/services/availability_commitment_service.py

@@ -0,0 +1,86 @@
+"""
+Address Validation Service Module
+=================================
+This package contains the shipping methods defined by Fedex's 
+AddressValidationService WSDL file. Each is encapsulated in a class for 
+easy access. For more details on each, refer to the respective class's 
+documentation.
+"""
+
+from datetime import datetime
+from .. base_service import FedexBaseService
+
+
+class FedexAddressValidationRequest(FedexBaseService):
+    """
+    This class allows you validate anywhere from one to a hundred addresses
+    in one go. Create AddressToValidate WSDL objects and add them to each
+    instance of this request using add_address().
+    """
+
+    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': 'aval',
+            'major': '4',
+            'intermediate': '0',
+            'minor': '0'
+        }
+        
+        # self.AddressValidationOptions = None
+        """@ivar: Holds the AddressValidationOptions WSDL object."""
+        self.AddressesToValidate = []
+        """@ivar: Holds the AddressToValidate WSDL object."""
+        # Call the parent FedexBaseService class for basic setup work.
+        super(FedexAddressValidationRequest, self).__init__(
+            self._config_obj, 'AddressValidationService_v4.wsdl', *args, **kwargs)
+        
+    def _prepare_wsdl_objects(self):
+        """
+        Create the data structure and get it ready for the WSDL request.
+        """
+        pass
+    
+    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.addressValidation(
+            WebAuthenticationDetail=self.WebAuthenticationDetail,
+            ClientDetail=self.ClientDetail,
+            TransactionDetail=self.TransactionDetail,
+            Version=self.VersionId,
+            InEffectAsOfTimestamp=datetime.now(),
+            AddressesToValidate=self.AddressesToValidate)
+
+    def add_address(self, address_item):
+        """
+        Adds an address to self.AddressesToValidate.
+        
+        @type address_item: WSDL object, type of AddressToValidate WSDL object.
+        @keyword address_item: A AddressToValidate, created by
+            calling create_wsdl_object_of_type('AddressToValidate') on
+            this FedexAddressValidationRequest object. 
+            See examples/create_shipment.py for more details.
+        """
+
+        self.AddressesToValidate.append(address_item)