https://github.com/sockjs/sockjs-protocol

An attempt to define SockJS protocol
https://github.com/sockjs/sockjs-protocol

Last synced: 1 day ago
JSON representation

An attempt to define SockJS protocol

• Host: GitHub
• URL: https://github.com/sockjs/sockjs-protocol
• Owner: sockjs
• Created: 2011-09-16T14:01:51.000Z (over 13 years ago)
• Default Branch: main
• Last Pushed: 2021-08-02T22:40:17.000Z (over 3 years ago)
• Last Synced: 2024-12-18T12:11:39.997Z (9 days ago)
• Language: Python
• Homepage: http://sockjs.org
• Size: 265 KB
• Stars: 202
• Watchers: 21
• Forks: 29
• Open Issues: 18
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
SockJS family:

  * [SockJS-client](https://github.com/sockjs/sockjs-client) JavaScript client library

  * [SockJS-node](https://github.com/sockjs/sockjs-node) Node.js server

  * [SockJS-erlang](https://github.com/sockjs/sockjs-erlang) Erlang server

  * [SockJS-cyclone](https://github.com/flaviogrossi/sockjs-cyclone) Python/Cyclone/Twisted server

  * [SockJS-tornado](https://github.com/MrJoes/sockjs-tornado) Python/Tornado server

  * [SockJS-twisted](https://github.com/DesertBus/sockjs-twisted/) Python/Twisted server

  * [Spring Framework](http://projects.spring.io/spring-framework) Java [client](https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-fallback) & server

  * [vert.x](https://github.com/vert-x/vert.x) Java/vert.x server

  * [Xitrum](http://xitrum-framework.github.io/) Scala server

  * [Atmosphere Framework](http://github.com/Atmosphere/atmosphere) JavaEE Server, Play Framework, Netty, Vert.x

Work in progress:

  * [SockJS-ruby](https://github.com/nyarly/sockjs-ruby)

  * [SockJS-netty](https://github.com/cgbystrom/sockjs-netty)

  * [SockJS-gevent](https://github.com/sdiehl/sockjs-gevent) ([SockJS-gevent fork](https://github.com/njoyce/sockjs-gevent))

  * [pyramid-SockJS](https://github.com/fafhrd91/pyramid_sockjs)

  * [wildcloud-websockets](https://github.com/wildcloud/wildcloud-websockets)

  * [wai-SockJS](https://github.com/Palmik/wai-sockjs)

  * [SockJS-perl](https://github.com/vti/sockjs-perl)

  * [SockJS-go](https://github.com/igm/sockjs-go/)

SockJS-protocol

===============

This project attempts to provide a definition of SockJS protocol. The

documentation is in a form of a Python test suite decorated with some

prose in literate-programming style. You can see current documentation

here:

 * Current stable: [sockjs-protocol-0.3.3.html](

   https://sockjs.github.io/sockjs-protocol/sockjs-protocol-0.3.3.html)

Running tests

-------------

You must have Python 2.X and `virtualenv` installed. You can install

it via `pip install virtualenv` or `sudo apt-get install python-virtualenv`.

To run the test suite against your server, first checkout dependencies:

    make test_deps

And you're ready to run the tests against your server. By default we

assume that your test server is at

[http://localhost:8081](http://localhost:8081):

    ./venv/bin/python sockjs-protocol.py

You can specify the test server URL manually:

    SOCKJS_URL=http://localhost:1234 ./venv/bin/python sockjs-protocol.py -v

You can run specific tests providing test class as an optional argument:

    ./venv/bin/python sockjs-protocol.py Protocol.test_simpleSession

There is also another test, intended to look for some http quirks:

    ./venv/bin/python http-quirks.py -v

Generating literate html

------------------------

If you edited `sockjs-protocol.py` files, you may want to see how it

looks rendered to html. To generate the html type:

    make build

You should see generated html files in `docs` subdirectory.

If you see `pygments.util.ClassNotFound`, take a look

[here](https://github.com/fitzgen/pycco/issues/39).