changebase 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d9aa3e35e3c305c7d25abca6c5fb16e67277713afccabe5673c3fafab819fa8
-  data.tar.gz: 8e1dc477d0122ae4bb24164f9deeaaed8916cfca94cc430fac47fc707a22e5d8
+  metadata.gz: dcaf7190bcd66bca83640222cc52f2bae125b65b9008c26c9e8dac4c88c35226
+  data.tar.gz: '099666dc5717843cf99230a8a22c51fed5568ef93b4aa550928621a29d8a3e72'
 SHA512:
-  metadata.gz: 3be0b99793e34d274783aa55bea767fe5dd1ec660ab72366b616a112402e40b7ad5ff5d4012e02a9dc2b6bf097f1633e715fd9669b58f548e26bba86d1ec3bf2
-  data.tar.gz: 30080425de141719518fe2c7cb3ceeefef0ecfc22f9491ff105ac6b52fbfce8529cbc433ca372232391a1a1fc6d81bdd4007a2e72f86dc12a2e64565636edfeb
+  metadata.gz: 0b3dc117e4516d95e353b2e4e4ad076020815e37c88a6c256bb40ca1633ff5a487b692ac49331a203e8c6f519c46523c20e231e1cee768078c007666dea23d35
+  data.tar.gz: f0915103e19c8966675d21d40b7091d62eb4eb97f686b92fc98087fe8277e3ef94ace4a3524ded170ead1cbd4f6d06395a03b6737fd937ca20edf4365a3225c3

data/README.md

