effective_logging 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a901f93bafa932e05ed2e192421ca7b48934cdb
-  data.tar.gz: 482d6d0ddbca6c267b3a390a3aa2e0bf0f3c94b8
+  metadata.gz: b74a588e1fd04011eea590704282fc85c6ed9e66
+  data.tar.gz: cb09f89a809c02770b26b1c6c583e31289358e12
 SHA512:
-  metadata.gz: 78219a82840db833a6dd6fd843874a9953637706ed8ac93d7a27e4e2605eaa62bf3cfa291ec65b13c8f8dad58e64817b25e38002898399c6c47b193dae10abfc
-  data.tar.gz: c87f6ee35dbd6bd1058e24f2db099f75ff0b2cbb626081e1b96f69f8e5e8b94da38054806b7b366f792d8c72f4069184b7757a8ab3367c3dcd6d3a42cad5ddb1
+  metadata.gz: c3933d77a4bd9b28d8f8df76df5fbfbc43002d08dfefc140cb606897b6745f81c98adb3e3b483f74ec5dd85aebaba7216ac24480b574ca2309d3d0d1a20143d2
+  data.tar.gz: e7e6ea41bd18c639999a2d71cf82a31caf7f2cb7c4931525b200cbf545c04df78f38634c2daa01181cd834c8d16d628997ff71af2322f88d65d59577521c0747

data/README.md

@@ -98,6 +98,17 @@ This behaviour can be disabled in the config/initializers/effective_logging.rb i
 
 If the TO email address match a User, the :user will be set appropriately.
 
+You can specify additional fields to be logged via your mailer:
+
+```ruby
+def notify_admin_of_new_post(post)
+  mail(
+    to: 'admin@example.com',
+    subject: 'A new post was created',
+    log: { :associated => post, :title => post.title }
+  )
+end
+```
 
 ### Automatic Logging of User Login and Logout
 

data/app/models/effective/datatables/logs.rb

@@ -10,47 +10,48 @@ if defined?(EffectiveDatatables)
           table_column :created_at
           table_column :id, visible: false
 
-          table_column :parent_id, visible: false
-          table_column :user, :if => proc { attributes[:user_id].blank? }
+          unless attributes[:user_id] || attributes[:user] || (attributes[:user] == false)
+            table_column :user
+          end
 
-          table_column :status, filter: { type: :select, values: EffectiveLogging.statuses }
+          unless attributes[:status] == false
+            table_column :status, filter: { type: :select, values: EffectiveLogging.statuses }
+          end
 
-          table_column :message, width: '50%', sortable: false
+          table_column :message
           table_column :logs_count, visible: false
 
           table_column :details, visible: false, sortable: false do |log|
-            log.details.delete(:email)
-            tableize_hash(log.details, th: true, sub_th: false, width: '100%')
+            tableize_hash(log.details.except(:email), th: true, sub_th: false, width: '100%')
           end
 
           table_column :updated_at, visible: false
 
-          table_column :actions, sortable: false, filter: false do |log|
-            show_path =
-              if datatables_active_admin_path?
-                admin_effective_log_path(log)
-              elsif datatables_admin_path?
-                effective_logging.admin_log_path(log)
-              else
-                effective_logging.log_path(log)
-              end
-
-            if log.logs_count.to_i > 0
-              link_to "View (#{log.logs_count} more)".html_safe, show_path
-            else
-              link_to 'View', show_path
-            end
-          end
+          actions_column partial: 'admin/logs/actions', partial_local: :log
         end
 
         # A nil attributes[:log_id] means give me all the top level log entries
         # If we set a log_id then it's for sub logs
         def collection
+          collection = Effective::Log.unscoped.where(parent_id: attributes[:log_id]).includes(:user, :associated)
+
           if attributes[:user_id].present?
-            Effective::Log.unscoped.where(:parent_id => attributes[:log_id]).where(:user_id => attributes[:user_id]).includes(:user)
-          else
-            Effective::Log.unscoped.where(:parent_id => attributes[:log_id]).includes(:user)
+            collection = collection.where(user_id: attributes[:user_id])
+          end
+
+          if attributes[:user].present?
+            collection = collection.where(user: attributes[:user])
           end
