seatsio 65.1.0 → 65.2.0

package/README.md

@@ -38,10 +38,31 @@ seatsio-js follows semver since v54.4.0.
 
 Please note that any version below v2 is not production ready.
 
-## Examples
+## Usage
+
+### General instructions
+
+To use this library, you'll need to create a `SeatsioClient`:
+
+```js
+import { SeatsioClient, Region } from 'seatsio'
+
+let client = new SeatsioClient(Region.EU(), <WORKSPACE SECRET KEY>)
+...
+```
+
+You can find your _workspace secret key_ in the [settings section of the workspace](https://app.seats.io/workspace-settings). It is important that you keep your _secret key_ private and not expose it in-browser calls unless it is password protected.
+
+The region should correspond to the region of your account:
+
+- `Region.EU()`: Europe
+- `Region.NA()`: North-America
+- `Region.SA()`: South-America
+- `Region.OC()`: Oceania
+
+If you're unsure about your region, have a look at your [company settings page](https://app.seats.io/company-settings).
 
 ### Creating a chart and an event
-Once you create a new `SeatsioClient` using your _secret key_, you can create _charts_ and then _events_. You can find your _secret key_ in the Settings section of your workspace: https://app.seats.io/workspace-settings. It is important that you keep your _secret key_ private and not expose it in-browser calls unless it is password protected.
 
 ```js
 import { SeatsioClient, Region } from 'seatsio'
@@ -257,10 +278,10 @@ When an API call results in an error, a rejected promise is returned with a valu
 
 ```json
 {
-  errors: [{ code: 'RATE_LIMIT_EXCEEDED', message: 'Rate limit exceeded' }],
-  messages: ['Rate limit exceeded'],
-  requestId: '123456',
-  status: 429
+  "errors": [{ "code": "RATE_LIMIT_EXCEEDED", "message": "Rate limit exceeded" }],
+  "messages": ["Rate limit exceeded"],
+  "requestId": "123456",
+  "status": 429
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seatsio",
-  "version": "65.1.0",
+  "version": "65.2.0",
   "main": "index.js",
   "description": "Official JavaScript and Node.JS client library for the Seats.io REST API",
   "license": "MIT",
@@ -22,7 +22,7 @@
     "eslint-config-standard": "16.0.3",
     "eslint-plugin-import": "2.25.3",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "5.2.0",
+    "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-standard": "5.0.0",
     "gulp": "latest",
     "gulp-buffer": "latest",
@@ -30,8 +30,8 @@
     "gulp-tap": "latest",
     "gulp-uglify": "latest",
     "gulp-uglify-es": "latest",
-    "jest": "27.4.3",
-    "jest-cli": "27.4.3",
+    "jest": "27.4.5",
+    "jest-cli": "27.4.5",
     "uuid": "8.3.2"
   }
 }

package/src/Reports/ChartReports.js

@@ -5,11 +5,6 @@ class ChartReports {
         this.client = client
     }
 
-    fetchReport (reportType, eventKey, bookWholeTables) {
-        return this.client.get(`/reports/charts/${encodeURIComponent(eventKey)}/${reportType}`, { params: { bookWholeTables } })
-            .then((res) => utilities.createChartReport(res.data))
-    }
-
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
@@ -28,6 +23,15 @@ class ChartReports {
         return this.fetchReport('byObjectType', chartKey, bookWholeTables)
     }
 
+    /**
+     * @param {string} chartKey
+     * @returns {Object} JSON response from the server
+     */
+    summaryByObjectType (chartKey) {
+        return this.client.get(ChartReports.summaryReportUrl('byObjectType', chartKey))
+            .then((res) => res.data)
+    }
+
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
@@ -37,6 +41,15 @@ class ChartReports {
         return this.fetchReport('byCategoryLabel', chartKey, bookWholeTables)
     }
 
