active_record_streams 0.1.0

data/lib/active_record_streams/publishers/sns_stream.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ActiveRecordStreams
+  module Publishers
+    class SnsStream
+      ANY_TABLE = '*'
+
+      ##
+      # @param [String] topic_arn
+      # @param [String] table_name
+      # @param [Enumerable<String>] ignored_tables
+      # @param [Hash] overrides
+
+      def initialize(
+        topic_arn:,
+        table_name: ANY_TABLE,
+        ignored_tables: [],
+        overrides: {}
+      )
+        @topic_arn = topic_arn
+        @table_name = table_name
+        @ignored_tables = ignored_tables
+        @overrides = overrides
+      end
+
+      ##
+      # @param [String] table_name
+      # @param [ActiveRecordStreams::Message] message
+
+      def publish(table_name, message)
+        return unless (any_table? && allowed_table?(table_name)) ||
+                      table_name == @table_name
+
+        client.publish(@topic_arn, message.json, @overrides)
+      end
+
+      private
+
+      def any_table?
+        @table_name == ANY_TABLE
+      end
+
+      def allowed_table?(table_name)
+        !@ignored_tables.include?(table_name)
+      end
+
+      def client
+        @client ||= SnsClient.new
+      end
+    end
+  end
+end

data/lib/active_record_streams/publishers/sns_stream_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative 'sns_stream'
+
+RSpec.describe ActiveRecordStreams::Publishers::SnsStream do
+  let(:topic_arn) { 'arn::some-topic-arn' }
+  let(:desired_table_name) { '*' }
+  let(:actual_table_name) { 'lovely_records' }
+  let(:ignored_tables) { [] }
+  let(:overrides) { {} }
+
+  let(:message) { double(json: '{}') }
+  let(:sns_client) { double(publish: nil) }
+
+  subject do
+    described_class.new(
+      topic_arn: topic_arn,
+      table_name: desired_table_name,
+      ignored_tables: ignored_tables,
+      overrides: overrides
+    )
+  end
+
+  before do
+    allow(ActiveRecordStreams::Publishers::SnsClient)
+      .to receive(:new)
+      .and_return(sns_client)
+  end
+
+  describe '#publish' do
+    context 'any table' do
+      it 'sends event to sns' do
+        expect(sns_client).to receive(:publish) do |topic_arn, data, _overrides|
+          expect(topic_arn).to eq(topic_arn)
+          expect(data).to eq(message.json)
+        end
+
+        subject.publish(actual_table_name, message)
+      end
+    end
+
+    context 'specific table' do
+      let(:desired_table_name) { actual_table_name }
+
+      it 'sends event to sns' do
+        expect(sns_client).to receive(:publish) do |topic_arn, data, _overrides|
+          expect(topic_arn).to eq(topic_arn)
+          expect(data).to eq(message.json)
+        end
+
+        subject.publish(actual_table_name, message)
+      end
+    end
+
+    context 'non-matching table' do
+      let(:desired_table_name) { 'another_table' }
+
+      it 'does not send event to sns' do
+        expect(sns_client).not_to receive(:publish)
+
+        subject.publish(actual_table_name, message)
+      end
+    end
+
+    context 'blacklisted table' do
+      let(:ignored_tables) { [actual_table_name] }
+
+      it 'does not send event to sns' do
+        expect(sns_client).not_to receive(:publish)
+
+        subject.publish(actual_table_name, message)
+      end
+    end
+
+    context 'with overrides' do
+      let(:overrides) { { 'hello' => 'world' } }
+
+      it 'sends event to a sns' do
+        expect(sns_client).to receive(:publish) do |topic_arn, data, overrides|
+          expect(topic_arn).to eq(topic_arn)
+          expect(data).to eq(message.json)
+          expect(overrides).to eq(overrides)
+        end
+
+        subject.publish(actual_table_name, message)
+      end
+    end
+  end
+end

data/lib/active_record_streams/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordStreams
+  VERSION = '0.1.0'
+end

data/lib/active_record_streams/version_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+
+RSpec.describe ActiveRecordStreams::VERSION do
+  it 'has a version number' do
+    expect(subject).to eq('0.1.0')
+  end
+end

data/lib/active_record_streams_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../spec/mocks/active_record/persistence'
+require_relative '../spec/mocks/active_record/relation'
+require_relative '../spec/mocks/active_record/base'
+
+require_relative 'active_record_streams'
+
+RSpec.describe ActiveRecordStreams do
+  describe '.configure' do
+    it 'yields configuration' do
+      expect { |b| subject.configure(&b) }.to yield_control
+    end
+  end
+
+  describe '.config' do
+    it 'returns configuration' do
+      expect(subject.config).to be_a(ActiveRecordStreams::Config)
+    end
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: active_record_streams
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Advanon Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: |2
+      Publish events about changes to your ActiveRecord models to different
+      targets, like HTTP endpoints, AWS SNS topics or Kinesis streams
+email:
+- team@advanon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- active_record_streams.gemspec
+- lib/active_record_streams.rb
+- lib/active_record_streams/config.rb
+- lib/active_record_streams/config_spec.rb
+- lib/active_record_streams/credentials.rb
+- lib/active_record_streams/credentials_spec.rb
+- lib/active_record_streams/extensions/active_record/base.rb
+- lib/active_record_streams/extensions/active_record/base_spec.rb
+- lib/active_record_streams/extensions/active_record/persistence.rb
+- lib/active_record_streams/extensions/active_record/persistence_spec.rb
+- lib/active_record_streams/extensions/active_record/relation.rb
+- lib/active_record_streams/extensions/active_record/relation_spec.rb
+- lib/active_record_streams/message.rb
+- lib/active_record_streams/message_spec.rb
+- lib/active_record_streams/publishers/http_stream.rb
+- lib/active_record_streams/publishers/http_stream_spec.rb
+- lib/active_record_streams/publishers/kinesis_client.rb
+- lib/active_record_streams/publishers/kinesis_client_spec.rb
+- lib/active_record_streams/publishers/kinesis_stream.rb
+- lib/active_record_streams/publishers/kinesis_stream_spec.rb
+- lib/active_record_streams/publishers/sns_client.rb
+- lib/active_record_streams/publishers/sns_client_spec.rb
+- lib/active_record_streams/publishers/sns_stream.rb
+- lib/active_record_streams/publishers/sns_stream_spec.rb
+- lib/active_record_streams/version.rb
+- lib/active_record_streams/version_spec.rb
+- lib/active_record_streams_spec.rb
+homepage: https://advanon.com
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://advanon.com
+  source_code_uri: https://github.com/Advanon/active_record_streams
+  changelog_uri: https://github.com/Advanon/active_record_streams/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Stream ActiveRecord events via HTTP, AWS SNS or Kinesis streams
+test_files: []