Merge pull request #18 from lexich/request_method

Extract `request` method for pure xhr request

README.md

@@ -337,8 +337,11 @@ dispatch(rest.actions.entries.sync());
 
 ###Actions sub methods
 
-#### sync
+#### sync(urlparams, params, callback)
 - @description: this method save you from twice requests flag `sync`. if `sync===true` requst wouldn't execute. In server-side mode calls twice
+- @param **urlparams**  - update url according Url schema
+- @param **params**     - add additional params to rest request
+- @param **callback**   - callback function when action ends
 - @type: Function
 - @example:
 
@@ -350,7 +353,7 @@ function onEnter(state, replaceState, callback) {
 
 ```
 
-#### reset
+#### reset()
 - @description: Reset state of current reducer
 - @type: Function
 - @example:
@@ -362,6 +365,16 @@ function onLeave(state, replaceState, callback) {
 
 ```
 
+#### request()
+- @description: Pure xhr request without sending events or catching reducers.
+- @type: Function
+- @example:
+```js
+import {actions} from "./rest";
+actions.entries.request().then((data)=> {
+  ....
+});
+```
 
 ### Url schema
 /api/v1/user/:id

bower.json

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

examples/isomorphic/app/pages/Repo.jsx

@@ -5,17 +5,18 @@ import { Link } from "react-router";
 class Repo extends React.Component {
   render() {
     const { repo } = this.props;
-    const data = repo.data;
+    const data = repo.data || {};
+    const owner = data.owner || {};
     return !repo.loading ? (
       <div className="Repo media">
         <div className="media-left">
-          <Link to={`/${data.owner.login}`}>
-            <img className="Repo__media media-object" src={data.owner.avatar_url } />
+          <Link to={`/${owner.login}`}>
+            <img className="Repo__media media-object" src={owner.avatar_url } />
           </Link>
         </div>
         <div className="media-body">
           <h4>{ data.name }</h4>
-          <Link to={`/${data.owner.login}`}>@{ data.owner.login }</Link>&nbsp;
+          <Link to={`/${owner.login}`}>@{ owner.login }</Link>&nbsp;
           Stars { data.stargazers_count } Forks {data.forks }
         </div>
       </div>) : ( <div className="Repo">Loading</div> );

examples/isomorphic/package.json

@@ -12,15 +12,14 @@
   "dependencies": {
     "ejs": "^2.3.4",
     "express": "^4.13.3",
-    "history": "^1.11.1",
+    "history": "^1.12.5",
     "isomorphic-fetch": "^2.1.1",
     "react": "^0.14.0",
+    "react-dom": "^0.14.0",
     "react-redux": "^3.0.0",
     "react-router": "^1.0.0-rc3",
     "redux": "^3.0.2",
-    "redux-thunk": "^1.0.0",
-    "react-dom": "^0.14.0",
-    "whatwg-fetch": "^0.9.0"
+    "redux-thunk": "^1.0.0"
   },
   "devDependencies": {
     "babel-core": "^5.8.25",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-api",
-  "version": "0.6.6",
+  "version": "0.6.7",
   "author": {
     "name": "Efremov Alex",
     "email": "lexich121@gmail.com",
@@ -26,19 +26,19 @@
   "dependencies": {
     "fast-apply": "0.0.3",
     "lodash": "^3.10.1",
-    "qs": "^5.1.0"
+    "qs": "^5.2.0"
   },
   "devDependencies": {
     "babel": "^5.8.23",
     "babel-eslint": "^4.1.3",
     "babel-loader": "^5.3.2",
     "chai": "^3.3.0",
     "coveralls": "^2.11.4",
-    "eslint": "^1.5.1",
+    "eslint": "^1.6.0",
     "eslint-config-airbnb": "^0.1.0",
-    "eslint-plugin-react": "^3.4.2",
+    "eslint-plugin-react": "^3.5.1",
     "husky": "^0.10.1",
-    "istanbul": "^0.3.21",
+    "istanbul": "^0.3.22",
     "mocha": "^2.3.3",
     "mocha-lcov-reporter": "^1.0.0",
     "webpack": "^1.12.2"

src/actionFn.js

@@ -37,6 +37,20 @@ function extractArgs(args) {
 export default function actionFn(url, name, options, ACTIONS={}, meta={}) {
   const {actionFetch, actionSuccess, actionFail, actionReset} = ACTIONS;
   const pubsub = new PubSub();
+
+  /**
+   * Fetch data from server
+   * @param  {Object}   pathvars    path vars for url
+   * @param  {Object}   params      fetch params
+   * @param  {Function} getState    helper meta function
+  */
+  const request = (pathvars, params, getState=none)=> {
+    const urlT = urlTransform(url, pathvars);
+    const baseOptions = isFunction(options) ? options(urlT, params, getState) : options;
+    const opts = { ...baseOptions, ...params };
+    return meta.holder.fetch(urlT, opts);
+  };
+
   /**
    * Fetch data from server
    * @param  {Object}   pathvars    path vars for url
@@ -45,8 +59,6 @@ export default function actionFn(url, name, options, ACTIONS={}, meta={}) {
    */
   const fn = (...args)=> {
     const [pathvars, params, callback] = extractArgs(args);
-
-    const urlT = urlTransform(url, pathvars);
     const syncing = params ? !!params.syncing : false;
     params && delete params.syncing;
     pubsub.push(callback);
@@ -56,19 +68,15 @@ export default function actionFn(url, name, options, ACTIONS={}, meta={}) {
       if (store && store.loading) {
         return;
       }
-
       dispatch({ type: actionFetch, syncing});
-      const baseOptions = isFunction(options) ? options(urlT, params, getState) : options;
-      const opts = { ...baseOptions, ...params };
-
       const fetchResolverOpts = {
         dispatch, getState,
         actions: meta.actions,
         prefetch: meta.prefetch
       };
 
       fetchResolver(0, fetchResolverOpts,
-        (err)=> err ? pubsub.reject(err) : meta.holder.fetch(urlT, opts)
+        (err)=> err ? pubsub.reject(err) : request(pathvars, params, getState)
           .then((data)=> !meta.validation ? data :
               new Promise((resolve, reject)=> meta.validation(data,
                 (err)=> err ? reject(err) : resolve(data))))
@@ -83,10 +91,17 @@ export default function actionFn(url, name, options, ACTIONS={}, meta={}) {
           }));
     };
   };
+
+  /*
+    Pure rest request
+   */
+  fn.request = request;
+
   /**
    * Reset store to initial state
    */
   fn.reset = ()=> ({type: actionReset});
+
   /**
    * Sync store with server. In server mode works as usual method.
    * If data have already synced, data would not fetch after call this method.

test/actionFn_spec.js

@@ -74,6 +74,19 @@ describe("actionFn", function() {
     return Promise.all([async1, async2]);
   });
 
+  it("check request method", function() {
+    let executeCounter = 0;
+    const api = actionFn("/test", "test", null, ACTIONS, {holder: {fetch: ()=> {
+      executeCounter++;
+      return fetchSuccess();
+    }}});
+    const async = api.request();
+    expect(async).to.be.an.instanceof(Promise);
+    return async.then((data)=> {
+      expect(data).to.eql({msg: "hello"});
+    });
+  });
+
   it("check normal usage", function() {
     const api = actionFn("/test", "test", null, ACTIONS, {holder: { fetch: fetchSuccess}});
     expect(api.reset()).to.eql({type: ACTIONS.actionReset });