From 844f86939bbc1a7fe5137165cfedea696b5e504f Mon Sep 17 00:00:00 2001
From: Zlobin Eugene <creastar@gmail.com>
Date: Mon, 16 May 2016 15:55:35 +0600
Subject: [PATCH] Add es-middleware dependency, readme fixes, new dependecy
 versions

---
 README.md               | 116 ++++++++++++++++++++++++++++------------
 package.json            |  25 ++++-----
 src/ajax.js             |  14 +++--
 src/api/xhr-abstract.js |  12 +++--
 src/api/xhr.js          |  35 +-----------
 test/index.js           |  48 ++++++++++++++---
 webpack.config.js       |   7 ++-
 7 files changed, 158 insertions(+), 99 deletions(-)

diff --git a/README.md b/README.md
index 8627ace..8a0073e 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 
-# Ajax requests in JavaScript
+# Ajax requests in JavaScript [![Build Status](https://travis-ci.org/Zlobin/es-ajax.png?branch=master)](https://travis-ci.org/Zlobin/es-ajax)
 
 ## Synopsis
 
@@ -11,18 +11,27 @@ The library is affording have full control for each external requests. Through A
 
 ## Dependencies
 
-Dependencies: [object-hash](https://www.npmjs.com/package/object-hash), [qs](https://www.npmjs.com/package/qs)
+Dependencies: [object-hash](https://www.npmjs.com/package/object-hash), [qs](https://www.npmjs.com/package/qs), [es-middleware](https://www.npmjs.com/package/es-middleware)
+
+## Installation
+
+`npm i --save es-ajax`
+or
+`git clone https://github.com/Zlobin/es-ajax.git`
+`cd es-ajax && npm i && webpack`
 
 ## Examples
 
 ```javascript
 var ajax = require('es-ajax');
 ```
-Or
+Or after running `npm i && webpack` inside library path:
 ```html
 <script src="<PATH/TO/LIBRARY>/dist/bundle.js">
 ```
 
+You can test some stuff inside /demo/ path.
+
 ```js
 // GET
 ajax('/some/url')
@@ -52,30 +61,21 @@ ajax('/some/url')
   })
   .then(function(response) {
     // response.headers
-    // response.status
-    // response.statusText
-    // response.type
-    // response.url
+    // response.response
 
-    if (response.status !== 200) {
-      console.log('Something wrong status:' + response.status);
-    } else {
-      response
-        .json()
-        .then(function(data) {
-          console.log(data);
-        });
-    }
+    // ... some stuff
   })
   .catch(function(err) {
     console.log(err);
   });
 ```
 
+You can change content-type of request, available types: 'json', 'text', 'html'
+
 ```js
 ajax('/some/url', {
-  type: 'json'
-})
+    type: 'json'
+  })
   .get()
   .then(function() {
     // ...
@@ -85,14 +85,31 @@ ajax('/some/url', {
   });
 ```
 
-Middleware is calling before a request was sent. It can cancel request, change URL, headers before sending.
-May be used, for instance, when you want to to some cache library. An example:
+Or you can add type manually, via headers:
+
 ```js
-var cache = function(headers, request, time) {
+ajax('/some/url', {
+    headers: {
+      'Content-type': 'my-type'
+    }
+  })
+  .get()
+  .then(function() {
+    // ...
+  })
+  .catch(function() {
+    // ...
+  });
+```
+
+:TODO
+Middleware is the programming pattern of providing hooks with a resume callback. It will be calling before a request was sent. It is able to cancel request, change URL and headers before sending. May be used, for instance, when you want to use some cache library, allow only some http-methods, like GET and POST, for instance. Some examples:
+```js
+var cache = function(next) {
   var response = null;
 
   // For instance, we don't do cache for URL what contains "noCache" parameter.
-  if (request.url.indexOf('noCache') > 0) {
+  if (this.request.url.indexOf('noCache') > 0) {
     // Check if we already have cached resulst from some MyCache library.
     response = MyCache.get({
       url: request.url,
@@ -103,16 +120,18 @@ var cache = function(headers, request, time) {
       console.log('Data from cache.');
       // Do not send request to the server.
       // Return cached response.
+      // @todo
     } else {
       console.log('Send request to the server.');
-      // Send request.
-      // Add response to the cache.
+      next();
     }
+  } else {
+    next();
   }
 };
 
 ajax()
-  .applyMiddleware([cache]);
+  .use([cache]);
 
 // First request will be send to the server.
 ajax('/foo/bar')
@@ -122,7 +141,43 @@ ajax('/foo/bar')
     ajax('/foo/bar')
       .get();    
   })
-  .catch();
+  .catch(function() {
+    // ...
+  });
+```
+
+Or if you want to allow to use only GET requests:
+
+```js
+var onlyGet = function(request, next) {
+  if (request.method === 'GET') {
+    next();
+  }
+
+  throw new Error('Allows only GET methods');
+  // ...
+};
+
+ajax()
+  .use([onlyGet]);
+
+ajax('/foo/bar')
+  .get()
+  .then(function() {
+    // ... succeed
+  })
+  .catch(function() {
+    // ...
+  });
+
+  ajax('/foo/bar')
+    .get()
+    .then(function() {
+      // ...
+    })
+    .catch(function() {
+      // ... failed
+    });
 ```
 
 ## API
@@ -133,7 +188,7 @@ ajax('/foo/bar')
 - **<code>getXhrMeta</code> Get meta info for the current request**
 - **<code>getAllRequests</code> Get info about each sent request**
 - **<code>setTimeout</code> Set timeout when reqeust should be canceled automatically**
-- **<code>applyMiddleware</code> no description**
+- **<code>use</code> add middleware functions**
 
 ##### Non-static, should be used with a XHR (fetch) instance.
 - **<code>setOverride</code> Set override for DELETE, PUT requests**
@@ -151,10 +206,6 @@ ajax('/foo/bar')
 
 Tests are performed using "mocha", "sinon", "expect" libraries, PhantomJS as a browser and "karma" as a server. Run `npm test`.
 
-## Building the documentation
-
-You can use JSDoc comments found within the source code.
-
 ## Minifying
 
 You can grab minified versions of es-ajax from /dist path after running `webpack`.
@@ -164,5 +215,4 @@ You can grab minified versions of es-ajax from /dist path after running `webpack
 1. Middleware
 2. Send more than one file
 3. Add more tests
-4. Finish demo
-5. Singleton request
+4. Singleton request
diff --git a/package.json b/package.json
index a9cb4a2..fa26b88 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "es-ajax",
   "description": "Ajax (fetch or xhr2) with promises - an useful JavaScript library for convenient work with ajax requests in a browser.",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "main": "src/index.js",
   "author": {
     "name": "Eugene Zlobin",
@@ -32,28 +32,29 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "es-middleware": "^1.0.1",
     "object-hash": "^1.1.2",
     "qs": "^6.1.0"
   },
   "devDependencies": {
-    "babel-cli": "^6.7.7",
-    "babel-core": "^6.7.7",
+    "babel-cli": "^6.8.0",
+    "babel-core": "^6.8.0",
     "babel-loader": "^6.2.4",
-    "babel-plugin-transform-export-extensions": "^6.5.0",
-    "babel-plugin-transform-object-rest-spread": "^6.6.5",
+    "babel-plugin-transform-export-extensions": "^6.8.0",
+    "babel-plugin-transform-object-rest-spread": "^6.8.0",
     "babel-preset-es2015": "^6.6.0",
     "babel-preset-stage-2": "^6.5.0",
-    "eslint": "^2.8.0",
-    "eslint-config-airbnb": "^8.0.0",
+    "eslint": "^2.10.1",
+    "eslint-config-airbnb": "^9.0.1",
     "eslint-loader": "^1.3.0",
-    "eslint-plugin-import": "^1.6.0",
-    "eslint-plugin-jsx-a11y": "^1.0.3",
-    "eslint-plugin-react": "^5.0.1",
-    "expect": "^1.18.0",
+    "eslint-plugin-import": "^1.8.0",
+    "eslint-plugin-jsx-a11y": "^1.2.0",
+    "eslint-plugin-react": "^5.1.1",
+    "expect": "^1.20.1",
     "karma": "^0.13.22",
     "karma-mocha": "^0.2.2",
     "karma-phantomjs-launcher": "^1.0.0",
-    "karma-sinon": "^1.0.4",
+    "karma-sinon": "^1.0.5",
     "karma-webpack": "^1.7.0",
     "mocha": "^2.4.5",
     "phantomjs-prebuilt": "^2.1.7",
diff --git a/src/ajax.js b/src/ajax.js
index f33fe50..647d395 100644
--- a/src/ajax.js
+++ b/src/ajax.js
@@ -3,11 +3,12 @@ import factory from './utils/factory';
 import { contentTypes } from './utils/content-types';
 import objectHash from 'object-hash';
 import { is } from './utils/is';
+import Middleware from 'es-middleware';
 
 const _requests = new Set();
 const _meta = new Map();
+const mw = new Middleware();
 let _timeout = 0;
-let _middleware = [];
 
 export function ajax(url, parameters = {}) {
   const defaults = {
@@ -41,6 +42,7 @@ export function ajax(url, parameters = {}) {
   if (!xhrApi && url) {
     // Create new instance.
     xhrApi = factory(settings.api, url, settings.request, settings.headers);
+    xhrApi.setMiddlewareRun(mw.run);
     xhrApi.onBeforeSend(params => {
       const { headers, request, time } = params;
       const hash = objectHash({
@@ -63,10 +65,6 @@ export function ajax(url, parameters = {}) {
 
       xhrApi.setTimeout(_timeout);
     });
-
-    if (_middleware.length) {
-      xhrApi.applyMiddleware(_middleware);
-    }
   }
 
   function proxy(name) {
@@ -145,8 +143,8 @@ export function ajax(url, parameters = {}) {
     return this;
   }
 
-  function applyMiddleware(functions) {
-    _middleware = functions;
+  function use(functions) {
+    mw.use(functions);
 
     return this;
   }
@@ -158,7 +156,7 @@ export function ajax(url, parameters = {}) {
     getXhrMeta,
     getAllRequests,
     setTimeout,
-    applyMiddleware,
+    use,
     // Non-static, should be used with a XHR (fetch) instance.
     setOverride: proxy('setOverride'),
     options: proxy('options'),
diff --git a/src/api/xhr-abstract.js b/src/api/xhr-abstract.js
index b87f238..4838060 100644
--- a/src/api/xhr-abstract.js
+++ b/src/api/xhr-abstract.js
@@ -39,10 +39,6 @@ export default class XhrAbstract {
     this.setHeaders(methodsOverride(methodName));
   }
 
-  applyMiddleware() {
-    // ...
-  }
-
   head() {
     this.setRequest({
       method: methods.head,
@@ -114,6 +110,14 @@ export default class XhrAbstract {
     return this.send();
   }
 
+  setMiddlewareRun(middleware) {
+    if (!is._function(middleware)) {
+      throw new TypeError('Parameter must be a function.');
+    }
+
+    this.run = middleware;
+  }
+
   send() {
     //
   }
diff --git a/src/api/xhr.js b/src/api/xhr.js
index 9615098..d19f398 100644
--- a/src/api/xhr.js
+++ b/src/api/xhr.js
@@ -6,14 +6,6 @@ import { methods } from './utils/methods';
 import asObject from './utils/as-object';
 import { is } from '../utils/is';
 
-/*
-  XHR2 specification.
-  @link https://xhr.spec.whatwg.org/
-
-  XHR2 examples.
-  @link http://www.html5rocks.com/en/tutorials/file/xhr2/
-*/
-
 export default class XhrAPI extends XhrAbstract {
   constructor(url, request = {}, headers = {}) {
     super();
@@ -22,7 +14,6 @@ export default class XhrAPI extends XhrAbstract {
 
     self._shouldOverride = true;
     self._onBeforeSend = null;
-    self._middleware = [];
     self._onProgress = null;
     self._timeout = null;
     self._defaultHeaders = {
@@ -48,20 +39,6 @@ export default class XhrAPI extends XhrAbstract {
     return this;
   }
 
-  applyMiddleware(functions) {
-    if (!is._array(functions)) {
-      throw new Error('Parameter should be an Array.');
-    }
-
-    functions.forEach(
-      func => {
-        if (is._function(func)) {
-          self._middleware.push(func);
-        }
-      }
-    );
-  }
-
   setOverride(method = [], callback = () => {}) {
     const shouldOverride = isTrue =>
       (internal(this)._shouldOverride = isTrue && callback(isTrue));
@@ -88,6 +65,7 @@ export default class XhrAPI extends XhrAbstract {
   }
 
   send(isFile = false) {
+    // @todo wrap around this.run
     const self = internal(this);
     const xhr = self._xhr;
     const { method, async, body } = self._requests;
@@ -171,17 +149,6 @@ export default class XhrAPI extends XhrAbstract {
 
         xhr.timeout = self._timeout;
 
-        /*
-        @todo middleware
-        if (self._middleware.length) {
-          self._middleware.forEach(
-            func => {
-              func(params);
-            }
-          );
-        }
-        */
-
         xhr.send(data);
       } catch (error) {
         rejected(null, error, {});
diff --git a/test/index.js b/test/index.js
index 3e31900..32a4b0c 100644
--- a/test/index.js
+++ b/test/index.js
@@ -1,7 +1,9 @@
 import expect from 'expect';
 
 const URL = '/';
-const fakeServer = sinon.fakeServer.create();
+const defaultMethod = 'GET';
+const fakeServer = sinon.fakeServerWithClock.create();
+const clock = sinon.useFakeTimers();
 
 function prepareRespond(url, method = 'GET') {
   const response = {
@@ -23,13 +25,14 @@ function prepareRespond(url, method = 'GET') {
 
 function respond() {
   fakeServer.respond();
+  console.log('fakeServer', fakeServer.requests[fakeServer.requests.length - 1].requestHeaders);
   fakeServer.restore();
 }
 
-function send(url, method, done) {
+function send(url, method, done, parameters = {}) {
   prepareRespond(url, method);
   method = method === 'DELETE' ? 'del' : method.toLowerCase();
-  ajax(url)[method]()
+  ajax(url)[method](parameters)
     .then(() => done())
     .catch(() => done('An error occured'));
   respond();
@@ -80,7 +83,15 @@ describe('1. es-ajax test', () => {
   });
 
   describe('1.3: Set headers', () => {
-    // ...
+    const parameters = {
+      headers: {
+        foo: 'bar',
+        bar: 'baz'
+      }
+    };
+
+    it(`1.3.1: should set headers`, done =>
+      send(URL, defaultMethod, done, parameters));
   });
 
   describe('1.4: Cancel request', () => {
@@ -92,7 +103,30 @@ describe('1. es-ajax test', () => {
   });
 
   describe('1.6: Set timeout', () => {
-    // ...
+    /*
+    it('1.4.1: timeout should be reached after 2000 ms', done => {
+      const responseTimeout = 3000; // ms
+      const requestTimeout = 2000; // s
+      const method = 'GET';
+
+      prepareRespond(URL, method);
+      ajax().setTimeout(requestTimeout);
+
+      ajax(URL)[method.toLowerCase()]()
+        .then((response) => {
+          console.log('response', response);
+          done('Fail. Timeout should be reached');
+        })
+        .catch(response => {
+          if (response.response === 'Timeout passed before request was completed.') {
+            done();
+          } else {
+            done('Fail. Timeout should be reached');
+          }
+        });
+
+      clock.tick(responseTimeout)  && respond();
+    }); */
   });
 
   describe('1.7: Abort all requests', () => {
@@ -100,7 +134,9 @@ describe('1. es-ajax test', () => {
   });
 
   describe('1.8: Get request ID', () => {
-    // ...
+    it('1.8.1: should return request ID', () =>
+      expect(ajax(URL).getXhrId().toString()).toMatch(/Symbol.*/)
+    );
   });
 
   describe('1.9: Get request meta information', () => {
diff --git a/webpack.config.js b/webpack.config.js
index d85dcc9..3fe2bb0 100644
--- a/webpack.config.js
+++ b/webpack.config.js
@@ -5,7 +5,7 @@ const webpack = require('webpack');
 const fs = require('fs');
 
 const env = process.env.NODE_ENV || 'development';
-const isProduction = false; //(env === 'production');
+const isProduction = (env === 'production');
 
 let plugins = [
   new webpack.optimize.OccurenceOrderPlugin(),
@@ -49,7 +49,10 @@ module.exports = {
     loaders: [
       {
         test: /\.js$/,
-        include: path.join(__dirname, 'src'),
+        include: [
+          path.join(__dirname, 'src'),
+          /node_modules\/(es-middleware)/
+        ],
         loaders: ['babel']
       }
     ]