A simple chat server
- postgresql >=9.3
- redis >=2.8
- change
db/dbconf.ymlto have the correct credentials. - run
goose up[1] to run all migrations. - create a configuration file in
cmd/(seedevelopment.jsonfor example). - run
godep restore[2] to install all golang dependencies. - run
make localto run the server.
Authorization is using jwt protocol.
-
params:
- first_name: required
- last_name: required
- username: required
- password: required
- email: required
- phone: required
-
json:
{
'status': 'success',
'data': [
{
'email': 'hello@example.com',
'first_name': 'Bob',
'last_name': 'Bobson',
'phone_number': '0123456789',
'token': {
'access_key_id': 'AN5O6G5HYN4KFY7H2KM7XX4MKRI2RPNKUQELMQ54RITJBNS5RXKA',
'created_at': '2015-09-03T02:08:08.558583633Z',
'expires_at': '2015-10-03T02:08:08.558584401Z',
'is_refreshable': true,
'modified_at': '2015-09-03T02:08:08.5585851Z',
'refresh_token': 'FAIMPUSXVQJAMRGBSSUJHIRRZC3ROLLOLPYT5VQOR5K6OJKFY62Q',
'secret_access_key': '5GHV7INX2QZTG4RFE6LQMR34HWSF27IUUM55P65MFW4462SLC43A'
},
'username': 'bob'
}
],
'error': {
'code': 200,
'errors': null,
'message': ''
},
'page': 1,
'per_page': 10,
'current_page': 1
}
-
params:
- username: required
- password: required
-
json:
{
'status': 'success',
'data': [
{
'access_key_id': 'R7JKSI4JJSFAANS4UTENUMGFCC4WLF2UPXWRJHJGJ6HWELFGJMEA',
'created_at': '2015-09-03T02:15:31.533436161Z',
'expires_at': '2015-10-03T02:15:31.533437208Z',
'is_refreshable': true,
'modified_at': '2015-09-03T02:15:31.533438047Z',
'refresh_token': 'N547NOKQVBVFAR7BEZKE5FSLOB4XN5VTOYH3TMIXHTQ4O6KJ5F4Q',
'secret_access_key': '3KHIVVGM4YNHFS7FAZQOUXM3ASBZTL23QXMHPMMNQPHMHZ4HRAHA'
}
],
'error': {
'code': 200,
'errors': null,
'message': ''
},
'page': 1,
'per_page': 10,
'current_page': 1
}- authentication is required
-
authentication is required
-
json
{
'status': 'success',
'data': [
{
'author_username': 'bob',
'created_at': '2015-09-02T15:49:02.996617Z',
'latest_message': 'hello'
}
],
'error': {
'code': 200,
'errors': None,
'message': ''
},
'page': 1,
'per_page': 10,
'current_page': 1
}-
authentication is required
-
json
{
'status': 'success'
'data': [
{
'author': 'bob',
'created_at': '2015-09-02T15:49:02.994339Z',
'message': 'hello',
'message_type': 0,
'recipient': 'alice'
},
{
'author': 'alice',
'created_at': '2015-09-02T15:40:02.994339Z',
'message': 'Hi bob',
'message_type': 0,
'recipient': 'bob'
},
],
'error': {
'code': 200,
'errors': null,
'message': ''
},
'page': 1,
'per_page': 10,
'current_page': 2
}-
endpoint:
/api/ws -
authentication is required
-
send a packet:
{
'author': 'bob',
'recipient': 'alice',
'message': 'hello'
}
- receive a packet
{
'author': 'bob',
'recipient': 'alice',
'message': 'hello',
'message_type': 0,
'created_at':'2015-09-03T03:13:12.817650473Z'
}
{
'status': 'fail',
'data': [],
'error': {
'code': 400,
'errors': {'error': 'Some fileds are not unique'},
'message': 'User error'
},
'page': 1,
'per_page': 10,
'current_page': 0
}-
Servers
server Aserver Bserver C
-
Users
bobalice
-
Message queues
shared queueA's queueB's queueC's queue
-
Workflow
bobconnects toserver A.aliceconnects toserver B,server C.bobsends a message toalice.- the message is pushed to the
shared queue. shared queuepushes the message toA's queue,B's queue,C's queueand persists the message to database.server Apops fromA's queueand drops the message becausealiceis not connected;server Bpops fromB's queueand pushes toalice;server Cpops fromB's queueand pushes toalice.
[1]. go get bitbucket.org/liamstask/goose/cmd/goose
[2]. go get github.com/tools/godep