Merge master into before-delete-transform

Author: carlbennettnz

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -1,4 +1,4 @@
-json-api ![CircleCI Badge](https://circleci.com/gh/ethanresnick/json-api.png?0d6d9ba9db7f15eb6363c6fd93408526bef06035&style=shield)
+json-api [![CircleCI Badge](https://circleci.com/gh/ethanresnick/json-api.png?0d6d9ba9db7f15eb6363c6fd93408526bef06035&style=shield)](https://circleci.com/gh/ethanresnick/json-api)
 ========
 
 This library creates a [JSON API](http://jsonapi.org/)-compliant REST API from your Node app and automatically generates API documentation.

UPGRADING.md

@@ -1,3 +1,5 @@
+# 2.9 -> 2.10 Breaking Changes  (Not Semver until 3.0)
+- [Very subtle changes](https://github.com/ethanresnick/json-api/commit/19e16edfb58ee2b5f2573a9e2d1d09cb73d05050) to how the request body is parsed and stored on the request object. You almost certainly don’t need to care about these changes.
 # v2.8 -> 2.9 Breaking Changes (Not Semver until 3.0)
 - APIController.responseFromExternalError() has a changed API
 - Errors caused in the Express handler while building the Request object are now

build/src/ResourceTypeRegistry.js

@@ -1,9 +1,3 @@
-/**
- * A private array of properties that will be used by the class below to
- * automatically generate simple getter setters for each property, all
- * following same format. Those getters/setters will take the resource type
- * whose property is being retrieved/set, and the value to set it to, if any.
- */
 "use strict";
 
 var _createClass = require("babel-runtime/helpers/create-class")["default"];
@@ -14,32 +8,58 @@ var _Object$assign = require("babel-runtime/core-js/object/assign")["default"];
 
 var _Object$keys = require("babel-runtime/core-js/object/keys")["default"];
 
+var _interopRequireDefault = require("babel-runtime/helpers/interop-require-default")["default"];
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var autoGetterSetterProps = ["dbAdapter", "beforeSave", "beforeRender", "labelMappers", "defaultIncludes", "info", "parentType"];
+
+var _lodashObjectMerge = require("lodash/object/merge");
+
+var _lodashObjectMerge2 = _interopRequireDefault(_lodashObjectMerge);
+
+/**
+ * A private array of properties that will be used by the class below to
+ * automatically generate simple getter setters for each property, all
+ * following same format. Those getters/setters will take the resource type
+ * whose property is being retrieved/set, and the value to set it to, if any.
+ */
+var autoGetterSetterProps = ["dbAdapter", "beforeSave", "beforeRender", "beforeDelete", "labelMappers", "defaultIncludes", "info", "parentType"];
+
+/**
+ * Global defaults for resource descriptions, to be merged into defaults
+ * provided to the ResourceTypeRegistry, which are in turn merged into defaults
+ * provided in each resource type descriptions.
+ */
+var globalResourceDefaults = {
+  behaviors: {
+    dasherizeOutput: { enabled: true }
+  }
+};
 
 /**
  * To fulfill a JSON API request, you often need to know about all the resources
  * in the system--not just the primary resource associated with the type being
  * requested. For example, if the request is for a User, you might need to
  * include related Projects, so the code handling the users request needs access
- * to the Project resource's beforeSave and afterQuery methods. Similarly, it
+ * to the Project resource's beforeSave and beforeRender methods. Similarly, it
  * would need access to url templates that point at relationships on the Project
  * resources. Etc. So we handle this by introducing a ResourceTypeRegistry that
- * the Dispatcher can have access to. Each resource type is registered by its
- * JSON api type and has a number of properties defining it.
+ * the Controller can have access to. Each resource type is registered by its
+ * JSON API type and has a number of properties defining it.
  */
 
 var ResourceTypeRegistry = (function () {
   function ResourceTypeRegistry() {
     var _this = this;
 
     var typeDescriptions = arguments.length <= 0 || arguments[0] === undefined ? [] : arguments[0];
+    var descriptionDefaults = arguments.length <= 1 || arguments[1] === undefined ? {} : arguments[1];
 
     _classCallCheck(this, ResourceTypeRegistry);
 
     this._resourceTypes = {};
+    this._descriptionDefaults = (0, _lodashObjectMerge2["default"])({}, globalResourceDefaults, descriptionDefaults);
     typeDescriptions.forEach(function (it) {
       _this.type(it);
     });
@@ -61,8 +81,11 @@ var ResourceTypeRegistry = (function () {
       if (description) {
         this._resourceTypes[_type] = {};
 
+        // Merge description defaults into provided description
+        description = (0, _lodashObjectMerge2["default"])({}, this._descriptionDefaults, description);
+
         // Set all the properties for the type that the description provides.
-        autoGetterSetterProps.concat(["urlTemplates"]).forEach(function (k) {
+        autoGetterSetterProps.concat(["urlTemplates", "behaviors"]).forEach(function (k) {
           if (Object.prototype.hasOwnProperty.call(description, k)) {
             _this2[k](_type, description[k]);
           }
@@ -98,6 +121,16 @@ var ResourceTypeRegistry = (function () {
           this._resourceTypes[type].urlTemplates = templatesToSet;
       }
     }
+  }, {
+    key: "behaviors",
+    value: function behaviors(type, behaviorsToSet) {
+      this._resourceTypes[type] = this._resourceTypes[type] || {};
+      if (behaviorsToSet) {
+        this._resourceTypes[type].behaviors = (0, _lodashObjectMerge2["default"])({}, this._descriptionDefaults.behaviors, behaviorsToSet);
+      } else {
+        return this._resourceTypes[type].behaviors;
+      }
+    }
   }]);
 
   return ResourceTypeRegistry;