This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
****************************************
HIPOCHAT: Websocket chat server
****************************************

Supports notifications and keep the old messages

Hipochat is an open-source websocket chat server, using RabbitMQ as message queue, Tornado as Backend Server and
Redis for persistent data.

Keeps the notifications count and also supports injections from external server directly to websocket
Supports checking authentication with your own webserver.


How it works
======================================================

First clone the project

**git clone https://github.com/Hipo/hipochat.git**


Then install the requirements

**pip install -r requirements.txt**


Make sure that you have redis-server and rabbitmq servers are running
Set your variables in

vars.py::

PushNotificationURL = '<endpoint receives="" your="" push="" notification="" signal="" and="" send="" an="" pn="">'
ProfileURL = '<endpoint you="" can="" ask="" if="" user="" is="" authenticated="">'
RABBIT_URL = '<rabbitmq server="">'
RABBIT_USERNAME = '<rabbitmq username="">'
RABBIT_PASS = '<rabbitmq password="">'
REDIS_URL = '<redis_url>'


You can check the nginx reverse proxy details

Technical Detail
===================================================

Chat Server Endpoint
---------------------

Your backend server needs an EP that you should be able to create a chat room or receive the chat room tokens


Example request::

HEADER: Authentication: Token <token>
URLs: **/api/chat**

Example response::

{
"chat": {
"token": "e598c2a9-317a-4577-8cbd-7fd5f0cddbdf"
}
}


If room is created you should receive '201 CREATED' MESSAGE else if exists '200 OK'
200 OK means you already have this chat room and you should fetch the old messages


Receive the old messages
-----------------------------------------

You visit the url with parameters below


Example Request::

HEADER -> Authorization: Token <token>
HTTP GET **/talk/old/<chat_room_token>/**


Response::

HTTP 200 OK

{
oldy: [
{
timestamp: 1414768486.196569,
message: "asdasda",
author: "asdasda"
},
{
timestamp: 1414770934.580683,
message: "adsadsdasads",
author: "assaddsa"
},
{
timestamp: 1414772188.836509,
message: "dsadasads",
author: "dssdaasd"
},
{
timestamp: 1414773038.058612,
token: "ac9e8485-8120-4cdc-a5c7-2687a04f01b5",
injected: {
message: "hede",
hodo: "hede"
}
}
]
}



As an authenticated user you can post injections to CHAT server
------------------------------------------------

You can inject external messages from a Backend Server directly into Websocket

Example Request::

HEADER -> Authorization: Token <token>
HTTP POST **/talk/item/<chat_room_token>/**

{ message: "foobar",
user: "johndoe"
}


Start the Live Chat Server
--------------------------------------------------------

Chat Server works with websocket technology
Also you will see the injections in chat dialogue when an injection comes directly to Chat Server
You should pass the user authentication token as query parameter

Example Request::

WEBSOCKET
ws://server.url/talk/chat/<chat_token>/?token=<auth_token>


NOTIFICATIONS COUNT
-----------------------------------------------------

You can receive the notifications count of chat rooms for authenticated user
by sending a request like below

HTTP GET **/talk/notification/<chat_token>/?type=<type>**

Got some of the code from https://github.com/haridas/RabbitChat
Release History

Release History

0.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
hipochat-0.1.tar.gz (6.4 kB) Copy SHA256 Checksum SHA256 Source Mar 4, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting