Feature/customers integration test

.github/worflows/ci.yml → .github/workflows/ci.yml

@@ -1,19 +1,19 @@
-name: Node.js CI
+name: CI
 
 on:
   push:
-    branches: [ "master", "master-v2" ]
+    branches: [ "master" ]
   pull_request:
-    branches: [ "*" ]
+    branches: [ "master" ]
 
 jobs:
-  build:
-
+  test:
+    name: Test on Node v${{ matrix.node-version }}
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x, 18.x]
+        node-version: [14.x, 16.x, 18.x, 19.x]
 
     steps:
     - uses: actions/checkout@v3
@@ -22,5 +22,5 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    - run: npm ci
+    - run: npm ci --legacy-peer-deps
     - run: npm test

.github/worflows/publish.yml → .github/workflows/publish.yml

@@ -1,30 +1,20 @@
-name: Node.js Publish Package
+name: Publish to NPM
 
 on:
   release:
     types: [created]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
+  publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: 18
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
+      - run: npm ci --legacy-peer-deps
+      - run: npm run build
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.gitignore

@@ -1,3 +1,6 @@
+# ============= Config e2e =============
+/e2e/e2e.config.ts
+
 # ============= Lint =============
 # Cache eslint
 .eslintcache

CHANGELOG.MD

@@ -1,5 +1,29 @@
 # Releases
 
+## VERSION 2.0.1
+- Added named export to MercadoPago configuration module
+- Modified integration example in readme
+- Adjusted PR template
+- Adjusted gitflow files
+
 ## VERSION 2.0.0
 
-* Search Method implementation
+Release SDK Node Mercado Pago V2
+
+- TypeScript Support ⭐️
+- Type of all requests and all responses
+- Maintained compatibility with Vanilla Javascript
+
+Tests
+- More than 90% coverage of unit tests
+- Documentation
+- Implementation examples from ALL clients
+- Technical Documentation
+- Melhorias no Readme
+- Contribution template
+
+Technical debits
+- Code registration
+- Removal of vulnerable libraries and without recent updates
+- Registration with other Mercado Pago SDKs
+- Individual Request configuration for client

PULL_REQUEST_TEMPLATE.md

@@ -6,22 +6,26 @@
 ### ✅ Checklist:
 
 - [ ] I followed the instructions indicated in [Contribution Guidelines](CONTRIBUTING.md)
+- [ ] I added the changes to CHANGELOG
 - [ ] Added the necessary tests for the code or functionality that I'm working on
 - [ ] I ran the tests and made sure they work
 - [ ] My branch coverage is at least 80%
 - [ ] I verified the style of my code matches the one in the project
 
 ## 🧰 How to reproduce
 
-- Step by step of how to test, specially for bugs.
-- Links of external docs.
+- [ ] Not Apply.
+- [ ] Step by step of how to test, specially for bugs.
+- [ ] Links of external docs.
 
 ## 📸 Screenshots
 
-- Before and after, if it's a fix for a bug.
+- [ ] Not Apply.
+- [ ] Before and after, if it's a fix for a bug.
 
 ## 📄 References
 
-- Links do external documentation
-- Diagrams
-- Useful links
+- [ ] Not Apply.
+- [ ] Links do external documentation.
+- [ ] Diagrams.
+- [ ] Useful links.

README.md

@@ -1,4 +1,4 @@
-![SDK Node MErcado Pago](https://github.com/lucmkz/sdk-nodejs/assets/31546923/84211022-6fc5-4db1-8772-117eca84f2d9)
+![SDK Node Mercado Pago](https://github.com/lucmkz/sdk-nodejs/assets/31546923/84211022-6fc5-4db1-8772-117eca84f2d9)
 
 
 # Mercado Pago SDK for NodeJS
@@ -32,10 +32,10 @@ That's it! Mercado Pago SDK has been successfully installed.
 
 ```javascript
 // Step 1: Import the parts of the module you want to use
-import MercadoPago, { Payment } from 'mercadopago';
+import { MercadoPagoConfig, Payment } from 'mercadopago';
 
 // Step 2: Initialize the client object
-const client = new MercadoPago({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
+const client = new MercadoPagoConfig({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
 
 // Step 3: Initialize the API object
 const payment = new Payment(client);
@@ -56,10 +56,10 @@ payment.create({ body }).then(console.log).catch(console.log);
 
 ### Step 1: Import the parts of the module you want to use
 
-Import `MercadoPago` and API objects from the MercadoPago module. 
+Import `MercadoPagoConfig` and API objects from the MercadoPago module. 
 
 ``` javascript
-import MercadoPago, { Payment } from 'mercadopago';
+import { MercadoPagoConfig, Payment } from 'mercadopago';
 ```
 
 ### Step 2: Initialize the client object
@@ -73,7 +73,7 @@ Initialize the client object, passing the following:
 For example:
 
 ``` javascript
-const client = new MercadoPago({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
+const client = new MercadoPagoConfig({ accessToken: 'access_token', options: { timeout: 5000, idempotencyKey: 'abc' } });
 ```
 
 ### Step 3: Initialize the API object
@@ -103,7 +103,7 @@ const body = {
 
 Use the API object's method to make the request. For example, to make a request to the `/v1/payments` endpoint using the `payment` object:
 
-```
+```javascript
 payment.create({ body }).then(console.log).catch(console.log);
 ```
 

e2e/customer/create.spec.ts

@@ -0,0 +1,86 @@
+import MercadoPago, { Customer } from '@src/index';
+import { config } from '../e2e.config';
+
+describe('IT customer, create', () => {
+	test('should create a client and match response object', async () => {
+		const client = new MercadoPago({ accessToken: config.access_token });
+		const customer = new Customer(client);
+
+		const email = createEmailTestUser();
+
+		const body = {
+			email: email,
+			first_name: 'Jhon',
+			last_name: 'Doe',
+			phone: {
+				area_code: '55',
+				number: '991234567'
+			},
+			identification: {
+				type: 'CPF',
+				number: '12345678900'
+			},
+			default_address: 'Home',
+			address: {
+				id: '123123',
+				zip_code: '25065172',
+				street_name: 'Rua Exemplo',
+				street_number: 123,
+				city: {}
+			},
+			date_registered: '2023-10-20T11:37:30.000-04:00',
+			description: 'Description del user',
+			default_card: 'None'
+		};
+
+		const createCustomer = await customer.create({ body });
+		expect(createCustomer).toHaveProperty('status', 'active');
+		expect(createCustomer).toEqual(expect.objectContaining({
+			email: email,
+			first_name: 'Jhon',
+			last_name: 'Doe',
+			date_registered: '2023-10-20T11:37:30.000-04:00',
+			description: 'Description del user',
+		}));
+		expect(createCustomer).toHaveProperty('phone', expect.objectContaining({
+			area_code: '55',
+			number: '991234567'
+		}));
+		expect(createCustomer).toHaveProperty('identification', expect.objectContaining({
+			type: 'CPF',
+			number: '12345678900'
+		}));
+		expect(createCustomer).toHaveProperty('address', expect.objectContaining({
+			zip_code: '25065172',
+			street_name: 'Rua Exemplo',
+			street_number: 123,
+		}));
+		expect(createCustomer).toEqual(expect.objectContaining({
+			id: expect.any(String),
+			email: expect.any(String),
+			first_name: expect.any(String),
+			last_name: expect.any(String),
+			phone: expect.any(Object),
+			identification: expect.any(Object),
+			default_address: expect.any(String),
+			address: expect.any(Object),
+			date_registered: expect.any(String),
+			date_created: expect.any(String),
+			date_last_updated: expect.any(String),
+			description: expect.any(String),
+			user_id: expect.any(Number),
+			merchant_id: expect.any(Number),
+			client_id: expect.any(Number),
+			status: expect.any(String),
+		}));
+
+		const removeCustomer = await customer.remove({ customerId: createCustomer.id });
+		expect(removeCustomer).toHaveProperty('id', removeCustomer.id);
+	});
+
+	function createEmailTestUser() {
+		const random = Math.floor(Math.random() * 1000000);
+		const email = 'test_user' + random + '@testuser.com';
+		return email;
+	}
+});

e2e/customer/get.spec.ts

@@ -0,0 +1,32 @@
+import MercadoPago, { Customer } from '@src/index';
+import { config } from '../e2e.config';
+
+describe('IT customer, get', () => {
+	test('should get a client and match response object', async () => {
+		const client = new MercadoPago({ accessToken: config.access_token });
+		const customer = new Customer(client);
+
+		const email = createEmailTestUser();
+
+		const body = {
+			email: email,
+		};
+
+		const createCustomer = await customer.create({ body });
+		expect(createCustomer).toHaveProperty('id');
+
+		const customerGet = await customer.get({ customerId: createCustomer.id });
+
+		expect(customerGet).toHaveProperty('id', createCustomer.id);
+		expect(customerGet).toHaveProperty('email', body.email);
+
+		const removeCustomer = await customer.remove({ customerId: customerGet.id });
+		expect(removeCustomer).toHaveProperty('id', removeCustomer.id);
+	});
+
+	function createEmailTestUser() {
+		const random = Math.floor(Math.random() * 1000000);
+		const email = 'test_user' + random + '@testuser.com';
+		return email;
+	}
+});

e2e/customer/remove.spec.ts

@@ -0,0 +1,41 @@
+import MercadoPago, { Customer } from '@src/index';
+import { config } from '../e2e.config';
+
+describe('IT customer, remove', () => {
+	test('should delete a customer and match response object', async () => {
+		const client = new MercadoPago({ accessToken: config.access_token });
+		const customer = new Customer(client);
+
+		const email = createEmailTestUser();
+
+		const body = {
+			email: email,
+		};
+
+		const createCustomer = await customer.create({ body });
+		expect(createCustomer).toHaveProperty('id');
+
+		const customerRemove = await customer.remove({ customerId: createCustomer.id });
+		expect(customerRemove).toHaveProperty('id', createCustomer.id);
+		expect(customerRemove).toHaveProperty('status', 'deactive');
+		expect(customerRemove).toEqual(expect.objectContaining({
+			id: expect.any(String),
+			email: expect.any(String),
+			user_id: expect.any(Number),
+			merchant_id: expect.any(Number),
+			client_id: expect.any(Number),
+			status: expect.any(String),
+			phone: expect.any(Object),
+			identification: expect.any(Object),
+			address: expect.any(Object),
+			date_last_updated: expect.any(String),
+		}));
+
+	});
+
+	function createEmailTestUser() {
+		const random = Math.floor(Math.random() * 1000000);
+		const email = 'test_user' + random + '@testuser.com';
+		return email;
+	}
+});

e2e/customer/search.spec.ts

@@ -0,0 +1,21 @@
+import MercadoPago, { Customer } from '@src/index';
+import { config } from '../e2e.config';
+
+describe('IT customer, search', () => {
+	test('should search a client and match response object', async () => {
+		const client = new MercadoPago({ accessToken: config.access_token });
+		const customer = new Customer(client);
+
+		const customerSearch = await customer.search({ options: { email: '[email protected]' } });
+		expect(customerSearch).toHaveProperty('results');
+		expect(customerSearch.results[0]).toHaveProperty('email', '[email protected]');
+		expect(customerSearch.results[0]).toEqual(expect.objectContaining({
+			id: expect.any(String),
+			email: expect.any(String),
+			phone: expect.any(Object),
+			identification: expect.any(Object),
+			address: expect.any(Object),
+			date_last_updated: expect.any(String),
+		}));
+	});
+});