uri-smtp 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ec42fc77da96a4bf7e8766406f110edbbd0de008148a7b62ad64b90137515e
-  data.tar.gz: def1342386b5d4ef7599f09750fd2dea8a709f06c452459c4f174374de4f48de
+  metadata.gz: 457b3741b5ef4678c7f1c6e19574f24d68d5f515ef58c6879f64516c8d472049
+  data.tar.gz: ecd3d5e89df1874095936cd804fd4241feefed5f2e8f6eb0f3015906d1f63cf6
 SHA512:
-  metadata.gz: 1eeb8f2e3f8debbc08271ae35c9a55cadbd2b2d7380a86d174cfa91461012b4986e1e9489c6fde38eedf018d1e5e8601807e6ba23fb6ed1aab3d0a755d82e628
-  data.tar.gz: d450be99efefaa24c20c2c6315a4d7b0a406d9ba043b558e6742a9bbe510670e0b6d076c5a1584ace1270ce650d73b9fd7549d93dd0853365b938b97713affe4
+  metadata.gz: 98b76dad4efd9c9c53f674ef06139844f8845415592bb9927ad90a7d903c62ef388a944779f55987d219035fac120e67247f50251228016db86c346e4d3bc8d3
+  data.tar.gz: 530215f54f3c2e1e1c78d99f476b30c11438136e1313d6abc26e7e830ee885f999c0dc90ce3e4874ac9ca11c7e45c3606a156e236ccf676bba33917b58534e18

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-07-25
+
+- Add: `uri#read_timeout`, `uri#open_timeout`  
+  Coerced integers from query:
+  ```ruby
+  URI("smtp://foo?read_timeout=1").read_timeout #=> 1
+  ```
+  Included in `to_h`.
+- Add: `uri.decoded_userinfo(format: ...)`  
+  `:format` can be one of `[:string :array :hash]`
+- Add: domain can appear in fragment
+  ```ruby
+  URI("smtp://foo.org#sender.org").domain #=> "sender.org"
+  ```
+  NOTE Any domain from the query takes precedence.
+- Fix: "smtps+foo://..." having no tls
+
 ## [0.4.0] - 2025-07-23
 
 - FIX: correct settings for action_mailer using mail v2.8.1
@@ -11,3 +28,4 @@
 ## [0.2.0] - 2025-07-18
 
 - Feature complete
+

data/README.md

@@ -1,6 +1,25 @@
 # URI::SMTP
 
-This library allows for parsing SMTP-URIs.
+Extends Ruby's `URI` with support for SMTP-uri's.  
+This allows for more concise SMTP-config:
+```diff
+# config/environments/production.rb
+config.action_mailer.delivery_method = :smtp
+- config.action_mailer.smtp_settings = {
+-   address:         "smtp.gmail.com",
+-   port:            587,
+-   domain:          "example.com",
+-   user_name:       Rails.application.credentials.dig(:smtp, :user_name),
+-   password:        Rails.application.credentials.dig(:smtp, :password),
+-   authentication:  "plain",
+-   enable_starttls: true,
+-   open_timeout:    5,
+-   read_timeout:    5
+- }
+# given ENV["SMPT_URL"]:
+# "smtp://user_name:password@smtp.gmail.com?open_timeout=5&read_timeout=5#example.com"
++ config.action_mailer.smtp_settings = URI(ENV.fetch("SMTP_URL")).to_h(format: :am)
+```
 
 ## Installation
 
@@ -21,27 +40,29 @@ gem install uri-smtp
 ### parse
 
 ```ruby
-u = URI("smtps+login://user%40gmail.com:p%40ss@smtp.gmail.com?domain=sender.org")
+u = URI("smtps+login://user%40gmail.com:p%40ss@smtp.gmail.com#sender.org")
 
 url.scheme           #=> "smtps+login"
 url.auth             #=> "login"
 url.starttls         #=> false
+url.starttls?        #=> false
 url.tls?             #=> true
 url.userinfo         #=> "user%40gmail.com:p%40ss"
+url.decoded_userinfo #=> ["user@gmail.com", "p@ss"]
 url.decoded_user     #=> "user@gmail.com"
 url.user             #=> "user%40gmail.com"
 url.decoded_password #=> "p@ss"
 url.password         #=> "p%40ss"
 url.host             #=> "smtp.gmail.com"
 url.port             #=> 465
-url.domain           #=> s"ender.org"
-url.query            #=> "domain=sender.org"
+url.domain           #=> "sender.org"
 ```
 
 ### to_h
 
 ```ruby
 URI("smtps+login://user%40gmail.com:p%40ss@smtp.gmail.com?domain=sender.org").to_h
+#=>
 {auth: "login",
  domain: "sender.org",
  host: "smtp.gmail.com",
@@ -56,6 +77,7 @@ URI("smtps+login://user%40gmail.com:p%40ss@smtp.gmail.com?domain=sender.org").to
 Formatting for action_mailer configuration, use `to_h(format: :am)`:
 ```ruby
 URI("smtps+login://user%40gmail.com:p%40ss@smtp.gmail.com?domain=sender.org").to_h(format: :am)