+    /**
+     * @param {string} chartKey
+     * @returns {Object} JSON response from the server
+     */
+    summaryByCategoryLabel (chartKey) {
+        return this.client.get(ChartReports.summaryReportUrl('byCategoryLabel', chartKey))
+            .then((res) => res.data)
+    }
+
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
@@ -45,6 +58,42 @@ class ChartReports {
     byCategoryKey (chartKey, bookWholeTables = undefined) {
         return this.fetchReport('byCategoryKey', chartKey, bookWholeTables)
     }
+
+    /**
+     * @param {string} chartKey
+     * @returns {Object} JSON response from the server
+     */
+    summaryByCategoryKey (chartKey) {
+        return this.client.get(ChartReports.summaryReportUrl('byCategoryKey', chartKey))
+            .then((res) => res.data)
+    }
+
+    /**
+     * @param {string} chartKey
+     * @param {string} bookWholeTables
+     * @returns {Object.<string, ChartObjectInfo[]>}
+     */
+    bySection (chartKey, bookWholeTables = undefined) {
+        return this.fetchReport('bySection', chartKey, bookWholeTables)
+    }
+
+    /**
+     * @param {string} chartKey
+     * @returns {Object} JSON response from the server
+     */
+    summaryBySection (chartKey) {
+        return this.client.get(ChartReports.summaryReportUrl('bySection', chartKey))
+            .then((res) => res.data)
+    }
+
+    fetchReport (reportType, eventKey, bookWholeTables) {
+        return this.client.get(`/reports/charts/${encodeURIComponent(eventKey)}/${reportType}`, { params: { bookWholeTables } })
+            .then((res) => utilities.createChartReport(res.data))
+    }
+
+    static summaryReportUrl (reportType, eventKey) {
+        return `/reports/charts/${encodeURIComponent(eventKey)}/${reportType}/summary`
+    }
 }
 
 module.exports = ChartReports

package/tests/chartReports/chartReport.test.js

@@ -119,3 +119,14 @@ test('get report byCategoryLabel', async () => {
     expect(report.Cat1.length).toBe(17)
     expect(report.Cat2.length).toBe(17)
 })
+
+test('get report bySection', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChartWithSections(chartKey, user.secretKey)
+
+    const report = await client.chartReports.bySection(chartKey)
+
+    expect(report['Section A'].length).toBe(36)
+    expect(report['Section B'].length).toBe(35)
+})

package/tests/chartReports/chartReportSummary.test.js

@@ -0,0 +1,120 @@
+const testUtils = require('../testUtils.js')
+
+test('summaryByObjectType', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+
+    const report = await client.chartReports.summaryByObjectType(chartKey)
+
+    expect(report).toEqual({
+        seat: {
+            count: 32,
+            bySection: { NO_SECTION: 32 },
+            byCategoryKey: { 9: 16, 10: 16 },
+            byCategoryLabel: { Cat1: 16, Cat2: 16 }
+        },
+        generalAdmission: {
+            count: 200,
+            bySection: { NO_SECTION: 200 },
+            byCategoryKey: { 9: 100, 10: 100 },
+            byCategoryLabel: { Cat2: 100, Cat1: 100 }
+        },
+        table: {
+            count: 0,
+            bySection: {},
+            byCategoryKey: {},
+            byCategoryLabel: {}
+        },
+        booth: {
+            count: 0,
+            bySection: {},
+            byCategoryKey: {},
+            byCategoryLabel: {}
+        }
+    })
+})
+
+test('summaryByCategoryKey', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+
+    const report = await client.chartReports.summaryByCategoryKey(chartKey)
+
+    expect(report).toEqual({
+        9: {
+            count: 116,
+            bySection: { NO_SECTION: 116 },
+            byObjectType: {
+                generalAdmission: 100,
+                seat: 16
+            }
+        },
+        10: {
+            count: 116,
+            bySection: { NO_SECTION: 116 },
+            byObjectType: {
+                generalAdmission: 100,
+                seat: 16
+            }
+        },
+        NO_CATEGORY: {
+            count: 0,
+            bySection: {},
+            byObjectType: {}
+        }
+    })
+})
+
+test('summaryByCategoryLabel', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+
+    const report = await client.chartReports.summaryByCategoryLabel(chartKey)
+
+    expect(report).toEqual({
+        Cat2: {
+            count: 116,
+            bySection: { NO_SECTION: 116 },
+            byObjectType: {
+                generalAdmission: 100,
+                seat: 16
+            }
+        },
+        Cat1: {
+            count: 116,
+            bySection: { NO_SECTION: 116 },
+            byObjectType: {
+                generalAdmission: 100,
+                seat: 16
+            }
+        },
+        NO_CATEGORY: {
+            count: 0,
+            bySection: {},
+            byObjectType: {}
+        }
+    })
+})
+
+test('summaryBySection', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+
+    const report = await client.chartReports.summaryBySection(chartKey)
+
+    expect(report).toEqual({
+        NO_SECTION: {
+            count: 232,
+            byCategoryKey: { 9: 116, 10: 116 },
+            byCategoryLabel: { Cat2: 116, Cat1: 116 },
+            byObjectType: {
+                generalAdmission: 200,
+                seat: 32
+            }
+        }
+    })
+})

