Merge pull request #19 from Theryston/feature/CNH

Feature/cnh

Author: Theryston

README.md

@@ -134,6 +134,48 @@ return:
 }
 ```
 
+## CNH:
+
+CNH is one of the classes that 4devs has, this class is able to generate and validate a CNH based on the services on the pages [https://www.4devs.com.br/validador_cnh](https://www.4devs.com.br/validador_cnh) and [https://www.4devs.com.br/gerador_de_cnh](https://www.4devs.com.br/gerador_de_cnh)
+
+### validate a CNH
+
+```ts
+import { CNH } from '4devs';
+
+const { isValid } = await CNH.validate({
+  cnh: '79973493843',
+});
+```
+
+parameters:
+
+- `cnh` (required) the cnh you want to validate
+
+return:
+
+```ts
+{
+  isValid: boolean;
+}
+```
+
+### generate a new CNH
+
+```ts
+import { CNH } from '4devs';
+
+const { cnh } = await CNH.generate();
+```
+
+return:
+
+```ts
+{
+  cnh: string;
+}
+```
+
 # Footer:
 
 This package is created using the website [https://www.4devs.com.br](https://www.4devs.com.br/). but the site has no responsibility for this content it was made in an open source way and without contacting the site.

__test__/CNH.test.ts

@@ -0,0 +1,23 @@
+import { CNH } from '../lib/index';
+
+const mockCNH = {
+  cnh: '27872004149',
+  isValid: true,
+};
+
+describe('CNH', () => {
+  it('should create an instance', async () => {
+    expect(new CNH()).toBeTruthy();
+  });
+
+  it('should to generate a new CNH', async () => {
+    const { cnh } = await CNH.generate();
+    expect(cnh).toBeTruthy();
+    expect(cnh.length).toBeGreaterThan(10);
+  });
+
+  it('should validate the CNH', async () => {
+    const { isValid } = await CNH.validate({ cnh: mockCNH.cnh });
+    expect(isValid).toBeTruthy();
+  });
+});

lib/index.ts

@@ -1,4 +1,5 @@
 import { Certificates } from './modules/Certificates';
 import { CPF } from './modules/CPF';
+import { CNH } from './modules/CNH';
 
-export { Certificates, CPF };
+export { Certificates, CPF, CNH };

lib/interfaces/ICNH.ts

@@ -0,0 +1,7 @@
+export interface ICNH {
+  cnh: string;
+}
+
+export interface ICNHValid {
+  isValid: boolean;
+}

lib/modules/CNH/GenerateCNH.ts

@@ -0,0 +1,18 @@
+import { ICNH } from '../../interfaces/ICNH';
+import { RequestUtil } from '../../utils/RequestUtil';
+
+export class GenerateCNH {
+  requestUtil = new RequestUtil();
+  async execute(): Promise<ICNH> {
+    const { data: cnh }: { data: string } = await this.requestUtil.post({
+      path: '/ferramentas_online.php',
+      json: {
+        acao: 'gerar_cnh',
+      },
+    });
+
+    return {
+      cnh: cnh,
+    };
+  }
+}

lib/modules/CNH/ValidateCNH.ts

@@ -0,0 +1,20 @@
+import { RequestUtil } from '../../utils/RequestUtil';
+import { ICNHValid } from '../../interfaces/ICNH';
+
+export class ValidateCNH {
+  requestUtil = new RequestUtil();
+  async execute({ cnh }: { cnh: string }): Promise<ICNHValid> {
+    const { data }: { data: string } = await this.requestUtil.post({
+      path: '/ferramentas_online.php',
+      json: {
+        acao: 'validar_cnh',
+        txt_cnh: cnh,
+      },
+    });
+    const isValid = data.toLowerCase().includes('verdadeiro');
+
+    return {
+      isValid,
+    };
+  }
+}

lib/modules/CNH/index.ts

@@ -0,0 +1,14 @@
+import { ICNH, ICNHValid } from 'lib/interfaces/ICNH';
+import { GenerateCNH } from './GenerateCNH';
+import { ValidateCNH } from './ValidateCNH';
+
+export class CNH {
+  public static async validate({ cnh }: { cnh: string }): Promise<ICNHValid> {
+    const validateCNH = new ValidateCNH();
+    return await validateCNH.execute({ cnh });
+  }
+  public static async generate(): Promise<ICNH> {
+    const generate = new GenerateCNH();
+    return generate.execute();
+  }
+}