cone.tokens 1.1.0__tar.gz

cone_tokens-1.1.0/.gitignore

@@ -0,0 +1,19 @@
+*egg-info
+*pyc
+/.coverage
+/.mxmake
+/.vscode
+/build/
+/constraints-mxdev.txt
+/coverage
+/dist/
+/htmlcov
+/node_modules/
+/package-lock.json
+/pnpm-lock.yaml
+/requirements-mxdev.txt
+/requirements.txt
+/sources/
+/var/
+/venv/
+__pycache__

cone_tokens-1.1.0/CHANGES.rst

@@ -0,0 +1,53 @@
+Changes
+=======
+
+1.1.0 (2026-02-03)
+------------------
+
+- Refactor package layout to use ``pyproject.toml`` and implicit namespace packages.
+  [rnix]
+
+
+0.5 (2024-05-23)
+----------------
+
+- Update Makefile.
+  [rnix]
+
+- ``properties`` and ``metadata`` of ``cone.tokens.model.Tokens`` are instance
+  properties now.
+  [rnix]
+
+- Use ``ts.http_request`` instead of ``ts.ajax.request``.
+  [rnix]
+
+
+0.4 (2024-02-12)
+----------------
+
+- Adopt Settings UI changes from ``cone.app``.
+  [rnix]
+
+
+0.3 (2023-09-28)
+----------------
+
+- Tokens can be bulk deleted.
+  [lenadax]
+
+- Tokens can be created from scanned value.
+  [rnix]
+
+
+0.2 (2023-09-27)
+----------------
+
+- Actually upload package to pypi.
+  [rnix]
+
+
+0.1 (2023-09-27)
+----------------
+
+- Initial work.
+  [rnix, toalba, lenadax]

cone_tokens-1.1.0/LICENSE.rst

@@ -0,0 +1,24 @@
+License
+=======
+
+MIT License
+
+Copyright (c) 2023-2025, Cone Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cone_tokens-1.1.0/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.4
+Name: cone.tokens
+Version: 1.1.0
+Summary: cone token api
+Project-URL: Homepage, http://github.com/conestack/cone.tokens
+Author-email: Cone Contributors <dev@conestack.org>
+License: MIT
+License-File: LICENSE.rst
+Keywords: cone,node,pyramid,web
+Classifier: Environment :: Web Environment
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Requires-Dist: cone-app<2.0.0,>1.0.99
+Requires-Dist: cone-sql>1.0.99
+Requires-Dist: python-dateutil
+Requires-Dist: qrcode[pil]
+Requires-Dist: yafowil-widget-datetime>1.99
+Provides-Extra: test
+Requires-Dist: cone-app[test]; extra == 'test'
+Requires-Dist: cone-ugm[test]; extra == 'test'
+Description-Content-Type: text/x-rst
+
+.. image:: https://img.shields.io/pypi/v/cone.tokens.svg
+    :target: https://pypi.python.org/pypi/cone.tokens
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/cone.tokens.svg
+    :target: https://pypi.python.org/pypi/cone.tokens
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/cone.tokens/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/conestack/cone.tokens/actions/workflows/test.yml
+    :alt: Test cone.tokens
+
+This package provides a unique token generator for ``cone.app``.
+
+Features:
+
+* QR Code generation
+* JSON API for token management
+
+
+Application ini file configuration
+==================================
+
+- **cone.tokens.config_file**: Required. Path to tokens json config file.
+
+- **cone.tokens.settings_node_path**: Optional. Application node path to token settings node.
+
+- **cone.tokens.entryfactory**: Optional. Node class used as entry node factory.
+
+
+JSON API
+========
+
+``cone.tokens`` provides a JSON API for token management.
+
+
+query_token
+-----------
+
+Query token by value. It expects a ``GET`` request.
+
+**Schema**: URL/tokens/query_token
+
+**Params**
+
+- ``value``: A string containing the token value to look up.
+
+**Response**
+
+- ``success``: True or False.
+- ``token``: Token data or null if token not exists.
+- ``message``: On failure the error message is returned.
+
+
+add_token
+---------
+
+``add_token`` is for generating a new token. It expects a ``POST`` request.
+
+**Schema**: URL/tokens/add_token
+
+**Params**
+
+- ``value``: A string containing the token value. If empty, the token uuid gets used as value.
+- ``valid_from``: A datetime in isoformat. If empty, token has no effective date.
+- ``valid_to``: A datetime in isoformat. If empty, token has no expiration date.
+- ``usage_count``: An integer defining how often the token can be consumed. If -1, token can be consumed unlimited times.
+- ``lock_time``: Time in seconds the token is locked after consumption as integer.
+
+**Response**
+
+- ``success``: True or False.
+- ``token_uid``: On success the token uid is returned.
+- ``message``: On failure the error message is returned.
+
+
+consume_token
+-------------
+
+``consume_token`` is for consuming a token. It expects a ``GET`` request.
+
+**Schema**: URL/tokens/<UUID>/consume_token
+
+**Params**
+
+- No parametes expected.
+
+**Response**
+
+- ``success``: True or False.
+- ``consumed``: On success flag whether token consumption was valid.
+- ``message``: On failure the error message is returned.
+
+
+update_token
+------------
+
+``edit_token`` is for editing a token. It expects a ``POST`` request.
+
+**Schema**: URL/tokens/<UUID>/update_token
+
+**Params**
+
+- ``value``: A string containing the token value. If empty, the token uuid gets used as value. Unchanged if parameter is omitted.
+- ``valid_from``: A datetime in isoformat. If empty, token has no effective date. Unchanged if parameter is omitted.
+- ``valid_to``: A datetime in isoformat. If empty, token has no expiration date. Unchanged if parameter is omitted.
+- ``usage_count``: An integer defining how often the token can be consumed. If -1, token can be consumed unlimited times. Unchanged if parameter is omitted.
+- ``lock_time``: Time in seconds the token is locked after consumption as integer. Unchanged if parameter is omitted.
+
+**Response**
+
+- ``success``: True or False.
+- ``message``: On failure the error message is returned.
+
+
+delete_token
+------------
+
+``delete_token`` is for deleting a token. It expects a ``POST`` request.
+
+**Schema**: URL/tokens/<UUID>/delete_token
+
+**Params**
+
+- No parametes expected.
+
+**Response**
+
+- ``success``: True or False.
+- ``message``: On failure the error message is returned.
+
+
+TODO
+====
+
+- Introduce ``consume`` permission for JSON API.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+- Torben Baumgartner
+- Lena Daxenbichler
+
+
+Changes
+=======
+
+1.1.0 (2026-02-03)
+------------------
+
+- Refactor package layout to use ``pyproject.toml`` and implicit namespace packages.
+  [rnix]
+
+
+0.5 (2024-05-23)
+----------------
+
+- Update Makefile.
+  [rnix]
+
+- ``properties`` and ``metadata`` of ``cone.tokens.model.Tokens`` are instance
+  properties now.
+  [rnix]
+
+- Use ``ts.http_request`` instead of ``ts.ajax.request``.
+  [rnix]
+
+
+0.4 (2024-02-12)
+----------------
+
+- Adopt Settings UI changes from ``cone.app``.
+  [rnix]
+
+
+0.3 (2023-09-28)
+----------------
+
+- Tokens can be bulk deleted.
+  [lenadax]
+
+- Tokens can be created from scanned value.
+  [rnix]
+
+
+0.2 (2023-09-27)
+----------------
+
+- Actually upload package to pypi.
+  [rnix]
+
+
+0.1 (2023-09-27)
+----------------
+
+- Initial work.
+  [rnix, toalba, lenadax]
+
+
+License
+=======
+
+MIT License
+
+Copyright (c) 2023-2025, Cone Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cone_tokens-1.1.0/README.rst

@@ -0,0 +1,144 @@
+.. image:: https://img.shields.io/pypi/v/cone.tokens.svg
+    :target: https://pypi.python.org/pypi/cone.tokens
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/cone.tokens.svg
+    :target: https://pypi.python.org/pypi/cone.tokens
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/cone.tokens/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/conestack/cone.tokens/actions/workflows/test.yml
+    :alt: Test cone.tokens
+
+This package provides a unique token generator for ``cone.app``.
+
+Features:
+
+* QR Code generation
+* JSON API for token management
+
+
+Application ini file configuration
+==================================
+
+- **cone.tokens.config_file**: Required. Path to tokens json config file.
+
+- **cone.tokens.settings_node_path**: Optional. Application node path to token settings node.
+
+- **cone.tokens.entryfactory**: Optional. Node class used as entry node factory.
+
+
+JSON API
+========
+
+``cone.tokens`` provides a JSON API for token management.
+
+
+query_token
+-----------
+
+Query token by value. It expects a ``GET`` request.
+
+**Schema**: URL/tokens/query_token
+
+**Params**
+
+- ``value``: A string containing the token value to look up.
+
+**Response**
+
+- ``success``: True or False.
+- ``token``: Token data or null if token not exists.
+- ``message``: On failure the error message is returned.
+
+
+add_token
+---------
+
+``add_token`` is for generating a new token. It expects a ``POST`` request.
+
+**Schema**: URL/tokens/add_token
+
+**Params**
+
+- ``value``: A string containing the token value. If empty, the token uuid gets used as value.
+- ``valid_from``: A datetime in isoformat. If empty, token has no effective date.
+- ``valid_to``: A datetime in isoformat. If empty, token has no expiration date.
+- ``usage_count``: An integer defining how often the token can be consumed. If -1, token can be consumed unlimited times.
+- ``lock_time``: Time in seconds the token is locked after consumption as integer.
+
+**Response**
+
+- ``success``: True or False.
+- ``token_uid``: On success the token uid is returned.
+- ``message``: On failure the error message is returned.
+
+
+consume_token
+-------------
+
+``consume_token`` is for consuming a token. It expects a ``GET`` request.
+
+**Schema**: URL/tokens/<UUID>/consume_token
+
+**Params**
+
+- No parametes expected.
+
+**Response**
+
+- ``success``: True or False.
+- ``consumed``: On success flag whether token consumption was valid.
+- ``message``: On failure the error message is returned.
+
+
+update_token
+------------
+
+``edit_token`` is for editing a token. It expects a ``POST`` request.
+
+**Schema**: URL/tokens/<UUID>/update_token
+
+**Params**
+
+- ``value``: A string containing the token value. If empty, the token uuid gets used as value. Unchanged if parameter is omitted.
+- ``valid_from``: A datetime in isoformat. If empty, token has no effective date. Unchanged if parameter is omitted.
+- ``valid_to``: A datetime in isoformat. If empty, token has no expiration date. Unchanged if parameter is omitted.
+- ``usage_count``: An integer defining how often the token can be consumed. If -1, token can be consumed unlimited times. Unchanged if parameter is omitted.
+- ``lock_time``: Time in seconds the token is locked after consumption as integer. Unchanged if parameter is omitted.
+
+**Response**
+
+- ``success``: True or False.
+- ``message``: On failure the error message is returned.
+
+
+delete_token
+------------
+
+``delete_token`` is for deleting a token. It expects a ``POST`` request.
+
+**Schema**: URL/tokens/<UUID>/delete_token
+
+**Params**
+
+- No parametes expected.
+
+**Response**
+
+- ``success``: True or False.
+- ``message``: On failure the error message is returned.
+
+
+TODO
+====
+
+- Introduce ``consume`` permission for JSON API.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+- Torben Baumgartner
+- Lena Daxenbichler

