cacholong-cloud-cli 0.3.0__py3-none-any.whl

cacholong_sdk/api_schema.py

@@ -0,0 +1,124 @@
+api_schema = {
+    "accounts": {
+        "properties": {
+            "name": {"type": ["string"]},
+            "display_name": {"type": ["string"]},
+            "description": {"type": ["string"]},
+            "created_at": {"type": ["string", "null"]},
+            "updated_at": {"type": ["string", "null"]},
+            "account_type": {"type": ["string", "null"]},
+            "account_account_id": {"type": ["string", "null"]},
+            "account_account_relation": {"type": ["string", "null"]},
+            "company": {"relation": "to-one", "resource": "companies"},
+            "users": {"relation": "to-many", "resource": "users"},
+        }
+    },
+    "addresses": {
+        "properties": {
+            "street": {"type": ["string"]},
+            "number": {"type": ["string"]},
+            "suffix": {"type": ["string"]},
+            "zipcode": {"type": ["string"]},
+            "city": {"type": ["string"]},
+            "state": {"type": ["string"]},
+            "country": {"type": ["string"]},
+            "user": {"relation": "to-one", "resource": "users"},
+            "company": {"relation": "to-one", "resource": "companies"},
+        }
+    },
+    "companies": {
+        "properties": {
+            "name": {"type": ["string"]},
+            "kvknr": {"type": ["string", "null"]},
+            "phone": {"type": ["string", "null"]},
+            "email": {"type": ["string", "null"]},
+            "email_invoice": {"type": ["string", "null"]},
+            "vat_number": {"type": ["string", "null"]},
+            "created_at": {"type": ["string", "null"]},
+            "updated_at": {"type": ["string", "null"]},
+            "account": {"relation": "to-one", "resource": "accounts"},
+            "addresses": {"relation": "to-many", "resource": "addresses"},
+        }
+    },
+    "dns-records": {
+        "properties": {
+            "external_service_provider_status": {"type": ["string", "null"]},
+            "dns_record_type": {"type": ["string"]},
+            "name": {"type": ["string"]},
+            "content": {"type": ["string"]},
+            "ttl": {"type": ["integer"]},
+            "priority": {"type": ["integer", "null"]},
+            "created_at": {"type": ["string", "null"]},
+            "updated_at": {"type": ["string", "null"]},
+            "dns-zone": {"relation": "to-one", "resource": "dns-zones"},
+            "dns-template": {"relation": "to-one", "resource": "dns-templates"},
+        }
+    },
+    "dns-templates": {
+        "properties": {
+            "name": {"type": ["string"]},
+            "created_at": {"type": ["string", "null"]},
+            "updated_at": {"type": ["string", "null"]},
+            "account": {"relation": "to-one", "resource": "accounts"},
+            "dns-records": {"relation": "to-many", "resource": "dns-records"},
+        }
+    },
+    "dns-zones": {
+        "properties": {
+            "external_service_provider_status": {"type": ["string", "null"]},
+            "domain": {"type": ["string"]},
+            "active": {"type": ["boolean"]},
+            "administratively_disabled": {"type": ["boolean", "null"]},
+            "dnssec": {"type": ["boolean"]},
+            "dnssec_status": {"type": ["string", "null"]},
+            "dnssec_flags": {"type": ["number", "null"]},
+            "dnssec_algorithm": {"type": ["number", "null"]},
+            "dnssec_public_key": {"type": ["string", "null"]},
+            "created_at": {"type": ["string", "null"]},
+            "updated_at": {"type": ["string", "null"]},
+            "account": {"relation": "to-one", "resource": "accounts"},
+            "name-server-group": {
+                "relation": "to-one",
+                "resource": "name-server-groups",
+            },
+            "purchase": {"relation": "to-one", "resource": "purchases"},
+            "product": {"relation": "to-one", "resource": "products"},
+            "dns-records": {"relation": "to-many", "resource": "dns-records"},
+        }
+    },
+    "products": {
+        "properties": {
+            "name": {"type": ["string"]},
+            "product_type": {"type": ["string"]},
+            "price": {"type": ["number", "null"]},
+            "default_bill_sequence": {"type": ["string"]},
+            "invoice_description": {"type": ["string"]},
+            "publish_start": {"type": ["string"]},
+            "publish_end": {"type": ["string"]},
+            "created_at": {"type": ["string", "null"]},
+            "updated_at": {"type": ["string", "null"]},
+            "children": {"relation": "to-many", "resource": "products"},
+            "parent": {"relation": "to-one", "resource": "products"},
+            "service-bundles": {"relation": "to-many", "resource": "service-bundles"},
+            "tlds": {"relation": "to-many", "resource": "tlds"},
+        }
+    },
+    "purchases": {
+        "properties": {
+            "product_type": {"type": ["string", "null"]},
+            "description": {"type": ["string"]},
+            "units": {"type": ["integer"]},
+            "date_purchase": {"type": ["string", "null"]},
+            "date_activation": {"type": ["string", "null"]},
+            "date_deactivation": {"type": ["string", "null"]},
+            "date_next_bill": {"type": ["string", "null"]},
+            "bill_sequence": {"type": ["string", "null"]},
+            "created_at": {"type": ["string", "null"]},
+            "updated_at": {"type": ["string", "null"]},
+            "account": {"relation": "to-one", "resource": "accounts"},
+            "children": {"relation": "to-many", "resource": "purchases"},
+            "parent": {"relation": "to-one", "resource": "purchases"},
+            "product": {"relation": "to-one", "resource": "products"},
+        }
+    },
+}

