release 1.0.0

Author: welefen

.eslintrc

@@ -0,0 +1,25 @@
+{
+  "parser": "babel-eslint",
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "rules": {
+    "strict": [0],
+    "eqeqeq": 2,
+    "quotes": [2, "single"],
+    "no-underscore-dangle": 0,
+    "eol-last": 0,
+    "camelcase": 0,
+    "no-loop-func": 0,
+    "no-trailing-spaces": 0,
+    "consistent-return": 0,
+    "new-cap": 0,
+    "no-shadow": 0,
+    //"semi": 0,
+    "no-process-exit": 0,
+    "no-empty": 0,
+    "yoda": 0,
+    "no-new-func": 0
+  }
+}

.gitignore

@@ -25,3 +25,5 @@ build/Release
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+
+lib/

.npmignore

@@ -0,0 +1,2 @@
+node_modules/
+coverage/

.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - '4'
+sudo: false
+script:
+    - "npm run test-cov"
+after_script: "npm install coveralls && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage"

README.md

@@ -1,3 +1,69 @@
 # think-ip-filter
 
-ip-filter for ThinkJS 2.0
+ip-filter middleware for ThinkJS 2.0 support blackList & whiteList.
+
+## Install
+
+```sh
+npm install think-ip-filter --save
+```
+
+## How to use
+
+### register middleware 
+
+create file if not exist, `src/common/bootstrap/middleware.js`.
+
+```js
+import ipFilter from 'think-ip-filter';
+think.middleware('ip_filter', ipFilter);
+```
+
+### config hook
+
+create file if not exist, `src/common/config/hook.js`.
+
+```js
+export default {
+  request_begin: ['prepend', 'ip_filter']
+}
+```
+
+### config ip whiteList or blackList
+
+add `ip_filter` config in file `src/common/config/config.js`.
+
+**black list**
+
+```js
+export default {
+  ip_filter: ['111.222.333.444', '120.*']
+}
+```
+
+**white list**
+
+```js
+export default {
+  ip_filter: {
+    whiteList: ['123.222.122.*']
+  }
+}
+```
+
+**dynamic load**
+
+dynamic load by function, must be return Promise.
+
+```js
+export default {
+  ip_filter: function(){
+    //such as: get from db
+    return Promise.resolve(['111.*']);
+  }
+}
+```
+
+## LICENSE
+
+MIT

package.json

@@ -0,0 +1,48 @@
+{
+  "name": "think-ip-filter",
+  "description": "ip filter middleware for ThinkJS 2.0, support whitelist & blacklist",
+  "version": "1.0.0",
+  "author": {
+    "name": "welefen",
+    "email": "[email protected]"
+  },
+  "scripts": {
+    "test": "mocha --reporter spec --timeout 5000 --recursive test/",
+    "test-cov": "istanbul cover --report html ./node_modules/mocha/bin/_mocha -- -t 5000 --recursive  -R spec test/",
+    "compile": "babel --loose all --optional runtime --stage 0 --modules common src/ --out-dir lib/",
+    "watch-compile": "npm run compile -- --watch",
+    "prepublish": "npm run compile",
+    "eslint": "eslint src/"
+  },
+  "contributors": [{
+    "name": "welefen",
+    "email": "[email protected]"
+  }],
+  "main": "lib/index.js",
+  "dependencies": {},
+  "devDependencies": {
+    "mocha": "1.20.1",
+    "istanbul": "0.4.0",
+    "babel": "5.8.23",
+    "thinkjs": "2.x.x",
+    "eslint": "1.8.0",
+    "babel-eslint": "4.1.3"
+  },
+  "keywords": [
+    "thinkjs",
+    "ip-filter",
+    "ipfilter"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/welefen/think-ip-filter"
+  },
+  "engines": {
+    "node": ">=0.12.0"
+  },
+  "license": "MIT",
+  "readmeFilename": "README.md",
+  "bugs": {
+    "url": "https://github.com/welefen/think-ip-filter/issues"
+  }
+}

src/index.js

@@ -0,0 +1,72 @@
+'use strict';
+/**
+ * ip filter, support blacklist & whitelist
+ */
+export default class extends think.middleware.base {
+  /**
+   * check ip is white
+   * @return {Boolean} []
+   */
+  checkIp(ip, ipList){
+    if(!think.isArray(ipList)){
+      ipList = [ipList];
+    }
+    let ips = ip.split('.');
+    let flag = ipList.some(item => {
+      if(think.isRegExp(item)){
+        return item.test(ip);
+      }
+      return item.split('.').every((num, i) => {
+        if (num === '*' || num === ips[i]) {
+          return true;
+        }
+      });
+    });
+    return flag;
+  }
+  /**
+   * show error
+   * @return {Promise} []
+   */
+  showError(){
+    this.http.error = new Error('ip is not allowed');
+    return think.statusAction(403, this.http);
+  }
+  /**
+   * run
+   * @return {Promise} []
+   */
+  async run(){
+
+    let config = this.config('ip_filter');
+    if(!config){
+      return;
+    }
+
+    //get config by dynamic
+    if(think.isFunction(config)){
+      config = await think.co.wrap(config)(this.http) || [];
+    }
+
+    //only blackList
+    if(think.isArray(config)){
+      config = {blackList: config};
+    }
+
+    let ip = this.http.ip();
+    if(!think.isEmpty(config.whiteList)){
+      let flag = this.checkIp(ip, config.whiteList);
+      if(!flag){
+        return this.showError();
+      }
+      return;
+    }
+    
+    if(!think.isEmpty(config.blackList)){
+      let flag = this.checkIp(ip, config.blackList);
+      if(flag){
+        return this.showError();
+      }
+    }
+  }
+}