imap.rb 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a11cb6eb95eff27b2d107a0e1ad8fc727b1eabb6d2c24523ada41b3906b9d42e
-  data.tar.gz: 5a37e2eff7d0177f768aeb77182f04dd47d7686cdbd42f99814c35a140e4d270
+  metadata.gz: 68b300810859bc9e1aad02afe6eb9ae614581c114c05b175e59bffea2e94b4cd
+  data.tar.gz: fd607d6ddca5bf9f9993f5fcc29a56c658671ada38d056c9bb9f6ce0c65d3968
 SHA512:
-  metadata.gz: 8a22fc1e24e9c7765d06733837547a29f581083586b0e9fdef601756ee1d61561b44689cb7dcf5ed62f3db8fc2096ac295ac8859fc765de30fd1135123a9aac6
-  data.tar.gz: 22a69f98811483319992902f342267743bbb69acac1723b1dc8067a54f9805e8965d91925a289cfd376eac22fff3d8ec333125f4f8733cf05debd9025ad38843
+  metadata.gz: 4864d678e3d41d3ad94a001ebb08460c1f93d2441c5eeea117fffc859609de853ee6e833cb1fb46f285b5a9b3f13427e04b483754fbd00504cb71d6ef38f54fd
+  data.tar.gz: 87db28691770c3bd7885866e25f5507f86785b9accf9689099cc3423ef8f82873e9be8a86145c53084566ef49565776e18d5337e683d71189e35a12a21e0f540

data/CHANGELOG

@@ -1,5 +1,16 @@
 # imap/CHANGELOG
 
+## 20260919
+
+0.10.0: ~ Imap.setup: + Imap::LoginFailed; ~ the gemspecs: /'~> 0.4'/'>= 0.4.5'/ upon net-imap. Imap.setup ignored the false which Imap#login returns when the server rejects the password, and handed back a client which was connected but not logged in.
+
+1. + Imap::LoginFailed
+2. + login!(): raises where the server rejects the password, and where only one of the username and the password is given.
+3. ~ Imap.setup: login!() for #login, and /&&/||/ upon the credentials.
+4. ~ imap.gemspec, imap.rb.gemspec: /'~> 0.4'/'>= 0.4.5'/ upon net-imap. FetchData#uid, #flags, #internaldate, #bodystructure and #message are absent in 0.4.0 and present in 0.4.5, and 0.7.0 reads all five. No ceiling, nothing being known to break at 1.0.
+5. + 4 tests: .setup upon a rejection, that it does not go on to select, a half-given pair, and neither given.
+6. ~ Imap::VERSION: /0.9.0/0.10.0/
+
 ## 20260917
 
 0.9.0: + all_of and ALL

data/imap.rb.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7'
 
   spec.dependencies = [
-    ['net-imap', '~> 0.4']
+    ['net-imap', '>= 0.4.5']
   ]
 
   spec.development_dependencies = [

data/lib/Imap/VERSION.rb

@@ -1,3 +1,3 @@
 class Imap
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/lib/imap.rb

@@ -6,18 +6,31 @@ require_relative './Imap/Message'
 require_relative './Imap/VERSION'
 
 class Imap
+  class LoginFailed < StandardError; end
+
   class << self
 
     def setup(config)
       raise ArgumentError, "Server must be specified" unless config[:server]
       imap_client = Imap.new(**config)
-      if config[:username] && config[:password]
-        imap_client.login(username: config[:username], password: config[:password])
+      login!(imap_client, config) if config[:username] || config[:password]
+      imap_client.mailbox = config[:mailbox] if config[:mailbox]
+      imap_client
+    end
+
+    private
+
+    # A half-given pair is a mistake rather than a reason not to log in, and a
+    # refusal is not something to carry on from: what follows is a connection
+    # which answers BAD to whatever is asked of it, several commands away from
+    # the fault.
+    def login!(imap_client, config)
+      unless config[:username] && config[:password]
+        raise LoginFailed, "#{config[:server]} wants both a username and a password; only the #{config[:username] ? 'username' : 'password'} was given"
       end
-      if config[:mailbox]
-        imap_client.mailbox = config[:mailbox]
+      unless imap_client.login(username: config[:username], password: config[:password])
+        raise LoginFailed, "#{config[:server]} refused #{config[:username]}"
       end
-      imap_client
     end
 
   end # class << self

data/test/Imap_test.rb

@@ -36,6 +36,47 @@ describe Imap do
     end
   end
 
+  describe ".setup, upon a login which does not take" do
+    def refusing_mock
+      mock = MockIMAP.new('imap.example.com', ssl: true)
+      def mock.login(username, password)
+        raise Net::IMAP::NoResponseError, OpenStruct.new(data: OpenStruct.new(text: 'Authentication failed'))
+      end
+      mock
+    end
+
+    it 'raises rather than handing back a connection which is not logged in' do
+      Net::IMAP.stub(:new, refusing_mock) do
+        error = _(proc{Imap.setup(server: 'imap.example.com', username: 'user', password: 'wrong')}).must_raise(Imap::LoginFailed)
+        _(error.message).must_equal 'imap.example.com refused user'
+      end
+    end
+
+    it 'does not go on to select a mailbox' do
+      mock = refusing_mock
+      Net::IMAP.stub(:new, mock) do
+        _(proc{Imap.setup(server: 'imap.example.com', username: 'user', password: 'wrong', mailbox: 'INBOX')}).must_raise(Imap::LoginFailed)
+      end
+      _(mock.select_called).must_equal false
+    end
+
+    it 'raises where only one of the pair is given, rather than skipping the login' do
+      Net::IMAP.stub(:new, MockIMAP.new('imap.example.com', ssl: true)) do
+        error = _(proc{Imap.setup(server: 'imap.example.com', username: 'user')}).must_raise(Imap::LoginFailed)
+        _(error.message).must_match(/only the username was given/)
+        _(proc{Imap.setup(server: 'imap.example.com', password: 'secret')}).must_raise(Imap::LoginFailed)
+      end
+    end
+
+    it 'does not log in at all where neither is given' do
+      mock = MockIMAP.new('imap.example.com', ssl: true)
+      Net::IMAP.stub(:new, mock) do
+        _(Imap.setup(server: 'imap.example.com')).must_be_instance_of Imap
+      end
+      _(mock.login_called).must_equal false
+    end
+  end
+
   describe "#login" do
     it 'returns true on successful login' do
       Net::IMAP.stub(:new, MockIMAP.new('imap.example.com', ssl: true)) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imap.rb
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - thoran
@@ -13,16 +13,16 @@ dependencies:
   name: net-imap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement