added some samples on how to write unit tests + fixed minor ugly API handling

Author: Christian Jeschke

README.md

@@ -120,7 +120,7 @@ server in order to test your applications:
 ```javascript
     var $websocketBackend;
 
-    beforeEach(angular.mock.module('ngWebSocket', 'ngWebSocketMock');
+    beforeEach(angular.mock.module('ngWebSocket', 'ngWebSocketMock'));
 
     beforeEach(inject(function (_$websocketBackend_) {
       $websocketBackend = _$websocketBackend_;

dist/angular-websocket-mock.js

@@ -54,6 +54,7 @@
     };
 
     this.fakeClose = function (url, code) {
+      closeQueue.push(url);
       if (existingMocks[url]) {
         existingMocks[url].map(function (mockSocket) {
           mockSocket.close(code);

example/howToTest/controller.js

@@ -0,0 +1,25 @@
+angular.module("appToTest", ['ngWebSocket']).controller("ControllerToTest", ["$scope", "$websocket", function($scope, $websocket) {
+	var socket;
+	$scope.isConnected = false;
+
+	function initializeSocket() {
+		socket.onOpen(function() {
+			$scope.isConnected = true;
+		});
+		socket.onClose(function() {
+			$scope.isConnected = false;
+		});
+		socket.onMessage(function(message) {
+			$scope.lastReceivedMessage = JSON.parse(message.data);
+		});
+	}
+
+	$scope.connect = function() {
+		socket = $websocket("wss://foo");
+		initializeSocket();
+	};
+
+	$scope.sendMessage = function(sMessage) {
+		socket.send(sMessage);
+	};
+}]);

example/howToTest/controller.spec.js

@@ -0,0 +1,57 @@
+describe("ControllerToTest", function() {
+	var controller, $scope, $websocketBackend;
+
+	beforeEach(angular.mock.module('ngWebSocket', 'ngWebSocketMock'));
+
+	beforeEach(function() {
+		module("appToTest");
+		inject(function(_$websocketBackend_, _$controller_) {
+			$websocketBackend = _$websocketBackend_;
+			$scope = {};
+      		controller = _$controller_('ControllerToTest', { $scope: $scope });
+		});
+
+		$websocketBackend.expectConnect("wss://foo");
+	});
+
+	afterEach(function() {
+		$websocketBackend.verifyNoOutstandingRequest();
+		$websocketBackend.verifyNoOutstandingExpectation();
+	});
+
+	function connect() {
+		$scope.connect();
+		$websocketBackend.flush();
+	}
+
+	it("should initiate a connection on connect", function() {
+		connect();
+	});
+
+	it("should react on an established connection", function() {
+		expect($scope.isConnected).toEqual(false);
+		connect();
+		expect($scope.isConnected).toEqual(true);
+	});
+
+	it("should react on a closing connection", function() {
+		connect();
+		$websocketBackend.fakeClose("wss://foo");
+		$websocketBackend.flush();
+		expect($scope.isConnected).toEqual(false);
+	});
+
+	it("should react on an incoming message", function() {
+		connect();
+		$websocketBackend.fakeMessage("wss://foo", "hello");
+		$websocketBackend.flush();
+		expect($scope.lastReceivedMessage).toEqual("hello");
+	});
+
+	it("should send a message to the socket", function() {
+		connect();
+		$websocketBackend.expectSend("wss://foo", "greetings");
+		$scope.sendMessage("greetings");
+		$websocketBackend.flush();
+	});
+});

example/howToTest/karma.conf.js

@@ -0,0 +1,65 @@
+// Karma configuration
+// Generated on Thu Dec 25 2014 14:12:24 GMT-0800 (PST)
+
+module.exports = function(config) {
+
+  var configuration = {
+
+    // base path, that will be used to resolve files and exclude
+    basePath: '',
+
+    // frameworks to use
+    frameworks: ['jasmine'],
+
+    // list of files / patterns to load in the browser
+    files: [
+      '../../bower_components/angular/angular.js',
+      '../../bower_components/angular-mocks/angular-mocks.js',
+      '../../dist/angular-websocket.js',
+      '../../dist/angular-websocket-mock.js',
+      './controller.js',
+      './controller.spec.js'
+    ],
+
+    // list of files to exclude
+    exclude: [
+
+    ],
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress', 'junit', 'growl', 'coverage'
+    reporters: ['progress'],
+
+    // web server port
+    port: 9876,
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_WARN,
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+    // Start these browsers, currently available:
+    // - Chrome
+    // - ChromeCanary
+    // - Firefox
+    // - Opera (has to be installed with `npm install karma-opera-launcher`)
+    // - Safari (only Mac; has to be installed with `npm install karma-safari-launcher`)
+    // - PhantomJS
+    // - IE (only Windows; has to be installed with `npm install karma-ie-launcher`)
+    browsers: ['PhantomJS'],
+
+    // If browser does not capture in given timeout [ms], kill it
+    captureTimeout: 60000,
+
+    // Continuous Integration mode
+    // if true, it capture browsers, run tests and exit
+    singleRun: true
+  };
+
+  config.set(configuration);
+};

example/howToTest/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "howToTest",
+  "scripts": {
+    "test": "karma start karma.conf.js"
+  }
+}

karma.conf.js

@@ -17,7 +17,9 @@ module.exports = function(config) {
       'bower_components/angular-mocks/angular-mocks.js',
       'dist/angular-websocket.js',
       'dist/angular-websocket-mock.js',
-      'test/angular-websocket.spec.js'
+      'test/angular-websocket.spec.js',
+      'example/howToTest/controller.js',
+      'example/howToTest/controller.spec.js',
     ],
 
     // list of files to exclude

src/angular-websocket-mock.js

@@ -34,6 +34,7 @@ function $WebSocketBackend() {
   };
 
   this.fakeClose = function(url, code) {
+    closeQueue.push(url);
     if(existingMocks[url]) {
       existingMocks[url].map(function(mockSocket) {
         mockSocket.close(code);

test/angular-websocket.spec.js

@@ -958,7 +958,6 @@ describe('angular-websocket', function() {
      it("should be automatically called on fake close", function() {
        var spy = jasmine.createSpy('callback');
        ws.onCloseCallbacks.push(spy);
-       $websocketBackend.expectClose(url);
        $websocketBackend.fakeClose(url);
        $websocketBackend.flush();
        expect(spy).toHaveBeenCalled();