SmartSolTech/Touchh
1
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases Wiki Activity

Shelter PMS fully functional

Browse Source
This commit is contained in:
trevor
2024-12-09 16:36:11 +09:00
parent 60eaef5527
commit e76a80fb2f
47 changed files with 665 additions and 909 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
pms_integration/admin.py
View File

@@ -1,14 +1,59 @@
from django.contrib import admin
from .models import PMSConfiguration, PMSIntegrationLog
# Register your models here.
from .manager import PluginLoader
from django.http import HttpResponseRedirect
from django.urls import path
from django.utils.html import format_html
from django.shortcuts import render
from django import forms
from pms_integration.models import PMSConfiguration, PMSIntegrationLog
class PMSConfigurationForm(forms.ModelForm):
class Meta:
model = PMSConfiguration
fields = "__all__"
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
plugins = PluginLoader.load_plugins()
self.fields['plugin_name'].choices = [(plugin, plugin) for plugin in plugins.keys()]
@admin.register(PMSConfiguration)
class PMSConfigurationAdmin(admin.ModelAdmin):
list_display = ('name', 'parser_settings', 'description', 'created_at')
form = PMSConfigurationForm
list_display = ('name', 'plugin_name', 'created_at', 'check_plugins_button')
search_fields = ('name', 'description')
list_filter = ('created_at',)
ordering = ('-created_at',)
def get_urls(self):
"""Добавляем URL для проверки плагинов."""
urls = super().get_urls()
custom_urls = [
path("check-plugins/", self.check_plugins, name="check-plugins"),
]
return custom_urls + urls
def check_plugins(self, request):
"""Проверка и отображение плагинов."""
plugins = PluginLoader.load_plugins()
plugin_details = [
{"name": plugin_name, "doc": plugins[plugin_name].__doc__ or "Нет документации"}
for plugin_name in plugins
]
context = {
"title": "Проверка плагинов",
"plugin_details": plugin_details,
}
return render(request, "admin/check_plugins.html", context)
def check_plugins_button(self, obj):
"""Добавляем кнопку для проверки плагинов."""
return format_html(
'<a class="button" href="{}">Проверить плагины</a>',
"/admin/pms_integration/pmsconfiguration/check-plugins/",
)
check_plugins_button.short_description = "Проверить плагины"
@admin.register(PMSIntegrationLog)
class PMSIntegrationLogAdmin(admin.ModelAdmin):

92
pms_integration/api_client.py Normal file
View File

@@ -0,0 +1,92 @@
import requests
from datetime import datetime
class APIClient:
"""
Универсальный клиент для работы с API PMS.
"""
def __init__(self, base_url, access_token=None, username=None, password=None):
"""
Инициализация API клиента.
:param base_url: Базовый URL API
:param access_token: Токен доступа (если требуется)
:param username: Имя пользователя (если используется basic auth)
:param password: Пароль (если используется basic auth)
"""
self.base_url = base_url
self.access_token = access_token
self.auth = (username, password) if username and password else None
def _build_headers(self):
"""
Создает заголовки для запроса.
:return: Словарь заголовков.
"""
headers = {'Content-Type': 'application/json'}
if self.access_token:
headers['Authorization'] = f'Bearer {self.access_token}'
return headers
def _make_request(self, method, endpoint, params=None, data=None):
"""
Выполняет запрос к API.
:param method: HTTP метод ('GET', 'POST', и т.д.)
:param endpoint: Конечная точка API.
:param params: Параметры строки запроса (для GET).
:param data: Данные для тела запроса (для POST).
:return: Ответ API в формате JSON.
"""
url = f"{self.base_url}{endpoint}"
headers = self._build_headers()
try:
response = requests.request(
method=method,
url=url,
headers=headers,
params=params,
json=data,
auth=self.auth
)
response.raise_for_status() # Генерирует исключение для HTTP ошибок
return response.json()
except requests.exceptions.RequestException as e:
print(f"Ошибка при запросе {method} {url}: {e}")
return None
def get(self, endpoint, params=None):
"""
Выполняет GET запрос.
:param endpoint: Конечная точка API.
:param params: Параметры строки запроса.
:return: Ответ API в формате JSON.
"""
return self._make_request('GET', endpoint, params=params)
def post(self, endpoint, data=None):
"""
Выполняет POST запрос.
:param endpoint: Конечная точка API.
:param data: Данные для тела запроса.
:return: Ответ API в формате JSON.
"""
return self._make_request('POST', endpoint, data=data)
def fetch_reservations(self, endpoint, from_date, to_date, pagination_start=0, pagination_count=50):
"""
Получение данных о бронированиях.
:param endpoint: Конечная точка API для бронирований.
:param from_date: Дата начала в формате 'YYYY-MM-DDTHH:MM:SS'.
:param to_date: Дата окончания в формате 'YYYY-MM-DDTHH:MM:SS'.
:param pagination_start: Начальная точка пагинации.
:param pagination_count: Количество записей для выборки.
:return: Ответ API в формате JSON.
"""
data = {
"from": from_date,
"until": to_date,
"pagination": {"from": pagination_start, "count": pagination_count}
}
return self.post(endpoint, data=data)

13
pms_integration/forms.py Normal file
View File

@@ -0,0 +1,13 @@
from django import forms
from .models import PMSConfiguration
from .manager import PluginLoader
class PMSConfigurationForm(forms.ModelForm):
class Meta:
model = PMSConfiguration
fields = "__all__"
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
plugins = PluginLoader.load_plugins()
self.fields['plugin_name'].choices = [(plugin, plugin) for plugin in plugins.keys()]

58
pms_integration/manager.py
View File

@@ -1,18 +1,14 @@
import importlib
from django.core.exceptions import ObjectDoesNotExist
from hotels.models import Hotel
from .models import PMSIntegrationLog
import os
from pathlib import Path
from plugins.base_plugin import BasePMSPlugin
from django.conf import settings
from .plugins.base_plugin import BasePMSPlugin
from asgiref.sync import sync_to_async
class PluginLoader:
"""
Класс для автоматической загрузки плагинов PMS.
"""
PLUGIN_PATH = Path(__file__).parent / "plugins"
print("Путь к папке плагинов:", PLUGIN_PATH.resolve())
print("Содержимое папки:", list(PLUGIN_PATH.iterdir()))
@staticmethod
def load_plugins():
plugins = {}
@@ -21,19 +17,17 @@ class PluginLoader:
module_name = f"pms_integration.plugins.{file[:-3]}"
try:
module = importlib.import_module(module_name)
# Ищем класс, наследующийся от BasePMSPlugin
for attr in dir(module):
cls = getattr(module, attr)
if isinstance(cls, type) and issubclass(cls, BasePMSPlugin) and cls is not BasePMSPlugin:
plugins[cls.__name__] = cls
print(f"Загружен плагин: {cls.__name__}")
except Exception as e:
print(f"Ошибка загрузки плагина {module_name}: {e}")
print(f"Ошибка при загрузке модуля {module_name}: {e}")
print(f"Итоговый список плагинов: {list(plugins.keys())}")
return plugins
class PMSIntegrationManager:
def __init__(self, hotel_id):
self.hotel_id = hotel_id
@@ -41,28 +35,40 @@ class PMSIntegrationManager:
self.pms_config = None
self.plugin = None
def load_hotel(self):
from hotels.models import Hotel # Импорт здесь, чтобы избежать кругового импорта
self.hotel = Hotel.objects.get(id=self.hotel_id)
async def load_hotel(self):
"""
Загружает данные отеля и PMS конфигурацию.
"""
from hotels.models import Hotel
self.hotel = await sync_to_async(Hotel.objects.select_related("pms").get)(id=self.hotel_id)
self.pms_config = self.hotel.pms
if not self.pms_config:
raise ValueError(f"Отель {self.hotel.name} не связан с PMS системой.")
raise ValueError(f"Отель {self.hotel.name} не имеет связанной PMS конфигурации.")
def load_plugin(self):
"""
Загружает плагин для PMS на основе конфигурации.
"""
plugins = PluginLoader.load_plugins()
if self.pms_config.name not in plugins:
raise ValueError(f"Плагин для PMS {self.pms_config.name} не найден.")
self.plugin = plugins[self.pms_config.name](self.pms_config)
if self.pms_config.plugin_name not in plugins:
raise ValueError(f"Плагин для PMS {self.pms_config.plugin_name} не найден.")
self.plugin = plugins[self.pms_config.plugin_name](self.pms_config)
def fetch_data(self):
"""
Получает данные из PMS с использованием загруженного плагина.
"""
if not self.plugin:
raise ValueError("Плагин не загружен.")
self.load_plugin()
return self.plugin.fetch_data()
def save_log(self, status, message):
from .models import PMSIntegrationLog # Избегаем кругового импорта
PMSIntegrationLog.objects.create(
async def save_log(self, status, message):
"""
Сохраняет запись в лог интеграции.
"""
from .models import PMSIntegrationLog
await sync_to_async(PMSIntegrationLog.objects.create)(
hotel=self.hotel,
status=status,
message=message,
)
)

11
pms_integration/migrations/0001_initial.py
View File

@@ -1,4 +1,4 @@
# Generated by Django 5.1.4 on 2024-12-08 23:48
# Generated by Django 5.1.4 on 2024-12-09 04:50
import django.db.models.deletion
from django.db import migrations, models
@@ -9,7 +9,7 @@ class Migration(migrations.Migration):
initial = True
dependencies = [
('hotels', '0020_alter_userhotel_user'),
('hotels', '__first__'),
]
operations = [
@@ -18,8 +18,11 @@ class Migration(migrations.Migration):
fields=[
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('name', models.CharField(max_length=255, verbose_name='Название PMS')),
('parser_settings', models.JSONField(default=dict, verbose_name='Настройки разбора данных')),
('description', models.TextField(blank=True, null=True, verbose_name='Описание')),
('url', models.URLField(verbose_name='URL API')),
('token', models.CharField(blank=True, max_length=255, null=True, verbose_name='Токен')),
('username', models.CharField(blank=True, max_length=255, null=True, verbose_name='Логин')),
('password', models.CharField(blank=True, max_length=255, null=True, verbose_name='Пароль')),
('plugin_name', models.CharField(max_length=255, verbose_name='Название плагина')),
('created_at', models.DateTimeField(auto_now_add=True, verbose_name='Дата создания')),
],
options={

14
pms_integration/models.py
View File

@@ -1,11 +1,18 @@
from django.db import models
from django.db import models
from django.contrib.auth.models import AbstractUser
class PMSConfiguration(models.Model):
name = models.CharField(max_length=255, verbose_name="Название PMS")
parser_settings = models.JSONField(default=dict, verbose_name="Настройки разбора данных")
description = models.TextField(blank=True, null=True, verbose_name="Описание")
created_at = models.DateTimeField(auto_now_add=True, verbose_name="Дата создания")
url = models.URLField(verbose_name="URL API")
token = models.CharField(max_length=255, blank=True, null=True, verbose_name="Токен")
username = models.CharField(max_length=255, blank=True, null=True, verbose_name="Логин")
password = models.CharField(max_length=255, blank=True, null=True, verbose_name="Пароль")
plugin_name = models.CharField(max_length=255, verbose_name="Название плагина")
created_at = models.DateTimeField(auto_now_add=True, verbose_name="Дата создания") # Добавлено поле
def __str__(self):
return self.name
@@ -15,6 +22,7 @@ class PMSConfiguration(models.Model):
verbose_name_plural = "PMS системы"
class PMSIntegrationLog(models.Model):
hotel = models.ForeignKey(
'hotels.Hotel', # Используем строковую ссылку

59
pms_integration/plugins/base_plugin.py
View File

@@ -1,15 +1,62 @@
from abc import ABC, abstractmethod
class BasePMSPlugin(ABC):
def __init__(self, hotel, pms_config):
self.hotel = hotel
"""
Базовый класс для всех PMS плагинов.
Плагин должен уметь:
- Возвращать данные fetch_data()
- Предоставлять дефолтные parser_settings
- Проходить базовую валидацию (validate_plugin)
"""
def __init__(self, pms_config):
"""
pms_config: объект PMSConfiguration
"""
self.pms_config = pms_config
@abstractmethod
def fetch_and_parse(self):
def _fetch_data(self):
"""
Этот метод должен быть реализован в каждом плагине.
Он должен получать данные из API и возвращать их в нужном формате.
Абстрактный метод для получения данных.
"""
pass
def fetch_data(self):
"""
Обертка для выполнения _fetch_data с возможной дополнительной обработкой.
"""
return self._fetch_data()
@abstractmethod
def get_default_parser_settings(self):
"""
Возвращает словарь/JSON с дефолтными настройками разбора.
Например:
{
"fields_mapping": {
"reservation_id": "id",
"check_in": "from",
"check_out": "until"
},
"conditions": {
"checkInStatus": "Заселен"
}
}
"""
print("get_default_parser_settings. pms_config:", self.pms_config)
return {}
def validate_plugin(self):
"""
Проверка на соответствие требованиям.
Можно проверить наличие методов или полей.
"""
# Например, проверить наличие fetch_data и get_default_parser_settings
required_methods = ["fetch_data", "get_default_parser_settings"]
for m in required_methods:
if not hasattr(self, m):
raise ValueError(f"Плагин {type(self).__name__} не реализует метод {m}.")
# Можно добавить дополнительные проверки
return True

41
pms_integration/plugins/bnovo_pms.py
View File

@@ -3,11 +3,51 @@ from .base_plugin import BasePMSPlugin
class BnovoPMS(BasePMSPlugin):
"""
Плагин для интеграции с Bnovo.
"""
json_schema = {
"type": "object",
"properties": {
"id": {"type": "integer"},
"number": {"type": "integer"},
"roomTypeName": {"type": "string"},
"checkInStatus": {"type": "string"},
"guests": {"type": "array"},
},
"required": ["id", "number", "roomTypeName", "checkInStatus", "guests"]
}
def get_default_parser_settings(self):
"""
Возвращает настройки парсера по умолчанию.
"""
return {
"field_mapping": {
"room_name": "roomNumber",
"check_in": "from",
"check_out": "until",
},
"date_format": "%Y-%m-%dT%H:%M:%S"
}
def fetch_data(self):
response = requests.get(self.pms_config.url, headers={"Authorization": f"Bearer {self.pms_config.token}"})
response.raise_for_status()
data = response.json()
# Проверка структуры
expected_fields = self.pms_config.parser_settings.get("fields_mapping", {})
for field in expected_fields.values():
if field not in data[0]: # Проверяем первую запись
raise ValueError(f"Поле {field} отсутствует в ответе API.")
return data
def fetch_and_parse(self):
response = requests.get(
self.pms_config.url,
headers={"Authorization": f"Bearer {self.pms_config.token}"}
)
self.validate_response(response) # Проверка соответствия структуры
if response.status_code != 200:
raise ValueError(f"Ошибка запроса к PMS Bnovo: {response.text}")
@@ -28,3 +68,4 @@ class BnovoPMS(BasePMSPlugin):
}
reservations.append(reservation)
return reservations

38
pms_integration/plugins/ecvi_pms.py
View File

@@ -2,6 +2,38 @@ from .base_plugin import BasePMSPlugin
class EcviPMS(BasePMSPlugin):
def fetch_and_parse(self):
# Реализация логики для ECVI
pass
"""
Плагин для PMS Shelter.
"""
def fetch_data(self):
print("Fetching data from Ecvi PMS...")
# Реализация метода получения данных из PMS Shelter
response = requests.get(self.pms_config.url, headers={"Authorization": f"Bearer {self.pms_config.token}"})
print("Response status:", response.status_code)
response.raise_for_status()
data = response.json()
print("Number of rooms:", len(data))
return data
json_schema = {
"type": "object",
"properties": {
"id": {"type": "integer"},
"number": {"type": "integer"},
"roomTypeName": {"type": "string"},
"checkInStatus": {"type": "string"},
"guests": {"type": "array"},
},
"required": ["id", "number", "roomTypeName", "checkInStatus", "guests"]
}
def get_default_parser_settings(self):
"""
Возвращает настройки парсера по умолчанию.
"""
return {
"field_mapping": {
"room_name": "roomNumber",
"check_in": "from",
"check_out": "until",
},
"date_format": "%Y-%m-%dT%H:%M:%S"
}

119
pms_integration/plugins/shelter_pms.py
View File

@@ -1,31 +1,100 @@
# pms_integration/plugins/shelter_pms.py
import requests
import json
from datetime import datetime, timedelta
from asgiref.sync import sync_to_async
from .base_plugin import BasePMSPlugin
from hotels.models import Reservation
from hotels.models import Hotel
class ShelterPMSPlugin(BasePMSPlugin):
"""Плагин для интеграции с Shelter PMS."""
def fetch_data(self):
"""Получение данных от Shelter PMS."""
url = self.api_config.url
headers = {"Authorization": f"Bearer {self.api_config.token}"}
response = requests.get(url, headers=headers, timeout=10)
response.raise_for_status()
return response.json()
class Shelter(BasePMSPlugin):
def __init__(self, config):
super().__init__(config)
self.token = config.token
def parse_data(self, raw_data):
"""Обработка данных от Shelter PMS."""
reservations = raw_data.get("reservations", [])
return [
{
"id": res["id"],
"room_number": res["room_number"],
"room_type": res["room_type"],
"check_in": res["check_in"],
"check_out": res["check_out"],
"status": res["status"],
"price": res.get("price"),
def get_default_parser_settings(self):
"""
Возвращает настройки по умолчанию для обработки данных.
"""
return {
"date_format": "%Y-%m-%dT%H:%M:%S",
"timezone": "UTC"
}
def _fetch_data(self):
"""
Выполняет запрос к API PMS для получения данных.
"""
url = 'https://pms.frontdesk24.ru/sheltercloudapi/Reservations/ByFilter'
headers = {
'accept': 'text/plain',
'Authorization': f'Bearer {self.token}',
'Content-Type': 'application/json',
}
from_index = 0
count_per_request = 50
total_count = None
all_items = []
now = datetime.now()
start_date = (now - timedelta(days=60)).strftime('%Y-%m-%dT%H:%M:%SZ')
end_date = (now + timedelta(days=60)).strftime('%Y-%m-%dT%H:%M:%SZ')
while total_count is None or from_index < total_count:
data = {
"from": start_date,
"until": end_date,
"pagination": {
"from": from_index,
"count": count_per_request
}
}
for res in reservations
]
response = requests.post(url, headers=headers, data=json.dumps(data))
if response.status_code == 200:
response_data = response.json()
items = response_data.get("items", [])
all_items.extend(items)
if total_count is None:
total_count = response_data.get("count", 0)
from_index += len(items)
else:
raise ValueError(f'Shelter API Error: {response.status_code}')
return all_items
async def _save_to_db(self, data, hotel_id):
"""
Сохраняет данные о бронированиях в таблицу Reservation.
:param data: Список данных о бронированиях.
:param hotel_id: ID отеля, к которому относятся бронирования.
"""
hotel = await sync_to_async(Hotel.objects.get)(id=hotel_id)
for item in data:
print(f"Данные для сохранения: {item}")
try:
reservation, created = await sync_to_async(Reservation.objects.update_or_create)(
reservation_id=item["id"],
hotel=hotel,
defaults={
"room_number": item.get("roomNumber", ""), # Номер комнаты
"room_type": item.get("roomTypeName", ""), # Тип комнаты
"check_in": datetime.strptime(item["from"], '%Y-%m-%dT%H:%M:%S'), # Дата заезда
"check_out": datetime.strptime(item["until"], '%Y-%m-%dT%H:%M:%S'), # Дата выезда
"status": item.get("checkInStatus", ""), # Статус бронирования
"price": item.get("reservationPrice", 0), # Цена
"discount": item.get("discount", 0), # Скидка
}
)
if created:
print(f"Создана запись: {reservation}")
else:
print(f"Обновлена запись: {reservation}")
except Exception as e:
print(f"Ошибка при сохранении бронирования ID {item['id']}: {e}")

16
pms_integration/templates/admin/check_plugins.html Normal file
View File

@@ -0,0 +1,16 @@
{% extends "admin/base_site.html" %}
{% block content %}
<h1>Проверка доступных плагинов</h1>
<p>Ниже перечислены плагины, доступные в системе:</p>
<ul>
{% for plugin_name in plugins.keys %}
<li>
<strong>{{ plugin_name }}</strong>: {{ plugins[plugin_name].__doc__ }}
</li>
{% endfor %}
</ul>
<p>
<a class="button" href="{% url 'admin:index' %}">Вернуться в админку</a>
</p>
{% endblock %}