Source code for PyTravisCI.communicator.base

"""
Just another Python API for Travis CI (API).

A module which provides the base of all communicator.

Author:
    Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Project link:
    https://github.com/funilrys/PyTravisCI

Project documentation:
    https://pytravisci.readthedocs.io/en/latest/

License
::


    MIT License

    Copyright (c) 2019, 2020 Nissar Chababy

    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.
"""

import copy
import inspect
import urllib.parse as urllib_parse
from functools import wraps
from typing import Any, Optional, Union

import PyTravisCI.exceptions as exceptions
import PyTravisCI.standardization as standardization
from PyTravisCI.requester import Requester


[docs]class CommunicatorBase: """ Provides the base of all communicator. """ resource_types: Optional["resource_types._all"] = None requester: Optional[Requester] = None standardizer: Optional[standardization.Standardization] = None endpoints: dict = dict() """ Should be a :py:class:`dict` in format: :: { "from_id": "/build/%(build_id)s" } :code:`from_id` is the name of the method and :code:`build/%(build_id)s` is the endpoint we need to communicate with. :code:`%(build_id)s` is what the method will expect as variable name. In fact, if the end-user give us :code:`build_id=4` as argument, the system will replace :code:`%(build_id)s` with :code:`4`. """ def __init__(self, req: Requester) -> None: if not isinstance(req, Requester): raise TypeError(f"<requester> must be {Requester}. {type(req)} given.") # pylint: disable=import-outside-toplevel import PyTravisCI.resource_types._all as resource_types self.resource_types = resource_types self.requester = req self.standardizer = standardization.Standardization()
[docs] def complete_response(func): # pylint: disable=no-self-argument """ A decorator which complete the responses before giving it back to the end-user. """ @wraps(func) def wrapper(self, **kwargs): # pragma: no cover response = func(self, **kwargs) # pylint:disable=not-callable ignore_sharing = [ "parameters", "data", ] if hasattr(response, "_at_type"): to_propagate = { "_PyTravisCI": { "com": {}, "shared": { x: y for x, y in kwargs.items() if x not in ignore_sharing }, } } try: to_propagate["_PyTravisCI"]["com"]["requester"] = self.requester except AttributeError: # pylint: disable=protected-access to_propagate["_PyTravisCI"]["com"]["requester"] = self._PyTravisCI[ "com" ]["requester"] response = CommunicatorBase.propagate_internal_vars( to_propagate, response ) return response return wrapper
[docs] def filter_before_action(func): # pylint: disable=no-self-argument """ A decorator which filter/format the given arguments before giving it back to the communicator method. This is useful in order to avoid having the same thing over and over everywhere. """ @wraps(func) def wrapper(self, **kwargs): # pragma: no cover if "repository_id_or_slug" in kwargs: kwargs["repository_id_or_slug"] = self.encode_slug( kwargs["repository_id_or_slug"] ) return func(self, **kwargs) # pylint: disable=not-callable return wrapper
[docs] @classmethod def propagate_internal_vars(cls, variables: dict, start_obj: Any) -> object: """ Propagate the given var to all objects. .. warning:: You are not invited to use this method outside of PyTravis's communicators. """ for var_name, var_value in variables.items(): try: if hasattr(start_obj, var_name): if isinstance(var_value, dict): start_obj[var_name].update(var_value) else: start_obj[var_name] = var_value else: start_obj[var_name] = var_value except TypeError: continue try: for _, value in start_obj.__dict__.items(): if hasattr(value, "_at_type"): value = cls.propagate_internal_vars(variables, value) elif isinstance(value, list): value = [cls.propagate_internal_vars(variables, x) for x in value] except AttributeError: # pragma: no cover pass return start_obj
[docs] @staticmethod def is_digit(data: Union[str, int]) -> bool: """ Checks if the given data is an integer or a digit string. """ return (not isinstance(data, bool) and isinstance(data, int)) or ( isinstance(data, str) and data.isdigit() )
[docs] @classmethod def encode_slug(cls, slug: str) -> str: """ Encodes the (repository) slug. """ if slug and not cls.is_digit(slug) and "%" not in slug and "/" in slug: slug = urllib_parse.quote(slug, safe="") return slug
[docs] @staticmethod def get_method_name() -> str: # pragma: no cover """ Provides the method name. .. warning:: You are not invited to use this method outside of PyTravisCI's communicators. """ return inspect.getouterframes(inspect.currentframe(), 2)[2][3]
[docs] def get_standardized(self, data: dict) -> Any: # pragma: no cover """ Provides the standardized version of the given dataset. """ try: self.standardizer.set_data(data) return self.standardizer.get_standardized() except AttributeError: return data
[docs] def get_response(self, endpoint: str) -> dict: # pragma: no cover """ Provides the response from the API. """ return self.requester.get(endpoint)
[docs] def post_response( self, endpoint: str, data: dict = None ) -> dict: # pragma: no cover """ POST and provides the response from the API. """ return self.requester.post(endpoint, data=data)
[docs] def patch_response( self, endpoint: str, data: dict = None ) -> dict: # pragma: no cover """ PATCH and provides the response from the API. """ return self.requester.patch(endpoint, data=data)
[docs] def delete_response(self, endpoint: str) -> Union[dict, bool]: # pragma: no cover """ DELETE and provides the response from the API. """ try: return self.requester.delete(endpoint) except exceptions.TravisCIError as exception: response_info = exception.get_response() if "status_code" in response_info and response_info["status_code"] == 204: return True return False
[docs] def get_and_construct_endpoint(self, kwargs: dict) -> str: # pragma: no cover """ Provides the endpoint to call from the given method name. """ if "parameters" in kwargs and kwargs["parameters"]: params = urllib_parse.urlencode(copy.deepcopy(kwargs["parameters"])) del kwargs["parameters"] if params: return self.endpoints[self.get_method_name()] % kwargs + f"?{params}" return self.endpoints[self.get_method_name()] % kwargs