sequel-auditer 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6860ac0c5865b177eac491a277880e87fe783ed4537be357de32a0d1f477f604
-  data.tar.gz: 2dd9b761c2210f6b9eb135f6556aadc570bfa3f1f02671a1affb0a6c9d186da9
+  metadata.gz: 1f050023468273d8dc79bc50f14b0569240f1cd7902f42fefbdfdb6ec0b3aee1
+  data.tar.gz: f66d9e691b3cdc738d28686734113919c93de999c69b074d9e9e9b345cc95e73
 SHA512:
-  metadata.gz: c5e5172bcb8f2f75192065c72559095308373c04cd92369e2c1881db19bce86fec84554d4dac9f250f81c3c87790e3a777f636f8be36f23266d3c4049c81a746
-  data.tar.gz: 50f98657d457799fae402bf92ecfd7beba7b1b109448d993b412dd0f7095886d7c7e345a10f381c1562e8e520cf09191941f370aa45dc9df5e34db0db1aa26f8
+  metadata.gz: f2754f8c56a4599a387e5bc473ebe8fecff7a3766fcc7d4ad679a706ff5d80fc73464c2728d16e482c11483a2e98e5dec131890b126bf285d2c638d271809011
+  data.tar.gz: 11e3db29cb47239b2aa3d736870f3b77f885948cdeac76bf93c445e33442d2fa2f2ddcc80730db8487c0b2e87820d407aafbbf3f5910d1e67c3e697f89c6eefc

data/README.md

@@ -75,6 +75,23 @@ bundle exec rake db:migrate
 
 This gem will try to get user from warden based authentications. When available, auditer will be fetched from warden, otherwise global function will be fired.
 
+## Resource Owner and Modifier
+
+SequelAuditer allows you to store 2 types of user data.
+
+### Modifier
+
+Modifier is who changed the data. This can be user itself, staff member or admins.
+
+### Resource Owner
+
+Resource owner respresents modified data's owner. This is usually an user. So, you can browse audit logs based on resource owner id and see who is the modifier. This data came from target model. You need to specify user method in model like this:
+
+```ruby
+  plugin :auditer, additional_info: :additional_info, user_method: :global_user, owner_field: :user
+```
+
+Now, `:owner_field` is a field in `Folder` model. `:global_user` is a global function/method that came from somewhere else in our app. Something like `current_user`.
 
 ### IMPORTANT SIDENOTE!
 
@@ -229,6 +246,8 @@ cat.update(name: 'Ruby Sequel')
   :changed => "{\"name\":[\"Sequel\",\"Ruby Sequel\"],\"updated_at\":\"<timestamp>\"}",
   :version => 2,
   :modifier_id => 88,
+  :modifier_type => "Staff",
+  :resource_owner_id => 70,
   :modifier_type => "User",
   :additional_info => "",
   :created_at => <timestamp>
@@ -254,6 +273,8 @@ cat.delete
   :changed => "{\"id\":1,\"name\":\"Ruby Sequel\",\"created_at\":\"<timestamp>\",\"updated_at\":\"<timestamp>\"}",
   :version => 3,
   :modifier_id => 88,
+  :modifier_type => "Staff",
+  :resource_owner_id => 70,
   :modifier_type => "User",
   :additional_info => "",
   :created_at => <timestamp>
@@ -295,6 +316,22 @@ So if you want to customize the modifier per model you can do that here.
 
 <br>
 
+#### `Sequel::auditer.auditer_resource_owner_field`
+
+Sets the name of the model name (association) that provides the resource owner object.
+Default is: `nil`.
+
+You can easily change the name of this model by calling:
+
+```ruby
+Sequel::auditer.auditer_resource_owner_field = :user
+```
+
+**Note!** the name of the function must be given as a symbol.
+**Note!!** it will first try to hit the method on the model (i.e. Post) itself first. It won't hit global function.
+
+<br>
+
 #### `Sequel::auditer.audited_additional_info_method`
 
 Sets the name of the global method that provides the additional info object (Hash).
@@ -438,7 +475,7 @@ Posts.audited_versions(:created_at < Date.today - 2)
 
 
 
-2) Track all changes made by a user / modifier_group.
+1) Track all changes made by a user / modifier_group.
 
 ```ruby
 joe = User[88]

data/lib/sequel/auditer.rb

@@ -1,20 +1,17 @@
-require "sequel/auditer/railtie"
-require "sequel/auditer/version"
-
+require 'sequel/auditer/railtie'
+require 'sequel/auditer/version'
 
 module Sequel
-
-  #
   module Auditer
-
-    CREATE  = 'create'
-    UPDATE  = 'update'
-    DESTROY = 'destroy'
+    CREATE  = 'create'.freeze
+    UPDATE  = 'update'.freeze
+    DESTROY = 'destroy'.freeze
 
     # set the name of the global method that provides the current user. Default: :current_user
     @auditer_current_user_method      = :current_user
-	# set any additional info such as :ip, :user_agent, ...
+    # set any additional info such as :ip, :user_agent, ...
     @auditer_additional_info_method   = :additional_info
+    @auditer_resource_owner_field     = :owner_field
     # enable swapping of the Audit model
     @auditer_model_name               = :AuditLog
     # toggle for enabling / disabling auditing
@@ -28,10 +25,12 @@ module Sequel
     ]
 
     class << self
-      attr_accessor :auditer_current_user_method, :auditer_additional_info_method,
-					:auditer_model_name, :auditer_enabled,
-					:auditer_default_ignored_columns
+      attr_accessor :auditer_current_user_method,
+                    :auditer_additional_info_method,
+                    :auditer_model_name,
+                    :auditer_enabled,
+                    :auditer_default_ignored_columns,
+                    :auditer_resource_owner_field
     end
-
   end
 end

data/lib/sequel/auditer/version.rb

@@ -1,5 +1,5 @@
 module Sequel
   module Auditer
-    VERSION = "0.2.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/sequel/plugins/auditer.rb

@@ -7,8 +7,9 @@ class AuditLog < Sequel::Model
   plugin :polymorphic
 
   # TODO: see if we should add these
-  many_to_one :associated, polymorphic: true
-  many_to_one :modifier,   polymorphic: true
+  many_to_one :associated, 			polymorphic: true
+  many_to_one :modifier,   			polymorphic: true
+  many_to_one :resource_owner,      polymorphic: true
 
   def before_validation
     # grab the current user
@@ -19,7 +20,12 @@ class AuditLog < Sequel::Model
     # grab any additional info if any
     if i = audit_additional_info
       self.additional_info = i
-      end
+    end
+	
+	# grab resource owner
+	# if o = audit_owner
+	  # self.resource_owner = o
+	# end
 
     super
   end
@@ -45,10 +51,16 @@ class AuditLog < Sequel::Model
 
   def audit_additional_info
     m = Kernel.const_get(associated_type)
-    m.send(m.auditer_additional_info_method) || send(m. auditer_additional_info_method)
+    m.send(m.auditer_additional_info_method) || send(m.auditer_additional_info_method)
   rescue StandardError
     nil
   end
+
+  def audit_owner
+    m = Kernel.const_get(associated_type)
+	o = m.send(m.auditer_resource_owner_field) || send(m.auditer_resource_owner_field)
+	# abort o.inspect
+  end
 end
 
 module Sequel
@@ -97,6 +109,7 @@ module Sequel
           # specifically for the audited model on a per model basis
           set_user_method(opts)
           set_additional_info_method(opts)
+          set_owner_method(opts)
 
           set_reference_method(opts)
 
@@ -132,7 +145,7 @@ module Sequel
       end
 
       module ClassMethods
-        attr_accessor :auditer_default_ignored_columns, :auditer_current_user_method, :auditer_additional_info_method
+        attr_accessor :auditer_default_ignored_columns, :auditer_current_user_method, :auditer_additional_info_method, :auditer_resource_owner_field
         # The holder of ignored columns
         attr_reader :auditer_ignored_columns
         # The holder of columns that should be audited
@@ -144,6 +157,7 @@ module Sequel
                                              :@auditer_default_ignored_columns => nil,
                                              :@auditer_current_user_method     => nil,
                                              :@auditer_additional_info_method  => nil,
+                                             :@auditer_resource_owner_field    => nil,
                                              :@auditer_included_columns        => nil,
                                              :@auditer_ignored_columns         => nil,
                                              :@auditer_reference_method        => nil)
@@ -197,6 +211,10 @@ module Sequel
           const_get(audit_model_name)
         end
 
+        def resource_owner
+          const_get(audit_model_name)
+        end
+		
         def audit_model_name
           ::Sequel::Auditer.auditer_model_name
         end
@@ -212,6 +230,10 @@ module Sequel
         def set_user_method(opts)
           @auditer_current_user_method = opts[:user_method] || ::Sequel::Auditer.auditer_current_user_method
         end
+		
+        def set_owner_method(opts)
+		  @auditer_resource_owner_field = opts[:owner_field] || ::Sequel::Auditer.auditer_resource_owner_field
+        end
 
         def set_additional_info_method(opts)
           if opts[:additional_info]
@@ -274,10 +296,18 @@ module Sequel
 
         def add_audited(event)
           changed = auditer_values(event)
+		  
+		  begin
+			res_owner = self.send(*model.auditer_resource_owner_field)
+		  rescue
+			res_owner = nil
+		  end
+		  
           unless changed.blank?
             add_version(
               event:      event,
-              changed:    changed
+              changed:    changed,
+			  resource_owner: res_owner
             )
           end
         end

data/lib/tasks/sequel-auditer/templates/audited_migration.rb

@@ -4,18 +4,20 @@ Sequel.migration do
   change do
     create_table(:audit_logs) do
       primary_key :id
-      String    :associated_type
-      Integer   :associated_id
-      String    :event
-      String    :changed,     text: true
-      Integer   :version
-      Integer   :modifier_id
-      String    :modifier_type
-      String	:additional_info,     text: true
-      DateTime  :created_at
+      String      :associated_type
+      Integer     :associated_id
+      String      :event
+      String      :changed, text: true
+      Integer     :version
+      Integer     :modifier_id
+      Integer     :resource_owner_id
+      String      :modifier_type
+      String      :resource_owner_type
+      String      :additional_info, text: true
+      DateTime    :created_at
 
-      index [:associated_type, :associated_id]
-      index [:modifier_type, :modifier_id]
+      index %i[associated_type associated_id]
+      index %i[modifier_type modifier_id]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-auditer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kematzy