rabbitChat 1.0.0

A Chat Server based on AMQP using RabbitMQ message broker implementing AMQP, websocket, sockjs, sockjs-tornado, tornado, and amqp python client library, Pika

rabbitChat
===========

A Chat-Server/Chat-System based on AMQP protocol(RabbitMQ Message Broker)

Documentation
--------------

**Link :** http://rabbitchat.readthedocs.io/en/latest/index.html




Details
--------


:Author: Anirban Roy Das
:Email: [e-mail]
:Copyright(C): 2016, Anirban Roy Das <[e-mail]>

Check ``rabbitChat/LICENSE`` file for full Copyright notice.



Overview
---------

rabbitChat is a very simple Chat Server which can be set up locally to chat in your LAN. It supports both **Public Chat** among all participants connected simultaneously at a particular time and also **Private Chat** betweent those individual participants.

It uses the `AMQP <https://www.amqp.org/>`_ protocol to implement the real time message passing system. **AMQP** is implemented in many languages and in many softwares, once of such is `RabbitMQ <https://www.rabbitmq.com/>`_ , which is a message broker implementing the `AMQP <https://www.amqp.org/>`_ protocol.

The connection is created using the `sockjs <https://github.com/sockjs/sockjs-client>`_ protocol. **SockJS** is implemented in many languages, primarily in Javascript to talk to the servers in real time, which tries to create a duplex bi-directional connection between the **Client(browser)** and the **Server**. Ther server should also implement the **sockjs** protocol. Thus using the `sockjs-tornado <https://github.com/MrJoes/sockjs-tornado>`_ library which exposes the **sockjs** protocol in `Tornado <http://www.tornadoweb.org/>`_ server.

It first tries to create a `Websocket <https://en.wikipedia.org/wiki/WebSocket>`_ connection, and if it fails then it fallbacks to other transport mechanisms, such as **Ajax**, **long polling**, etc. After the connection is established, the tornado server**(sockjs-tornado)** connects to **rabbitMQ** via AMQP protocol using the **AMQP Python Client Library**, `Pika <https://pypi.python.org/pypi/pika>`_.

Thus the connection is *web-browser* to *tornado* to *rabbitMQ* and vice versa.



Technical Specs
----------------


:sockjs-client: Advanced Websocket Javascript Client
:Tornado: Async Python Web Library + Web Server
:sockjs-tornado: SockJS websocket server implementation for Tornado
:AMQP: Advance Message Queuing Protocol used in Message Oriented Middleware
:pika: AMQP Python Client Library
:RabbitMQ: A Message Broker implementing AMQP



Features
---------

* Public chat
* Shows who joined and who left
* Shows number of people online
* Shows who is typing and who is not
* Join/Leave chat room features




Installation
------------

Prerequisites
~~~~~~~~~~~~~

1. python 2.7+
2. tornado
3. sockjs-tornado
4. sockjs-client
5. pika
6. rabbitMQ


Install
~~~~~~~
::

$pipinstallrabbitChatIfabovedependenciesdonotgetinstalledbytheabovecommand,thenusethebelowstepstoinstallthemonebyone.\ast \ast Step1-Installpip\ast \ast Followthebelowmethodsforinstallingpip.Oneofthemmayhelpyoutoinstallpipinyoursystem.\ast \ast \ast Method1-\ast \ast https://pip.pypa.io/en/stable/installing/\ast \ast \ast Method2-\ast \ast http://ask.xmodulo.com/install-pip-linux.html\ast \ast \ast Method3-\ast \ast IfyouinstalledpythononMACOSXvia‘‘brewinstallpython‘‘,then\ast \ast pip\ast \ast isalreadyinstalledalongwithpython.\ast \ast Step2-Installtornado\ast \ast ::$ pip install tornado

**Step 3 - Install sockjs-tornado**
::

$pipinstallsockjs-tornado\ast \ast Step4-Installpika\ast \ast ::$ pip install pika

**Step 5 - Install RabbitMQ**

* *For* ``Mac`` *Users*

1. Brew Install RabbitMQ
::

$brewinstallrabbitmq2.ConfigureRabbitMq,followthis‘link<https://www.rabbitmq.com/install-homebrew.html>{‘}_{,}this‘one<https://www.rabbitmq.com/install-standalone-mac.html>{‘}_{a}nd‘this<https://www.rabbitmq.com/configure.html>{‘}_{.}\ast \ast For\ast ‘‘Ubuntu/Linux‘‘\ast Users\ast 1.EnableRabbitMQapplicationrepository::$ echo "deb http://www.rabbitmq.com/debian/ testing main" >> /etc/apt/sources.list

2. Add the verification key for the package
::

$wget-ohttp://www.rabbitmq.com/rabbitmq-signing-key-public.asc|sudoapt-keyadd-3.Updatethesourceswithournewadditionfromabove::$ apt-get update


4. And finally, download and install RabbitMQ
::

$\text{You can't use 'macro parameter character \#' in math mode}$ rabbitmq-server

# If you want to run in background
$\text{You can't use 'macro parameter character \#' in math mode}$ brew services rabbitmq start


2. *For* ``Ubuntu/LInux`` *Users*
::

# start normally
$\text{You can't use 'macro parameter character \#' in math mode}$ rabbitmq-server --detached

# To start using service
$\text{You can't use 'macro parameter character \#' in math mode}$ service rabbitmq-server stop

# To restart using service
$\text{You can't use 'macro parameter character \#' in math mode}$ service rabbitmq-server status



* **Start rabbitChat Server**
::

$rabbitChat[options]-\ast \ast Options\ast \ast :--port:Portnumberwherethechatserverwillstart-\ast \ast Example\ast \ast ::$ rabbitChat --port=9191


* **Stop rabbitChat Server**



Click ``Ctrl+C`` to stop the server.



Todo
-----

1. Add Private Chat functionality.

2. Manage Presence Management, sent, delivered acknowledgements.

3. Message Persistence and delivery of messages to offline clinets.

4. Add Blog post regarding this topic.