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.5.4)

Miscellaneous information

/api/v1/info

Authentication

/api/v1/login
/api/v1/logout
/api/v1/me

Users

/api/v1/users.create
/api/v1/users.update

Usage

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}"

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

To create a user:

require 'rocketchat'

rocket_server = RocketChat::Server.new('http://your.server.address/')
session = rocket_server.login('username', 'password')
session.users.create('new_username', '[email protected]', 'New User', '123456',
                     active: true, send_welcome_email: false)

Optional parameters for create are:

:active, :roles, :join_default_channels, :require_password_change, :send_welcome_email, :verified, :custom_fields

To update a user:

require 'rocketchat'

rocket_server = RocketChat::Server.new('http://your.server.address/')
session = rocket_server.login('username', 'password')
session.users.update('LAjzCDLqggCT7B82M',
  email: '[email protected]',
  name: 'Updated Name',
  roles: ['user', 'moderator']
)

Optional parameters for update are:

:username, :email, :password, :name, :active, :roles, :join_default_channels, :require_password_change, :send_welcome_email, :verified, :custom_fields

Contributing

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

License

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