kushojin 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aded25303e7f5437b7c4ff30cf00786404573a9b348e41ec717ed3fe2ba91a12
-  data.tar.gz: 7a2475384378eebc452d62d2ad969c8d5c792599aa59265b47dc9ad9d08b388b
+  metadata.gz: 12a83022282a232735d811e92857d5662ee21021b19710909339bf284cf866c8
+  data.tar.gz: 62d665c8228c5d29e2f45b4bfa972ab24744cccbf4ca2a3f165576ef59a98f87
 SHA512:
-  metadata.gz: d1c3a9cb1b8ae4cd2e07b0e2da45583b1a2f38f18d9a96bddaa1c7d74ee9dd9483059b0ca007754cdaac349fcae758f13840f0d391f26233dc59742cc9317faf
-  data.tar.gz: 7b00fca7decfed5b27caf9e357c8cbf0813a13d1d80ea8e399dad7c12d841485cc8f4f09e2776b809242bead4dbb58338b17dd1567d85bad56887b917dd0c4fb
+  metadata.gz: 45732eeacc349c2a826cf297a2d55317ddcb218885bb205c4ff575c00d2fb0c2f3f4592aa7933e134dbcdfc6b48eb27ddc546c209c344984e858d8dbcb5f3b4c
+  data.tar.gz: db3657298bf64ea4a5633285d821be4d50d1c2c6432af5f49924406d9098c9f4ff20340549e8698785cafc4eb7848c2d96f28783d8f42e395b93a1bb194e682b

data/README.md

@@ -1,6 +1,8 @@
 # Kushojin [![Build Status](https://travis-ci.org/nowlinuxing/kushojin.svg?branch=master)](https://travis-ci.org/nowlinuxing/kushojin.svg?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/33c293ed9b4f9f25ab2c/maintainability)](https://codeclimate.com/github/nowlinuxing/kushojin/maintainability)
 
-Kushojin aims to record changed attributes of ActiveRecord model.
+Kushojin gathers changes to the attributes of the ActiveRecord model and sends them externally via Fluentd.
+This is useful for logging, tracking and real-time aggregation of accesses involving database updates.
+Since Fluentd is used for external transmission, Kushojin can respond flexibly to various requests.
 
 ## Installation
 
@@ -53,21 +55,60 @@ end
     $ curl -X PATCH -d "user[age]=21" http://localhost:3000/users/1
     # no output
 
-Custom callback object can be used with `:callbacks` option.
+### Customize sending fields of changes
+
+Kushojin sends model changes with some information:
+
+- tag: Controller name and action name concatenated with a period.
+- event: The event which model is changed on.
+- table_name: Table name of the model.
+- primary key: Primary key name and value.
+- changes: Model changes without its primary key, `created_at`, and `updated_at`. It contains pairs of attribute name and before/after values.
+- request_id: Request ID.
+
+It is able to pass a customized sender to add additional information.
+
+```ruby
+class CustomSender < Kushojin::Sender::EachSender
+  private
+
+  # Add "user_id"
+  def serialize(change, controller)
+    super.merge!("user_id" => controller.current_user.id)
+  end
+end
+
+class MessagesController < ApplicationController
+  send_changes Kushojin::ControllerMethods::SendChangeCallback.new(sender: CustomSender.new)
+
+  def current_user
+    return_user_record_with_any_authentication_logic
+  end
+
+  def create
+    Message.create(params[:message])
+  end
+end
+```
+
+### Customize callbacks of model
+
+You can pass in a class or an instance to change behaviors of the callbacks.
 
 ```ruby
 class CustomCallbacks
-  # Must respond to after_create, after_update, and after_destroy.
+  # Must be able to respond to after_create, after_update, and after_destroy.
   def after_create(record); end
   def after_update(record); end
   def after_destroy(record); end
 end
 
 class User < ApplicationRecord
-  record_changes callbacks: CustomCallbacks.new
+  record_changes CustomCallbacks.new
 end
 ```
 
+
 ### Override
 
 You can override options of Recording changes in subclass.

data/kushojin.gemspec

@@ -26,8 +26,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "actionpack", ">= 5.0"
   spec.add_development_dependency "rspec", ">= 3.0"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sqlite3", "~> 1.3.6"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rubocop"
 end

data/lib/kushojin/controller_methods.rb

@@ -1,4 +1,4 @@
-require "kushojin/controller_methods/filter"
-require "kushojin/controller_methods/send_change_filter"
+require "kushojin/controller_methods/callback"
+require "kushojin/controller_methods/send_change_callback"
 
-ActionController::Metal.extend Kushojin::ControllerMethods::Filter
+ActionController::Metal.extend Kushojin::ControllerMethods::Callback

data/lib/kushojin/controller_methods/callback.rb

@@ -0,0 +1,53 @@
+module Kushojin
+  module ControllerMethods
+    module Callback
+      # Send recorded changes.
+      #
+      #   class UsersController < ApplicationController
+      #     send_changes
+      #
+      #     def create
+      #       User.create(user_params)
+      #     end
+      #
+      #     def update
+      #       User.find(params[:id]).update(user_params)
+      #     end
+      #
+      #     def destroy
+      #       User.find(params[:id]).destroy
+      #     end
+      #
+      #     private
+      #
+      #     def user_params
+      #       params.require(:user).permit(:name)
+      #     end
+      #   end
+      #
+      # You can pass in a class or an instance to change behavior of the callback.
+      #
+      #   class CustomCallback < Kushojin::ControllerMethods::SendChangeCallback
+      #     # Must respond to around.
+      #     def around(controller)
+      #       # Do something
+      #       super
+      #     end
+      #   end
+      #
+      #   class UsersController < ApplicationController
+      #     send_changes CustomCallback.new
+      #   end
+      #
+      # ===== Options
+      #
+      # * <tt>only</tt> - Send changes only for this action.
+      # * <tt>except</tt> - Send changes for all actions except this action.
+      #
+      def send_changes(callback = nil, **options)
+        callback ||= Kushojin::ControllerMethods::SendChangeCallback.new
+        around_action callback, options
+      end
+    end
+  end
+end

