https://github.com/vivekmiyani/offline_broadcaster
Deliver messages to offline users when they comes online.
https://github.com/vivekmiyani/offline_broadcaster
activerecord deliver-messages gem ruby ruby-on-rails rubygems
Last synced: 9 months ago
JSON representation
Deliver messages to offline users when they comes online.
- Host: GitHub
- URL: https://github.com/vivekmiyani/offline_broadcaster
- Owner: vivekmiyani
- License: mit
- Archived: true
- Created: 2021-02-23T09:10:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-01T06:12:34.000Z (over 5 years ago)
- Last Synced: 2024-09-19T05:17:35.962Z (almost 2 years ago)
- Topics: activerecord, deliver-messages, gem, ruby, ruby-on-rails, rubygems
- Language: Ruby
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OfflineBroadcaster
- This gem aims to deliver messages/data or save into database for later delivery to the receiver according to their (online/offline) status.
- The main advantage to use this gem is that we can eliminate message delivery logic from our application code. So we can directly do broadcast without worrying about the user status.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'offline_broadcaster'
```
And then execute:
$ bundle install
Install migration yourself (as of now):
```ruby
class CreateOfflineBroadcasterRecords < ActiveRecord::Migration[6.1]
def change
create_table :offline_broadcaster_records do |t|
t.references :receiver, polymorphic: true
t.string :channel
t.json :data
t.timestamps
end
end
end
```
Run migration:
$ rails db:migrate
## Usage
#### Create `Adapter` to listen for the messages:
- It should inherit `OfflineBroadcaster::Adapter` (It can be placed inside model or wherever you want).
- Overload collect method as below example.
- So, whenever user receives a message this method will be called. Like, for online users it will be called immediately and for offline users it will be called once user comes online.
```ruby
class User::OfflineManager < OfflineBroadcaster::Adapter
# This method called when user comes online.
def self.collect(channel:, receiver:, data:)
# Here we can safely publish message to redis channel
# OR we can publish it on ActionCable channel.
end
end
```
#### Add this to your `User` model:
- While calling `acts_as_offline_receiver` pass `online_attribute` so gem can identify user status (In our case we have `online` column in our database).
- And also need to pass adapter we just wrote.
```ruby
class User < ApplicationRecord
acts_as_offline_receiver online_attribute: :online, adapter: User::OfflineManager
end
```
#### Let's test it:
```ruby
receiver = User.last
receiver.online
# => false
# Send a message
User::OfflineManager.deliver(channel: 'greeting_channel', receiver: receiver, data: 'Hello online user!!')
User::OfflineManager.deliver(channel: 'greeting_channel', receiver: receiver, data: { message: 'Welcome!!' })
# => # Some insert query will going to run.
# Update the user status
receiver.update(online: true)
# => User::OfflineManager#collect will be called.
```
## How it works?
1. This gem will observe the given attribute changes (to identify user online/offline status).
2. While sending a message if user is online then that message will be delivered immediately
3. Otherwise, it will store that into database and when user comes online again those pending messages will be delivered.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/vivekmiyani/offline_broadcaster. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/vivekmiyani/offline_broadcaster/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the OfflineBroadcaster project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vivekmiyani/offline_broadcaster/blob/master/CODE_OF_CONDUCT.md).