Project

quik-chat

0.0
No commit activity in last 3 years
No release in over 3 years
WIP: Client/Server Chat implementation as an Rest API Rails Application
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.13
~> 10.0
~> 3.0
 Project Readme

QuikChat::Client

Let the users quikchat!

Installation

Add this line to your application's Gemfile:

gem 'quikchat-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install quikchat-client

Usage

List conversations for user QuikChat.all_for_user_id(1, before_id: 100) List messages in conversation 123 QuikChat.new(id: 123).messages(before_id: 100) Post message to conversation 123 QuikChat.new(id: 123).post(sender: uid, body: msg) Post message to users QuikChat.new(user_ids: [1,2,3]).post(sender: uid, body: msg)

Potential APIs in Ruby Web:

GET /api/v1/quikchats POST /api/v1/quikchats { recipients, message } GET /api/v1/quikchats/1239034 POST /api/v1/quikchats/1239034 { message }

Service APIs in the service:

GET /users/:user_id/conversations conversations#index POST /conversations conversations#create GET /conversations/:conversation_id/messages messages#index POST /conversations/:conversation_id/messages messages#create

Contributing

  1. Fork it ( https://github.com/[my-github-username]/quikchat-client/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request