goodmail 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97d19566a8e8eacb10fed28cddfbe7c9f254ae6f4df4b0c2a8ad5259d646631d
-  data.tar.gz: a15578a0b463e3372ffeff6f9d0a2b0aaa3754c0cf604cc574a97fb0506545fe
+  metadata.gz: c91c844f486384162c36ae455e8c41cd282930c6e8e61a8f43ba549a32dbc76d
+  data.tar.gz: c7f26ef1b5f58f3803d6611dd9401eea9a150b9dc5f05e9b60a4732114361493
 SHA512:
-  metadata.gz: 8ec18e8bc6a78545259c5a359b1811fa7df18cccdca0df36761b94db25304ea9f894ae85cbddbeb54c674526ad7eb5c5a80e24767f7bd97d23baa692ab02aa5f
-  data.tar.gz: d384ec22ed4107cb20c73deff523e15b3d5dcaf7c3d5a464030024336fde15e6346f5f02f90673e23d6790e085db70782b2a2e0df783dbd7db8ad23908b8e3ff
+  metadata.gz: d2c869d81f688f83d04c3fe06060225c60284d9911be34d53a34a8e8fa533c43e241c0a963eee4b2d5459ea7f65aed49dccf77ef4fb3166f444a0a4592dcc697
+  data.tar.gz: ff185729ddc066578ee712009ce27ddd36111fbe6ec8331c0fbb62fe59bfd622a329aa9aa0f92ba71905e9c3cc7e8f6207056196a2bc0353bf922873aa61ec4f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.3.0] - 2025-05-15
+- Add Goodmail.render for custom mailers
+
 ## [0.2.0] - 2025-05-02
 
 ### Added

data/README.md

@@ -234,6 +234,39 @@ end
 *   **Purpose**: `Goodmail.render` is primarily for generating and retrieving processed email content parts. `Goodmail.compose` is for generating a complete, deliverable `Mail::Message` object.
 *   **List-Unsubscribe Header**: `Goodmail.render` itself does *not* add the `List-Unsubscribe` header to any mail object (as it doesn't create one). If you use `Goodmail.render`, you are responsible for adding this header to your `Mail::Message` object if an `unsubscribe_url` was effectively used during rendering (either passed to `Goodmail.render` or taken from global config) and you require this header. The internal `Goodmail::Mailer` (used by `Goodmail.compose`) handles adding this header automatically to the `Mail::Message` object it builds.
 
+### Integrating with the Pay Gem
+
+Goodmail works seamlessly with the [Pay gem](https://github.com/pay-rails/pay) to send beautiful transactional emails for payment notifications (receipts, refunds, subscription updates, etc.).
+
+Since Pay allows you to configure a custom mailer class, you can create a mailer that uses `Goodmail.render` to generate beautiful email content for all Pay notifications.
+
+**Quick Setup:**
+
+1. Copy the example mailer from [`examples/pay_goodmail_mailer.rb`](examples/pay_goodmail_mailer.rb) to your Rails app at `app/mailers/pay_goodmail_mailer.rb`
+
+2. Configure Pay to use the custom mailer in `config/initializers/pay.rb`:
+
+```ruby
+Pay.setup do |config|
+  config.parent_mailer = "ApplicationMailer"
+  config.mailer = "PayGoodmailMailer"
+  # ... other Pay configuration
+end
+```
+
+3. Customize the email content and URLs in the mailer to match your app
+
+The example implementation includes all Pay notification types:
+- `receipt` - Payment receipts
+- `refund` - Refund confirmations
+- `subscription_renewing` - Renewal reminders
+- `payment_action_required` - Payment action needed
+- `subscription_trial_will_end` - Trial ending soon
+- `subscription_trial_ended` - Trial has ended
+- `payment_failed` - Failed payment alerts
+
+Each method uses `Goodmail.render` to create beautiful, consistent emails that match your brand.
+
 ### Adding Unsubscribe Functionality
 
 Goodmail helps you add the `List-Unsubscribe` header and an optional visible link, but **you must provide the actual URL** where users can unsubscribe.

data/lib/goodmail/configuration.rb

@@ -39,6 +39,7 @@ module Goodmail
       @config = DEFAULT_CONFIG.dup unless defined?(@config) && @config
       @config
     end
+    alias_method :configuration, :config
 
     # Resets the configuration back to the default values.
     # Primarily useful for testing environments.

data/lib/goodmail/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Goodmail
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: goodmail
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - rameerez
 bindir: exe
 cert_chain: []
-date: 2025-05-14 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails