Aller au contenu

tilttek/friend-challenges

✅ publié

Des défis de membres, entre amis ou ouverts, avec un lot en points détenu en séquestre et la modération du site.

Ana lance à ses amis le défi de peindre dix figurines en une semaine, pour 100 points. Les points quittent aussitôt son solde et sont détenus pour le lot ; Bea et Cy participent, Dee décline sans qu'Ana en soit avisée ; Bea envoie une photo, Ana l'accepte, et les 100 points vont à Bea. Si personne n'avait relevé le défi à la fin de son examen, les points seraient retournés à Ana, comme lorsqu'elle l'annule avant que quiconque envoie une preuve, ou lorsqu'un modérateur le retire.

Un défi est entre amis, à moins que son créateur l'ouvre à tous les membres. Ses preuves sont jugées par son créateur, par un vote du créateur et des autres participants, ou par un modérateur du site. Un membre signale un défi ou une preuve aux modérateurs, qui le gèlent — son lot reste détenu, rien ne bouge —, le dégèlent, le retirent, ou retirent une preuve. Chaque défi est une machine à états explicite ; chaque mouvement est vérifié, conservé seulement si aucun autre auteur n'en a conservé un autre avant, puis réglé dans le séquestre et annoncé par un événement. Un mouvement envoyé de nouveau ne change rien. Toute heure est en UTC.

C'est une bibliothèque PHP simple. L'application conserve les défis, les amitiés, la modération et les points dans son propre stockage, par quatre ports ; la bibliothèque fournit une implémentation en mémoire de chacun, et un séquestre sur le registre de tilttek/points. Le lot est fait de points, jamais d'argent.

État

PartieÉtat
FriendChallenges : créer, participer, décliner, prouver, approuver, rejeter, annuler, faire expirer, signaler, geler, dégeler, retirer, régler, effacerImplémenté et testé
Challenge : la machine à états, ses limites, et son enregistrement écrit puis relu, vérifiéImplémenté et testé
Contract\PrizeEscrow, avec Escrow\InMemoryPrizeEscrow et Escrow\PointsPrizeEscrow sur tilttek/pointsImplémenté et testé
Contract\ChallengeStore, Contract\Friendship, Contract\Moderation, avec des implémentations en mémoireImplémenté et testé
Event\ChallengeWon et les autres événements, répartis par PSR-14Implémenté et testé
Des exceptions sous une seule interface FriendChallengesExceptionImplémenté et testé

Documentation

DocumentContenu
InstallationLes prérequis, l'installation et le branchement.
UtilisationCréer un défi, y participer, les preuves et leur examen, comment un défi se termine.
SéquestreComment le lot est détenu, payé et rendu, et un séquestre sur tilttek/exchange-bundle.
ModérationLes signalements, le gel, le retrait, et les garde-fous entre amis.
Vie privéeEffacer un membre : il quitte chaque défi, puis un pseudonyme prend sa place.
CélébrationsAnnoncer un défi gagné, avec la célébration du kit PHIL UX.
Points d'extensionLes ports, l'écriture d'un magasin, et les événements.
TestsLes tests de la bibliothèque, ses cibles de fuzzing et ses bancs d'essai.
RéférenceChaque type de la bibliothèque, avec son rôle, et ses exceptions.

Démarrage rapide

use Tilttek\FriendChallenges\ChallengeDraft;
use Tilttek\FriendChallenges\FriendChallenges;
use Tilttek\FriendChallenges\Prize;

$challenges = new FriendChallenges($store, $escrow, $friendship, $moderation, $eventDispatcher);

$challenges->create(new ChallengeDraft('01JD3', 'Paint ten minis in a week', new Prize(100), new DateTimeImmutable('+7 days'), [$bea, $cy]), $ana);
$challenges->join('01JD3', $bea);
$challenges->submitProof('01JD3', 'proof-1', $bea, 'upload:8812');
$challenges->approve('01JD3', 'proof-1', $ana);   // won: Bea receives the 100 points held

Prérequis

PHP 8.5 ou une version plus récente avec mbstring et sodium, phil/resource 0.1, tilttek/points 0.1 ou 0.2, psr/clock, psr/event-dispatcher et symfony/clock.

Contribuer

Les contributions sont les bienvenues sur le monodépôt de PHIL : lisez le guide de contribution et le code de conduite, en anglais. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Tilttek project. Voir LICENSE.