Updated google recaptcha module options. Updated readme.

README.md

@@ -2,21 +2,21 @@
 
 The [NestJS](https://docs.nestjs.com/) module to protect your endpoints via [google recaptcha](https://www.google.com/recaptcha/about/).
 
-- [Installation](#Installation)
-- [Configuration](#Configuration)
-- [Usage](#Usage)
-- [Error handling](#ErrorHandling)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+- [Error handling](#error-handling)
 
 Usage example [here](https://github.com/chvarkov/google-recaptcha-example)
 
 
-### Installation <a name="Installation"></a>
+## Installation
 
 ```
 $ npm i @nestlab/google-recaptcha
 ```
 
-### Configuration <a name="Configuration"></a>
+## Configuration
 
 ```typescript
 @Module({
@@ -25,7 +25,7 @@ $ npm i @nestlab/google-recaptcha
             secretKey: process.env.GOOGLE_RECAPTCHA_SECRET_KEY,
             response: req => req.headers.recaptcha,
             skipIf: process.env.NODE_ENV !== 'production',
-            useRecaptchaNet: false,
+            network: GoogleRecaptchaNetwork.Recaptcha,
             agent: null
         })
     ],
@@ -36,13 +36,13 @@ export class AppModule {
 
 **Configuration options**
 
-| Property          | Description |
-|-------------------|-------------|
-| `secretKey`       | **Required.**<br> Type: `string`<br> Google recaptcha secret key |
-| `response`        | **Required.**<br> Type: `(request) => string`<br> Function that returns response (recaptcha token) by request |
-| `skipIf`          | Optional.<br> Type: `boolean` \| `(request) => boolean \| Promise<boolean>` <br> Function that returns true if you allow the request to skip the recaptcha verification. Useful for involing other check methods (e.g. custom privileged API key) or for development or testing |
-| `useRecaptchaNet` | Optional.<br> Type: `boolean`<br> If your server has trouble connecting to https://www.google.com. You can use https://recaptcha.net instead, just set true |
-| `agent`           | Optional.<br> Type: `https.Agent`<br> If you need to use an agent |
+| Property    | Description |
+|-------------|-------------|
+| `secretKey` | **Required.**<br> Type: `string`<br> Google recaptcha secret key |
+| `response`  | **Required.**<br> Type: `(request) => string`<br> Function that returns response (recaptcha token) by request |
+| `skipIf`    | Optional.<br> Type: `boolean` \| `(request) => boolean \| Promise<boolean>` <br> Function that returns true if you allow the request to skip the recaptcha verification. Useful for involing other check methods (e.g. custom privileged API key) or for development or testing |
+| `network`   | Optional.<br> Type: `GoogleRecaptchaNetwork` \| `boolean`<br> Default: `GoogleRecaptchaNetwork.Google` <br> If your server has trouble connecting to https://google.com then you can set networks:<br> `GoogleRecaptchaNetwork.Google` = 'https://www.google.com/recaptcha/api/siteverify'<br>`GoogleRecaptchaNetwork.Recaptcha` = 'https://recaptcha.net/recaptcha/api/siteverify'<br> or set any api url |
+| `agent`     | Optional.<br> Type: `https.Agent`<br> 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.
 
@@ -60,7 +60,7 @@ export class AppModule {
 }
 ```
 
-### Usage <a name="Usage"></a>
+## Usage
 
 Use `@Recaptcha` decorator to protect your endpoints.
 
@@ -107,7 +107,7 @@ export class FeedbackController {
 
 ```
 
-### Error handling <a name="ErrorHandling"></a>
+### Error handling
 
 Google recaptcha guard will throw GoogleRecaptchaException on error.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestlab/google-recaptcha",
-  "version": "1.1.11",
+  "version": "1.2.0",
   "description": "Google recaptcha module for NestJS.",
   "keywords": [
     "nest",

src/enums/google-recaptcha-network.ts

@@ -0,0 +1,4 @@
+export enum GoogleRecaptchaNetwork {
+    Google = 'https://www.google.com/recaptcha/api/siteverify',
+    Recaptcha = 'https://recaptcha.net/recaptcha/api/siteverify',
+}

src/index.ts

@@ -3,4 +3,5 @@ export { GoogleRecaptchaGuard } from './guards/google-recaptcha.guard';
 export { GoogleRecaptchaModule } from './google-recaptcha.module';
 export { GoogleRecaptchaModuleOptions } from './interfaces/google-recaptcha-module-options';
 export { ErrorCode } from './enums/error-code';
+export { GoogleRecaptchaNetwork } from './enums/google-recaptcha-network'
 export { GoogleRecaptchaException } from './exceptions/google-recaptcha.exception';

src/interfaces/google-recaptcha-validator-options.ts

@@ -1,12 +1,15 @@
 import * as https from "https";
+import {GoogleRecaptchaNetwork} from "../enums/google-recaptcha-network";
 
 export interface GoogleRecaptchaValidatorOptions {
     secretKey: string;
     /**
-     * If your server has trouble connecting to https://www.google.com,
-     * set it to `true` to use https://recaptcha.net instead.
+     * If your server has trouble connecting to https://google.com then you can set networks:
+     * GoogleRecaptchaNetwork.Google = 'https://www.google.com/recaptcha/api/siteverify'
+     * GoogleRecaptchaNetwork.Recaptcha = 'https://recaptcha.net/recaptcha/api/siteverify'
+     * or set any api url
      */
-    useRecaptchaNet?: boolean;
+    network?: GoogleRecaptchaNetwork | string;
     /**
      * If your server has trouble connecting to https://www.google.com,
      * you can use an agent (`proxy-agent` or other NPM modules)

src/services/google-recaptcha.validator.ts

@@ -4,11 +4,11 @@ import { RECAPTCHA_OPTIONS } from '../provider.declarations';
 import * as qs from 'querystring';
 import { GoogleRecaptchaValidationResult } from '../interfaces/google-recaptcha-validation-result';
 import { ErrorCode } from '../enums/error-code';
+import { GoogleRecaptchaNetwork } from '../enums/google-recaptcha-network';
 
 @Injectable()
 export class GoogleRecaptchaValidator {
-    private readonly apiUrl = 'https://www.google.com/recaptcha/api/siteverify';
-    private readonly apiUrlUseRecaptchaNet = 'https://recaptcha.net/recaptcha/api/siteverify';
+    private readonly defaultNetwork = GoogleRecaptchaNetwork.Google;
     private readonly headers = {'Content-Type': 'application/x-www-form-urlencoded'};
 
     constructor(private readonly http: HttpService,
@@ -18,7 +18,7 @@ export class GoogleRecaptchaValidator {
     validate(response: string): Promise<GoogleRecaptchaValidationResult> {
         const data = qs.stringify({secret: this.options.secretKey, response});
 
-        const url = this.options.useRecaptchaNet ? this.apiUrlUseRecaptchaNet : this.apiUrl;
+        const url = this.options.network || this.defaultNetwork;
 
         return this.http.post(url, data, {
                 headers: this.headers,

test/google-recaptcha-async-module.spec.ts

@@ -1,9 +1,9 @@
-import { Test } from '@nestjs/testing';
-import { Module } from '@nestjs/common';
-import { GoogleRecaptchaValidator } from '../src/services/google-recaptcha.validator';
-import { GoogleRecaptchaModule } from '../src/google-recaptcha.module';
-import { GoogleRecaptchaModuleOptions } from '../src';
-import { GoogleRecaptchaOptionsFactory } from '../src/interfaces/google-recaptcha-module-options';
+import {Test} from '@nestjs/testing';
+import {Module} from '@nestjs/common';
+import {GoogleRecaptchaValidator} from '../src/services/google-recaptcha.validator';
+import {GoogleRecaptchaModule} from '../src/google-recaptcha.module';
+import {GoogleRecaptchaModuleOptions, GoogleRecaptchaNetwork} from '../src';
+import {GoogleRecaptchaOptionsFactory} from '../src/interfaces/google-recaptcha-module-options';
 
 export class GoogleRecaptchaModuleOptionsFactory implements GoogleRecaptchaOptionsFactory {
     createGoogleRecaptchaOptions(): Promise<GoogleRecaptchaModuleOptions> {
@@ -17,7 +17,7 @@ export class TestConfigService {
             secretKey: 'secret',
             response: req => req.body.recaptcha,
             skipIf: () => true,
-            useRecaptchaNet: false,
+            network: GoogleRecaptchaNetwork.Google,
             agent: null
         };
     }

test/google-recaptcha-module.spec.ts

@@ -1,13 +1,14 @@
-import { Test } from '@nestjs/testing';
-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';
+import {Test} from '@nestjs/testing';
+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', () => {
+    const customNetwork = 'CUSTOM_URL';
     let app: INestApplication;
 
     beforeAll(async () => {
@@ -17,7 +18,7 @@ describe('Google recaptcha module', () => {
                     secretKey: process.env.GOOGLE_RECAPTCHA_SECRET_KEY,
                     response: req => req.headers.authorization,
                     skipIf: () => process.env.NODE_ENV !== 'production',
-                    useRecaptchaNet: true,
+                    network: customNetwork,
                     agent: new Agent({maxFreeSockets: 10}),
                 }),
             ],
@@ -42,7 +43,7 @@ describe('Google recaptcha module', () => {
         const options: GoogleRecaptchaModuleOptions = app.get(RECAPTCHA_OPTIONS);
 
         expect(options).toBeDefined();
-        expect(options.useRecaptchaNet).toBeTruthy();
+        expect(options.network).toBe(customNetwork);
         expect(options.agent).toBeDefined();
         expect(options.agent).toBeInstanceOf(Agent);
         expect(options.agent.maxFreeSockets).toBe(10);