effective_logging 3.0.8 → 3.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e927867ada599e7421b8ff9d05e502647dcc2efb7512a5315ca47275e3edf0c
-  data.tar.gz: 002fb78421be669cc009c6fc237353a56ae5013944a1b3b44702ca3acb77cec7
+  metadata.gz: 1fc5a45c2f4f2b72d25f2440ab60382a4e86455ac95176a4b8c927009aa1712b
+  data.tar.gz: 75fb045296a8e2887ada0a2e637c3f0005b4ba7efaca433c2c7f49d29f0505b9
 SHA512:
-  metadata.gz: 268d59bf22f25ff827e5fd5112283e4c21f566fb6e011283bb88942043dccfd84b8c62f5168d4987ce4069e7c63b2a55fcaa4b88b7ad58cd25464e4197c43ea3
-  data.tar.gz: 9aab2bcae402baca16d24ec20088921aee6c0121e0b080dd27d74727d894e7ddaeb6d6526d54a95627ee58219db78e0b5d748e30449785bd705b1ed8f1f89ba5
+  metadata.gz: c17d99ed81e95846c101e19384c6be111147fec944ec6fe95ed2913cbec52344e4ac0ba6132e3dcdb66cf811b9d0336ca6af3fb80ac1253b53e0b1296b442b59
+  data.tar.gz: 971f6803ddf2e57e2b66068a33bd7ce6bdac5b8cfa735290656df37f2a569234d2dd5b86b9710c846cca37b49abdb0db16b15c1f99f9ae817289f37c94b4ce7a

data/README.md

@@ -197,19 +197,17 @@ This logging includes the resource's base attributes, all autosaved associations
 
 It will recurse through all accepts_nested_attributes has_many's and handle any number of child objects.
 
-Add to your model:
+Add to your application controller:
 
-```ruby
-class Post < ActiveRecord::Base
-  log_changes
-end
+```
+around_action :set_effective_logging_current_user
 ```
 
-and to your controller:
+Add to your model:
 
 ```ruby