cone_tokens-1.1.0/pyproject.toml

@@ -0,0 +1,72 @@
+[build-system]
+requires = ["hatchling", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[project]
+name = "cone.tokens"
+version = "1.1.0"
+description = "cone token api"
+dynamic = ["readme"]
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [{name = "Cone Contributors", email = "dev@conestack.org"}]
+keywords = ["node", "pyramid", "cone", "web"]
+classifiers = [
+    "Environment :: Web Environment",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dependencies = [
+    "cone.app>1.0.99,<2.0.0",
+    "cone.sql>1.0.99",
+    "python-dateutil",
+    "qrcode[pil]",
+    "yafowil.widget.datetime>1.99",
+]
+
+[project.optional-dependencies]
+test = [
+    "cone.app[test]",
+    "cone.ugm[test]",
+]
+
+[project.urls]
+Homepage = "http://github.com/conestack/cone.tokens"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/x-rst"
+fragments = [
+    {path = "README.rst"},
+    {text = "\n\n"},
+    {path = "CHANGES.rst"},
+    {text = "\n\n"},
+    {path = "LICENSE.rst"},
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/.github/",
+    "/js/",
+    "/Makefile",
+    "/mx.ini",
+    "/package.json",
+    "/pnpm-lock.yaml",
+    "/scss/",
+    "/tokens.ini",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cone"]
+
+[tool.pytest.ini_options]
+consider_namespace_packages = true
+addopts = ["--import-mode=importlib"]
+pythonpath = "src"
+
+[tool.zest-releaser]
+create-wheel = true

cone_tokens-1.1.0/src/cone/tokens/__init__.py

@@ -0,0 +1,41 @@
+from cone.app import import_from_string
+from cone.app import main_hook
+from cone.app import register_config
+from cone.tokens.browser import configure_resources
+from cone.tokens.settings import TokenSettings
+from cone.tokens.settings import tokens_config
+import cone.app
+import logging
+
+
+logger = logging.getLogger('cone.tokens')
+
+
+@main_hook
+def initialize_tokens(config, global_config, settings):
+    # application startup initialization
+
+    tokens_config.config_file = settings['cone.tokens.config_file']
+    tokens_config.settings_node_path = settings.get(
+        'cone.tokens.settings_node_path',
+        'settings/token_settings'
+    ).split('/')
+
+    # register entry node
+    tokens_entry_factory = settings.get(
+        'cone.tokens.entryfactory',
+        'cone.tokens.model.TokenContainer'
+    )
+    cone.app.register_entry('tokens', import_from_string(tokens_entry_factory))
+
+    # settings
+    register_config('token_settings', TokenSettings)
+
+    # static resources
+    configure_resources(config, settings)
+
+    # add translation
+    config.add_translation_dirs('cone.tokens:locale/')
+
+    # scan browser package
+    config.scan('cone.tokens.browser')