Gem version Dependency status Build status Code climate Coverage Inline docs

A Ruby implementation of the Matrix API.


Copyright (c) 2016 by Adam Hellberg.

chatrix is licensed under the MIT License, see the file LICENSE for more information.


Add this line to your application's Gemfile:

gem 'chatrix'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chatrix


This implementation is currently very basic and exposes all the endpoints in the Matrix class. Example usage:

# Uses the standard homeserver
api = 'my secret token'

# Join may raise ForbiddenError if client does not have permission
# to join the room
if id = api.join ''
  api.send_message id, 'Hello everyone!'

Currently there is no asynchronous calls or built-in handling of rate-limiting.


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.


Bug reports and pull requests are welcome on GitHub.