activerecord-postgres_pub_sub 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1424251b97e52c73cf656eb628a1e37a3a0de3884ddd96b39cb5d6c1d09f7e7b
+  data.tar.gz: 825a01dcb7562495c2ff0e8e3159e5451ec90742daa5d404b2c7dc90177f85e3
+SHA512:
+  metadata.gz: ccaaddb16fc67fcf2fe3717630d947eca0d2d8751d12a33c79a2384d1522459492df4df7af5c79a13bac0ad5d399570c8eb191e840e8a165024fe76518f607ef
+  data.tar.gz: 1de55a0455b85900796107620981b1782eba4b0cabc28a5aa010dfe56a5b52eb53b5910fd9dde2b49d751e8bbf3b7c23c81992cb3009407f92cfcf8b2b94ff15

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# activerecord-postgres_pub_sub
+
+## v0.2.0
+- Public release
+
+## v0.1.0
+- Initial version

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://ezcater.jfrog.io/ezcater/api/gems/ezcater-gem-source"
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in activerecord-postgres_pub_sub.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ezCater, Inc
+
+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,98 @@
+# activerecord-postgres_pub_sub
+
+This gem contains support for PostgreSQL LISTEN and NOTIFY functionality: 
+[doc](https://www.postgresql.org/docs/9.6/static/libpq-notify.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "activerecord-postgres_pub_sub"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-postgres_pub_sub
+
+## Usage
+
+### Listener
+
+The `Listener` class is used to handle notification messages.
+
+The listener can be configured with three blocks:
+
+* **on_notify**: called whenever a notification is received.
+* **on_start**: called before receiving any notifications.
+* **on_timeout**: called based on a configurable timeout, when no notifications
+  have been received.
+  
+When creating a listener, the following configuration is supported:
+
+* **listen_timeout**: If set, the `on_timeout` block will be called if 
+  no notifications are received within this period. (Default `nil`).  
+* **notify_only**: A payload string can be included in notifications. By default
+  the listener ignores the payload and coalesces multiple notifications into a 
+  single call. When this option is `false`, the `on_notify` block is called with
+  the payload for each notification. (Default `true`).
+* **exclusive_lock**: Acquire a lock using
+  [with_advisory_lock](https://github.com/ClosureTree/with_advisory_lock) prior to listening.
+  This option ensures that a process as a singleton listener. (Default `true`).
+
+Example:
+
+```ruby
+ActiveRecord::PostgresPubSub::Listener.listen("notify_channel", listen_timeout: 30) do |listener|
+  listener.on_start do
+    # when starting assume we missed something and perform regular activity 
+    handle_notification
+  end
+  
+  listener.on_notify do
+    handle_notification
+  end
+  
+  listener.on_timeout do
+    perform_regular_maintenance 
+  end
+end
+```
+
+### Generator
+
+This gem contains a Rails generator for a migration to add a trigger to notify on insert to a table.
+
+The generator must be run with a model name corresponding to the table.
+
+```bash
+rails generate active_record:postgres_pub_sub:notify_on_insert --model_name NameSpace::Entity
+```
+
+In this example, notification events would be generated for the channel named `"name_space_entity"` based
+on inserts to the `name_space_entities` table.
+
+## 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/ezcater/activerecord-postgres_pub_sub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/activerecord-postgres_pub_sub.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "activerecord/postgres_pub_sub/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-postgres_pub_sub"
+  spec.version       = ActiveRecord::PostgresPubSub::VERSION
+  spec.authors       = ["ezCater, Inc"]
+  spec.email         = ["engineering@ezcater.com"]
+  spec.summary       = "Support for Postgres Notify/Listen"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/ezcater/activerecord-postgres_pub_sub"
+  spec.license       = "MIT"
+
+  # Set "allowed_push_post" to control where this gem can be published.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  excluded_files = %w(.circleci/config.yml
+                      .github/PULL_REQUEST_TEMPLATE.md
+                      .gitignore
+                      .rspec
+                      .rubocop.yml
+                      .ruby-gemset
+                      .ruby-version
+                      .travis.yml
+                      bin/console
+                      bin/setup
+                      Rakefile)
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end - excluded_files
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", "~> 5.1.4"
+  spec.add_runtime_dependency "pg", "~> 0.18"
+  spec.add_runtime_dependency "private_attr"
+  spec.add_runtime_dependency "with_advisory_lock"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "ezcater_rubocop", "0.52.7"
+  spec.add_development_dependency "overcommit"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rspec_junit_formatter", "0.2.2"
+  spec.add_development_dependency "simplecov"
+end

data/lib/activerecord-postgres_pub_sub.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "activerecord/postgres_pub_sub/version"
+require "activerecord/postgres_pub_sub/listener"

data/lib/activerecord/postgres_pub_sub/listener.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "private_attr"
+require "with_advisory_lock"
+
+module ActiveRecord
+  module PostgresPubSub
+    class Listener
+      extend PrivateAttr
+
+      private_attr_reader :on_notify_blk, :on_start_blk, :on_timeout_blk,
+                          :channel, :listen_timeout, :exclusive_lock, :notify_only
+
+      def self.listen(channel, listen_timeout: nil, exclusive_lock: true, notify_only: true)
+        listener = new(channel,
+                       listen_timeout: listen_timeout,
+                       exclusive_lock: exclusive_lock,
+                       notify_only: notify_only)
+        yield(listener) if block_given?
+        listener.listen
+      end
+
+      def initialize(channel, listen_timeout: nil, exclusive_lock: true, notify_only: true)
+        @channel = channel
+        @listen_timeout = listen_timeout
+        @exclusive_lock = exclusive_lock
+        @notify_only = notify_only
+      end
+
+      def on_notify(&blk)
+        @on_notify_blk = blk
+      end
+
+      def on_start(&blk)
+        @on_start_blk = blk
+      end
+
+      def on_timeout(&blk)
+        @on_timeout_blk = blk
+      end
+
+      def listen
+        with_connection do |connection|
+          on_start_blk&.call
+
+          loop do
+            wait_for_notify(connection) do |payload|
+              notify_only ? on_notify_blk.call : on_notify_blk.call(payload)
+            end
+          end
+        end
+      end
+
+      private
+
+      def with_connection
+        ActiveRecord::Base.connection_pool.with_connection do |connection|
+          with_optional_lock do
+            connection.execute("LISTEN #{channel}")
+
+            begin
+              yield(connection)
+            ensure
+              connection.execute("UNLISTEN #{channel}")
+            end
+          end
+        end
+      end
+
+      def with_optional_lock
+        if exclusive_lock
+          ActiveRecord::Base.with_advisory_lock(lock_name) { yield }
+        else
+          yield
+        end
+      end
+
+      def lock_name
+        "#{channel}-listener"
+      end
+
+      def empty_channel(connection)
+        while connection.wait_for_notify(0)
+          # call until nil is returned
+        end
+      end
+
+      def wait_for_notify(connection)
+        connection_pid = connection.raw_connection.backend_pid
+        event_result = connection.raw_connection.wait_for_notify(listen_timeout) do |_event, pid, payload|
+          if pid != connection_pid
+            empty_channel(connection.raw_connection) if notify_only
+            yield(payload)
+          end
+        end
+
+        on_timeout_blk&.call if event_result.nil?
+      end
+    end
+  end
+end

data/lib/activerecord/postgres_pub_sub/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module PostgresPubSub
+    VERSION = "0.2.0"
+  end
+end

data/lib/generators/active_record/postgres_pub_sub/notify_on_insert_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+require "rails/generators/active_record"
+
+module ActiveRecord
+  module PostgresPubSub
+    class NotifyOnInsertGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.join(File.dirname(__FILE__), "templates")
+
+      class_option :model_name, type: :string
+
+      def create_migration_file
+        migration_template("create_notify_on_insert_trigger.rb.erb",
+                           "db/migrate/create_notify_on_#{table_name}_insert_trigger.rb")
+      end
+
+      private
+
+      def model_name
+        @model_name ||= options.fetch(:model_name)
+      end
+
+      def table_name
+        @table_name ||= model_name.tableize.tr("/", "_")
+      end
+
+      def notification_name
+        @notification_name || table_name.singularize
+      end
+
+      def table_module
+        @module_name ||= model_name.deconstantize.underscore.tr("/", "_")
+      end
+
+      def model_title
+        @model_title ||= table_name.camelize
+      end
+    end
+  end
+end

data/lib/generators/active_record/postgres_pub_sub/templates/create_notify_on_insert_trigger.rb.erb

@@ -0,0 +1,31 @@
+class CreateNotifyOn<%= model_title %>InsertTrigger < ActiveRecord::Migration[5.1]
+  TABLE_NAME = "<%= table_name %>".freeze
+  NOTIFICATION_NAME = "<%= notification_name %>".freeze
+  TABLE_MODULE = "<%= table_module %>".freeze
+
+  def up
+    execute <<-SQL
+      CREATE OR REPLACE FUNCTION notify_#{TABLE_MODULE}_listeners() RETURNS TRIGGER AS $$
+      DECLARE
+      BEGIN
+        PERFORM pg_notify('#{NOTIFICATION_NAME}', null);
+        RETURN NEW;
+      END;
+      $$ LANGUAGE plpgsql
+    SQL
+
+    execute <<-SQL
+      CREATE TRIGGER #{TABLE_MODULE}_trigger
+      AFTER INSERT
+      ON #{TABLE_NAME}
+      FOR EACH STATEMENT
+      EXECUTE PROCEDURE notify_#{TABLE_MODULE}_listeners()
+    SQL
+  end
+
+  def down
+    execute <<-SQL
+      DROP FUNCTION notify_#{TABLE_MODULE}_listeners() CASCADE
+    SQL
+  end
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-postgres_pub_sub
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- ezCater, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: private_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_advisory_lock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ezcater_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.7
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Support for Postgres Notify/Listen
+email:
+- engineering@ezcater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- activerecord-postgres_pub_sub.gemspec
+- lib/activerecord-postgres_pub_sub.rb
+- lib/activerecord/postgres_pub_sub/listener.rb
+- lib/activerecord/postgres_pub_sub/version.rb
+- lib/generators/active_record/postgres_pub_sub/notify_on_insert_generator.rb
+- lib/generators/active_record/postgres_pub_sub/templates/create_notify_on_insert_trigger.rb.erb
+homepage: https://github.com/ezcater/activerecord-postgres_pub_sub
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Support for Postgres Notify/Listen
+test_files: []