-class ApplicationController < ActionController::Base
-  before_action :set_effective_logging_current_user
+class Post < ActiveRecord::Base
+  log_changes
 end
 ```
 
@@ -371,4 +369,3 @@ MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Bonus points for test coverage
 6. Create new Pull Request
-

data/app/views/effective/logs/_log.html.haml

@@ -40,7 +40,7 @@
       - next unless value.present?
       .row
         .col-md-12
-          %p
+          .mt-3
             %strong= "#{key.to_s.titleize}:"
           = format_log_details_value(log, key)
 
@@ -50,4 +50,3 @@
 
       - unless log.datatable.nil?
         = render_datatable(log.datatable)
-

data/config/effective_logging.rb

@@ -40,6 +40,9 @@ EffectiveLogging.setup do |config|
   #### Automatic Logging Functionality ####
   #########################################
 
+  # Log all active storage downloads
+  config.active_storage_enabled = true
+
   # Log all sent emails
   config.email_enabled = true
 

data/lib/effective_logging.rb

@@ -11,6 +11,7 @@ module EffectiveLogging
   mattr_accessor :layout
   mattr_accessor :additional_statuses
 
+  mattr_accessor :active_storage_enabled
   mattr_accessor :email_enabled
   mattr_accessor :sign_in_enabled
   mattr_accessor :sign_out_enabled
@@ -48,8 +49,21 @@ module EffectiveLogging
 
   def self.statuses
     @statuses ||= (
-      Array(@@additional_statuses).map { |status| status.to_s.downcase } |  # union
-      ['info', 'success', 'error', 'view', log_changes_status, ('email' if email_enabled), ('sign_in' if sign_in_enabled), ('sign_out' if sign_out_enabled)].compact
+      base = [
+        'info',
+        'success',
+        'error',
+        'view',
+        log_changes_status, # 'change'
+        ('download' if active_storage_enabled),
+        ('email' if email_enabled),
+        ('sign_in' if sign_in_enabled),
+        ('sign_out' if sign_out_enabled)
+      ].compact
+
+      additional = Array(@@additional_statuses).map { |status| status.to_s.downcase }
+
+      base | additional # union
     )
   end
 

data/lib/effective_logging/active_storage_logger.rb

@@ -0,0 +1,23 @@
+module EffectiveLogging
+  module ActiveStorageLogger
+
+    def track_downloads
+      user = current_user if respond_to?(:current_user)
+
+      key = decode_verified_key()
+      return unless key.present?
+
+      blob = ActiveStorage::Blob.where(key: key[:key]).first
+      return unless blob.present?
+
+      blob.attachments.each do |attachment|
+        associated = attachment.record
+        filename = blob.filename.to_s
+        message = [associated.to_s, filename.to_s].uniq.join(' ')
+
+        EffectiveLogger.download(message, associated: associated, filename: filename, user: user)
+      end
+    end
+
+  end
+end

data/lib/effective_logging/email_logger.rb

@@ -5,7 +5,7 @@ module EffectiveLogging
       return unless message.present?
 
       # collect a Hash of arguments used to invoke EffectiveLogger.success
-      logged_fields = { from: message.from.join(','), to: message.to, subject: message.subject }
+      logged_fields = { from: message.from.join(','), to: message.to, subject: message.subject, cc: message.cc, bcc: message.bcc }
 
       # 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: { post: @post })
@@ -18,10 +18,11 @@ module EffectiveLogging
       end
 
       body = (message.body.try(:parts) || []).find { |part| part.content_type.to_s.downcase.include?('text/html') }
+      to = Array(message.to) - [nil, '']
 
       logged_fields[:email] = "#{message.header}<hr>#{(body.presence || message.body)}"
 
-      (message.to || []).each do |to|
+      to.each do |to|
         user = (User.where(email: to).first rescue nil)
 
         logged_fields[:to] = to
@@ -30,6 +31,11 @@ module EffectiveLogging
 
         ::EffectiveLogger.email("#{message.subject} - #{message.to.join(', ')}", logged_fields)
       end
+
+      if to.blank? && (message.cc.present? || message.bcc.present?)
+        ::EffectiveLogger.email("#{message.subject} - multiple recipients", logged_fields)
+      end
+
     end
 
   end

data/lib/effective_logging/engine.rb

@@ -1,11 +1,14 @@
 require 'effective_logging/active_record_logger'
+require 'effective_logging/active_storage_logger'
+require 'effective_logging/email_logger'
+require 'effective_logging/log_page_views'
+require 'effective_logging/set_current_user'
+require 'effective_logging/user_logger'
 
 module EffectiveLogging
   class Engine < ::Rails::Engine
     engine_name 'effective_logging'
 
-    config.autoload_paths += Dir["#{config.root}/lib/"]
-
     # Set up our default configuration options.
     initializer "effective_logging.defaults", :before => :load_config_initializers do |app|
       eval File.read("#{config.root}/config/effective_logging.rb")
@@ -14,7 +17,6 @@ module EffectiveLogging
     # Automatically Log Emails
     initializer 'effective_logging.emails' do |app|
       if EffectiveLogging.email_enabled == true
-        require 'effective_logging/email_logger'
         ActionMailer::Base.register_interceptor(EffectiveLogging::EmailLogger)
       end
     end
@@ -26,11 +28,20 @@ module EffectiveLogging
       end
     end
 
+    # Log all ActiveStorage downloads
+    initializer 'effective_logging.active_storage' do |app|
+      if EffectiveLogging.active_storage_enabled == true && defined?(ActiveStorage)
+        Rails.application.config.to_prepare do
+          ActiveStorage::DiskController.include(EffectiveLogging::ActiveStorageLogger)
+          ActiveStorage::DiskController.class_eval { after_action(:track_downloads, only: :show) }
+        end
+      end
+    end
+
     # Register the log_page_views concern so that it can be called in ActionController or elsewhere
     initializer 'effective_logging.log_changes_action_controller' do |app|
       Rails.application.config.to_prepare do
         ActiveSupport.on_load :action_controller do
-          require 'effective_logging/set_current_user'
           ActionController::Base.include(EffectiveLogging::SetCurrentUser::ActionController)
         end
       end

data/lib/effective_logging/set_current_user.rb

@@ -3,13 +3,17 @@ module EffectiveLogging
     module ActionController
 
       # Add me to your ApplicationController
-      # before_action :set_effective_logging_current_user
+      # around_action :set_effective_logging_current_user
 
       def set_effective_logging_current_user
         EffectiveLogging.current_user = current_user
+
+        if block_given?
+          yield
+          EffectiveLogging.current_user = nil
+        end
       end
 
     end
   end
 end
-

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '3.0.8'.freeze
+  VERSION = '3.0.13'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 3.0.8
+  version: 3.0.13
 platform: ruby
 authors:
 - Code and Effect
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -112,6 +112,7 @@ files:
 - db/migrate/01_create_effective_logging.rb.erb
 - lib/effective_logging.rb
 - lib/effective_logging/active_record_logger.rb
+- lib/effective_logging/active_storage_logger.rb
 - lib/effective_logging/email_logger.rb
 - lib/effective_logging/engine.rb
 - lib/effective_logging/log_page_views.rb
@@ -123,7 +124,7 @@ homepage: https://github.com/code-and-effect/effective_logging
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Automatically log all sent emails, user logins, and page views. This also
   will log custom events from Ruby and JavaScript.