midi-smtp-server 3.2.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2376ca7f3510ebe230523b2fd5629dc39a5c44f3415ce3980d1e27d156ac3397
-  data.tar.gz: eaeb5ae1fe8dd868b772d9dfa267665e2b0e8b6f63c4761cab2d861cac412499
+  metadata.gz: 7acc07aa094d1a272f39cd92b1609d9d9eb75447cb188d44abcdd3b36b4be8f9
+  data.tar.gz: 1338e9d41425eeb539a9ff873bb72fd81aa8ac28143a5bfec4a37c0937e29674
 SHA512:
-  metadata.gz: da5d3c16c081cd3c34be74d1f745bcc015e5c1fa9bbcdf6d55552e1e2c30df831ad63c025c86e4ffda078dc37b1c7bcf16d14fe512dbb91bbabb54dd9b2ca944
-  data.tar.gz: acbdac6c519f20758e9af7922094032ce3d3bc67e4874d8b37bac283e408ca303cd3fc47ae51b360e3ef9d1bfddc68bc620f5a105e4a68ca4a3d0ca3fef73ef6
+  metadata.gz: e59c85758a6ba6e2a78bb82b64b79a08b57b8fb309b15206ed9221b7ebfc127629a4dc470b93b74f4f8c0f99da58602d63d7f618aef1589d427c1426484fee13
+  data.tar.gz: 13cbeef718a3c8a204ab7bc67b855d97525d5c2b8f86bf8909e956f66b635e078c7c4f12fe09ca4a74b7cd1fd81ba31112aedc2ee8bbd7c83ef07d803ccaafae

data/CHANGELOG.md

