ti2 1.0.7 → 1.0.11

package/api.yml

@@ -141,6 +141,7 @@ components:
             type: string
     bookingSearchQuery:
       type: object
+      additionalProperties: true
       properties:
         bookingId:
           type: string
@@ -172,6 +173,7 @@ components:
           default: "DD/MM/YYYY"
     bookingDetail:
       type: object
+      additionalProperties: true
       properties:
         id:
           type: string
@@ -181,7 +183,15 @@ components:
           type: string
           required: true
           description: The booking status
-
+    bookingSearchQueryResults:
+      type: object
+      additionalProperties: true
+      properties:
+        bookings:
+          type: object
+          required: true
+          items:
+            $ref: '#/components/schemas/bookingDetail'
     bookingDetailsForCancel:
       allOf:     # Combines the BasicErrorModel and the inline model
         - $ref: '#/components/schemas/bookingDetail'
@@ -191,6 +201,89 @@ components:
           type: integer
           required: true
           description: The unix time the cancellation was sent
+    cancellationReturn:
+      type: object
+      properties:
+        cancellation:
+          type: object
+          allOf:     # Combines the BasicErrorModel and the inline model
+            - $ref: '#/components/schemas/bookingDetail'
+    bookingsProductQuery:
+      type: object
+      additionalProperties: true
+      description: Additional properties may be included
+      properties:
+        productName:
+          type: string
+          required: false
+          description: Product Name wildcard match
+          example: '*bus*'
+    bookingsProductSearchReturn:
+      type: object
+      additionalProperties: true
+      description: Additional properties may be included
+      properties:
+        products:
+          type: array
+          required: false
+          description: Product Search Results
+          items: 
+            type: object
+        accommodation:
+          type: array
+          required: false,
+          decription: Accommodation search results
+          items:
+            type: object
+    pricingItem:
+      type: object
+      additionalProperties: true
+      properties:
+        original:
+          type: integer
+        retail:
+          type: integer
+        net:
+          type: integer
+        currency:
+          type: string
+          example: "USD"
+        currencyPrecision:
+          type: integer
+        includedTaxes:
+          type: array
+          items:
+            type: object
+            additionalProperties: true
+            properties:
+              name:
+                type: string
+              retail:
+                type: integer
+              net:
+                type: integer
+    availabilityItem:
+      type: object
+      additionalProperties: true
+      properties:
+        id:
+          type: string
+          required: true
+          description: An availability Id that can be used for quoting
+        pricing:
+          $ref: '#/components/schemas/pricingItem'
+          required: false
+        cancelPolicy:
+          type: string
+          required: false
+    bookingRequest:
+      type: object
+      additionalProperties: true
+      required: true
+      properties:
+        id:
+          type: string
+          description: a quote Id to make a reservation for
 paths:
   /ping:
     get:
@@ -227,6 +320,30 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Message'
+
+  /app/{appKey}:
+    delete:
+      security:
+        - bearerAuth: ['admin']
+      tags:
+        - admin
+      summary: Should delete an App, the name of the app should be url safe (no spaces)
+      operationId: deleteApp
+      parameters:
+        - name: appKey
+          in: path
+          description: App name to delete, should be urlsafe and have a correspondant npm package already in the required npm modules as ti2-appName
+          required: true
+          example: 'expedia'
+          schema:
+            type: string
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Message'
   /apps:
     get:
       security:
@@ -492,10 +609,12 @@ paths:
             schema:
               $ref: '#/components/schemas/bookingSearchQuery'
       responses:
-        description: search results
-        content:
-          application/json:
-            schema: '#/components/schemas/AnyValue'
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/bookingSearchQueryResults'
   /bookings/{appKey}/{userId}/{hint}/search:
     post:
       security:
@@ -533,10 +652,12 @@ paths:
             schema:
               $ref: '#/components/schemas/bookingSearchQuery'
       responses:
-        description: search results
-        content:
-          application/json:
-            schema: '#/components/schemas/AnyValue'
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/bookingSearchQueryResults'
   /bookings/{appKey}/{userId}/cancel:
     post:
       security:
@@ -567,10 +688,12 @@ paths:
             schema:
               $ref: '#/components/schemas/bookingDetailsForCancel'
       responses:
-        description: search results
-        content:
-          application/json:
-            schema: '#/components/schemas/AnyValue'
+        '200':
+          description: Cancellation confirmation details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/cancellationReturn'
   /bookings/{appKey}/{userId}/{hint}/cancel:
     post:
       security:
@@ -608,7 +731,373 @@ paths:
             schema:
               $ref: '#/components/schemas/bookingDetailsForCancel'
       responses:
-        description: search results
+        '200':
+          description: Cancellation confirmation details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/cancellationReturn'
+  /products/{appKey}/{userId}/search:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Product Search
+      operationId: bookingsProductSearch
+      parameters:
+        - name: appKey
+          in: path
+          description: app to search the booking products, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Search query
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bookingsProductQuery'
+      responses:
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/bookingsProductSearchReturn'
+  /products/{appKey}/{userId}/{hint}/search:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Product Search using for an specific hint
+      operationId: bookingsProductSearch
+      parameters:
+        - name: appKey
+          in: path
+          description: app to search the booking products, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+        - name: hint
+          in: path
+          description: a specific token hint to be used
+          required: true
+          example: 'travelgate-australia'
+          schema:
+            type: string
+      requestBody:
+        description: Search query
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bookingsProductQuery'
+      responses:
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/bookingsProductSearchReturn'
+  /bookings/{appKey}/{userId}/availability:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Availability Search
+      operationId: bookingsAvailabilitySearch
+      parameters:
+        - name: appKey
+          in: path
+          description: app to search availability for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: both app details
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AnyValue'
+      responses:
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  availability:
+                    type: array
+                    required: true
+                    items:
+                      $ref: '#/components/schemas/availabilityItem'
+  /bookings/{appKey}/{userId}/{hint}/availability:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Availability Search for an specific hint
+      operationId: bookingsAvailabilitySearch
+      parameters:
+        - name: appKey
+          in: path
+          description: app to search availability for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+        - name: hint
+          in: path
+          description: a specific token hint to be used
+          required: true
+          example: 'travelgate-australia'
+          schema:
+            type: string
+      requestBody:
+        description: both app details
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/AnyValue'
+      responses:
+        '200':
+          description: search results
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  availability:
+                    type: array
+                    required: true
+                    items:
+                      $ref: '#/components/schemas/availabilityItem'
+  /bookings/{appKey}/{userId}/quote:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Quote an Availability
+      operationId: searchQuote
+      parameters:
+        - name: appKey
+          in: path
+          description: app to quote availability for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Availability spec to be quoted
+        required:  true
         content:
           application/json:
-            schema: '#/components/schemas/AnyValue'
+            schema:
+              type: object
+              additionalProperties: true
+              properties:
+                id:
+                  type: string
+                  required: true
+                  description: An availability Id to quote
+      responses:
+        '200':
+          description: Quote Details
+          content:
+            application/json:
+              schema:
+                type: object
+                required: true
+                properties:
+                  quote:
+                    type: array
+                    required: true
+                    items:
+                      type: object
+                      additionalProperties: true
+                      properties:
+                        id:
+                          type: string
+                          description: a quote Id that can be use to book
+  /bookings/{appKey}/{userId}/{hint}/quote:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Quote an Availability for an specific hint
+      operationId: searchQuote
+      parameters:
+        - name: appKey
+          in: path
+          description: app to quote the availability for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+        - name: hint
+          in: path
+          description: a specific token hint to be used
+          required: true
+          example: 'travelgate-australia'
+          schema:
+            type: string
+      requestBody:
+        description: Availability spec to be quoted
+        required:  true
+        content:
+          application/json:
+            schema:
+              type: object
+              additionalProperties: true
+              properties:
+                id:
+                  type: string
+                  required: true
+                  description: An availability Id to quote
+      responses:
+        '200':
+          description: Quote Details
+          content:
+            application/json:
+              schema:
+                type: object
+                required: true
+                properties:
+                  quote:
+                    type: array
+                    required: true
+                    items:
+                      type: object
+                      additionalProperties: true
+                      properties:
+                        id:
+                          type: string
+                          description: a quote Id that can be use to book
+  /bookings/{appKey}/{userId}/booking:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Create a Booking
+      operationId: createBooking
+      parameters:
+        - name: appKey
+          in: path
+          description: app to create the booking for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Booking creation payload
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bookingRequest'
+      responses:
+        '200':
+          description: Booking Details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AnyValue'
+  /bookings/{appKey}/{userId}/{hint}/booking:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Create a Booking for an specific hint
+      operationId: createBooking
+      parameters:
+        - name: appKey
+          in: path
+          description: app to create the booking for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+        - name: hint
+          in: path
+          description: a specific token hint to be used
+          required: true
+          example: 'travelgate-australia'
+          schema:
+            type: string
+      requestBody:
+        description: Booking creation payload
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bookingRequest'
+      responses:
+        '200':
+          description: Booking Details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AnyValue'

