Skip to content

abrom/rocketchat-ruby

Repository files navigation

Travis Build Status Maintainability Test Coverage Gem Version

Rocket.Chat REST API for Ruby

This is a gem wrapping the v1 REST API for Rocket.Chat.

The gem is based on a fork of http://github.com/int2xx9/ruby-rocketchat however that gem implemented v0.1 of the Rocket.Chat API and it was not forward compatible. Thanks to @int2xx9 for the framework on which this gem was based

Installation

Add this line to your application's Gemfile:

gem 'rocketchat'

And then execute:

$ bundle

Supported API calls

This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.54)

Miscellaneous information

Authentication

Chat

IM

Channels

Groups

Users

Settings

Usage

info

To get Rocket.Chat version

require 'rocketchat'

rocket_server = RocketChat::Server.new('http://your.server.address/')
info = rocket_server.info
puts "Rocket.Chat version: #{info.version}"

authentication

To logout from a server:

require 'rocketchat'

rocket_server = RocketChat::Server.new('http://your.server.address/')
session = rocket_server.login('username', 'password')
# ... use the API ...
session.logout

debugging

To debug the communications between the gem and Rocket.Chat, there is a debug option. It accepts a stream for logging.

require 'rocketchat'

rocket_server = RocketChat::Server.new('http://your.server.address/', debug: $stderr)

For details of specific APIs:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/abrom/rocketchat-ruby.

Note that spec tests are appreciated to minimise regressions. Before submitting a PR, please ensure that:

$ rspec

and

$ rubocop

both succeed

License

The gem is available as open source under the terms of the MIT License.