README

   1 ====================================
   2 Gestion des adhésions de Nos oignons
   3 ====================================
   4
   5 Voici une collection de scripts et de bouts de code qui permettent de gérer les
   6 adhésions de Nos oignons conformément aux statuts de l'association.
   7
   8 Base des membres
   9 ================
  10
  11 La base des membres est pensée pour être stockée dans le wiki du conseil
  12 d'administration. Elle est formée d'une série de pages, une par membre.
  13
  14 Cela donne l'aboresence suivante :
  15
  16     Membres
  17     ├── 000000.mdwn
  18     ├── 000001.mdwn
  19     ├── 000002.mdwn
  20     ├── 000003.mdwn
  21     ├── 000004.mdwn
  22     …
  23     └── 000042.mdwn
  24
  25 Chaque page doit ressembler à :
  26
  27     ---
  28     name: Violette Dupuis
  29     address: |
  30       42 rue du Fleuve
  31       12042 Essaiville
  32     email: violette@example.org
  33     joined_on: 2013-05-25
  34     membership_fee_paid_on: 2013-05-25
  35     ---
  36
  37     Violette sait programmer en Ruby, on peut lui demander si on a besoin de
  38     coup de main.
  39
  40 Le début de chaque page est un morceau de [YAML]. Il doit contenir les entrées
  41 suivantes :
  42
  43 =`name`=
  44     Le nom (complet) du membre.
  45
  46 =`address`=
  47     L'adresse postale du membre.
  48
  49 =`email`=
  50     L'adresse email du membre. C'est à cette adresse que seront envoyés les
  51     messages de l'assemblée générale et les rappels de cotisation.
  52
  53 =`joined_on`=
  54     Date d'adhésion à l'association.
  55
  56 =`membership_fee_paid_on`=
  57     Date du paiement de la dernière cotisation.
  58
  59 Le reste de la page peut servir à noter ce qu'on veut.
  60
  61 [YAML]: http://yaml.org/
  62
  63 Scripts
  64 =======
  65
  66 Voici le détail des scripts utilisés. On peut se faire une idée de leurs
  67 fonctionalités respectives en lisant les cas d'utilisation dans les fichiers
  68 `features/*.feature`.
  69
  70 Le chemin vers la racine du clone du wiki du conseil d'amnisitration est
  71 spécifié par la variable d'environnement `NOS_OIGNONS_BOARD_WIKI_PATH`. Si
  72 cette dernière n'est pas spécifiée, les scripts cherchent un répertoire
  73 `Membres` à la racine du Git courant, et si ce n'est pas le cas, dans
  74 le répertoire `wiki-ca` du répertoire parent du Git courant.
  75
  76 `list-email`
  77 ------------
  78
  79 Affiche sur la sortie standard les adresses emails des membres à jour de
  80 cotisation.
  81
  82 `pre-commit-hook`
  83 -----------------
  84
  85 `pre-commit` hook pour Git. Ce dernier est avant tout là pour éviter de pouvoir
  86 enregistrer des informations invalides dans la base des membres depuis Ikiwiki.
  87 Il est nécessaire de le configurer à chaque fois qu'on clone le dépôt du wiki du
  88 C.A. (en faisant un lien symbolique dans `.git/hooks/pre-commit`).
  89
  90 `pre-receive-hook`
  91 ------------------
  92
  93 `pre-receive` hook pour Git. Ce dernier est là pour éviter de pouvoir enregistrer
  94 des informations invalides dans la base des membres. Il doit être configuré dans
  95 le dépôt central du wiki du C.A. (via un lien symbolique dans
  96 `.git/hooks/pre-receive`).
  97
  98 `update-ag-subscribers`
  99 -----------------------
 100
 101 Met à jour la liste des adresses email inscrites à la liste *ag@* par rapport
 102 aux membres à jour de cotisation. À exécuter à travers un *cron*. A besoin de
 103 pouvoir lancer les commandes `list_members`, `add_members` et `remove_members`
 104 via `sudo` sur le compte `list`.
 105
 106 `send-membership-reminders`
 107 ---------------------------
 108
 109 Préviens les membres qu'il faut renouveler leur cotisation.
 110
 111 Le fichier utilisé pour garder la liste des envois déjà effectués est soit
 112 celui indiqué par la variable d'environnement `NOS_OIGNONS_REMINDER_DB`, soit
 113 le fichier `var/reminders.yaml` si la variable est vide.
 114
 115 `send-member-emails-to-advisors`
 116 --------------------------------
 117
 118 Envoie la liste des emails des membres à jour de cotisation au comité
 119 de déontologie.
 120
 121 Ce script a vocation a être executé tous les mois afin que le comité
 122 puisse convoquer une assemblée générale extraordinaire, même en cas de
 123 défaillance du conseil d'administration.
 124
 125 `create-membership-fee-receipt`
 126 -------------------------------
 127
 128 Permet de créer un reçu de cotisation pour les membres en faisant
 129 la demande.
 130
 131 Exemple d'utilisation :
 132
 133     bin/create-membership-fee-receipt 000042 10,00
 134
 135 Cela crééra un reçu pour le membre 000042 pour une cotisation d'un montant
 136 de 10,00€. Le reçu est généré sous forme d'un fichier PDF dans le répertoire
 137 spécifié par la variable d'environnement NOS_OIGNONS_RECEIPTS_DIR (ou le
 138 répertoire `receipts` dans le répertoire courant).
 139
 140 **Il faut créer le répertoire avant utilisation s'il n'existe pas déjà.**
 141
 142 Développement
 143 =============
 144
 145 L'essentiel du code est en Ruby. Les dépendances sont gérées avec Bundler. Les
 146 tests d'intégrations sont faits avec Cucumber.
 147
 148 Installer les paquets Debian qui vont bien (sur Wheezy) :
 149
 150     apt-get install ruby1.9.1 bundler
 151
 152 Pour récupérer les dépendances :
 153
 154     ruby1.9.1 /usr/bin/bundle install --path=vendor/bundle
 155
 156 Déploiement
 157 ===========
 158
 159 Installer les paquets Debian qui vont bien (sur Wheezy) :
 160
 161     apt-get install ruby1.9.1 bundler
 162
 163 Installer les dépendances :
 164
 165     ruby1.9.1 /usr/bin/bundle install --deployment \
 166                                       --without=development \
 167                                       --path=vendor/bundle
 168     chmod -R o+rX vendor/bundle
 169
 170 Il faut donner les droits d'écriture à `wiki-ca` sur le répertoire `var`.
 171
 172 Pour rendre facilement accessible `list-members-emails`, on peut ajouter dans
 173 `/usr/local/bin` un mini script tel que celui-ci :
 174
 175     #!/bin/sh
 176     NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src \
 177         /srv/ikiwiki/wiki-ca/gestion-adh/bin/list-emails
 178
 179 Ne pas oublier de le rendre exécutable.
 180
 181 Pour permettre au script `update-ag-subscribers` de fonctionner, il est
 182 nécessaire de l'autoriser à exécuter certaines commandes de Mailman.
 183 Pour cela, on va créer un fichier dans `/etc/sudoers.d` :
 184
 185     Defaults:wiki-ca !requiretty
 186
 187     Cmnd_Alias AG_MANAGEMENT = /usr/sbin/list_members ag,\
 188                                /usr/sbin/add_members -r - ag,\
 189                                /usr/sbin/remove_members -f - ag
 190
 191     wiki-ca ALL = (list) NOPASSWD: AG_MANAGEMENT
 192
 193 Ensuite, pour exécuter régulièrement les scripts via le *crontab* du compte
 194 `wiki-ca`, il faut y ajouter :
 195
 196     42 * * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/update-ag-subscribers
 197     42 6 * * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/send-membership-reminders
 198     21 0 1 * * BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile NOS_OIGNONS_BOARD_WIKI_PATH=/srv/ikiwiki/wiki-ca/src ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/send-member-emails-to-advisors
 199
 200 Pour installer le `pre-commit` *hook* sur le dépôt utilisé par
 201 Ikiwiki, on met dans `/srv/ikiwiki/wiki-ca/src/.git/hooks/pre-commit` :
 202
 203     if ! BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/pre-commit-hook; then
 204             # Reset changes that do not pass the pre-commit hook to prevent
 205             # wrong changes to lay in the Ikiwiki source directory.
 206             git reset --hard
 207             exit 1
 208     fi
 209
 210 Ne pas oublier de le rendre exécutable.
 211
 212 Pour installer le `pre-receive` *hook* sur le dépôt central, on met dans
 213 `/srv/git/.gitolite/hooks/wiki-ca/hooks/pre-receive` :
 214
 215     #!/bin/sh
 216     BUNDLE_GEMFILE=/srv/ikiwiki/wiki-ca/gestion-adh/Gemfile ruby1.9.1 /srv/ikiwiki/wiki-ca/gestion-adh/bin/pre-receive-hook
 217
 218 Ne pas oublier de le rendre exécutable. Il faut ensuite faire un lien symbolique :
 219
 220     ln -s ../../../.gitolite/hooks/wiki-ca/pre-receive /srv/git/repositories/wiki-ca.git/hooks/pre-receive