autobahn test suite compliance

Author: Dave P

README.md

@@ -1,27 +1,20 @@
 <h2>A very simple WebSocket Server written in Python</h2>
-<h3>No package installation, just one file, enjoy</h3>
 
 Supports
-  - Hixie 76 (Safari and iPhone)
   - RFC 6455 (All latest browsers)
   - TLS/SSL
 
-<h3><a href = http://opiate.github.io/SimpleWebSocketServer>Click for the fancy Website</a></h3>
+Passes Autobahn Websocket Testsuite 
 
-<h4>A Simple Echo Server Example</h4>
-
-1) Write the client code by extending WebSocket
+<h4>Simple Echo Server Example</h4>
 `````python
     from SimpleWebSocketServer import WebSocket, SimpleWebSocketServer
 
     class SimpleEcho(WebSocket):
-        
+
         def handleMessage(self):
-            if self.data is None:
-                self.data = ''
-                
             # echo message back to client
-            self.sendMessage(str(self.data))
+            self.sendMessage(self.data)
 
         def handleConnected(self):
             print self.address, 'connected'
@@ -33,9 +26,7 @@ Supports
     server.serveforever()
 `````
 
-2) Run your code
-
-3) Open up <i>websocket.html</i> and connect to the server
+Open <i>websocket.html</i> and connect to the server.
 
 <h4>Want to get up and running faster?</h4>
 
@@ -70,46 +61,27 @@ Ensure the <i>websocket.html</i> is also in the same directory to where the serv
 
 5) Change <i>ws://localhost:8000/</i> to <i>wss://localhost:8000</i> and click connect. 
 
-Note: if you are having problems connecting, ensure that the certificate is added in your browser against the exception https://localhost:8000 or whatever host:port pair you want to connect to. 
+Note: if you are having problems connecting, ensure that the certificate is added in your browser against the exception <i>https://localhost:8000</i> or whatever host:port pair you want to connect to. 
 
 <h4>For the Programmers</h4>
 
 def handleConnected(): called when handskake is complete
+ - self.address: TCP address port tuple of the endpoint
 
 def handleClose(): called when the endpoint is closed or there is an error
 
 def handleMessage(): gets called when there is an incoming message from the client endpoint
  - self.opcode: the WebSocket frame type (STREAM, TEXT, BINARY)
- - self.data: bytearray payload or None if there was no payload
- - self.address: TCP address port tuple of the endpoint
+ - self.data: bytearray (BINARY frame) or unicode payload (TEXT frame)  
  - self.request: HTTP details from the WebSocket handshake (refer to BaseHTTPRequestHandler)
- - self.server.connections: map containing all the clients connected to the server
-
-def sendMessage(buffer): send some text or binary data to the client endpoint
- - sending a buffer as str() will send a text based WebSocket frame otherwise a binary frame
+ 
+def sendMessage(data): send some text or binary data to the client endpoint
+ - sending data as a unicode object will send a TEXT frame
+ - sending data as a bytearray object will send a BINARY frame
 
 def sendClose() : send close frame to endpoint
 
 
 ---------------------
 The MIT License (MIT)
 
-Copyright (c) 2013 Dave P.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

SimpleExampleServer.py

@@ -1,71 +1,44 @@
 '''
 The MIT License (MIT)
-
 Copyright (c) 2013 Dave P.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 '''
 
-import signal, sys, ssl, logging
+import signal, sys, ssl
 from SimpleWebSocketServer import WebSocket, SimpleWebSocketServer, SimpleSSLWebSocketServer
 from optparse import OptionParser
 
-logging.basicConfig(format='%(asctime)s %(message)s', level=logging.DEBUG)
 
 class SimpleEcho(WebSocket):
 
    def handleMessage(self):
-      if self.data is None:
-         self.data = ''
-      
-      try:
-         self.sendMessage(str(self.data))
-      except Exception as n:
-         print n
-         
+      self.sendMessage(self.data)
+
    def handleConnected(self):
-      print self.address, 'connected'
+      pass
 
    def handleClose(self):
-      print self.address, 'closed'
+      pass
 
 
 class SimpleChat(WebSocket):
 
    def handleMessage(self):
-      if self.data is None:
-         self.data = ''
-      
       for client in self.server.connections.itervalues():
          if client != self:
-            try:
-               client.sendMessage(str(self.address[0]) + ' - ' + str(self.data))
-            except Exception as n:
-               print n
-
+            client.sendMessage(self.address[0] + ' - ' + self.data)
 
    def handleConnected(self):
       print self.address, 'connected'
       for client in self.server.connections.itervalues():
          if client != self:
-            try:
-               client.sendMessage(str(self.address[0]) + ' - connected')
-            except Exception as n:
-               print n
-
+            client.sendMessage(self.address[0] + u' - connected')
+       
    def handleClose(self):
       print self.address, 'closed'
       for client in self.server.connections.itervalues():
          if client != self:
-            try:
-               client.sendMessage(str(self.address[0]) + ' - disconnected')
-            except Exception as n:
-               print n
-
+            client.sendMessage(self.address[0] + u' - disconnected')
+            
 
 if __name__ == "__main__":
 

SimpleHTTPSServer.py

@@ -1,19 +1,12 @@
 '''
 The MIT License (MIT)
-
 Copyright (c) 2013 Dave P.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 '''
 
 import BaseHTTPServer, SimpleHTTPServer
 import ssl
 
 # openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem
 httpd = BaseHTTPServer.HTTPServer(('', 443), SimpleHTTPServer.SimpleHTTPRequestHandler)
-httpd.socket = ssl.wrap_socket (httpd.socket, server_side=True, certfile='./cert.pem', keyfile='./cert.pem', ssl_version=ssl.PROTOCOL_TLSv1)
+httpd.socket = ssl.wrap_socket(httpd.socket, server_side=True, certfile='./cert.pem', keyfile='./cert.pem', ssl_version=ssl.PROTOCOL_TLSv1)
 httpd.serve_forever()