pyixapi 0.2.2__tar.gz → 0.2.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyixapi
-Version: 0.2.2
+Version: 0.2.3
 Summary: Python API client library for IX-API
 License: Apache-2.0
 Author: Guillaume Mazoyer

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

@@ -1,5 +1,3 @@
-from typing import Any
-
 import requests
 
 from pyixapi.core.endpoint import Endpoint
@@ -44,13 +42,13 @@ 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__}",
+    ):
         self.url = url.rstrip("/")
         self.key = key
         self.secret = secret
@@ -92,7 +90,7 @@ class API(object):
         self.role_assignments = Endpoint(self, "role-assignments", model=RoleAssignment)
 
     @property
-    def version(self) -> int:
+    def version(self):
         """
         Get the API version of IX-API.
         """
@@ -101,20 +99,20 @@ class API(object):
         ).get_version()
 
     @property
-    def accounts(self) -> Endpoint:
+    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.
 
@@ -141,7 +139,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.
         """
@@ -156,7 +154,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.
 

{pyixapi-0.2.2 → pyixapi-0.2.3}/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.
         """
@@ -36,7 +31,7 @@ class Endpoint:
         )
         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.
@@ -49,7 +44,7 @@ class Endpoint:
         )
         return RecordSet(self, r)
 
-    def get(self, *args, **kwargs) -> Optional[Record]:
+    def get(self, *args, **kwargs):
         """
         Return a single object from an endpoint.
         """
@@ -88,7 +83,7 @@ class Endpoint:
             else:
                 raise e
 
-    def create(self, *args, **kwargs) -> Record:
+    def create(self, *args, **kwargs):
         """
         Creates an object on an endpoint.
 

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

@@ -1,5 +1,4 @@
 import json
-from typing import Any, Optional
 
 from pyixapi.core.util import cat
 
@@ -34,7 +33,7 @@ class RequestError(Exception):
         self.req = r
         self.error = r.text
 
-    def __str__(self) -> str:
+    def __str__(self):
         return self.message
 
 
@@ -45,7 +44,7 @@ class ContentError(Exception):
     those cases.
     """
 
-    def __init__(self, req) -> None:
+    def __init__(self, req):
         super(ContentError, self).__init__(req)
 
         self.req = req
@@ -53,11 +52,11 @@ class ContentError(Exception):
             "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.
 
@@ -81,7 +80,7 @@ class Request:
         self.url = self.base if not key else cat(self.base, key)
         self.user_agent = user_agent
 
-    def get_openapi(self) -> Any:
+    def get_openapi(self):
         """
         Get the OpenAPI Spec.
         """
@@ -94,7 +93,7 @@ class Request:
         else:
             raise RequestError(req)
 
-    def get_version(self) -> int:
+    def get_version(self):
         """
         Get the API version of IX-API.
 
@@ -108,7 +107,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 +120,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:
@@ -160,7 +153,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 +172,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 +184,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 +196,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 +210,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 +222,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.3}/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,13 +52,13 @@ 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):
@@ -81,7 +81,7 @@ class RecordSet:
             return self.request.count
 
 
-class Record:
+class Record(object):
     """
     Create Python objects from IX-API responses.
 
@@ -144,7 +144,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

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

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

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyixapi"
-version = "0.2.2"
+version = "0.2.3"
 description = "Python API client library for IX-API"
 authors = ["Guillaume Mazoyer <oss@mazoyer.eu>"]
 readme = "README.md"

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))