Added tests, updated readme.

chvarkov · Oct 30, 2020 · 4beebfb · 4beebfb
1 parent aa099cf
commit 4beebfb
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -25,9 +25,6 @@ $ npm i @nestlab/google-recaptcha
             secretKey: process.env.GOOGLE_RECAPTCHA_SECRET_KEY,
             response: req => req.headers.recaptcha,
             skipIf: () => process.env.NODE_ENV !== 'production',
-            // If your server has trouble connecting to https://www.google.com
-            // You can use https://recaptcha.net instead
-            // Or use an agent (see proxy-agent NPM module)
             useRecaptchaNet: false,
             agent: null
         })
@@ -37,6 +34,17 @@ export class AppModule {
 }
 ```
 
+**Configuration options**
+
+| Property          |   | Type                       | Description |
+|-------------------|---|----------------------------|-------------|
+| `secretKey`       | ✔ | string                     | Google recaptcha secret key |
+| `response`        | ✔ | (request) => string        | Function that returns response (recaptcha token) by request |
+| `skipIf`          | ✖ | () => boolean              | Function that returns true if you need skip check for development or testing |
+| `useRecaptchaNet` | ✖ | boolean                    | If your server has trouble connecting to https://www.google.com. You can use https://recaptcha.net instead, just set true |
+| `agent`           | ✖ | https.Agent                | If you need to use an agent |
+
+
 If you want import configs from your [ConfigService](https://docs.nestjs.com/techniques/configuration#getting-started) via [custom getter function](https://docs.nestjs.com/techniques/configuration#custom-getter-functions) that will return `GoogleRecaptchaModuleOptions` object.
 
 ```typescript

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@nestlab/google-recaptcha",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Google recaptcha module for NestJS.",
   "keywords": [
     "nest",

diff --git a/src/services/google-recaptcha.validator.ts b/src/services/google-recaptcha.validator.ts
@@ -18,8 +18,9 @@ export class GoogleRecaptchaValidator {
     validate(response: string): Promise<GoogleRecaptchaValidationResult> {
         const data = qs.stringify({secret: this.options.secretKey, response});
 
-        return this.http.post(
-            this.options.useRecaptchaNet ? this.apiUrlUseRecaptchaNet : this.apiUrl, data, {
+        const url = this.options.useRecaptchaNet ? this.apiUrlUseRecaptchaNet : this.apiUrl;
+
+        return this.http.post(url, data, {
                 headers: this.headers,
                 httpsAgent: this.options.agent
             }

diff --git a/test/google-recaptcha-module.spec.ts b/test/google-recaptcha-module.spec.ts
@@ -3,6 +3,9 @@ import { INestApplication } from '@nestjs/common';
 import { GoogleRecaptchaValidator } from '../src/services/google-recaptcha.validator';
 import { GoogleRecaptchaGuard } from '../src/guards/google-recaptcha.guard';
 import { GoogleRecaptchaModule } from '../src/google-recaptcha.module';
+import { Agent } from 'https';
+import { RECAPTCHA_OPTIONS } from '../src/provider.declarations';
+import { GoogleRecaptchaModuleOptions } from '../src';
 
 describe('Google recaptcha module', () => {
     let app: INestApplication;
@@ -14,9 +17,9 @@ describe('Google recaptcha module', () => {
                     secretKey: process.env.GOOGLE_RECAPTCHA_SECRET_KEY,
                     response: req => req.headers.authorization,
                     skipIf: () => process.env.NODE_ENV !== 'production',
-                    useRecaptchaNet: false,
-                    agent: null
-                })
+                    useRecaptchaNet: true,
+                    agent: new Agent({maxFreeSockets: 10}),
+                }),
             ],
         }).compile();
 
@@ -34,4 +37,14 @@ describe('Google recaptcha module', () => {
 
         expect(guard).toBeInstanceOf(GoogleRecaptchaGuard);
     });
+
+    test('Test use recaptcha net options',  async () => {
+        const options: GoogleRecaptchaModuleOptions = app.get(RECAPTCHA_OPTIONS);
+
+        expect(options).toBeDefined();
+        expect(options.useRecaptchaNet).toBeTruthy();
+        expect(options.agent).toBeDefined();
+        expect(options.agent).toBeInstanceOf(Agent);
+        expect(options.agent.maxFreeSockets).toBe(10);
+    });
 });