minor style changes; readme update

fessnecro · Mar 24, 2018 · 4b7784e · 4b7784e
1 parent bdeda08
commit 4b7784e
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 83 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@
 node_modules
 npm-debug.log
 .coveralls.yml
-coverage
+coverage
+localtest.js
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 [![](https://nodei.co/npm/socket-anti-spam.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/socket-anti-spam)
+
 [![](https://david-dm.org/michaeldegroot/socket-anti-spam.svg 'deps') ](https://david-dm.org/michaeldegroot/socket-anti-spam 'david-dm')
 [![](https://travis-ci.org/michaeldegroot/socket-anti-spam.svg?branch=master 'testing') ](https://travis-ci.org/michaeldegroot/socket-anti-spam 'travis-ci')
 [![](https://coveralls.io/repos/michaeldegroot/socket-anti-spam/badge.svg?branch=master&service=github)](https://coveralls.io/github/michaeldegroot/socket-anti-spam?branch=master)
@@ -8,6 +9,7 @@
 ___
 # What it does
 
+
 Keeps track of how many socket.emit's an ip has submitted under a certain timeframe and determine if it is spammy behaviour.
 If the module determined the user is spamming the socket will receive a temp ip ban. Everything is customizable.
 
@@ -21,7 +23,6 @@ if the spamScore is above a certain spamScore threshold the socket will be disco
 If the socket keeps spamming after a certain kick threshold, the socket will be temp ip banned.
 
 
-
 [You can see a demo of the module in action here, please remember that this is from previous versions and the appearances might look different](https://bitbucket.org/repo/kR4677/images/1013607973-socketspam.gif)
 ___
 # Changelog
@@ -31,23 +32,29 @@ ___
 ___
 #  Getting started
 
+
 ##### 1. Start by installing the package:
-    yarn add socket-anti-spam
+  npm install socket-anti-spam
 
 ##### 2. Load the code
 
 ```javascript
-  const antiSpam  = require('socket-anti-spam')
+  const SocketAntiSpam  = require('socket-anti-spam')
   const socket-io = require('socket.io').listen(8080)
 
-  antiSpam.init({
-      banTime:            30,         // Ban time in minutes
-      kickThreshold:      2,          // User gets kicked after this many spam score
-      kickTimesBeforeBan: 1,          // User gets banned after this many kicks
-      banning:            true,       // Uses temp IP banning after kickTimesBeforeBan
-      heartBeatStale:     40,         // Removes a heartbeat after this many seconds
-      heartBeatCheck:     4,          // Checks a heartbeat per this many seconds
-      io:                 socket-io,  // Bind the socket.io variable
+  const socketAntiSpam = new SocketAntiSpam({
+    banTime:            30,         // Ban time in minutes
+    kickThreshold:      2,          // User gets kicked after this many spam score
+    kickTimesBeforeBan: 1,          // User gets banned after this many kicks
+    banning:            true,       // Uses temp IP banning after kickTimesBeforeBan
+    heartBeatStale:     40,         // Removes a heartbeat after this many seconds
+    heartBeatCheck:     4,          // Checks a heartbeat per this many seconds
+    io:                 socket-io,  // Bind the socket.io variable
+  })
+
+  // Call functions with created reference 'socketAntiSpam'
+  socketAntiSpam.event.on('ban', data => {
+    // Do stuff
   })
 ````
 
@@ -64,9 +71,7 @@ _Event fires when a socket authenticates with the socket-anti-spam module_
 __Example__
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
-antiSpam.event.on('authenticate', socket => {
+socketAntiSpam.event.on('authenticate', socket => {
   // We have the socket var that tried to authenticate
 
 
@@ -82,9 +87,7 @@ _Event fires when a socket was kicked_
 __Example__
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
-antiSpam.event.on('kick', (socket, data) => {
+socketAntiSpam.event.on('kick', (socket, data) => {
   // We have the socket var that was kicked
 
   // The second parameter is a object that was binded to the socket with some extra information
@@ -99,9 +102,7 @@ _Event fires when a socket was banned_
 __Example__
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
-antiSpam.event.on('ban', (socket, data) => {
+socketAntiSpam.event.on('ban', (socket, data) => {
   // We have the socket var that was banned
 
   // The second parameter is a object that was binded to the socket with some extra information
@@ -116,9 +117,7 @@ _Event fires when a socket received a new spamscore_
 __Example__
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
-antiSpam.event.on('spamscore', (socket, data) => {
+socketAntiSpam.event.on('spamscore', (socket, data) => {
   // We have the socket var that received a new spamscore update
 
   // The second parameter is a object that was binded to the socket with some extra information
@@ -142,12 +141,9 @@ __Example__
 
 ````js
 const io = require('socket.io')
-const antiSpam = require('socket-anti-spam')
-
 io.sockets.on('connection', socket => {
     socket.on('chatMessage', () => {
-        antiSpam.addSpam(socket) // Adds a spamscore because this socket sent a emit
-
+        socketAntiSpam.addSpam(socket) // Adds a spamscore because this socket sent a emit
         // The rest of your code
     })
 })
@@ -159,9 +155,7 @@ _Returns a array full of ip's that are currently banned_
 __Example__
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
-const bans = antiSpam.getBans()
+const bans = socketAntiSpam.getBans()
 console.log(bans)   // Returns a array full of ip's that are currently banned
 ````
 ###  .ban(data,minutes)
@@ -174,18 +168,14 @@ _Simply bans a socket or ip_
 __Example__ banning a ip in string format
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
-antiSpam.ban('127.0.0.1') // Bye!
+socketAntiSpam.ban('127.0.0.1') // Bye!
 ````
 
 __Example__ banning a socket, and set ban time for 5 minutes
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
 io.sockets.on('connection', socket => {
-    antiSpam.ban(socket, 5)
+    socketAntiSpam.ban(socket, 5)
 })
 ````
 ###  .unBan(data)
@@ -197,18 +187,14 @@ _Simply unbans a socket or ip_
 __Example__ unbanning a ip in string format
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
-antiSpam.unban('127.0.0.1') // He's back!
+socketAntiSpam.unban('127.0.0.1') // He's back!
 ````
 
 __Example__ unbanning a socket
 
 ````js
-const antiSpam = require('socket-anti-spam')
-
 io.sockets.on('connection', socket => {
-    antiSpam.unBan(socket)
+    socketAntiSpam.unBan(socket)
 })
 ````
 

diff --git a/antispam.js b/antispam.js
@@ -102,8 +102,9 @@ class SocketAntiSpam {
     debug('Authenticating socket', socket.id)
     return new Promise((resolve, reject) => {
       try {
-        if (this.not(socket.ip))
+        if (this.not(socket.ip)) {
           socket.ip = socket.client.request.headers['x-forwarded-for'] || socket.client.conn.remoteAddress
+        }
 
         this.event.emit('authenticate', socket)
         if (typeof(this.users[socket.ip]) == 'undefined') {
@@ -149,7 +150,7 @@ class SocketAntiSpam {
 
       this.authenticate(socket).then(data => {
         if (data.banned) {
-          return resolve()
+          return reject(new Error('socket is banned'))
         }
 
         const lastInteraction = moment.duration(moment().diff(data.lastInteraction)).asSeconds()
@@ -191,7 +192,7 @@ class SocketAntiSpam {
         }
 
         debug('Current spamscore of', socket.id, 'is', data.score)
-        return resolve()
+        return resolve(data)
       }).catch(e => {
         return reject(e)
       })
@@ -200,30 +201,49 @@ class SocketAntiSpam {
 
   ban(data, min) {
     debug('Banning', data, min)
-    if (this.not(data))
+    if (this.not(data)) {
       throw new Error('No options defined')
-    if (this.not(min))
+    }
+
+    if (this.not(min)) {
       min = this.options.banTime
+    }
+
     let ip = false
-    if (typeof(this.users[data]) !='undefined')
+    if (typeof(this.users[data]) !='undefined') {
       ip = data
-    if (typeof(this.users[data.ip]) != 'undefined')
+    }
+
+    if (typeof(this.users[data.ip]) != 'undefined') {
       ip = data.ip
-    if (ip)
+    }
+
+    if (ip) {
       return this.banUser(true, ip)
+    }
+
     return false
   }
 
   unBan(data) {
     debug('Unbanning', data)
-    if (this.not(data))
+    if (this.not(data)) {
       throw new Error('No options defined')
+    }
+
     let ip = false
-    if (typeof(this.users[data])!='undefined')
+    if (typeof(this.users[data]) != 'undefined') {
       ip = data
-    if (typeof(this.users[data.ip])!='undefined')
+    }
+
+    if (typeof(this.users[data.ip]) != 'undefined') {
       ip = data.ip
-    if (ip) return this.banUser(false, ip)
+    }
+
+    if (ip) {
+      return this.banUser(false, ip)
+    }
+
     return false
   }
 

diff --git a/localtest.js b/localtest.js