lswapi 0.5.2__tar.gz → 0.5.4__tar.gz

lswapi-0.5.4/.gitignore

@@ -0,0 +1,10 @@
+*.egg-info
+*.pyc
+.eggs
+/.coverage
+/.version
+/coverage.xml
+/dist
+/env
+/htmlcov
+__pycache__

{lswapi-0.5.2 → lswapi-0.5.4}/PKG-INFO

@@ -1,24 +1,13 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.5
 Name: lswapi
-Version: 0.5.2
+Version: 0.5.4
 Summary: a python client library for easy leaseweb api access
-License: Apache-2.0
-Author: Nico Di Rocco
-Author-email: n.dirocco@global.leaseweb.com
-Requires-Python: >= 3.9
-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
 Project-URL: Homepage, http://developer.leaseweb.com
 Project-URL: Issues, https://github.com/nrocco/lswapi
+Author-email: Nico Di Rocco <n.dirocco@global.leaseweb.com>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 
 # lswapi (beta)
@@ -90,8 +79,7 @@ to `get_leaseweb_api` or via the environment variable `LSW_API_KEY`:
     >>> servers = await response.json()
 
 
-Contribute
-----------
+## Contribute
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -99,4 +87,3 @@ Contribute
 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.2 → lswapi-0.5.4}/README.md

@@ -67,8 +67,7 @@ to `get_leaseweb_api` or via the environment variable `LSW_API_KEY`:
     >>> servers = await response.json()
 
 
-Contribute
-----------
+## Contribute
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

lswapi-0.5.4/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "lswapi"
+dynamic = ["version"]
+description = "a python client library for easy leaseweb api access"
+authors = [
+    { name="Nico Di Rocco", email="n.dirocco@global.leaseweb.com" },
+]
+license = "Apache-2.0"
+readme = "README.md"
+requires-python = ">= 3.9"
+dependencies = []
+
+[project.urls]
+Homepage = "http://developer.leaseweb.com"
+Issues = "https://github.com/nrocco/lswapi"
+
+[dependency-groups]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "requests-mock",
+    "ruff",
+]
+httpie = [
+    "httpie",
+]
+requests = [
+    "requests",
+]
+aio = [
+    "aiodns",
+    "aiohttp",
+]
+
+[project.entry-points."httpie.plugins.auth.v1"]
+httpie_lswapi = "lswapi.httpie:ApiAuthPlugin"
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/",
+    "pyproject.toml",
+    "README.md",
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 999
+
+[tool.ruff.lint]
+ignore = ["E501"]  # E501 is the line-too-long rule

{lswapi-0.5.2 → lswapi-0.5.4}/src/lswapi/aio/__init__.py

@@ -1,10 +1,9 @@
-from lswapi import __api_base_url__
-from lswapi import __auth_token_url__
+from os import environ
+
+from lswapi import __api_base_url__, __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
+from lswapi.aio.oauth import AccessTokenFileStore, LeasewebOAuthMiddleware
 
 
 def get_leaseweb_api(api_key=None, client_id=None, client_secret=None, base_url=None, token_url=None, token_store=None):
@@ -15,13 +14,16 @@ def get_leaseweb_api(api_key=None, client_id=None, client_secret=None, base_url=
     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),
-    ])
+        raise RuntimeError("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.2 → lswapi-0.5.4}/src/lswapi/aio/client.py

@@ -1,8 +1,12 @@
+from __future__ import annotations
+
 from aiohttp import ClientSession
 
 
 class LeasewebHttpClient:
-    def __init__(self, *args, middlewares: list[callable] = [], **kwargs):
+    def __init__(self, *args, middlewares: list[callable] | None = None, **kwargs):
+        if middlewares is None:
+            middlewares = []
         self.middlewares = middlewares
         self.__create_session = lambda: ClientSession(*args, **kwargs)
         self.session = None
@@ -10,10 +14,9 @@ class LeasewebHttpClient:
     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 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):

{lswapi-0.5.2 → lswapi-0.5.4}/src/lswapi/aio/oauth.py

@@ -1,9 +1,10 @@
-import aiohttp
 import asyncio
 import json
 import os
 import time
 
+import aiohttp
+
 from lswapi.aio.client import LeasewebHttpClient
 from lswapi.aio.middleware import LoggingMiddleware
 

lswapi-0.5.4/src/lswapi/httpie.py

@@ -0,0 +1,55 @@
+"""
+LswApi auth plugin for HTTPie.
+"""
+
+from hashlib import md5
+from json import dumps, loads
+from pathlib import Path
+from time import time
+
+from httpie.cli.definition import parser as httpie_args_parser
+from httpie.plugins import AuthPlugin
+
+from lswapi import __auth_token_url__
+from lswapi.requests.oauth import fetch_access_token
+
+
+class LswApiAuth:
+    def __init__(self, client_id, client_secret):
+        if not client_id:
+            raise ValueError("client_id is required")
+        self.client_id = client_id
+        if not client_secret:
+            raise ValueError("client_secret is required")
+        self.client_secret = client_secret
+        options = httpie_args_parser.args
+        self.token_url = options.auth_token_url or __auth_token_url__
+        hash = md5(self.token_url.encode("utf-8")).hexdigest()
+        self.token_store = Path.home() / ".cache" / "httpie" / f"{hash}.json"
+
+    def __call__(self, r):
+        if self.token_store.exists():
+            token = loads(self.token_store.read_text())
+            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(self.token_url, self.client_id, self.client_secret)
+        self.token_store.parent.mkdir(parents=True, exist_ok=True)
+        self.token_store.write_text(dumps(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"
+
+    params = httpie_args_parser.add_argument_group(title="LswApi Oauth OAuth2.0 options")
+
+    params.add_argument("--auth-token-url", default=None, metavar="LSW_AUTH_URL", help="OAuth 2.0 Token endpoint URI")
+
+    def get_auth(self, username, password):
+        return LswApiAuth(username, password)

{lswapi-0.5.2 → lswapi-0.5.4}/src/lswapi/requests/__init__.py

@@ -1,9 +1,8 @@
-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
 
+from lswapi import __api_base_url__, __auth_token_url__
+from lswapi.requests.session import LeasewebApiKeyAuth, LeasewebSession
+
 
 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__)
@@ -12,10 +11,10 @@ def get_leaseweb_api(api_key=None, client_id=None, client_secret=None, base_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))
+        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")
+    raise RuntimeError("No authentication method specified")

{lswapi-0.5.2 → lswapi-0.5.4}/src/lswapi/requests/oauth.py

@@ -1,11 +1,12 @@
-from requests import post
 from time import time
 
+from requests import post
+
 
 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")
+        raise RuntimeError("Could not obtain an access token")
     token = response.json()
     token["created_at"] = int(time())
     token["expires_at"] = token["created_at"] + token["expires_in"] - 10

{lswapi-0.5.2 → lswapi-0.5.4}/src/lswapi/requests/session.py

@@ -1,11 +1,12 @@
-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 json import dump, load
 from os import path
+from time import time
+
 from requests import Session
 from requests.auth import AuthBase
-from time import time
+
+from lswapi import __api_base_url__, __auth_token_url__
+from lswapi.requests.oauth import fetch_access_token
 
 
 class LeasewebApiKeyAuth(AuthBase):
@@ -29,10 +30,9 @@ class LeasewebSession(Session):
         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 not self.access_token and self.token_store and 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)
@@ -41,7 +41,9 @@ class LeasewebSession(Session):
                 dump(self.access_token, file)
         return self.access_token
 
-    def request(self, method, url, data=None, headers={}, **kwargs):
+    def request(self, method, url, data=None, headers=None, **kwargs):
+        if headers is None:
+            headers = {}
         if self.client_id and self.client_secret:
             headers["Authorization"] = "{token_type} {access_token}".format(**self._fetch_access_token())
         if not url.startswith("http"):

lswapi-0.5.2/pyproject.toml

@@ -1,63 +0,0 @@
-[project]
-name = "lswapi"
-version = "0.5.2"
-description = "a python client library for easy leaseweb api access"
-authors = [
-    {name = "Nico Di Rocco",email = "n.dirocco@global.leaseweb.com"}
-]
-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"
-]
-license = "Apache-2.0"
-readme = "README.md"
-requires-python = ">= 3.9"
-dependencies = [
-]
-
-[project.urls]
-Homepage = "http://developer.leaseweb.com"
-Issues = "https://github.com/nrocco/lswapi"
-
-
-[project.entry-points."httpie.plugins.auth.v1"]
-httpie_lswapi = "lswapi.httpie:ApiAuthPlugin"
-
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-
-[tool.poetry.group.dev.dependencies]
-flake8 = "^7.3.0"
-pytest = "^8.4.1"
-pytest-cov = "^6.2.1"
-requests-mock = "^1.12.1"
-
-
-[tool.poetry.group.httpie.dependencies]
-httpie = "^3.2.4"
-
-
-[tool.poetry.group.requests.dependencies]
-requests = "^2.32.4"
-
-
-[tool.poetry.group.aio.dependencies]
-aiodns = "^3.5.0"
-aiohttp = "^3.12.15"
-
-
-[tool.pytest.ini_options]
-testpaths = ["tests"]
-

lswapi-0.5.2/src/lswapi/httpie.py

@@ -1,43 +0,0 @@
-"""
-LswApi auth plugin for HTTPie.
-"""
-from httpie.plugins import AuthPlugin
-from json import loads, dumps
-from lswapi import __auth_token_url__
-from lswapi.requests import fetch_access_token
-from os import path
-from time import time
-
-
-__token_store__ = path.expanduser("~/.lswapi.token")
-
-
-class LswApiAuth(object):
-    def __init__(self, client_id, client_secret):
-        self.client_id = client_id
-        self.client_secret = client_secret
-
-    def __call__(self, r):
-        if path.exists(__token_store__):
-            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)
-                return r
-
-        token = fetch_access_token(__auth_token_url__, self.client_id, self.client_secret)
-
-        with open(__token_store__, "w") as file:
-            file.write(dumps(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"
-
-    def get_auth(self, username, password):
-        return LswApiAuth(username, password)

{lswapi-0.5.2 → lswapi-0.5.4}/src/lswapi/aio/middleware.py

@@ -1,5 +1,5 @@
-import time
 import logging
+import time
 
 
 class LoggingMiddleware: