Merge pull request #7 from TrustlyInc/DEV

Update main branch

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+### Description
+
+_(Insert pull request description)_
+
+---
+
+### Relevant Commits
+
+_(List of main updates)_
+
+---
+
+### Requirements
+
+_(Please check if your pull request fulfills the following requirements)_
+
+- [ ] Changes were properly tested (attach evidence if applicable)
+- [ ] Repository's code-style/linting compliant
+
+---
+
+### Evidence
+
+_(Insert any evidence related to this pull request. Leave it as **"None"** or **"Not applicable"** if you have nothing to add)_
+
+---
+
+### Additional Information
+
+_(Insert any additional information related to this pull request, as more context or Jira ticket. Leave it as **"None"** or **"Not applicable"** if you have nothing to add)_

.gitignore

@@ -2,6 +2,9 @@
 /dist
 /node_modules
 
+# environment variables file
+.env
+
 # Logs
 logs
 *.log

README.md

@@ -2,7 +2,6 @@
   Alpha Merchant App - Simple Backend
 </p>
 
-
 ## Description
 
 Simple backend to demonstrate how to implement the endpoints to integrate with Trustly.
@@ -19,24 +18,31 @@ $ git clone https://github.com/TrustlyInc/trustly-nestjs-example.git
 ```
 
 ## Configuring Trustly API credentials
-In the `.development.env` file replace environment variables values:
-- ACCESS_ID
-- ACCESS_KEY
-- BASE_URL
+
+Copy the `.env.example` file to a new `.env` file and fill out your environment variables.
 
 ## Install dependencies
+
 ```bash
 # install dependencies
 $ npm install
 ```
 
 ## Running the app
+
 ```bash
 # development
 $ npm run start:dev
 ```
 
 ## Swagger
+
 ```
 http://localhost:8080/api
-```
+```
+
+# Contributing
+
+You can participate in this project by submitting bugs and feature requests in the [Issues](https://github.com/TrustlyInc/trustly-nestjs-example/issues) tab. Please, add [@lukevance](https://github.com/lukevance) as an assignee.
+
+If you are interested in fixing issues and contributing directly to the code base, feel free to open a Pull Request with your changes. Please, make sure to fulfill our [Pull Request Template](https://github.com/TrustlyInc/trustly-nestjs-example/blob/main/.github/pull_request_template.md) and add [@lukevance](https://github.com/lukevance) as code reviewer.

src/Dtos/establish.dto.ts

@@ -46,4 +46,8 @@ export class EstablishDto {
     account: AccountDto;
     @ApiProperty()
     transactionId: any;
-}
+}
+
+export interface EstablishDto {
+  [key: string]: string | object;
+}

src/RequestSignature/request-signature.controller.ts

@@ -1,41 +1,48 @@
-import { Body, Controller, Get, Post, RawBodyRequest, Req } from '@nestjs/common';
+import {
+  Body,
+  Controller,
+  Post,
+  RawBodyRequest,
+  Req,
+  Res,
+} from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
-import { ApiParam, ApiCreatedResponse} from '@nestjs/swagger'
+import { ApiParam, ApiCreatedResponse } from '@nestjs/swagger';
 import { RequestSignatureService } from './request-signature.service';
+import { normalizeEstablishData } from './request-signature.utils';
 import { EstablishDto } from '../Dtos/establish.dto';
-import { CustomerDto } from 'src/Dtos/customer.dto';
-import { AddressDto } from 'src/Dtos/address.dto';
+import { Response } from 'express';
 
 @Controller()
 export class RequestSignatureController {
-  constructor(private readonly requestSignatureService: RequestSignatureService, private readonly configService: ConfigService) {}
+  constructor(
+    private readonly requestSignatureService: RequestSignatureService,
+    private readonly configService: ConfigService
+  ) {}
 
-  ACCESS_KEY = this.configService.get<String>('ACCESS_KEY')
+  ACCESS_KEY = this.configService.get<String>('ACCESS_KEY');
 
   @Post('/signature')
-  @ApiParam({name: 'establish', required: true, schema: new EstablishDto() })
+  @ApiParam({ name: 'establish', required: true, schema: new EstablishDto() })
   @ApiCreatedResponse({
     type: String,
   })
-  createRequestSignature(@Body() establish: EstablishDto, @Req() req: RawBodyRequest<Request>): string {
-      let rawBody = req.rawBody;
+  createRequestSignature(
+    @Body() establish: EstablishDto,
+    @Req() req: RawBodyRequest<Request>,
+    @Res() res: Response
+  ): object {
+    const rawBody = req.rawBody;
 
-      if (rawBody){
-        let json = JSON.parse(rawBody.toString());
+    if (rawBody) {
+      establish = normalizeEstablishData(establish, rawBody);
+    }
 
-        if(json['customer.name']){
-          let address = new AddressDto();
-          address.country = json['customer.address.country'];
-
-          let customer = new CustomerDto();
-          customer.name = json['customer.name'];
-          customer.address = address;
-
-          establish.customer = customer;
-        }
-
-      }
-
-    return this.requestSignatureService.getRequestSignature(establish, this.ACCESS_KEY as string);
+    return res.json(
+      this.requestSignatureService.getRequestSignature(
+        establish,
+        this.ACCESS_KEY as string
+      )
+    );
   }
-}
+}

src/RequestSignature/request-signature.utils.spec.ts

@@ -0,0 +1,21 @@
+import { EstablishDto } from '../Dtos/establish.dto';
+import { normalizeEstablishData } from './request-signature.utils';
+
+describe('normalizeEstablishData', () => {
+  test('converts dot notation into nested object', () => {
+    const dotNotationExample = { 'customer.address.country': 'US' };
+    const nestedObjectExpectation = {
+      customer: { address: { country: 'US' } },
+    };
+
+    const establish = {
+      ...new EstablishDto(),
+      ...dotNotationExample,
+    };
+    const rawBody = Buffer.from(JSON.stringify(dotNotationExample), 'utf-8');
+
+    const result = normalizeEstablishData(establish, rawBody);
+
+    expect(result).toEqual(nestedObjectExpectation);
+  });
+});

src/RequestSignature/request-signature.utils.ts

@@ -1,4 +1,5 @@
 import { EstablishDto } from '../Dtos/establish.dto';
+import { convertDotNotationIntoNestedObject } from '../utils/normalize';
 
 const CryptoSignature = require('crypto');
 
@@ -72,4 +73,23 @@ export const generateSignature = (establishData: EstablishDto, accessKey: string
 
     const requestSignature = CryptoSignature.createHmac('sha1', accessKey).update(query).digest('base64');
     return requestSignature;
-}
+};
+
+export const normalizeEstablishData = (
+  establish: EstablishDto,
+  rawBody: Buffer
+) => {
+  // Remove dot notations
+  for (const key in establish) {
+    if (key.includes('.')) delete establish[key];
+  }
+
+  // Add as nested objects
+  const jsonBody = JSON.parse(rawBody.toString());
+  const objectLiteralBody = convertDotNotationIntoNestedObject(jsonBody);
+  for (const key in objectLiteralBody) {
+    establish[key] = objectLiteralBody[key];
+  }
+
+  return establish;
+};

src/app.module.ts

@@ -9,12 +9,12 @@ import { TransactionModule } from './transaction/transaction.module';
 @Module({
   imports: [
     ConfigModule.forRoot({
-      envFilePath: '.development.env'
+      envFilePath: '.env',
     }),
     ServeStaticModule.forRoot({
       rootPath: join(__dirname, '..', 'client'),
     }),
-    TransactionModule
+    TransactionModule,
   ],
   controllers: [RequestSignatureController],
   providers: [RequestSignatureService],

src/main.ts

@@ -5,6 +5,7 @@ import { AppModule } from './app.module';
 
 async function bootstrap() {
   const app = await NestFactory.create<NestExpressApplication>(AppModule, {
+    cors: true,
     rawBody: true,
   });
 

src/transaction/transaction.module.ts

@@ -1,19 +1,17 @@
 import { Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
-import { HttpModule } from "@nestjs/axios";
+import { HttpModule } from '@nestjs/axios';
 import { TransactionService } from './transaction.service';
 import { TransactionController } from './transaction.controller';
 
 @Module({
-    imports: [
-        ConfigModule.forRoot({
-            envFilePath: '.development.env'
-          }),
-        HttpModule,
-      ],
+  imports: [
+    ConfigModule.forRoot({
+      envFilePath: '.env',
+    }),
+    HttpModule,
+  ],
   controllers: [TransactionController],
   providers: [TransactionService],
 })
-
 export class TransactionModule {}
-

src/utils/normalize.spec.ts

@@ -0,0 +1,41 @@
+import { convertDotNotationIntoNestedObject } from './normalize';
+
+describe('convertDotNotationIntoNestedObject', () => {
+  test('converts dot notation into nested object', () => {
+    const input = {
+      'customer.address.country': 'US',
+      'customer.email': '[email protected]',
+      'customer.name': 'John',
+    };
+
+    const expectedOutput = {
+      customer: {
+        address: {
+          country: 'US',
+        },
+        email: '[email protected]',
+        name: 'John',
+      },
+    };
+
+    const result = convertDotNotationIntoNestedObject(input);
+
+    expect(result).toEqual(expectedOutput);
+  });
+
+  test('returns the same object reference for object literal input', () => {
+    const input = {
+      customer: {
+        address: {
+          country: 'US',
+        },
+        email: '[email protected]',
+        name: 'John',
+      },
+    };
+
+    const result = convertDotNotationIntoNestedObject(input);
+
+    expect(result).toEqual(input);
+  });
+});

src/utils/normalize.ts

@@ -0,0 +1,22 @@
+type NestedObject = { [key: string]: NestedObject | string };
+
+export function convertDotNotationIntoNestedObject(
+  obj: NestedObject
+): NestedObject {
+  const result: NestedObject = {};
+
+  for (const key in obj) {
+    const parts = key.split('.');
+    let current: NestedObject = result;
+
+    for (let i = 0; i < parts.length - 1; i++) {
+      const part = parts[i];
+      current[part] = current[part] || {};
+      current = current[part] as NestedObject;
+    }
+
+    current[parts[parts.length - 1]] = obj[key];
+  }
+
+  return result;
+}