koyo-postgres-replication 0.1.5.pre → 0.1.6.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b45ea024487cd58842efb84ffb49a8a838a087c3302fc1411d02ec1afc646c2
-  data.tar.gz: 81900cffddb22af277e55be4c558316b9e0a61e3c9d9618f8d47ae1019f479ab
+  metadata.gz: 205fff146002126edb7d725c1897ed7e3dc6bedc78539f0d21e707e22c5aeee0
+  data.tar.gz: 5aa57b08c21c7e86fdd6b44f9b2a4a679b2cf6c3e7628ab99f932757b46974ab
 SHA512:
-  metadata.gz: 52657842594b2e36b7ac7f658b2c3a56b3e4c6a4d7b22896dd1fade2daa34c7d7a4a9884c374930b055180b46078b72b2c6bdddf2a6b8a518ea67528e8b58b56
-  data.tar.gz: 7252cd8c30c701ee033cf7244ed668e9b23d9c9b0f48d958835eafe59a0419c0df60a05e09e580ebb798bec704e44708bd12905cf658669494ed58fa6a3082f6
+  metadata.gz: 13a8079535f071892ce0916853c6ddb2f197d355dbe780889c80d67313254632365e6a2a29a171f3dcbba6811bf6f77f9be59a26fe9822abbf56cace481cd41b
+  data.tar.gz: 20db2d8d865adc610b433673b44c93528cc490b43f7ac430aaf4a8924f10a14e552e7ea8e986790226bab27ce3e4835f900daebddf6252f27133fd5b9f1faba3

data/.yardoc/checksums

@@ -4,7 +4,7 @@ lib/koyo/repl/mod.rb 92b54b56643b06fdc74adc65dc04460f631d4036
 lib/koyo/repl/data.rb cb847585c0f439b9f645b5ebd7fa3b96e08b94ff
 lib/koyo/repl/install.rb 9b19b7bb74d084882a1f726693bac2d693015daa
 lib/koyo/repl/railtie.rb 9c560c38f4663edda57aa39c9bb4bd9411daabbd
-lib/koyo/repl/version.rb d0d535b2aac27e3caa5eaeef69e117772e334f44
+lib/koyo/repl/version.rb a05897446d0fc22220b2393f10f0ab1f4dbba1d8
 lib/koyo/repl/data_row.rb 46bd0b440721f3b0ddcded3fef1817ca5d77cb35
 lib/koyo/repl/database.rb 719f2723b83a927e0524f6dea79393caaeba0514
 lib/koyo/repl/diagnostics.rb 93226c47642c5e20f615425aff8a0c0ba988b07b

data/Dockerfile

@@ -17,13 +17,8 @@ RUN gem update --system && gem install bundler && gem install rails
 
 WORKDIR /usr/src/app
 
-COPY Gemfile .
-COPY Gemfile.lock .
-
 COPY . .
 
 RUN bundle install
 
-COPY . .
-
 CMD ["irb"] 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    koyo-postgres-replication (0.1.5.pre)
+    koyo-postgres-replication (0.1.6.pre)
       pg (~> 1.1)
       rack (~> 2.0, >= 2.0.0)
       rails (~> 7.0)

data/README.md

@@ -4,9 +4,63 @@
 
 効用 koyo - Japanese for utility
 
-## Replcation slots
+## What is this?
 
-This gem tries to simplify dealing with a `replication slot` in Postgres. 
+This gem tries to simplify dealing with a `replication slot` in Postgres. It
+gives you a simple way to capture events in your Rails app when your Postgres
+DB has a create, update, delete event. You can manage this from one class, or
+manage this on a table-by-table basis within ActiveRecord Models. 
+
+Example of catch all:
+
+```
+class KoyoReplHandlerService < Koyo::Repl::EventHandlerService
+  class << self
+    # This is called whenever a create/update/delete action happens
+    # @param (Koyo::Repl::DataRow) row is docuemented in the wiki at
+    # https://github.com/wiseleyb/koyo-postgres-replication/wiki/Koyo::Repl::DataRow-data-spec
+    def koyo_handle_all_replication(row)
+      case row.kind
+      when 'insert'
+        case row.table
+        when 'users'
+          # Do something with data... like update some api
+          # It's important to do this async (active-job/sidekiq) so you 
+          # don't back up the replication slot
+          UpdateSomeApi.performn_async(row.id)
+          # This job would do something like:
+          # User.find(row.id); Call some API with data
+      when 'delete'
+      when 'update'
+    end
+  end
+end
+```
+
+Example of model callback:
+
+```
+class User < ApplicationRecord
+  include Koyo::Repl::Mod
+  koyo_repl_handler :handle_replication
+
+  # This is called when a row is created/updated/deleted for the users table
+  # @param (Koyo::Repl::DataRow) row is docuemented in the wiki at
+  # https://github.com/wiseleyb/koyo-postgres-replication/wiki/Koyo::Repl::DataRow-data-spec
+  def self.handle_replication(row)
+    case row.kind
+    when 'insert'
+      # Do something with data... like update some api
+      # It's important to do this async (active-job/sidekiq) so you 
+      # don't back up the replication slot
+      UpdateSomeApi.performn_async(row.id)
+      # This job would do something like:
+      # User.find(row.id); Call some API with data
+    when 'delete'
+    when 'update'
+  end
+end
+```
 
 ### What is a replication slot?
 

data/changelog.md

@@ -1,5 +1,10 @@
 # Koyo Postgres Replication Changelog
 
+## 0.1.6.pre
+
+- Clean up docker config
+- Clean up README/doc
+
 ## 0.1.5.pre
 
 - Yard doc gemspec change to get it to show up in rubygems

data/lib/koyo/repl/version.rb

@@ -2,6 +2,6 @@
 
 module Koyo
   module Repl
-    VERSION = '0.1.5.pre'
+    VERSION = '0.1.6.pre'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koyo-postgres-replication
 version: !ruby/object:Gem::Version
-  version: 0.1.5.pre
+  version: 0.1.6.pre
 platform: ruby
 authors:
 - Ben Wiseley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg