README.md

⚠️ Repository archivé : le sdk a été intégré à api-phonenumber-validator

❔ phonenumber-validator

SDK Java permettant de valider, qualifier un numéro de téléphone calédonien.

👶 Découvrir

Pour mieux comprendre comment est né ce projet, ce qu'il permet et les réalisations qu'il permet, allez sur la série dédiée PhoneNumber Validator sur DEV.to.

⬇️ Import de la dépendance publique

Cette dépendance est disponible publiquement via Jitpack.

🪶 Maven

Ajouter la repo Jitpack :

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

Puis la dépendance :

<dependency>
  <groupId>com.github.opt-nc</groupId>
  <artifactId>phonenumber-validator</artifactId>
  <version>Tag</version>
</dependency>

🐘 Gradle

Ajouter la repo :

allprojects {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}

Puis la dépendance :

dependencies {
  implementation 'com.github.opt-nc:phonenumber-validator:Tag'
}

✍️ Exemples de code

Plusieurs exemples sont disponibles dans la classe Main du projet. Pour lancer l'exemple:

mvn compile exec:java

La classe utilitaire PhoneNumberValidator ne prend en entrée que des chaines de caractères respectant la norme E.164, i.e de la forme "+687123456".

La méthode format, permet de convertir un numéro de téléphone sur 6 digits dans la norme E.164.

Connaitre le type de numéro de téléphone

System.out.println("Type de numéro : " + PhoneNumberValidator.getPhoneType("+687514243").name());
System.out.println("Mobile ? : " + (PhoneNumberValidator.isMobile("+687514243") ? "oui" : "non"));
System.out.println("Fixe ? : " + (PhoneNumberValidator.isFixe("+687514243") ? "oui" : "non"));
System.out.println("Special ? : " + (PhoneNumberValidator.isSpecial("+687514243") ? "oui" : "non"));

Type de numéro : Mobile
Mobile ? : oui
Fixe ? : non
Special ? : non

Formater un numéro de téléphone en respectant la norme E.164

String mobilePhoneNumber = PhoneNumberValidator.format("514243");
System.out.println("Numéro de téléphone formaté : " + mobilePhoneNumber);

Numéro de téléphone formaté : +687514243

🧰 Script J'Bang!

Un script Java est disponible dans le catalogue J'Bang de l'OPT-NC. Ce script permet d'utiliser le sdk sous forme de CLI Picocli.

👉 Pré-requis

• Installer J'Bang :
  • Tuto complet sur Killercoda

🕹️ Commandes

check

Le numéro est-il un numéro de mobile ?

jbang  phonenumber-validator@opt-nc/jbang-catalog -c is-mobile +687832583

Le numéro est-il un numéro de fixe

jbang  phonenumber-validator@opt-nc/jbang-catalog -c is-fixe +687832583

Le numéro est-il un numéro spécial (urgences, services OPT-NC, SOS)

jbang  phonenumber-validator@opt-nc/jbang-catalog -c is-special +68715

Le numéro est-il un numéro de téléphone possible/valide

jbang  phonenumber-validator@opt-nc/jbang-catalog -c is-valid +687832583

Avoir les infos du numéro de téléphone

jbang  phonenumber-validator@opt-nc/jbang-catalog -c info +687832583

format

Formate le numéro de téléphone non formaté en numéro formaté en suivant la norme E.164

jbang  phonenumber-validator@opt-nc/jbang-catalog -f 83-25-83

⚠️ Ne pas oublier de refraîchir regulièrement le cache J'Bang!

jbang cache clear

🙏 Remerciements

Ce projet a débuté suite à une idée lancée par @MarketingCollectif sur le forum de discussion de opt-nc.

Merci à @MarketingCollectif de nous avoir soumis sa demande, qui nous l'espérons, profitera àu plus grand nombre.