net-imap 0.4.21 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab1b84ea6eac7b0d57793127bc365c79b63eb9564386427eb66cca91cf5df294
-  data.tar.gz: 3040f462d83f7a364fed076a730d5a9ba0512ea52ab0368765befb0e2d700dd4
+  metadata.gz: 2c89d97e842bce303df112c3fbc0f048f20a2ff1dbf3b85bb2314ea0d2e207c5
+  data.tar.gz: 11d6ec196e1e768f61a17b0ce7f385a11eb03e3e92af8ab327ba9a90699ee940
 SHA512:
-  metadata.gz: a7565d3002323cdaad204bbd5eceb0b64d265e61daa41d9e3c61b8ea12ff3bbbb5f5e62298138f48a96c32553b1fcf3c6dcab7cae5776a22a521abe77b6e153c
-  data.tar.gz: 73b9338a55d33e703c86217ee80ee7486e92dbf67b232c152d4115a89a76c4f384c39e34888d24ec8cf389af1d67ca1d1d84e3edc676ecc501495cf6b66d7dfe
+  metadata.gz: ca70e20c3c70f4ca57822f70936546adb3129dd7c0771ef2d054b0356ed4f6a994b7453803cc06bd25ebb37dc0ed10f60b5541bc56749dee38a6126264344599
+  data.tar.gz: 2921a79dbdab7bd0476d883c18db50150388d587c711270faac99ad4505574a23e6532fe61a4fb48f51c8bddea6641d96f81d9dcbe245b4d4f4542fcc7418566

data/Gemfile

@@ -13,4 +13,10 @@ gem "rdoc"
 gem "test-unit"
 gem "test-unit-ruby-core", git: "https://github.com/ruby/test-unit-ruby-core"
 
-gem "benchmark-driver"
+gem "benchmark-driver", require: false
+
+group :test do
+  gem "simplecov",        require: false
+  gem "simplecov-html",   require: false
+  gem "simplecov-json",   require: false
+end

data/lib/net/imap/authenticators.rb

@@ -9,7 +9,7 @@ module Net::IMAP::Authenticators
       "%s.%s is deprecated.  Use %s.%s instead." % [
         Net::IMAP, __method__, Net::IMAP::SASL, __method__
       ],
-      uplevel: 1
+      uplevel: 1, category: :deprecated
     )
     Net::IMAP::SASL.add_authenticator(...)
   end
@@ -20,7 +20,7 @@ module Net::IMAP::Authenticators
       "%s.%s is deprecated.  Use %s.%s instead." % [
         Net::IMAP, __method__, Net::IMAP::SASL, __method__
       ],
-      uplevel: 1
+      uplevel: 1, category: :deprecated
     )
     Net::IMAP::SASL.authenticator(...)
   end

data/lib/net/imap/command_data.rb

@@ -179,6 +179,7 @@ module Net
       end
     end
 
+    # *DEPRECATED*.  Replaced by SequenceSet.
     class MessageSet # :nodoc:
       def send_data(imap, tag)
         imap.__send__(:put_string, format_internal(@data))
@@ -192,6 +193,16 @@ module Net
 
       def initialize(data)
         @data = data
+        warn("DEPRECATED: #{MessageSet} should be replaced with #{SequenceSet}.",
+             uplevel: 1, category: :deprecated)
+        begin
+          # to ensure the input works with SequenceSet, too
+          SequenceSet.new(data)
+        rescue
+          warn "MessageSet input is incompatible with SequenceSet: [%s] %s" % [
+            $!.class, $!.message
+          ]
+        end
       end
 
       def format_internal(data)

data/lib/net/imap/config/attr_type_coercion.rb

@@ -18,8 +18,6 @@ module Net
             super(attr)
             AttrTypeCoercion.attr_accessor(attr, type: type)
           end
-
-          module_function def Integer?; NilOrInteger end
         end
         private_constant :Macros
 
@@ -28,36 +26,34 @@ module Net
         end
         private_class_method :included
 
-        if defined?(Ractor.make_shareable)
-          def self.safe(...) Ractor.make_shareable nil.instance_eval(...).freeze end
-        else
-          def self.safe(...) nil.instance_eval(...).freeze end
+        def self.attr_accessor(attr, type: nil)
+          return unless type
+          if    :boolean == type then boolean attr
+          elsif Integer  == type then integer attr
+          elsif Array   === type then enum    attr, type
+          else raise ArgumentError, "unknown type coercion %p" % [type]
+          end
         end
-        private_class_method :safe
 
