0.0
No commit activity in last 3 years
No release in over 3 years
This library publishes tracked ActiveRecord changes to a persistence layer such as Apache Kafka.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0

Runtime

 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:

gem 'eventsourcer'

And then execute:

$ bundle

Usage

In initializer configure Eventsourcer:

  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:

  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

  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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/samdvr/eventsourcer.