@@ -5,6 +5,15 @@ We suggest everybody using MidiSmtpServer to switch at least to latest 2.3.y. or
 For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may follow the guides at [Appendix Upgrade](https://midi-smtp-server.readthedocs.io/appendix_upgrade/) to get your code ready for the latest releases.
 
 
+#### 3.3.2 (2026-09-16)
+
+1. Updates and fixes for Ruby versions 3.3, 3.4 and 4.0
+2. New feature and optimization for [IO wait](https://midi-smtp-server.readthedocs.io/feature_load_balancing) by event mode
+3. Deprecate `io_waitreadable_sleep` in favor of `io_wait_mode` and `io_wait_available`
+4. Test fixes for newer Ruby (3.3+) and OS-specific socket behaviour
+5. mkdocs update for readthedocs
+
+
 #### 3.2.1 (2023-08-15)
 
 1. New feature [proxy](https://midi-smtp-server.readthedocs.io/feature_proxy) ([check issue 49](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/49))

data/README.md

@@ -92,7 +92,7 @@ Use the component in your project sources by:
 
 When a `Gemfile` handles your dependencies, please consider to use the [pessimistic operator](https://thoughtbot.com/blog/rubys-pessimistic-operator) at least:
 
-  `gem 'midi-smtp-server', '~> 3.1.2''`
+  `gem 'midi-smtp-server', '~> 3.3.2''`
 
 All changes by PATCH versions are always functional and compatible with no issues on update!
 
@@ -159,10 +159,13 @@ We suggest everybody using MidiSmtpServer to switch at least to latest 2.3.y. or
 For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may follow the guides (see appendix) how to change your existing code to be compatible with the latest releases.
 
 
-#### Latest release: 3.2.1 (2023-08-15)
+#### Latest release: 3.3.2 (2026-09-16)
 
-1. New feature [proxy](https://midi-smtp-server.readthedocs.io/feature_proxy) ([check issue 49](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/49))
-2. mkdocs update for readthedocs
+1. Updates and fixes for Ruby versions 3.3, 3.4 and 4.0
+2. New feature and optimization for [IO wait](https://midi-smtp-server.readthedocs.io/feature_load_balancing) by event mode
+3. Deprecate `io_waitreadable_sleep` in favor of `io_wait_mode` and `io_wait_available`
+4. Test fixes for newer Ruby (3.3+) and OS-specific socket behaviour
+5. mkdocs update for readthedocs
 
 
 #### Changelog history
@@ -205,4 +208,4 @@ Author: [Tom Freudenberg](http://about.me/tom.freudenberg)
 
 [MidiSmtpServer Class](https://github.com/4commerce-technologies-AG/midi-smtp-server/) is inspired from [MiniSmtpServer Class](https://github.com/aarongough/mini-smtp-server) and code written by [Aaron Gough](https://github.com/aarongough) and [Peter Cooper](https://github.com/4commerce-technologies-AG/midi-smtp-server#author--credits)
 
-Copyright (c) 2014-2023 [Tom Freudenberg](https://github.com/TomFreudenberg), [4commerce technologies AG](https://www.4commerce.de/), released under the MIT license
+Copyright (c) 2014-2026 [Tom Freudenberg](https://github.com/TomFreudenberg), [4commerce technologies AG](https://www.4commerce.de/), released under the MIT license

data/lib/midi-smtp-server/exceptions.rb

@@ -38,7 +38,7 @@ module MidiSmtpServer
       @smtpd_return_code = smtpd_return_code
       @smtpd_return_text = smtpd_return_text
       # call inherited constructor
-      super msg
+      super(msg)
     end
 
     def smtpd_result
@@ -52,7 +52,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 421, 'Service too busy or not available, closing transmission channel'
+      super(msg, 421, 'Service too busy or not available, closing transmission channel')
     end
 
   end
@@ -63,7 +63,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 450, 'Requested mail action not taken: mailbox unavailable'
+      super(msg, 450, 'Requested mail action not taken: mailbox unavailable')
     end
 
   end
@@ -73,7 +73,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 451, 'Requested action aborted: local error in processing'
+      super(msg, 451, 'Requested action aborted: local error in processing')
     end
 
   end
@@ -83,7 +83,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 452, 'Requested action not taken: insufficient system storage'
+      super(msg, 452, 'Requested action not taken: insufficient system storage')
     end
 
   end
@@ -94,7 +94,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 500, 'Syntax error, command unrecognised or error in parameters or arguments'
+      super(msg, 500, 'Syntax error, command unrecognised or error in parameters or arguments')
     end
 
   end
@@ -104,7 +104,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 501, 'Syntax error in parameters or arguments'
+      super(msg, 501, 'Syntax error in parameters or arguments')
     end
 
   end
@@ -114,7 +114,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 502, 'Command not implemented'
+      super(msg, 502, 'Command not implemented')
     end
 
   end
@@ -124,7 +124,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 503, 'Bad sequence of commands'
+      super(msg, 503, 'Bad sequence of commands')
     end
 
   end
@@ -134,7 +134,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 504, 'Command parameter not implemented'
+      super(msg, 504, 'Command parameter not implemented')
     end
 
   end
@@ -144,7 +144,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 521, 'Service does not accept mail'
+      super(msg, 521, 'Service does not accept mail')
     end
 
   end
@@ -155,7 +155,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 550, 'Requested action not taken: mailbox unavailable'
+      super(msg, 550, 'Requested action not taken: mailbox unavailable')
     end
 
   end
@@ -165,7 +165,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 552, 'Requested mail action aborted: exceeded storage allocation'
+      super(msg, 552, 'Requested mail action aborted: exceeded storage allocation')
     end
 
   end
@@ -175,7 +175,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 553, 'Requested action not taken: mailbox name not allowed'
+      super(msg, 553, 'Requested action not taken: mailbox name not allowed')
     end
 
   end
@@ -185,7 +185,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 554, 'Transaction failed'
+      super(msg, 554, 'Transaction failed')
     end
 
   end
@@ -197,7 +197,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 432, 'Password transition is needed'
+      super(msg, 432, 'Password transition is needed')
     end
 
   end
@@ -207,7 +207,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 454, 'Temporary authentication failure'
+      super(msg, 454, 'Temporary authentication failure')
     end
 
   end
@@ -217,7 +217,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 530, 'Authentication required'
+      super(msg, 530, 'Authentication required')
     end
 
   end
@@ -227,7 +227,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 534, 'Authentication mechanism is too weak'
+      super(msg, 534, 'Authentication mechanism is too weak')
     end
 
   end
@@ -237,7 +237,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 535, 'Authentication credentials invalid'
+      super(msg, 535, 'Authentication credentials invalid')
     end
 
   end
@@ -247,7 +247,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 538, 'Encryption required for requested authentication mechanism'
+      super(msg, 538, 'Encryption required for requested authentication mechanism')
     end
 
   end
@@ -259,7 +259,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 454, 'TLS not available'
+      super(msg, 454, 'TLS not available')
     end
 
   end
@@ -269,7 +269,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 530, 'Encryption required, must issue STARTTLS command first'
+      super(msg, 530, 'Encryption required, must issue STARTTLS command first')
     end
 
   end
@@ -281,7 +281,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 500, 'Bad input, PIPELINING is not allowed'
+      super(msg, 500, 'Bad input, PIPELINING is not allowed')
     end
 
   end
@@ -293,7 +293,7 @@ module MidiSmtpServer
 
     def initialize(msg = nil)
       # call inherited constructor
-      super msg, 500, 'Bad input, Lines must be terminated by CRLF sequence'
+      super(msg, 500, 'Bad input, Lines must be terminated by CRLF sequence')
     end
 
   end

data/lib/midi-smtp-server/tls-transport.rb

@@ -75,7 +75,7 @@ module MidiSmtpServer
         # try to load certificate and key
         cert_lines = File.read(@cert_path.to_s).lines
         # check if the cert file contains a chain of certs
-        cert_indexes = cert_lines.each_with_index.map { |line, index| index if line.downcase.include?('-begin certificate-') }.compact
+        cert_indexes = cert_lines.each_with_index.filter_map { |line, index| index if line.downcase.include?('-begin certificate-') }
         # create each cert in the chain
         certs = []
         cert_indexes.each_with_index do |cert_index, current_index|

data/lib/midi-smtp-server/version.rb

@@ -6,12 +6,12 @@ module MidiSmtpServer
   module VERSION
 
     MAJOR = 3
-    MINOR = 2
-    TINY = 1
+    MINOR = 3
+    TINY = 2
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')
 
-    DATE = '2023-08-15'
+    DATE = '2026-09-16'
 
   end
 

data/lib/midi-smtp-server.rb

@@ -2,6 +2,7 @@
 
 require 'logger'
 require 'socket'
+require 'io/wait'
 require 'resolv'
 require 'base64'
 
@@ -27,7 +28,9 @@ module MidiSmtpServer
   DEFAULT_CRLF_MODE = :CRLF_ENSURE
 
   # default values for IO operations
-  DEFAULT_IO_WAITREADABLE_SLEEP = 0.1
+  IO_WAIT_MODES = [:IO_WAIT_SLEEP, :IO_WAIT_EVENT].freeze
+  DEFAULT_IO_WAIT_MODE = :IO_WAIT_EVENT
+  DEFAULT_IO_WAIT_AVAILABLE = 0.1
   DEFAULT_IO_CMD_TIMEOUT = 30
   DEFAULT_IO_BUFFER_CHUNK_SIZE = 4 * 1024
   DEFAULT_IO_BUFFER_MAX_SIZE = 1 * 1024 * 1024
@@ -197,8 +200,10 @@ module MidiSmtpServer
     attr_reader :max_connections
     # CRLF handling based on conformity to RFC(2)822
     attr_reader :crlf_mode
-    # Time in seconds to sleep on IO::WaitReadable exception
-    attr_reader :io_waitreadable_sleep
+    # how to wait on IO::WaitReadable exception
+    attr_reader :io_wait_mode
+    # Time in fraction of a second to wait on IO::WaitReadable exception
+    attr_reader :io_wait_available
     # Maximum time in seconds to wait for a complete incoming data line, as a FixNum
     attr_reader :io_cmd_timeout
     # Bytes to read non-blocking from socket into buffer, as a FixNum
@@ -230,7 +235,8 @@ module MidiSmtpServer
     # +max_connections+:: maximum number of connections, this does limit the number of concurrent TCP connections (not set or nil => unlimited)
     # +crlf_mode+:: CRLF handling support (:CRLF_ENSURE [default], :CRLF_LEAVE, :CRLF_STRICT)
     # +do_dns_reverse_lookup+:: flag if this smtp server should do reverse DNS lookups on incoming connections
-    # +io_waitreadable_sleep+:: seconds to sleep in loop when no input data is available (DEFAULT_IO_WAITREADABLE_SLEEP)
+    # +io_wait_mode+:: how to wait when no input data is available (DEFAULT_IO_WAIT_MODE)
+    # +io_wait_available+:: fraction of a second to wait in loop when no input data is available (DEFAULT_IO_WAIT_AVAILABLE)
     # +io_cmd_timeout+:: time in seconds to wait until complete line of data is expected (DEFAULT_IO_CMD_TIMEOUT, nil => disabled test)
     # +io_buffer_chunk_size+:: size of chunks (bytes) to read non-blocking from socket (DEFAULT_IO_BUFFER_CHUNK_SIZE)
     # +io_buffer_max_size+:: max size of buffer (max line length) until \lf ist expected (DEFAULT_IO_BUFFER_MAX_SIZE, nil => disabled test)
@@ -255,7 +261,9 @@ module MidiSmtpServer
       max_connections: nil,
       crlf_mode: nil,
       do_dns_reverse_lookup: nil,
-      io_waitreadable_sleep: nil,
+      io_wait_mode: nil,
+      io_wait_available: nil,
+      io_waitreadable_sleep: nil, # deprecated, but for compatibility
       io_cmd_timeout: nil,
       io_buffer_chunk_size: nil,
       io_buffer_max_size: nil,
@@ -343,7 +351,7 @@ module MidiSmtpServer
             # test for all local valid ipv4 and ipv6 ip_addresses
             # check question on stackoverflow for details
             # https://stackoverflow.com/questions/59770803/identify-all-relevant-ip-addresses-from-ruby-socket-ip-address-list
-            ip_addresses_for_host << a.ip_address if \
+            ip_addresses_for_host << a.ip_address if
               (a.ipv4? &&
                 (a.ipv4_loopback? || a.ipv4_private? ||
                  !(a.ipv4_loopback? || a.ipv4_private? || a.ipv4_multicast?)
@@ -391,10 +399,21 @@ module MidiSmtpServer
       # always prevent auto resolving hostnames to prevent a delay on socket connect
       BasicSocket.do_not_reverse_lookup = true
       # do reverse lookups manually if enabled by io.addr and io.peeraddr
+      # rubocop: disable-next Style/RedundantCondition
       @do_dns_reverse_lookup = do_dns_reverse_lookup.nil? ? true : do_dns_reverse_lookup
 
+      # deprecated compatibility
+      raise 'Not allowed to use io_wait_available and deprecated io_waitreadable_sleep at the same time!' unless io_waitreadable_sleep.nil? || io_wait_available.nil?
+      unless io_waitreadable_sleep.nil?
+        io_wait_available = io_waitreadable_sleep
+        io_wait_mode = :IO_WAIT_SLEEP
+        @logger_protected.warn('Deprecated: "io_waitreadable_sleep" was replaced! Please use "io_wait_available" and "io_wait_mode" instead.')
+      end
       # io and buffer settings
-      @io_waitreadable_sleep = io_waitreadable_sleep.nil? ? DEFAULT_IO_WAITREADABLE_SLEEP : io_waitreadable_sleep
+      @io_wait_mode = io_wait_mode.nil? ? DEFAULT_IO_WAIT_MODE : io_wait_mode
+      raise "Unknown io wait mode #{@io_wait_mode} was given!" unless IO_WAIT_MODES.include?(@io_wait_mode)
+      @io_wait_available = io_wait_available.nil? ? DEFAULT_IO_WAIT_AVAILABLE : io_wait_available
+      raise 'Value of time must be positive (io_wait_available)' unless @io_wait_available.positive?
       @io_cmd_timeout = io_cmd_timeout.nil? ? DEFAULT_IO_CMD_TIMEOUT : io_cmd_timeout
       @io_buffer_chunk_size = io_buffer_chunk_size.nil? ? DEFAULT_IO_BUFFER_CHUNK_SIZE : io_buffer_chunk_size
       @io_buffer_max_size = io_buffer_max_size.nil? ? DEFAULT_IO_BUFFER_MAX_SIZE : io_buffer_max_size
@@ -769,10 +788,25 @@ module MidiSmtpServer
                 io_buffer_line_lf = io_buffer.index("\n")
               end
 
-            # ignore exception when no input data is available yet
+            # handle no input data is available yet
             rescue IO::WaitReadable
-              # but wait a few moment to slow down system utilization
-              sleep @io_waitreadable_sleep
+              if @io_wait_mode == :IO_WAIT_SLEEP
+                # reduce the processing speed and thereby the system
+                # utilization by sleeping the configured time
+                sleep @io_wait_available
+              else
+                # block on the underlying socket until new data has arrived,
+                # but wake up at least after wait time so that the loop
+                # keeps checking shutdown? and io_cmd_timeout
+                # (io.to_io resolves the plain socket behind an
+                # OpenSSL::SSL::SSLSocket, otherwise wait_readable is not defined
+                io.to_io.wait_readable(@io_wait_available)
+              end
+
+            # during TLS (re)negotiation a read may require the socket
+            # to become writable first. this always waits by event
+            rescue IO::WaitWritable
+              io.to_io.wait_writable(@io_wait_available)
             end
 
             # check if io_buffer is filled and contains already a line-feed
@@ -946,8 +980,8 @@ module MidiSmtpServer
             # check whether to answer as HELO or EHLO
             case line
               when (/^EHLO/i)
-                # rubocop:disable Style/StringConcatenation
                 # reply supported extensions
+                # rubocop: disable-next Style/StringConcatenation
                 return "250-#{session[:ctx][:server][:helo_response].to_s.strip}\r\n" +
                        # respond with 8BITMIME extension
                        (@internationalization_extensions ? "250-8BITMIME\r\n" : '') +
@@ -960,7 +994,6 @@ module MidiSmtpServer
                        # respond with STARTTLS if available and not already enabled
                        (@encrypt_mode == :TLS_FORBIDDEN || encrypted?(session[:ctx]) ? '' : "250-STARTTLS\r\n") +
                        '250 OK'
-                # rubocop:enable all
               else
                 # reply ok only
                 return "250 OK #{session[:ctx][:server][:helo_response].to_s.strip}".strip
@@ -1302,7 +1335,7 @@ module MidiSmtpServer
         # If we are in date mode then ...
 
         # call event to signal beginning of message data transfer
-        on_message_data_start_event(session[:ctx]) unless session[:ctx][:message][:data][0]
+        on_message_data_start_event(session[:ctx]) if session[:ctx][:message][:data].empty?
 
         # ... and the entire new message data (line) does NOT consists
         # solely of a period (.) on a line by itself then we are being

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: midi-smtp-server
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.2
 platform: ruby
 authors:
 - Tom Freudenberg
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
-dependencies: []
+date: 2026-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: MidiSmtpServer is the highly customizable ruby SMTP-Server and SMTP-Service
   library with builtin support for AUTH and SSL/STARTTLS, 8BITMIME and SMTPUTF8, IPv4
   and IPv6 and additional features.
@@ -34,9 +61,9 @@ metadata:
   source_code_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server
   changelog_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server#changes-and-updates
   bug_tracker_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server/issues
-  documentation_uri: https://www.rubydoc.info/gems/midi-smtp-server/3.2.1
+  documentation_uri: https://www.rubydoc.info/gems/midi-smtp-server/3.3.2
   wiki_uri: https://midi-smtp-server.readthedocs.io/
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -44,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: MidiSmtpServer Class
 test_files: []