Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opt-nc/phonenumber-validator
SDK java permettant de valider et qualifier un numéro de téléphone calédonien.
https://github.com/opt-nc/phonenumber-validator
java mobile-phone new-caledonia nouvelle-caledonie oeuvrerpourtous phone-number phonenumber-validator sdk sdk-java
Last synced: 11 days ago
JSON representation
SDK java permettant de valider et qualifier un numéro de téléphone calédonien.
- Host: GitHub
- URL: https://github.com/opt-nc/phonenumber-validator
- Owner: opt-nc
- License: gpl-3.0
- Created: 2022-07-03T21:19:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-12T03:19:39.000Z (over 1 year ago)
- Last Synced: 2023-06-12T04:24:44.997Z (over 1 year ago)
- Topics: java, mobile-phone, new-caledonia, nouvelle-caledonie, oeuvrerpourtous, phone-number, phonenumber-validator, sdk, sdk-java
- Language: Java
- Homepage: https://dev.to/adriens/series/19561
- Size: 119 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/semantic-release/semantic-release)
[](https://github.com/opt-nc/phonenumber-validator/actions/workflows/maven-build.yml)
[](https://jitpack.io/#opt-nc/phonenumber-validator)
[](https://www.gnu.org/licenses/gpl-3.0)
⚠️ Repository archivé : le sdk a été intégré à [api-phonenumber-validator](https://github.com/opt-nc/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](https://dev.to/adriens/series/19561).
## ⬇️ Import de la dépendance publique
Cette dépendance est disponible publiquement via [Jitpack](https://jitpack.io/#opt-nc/phonenumber-validator).
### 🪶 Maven
Ajouter la repo [Jitpack](https://jitpack.io/) :
```xml
jitpack.io
https://jitpack.io
```
Puis la dépendance :
```xml
com.github.opt-nc
phonenumber-validator
Tag
```
### 🐘 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](https://github.com/opt-nc/phonenumber-validator/blob/main/src/main/java/nc/opt/telecom/sdk/phonenumber/validator/Main.java) du projet.
Pour lancer l'exemple:
```shell
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
```java
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"));
```
```shell
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
```java
String mobilePhoneNumber = PhoneNumberValidator.format("514243");
System.out.println("Numéro de téléphone formaté : " + mobilePhoneNumber);
```
```shell
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](https://github.com/opt-nc/jbang-catalog).
Ce script permet d'utiliser le sdk sous forme de `CLI` [Picocli](https://picocli.info/).
### 👉 Pré-requis
- Installer J'Bang :
- [Tuto complet sur Killercoda](https://killercoda.com/opt-labs/course/jbang)
### 🕹️ Commandes
#### check
Le numéro est-il un numéro de mobile ?
```shell
jbang phonenumber-validator@opt-nc/jbang-catalog -c is-mobile +687832583
```
Le numéro est-il un numéro de fixe
```shell
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)
```shell
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
```shell
jbang phonenumber-validator@opt-nc/jbang-catalog -c is-valid +687832583
```
Avoir les infos du numéro de téléphone
```shell
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
```shell
jbang phonenumber-validator@opt-nc/jbang-catalog -f 83-25-83
```
:warning: Ne pas oublier de refraîchir regulièrement le cache J'Bang!
```shell
jbang cache clear
```
## 🙏 Remerciements
Ce projet a débuté suite à une [idée](https://github.com/orgs/opt-nc/discussions/13) lancée par [@MarketingCollectif ](https://github.com/MarketingCollectif) sur le [forum de discussion de opt-nc](https://github.com/orgs/opt-nc/discussions).
Merci à [@MarketingCollectif ](https://github.com/MarketingCollectif) de nous avoir soumis sa demande, qui nous l'espérons, profitera àu plus grand nombre.