lograge-action-mailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84db2e508897b2ff827e412f14e52e126a9a9440d00df916555c78f0e85cb6c7
+  data.tar.gz: 2e098eb9e05416365ffd6687a7dd28567f144b5f3fc6c7c4db60503b946e1208
+SHA512:
+  metadata.gz: cbd9db29b08b0f12982790c9b633ffcfa10001052b4a6f1694d5a008f058d03c94dea17ceeb6158fef15abacbdef47d2e183bd10d82d2cbe0377b30843734255
+  data.tar.gz: 4400b551e8d71e37988b7d86b5cd937f77c46e9ca90c2ef139360b74f349fa423f5436d9efdc5d5a9a2537c1eef18fb046e7b570f7abf5d7137f7a58cc27c280

data/README.md

@@ -0,0 +1,34 @@
+# Lograge::ActionMailer
+
+You get a single line with all the important information, like this:
+```log
+ "status":"delivered","mailer":"UserMailer","message_id":"61e6b06c20d63_323a76b547849c@application-dev.mail","duration":"855.3ms"
+```
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'lograge'
+gem 'lograge-action-mailer'
+```
+
+Enable it in an initializer or the relevant environment config:
+```ruby
+# config/initializers/lograge.rb
+# OR
+# config/environments/production.rb
+Rails.application.configure do
+  config.lograge.action_mailer.enabled = true
+end
+```
+To further clean up your logging, you can also tell Lograge to skip log messages meeting given criteria. You can skip log messages generated from ActionMailer events:
+```ruby
+Rails.application.configure do
+  config.lograge.action_mailer.ignore_events = ["process"]
+end
+```
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lograge/action_mailer/base_log_subscriber.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/log_subscriber"
+
+module Lograge
+  module ActionMailer
+    class BaseLogSubscriber < ActiveSupport::LogSubscriber
+      protected
+
+      def processing_data(event, data)
+        return if event_ignore?(event.name)
+
+        logger.send(Lograge.log_level, Lograge.formatter.call(data))
+      end
+
+      private
+
+      def event_ignore?(name)
+        !!Array(Lograge::ActionMailer.ignore_events).index(name.split(".").first)
+      end
+
+      def logger
+        Lograge::ActionMailer.logger.presence || Lograge.logger.presence || super
+      end
+    end
+  end
+end

data/lib/lograge/action_mailer/railtie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "active_support"
+require "active_support/ordered_options"
+
+module Lograge
+  module ActionMailer
+    class Railtie < Rails::Railtie
+      config.lograge = ActiveSupport::OrderedOptions.new unless config.respond_to?(:lograge)
+      config.lograge.action_mailer = ActiveSupport::OrderedOptions.new
+      config.lograge.action_mailer.enabled = false
+      config.lograge.action_mailer.ignore_events = []
+
+      config.after_initialize do |app|
+        Lograge::ActionMailer.setup(app) if app.config.lograge.action_mailer.enabled
+      end
+    end
+  end
+end

data/lib/lograge/action_mailer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lograge
+  module ActionMailer
+    VERSION = "0.0.1"
+  end
+end

data/lib/lograge/action_mailer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "lograge/action_mailer/railtie"
+require "lograge/action_mailer/base_log_subscriber"
+require "lograge/log_subscribers/action_mailer"
+
+require "action_mailer/log_subscriber"
+
+module Lograge
+  module ActionMailer
+    class << self
+      attr_accessor :logger, :ignore_events
+
+      def remove_existing_log_subscriptions
+        ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+          next unless subscriber.is_a?(::ActionMailer::LogSubscriber)
+
+          Lograge.unsubscribe(:action_mailer, subscriber)
+        end
+      end
+
+      def setup(app)
+        Lograge::ActionMailer.remove_existing_log_subscriptions
+        Lograge::LogSubscribers::ActionMailer.attach_to :action_mailer
+        Lograge::ActionMailer.logger = app.config.lograge.action_mailer.logger
+        Lograge::ActionMailer.ignore_events = app.config.lograge.action_mailer.ignore_events
+      end
+    end
+  end
+end

data/lib/lograge/log_subscribers/action_mailer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lograge
+  module LogSubscribers
+    class ActionMailer < Lograge::ActionMailer::BaseLogSubscriber
+      def deliver(event)
+        data = {
+          status: event.payload[:perform_deliveries] ? :delivered : :skipped,
+          mailer: event.payload[:mailer],
+          message_id: event.payload[:message_id],
+          duration: "#{event.duration.round(1)}ms"
+        }.compact
+
+        processing_data(event, data)
+      end
+
+      def process(event)
+        data = {
+          status: event.payload[:perform_deliveries] ? :delivered : :skipped,
+          mailer: event.payload[:mailer],
+          action: event.payload[:action],
+          duration: "#{event.duration.round(1)}ms"
+        }.compact
+
+        processing_data(event, data)
+      end
+    end
+  end
+end

data/lib/lograge-action-mailer.rb

@@ -0,0 +1,7 @@
+module Lograge
+  module ActionMailer
+  end
+end
+
+require "lograge/action_mailer/version"
+require "lograge/action_mailer"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: lograge-action-mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pervushin Alec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+description: Lograge for ActionMailer.
+email:
+- pervushin.oa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/lograge-action-mailer.rb
+- lib/lograge/action_mailer.rb
+- lib/lograge/action_mailer/base_log_subscriber.rb
+- lib/lograge/action_mailer/railtie.rb
+- lib/lograge/action_mailer/version.rb
+- lib/lograge/log_subscribers/action_mailer.rb
+homepage: https://github.com/one0fnine/lograge-action-mailer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Lograge for ActionMailer.
+test_files: []