No commit activity in last 3 years
No release in over 3 years
Rocket.Chat realtime api client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

 Project Readme

RocketChat::Realtime

The ruby implement for RocketChat Realtime API.

Installation

Add this line to your application's Gemfile:

gem 'rocket_chat-realtime'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rocket_chat-realtime

Usage

Create a client

client = RocketChat::Realtime::Client.new(server: 'wss://chat.example.com')

Connect to server

client.connect

or use a shortcut via .connect

client = RocketChat::Realtime.connect(server: 'wss://chat.example.com')

Login to server

client.login(username, password)

The Realtime API is async and depend on the Metro.js DDP, we can use Concurrent::Promises to capture the return message.

client
  .login(username, password)
  .then { |res| puts "Token is #{res['token']}" }

Subscribe room messages

client
  .subscribe_room_messages('ROOM_ID')
  .then { puts 'Ready!' }

Process room messages

client.on('stream-room-messages') do |message|
  puts "Received message: #{message['args'][0]['msg']}"
end

Send message

client
  .send_message('ROOM_ID', 'MESSAGE')
  .then { |res| puts 'Success' }

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/5xRuby/rocket_chat-realtime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the RocketChat::Realtime project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.