Added jasmine example, added wrapper function around the mock

Author: mimo84

README.md

@@ -103,6 +103,55 @@ define(["angular","ng-socket-io"],function(ng){
 })
 ```
 
+### Example test using Jasmine
+Test.js
+```js
+describe('Controller: socketController', function () {
+
+    // load the controller's module
+    beforeEach(module('app'));
+
+    var socketController,
+      notify,
+      scope;
+
+    // Initialize the controller and a mock scope
+    beforeEach(inject(function ($controller, $rootScope, _notify_) {
+      scope = $rootScope.$new();
+      notify = _notify_;
+      socketController = $controller('socketController', {
+        $scope: scope
+      });
+
+    }));
+
+    it('The scope.items should change somehow', function() {
+      expect(scope.items.length).toEqual(0);
+      notify.receive('loadItems',{res: ['1','2','3']} )
+      expect(scope.items.length).toEqual(3);
+    });
+
+  });
+```
+
+```js
+'use strict';
+
+angular.module('app')
+  .controller('socketController', function ($scope, notify) {
+    // As first step to unit-test the socket, what we are
+    // going to do it is to try mocking an error, and changing
+    // a variable.
+    // This I hope it's easy enough to get started. It is not easy.
+
+
+    $scope.items = []
+    notify.on("loadItems", function(res){
+      $scope.items = res.res
+    });
+  });
+```
+
 ### Todo
 
 * Usage with sinon.js for spies

angular-socket.io-mock.js

@@ -1,39 +1,44 @@
 /* global angular: false */
 var ng = angular.module("btford.socket-io",[])
-ng.provider("socket",function(){
+ng.provider("socketFactory",function(){
   this.$get = function($rootScope){
 
-    var obj = {}
-    obj.events = {}
-    obj.emits = {}
-
-    // intercept 'on' calls and capture the callbacks
-    obj.on = function(eventName, callback){
-      if(!this.events[eventName]) this.events[eventName] = []
-      this.events[eventName].push(callback)
-    }
-
-    // intercept 'emit' calls from the client and record them to assert against in the test
-    obj.emit = function(eventName){
-      var args = Array.prototype.slice.call(arguments,1)
-
-      if(!this.emits[eventName])
-        this.emits[eventName] = []
-      this.emits[eventName].push(args)
-    }
-
-    //simulate an inbound message to the socket from the server (only called from the test)
-    obj.receive = function(eventName){
-      var args = Array.prototype.slice.call(arguments,1)
-
-      if(this.events[eventName]){
-        angular.forEach(this.events[eventName], function(callback){
-          $rootScope.$apply(function() {
-            callback.apply(this, args)
+    return function() {
+      var obj = {}
+      obj.events = {}
+      obj.emits = {}
+
+      // intercept 'on' calls and capture the callbacks
+      obj.on = function(eventName, callback){
+        if(!this.events[eventName]) this.events[eventName] = []
+        this.events[eventName].push(callback)
+      }
+
+      // intercept 'emit' calls from the client and record them to assert against in the test
+      obj.emit = function(eventName){
+        var args = Array.prototype.slice.call(arguments,1)
+
+        if(!this.emits[eventName])
+          this.emits[eventName] = []
+        this.emits[eventName].push(args)
+      }
+
+      //simulate an inbound message to the socket from the server (only called from the test)
+      obj.receive = function(eventName){
+        var args = Array.prototype.slice.call(arguments,1)
+
+        if(this.events[eventName]){
+
+          angular.forEach(this.events[eventName], function(callback){
+            $rootScope.$apply(function() {
+
+              callback.apply(this, args)
+            })
           })
-        })
+        }
       }
-    }
-    return obj
+
+      return obj
+    };
   }
 })

package.json

@@ -21,7 +21,7 @@
     "test"
   ],
   "devDependencies": {
-    "karma": "0.11.x"
+    "karma": "^0.12.9"
   },
   "scripts": {
     "test": "karma start --single-run --browsers PhantomJS"