-        Types = Hash.new do |h, type|
-          type.nil? || Proc === type or raise TypeError, "type not nil or Proc"
-          safe{type}
+        def self.boolean(attr)
+          define_method :"#{attr}=" do |val| super !!val end
+          define_method :"#{attr}?" do send attr end
         end
-        Types[:boolean] = Boolean = safe{-> {!!_1}}
-        Types[Integer]  = safe{->{Integer(_1)}}
 
-        def self.attr_accessor(attr, type: nil)
-          type = Types[type] or return
-          define_method :"#{attr}=" do |val| super type[val] end
-          define_method :"#{attr}?" do send attr end if type == Boolean
+        def self.integer(attr)
+          define_method :"#{attr}=" do |val| super Integer val end
         end
 
-        NilOrInteger = safe{->val { Integer val unless val.nil? }}
-
-        Enum = ->(*enum) {
-          enum     = safe{enum}
+        def self.enum(attr, enum)
+          enum = enum.dup.freeze
           expected = -"one of #{enum.map(&:inspect).join(", ")}"
-          safe{->val {
-            return val if enum.include?(val)
-            raise ArgumentError, "expected %s, got %p" % [expected, val]
-          }}
-        }
+          define_method :"#{attr}=" do |val|
+            unless enum.include?(val)
+              raise ArgumentError, "expected %s, got %p" % [expected, val]
+            end
+            super val
+          end
+        end
 
       end
     end

data/lib/net/imap/config.rb

@@ -129,25 +129,8 @@ module Net
       def self.global; @global if defined?(@global) end
 
       # A hash of hard-coded configurations, indexed by version number or name.
-      # Values can be accessed with any object that responds to +to_sym+ or
-      # +to_r+/+to_f+ with a non-zero number.
-      #
-      # Config::[] gets named or numbered versions from this hash.
-      #
-      # For example:
-      #     Net::IMAP::Config.version_defaults[0.5] == Net::IMAP::Config[0.5]
-      #     Net::IMAP::Config[0.5]       == Net::IMAP::Config[0.5r]     # => true
-      #     Net::IMAP::Config["current"] == Net::IMAP::Config[:current] # => true
-      #     Net::IMAP::Config["0.5.6"]   == Net::IMAP::Config[0.5r]     # => true
       def self.version_defaults; @version_defaults end
-      @version_defaults = Hash.new {|h, k|
-        # NOTE: String responds to both so the order is significant.
-        # And ignore non-numeric conversion to zero, because: "wat!?".to_r == 0
-        (h.fetch(k.to_r, nil) || h.fetch(k.to_f, nil) if k.is_a?(Numeric)) ||
-          (h.fetch(k.to_sym, nil) if k.respond_to?(:to_sym)) ||
-          (h.fetch(k.to_r,   nil) if k.respond_to?(:to_r) && k.to_r != 0r) ||
-          (h.fetch(k.to_f,   nil) if k.respond_to?(:to_f) && k.to_f != 0.0)
-      }
+      @version_defaults = {}
 
       # :call-seq:
       #  Net::IMAP::Config[number] -> versioned config
@@ -170,17 +153,18 @@ module Net
         elsif config.nil? && global.nil?   then nil
         elsif config.respond_to?(:to_hash) then new(global, **config).freeze
         else
-          version_defaults[config] or
+          version_defaults.fetch(config) do
             case config
             when Numeric
               raise RangeError, "unknown config version: %p" % [config]
-            when String, Symbol
+            when Symbol
               raise KeyError, "unknown config name: %p" % [config]
             else
               raise TypeError, "no implicit conversion of %s to %s" % [
                 config.class, Config
               ]
             end
+          end
         end
       end
 
@@ -207,13 +191,10 @@ module Net
 
       # Seconds to wait until a connection is opened.
       #
-      # Applied separately for establishing TCP connection and starting a TLS
-      # connection.
-      #
       # If the IMAP object cannot open a connection within this time,
       # it raises a Net::OpenTimeout exception.
       #
-      # See Net::IMAP.new and Net::IMAP#starttls.
+      # See Net::IMAP.new.
       #
       # The default value is +30+ seconds.
       attr_accessor :open_timeout, type: Integer
@@ -242,40 +223,29 @@ module Net
       #   Use +SASL-IR+ when it is supported by the server and the mechanism.
       attr_accessor :sasl_ir, type: :boolean
 
-      # The maximum allowed server response size.  When +nil+, there is no limit
-      # on response size.
+      # Controls the behavior of Net::IMAP#login when the +LOGINDISABLED+
+      # capability is present.  When enforced, Net::IMAP will raise a
+      # LoginDisabledError when that capability is present.
       #