data/lib/kushojin/controller_methods/{send_change_filter.rb → send_change_callback.rb}

@@ -1,6 +1,6 @@
 module Kushojin
   module ControllerMethods
-    class SendChangeFilter
+    class SendChangeCallback
       def initialize(sender: nil)
         @sender = sender || Config.sender
       end

data/lib/kushojin/model_methods/callback.rb

@@ -14,42 +14,30 @@ module Kushojin
         #     record_changes
         #   end
         #
-        # Changes is recorded when the model is created, updated and destroyed.
-        # The +:only+ option can be used same as filters of controller.
-        #
-        #   record_changes only: [:create, :destroy]
-        #
-        # Custom callback object can be used with +:callbacks+ option.
+        # You can pass in a class or an instance to change behaviors of the callbacks.
         #
         #   class CustomCallbacks
-        #     # Must respond to after_create, after_update, and after_destroy.
+        #     # Must be able to respond to after_create, after_update, and after_destroy.
         #     def after_create(record); end
         #     def after_update(record); end
         #     def after_destroy(record); end
         #   end
         #
         #   class User < ApplicationRecord
-        #     record_changes callbacks: CustomCallbacks.new
+        #     record_changes CustomCallbacks.new
         #   end
         #
-        # Both +:only+ and +:callbacks+ option can be overrided by subclass.
-        #
-        #   class ApplicationRecord < ActiveRecord::Base
-        #     self.abstract_class = true
-        #     record_changes
-        #   end
+        # Changes is recorded when the model is created, updated and destroyed.
+        # The +:only+ option can be used same as filters of controller.
         #
-        #   class User < ApplicationRecord
-        #     record_changes only: [:create, :destroy], callbacks: CustomCallbacks.new
-        #   end
+        #   record_changes only: [:create, :destroy]
         #
         # ===== Options
         #
         # * <tt>only</tt> - Records only for this event.
         #   Support event is +:create+, +:update+, and +:destroy+.
-        # * <tt>callbacks</tt> - Use callback object instead of RecordChangesCallbacks.
         #
-        def record_changes(only: [], callbacks: nil)
+        def record_changes(callbacks = nil, only: [])
           if kushojin_callbacks
             remove_callbacks
             self.kushojin_callbacks = callbacks if callbacks

data/lib/kushojin/sender/base.rb

@@ -1,8 +1,8 @@
 module Kushojin
   module Sender
     class Base
-      def initialize(logger, **_args)
-        @logger = logger
+      def initialize(logger = nil, **_args)
+        @logger = logger || Config.logger
       end
 
       def send(_changes, **_args)

data/lib/kushojin/sender/each_sender.rb

@@ -1,22 +1,27 @@
 module Kushojin
   module Sender
     class EachSender < Base
-      def initialize(logger, serializer: Serializer::SimpleSerializer)
+      def initialize(logger = nil, serializer: Serializer::SimpleSerializer)
         super
         @serializer = serializer
       end
 
       def send(changes, controller:)
+        tag = generate_tag(controller)
         changes.each do |change|
-          @logger.post(tag(controller), @serializer.serialize(change, controller: controller))
+          @logger.post(tag, serialize(change, controller))
         end
       end
 
       private
 
-      def tag(controller)
+      def generate_tag(controller)
         "#{controller.controller_name}.#{controller.action_name}"
       end
+
+      def serialize(change, controller)
+        @serializer.serialize(change).merge!("request_id" => controller.request.request_id)
+      end
     end
   end
 end

data/lib/kushojin/sender/serializer/simple_serializer.rb

@@ -2,10 +2,9 @@ module Kushojin
   module Sender
     module Serializer
       class SimpleSerializer < Base
-        def self.serialize(change, controller:)
+        def self.serialize(change)
           {
             "event"            => change.event.to_s,
-            "request_id"       => controller.request.request_id,
             "table_name"       => change.table_name,
             change.primary_key => change.model.id,
             "changes"          => changes_hash(change),

data/lib/kushojin/version.rb

@@ -1,3 +1,3 @@
 module Kushojin
-  VERSION = "0.1.3".freeze
+  VERSION = "0.1.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kushojin
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Loose coupling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +98,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -143,8 +157,8 @@ files:
 - lib/kushojin.rb
 - lib/kushojin/config.rb
 - lib/kushojin/controller_methods.rb
-- lib/kushojin/controller_methods/filter.rb
-- lib/kushojin/controller_methods/send_change_filter.rb
+- lib/kushojin/controller_methods/callback.rb
+- lib/kushojin/controller_methods/send_change_callback.rb
 - lib/kushojin/model_methods.rb
 - lib/kushojin/model_methods/callback.rb
 - lib/kushojin/model_methods/change.rb

data/lib/kushojin/controller_methods/filter.rb

@@ -1,10 +0,0 @@
-module Kushojin
-  module ControllerMethods
-    module Filter
-      def send_changes(**args)
-        filter = args.delete(:filter) || Kushojin::ControllerMethods::SendChangeFilter.new
-        around_action filter, args
-      end
-    end
-  end
-end