event_notifier 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4bdaed6c6e9be6fed55844588f65789c25e9931758373311a7ef0121445246c
+  data.tar.gz: 2e4c112decef0357bd5f7f55db089912f5f1386d81167004a81aa85540ea59dc
+SHA512:
+  metadata.gz: fcdd0bfb8ef55d5264517dcd1c7665a458582f8adcb579f77fc33e2f7a8d7fcb63535dca38f9d79827a9cdcb3d2ea24ce6d6cae36e9f787764b2f1fc8356669f
+  data.tar.gz: 9cb08e2f7330b5a97d27ec1265b41ac0011dc6c4b4c65e891918275471c2950e0d83ef80fe6dde206ab1dcbb7d8589f23ea3b1df7bf8ebb413757f9ceeaacd87

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Shahzad Tariq
+
+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.rdoc

@@ -0,0 +1,54 @@
+= EventNotifier
+
+Listen for database events like create new record, updated existing or destroy & notify. These events can be used with ActionController::Live or Server Sent Events (SSE)
+
+== Installation
+
+Simply add event_notifier gem to your Gemfile.
+
+    gem 'event_notifier'
+
+& from terminal, run:
+
+    bundle install
+    
+
+== Usage
+
+    class Account < ActiveRecord::Base
+        include EventNotifier
+
+        .....
+
+    end
+
+
+and inside your controller / SSE or wherever you want to use database events,
+
+    class AccountsController < ApplicationController
+
+        def sse_live
+            Account.on_event do |_event|
+                sse.write(_event) # or whatever you want to do when a new account is created or existing account object is updated or destroyed
+            end
+        end
+    end
+                
+
+And now you are ready to track database event notifications.
+
+p.s. Currently only create/update & destory events are handled
+
+
+== TODO
+
+* Configuration options for events to handle
+* MongoDB support
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/event_notifier/VERSION.rb

@@ -0,0 +1,3 @@
+module EventNotifier
+  VERSION = "1.0.0"
+end

data/lib/event_notifier.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module EventNotifier
+  extend ActiveSupport::Concern
+
+  included do
+    after_save :notify_event
+    after_destroy :notify_event
+
+    def notify_event
+      self.class.connection.execute "NOTIFY #{self.class.table_name}, 'SSE'"
+    end
+
+    def self.on_event
+      connection.execute "LISTEN #{table_name}"
+      loop do
+        break if Rails.env.test?
+
+        connection.raw_connection.wait_for_notify do |_event, _pid, data|
+          yield data
+        end
+        sleep 5
+      end
+    ensure
+      connection.execute "UNLISTEN #{table_name}"
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: event_notifier
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shahzad Tariq
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Listen for database events like create new record, updated existing or
+  destroy & notify. These events can be used with ActionController::Live or Server
+  Sent Events (SSE)
+email:
+- m.shahzad.tariq@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- lib/event_notifier.rb
+- lib/event_notifier/VERSION.rb
+homepage: http://github.com/mshahzadtariq/event_notifier
+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: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Listen for database events like create new record, updated existing or destroy
+  & notify.
+test_files: []