pyixapi 0.2.2__tar.gz → 0.2.4__tar.gz

{pyixapi-0.2.2 → pyixapi-0.2.4}/PKG-INFO

@@ -1,21 +1,23 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pyixapi
-Version: 0.2.2
+Version: 0.2.4
 Summary: Python API client library for IX-API
 License: Apache-2.0
 Author: Guillaume Mazoyer
 Author-email: oss@mazoyer.eu
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-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-Dist: PyJWT (>=2.4.0,<2.9)
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: dev
+Requires-Dist: PyJWT (>=2.4.0,<2.11)
+Requires-Dist: pytest ; extra == "dev"
 Requires-Dist: requests (>=2.20.0,<3.0)
+Requires-Dist: ruff (>=0.9,<0.10) ; extra == "dev"
 Description-Content-Type: text/markdown
 
 # pyixapi

{pyixapi-0.2.2 → pyixapi-0.2.4}/pyixapi/core/api.py

@@ -1,5 +1,3 @@
-from typing import Any
-
 import requests
 
 from pyixapi.core.endpoint import Endpoint
@@ -31,7 +29,7 @@ from pyixapi.models import (
     RoleAssignment,
 )
 
-__version__ = "0.2.2"
+__version__ = "0.2.4"
 
 
 class API(object):
@@ -44,13 +42,14 @@ class API(object):
 
     def __init__(
         self,
-        url: str,
-        key: str,
-        secret: str,
-        access_token: str = "",
-        refresh_token: str = "",
-        user_agent: str = f"pyixapi/{__version__}",
-    ) -> None:
+        url,
+        key,
+        secret,
+        access_token="",
+        refresh_token="",
+        user_agent=f"pyixapi/{__version__}",
+        proxies=None,
+    ):
         self.url = url.rstrip("/")
         self.key = key
         self.secret = secret
@@ -58,6 +57,7 @@ class API(object):
         self.refresh_token = Token.from_jwt(refresh_token) if refresh_token else None
         self.http_session = requests.Session()
         self.user_agent = user_agent
+        self.proxies = proxies
 
         self.auth = Endpoint(self, "auth")
         self.connections = Endpoint(self, "connections", model=Connection)
@@ -67,54 +67,46 @@ class API(object):
         self.facilities = Endpoint(self, "facilities", model=Facility)
         self.ips = Endpoint(self, "ips", model=IP)
         self.macs = Endpoint(self, "macs", model=MAC)
-        self.network_feature_configs = Endpoint(
-            self, "network-feature-configs", model=NetworkFeatureConfig
-        )
+        self.network_feature_configs = Endpoint(self, "network-feature-configs", model=NetworkFeatureConfig)
         self.network_features = Endpoint(self, "network-features", model=NetworkFeature)
-        self.network_service_configs = Endpoint(
-            self, "network-service-configs", model=NetworkServiceConfig
-        )
+        self.network_service_configs = Endpoint(self, "network-service-configs", model=NetworkServiceConfig)
         self.network_services = Endpoint(self, "network-services", model=NetworkService)
         self.pops = Endpoint(self, "pops", model=PoP)
         # Version 2+
-        self.member_joining_rules = Endpoint(
-            self, "member-joining-rules", model=MemberJoiningRule
-        )
+        self.member_joining_rules = Endpoint(self, "member-joining-rules", model=MemberJoiningRule)
         self.metro_areas = Endpoint(self, "metro-areas", model=MetroArea)
-        self.metro_area_networks = Endpoint(
-            self, "metro-area-networks", model=MetroAreaNetwork
-        )
+        self.metro_area_networks = Endpoint(self, "metro-area-networks", model=MetroAreaNetwork)
         self.ports = Endpoint(self, "ports", model=Port)
-        self.port_reservations = Endpoint(
-            self, "port-reservations", model=PortReservation
-        )
+        self.port_reservations = Endpoint(self, "port-reservations", model=PortReservation)
         self.roles = Endpoint(self, "roles", model=Role)
         self.role_assignments = Endpoint(self, "role-assignments", model=RoleAssignment)
 
     @property
-    def version(self) -> int:
+    def version(self):
         """
         Get the API version of IX-API.
         """
         return Request(
-            base=self.url, token=self.access_token, http_session=self.http_session
+            base=self.url,
+            token=self.access_token,
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).get_version()
 
     @property
-    def accounts(self) -> Endpoint:
-        return Endpoint(
-            self, "customers" if self.version == 1 else "accounts", model=Account
-        )
+    def accounts(self):
+        return Endpoint(self, "customers" if self.version == 1 else "accounts", model=Account)
 
     @property
-    def product_offerings(self) -> Endpoint:
+    def product_offerings(self):
         return Endpoint(
             self,
             "products" if self.version == 1 else "product-offerings",
             model=ProductOffering,
         )
 
-    def authenticate(self) -> Record:
+    def authenticate(self):
         """
         Authenticate and generate a pair of tokens.
 
@@ -133,7 +125,10 @@ class API(object):
             return self.refresh_authentication()
 
         r = Request(
-            cat(self.url, "auth", "token"), http_session=self.http_session
+            cat(self.url, "auth", "token"),
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).post(data={"api_key": self.key, "api_secret": self.secret})
 
         self.access_token = Token.from_jwt(r["access_token"])
@@ -141,7 +136,7 @@ class API(object):
 
         return Record(r, self, self.auth)
 
-    def refresh_authentication(self) -> Record:
+    def refresh_authentication(self):
         """
         Prolong authentication by refreshing the tokens pair.
         """
@@ -149,6 +144,8 @@ class API(object):
             cat(self.url, "auth", "refresh"),
             token=self.refresh_token.encoded,
             http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).post(data={"refresh_token": self.refresh_token.encoded})
 
         self.access_token = Token.from_jwt(r["access_token"])
@@ -156,7 +153,7 @@ class API(object):
 
         return Record(r, self, self.auth)
 
-    def health(self) -> dict[str, Any]:
+    def health(self):
         """
         Get the health information from IX-API.
 
@@ -166,5 +163,9 @@ class API(object):
             return {}
 
         return Request(
-            base=self.url, token=self.access_token, http_session=self.http_session
+            base=self.url,
+            token=self.access_token,
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).get_health()

{pyixapi-0.2.2 → pyixapi-0.2.4}/pyixapi/core/endpoint.py

@@ -1,14 +1,9 @@
-from typing import TYPE_CHECKING, Optional
-
 from pyixapi.core.query import Request, RequestError
 from pyixapi.core.response import Record, RecordSet
 from pyixapi.core.util import cat
 
-if TYPE_CHECKING:
-    from .api import API
-
 
-class Endpoint:
+class Endpoint(object):
     """
     Represent actions available on endpoints in the IX-API.
 
@@ -16,16 +11,16 @@ class Endpoint:
     object.
     """
 
-    def __init__(self, api: "API", name: str, model: Optional[Record] = None) -> None:
+    def __init__(self, api, name, model=None):
         self.return_obj = model if model else Record
         self.api = api
         self.url = cat(api.url, name)
         self.name = name
 
-    def __str__(self) -> str:
+    def __str__(self):
         return self.url
 
-    def all(self) -> RecordSet:
+    def all(self):
         """
         Return all objects from an endpoint.
         """
@@ -33,10 +28,12 @@ class Endpoint:
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         return RecordSet(self, r)
 
-    def filter(self, *args, **kwargs) -> RecordSet:
+    def filter(self, *args, **kwargs):
         """
         Query the list of a given endpoint. Also take named arguments that match the
         usable filters on a given endpoint.
@@ -46,10 +43,12 @@ class Endpoint:
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         return RecordSet(self, r)
 
-    def get(self, *args, **kwargs) -> Optional[Record]:
+    def get(self, *args, **kwargs):
         """
         Return a single object from an endpoint.
         """
@@ -79,6 +78,8 @@ class Endpoint:
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         try:
             return next(RecordSet(self, r), None)
@@ -88,7 +89,7 @@ class Endpoint:
             else:
                 raise e
 
-    def create(self, *args, **kwargs) -> Record:
+    def create(self, *args, **kwargs):
         """
         Creates an object on an endpoint.
 
@@ -99,6 +100,8 @@ class Endpoint:
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         ).post(args[0] if args else kwargs)
 
         return self.return_obj(req, self.api, self)

{pyixapi-0.2.2 → pyixapi-0.2.4}/pyixapi/core/query.py

@@ -1,5 +1,4 @@
 import json
-from typing import Any, Optional
 
 from pyixapi.core.util import cat
 
@@ -15,26 +14,20 @@ class RequestError(Exception):
         if r.status_code == 404:
             self.message = f"The requested url: {r.url} could not be found."
         elif r.status_code == 401:
-            self.message = (
-                "Authentication credentials are invalid, tokens renewal required."
-            )
+            self.message = "Authentication credentials are invalid, tokens renewal required."
         else:
             try:
-                self.message = (
-                    f"The request failed with code {r.status_code} "
-                    f"{r.reason}: {r.json()}"
-                )
+                self.message = f"The request failed with code {r.status_code} {r.reason}: {r.json()}"
             except ValueError:
                 self.message = (
-                    f"The request failed with code {r.status_code} "
-                    f"{r.reason} but details were not found as JSON."
+                    f"The request failed with code {r.status_code} {r.reason} but details were not found as JSON."
                 )
 
         super(RequestError, self).__init__(r)
         self.req = r
         self.error = r.text
 
-    def __str__(self) -> str:
+    def __str__(self):
         return self.message
 
 
@@ -45,19 +38,17 @@ class ContentError(Exception):
     those cases.
     """
 
-    def __init__(self, req) -> None:
+    def __init__(self, req):
         super(ContentError, self).__init__(req)
 
         self.req = req
-        self.error = (
-            "The server returned invalid (non-JSON) data. Maybe not an IX-API server?"
-        )
+        self.error = "The server returned invalid (non-JSON) data. Maybe not an IX-API server?"
 
-    def __str__(self) -> str:
+    def __str__(self):
         return self.error
 
 
-class Request:
+class Request(object):
     """
     Create requests to the IX-API.
 
@@ -71,7 +62,14 @@ class Request:
     """
 
     def __init__(
-        self, base, http_session, filters=None, key=None, token=None, user_agent=None
+        self,
+        base,
+        http_session,
+        filters=None,
+        key=None,
+        token=None,
+        user_agent=None,
+        proxies=None,
     ):
         self.base = base
         self.filters = filters or None
@@ -80,21 +78,20 @@ class Request:
         self.http_session = http_session
         self.url = self.base if not key else cat(self.base, key)
         self.user_agent = user_agent
+        self.proxies = proxies
 
-    def get_openapi(self) -> Any:
+    def get_openapi(self):
         """
         Get the OpenAPI Spec.
         """
         headers = {"Content-Type": "application/json;"}
-        req = self.http_session.get(
-            cat(self.base, "docs/?format=openapi"), headers=headers
-        )
+        req = self.http_session.get(cat(self.base, "docs/?format=openapi"), headers=headers)
         if req.ok:
             return req.json()
         else:
             raise RequestError(req)
 
-    def get_version(self) -> int:
+    def get_version(self):
         """
         Get the API version of IX-API.
 
@@ -108,7 +105,7 @@ class Request:
         except RequestError:
             return 1
 
-    def get_health(self) -> dict[str, Any]:
+    def get_health(self):
         """
         Get the health from /api/health endpoint in IX-API.
         """
@@ -121,13 +118,7 @@ class Request:
         else:
             raise RequestError(r)
 
-    def _make_call(
-        self,
-        verb: str = "get",
-        url_override: Optional[str] = None,
-        add_params: Optional[dict[str, Any]] = None,
-        data: Optional[Any] = None,
-    ) -> Any:
+    def _make_call(self, verb="get", url_override=None, add_params=None, data=None):
         if verb in ("post", "put") or verb == "delete" and data:
             headers = {"Content-Type": "application/json;"}
         else:
@@ -144,7 +135,12 @@ class Request:
                 params.update(add_params)
 
         r = getattr(self.http_session, verb)(
-            url_override or self.url, headers=headers, params=params, json=data
+            url_override or self.url,
+            headers=headers,
+            params=params,
+            json=data,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         )
 
         if verb == "delete":
@@ -160,7 +156,7 @@ class Request:
         else:
             raise RequestError(r)
 
-    def get(self, add_params: Optional[dict[str, Any]] = None) -> Any:
+    def get(self, add_params=None):
         """
         Make a GET request to IX-API.
 
@@ -179,7 +175,7 @@ class Request:
             self.count = len(req)
             yield req
 
-    def put(self, data: Any) -> Any:
+    def put(self, data):
         """
         Make a PUT request to IX-API.
 
@@ -191,7 +187,7 @@ class Request:
         """
         return self._make_call(verb="put", data=data)
 
-    def post(self, data: Any) -> Any:
+    def post(self, data):
         """
         Make a POST request to IX-API.
 
@@ -203,7 +199,7 @@ class Request:
         """
         return self._make_call(verb="post", data=data)
 
-    def delete(self, data: Optional[Any] = None) -> Any:
+    def delete(self, data=None):
         """
         Make a DELETE request to IX-API.
 
@@ -217,7 +213,7 @@ class Request:
         """
         return self._make_call(verb="delete", data=data)
 
-    def patch(self, data: Any) -> Any:
+    def patch(self, data):
         """
         Make a PATCH request to IX-API.
 
@@ -229,7 +225,7 @@ class Request:
         """
         return self._make_call(verb="patch", data=data)
 
-    def options(self) -> Any:
+    def options(self):
         """
         Make an OPTIONS request to IX-API.
 

{pyixapi-0.2.2 → pyixapi-0.2.4}/pyixapi/core/response.py

@@ -2,7 +2,7 @@ from pyixapi.core.query import Request
 from pyixapi.core.util import Hashabledict
 
 
-def get_return(lookup) -> int:
+def get_return(lookup):
     """
     Return simple representations for items passed to lookup.
 
@@ -15,7 +15,7 @@ def get_return(lookup) -> int:
         return lookup
 
 
-class RecordSet:
+class RecordSet(object):
     """
     Iterator containing :py:class:`.Record` objects.
 
@@ -52,23 +52,19 @@ class RecordSet:
     >>>
     """
 
-    def __init__(self, endpoint, request, **kwargs) -> None:
+    def __init__(self, endpoint, request, **kwargs):
         self.endpoint = endpoint
         self.request = request
         self.response = self.request.get()
         self._response_cache = []
 
-    def __iter__(self) -> "RecordSet":
+    def __iter__(self):
         return self
 
     def __next__(self):
         if self._response_cache:
-            return self.endpoint.return_obj(
-                self._response_cache.pop(), self.endpoint.api, self.endpoint
-            )
-        return self.endpoint.return_obj(
-            next(self.response), self.endpoint.api, self.endpoint
-        )
+            return self.endpoint.return_obj(self._response_cache.pop(), self.endpoint.api, self.endpoint)
+        return self.endpoint.return_obj(next(self.response), self.endpoint.api, self.endpoint)
 
     def __len__(self):
         try:
@@ -81,7 +77,7 @@ class RecordSet:
             return self.request.count
 
 
-class Record:
+class Record(object):
     """
     Create Python objects from IX-API responses.
 
@@ -144,7 +140,7 @@ class Record:
 
     url = None
 
-    def __init__(self, values, api, endpoint) -> None:
+    def __init__(self, values, api, endpoint):
         self._full_cache = []
         self._init_cache = []
         self.api = api
@@ -250,9 +246,7 @@ class Record:
             if isinstance(current_val, Record):
                 current_val = getattr(current_val, "serialize")(nested=True)
             if isinstance(current_val, list):
-                current_val = [
-                    v.id if isinstance(v, Record) else v for v in current_val
-                ]
+                current_val = [v.id if isinstance(v, Record) else v for v in current_val]
             r[i] = current_val
         return r
 
@@ -265,9 +259,7 @@ class Record:
             return k, v
 
         current = Hashabledict({fmt_dict(k, v) for k, v in self.serialize().items()})
-        init = Hashabledict(
-            {fmt_dict(k, v) for k, v in self.serialize(init=True).items()}
-        )
+        init = Hashabledict({fmt_dict(k, v) for k, v in self.serialize(init=True).items()})
         return set([i[0] for i in set(current.items()) ^ set(init.items())])
 
     def updates(self):
@@ -298,6 +290,8 @@ class Record:
                 base=self.endpoint.url,
                 token=self.api.access_token,
                 http_session=self.api.http_session,
+                user_agent=self.user_agent,
+                proxies=self.api.proxies,
             )
             if r.patch(updates):
                 return True
@@ -324,5 +318,7 @@ class Record:
             base=self.endpoint.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         return True if r.delete() else False

{pyixapi-0.2.2 → pyixapi-0.2.4}/pyixapi/core/util.py

@@ -1,9 +1,12 @@
+from typing import Any
+
+
 class Hashabledict(dict):
     def __hash__(self):
         return hash(frozenset(self))
 
 
-def cat(*args, separator: str = "/", trailing: str = "") -> str:
+def cat(*args: Any, separator: str = "/", trailing: str = "") -> str:
     """
     Concatenate strings given a separator. All items will be parsed as string.
 

{pyixapi-0.2.2 → pyixapi-0.2.4}/pyproject.toml

@@ -1,47 +1,34 @@
-[tool.poetry]
+[project]
 name = "pyixapi"
-version = "0.2.2"
+version = "0.2.4"
 description = "Python API client library for IX-API"
-authors = ["Guillaume Mazoyer <oss@mazoyer.eu>"]
+authors = [{ name = "Guillaume Mazoyer", email = "oss@mazoyer.eu" }]
 readme = "README.md"
 license = "Apache-2.0"
-packages = [{ include = "pyixapi" }]
+requires-python = ">=3.9"
 classifiers = [
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
-    "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",
+    "Programming Language :: Python :: 3.13",
 ]
+dependencies = ["PyJWT>=2.4.0,<2.11", "requests>=2.20.0,<3.0"]
 
-[tool.poetry.dependencies]
-python = "^3.8"
-PyJWT = ">=2.4.0,<2.9"
-requests = ">=2.20.0,<3.0"
+[project.optional-dependencies]
+dev = ["pytest", "ruff>=0.9,<0.10"]
 
-[tool.poetry.group.dev.dependencies]
-pytest = "*"
-ruff = "~0.2"
+[tool.poetry]
+requires-poetry = ">=2.0"
+packages = [{ include = "pyixapi" }]
 
 [tool.ruff]
-line-length = 88
-
-exclude = [
-    ".git",
-    ".tox",
-    ".venv",
-    "env",
-    "_build",
-    "build",
-    "dist",
-    "examples",
-    "__main__.py",
-]
+line-length = 120
+exclude = [".git", ".tox", ".venv", "env", "_build", "build", "dist", "examples", "__main__.py"]
 
 [tool.ruff.lint]
-preview = true
-
 select = [
     "C90", # mccabe complexity
     "E",   # pycodestyle errors
@@ -67,12 +54,9 @@ line-ending = "auto"
 [tool.ruff.lint.isort]
 known-first-party = ["pyixapi"]
 
-[tool.ruff.lint.pycodestyle]
-max-line-length = 88
-
 [tool.ruff.lint.mccabe]
 max-complexity = 31
 
 [build-system]
-requires = ["poetry-core"]
+requires = ["poetry-core>=2.0"]
 build-backend = "poetry.core.masonry.api"

pyixapi-0.2.2/pyixapi/__main__.py

@@ -1,69 +0,0 @@
-from pyixapi import api
-
-
-def create_mac_address(ixapi, mac_address):
-    """
-    Create a new MAC address in IX-API. If the MAC already exists, return it
-    without creation.
-    """
-    # Make sure to have a consistent case
-    mac_address = str(mac_address).lower()
-
-    # Return existing object if MAC already exists
-    for mac in ixapi.macs.all():
-        if mac["address"] == mac_address:
-            return mac
-
-    return ixapi.macs.create(
-        address=mac_address, consuming_customer="2", managing_customer="2"
-    )
-
-
-# ixapi = api(
-#    "https://api.de-cix.net/api/v1/",
-#    "-GnNlMD8hBuxSSUJmpbfUkss9dyOKfTV1SnZibNyyr4",
-#    "XKq8M6NVh5lCbPJ2Ml1h7V93QNIMsGVBfM6g2nRZF-E",
-# )
-
-ixapi = api(
-    "https://api.de-cix.net/api/v2/",
-    "lZJ_sV59gydj12RFATG4NaQFRI15iKRi9RC0oDqn2_A",
-    "Yt_RImR_ymuhx2r9YQXerh5q9EyE6TxaREjzmEQNr1o",
-)
-
-# ixapi = api(
-#    "http://localhost:8000/api/v1/",
-#    "c25f077c899694fc",
-#    "zZm-hzDIR5BZUhn5ULo4-_BQyx39ayRRn_0HFaSNDShqunrTiNY4a6n0Bnjqg62F-NsywRLvn3Dt3pRXWRgS1A",
-# )
-
-authentication = ixapi.authenticate()
-print(authentication)
-
-print(f"IX-API is at version {ixapi.version}")
-
-authentication = ixapi.authenticate()
-print(authentication)
-
-print([i for i in ixapi.accounts.all()])
-
-# for i in ixapi.ips.all():
-#    print(f"{i.ip} - {i.network}")
-# print(ixapi.network_service_configs.get("DXDB:PAS:509177"))
-
-# for i in ixapi.ports.all():
-#    print(i)
-
-# print(len(ixapi.network_services.filter(consuming_customer="DXDB:CUST:1348")))
-# print(len(ixapi.network_services.all()))
-
-# mac = create_mac_address(ixapi, "e4:f7:ad:58:87:ff")
-
-# for i in ixapi.macs.all():
-#    print(dict(i))
-
-# for i in ixapi.network_service_configs.all():
-#    # i.macs = [mac]
-#    # print(i.save())
-#    i.update({"macs": [mac]})
-#    print(dict(i))