party.py

# -*- encoding: utf-8 -*-
"""
    Customizes party address to have address in correct format for UPS API .

"""
import re

# Remove when we are on python 3.x :)
from orderedset import OrderedSet
from lxml import etree
from logbook import Logger

from ups.shipping_package import ShipmentConfirm
from ups.base import PyUPSException
from trytond.pool import Pool, PoolMeta
from trytond.transaction import Transaction


__all__ = ['Address']
__metaclass__ = PoolMeta

digits_only_re = re.compile('\D+')
logger = Logger('trytond_ups')


class Address:
    '''
    Address
    '''
    __name__ = "party.address"

    @classmethod
    def __setup__(cls):
        super(Address, cls).__setup__()
        cls._error_messages.update({
            'ups_field_missing':
                '%s is missing in %s.'
        })

    def _get_ups_address_xml(self):
        """
        Return Address XML
        """
        if not all([self.street, self.city, self.country]):
            self.raise_user_error("Street, City and Country are required.")

        if self.country.code in ['US', 'CA'] and not self.subdivision:
            self.raise_user_error(
                "State is required for %s" % self.country.code
            )

        if self.country.code in ['US', 'CA', 'PR'] and not self.zip:
            # If Shipper country is US or Puerto Rico, 5 or 9 digits is
            # required. The character - may be used to separate the first five
            # digits and the last four digits. If the Shipper country is CA,
            # then the postal code is required and must be 6 alphanumeric
            # characters whose format is A#A#A# where A is an uppercase letter
            # and # is a digit. For all other countries the postal code is
            # optional and must be no more than 9 alphanumeric characters long.
            self.raise_user_error("ZIP is required for %s" % self.country.code)

        vals = {
            'AddressLine1': self.street[:35],  # Limit to 35 Char
            'City': self.city[:30],  # Limit 30 Char
            'CountryCode': self.country.code,
        }

        if self.streetbis:
            vals['AddressLine2'] = self.streetbis[:35]  # Limit to 35 char
        if self.subdivision:
            # TODO: Handle Ireland Case
            vals['StateProvinceCode'] = self.subdivision.code[3:]
        if self.zip:
            vals['PostalCode'] = self.zip

        return ShipmentConfirm.address_type(**vals)

    def to_ups_from_address(self):
        '''
        Converts party address to UPS `From Address`.

        :return: Returns instance of FromAddress
        '''
        Company = Pool().get('company.company')

        vals = {}
        if not self.party.phone:
            self.raise_user_error(
                "ups_field_missing",
                error_args=('Phone no.', '"from address"')
            )

        company_id = Transaction().context.get('company')
        if not company_id:
            self.raise_user_error(
                "ups_field_missing",
                error_args=('Company', 'context')
            )

        company_party = Company(company_id).party

        vals = {
            'CompanyName': company_party.name,
            'AttentionName': self.name or self.party.name,
            'TaxIdentificationNumber': company_party.vat_number,
            'PhoneNumber': digits_only_re.sub('', self.party.phone),
        }

        fax = self.party.fax
        if fax:
            vals['FaxNumber'] = fax

        # EMailAddress
        email = self.party.email
        if email:
            vals['EMailAddress'] = email

        return ShipmentConfirm.ship_from_type(
            self._get_ups_address_xml(), **vals)

    def to_ups_to_address(self):
        '''
        Converts party address to UPS `To Address`.

        :return: Returns instance of ToAddress
        '''
        party = self.party

        tax_identification_number = ''
        if party.vat_number:
            tax_identification_number = party.vat_number
        elif hasattr(party, 'tax_exemption_number') and \
                party.tax_exemption_number:
            tax_identification_number = party.tax_exemption_number

        vals = {
            'CompanyName': self.name or party.name,
            'TaxIdentificationNumber': tax_identification_number,
            'AttentionName': self.name or party.name,
        }

        if party.phone:
            vals['PhoneNumber'] = digits_only_re.sub('', party.phone)

        fax = party.fax
        if fax:
            vals['FaxNumber'] = fax

        # EMailAddress
        email = party.email
        if email:
            vals['EMailAddress'] = email

        # TODO: LocationID is optional

        return ShipmentConfirm.ship_to_type(self._get_ups_address_xml(), **vals)

    def to_ups_shipper(self, carrier):
        '''
        Converts party address to UPS `Shipper Address`.

        :return: Returns instance of ShipperAddress
        '''
        Company = Pool().get('company.company')

        vals = {}
        if not self.party.phone:
            self.raise_user_error(
                "ups_field_missing",
                error_args=('Phone no.', '"Shipper Address"')
            )

        company_id = Transaction().context.get('company')
        if not company_id:
            self.raise_user_error(
                "ups_field_missing", error_args=('Company', 'context')
            )

        company_party = Company(company_id).party

        vals = {
            'CompanyName': company_party.name,
            'TaxIdentificationNumber': company_party.vat_number,
            'Name': self.name or self.party.name,
            'AttentionName': self.name or self.party.name,
            'PhoneNumber': digits_only_re.sub('', self.party.phone),
            'ShipperNumber': carrier.ups_shipper_no,
        }

        fax = self.party.fax
        if fax:
            vals['FaxNumber'] = fax

        # EMailAddress
        email = self.party.email
        if email:
            vals['EMailAddress'] = email

        return ShipmentConfirm.shipper_type(
            self._get_ups_address_xml(),
            **vals
        )

    def _ups_address_validate(self):
        """
        Validates the address using the PyUPS API.

        .. tip::

            This method is not intended to be called directly. It is
            automatically called by the address validation API of
            trytond-shipping module.
        """
        Subdivision = Pool().get('country.subdivision')
        Address = Pool().get('party.address')
        CarrierConfig = Pool().get('carrier.configuration')

        config = CarrierConfig(1)
        carrier = config.default_validation_carrier

        if not carrier:
            # TODO: Make this translatable error message
            self.raise_user_error(
                "Validation Carrier is not selected in carrier configuration."
            )

        api_instance = carrier.ups_api_instance(call='address_val')

        if not self.country:
            # XXX: Either this or assume it is the US of A
            self.raise_user_error('Country is required to validate address.')

        values = {
            'CountryCode': self.country.code,
        }

        if self.subdivision:
            # Fetch ups compatible subdivision
            values['StateProvinceCode'] = self.subdivision.code.split('-')[-1]

        if self.city:
            values['City'] = self.city

        if self.zip:
            values['PostalCode'] = self.zip

        address_request = api_instance.request_type(**values)

        # Logging.
        logger.debug(
            'Making Address Validation Request to UPS for Address Id: {0}'
            .format(self.id)
        )
        logger.debug(
            '--------AV API REQUEST--------\n%s'
            '\n--------END REQUEST--------'
            % etree.tostring(address_request, pretty_print=True)
        )

        try:
            address_response = api_instance.request(address_request)

            # Logging.
            logger.debug(
                '--------AV API RESPONSE--------\n%s'
                '\n--------END RESPONSE--------'
                % etree.tostring(address_response, pretty_print=True)
            )
        except PyUPSException, exc:
            self.raise_user_error(unicode(exc[0]))

        if (len(address_response.AddressValidationResult) == 1) and \
                address_response.AddressValidationResult.Quality.pyval == 1:
            # This is a perfect match and there is no need to make
            # suggestions.
            return True

        # The UPS response will include the following::
        #
        #   * City
        #   * StateProvinceCode
        #   * PostalCodeLowEnd  (Not very useful)
        #   * PostalCodeHighEnd (Not Very Useful)
        #
        # Example: https://gist.github.com/tarunbhardwaj/4df0673bdd1c7bc6ab89
        #
        # The approach here is to clear out the duplicates with just city
        # and the state and only return combinations of address which
        # differentiate based on city and state.
        #
        # (In most practical uses, it would just be the city that keeps
        # changing).

        unique_combinations = OrderedSet([
            (node.Address.City.text, node.Address.StateProvinceCode.text)
            for node in address_response.AddressValidationResult
        ])

        # This part is sadly static... wish we could verify more than the
        # state and city... like the street.
        base_address = {
            'name': self.name,
            'street': self.street,
            'streetbis': self.streetbis,
            'country': self.country,
            'zip': self.zip,
        }
        matches = []
        for city, subdivision_code in unique_combinations:
            try:
                subdivision, = Subdivision.search([
                    ('code', '=', '%s-%s' % (
                        self.country.code, subdivision_code
                    ))
                ])
            except ValueError:
                # If a unique match cannot be found for the subdivision,
                # we wont be able to save the address anyway.
                continue

            if (self.city.upper() == city.upper()) and \
                    (self.subdivision == subdivision):
                # UPS does not know it, but this is a right address too
                # because we are suggesting exactly what is already in the
                # address.
                return True

            matches.append(
                Address(city=city, subdivision=subdivision, **base_address)
            )

        return matches