-      # The default value (512 MiB, since +v0.5.7+) is <em>very high</em> and
-      # unlikely to be reached.  To use a lower limit, fetch message bodies in
-      # chunks rather than all at once.  A _much_ lower value should be used
-      # with untrusted servers (for example, when connecting to a user-provided
-      # hostname).
+      # <em>(Support for +LOGINDISABLED+ was added in +v0.5.0+.)</em>
       #
-      # <em>Please Note:</em> this only limits the size per response.  It does
-      # not prevent a flood of individual responses and it does not limit how
-      # many unhandled responses may be stored on the responses hash.  See
-      # Net::IMAP@Unbounded+memory+use.
-      #
-      # Socket reads are limited to the maximum remaining bytes for the current
-      # response: max_response_size minus the bytes that have already been read.
-      # When the limit is reached, or reading a +literal+ _would_ go over the
-      # limit, ResponseTooLargeError is raised and the connection is closed.
-      # See also #socket_read_limit.
+      # ==== Valid options
       #
-      # Note that changes will not take effect immediately, because the receiver
-      # thread may already be waiting for the next response using the previous
-      # value.  Net::IMAP#noop can force a response and enforce the new setting
-      # immediately.
+      # [+false+ <em>(original behavior, before support was added)</em>]
+      #   Send the +LOGIN+ command without checking for +LOGINDISABLED+.
       #
-      # ==== Versioned Defaults
+      # [+:when_capabilities_cached+]
+      #   Enforce the requirement when Net::IMAP#capabilities_cached? is true,
+      #   but do not send a +CAPABILITY+ command to discover the capabilities.
       #
-      # Net::IMAP#max_response_size <em>was added in +v0.2.5+ and +v0.3.9+ as an
-      # attr_accessor, and in +v0.4.20+ and +v0.5.7+ as a delegator to this
-      # config attribute.</em>
+      # [+true+ <em>(default since +v0.5+)</em>]
+      #   Only send the +LOGIN+ command if the +LOGINDISABLED+ capability is not
+      #   present.  When capabilities are unknown, Net::IMAP will automatically
+      #   send a +CAPABILITY+ command first before sending +LOGIN+.
       #
-      # * original: +nil+ <em>(no limit)</em>
-      # * +0.5+: 512 MiB
-      attr_accessor :max_response_size, type: Integer?
+      attr_accessor :enforce_logindisabled, type: [
+        false, :when_capabilities_cached, true
+      ]
 
       # Controls the behavior of Net::IMAP#responses when called without any
       # arguments (+type+ or +block+).
@@ -303,7 +273,7 @@ module Net
       #   Raise an ArgumentError with the deprecation warning.
       #
       # Note: #responses_without_args is an alias for #responses_without_block.