+
+          if attributes[:associated_id] && attributes[:associated_type]
+            collection = collection.where(associated_id: attributes[:associated_id], associated_type: attributes[:associated_type])
+          end
+
+          if attributes[:associated]
+            collection = collection.where(associated: attributes[:associated])
+          end
+
+          collection
         end
 
       end

data/app/views/admin/logs/_actions.html.haml

@@ -0,0 +1,14 @@
+:ruby
+  show_path =
+    if datatables_active_admin_path?
+      admin_effective_log_path(log)
+    elsif datatables_admin_path?
+      effective_logging.admin_log_path(log)
+    else
+      effective_logging.log_path(log)
+    end
+
+- if log.logs_count.to_i > 0
+  = link_to "View (#{log.logs_count} more)".html_safe, show_path
+- else
+  = link_to 'View', show_path

data/lib/effective_logging/email_logger.rb

@@ -1,26 +1,28 @@
 module EffectiveLogging
   class EmailLogger
-    def self.delivered_email(message)
+    def self.delivering_email(message)
       return unless message.present?
 
-      # Cleanup the Header
-      message_header = message.header.to_s
-      message_header.gsub!(";\r\n charset", '; charset')
+      # collect a Hash of arguments used to invoke EffectiveLogger.success
+      logged_fields = { from: message.from.join(','), to: message.to, subject: message.subject }
 
-      # Cleanup the Body
-      if (message_body = message.body.to_s).include?('<html')
-        message_body.gsub!(/(\r)*\n\s*/, '')
-        message_body.gsub!("<!DOCTYPE html>", '')
+      # Add a log header to your mailer to pass some objects or additional things to EffectiveLogger
+      # mail(to: 'admin@example.com', subject: @post.title, log: { associated: @post })
+      if message.header['log'].present?
+        # This is a bit sketchy, but gives access to the object in Rails 4.2 anyway
+        logged_fields.merge!(message.header['log'].instance_variable_get(:@value) || {})
+
+        # Get rid of the extra header, as it should not be set in the real mail message.
+        message.header['log'] = nil
       end
 
-      (message.to || []).each do |email|
-        user = User.where(:email => email).first
+      logged_fields[:email] = "#{message.header}<hr>#{message.body}"
+
+      (message.to || []).each do |to|
+        logged_fields[:to] = to
+        logged_fields[:user] ||= (User.where(email: to).first rescue nil)
 
-        if user.present?
-          EffectiveLogger.success("email sent: #{message.subject}", :user => user, :recipient => email, :subject => message.subject, :email => message_header + '<hr>' + message_body)
-        else
-          EffectiveLogger.success("email sent to #{email}: #{message.subject}", :recipient => email, :subject => message.subject, :email => message_header + '<hr>' + message_body)
-        end
+        EffectiveLogger.success("email sent: #{message.subject}", logged_fields)
       end
     end
 

data/lib/effective_logging/engine.rb

@@ -19,7 +19,7 @@ module EffectiveLogging
     initializer 'effective_logging.emails' do |app|
       if EffectiveLogging.emails_enabled == true
         require 'effective_logging/email_logger'
-        ActionMailer::Base.register_observer(EffectiveLogging::EmailLogger)
+        ActionMailer::Base.register_interceptor(EffectiveLogging::EmailLogger)
       end
     end
 

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.4.0'.freeze
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: effective_datatables
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: haml-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Automatically log all sent emails, user logins, and page views. This
@@ -102,6 +102,7 @@ files:
 - app/models/effective_logger.rb
 - app/views/active_admin/effective_logging/logs/index.html.haml
 - app/views/active_admin/effective_logging/logs/show.html.haml
+- app/views/admin/logs/_actions.html.haml
 - app/views/admin/logs/index.html.haml
 - app/views/admin/logs/show.html.haml
 - app/views/effective/logs/_log.html.haml
@@ -130,17 +131,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Automatically log all sent emails, user logins, and page views. This also