Merge pull request #2 from GeorgianStan/heroku-deployment

Heroku deployment

Author: GeorgianStan

.gitignore

@@ -14,7 +14,6 @@ lerna-debug.log*
 
 .development.env
 .test.env
-.production.env
 
 # OS
 .DS_Store

Procfile

@@ -0,0 +1 @@
+web: npm run start:prod

README.md

@@ -1,3 +1,128 @@
-# Roamnia-UAT-API
+# Romania-UAT-API
 
-Navigate to `/documentation` for more information.
+The project is a web API for the administrative units on the Romanian territory.
+
+## Other linked materials
+
+- [MDRAP-UAT](http://www.dpfbl.mdrap.ro/harta_judete.html)
+- [Coduri Siruta](http://www.123coduri.ro/cauta-in-baza-de-date-coduri-siruta.php?vcodg1=%22%22#nomtop)
+
+# Usage
+
+The API is free to use and it can be found at https://romania-uat-api.herokuapp.com/
+
+Tp access the documentation, navigate to [/documentation](https://romania-uat-api.herokuapp.com/documentation/).
+
+## Rate limit
+
+The current rate limit is set to **200** requests per IP in a **5m** window.
+
+The following headers can be tracked to monitor the usage, if needed.
+
+- `x-ratelimit-limit` - total number of available requests in the defined time period;
+- `x-ratelimit-remaining` - the number of requests remained until the reset time;
+- `x-ratelimit-reset` - the timestamp in seconds when the usage limit will be reset;
+
+## Example usage
+
+The `/api/v1/uat` endpoint can be used for all the required operations.
+This endpoint can query the dataset based on a given [SIRUTA](https://ro.wikipedia.org/wiki/SIRUTA) code or based on the UAT type.
+
+_Example 1_
+
+Get information about **Brasov**.
+
+`https://romania-uat-api.herokuapp.com/api/v1/uat?siruta=83`
+
+```json
+[
+  {
+    "label": "BRASOV",
+    "type": 1,
+    "siruta": 83,
+    "mnemonic": "BV",
+    "sirutaUp": 877
+  }
+]
+```
+
+_Example 2_
+
+Get all the UATs from within **Brasov**.
+
+`https://romania-uat-api.herokuapp.com/api/v1/uat?sirutaUp=83`
+
+```json
+[
+  {
+    "label": "HOLBAV",
+    "type": 5,
+    "siruta": 42472,
+    "sirutaUp": 83
+  },
+  {
+    "label": "MUNICIPIUL BRASOV",
+    "type": 3,
+    "siruta": 40198,
+    "sirutaUp": 83
+  },
+  {
+    "label": "MUNICIPIUL  CODLEA",
+    "type": 3,
+    "siruta": 40241,
+    "sirutaUp": 83
+  },
+  ...
+  ...
+  ...
+]
+```
+
+_Example 3_
+
+Get all the UATs that are of type **JUDET**.
+
+`https://romania-uat-api.herokuapp.com/api/v1/uat?type=1`
+
+```json
+[
+  {
+    "label": "ALBA",
+    "type": 1,
+    "siruta": 10,
+    "mnemonic": "AB",
+    "sirutaUp": 877
+  },
+  {
+    "label": "ARAD",
+    "type": 1,
+    "siruta": 29,
+    "mnemonic": "AR",
+    "sirutaUp": 859
+  },
+  {
+    "label": "ARGES",
+    "type": 1,
+    "siruta": 38,
+    "mnemonic": "AG",
+    "sirutaUp": 831
+  },
+  ...
+  ...
+  ...
+]
+```
+
+# Contributing
+
+Pull requests and stars are always welcome. Please check the guidelines.
+
+# Stay in touch
+
+Author - [Stan Georgian](https://twitter.com/GeorgianStan9)
+
+Discussions - [Discussions Page](https://github.com/GeorgianStan/romania-uat-api/discussions)
+
+# License
+
+This project is licensed under the MIT License.

ReadMe-Developer-Manual.md

@@ -20,42 +20,37 @@ Now `npx` will now use the local `@nestjs/cli` version from `node_modules`.
 
 ## How to run in production
 
-To start the application you need to create a `.production.env` file with the expected variables from `.sample.env`.
-This file is not completely required, but the ENV variables from .sampe.env must be present in this environment.
-
-If `.production.env` exists then the application will use the variables present there istead of those set globally in the `process.env`.
+**Check if `.production.env` exists and it has the expected variables or if the environment variables from .sample.env are all set.**
 
 ```bash
 $ nvm use #optional, but the min version of NodeJS should match the version from .nvmrc
 $ nvm install(optional)
 $ npm ci
-$ npm run build:prod
-$ # set NODE_ENV to production and execute npm run start:prod
+$ npm run build
+$ npm run start:prod
 ```
 
 ## How to run in dev
 
-Same as production, but this time the file name must be `.development.test`
+**Check if `.development.env` exists and it has the expected variables**
 
 1. Switch to node verison >= the one mentioned in `.nvmrc`
 2. Install the dependencies `npm ci` or `npm i`
 3. Run in dev mode `npm run start:dev`
 
 ## How to run debug
 
-Same as development
+**Check if `.development.env` exists and it has the expected variables**
 
 1. Open VSCode
 2. All the settings are in `.vscode/launch.json`, so update them if you thing that is required
 3. In `Run and Debug` panel, choose and run `Debug App`
 
-## Test E2E
-
-For E2E testing the workflow is the same as `development` or `production` in terms of system variables, but this time the file name must be `.test.env`.
-
 ## Other Scripts
 
 `npm run test` - to run all the test files
-`test:e2e` - to run only the E2E tests
-`npm run lint` - to show linting warning or errors
-`npm run lint:fix` - to lint and fix the code
+`npm run lint` - to lint the code
+
+# Data
+
+The UAT data can be found in `data` folder in JSON format.

jest.config.js

@@ -1,7 +1,7 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  testPathIgnorePatterns: ['/node_modules/', '.git', '/dist/'],
+  testPathIgnorePatterns: ['/node_modules/', '.git', 'dist/'],
   moduleNameMapper: {
     'src(.*)$': '<rootDir>/src/$1',
   },

package.json

@@ -1,12 +1,10 @@
 {
   "name": "romania-uat-api",
-  "version": "0.0.1",
-  "description": "",
-  "author": "",
-  "private": true,
-  "license": "UNLICENSED",
+  "version": "1.0.0",
+  "description": "Web API for the administrative units on the Romanian territory",
+  "author": "Stan Georgian",
+  "license": "MIT",
   "scripts": {
-    "prebuild": "rimraf dist",
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "start": "nest start",

src/core/config/config.service.ts

@@ -8,53 +8,33 @@ import { readFileSync, existsSync } from 'fs';
 
 @Injectable()
 export class ConfigService {
-  #envPath: any;
-
-  #nodeEnv: string = process.env.NODE_ENV
+  private envPath: any;
+  private readonly nodeEnv: string = process.env.NODE_ENV
     ? process.env.NODE_ENV.trim()
     : undefined;
 
-  #envConfig: { [key: string]: string };
-
-  /**
-   * * The .env file may be optional, but the ENV variables are required
-   * ? This function will check if all the variables from .sample.env are present
-   */
-  #validateConfigVariables = () => {
-    const pathToSampleFile = resolve(process.cwd(), '.sample.env');
-    const requiredEnvVars: any = Object.keys(
-      parse(readFileSync(pathToSampleFile)),
-    );
-
-    requiredEnvVars.forEach((envKey: string) => {
-      if (this.get(envKey) === undefined) {
-        throw new Error(`Missing ENV variable ${envKey}`);
-      }
-    });
-  };
-
+  private readonly envConfig: { [key: string]: string };
   constructor() {
-    switch (this.#nodeEnv) {
+    switch (this.nodeEnv) {
       case 'test':
-        this.#envPath = resolve(process.cwd(), '.test.env');
+        this.envPath = resolve(process.cwd(), '.test.env');
         break;
       case 'production':
-        this.#envPath = resolve(process.cwd(), '.production.env');
+        this.envPath = resolve(process.cwd(), '.production.env');
         break;
       case 'development':
-        this.#envPath = resolve(process.cwd(), '.development.env');
+        this.envPath = resolve(process.cwd(), '.development.env');
         break;
       default:
         throw new Error('Specify the NODE_ENV variable');
     }
 
-    this.#envConfig =
-      (existsSync(this.#envPath) && parse(readFileSync(this.#envPath))) || {};
-
-    this.#validateConfigVariables();
+    this.envConfig = existsSync(this.envPath)
+      ? parse(readFileSync(this.envPath))
+      : {};
   }
 
   get(key: string): string {
-    return this.#envConfig[key] || process.env[key];
+    return process.env[key] || this.envConfig[key];
   }
 }

src/core/data/@types/enitity.ts

@@ -17,9 +17,9 @@ export class UAT {
 
   @ApiProperty({
     enum: Object.keys(UATType).filter((_) => !isNaN(Number(_))),
-    description: `The type of the UAT: ${Object.keys(UATType).filter((_) =>
-      isNaN(Number(_)),
-    )}`,
+    description: `The type of the UAT: ${Object.keys(UATType)
+      .filter((uatType) => isNaN(Number(uatType)))
+      .map((uatType) => ` ${uatType}`)}`,
   })
   type: UATType;
 

src/main.ts

@@ -44,7 +44,7 @@ async function bootstrap() {
   app.use(
     rateLimit({
       windowMs: utilsService.stringToMs(
-        configService.get('WINDOWMS_RATE_LIMIT'), // ? a given IP can make a limited number of request in this x time period
+        configService.get('WINDOWMS_RATE_LIMIT'),
       ),
       max: parseInt(configService.get('RATE_LIMIT_MAX_REQ')), // ? limit each IP to x requests per windowMs
     }),
@@ -73,9 +73,7 @@ async function bootstrap() {
   // ? start the server
   await app.listen(configService.get('PORT'), () => {
     console.log(
-      `App up in ${configService.get('NODE_ENV')} at PORT: ${configService.get(
-        'PORT',
-      )}`,
+      `app up in ${process.env.NODE_ENV} at ${configService.get('PORT')}`,
     );
   });
 }

src/modules/api-v1/api-v1.service.ts

@@ -48,7 +48,7 @@ export class ApiV1Service {
       return this.#getUATBySirutaUp(payload.sirutaUp);
     }
 
-    if (payload.type) {
+    if (payload.type !== null || payload.type !== undefined) {
       return this.#getUATByType(payload.type);
     }
   }