mailer-log 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e50f5dea58e4b40e9921bada1e13d7d600412b24b807965c324f0ca1b120ccad
-  data.tar.gz: 29663f1776838ec44972bb682c26a4cd5b850d8f0af64c47bbf21ca3d1d9443e
+  metadata.gz: 246ac2bdc7be2049ccdf70145045c59b6e812b5fc1e15e55c34e27d7a9d355a7
+  data.tar.gz: ad4d87236c3317f50782b0036aef15b3b82fb0ad148619085ef76d4e83706cb6
 SHA512:
-  metadata.gz: 52bacd669f3f137988fdd5bc2671dc353925c2674fbe8ca2229f7728788fc366ae03ef81ccf10afc955aa96ab2a3f1f9a76a82137d54a3a14f4c5b9b3b727911
-  data.tar.gz: 1178c08af25d81d72601baaa28b16fa09e0736bde7016273c0985594c871a13908596cddaf4eb16974fb68994f8a5b817f2cd500fa905652907716aee6c9e3b3
+  metadata.gz: 33943c05863643d2c1777cf7815722842f300676a862911832061fb2d3dd32c9cbc69eb195780362eb58cac4f14420d25ab495aafe963ef267137c4f5ef1af3d
+  data.tar.gz: 43e5dadcc5baa827305b13c17d04bab4bdc41a5fb1d73b163f58a9bd62c2c46978062aa79fb609ee0975e9a4623f4a5982979f41ba60b7e84c2e0b5f0fea9eef

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.6] - 2025-12-15
+
+### Added
+
+- Configurable `mount_path` option (default: `/admin/mailer-log`)
+- `MailerLog.routes(self)` helper method for easier route mounting
+
 ## [0.1.5] - 2025-12-15
 
 ### Added

data/README.md

@@ -37,10 +37,16 @@ This will:
 ```ruby
 # config/routes.rb
 Rails.application.routes.draw do
-  mount MailerLog::Engine, at: '/mailer_log'
+  MailerLog.routes(self, at: '/admin/email_log')
 end
 ```
 
+Or mount manually:
+
+```ruby
+mount MailerLog::Engine, at: '/admin/email_log'
+```
+
 ### 4. Build the frontend (if needed)
 
 The engine includes pre-built Vue.js frontend assets. If you need to rebuild:
@@ -61,6 +67,9 @@ Edit `config/initializers/mailer_log.rb` to customize settings:
 
 ```ruby
 MailerLog.configure do |config|
+  # Mount path for the engine (default: '/admin/mailer-log')
+  # config.mount_path = '/admin/mailer-log'
+
   # Email retention period (default 1 year)
   config.retention_period = 1.year
 
@@ -95,7 +104,7 @@ end
 
 1. In Mailgun Dashboard, go to **Webhooks**
 2. Add webhook for each event:
-   - URL: `https://your-app.com/mailer_log/webhooks/mailgun` (adjust path based on your routes mount point)
+   - URL: `https://your-app.com/admin/mailer-log/webhooks/mailgun` (adjust path based on your mount_path)
    - Events: `delivered`, `opened`, `clicked`, `bounced`, `failed`, `dropped`, `complained`
 
 ### 3. For Each Domain
@@ -171,6 +180,7 @@ cleanup_mailer_log:
 
 | Parameter | Default | Description |
 |-----------|---------|-------------|
+| `mount_path` | `'/admin/mailer-log'` | Default path for `MailerLog.routes(self)` when `at:` not specified |
 | `retention_period` | `1.year` | Email retention period |
 | `webhook_signing_key` | `nil` | Key for Mailgun webhook verification |
 | `capture_call_stack` | `true` | Capture call stack |

data/lib/generators/mailer_log/install/templates/README

@@ -12,13 +12,19 @@ Next steps:
 2. Add routes to config/routes.rb:
 
    Rails.application.routes.draw do
-     mount MailerLog::Engine, at: '/mailer_log'
+     MailerLog.routes(self, at: '/admin/email_log')
+   end
+
+   Or mount manually:
+
+   Rails.application.routes.draw do
+     mount MailerLog::Engine, at: '/admin/email_log'
    end
 
 3. Configure Mailgun webhooks (optional, for delivery tracking):
 
    - Go to Mailgun Dashboard -> Sending -> Webhooks
-   - Add webhook URL: https://your-app.com/mailer_log/webhooks/mailgun
+   - Add webhook URL: https://your-app.com/admin/mailer-log/webhooks/mailgun
    - Select events: delivered, opened, clicked, bounced, failed, complained
    - Copy webhook signing key to ENV['MAILGUN_WEBHOOK_SIGNING_KEY']
 
@@ -29,7 +35,7 @@ Next steps:
      cron: '0 3 * * *'
      class: MailerLog::CleanupJob
 
-5. Access admin UI at: /mailer_log/admin/emails
+5. Access admin UI at: /admin/mailer-log (or your configured mount_path)
 
 ===============================================================================
 

data/lib/generators/mailer_log/install/templates/initializer.rb.tt

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 MailerLog.configure do |config|
+  # Mount path for the engine (default: '/admin/mailer-log')
+  # Used when calling MailerLog.routes(self) in config/routes.rb
+  # config.mount_path = '/admin/mailer-log'
+
   # Email retention period (default: 1 year)
   # Emails older than this will be deleted by CleanupJob
   config.retention_period = 1.year

data/lib/mailer_log/configuration.rb

@@ -3,11 +3,12 @@
 module MailerLog
   class Configuration
     attr_accessor :retention_period,
-                  :webhook_signing_key,
-                  :capture_call_stack,
-                  :call_stack_depth,
-                  :admin_layout,
-                  :per_page
+      :webhook_signing_key,
+      :capture_call_stack,
+      :call_stack_depth,
+      :admin_layout,
+      :per_page,
+      :mount_path
 
     attr_reader :authenticate_with_proc, :resolve_accountable_proc
 
@@ -18,6 +19,7 @@ module MailerLog
       @call_stack_depth = 20
       @admin_layout = 'application'
       @per_page = 25
+      @mount_path = '/admin/mailer-log'
       @authenticate_with_proc = nil
       @resolve_accountable_proc = nil
     end

data/lib/mailer_log/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailerLog
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/lib/mailer_log.rb

@@ -20,5 +20,15 @@ module MailerLog
     def reset_configuration!
       @configuration = Configuration.new
     end
+
+    # Mount engine routes
+    # Usage in config/routes.rb:
+    #   MailerLog.routes(self, at: '/admin/email_log')
+    # Or use configured mount_path:
+    #   MailerLog.routes(self)  # uses config.mount_path (default: /admin/mailer-log)
+    def routes(router, at: nil)
+      path = at || configuration.mount_path
+      router.mount Engine, at: path
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailer-log
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - TrafficRunners
@@ -62,7 +62,7 @@ description: A Rails engine that captures all outgoing emails, stores them in Po
   provides a Vue.js admin UI for browsing emails, and tracks delivery events via Mailgun
   webhooks.
 email:
-- team@localviking.com
+- sk@trafficrunners.net
 executables: []
 extensions: []
 extra_rdoc_files: []