active_record_streams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04ab246f568d123036bade4dac470b4043c56853
+  data.tar.gz: 5dec2a061686683d131d0d1363a63bc6b5e85e47
+SHA512:
+  metadata.gz: 939dcae88607b746000741c4ada06c4e60c6e522a932b0b6f45353ae9183df7371fa2bdfafe5999db4b6b90ee097d42e5ca919fbfb253eb84e3d8cee4eae0c8f
+  data.tar.gz: d027a7cf85323ced248355420ee9a0bf3fb090e066ee6bf972fa65933361128831b215e14bd274c51be81b1a2673075cd9b14c3e63ed90a81dc4aa8ad739cbad

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,35 @@
+## Overview
+
+Please include a brief summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. Please also add links to relevant tickets (if there are any).
+
+Connects #XXX
+
+### Type of change
+
+Please delete options that are not relevant.
+
+- Bug fix (non-breaking change which fixes an issue)
+- New feature (non-breaking change which adds functionality)
+- Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- Configuration changes
+- Refactoring
+- This change requires a documentation update
+
+### Migrations
+
+*Optional.* Add brief description of migration.
+
+### Demo
+
+*Optional.* Screenshots, `curl` examples, etc.
+
+### Notes
+
+*Optional.* Ancillary topics, caveats, alternative strategies that didn't work out, anything else.
+
+## Testing instructions
+
+- Describe how to test this PR
+- Prefer bulleted description
+- Include any setup required, such as bundling scripts, restarting services, etc.
+- Include test case, and expected output

data/.gitignore

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

data/.rspec

@@ -0,0 +1,5 @@
+--format documentation
+--color
+--require spec/spec_helper
+--default-path .
+--exclude-pattern vendor/**/*

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require: rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+  - !ruby/regexp /_spec\.rb\z/
+  - vendor/**/*
+
+Documentation:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install:
+  - gem install bundler -v 1.17.1
+  - bundle install
+  - bundle exec rubocop
+  - bundle exec rspec --version
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2017-06-20
+### Added
+- Global hooks for ActiveRecord 4.2.10.
+- Overrides to ActiveRecord::Base, ActiveRecord::Relation, ActiveRecord::Persistence to serve callbacks.
+- SNS, Kinesis and HTTP stream types.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    active_record_streams (0.1.0)
+      activerecord (~> 4.2.10)
+      aws-sdk (~> 2.11.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.11.1)
+      activesupport (= 4.2.11.1)
+      builder (~> 3.1)
+    activerecord (4.2.11.1)
+      activemodel (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      arel (~> 6.0)
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    ast (2.4.0)
+    aws-eventstream (1.0.2)
+    aws-sdk (2.11.258)
+      aws-sdk-resources (= 2.11.258)
+    aws-sdk-core (2.11.258)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.11.258)
+      aws-sdk-core (= 2.11.258)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    jmespath (1.4.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record_streams!
+  bundler (~> 1.17)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.67.2)
+  rubocop-performance (~> 1.1.0)
+
+BUNDLED WITH
+   1.17.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Advanon AG (https://advanon.com)
+
+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,168 @@
+[![Build Status](https://travis-ci.org/Advanon/active_record_streams.svg?branch=master)](https://travis-ci.org/Advanon/active_record_streams)
+
+# Active Record Streams
+
+A small library to stream ActiveRecord's create/update/delete
+events to AWS SNS topics, Kinesis streams or HTTP listeners.
+
+## Version mappings
+
+```
+1.0.X - ActiveRecord 4.2.10
+```
+
+## Warning
+
+Please, be aware that this library changes behaviour of such methods as
+`update_all`, `delete_all`, `update_columns`, `update_column`
+to start serving callbacks.
+
+## How does it work
+
+The library adds a global hook to the ActiveRecord's `after_commit`
+events and streams these events to the specified targets (topics/streams/http).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_streams'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_streams
+
+## Usage
+
+### Setting up for AWS
+
+Skip this section if you are not going to use any of AWS targets.
+
+If you already configured AWS sdk or you are running the code under 
+AWS-controlled environment with proper policies, ActiveRecordStreams
+should start working without specifying any credentials.
+
+If you didn't yet configure AWS globally or you want to specify separate
+authentication details for streaming, use the following snippet:
+
+```ruby
+# config/initializers/active_record_streams.rb
+
+require 'active_record_streams'
+
+ActiveRecordStreams.configure do |config|
+  config.aws_region = 'eu-central-1'
+  config.aws_access_key_id = 'YOUR_ACCESS_KEY_ID'
+  config.aws_secret_access_key = 'YOUR_SECRET_ACCESS_KEY'
+end
+```
+
+### Enabling streams
+
+To start streaming events you just need to add them to configuration.
+You may add as many streams as you need. By default, each stream
+publishes events for all the tables, but you may change that by specifying
+the `table_name` or `ignored_tables` option.
+
+```ruby
+# config/initializers/active_record_streams.rb
+
+require 'active_record_streams'
+
+ActiveRecordStreams.configure do |config|
+  # Listen to all tables and publish events to the specified SNS topic
+  config.streams << ActiveRecordStreams::Publishers::SnsStream.new(
+    topic_arn: 'arn:aws:sns:...'
+  )
+  
+  # Publish only events coming from `users` table to the specified SNS topic
+  config.streams << ActiveRecordStreams::Publishers::SnsStream.new(
+    table_name: 'users',
+    topic_arn: 'arn:aws:sns:...'
+  )
+  
+  # Publish events for all the tables but `updates`
+  config.streams << ActiveRecordStreams::Publishers::SnsStream.new(
+    ignored_tables: %w[updates],
+    topic_arn: 'arn:aws:sns:...'
+  )
+end
+```
+
+## Supported targets:
+
+### ActiveRecordStreams::Publishers::SnsStream
+
+```ruby
+config.streams << ActiveRecordStreams::Publishers::SnsStream.new(
+  topic_arn: String,                  # Required
+  table_name: String,                 # Optional
+  ignored_tables: Enumerable<String>, # Optional
+
+  # See: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#publish-instance_method
+  overrides: {                        ## Optional
+    target_arn: String,               #
+    phone_number: String,             #
+    subject: String,                  #
+    message_structure: String,        #
+    message_attributes: {             #
+      'String' => {                   #
+        data_type: String,            #
+        string_value: String,         #
+        binary_value: String          ##
+      }
+    }
+  }
+)
+```
+
+### ActiveRecordStreams::Publishers::KinesisStream
+
+```ruby
+config.streams << ActiveRecordStreams::Publishers::KinesisStream.new(
+  stream_name: String,                # Required
+  table_name: String,                 # Optional
+  ignored_tables: Enumerable<String>, # Optional
+
+  # See: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kinesis/Client.html#put_record-instance_method
+  overrides: {                             ## Optional
+    explicit_hash_key: String,             #
+    sequence_number_for_ordering: String,  ##
+  }
+)
+```
+
+### ActiveRecordStreams::Publishers::HttpStream
+
+```ruby
+config.streams << ActiveRecordStreams::Publishers::HttpStream.new(
+  url: String,                        # Required
+  headers: Hash,                      # Optional
+  table_name: String,                 # Optional
+  ignored_tables: Enumerable<String>  # Optional
+)
+```
+
+## License
+
+This software is licensed under the MIT license. See `MIT-LICENSE` for details.
+
+## Development
+
+1) Run `bundle install` to install dependencies
+2) Use `rubocop` or `bundle exec rubocop` to run the Rubocop
+3) Run `rspec` or `bundle exec rspec` to run the tests
+4) Run `bundle exec rake install` to install the gem on a local machine
+5) Do not forget to add your changes to the `CHANGELOG.md`
+5) To release a new version update `version.rb`, `version_spec.rb` and run `gem build active_record_streams.gemspec` to release a new version
+6) To push a new version to the Rubygems run `gem push <generated_gem_file.gem>`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Advanon/active_record_streams.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/active_record_streams.gemspec

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_streams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_streams'
+  spec.version       = ActiveRecordStreams::VERSION
+  spec.authors       = ['Advanon Team']
+  spec.email         = ['team@advanon.com']
+
+  spec.summary = <<-HEREDOC
+    Stream ActiveRecord events via HTTP, AWS SNS or Kinesis streams
+  HEREDOC
+
+  spec.description = <<-HEREDOC
+    Publish events about changes to your ActiveRecord models to different
+    targets, like HTTP endpoints, AWS SNS topics or Kinesis streams
+  HEREDOC
+
+  spec.homepage = 'https://advanon.com'
+  spec.required_ruby_version = '>= 2.3.3'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+
+    spec.metadata['source_code_uri'] =
+      'https://github.com/Advanon/active_record_streams'
+
+    spec.metadata['changelog_uri'] =
+      'https://github.com/Advanon/active_record_streams/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 4.2.10'
+  spec.add_dependency 'aws-sdk', '~> 2.11.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry', '~> 0.12.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.1.0'
+end