effective_logging 3.0.9 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87ea6d6a2184d29eec7b23d56bde3f84c17f16b8f6058a9823849c5ee56edc50
-  data.tar.gz: 0bb7c7040965bc8bb4587a1668d01902b4c85d26c574269b7b130a41325a570e
+  metadata.gz: 91790ca464dd429fb345fcbef0d15cbdebefdbd56f8685aaa8206653a7cd4350
+  data.tar.gz: fccd38fd9967c82487436ed7a25154bc7b84a4fc30c129691ce532683a951717
 SHA512:
-  metadata.gz: 4c7d6f2d933d8774ebc5142a3e171e03178d5918a392635db966c9aa88b0d6d19127520d644fa2f43733cefc514bb31fb23d68dc542c99133b90922cf5aaa213
-  data.tar.gz: 8914c55bdfbe4e3951e25152c095656c2fb649ebd91d3cceca73191b16177f45db31a14339c42363d223a571cefcf9bf1644f7c9683de43d001ea3ff371a6c8b
+  metadata.gz: 57df8caf9cf1a316d2a4591f28ca072b08fa2fae0da1bf71cdd72474971e16637d60337eeb9ce903bfe35033c1fcf68fb7ed76e022aab47a8a7503289fd8cbbc
+  data.tar.gz: 0b6106eade70761e9d71602846c5000308533de2058a6f8097e8aec22439155e5e55c83fafeeaf6a7e9c9339ec19cdd17cb15b372e3b3d79a1dc623eaf8b8bdf

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Code and Effect Inc.
+Copyright 2021 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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/controllers/admin/logs_controller.rb

@@ -1,21 +1,25 @@
 module Admin
   class LogsController < ApplicationController
-    before_action :authenticate_user!
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_logging) }
+
+    include Effective::CrudController
     skip_log_page_views
 
-    layout (EffectiveLogging.layout.kind_of?(Hash) ? EffectiveLogging.layout[:admin_logs] : EffectiveLogging.layout)
+    if (config = EffectiveLogging.layout)
+      layout(config.kind_of?(Hash) ? config[:admin] : config)
+    end
 
     def index
+      EffectiveResources.authorize!(self, :index, Effective::Log)
       @datatable = EffectiveLogsDatatable.new(self)
-
       @page_title = 'Logs'
-
-      EffectiveLogging.authorize!(self, :index, Effective::Log)
-      EffectiveLogging.authorize!(self, :admin, :effective_logging)
     end
 
     def show
       @log = Effective::Log.includes(:logs).find(params[:id])
+      EffectiveResources.authorize!(self, :show, @log)
+
       @log.next_log = Effective::Log.order(:id).where(parent_id: @log.parent_id).where('id > ?', @log.id).first
       @log.prev_log = Effective::Log.order(:id).where(parent_id: @log.parent_id).where('id < ?', @log.id).last
 
@@ -25,8 +29,6 @@ module Admin
         @log.datatable = EffectiveLogsDatatable.new(self, log_id: @log.id)
       end
 
-      EffectiveLogging.authorize!(self, :show, @log)
-      EffectiveLogging.authorize!(self, :admin, :effective_logging)
     end
   end
 end

data/app/controllers/effective/logs_controller.rb

@@ -1,11 +1,17 @@
 module Effective
   class LogsController < ApplicationController
+    before_action(:authenticate_user!, only: [:index, :show]) if defined?(Devise)
+
+    include Effective::CrudController
     skip_log_page_views
-    before_action :authenticate_user!, only: [:index, :show]
+
+    if (config = EffectiveLogging.layout)
+      layout(config.kind_of?(Hash) ? config[:application] : config)
+    end
 
     # This is a post from our Javascript
     def create
-      EffectiveLogging.authorize!(self, :create, Effective::Log.new)
+      EffectiveResources.authorize!(self, :create, Effective::Log.new)
 
       @log = Effective::Log.new.tap do |log|
         log.message = log_params[:message]
@@ -34,7 +40,7 @@ module Effective
 
     # This is the User index event
     def index
-      EffectiveLogging.authorize!(self, :index, Effective::Log.new(user_id: current_user.id))
+      EffectiveResources.authorize!(self, :index, Effective::Log.new(user_id: current_user.id))
 
       @datatable = EffectiveLogsDatatable.new(self, user_id: current_user.id)
     end

data/app/datatables/effective_logs_datatable.rb

@@ -7,10 +7,8 @@ class EffectiveLogsDatatable < Effective::Datatable
 
     if attributes[:user] == false
       # Do not include
-    elsif attributes[:for]
-      col :user, search: :string
     else
-      col :user
+      col :user, search: :string
     end
 
     unless attributes[:status] == false

data/app/models/concerns/acts_as_loggable.rb

@@ -27,8 +27,8 @@ module ActsAsLoggable
       except: Array(@acts_as_loggable_options[:except])
     }
 
-    if name == 'User'
-      log_changes_options[:except] += %i(sign_in_count current_sign_in_at current_sign_in_ip last_sign_in_at last_sign_in_ip encrypted_password remember_created_at reset_password_token invitation_sent_at invitation_created_at invitation_token)
+    if name.end_with?('User')
+      log_changes_options[:except] += %i(sign_in_count current_sign_in_at current_sign_in_ip last_sign_in_at last_sign_in_ip encrypted_password remember_created_at reset_password_token invitation_sent_at invitation_created_at invitation_token access_token refresh_token token_expires_at)
     end
 
     self.send(:define_method, :log_changes_options) { log_changes_options }
@@ -67,4 +67,3 @@ module ActsAsLoggable
   end
 
 end
-

data/app/models/effective/log.rb

@@ -11,33 +11,36 @@ module Effective
     belongs_to :parent, class_name: 'Effective::Log', counter_cache: true, optional: true
     has_many :logs, class_name: 'Effective::Log', foreign_key: :parent_id
 
-    belongs_to :user, optional: true
+    belongs_to :user, polymorphic: true, optional: true
     belongs_to :changes_to, polymorphic: true, optional: true # This is the log_changes to: option
     belongs_to :associated, polymorphic: true, optional: true
 
-    serialize :details, Hash
+    effective_resource do
+      logs_count          :integer  # Rails Counter Cache
+
+      changes_to_type     :string
+      changes_to_id       :string
 
-    # Attributes
-    # logs_count          :integer  # Rails Counter Cache
+      associated_type     :string
+      associated_id       :integer
+      associated_to_s     :string
 
-    # changes_to_type     :string
-    # changes_to_id       :string
+      status              :string
+      message             :text
+      details             :text
 
-    # associated_type     :string
-    # associated_id       :integer
-    # associated_to_s     :string
-    # message             :text
-    # details             :text
-    # status              :string
-    # timestamps
+      timestamps
+    end
+
+    serialize :details, Hash
 
     validates :message, presence: true
     validates :status, presence: true, inclusion: { in: EffectiveLogging.statuses }
 
     scope :deep, -> { includes(:user, :associated) }
     scope :sorted, -> { order(:id) }
-    scope :logged_changes, -> { where(status: EffectiveLogging.log_changes_status)}
-    scope :changes, -> { where(status: EffectiveLogging.log_changes_status)}
+    scope :logged_changes, -> { where(status: EffectiveLogging.log_changes_status) }
+    scope :changes, -> { where(status: EffectiveLogging.log_changes_status) }
 
     def to_s
       "Log #{id}"
@@ -63,5 +66,3 @@ module Effective
 
   end
 end
-
-

data/app/models/effective_logger.rb

@@ -6,7 +6,7 @@ class EffectiveLogger
 
     options = Hash(options).delete_if { |k, v| v.blank? }
 
-    if options[:user].present? && !options[:user].kind_of?(User)
+    if options[:user].present? && !options[:user].class.name.end_with?('User')
       raise ArgumentError.new('Log.log :user => ... argument must be a User object')
     end
 
@@ -30,6 +30,7 @@ class EffectiveLogger
       message: message,
       status: status,
       user_id: options.delete(:user_id),
+      user_type: options.delete(:user_type),
       user: options.delete(:user),
       parent: options.delete(:parent),
       associated: options.delete(:associated),

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

@@ -2,37 +2,11 @@ EffectiveLogging.setup do |config|
   # Configure Database Tables
   config.logs_table_name = :logs
 
-  # Authorization Method
-  #
-  # This method is called by all controller actions with the appropriate action and resource
-  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
-  #
-  # Use via Proc (and with CanCan):
-  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
-  #
-  # Use via custom method:
-  # config.authorization_method = :my_authorization_method
-  #
-  # And then in your application_controller.rb:
-  #
-  # def my_authorization_method(action, resource)
-  #   current_user.is?(:admin)
-  # end
-  #
-  # Or disable the check completely:
-  # config.authorization_method = false
-  config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) } # CanCanCan
-
   # Admin Screens Layout Settings
-  config.layout = 'application'   # All EffectiveLogging controllers will use this layout
-
-  # config.layout = {
-  #   logs: 'application',
-  #   admin_logs: 'admin',
-  # }
+  # config.layout = { application: 'application', admin: 'admin' }
 
   # EffectiveLogger.info('my message') macros
-  # The following statuses are already present: info, success, error, view, change, email, sign_in, sign_out
+  # The following exist: info, success, error, view, change, download, email, sign_in, sign_out
   # Add more here
   config.additional_statuses = []
 
@@ -40,6 +14,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/db/migrate/01_create_effective_logging.rb.erb

@@ -3,6 +3,7 @@ class CreateEffectiveLogging < ActiveRecord::Migration[4.2]
     create_table <%= @logs_table_name %> do |t|
       t.integer       :parent_id
 
+      t.string        :user_type
       t.integer       :user_id
 
       t.string        :changes_to_type

data/lib/effective_logging.rb

@@ -3,53 +3,34 @@ require 'effective_logging/engine'
 require 'effective_logging/version'
 
 module EffectiveLogging
-
-  # The following are all valid config keys
-  mattr_accessor :logs_table_name
-
-  mattr_accessor :authorization_method
-  mattr_accessor :layout
-  mattr_accessor :additional_statuses
-
-  mattr_accessor :email_enabled
-  mattr_accessor :sign_in_enabled
-  mattr_accessor :sign_out_enabled
-
   mattr_accessor :supressed
 
-  def self.setup
-    yield self
+  def self.config_keys
+    [
+      :logs_table_name, :layout, :additional_statuses,
+      :active_storage_enabled, :email_enabled, :sign_in_enabled, :sign_out_enabled
+    ]
   end
 
-  def self.authorized?(controller, action, resource)
-    @_exceptions ||= [Effective::AccessDenied, (CanCan::AccessDenied if defined?(CanCan)), (Pundit::NotAuthorizedError if defined?(Pundit))].compact
-
-    return !!authorization_method unless authorization_method.respond_to?(:call)
-    controller = controller.controller if controller.respond_to?(:controller)
-
-    begin
-      !!(controller || self).instance_exec((controller || self), action, resource, &authorization_method)
-    rescue *@_exceptions
-      false
-    end
-  end
-
-  def self.authorize!(controller, action, resource)
-    raise Effective::AccessDenied unless authorized?(controller, action, resource)
-  end
-
-  def self.supressed(&block)
-    @@supressed = true; yield; @@supressed = false
-  end
-
-  def self.supressed?
-    @@supressed == true
-  end
+  include EffectiveGem
 
   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
 
@@ -59,11 +40,21 @@ module EffectiveLogging
 
   # This is set by the "set_effective_logging_current_user" before_filter.
   def self.current_user=(user)
-    @effective_logging_current_user = user
+    Thread.current[:effective_logging_current_user] = user
   end
 
   def self.current_user
-    @effective_logging_current_user
+    Thread.current[:effective_logging_current_user]
+  end
+
+  def self.supressed(&block)
+    Thread.current[:effective_logging_supressed] = true
+    yield
+    Thread.current[:effective_logging_supressed] = nil
+  end
+
+  def self.supressed?
+    Thread.current[:effective_logging_supressed] == true
   end
 
 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,30 +5,56 @@ 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 }
+      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 })
       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) || {})
+        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
 
+      # Pass a tenant to your mailer
+      # mail(to: 'admin@example.com', subject: @post.title, tenant: Tenant.current)
+      tenant = if message.header['tenant'].present?
+        value = message.header['tenant'].to_s.to_sym # OptionalField, not a String here
+        message.header['tenant'] = nil
+        value
+      end || (Tenant.current if defined?(Tenant))
+
+      user_klass = "#{tenant.to_s.classify}::User".safe_constantize
+
       body = (message.body.try(:parts) || []).find { |part| part.content_type.to_s.downcase.include?('text/html') }
+      body ||= message.body
 
-      logged_fields[:email] = "#{message.header}<hr>#{(body.presence || message.body)}"
+      fields[:email] = "#{message.header}<hr>#{body}"
 
-      (message.to || []).each do |to|
-        user = (User.where(email: to).first rescue nil)
+      if tenant.present?
+        Tenant.as(tenant) { log_email(message, fields, user_klass) }
+      else
+        log_email(message, fields, user_klass)
+      end
+
+      true
+    end
 
-        logged_fields[:to] = to
-        logged_fields[:associated] ||= user
-        logged_fields[:user] ||= user
+    private
+
+    def self.log_email(message, fields, user_klass)
+      tos = Array(message.to) - [nil, '']
+
+      tos.each do |to|
+        user = (user_klass.where(email: to.downcase).first if user_klass.present?)
+
+        user_fields = fields.merge(to: to, user: user, associated: user)
+        ::EffectiveLogger.email("#{message.subject} - #{tos.join(', ')}", user_fields)
+      end
 
-        ::EffectiveLogger.email("#{message.subject} - #{message.to.join(', ')}", logged_fields)
+      if tos.blank? && (message.cc.present? || message.bcc.present?)
+        ::EffectiveLogger.email("#{message.subject} - multiple recipients", fields)
       end
     end
 

data/lib/effective_logging/engine.rb

@@ -1,4 +1,5 @@
 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'
@@ -27,6 +28,16 @@ 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

data/lib/effective_logging/log_page_views.rb

@@ -39,7 +39,7 @@ module EffectiveLogging
         return if @_effective_logging_skip_log_page_view == true
         return if (self.class.log_page_views_opts[:skip_namespace] || []).include?(self.class.parent)
 
-        user = EffectiveLogging.current_user || current_user
+        user = EffectiveLogging.current_user || (current_user if respond_to?(:current_user))
 
         if self.class.log_page_views_opts[:details] == false
           ::EffectiveLogger.view("#{request.request_method} #{request.path}", user: user)
@@ -66,4 +66,3 @@ module EffectiveLogging
 
   end
 end
-

data/lib/effective_logging/set_current_user.rb

@@ -3,13 +3,18 @@ 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?
+          retval = yield
+          EffectiveLogging.current_user = nil
+          retval
+        end
       end
 
     end
   end
 end
-

data/lib/effective_logging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLogging
-  VERSION = '3.0.9'.freeze
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_logging
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 3.1.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-13 00:00:00.000000000 Z
+date: 2021-02-18 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