imap_processor 1.1.1 → 1.7

data/lib/net/imap/idle.rb

@@ -0,0 +1,48 @@
+require 'net/imap'
+
+class Net::IMAP
+
+  ##
+  # Sends an IDLE command that waits for notifications of new or expunged
+  # messages.  Yields responses from the server during the IDLE.
+  #
+  # Use #idle_done to leave IDLE.
+
+  def idle(&response_handler)
+    raise LocalJumpError, "no block given" unless response_handler
+
+    response = nil
+
+    synchronize do
+      tag = Thread.current[:net_imap_tag] = generate_tag
+      put_string "#{tag} IDLE#{CRLF}"
+
+      begin
+        add_response_handler response_handler
+
+        @idle_done_cond = new_cond
+        @idle_done_cond.wait
+        @idle_done_cond = nil
+      ensure
+        remove_response_handler response_handler
+        put_string "DONE#{CRLF}"
+        response = get_tagged_response tag
+      end
+    end
+
+    response
+  end
+
+  ##
+  # Leaves IDLE
+
+  def idle_done
+    raise Net::IMAP::Error, 'not during idle' unless @idle_done_cond
+
+    synchronize do
+      @idle_done_cond.signal
+    end
+  end
+
+end unless Net::IMAP.method_defined? :idle
+

data/test/test_imap_processor.rb

@@ -0,0 +1,185 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'imap_processor'
+require 'time'
+
+##
+# These tests expect a local IMAP server with a 'test' login with a 'test'
+# password.  It's fairly easy to set up dovecot to do this:
+#
+# In dovecot.conf:
+#
+#   mail_location = mbox:~/mail:INBOX=~/Mailbox
+#   
+#   auth default {
+#     mechanisms = plain
+#   
+#     passdb passwd-file {
+#       args = scheme=plain username_format=%n /path/to/etc/dovecot/passwd
+#     }
+#   
+#     userdb passwd-file {
+#       args = username_format=%n /path/to/etc/dovecot/passwd
+#     }
+#   }
+#
+# And in /path/to/etc/dovecot/passwd:
+#
+#   test:test:<your uid>:<your gid>::/path/to/your/home/dovecot
+
+class TestIMAPProcessor < MiniTest::Unit::TestCase
+
+  def setup
+    host, port, username, password = 'localhost', 143, 'test', 'test'
+
+    @ip = IMAPProcessor.new :Host => host, :Port => port,
+                            :Username => username, :Password => password,
+                            :Verbose => false
+
+    @connection = @ip.connect
+
+    @imap = @connection.imap
+    @ip.instance_variable_set :@imap, @imap
+
+    @delim = @imap.list('', 'INBOX').first.delim
+
+    @NI = Net::IMAP
+  end
+
+  def teardown
+    @imap.select 'INBOX'
+    uids = @imap.search 'ALL'
+    @imap.store uids, '+FLAGS.SILENT', [:Deleted] unless uids.empty?
+    @imap.expunge
+    @imap.list('', '*').each do |mailbox|
+      next if mailbox.name == 'INBOX'
+      @imap.delete mailbox.name
+    end
+    @imap.disconnect
+  end
+
+  # pre-run cleanup
+  test = self.new nil
+  test.setup
+  test.teardown
+
+  def test_capability
+    res =
+      @NI::UntaggedResponse.new('OK',
+        @NI::ResponseText.new(
+          @NI::ResponseCode.new('CAPABILITY',
+            'IMAP4rev1 LITERAL+ SASL-IR LOGIN-REFERRALS ID ENABLE AUTH=PLAIN'),
+          'Dovecot ready.'),
+        "OK [CAPABAILITY ...] Dovecot ready.\r\n")
+
+    cap = @ip.capability @imap, res
+
+    assert_equal \
+      %w[IMAP4rev1 LITERAL+ SASL-IR LOGIN-REFERRALS ID ENABLE AUTH=PLAIN],
+      cap
+  end
+
+  def test_capability_no_cap
+    res =
+      @NI::TaggedResponse.new('RUBY0001', 'OK',
+        @NI::ResponseText.new(nil,
+          'User logged in'),
+        "RUBY0001 OK User logged in\r\n")
+
+    cap = @ip.capability @imap, res
+
+    assert_includes cap, 'IMAP4REV1'
+  end
+
+  def test_capability_no_res
+    cap = @ip.capability @imap
+
+    assert_includes cap, 'IMAP4REV1'
+  end
+
+  def test_create_mailbox
+    @imap.create "directory#{@delim}"
+
+    assert_equal nil, @ip.create_mailbox('directory')
+
+    refute_nil @ip.create_mailbox('destination') 
+    mailbox = @imap.list('', 'destination').first
+    assert_equal 'destination', mailbox.name
+    assert_equal [:Noinferiors, :Unmarked], mailbox.attr
+  end
+
+  def test_delete_messages
+    util_message
+    uids = util_uids
+
+    @ip.delete_messages uids
+
+    assert_empty util_uids
+  end
+
+  def test_delete_messages_no_expunge
+    util_message
+    uids = util_uids
+
+    @ip.delete_messages uids, false
+
+    uids = util_uids
+
+    refute_empty uids
+    assert_includes :Deleted, @imap.fetch(uids, 'FLAGS').first.attr['FLAGS']
+  end
+
+  def test_move_messages
+    util_message
+    uids = util_uids
+
+    @ip.move_messages uids, 'destination'
+
+    assert_equal 0, @imap.search('ALL').length
+
+    assert_equal 1, @imap.list('', 'destination').length
+  end
+
+  def test_show_messages
+    now = Time.now
+    util_message nil, now
+    uids = util_uids
+
+    out, = capture_io do
+      @ip.show_messages uids
+    end
+
+    expected = <<-EXPECTED
+Subject: message 1
+Date: #{now.rfc2822}
+Message-Id: 1
+
+    EXPECTED
+
+    assert_equal expected, out
+  end
+
+  def util_message(flags = nil, time = Time.now)
+    @count ||= 0
+    @count += 1
+
+    message = <<-MESSAGE
+From: from@example.com
+To: to@example.com
+Subject: message #{@count}
+Date: #{time.rfc2822}
+Message-Id: #{@count}
+
+Hi, this is message number #{@count}
+    MESSAGE
+
+    @imap.append 'INBOX', message, flags, time
+  end
+
+  def util_uids
+    @imap.select 'INBOX'
+    @imap.search 'ALL'
+  end
+
+end
+

