Merge pull request Pithikos#1 from Pithikos/master

renew

Author: FolderLevel

.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+.cache

README.md

@@ -7,27 +7,33 @@ A minimal Websockets Server in Python with no external dependencies.
   * Clean simple API
   * Multiple clients
   * No dependencies
-  
+
 Notice that this implementation does not support the more advanced features
 like SSL etc. The project is focused mainly on making it easy to run a
 websocket server for prototyping, testing or for making a GUI for your application.
 
+If this project reduced your development time feel free to buy me a coffee.
+
+[![Donate](https://www.paypal.com/en_US/i/btn/x-click-but21.gif)](https://www.paypal.me/seferidis)
+
 
 Usage
 =======================
 You can get a feel of how to use the websocket server by running
 
     python server.py
-    
+
 Then just open `client.html` in your browser and you should be able to send and receive messages.
 
 
 Using in your project
 =======================
-You can either simply copy/paste the *websocket_server.py* file in your project and use it directly (recommended)
-or you can install the project directly from PyPi (might not be up-to-date):
 
-    pip install websocket-server
+You can use the project in three ways.
+
+  1. Copy/paste the *websocket_server.py* file in your project and use it directly
+  2. `pip install git+https://github.com/Pithikos/python-websocket-server` (latest code)
+  3. `pip install websocket-server` (might not be up-to-date)
 
 For coding details have a look at the [*server.py*](https://github.com/Pithikos/python-websocket-server/blob/master/server.py) example and the [API](https://github.com/Pithikos/python-websocket-server#api).
 
@@ -39,18 +45,23 @@ The API is simply methods and properties of the `WebsocketServer` class.
 
 ## WebsocketServer
 
-The WebsocketServer takes two arguments: a `port` and a `hostname`.
-By default the localhost `127.0.0.1` is used. However if you want to be able and connect
-to the server from the network you need to pass `0.0.0.0` as hostname e.g. `WebsocketServer(13254, host='0.0.0.0')`.
+The WebsocketServer can be initialized with the below parameters.
 
-###Properties
+*`port`* - The port clients will need to connect to.
+
+*`host`* - By default the `127.0.0.1` is used which allows connections only from the current machine. If you wish to allow all network machines to connect, you need to pass `0.0.0.0` as hostname.
+
+*`loglevel`* - logging level to print. By default WARNING is used. You can use `logging.DEBUG` or `logging.INFO` for more verbose output.
+
+
+### Properties
 
 | Property | Description          |
 |----------|----------------------|
 | clients  | A list of `client`   |
 
 
-###Methods
+### Methods
 
 | Method                      | Description                                                                           | Takes           | Gives |
 |-----------------------------|---------------------------------------------------------------------------------------|-----------------|-------|
@@ -61,7 +72,7 @@ to the server from the network you need to pass `0.0.0.0` as hostname e.g. `Webs
 | `send_message_to_all()`     | Sends a `message` to **all** connected clients. The message is a simple string.       | message         | None  |
 
 
-###Callback functions
+### Callback functions
 
 | Set by                      | Description                                       | Parameters              |
 |-----------------------------|---------------------------------------------------|-------------------------|
@@ -70,23 +81,23 @@ to the server from the network you need to pass `0.0.0.0` as hostname e.g. `Webs
 | `set_fn_message_received()` | Called when a `client` sends a `message`          | client, server, message |
 
 
-The client passed to the callback is the client that left, sent the message, etc. The server might not have any use to use. However it is
-passed in case you want to send messages to clients.
+The client passed to the callback is the client that left, sent the message, etc. The server might not have any use to use. However it is passed in case you want to send messages to clients.
 
 
 Example:
 ````
+import logging
 from websocket_server import WebsocketServer
 
 def new_client(client, server):
 	server.send_message_to_all("Hey all, a new client has joined us")
 
-server = WebsocketServer(13254, host='127.0.0.1')
+server = WebsocketServer(13254, host='127.0.0.1', loglevel=logging.INFO)
 server.set_fn_new_client(new_client)
 server.run_forever()
 ````
 
-##Client
+## Client
 
 Client is just a dictionary passed along methods.
 
@@ -97,4 +108,3 @@ Client is just a dictionary passed along methods.
 	'address' : (addr, port)
 }
 ````
-

tests/README.md

@@ -0,0 +1,13 @@
+Testing
+--------
+
+Run unit tests
+
+    pytest
+
+
+Run functional tests
+
+     python message_lengths.py
+
+Open client.html in the browser and refresh consequently until all test cases pass.

tests/_bootstrap_.py

@@ -1,4 +1,6 @@
 #Bootstrap
 import sys, os
-if 'python-websockets-server' in  os.getcwd():
+if os.getcwd().endswith('tests'):
 	sys.path.insert(0, '..')
+elif os.getcwd().endswith('websocket-server'):
+	sys.path.insert(0, '.')

tests/handshake.py

@@ -1,20 +1,20 @@
 import _bootstrap_
-from websocket import WebSocketsServer
+from websocket_server import WebsocketServer
 from time import sleep
 from testsuite.messages import *
 
 '''
-This creates just a server that will send a different message to every new connection: 
-    
+This creates just a server that will send a different message to every new connection:
+
     1. A message of length less than 126
     2. A message of length 126
     3. A message of length 127
     4. A message of length bigger than 127
     5. A message above 1024
     6. A message above 65K
     7. An enormous message (well beyond 65K)
-    
-    
+
+
 Reconnect to get the next message
 '''
 
@@ -52,6 +52,6 @@ def new_client(client, server):
 
 
 PORT=9001
-server = WebSocketsServer(PORT)
+server = WebsocketServer(PORT)
 server.set_fn_new_client(new_client)
 server.run_forever()

tests/message_lengths.py

@@ -0,0 +1,29 @@
+import _bootstrap_
+from websocket_server import *
+import pytest
+
+
+class DummyWebsocketHandler(WebSocketHandler):
+    def __init__(self, *_):
+        pass
+
+@pytest.fixture
+def websocket_handler():
+	return DummyWebsocketHandler()
+
+def test_hash_calculations_for_response(websocket_handler):
+	key = 'zyjFH2rQwrTtNFk5lwEMQg=='
+	expected_key = '2hnZADGmT/V1/w1GJYBtttUKASY='
+	assert websocket_handler.calculate_response_key(key) == expected_key
+
+
+def test_response_messages(websocket_handler):
+	key = 'zyjFH2rQwrTtNFk5lwEMQg=='
+	expected = \
+		'HTTP/1.1 101 Switching Protocols\r\n'\
+		'Upgrade: websocket\r\n'              \
+		'Connection: Upgrade\r\n'             \
+		'Sec-WebSocket-Accept: 2hnZADGmT/V1/w1GJYBtttUKASY=\r\n'\
+		'\r\n'
+	handshake_content = websocket_handler.make_handshake_response(key)
+	assert handshake_content == expected