debezium 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f3398eb5ff6b79c049747db3b65c73bdea7f6bf96d1b5f6ac358930e1fda59a
+  data.tar.gz: 77738af1561bd3beddc86f57c3df3fa1535b6f5320b6c7c4229b3cfac40a1393
+SHA512:
+  metadata.gz: b73496223f22bffa65709c384a997a1838c83e27d9d8c19705018b06ef06d74d9a377077055ea9d2b4513bf9b33a45beffee100b64c5219df3fbe57cf1ba70e3
+  data.tar.gz: 01c728a6af11de6f26f0140af59e6dd598eef6503d0b679c953dac57797818ac580a82fa132d9bf87e5aefa4630376473e335f7894111c0b33a8bca88633d3fb

data/lib/debezium/change.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Debezium
+  # Represents the differences between two hashes, categorizing them as additions, removals, or modifications.
+  class Change
+    # Initializes a Change object and computes the differences between two hashes.
+    #
+    # @param old [Hash] The original hash.
+    # @param new [Hash] The modified hash.
+    def initialize(old, new)
+      @additions     = {}
+      @removals      = {}
+      @modifications = {}
+
+      hash_diff(old, new)
+    end
+
+    # Checks if the provided key was added.
+    #
+    # @param key [Object] The key to check.
+    # @return [Boolean] True if the key was added, otherwise false.
+    def added?(key)
+      @additions.include?(key)
+    end
+
+    # Checks if the provided key was removed.
+    #
+    # @param key [Object] The key to check.
+    # @return [Boolean] True if the key was removed, otherwise false.
+    def removed?(key)
+      @removals.include?(key)
+    end
+
+    # Checks if the provided key was modified.
+    #
+    # @param key [Object] The key to check.
+    # @return [Boolean] True if the key was modified, otherwise false.
+    def modified?(key)
+      @modifications.include?(key)
+    end
+
+    # Returns the list of added key-value pairs.
+    #
+    # @return [Array<Array>] An array of key-value pairs that were added.
+    def additions
+      @additions.to_a
+    end
+
+    # Returns the list of removed key-value pairs.
+    #
+    # @return [Array<Array>] An array of key-value pairs that were removed.
+    def removals
+      @removals.to_a
+    end
+
+    # Returns the list of modified key-value pairs.
+    #
+    # @return [Array<Array>] An array of key-value pairs showing new and old values.
+    def modifications
+      @modifications.to_a
+    end
+
+    private
+
+    # Computes the differences between two hashes and categorizes them into additions, removals, and modifications.
+    #
+    # @param old_hash [Hash] The original hash.
+    # @param new_hash [Hash] The modified hash.
+    # @return [void]
+    def hash_diff(old_hash, new_hash)
+      hash_additions(old_hash, new_hash)
+      hash_removals(old_hash, new_hash)
+      hash_modifications(old_hash, new_hash)
+    end
+
+    # Computes hash additions between two hashes.
+    #
+    # @param old_hash [Hash] The original hash.
+    # @param new_hash [Hash] The modified hash.
+    # @return [void]
+    def hash_additions(old_hash, new_hash)
+      new_hash.each do |key, value|
+        next if old_hash.key?(key)
+
+        @additions[key] = value
+      end
+    end
+
+    # Computes hash removals between two hashes.
+    #
+    # @param old_hash [Hash] The original hash.
+    # @param new_hash [Hash] The modified hash.
+    # @return [void]
+    def hash_removals(old_hash, new_hash)
+      old_hash.each do |key, value|
+        next if new_hash.key?(key)
+
+        @removals[key] = value
+      end
+    end
+
+    # Computes hash modifications between two hashes.
+    #
+    # @param old_hash [Hash] The original hash.
+    # @param new_hash [Hash] The modified hash.
+    # @return [void]
+    def hash_modifications(old_hash, new_hash)
+      old_hash.each do |key, value|
+        next unless new_hash.key?(key)
+        next if new_hash[key] == value
+
+        @modifications[key] = [new_hash[key], value]
+      end
+    end
+  end
+end

data/lib/debezium/message.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Debezium
+  # Message represents a Debezium message, containing information about the `before` and `after`
+  # states of a record.
+  #
+  # This class parses a Debezium event message (JSON) and provides methods to determine the type
+  # of operation and access the changes between the `before` and `after` states in case of an update operation.
+  #
+  class Message
+    # @return [Object] The `after` state of the record.
+    attr_accessor :after
+
+    # @return [Object] The `before` state of the record.
+    attr_accessor :before
+
+    # @return [Symbol] The operation type (`:create`, `:update`, `:delete`, or `:unknown`).
+    attr_accessor :op
+
+    # @return [Hash] The parsed JSON of the event.
+    attr_accessor :json
+
+    # Initializes a new Message instance by parsing the given Debezium JSON message.
+    #
+    # @param json [String] The Debezium JSON message to parse.
+    # @return [Message] The newly created Message instance.
+    def initialize(json)
+      @json = JSON.parse(json)
+
+      @before = @json['before']
+      @after  = @json['after']
+      @op     = parse_op(@json['op'])
+    end
+
+    # Checks if the operation is a "create" operation.
+    #
+    # @return [Boolean] `true` if the operation is a create, otherwise `false`.
+    def create?
+      @op == :create
+    end
+
+    # Checks if the operation is an "update" operation.
+    #
+    # @return [Boolean] `true` if the operation is an update, otherwise `false`.
+    def update?
+      @op == :update
+    end
+
+    # Checks if the operation is a "delete" operation.
+    #
+    # @return [Boolean] `true` if the operation is a delete, otherwise `false`.
+    def delete?
+      @op == :delete
+    end
+
+    # Returns the changes between the `before` and `after` states for update operations.
+    #
+    # @return [Change, nil] Returns a `Change` object if the operation is an update; otherwise `nil`.
+    def changes
+      return nil unless update?
+
+      @changes ||= Change.new(before, after)
+    end
+
+    private
+
+    # Parses the operation type from the given Debezium operation code.
+    #
+    # @param operation [String] The Debezium operation code (`'c'` for create, `'u'` for update, `'d'` for delete).
+    # @return [Symbol] The operation (`:create`, `:update`, `:delete`, or `:unknown`).
+    def parse_op(operation)
+      case operation
+      when 'c'
+        :create
+      when 'u'
+        :update
+      when 'd'
+        :delete
+      else
+        :unknown
+      end
+    end
+  end
+end

data/lib/debezium/version.rb

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

data/lib/debezium.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'debezium/version'
+require 'json'
+
+require_relative 'debezium/change'
+require_relative 'debezium/message'
+require_relative 'debezium/version'
+
+# Debezium CDC Messages
+module Debezium
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: debezium
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Tate Thurston
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-04 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/debezium.rb
+- lib/debezium/change.rb
+- lib/debezium/message.rb
+- lib/debezium/version.rb
+homepage: https://github.com/tatethurston/ruby-debezium
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A gem to handle CDC messages from Debezium
+test_files: []