pyixapi 0.2.0__tar.gz → 0.2.2__tar.gz

{pyixapi-0.2.0/pyixapi.egg-info → pyixapi-0.2.2}/PKG-INFO

@@ -1,21 +1,22 @@
 Metadata-Version: 2.1
 Name: pyixapi
-Version: 0.2.0
-Summary: IX-API client library
-Home-page: https://github.com/peering-manager/pyixapi
+Version: 0.2.2
+Summary: Python API client library for IX-API
+License: Apache-2.0
 Author: Guillaume Mazoyer
 Author-email: oss@mazoyer.eu
-License: Apache2
-Keywords: ix-api,internet-exchange,peering
+Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
-Classifier: Development Status :: 5 - Production/Stable
+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)
+Requires-Dist: requests (>=2.20.0,<3.0)
 Description-Content-Type: text/markdown
-License-File: LICENSE
 
 # pyixapi
 
@@ -30,8 +31,6 @@ Supported versions are:
 
 To install run `pip install pyixapi`.
 
-Alternatively, you can clone the repo and run `python setup.py install`.
-
 ## Quick Start
 
 To begin, import pyixapi and instantiate the API.
@@ -77,3 +76,4 @@ DXDB:PAS:00008
 ```
 
 Write queries are not implemented yet.
+

{pyixapi-0.2.0 → pyixapi-0.2.2}/README.md

@@ -11,8 +11,6 @@ Supported versions are:
 
 To install run `pip install pyixapi`.
 
-Alternatively, you can clone the repo and run `python setup.py install`.
-
 ## Quick Start
 
 To begin, import pyixapi and instantiate the API.

pyixapi-0.2.2/pyixapi/__init__.py

@@ -0,0 +1,5 @@
+from .core.api import API as api
+from .core.api import __version__  # noqa: F401
+from .core.query import ContentError, RequestError
+
+__all__ = ("api", "ContentError", "RequestError")

pyixapi-0.2.2/pyixapi/__main__.py

@@ -0,0 +1,69 @@
+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))

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

@@ -1,3 +1,5 @@
+from typing import Any
+
 import requests
 
 from pyixapi.core.endpoint import Endpoint
@@ -24,13 +26,12 @@ from pyixapi.models import (
     PoP,
     Port,
     PortReservation,
-    Product,
     ProductOffering,
     Role,
     RoleAssignment,
 )
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 
 class API(object):
@@ -43,13 +44,13 @@ class API(object):
 
     def __init__(
         self,
-        url,
-        key,
-        secret,
-        access_token="",
-        refresh_token="",
-        user_agent=f"pyixapi/{__version__}",
-    ):
+        url: str,
+        key: str,
+        secret: str,
+        access_token: str = "",
+        refresh_token: str = "",
+        user_agent: str = f"pyixapi/{__version__}",
+    ) -> None:
         self.url = url.rstrip("/")
         self.key = key
         self.secret = secret
@@ -75,7 +76,6 @@ class API(object):
         )
         self.network_services = Endpoint(self, "network-services", model=NetworkService)
         self.pops = Endpoint(self, "pops", model=PoP)
-        self.products = Endpoint(self, "products", model=Product)
         # Version 2+
         self.member_joining_rules = Endpoint(
             self, "member-joining-rules", model=MemberJoiningRule
@@ -88,14 +88,11 @@ class API(object):
         self.port_reservations = Endpoint(
             self, "port-reservations", model=PortReservation
         )
-        self.product_offerings = Endpoint(
-            self, "product-offerings", model=ProductOffering
-        )
         self.roles = Endpoint(self, "roles", model=Role)
         self.role_assignments = Endpoint(self, "role-assignments", model=RoleAssignment)
 
     @property
-    def version(self):
+    def version(self) -> int:
         """
         Get the API version of IX-API.
         """
@@ -104,12 +101,20 @@ class API(object):
         ).get_version()
 
     @property
-    def accounts(self):
+    def accounts(self) -> Endpoint:
         return Endpoint(
             self, "customers" if self.version == 1 else "accounts", model=Account
         )
 
-    def authenticate(self):
+    @property
+    def product_offerings(self) -> Endpoint:
+        return Endpoint(
+            self,
+            "products" if self.version == 1 else "product-offerings",
+            model=ProductOffering,
+        )
+
+    def authenticate(self) -> Record:
         """
         Authenticate and generate a pair of tokens.
 
@@ -136,7 +141,7 @@ class API(object):
 
         return Record(r, self, self.auth)
 
-    def refresh_authentication(self):
+    def refresh_authentication(self) -> Record:
         """
         Prolong authentication by refreshing the tokens pair.
         """
@@ -151,7 +156,7 @@ class API(object):
 
         return Record(r, self, self.auth)
 
-    def health(self):
+    def health(self) -> dict[str, Any]:
         """
         Get the health information from IX-API.
 

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

@@ -1,9 +1,14 @@
+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(object):
+class Endpoint:
     """
     Represent actions available on endpoints in the IX-API.
 
@@ -11,16 +16,16 @@ class Endpoint(object):
     object.
     """
 
-    def __init__(self, api, name, model=None):
+    def __init__(self, api: "API", name: str, model: Optional[Record] = None) -> None:
         self.return_obj = model if model else Record
         self.api = api
         self.url = cat(api.url, name)
         self.name = name
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.url
 
-    def all(self):
+    def all(self) -> RecordSet:
         """
         Return all objects from an endpoint.
         """
@@ -31,7 +36,7 @@ class Endpoint(object):
         )
         return RecordSet(self, r)
 
-    def filter(self, *args, **kwargs):
+    def filter(self, *args, **kwargs) -> RecordSet:
         """
         Query the list of a given endpoint. Also take named arguments that match the
         usable filters on a given endpoint.
@@ -44,7 +49,7 @@ class Endpoint(object):
         )
         return RecordSet(self, r)
 
-    def get(self, *args, **kwargs):
+    def get(self, *args, **kwargs) -> Optional[Record]:
         """
         Return a single object from an endpoint.
         """
@@ -62,7 +67,9 @@ class Endpoint(object):
             try:
                 next(response)
                 raise ValueError(
-                    "get() returned more than one result. Check that the kwarg(s) passed are valid for this endpoint or use filter() or all() instead."
+                    "get() returned more than one result. Check that the kwarg(s) "
+                    "passed are valid for this endpoint or use filter() or all() "
+                    "instead."
                 )
             except StopIteration:
                 return value
@@ -81,7 +88,7 @@ class Endpoint(object):
             else:
                 raise e
 
-    def create(self, *args, **kwargs):
+    def create(self, *args, **kwargs) -> Record:
         """
         Creates an object on an endpoint.
 

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

@@ -1,4 +1,5 @@
 import json
+from typing import Any, Optional
 
 from pyixapi.core.util import cat
 
@@ -19,15 +20,21 @@ class RequestError(Exception):
             )
         else:
             try:
-                self.message = f"The request failed with code {r.status_code} {r.reason}: {r.json()}"
+                self.message = (
+                    f"The request failed with code {r.status_code} "
+                    f"{r.reason}: {r.json()}"
+                )
             except ValueError:
-                self.message = f"The request failed with code {r.status_code} {r.reason} but details were not found as JSON."
+                self.message = (
+                    f"The request failed with code {r.status_code} "
+                    f"{r.reason} but details were not found as JSON."
+                )
 
         super(RequestError, self).__init__(r)
         self.req = r
         self.error = r.text
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.message
 
 
@@ -38,7 +45,7 @@ class ContentError(Exception):
     those cases.
     """
 
-    def __init__(self, req):
+    def __init__(self, req) -> None:
         super(ContentError, self).__init__(req)
 
         self.req = req
@@ -46,11 +53,11 @@ class ContentError(Exception):
             "The server returned invalid (non-JSON) data. Maybe not an IX-API server?"
         )
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.error
 
 
-class Request(object):
+class Request:
     """
     Create requests to the IX-API.
 
@@ -74,7 +81,7 @@ class Request(object):
         self.url = self.base if not key else cat(self.base, key)
         self.user_agent = user_agent
 
-    def get_openapi(self):
+    def get_openapi(self) -> Any:
         """
         Get the OpenAPI Spec.
         """
@@ -87,7 +94,7 @@ class Request(object):
         else:
             raise RequestError(req)
 
-    def get_version(self):
+    def get_version(self) -> int:
         """
         Get the API version of IX-API.
 
@@ -101,7 +108,7 @@ class Request(object):
         except RequestError:
             return 1
 
-    def get_health(self):
+    def get_health(self) -> dict[str, Any]:
         """
         Get the health from /api/health endpoint in IX-API.
         """
@@ -114,7 +121,13 @@ class Request(object):
         else:
             raise RequestError(r)
 
-    def _make_call(self, verb="get", url_override=None, add_params=None, data=None):
+    def _make_call(
+        self,
+        verb: str = "get",
+        url_override: Optional[str] = None,
+        add_params: Optional[dict[str, Any]] = None,
+        data: Optional[Any] = None,
+    ) -> Any:
         if verb in ("post", "put") or verb == "delete" and data:
             headers = {"Content-Type": "application/json;"}
         else:
@@ -147,7 +160,7 @@ class Request(object):
         else:
             raise RequestError(r)
 
-    def get(self, add_params=None):
+    def get(self, add_params: Optional[dict[str, Any]] = None) -> Any:
         """
         Make a GET request to IX-API.
 
@@ -166,7 +179,7 @@ class Request(object):
             self.count = len(req)
             yield req
 
-    def put(self, data):
+    def put(self, data: Any) -> Any:
         """
         Make a PUT request to IX-API.
 
@@ -178,7 +191,7 @@ class Request(object):
         """
         return self._make_call(verb="put", data=data)
 
-    def post(self, data):
+    def post(self, data: Any) -> Any:
         """
         Make a POST request to IX-API.
 
@@ -190,7 +203,7 @@ class Request(object):
         """
         return self._make_call(verb="post", data=data)
 
-    def delete(self, data=None):
+    def delete(self, data: Optional[Any] = None) -> Any:
         """
         Make a DELETE request to IX-API.
 
@@ -204,7 +217,7 @@ class Request(object):
         """
         return self._make_call(verb="delete", data=data)
 
-    def patch(self, data):
+    def patch(self, data: Any) -> Any:
         """
         Make a PATCH request to IX-API.
 
@@ -216,7 +229,7 @@ class Request(object):
         """
         return self._make_call(verb="patch", data=data)
 
-    def options(self):
+    def options(self) -> Any:
         """
         Make an OPTIONS request to IX-API.
 

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

@@ -2,7 +2,7 @@ from pyixapi.core.query import Request
 from pyixapi.core.util import Hashabledict
 
 
-def get_return(lookup):
+def get_return(lookup) -> int:
     """
     Return simple representations for items passed to lookup.
 
@@ -15,7 +15,7 @@ def get_return(lookup):
         return lookup
 
 
-class RecordSet(object):
+class RecordSet:
     """
     Iterator containing :py:class:`.Record` objects.
 
@@ -52,13 +52,13 @@ class RecordSet(object):
     >>>
     """
 
-    def __init__(self, endpoint, request, **kwargs):
+    def __init__(self, endpoint, request, **kwargs) -> None:
         self.endpoint = endpoint
         self.request = request
         self.response = self.request.get()
         self._response_cache = []
 
-    def __iter__(self):
+    def __iter__(self) -> "RecordSet":
         return self
 
     def __next__(self):
@@ -81,7 +81,7 @@ class RecordSet(object):
             return self.request.count
 
 
-class Record(object):
+class Record:
     """
     Create Python objects from IX-API responses.
 
@@ -144,7 +144,7 @@ class Record(object):
 
     url = None
 
-    def __init__(self, values, api, endpoint):
+    def __init__(self, values, api, endpoint) -> None:
         self._full_cache = []
         self._init_cache = []
         self.api = api

{pyixapi-0.2.0 → pyixapi-0.2.2}/pyixapi/core/token.py

@@ -1,4 +1,5 @@
-from datetime import datetime
+import warnings
+from datetime import datetime, timezone
 
 import jwt
 
@@ -11,7 +12,7 @@ class InvalidTokenException(Exception):
     pass
 
 
-class Token(object):
+class Token:
     """
     A token is at the core of the authentication mechanism of IX-API.
 
@@ -24,37 +25,43 @@ class Token(object):
     continue using the API.
     """
 
-    def __init__(self, token, issued_at, expires_at):
-        self.encoded = token  # Cache signed token data
-        self.issued_at = issued_at
-        self.expires_at = expires_at
+    def __init__(self, token: str, expires_at: datetime) -> None:
+        self.encoded: str = token  # Cache signed token data
+        self.expires_at: datetime = expires_at
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.encoded
 
-    def __repr__(self):
-        return f"<Token issued_at={self.issued_at} ttl={self.ttl}s>"
+    def __repr__(self) -> str:
+        return f"<Token ttl={self.ttl}s>"
 
     @property
-    def ttl(self):
+    def issued_at(self) -> datetime:
+        warnings.warn(
+            "Property 'issued_at' is deprecated and value will always be set to now.",
+            DeprecationWarning,
+        )
+        return datetime.now(tz=timezone.utc)
+
+    @property
+    def ttl(self) -> int:
         """
         TTL is the number of seconds, from now, before the token expires.
         """
-        seconds = (self.expires_at - datetime.now()).total_seconds()
+        seconds = (self.expires_at - datetime.now(timezone.utc)).total_seconds()
         return max(0, seconds)
 
     @property
-    def is_expired(self):
+    def is_expired(self) -> bool:
         """
         Tell if a token is expired or not (TTL equals to 0).
         """
         return self.ttl == 0
 
     @classmethod
-    def from_jwt(cls, token):
+    def from_jwt(cls, token: str) -> "Token":
         """
-        Create a new token from a JWT, decoding it and caching it issued and
-        expiration times.
+        Create a new token from a JWT, decoding it and caching its expiration time.
 
         :param token: (str) String containing the original encoded token which is the
             result of a POST request to the authentication endpoint.
@@ -65,8 +72,9 @@ class Token(object):
             raise TokenException(e)
 
         try:
-            issued_at = datetime.fromtimestamp(payload["iat"])
-            expires_at = datetime.fromtimestamp(payload["exp"])
-            return cls(token, issued_at, expires_at)
+            return cls(
+                token=token,
+                expires_at=datetime.fromtimestamp(payload["exp"], tz=timezone.utc),
+            )
         except Exception as e:
             raise InvalidTokenException(e)

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

@@ -3,7 +3,7 @@ class Hashabledict(dict):
         return hash(frozenset(self))
 
 
-def cat(*args, separator="/", trailing=""):
+def cat(*args, separator: str = "/", trailing: str = "") -> str:
     """
     Concatenate strings given a separator. All items will be parsed as string.
 

{pyixapi-0.2.0 → pyixapi-0.2.2}/pyixapi/models.py

@@ -154,10 +154,11 @@ class PoP(Record):
         return self.name
 
 
-class Product(Record):
+class ProductOffering(Record):
     """
-    A Product is a network or peering-related product of a defined type sold by an IXP
-    to its customers.
+    A ProductOffering is an offer made by an exchange to be consumed by a client.
+
+    It is also referenced as "product" in IX-API v1.
     """
 
     def __str__(self):
@@ -226,15 +227,6 @@ class PortReservation(Record):
         return self.id
 
 
-class ProductOffering(Record):
-    """
-    A ProductOffering is an offer made by an exchange to be consumed by a client.
-    """
-
-    def __str__(self):
-        return self.name
-
-
 class Role(Record):
     """
     A Role enables a Contact to act for a specific purpose.