Merge branch 'master' into 285-fix-graphql-updates

pmcnr-hx · web-flow · commit e9c30ac561ce · 2017-06-01T01:39:04.000+01:00
diff --git a/documentation/configuring.md b/documentation/configuring.md
@@ -22,7 +22,7 @@ jsonApi.setConfig({
     copyright: "Blah"
   },
   // Should the interactive GraphQL HTTP interface be served up?
-  graphiql: true
+  graphiql: true,
   // (optional) meta can be a function to be invoked at the end of every request
   meta: function(request) {
     return { timestamp: new Date() };
diff --git a/documentation/suggested-project-structure.md b/documentation/suggested-project-structure.md
@@ -48,11 +48,11 @@ jsonApi.start();
 The idea is to stick to having one resource per file and stick to pure config. Each file should do nothing more than define a resource. Handlers should be referenced from the `../handlers` folder, which enables us to easily abstract functionality by sharing features amongst handlers. Resource files are effectively defining your routing layer.
 
 ```javascript
-var commentHandler = require("../handlers/commentHandler.js");
+var photosHandler = require("../handlers/photosHandler.js");
 
 jsonApi.define({
   resource: "photos",
-  handlers: memoryHandler,
+  handlers: photosHandler,
   attributes: {
     title: jsonApi.Joi.string()
     url: jsonApi.Joi.string().uri()
diff --git a/example/server.js b/example/server.js
@@ -32,10 +32,10 @@ jsonApi.setConfig({
 
 jsonApi.authenticate((request, callback) => {
   // If a "blockMe" header is provided, block access.
-  if (request.headers.blockme) return callback('Fail')
+  if (request.headers.blockme) return callback(new Error('Fail'))
 
   // If a "blockMe" cookie is provided, block access.
-  if (request.cookies.blockMe) return callback('Fail')
+  if (request.cookies.blockMe) return callback(new Error('Fail'))
 
   return callback()
 })
diff --git a/lib/MemoryHandler.js b/lib/MemoryHandler.js
@@ -47,7 +47,7 @@ MemoryStore.prototype.find = (request, callback) => {
 
   // If the resource doesn't exist, error
   if (!theResource) {
-    return callback({
+    return callback({  // eslint-disable-line standard/no-callback-literal
       status: '404',
       code: 'ENOTFOUND',
       title: 'Requested resource does not exist',
@@ -66,7 +66,7 @@ MemoryStore.prototype.create = (request, newResource, callback) => {
   // Check to see if the ID already exists
   const index = MemoryStore._indexOf(resources[request.params.type], newResource)
   if (index !== -1) {
-    return callback({
+    return callback({  // eslint-disable-line standard/no-callback-literal
       status: '403',
       code: 'EFORBIDDEN',
       title: 'Requested resource already exists',
diff --git a/lib/postProcessing/fields.js b/lib/postProcessing/fields.js
@@ -11,7 +11,7 @@ fields.action = (request, response, callback) => {
 
   for (const resource in resourceList) {
     if (!jsonApi._resources[resource]) {
-      return callback({
+      return callback({  // eslint-disable-line standard/no-callback-literal
         status: '403',
         code: 'EFORBIDDEN',
         title: 'Invalid field resource',
@@ -23,7 +23,7 @@ fields.action = (request, response, callback) => {
 
     for (const j of field) {
       if (!jsonApi._resources[resource].attributes[j]) {
-        return callback({
+        return callback({  // eslint-disable-line standard/no-callback-literal
           status: '403',
           code: 'EFORBIDDEN',
           title: 'Invalid field selection',
diff --git a/lib/postProcessing/sort.js b/lib/postProcessing/sort.js
@@ -12,7 +12,7 @@ sort.action = (request, response, callback) => {
   }
 
   if (!request.resourceConfig.attributes[attribute]) {
-    return callback({
+    return callback({  // eslint-disable-line standard/no-callback-literal
       status: '403',
       code: 'EFORBIDDEN',
       title: 'Invalid sort',
diff --git a/lib/router.js b/lib/router.js
@@ -133,7 +133,7 @@ router.authenticate = (request, res, callback) => {
       detail: err || 'You are not authorised to access this resource.'
     }
     const payload = responseHelper.generateError(request, errorWrapper)
-    res.status(401).end(new Buffer(JSON.stringify(payload)))
+    res.status(401).end(Buffer.from(JSON.stringify(payload)))
   })
 }
 
@@ -199,7 +199,7 @@ router._getParams = req => {
 router.sendResponse = (res, payload, httpCode) => {
   const timeDiff = (new Date()) - res._startDate
   metrics.processResponse(res._request, httpCode, payload, timeDiff)
-  res.status(httpCode).end(new Buffer(JSON.stringify(payload)))
+  res.status(httpCode).end(Buffer.from(JSON.stringify(payload)))
 }
 
 router.getExpressServer = () => {
diff --git a/lib/routes/_foreignKeySearch.js b/lib/routes/_foreignKeySearch.js
@@ -30,15 +30,15 @@ foreignKeySearchRoute.register = () => {
       callback => {
         const foreignKeySchema = resourceConfig.attributes[foreignKey]
         if (!foreignKeySchema || !foreignKeySchema._settings) {
-          return callback({
+          return callback({  // eslint-disable-line standard/no-callback-literal
             status: '403',
             code: 'EFORBIDDEN',
             title: 'Invalid foreign key lookup',
             detail: `Relation [${foreignKey}] does not exist within ${request.params.type}`
           })
         }
         if (!(foreignKeySchema._settings.__one || foreignKeySchema._settings.__many)) {
-          return callback({
+          return callback({  // eslint-disable-line standard/no-callback-literal
             status: '403',
             code: 'EFORBIDDEN',
             title: 'Invalid foreign key lookup',
diff --git a/lib/routes/find.js b/lib/routes/find.js
@@ -35,7 +35,7 @@ findRoute.register = () => {
       },
       (sanitisedData, callback) => {
         if (!sanitisedData) {
-          return callback({
+          return callback({  // eslint-disable-line standard/no-callback-literal
             status: '404',
             code: 'EVERSION',
             title: 'Resource is not valid',
diff --git a/lib/routes/helper.js b/lib/routes/helper.js
@@ -13,7 +13,7 @@ helper.validate = (someObject, someDefinition, callback) => {
   debug.validationInput(JSON.stringify(someObject))
   Joi.validate(someObject, someDefinition, { abortEarly: false }, (err, sanitisedObject) => {
     if (err) {
-      return callback({
+      return callback({  // eslint-disable-line standard/no-callback-literal
         status: '403',
         code: 'EFORBIDDEN',
         title: 'Param validation failed',
@@ -27,7 +27,7 @@ helper.validate = (someObject, someDefinition, callback) => {
 
 helper.checkForBody = (request, callback) => {
   if (!request.params.data) {
-    return callback({
+    return callback({  // eslint-disable-line standard/no-callback-literal
       status: '403',
       code: 'EFORBIDDEN',
       title: 'Request validation failed',
@@ -36,7 +36,7 @@ helper.checkForBody = (request, callback) => {
   }
   // data can be {} or [] both of which are typeof === 'object'
   if (typeof request.params.data !== 'object') {
-    return callback({
+    return callback({  // eslint-disable-line standard/no-callback-literal
       status: '403',
       code: 'EFORBIDDEN',
       title: 'Request validation failed',
diff --git a/lib/routes/related.js b/lib/routes/related.js
@@ -25,15 +25,15 @@ relatedRoute.register = () => {
       callback => {
         relation = resourceConfig.attributes[request.params.relation]
         if (!relation || !relation._settings || !(relation._settings.__one || relation._settings.__many)) {
-          return callback({
+          return callback({  // eslint-disable-line standard/no-callback-literal
             status: '404',
             code: 'ENOTFOUND',
             title: 'Resource not found',
             detail: 'The requested relation does not exist within the requested type'
           })
         }
         if (relation._settings.__as) {
-          return callback({
+          return callback({  // eslint-disable-line standard/no-callback-literal
             status: '404',
             code: 'EFOREIGN',
             title: 'Relation is Foreign',
diff --git a/lib/routes/relationships.js b/lib/routes/relationships.js
@@ -22,7 +22,7 @@ relationshipsRoute.register = () => {
       callback => {
         const relation = resourceConfig.attributes[request.params.relation]
         if (!relation || !(relation._settings.__one || relation._settings.__many)) {
-          return callback({
+          return callback({  // eslint-disable-line standard/no-callback-literal
             status: '404',
             code: 'ENOTFOUND',
             title: 'Resource not found',
@@ -43,7 +43,7 @@ relationshipsRoute.register = () => {
       },
       (sanitisedData, callback) => {
         if (!sanitisedData) {
-          return callback({
+          return callback({  // eslint-disable-line standard/no-callback-literal
             status: '404',
             code: 'EVERSION',
             title: 'Resource is not valid',
diff --git a/lib/routes/removeRelation.js b/lib/routes/removeRelation.js
@@ -44,7 +44,7 @@ removeRelationRoute.register = () => {
 
         for (let i = 0; i < theirs.length; i++) {
           if (relationType.indexOf(theirs[i].type) === -1) {
-            return callback({
+            return callback({  // eslint-disable-line standard/no-callback-literal
               status: '403',
               code: 'EFORBIDDEN',
               title: 'Invalid Request',
@@ -54,7 +54,7 @@ removeRelationRoute.register = () => {
           const someId = theirs[i].id
           const indexOfTheirs = keys.indexOf(someId)
           if (indexOfTheirs === -1) {
-            return callback({
+            return callback({  // eslint-disable-line standard/no-callback-literal
               status: '403',
               code: 'EFORBIDDEN',
               title: 'Invalid Request',
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jsonapi-server",
-  "version": "2.3.2",
+  "version": "3.0.0",
   "description": "A config driven NodeJS framework implementing json:api",
   "keywords": [
     "jsonapi",
@@ -16,17 +16,17 @@
     "url": "https://github.com/holidayextras/jsonapi-server"
   },
   "engines": {
-    "node": "*"
+    "node": ">=4.5"
   },
   "dependencies": {
-    "express-graphql": "^0.5.4",
-    "graphql": "^0.7.0",
-    "async": "2.4.0",
+    "async": "2.4.1",
     "body-parser": "1.17.2",
     "cookie-parser": "1.4.3",
     "debug": "2.6.8",
     "express": "4.15.3",
-    "joi": "10.5.0",
+    "express-graphql": "0.5.4",
+    "graphql": "0.7.2",
+    "joi": "10.5.2",
     "lodash.assign": "4.2.0",
     "lodash.isequal": "4.5.0",
     "lodash.omit": "4.5.0",
@@ -40,14 +40,16 @@
   },
   "devDependencies": {
     "eslint": "^3.6.1",
-    "eslint-config-standard": "^6.1.0",
+    "eslint-config-standard": "10.2.1",
+    "eslint-plugin-import": "2.3.0",
+    "eslint-plugin-node": "4.2.2",
     "eslint-plugin-promise": "^3.3.0",
-    "eslint-plugin-standard": "^2.0.0",
+    "eslint-plugin-standard": "3.0.1",
     "istanbul": "0.4.5",
     "jscpd": "0.6.11",
     "lokka": "1.7.0",
     "lokka-transport-http": "1.6.1",
-    "mocha": "3.4.1",
+    "mocha": "3.4.2",
     "mocha-performance": "0.1.1",
     "node-inspector": "1.1.1",
     "plato": "1.7.0",

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ sort.action = (request, response, callback) => {`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`if (!request.resourceConfig.attributes[attribute]) {`
`15`		`- return callback({`
	`15`	`+ return callback({ // eslint-disable-line standard/no-callback-literal`
`16`	`16`	`status: '403',`
`17`	`17`	`code: 'EFORBIDDEN',`
`18`	`18`	`title: 'Invalid sort',`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ router.authenticate = (request, res, callback) => {`
`133`	`133`	`detail: err \|\| 'You are not authorised to access this resource.'`
`134`	`134`	`}`
`135`	`135`	`const payload = responseHelper.generateError(request, errorWrapper)`
`136`		`- res.status(401).end(new Buffer(JSON.stringify(payload)))`
	`136`	`+ res.status(401).end(Buffer.from(JSON.stringify(payload)))`
`137`	`137`	`})`
`138`	`138`	`}`
`139`	`139`
`@@ -199,7 +199,7 @@ router._getParams = req => {`
`199`	`199`	`router.sendResponse = (res, payload, httpCode) => {`
`200`	`200`	`const timeDiff = (new Date()) - res._startDate`
`201`	`201`	`metrics.processResponse(res._request, httpCode, payload, timeDiff)`
`202`		`- res.status(httpCode).end(new Buffer(JSON.stringify(payload)))`
	`202`	`+ res.status(httpCode).end(Buffer.from(JSON.stringify(payload)))`
`203`	`203`	`}`
`204`	`204`
`205`	`205`	`router.getExpressServer = () => {`