New API

* Add `before` and `after` middleware handlers
* Move configuration to an `expose` method
* Add tests

* Rename to restful-keystone

Author: creynders

.jscsrc

@@ -1,90 +1,84 @@
 {
-    "disallowEmptyBlocks": true,
-    "disallowKeywordsOnNewLine": ["else"],
-    "disallowKeywords": ["with"],
-    "disallowMixedSpacesAndTabs": true,
-    "disallowMultipleLineBreaks": true,
-    "disallowMultipleLineStrings": true,
-    "disallowMultipleVarDecl": true,
-    "disallowNewlineBeforeBlockStatements": true,
-    "disallowOperatorBeforeLineBreak": [
-        "+",
-        "-"
-    ],
-    "disallowPaddingNewlinesInBlocks": true,
-    "disallowSpaceAfterPrefixUnaryOperators": true,
-    "disallowSpaceBeforePostfixUnaryOperators": true,
-    "disallowSpacesInAnonymousFunctionExpression": {
-        "beforeOpeningRoundBrace": true,
-        "beforeOpeningCurlyBrace": true
-    },
-    "disallowSpacesInCallExpression": true,
-    "disallowSpacesInFunctionDeclaration": {
-        "beforeOpeningRoundBrace": true,
-        "beforeOpeningCurlyBrace": true
-    },
-    "disallowSpacesInFunctionExpression": {
-        "beforeOpeningRoundBrace": true,
-        "beforeOpeningCurlyBrace": true
-    },
-    "disallowSpacesInNamedFunctionExpression": {
-        "beforeOpeningRoundBrace": true,
-        "beforeOpeningCurlyBrace": true
-    },
-    "disallowTrailingComma": true,
-    "disallowTrailingWhitespace": true,
-    "maximumLineLength": {
-        "value": 120,
-        "allowComments": true,
-        "allowUrlComments": true,
-        "allowRegex": true
-    },
-    "requireAlignedObjectValues": "ignoreLineBreak",
-    "requireBlocksOnNewline": true,
-    "requireCamelCaseOrUpperCaseIdentifiers": true,
-    "requireCapitalizedConstructors": true,
-    "requireCurlyBraces": [
-        "for",
-        "while",
-        "do",
-        "try",
-        "catch"
-    ],
-    "requireDotNotation": true,
-    "requireKeywordsOnNewLine": [],
-    "requireLineFeedAtFileEnd": true,
-    "requirePaddingNewLinesInObjects": true,
-    "requireParenthesesAroundIIFE": true,
-    "requireSpaceAfterBinaryOperators": true,
-    "requireSpaceAfterKeywords": [
-        "return",
-        "case"
-    ],
-    "requireSpaceAfterLineComment": true,
-    "requireSpaceAfterObjectKeys": true,
-    "requireSpaceBeforeBinaryOperators": true,
-    "requireSpaceBeforeKeywords": true,
-    "requireSpaceBeforeObjectValues": true,
-    "requireSpaceBetweenArguments": true,
-    "requireSpacesInConditionalExpression": true,
-    "requireSpacesInsideArrayBrackets": "all",
-    "requireSpacesInsideObjectBrackets": "all",
-    "requireSpacesInsideParentheses": {
-        "all": true
-    },
-    "requireYodaConditions": true,
-    "validateIndentation": 2,
-    "validateLineBreaks": "LF",
-    "validateParameterSeparator": ", ",
-    "validateQuoteMarks": {
-        "mark": "\"",
-        "escape": true
-    },
-    "fileExtensions": [
-        ".js",
-        "jscs"
-    ],
-    "excludeFiles": [
-        "templates"
-    ]
+  "disallowEmptyBlocks": true,
+  "disallowKeywordsOnNewLine": ["else"],
+  "disallowKeywords": ["with"],
+  "disallowMixedSpacesAndTabs": true,
+  "disallowMultipleLineBreaks": true,
+  "disallowMultipleLineStrings": true,
+  "disallowNewlineBeforeBlockStatements": true,
+  "disallowOperatorBeforeLineBreak": [
+    "?",
+    ":"
+  ],
+  "disallowPaddingNewlinesInBlocks": true,
+  "disallowSpaceAfterPrefixUnaryOperators": true,
+  "disallowSpaceBeforePostfixUnaryOperators": true,
+  "disallowSpacesInAnonymousFunctionExpression": {
+    "beforeOpeningRoundBrace": true,
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowSpacesInCallExpression": true,
+  "disallowSpacesInFunctionDeclaration": {
+    "beforeOpeningRoundBrace": true,
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowSpacesInFunctionExpression": {
+    "beforeOpeningRoundBrace": true,
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowSpacesInNamedFunctionExpression": {
+    "beforeOpeningRoundBrace": true,
+    "beforeOpeningCurlyBrace": true
+  },
+  "disallowTrailingComma": true,
+  "disallowTrailingWhitespace": true,
+  "maximumLineLength": {
+    "value": 120,
+    "allowComments": true,
+    "allowUrlComments": true,
+    "allowRegex": true
+  },
+  "requireAlignedObjectValues": "ignoreLineBreak",
+  "requireBlocksOnNewline": true,
+  "requireCamelCaseOrUpperCaseIdentifiers": true,
+  "requireCapitalizedConstructors": true,
+  "requireCurlyBraces": [
+    "for",
+    "while",
+    "do",
+    "try",
+    "catch"
+  ],
+  "requireDotNotation": true,
+  "requireKeywordsOnNewLine": [],
+  "requireLineFeedAtFileEnd": true,
+  "requirePaddingNewLinesInObjects": true,
+  "requireParenthesesAroundIIFE": true,
+  "requireSpaceAfterBinaryOperators": true,
+  "requireSpaceAfterKeywords": [
+    "return",
+    "case"
+  ],
+  "requireSpaceAfterObjectKeys": true,
+  "requireSpaceBeforeBinaryOperators": true,
+  "requireSpaceBeforeKeywords": true,
+  "requireSpaceBeforeObjectValues": true,
+  "requireSpaceBetweenArguments": true,
+  "requireSpacesInConditionalExpression": true,
+  "requireSpacesInsideArrayBrackets": "all",
+  "requireSpacesInsideObjectBrackets": "all",
+  "requireSpacesInsideParentheses": {
+    "all": true
+  },
+  "requireYodaConditions": true,
+  "validateIndentation": 2,
+  "validateLineBreaks": "LF",
+  "validateParameterSeparator": ", ",
+  "fileExtensions": [
+    ".js",
+    "jscs"
+  ],
+  "excludeFiles": [
+    "templates"
+  ]
 }

.jshintrc

@@ -11,5 +11,6 @@
   "eqnull": true,
   "node": true,
   "laxbreak": true,
-  "expr": true
+  "expr": true,
+  "laxcomma": true
 }

Gruntfile.js

@@ -11,5 +11,6 @@ module.exports = function( grunt ){
 
   grunt.initConfig( configs );
 
-  grunt.registerTask( 'default', [ 'jshint', 'mochacli' ] );
+  grunt.registerTask( 'lint', [ 'jshint', 'jscs' ] );
+  grunt.registerTask( 'default', [ 'lint', 'mochacli' ] );
 };

README.md

@@ -10,7 +10,7 @@ It allows for very granular control of editable fields, population, filters and
 ## Install
 
 ```sh
-$ npm install --save keystone-restful
+$ npm install --save restful-keystone
 ```
 
 ## Usage
@@ -21,7 +21,7 @@ $ npm install --save keystone-restful
 
 ```js
 // file: routes/index.js
-var restful = require('keystone-restful');
+var restful = require('restful-keystone');
 
 // ...
 
@@ -72,7 +72,7 @@ Status: 200 OK
             "categories": [],
             "content": {
                 "brief": "<p>This is a test</p>",
-                "extended": "<p>To make sure keystone-restful is functioning correctly</p>"
+                "extended": "<p>To make sure restful-keystone is functioning correctly</p>"
             },
             "state": "published"
         }
@@ -82,7 +82,7 @@ Status: 200 OK
 
 ### Configuration
 
-A number of keystone-restful specific options can be passed to the module to configure how it functions:
+A number of restful-keystone specific options can be passed to the module to configure how it functions:
 
 #### `root`
 
@@ -160,7 +160,7 @@ Idem to `show`, except it configures which fields are editable. All fields passe
 
 **{Boolean|String}** default: `"<%=name%>"`
 
-Used for enveloping the results (which is definitely best practice, _especially_ when multiple resources are returned). 
+Used for enveloping the results (which is definitely best practice, _especially_ when multiple resources are returned).
 **By default this will be the singular or plural version of the list name**, e.g. `"posts"` or `"post"`.
 
 ```sh
@@ -184,7 +184,7 @@ Status: 200 OK
 	    "categories": [],
 	    "content": {
 	        "brief": "<p>This is a test</p>",
-	        "extended": "<p>To make sure keystone-restful is functioning correctly</p>"
+	        "extended": "<p>To make sure restful-keystone is functioning correctly</p>"
 	    },
 	    "state": "published"
 	}
@@ -234,7 +234,7 @@ Status: 200 OK
 	    "categories": [],
 	    "content": {
 	        "brief": "<p>This is a test</p>",
-	        "extended": "<p>To make sure keystone-restful is functioning correctly</p>"
+	        "extended": "<p>To make sure restful-keystone is functioning correctly</p>"
 	    },
 	    "state": "published"
 	}
@@ -347,11 +347,11 @@ Status: 200 OK
 
 All requests respond with a `200 OK` status if the request was succesful, except for `remove` requests which will return `204 No Content`.
 
-When something goes wrong appropriate errors are thrown, however keystone-restful does not provide any error handling out of the box, i.e. you need to make sure you have some kind of error handling middleware in place.
+When something goes wrong appropriate errors are thrown, however restful-keystone does not provide any error handling out of the box, i.e. you need to make sure you have some kind of error handling middleware in place.
 
 ### Permissions
 
-Keystone-restful does **NOT** provide any security checks, i.e. if you expose a resource it is available to anonymous requests !!
+restful-keystone does **NOT** provide any security checks, i.e. if you expose a resource it is available to anonymous requests !!
 You need to set up any restrictions you want to see applied to routes yourself. (Probably this will change in the near future)
 
 ## Roadmap
@@ -367,9 +367,9 @@ You need to set up any restrictions you want to see applied to routes yourself.
 MIT © [d-pac](http://www.d-pac.be)
 
 
-[npm-url]: https://npmjs.org/package/keystone-restful
-[npm-image]: https://badge.fury.io/js/keystone-restful.svg
-[travis-url]: https://travis-ci.org/d-pac/keystone-restful
-[travis-image]: https://travis-ci.org/d-pac/keystone-restful.svg?branch=master
-[daviddm-url]: https://david-dm.org/d-pac/keystone-restful.svg?theme=shields.io
-[daviddm-image]: https://david-dm.org/d-pac/keystone-restful
+[npm-url]: https://npmjs.org/package/restful-keystone
+[npm-image]: https://badge.fury.io/js/restful-keystone.svg
+[travis-url]: https://travis-ci.org/d-pac/restful-keystone
+[travis-image]: https://travis-ci.org/d-pac/restful-keystone.svg?branch=master
+[daviddm-url]: https://david-dm.org/d-pac/restful-keystone.svg?theme=shields.io
+[daviddm-image]: https://david-dm.org/d-pac/restful-keystone

index.js

@@ -1,82 +1 @@
-'use strict';
-var debug = require( "debug" );
-var _ = require( "lodash" );
-var path = require( "path" );
-
-function log( obj ){
-  var fs = require( "fs" );
-  var util = require( "util" );
-  fs.writeFileSync( "keystone.txt", util.inspect( obj, {
-    showHidden : true,
-    depth      : 1,
-    colors     : false
-  } ) );
-}
-
-function parseMixedValue( value,
-                          defaultValue ){
-  if( _.isUndefined( value ) ){
-    value = true;
-  }
-
-  if( _.isArray( value ) ){
-    value = value.join( " " );
-  } else if( _.isBoolean( value ) ){
-    value = (value)
-      ? defaultValue
-      : "";
-  }
-
-  if( !_.isString( value ) ){
-    //todo: throw error?
-  }
-  return value
-}
-
-function parseConfig( list,
-                      config ){
-
-  if(config){
-    config = _.defaults( {}, config );
-    var fields = _.keys( list.fields ).join( " " );
-    config.methods = parseMixedValue( config.methods, "list retrieve remove create update" );
-    config.show = parseMixedValue( config.show, fields );
-    config.edit = parseMixedValue( config.edit, fields );
-    config.populate = parseMixedValue( config.populate, "" );
-    config.envelop = parseMixedValue( config.envelop, "<%=name%>" );
-
-    config.key = config.key || list.key;
-    config.path = config.path || list.path;
-
-    return config;
-  }
-
-  return {
-    hidden: true
-  };
-}
-
-module.exports = function( keystone,
-                           config ){
-  _.defaults( config, {
-    root      : "/api",
-    resources : {}
-  } );
-  //todo: throw error if keystone not supplied or lists not available
-  _.each( keystone.lists, function( list,
-                                    key ){
-    var restConfig = parseConfig( list, config.resources[ key ] );
-    if( !restConfig.hidden ){
-      var entry = path.join( config.root, restConfig.path );
-      var methods = restConfig.methods.split( " " );
-      _.each( methods, function( methodName ){
-        var method = require( "./lib/methods/" + methodName );
-        var route = method( list, restConfig, entry );
-        keystone.app[ route.verb ]( route.url, route.handle );
-      } );
-    }
-  } );
-  return function(){
-
-  }
-};
+module.exports = require( './lib/restful' );

lib/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+
+var define = require( "node-constants" )( exports );
+
+define( {
+  METHODS_ALL : [ "retrieve", "list", "create", "update", "remove" ],
+  SYMBOL_ALL  : "*"
+} );