metadata

@@ -1,103 +1,152 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: imap_processor
-version: !ruby/object:Gem::Version 
-  version: 1.1.1
+version: !ruby/object:Gem::Version
+  version: '1.7'
 platform: ruby
-authors: 
+authors:
+- Ryan Davis
 - Eric Hodel
 autorequire: 
 bindir: bin
-cert_chain: 
+cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
-  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
-  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
-  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
-  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
-  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
-  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
-  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
-  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
-  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
-  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
-  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
-  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
-  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
-  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
-  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
-  x52qPcexcYZR7w==
+  MIIDPjCCAiagAwIBAgIBBDANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTE5MTIxMzAwMDIwNFoXDTIwMTIxMjAwMDIwNFowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
+  AQCkkcHqAa6IKLYGl93rn78J3L+LnqyxaA059n4IGMHWN5bv9KBQnIjOrpLadtYZ
+  vhWkunWDKdfVapBEq5+T4HzqnsEXC3aCv6JEKJY6Zw7iSzl0M8hozuzRr+w46wvT
+  fV2yTN6QTVxqbMsJJyjosks4ZdQYov2zdvQpt1HsLi+Qmckmg8SPZsd+T8uiiBCf
+  b+1ORSM5eEfBQenPXy83LZcoQz8i6zVB4aAfTGGdhxjoMGUEmSZ6xpkOzmnGa9QK
+  m5x9IDiApM+vCELNwDXXGNFEnQBBK+wAe4Pek8o1V1TTOxL1kGPewVOitX1p3xoN
+  h7iEjga8iM1LbZUfiISZ+WrB
   -----END CERTIFICATE-----
-
-date: 2009-05-19 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
+date: 2020-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.12.1
-    version: 
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
 description: |-
   IMAPProcessor is a client for processing messages on an IMAP server.  It
   provides some basic mechanisms for connecting to an IMAP server, determining
   capabilities and handling messages.
-  
-  IMAPProcessor ships with the imap_keywords executable which can query an IMAP
-  server for keywords set on messages in mailboxes.
-email: 
+
+  IMAPProcessor ships with several executables which can query and
+  manipulate IMAP mailboxes in several different ways:
+
+  imap_archive  :: Archives old messages to a new dated mailbox.
+  imap_cleanse  :: Delete messages older than a certain age in specified mailboxes.
+  imap_flag     :: Flag messages to/from certain people.
+  imap_idle     :: Shows new messages in a mailbox.
+  imap_keywords :: Queries an IMAP server for keywords set on messages
+  imap_learn    :: Flags messages based on what you've flagged before.
+  imap_mkdir    :: Ensures that certain mailboxes exist.
+email:
+- ryand-ruby@zenspider.com
 - drbrain@segment7.net
-executables: 
+executables:
+- imap_archive
+- imap_cleanse
+- imap_flag
+- imap_idle
 - imap_keywords
+- imap_learn
+- imap_mkdir
 extensions: []
-
-extra_rdoc_files: 
-- History.txt
+extra_rdoc_files:
+- History.rdoc
 - Manifest.txt
-- README.txt
-files: 
-- .autotest
-- History.txt
+- README.rdoc
+files:
+- ".autotest"
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
+- bin/imap_archive
+- bin/imap_cleanse
+- bin/imap_flag
+- bin/imap_idle
 - bin/imap_keywords
+- bin/imap_learn
+- bin/imap_mkdir
 - lib/imap_processor.rb
+- lib/imap_processor/archive.rb
+- lib/imap_processor/cleanse.rb
+- lib/imap_processor/client.rb
+- lib/imap_processor/flag.rb
+- lib/imap_processor/idle.rb
 - lib/imap_processor/keywords.rb
+- lib/imap_processor/learn.rb
+- lib/imap_processor/mkdir.rb
 - lib/imap_sasl_plain.rb
-has_rdoc: true
-homepage: http://seattlerb.rubyforge.org/imap_processor
-licenses: []
-
+- lib/net/imap/date.rb
+- lib/net/imap/idle.rb
+- test/test_imap_processor.rb
+homepage: https://github.com/seattlerb/imap_processor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/seattlerb/imap_processor
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
-require_paths: 
+rdoc_options:
+- "--main"
+- README.rdoc
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: seattlerb
-rubygems_version: 1.3.3
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: IMAPProcessor is a client for processing messages on an IMAP server
 test_files: []
-