package/controllers/__tests__/admin.js

@@ -1,10 +1,8 @@
-/* globals describe it expect afterAll */
+/* globals describe it expect */
 
 const chance = require('chance').Chance();
-const request = require('supertest');
-const app = require('../../index');
-const sqldb = require('../../models/db');
-const { slugify } = require('../../test/utils');
+const testUtils = require('../../test/utils');
+const slugify = require('../../test/slugify');
 
 const { env: { adminKey } } = process;
 
@@ -17,26 +15,24 @@ describe('admin', () => {
     packageName: `ti2-${appName}`,
     adminEmail: chance.email(),
   };
+  const { doApiPost, doApiGet } = testUtils({
+    plugins: [appName],
+  });
   let appKey;
   const userId = '536830b6ed19afa44a000002';
-  afterAll(async () => {
-    await sqldb.connectionManager.close();
-  });
   it('should be able to create an app', async () => {
-    const resp = await request(app)
-      .post('/app')
-      .set('Authorization', `Bearer ${adminKey}`)
-      .send(newApp);
-    expect(resp.statusCode).toBe(200);
-    expect(resp.body.value).toBeTruthy();
-    appKey = resp.body.value;
+    ({ value: appKey } = await doApiPost({
+      url: '/app',
+      token: adminKey,
+      payload: newApp,
+    }));
+    expect(appKey).toBeTruthy();
   });
   it('the created app should be on the list of apps', async () => {
-    const resp = await request(app)
-      .get('/apps')
-      .set('Authorization', `Bearer ${adminKey}`);
-    expect(resp.statusCode).toBe(200);
-    const { body: { integrations } } = resp;
+    const { integrations } = await doApiGet({
+      url: '/apps',
+      token: adminKey,
+    });
     expect(integrations).toEqual(
       expect.arrayContaining([
         expect.objectContaining(newApp),
@@ -45,18 +41,19 @@ describe('admin', () => {
   });
   it('should be able to reset an app\'s key', async () => {
     const url = `/app/resetAppKey/${newApp.name}`;
-    const resp = await request(app)
-      .get(url)
-      .set('Authorization', `Bearer ${adminKey}`);
-    expect(resp.statusCode).toBe(200);
-    const { body: { value } } = resp;
+    const { value } = await doApiGet({
+      url,
+      token: adminKey,
+    });
     expect(value).toBeTruthy();
     expect(value).not.toBe(appKey);
   });
-  it.skip('should be able to create a new user authentication token', async () => {
-    const resp = await request(app).post('/user')
-      .set('Authorization', `Bearer ${adminKey}`)
-      .send({ userId });
-    expect(resp.statusCode).toBe(200);
+  it('should be able to create a new user authentication token', async () => {
+    const { value } = await doApiPost({
+      url: '/user',
+      token: adminKey,
+      payload: { userId },
+    });
+    expect(value).toBeTruthy();
   });
 });