apytizer 0.0.1a0__py3-none-any.whl → 0.0.1b1__py3-none-any.whl

apytizer/base/endpoint.py

@@ -1,443 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Basic endpoint class.
-
-This module defines a basic endpoint class implementation.
-
-"""
-
-# Standard Library Imports
-from __future__ import annotations
-import logging
-from typing import Dict, List, MutableMapping, Union
-
-# Third-Party Imports
-import requests
-
-# Local Imports
-from ..abstracts.api import AbstractAPI
-from ..abstracts.endpoint import AbstractEndpoint
-from ..decorators.caching import cache_response
-from ..utils import merge
-
-
-# Initialize logger.
-log = logging.getLogger(__name__)
-
-
-class BasicEndpoint(AbstractEndpoint):
-    """
-    Class for interacting with an API endpoint.
-
-    Args:
-        path: Relative URL path for endpoint.
-        headers (optional): Headers to set globally for endpoint.
-        params (optional): Parameters to set globally for endpoint.
-        methods (optional): List of HTTP methods accepted by endpoint.
-        cache (optional): Mutable mapping for caching responses.
-
-    Attributes:
-        uri: Endpoint URL.
-
-    """
-
-    def __init__(
-        self,
-        api: AbstractAPI,
-        path: str,
-        *,
-        headers: Dict = None,
-        params: Dict = None,
-        methods: List[str] = None,
-        cache: MutableMapping = None,
-    ):
-        self.api = api
-        self.path = path if path[0] != "/" else path[1:]
-        self.headers = headers
-        self.params = params
-        self.methods = methods
-        self.cache = cache
-
-    def __call__(
-        self,
-        ref: Union[int, str],
-        *,
-        headers: Dict = None,
-        params: Dict = None,
-        methods: List[str] = None,
-        cache: MutableMapping = None
-    ) -> BasicEndpoint:
-        """
-        Returns a new endpoint with the appended reference.
-
-        This method is a shortcut for accessing HTTP methods on a
-        child endpoint or a nested resource.
-
-        Args:
-            ref: Reference for a collection or nested resource.
-            headers (optional) : Headers to set globally for endpoint.
-            params (optional) : Parameters to set globally for endpoint.
-            methods (optional): List of HTTP methods accepted by endpoint.
-            cache (optional): Mutable mapping for caching responses.
-
-        Returns:
-            BasicEndpoint instance.
-
-        """
-        if isinstance(ref, (int, str)):
-            endpoint = BasicEndpoint(
-                self.api,
-                f'{self.path!s}/{ref!s}',
-                headers=headers,
-                params=params,
-                methods=methods,
-                cache=cache,
-            )
-        else:
-            raise TypeError
-
-        return endpoint
-
-    def __getitem__(self, ref: Union[int, str]) -> BasicEndpoint:
-        """
-        Returns a new endpoint with the appended reference.
-
-        This method is a shortcut for accessing HTTP methods on a
-        child endpoint or a nested resource.
-
-        Args:
-            ref: Reference for a collection or nested resource.
-
-        Returns:
-            BasicEndpoint instance.
-
-        """
-        if isinstance(ref, (int, str)):
-            endpoint = BasicEndpoint(
-                self.api,
-                f'{self.path!s}/{ref!s}'
-            )
-        else:
-            raise TypeError
-
-        return endpoint
-
-    def __add__(self, path: Union[int, str]) -> BasicEndpoint:
-        """
-        Returns a new endpoint after combining both paths.
-
-        This is a method for quickly accessing HTTP methods for
-        child endpoints or nested resources. It behaves the same
-        as the __truediv__ method.
-
-        Args:
-            path: Value to append to the current path.
-
-        Returns:
-            BasicEndpoint instance.
-
-        """
-        if isinstance(path, (int, str)):
-            endpoint = BasicEndpoint(
-                self.api,
-                f'{self.path!s}/{path!s}'
-            )
-        else:
-            raise TypeError
-
-        return endpoint
-
-    def __truediv__(self, path: Union[int, str]) -> BasicEndpoint:
-        """
-        Returns a new endpoint after combining both paths.
-
-        This is a method for quickly accessing HTTP methods for
-        child endpoints or nested resources. It behaves the same
-        as the __add__ method.
-
-        Args:
-            path: Value to append to the current path.
-
-        Returns:
-            BasicEndpoint instance.
-
-        """
-        if isinstance(path, (int, str)):
-            endpoint = BasicEndpoint(
-                self.api,
-                f'{self.path!s}/{path!s}'
-            )
-        else:
-            raise TypeError
-
-        return endpoint
-
-    @cache_response
-    def head(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP HEAD request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
-
-        """
-
-        if self.methods and 'HEAD' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.head(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response
-
-    @cache_response
-    def get(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP GET request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
-
-        """
-
-        if self.methods and 'GET' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.get(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response
-
-    @cache_response
-    def post(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP POST request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
-
-        """
-
-        if self.methods and 'POST' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.post(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response
-
-    @cache_response
-    def put(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP PUT request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT
-
-        """
-
-        if self.methods and 'PUT' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.put(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response
-
-    @cache_response
-    def patch(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP PATCH request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
-
-        """
-
-        if self.methods and 'PATCH' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.patch(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response
-
-    @cache_response
-    def delete(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP DELETE request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
-
-        """
-
-        if self.methods and 'DELETE' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.delete(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response
-
-    @cache_response
-    def options(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP OPTIONS request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
-
-        """
-        if self.methods and 'OPTIONS' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.options(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response
-
-    @cache_response
-    def trace(
-        self,
-        headers: Dict = None,
-        params: Dict = None,
-        **kwargs
-    ) -> requests.Response:
-        """
-        Sends an HTTP TRACE request to API endpoint.
-
-        Args:
-            headers (optional): Request headers (overrides global headers).
-            params (optional): Request parameters (overrides global parameters).
-            **kwargs: Data or parameters to include in request.
-
-        Returns:
-            Response object.
-
-        .. _MDN Web Docs:
-            https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/TRACE
-
-        """
-
-        if self.methods and 'TRACE' not in self.methods:
-            raise NotImplementedError
-
-        response = self.api.trace(
-            self.path,
-            headers=merge(self.headers, headers),
-            params=merge(self.params, params),
-            **kwargs
-        )
-        return response

apytizer/base/model.py

@@ -1,119 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Basic model class.
-
-This module defines the implementation of a basic model class.
-
-"""
-
-# Standard Library Imports
-from __future__ import annotations
-import collections
-import functools
-import logging
-from typing import Any, List, Mapping, Tuple, Union
-
-# Local Imports
-from ..abstracts.model import AbstractModel
-
-
-# Initialize logger.
-log = logging.getLogger(__name__)
-
-# Define custom types.
-AttributeKey = Union[List[str], str, Tuple[str]]
-
-
-class BasicModel(AbstractModel):
-    """
-    Class for representing a basic object model.
-
-    Args:
-        **kwargs: Data with which to set model state.
-
-    """
-    state: collections.ChainMap
-
-    def __init__(self, **kwargs):
-        self.state = collections.ChainMap({}, kwargs)
-
-    def __contains__(self, key: str) -> bool:
-        return key in self.state
-
-    def __eq__(self, other: AbstractModel) -> bool:
-        return dict(other) == dict(self) if isinstance(other, self.__class__) else False
-
-    def __getattr__(self, name: str) -> Any:
-        attr = self.get(name)
-        if not attr:
-            cls = self.__class__.__name__
-            message = f"type object '{cls!s}' has no attribute '{attr!s}'"
-            raise AttributeError(message)
-        return attr
-
-    def __getitem__(self, key: AttributeKey) -> Any:
-        return self.get(key)
-
-    def __iter__(self):
-        yield from self.state.items()
-
-    def __repr__(self) -> str:
-        return f"{self.__class__.__name__}({self.state!s})"
-
-    def commit(self) -> None:
-        """
-        Commits changes to local state.
-
-        """
-        if self.state.maps[0]:
-            self.state = self.state.new_child()
-
-    def get(self, key: AttributeKey, default = None) -> Any:
-        """
-        Get value for key(s) in local state.
-
-        Function allows lookups even within nested dictionaries. When passed multiple keys,
-        either separated by periods or as a list or tuple, the function looks up each key
-        in sequence.
-
-        Args:
-            key: Key(s) to use to retrieve value.
-
-        Returns:
-            Value for key in state.
-
-        """
-        if (isinstance(key, (list, tuple))) \
-            and all(isinstance(k, str) for k in key):
-            key = '.'.join(key)
-
-        if not isinstance(key, str):
-            raise TypeError
-
-        value = functools.reduce(
-            lambda data, key: data.get(key, default) \
-                if isinstance(data, (collections.ChainMap, dict)) \
-                else data if data else default,
-            key.split('.'),
-            self.state
-        )
-        return value
-
-    def update(self, __m: Mapping = None, **kwargs) -> None:
-        """
-        Update local state of model with provided data.
-
-        Args:
-            __m (optional): Mapping with which to update local state.
-            **kwargs: Data with which to update local state.
-
-        """
-        # TODO: Develop method for recursively updating nested dictionaries in local state.
-        self.state.update(__m, **kwargs)
-        return self
-
-    def rollback(self) -> None:
-        """
-        Rollback changes to local state.
-
-        """
-        self.state.clear()

apytizer/decorators/json.py

@@ -1,35 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Standard Library Imports
-import functools
-import logging
-from typing import Callable, Dict, List, Union
-
-# Third-Party Importd
-from requests import Response
-
-
-log = logging.getLogger(__name__)
-
-
-def json_response(func: Callable) -> Callable:
-    """
-    Automatically parses a JSON response.
-
-    Args:
-        func: Function to decorate.
-
-    Returns:
-        Wrapped function.
-
-    """
-
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs) -> Union[Dict, List, Response]:
-        log.debug('Parsing JSON response...')
-        response = func(*args, **kwargs)
-        return response.json() \
-            if response.headers.get('Content-Type') == "application/json" \
-            else response
-
-    return wrapper

apytizer/utils/generate_key.py

@@ -1,18 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Third-Party Imports
-from cachetools.keys import hashkey
-
-
-def generate_key(*tags):
-    """Generates a hashable key for caching values."""
-
-    def hash_parameters(*args, **kwargs):
-        """Hashes function parameters."""
-        key = hashkey(
-            *tags, *args,
-            *[f"{k!s}={v!s}" for k, v in sorted(kwargs.items())]
-        )
-        return key
-
-    return hash_parameters

apytizer/utils/merge.py

@@ -1,19 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Standard Library Imports
-from typing import Dict
-
-
-def merge(*args: Dict) -> Dict:
-    """
-    Combines dictionaries.
-
-    Args:
-        *args: Dictionaries to merge.
-
-    Returns:
-        Merged dictionary.
-
-    """
-    result = {k: v for dictionary in args if dictionary for k, v in dictionary.items()}
-    return result if result else None

apytizer-0.0.1a0.dist-info/METADATA

@@ -1,27 +0,0 @@
-Metadata-Version: 2.1
-Name: apytizer
-Version: 0.0.1a0
-Summary: Implement wrappers quickly for REST APIs
-Home-page: https://github.com/seanssullivan/apytizer
-Author: Sean Sullivan
-Author-email: seansullivan@seanmedia.ca
-License: UNKNOWN
-Download-URL: https://github.com/seanssullivan/apytizer/archive/refs/tags/v0.0.1-alpha.tar.gz
-Project-URL: Bug Tracker, https://github.com/seanssullivan/apytizer/issues
-Platform: UNKNOWN
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: cachetools
-Requires-Dist: requests
-
-# apytizer
-
-Implement wrappers quickly for REST APIs.
-
-

apytizer-0.0.1a0.dist-info/RECORD

@@ -1,25 +0,0 @@
-apytizer/__init__.py,sha256=YZcB-OH7axZXlxE_gKW3CR024jvh78GiH0eQT3tn0fM,356
-apytizer/abstracts/__init__.py,sha256=LyYT2mxAeyqPCC1VmU6k5blAJMM6UV2vlzsJX9ukXcg,184
-apytizer/abstracts/api.py,sha256=EOqYEgFYBkqYTJvkSV_S7W6u_Cjdcc9hpge0h4SC_Ac,3849
-apytizer/abstracts/endpoint.py,sha256=srD8vpDcrslhXf7xsN0TJnMGRGEk-B2alkLHtMRYRyw,4434
-apytizer/abstracts/model.py,sha256=P2yuZAkPm1cUPavcy1iv5-W20tVnv19TSQl1C2llBG4,1088
-apytizer/abstracts/session.py,sha256=ddHmgCKymBwJ7W_RrBrZnpKccMSNHhOeIhgi94CmX2E,802
-apytizer/adapters/__init__.py,sha256=Pj1f2o4p4jC3IptghGA-GC4nQuRuBQ173-iwkhprwgg,86
-apytizer/adapters/transport.py,sha256=P0i23ZgoxSoT6BQmOwRpWGgenT2-sQps6aaTGhQ37Vg,1270
-apytizer/base/__init__.py,sha256=C5wxAx9TUxU2-V3ZJaxOm_45hMbyTLQ8END4wUv2ZCE,166
-apytizer/base/api.py,sha256=i-5fqFHp84QeFSAldnu9pSuMB0X_Ga5f-ng5xtYZlWM,13823
-apytizer/base/endpoint.py,sha256=qDXr7DZBsB4ctBm6HuOIXfyQFRYN777Wexy-E3fBzwQ,11962
-apytizer/base/model.py,sha256=xkmRtW3Q0vMlOQTrO66qL57qRNNKJVjsqFr_BG2lNhc,3179
-apytizer/decorators/__init__.py,sha256=p9jpLbVYYsdp2v4OdfIuzZkHG3DuYvWy8-kFumvNn1I,156
-apytizer/decorators/caching.py,sha256=AU_sSgiUeGqfcVnpgIgtg47aUtlPxXgfWKR4ONsi4NY,729
-apytizer/decorators/connection.py,sha256=QrSBzYU3jdKTSVTj1PQjJn0xijVIeWCdZiO8WlWHNLE,1093
-apytizer/decorators/json.py,sha256=L1y4HdInbkSD6-PfJhUMhH4LK5RvQtcn-kzVUY5wG6w,750
-apytizer/decorators/pagination.py,sha256=xeY1NVC_MBLB8NHyAnUqPPjaboSQuoZAM-xEwDXVcPk,1319
-apytizer/utils/__init__.py,sha256=EOIMaFAH013KE_AAJkeT_kHDceoLLCB3Ep-FgW4RmTQ,110
-apytizer/utils/generate_key.py,sha256=tfllCUtYIlqmKxIA4oZ44dg2L_XXaC_9nPc7qlzTk30,421
-apytizer/utils/merge.py,sha256=RWgAm3VThk6s-vL_OhCLR-m8K09h9TaaL3XeVKCTSqY,370
-apytizer-0.0.1a0.dist-info/LICENSE,sha256=rwTrW8f9E015utDMKkNmSWxjW22qM-BDH6xSiLw0lGQ,10351
-apytizer-0.0.1a0.dist-info/METADATA,sha256=Eym7Ppzi6LnV-QhTPqfYO1-EaPIcntcecg9AGEcaCB8,885
-apytizer-0.0.1a0.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
-apytizer-0.0.1a0.dist-info/top_level.txt,sha256=6qWpqA68Ce4ygWKZEhGSg5O1XgZORvPNuD4A0QnD_dA,9
-apytizer-0.0.1a0.dist-info/RECORD,,

apytizer-0.0.1a0.dist-info/top_level.txt

@@ -1 +0,0 @@
-apytizer