♻️ SASL: Add Authenticator base class w/📚docs

* Add many many docs
* Add properties, events, and callbacks
* Add initial_response?
* Add AuthenticationFailure for failures detected by the SASL mechanism.
  This is different from failures detected by the application protocol,
  such as when the IMAP server responds with "NO" or "BAD".

Currently unused, but existing authenticators will be refactored based
on this, and new authenticators will be writte on it.

Author: nevans

lib/net/imap.rb

@@ -980,6 +980,10 @@ def starttls(options = {}, verify = true)
     #
     # ==== Supported SASL Mechanisms
     #
+    #--
+    # n.b. the following table is copied from Net::IMAP::SASL::Authenticator.
+    #++
+    #
     # +PLAIN+::     See PlainAuthenticator.
     #               Login using clear-text username and password.
     #

lib/net/imap/sasl.rb

@@ -28,6 +28,16 @@ module SASL
       autoload :StringPrep, File.expand_path("sasl/stringprep", __dir__)
       autoload :SASLprep, File.expand_path("#{__dir__}/sasl/saslprep", __dir__)
 
+      # Error raised when the client SASL::Authenticator determines that it
+      # cannot complete successfully during a call to Authenticator#process.
+      #
+      # Note that most \SASL mechanisms cannot detect or report errors until the
+      # protocol-specific outcome message, e.g. a tagged response in \IMAP.
+      # Those authentication errors will be handled or raised by the protocol
+      # client, e.g. a Net::IMAP::NoResponseError.
+      class AuthenticationFailure < Error
+      end
+
       # ArgumentError raised when +string+ is invalid for the stringprep
       # +profile+.
       class StringPrepError < ArgumentError