letter_thief 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bff6011c6899c346bc0de0779fa7b95549d51ee83b78567b77ebecbdc290c4a
-  data.tar.gz: 8804964cea6bf766ec28472dc5fd9f6b41f2f2a32d89b37b7981870b173c7f49
+  metadata.gz: 6b9da9a56525056e77e837df646d89b134022a8a728c5d69d04035044acb1cbc
+  data.tar.gz: 0f397860a20dd2ec9faa0aaaba3fbed694f8f1ebd3cafe3867343f776206c911
 SHA512:
-  metadata.gz: bae87c979366a349a3965c636ea86eb9592c22a9a68241902abe4e27572bd285192ba05121d601bac86b2b6d1623632a17b72957ac06d585911ec9cf0a6b63e9
-  data.tar.gz: 7473e046f6c52bb33df9bcb2fed97efdda306150cf5c74096dd0ffbc647fd9c008bfcfc3647a038e530973e1edd324ef410407ad7a2c8688dd306642cb419cb2
+  metadata.gz: f54fe7d9f2fcca342075704f993e1656006c476f55311f8f6f4b8c081bafa479867e7b51956f6ad6161dfb4c79a67b352767aa0714a66ef4ebd4a8c4090a5126
+  data.tar.gz: 8bfd75c5082d73e95f1bf95bc810d04ea5a1d13ab76cf149a28743abc34dc0d8800508308279fce5dd54e9367a4b8acd12884b30b468783058ce2e2ff4b73059

data/README.md

@@ -26,6 +26,7 @@ If you used `letter_opener` in the past you know how nice it is to have
 the sent emails opened automatically in your Browser when working locally.
 LetterThief supports this as well with the very same mechanism, but `launchy` is not a direct dependency.
 If you add Launchy on your Gemfile, emails will be opened right away once sent.
+This can be disabled with `LetterThief.open_sent_emails = false`.
 
 Since emails are persisted on the Database it means you can use this also on Heroku, deplo.io, or other PaaS where you
 don't have a disk. No need for an external service like Mailtrap (amazing service!) anymore.
@@ -57,6 +58,24 @@ authenticate :user, ->(user) { user&.administrator? } do
 end
 ```
 
+### Authentication
+
+Alternatively, you can provide your own authentication mechanism by specifying a different controller as the base class
+for LetterThief's controllers. By default, LetterThief's controllers extend `::ApplicationController`, but you can change
+this easily:
+
+```ruby
+# config/initializers/letter_thief.rb
+Rails.application.configure do
+  LetterThief.base_controller_class = "AdminController"
+end
+```
+
+This is useful if you have a custom controller (like `AdminController`) that already handles authentication via
+`before_action` callbacks.
+
+### Delivery Method
+
 If you want to stop sending emails, you can use it also as delivery method:
 
 ```ruby
@@ -74,12 +93,25 @@ end
 
 and LetterThief will open emails directly in your Browser like Letter Opener.
 
+If `launchy` is in your Gemfile for other reasons and you don't want emails to be opened automatically, you can disable
+it:
+
+```ruby
+# config/initializers/letter_thief.rb
+LetterThief.open_sent_emails = false
+```
+
 ### Separate database
 
-If you'd like to store your emails on a separate database, you can configure it via:
+If you'd like to store your emails on a separate database, you can configure it in an initializer:
+
+```ruby
+# config/initializers/letter_thief.rb
+LetterThief.connects_to = {database: {writing: :letter_thief}}
+```
 
-`config.letter_thief.connects_to = {database: {writing: :letter_thief}}` and of course you'll need a separate database
-configuration. Here is an example:
+The value is passed as is to Rails' `connects_to`, so you can also configure shards or a separate reading database.
+Of course you'll need a separate database configuration. Here is an example:
 
 ```yml
 development:
@@ -92,6 +124,20 @@ development:
     migrations_paths: db/letter_thief_migrate
 ```
 
+Move the migration generated by `rails generate letter_thief:install` to `db/letter_thief_migrate` so that the
+`letter_thief_email_messages` table is created on the separate database. Attachments still use ActiveStorage on your
+primary database.
+
+### Enable/Disable Observer
+
+By default, LetterThief observes all emails sent by your application and logs them to the database. You can disable this behavior by setting:
+
+```ruby
+LetterThief.observer_enabled = false
+```
+
+This is useful when you want to disable email logging in production or only enable it when debugging specific issues. You can configure this per environment in `config/environments/production.rb` or toggle it dynamically in the Rails console.
+
 ## Varia
 
 > [!NOTE]
@@ -123,6 +169,20 @@ TARGET_DB=mysql bin/test #mysql
 
 You can also sping up a dummy app with `bin/rails server` and work there.
 
