notifiably_audited 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjE4ZTc3NjA5YWUxYzdlM2YwODc3N2UwMTM0NDk1NGQwNzFjNzk0OQ==
+    Nzc2YzdiYWVkNWZjZWQ2NjUyMTk5ZGNkMzFmNzg0YmM0NTVjMDZiYQ==
   data.tar.gz: !binary |-
-    NGVlN2YzNjMxMWI1MGMxZWQwYzgzMmQzOTI5MGJlNzk0NmIxZGY5MA==
+    ODE1NzhlN2IxMjc5YTBiOWU0Yjk0YjhiYTEzYjkwOGZlNTNkODUwMg==
 SHA512:
   metadata.gz: !binary |-
-    YTVlM2QwMzliMDViNDQxNmM2NDIxOTQ1NDYxMzFhMzQyYWNjYTQ2OWU3NGE0
-    YzhkZmYwYmY3MTZmYWM0MTFmNDVkN2M3N2ZlNzIyNDE4MmUxZmYyYTY3MmUx
-    OTIwMjUxZjY4MGUwYjgzNzc2MDQzNzAxNTUxOTcxMDY3M2UyZDY=
+    ZTRiMTA4MTQ0NzBjYWFjNTY0NWQyYzRmOTQ4NDU1NDNjNGU5MTBmOGZlYmY2
+    YTZhNTU4NzVmYWVjNjg0MTllOTQ1YWFkYzliYzBmODlmYjdiOWQ4NDllYjEz
+    NmJlZjc1MzY2Yzg5ZGUxNDJiMzhhN2U4ZTc2YzhmNDcyNjE3MTY=
   data.tar.gz: !binary |-
-    MmYxOTczOWU2ZGRkM2IxYzFlNWIzMjhhZTRiZTIyNzJlOWY0MDA4NDU0NmVl
-    NzQ4NWU2NWQxYjcxNWEyYThlNWRlYjc5ZTFhMGU3ZjVmY2UyNDg1MmVmY2Qx
-    OTE2ZDI2YjkxNzBjMjcxOGQ4MzNlZjNjZWY1ZWNmNDE2YWNjOGM=
+    YTZjNzNmMWU0MWM2YzQyNzBjZDNlOWIxY2I0OGJmNjI3ZDA0MDZiYjVmZWIw
+    NmUwNzJkYzY2M2YzYmI3NGNmOTRlMDRlNzA4Yzc1Yjk1M2NlZDhlODU5Yzhk
+    ZjAzNTYxZTZlZjQxNDI1NDA4ZDcwOTU5YzE5ZWIxNWVmZDhlMDU=

data/audited.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name    = 'notifiably_audited'
-  gem.version = '0.0.2'
+  gem.version = '0.0.3'
 
   gem.authors     = ['Brandon Keepers', 'Kenneth Kalmer', 'Daniel Morrison', 'Brian Ryckbost', 'Steve Richert', 'Ryan Glover']
   gem.email       = 'info@collectiveidea.com'
@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rails', '~> 3.0'
   gem.add_development_dependency 'rspec-rails', '~> 2.0'
   gem.add_development_dependency 'sqlite3', '~> 1.0'