+#=>
 {address: "smtp.gmail.com",
  authentication: "login",
  domain: "sender.org",
@@ -89,7 +111,7 @@ There's no official specification for SMTP-URIs. There's some prior work though.
   SMTP with TLS.
 
 > [!NOTE]
-> to get `url.starttls #=> :auto`, provide it in the query: `smtp://foo?auth=auto`. In that case `net-smtp` uses STARTTLS when the server supports it (but won't halt like when using `:always`).
+> to get `url.starttls #=> :auto`, provide it in the query: `smtp://user:pw@foo?auth=auto`. In that case `net-smtp` uses STARTTLS when the server supports it (but won't halt like when using `:always`).
 
 
 ### auth

data/lib/uri/smtp/version.rb

@@ -4,6 +4,6 @@ require "uri"
 
 module URI
   class SMTP < URI::Generic
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/uri/smtp.rb

@@ -21,6 +21,7 @@ module URI
       return @port if @port
       return 25 if host_local?
       return 465 if tls?
+
       587
     end
 
@@ -30,15 +31,56 @@ module URI
       return parsed_query["auth"] if parsed_query.has_key?("auth")
       return nil if scheme_auth == "none"
       return scheme_auth if scheme_auth
+
       "plain"
     end
 
+    # all formats: return nil when userinfo == nil.
+    #
+    # format: :array
+    # Never contains empty strings (as opposed to [#user, #password]).
+    # Example:
+    # Given #<URI::SMTP smtps://:token@smtp.gmail.com>
+    # Then:
+    # [uri.user, uri.password] #=> ["", "token"]
+    # uri.decoded_userinfo     #=> [nil, "token"]
+    #
+    # format: :hash
+    # Keys are absent when value would be `nil`.
+    # Example:
+    # Given #<URI::SMTP smtps://:token@smtp.gmail.com>
+    # Then:
+    # uri.decoded_userinfo(format: :array) #=> [nil, "token"]
+    # uri.decoded_userinfo(format: :to_h) #=> {password: "token"}
+    def decoded_userinfo(format: :string)
+      return if userinfo.nil?
+
+      case format
+      when :string
+        [decoded_user, decoded_password].compact.join(":")
+      when :array
+        [string_presence(decoded_user), string_presence(decoded_password)]
+      when :hash
+        {
+          user: string_presence(decoded_user),
+          password: string_presence(decoded_password)
+        }.delete_if { |_k, v| v.nil? }
+      else
+        raise ArgumentError,
+          "Unknown format #{format.inspect}. Should be one of #{%i[string array hash].inspect}."
+      end
+    end
+
     def domain
-      parsed_query["domain"]
+      parsed_query["domain"] || fragment
     end
 
-    def scheme_auth
-      scheme[/.*(?:\+(.+))/, 1]
+    def read_timeout
+      parsed_query["read_timeout"]
+    end
+
+    def open_timeout
+      parsed_query["open_timeout"]
     end
 
     def starttls
@@ -46,12 +88,13 @@ module URI
       return parsed_query["starttls"] if parsed_query.has_key?("starttls")
       return false if host_local?
       return false if insecure?
+
       :always
     end
     alias_method :starttls?, :starttls
 
     def tls
-      scheme == "smtps"
+      !!scheme[/^smtps/]
     end
     alias_method :tls?, :tls
 
@@ -64,14 +107,18 @@ module URI
     end
 
     def parsed_query
-      @parsed_query ||= URI.decode_www_form(query.to_s).to_h.tap do
-        _1["starttls"] &&= case _1["starttls"]
-        when "always", "auto" then _1["starttls"].to_sym
-        when "false" then false
-        else
-          :always
+      @parsed_query ||= URI.decode_www_form(query.to_s).to_h
+        .delete_if { |_k, v| !string_presence(v) }
+        .tap do
+          _1["read_timeout"] &&= _1["read_timeout"].to_i
+          _1["open_timeout"] &&= _1["open_timeout"].to_i
+          _1["starttls"] &&= case _1["starttls"]
+          when "always", "auto" then _1["starttls"].to_sym
+          when "false" then false
+          else
+            :always
+          end
         end
-      end
     end
 
     def to_h(format: nil)
@@ -83,7 +130,9 @@ module URI
           domain:,
           enable_starttls: starttls == :always,
           enable_starttls_auto: starttls == :auto,
+          open_timeout:,
           port:,
+          read_timeout:,
           tls:
         }.tap do
           unless _1[:authentication].nil?
@@ -104,7 +153,9 @@ module URI
           auth:,
           domain:,
           host:,
+          open_timeout:,
           port:,
+          read_timeout:,
           scheme:,
           starttls:,
           tls:
@@ -120,6 +171,16 @@ module URI
     def self.parse(uri)
       new(*URI.split(uri))
     end
+
+    private
+
+    def scheme_auth
+      scheme[/.*(?:\+(.+))/, 1]
+    end
+
+    def string_presence(s)
+      s.to_s.strip.then { _1 unless _1.empty? }
+    end
   end
 
   register_scheme "SMTP", SMTP

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uri-smtp
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Gert Goet