imap.rb 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45cf03dcb336e9795a5ef5339e6ac0c6e3b2f5e79014f3462684f39f79aae98f
-  data.tar.gz: e204d83b456b966f0f9a9c3a55acfb492564da65a2b2be22d8c27326104ba755
+  metadata.gz: 68b300810859bc9e1aad02afe6eb9ae614581c114c05b175e59bffea2e94b4cd
+  data.tar.gz: fd607d6ddca5bf9f9993f5fcc29a56c658671ada38d056c9bb9f6ce0c65d3968
 SHA512:
-  metadata.gz: 20938befdd15cc9da7f5679b0043facbdbc0d3a69b04f93a0100c43b4314b6832ecfed375484d1429221ee60703dfc94ac3abdd1f4ff40060ed528828187fcf4
-  data.tar.gz: e467e3aed0b2b09cc86e175a1b3f940e37922232e4efb97998c5dc7a959b5a3f9b8f012bb1a8ff6505d7dff83f488e418c5e7d8670fe5b4db7333991ff683d77
+  metadata.gz: 4864d678e3d41d3ad94a001ebb08460c1f93d2441c5eeea117fffc859609de853ee6e833cb1fb46f285b5a9b3f13427e04b483754fbd00504cb71d6ef38f54fd
+  data.tar.gz: 87db28691770c3bd7885866e25f5507f86785b9accf9689099cc3423ef8f82873e9be8a86145c53084566ef49565776e18d5337e683d71189e35a12a21e0f540

data/CHANGELOG

@@ -1,7 +1,27 @@
 # 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
+
+1. + Imap::Search#all_of: all_of: [{text: 'invoice'}, {text: 'overdue'}] for TEXT invoice TEXT overdue. IMAP has no AND keyword, keys simply sitting side by side, but a hash cannot hold the same key twice, so two terms upon the one key could not be asked for at all: {text: 'a', text: 'b'} keeps b and drops a without a word. Each element is a criteria hash of its own, so or and not nest inside it.
+2. ~ Imap::Search#to_imap_search_keys: + ALL_OF and + ALL, read before the operator tests beside OR and NOT, being none of the three. ALL sat in ALL_SEARCH_KEYS and in neither operator list, so {all: true} raised UnknownSearchKey. It is the key meaning every message, which is precisely what a search with no criteria has to send, so the hash could not express the simplest search there is.
+3. ALL is a case and not a member of BOOLEAN_SEARCH_KEYS, where it appears to belong: each of those defines a method of its own name, and #all is already the alias for #message_ids which the header's own example ends upon. Adding it there redefined the alias silently, which warning = true reported and 0.4.4 turned on for this.
+4. + 5 tests: that all_of ands a list, that it is how the one key carries several terms where a hash cannot, that or and not nest within it, that it sits beside the plain keys, and that {all: true} answers ['ALL'].
+5. ~ Imap::VERSION: /0.8.0/0.9.0/
+
+
 0.8.0: + Imap::Message.for, the fetch without the search, and a class a program can subclass.
 
 1. + Imap::Message.for(imap_client, message_ids): the batched fetch on its own, .search now being the search and then this. A program which builds its own search keys had no way in: .search couples the two, so search-mail had 159 lines of its own Hit reimplementing the fetch beside it.

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/Message.rb

@@ -29,7 +29,6 @@ class Imap
     ENCODED_WORD = /=\?([^?]+)\?([BbQq])\?([^?]*)\?=/
 
     class << self
-
       def search(imap_client, **search_criteria)
         self.for(imap_client, Imap::Search.new(imap_client, search_criteria).message_ids)
       end
@@ -68,7 +67,6 @@ class Imap
       rescue StandardError
         text
       end
-
     end # class << self
 
     attr_accessor :imap_client

data/lib/Imap/Search.rb

@@ -4,6 +4,7 @@
 # Usage:
 # 1. Imap::Search.new(imap_client).not.subject('Payday Loans').answered.from('noreply@example.com').all
 # 2. Imap::Search.new(imap_client, {from: 'noreply@example.com', answered: true})
+# 3. Imap::Search.new(imap_client, {all_of: [{text: 'invoice'}, {text: 'overdue'}]})
 
 # Notes:
 # 1. List of search keys taken from RFC-3501 (INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1), http://tools.ietf.org/html/rfc3501.
@@ -123,6 +124,10 @@ class Imap
       criteria.inject([]) do |m, kv|
         key, value = kv.first.to_s.upcase, kv.last
         case
+        when key == 'ALL'
+          m << 'ALL'
+        when key == 'ALL_OF'
+          m << all_of(value)
         when key == 'OR'
           m << any_of(value)
         when key == 'NOT'
@@ -137,6 +142,13 @@ class Imap
       end.flatten
     end
 
+    # AND has no keyword: keys sit side by side and the server ands them.  A hash
+    # cannot hold the same key twice, though, so several terms upon the one key
+    # say so here: all_of: [{text: 'a'}, {text: 'b'}] for TEXT a TEXT b.
+    def all_of(criteria_hashes)
+      criteria_hashes.flat_map{|criteria_hash| Search.new(nil, criteria_hash).to_imap_search_keys}
+    end
+
     # OR takes two keys and no more, so three criteria nest: OR OR a b c.  Each
     # is a criteria hash of its own, so either side may nest further.
     def any_of(criteria_hashes)

data/lib/Imap/VERSION.rb

@@ -1,3 +1,3 @@
 class Imap
-  VERSION = '0.8.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/Search_test.rb

@@ -47,6 +47,27 @@ describe Imap::Search do
   describe 'OR, NOT and HEADER' do
     def keys(criteria) = Imap::Search.new(client, criteria).to_imap_search_keys
 
+    it 'answers ALL, which every key list named and neither operator list held' do
+      _(keys(all: true)).must_equal ['ALL']
+    end
+
+    it 'ands a list of criteria hashes for ALL_OF' do
+      _(keys(all_of: [{text: 'invoice'}, {text: 'overdue'}])).must_equal ['TEXT', 'invoice', 'TEXT', 'overdue']
+    end
+
+    it 'is how the one key carries more than one term, a hash holding it once' do
+      _(keys({text: 'invoice'}.merge(text: 'overdue'))).must_equal ['TEXT', 'overdue']
+      _(keys(all_of: [{text: 'invoice'}, {text: 'overdue'}])).must_equal ['TEXT', 'invoice', 'TEXT', 'overdue']
+    end
+
+    it 'nests OR and NOT inside ALL_OF' do
+      _(keys(all_of: [{not: {text: 'draft'}}, {or: [{from: 'a@x'}, {to: 'b@y'}]}])).must_equal ['NOT', 'TEXT', 'draft', 'OR', 'FROM', 'a@x', 'TO', 'b@y']
+    end
+
+    it 'sits beside the plain keys' do
+      _(keys(since: '1-Sep-2026', all_of: [{text: 'a'}, {text: 'b'}])).must_equal ['SINCE', '1-Sep-2026', 'TEXT', 'a', 'TEXT', 'b']
+    end
+
     it 'takes two criteria hashes for OR' do
       _(keys(or: [{from: 'a@x'}, {to: 'b@y'}])).must_equal ['OR', 'FROM', 'a@x', 'TO', 'b@y']
     end

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.8.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