rename type to protocol, url to endpoint (#62)

v-rudkovskiy · web-flow · commit c6975406e44e · 2023-06-05T16:40:56.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/Constants.js b/src/Constants.js
@@ -210,4 +210,15 @@ export default {
         ENDPOINT_PATH: 'bundle',
         ENDPOINT_OBTAIN_PATH: 'obtain',
     },
+
+    Notification: {
+        ENDPOINT_PATH: 'notification',
+        Protocol: {
+            WEBHOOK: 'WEBHOOK',
+        },
+        Event: {
+            CREATE_LICENSEE: 'CREATE_LICENSEE',
+            CREATE_LICENSE: 'CREATE_LICENSE',
+        },
+    },
 };
diff --git a/src/entities/Notification.js b/src/entities/Notification.js
@@ -48,10 +48,10 @@ export default class Notification extends BaseEntity {
                 number: 'string',
                 active: 'boolean',
                 name: 'string',
-                type: 'string',
+                protocol: 'string',
                 events: 'string',
                 payload: 'string',
-                url: 'string',
+                endpoint: 'string',
             },
         });
     }
@@ -80,12 +80,12 @@ export default class Notification extends BaseEntity {
         return this.getProperty('name', def);
     }
 
-    setType(type) {
-        return this.setProperty('type', type);
+    setProtocol(type) {
+        return this.setProperty('protocol', type);
     }
 
-    getType(def) {
-        return this.getProperty('type', def);
+    getProtocol(def) {
+        return this.getProperty('protocol', def);
     }
 
     setEvents(events) {
@@ -104,11 +104,11 @@ export default class Notification extends BaseEntity {
         return this.getProperty('payload', def);
     }
 
-    setURL(url) {
-        return this.setProperty('url', url);
+    setEndpoint(endpoint) {
+        return this.setProperty('endpoint', endpoint);
     }
 
-    getURL(def) {
-        return this.getProperty('url', def);
+    getEndpoint(def) {
+        return this.getProperty('endpoint', def);
     }
 }
diff --git a/test/factories/notification.js b/test/factories/notification.js
@@ -6,10 +6,10 @@ export default factory((data = {}) => new Notification({
     number: Math.random().toString(36).substr(2, 9),
     name: faker.lorem.words(),
     active: faker.datatype.boolean(),
-    type: Math.round(Math.random()) ? 'WEBHOOK' : 'EMAIL',
+    protocol: Math.round(Math.random()) ? 'WEBHOOK' : 'EMAIL',
     events: faker.hacker.verb(),
     payload: faker.lorem.sentence(),
-    url: faker.internet.url(),
+    endpoint: faker.internet.url(),
     custom_property: faker.lorem.words(),
 
     ...data,
diff --git a/test/specs/entities/Notification.spec.js b/test/specs/entities/Notification.spec.js
@@ -58,21 +58,21 @@ describe('entities/Notification', () => {
         expect(notification.active).toBe(true);
     });
 
-    it('check "type" property setters/getters', () => {
-        notification.setProperty('type', 'WEBHOOK');
-        expect(notification.getProperty('type')).toBe('WEBHOOK');
-        expect(notification.getType()).toBe('WEBHOOK');
-        expect(notification.type).toBe('WEBHOOK');
-
-        notification.setType('EMAIL');
-        expect(notification.getProperty('type')).toBe('EMAIL');
-        expect(notification.getType()).toBe('EMAIL');
-        expect(notification.type).toBe('EMAIL');
-
-        notification.type = 'EMAIL';
-        expect(notification.getProperty('type')).toBe('EMAIL');
-        expect(notification.getType()).toBe('EMAIL');
-        expect(notification.type).toBe('EMAIL');
+    it('check "protocol" property setters/getters', () => {
+        notification.setProperty('protocol', 'WEBHOOK');
+        expect(notification.getProperty('protocol')).toBe('WEBHOOK');
+        expect(notification.getProtocol()).toBe('WEBHOOK');
+        expect(notification.protocol).toBe('WEBHOOK');
+
+        notification.setProtocol('EMAIL');
+        expect(notification.getProperty('protocol')).toBe('EMAIL');
+        expect(notification.getProtocol()).toBe('EMAIL');
+        expect(notification.protocol).toBe('EMAIL');
+
+        notification.protocol = 'EMAIL';
+        expect(notification.getProperty('protocol')).toBe('EMAIL');
+        expect(notification.getProtocol()).toBe('EMAIL');
+        expect(notification.protocol).toBe('EMAIL');
     });
 
     it('check "events" property setters/getters', () => {
@@ -109,21 +109,21 @@ describe('entities/Notification', () => {
         expect(notification.payload).toBe('some-payload-2');
     });
 
-    it('check "url" property setters/getters', () => {
-        notification.setProperty('url', 'https://example.com');
-        expect(notification.getProperty('url')).toBe('https://example.com');
-        expect(notification.getURL()).toBe('https://example.com');
-        expect(notification.url).toBe('https://example.com');
-
-        notification.setURL('https://example2.com');
-        expect(notification.getProperty('url')).toBe('https://example2.com');
-        expect(notification.getURL()).toBe('https://example2.com');
-        expect(notification.url).toBe('https://example2.com');
-
-        notification.url = 'https://example3.com';
-        expect(notification.getProperty('url')).toBe('https://example3.com');
-        expect(notification.getURL()).toBe('https://example3.com');
-        expect(notification.url).toBe('https://example3.com');
+    it('check "endpoint" property setters/getters', () => {
+        notification.setProperty('endpoint', 'https://example.com');
+        expect(notification.getProperty('endpoint')).toBe('https://example.com');
+        expect(notification.getEndpoint()).toBe('https://example.com');
+        expect(notification.endpoint).toBe('https://example.com');
+
+        notification.setEndpoint('https://example2.com');
+        expect(notification.getProperty('endpoint')).toBe('https://example2.com');
+        expect(notification.getEndpoint()).toBe('https://example2.com');
+        expect(notification.endpoint).toBe('https://example2.com');
+
+        notification.endpoint = 'https://example3.com';
+        expect(notification.getProperty('endpoint')).toBe('https://example3.com');
+        expect(notification.getEndpoint()).toBe('https://example3.com');
+        expect(notification.endpoint).toBe('https://example3.com');
     });
 
     it('check "custom-property" property setters/getters', () => {
diff --git a/test/specs/services/NotificationService.spec.js b/test/specs/services/NotificationService.spec.js
@@ -29,7 +29,7 @@ describe('services/NotificationService', () => {
         // configure mock for create request
         mock.onPost(`${context.getBaseUrl()}/${Constants.Notification.ENDPOINT_PATH}`)
             .reply(200, new Response(
-                new Item({ ...notification }, 'VendorNotification'),
+                new Item({ ...notification }, 'Notification'),
             ));
 
         const entity = await NotificationService.create(context, notification);
@@ -38,10 +38,10 @@ describe('services/NotificationService', () => {
         expect(entity.getProperty('number', null)).toBe(notification.number);
         expect(entity.getProperty('name', null)).toBe(notification.name);
         expect(entity.getProperty('active', null)).toBe(notification.active);
-        expect(entity.getProperty('type', null)).toBe(notification.type);
+        expect(entity.getProperty('protocol', null)).toBe(notification.protocol);
         expect(entity.getProperty('events', null)).toBe(notification.events);
         expect(entity.getProperty('payload', null)).toBe(notification.payload);
-        expect(entity.getProperty('url', null)).toBe(notification.url);
+        expect(entity.getProperty('endpoint', null)).toBe(notification.endpoint);
         expect(entity.getProperty('custom_property', null)).toBe(notification.custom_property);
     });
 
@@ -52,7 +52,7 @@ describe('services/NotificationService', () => {
             // configure mock for get request
             mock.onGet(`${context.getBaseUrl()}/${Constants.Notification.ENDPOINT_PATH}/${notification.number}`)
                 .reply(200, new Response(
-                    new Item({ ...notification }, 'VendorNotification'),
+                    new Item({ ...notification }, 'Notification'),
                 ));
 
             const entity = await NotificationService.get(context, notification.number);
@@ -61,10 +61,10 @@ describe('services/NotificationService', () => {
             expect(entity.getProperty('number', null)).toBe(notification.number);
             expect(entity.getProperty('name', null)).toBe(notification.name);
             expect(entity.getProperty('active', null)).toBe(notification.active);
-            expect(entity.getProperty('type', null)).toBe(notification.type);
+            expect(entity.getProperty('protocol', null)).toBe(notification.protocol);
             expect(entity.getProperty('events', null)).toBe(notification.events);
             expect(entity.getProperty('payload', null)).toBe(notification.payload);
-            expect(entity.getProperty('url', null)).toBe(notification.url);
+            expect(entity.getProperty('endpoint', null)).toBe(notification.endpoint);
             expect(entity.getProperty('custom_property', null)).toBe(notification.custom_property);
         });
 
@@ -91,7 +91,7 @@ describe('services/NotificationService', () => {
 
             // configure mock for list request
             mock.onGet(`${context.getBaseUrl()}/${Constants.Notification.ENDPOINT_PATH}`)
-                .reply(200, new Response(notifications.map((v) => new Item(v, 'VendorNotification'))));
+                .reply(200, new Response(notifications.map((v) => new Item(v, 'Notification'))));
 
             const list = await NotificationService.list(context);
 
@@ -103,10 +103,10 @@ describe('services/NotificationService', () => {
                 expect(entity.getProperty('number', null)).toBe(notification.number);
                 expect(entity.getProperty('name', null)).toBe(notification.name);
                 expect(entity.getProperty('active', null)).toBe(notification.active);
-                expect(entity.getProperty('type', null)).toBe(notification.type);
+                expect(entity.getProperty('protocol', null)).toBe(notification.protocol);
                 expect(entity.getProperty('events', null)).toBe(notification.events);
                 expect(entity.getProperty('payload', null)).toBe(notification.payload);
-                expect(entity.getProperty('url', null)).toBe(notification.url);
+                expect(entity.getProperty('endpoint', null)).toBe(notification.endpoint);
                 expect(entity.getProperty('custom_property', null)).toBe(notification.custom_property);
             });
         });
@@ -157,7 +157,7 @@ describe('services/NotificationService', () => {
         // configure mock for get request
         mock.onGet(`${context.getBaseUrl()}/${Constants.Notification.ENDPOINT_PATH}/${notification.number}`)
             .reply(200, new Response(
-                new Item({ ...notification }, 'VendorNotification'),
+                new Item({ ...notification }, 'Notification'),
             ));
 
         notification = await NotificationService.get(context, notification.number);
@@ -168,7 +168,7 @@ describe('services/NotificationService', () => {
         // configure mock for update request
         mock.onPost(`${context.getBaseUrl()}/${Constants.Notification.ENDPOINT_PATH}/${notification.number}`)
             .reply(200, new Response(
-                new Item({ ...notification }, 'VendorNotification'),
+                new Item({ ...notification }, 'Notification'),
             ));
 
         const updated = await NotificationService.update(context, notification.getProperty('number'), notification);

Original file line number	Diff line number	Diff line change
`@@ -48,10 +48,10 @@ export default class Notification extends BaseEntity {`
`48`	`48`	`number: 'string',`
`49`	`49`	`active: 'boolean',`
`50`	`50`	`name: 'string',`
`51`		`- type: 'string',`
	`51`	`+ protocol: 'string',`
`52`	`52`	`events: 'string',`
`53`	`53`	`payload: 'string',`
`54`		`- url: 'string',`
	`54`	`+ endpoint: 'string',`
`55`	`55`	`},`
`56`	`56`	`});`
`57`	`57`	`}`
`@@ -80,12 +80,12 @@ export default class Notification extends BaseEntity {`
`80`	`80`	`return this.getProperty('name', def);`
`81`	`81`	`}`
`82`	`82`
`83`		`- setType(type) {`
`84`		`- return this.setProperty('type', type);`
	`83`	`+ setProtocol(type) {`
	`84`	`+ return this.setProperty('protocol', type);`
`85`	`85`	`}`
`86`	`86`
`87`		`- getType(def) {`
`88`		`- return this.getProperty('type', def);`
	`87`	`+ getProtocol(def) {`
	`88`	`+ return this.getProperty('protocol', def);`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`setEvents(events) {`
`@@ -104,11 +104,11 @@ export default class Notification extends BaseEntity {`
`104`	`104`	`return this.getProperty('payload', def);`
`105`	`105`	`}`
`106`	`106`
`107`		`- setURL(url) {`
`108`		`- return this.setProperty('url', url);`
	`107`	`+ setEndpoint(endpoint) {`
	`108`	`+ return this.setProperty('endpoint', endpoint);`
`109`	`109`	`}`
`110`	`110`
`111`		`- getURL(def) {`
`112`		`- return this.getProperty('url', def);`
	`111`	`+ getEndpoint(def) {`
	`112`	`+ return this.getProperty('endpoint', def);`
`113`	`113`	`}`
`114`	`114`	`}`