+  gem.add_development_dependency 'private_pub'
 
   gem.files         = `git ls-files`.split($\).reject{|f| f =~ /(lib\/audited\-|adapters|generators)/ }
   gem.test_files    = gem.files.grep(/^spec\//)

data/lib/audited/audit.rb

@@ -12,11 +12,14 @@ module Audited
         belongs_to :associated, :polymorphic => true
 
         before_create :set_version_number, :set_audit_user
+        
+        after_save :notify
 
         cattr_accessor :audited_class_names
         self.audited_class_names = Set.new
 
-        attr_accessible :action, :audited_changes, :comment, :associated
+        attr_accessible :action, :audited_changes, :comment, 
+                        :associated, :receiver_id, :checked, :meta,:title
       end
 
       # Returns the list of classes that are being audited
@@ -96,7 +99,17 @@ module Audited
 
     def set_audit_user
       self.user = Thread.current[:audited_user] if Thread.current[:audited_user]
+      p self.user
       nil # prevent stopping callback chains
     end
+    #====== beck added for notifiable ====
+    def notify
+        PrivatePub.publish_to("/notifiably_audited/" + self.receiver_id.to_s, 
+                              title: self.title,
+                              comment: self.comment,
+                              id: self.id)
+    end
+    #========================================
+    
   end
 end

data/lib/audited/auditor.rb

@@ -43,13 +43,21 @@ module Audited
       #       attr_accessible :name
       #     end
       #
-      def audited(options = {})
+      def notifiably_audited(options = {})
         # don't allow multiple calls
         return if self.included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
 
         class_attribute :non_audited_columns,   :instance_writer => false
         class_attribute :auditing_enabled,      :instance_writer => false
         class_attribute :audit_associated_with, :instance_writer => false
+        
+        #====== beck added for notifiable ====
+        class_attribute :audit_alert_to, :instance_writer => false
+        class_attribute :audit_alert_for, :instance_writer => false
+        class_attribute :audit_title, :instance_writer => false
+        class_attribute :audit_create_comment, :instance_writer => false
+        class_attribute :audit_update_comment, :instance_writer => false
+        #=====================================
 
         if options[:only]
           except = self.column_names - options[:only].flatten.map(&:to_s)
@@ -59,6 +67,14 @@ module Audited
         end
         self.non_audited_columns = except
         self.audit_associated_with = options[:associated_with]
+        
+        #====== beck added for notifiable ====
+        self.audit_alert_to = options[:alert_to] || :assigned_to
+        self.audit_alert_for = options[:alert_for] || nil
+        self.audit_title = options[:title] || :name
+        self.audit_create_comment = options[:create_comment] || "New <<here>> has been created"
+        self.audit_update_comment = options[:update_comment] || "Values of <<here>> has been updated"
+        #=====================================
 
         if options[:comment_required]
           validates_presence_of :audit_comment, :if => :auditing_enabled
@@ -88,12 +104,90 @@ module Audited
         include Audited::Auditor::AuditedInstanceMethods
 
         self.auditing_enabled = true
+        
       end
 
       def has_associated_audits
         has_many :associated_audits, :as => :associated, :class_name => Audited.audit_class.name
       end
     end
+    
+#========  Audit Instance Methods - Means the methods on the target object =====================
+
+    #====== beck modified for notifiable ====
+    # @non_monitor is 1 initially, if somewhere an audit is created this is set to 0, so no future 
+    # audit will be created.
+    
+    # if polymorphic, then 
+    # [:polymorphic,"title",
+    #  col of self to be displayed as comment,[:commentable_type,:commentable_id]]
+    #----------------------------------------------
+    # opts format for notifiably_audited method/gem
+    #----------------------------------------------
+    #   notifiably_audited alert_for: [[[:assigned_to],
+    #                                   "Re-assigned",
+    #                                   "This product has been reassigned",
+    #                                   [:user,:email]],
+    #                                   [[:color,:score],
+    #                                    "Color/Score Changed",
+    #                                   "Color/Score value is changed"],
+    #                                   [[:product_status_id],
+    #                                    "Status Changed",
+    #                                   "Status of this product is changed",
+    #                                    [:product_status,:name]]],
+    #                     associated_with: :product_status, 
+    #                      title: :name, 
+    #                      create_comment: "New <<here>> has been created", 
+    #                      update_comment: "Custom: Values of <<here>> has been updated"
+    #
+    #  &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
+    #
+    #   notifiably_audited alert_for: [[:polymorphic,
+    #                                   nil,
+    #                                   :content,
+    #                                   [:commentable_type,:commentable_id]]]
+    #
+    # -----------
+    # alert_to :
+    # -----------
+    # The column of the target_object that has the user_id to send 
+    # the notification to.(receiver_id of the Audit record) 
+    # -----------
+    # alert_for :
+    # -----------
+    # Takes array of arrays as an argument. Every array in the main array corresponds to
+    # one or group of columns update and how to notify.
+    # Following is the index wise explanation of the arrays.
+    # 1. Column name or Column names
+    # 2. Title of the notification(title column of the Audit record)
+    # 3. Description of the notification(audit_comment column of the Audit record)
+    # 4. If the column name is a foreign key of an belongs_to association, then the model_name of the
+    #    associated model and the column of the model to be displayed in title is specified
+    # -----------
+    # title :
+    # -----------
+    # Takes 1 column name or a method name of the target object as an argument, in order to prompt the 
+    # title of the target object wherever needed in the notification
+    # ---------------
+    # create_comment :
+    # ---------------
+    # Default audit_comment for create action
+    # ---------------
+    # update_comment :
+    # ---------------
+    # Default audit_comment for update action
+    #
+    # ***************
+    # :polymorphic
+    # ***************
+    # If this is passed as the first argument of the alert_for option, then it means, the current_model 
+    # is polymorphic and the target_object is a different model to which the current model is
+    # polymorphic to.
+    # 
+    # In the above case the 4th argument of the alert_for option should be the type and id of the
+    # polymorphic model.(Ex: [:commentable_type,commentable_id])
+    #----------------------------------------------
+    #=====================================
 
     module AuditedInstanceMethods
       # Temporarily turns off auditing while saving.
@@ -192,23 +286,108 @@ module Audited
         end
         audits.to_version(version)
       end
-
+      #====== beck modified for notifiable ====
+      
       def audit_create
-        write_audit(:action => 'create', :audited_changes => audited_attributes,
-                    :comment => audit_comment)
+        set_audit_values("create")# also sets @non_monitor as 1
+        if !audit_alert_for.nil?
+           audit_alert_for.each do |f|
+              if f[0] == :polymorphic
+                polymorphic_audit(f)# also sets @non_monitor as 0
+              end
+           end
+         end
+         
+         if @non_monitor == 1 
+           write_audit(@audit_values)
+         end
       end
-
+      
       def audit_update
         unless (changes = audited_changes).empty? && audit_comment.blank?
-          write_audit(:action => 'update', :audited_changes => changes,
-                      :comment => audit_comment)
+          set_audit_values("update")# also sets @non_monitor as 1
+          
+          if !audit_alert_for.nil?
+              audit_alert_for.each do |f|
+                  if f[0] == :polymorphic
+                    polymorphic_audit(f)# also sets @non_monitor as 0
+                  else
+                    changed_eq_opts(f)# also sets @non_monitor as 0
+                  end
+              end
+          end
+          
+          if @non_monitor == 1 
+            write_audit(@audit_values)
+          end
+          
         end
       end
-
+      
       def audit_destroy
         write_audit(:action => 'destroy', :audited_changes => audited_attributes,
-                    :comment => audit_comment)
+                    :comment => audit_comment, :receiver_id => self.send(audit_alert_to), :checked => false)
+      end
+      #=== Following methods helps audit_create and update ======
+      # set_audit_values
+      # polymorphic_audit
+      # changed_eq_opts
+      #==========================================================
+      
+      def set_audit_values(type)
+        @non_monitor = 1
+        # based on type the audit attributes are set
+        if (type == "create")
+          v_audited_changes = audited_attributes
+        elsif (type == "update")
+          v_audited_changes = changes
+        end
+        # the <<here>> part of the comment is replaced with class name
+        v_comment = send("audit_" + type +"_comment").gsub(/<<here>>/,self.class.name)
+        # fields of the audit record set initially as hash, can be over ridden
+        @audit_values = {action: type, 
+                         audited_changes: v_audited_changes,
+                         comment: v_comment, 
+                         title: (self.send(audit_title) rescue self.class.name),
+                         checked: false,
+                         receiver_id: (self.send(audit_alert_to) rescue nil)}
+      end
+      
+      def polymorphic_audit(opts)
+        # polymorphic - so the actual object is set, not the polymorphed object(product not comment)
+        target_object = self.send(opts[3][0]).constantize.find(self.send(opts[3][1]))
+        # overriding the audit values based on polymorphic opts
+        @audit_values[:title] = (opts[1] || @audit_values[:title]).to_s + " - #{target_object.class.name}[#{target_object.send(audit_title)}]"
+        @audit_values[:comment] = self.send(opts[2])[0..20].to_s + "..."
+        @audit_values[:receiver_id] = target_object.send(audit_alert_to)
+        # actual recording of audit
+        write_audit(@audit_values)
+        # setting to 0, so dont record anymore audits
+        @non_monitor = 0
+      end
+      
+      def changed_eq_opts(opts)        
+        # the cols that are going to be modified as identified by audited gem
+        changed = changes.keys.map &:to_sym
+        # the cols to be listened to, as passed in the opts
+        opts_changes = opts[0]
+        # if the sub array(to be listened) is included in the main array(audited identified cols)
+        if ((opts_changes - changed).size == 0)
+          # overriding audit values
+          @audit_values[:title] = opts[1]
+          @audit_values[:comment] = opts[2] 
+            # if 3rd argument is present in the opts, then overriding title
+            if opts[3].present?
+              append = opts[3][0].to_s.camelize.constantize.find(self.send(opts[0][0])).send(opts[3][1])
+              @audit_values[:title] = @audit_values[:title] + "[#{append}]"
+            end
+          # actual recording of audit
+          write_audit(@audit_values)
+          # setting to 0, so dont record anymore audits
+          @non_monitor = 0
+        end
       end
+      #========================================
 
       def write_audit(attrs)
         attrs[:associated] = self.send(audit_associated_with) unless audit_associated_with.nil?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notifiably_audited
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brandon Keepers
@@ -113,6 +113,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: private_pub
+  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'
 description: Log all changes to your models
 email: info@collectiveidea.com
 executables: []