https://github.com/samdvr/eventsourcer
A helper library for event sourcing Rails ActiveRecord model changes
https://github.com/samdvr/eventsourcer
activerecord kafka ruby ruby-on-rails
Last synced: 4 months ago
JSON representation
A helper library for event sourcing Rails ActiveRecord model changes
- Host: GitHub
- URL: https://github.com/samdvr/eventsourcer
- Owner: samdvr
- License: mit
- Created: 2017-12-30T23:23:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-16T00:10:01.000Z (over 8 years ago)
- Last Synced: 2025-12-01T08:31:25.719Z (7 months ago)
- Topics: activerecord, kafka, ruby, ruby-on-rails
- Language: Ruby
- Size: 25.4 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Eventsourcer
A helper library for event sourcing Rails ActiveRecord model changes to Kafka(more brokers coming soon).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'eventsourcer'
```
And then execute:
$ bundle
## Usage
In initializer configure Eventsourcer:
```ruby
Eventsourcer.configure do |config|
config.broker = :kafka #required
config.kafka_seed_brokers = ["localhost:9092"] #optional
config.kafka_max_queue_size = 10000 #optional
end
```
Add Eventsourcer to a model you would like to track:
```ruby
require "eventsourcer"
class User < ApplicationRecord
include Eventsourcer
end
```
## Kafka Broker
Events generated for Kafka are published to ActiveRecord Model's table_name topic.
For example
```ruby
require "eventsourcer"
class User < ApplicationRecord
include Eventsourcer
end
```
will publish messages to "users" topic.
## Development
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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/samdvr/eventsourcer.