+## Release
+
+1. Bump the version in `lib/letter_thief/version.rb`, update `CHANGELOG.md` and commit to `main`.
+1. Tag the commit with the bare version and push the tag:
+
+   ```bash
+   git tag -a 1.2.3 -m 1.2.3
+   git push origin 1.2.3
+   ```
+
+1. Create a GitHub release for the tag with the changelog section as notes.
+
+Semaphore runs the tests on the tag and, when they pass, promotes the `release` pipeline, which pushes the gem to
+[rubygems.org](https://rubygems.org). It fails when the tag does not match the gem version.
 
 ## Contributing
 

data/Rakefile

@@ -6,3 +6,5 @@ load "rails/tasks/engine.rake"
 load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
+
+Rake::Task["release"].clear

data/app/controllers/letter_thief/application_controller.rb

@@ -1,4 +1,4 @@
 module LetterThief
-  class ApplicationController < ActionController::Base
+  class ApplicationController < LetterThief.base_controller_class.constantize
   end
 end

data/app/models/letter_thief/application_record.rb

@@ -1,5 +1,7 @@
 module LetterThief
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
+
+    connects_to(**LetterThief.connects_to) if LetterThief.connects_to
   end
 end

data/app/models/letter_thief/email_message.rb

@@ -2,14 +2,12 @@ module LetterThief
   class EmailMessage < ApplicationRecord
     self.table_name = "letter_thief_email_messages"
 
-    connects_to(**LetterThief.connects_to) if LetterThief.connects_to
-
     if LetterThief.activestorage_available?
       has_many_attached :attachments
       has_one_attached :raw_email
     end
 
-    unless ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
+    unless connection.adapter_name.downcase.include?("postgresql")
       serialize :to, coder: JSON, type: Array
       serialize :from, coder: JSON, type: Array
       serialize :sender, coder: JSON, type: Array

data/app/models/letter_thief/email_search.rb

@@ -16,7 +16,7 @@ module LetterThief
       scope = EmailMessage.order(intercepted_at: :desc)
 
       if query.present?
-        adapter = ActiveRecord::Base.connection.adapter_name.downcase
+        adapter = EmailMessage.connection.adapter_name.downcase
         scope = if adapter.include?("postgresql")
           scope.where(<<~SQL.squish, q: "%#{query}%")
             subject ILIKE :q

data/lib/letter_thief/delivery_method.rb

@@ -6,8 +6,15 @@ module LetterThief
     end
 
     def deliver!(mail)
+      delivered_mail = Observer.delivered_email(mail)
+      open_in_browser(delivered_mail) if LetterThief.open_sent_emails
+    end
+
+    private
+
+    def open_in_browser(delivered_mail)
       require "launchy"
-      ::Launchy.open(LetterThief::Engine.routes.url_helpers.email_message_url(Observer.delivered_email(mail), Rails.configuration.action_mailer.default_url_options))
+      ::Launchy.open(LetterThief::Engine.routes.url_helpers.email_message_url(delivered_mail, Rails.configuration.action_mailer.default_url_options))
     rescue LoadError
       puts "WARNING: LetterThief requires the 'launchy' gem to open the email in a web browser. Add it to your Gemfile."
     end

data/lib/letter_thief/engine.rb

@@ -6,7 +6,7 @@ module LetterThief
     isolate_namespace LetterThief
 
     initializer "letter_thief.add_observer" do
-      unless Rails.application.config.action_mailer.delivery_method == :letter_thief
+      if LetterThief.observer_enabled && Rails.application.config.action_mailer.delivery_method != :letter_thief
         ActiveSupport.on_load(:action_mailer) do
           ActionMailer::Base.register_observer(LetterThief::Observer)
         end

data/lib/letter_thief/version.rb

@@ -1,3 +1,3 @@
 module LetterThief
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

data/lib/letter_thief.rb

@@ -3,6 +3,9 @@ require "letter_thief/engine"
 
 module LetterThief
   mattr_accessor :connects_to
+  mattr_accessor :base_controller_class, default: "::ApplicationController"
+  mattr_accessor :observer_enabled, default: true
+  mattr_accessor :open_sent_emails, default: true
 
   def self.used_activestorage_space
     ActiveStorage::Blob

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: letter_thief
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alessandro Rodi
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,7 +59,6 @@ metadata:
   homepage_uri: https://github.com/coorasse/letter_thief
   source_code_uri: https://github.com/coorasse/letter_thief
   changelog_uri: https://github.com/coorasse/letter_thief/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 4.0.2
 specification_version: 4
 summary: Log emails in Rails and visualize them.
 test_files: []