postmail_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e82262745d8d6def26f3763147d49b5bb6ca18f60276308dd2ee40a03f01dd8
-  data.tar.gz: a1a533c7d4d6e67ef667d49d7c179214faacf57f78c88d110ef59ff8bd0b2f6e
+  metadata.gz: '082b38d7e9f806d253c50216bcbcfbf4403c3d310bb1bef277f99c2de62350c3'
+  data.tar.gz: 19957be43157502c87a60c2b8289c893a5633d8f415b3be41807c600fa9b0b62
 SHA512:
-  metadata.gz: 43a555ac29f11c84661f92d2fe65a587799468ca2b4614ea89be727612d782ada63a48ceb6501466717643b1e0fb0cf697bc2fb3bdc9f222509d23336d6d0ca1
-  data.tar.gz: aa319b8ab71c34e5ef22cdf34c48618f561e8db298e7dce662b317e8da6bc58d7b20beb4a89325ed161184d5fce2a6c1d4125c894d208305d480fc4f11e18ef0
+  metadata.gz: f734c2ea0208d4cf30a2ba049d75f35ac07b61f85ffe6503d49d1a3b5e59c3dd3c400d2076bf19997f5efadcbe657a4a6cee567a7093865ef244f4dac2a48951
+  data.tar.gz: 274e9ceef04ab13495b31bb6ecf2872dbc600d3f02b3d17e19b07e686c516bd10fffdd473d050ae23ddd7be994dc8b63318bb7b7a8548b72f100f1c9ec28e5b8

data/README.md

@@ -1,20 +1,20 @@
-# Postmail
+# PostmailRuby
 
-Postmail est une gem Ruby qui fournit un mécanisme flexible d’envoi d’e‑mails pour Ruby on Rails ou tout projet utilisant Action Mailer.  La gem propose deux méthodes d’expédition : soit par **SMTP**, soit par une **API HTTP**.  Tous les paramètres de connexion et le choix de la méthode d’envoi se pilotent via des variables d’environnement afin de simplifier la configuration lors du déploiement.
+PostmailRuby est une gem Ruby qui fournit un mécanisme flexible d’envoi d’e‑mails pour Ruby on Rails ou tout projet utilisant Action Mailer.  La gem propose deux méthodes d’expédition : soit par **SMTP**, soit par une **API HTTP**.  Tous les paramètres de connexion et le choix de la méthode d’envoi se pilotent via des variables d’environnement afin de simplifier la configuration lors du déploiement.
 
 ## Installation
 
 Dans votre `Gemfile`, ajoutez :
 
 ```ruby
-gem "postmail_ruby", path: "path/to/postmail"
+gem "postmail_ruby", '~> 0.1.1'
 ```
 
 Puis exécutez `bundle install` pour installer la gem.
 
 ## Utilisation dans Rails
 
-Postmail enregistre deux méthodes de livraison personnalisées pour Action Mailer : `:postmail_smtp` et `:postmail_api`.  La gem est livrée avec un **Railtie** qui détecte Rails et configure automatiquement Action Mailer en fonction des variables d’environnement ci‑dessous.  En pratique, il suffit de définir vos variables d’environnement et de vous assurer que la gem est chargée.
+PostmailRuby enregistre deux méthodes de livraison personnalisées pour Action Mailer : `:postmail_smtp` et `:postmail_api`.  La gem est livrée avec un **Railtie** qui détecte Rails et configure automatiquement Action Mailer en fonction des variables d’environnement ci‑dessous.  En pratique, il suffit de définir vos variables d’environnement et de vous assurer que la gem est chargée.
 
 Si vous souhaitez configurer explicitement la gem (par exemple hors de Rails), vous pouvez appeler :
 
@@ -32,7 +32,7 @@ Toutes les options de configuration se font via des variables d’environnement,
 | Variable | Description | Valeur par défaut |
 |---------|-------------|------------------|
 | `POSTMAIL_DELIVERY_METHOD` | Choix de la méthode d’envoi : `smtp` (envoi via serveur SMTP) ou `api` (envoi via appel HTTP). | `smtp` |
-| `POSTMAIL_DISABLE_RAILS_SMTP` | Lorsque défini à `true`, Postmail désactive les paramètres SMTP par défaut de Rails (`ActionMailer::Base.smtp_settings`) pour éviter des retours en arrière accidentels. Utiliser cette option est recommandé si vous envoyez exclusivement via l’API. | `false` |
+| `POSTMAIL_DISABLE_RAILS_SMTP` | Lorsque défini à `true`, PostmailRuby désactive les paramètres SMTP par défaut de Rails (`ActionMailer::Base.smtp_settings`) pour éviter des retours en arrière accidentels. Utiliser cette option est recommandé si vous envoyez exclusivement via l’API. | `false` |
 | `POSTMAIL_API_ENDPOINT` | URL complète de l’endpoint HTTP pour l’envoi par API (par exemple `https://postal.exanora.com/api/v1/send/message`). Obligatoire si `POSTMAIL_DELIVERY_METHOD=api`. | – |
 | `POSTMAIL_API_KEY` | Clé d’API utilisée pour authentifier les requêtes HTTP (envoyée dans l’en‑tête `X-Server-API-Key`). | – |
 | `POSTMAIL_API_TIMEOUT` | Temps d’attente maximum en secondes lors de l’appel HTTP. | `10` |
