module-retour-client-revo 1.0.0__tar.gz

module_retour_client_revo-1.0.0/.gitignore

@@ -0,0 +1,103 @@
+# General #
+.htaccess
+htaccess
+tmp/
+#public/
+logs/
+stderr.log
+.DS_Store
+
+# Django #
+*.log
+*.pot
+*.pyc
+*.db
+__pycache__
+db.sqlite3
+media
+staticfiles
+
+# Backup files #
+*.bak
+
+# If you are using PyCharm #
+*/.idea/*
+.idea
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/gradle.xml
+.idea/**/libraries
+*.iws /out/
+
+# If your are using VSCode #
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+.history/
+*.vsix
+.vscode/
+
+# Python #
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python build/
+develop-eggs/
+downloads/
+eggs/
+.eggs/
+#lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/

module_retour_client_revo-1.0.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: module-retour-client-revo
+Version: 1.0.0
+Summary: Module Django pour la gestion des retours clients et bugs
+Author-email: Revolucy <hello@revolucy.fr>
+License: MIT
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: django-anymail[brevo]>=12.0
+Requires-Dist: django<6.0,>=4.2
+Requires-Dist: requests<3,>=2.31
+Description-Content-Type: text/markdown
+
+# Module de retour Client
+
+## Conception
+
+- [Django](https://www.djangoproject.com/)
+- [Bootstrap](https://getbootstrap.com/)
+- [JQuery 3.5.1](https://api.jquery.com/category/version/3.5/)
+
+## Installation
+
+#### 1 - Ajouter le package dans les requirements
+#### 2 - Ajouter dans votre .env :
+=> Pour la préprod/Prod :<br>
+```html
+#====================================== RETOUR CLIENT =======================================
+EMAIL_CLIENT_RETOUR='test@test.fr'
+SIREN_CLIENT='1245648'
+DATE_MISE_EN_PRODUCTION='2024-12-30'
+DATE_FIN_GARANTIE='2024-12-30'
+```
+
+#### 3 - Ajouter dans votre fichier settings.py :
+```html
+INSTALLED_APPS = [
+    'retour_client',
+]
+```
+```html
+'context_processors': [
+    'retour_client.context_processors.formulaire_retour_client',
+]
+```
+```html
+########### Configuration RETOUR CLIENT.
+EMAIL_CLIENT_RETOUR = env('EMAIL_CLIENT_RETOUR')
+SIREN_CLIENT = env('SIREN_CLIENT')
+DATE_MISE_EN_PRODUCTION = env('DATE_MISE_EN_PRODUCTION')
+DATE_FIN_GARANTIE = env('DATE_FIN_GARANTIE')
+```
+#### 4 - Ajouter dans votre fichier urls.py :
+```html
+ path('retour-client/', include("retour_client.urls")),
+```
+#### 5 - Ajouter dans le footer.html de votre base :
+```html
+<!-- AJOUT POPUP RETOUR CLIENT -->
+{% include 'retour_client.html' %}
+```
+#### 6 - Ajouter un cron journalier 09h00 sur le serveur pour envoi des mails en préprod:
+```html
+Commande : envoi_mail_retour_client_preprod
+```
+
+## Licence
+
+[Revolucy](https://www.revolucy.fr)
+
+## Versionning
+
+- V1.0.0 | Création du module de retour
+
+## Flux
+
+### PREPROD : 
+=> Module de retour visible pour tous les utilisateurs
+
+1 - Création d'un ticket par le client :
+- Enregistrement du ticket sur le site
+- 2 Mails (Client / Chef de projet revo) journalier avec liste des tickets en attente de traitement avec les retours via un Batch
+
+### PRODUCTION - EN PERIODE DE GARANTIE : 
+=> Module de retour visible pour les administrateurs seulement
+=> Affichage du compteur de jours restant de garantie
+
+1 - Création d'un ticket par le client :
+- Enregistrement du ticket sur le site
+- 2 Mails (Client / Chef de projet revo) journalier avec liste des tickets en attente de traitement avec les retours via un Batch
+
+### PRODUCTION - HORS PERIODE DE GARANTIE : 
+=> Module de retour visible pour les administrateurs seulement
+=> Affichage du compteur de nombre de crédit ticket restant
+=> Si moins d’1H de crédit : Ajout d'un lien pour prendre un pack de crédit 5H ou 10H, puis création de la facture associée dans Lucy
+
+1 - Création d'un ticket par le client :
+- Enregistrement du ticket sur le site
+- Mail Chef de projet revo à l'ajout du ticket
+
+2 - Réponse par le chef de projet : 
+- Indication du nombre d'heure passé
+- Déduction du crédit de temps dans Lucy par API
+- Mail Client à l'ajout d'une réponse au ticket
+
+## Déploiement Pypi
+
+1 - pip install build twine<br>
+2 - python -m build<br>
+3 - python -m twine upload dist/*<br>
+4 - Indiquer le token présent dans 1Password

module_retour_client_revo-1.0.0/README.md

@@ -0,0 +1,98 @@
+# Module de retour Client
+
+## Conception
+
+- [Django](https://www.djangoproject.com/)
+- [Bootstrap](https://getbootstrap.com/)
+- [JQuery 3.5.1](https://api.jquery.com/category/version/3.5/)
+
+## Installation
+
+#### 1 - Ajouter le package dans les requirements
+#### 2 - Ajouter dans votre .env :
+=> Pour la préprod/Prod :<br>
+```html
+#====================================== RETOUR CLIENT =======================================
+EMAIL_CLIENT_RETOUR='test@test.fr'
+SIREN_CLIENT='1245648'
+DATE_MISE_EN_PRODUCTION='2024-12-30'
+DATE_FIN_GARANTIE='2024-12-30'
+```
+
+#### 3 - Ajouter dans votre fichier settings.py :
+```html
+INSTALLED_APPS = [
+    'retour_client',
+]
+```
+```html
+'context_processors': [
+    'retour_client.context_processors.formulaire_retour_client',
+]
+```
+```html
+########### Configuration RETOUR CLIENT.
+EMAIL_CLIENT_RETOUR = env('EMAIL_CLIENT_RETOUR')
+SIREN_CLIENT = env('SIREN_CLIENT')
+DATE_MISE_EN_PRODUCTION = env('DATE_MISE_EN_PRODUCTION')
+DATE_FIN_GARANTIE = env('DATE_FIN_GARANTIE')
+```
+#### 4 - Ajouter dans votre fichier urls.py :
+```html
+ path('retour-client/', include("retour_client.urls")),
+```
+#### 5 - Ajouter dans le footer.html de votre base :
+```html
+<!-- AJOUT POPUP RETOUR CLIENT -->
+{% include 'retour_client.html' %}
+```
+#### 6 - Ajouter un cron journalier 09h00 sur le serveur pour envoi des mails en préprod:
+```html
+Commande : envoi_mail_retour_client_preprod
+```
+
+## Licence
+
+[Revolucy](https://www.revolucy.fr)
+
+## Versionning
+
+- V1.0.0 | Création du module de retour
+
+## Flux
+
+### PREPROD : 
+=> Module de retour visible pour tous les utilisateurs
+
+1 - Création d'un ticket par le client :
+- Enregistrement du ticket sur le site
+- 2 Mails (Client / Chef de projet revo) journalier avec liste des tickets en attente de traitement avec les retours via un Batch
+
+### PRODUCTION - EN PERIODE DE GARANTIE : 
+=> Module de retour visible pour les administrateurs seulement
+=> Affichage du compteur de jours restant de garantie
+
+1 - Création d'un ticket par le client :
+- Enregistrement du ticket sur le site
+- 2 Mails (Client / Chef de projet revo) journalier avec liste des tickets en attente de traitement avec les retours via un Batch
+
+### PRODUCTION - HORS PERIODE DE GARANTIE : 
+=> Module de retour visible pour les administrateurs seulement
+=> Affichage du compteur de nombre de crédit ticket restant
+=> Si moins d’1H de crédit : Ajout d'un lien pour prendre un pack de crédit 5H ou 10H, puis création de la facture associée dans Lucy
+
+1 - Création d'un ticket par le client :
+- Enregistrement du ticket sur le site
+- Mail Chef de projet revo à l'ajout du ticket
+
+2 - Réponse par le chef de projet : 
+- Indication du nombre d'heure passé
+- Déduction du crédit de temps dans Lucy par API
+- Mail Client à l'ajout d'une réponse au ticket
+
+## Déploiement Pypi
+
+1 - pip install build twine<br>
+2 - python -m build<br>
+3 - python -m twine upload dist/*<br>
+4 - Indiquer le token présent dans 1Password

module_retour_client_revo-1.0.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling>=1.20"]
+build-backend = "hatchling.build"
+
+[project]
+name = "module-retour-client-revo"
+version = "1.0.0"
+description = "Module Django pour la gestion des retours clients et bugs"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [{name = "Revolucy", email = "hello@revolucy.fr"}]
+
+dependencies = [
+  "Django>=4.2,<6.0",
+  "requests>=2.31,<3",
+  "django-anymail[brevo]>=12.0",
+]
+classifiers = [
+  "Framework :: Django",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["retour_client"]
+include = [
+  "retour_client/templates/**",
+  "retour_client/static/**",
+  "retour_client/migrations/**",
+  "retour_client/management/**",
+]
+
+[tool.hatch.version]
+path = "retour_client/__init__.py"

module_retour_client_revo-1.0.0/retour_client/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

module_retour_client_revo-1.0.0/retour_client/adapters.py

@@ -0,0 +1,35 @@
+from django.conf import settings
+from django.core.mail import EmailMultiAlternatives
+from django.utils import timezone
+
+
+def now_date():
+    return timezone.now().date()
+
+
+def is_user_admin(user):
+    fn = getattr(settings, "RETOUR_CLIENT_IS_ADMIN_FN", None)
+    return fn(user) if fn else bool(getattr(user, "is_staff", False))
+
+
+def get_current_user(request):
+    return getattr(request, "user", None)
+
+
+def image_upload_to(instance, filename):
+    fn = getattr(settings, "RETOUR_CLIENT_IMAGE_UPLOAD_TO", None)
+    return fn(instance, filename) if fn else f"retour_client/{filename}"
+
+
+def send_mail_html(subject, to, body_html):
+    fn = getattr(settings, "RETOUR_CLIENT_SEND_MAIL_FN", None)
+    if fn:
+        return fn(subject, to, body_html)
+    mail = EmailMultiAlternatives(subject, body_html, to=to)
+    mail.attach_alternative(body_html, "text/html")
+    mail.send()
+
+
+def get_lucy_collaborateur_email(siren):
+    fn = getattr(settings, "RETOUR_CLIENT_GET_COLLAB_EMAIL_FN", None)
+    return fn(siren) if fn else None

module_retour_client_revo-1.0.0/retour_client/admin.py

@@ -0,0 +1,14 @@
+from django.contrib import admin
+
+from retour_client.models import RetourClient, ReponseBug
+
+
+class BlockReponseBug(admin.StackedInline):
+    model = ReponseBug
+    extra = 1
+
+
+@admin.register(RetourClient)
+class RetourClientAdmin(admin.ModelAdmin):
+    list_display = ('pk', 'priorite', 'statut', 'description')
+    inlines = [BlockReponseBug]

module_retour_client_revo-1.0.0/retour_client/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class RetourClientConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'retour_client'

module_retour_client_revo-1.0.0/retour_client/constantes.py

@@ -0,0 +1,65 @@
+class RetourClientConstantes:
+    INCONNU = 'Inconnu'
+
+    CRITIQUE = 'C'
+    NORMAL = 'N'
+    NON_URGENT = 'B'
+
+    priorite = [
+        (CRITIQUE, 'Critique'),
+        (NORMAL, 'Normal'),
+        (NON_URGENT, 'Non Urgent'),
+    ]
+
+    EN_ATTENTE = 'A'
+    EN_TRAITEMENT = 'E'
+    TRAITE = 'T'
+    VALIDE = 'V'
+    V2 = 'Z'
+
+    statut = [
+        (EN_ATTENTE, 'En attente'),
+        (EN_TRAITEMENT, 'En cours'),
+        (TRAITE, 'Traité par Revolucy'),
+        (VALIDE, 'Retour validé'),
+        (V2, 'Demande V2'),
+    ]
+
+    statut_client = [
+        (EN_ATTENTE, 'En attente'),
+        (EN_TRAITEMENT, 'En cours'),
+        (TRAITE, 'Traité par Revolucy'),
+        (V2, 'Demande V2'),
+    ]
+
+    NON_CLASSE = 'N'
+    QUESTION = 'Q'
+    BUG = 'B'
+    AMELIORATION = 'A'
+
+    type = [
+        (NON_CLASSE, 'Non classé'),
+        (QUESTION, 'Question'),
+        (BUG, 'Bug'),
+        (AMELIORATION, 'Amélioration'),
+    ]
+
+    STATUS_MAPPING_YT = {
+        'En attente': 'A',
+        'En cours': 'E',
+        'Terminé': 'T',
+    }
+
+    REVOLUCY = 'R'
+    CLIENT = 'C'
+
+    repondant = [
+        (REVOLUCY, 'Revolucy'),
+        (CLIENT, 'Client'),
+    ]
+
+    class Environnement:
+        LOCAL = 'local'
+        RECETTE = 'recette'
+        PREPRODUCTION = 'preproduction'
+        PRODUCTION = 'production'

module_retour_client_revo-1.0.0/retour_client/context_processors.py

@@ -0,0 +1,48 @@
+import logging
+from datetime import datetime
+
+from django.conf import settings
+
+from .constantes import RetourClientConstantes
+from .forms import RetourClientForm
+from .http_utils import safe_get_json
+
+logger = logging.getLogger(__name__)
+
+
+def formulaire_retour_client(request):
+    form_bug = RetourClientForm()
+    jrs_restant_garantie = 0
+    solde_ticket = 0
+    current_user = request.user
+
+    if not request.user.is_anonymous and current_user.email == 'info.marseille@alyseparking.com':
+        siren = settings.SIREN_CLIENT_MARSEILLE
+    else:
+        siren = settings.SIREN_CLIENT
+
+    if (settings.ENVIRONNEMENT == RetourClientConstantes.Environnement.PRODUCTION
+            and not current_user.is_anonymous
+            and getattr(current_user, "is_administrateur", False)):
+
+        jrs_restant_garantie = (
+                datetime.strptime(settings.DATE_FIN_GARANTIE, '%Y-%m-%d').date()
+                - datetime.today().date()
+        ).days
+
+        url = f"https://app.lucy-crm.fr/api/credit-client/{siren}"
+
+        data, err = safe_get_json(url, timeout=(2, 5))  # ≤ ~5 s
+        if data:
+            solde_ticket = data.get("solde_ticket", 0)
+        else:
+            # On loggue mais on NE BLOQUE PAS : on garde solde_ticket=0
+            logger.error(f"[Lucy API] Impossible de récupérer solde_ticket: {err}")
+
+    return {
+        'form_bug': form_bug,
+        'environnement': settings.ENVIRONNEMENT,
+        'siren_client': siren,
+        'jrs_restant_garantie': jrs_restant_garantie,
+        'solde_ticket': solde_ticket,
+    }

module_retour_client_revo-1.0.0/retour_client/forms/__init__.py

@@ -0,0 +1,2 @@
+from .commentaires_bug import ReponseBugForm
+from .retour_client import RetourClientForm

module_retour_client_revo-1.0.0/retour_client/forms/commentaires_bug.py

@@ -0,0 +1,31 @@
+from django import forms
+
+from retour_client.constantes import RetourClientConstantes
+from retour_client.models import ReponseBug
+from retour_client.adapters import is_user_admin
+
+
+class ReponseBugForm(forms.ModelForm):
+    class Meta:
+        model = ReponseBug
+        fields = ["reponse", "repondant", "temps_passe", "piece_jointe"]
+
+    reponse = forms.CharField(
+        widget=forms.Textarea(attrs={"class": "form-control", "rows": 6}),
+        required=True,
+    )
+
+    def __init__(self, *args, **kwargs):
+        # récupère l’utilisateur sans casser l’API Django/admin
+        current_user = kwargs.pop("current_user", None)
+        super().__init__(*args, **kwargs)
+
+        # valeur initiale selon le rôle
+        if current_user and not getattr(current_user, "is_anonymous", False) and is_user_admin(current_user):
+            self.fields["repondant"].initial = RetourClientConstantes.REVOLUCY
+        else:
+            self.fields["repondant"].initial = RetourClientConstantes.CLIENT
+
+    def clean_reponse(self):
+        reponse = self.cleaned_data.get("reponse", "")
+        return reponse.replace("\n", "<br>")

module_retour_client_revo-1.0.0/retour_client/forms/retour_client.py

@@ -0,0 +1,16 @@
+from django import forms
+
+from retour_client.models import RetourClient
+
+
+class RetourClientForm(forms.ModelForm):
+    class Meta:
+        model = RetourClient
+        exclude = ['date_ajout', 'statut', 'utilisateur', 'image', 'navigateur', 'lien_url', 'type']
+
+    description = forms.CharField(widget=forms.Textarea(attrs={'class': 'form-control', 'rows': 6}), required=True)
+
+    def clean_description(self):
+        description = self.cleaned_data.get('description')
+        # Convertit les sauts de ligne en <br> dans la description
+        return description.replace('\n', '<br>')

module_retour_client_revo-1.0.0/retour_client/http_utils.py

@@ -0,0 +1,28 @@
+import requests
+from requests.exceptions import RequestException, Timeout, ConnectionError
+
+DEFAULT_TIMEOUT = (2, 5)  # (connect_timeout, read_timeout) -> total ≤ ~5s
+
+
+def safe_get_json(url, headers=None, timeout=DEFAULT_TIMEOUT):
+    try:
+        r = requests.get(url, headers=headers or {}, timeout=timeout)
+        if r.ok:
+            return r.json(), None
+        return None, f"HTTP {r.status_code}"
+    except (Timeout, ConnectionError) as e:
+        return None, f"timeout/conn error: {e}"
+    except RequestException as e:
+        return None, f"request error: {e}"
+    except ValueError as e:  # JSON decode
+        return None, f"json decode error: {e}"
+
+
+def safe_post_json(url, payload, headers=None, timeout=DEFAULT_TIMEOUT):
+    try:
+        r = requests.post(url, json=payload, headers=headers or {}, timeout=timeout)
+        return r, None
+    except (Timeout, ConnectionError) as e:
+        return None, f"timeout/conn error: {e}"
+    except RequestException as e:
+        return None, f"request error: {e}"

module_retour_client_revo-1.0.0/retour_client/management/commands/envoi_mail_retour_client_preprod.py

@@ -0,0 +1,15 @@
+import logging
+
+from django.core.management import BaseCommand
+
+from retour_client.management.envoi_mail_retour_client_preprod import EnvoiMailRetourClientBatch
+
+logger = logging.getLogger(__name__)
+
+
+class Command(BaseCommand):
+    help = "Envoyer les recap des tickets en cours au client et chef de projet"
+
+    def handle(self, *args, **options):
+        logger.info(f"Lancement de la commande '{self.help}'")
+        EnvoiMailRetourClientBatch.do_process()