cacholong_sdk/common.py

@@ -0,0 +1,119 @@
+from typing import Generic, TypeVar, Optional, Any, Union, Awaitable
+from jsonapi_client.resourceobject import ResourceObject
+from jsonapi_client import Modifier, Filter
+from jsonapi_client.exceptions import DocumentError
+from .exception import ValidationException
+
+from rich.console import Console, ConsoleOptions, RenderResult
+from rich.json import JSON
+from uuid import UUID
+import json
+
+
+class UUIDEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, UUID):
+            return str(obj)
+        return json.JSONEncoder.default(self, obj)
+
+
+class BaseModel:
+    def __init__(self, obj: ResourceObject):
+        self._obj = obj
+
+    @property
+    def id(self):
+        return self._obj.id
+
+    @id.setter
+    def id(self, value):
+        self._obj.id = value
+
+    @property
+    def json(self):
+        return self._obj.json
+
+    @property
+    def url(self) -> str:
+        return self._obj.url
+
+    def __rich_console__(
+        self, console: Console, options: ConsoleOptions
+    ) -> RenderResult:
+        yield JSON(json.dumps(self.json, cls=UUIDEncoder), indent=4)
+
+    def __getitem__(self, item):
+        return self._obj[item]
+
+    def __setitem__(self, item, value):
+        self._obj[item] = value
+
+    def commit(
+        self, custom_url: str = "", meta: Optional[dict] = None
+    ) -> Awaitable[ResourceObject]:
+        return self._obj.commit(custom_url, meta)
+
+
+Model = TypeVar("Model", bound=BaseModel)
+
+
+class BaseController(Generic[Model]):
+    _class: Any
+    _resource: str
+
+    def __init__(self, connection) -> None:
+        self._connection = connection
+        if not issubclass(self._class, BaseModel):
+            raise ValueError("_class attribute is not set")
+
+    @property
+    def resource(self):
+        return self._resource
+
+    async def fetch(self, resource_id) -> Model:
+        doc = await self._connection.get(self._resource, resource_id)
+        return self._class(doc.resource)
+
+    async def fetch_all(self, modifier: Modifier = None):
+        async for resource in self._connection.iterate(self._resource, modifier):
+            yield self._class(resource)
+
+    def create(self) -> Model:
+        model = self._class(self._connection.create(self._resource))
+        return model
+
+    async def store(
+        self, model: Model, create_issue: bool = False, meta: Optional[dict] = None
+    ):
+        custom_url = ""
+        if create_issue:
+            custom_url = model._obj.post_url
+            custom_url = custom_url + "?issue=1"
+        await model.commit(custom_url, meta)
+
+    async def update(
+        self, model: Model, create_issue: bool = False, meta: Optional[dict] = None
+    ):
+        custom_url = ""
+        if create_issue:
+            custom_url = model._obj.url
+            custom_url = custom_url + "?issue=1"
+        await model.commit(custom_url, meta)
+
+    async def destroy(self, resource_id, create_issue: bool = False):
+        resource = self._connection.create(self._resource)
+        resource.id = resource_id
+        resource.delete()
+        try:
+            custom_url = ""
+            if create_issue:
+                custom_url = resource.url
+                custom_url = custom_url + "?issue=1"
+            await resource.commit(custom_url)
+        except KeyError:
+            # Because we didn't fetch the record first it is not stored in
+            # the cache, just handle the exception and that's it. The resource
+            # is succesfully removed from the server.
+            pass
+        except DocumentError as e:
+            raise ValidationException("Validation failed", e.errors)