package/tests/exponentialBackoff.test.js

@@ -2,13 +2,13 @@ const Region = require('../src/Region')
 const { SeatsioClient } = require('../index.js')
 
 test('aborts eventually if server keeps returning 429', async () => {
-    const client = new SeatsioClient(new Region('https://mockbin.org'))
+    const client = new SeatsioClient(new Region('https://httpbin.org'))
     const start = new Date()
     try {
-        await client.client.get('/bin/0381d6f4-0155-4b8c-937b-73d3d88b2a3f')
+        await client.client.get('/status/429')
         throw new Error('Should have failed')
     } catch (e) {
-        expect(e).toEqual({ errors: [{ code: 'RATE_LIMIT_EXCEEDED', message: 'Rate limit exceeded' }], messages: [], requestId: '123456', status: 429 })
+        expect(e).toBe('get /status/429 resulted in 429 TOO MANY REQUESTS error')
         const waitTime = new Date().getTime() - start.getTime()
         expect(waitTime).toBeGreaterThan(10000)
         expect(waitTime).toBeLessThan(20000)
@@ -16,26 +16,26 @@ test('aborts eventually if server keeps returning 429', async () => {
 })
 
 test('aborts directly if server returns error other than 429', async () => {
-    const client = new SeatsioClient(new Region('https://mockbin.org'))
+    const client = new SeatsioClient(new Region('https://httpbin.org'))
     const start = new Date()
     try {
-        await client.client.get('/bin/1eea3aab-2bb2-4f92-99c2-50d942fb6294')
+        await client.client.get('/status/400')
         throw new Error('Should have failed')
     } catch (e) {
-        expect(e).toBe('get /bin/1eea3aab-2bb2-4f92-99c2-50d942fb6294 resulted in 400 Bad Request error')
+        expect(e).toBe('get /status/400 resulted in 400 BAD REQUEST error')
         const waitTime = new Date().getTime() - start.getTime()
         expect(waitTime).toBeLessThan(2000)
     }
 })
 
 test('aborts directly if server returns 429 but max retries 0', async () => {
-    const client = new SeatsioClient(new Region('https://mockbin.org')).setMaxRetries(0)
+    const client = new SeatsioClient(new Region('https://httpbin.org')).setMaxRetries(0)
     const start = new Date()
     try {
-        await client.client.get('/bin/0381d6f4-0155-4b8c-937b-73d3d88b2a3f')
+        await client.client.get('/status/429')
         throw new Error('Should have failed')
     } catch (e) {
-        expect(e).toEqual({ errors: [{ code: 'RATE_LIMIT_EXCEEDED', message: 'Rate limit exceeded' }], messages: [], requestId: '123456', status: 429 })
+        expect(e).toBe('get /status/429 resulted in 429 TOO MANY REQUESTS error')
         const waitTime = new Date().getTime() - start.getTime()
         expect(waitTime).toBeLessThan(2000)
     }