lswapi 0.4.2__tar.gz → 0.5.0__tar.gz

lswapi-0.5.0/.version

@@ -0,0 +1 @@
+0.5.0

lswapi-0.5.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.2
+Name: lswapi
+Version: 0.5.0
+Summary: a python client library for easy leaseweb api access
+Author-email: Nico Di Rocco <n.dirocco@global.leaseweb.com>
+License: Apache-2.0
+Project-URL: Homepage, http://developer.leaseweb.com
+Project-URL: Issues, https://github.com/nrocco/lswapi
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: develop
+Requires-Dist: flake8; extra == "develop"
+Requires-Dist: pytest; extra == "develop"
+Requires-Dist: pytest-cov; extra == "develop"
+Requires-Dist: requests-mock; extra == "develop"
+Requires-Dist: twine; extra == "develop"
+Provides-Extra: httpie
+Requires-Dist: httpie; extra == "httpie"
+Provides-Extra: requests
+Requires-Dist: requests; extra == "requests"
+Provides-Extra: aio
+Requires-Dist: aiodns; extra == "aio"
+Requires-Dist: aiohttp; extra == "aio"
+
+# lswapi (beta)
+
+[![Actions Status](https://github.com/nrocco/lswapi/workflows/Python%20package/badge.svg)](https://github.com/nrocco/lswapi/actions)
+
+Python module to talk to Leaseweb's API.
+
+For more information refer to the documentation available at
+[http://developer.leaseweb.com]
+
+This module contains two api clients:
+
+1.  One is based on the `requests` module.
+2.  The second one is based on the `aiohttp` module for asyncio support.
+
+
+## Installation
+
+Install the module using pip. This will not install `requests` or `aiohttp`.
+
+    pip install lswapi
+
+
+You can install optional depencies, such as `aiohttp`:
+
+    pip install 'lswapi[aio]'
+
+Or if you prefer to use `requests`:
+
+    pip install 'lswapi[requests]'
+
+
+## Usage
+
+
+### Using requests
+
+The `lswapi.requests.get_leaseweb_api` function creates an instance of the Leaseweb Api
+object with the `X-Lsw-Auth` key. You can provide the api key as an argument
+to `get_leaseweb_api`
+
+    $ python
+    >>> from lswapi.requests import get_leaseweb_api
+    >>> client = get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
+    >>> response = client.get("/bareMetals/v2/servers")
+    >>> servers = response.json()
+
+
+or get `LSW_API_KEY` from an environment variable:
+
+    $ LSW_API_KEY=xxxx-xxxx-xxxxx python
+    >>> from lswapi.requests import get_leaseweb_api
+    >>> client = get_leaseweb_api()
+    >>> response = client.get("/bareMetals/v2/servers")
+    >>> servers = response.json()
+
+
+### Using aiohttp
+
+The `lswapi.aio.get_leaseweb_api` function creates an instance of the Leaseweb Api
+object with the `X-Lsw-Auth` key. You can provide the api key as an argument
+to `get_leaseweb_api` or via the environment variable `LSW_API_KEY`:
+
+    $ python -m asyncio
+    >>> from lswapi.aio import get_leaseweb_api
+    >>> client = get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
+    >>> response = await client.get("/bareMetals/v2/servers")
+    >>> servers = await response.json()
+
+
+Contribute
+----------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make sure that tests pass (`make test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

lswapi-0.5.0/README.md

@@ -0,0 +1,78 @@
+# lswapi (beta)
+
+[![Actions Status](https://github.com/nrocco/lswapi/workflows/Python%20package/badge.svg)](https://github.com/nrocco/lswapi/actions)
+
+Python module to talk to Leaseweb's API.
+
+For more information refer to the documentation available at
+[http://developer.leaseweb.com]
+
+This module contains two api clients:
+
+1.  One is based on the `requests` module.
+2.  The second one is based on the `aiohttp` module for asyncio support.
+
+
+## Installation
+
+Install the module using pip. This will not install `requests` or `aiohttp`.
+
+    pip install lswapi
+
+
+You can install optional depencies, such as `aiohttp`:
+
+    pip install 'lswapi[aio]'
+
+Or if you prefer to use `requests`:
+
+    pip install 'lswapi[requests]'
+
+
+## Usage
+
+
+### Using requests
+
+The `lswapi.requests.get_leaseweb_api` function creates an instance of the Leaseweb Api
+object with the `X-Lsw-Auth` key. You can provide the api key as an argument
+to `get_leaseweb_api`
+
+    $ python
+    >>> from lswapi.requests import get_leaseweb_api
+    >>> client = get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
+    >>> response = client.get("/bareMetals/v2/servers")
+    >>> servers = response.json()
+
+
+or get `LSW_API_KEY` from an environment variable:
+
+    $ LSW_API_KEY=xxxx-xxxx-xxxxx python
+    >>> from lswapi.requests import get_leaseweb_api
+    >>> client = get_leaseweb_api()
+    >>> response = client.get("/bareMetals/v2/servers")
+    >>> servers = response.json()
+
+
+### Using aiohttp
+
+The `lswapi.aio.get_leaseweb_api` function creates an instance of the Leaseweb Api
+object with the `X-Lsw-Auth` key. You can provide the api key as an argument
+to `get_leaseweb_api` or via the environment variable `LSW_API_KEY`:
+
+    $ python -m asyncio
+    >>> from lswapi.aio import get_leaseweb_api
+    >>> client = get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
+    >>> response = await client.get("/bareMetals/v2/servers")
+    >>> servers = await response.json()
+
+
+Contribute
+----------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make sure that tests pass (`make test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

lswapi-0.5.0/lswapi.egg-info/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.2
+Name: lswapi
+Version: 0.5.0
+Summary: a python client library for easy leaseweb api access
+Author-email: Nico Di Rocco <n.dirocco@global.leaseweb.com>
+License: Apache-2.0
+Project-URL: Homepage, http://developer.leaseweb.com
+Project-URL: Issues, https://github.com/nrocco/lswapi
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: develop
+Requires-Dist: flake8; extra == "develop"
+Requires-Dist: pytest; extra == "develop"
+Requires-Dist: pytest-cov; extra == "develop"
+Requires-Dist: requests-mock; extra == "develop"
+Requires-Dist: twine; extra == "develop"
+Provides-Extra: httpie
+Requires-Dist: httpie; extra == "httpie"
+Provides-Extra: requests
+Requires-Dist: requests; extra == "requests"
+Provides-Extra: aio
+Requires-Dist: aiodns; extra == "aio"
+Requires-Dist: aiohttp; extra == "aio"
+
+# lswapi (beta)
+
+[![Actions Status](https://github.com/nrocco/lswapi/workflows/Python%20package/badge.svg)](https://github.com/nrocco/lswapi/actions)
+
+Python module to talk to Leaseweb's API.
+
+For more information refer to the documentation available at
+[http://developer.leaseweb.com]
+
+This module contains two api clients:
+
+1.  One is based on the `requests` module.
+2.  The second one is based on the `aiohttp` module for asyncio support.
+
+
+## Installation
+
+Install the module using pip. This will not install `requests` or `aiohttp`.
+
+    pip install lswapi
+
+
+You can install optional depencies, such as `aiohttp`:
+
+    pip install 'lswapi[aio]'
+
+Or if you prefer to use `requests`:
+
+    pip install 'lswapi[requests]'
+
+
+## Usage
+
+
+### Using requests
+
+The `lswapi.requests.get_leaseweb_api` function creates an instance of the Leaseweb Api
+object with the `X-Lsw-Auth` key. You can provide the api key as an argument
+to `get_leaseweb_api`
+
+    $ python
+    >>> from lswapi.requests import get_leaseweb_api
+    >>> client = get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
+    >>> response = client.get("/bareMetals/v2/servers")
+    >>> servers = response.json()
+
+
+or get `LSW_API_KEY` from an environment variable:
+
+    $ LSW_API_KEY=xxxx-xxxx-xxxxx python
+    >>> from lswapi.requests import get_leaseweb_api
+    >>> client = get_leaseweb_api()
+    >>> response = client.get("/bareMetals/v2/servers")
+    >>> servers = response.json()
+
+
+### Using aiohttp
+
+The `lswapi.aio.get_leaseweb_api` function creates an instance of the Leaseweb Api
+object with the `X-Lsw-Auth` key. You can provide the api key as an argument
+to `get_leaseweb_api` or via the environment variable `LSW_API_KEY`:
+
+    $ python -m asyncio
+    >>> from lswapi.aio import get_leaseweb_api
+    >>> client = get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
+    >>> response = await client.get("/bareMetals/v2/servers")
+    >>> servers = await response.json()
+
+
+Contribute
+----------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make sure that tests pass (`make test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

lswapi-0.5.0/lswapi.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+.version
+LICENSE.txt
+README.md
+pyproject.toml
+lswapi.egg-info/PKG-INFO
+lswapi.egg-info/SOURCES.txt
+lswapi.egg-info/dependency_links.txt
+lswapi.egg-info/entry_points.txt
+lswapi.egg-info/requires.txt
+lswapi.egg-info/top_level.txt
+src/lswapi/__init__.py
+src/lswapi/httpie.py
+src/lswapi/aio/__init__.py
+src/lswapi/aio/client.py
+src/lswapi/aio/middleware.py
+src/lswapi/aio/oauth.py
+src/lswapi/requests/__init__.py
+src/lswapi/requests/oauth.py
+src/lswapi/requests/session.py
+tests/test_aio.py
+tests/test_lswapi.py
+tests/test_requests.py

{lswapi-0.4.2 → lswapi-0.5.0}/lswapi.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [httpie.plugins.auth.v1]
 httpie_lswapi = lswapi.httpie:ApiAuthPlugin
-

lswapi-0.5.0/lswapi.egg-info/requires.txt

@@ -0,0 +1,17 @@
+
+[aio]
+aiodns
+aiohttp
+
+[develop]
+flake8
+pytest
+pytest-cov
+requests-mock
+twine
+
+[httpie]
+httpie
+
+[requests]
+requests

lswapi-0.5.0/pyproject.toml

@@ -0,0 +1,67 @@
+[project]
+name = "lswapi"
+dynamic = ["version"]
+description = "a python client library for easy leaseweb api access"
+readme = "README.md"
+authors = [
+    { name="Nico Di Rocco", email="n.dirocco@global.leaseweb.com" },
+]
+license = {text="Apache-2.0"}
+requires-python = ">= 3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: Unix",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities"
+]
+
+[project.urls]
+Homepage = "http://developer.leaseweb.com"
+Issues = "https://github.com/nrocco/lswapi"
+
+[project.optional-dependencies]
+develop = [
+    "flake8",
+    "pytest",
+    "pytest-cov",
+    "requests-mock",
+    "twine",
+]
+httpie = [
+    "httpie",
+]
+requests = [
+    "requests",
+]
+aio = [
+    "aiodns",
+    "aiohttp",
+]
+
+[project.entry-points."httpie.plugins.auth.v1"]
+httpie_lswapi = "lswapi.httpie:ApiAuthPlugin"
+
+[build-system]
+requires = [
+    "setuptools>=64",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {file = ".version"}
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.distutils.egg_info]
+egg_base = "."

lswapi-0.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

lswapi-0.5.0/src/lswapi/__init__.py

@@ -0,0 +1,9 @@
+try:
+    from importlib.metadata import version
+    __version__ = version(__name__)
+    del version
+except Exception:
+    __version__ = "unknown"
+
+__auth_token_url__ = "https://auth.leaseweb.com/token"
+__api_base_url__ = "https://api.leaseweb.com"

lswapi-0.5.0/src/lswapi/aio/__init__.py

@@ -0,0 +1,27 @@
+from lswapi import __api_base_url__
+from lswapi import __auth_token_url__
+from lswapi.aio.client import LeasewebHttpClient
+from lswapi.aio.middleware import LoggingMiddleware
+from lswapi.aio.oauth import AccessTokenFileStore
+from lswapi.aio.oauth import LeasewebOAuthMiddleware
+from os import environ
+
+
+def get_leaseweb_api(api_key=None, client_id=None, client_secret=None, base_url=None, token_url=None, token_store=None):
+    base_url = base_url or environ.get("LSW_BASE_URL", __api_base_url__)
+    token_url = token_url or environ.get("LSW_AUTH_URL", __auth_token_url__)
+    token_store = token_store or environ.get("LSW_AUTH_TOKEN_STORE")
+    api_key = api_key or environ.get("LSW_API_KEY")
+    if api_key:
+        return LeasewebHttpClient(base_url, middlewares=[LoggingMiddleware(debug=False)], headers={"X-Lsw-Auth": api_key})
+    if not client_id or not client_secret:
+        raise Exception("No authentication method specified")
+    return LeasewebHttpClient(base_url, middlewares=[
+        LeasewebOAuthMiddleware(
+            client_id,
+            client_secret,
+            token_url,
+            store=AccessTokenFileStore(token_store) if token_store else None,
+        ),
+        LoggingMiddleware(debug=False),
+    ])

lswapi-0.5.0/src/lswapi/aio/client.py

@@ -0,0 +1,46 @@
+from aiohttp import ClientSession
+
+
+class LeasewebHttpClient:
+    def __init__(self, *args, middlewares: list[callable] = [], **kwargs):
+        self.middlewares = middlewares
+        self.session = ClientSession(*args, **kwargs)
+
+    async def _run_middlewares(self, method, url, next_func, **kwargs):
+        async def middleware_chain(index, method, url, **kwargs):
+            if index < len(self.middlewares):
+                return await self.middlewares[index](
+                    method, url, lambda m, u, **k: middleware_chain(index + 1, m, u, **k), **kwargs
+                )
+            return await next_func(method, url, **kwargs)
+        return await middleware_chain(0, method, url, **kwargs)
+
+    async def _request(self, method, url, **kwargs):
+        return await self.session.request(method, url, **kwargs)
+
+    async def request(self, method, url, **kwargs):
+        return await self._run_middlewares(method, url, self._request, **kwargs)
+
+    async def get(self, url, **kwargs):
+        return await self.request("GET", url, **kwargs)
+
+    async def post(self, url, **kwargs):
+        return await self.request("POST", url, **kwargs)
+
+    async def put(self, url, **kwargs):
+        return await self.request("PUT", url, **kwargs)
+
+    async def patch(self, url, **kwargs):
+        return await self.request("PATCH", url, **kwargs)
+
+    async def delete(self, url, **kwargs):
+        return await self.request("DELETE", url, **kwargs)
+
+    async def close(self):
+        await self.session.close()
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await self.close()

lswapi-0.5.0/src/lswapi/aio/middleware.py

@@ -0,0 +1,20 @@
+import time
+import logging
+
+
+class LoggingMiddleware:
+    def __init__(self, debug=False) -> None:
+        self.debug = debug
+
+    async def __call__(self, method, url, next_func, **kwargs):
+        start = time.monotonic()
+        response = await next_func(method, url, **kwargs)
+        end = time.monotonic()
+        logging.info(f"Request to {response.method} {response.url} took {(end - start):.3f} seconds and resulted in a {response.status} {response.reason}")
+        if self.debug:
+            for header, value in response.request_info.headers.items():
+                logging.debug(f">>> {header}: {value}")
+            logging.debug(f"<<< HTTP/{response.version.major}.{response.version.minor} {response.status} {response.reason}")
+            for header, value in response.headers.items():
+                logging.debug(f"<<< {header}: {value}")
+        return response

lswapi-0.5.0/src/lswapi/aio/oauth.py

@@ -0,0 +1,85 @@
+import aiohttp
+import asyncio
+import json
+import os
+import time
+
+from lswapi.aio.client import LeasewebHttpClient
+from lswapi.aio.middleware import LoggingMiddleware
+
+
+class AccessTokenInMemoryStore:
+    def __init__(self):
+        self.token = None
+
+    async def load(self):
+        return self.token
+
+    async def save(self, token):
+        self.token = token
+
+    async def remove(self):
+        self.token = None
+
+
+class AccessTokenFileStore:
+    def __init__(self, filepath):
+        self.token = None
+        self.filepath = filepath
+        self.lock = asyncio.Lock()
+
+    async def load(self):
+        async with self.lock:
+            if self.token:
+                return self.token
+            if not os.path.exists(self.filepath):
+                return None
+            with open(self.filepath, "r") as file:
+                try:
+                    self.token = json.load(file)
+                except json.decoder.JSONDecodeError:
+                    os.remove(self.filepath)
+        return self.token
+
+    async def save(self, token):
+        async with self.lock:
+            with open(self.filepath, "w") as file:
+                json.dump(token, file)
+            self.token = token
+
+    async def remove(self):
+        async with self.lock:
+            if os.path.exists(self.filepath):
+                os.remove(self.filepath)
+            self.token = None
+
+
+class LeasewebOAuthMiddleware:
+    def __init__(self, client_id, client_secret, token_url, store=None):
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.token_url = token_url
+        self.store = store or AccessTokenInMemoryStore()
+        self.lock = asyncio.Lock()
+
+    async def __call__(self, method, url, next_func, **kwargs):
+        async with self.lock:
+            token = await self.store.load()
+            if not token or token.get("expires_at") < time.time():
+                token = await self.__fetch_access_token()
+                await self.store.save(token)
+        if "headers" not in kwargs:
+            kwargs["headers"] = {}
+        kwargs["headers"]["Authorization"] = "{token_type} {access_token}".format(**token)
+        return await next_func(method, url, **kwargs)
+
+    async def __fetch_access_token(self):
+        auth = aiohttp.BasicAuth(login=self.client_id, password=self.client_secret)
+        async with LeasewebHttpClient(auth=auth, middlewares=[LoggingMiddleware(debug=False)]) as client:
+            payload = {"grant_type": "client_credentials"}
+            response = await client.post(self.token_url, data=payload)
+            assert response.status == 200
+            token = await response.json()
+            token["issued_at"] = int(time.time())
+            token["expires_at"] = token["issued_at"] + token["expires_in"] - 10
+            return token

lswapi-0.4.2/lswapi/httpie/__init__.py → lswapi-0.5.0/src/lswapi/httpie.py

@@ -1,11 +1,15 @@
 """
 LswApi auth plugin for HTTPie.
 """
+from httpie.plugins import AuthPlugin
 from json import loads, dumps
-from time import time
+from lswapi import __auth_token_url__
+from lswapi.requests import fetch_access_token
 from os import path
-from lswapi import __auth_token_url__, __token_store__, fetch_access_token
-from httpie.plugins import AuthPlugin
+from time import time
+
+
+__token_store__ = path.expanduser("~/.lswapi.token")
 
 
 class LswApiAuth(object):
@@ -15,25 +19,25 @@ class LswApiAuth(object):
 
     def __call__(self, r):
         if path.exists(__token_store__):
-            with open(__token_store__, 'r') as file:
+            with open(__token_store__, "r") as file:
                 token = loads(file.read())
-            if 'expires_at' in token and token['expires_at'] > time():
-                r.headers['Authorization'] = '{token_type} {access_token}'.format(**token)
+            if "expires_at" in token and token["expires_at"] > time():
+                r.headers["Authorization"] = "{token_type} {access_token}".format(**token)
                 return r
 
         token = fetch_access_token(__auth_token_url__, self.client_id, self.client_secret)
 
-        with open(__token_store__, 'w') as file:
+        with open(__token_store__, "w") as file:
             file.write(dumps(token))
 
-        r.headers['Authorization'] = '{token_type} {access_token}'.format(**token)
+        r.headers["Authorization"] = "{token_type} {access_token}".format(**token)
         return r
 
 
 class ApiAuthPlugin(AuthPlugin):
-    name = 'LswApi Oauth'
-    auth_type = 'lswapi'
-    description = 'LeaseWeb Api Oauth Authentication'
+    name = "LswApi Oauth"
+    auth_type = "lswapi"
+    description = "Leaseweb Api Oauth Authentication"
 
     def get_auth(self, username, password):
         return LswApiAuth(username, password)

lswapi-0.5.0/src/lswapi/requests/__init__.py

@@ -0,0 +1,21 @@
+from lswapi import __api_base_url__
+from lswapi import __auth_token_url__
+from lswapi.requests.session import LeasewebSession
+from lswapi.requests.session import LeasewebApiKeyAuth
+from os import environ
+
+
+def get_leaseweb_api(api_key=None, client_id=None, client_secret=None, base_url=None, token_url=None, token_store=None):
+    base_url = base_url or environ.get("LSW_BASE_URL", __api_base_url__)
+    token_url = token_url or environ.get("LSW_AUTH_URL", __auth_token_url__)
+    token_store = token_store or environ.get("LSW_AUTH_TOKEN_STORE", None)
+    api_key = api_key or environ.get("LSW_API_KEY")
+    if api_key:
+        api = LeasewebSession(base_url=base_url)
+        api.auth = (LeasewebApiKeyAuth(api_key))
+        return api
+    client_id = client_id or environ.get("LSW_CLIENT_ID")
+    client_secret = client_secret or environ.get("LSW_CLIENT_SECRET")
+    if client_id and client_secret:
+        return LeasewebSession(base_url=base_url, client_id=client_id, client_secret=client_secret, token_url=token_url, token_store=token_store)
+    raise Exception("No authentication method specified")

lswapi-0.5.0/src/lswapi/requests/oauth.py

@@ -0,0 +1,12 @@
+from requests import post
+from time import time
+
+
+def fetch_access_token(token_url, client_id, client_secret):
+    response = post(token_url, auth=(client_id, client_secret), data={"grant_type": "client_credentials"})
+    if response.status_code != 200:
+        raise Exception("Could not obtain an access token")
+    token = response.json()
+    token["created_at"] = int(time())
+    token["expires_at"] = token["created_at"] + token["expires_in"] - 10
+    return token

lswapi-0.5.0/src/lswapi/requests/session.py

@@ -0,0 +1,49 @@
+from json import load, dump
+from lswapi import __api_base_url__
+from lswapi import __auth_token_url__
+from lswapi.requests.oauth import fetch_access_token
+from os import path
+from requests import Session
+from requests.auth import AuthBase
+from time import time
+
+
+class LeasewebApiKeyAuth(AuthBase):
+    def __init__(self, lsw_auth_key):
+        self.lsw_auth_key = lsw_auth_key
+
+    def __call__(self, r):
+        r.headers["X-Lsw-Auth"] = self.lsw_auth_key
+        return r
+
+
+class LeasewebSession(Session):
+    access_token = None
+
+    def __init__(self, client_id=None, client_secret=None, base_url=None, token_url=None, token_store=None):
+        self.base_url = base_url or __api_base_url__
+        self.token_url = token_url or __auth_token_url__
+        self.token_store = token_store
+        self.client_id = client_id
+        self.client_secret = client_secret
+        super().__init__()
+
+    def _fetch_access_token(self):
+        if not self.access_token and self.token_store:
+            if path.exists(self.token_store):
+                with open(self.token_store, "r") as file:
+                    self.access_token = load(file)
+        if self.access_token and self.access_token.get("expires_at") > time():
+            return self.access_token
+        self.access_token = fetch_access_token(self.token_url, self.client_id, self.client_secret)
+        if self.token_store:
+            with open(self.token_store, "w") as file:
+                dump(self.access_token, file)
+        return self.access_token
+
+    def request(self, method, url, data=None, headers={}, **kwargs):
+        if self.client_id and self.client_secret:
+            headers["Authorization"] = "{token_type} {access_token}".format(**self._fetch_access_token())
+        if not url.startswith("http"):
+            url = "{}/{}".format(self.base_url, url.lstrip("/"))
+        return super().request(method, url, headers=headers, data=data, **kwargs)

lswapi-0.5.0/tests/test_aio.py

@@ -0,0 +1,23 @@
+import asyncio
+import pytest
+
+from lswapi.aio import get_leaseweb_api
+
+
+def test_get_with_nothing():
+    async def fuubar():
+        with pytest.raises(Exception):
+            get_leaseweb_api()
+    asyncio.run(fuubar())
+
+
+def test_get_with_api_key():
+    async def fuubar():
+        assert get_leaseweb_api(api_key="xxx")
+    asyncio.run(fuubar())
+
+
+def test_get_with_oauth():
+    async def fuubar():
+        assert get_leaseweb_api(client_id="xxx", client_secret="yyy")
+    asyncio.run(fuubar())

lswapi-0.5.0/tests/test_lswapi.py

@@ -0,0 +1,7 @@
+import lswapi
+
+
+def test_version():
+    assert lswapi.__version__
+    assert lswapi.__auth_token_url__ == "https://auth.leaseweb.com/token"
+    assert lswapi.__api_base_url__ == "https://api.leaseweb.com"

lswapi-0.5.0/tests/test_requests.py

@@ -0,0 +1,16 @@
+import pytest
+
+from lswapi.requests import get_leaseweb_api
+
+
+def test_get_with_nothing():
+    with pytest.raises(Exception):
+        get_leaseweb_api()
+
+
+def test_get_with_api_key():
+    assert get_leaseweb_api(api_key="xxx")
+
+
+def test_get_with_oauth():
+    assert get_leaseweb_api(client_id="xxx", client_secret="yyy")

lswapi-0.4.2/MANIFEST.in

@@ -1,6 +0,0 @@
-include LICENSE.txt
-include README.md
-include requirements.txt
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
-recursive-exclude tests *

lswapi-0.4.2/PKG-INFO

@@ -1,74 +0,0 @@
-Metadata-Version: 1.1
-Name: lswapi
-Version: 0.4.2
-Summary: a python client library for easy leaseweb api access
-Home-page: http://developer.leaseweb.com
-Author: Nico Di Rocco
-Author-email: n.dirocco@global.leaseweb.com
-License: GPLv3
-Download-URL: https://github.com/nrocco/lswapi/tags
-Description: lswapi (beta)
-        =============
-        
-        [![Actions Status](https://github.com/nrocco/lswapi/workflows/Python%20package/badge.svg)](https://github.com/nrocco/lswapi/actions)
-        
-        Python module to talk to LeaseWeb's API.
-        
-        For more information refer to the documentation available at
-        [http://developer.leaseweb.com]
-        
-        
-        Installation
-        ------------
-        
-        Install the module using pip
-        
-            pip install lswapi
-        
-        
-        Usage
-        -----
-        
-        The `lswapi.get_leaseweb_api` function creates an instance of the LeaseWeb Api
-        object with the `X-Lsw-Auth` key. You can provide the api key as an argument
-        to `get_leaseweb_api`
-        
-            $ python
-            >>> import lswapi
-            >>> client = lswapi.get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
-            >>> response = client.get("/bareMetals/v2/servers")
-            >>> servers = response.json()
-        
-        
-        or as an environment variable `LSW_API_KEY`
-        
-            $ LSW_API_KEY=xxxx-xxxx-xxxxx python
-            >>> import lswapi
-            >>> client = lswapi.get_leaseweb_api()
-            >>> response = client.get("/bareMetals/v2/servers")
-            >>> servers = response.json()
-        
-        
-        Contribute
-        ----------
-        
-        1. Fork it
-        2. Create your feature branch (`git checkout -b my-new-feature`)
-        3. Commit your changes (`git commit -am 'Add some feature'`)
-        4. Make sure that tests pass (`make test`)
-        5. Push to the branch (`git push origin my-new-feature`)
-        6. Create new Pull Request
-        
-Platform: UNKNOWN
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Operating System :: Unix
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities

lswapi-0.4.2/README.md

@@ -1,51 +0,0 @@
-lswapi (beta)
-=============
-
-[![Actions Status](https://github.com/nrocco/lswapi/workflows/Python%20package/badge.svg)](https://github.com/nrocco/lswapi/actions)
-
-Python module to talk to LeaseWeb's API.
-
-For more information refer to the documentation available at
-[http://developer.leaseweb.com]
-
-
-Installation
-------------
-
-Install the module using pip
-
-    pip install lswapi
-
-
-Usage
------
-
-The `lswapi.get_leaseweb_api` function creates an instance of the LeaseWeb Api
-object with the `X-Lsw-Auth` key. You can provide the api key as an argument
-to `get_leaseweb_api`
-
-    $ python
-    >>> import lswapi
-    >>> client = lswapi.get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
-    >>> response = client.get("/bareMetals/v2/servers")
-    >>> servers = response.json()
-
-
-or as an environment variable `LSW_API_KEY`
-
-    $ LSW_API_KEY=xxxx-xxxx-xxxxx python
-    >>> import lswapi
-    >>> client = lswapi.get_leaseweb_api()
-    >>> response = client.get("/bareMetals/v2/servers")
-    >>> servers = response.json()
-
-
-Contribute
-----------
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Make sure that tests pass (`make test`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request

lswapi-0.4.2/lswapi/__init__.py

@@ -1,76 +0,0 @@
-from os import environ, path
-from requests.auth import AuthBase
-from requests import Session
-from requests import post
-from time import time
-
-__version__ = '0.4.2'
-__auth_token_url__ = 'https://auth.leaseweb.com/token'
-__api_base_url__ = 'https://api.leaseweb.com'
-__token_store__ = path.expanduser('~/.lswapi.token')
-
-
-def get_leaseweb_api(api_key=None, client_id=None, client_secret=None, base_url=None, token_url=None):
-    base_url = base_url or environ.get('LSW_BASE_URL', __api_base_url__)
-    token_url = token_url or environ.get('LSW_AUTH_URL', __auth_token_url__)
-
-    api_key = api_key or environ.get('LSW_API_KEY')
-    if api_key:
-        api = LeaseWebSession(base_url=base_url)
-        api.auth = (LeasewebApiKeyAuth(api_key))
-        return api
-
-    client_id = client_id or environ.get('LSW_CLIENT_ID')
-    client_secret = client_secret or environ.get('LSW_CLIENT_SECRET')
-    if client_id and client_secret:
-        return LeaseWebSession(base_url=base_url, client_id=client_id, client_secret=client_secret, token_url=token_url)
-
-    raise Exception("No authentication method specified")
-
-
-def fetch_access_token(token_url, client_id, client_secret):
-    response = post(token_url, auth=(client_id, client_secret), data={'grant_type': 'client_credentials'})
-    if response.status_code != 200:
-        raise Exception('Could not obtain an access token')
-    token = response.json()
-    token['created_at'] = int(time())
-    token['expires_at'] = token['created_at'] + token['expires_in'] - 10
-    return token
-
-
-class LeasewebApiKeyAuth(AuthBase):
-    def __init__(self, lsw_auth_key):
-        self.lsw_auth_key = lsw_auth_key
-
-    def __call__(self, r):
-        r.headers['X-Lsw-Auth'] = self.lsw_auth_key
-        return r
-
-
-class LeaseWebSession(Session):
-    access_token = None
-
-    def __init__(self, client_id=None, client_secret=None, base_url=None, token_url=None):
-        self.base_url = base_url or __api_base_url__
-        self.token_url = token_url or __auth_token_url__
-        self.client_id = client_id
-        self.client_secret = client_secret
-        super(LeaseWebSession, self).__init__()
-
-    def _fetch_access_token(self):
-        return fetch_access_token(self.token_url, self.client_id, self.client_secret)
-
-    def request(self, method, url, data=None, headers={}, **kwargs):
-        if self.client_id and self.client_secret:
-            if not self.access_token:
-                self.access_token = self._fetch_access_token()
-            if int(time()) > self.access_token['expires_at']:
-                self.access_token = self._fetch_access_token()  # TODO: use refresh tokens instead
-            headers['Authorization'] = '{token_type} {access_token}'.format(**self.access_token)
-        if not url.startswith('http'):
-            url = '{}/{}'.format(self.base_url, url.lstrip('/'))
-
-        # if response.status_code == 401 and 'WWW-Authenticate' in response.headers:
-        #     pass # TODO analyse the WWW-Authenticate response header
-
-        return super(LeaseWebSession, self).request(method, url, headers=headers, data=data, **kwargs)

lswapi-0.4.2/lswapi.egg-info/PKG-INFO

@@ -1,74 +0,0 @@
-Metadata-Version: 1.1
-Name: lswapi
-Version: 0.4.2
-Summary: a python client library for easy leaseweb api access
-Home-page: http://developer.leaseweb.com
-Author: Nico Di Rocco
-Author-email: n.dirocco@global.leaseweb.com
-License: GPLv3
-Download-URL: https://github.com/nrocco/lswapi/tags
-Description: lswapi (beta)
-        =============
-        
-        [![Actions Status](https://github.com/nrocco/lswapi/workflows/Python%20package/badge.svg)](https://github.com/nrocco/lswapi/actions)
-        
-        Python module to talk to LeaseWeb's API.
-        
-        For more information refer to the documentation available at
-        [http://developer.leaseweb.com]
-        
-        
-        Installation
-        ------------
-        
-        Install the module using pip
-        
-            pip install lswapi
-        
-        
-        Usage
-        -----
-        
-        The `lswapi.get_leaseweb_api` function creates an instance of the LeaseWeb Api
-        object with the `X-Lsw-Auth` key. You can provide the api key as an argument
-        to `get_leaseweb_api`
-        
-            $ python
-            >>> import lswapi
-            >>> client = lswapi.get_leaseweb_api(api_key="xxxx-xxx-xxxxxx")
-            >>> response = client.get("/bareMetals/v2/servers")
-            >>> servers = response.json()
-        
-        
-        or as an environment variable `LSW_API_KEY`
-        
-            $ LSW_API_KEY=xxxx-xxxx-xxxxx python
-            >>> import lswapi
-            >>> client = lswapi.get_leaseweb_api()
-            >>> response = client.get("/bareMetals/v2/servers")
-            >>> servers = response.json()
-        
-        
-        Contribute
-        ----------
-        
-        1. Fork it
-        2. Create your feature branch (`git checkout -b my-new-feature`)
-        3. Commit your changes (`git commit -am 'Add some feature'`)
-        4. Make sure that tests pass (`make test`)
-        5. Push to the branch (`git push origin my-new-feature`)
-        6. Create new Pull Request
-        
-Platform: UNKNOWN
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Operating System :: Unix
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities

lswapi-0.4.2/lswapi.egg-info/SOURCES.txt

@@ -1,14 +0,0 @@
-LICENSE.txt
-MANIFEST.in
-README.md
-requirements.txt
-setup.cfg
-setup.py
-lswapi/__init__.py
-lswapi.egg-info/PKG-INFO
-lswapi.egg-info/SOURCES.txt
-lswapi.egg-info/dependency_links.txt
-lswapi.egg-info/entry_points.txt
-lswapi.egg-info/requires.txt
-lswapi.egg-info/top_level.txt
-lswapi/httpie/__init__.py

lswapi-0.4.2/lswapi.egg-info/requires.txt

@@ -1 +0,0 @@
-requests

lswapi-0.4.2/requirements.txt

@@ -1 +0,0 @@
-requests

lswapi-0.4.2/setup.cfg

@@ -1,24 +0,0 @@
-[bumpversion]
-current_version = 0.4.2
-commit = True
-tag = True
-
-[wheel]
-universal = 1
-
-[flake8]
-exclude = .git,__pycache__,build,dist,env
-max-complexity = 10
-max-line-length = 1000
-
-[pycodestyle]
-ignore = E501
-
-[bumpversion:file:setup.py]
-
-[bumpversion:file:lswapi/__init__.py]
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

lswapi-0.4.2/setup.py

@@ -1,50 +0,0 @@
-#!/usr/bin/env python
-import io
-import codecs
-
-from setuptools import setup, find_packages
-
-
-def load_requirements(filename):
-    with io.open(filename, encoding='utf-8') as reqfile:
-        return [line.strip() for line in reqfile if not line.startswith('#')]
-
-
-setup(
-    name='lswapi',
-    description='a python client library for easy leaseweb api access',
-    version='0.4.2',
-    author='Nico Di Rocco',
-    author_email='n.dirocco@global.leaseweb.com',
-    url='http://developer.leaseweb.com',
-    license='GPLv3',
-    long_description=codecs.open('README.md', 'rb', 'utf-8').read(),
-    download_url='https://github.com/nrocco/lswapi/tags',
-    include_package_data=True,
-    install_requires=load_requirements('requirements.txt'),
-    tests_require=[
-        'httpie',
-        'coverage',
-    ],
-    entry_points={
-        'httpie.plugins.auth.v1': [
-            'httpie_lswapi = lswapi.httpie:ApiAuthPlugin'
-        ]
-    },
-    packages=find_packages(exclude=['tests']),
-    test_suite='tests',
-    classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
-        'Operating System :: Unix',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Topic :: Software Development :: Libraries :: Python Modules',
-        'Topic :: Utilities'
-    ],
-)