|
| 1 | +""" |
| 2 | +Module for working with custom map visualizations (aka Kuvizs) |
| 3 | +
|
| 4 | +.. module:: carto.Kuvizs |
| 5 | + :platform: Unix, Windows |
| 6 | + :synopsis: Module for working with custom map visualizations (aka Kuvizs) |
| 7 | +
|
| 8 | +.. moduleauthor:: Simon Martin <[email protected]> |
| 9 | +
|
| 10 | +""" |
| 11 | + |
| 12 | +import base64 |
| 13 | + |
| 14 | +from pyrestcli.fields import CharField, DateTimeField |
| 15 | + |
| 16 | +from .resources import Manager, WarnResource |
| 17 | +from .paginators import CartoPaginator |
| 18 | + |
| 19 | + |
| 20 | +API_VERSION = "v4" |
| 21 | +API_ENDPOINT = "api/{api_version}/kuviz/" |
| 22 | + |
| 23 | +PRIVACY_PASSWORD = 'password' |
| 24 | + |
| 25 | + |
| 26 | +class Kuviz(WarnResource): |
| 27 | + """ |
| 28 | + Represents a custom map visualization in CARTO. |
| 29 | +
|
| 30 | + .. warning:: Non-public API. It may change with no previous notice |
| 31 | + """ |
| 32 | + created_at = DateTimeField() |
| 33 | + data = CharField() |
| 34 | + id = CharField() |
| 35 | + name = CharField() |
| 36 | + password = CharField() |
| 37 | + privacy = CharField() |
| 38 | + updated_at = DateTimeField() |
| 39 | + url = CharField() |
| 40 | + |
| 41 | + class Meta: |
| 42 | + collection_endpoint = API_ENDPOINT.format(api_version=API_VERSION) |
| 43 | + name_field = "id" |
| 44 | + |
| 45 | + |
| 46 | +class KuvizManager(Manager): |
| 47 | + """ |
| 48 | + Manager for the Kuviz class. |
| 49 | +
|
| 50 | + .. warning:: Non-public API. It may change with no previous notice |
| 51 | + """ |
| 52 | + resource_class = Kuviz |
| 53 | + paginator_class = CartoPaginator |
| 54 | + |
| 55 | + def get(self, id): |
| 56 | + pass |
| 57 | + |
| 58 | + def all(self): |
| 59 | + pass |
| 60 | + |
| 61 | + def create(self, html, name, password=None): |
| 62 | + """ |
| 63 | + Creates a Kuviz. |
| 64 | +
|
| 65 | + :param html: The visualization HTML |
| 66 | + :param name: The visualization name |
| 67 | + :type html: str |
| 68 | + :type name: str |
| 69 | +
|
| 70 | + :return: A Kuviz instance with the `url` and `visualization` properties |
| 71 | + of the new Kuviz |
| 72 | + """ |
| 73 | + data = base64.b64encode(html.encode()).decode('ascii') |
| 74 | + if password: |
| 75 | + return super(KuvizManager, self).create(data=data, name=name, |
| 76 | + privacy=PRIVACY_PASSWORD, password=password) |
| 77 | + else: |
| 78 | + return super(KuvizManager, self).create(data=data, name=name) |
| 79 | + |
| 80 | + def update(self, html, name, password=None): |
| 81 | + pass |
0 commit comments