apytizer 0.0.1a0__tar.gz → 0.0.1b1__tar.gz

apytizer-0.0.1b1/.gitignore

@@ -0,0 +1,135 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# VS Code settings
+.vscode
+
+# OS stuff
+.DS_Store

apytizer-0.0.1b1/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2021 Sean Sullivan
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

apytizer-0.0.1b1/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: apytizer
+Version: 0.0.1b1
+Summary: Implement wrappers quickly for REST APIs.
+Project-URL: Homepage, https://github.com/seanssullivan/apytizer
+Project-URL: Repository, https://github.com/seanssullivan/apytizer.git
+Project-URL: Issues, https://github.com/seanssullivan/apytizer/issues
+Author-email: Sean Sullivan <seansullivan@seanmedia.ca>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Requires-Dist: cachetools
+Requires-Dist: requests
+Provides-Extra: docs
+Requires-Dist: sphinx>=2.0.0; extra == 'docs'
+Provides-Extra: testing
+Requires-Dist: cachetools; extra == 'testing'
+Requires-Dist: coverage; extra == 'testing'
+Requires-Dist: flask; extra == 'testing'
+Requires-Dist: pytest; extra == 'testing'
+Requires-Dist: pytest-cov; extra == 'testing'
+Requires-Dist: pytest-env; extra == 'testing'
+Requires-Dist: requests; extra == 'testing'
+Requires-Dist: tox; extra == 'testing'
+Description-Content-Type: text/markdown
+
+# apytizer
+
+Implement wrappers quickly for REST APIs.

apytizer-0.0.1b1/pyproject.toml

@@ -0,0 +1,97 @@
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "apytizer"
+version = "0.0.1b1"
+authors = [
+  { name="Sean Sullivan", email="seansullivan@seanmedia.ca" },
+]
+description = "Implement wrappers quickly for REST APIs."
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.9"
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+]
+license = "Apache-2.0"
+license-files = ["LICEN[CS]E*"]
+dependencies = [
+  "cachetools",
+  "requests",
+]
+
+[project.urls]
+Homepage = "https://github.com/seanssullivan/apytizer"
+Repository = "https://github.com/seanssullivan/apytizer.git"
+Issues = "https://github.com/seanssullivan/apytizer/issues"
+
+[project.optional-dependencies]
+docs = [
+  "sphinx>=2.0.0",
+]
+testing = [
+  "cachetools",
+  "coverage",
+  "Flask",
+  "pytest",
+  "pytest-cov",
+  "pytest-env",
+  "requests",
+  "tox",
+]
+
+[dev-dependencies]
+black = { version = "^22.10.0", python = "^3.9" }
+
+[tool.black]
+line-length = 79
+exclude = '''
+
+(
+    /(
+          \.eggs      # exclude a few common directories in the
+        | \.git       # root of the project
+        | \.mypy_cache
+        | \.tox
+        | \.venv
+        | build
+        | dist
+        | env
+    )
+)
+'''
+
+[tool.coverage.report]
+show_missing = true
+exclude_lines = [
+    'pragma: no cover',
+    '\.\.\.',
+    'if TYPE_CHECKING:',
+    "if __name__ == '__main__':",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/apytizer"]
+exclude = [
+  "src/apytizer/factories",
+  "src/apytizer/managers",
+  "src/apytizer/mappers",
+  "src/apytizer/repositories",
+  "src/apytizer/states",
+  "tests/*",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/apytizer"]

apytizer-0.0.1b1/src/apytizer/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+# src/apytizer/__init__.py
+
+__version__ = "0.0.1"

apytizer-0.0.1b1/src/apytizer/adapters/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+# Local Imports
+from .transport_adapter import *

apytizer-0.0.1b1/src/apytizer/adapters/transport_adapter.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+# src/apytizer/adapters/transport_adapter.py
+"""Transport Adapter.
+
+This module defines a transport adapter class: an implementation of an
+HTTPAdapter which handles exponential backoff for retrying requests and
+provides default values for rate limiting and timeout.
+
+"""
+
+# Standard Library Imports
+from http import HTTPStatus
+from typing import Any
+from urllib3.util import Retry
+
+# Third-Party Imports
+from requests import PreparedRequest
+from requests import Response
+from requests.adapters import HTTPAdapter
+
+# Local Import
+from ..http_methods import HTTPMethod
+
+__all__ = ["TransportAdapter"]
+
+
+# Constants
+DEFAULT_RATE_LIMIT = 1
+DEFAULT_TIMEOUT = 5
+NUMBER_OF_RETRIES = 10
+
+
+class TransportAdapter(HTTPAdapter):
+    """Implementation of a transport adaptor.
+
+    Transport adapters define methods for interacting with HTTP services,
+    enabling the use of per-service configurations.
+
+    Args:
+        *args: Positional arguments.
+        rate_limit (optional): Rate limit.
+        timeout (optional): Timeout.
+        **kwargs: Keyword arguments.
+
+    """
+
+    def __init__(
+        self,
+        *args: Any,
+        rate_limit: int = DEFAULT_RATE_LIMIT,
+        timeout: int = DEFAULT_TIMEOUT,
+        **kwargs: Any,
+    ) -> None:
+        kwargs.setdefault("max_retries", make_retry(rate_limit))
+        super().__init__(*args, **kwargs)
+        self.timeout = timeout
+
+    def send(
+        self,
+        request: PreparedRequest,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Response:
+        kwargs.setdefault("timeout", self.timeout)
+        return super().send(request, *args, **kwargs)
+
+
+def make_retry(rate_limit: int) -> Retry:
+    """Make retry configuration.
+
+    Args:
+        rate_limit: Rate limit for backoff factor.
+
+    Returns:
+        Retry configuration.
+
+    """
+    result = Retry(
+        total=NUMBER_OF_RETRIES,
+        status_forcelist=[
+            HTTPStatus.REQUEST_ENTITY_TOO_LARGE,
+            HTTPStatus.TOO_MANY_REQUESTS,
+            HTTPStatus.INTERNAL_SERVER_ERROR,
+            HTTPStatus.BAD_GATEWAY,
+            HTTPStatus.SERVICE_UNAVAILABLE,
+            HTTPStatus.GATEWAY_TIMEOUT,
+        ],
+        allowed_methods=[method.name for method in HTTPMethod],
+        backoff_factor=rate_limit,
+    )
+    return result

apytizer-0.0.1b1/src/apytizer/apis/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+# src/apytizer/apis/__init__.py
+
+# Local Imports
+from .abstract_api import *
+from .web_api import *

apytizer-0.0.1b1/src/apytizer/apis/abstract_api.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# src/apytizer/apis/abstract_api.py
+"""Abstract API Class.
+
+This module defines an abstract API class which provides an interface
+for subclasses to implement.
+
+"""
+
+# Standard Library Imports
+from __future__ import annotations
+import abc
+from typing import Optional
+
+# Local Imports
+from ..connections import AbstractConnection
+
+__all__ = ["AbstractAPI"]
+
+
+class AbstractAPI(abc.ABC):
+    """Represents an abstract API."""
+
+    @property
+    @abc.abstractmethod
+    def connection(self) -> Optional[AbstractConnection]:
+        """Connection with which to make requests."""
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def __eq__(self, other: object) -> bool:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def __hash__(self) -> int:
+        raise NotImplementedError