@@ -0,0 +1,120 @@
+# Changebase Ruby Library
+
+The Changebase Ruby library provides convenient access to the Changebase API from
+applications written in the Ruby language.
+
+## Installation
+
+```sh
+gem install changebase
+```
+
+If you are installing via bundler:
+
+```ruby
+gem "changebase"
+```
+
+## Rails
+
+Once you install the Gem run your migration to autmatically create the metadata
+table for your database by runing:
+
+`rails db:migrate`
+
+### ActionController
+
+In a controller you can use the following to log metadata with all updates during
+a request:
+
+```ruby
+  class ApplicationController < ActionController::Base
+    changebase do
+      {
+        request_id: request.uuid,
+        user: {
+          id: current_user.id
+        }
+      }
+    end
+  end
+```
+
+The `changebase` function can be called multiple times to include various data.
+To nest a value simply give it all the keys so it knows where to bury the value.
+
+Below are several diffent way of including metadata:
+
+```ruby
+  class ApplicationController < ActionController::Base
+    
+    # Just a block returning a hash of metadata.
+    changebase do
+        { my: data }
+    end
+    
+    # Sets `release` in the metadata to the string RELEASE_SHA
+    changebase :release, RELEASE_SHA
+    
+    # Sets `request_id` in the metadata to the value returned from the `Proc`
+    changebase :request_id, -> { request.uuid }
+    
+    # Sets `user.id` in the metadata to the value returned from the
+    # `current_user_id` function
+    changebase :user, :id, :current_user_id
+    
+    # Sets `user.name` in the metadata to the value returned from the block
+    changebase :user, :name do
+      current_user.name
+    end
+    
+    def current_user_id
+      current_user.id
+    end
+  end
+```
+
+In the above example the following would be logged with all database changes:
+
+```ruby
+{
+  release:     'd5db29cd03a2ed055086cef9c31c252b4587d6d0',
+  request_id:  'a39073a5-10b9-41b7-b5f0-06806853507b',
+  user: {
+    id:        'f06114cc-7819-4906-85dc-b93edb0fb08c',
+    name:      'Tom'
+  }
+}
+```
+
+### ActiveRecord
+
+To include metadata when creating or modifying data with ActiveRecord:
+
+```ruby
+  ActiveRecord::Base.with_metadata({user: {name: 'Tom'}}) do
+    @post.update(title: "A new beging")
+  end
+```
+
+### Configuration
+
+To configure the metadata table that Changebase writes to create a initializer
+at `config/initializers/changebase.rb` with the following:
+
+```ruby
+Rails.application.config.tap do |config|
+  config.changebase.metadata_table = "my_very_cool_custom_metadata_table"
+end
+```
+
+If you are not using Rails you can configure Changebase directly via:
+
+```ruby
+Changebase.metadata_table = "my_very_cool_custom_metadata_table"
+```
+
+## Bugs
+
+If you think you found a bug, please file a ticket on the [issue 
+tracker](https://github.com/changebase-io/ruby-gem/issues).

data/db/migrate/20220217151934_create_changebase_metadata_table.rb

@@ -0,0 +1,18 @@
+class CreateChangebaseMetadataTable < ActiveRecord::Migration[6.0]
+  
+  def up
+    table = Rails.application.config.changebase.metadata_table
+    
+    if !ActiveRecord::Base.connection.table_exists?(table)
+      create_table table, id: false do |t|
+        t.primary_key :version, :integer
+        t.jsonb       :data
+      end
+    end
+  end
+  
+  def down
+    drop_table(Rails.application.config.changebase.metadata_table)
+  end
+  
+end

data/lib/changebase/action_controller.rb

@@ -0,0 +1,72 @@
+module Changebase::ActionController
+  extend ActiveSupport::Concern
+
+  included do
+    prepend_around_action :changebase_metadata_wrapper
+  end
+  
+  module ClassMethods
+    def changebase(*keys, &block)
+      method = if block
+        block
+      elsif keys.size > 1
+        keys.pop
+      else
+        keys.first
+      end
+      
+      @changebase_metadata ||= []
+      @changebase_metadata << [keys, method]
+    end
+    
+    def changebase_metadata
+      klass_metadata = if instance_variable_defined?(:@changebase_metadata)
+        @changebase_metadata
+      else
+        []
+      end
+      
+      if self.superclass.respond_to?(:changebase_metadata)
+        klass_metadata + self.superclass.changebase_metadata
+      else
+        klass_metadata
+      end
+    end
+  end
+  
+  def changebase_metadata
+    self.class.changebase_metadata
+  end
+    
+  def changebase_metadata_wrapper(&block)
+    metadata = {}
+    
+    changebase_metadata.each do |keys, value|
+      data = metadata
+      keys[0...-1].each do |key|
+        data[key] ||= {}
+        data = data[key]
+      end
+      
+      value = case value
+      when Symbol
+        self.send(value)
+      when Proc
+        instance_exec(&value)
+      else
+        value
+      end
+      
+      if keys.last
+        data[keys.last] ||= value
+      else
+        data.merge!(value)
+      end
+    end
+
+    ActiveRecord::Base.with_metadata(metadata, &block)
+  end
+  
+end
+
+ActionController::Base.include(Changebase::ActionController)

data/lib/changebase/active_record.rb

@@ -0,0 +1,106 @@
+module Changebase::ActiveRecord
+  extend ActiveSupport::Concern
+  
+  module ClassMethods
+    def with_metadata(metadata, &block)
+      connection.with_metadata(metadata, &block)
+    end
+  end
+  
+  def with_metadata(metadata, &block)
+    self.class.with_metadata(metadata, &block)
+  end
+end
+
+module Changebase::ActiveRecord::Connection
+
+  def with_metadata(metadata, &block)
+    @changebase_metadata = metadata
+    yield
+  ensure
+    @changebase_metadata = nil
+  end
+  
+end
+
+module Changebase::ActiveRecord::PostgreSQLAdapter
+
+  def initialize(*args, **margs)
+    @without_changebase = false
+    @changebase_metadata = nil
+    super
+  end
+  
+  def without_changebase
+    @without_changebase = true
+    yield
+  ensure
+    @without_changebase = false
+  end
+  
+  def drop_database(name) # :nodoc:
+    without_changebase { super }
+  end
+
+  def drop_table(table_name, **options) # :nodoc:
+    without_changebase { super }
+  end
+
+  def create_database(name, options = {})
+    without_changebase { super }
+  end
+  
+  def recreate_database(name, options = {}) # :nodoc:
+    without_changebase { super }
+  end
+  
+  def execute(sql, name = nil)
+    if !@without_changebase && !current_transaction.open? && write_query?(sql)
+      transaction { super }
+    else
+      super
+    end
+  end
+  
+  def exec_query(sql, name = "SQL", binds = [], prepare: false)
+    if !@without_changebase && !current_transaction.open? && write_query?(sql)
+      transaction { super }
+    else
+      super
+    end
+  end
+  
+  def exec_delete(sql, name = nil, binds = []) # :nodoc:
+    if !@without_changebase && !current_transaction.open? && write_query?(sql)
+      transaction { super }
+    else
+      super
+    end
+  end
+
+  def commit_db_transaction
+    if !@without_changebase && @changebase_metadata && !@changebase_metadata.empty?
+      sql = ActiveRecord::Base.send(:replace_named_bind_variables, <<~SQL, {version: 1, metadata: ActiveSupport::JSON.encode(@changebase_metadata)})
+        INSERT INTO #{quote_table_name(Changebase.metadata_table)} ( version, data )
+        VALUES ( :version, :metadata )
+        ON CONFLICT ( version )
+        DO UPDATE SET version = :version, data = :metadata;
+      SQL
+      
+      log(sql, "CHANGEBASE") do
+        ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+          @connection.async_exec(sql)
+        end
+      end
+    end
+    super
+  end
+  
+end
+
+require 'active_record'
+ActiveRecord::Base.include(Changebase::ActiveRecord)
+ActiveRecord::ConnectionAdapters::AbstractAdapter.include(Changebase::ActiveRecord::Connection)
+
+require 'active_record/connection_adapters/postgresql_adapter'
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(Changebase::ActiveRecord::PostgreSQLAdapter)

data/lib/changebase/railtie.rb

@@ -0,0 +1,23 @@
+class Changebase::Engine < ::Rails::Engine
+
+  config.changebase = ActiveSupport::OrderedOptions.new
+  config.changebase.metadata_table = "changebase_metadata"
+  
+  initializer :changebase do |app|
+    migration_paths = config.paths['db/migrate'].expanded
+    
+    ActiveSupport.on_load(:active_record) do
+      require 'changebase/active_record'
+      migration_paths.each do |path|
+        ActiveRecord::Tasks::DatabaseTasks.migrations_paths << path
+      end
+    end
+    
+    ActiveSupport.on_load(:action_controller) do
+      require 'changebase/action_controller'
+    end
+    
+    Changebase.metadata_table = app.config.changebase.metadata_table
+  end
+  
+end

data/lib/changebase/version.rb

@@ -1,3 +1,3 @@
 module Changebase
-  VERSION = '0.0.1'
+  VERSION = '0.1'
 end

data/lib/changebase.rb

@@ -0,0 +1,16 @@
+module Changebase
+  autoload :ActiveRecord, 'changebase/active_record'
+  autoload :ActionController, 'changebase/action_controller'
+  
+  @metadata_table = "changebase_metadata"
+  
+  def self.metadata_table=(value)
+    @metadata_table = value
+  end
+  
+  def self.metadata_table
+    @metadata_table
+  end
+end
+
+require 'changebase/railtie' if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: changebase
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Jon Bracy
@@ -9,8 +9,68 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -82,13 +142,69 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mini_mime
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: factory_bot
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -97,36 +213,44 @@ dependencies:
         version: '0'
 description: Ruby library for integrating with Changebase.io
 email:
-- jonbracy@gmail.com
-- waratuman@gmail.com
+- jon@changebase.io
+- james@changebase.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
-- README.rdoc
+- README.md
+- db/migrate/20220217151934_create_changebase_metadata_table.rb
+- lib/changebase.rb
+- lib/changebase/action_controller.rb
+- lib/changebase/active_record.rb
+- lib/changebase/railtie.rb
 - lib/changebase/version.rb
 homepage: https://changebase.io
 licenses: []
-metadata: {}
+metadata:
+  homepage_uri: https://changebase.io
+  source_code_uri: https://github.com/changebase-io/ruby-gem
+  bug_tracker_uri: https://github.com/changebase-io/ruby-gem/issues
 post_install_message:
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Changebase.io Client

data/README.rdoc

@@ -1,17 +0,0 @@
-= \Changebase Ruby Library
-
-The Changebase Ruby library provides convenient access to the Changebase API from
-applications written in the Ruby language.
-
-== Installation
-
-  $ gem install changebase
-
-== Bugs
-
-If you think you found a bug, please file a ticket on the {issue 
-  tracker}[https://github.com/changebase-io/ruby-gem/issues].
-
-== License
-
-#TODO