Merge pull request #60 from lexich/crud-option

Crud option

DOCS.md

@@ -295,6 +295,28 @@ rest.actions.test.post(1, "admin", {msg: "Hello"}, (err)=> {
 rest.actions.test.async();
 ```
 
+####crud
+- @description: autogenerate `helpers` ("get", "post", "put", "delete", "patch") for selected endpoint. Also you can overwrite autogenerate action with `helpers` definitions.
+- @type: Boolean
+- @default: false
+- @example:
+```js
+{
+  test: {
+    url: "/test/:id",
+    crud: true
+  }
+}
+
+//using
+rest.action.test.get({ id: 1})
+rest.action.test.post({ id: 1}, { body: "data" }, (err, data)=> {
+  //code
+});
+rest.action.test.put({ id: 1}, { body: "data" })
+rest.action.test.delete({ id: 1 });
+```
+
 ### reduxApi object
 
 ####use(key, value)

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-api",
-  "version": "0.8.10",
+  "version": "0.9.0",
   "main": "dist/redux-api.min.js",
   "dependencies": {}
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-api",
-  "version": "0.8.10",
+  "version": "0.9.0",
   "author": {
     "name": "Efremov Alex",
     "email": "lexich121@gmail.com",

src/actionFn.js

@@ -27,6 +27,19 @@ function extractArgs(args) {
   return [pathvars, params, callback];
 }
 
+function helperCrudFunction(name) {
+  return (...args)=> {
+    const [pathvars, params, cb] = extractArgs(args);
+    return [pathvars, { ...params, method: name }, cb];
+  };
+}
+
+export const CRUD = reduce(["get", "post", "put", "delete", "patch"],
+  (memo, name)=> {
+    memo[name] = helperCrudFunction(name);
+    return memo;
+  }, {});
+
 /**
  * Constructor for create action
  * @param  {String} url          endpoint's url
@@ -151,7 +164,12 @@ export default function actionFn(url, name, options, ACTIONS={}, meta={}) {
     };
   };
 
-  return reduce(meta.helpers, (memo, func, helpername)=> {
+  let helpers = meta.helpers || [];
+  if (meta.crud) {
+    helpers = { ...CRUD, ...helpers };
+  }
+
+  return reduce(helpers, (memo, func, helpername)=> {
     if (memo[helpername]) {
       throw new Error(
         `Helper name: "${helpername}" for endpoint "${name}" has been already reserved`

src/index.js

@@ -97,8 +97,8 @@ export default function reduxApi(config) {
     }
 
     const {
-      url, options, transformer, broadcast,
-      reducerName, prefetch, postfetch, validation, helpers
+      url, options, transformer, broadcast, crud,
+      reducerName, prefetch, postfetch, validation, helpers,
     } = opts;
 
     const ACTIONS = {
@@ -117,7 +117,7 @@ export default function reduxApi(config) {
       virtual: !!opts.virtual,
       actions: memo.actions,
       prefetch, postfetch, validation,
-      helpers, transformer
+      helpers, transformer, crud
     };
 
     memo.actions[key] = actionFn(url, key, options, ACTIONS, meta);