viewo-helpdesk 1.0.0__tar.gz

viewo_helpdesk-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Helmut Konrad Schewe
+
+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.

viewo_helpdesk-1.0.0/MANIFEST.in

@@ -0,0 +1 @@
+graft viewo_helpdesk/templates

viewo_helpdesk-1.0.0/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: viewo_helpdesk
+Version: 1.0.0
+Author-email: Helmut Konrad Schewe <helmutus@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/anaticulae/viewo-helpdesk
+Project-URL: Repository, https://github.com/anaticulae/viewo-helpdesk
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bootstrap-flask<3.0.0,>=2.6.0
+Requires-Dist: configos<2.0.0,>=1.0.4
+Requires-Dist: flask-login<1.0.0,>=0.6.3
+Requires-Dist: flask<4.0.0,>=3.1.3
+Requires-Dist: flask_bootstrap<4.0.0.0,>=3.3.7.1
+Requires-Dist: utilo<3.0.0,>=2.112.1
+Provides-Extra: dev
+Requires-Dist: utilotest==1.1.1; extra == "dev"
+Dynamic: license-file
+
+# viewo_helpdesk

viewo_helpdesk-1.0.0/README

@@ -0,0 +1 @@
+# viewo_helpdesk

viewo_helpdesk-1.0.0/pyproject.toml

@@ -0,0 +1,98 @@
+[build-system]
+requires = [
+    "setuptools>=83.0.0",
+    "wheel>=0.47.0",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "viewo_helpdesk"
+version = "1.0.0"
+description = ""
+requires-python = ">=3.12"
+authors = [
+    { name = "Helmut Konrad Schewe", email = "helmutus@outlook.com" },
+]
+dependencies = [
+    "bootstrap-flask>=2.6.0,<3.0.0",
+    "configos>=1.0.4,<2.0.0",
+    "flask-login>=0.6.3,<1.0.0",
+    "flask>=3.1.3,<4.0.0",
+    "flask_bootstrap>=3.3.7.1,<4.0.0.0",
+    "utilo>=2.112.1,<3.0.0",
+]
+keywords = []
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
+
+[project.readme]
+file = "README"
+content-type = "text/markdown"
+
+[project.optional-dependencies]
+dev = [
+    "utilotest==1.1.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/anaticulae/viewo-helpdesk"
+Repository = "https://github.com/anaticulae/viewo-helpdesk"
+
+[project.scripts]
+viewo_helpdesk = "viewo_helpdesk.cli:main"
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version",
+]
+
+[tool.semantic_release.changelog]
+mode = "init"
+output_format = "md"
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG"
+
+[tool.semantic_release.commit_parser_options]
+allowed_tags = [
+    "build",
+    "chore",
+    "ci",
+    "deps",
+    "docs",
+    "feat",
+    "fix",
+    "perf",
+    "refactor",
+    "style",
+    "test",
+]
+default_bump_level = 2
+
+[tool.setuptools.packages.find]
+where = [
+    ".",
+]
+include = [
+    "viewo_helpdesk",
+    "viewo_helpdesk.api",
+    "viewo_helpdesk.message",
+    "viewo_helpdesk.view",
+]
+exclude = [
+    "tests*",
+]
+
+[tool.hoverpower]
+packages = [
+    "DOCU",
+    "HOME",
+    "MASTER",
+]

viewo_helpdesk-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

viewo_helpdesk-1.0.0/tests/test_action.py

@@ -0,0 +1,25 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import pytest
+
+import tests
+import viewo_helpdesk
+
+
+@pytest.mark.usefixtures('appi')
+def test_action_start_converation():
+    # user starts issue
+    created = tests.create_single_sample()
+
+    dialog = viewo_helpdesk.load_messages(tests.TESTUSER, created)
+    assert len(dialog) == 3
+    assert dialog[0].writer  # user
+    assert not dialog[1].writer  # admin
+    assert dialog[2].writer  # user

viewo_helpdesk-1.0.0/tests/test_collect.py

@@ -0,0 +1,18 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import pytest
+
+import viewo_helpdesk
+
+
+@pytest.mark.usefixtures('appi')
+def test_load_users():
+    users = viewo_helpdesk.load_users()
+    assert not users

viewo_helpdesk-1.0.0/tests/test_config.py

@@ -0,0 +1,18 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import pytest
+
+import viewo_helpdesk.config
+
+
+@pytest.mark.usefixtures('appi')
+def test_access_root():
+    root = viewo_helpdesk.config.helpdesk()
+    assert root

viewo_helpdesk-1.0.0/tests/test_login.py

@@ -0,0 +1,8 @@
+import tests
+
+
+def test_login(client_single):
+    response = client_single.get('/admin/login')
+    content = tests.decode(response)
+    assert '<title>Admin - Login</title>' in content
+    assert '>Anmelden<' in content

viewo_helpdesk-1.0.0/viewo_helpdesk/__init__.py

@@ -0,0 +1,38 @@
+#==============================================================================
+# C O P Y R I G H T
+#------------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+#==============================================================================
+
+import importlib.metadata
+import os
+
+import utilo
+
+import viewo_helpdesk.__patch__
+from viewo_helpdesk.api import api_call
+from viewo_helpdesk.config import API_PREFIX
+from viewo_helpdesk.config import SECRET_KEY
+from viewo_helpdesk.config import VIEWO_HELPDESK
+from viewo_helpdesk.config import board
+from viewo_helpdesk.config import configure
+from viewo_helpdesk.message import Dialog
+from viewo_helpdesk.message import Dialogs
+from viewo_helpdesk.message import Message
+from viewo_helpdesk.message import Messages
+from viewo_helpdesk.message.action import start_conversion
+from viewo_helpdesk.message.action import write_message
+from viewo_helpdesk.message.collect import load_dialogs
+from viewo_helpdesk.message.collect import load_messages
+from viewo_helpdesk.message.collect import load_users
+from viewo_helpdesk.message.collect import valid_dialog
+from viewo_helpdesk.message.collect import valid_user
+from viewo_helpdesk.message.path import userpath
+from viewo_helpdesk.message.serialize import dump_message
+
+__version__ = importlib.metadata.version('viewo-helpdesk')
+
+ROOT = os.path.abspath(utilo.join(os.path.dirname(__file__), '..'))

viewo_helpdesk-1.0.0/viewo_helpdesk/__main__.py

@@ -0,0 +1,26 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import os
+
+import utilo
+
+import viewo_helpdesk
+import viewo_helpdesk.app
+import viewo_helpdesk.config
+
+CONFIG = {
+    viewo_helpdesk.config.VIEWO_HELPDESK:
+        os.environ.get(
+            viewo_helpdesk.config.VIEWO_HELPDESK,
+            utilo.join(utilo.tmpdir(viewo_helpdesk.ROOT), 'viewo_helpdesk'),
+        )
+}
+
+instance = viewo_helpdesk.app.create(CONFIG)  # pylint:disable=C0103

viewo_helpdesk-1.0.0/viewo_helpdesk/__patch__.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================

viewo_helpdesk-1.0.0/viewo_helpdesk/api/__init__.py

@@ -0,0 +1,101 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import functools
+import http
+
+import flask
+import flask_login
+import utilo
+
+import viewo_helpdesk
+import viewo_helpdesk.config
+
+api_auth = flask.Blueprint('api_auth', __name__)  # pylint:disable=C0103
+api_message = flask.Blueprint('api_message', __name__)  # pylint:disable=C0103
+
+__all__ = ['api_auth', 'api_message', 'auth', 'delete', 'post', 'present']
+
+
+def dump(data, name='', uri='') -> str:
+    uri = uri if uri else flask.request.path
+    name = name if name else 'data'
+    data = utilo.simplify(data)  # pylint:disable=E1101
+    connected = {'uri': uri, name: data}
+    json = flask.jsonify(connected)
+    return json
+
+
+def success(message: str = 'completed', **args):
+    result = flask.jsonify({
+        'message': message,
+        **args,
+    })
+    return result, http.HTTPStatus.OK
+
+
+def notfound(message: str):
+    result = flask.jsonify({
+        'error': 'not found',
+        'message': message,
+    })
+    return result, http.HTTPStatus.NOT_FOUND
+
+
+def bad(message: str):
+    result = flask.jsonify({
+        'error': 'bad request',
+        'message': message,
+    })
+    return result, http.HTTPStatus.BAD_REQUEST
+
+
+def internal(message: str):
+    result = flask.jsonify({
+        'error': 'internal',
+        'message': message,
+    })
+    return result, http.HTTPStatus.INTERNAL_SERVER_ERROR
+
+
+def api_call(path):
+    return viewo_helpdesk.config.API_PREFIX + path
+
+
+def valid_user(function):
+
+    @functools.wraps(function)
+    def decorated_function(*args, **kwargs):
+        userid = kwargs['userid']
+        currentuser = flask_login.current_user
+        if not currentuser.is_authenticated:
+            return bad('login required')
+        if not userid and not currentuser.is_admin:
+            return notfound('not accessable')
+        if userid and not currentuser.is_admin:
+            if not viewo_helpdesk.valid_user(userid):
+                return notfound(f'could not locate `{userid}`')
+            if currentuser.get_id() != userid:
+                return notfound('not accessable')
+        return function(*args, **kwargs)
+
+    return decorated_function
+
+
+def valid_dialog(function):
+
+    @functools.wraps(function)
+    def decorated_function(*args, **kwargs):
+        userid = kwargs['userid']
+        date = kwargs['date']
+        if not viewo_helpdesk.valid_dialog(userid, date):
+            return notfound(f'could not locate `{userid}` `{date}`')
+        return function(*args, **kwargs)
+
+    return decorated_function

viewo_helpdesk-1.0.0/viewo_helpdesk/api/auth.py

@@ -0,0 +1,102 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import dataclasses
+import functools
+import http
+
+import flask
+import flask_login
+
+import viewo_helpdesk.api
+import viewo_helpdesk.config
+
+NO_ACCESS = 'LOGIN REQUIRED'
+
+
+@dataclasses.dataclass
+class FlaskUser(flask_login.UserMixin):
+    identifier: str = None
+
+    def get_id(self):
+        return self.identifier
+
+    @property
+    def is_admin(self):
+        return self.identifier == viewo_helpdesk.config.ADMIN_NAME
+
+
+def create_loginmanager(app):
+    loginmanager = flask_login.LoginManager()
+    loginmanager.login_view = 'api_auth.show_login'
+    loginmanager.init_app(app)
+
+    loginmanager._user_callback = load_user  # pylint:disable=W0212
+
+
+def verify_password(user: str, password: str) -> bool:
+    if user == viewo_helpdesk.config.ADMIN_NAME:
+        if password == viewo_helpdesk.config.ADMIN_PASSWORD:
+            return True
+    return False
+
+
+def login(user, password) -> bool:
+    if not verify_password(user, password):
+        return False
+    user = load_user(user)
+    flask_login.login_user(user)
+    return True
+
+
+def load_user(userid):
+    return FlaskUser(identifier=userid)
+
+
+@viewo_helpdesk.api.api_auth.route('/auth')
+def show_login():
+    return NO_ACCESS, http.HTTPStatus.UNAUTHORIZED
+
+
+@viewo_helpdesk.api.api_auth.route('/logout')
+def logout():
+    flask_login.logout_user()
+    return 'DONE'
+
+
+@viewo_helpdesk.api.api_auth.route('/auth', methods=['POST'])
+def check_login():
+    if flask_login.current_user.is_authenticated:
+        return 'DONE'
+
+    user = flask.request.form['user']
+    password = flask.request.form['password']
+
+    # verify
+    if not verify_password(user, password):
+        return 'INVALID PASSWORD', http.HTTPStatus.NOT_FOUND
+
+    # login
+    login(user, password)
+    if flask_login.current_user.is_admin:
+        return flask.jsonify({'link': '/admin/messages/list'})
+    return 'DONE'
+
+
+def admin_required(func):
+
+    @functools.wraps(func)
+    def decorated_view(*args, **kwargs):
+        if not flask_login.current_user.is_authenticated:
+            return flask.current_app.login_manager.unauthorized()
+        if not flask_login.current_user.is_admin:
+            return flask.current_app.login_manager.unauthorized()
+        return func(*args, **kwargs)
+
+    return decorated_view

viewo_helpdesk-1.0.0/viewo_helpdesk/api/delete.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================

viewo_helpdesk-1.0.0/viewo_helpdesk/api/post.py

@@ -0,0 +1,49 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask
+import flask_login
+import utilo
+
+import viewo_helpdesk
+import viewo_helpdesk.api
+
+
+@viewo_helpdesk.api.api_message.route('/dialog/add', methods=['POST'])
+def message_add() -> str:
+    parent = flask.request.form.get('parent', None)
+    userid = flask.request.form.get('userid', None)
+    date = utilo.now()
+    title = flask.request.form.get('title', None)
+    text = flask.request.form.get('text', None)
+    category = flask.request.form.get('category', None)
+
+    new_dialog = parent is None
+    admin = flask_login.current_user.is_admin
+    if not admin:
+        userid = flask_login.current_user.get_id()
+
+    message = viewo_helpdesk.Message(
+        parent=None if new_dialog else parent,
+        userid=userid,
+        date=date,
+        title=title,
+        text=text,
+        writer=userid if not admin else None,
+        category=category,
+    )
+    if new_dialog:
+        viewo_helpdesk.start_conversion(message, current=date)
+    else:
+        viewo_helpdesk.write_message(message, current=date)
+
+    done = {'date': date}
+    uri = viewo_helpdesk.api_call(f'/dialog/{userid}/{date}')
+    dumped = viewo_helpdesk.api.dump(done, name='success', uri=uri)
+    return dumped

viewo_helpdesk-1.0.0/viewo_helpdesk/api/present.py

@@ -0,0 +1,43 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import viewo_helpdesk
+import viewo_helpdesk.api
+import viewo_helpdesk.api.auth
+
+
+@viewo_helpdesk.api.api_message.route(
+    '/dialogs/<string(length=16):userid>',
+    methods=['GET'],
+)
+@viewo_helpdesk.api.valid_user
+def dialogs(userid):
+    result = viewo_helpdesk.load_dialogs(userid)
+    dumped = viewo_helpdesk.api.dump(result, 'dialogs')
+    return dumped
+
+
+@viewo_helpdesk.api.api_message.route('/dialogs', methods=['GET'])
+@viewo_helpdesk.api.auth.admin_required
+def get_dialog():
+    result = viewo_helpdesk.load_dialogs()
+    dumped = viewo_helpdesk.api.dump(result, 'dialogs')
+    return dumped
+
+
+@viewo_helpdesk.api.api_message.route(
+    '/dialog/<string(length=16):userid>/<int:date>',
+    methods=['GET'],
+)
+@viewo_helpdesk.api.valid_user
+@viewo_helpdesk.api.valid_dialog
+def dialog_get(userid: str, date: int):
+    messages = viewo_helpdesk.load_messages(userid, date)
+    dumped = viewo_helpdesk.api.dump(messages, 'messages')
+    return dumped

viewo_helpdesk-1.0.0/viewo_helpdesk/app.py

@@ -0,0 +1,45 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import flask
+import flask_bootstrap
+
+import viewo_helpdesk
+import viewo_helpdesk.api.auth
+import viewo_helpdesk.api.post
+import viewo_helpdesk.api.present
+from viewo_helpdesk.api import api_auth
+from viewo_helpdesk.api import api_message
+from viewo_helpdesk.view import *  # pylint:disable=wildcard-import
+from viewo_helpdesk.view import view_login
+from viewo_helpdesk.view import view_user
+
+
+def create(config=None) -> flask.Flask:
+    appi = flask.Flask(__name__)
+    appi.secret_key = viewo_helpdesk.SECRET_KEY
+
+    viewo_helpdesk.api.auth.create_loginmanager(appi)
+
+    appi.config.setdefault('BOOTSTRAP_SERVE_LOCAL', True)
+    flask_bootstrap.Bootstrap5(app=appi)
+
+    if config:
+        appi.config.update(config)
+
+    # view
+    appi.register_blueprint(view_admin)
+    appi.register_blueprint(view_login)
+    appi.register_blueprint(view_user)
+
+    # api
+    appi.register_blueprint(api_auth, url_prefix=viewo_helpdesk.API_PREFIX)
+    appi.register_blueprint(api_message, url_prefix=viewo_helpdesk.API_PREFIX)
+
+    return appi