rubis/bruno/README.md
ordinarthur 3bad1451a9
All checks were successful
Build & Deploy Web / build-and-deploy (push) Successful in 19s
docs(bruno): collection Billing + endpoints check-in in-app
Nouveau dossier `09-Billing/` avec :
  - folder.bru (overview : plans + flows upgrade/cancel/reactivate)
  - 01 Get subscription : state du plan, caps, grace period, cancel flag
  - 02 Start checkout   : crée une Checkout Session Stripe (Pro/Business
                          × monthly/yearly)
  - 03 Open portal      : Customer Portal pour gérer CB/annulation
  - 04 Reactivate       : annule l'annulation programmée (sans paiement
                          immédiat) — gère le conflit Stripe
                          cancel_at vs cancel_at_period_end

Aussi documenté les endpoints in-app check-in qui manquaient dans Bruno :
  - 03 In-app pending           : liste des factures awaiting_user_confirmation
  - 04 In-app respond paid      : équivalent du lien email "C'est payé"
  - 05 In-app respond pending   : équivalent "Toujours en attente"

README mis à jour avec le parcours étendu (signup → … → billing).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-07 17:25:55 +02:00

3.6 KiB

Rubis API — Collection Bruno

Collection Bruno qui répertorie toutes les routes de l'API et permet de les tester en suivant un parcours réaliste (signup → onboarding → création client → facture → encaissement).

Installation

  1. Installe Bruno : https://www.usebruno.com/downloads
  2. Dans Bruno, Open Collection → sélectionne le dossier bruno/ à la racine du repo.
  3. Sélectionne l'environnement local dans le sélecteur en haut à droite.

Démarrer l'API

pnpm dev:up      # Postgres, Redis, MinIO, Mailpit
pnpm dev:api     # API sur http://localhost:3333

Si la DB est neuve : pnpm -F api exec node ace migration:run

Variables d'environnement

Définies dans environments/local.bru. Les valeurs vides (token, userId, etc.) sont remplies automatiquement par les script:post-response :

Variable Source Utilisée par
baseUrl en dur (http://localhost:3333) toutes
email / password / fullName en dur (login fixture) Signup, Login
token rempli après Signup/Login toutes les routes auth
userId rempli après Signup/Login (info)
organizationId rempli après Signup/Login (info, debug)
clientId rempli après Create client détail/update client, création facture
planSlug en dur (standard-30j) détail/update plan
invoiceId rempli après Create invoice OU Validate draft détail/mark-paid
batchId / draftId remplis après Upload (mock) Get batch / Validate / Skip / Cancel

Parcours recommandé (premier run)

  1. Auth → 01 Signup (récupère un token + crée l'org + provisionne les 4 plans)
  2. Account → 01 Get profile (vérifie l'auth)
  3. Organizations → 02 Update my org (onboarding step 2)
  4. Clients → 04 Create (crée un client, capture clientId)
  5. Plans → 01 List (vérifie les 4 plans pré-fournis)
  6. Invoices → 04 Create (crée une facture liée au client)
  7. Invoices → 05 Get detail (vérifie la timeline)
  8. Invoices → 06 Mark paid (encaisse + bonus rubis)
  9. Organizations → 01 Get my org (vérifie rubisCount incrémenté)
  10. Clients → 02 List with stats (vérifie les compteurs)
  11. Imports → 01 Upload (mock) (capture batchId + draftId)
  12. Imports → 02 Get batch (review des drafts pending)
  13. Imports → 03 Validate draft (transforme le draft en facture)
  14. Checkin → 03 In-app pending (liste les factures awaiting_user_confirmation)
  15. Checkin → 04 In-app respond paid ou 05 In-app respond pending
  16. Billing → 01 Get subscription (state du plan + caps)
  17. Billing → 02 Start checkout (upgrade Pro/Business via Stripe Checkout)
  18. Billing → 03 Open portal (gérer CB / annuler via Stripe Portal)
  19. Billing → 04 Reactivate (annule l'annulation programmée)

Flow refresh (silent re-login)

Une fois Signup ou Login passé, Bruno a stocké le cookie rubis_refresh dans sa cookie jar. Tu peux vider token dans l'env actif (pour simuler une expiration), puis appeler Auth → 04 Refresh : tu reçois un nouveau access token sans devoir re-saisir email/password. C'est ce que le SPA fera silencieusement quand une requête revient en 401.

Reset entre runs

L'email alice@bruno.test est unique en DB → 2e signup retourne 422 email_taken. Pour repartir propre :

docker exec rubis-postgres psql -U rubis -d rubis_dev -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
pnpm -F api exec node ace migration:run

Ou change email dans l'environnement local pour forcer un nouveau signup à chaque run.