stream-chat-ruby

stream-chat-ruby is the official Ruby client for Stream chat a service for building chat applications.

You can sign up for a Stream account at https://getstream.io/chat/get_started/.

You can use this library to access chat API endpoints server-side. For the client-side integrations (web and mobile) have a look at the Javascript, iOS and Android SDK libraries (https://getstream.io/chat/).

Installation

stream-chat-ruby supports:

• Ruby (2.6, 2.5, 2.4, 2.3)

Install

gem install stream-chat-ruby

Documentation

Official API docs

Supported features

• Chat channels
• Messages
• Chat channel types
• User management
• Moderation API
• Push configuration
• User devices
• User search
• Channel search

Import

require 'stream-chat'

Initialize client

client = StreamChat::Client.new(api_key='STREAM_KEY', api_secret='STREAM_SECRET')

Generate a token for client side use

client.create_token('bob-1')

Create/Update users

client.update_user({
    :id => 'bob-1',
    :role => 'admin',
    :name => 'Robert Tables'
})

# batch update is also supported
jane = ...
june = ...
client.update_users([jane, june])

Channel types CRUD

# Create
client.create_channel_type({
    'name' => 'livechat',
    'automod' => 'disabled',
    'commands' => ['ban'],
    'mutes' => true
})

# Update
client.update_channel_type('livechat', 'automod' => 'enabled'})

# Get
client.get_channel_type('livechat')

# List
client.list_channel_types

# Delete
client.delete_channel_type('livechat')

Channels

# Create a channel with members from the start
chan = client.channel("messaging", channel_id: "bob-and-jane", data: {'members'=> ['bob-1', 'jane-77']})
chan.create('bob-1')

# Create a channel and then add members
chan = client.channel("messaging", channel_id: "bob-and-jane")
chan.create('bob-1')
chan.add_members(['bob-1', 'jane-77'])

# Send messages
m1 = chan.send_message({'text' => 'Hi Jane!'}, 'bob-1')
m2 = chan.send_message({'text' => 'Hi Bob'}, 'jane-77')

# Send replies
r1 = chan.send_message({'text' => 'And a good day!', 'parent_id' => m1['id']}, 'bob-1')

# Send reactions
chan.send_reaction(m1['id'], {'type' => 'like'}, 'bob-1')

# Add/remove moderators
chan.add_moderators(['jane-77'])
chan.demote_moderators(['bob-1'])

# Add a ban with a timeout
chan.ban_user('bob-1', timeout: 30)

# Remove a ban
chan.unban_user('bob-1')

# Query channel state
chan.query({'messages' => { 'limit' => 10, 'id_lte' => m1['id']}})

Messages

# Delete a message from any channel by ID
deleted_message = client.delete_message(r1['id'])

Devices

# Add device
jane_phone = client.add_device({'id' => 'iOS Device Token', 'push_provider' => push_provider.apn, 'user_id' => 'jane-77'})

# List devices
client.get_devices('jane-77')

# Remove device
client.remove_device(jane_phone['id'], jane_phone['user_id'])

Example Rails application

See an example rails application using the Ruby SDK.

Contributing

First, make sure you can run the test suite. Tests are run via rspec

STREAM_CHAT_API_KEY=my_api_key STREAM_CHAT_API_SECRET=my_api_secret bundle exec rake spec

Releasing a new version

In order to release new version you need to be a maintainer of the library.

• Update CHANGELOG
• Update the version in lib/stream-chat/version.rb
• Commit and push to GitHub
• Build the gem with bundle exec rake build
• Publish the gem with bundle exec rake release