From 3001a5ae7f693a67afdf60e2ba5f6e022d794ab4 Mon Sep 17 00:00:00 2001
From: C-Duv <github.accounts@claude.duvergier.fr>
Date: Sun, 5 Feb 2017 03:29:47 +0100
Subject: [PATCH] Apply basic coding standards

This commit does not change script behavior, it only deals with code syntax and
standards:
* Long lines were capped to 80 chars
* Long commands were splited into multiple for improved readability
* Variables are now all using the curly brace syntax
---
 send-notification.sh | 57 +++++++++++++++++++++++++++++++-------------
 1 file changed, 40 insertions(+), 17 deletions(-)

diff --git a/send-notification.sh b/send-notification.sh
index c3a1f35..f352404 100644
--- a/send-notification.sh
+++ b/send-notification.sh
@@ -18,7 +18,8 @@
 ## Configuration système
 ##
 
-# Caractère de fin de ligne (http://en.wikipedia.org/wiki/Percent-encoding#Character_data)
+# Caractère de fin de ligne
+# (http://en.wikipedia.org/wiki/Percent-encoding#Character_data)
 NEWLINE_CHAR="%0D" # Valeurs possibles : %0A, %0D et %0D%0A
 
 # URL d'accès à l'API
@@ -32,10 +33,12 @@ SMSAPI_SEND_ACTION="sendmsg"
 ## Configuration utilisateur
 ##
 
-# Login utilisateur / identifiant Free Mobile (celui utilisé pour accéder à l'Espace Abonné)
+# Login utilisateur / identifiant Free Mobile (celui utilisé pour accéder à
+# l'Espace Abonné)
 USER_LOGIN="1234567890"
 
-# Clé d'identification (générée et fournie par Free Mobile via l'Espace Abonné, "Mes Options" : https://mobile.free.fr/moncompte/index.php?page=options)
+# Clé d'identification (générée et fournie par Free Mobile via l'Espace Abonné,
+# "Mes Options" : https://mobile.free.fr/moncompte/index.php?page=options)
 API_KEY="s0me5eCre74p1K3y"
 
 # Texte qui sera ajouté AVANT chaque message envoyé
@@ -53,45 +56,65 @@ Le serveur de la maison"
 ##
 
 MESSAGE_TO_SEND=""
-if [ "$1" ]; then # Message en tant qu'argument de la ligne de commande
-    MESSAGE_TO_SEND="$1"
+if [ "${1}" ]; then # Message en tant qu'argument de la ligne de commande
+    MESSAGE_TO_SEND="${1}"
 else # Message lu de STDIN
     while read line
     do
-        MESSAGE_TO_SEND="$MESSAGE_TO_SEND$line\n"
+        MESSAGE_TO_SEND="${MESSAGE_TO_SEND}${line}\n"
     done
     MESSAGE_TO_SEND=${MESSAGE_TO_SEND%"\n"} # Retire le dernier saut de ligne
 fi
 
-FINAL_MESSAGE_TO_SEND="$MESSAGE_HEADER$MESSAGE_TO_SEND$MESSAGE_FOOTER" # Assemble header, message et footer
+# Assemble header, message et footer
+FINAL_MESSAGE_TO_SEND="${MESSAGE_HEADER}${MESSAGE_TO_SEND}${MESSAGE_FOOTER}"
 
 ##
 ## Appel à l'API (envoi)
 ##
 
-# echo "Will send the following to $USER_LOGIN:" #DEBUG
-# echo "$FINAL_MESSAGE_TO_SEND" #DEBUG
+# echo "Will send the following to ${USER_LOGIN}:" #DEBUG
+# echo "${FINAL_MESSAGE_TO_SEND}" #DEBUG
 
 # Converts newlines to $NEWLINE_CHAR
-FINAL_MESSAGE_TO_SEND=$(echo -n "$FINAL_MESSAGE_TO_SEND" | sed '{:q;N;s/\n/'$NEWLINE_CHAR'/g;t q}')
+FINAL_MESSAGE_TO_SEND=$(\
+    echo -n "${FINAL_MESSAGE_TO_SEND}" | \
+    sed '{:q;N;s/\n/'${NEWLINE_CHAR}'/g;t q}'\
+)
 # echo "Newline encoded message:" #DEBUG
-# echo "$FINAL_MESSAGE_TO_SEND" #DEBUG
+# echo "${FINAL_MESSAGE_TO_SEND}" #DEBUG
 
-# --insecure : Certificat de $SMSAPI_BASEURL ne fourni pas d'informations sur son propriétaire
-# --write-out "%{http_code}" --silent --output /dev/null : Renvoi le code réponse HTTP uniquement
-HTTP_STATUS_CODE=$(curl --insecure --get "$SMSAPI_BASEURL/$SMSAPI_SEND_ACTION" --data "user=$USER_LOGIN" --data "pass=$API_KEY" --data "msg=$FINAL_MESSAGE_TO_SEND" --write-out "%{http_code}" --silent --output /dev/null)
+# Particularités de l'appel de curl et la/les options associées :
+# * Le certificat de $SMSAPI_BASEURL ne fourni pas d'informations sur son
+#   propriétaire :
+#       --insecure
+# * Renvoi le code réponse HTTP uniquement :
+#       --write-out "%{http_code}" --silent --output /dev/null
+#                                                          
+HTTP_STATUS_CODE=$(\
+    curl \
+        --insecure \
+        --write-out "%{http_code}" \
+        --silent \
+        --output /dev/null \
+        --get "${SMSAPI_BASEURL}/${SMSAPI_SEND_ACTION}" \
+        --data "user=${USER_LOGIN}" \
+        --data "pass=${API_KEY}" \
+        --data "msg=${FINAL_MESSAGE_TO_SEND}" \
+)
 
 # Codes réponse HTTP possibles
 # 200 : Le SMS a été envoyé sur votre mobile.
 # 400 : Un des paramètres obligatoires est manquant.
 # 402 : Trop de SMS ont été envoyés en trop peu de temps.
-# 403 : Le service n'est pas activé sur l'espace abonné, ou login / clé incorrect.
+# 403 : Le service n'est pas activé sur l'espace abonné, ou login / clé
+#       incorrect.
 # 500 : Erreur côté serveur. Veuillez réessayez ultérieurement.
 
-if [ "$HTTP_STATUS_CODE" -eq 200 ]; then
+if [ "${HTTP_STATUS_CODE}" -eq 200 ]; then
     # echo "API responded with 200: exiting with 0" #DEBUG
     exit 0
 else
-    echo "Error: API responded with $HTTP_STATUS_CODE"
+    echo "Error: API responded with ${HTTP_STATUS_CODE}"
     exit 1
 fi