@@ -42,7 +42,7 @@ Toutes les options de configuration se font via des variables d’environnement,
 | `POSTMAIL_SMTP_PASSWORD` | Mot de passe pour l’authentification SMTP. | `nil` |
 | `POSTMAIL_SMTP_AUTHENTICATION` | Type d’authentification SMTP : `plain`, `login` ou `cram_md5`. | `plain` |
 | `POSTMAIL_SMTP_ENABLE_STARTTLS_AUTO` | Active STARTTLS. Mettre `false` pour désactiver. | `true` |
-| `POSTMAIL_SMTP_SSL` | Lorsque défini à `true`, Postmail établit une connexion SSL/TLS implicite (comme un port 465). | `false` |
+| `POSTMAIL_SMTP_SSL` | Lorsque défini à `true`, PostmailRuby établit une connexion SSL/TLS implicite (comme un port 465). | `false` |
 | `POSTMAIL_SMTP_OPEN_TIMEOUT` | Durée maximale (en secondes) pour établir la connexion SMTP. | `30` |
 | `POSTMAIL_SMTP_READ_TIMEOUT` | Durée maximale (en secondes) pour la lecture des réponses SMTP. | `30` |
 
@@ -54,7 +54,7 @@ Rails utilise un mécanisme SMTP par défaut si aucune méthode d’envoi n’es
 POSTMAIL_DISABLE_RAILS_SMTP=true
 ```
 
-Lorsque cette variable est à `true`, Postmail réinitialise `ActionMailer::Base.smtp_settings` à un hash vide et définit `ActionMailer::Base.delivery_method` sur `:postmail_api` ou `:postmail_smtp` en fonction de `POSTMAIL_DELIVERY_METHOD`.
+Lorsque cette variable est à `true`, PostmailRuby réinitialise `ActionMailer::Base.smtp_settings` à un hash vide et définit `ActionMailer::Base.delivery_method` sur `:postmail_api` ou `:postmail_smtp` en fonction de `POSTMAIL_DELIVERY_METHOD`.
 
 ### Exemple de configuration
 
@@ -82,9 +82,9 @@ POSTMAIL_DISABLE_RAILS_SMTP=false
 
 ## Fonctionnement
 
-Lorsque la méthode d’envoi est `api`, Postmail sérialise votre message et l’envoie en `POST` vers l’endpoint HTTP.  Le corps de la requête est JSON et inclut les adresses, le sujet, les corps texte/HTML et les pièces jointes (encodées en Base64).  La clé API est transmise via l’en‑tête `X-Server-API-Key`.
+Lorsque la méthode d’envoi est `api`, PostmailRuby sérialise votre message et l’envoie en `POST` vers l’endpoint HTTP.  Le corps de la requête est JSON et inclut les adresses, le sujet, les corps texte/HTML et les pièces jointes (encodées en Base64).  La clé API est transmise via l’en‑tête `X-Server-API-Key`.
 
-Lorsque la méthode d’envoi est `smtp`, Postmail utilise les paramètres SMTP renseignés pour établir la connexion avec le serveur de messagerie via la gem `mail`.  Les options SSL/TLS, timeouts et authentification sont héritées des variables d’environnement.
+Lorsque la méthode d’envoi est `smtp`, PostmailRuby utilise les paramètres SMTP renseignés pour établir la connexion avec le serveur de messagerie via la gem `mail`.  Les options SSL/TLS, timeouts et authentification sont héritées des variables d’environnement.
 
 ## Contribuer
 

data/lib/postmail_ruby/configuration.rb

@@ -51,7 +51,7 @@ module PostmailRuby
     end
 
     # Returns true if the default Rails SMTP configuration should be disabled.
-    # When this is true, Postmail will clear `config.action_mailer.smtp_settings`.
+    # When this is true, PostmailRuby will clear `config.action_mailer.smtp_settings`.
     def disable_default_smtp?
       @disable_default_smtp
     end

data/lib/postmail_ruby/delivery_method/http.rb

@@ -64,7 +64,7 @@ module PostmailRuby
       # omitted from the final hash for brevity.
       #
       # @param [Mail::Message] mail
-      # @param [Postmail::Configuration] config
+      # @param [PostmailRuby::Configuration] config
       # @return [Hash]
       def build_payload(mail, _config)
         {

data/lib/postmail_ruby/delivery_method/smtp.rb

@@ -5,10 +5,10 @@ require 'mail'
 module PostmailRuby
   module DeliveryMethod
     # Provides a custom SMTP delivery method that reads its
-    # configuration from Postmail::Configuration. This class is
+    # configuration from PostmailRuby::Configuration. This class is
     # essentially a thin wrapper around Mail::SMTP, passing in
     # settings derived from environment variables. It allows
-    # Action Mailer to use Postmail configuration seamlessly.
+    # Action Mailer to use PostmailRuby configuration seamlessly.
     class SMTP
       attr_reader :settings
 

data/lib/postmail_ruby/railtie.rb

@@ -3,18 +3,18 @@
 require 'rails/railtie'
 
 module PostmailRuby
-  # Railtie for integrating Postmail with Rails. This railtie
+  # Railtie for integrating PostmailRuby with Rails. This railtie
   # registers custom delivery methods with Action Mailer and
-  # configures Action Mailer based on Postmail configuration. It
+  # configures Action Mailer based on PostmailRuby configuration. It
   # also offers an option to disable the default SMTP settings
-  # configured by Rails, allowing Postmail to be the sole mail
+  # configured by Rails, allowing PostmailRuby to be the sole mail
   # provider in a Rails application.
   class Railtie < ::Rails::Railtie
     initializer 'postmail_ruby.initialize' do
       ActiveSupport.on_load(:action_mailer) do
         # Register our delivery methods
-        ActionMailer::Base.add_delivery_method :postmail_smtp, Postmail::DeliveryMethod::SMTP
-        ActionMailer::Base.add_delivery_method :postmail_api, Postmail::DeliveryMethod::HTTP
+        ActionMailer::Base.add_delivery_method :postmail_smtp, PostmailRuby::DeliveryMethod::SMTP
+        ActionMailer::Base.add_delivery_method :postmail_api, PostmailRuby::DeliveryMethod::HTTP
 
         # Determine which delivery method to use based on configuration
         delivery_method = Postmail.config.delivery_method
@@ -28,7 +28,7 @@ module PostmailRuby
         # If using SMTP, apply our SMTP settings and optionally
         # clear any default Rails SMTP settings. The
         # disable_default_smtp? flag removes Rails SMTP settings
-        # before applying Postmail settings.
+        # before applying PostmailRuby settings.
         if delivery_method == :smtp
           if PostmailRuby.config.disable_default_smtp?
             # Clear any pre-existing SMTP settings so they do not

data/lib/postmail_ruby/version.rb

@@ -2,5 +2,5 @@
 
 module PostmailRuby
   # Gem version constant
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/postmail_ruby.rb

@@ -3,7 +3,7 @@
 require_relative 'postmail_ruby/version'
 require_relative 'postmail_ruby/configuration'
 
-# Main entry point for the Postmail gem. This module exposes
+# Main entry point for the PostmailRuby gem. This module exposes
 # configuration and helper methods to integrate the gem into a
 # Ruby on Rails application. When loaded in a Rails environment,
 # a Railtie is required automatically to register custom delivery
@@ -15,7 +15,7 @@ module PostmailRuby
     # object reads environment variables to determine how Postmail
     # should behave (API vs SMTP, credentials, endpoints, etc.).
     #
-    # @return [Postmail::Configuration]
+    # @return [PostmailRuby::Configuration]
     attr_accessor :configuration
 
     # Yields the configuration instance to a block so that callers
@@ -24,12 +24,12 @@ module PostmailRuby
     # used to change settings in an initializer.
     #
     # @example Override the API endpoint
-    #   Postmail.configure do |config|
+    #   PostmailRuby.configure do |config|
     #     config.api_endpoint = "https://my-postal.example/api/v1/send/message"
     #   end
     #
-    # @yieldparam [Postmail::Configuration] configuration
-    # @return [Postmail::Configuration]
+    # @yieldparam [PostmailRuby::Configuration] configuration
+    # @return [PostmailRuby::Configuration]
     def configure
       self.configuration ||= Configuration.new
       return configuration unless block_given?
@@ -43,7 +43,7 @@ module PostmailRuby
     # created. This method should be used internally when a
     # configuration is required.
     #
-    # @return [Postmail::Configuration]
+    # @return [PostmailRuby::Configuration]
     def config
       self.configuration ||= Configuration.new
     end
@@ -51,7 +51,7 @@ module PostmailRuby
 end
 
 # Require delivery method classes. These require statements are
-# placed outside of the Postmail module definition so that they
+# placed outside of the PostmailRuby module definition so that they
 # are loaded when the gem is required. They rely on Postmail
 # configuration, so configuration must be loaded first.
 require_relative 'postmail_ruby/delivery_method/http'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmail_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - DAKIN Judicaël
@@ -24,10 +24,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
-description: Postmail is a simple gem that adds custom Action Mailer delivery methods
-  allowing you to send email via either SMTP or an HTTP API. The delivery method and
-  all settings are configurable via environment variables so it can be easily switched
-  at runtime without code changes.
+description: PostmailRuby is a simple gem that adds custom Action Mailer delivery
+  methods allowing you to send email via either SMTP or an HTTP API. The delivery
+  method and all settings are configurable via environment variables so it can be
+  easily switched at runtime without code changes.
 email:
 - d.j.bidossessi@gmail.com
 executables: []