django-yadialogs 0.1.0__tar.gz

django_yadialogs-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+.project
+.pydevproject
+.idea
+.tox
+.venv
+__pycache__
+*.pyc
+*.pyo
+*.egg-info
+*.lock
+site/

django_yadialogs-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2020-2026, Igor `idle sign` Starikov
+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 django-yadialogs 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
+

django_yadialogs-0.1.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.5
+Name: django-yadialogs
+Version: 0.1.0
+Summary: Yandex Dialogs integration for Django
+Project-URL: Homepage, https://github.com/idlesign/django-yadialogs
+Project-URL: Documentation, https://django-yadialogs.readthedocs.io/
+Author-email: Igor Starikov <idlesign@yandex.ru>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: Django,dialogs,yandex
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.10
+Requires-Dist: django-etc>=1.2.0
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# django-yadialogs
+
+<https://github.com/idlesign/django-yadialogs>
+
+[![release](https://img.shields.io/pypi/v/django-yadialogs.svg)](https://pypi.python.org/pypi/django-yadialogs)
+[![lic](https://img.shields.io/pypi/l/django-yadialogs.svg)](https://pypi.python.org/pypi/django-yadialogs)
+[![coverage](https://img.shields.io/coveralls/idlesign/django-yadialogs/master.svg)](https://coveralls.io/r/idlesign/django-yadialogs)
+
+**Work in progress. Stay tuned.**
+
+## Description
+
+*Yandex Dialogs integration for Django*
+
+Here will be an introductory description.
+
+## Documentation
+
+<https://django-yadialogs.readthedocs.io/>

django_yadialogs-0.1.0/README.md

@@ -0,0 +1,19 @@
+# django-yadialogs
+
+<https://github.com/idlesign/django-yadialogs>
+
+[![release](https://img.shields.io/pypi/v/django-yadialogs.svg)](https://pypi.python.org/pypi/django-yadialogs)
+[![lic](https://img.shields.io/pypi/l/django-yadialogs.svg)](https://pypi.python.org/pypi/django-yadialogs)
+[![coverage](https://img.shields.io/coveralls/idlesign/django-yadialogs/master.svg)](https://coveralls.io/r/idlesign/django-yadialogs)
+
+**Work in progress. Stay tuned.**
+
+## Description
+
+*Yandex Dialogs integration for Django*
+
+Here will be an introductory description.
+
+## Documentation
+
+<https://django-yadialogs.readthedocs.io/>

django_yadialogs-0.1.0/pyproject.toml

@@ -0,0 +1,93 @@
+[project]
+name = "django-yadialogs"
+dynamic = ["version"]
+description = "Yandex Dialogs integration for Django"
+authors = [
+    { name = "Igor Starikov", email = "idlesign@yandex.ru" },
+]
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = ["Django", "yandex", "dialogs"]
+dependencies = [
+    "django-etc>=1.2.0",
+    "requests",
+]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Framework :: Django",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "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",
+    "License :: OSI Approved :: BSD License",
+]
+
+[project.urls]
+Homepage = "https://github.com/idlesign/django-yadialogs"
+Documentation = "https://django-yadialogs.readthedocs.io/"
+
+[dependency-groups]
+dev = [
+    { include-group = "docs" },
+    { include-group = "linters" },
+    { include-group = "tests" },
+    { include-group = "runtime" },
+]
+docs = [
+    "mkdocs-apidescribed-plugin",
+    "mkdocs-material",
+    "mkdocs-navsorted-plugin",
+]
+linters = [
+    "ruff==0.13.1",
+]
+tests = [
+    "coverage",
+    "pytest",
+    "pytest-datafixtures",
+    "pytest-djangoapp>=1.6.0",
+    "pytest-responsemock",
+]
+runtime = [
+    "Django>=3.2.9",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/yadialogs/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/yadialogs"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["src/"]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+addopts = "--pyargs"
+
+[tool.coverage.run]
+source = [
+    "src/yadialogs",
+]
+omit = [
+    "src/yadialogs/migrations/*",
+]
+
+[tool.makeapp.tests]
+deps = [
+    "django~=${{ django-version }}.0",
+]

django_yadialogs-0.1.0/src/yadialogs/__init__.py

@@ -0,0 +1,4 @@
+VERSION = '0.1.0'
+
+
+default_app_config = 'yadialogs.apps.YadialogsConfig'

django_yadialogs-0.1.0/src/yadialogs/api.py

@@ -0,0 +1,97 @@
+from pathlib import Path
+from typing import Union, Type, List
+
+from .http import HttpClient
+from .resources.api.assets import Image, Sound
+from .resources.api.status import Status, ImagesInfo, SoundsInfo
+from .settings import API_KEY
+
+
+class _ApiRealm:
+
+    _name: str = ''
+    _asset_cls: Union[Type[Image], Type[Sound]]
+
+    def __init__(self, *, api: 'DialogsApi'):
+        self._api = api
+
+    def _get_url_base(self, *, dialog_id: str) -> str:
+        return f'{self._api._url_base}/skills/{dialog_id}/{self._name}'
+
+    def get_info(self) -> Union[ImagesInfo, SoundsInfo]:
+        """Возвращает информацию о хранилище ресурсов (изображений или звукозаписей)."""
+        return getattr(self._api.get_status(), self._name)
+
+    def upload(self, *, dialog_id: str, fpath: Union[Path, str]):
+        """Загружает указанный файл ресурса (изображения или звукозаписи.)
+
+        :param dialog_id: Идентификатор диалога.
+        :param fpath: Путь до файла.
+
+        """
+        response = self._api._client.upload(self._get_url_base(dialog_id=dialog_id), fpath=fpath)
+        return self._asset_cls(dialog_id=dialog_id, raw=response[self._name.rstrip('s')])
+
+    def list(self, *, dialog_id: str) -> Union[List[Image], List[Sound]]:
+        """Возвращает список с объектами ресурсов (изображений или звукозаписей).
+
+        :param dialog_id: Идентификатор диалога.
+
+        """
+        response = self._api._client.get(self._get_url_base(dialog_id=dialog_id))
+        asset_cls = self._asset_cls
+        return [asset_cls(dialog_id=dialog_id, raw=asset) for asset in response[self._name]]
+
+    def delete(self, *, asset: Union[str, Image, Sound], dialog_id: str = '') -> bool:
+        """Удаляет указанный ресурс.
+
+        :param asset: Объект ресурса или его идентификатор.
+        :param dialog_id: Идентификатор диалога.
+
+        """
+        dialog_id = dialog_id or asset.dialog_id
+        return self._api._client.delete(f'{self._get_url_base(dialog_id=dialog_id)}/{asset}')['result'] == 'ok'
+
+
+class _ImagesApi(_ApiRealm):
+    """Интерфейс для доступа к данным хранилища изображений."""
+
+    _name: str = 'images'
+    _asset_cls: Type[Image] = Image
+
+
+class _SoundsApi(_ApiRealm):
+    """Интерфейс для доступа к данным хранилища звукозаписей."""
+
+    _name: str = 'sounds'
+    _asset_cls: Type[Sound] = Sound
+
+    def get(self, *, dialog_id: str, asset_id: str) -> Union[Image, Sound]:
+        """Возвращает объект ресурса с информацией о нём.
+
+        :param dialog_id: Идентификатор диалога.
+        :param asset_id: Идентификатор ресурса.
+
+        """
+        response = self._api._client.get(f'{self._get_url_base(dialog_id=dialog_id)}/{asset_id}')
+        return self._asset_cls(dialog_id=dialog_id, raw=response[self._name.rstrip('s')])
+
+
+class DialogsApi:
+    """Предоставляет интерфейс для взаимодействия с API Диалогов."""
+
+    _url_base: str = 'https://dialogs.yandex.net/api/v1'
+
+    def __init__(self, *, token: str = ''):
+        self._client = HttpClient(token=token or API_KEY)
+
+        self.images = _ImagesApi(api=self)
+        """Интерфейс для доступа к хранилищу изображений."""
+
+        self.sounds = _SoundsApi(api=self)
+        """Интерфейс для доступа к хранилищу звукозаписей."""
+
+    def get_status(self) -> Status:
+        """Возвращает объект со статусной информацией."""
+        response = self._client.get(f'{self._url_base}/status')
+        return Status(response)

django_yadialogs-0.1.0/src/yadialogs/apps.py

@@ -0,0 +1,14 @@
+from django.apps import AppConfig
+
+
+class YadialogsConfig(AppConfig):
+    """Конфигурация приложения."""
+
+    name = 'yadialogs'
+    verbose_name = 'Яндекс.Диалоги'
+    default_auto_field = 'django.db.models.AutoField'
+
+    def ready(self):
+        """Инициализирует приложение."""
+        from .toolbox import autodiscover_dialogs
+        autodiscover_dialogs()

django_yadialogs-0.1.0/src/yadialogs/dialog.py

@@ -0,0 +1,104 @@
+from typing import Dict, Type, Optional, Union
+
+from django.http import HttpRequest
+
+from .exceptions import HandledRequestException
+from .resources.request import Request, TypeRequestData
+from .resources.response import Response
+
+
+class Dialog:
+    """Base for dialogs."""
+
+    id: str = ''
+    """Identifier given to a dialog after its registration."""
+
+    alias: str = ''
+    """Convenience alias for a dialog."""
+
+    dialogs: Dict[str, Dict[str, Type['Dialog']]] = {
+        'alias': {},
+        'id': {},
+    }
+    """All registered dialogs."""
+
+    verify_id: bool = True
+    """Perform an additional check verifying 
+    that a dialog ID in request matches the dialog ID from this class.
+    """
+
+    debug: bool = False
+
+    def __init__(self, data: dict, *, http_request: HttpRequest):
+        """
+        :param data: Data from Dialogs server.
+        :param http_request: Source Django request object.
+
+        """
+        self.request = Request(raw=data)
+        self.http_request = http_request
+
+    def __init_subclass__(cls):
+
+        super().__init_subclass__()
+
+        if cls.id and cls.alias:
+            cls.dialogs['alias'][cls.alias] = cls
+            cls.dialogs['id'][cls.id] = cls
+
+    @classmethod
+    def handle_request(cls, data: dict, *, http_request: HttpRequest) -> dict:
+        """Handles request from Dialogs server.
+
+        :param data: Data from server.
+        :param http_request: Source Django request object.
+
+        """
+        dialog = cls(data, http_request=http_request)
+
+        try:
+
+            if cls.verify_id and (dialog_id := dialog.request.session.dialog_id) != dialog.id:
+                raise HandledRequestException(
+                    f"Requested dialog ID \"{dialog_id}\" doesn't match the ID from \"{dialog.alias}\"."
+                )
+
+            response = dialog.process(data=dialog.request.data)
+
+            if isinstance(response, str):
+                response = dialog.response_from_request(text=response)
+
+        except HandledRequestException as e:
+            response = dialog.response_for_exception(e)
+
+        return response.serialize()
+
+    @classmethod
+    def get(cls, dialog: str, by_id: bool = False) -> Type['Dialog'] | None:
+        """Get dialog type by its alias or id.
+
+        :param dialog: Dialog alias or id.
+
+        :param by_id: Get by id instead of an alias.
+
+        """
+        return cls.dialogs['id' if by_id else 'alias'].get(dialog)
+
+    def process(self, *, data: TypeRequestData, **kwargs) -> Union[Response, str]:
+        """Should implement server request processing and return a response.
+        Response could be a new Response object
+        or just a string to generate Response object for.
+        """
+        raise HandledRequestException(f'Request processing is not implemented for "{self.alias}" dialog.')
+
+    def response_for_exception(self, e: Exception) -> Response:
+        return Response(f'Error: {e}', end_session=True)
+
+    def response_from_request(self, *, text: str = '', end_session: bool = False) -> Response:
+
+        response = Response(text, end_session=end_session)
+
+        if states := self.request.states:
+            response.states = states
+
+        return response

django_yadialogs-0.1.0/src/yadialogs/exceptions.py

@@ -0,0 +1,7 @@
+
+class YaDialogsException(Exception):
+    """База для исключений yadialogs."""
+
+
+class HandledRequestException(YaDialogsException):
+    """Обработанное исключение для запросов от Диалогов."""

django_yadialogs-0.1.0/src/yadialogs/http.py

@@ -0,0 +1,38 @@
+from pathlib import Path
+from typing import Callable, Union
+
+from requests import Session
+
+from . import VERSION as VERSION_STR
+from .settings import API_TIMEOUT
+
+
+class HttpClient:
+    """Клиент для соверщения HTTP запросов."""
+
+    timeout: int = API_TIMEOUT
+
+    user_agent: str = ''
+
+    def __init__(self, *, token: str):
+        session = Session()
+        session.headers.update({
+            'Authorization': f'OAuth {token}',
+            'User-Agent': f'django-yadialogs/{VERSION_STR}',
+        })
+        self.session = session
+
+    def _request(self, *, method: Callable, url, **kwargs) -> dict:
+        response = method(url, **{'timeout': self.timeout, **kwargs})
+        response.raise_for_status()
+        data = response.json()
+        return data
+
+    def delete(self, url: str) -> dict:
+        return self._request(method=self.session.delete, url=url)
+
+    def upload(self, url: str, *, fpath: Union[Path, str]) -> dict:
+        return self._request(method=self.session.post, url=url, files={'file': Path(fpath).open('rb')})
+
+    def get(self, url: str) -> dict:
+        return self._request(method=self.session.get, url=url)

django_yadialogs-0.1.0/src/yadialogs/migrations/0001_initial.py

@@ -0,0 +1,54 @@
+# Generated by Django 6.1.3 on 2026-11-10 08:13
+
+import django.core.files.storage
+import yadialogs.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Image',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('rid', models.CharField(help_text='Идентификатор ресурса', max_length=50, verbose_name='ID')),
+                ('dt_uploaded', models.DateTimeField(db_column='db_upl', verbose_name='Загружен')),
+                ('status', models.IntegerField(choices=[(1, 'Загружен'), (2, 'Ошибка')], default=1, verbose_name='Статус')),
+                ('status_hint', models.TextField(help_text='Подсказка для состояния.', verbose_name='Подсказка')),
+                ('dialog_alias', models.CharField(db_column='dalias', db_index=True, help_text='Псевдоним диалога', max_length=36, verbose_name='Диалог')),
+                ('alias', models.CharField(default=None, help_text='Краткое имя для удобной адресации ресурса', max_length=50, null=True, unique=True, verbose_name='Псевдоним')),
+                ('group', models.UUIDField(db_column='grp', default=None, help_text='Идентификатор, объединяющий группу ресурсов', null=True, verbose_name='Группа')),
+                ('file', models.FileField(storage=django.core.files.storage.FileSystemStorage(location='/tmp'), upload_to=yadialogs.models.get_upload, verbose_name='Файл')),
+                ('size', models.IntegerField(verbose_name='Размер файла')),
+            ],
+            options={
+                'verbose_name': 'Изображение',
+                'verbose_name_plural': 'Изображения',
+            },
+        ),
+        migrations.CreateModel(
+            name='Sound',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('rid', models.CharField(help_text='Идентификатор ресурса', max_length=50, verbose_name='ID')),
+                ('dt_uploaded', models.DateTimeField(db_column='db_upl', verbose_name='Загружен')),
+                ('status', models.IntegerField(choices=[(1, 'Загружен'), (2, 'Ошибка')], default=1, verbose_name='Статус')),
+                ('status_hint', models.TextField(help_text='Подсказка для состояния.', verbose_name='Подсказка')),
+                ('dialog_alias', models.CharField(db_column='dalias', db_index=True, help_text='Псевдоним диалога', max_length=36, verbose_name='Диалог')),
+                ('alias', models.CharField(default=None, help_text='Краткое имя для удобной адресации ресурса', max_length=50, null=True, unique=True, verbose_name='Псевдоним')),
+                ('group', models.UUIDField(db_column='grp', default=None, help_text='Идентификатор, объединяющий группу ресурсов', null=True, verbose_name='Группа')),
+                ('file', models.FileField(storage=django.core.files.storage.FileSystemStorage(location='/tmp'), upload_to=yadialogs.models.get_upload, verbose_name='Файл')),
+                ('size', models.IntegerField(verbose_name='Размер файла')),
+            ],
+            options={
+                'verbose_name': 'Звук',
+                'verbose_name_plural': 'Звуки',
+            },
+        ),
+    ]

django_yadialogs-0.1.0/src/yadialogs/models.py

@@ -0,0 +1,71 @@
+from django.core.files.storage import FileSystemStorage
+from django.db import models
+
+
+TmpStorage = FileSystemStorage(location='/tmp')
+
+
+def get_upload(instance: 'Asset', filename):
+    return 'some'
+
+
+class Asset(models.Model):
+    """Ресурс. Базовая модель."""
+
+    _api_realm: str = ''
+
+    class Statuses(models.IntegerChoices):
+        """Статусы ресурсов."""
+
+        UPLOADED = 1, 'Загружен'
+        ERROR = 2, 'Ошибка'
+
+    rid = models.CharField('ID', max_length=50, help_text='Идентификатор ресурса')
+
+    dt_uploaded = models.DateTimeField('Загружен', db_column='db_upl')
+
+    status = models.IntegerField('Статус', choices=Statuses.choices, default=Statuses.UPLOADED)
+    status_hint = models.TextField('Подсказка', help_text='Подсказка для состояния.')
+
+    dialog_alias = models.CharField(
+        'Диалог', max_length=36, db_index=True, db_column='dalias',
+        help_text='Псевдоним диалога')
+
+    alias = models.CharField(
+        'Псевдоним', max_length=50, null=True, default=None, unique=True,
+        help_text='Краткое имя для удобной адресации ресурса')
+
+    group = models.UUIDField(
+        'Группа', null=True, default=None, db_column='grp',
+        help_text='Идентификатор, объединяющий группу ресурсов')
+
+    file = models.FileField(
+        'Файл', upload_to=get_upload, storage=TmpStorage)
+
+    size = models.IntegerField('Размер файла')
+
+    class Meta:
+        abstract = True
+
+    def __str__(self):
+        return f'{self.rid} [{self.alias}]'
+
+
+class Image(Asset):
+    """Изображение."""
+
+    _api_realm: str = 'images'
+
+    class Meta:
+        verbose_name = 'Изображение'
+        verbose_name_plural = 'Изображения'
+
+
+class Sound(Asset):
+    """Звукозапись."""
+
+    _api_realm: str = 'sounds'
+
+    class Meta:
+        verbose_name = 'Звук'
+        verbose_name_plural = 'Звуки'

django_yadialogs-0.1.0/src/yadialogs/resources/api/assets.py

@@ -0,0 +1,58 @@
+from typing import TYPE_CHECKING
+
+from django.utils.dateparse import parse_datetime
+
+if TYPE_CHECKING:
+    from datetime import datetime
+
+from ..base import Container
+
+
+class _Asset(Container):
+
+    def __init__(self, *, dialog_id: str, raw: dict):
+
+        super().__init__(raw)
+
+        self.dialog_id = dialog_id
+        """Идентификатор диалога."""
+
+        self.id: str = raw['id']
+        """Идентификатор ресурса."""
+
+        self.size: int = raw['size'] or 0
+        """Размер ресурса, байтов."""
+
+        self.uploaded: datetime = parse_datetime(raw['createdAt'])
+        """Дата и время загрузки ресурса."""
+
+    def __str__(self) -> str:
+        return self.id
+
+
+class Image(_Asset):
+    """Изображение."""
+
+    def __init__(self, *, dialog_id: str, raw: dict):
+
+        super().__init__(dialog_id=dialog_id, raw=raw)
+
+        self.orig_url: str = raw.get('origUrl') or ''
+        """URL изображения (если оно было загружено используя URL)."""
+
+
+class Sound(_Asset):
+    """Звукозапись."""
+
+    def __init__(self, *, dialog_id: str, raw: dict):
+
+        super().__init__(dialog_id=dialog_id, raw=raw)
+
+        self.orig_name: str = raw['originalName']
+        """Оригинальное имя файла."""
+
+        self.is_processed: bool = raw['isProcessed']
+        """Флаг законченности обработки."""
+
+        self.error: str = raw['error'] or ''
+        """Описание ошибки обработки."""