cacholong_sdk/company.py

@@ -0,0 +1,14 @@
+from .common import BaseController, BaseModel
+
+
+class CompanyModel(BaseModel):
+    pass
+
+
+class Company(BaseController[CompanyModel]):
+    _class = CompanyModel
+
+    def __init__(self, connection):
+        self._resource = "companies"
+
+        super().__init__(connection)

cacholong_sdk/connection.py

@@ -0,0 +1,22 @@
+import importlib.metadata
+
+from jsonapi_client import Session
+from .api_schema import api_schema
+
+
+class connection(Session):
+    def __init__(self, api_uri, api_key, extra_headers={}) -> None:
+
+        # Call parent constructor
+        basic_headers = {
+            "Accept": "application/vnd.api+json",
+            "Authorization": "Bearer " + api_key,
+            "User-Agent": "ccloud/" + importlib.metadata.version("ccloud"),
+        }
+        headers = basic_headers | extra_headers
+        super().__init__(
+            api_uri,
+            enable_async=True,
+            schema=api_schema,
+            request_kwargs={"headers": headers},
+        )

cacholong_sdk/dns_record.py

@@ -0,0 +1,14 @@
+from .common import BaseController, BaseModel
+
+
+class DnsRecordModel(BaseModel):
+    pass
+
+
+class DnsRecord(BaseController[DnsRecordModel]):
+    _class = DnsRecordModel
+
+    def __init__(self, connection):
+        self._resource = "dns-records"
+
+        super().__init__(connection)

cacholong_sdk/dns_template.py

@@ -0,0 +1,14 @@
+from .common import BaseController, BaseModel
+
+
+class DnsTemplateModel(BaseModel):
+    pass
+
+
+class DnsTemplate(BaseController[DnsTemplateModel]):
+    _class = DnsTemplateModel
+
+    def __init__(self, connection):
+        self._resource = "dns-templates"
+
+        super().__init__(connection)

cacholong_sdk/dns_zone.py

@@ -0,0 +1,14 @@
+from .common import BaseController, BaseModel
+
+
+class DnsZoneModel(BaseModel):
+    pass
+
+
+class DnsZone(BaseController[DnsZoneModel]):
+    _class = DnsZoneModel
+
+    def __init__(self, connection):
+        self._resource = "dns-zones"
+
+        super().__init__(connection)

cacholong_sdk/exception.py

@@ -0,0 +1,7 @@
+class ValidationException(Exception):
+    def __init__(self, message, errors):
+        self.message = message
+        self.errors = errors
+
+        # call parent constructor
+        super().__init__(self.message)

cacholong_sdk/product.py

@@ -0,0 +1,14 @@
+from .common import BaseController, BaseModel
+
+
+class ProductModel(BaseModel):
+    pass
+
+
+class Product(BaseController[ProductModel]):
+    _class = ProductModel
+
+    def __init__(self, connection):
+        self._resource = "products"
+
+        super().__init__(connection)

cacholong_sdk/purchase.py

@@ -0,0 +1,14 @@
+from .common import BaseController, BaseModel
+
+
+class PurchaseModel(BaseModel):
+    pass
+
+
+class Purchase(BaseController[PurchaseModel]):
+    _class = PurchaseModel
+
+    def __init__(self, connection):
+        self._resource = "purchases"
+
+        super().__init__(connection)

jsonapi_client/__init__.py

