Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An attempt to define SockJS protocol
Python CoffeeScript
branch: master

This branch is 1 commit ahead, 99 commits behind sockjs:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.gitignore
Makefile
README.md
client.coffee
common.coffee
http-quirks.py
httplib.py
smoke-test.coffee
sockjs-protocol-0.1.py
sockjs-protocol-0.2.py
test_deps.txt
utils.py

README.md

SockJS family:

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:

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:

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

You can specify the test server URL manually:

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

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

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

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

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

Genrating literate html

If you edited sockjs-protocol 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.

Something went wrong with that request. Please try again.