https://github.com/ssbarnea/zzz-homework

https://github.com/ssbarnea/zzz-homework

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/ssbarnea/zzz-homework
• Owner: ssbarnea
• Created: 2015-04-05T13:28:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-04-06T20:45:54.000Z (over 9 years ago)
• Last Synced: 2024-05-02T01:21:54.802Z (5 months ago)
• Language: Python
• Size: 145 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
.. image:: https://api.travis-ci.org/ssbarnea/zzz-homework.svg?branch=master

        :target: https://travis-ci.org/ssbarnea/zzz-homework

.. image:: https://img.shields.io/coveralls/ssbarnea/zzz-homework.svg

        :target: https://coveralls.io/r/ssbarnea/zzz-homework

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

Homework : Basic HTTP messaging

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

Getting the code

~~~~~~~~~~~~~~~~

git clone https://github.com/ssbarnea/zzz-homework.git

Installing

~~~~~~~~~~

# You need python 2.7-3.4 to run it as it requires latest stable django (1.8)

pip install -r requirements.txt

Testing

~~~~~~~

python manage.py test

Running the server

~~~~~~~~~~~~~~~~~~

python manage.py runserver

Implementation

~~~~~~~~~~~~~~

We picked Django because is mature, popular and easy to use. 

While a gevent could seem a a very scalable solution it could be an over-engineering for such a task. Reference http://nichol.as/benchmark-of-python-web-servers

Assumptions made during initial implementation:

* Following HTTP specification when initial spec is not really clear.

* When an entity is created (probably using POST) response code is 201 (not 200). See `RFC2616 `_

* A message should not be NULL and less than 255 chars.

* Usernames and topic cannot have special characters in them

* Communication is JSON based

* on POST /topic/user/ we will create any of user or topic if they do not exist.

TO DO

~~~~~

* Better testing, initial version had only basic tests for validating initial spec

* validation of parameters for special chars, length

* load testing and documenting solution limits (tried implementing nose but discovered that `django-nose is broken `_

* daemon scripts

* watchdog to restart the daemon if it does crash

* investigate docker usage for packaging/deployment 

* have beer with the customer!