@@ -0,0 +1,42 @@
+"""
+JSON API Python client 
+https://github.com/qvantel/jsonapi-client
+
+(see JSON API specification in http://jsonapi.org/)
+
+Copyright (c) 2017, Qvantel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Qvantel nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL QVANTEL BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+import importlib.metadata
+
+from .session import Session
+from .filter import Filter, Inclusion, Modifier, Sort, SparseField
+from .common import ResourceTuple
+
+__version__ = "0.9.9"
+try:
+    __version__ = importlib.metadata.version("jsonapi-client")
+except:
+    pass

jsonapi_client/common.py

@@ -0,0 +1,186 @@
+"""
+JSON API Python client 
+https://github.com/qvantel/jsonapi-client
+
+(see JSON API specification in http://jsonapi.org/)
+
+Copyright (c) 2017, Qvantel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the Qvantel nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL QVANTEL BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+
+import asyncio
+import logging
+from typing import Union, TYPE_CHECKING, NamedTuple
+
+if TYPE_CHECKING:
+    from .session import Session
+
+logger = logging.getLogger(__name__)
+
+
+class HttpStatus:
+    OK_200 = 200
+    CREATED_201 = 201
+    ACCEPTED_202 = 202
+    NO_CONTENT_204 = 204
+    FORBIDDEN_403 = 403
+    NOT_FOUND_404 = 404
+    CONFLICT_409 = 409
+
+    HAS_RESOURCES = (OK_200, CREATED_201, ACCEPTED_202)
+    ALL_OK = (OK_200, CREATED_201, ACCEPTED_202, NO_CONTENT_204)
+
+
+class HttpMethod:
+    POST = 'post'
+    PATCH = 'patch'
+    DELETE = 'delete'
+
+
+class RelationType:
+    TO_ONE = 'to-one'
+    TO_MANY = 'to-many'
+
+
+class AbstractJsonObject:
+    """
+    Base for all JSON API specific objects
+    """
+    def __init__(self, session: 'Session', data: Union[dict, list]) -> None:
+        self._invalid = False
+        self._session = session
+        self._handle_data(data)
+
+    @property
+    def session(self):
+        return self._session
+
+    def _handle_data(self, data: Union[dict, list]) -> None:
+        """
+        Store data
+        """
+        raise NotImplementedError
+
+    def __repr__(self):
+        return f'<{self.__class__.__name__}: {str(self)} ({id(self)})>'
+
+    def __str__(self):
+        raise NotImplementedError
+
+    @property
+    def url(self) -> str:
+        raise NotImplementedError
+
+    def mark_invalid(self):
+        self._invalid = True
+
+
+def error_from_response(response_content):
+    try:
+        error_str = repr([ e['detail'] for e in response_content['errors'] ])
+    except Exception:
+        error_str = '?'
+    return error_str
+
+
+def jsonify_attribute_name(name):
+    return name.replace('__', '.').replace('_', '-')
+
+
+def dejsonify_attribute_name(name):
+    return name.replace('.', '__').replace('-', '_')
+
+
+def jsonify_attribute_names(iterable):
+    for i in iterable:
+        yield jsonify_attribute_name(i)
+
+
+def dejsonify_attribute_names(iterable):
+    for i in iterable:
+        yield dejsonify_attribute_name(i)
+
+
+async def execute_async(func, *args):
+    """Shortcut to asynchronize normal blocking function"""
+    loop = asyncio.get_event_loop()
+    return await loop.run_in_executor(None, func, *args)
+
+
+class cached_property(object):
+    """
+    From Django code
+
+    Decorator that converts a method with a single self argument into a
+    property cached on the instance.
+
+    Optional ``name`` argument allows you to make cached properties of other
+    methods. (e.g.  url = cached_property(get_absolute_url, name='url') )
+    """
+    def __init__(self, func, name=None):
+        self.func = func
+        self.__doc__ = getattr(func, '__doc__')
+        self.name = name or func.__name__
+
+    def __get__(self, instance, type=None):
+        if instance is None:
+            return self
+        res = instance.__dict__[self.name] = self.func(instance)
+        return res
+
+
+class AttributeProxy:
+    """
+    Attribute proxy used in ResourceObject.fields etc.
+    """
+    def __init__(self, target_object=None):
+        self._target_object = target_object
+
+    def __getitem__(self, item):
+        return self._target_object[item]
+
+    def __setitem__(self, key, value):
+        self._target_object[key] = value
+
+    def __getattr__(self, item):
+        try:
+            return self[jsonify_attribute_name(item)]
+        except KeyError:
+            raise AttributeError
+
+    def __setattr__(self, key, value):
+        if key == '_target_object':
+            return super().__setattr__(key, value)
+        try:
+            self[jsonify_attribute_name(key)] = value
+        except KeyError:
+            raise AttributeError
+
+
+class ResourceTuple(NamedTuple):
+    id: str
+    type: str
+    meta: dict = None
+