merge from main

Author: Stewart86

.github/workflows/constraints.txt

@@ -1,5 +1,5 @@
-pip==21.2.4
-nox==2021.6.12
+pip==21.3.1
+nox==2021.10.1
 nox-poetry==0.8.6
-poetry==1.1.8
-virtualenv==20.7.2
+virtualenv==20.9.0
+poetry==1.1.11

.github/workflows/test.yml

@@ -73,3 +73,53 @@ jobs:
       - name: Run Nox
         run: |
           nox --force-color --python=${{ matrix.python-version }}
+
+      - name: Upload coverage data
+        if: always() && matrix.session == 'tests'
+        uses: "actions/[email protected]"
+        with:
+          name: coverage-data
+          path: ".coverage.*"
+
+  coverage:
+    runs-on: ubuntu-latest
+    needs: tests
+    steps:
+      - name: Check out the repository
+        uses: actions/[email protected]
+
+      - name: Set up Python 3.9
+        uses: actions/[email protected]
+        with:
+          python-version: 3.9
+
+      - name: Upgrade pip
+        run: |
+          pip install --constraint=.github/workflows/constraints.txt pip
+          pip --version
+
+      - name: Install Poetry
+        run: |
+          pip install --constraint=.github/workflows/constraints.txt poetry
+          poetry --version
+
+      - name: Install Nox
+        run: |
+          pip install --constraint=.github/workflows/constraints.txt nox nox-poetry
+          nox --version
+
+      - name: Download coverage data
+        uses: actions/[email protected]
+        with:
+          name: coverage-data
+
+      - name: Combine coverage data and display human readable report
+        run: |
+          nox --force-color --session=coverage
+
+      - name: Create coverage report
+        run: |
+          nox --force-color --session=coverage -- xml
+
+      - name: Upload coverage report
+        uses: codecov/[email protected]

.gitignore

@@ -53,13 +53,6 @@ cover/
 *.mo
 *.pot
 
-# 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__/
 
@@ -75,7 +68,7 @@ __pypackages__/
 dmypy.json
 
 # vscode
-vscode/
+.vscode/
 .vscode/settings.json
 .vscode/launch.json
 

CONTRIBUTING.rst

@@ -8,7 +8,6 @@ welcomes contributions in the form of bug reports, feature requests, and pull re
 Here is a list of important resources for contributors:
 
 - `Source Code`_
-- `Documentation`_
 - `Issue Tracker`_
 - `Code of Conduct`_
 
@@ -57,11 +56,6 @@ Install the package with development requirements:
 You can now run an interactive Python session,
 or the command-line interface:
 
-.. code:: console
-
-   $ poetry run python
-   $ poetry run aiocloudflare
-
 .. _Poetry: https://python-poetry.org/
 .. _Nox: https://nox.thea.codes/
 .. _nox-poetry: https://nox-poetry.readthedocs.io/

README.rst

@@ -7,6 +7,8 @@ aioCloudflare
 
 |pre-commit| |Black|
 
+|Downloads|
+
 .. |PyPI| image:: https://img.shields.io/pypi/v/aiocloudflare.svg
    :target: https://pypi.org/project/aiocloudflare/
    :alt: PyPI
@@ -31,12 +33,15 @@ aioCloudflare
 .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Black
+.. |Downloads| image:: https://static.pepy.tech/badge/aiocloudflare
+   :target: https://pepy.tech/project/aiocloudflare
+   :alt: Downloads
 
-Inspired by the offical `python-cloudflare` library developed by `Cloudflare`_. This project is created to be competible to use with `asyncio` for non-blocking IO.
+Inspired by the offical ``python-cloudflare`` library developed by `Cloudflare`_. This project is created to be compatible with ``asyncio`` for non-blocking IO.
 
-For sync code, it is recommanded to use `python-cloudflare` via `pip install python-cloudflare` as it is used by hundreds and offically maintained by cloudflare. This ensure that APIs are always updated according to Cloudflare API release.
+For sync code, it is recommanded to use ``python-cloudflare`` via ``pip install python-cloudflare`` as it is used by hundreds and offically maintained by Cloudflare. This ensure that APIs are always updated according to Cloudflare API release.
 
-*NOTE:* This library is in Pre-Alpha, this means things might break. Do not use it in Production unless you have tested on the API route specific to your use case and that would be at your own risk.
+*NOTE:* This library is in Beta, this means fixes and updates are still going on every second. Do not use it in Production unless you have tested on the API route specific to your use case and that would be at your own risk.
 
 Having said that, do submit an issue if you encounter any bug so we can move away from the Alpha stage sooner.
 
@@ -47,6 +52,15 @@ Features
 * Autocompletion on IDE.
 * Fully type hinted.
 
+Feature Roadmap
+---------------
+
+* to support cert token
+* to support sync API client
+
+These are some alternative use cases that are not in the top of my priority now as I have not received
+any request for. If you are interested, you may want to submit a pull request to contribute some of these features.
+
 
 Requirements
 ------------
@@ -73,19 +87,82 @@ Usage
 
     async def get_zone():
         async with Cloudflare() as cf:
-            result = await cf.zones.get()
+            response = await cf.zones.get()
+
+Unlike the offical ``python-cloudflare`` library, ``aiocloudflare`` does not parse and handle http responses.
+
+So the awaited response object will have to be handled just as any http request, response pattern. the ``Response`` object is the same as ``httpx``'s ``Response``.
+
+.. code:: Python
+
+    from aiocloudflare import Cloudflare
+
+    async def get_zone():
+        async with Cloudflare() as cf:
+            response = await cf.zones.get()
+
+            # check status code
+            if response.status_code == 200:
+
+                # get json data
+                resp_json = response.json()
+
+                # Cloudflare API typically store results in a ``result`` key.
+                return resp_json["result"]
 
-Full configuration can be done using `Config()` class.
+            else:
+                # to get texture data from response
+                print(response.text)
+
+
+Full configuration can be done using ``Config()`` class.
 
 .. code:: Python
 
     from aioCloudflare import Cloudflare, Config
 
-    config = Config(email="[email protected]", token="<secret>")
+    config = Config(email="[email protected]", token="<secret>")  # for demo only, do not hardcode secrets
     async def get_zone():
         async with Cloudflare(config=config) as cf:
             result = await cf.zones.get()
 
+Configuration can also be stored in a ``.env`` file for a "global" configuration without needing to create a ``Config()`` class. Keys available are:
+
+.. code:: console
+
+    CF_API_EMAIL=""
+    CF_API_KEY=""
+    CF_API_CERTKEY=""
+    CF_API_URL=""
+    DEBUG=false
+    CF_PROFILE=""
+    USER_AGENT=""
+
+Advance Usage
+_____________
+
+You may wish to wrap ``Cloudflare()`` into you own class for customised settings or requirements. To do that, just provide a ``__aenter__()`` and ``__aexit__()`` method to your class like so.
+
+.. code:: Python
+
+    class MyCfClient:
+        def __init__(self):
+            self._config = Config(email="[email protected]", token="<secret>")  # for demo only, do not hardcode secrets
+
+        async def __aenter__(self):
+            self._client = Cloudflare(config=self._config)
+            return self
+
+        async def __aexit__(self, exc_type, exc_value, traceback):
+            await self._client.aclose()
+
+Then you can call your own class with async context manager.
+
+.. code:: Python
+
+    async with MyCfClient() as own_class:
+        await own_class.zones.get()
+
 
 Contributing
 ------------
@@ -98,7 +175,7 @@ License
 -------
 
 Distributed under the terms of the `MIT license`_,
-*Hello World* is free and open source software.
+*aioCloudflare* is free and open source software.
 
 
 Issues
@@ -112,6 +189,6 @@ please `file an issue`_ along with a detailed description.
 .. _PyPI: https://pypi.org/
 .. _file an issue: https://github.com/stewart86/aiocloudflare/issues
 .. _pip: https://pip.pypa.io/
+.. _Cloudflare: https://github.com/cloudflare/python-cloudflare
 .. github-only
 .. _Contributor Guide: CONTRIBUTING.rst
-.. _Cloudflare: https://cloudflare.com

aiocloudflare/api/accounts/access/access.py

@@ -1,7 +1,43 @@
 from aiocloudflare.commons.unused import Unused
 
+from .apps.apps import Apps
+from .certificates.certificates import Certificates
+from .groups.groups import Groups
+from .identity_providers.identity_providers import IdentityProviders
+from .logs.logs import Logs
+from .organizations.organizations import Organizations
+from .service_tokens.service_tokens import ServiceTokens
+
 
 class Access(Unused):
     _endpoint1 = "accounts"
     _endpoint2 = "access"
     _endpoint3 = None
+
+    @property
+    def logs(self) -> Logs:
+        return Logs(self._config, self._session)
+
+    @property
+    def identity_providers(self) -> IdentityProviders:
+        return IdentityProviders(self._config, self._session)
+
+    @property
+    def organizations(self) -> Organizations:
+        return Organizations(self._config, self._session)
+
+    @property
+    def groups(self) -> Groups:
+        return Groups(self._config, self._session)
+
+    @property
+    def service_tokens(self) -> ServiceTokens:
+        return ServiceTokens(self._config, self._session)
+
+    @property
+    def certificates(self) -> Certificates:
+        return Certificates(self._config, self._session)
+
+    @property
+    def apps(self) -> Apps:
+        return Apps(self._config, self._session)

aiocloudflare/api/accounts/access/apps/apps.py

@@ -10,14 +10,14 @@ class Apps(Auth):
     _endpoint2 = "access/apps"
     _endpoint3 = None
 
-    @property
-    def ca(self) -> Ca:
-        return Ca(self._config, self._session)
-
     @property
     def policies(self) -> Policies:
         return Policies(self._config, self._session)
 
     @property
     def revoke_tokens(self) -> RevokeTokens:
         return RevokeTokens(self._config, self._session)
+
+    @property
+    def ca(self) -> Ca:
+        return Ca(self._config, self._session)