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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7e309ca1f76d89a85e0d84b66fd54b629e7060ffd089a6a4383099230ccad9f
-  data.tar.gz: d387c7c45a91cf7500c83188688024fd8c08c97c4298fcc015d1d7b12adc425b
+  metadata.gz: 205fff146002126edb7d725c1897ed7e3dc6bedc78539f0d21e707e22c5aeee0
+  data.tar.gz: 5aa57b08c21c7e86fdd6b44f9b2a4a679b2cf6c3e7628ab99f932757b46974ab
 SHA512:
-  metadata.gz: 69dae55f084fc5d4206164d47e312d5bcbf530397190563126097fc3e0250760537ae1930b68228e18f7490e929e374af67663bb3ee8b6da99460dc718951bc6
-  data.tar.gz: 4c53b1c6a422c78f70885ac5db3a4951b8323b8ba9707771915cd4cbe933274d2697c467c2b75586ca9c77e2e5fd299cf8bdfdc5b011a39dc6efa2ab6288bb82
+  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

@@ -0,0 +1,24 @@
+FROM ruby:3.2.2-slim
+
+RUN apt-get update -qq && apt-get install -yq --no-install-recommends \
+    git \
+    build-essential \
+    gnupg2 \
+    less \
+    libpq-dev \
+    postgresql-client \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+ENV LANG=C.UTF-8 \
+  BUNDLE_JOBS=4 \
+  BUNDLE_RETRY=3
+  
+RUN gem update --system && gem install bundler && gem install rails
+
+WORKDIR /usr/src/app
+
+COPY . .
+
+RUN bundle install
+
+CMD ["irb"] 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    koyo-postgres-replication (0.1.4.pre)
+    koyo-postgres-replication (0.1.6.pre)
       pg (~> 1.1)
       rack (~> 2.0, >= 2.0.0)
       rails (~> 7.0)
@@ -125,6 +125,8 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.9)
+    nokogiri (1.15.4-aarch64-linux)
+      racc (~> 1.4)
     nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
     parallel (1.23.0)
@@ -214,6 +216,7 @@ GEM
     zeitwerk (2.6.11)
 
 PLATFORMS
+  aarch64-linux
   arm64-darwin-22
 
 DEPENDENCIES

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?
 
@@ -192,6 +246,16 @@ TODO: update
 
 # Working with gem
 
+## Run specs
+
+```
+rspec spec
+```
+
+### Docker
+
+See [Docker wiki page](https://github.com/wiseleyb/koyo-postgres-replication/wiki/Docker)
+
 ## Gem Build
 
 ```

data/changelog.md

@@ -1,5 +1,15 @@
 # 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
+- Add Docker files
+
 ## 0.1.4.pre
 
 - Add link to

data/docker/postgres/Dockerfile

@@ -0,0 +1,3 @@
+FROM postgres:14
+RUN apt-get update -qq && apt-get install -yq --no-install-recommends \
+    postgresql-14-wal2json

data/docker-compose.yml

@@ -0,0 +1,34 @@
+version: '3.9'
+services:
+  db:
+    build: ./docker/postgres
+    image: postgres:13
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_DB=rei_replication_test
+      - POSTGRES_PASSWORD=changeme
+      # - POSTGRES_USER=postgres
+    volumes:
+      - db_data:/var/lib/postgresql/data
+    command:
+      - "postgres"
+      - "-c"
+      - "wal_level=logical"
+  web:
+    build: .
+    image: rails-on-docker:1.3.0
+    stdin_open: true
+    tty: true
+    environment:
+      - DATABASE_URL=postgres://postgres:changeme@db
+      - BOOTSNAP_CACHE_DIR=/usr/local/bundle/_bootsnap
+      - HISTFILE=/usr/src/app/.dockerdev/.bash_history
+      - MALLOC_ARENA_MAX=2
+    volumes:
+      - .:/usr/src/app/:cached
+    depends_on:
+      - db
+volumes:
+  bundle:
+  db_data:

data/entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+unset BUNDLE_PATH
+unset BUNDLE_BIN
+set -e
+exec "$@"

data/koyo-postgres-replication.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'bug_tracker_uri' => "#{url}/issues",
     'changelog_uri' => "#{url}/blob/main/changelog.md",
-    'documentation' => 'https://www.rubydoc.info/github/wiseleyb/koyo-postgres-replication/main',
+    'documentation_uri' => 'https://www.rubydoc.info/github/wiseleyb/koyo-postgres-replication/main',
     'homepage_uri' => spec.homepage,
     'source_code_uri' => burl
   }

data/lib/koyo/repl/version.rb

@@ -2,6 +2,6 @@
 
 module Koyo
   module Repl
-    VERSION = '0.1.4.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.4.pre
+  version: 0.1.6.pre
 platform: ruby
 authors:
 - Ben Wiseley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-20 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -116,12 +116,16 @@ files:
 - ".yardoc/objects/root.dat"
 - ".yardoc/proxy_types"
 - ".yardopts"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
 - changelog.md
+- docker-compose.yml
+- docker/postgres/Dockerfile
+- entrypoint.sh
 - koyo-postgres-replication.gemspec
 - lib/koyo.rb
 - lib/koyo/repl/configuration.rb
@@ -146,7 +150,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/wiseleyb/koyo-postgres-replication/issues
   changelog_uri: https://github.com/wiseleyb/koyo-postgres-replication/blob/main/changelog.md
-  documentation: https://www.rubydoc.info/github/wiseleyb/koyo-postgres-replication/main
+  documentation_uri: https://www.rubydoc.info/github/wiseleyb/koyo-postgres-replication/main
   homepage_uri: https://github.com/wiseleyb
   source_code_uri: https://github.com/wiseleyb
 post_install_message: