EntityBase

Complexity

Total Complexity

6

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Test Coverage

Coverage

95%

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__init__()	0	10	3
A	get_schema()	0	8	1
A	validate()	0	16	2

# -*- coding: utf-8 -*-

This module should have a docstring.

# #############################################################################
#
# The MIT License (MIT)
#
# Copyright (c) 2016 Trocafone
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
###############################################################################

from zeep import Client

The import zeep could not be resolved.

from zeep.transports import Transport

The import zeep.transports could not be resolved.

from voluptuous import Invalid, MultipleInvalid

The import voluptuous could not be resolved.

import certifi

The import certifi could not be resolved.

class WebserviceError(Exception):

This class should have a docstring.

    pass


class WebserviceBase():

This class should have a docstring.

Old-style class defined.

This abstract class seems to be used only once.

    def __init__(self, env, id_correios, password, cert=False):
        ''' Webservice initialization.

        Depending on the env get a different wsdl definition.
        New Correios SIGEP uses HTTPAuth to do requests.

        Args:
            env (str): Environment used to get the wsdl
            id_correios (str): IdCorreios given by correios website
            password (str): password vinculated to the IdCorreios
        '''

        ''' Untrusted ssl certificate for homolog envs see more at:

        https://www.ssllabs.com/ssltest/analyze.html?d=apphom.correios.com.br
        '''

This string statement has no effect and could be removed.

        if cert is False:
            verify = False
        else:
            verify = certifi.where()

        t = Transport(

The name t does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            verify=verify,
            http_auth=(id_correios, password)
        )
        self.client = Client(wsdl=self.get_env(env), transport=t)

    def get_env(self, env):
        """ Get WSDL Url.

        Must be implemented in order to return the correct WSDL.

        Args:
            env (str): Environment used to get the wsdl

        Returns:
            str: WSDL Url of the corresponding environment
        """
        raise NotImplementedError()

    def call(self, method, request):
        ''' Call the webservice method with the validated request content

        Args:
            method (str): Name of the method available at the webservice
            request (RequestObject): Object containing all the info needed

        Returns:
            dict: Result of the service call
        '''
        service_method = getattr(self.client.service, method, None)

        try:
            return service_method(request)
        except ValueError:
            raise WebserviceError('The method you are trying to call does not '
                                  'exists.')


class EntityBase(dict):

This class should have a docstring.

    def __init__(self, **kargs):
        super(EntityBase, self).__init__(kargs)
        self.validate()

        try:
            raise getattr(self, 'error')
        except AttributeError:
            pass
        except Invalid as e:

The name e does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            raise MultipleInvalid([e])

    def get_schema(self):
        """ Returns validation schema

        Returns:
            voluptous.Schema: Schema with validation rules
        """
        raise NotImplementedError("Every entitiy needs validation against a " +
                                  "Schema.")

    def validate(self):
        """ Validates content against schema

        In case of failure an error is kept inside the entity object,
        to be displayed by the client user if needed.

        Returns:
            bool: Validation result
        """
        schema = self.get_schema()
        try:
            super(EntityBase, self).__init__(schema(self))
            return True
        except Exception as e:

Catching very general exceptions such as Exception is usually not recommended.

The name e does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            self.error = e
            return False