eventsourcer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac058eea62551794983eb02cd440f9bb2c77b5ee
+  data.tar.gz: bed17d5c7ce1cb3e825cd50dc0f9c39bf70d3b40
+SHA512:
+  metadata.gz: 77577db2ed19afd3b27ef743a989ab0a3abb4b95faaea333213689b9afda8d7785c9bcd0bf20921abf563ce2824511ec04e71b0d959e27395a61a91c819044ea
+  data.tar.gz: 6ac71cb73df6a931d73fe5a5d173494d2836abe3082cd73495301c7c8c07f787f6baa225ea919c5afe102aa3e17a0e5196160a9656a54475097388639c12f744

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    eventsourcer (0.1.0)
+      ruby-kafka (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    ruby-kafka (0.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  eventsourcer!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brian Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# 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
+```
+
+
+## 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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eventsourcer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eventsourcer.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "eventsourcer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "eventsourcer"
+  spec.version       = Eventsourcer::VERSION
+  spec.authors       = ["Sam Davarnia"]
+
+  spec.summary       = %q{Library to event source ActiveRecord changes to a broker.}
+  spec.description   = %q{This library publishes tracked ActiveRecord changes to a persistence layer such as Apache Kafka.}
+  spec.homepage      = "https://github.com/samdvr/eventsourcer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "ruby-kafka", "~> 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/eventsourcer.rb

@@ -0,0 +1,36 @@
+require 'eventsourcer/version'
+require 'eventsourcer/broker_factory'
+require 'eventsourcer/errors'
+require 'eventsourcer/brokers/base'
+require 'eventsourcer/brokers/kafka_broker'
+
+module Eventsourcer
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :broker, :logger, :kafka_seed_brokers, :kafka_max_queue_size
+
+    def initialize
+      @broker = nil
+      @logger = nil
+      @kafka_seed_brokers = nil
+      @kafka_max_queue_size = nil
+    end
+  end
+
+  def self.included(base)
+    base.send :after_commit, :publish if base.respond_to?(:after_commit)
+  end
+
+  def publish
+    @publisher ||= Eventsourcer::BrokerFactory.build
+    @publisher.publish(table_name: self.class.table_name, previous_changes: previous_changes)
+  end
+end

data/lib/eventsourcer/broker_factory.rb

@@ -0,0 +1,17 @@
+module Eventsourcer
+  class BrokerFactory
+    def self.build
+      raise Eventsourcer::Errors::BrokerNotConfiguredError unless Eventsourcer.configuration
+      return fetch_broker_klass(Eventsourcer.configuration.broker)
+    end
+
+    def self.fetch_broker_klass(configured_broker)
+      if configured_broker == :kafka
+        return Eventsourcer::Brokers::KafkaBroker
+      else
+        raise Eventsourcer::Errors::BrokerNotFound
+      end
+    end
+  end
+
+end

data/lib/eventsourcer/brokers/base.rb

@@ -0,0 +1,9 @@
+module Eventsourcer
+  module Brokers
+    class Base
+      def self.publish(table_name:, previous_changes:)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/eventsourcer/brokers/kafka_broker.rb

@@ -0,0 +1,41 @@
+require "securerandom"
+require "json"
+require "kafka"
+
+module Eventsourcer
+  module Brokers
+    class KafkaBroker < Base
+      @mutex = Mutex.new
+
+      def self.publish(table_name:, previous_changes:)
+        producer = client.async_producer(max_queue_size: Eventsourcer.configuration.kafka_max_queue_size || 10000)
+        begin
+          produce_to_kafka(producer, table_name, previous_changes.to_json)
+        rescue Kafka::BufferOverflow
+          producer.deliver_messages
+          produce_to_kafka(producer, table_name, previous_changes.to_json)
+        end
+
+        producer.deliver_messages
+        producer.shutdown
+      end
+      
+      private
+
+      def self.produce_to_kafka(producer, table_name, previous_changes_json)
+        producer.produce(previous_changes_json,
+                 topic: table_name,
+                 key: SecureRandom.uuid)
+      end
+
+      def self.client
+        @mutex.synchronize do
+          @client ||= Kafka.new(
+            seed_brokers: Eventsourcer.configuration.kafka_seed_brokers || ["localhost:9092"],
+            logger: Eventsourcer.configuration.logger || Rails.logger
+          )
+        end
+      end
+    end
+  end
+end

data/lib/eventsourcer/errors.rb

@@ -0,0 +1,12 @@
+module Eventsourcer
+  module Errors
+    class Base < StandardError
+    end
+
+    class BrokerNotConfiguredError < Base
+    end
+
+    class BrokerNotFound < Base
+    end
+  end
+end

data/lib/eventsourcer/version.rb

@@ -0,0 +1,3 @@
+module Eventsourcer
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: eventsourcer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Davarnia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This library publishes tracked ActiveRecord changes to a persistence
+  layer such as Apache Kafka.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eventsourcer.gemspec
+- lib/eventsourcer.rb
+- lib/eventsourcer/broker_factory.rb
+- lib/eventsourcer/brokers/base.rb
+- lib/eventsourcer/brokers/kafka_broker.rb
+- lib/eventsourcer/errors.rb
+- lib/eventsourcer/version.rb
+homepage: https://github.com/samdvr/eventsourcer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Library to event source ActiveRecord changes to a broker.
+test_files: []