-      attr_accessor :responses_without_block, type: Enum[
+      attr_accessor :responses_without_block, type: [
         :silence_deprecation_warning, :warn, :frozen_dup, :raise,
       ]
 
@@ -315,67 +285,6 @@ module Net
       #
       # Alias for responses_without_block
 
-      # Whether ResponseParser should use the deprecated UIDPlusData or
-      # CopyUIDData for +COPYUID+ response codes, and UIDPlusData or
-      # AppendUIDData for +APPENDUID+ response codes.
-      #
-      # UIDPlusData stores its data in arrays of numbers, which is vulnerable to
-      # a memory exhaustion denial of service attack from an untrusted or
-      # compromised server.  Set this option to +false+ to completely block this
-      # vulnerability.  Otherwise, parser_max_deprecated_uidplus_data_size
-      # mitigates this vulnerability.
-      #
-      # AppendUIDData and CopyUIDData are _mostly_ backward-compatible with
-      # UIDPlusData.  Most applications should be able to upgrade with little
-      # or no changes.
-      #
-      # <em>(Parser support for +UIDPLUS+ added in +v0.3.2+.)</em>
-      #
-      # <em>(Config option added in +v0.4.19+ and +v0.5.6+.)</em>
-      #
-      # <em>UIDPlusData will be removed in +v0.6+ and this config setting will
-      # be ignored.</em>
-      #
-      # ==== Valid options
-      #
-      # [+true+ <em>(original default)</em>]
-      #    ResponseParser only uses UIDPlusData.
-      #
-      # [+:up_to_max_size+ <em>(default since +v0.5.6+)</em>]
-      #    ResponseParser uses UIDPlusData when the +uid-set+ size is below
-      #    parser_max_deprecated_uidplus_data_size.  Above that size,
-      #    ResponseParser uses AppendUIDData or CopyUIDData.
-      #
-      # [+false+ <em>(planned default for +v0.6+)</em>]
-      #    ResponseParser _only_ uses AppendUIDData and CopyUIDData.
-      attr_accessor :parser_use_deprecated_uidplus_data, type: Enum[
-        true, :up_to_max_size, false
-      ]
-
-      # The maximum +uid-set+ size that ResponseParser will parse into
-      # deprecated UIDPlusData.  This limit only applies when
-      # parser_use_deprecated_uidplus_data is not +false+.
-      #
-      # <em>(Parser support for +UIDPLUS+ added in +v0.3.2+.)</em>
-      #
-      # <em>Support for limiting UIDPlusData to a maximum size was added in
-      # +v0.3.8+, +v0.4.19+, and +v0.5.6+.</em>
-      #
-      # <em>UIDPlusData will be removed in +v0.6+.</em>
-      #
-      # ==== Versioned Defaults
-      #
-      # Because this limit guards against a remote server causing catastrophic
-      # memory exhaustion, the versioned default (used by #load_defaults) also
-      # applies to versions without the feature.
-      #
-      # * +0.3+ and prior: <tt>10,000</tt>
-      # * +0.4+: <tt>1,000</tt>
-      # * +0.5+: <tt>100</tt>
-      # * +0.6+: <tt>0</tt>
-      #
-      attr_accessor :parser_max_deprecated_uidplus_data_size, type: Integer
-
       # Creates a new config object and initialize its attribute with +attrs+.
       #
       # If +parent+ is not given, the global config is used by default.
@@ -454,71 +363,38 @@ module Net
         open_timeout: 30,
         idle_response_timeout: 5,
         sasl_ir: true,
-        max_response_size: nil,
-        responses_without_block: :silence_deprecation_warning,
-        parser_use_deprecated_uidplus_data: true,
-        parser_max_deprecated_uidplus_data_size: 1000,
+        enforce_logindisabled: true,
+        responses_without_block: :warn,
       ).freeze
 
       @global = default.new
 
       version_defaults[:default] = Config[default.send(:defaults_hash)]
+      version_defaults[:current] = Config[:default]
 
-      version_defaults[0r] = Config[:default].dup.update(
+      version_defaults[0] = Config[:current].dup.update(
         sasl_ir: false,
-        max_response_size: nil,
-        parser_use_deprecated_uidplus_data: true,
-        parser_max_deprecated_uidplus_data_size: 10_000,
+        responses_without_block: :silence_deprecation_warning,
+        enforce_logindisabled: false,
       ).freeze
-      version_defaults[0.0r] = Config[0r]
-      version_defaults[0.1r] = Config[0r]
-      version_defaults[0.2r] = Config[0r]
-      version_defaults[0.3r] = Config[0r]
+      version_defaults[0.0] = Config[0]
+      version_defaults[0.1] = Config[0]
+      version_defaults[0.2] = Config[0]
+      version_defaults[0.3] = Config[0]
 
-      version_defaults[0.4r] = Config[0.3r].dup.update(
+      version_defaults[0.4] = Config[0.3].dup.update(
         sasl_ir: true,
-        parser_max_deprecated_uidplus_data_size: 1000,
       ).freeze
 
-      version_defaults[0.5r] = Config[0.4r].dup.update(
-        max_response_size: 512 << 20, # 512 MiB
-        responses_without_block: :warn,
-        parser_use_deprecated_uidplus_data: :up_to_max_size,
-        parser_max_deprecated_uidplus_data_size: 100,
-      ).freeze
+      version_defaults[0.5] = Config[:current]
 
-      version_defaults[0.6r] = Config[0.5r].dup.update(
+      version_defaults[0.6] = Config[0.5].dup.update(
         responses_without_block: :frozen_dup,
-        parser_use_deprecated_uidplus_data: false,
-        parser_max_deprecated_uidplus_data_size: 0,
-      ).freeze
-
-      version_defaults[0.7r] = Config[0.6r].dup.update(
       ).freeze
-
-      # Safe conversions one way only:
-      #   0.6r.to_f == 0.6  # => true
-      #   0.6 .to_r == 0.6r # => false
-      version_defaults.to_a.each do |k, v|
-        next unless k.is_a? Rational
-        version_defaults[k.to_f] = v
-      end
-
-      current = VERSION.to_r
-      version_defaults[:original] = Config[0]
-      version_defaults[:current]  = Config[current]
-      version_defaults[:next]     = Config[current + 0.1r]
-
-      version_defaults[:future]   = Config[0.7r]
+      version_defaults[:next] = Config[0.6]
+      version_defaults[:future] = Config[:next]
 
       version_defaults.freeze
-
-      if ($VERBOSE || $DEBUG) && self[:current].to_h != self[:default].to_h
-        warn "Misconfigured Net::IMAP::Config[:current] => %p,\n" \
-             " not equal to Net::IMAP::Config[:default] => %p" % [
-                self[:current].to_h, self[:default].to_h
-              ]
-      end
     end
   end
 end

data/lib/net/imap/data_encoding.rb

@@ -186,7 +186,7 @@ module Net
 
       # Ensure argument is 'number' or raise DataFormatError
       def ensure_number(num)
-        return if valid_number?(num)
+        return num if valid_number?(num)
 
         msg = "number must be unsigned 32-bit integer: #{num}"
         raise DataFormatError, msg
@@ -194,7 +194,7 @@ module Net
 
       # Ensure argument is 'nz_number' or raise DataFormatError
       def ensure_nz_number(num)
-        return if valid_nz_number?(num)
+        return num if valid_nz_number?(num)
 
         msg = "nz_number must be non-zero unsigned 32-bit integer: #{num}"
         raise DataFormatError, msg
@@ -202,7 +202,7 @@ module Net
 
       # Ensure argument is 'mod_sequence_value' or raise DataFormatError
       def ensure_mod_sequence_value(num)
-        return if valid_mod_sequence_value?(num)
+        return num if valid_mod_sequence_value?(num)
 
         msg = "mod_sequence_value must be unsigned 64-bit integer: #{num}"
         raise DataFormatError, msg

data/lib/net/imap/deprecated_client_options.rb

@@ -83,10 +83,12 @@ module Net
         elsif deprecated.empty?
           super host, port: port_or_options
         elsif deprecated.shift
-          warn "DEPRECATED: Call Net::IMAP.new with keyword options", uplevel: 1
+          warn("DEPRECATED: Call Net::IMAP.new with keyword options",
+               uplevel: 1, category: :deprecated)
           super host, port: port_or_options, ssl: create_ssl_params(*deprecated)
         else
-          warn "DEPRECATED: Call Net::IMAP.new with keyword options", uplevel: 1
+          warn("DEPRECATED: Call Net::IMAP.new with keyword options",
+               uplevel: 1, category: :deprecated)
           super host, port: port_or_options, ssl: false
         end
       end
@@ -113,7 +115,8 @@ module Net
         elsif deprecated.first.respond_to?(:to_hash)
           super(**Hash.try_convert(deprecated.first))
         else
-          warn "DEPRECATED: Call Net::IMAP#starttls with keyword options", uplevel: 1
+          warn("DEPRECATED: Call Net::IMAP#starttls with keyword options",
+               uplevel: 1, category: :deprecated)
           super(**create_ssl_params(*deprecated))
         end
       end

data/lib/net/imap/errors.rb

@@ -7,41 +7,14 @@ module Net
     class Error < StandardError
     end
 
-    # Error raised when data is in the incorrect format.
-    class DataFormatError < Error
-    end
-
-    # Error raised when the socket cannot be read, due to a Config limit.
-    class ResponseReadError < Error
-    end
-
-    # Error raised when a response is larger than IMAP#max_response_size.
-    class ResponseTooLargeError < ResponseReadError
-      attr_reader :bytes_read, :literal_size
-      attr_reader :max_response_size
-
-      def initialize(msg = nil, *args,
-                     bytes_read:        nil,
-                     literal_size:      nil,
-                     max_response_size: nil,
-                     **kwargs)
-        @bytes_read        = bytes_read
-        @literal_size      = literal_size
-        @max_response_size = max_response_size
-        msg ||= [
-          "Response size", response_size_msg, "exceeds max_response_size",
-          max_response_size && "(#{max_response_size}B)",
-        ].compact.join(" ")
-        super(msg, *args, **kwargs)
+    class LoginDisabledError < Error
+      def initialize(msg = "Remote server has disabled the LOGIN command", ...)
+        super
       end
+    end
 
-      private
-
-      def response_size_msg
-        if bytes_read && literal_size
-          "(#{bytes_read}B read + #{literal_size}B literal)"
-        end
-      end
+    # Error raised when data is in the incorrect format.
+    class DataFormatError < Error
     end
 
     # Error raised when a response from the server is non-parsable.