mail_room 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c956827ee8a391612edf608e8cfcca307fd40bf6
-  data.tar.gz: 03d42253cf5fa4f3d9902cacb7ed3a1e45e414d3
+  metadata.gz: 9feac02c627c54d87da87bc73e1aec3587f43ff3
+  data.tar.gz: 55c2cd20c9e7b7036094c4d46c2efc93567f3e77
 SHA512:
-  metadata.gz: c4316883fc6dee362bef9dfaefb7f88d70fe0641bdf35045b76c27d775b5bfa267cb858dc8593eb2d6488d0251a773e00e0636e7af86650a5bc65dabc07d3347
-  data.tar.gz: 617090d049ac9c620909af604839c6ce9f71940ebcce43912d35875ac93fdad1b680137a4a702271d2b62ad19f9315d48b1ed16f6907b218278fae839f403d4b
+  metadata.gz: 29476b7c9e48f064087b59cc869ad6fab364044ca5a8fbf0f8fdb2dadb6a0222cdb07c473f4d82f0b75ccf895c063b56599bb1fd1acfa906309844f85bca3fb8
+  data.tar.gz: 030b4c91c26c545d2103d2d6f7147606bfafa7998c3b31251356b8da4241614260210863c9ef8ce04423ec91f95a381cf23fcdc648fc397368d2d33e5e6039f1

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.5
-  - 2.2.0
+  - 2.2.4
+  - 2.3.0
 script: bundle exec rspec spec
 sudo: false

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## mail_room 0.7.0 ##
+
+* Backports idle timeout from ruby 2.3.0
+* Sets default to 29 minutes to prevent IMAP disconnects
+* Validates that the timeout does not exceed 29 minutes
+
+    *Tony Pitale <@tpitale>*
+
 ## mail_room 0.6.1 ##
 
 * ERB parsing of configuration yml file to enable using ENV variables

data/CODE_OF_CONDUCT.md

@@ -11,12 +11,14 @@ Examples of unacceptable behavior by participants include:
 * Trolling or insulting/derogatory comments
 * Public or private harassment
 * Publishing other's private information, such as physical or electronic addresses, without explicit permission
-* Other unethical or unprofessional conduct.
+* Other unethical or unprofessional conduct
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
 
 This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/](http://contributor-covenant.org/version/1/3/0/)

data/README.md

@@ -7,7 +7,7 @@ mail_room is a configuration based process that will idle on IMAP connections an
 * Log the message or open with LetterOpener (Logger or LetterOpener)
 
 [![Build Status](https://travis-ci.org/tpitale/mail_room.png?branch=master)](https://travis-ci.org/tpitale/mail_room)
-[![Code Climate](https://codeclimate.com/github/tpitale/mail_room.png)](https://codeclimate.com/github/tpitale/mail_room)
+[![Code Climate](https://codeclimate.com/github/tpitale/mail_room/badges/gpa.svg)](https://codeclimate.com/github/tpitale/mail_room)
 
 ## Installation ##
 
@@ -189,6 +189,11 @@ disabled, you can get the raw string of the email using `request.body.read`.
 I would recommend having the `mail` gem bundled and parse the email using
 `Mail.read_from_string(request.body.read)`.
 
+## idle_timeout ##
+
+By default, the IDLE command will wait for 29 minutes (in order to keep the server connection happy).
+If you'd prefer not to wait that long, you can pass `imap_timeout` in seconds for your mailbox configuration.
+
 ## Search Command ##
 
 This setting allows configuration of the IMAP search command sent to the server. This still defaults 'UNSEEN'. You may find that 'NEW' works better for you.
@@ -197,6 +202,8 @@ This setting allows configuration of the IMAP search command sent to the server.
 
 You can set per-mailbox configuration for the IMAP server's `host` (default: 'imap.gmail.com'), `port` (default: 993), `ssl` (default: true), and `start_tls` (default: false).
 
+If you want to set additional options for IMAP SSL you can pass a YAML hash to match [SSLContext#set_params](http://docs.ruby-lang.org/en/2.2.0/OpenSSL/SSL/SSLContext.html#method-i-set_params). If you set `verify_mode` to `:none` it'll replace with the appropriate constant.
+
 If you're seeing the error `Please log in via your web browser: https://support.google.com/mail/accounts/answer/78754 (Failure)`, you need to configure your Gmail account to allow less secure apps to access it: https://support.google.com/accounts/answer/6010255.
 
 ## Running in Production ##

data/lib/mail_room/backports/imap.rb

@@ -0,0 +1,33 @@
+module MailRoom
+  class IMAP < Net::IMAP
+    # Backported 2.3.0 version of net/imap idle command to support timeout
+    def idle(timeout = nil, &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(timeout)
+          @idle_done_cond = nil
+          if @receiver_thread_terminating
+            raise Net::IMAP::Error, "connection closed"
+          end
+        ensure
+          unless @receiver_thread_terminating
+            remove_response_handler(response_handler)
+            put_string("DONE#{CRLF}")
+            response = get_tagged_response(tag, "IDLE")
+          end
+        end
+      end
+
+      return response
+    end
+  end
+end

data/lib/mail_room/mailbox.rb

@@ -10,6 +10,7 @@ module MailRoom
     :port,
     :ssl,
     :start_tls,
+    :idle_timeout,
     :search_command,
     :name,
     :delete_after_delivery,
@@ -23,9 +24,17 @@ module MailRoom
     :arbitration_options
   ]
 
+  IdleTimeoutTooLarge = Class.new(RuntimeError)
+
   # Holds configuration for each of the email accounts we wish to monitor
   #   and deliver email to when new emails arrive over imap
   Mailbox = Struct.new(*MAILBOX_FIELDS) do
+    # Keep it to 29 minutes or less
+    # The IMAP serve will close the connection after 30 minutes of inactivity
+    # (which sending IDLE and then nothing technically is), so we re-idle every
+    # 29 minutes, as suggested by the spec: https://tools.ietf.org/html/rfc2177
+    IMAP_IDLE_TIMEOUT = 29 * 60 # 29 minutes in in seconds
+
     # Default attributes for the mailbox configuration
     DEFAULTS = {
       :search_command => 'UNSEEN',
@@ -34,6 +43,7 @@ module MailRoom
       :port => 993,
       :ssl => true,
       :start_tls => false,
+      :idle_timeout => IMAP_IDLE_TIMEOUT,
       :delete_after_delivery => false,
       :delivery_options => {},
       :arbitration_method => 'noop',
@@ -44,6 +54,8 @@ module MailRoom
     # @param attributes [Hash] configuration options
     def initialize(attributes={})
       super(*DEFAULTS.merge(attributes).values_at(*members))
+
+      validate!
     end
 
     def delivery_klass
@@ -75,6 +87,17 @@ module MailRoom
       delivery.deliver(body)
     end
 
+    # true, false, or ssl options hash
+    def ssl_options
+      replace_verify_mode(ssl)
+    end
+
+    def validate!
+      if self[:idle_timeout] > IMAP_IDLE_TIMEOUT
+        raise IdleTimeoutTooLarge.new("Please use an idle timeout smaller than #{29*60} to prevent IMAP server disconnects")
+      end
+    end
+
     private
 
     def parsed_arbitration_options
@@ -84,5 +107,23 @@ module MailRoom
     def parsed_delivery_options
       delivery_klass::Options.new(self)
     end
+
+    def replace_verify_mode(options)
+      return options unless options.is_a?(Hash)
+      return options unless options.has_key?(:verify_mode)
+
+      options[:verify_mode] = case options[:verify_mode]
+      when :none, 'none'
+        OpenSSL::SSL::VERIFY_NONE
+      when :peer, 'peer'
+        OpenSSL::SSL::VERIFY_PEER
+      when :client_once, 'client_once'
+        OpenSSL::SSL::VERIFY_CLIENT_ONCE
+      when :fail_if_no_peer_cert, 'fail_if_no_peer_cert'
+        OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+      end
+
+      options
+    end
   end
 end

data/lib/mail_room/mailbox_watcher.rb

@@ -4,7 +4,7 @@ module MailRoom
   # Watch a Mailbox
   # @author Tony Pitale
   class MailboxWatcher
-    attr_accessor :idling_thread, :timeout_thread
+    attr_accessor :idling_thread
 
     # Watch a new mailbox
     # @param mailbox [MailRoom::Mailbox] the mailbox to watch
@@ -17,7 +17,7 @@ module MailRoom
 
     # build a net/imap connection to google imap
     def imap
-      @imap ||= Net::IMAP.new(@mailbox.host, :port => @mailbox.port, :ssl => @mailbox.ssl)
+      @imap ||= MailRoom::IMAP.new(@mailbox.host, :port => @mailbox.port, :ssl => @mailbox.ssl_options)
     end
 
     # build a handler to process mailbox messages
@@ -100,20 +100,8 @@ module MailRoom
 
       @idling = true
 
-      self.timeout_thread = Thread.start do
-        # The IMAP server will close the connection after 30 minutes of inactivity
-        # (which sending IDLE and then nothing technically is), so we re-idle every
-        # 29 minutes, as suggested by the spec: https://tools.ietf.org/html/rfc2177
-        sleep 29 * 60
-
-        imap.idle_done if idling?
-      end
-      timeout_thread.abort_on_exception = true
-
-      imap.idle(&idle_handler)
+      imap.idle(@mailbox.idle_timeout, &idle_handler)
     ensure
-      timeout_thread.kill if timeout_thread
-      self.timeout_thread = nil
       @idling = false
     end
 
@@ -139,7 +127,7 @@ module MailRoom
       self.idling_thread = Thread.start do
         while(running?) do
           begin
-            # block until we stop idling
+            # block for idle_timeout until we stop idling
             idle
 
             # when new messages are ready

data/lib/mail_room/version.rb

@@ -1,4 +1,4 @@
 module MailRoom
   # Current version of MailRoom gem
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/mail_room.rb

@@ -6,6 +6,7 @@ module MailRoom
 end
 
 require "mail_room/version"
+require "mail_room/backports/imap"
 require "mail_room/configuration"
 require "mail_room/mailbox"
 require "mail_room/mailbox_watcher"

data/spec/lib/mailbox_spec.rb

@@ -89,5 +89,13 @@ describe MailRoom::Mailbox do
         noop.should have_received(:deliver).never
       end
     end
+
+    context "with ssl options hash" do
+      it 'replaces verify mode with constant' do
+        mailbox = MailRoom::Mailbox.new({:ssl => {:verify_mode => :none}})
+
+        expect(mailbox.ssl_options).to eq({:verify_mode => OpenSSL::SSL::VERIFY_NONE})
+      end
+    end
   end
 end

data/spec/lib/mailbox_watcher_spec.rb

@@ -25,14 +25,12 @@ describe MailRoom::MailboxWatcher do
   end
 
   describe '#imap' do
-    let(:mailbox) {MailRoom::Mailbox.new}
-
     it 'builds a new Net::IMAP object' do
-      Net::IMAP.stubs(:new).returns('imap')
+      MailRoom::IMAP.stubs(:new).returns('imap')
 
       MailRoom::MailboxWatcher.new(mailbox).imap.should eq('imap')
 
-      Net::IMAP.should have_received(:new).with('imap.gmail.com', :port => 993, :ssl => true)
+      MailRoom::IMAP.should have_received(:new).with('imap.gmail.com', :port => 993, :ssl => true)
     end
   end
 
@@ -40,7 +38,7 @@ describe MailRoom::MailboxWatcher do
     let(:imap) {stub(:login => true, :select => true)}
 
     let(:mailbox) {
-      MailRoom::Mailbox.new(:email => 'user1@gmail.com', :password => 'password', :name => 'inbox', )
+      MailRoom::Mailbox.new(:email => 'user1@gmail.com', :password => 'password', :name => 'inbox')
     }
 
     let(:watcher) {
@@ -74,7 +72,7 @@ describe MailRoom::MailboxWatcher do
 
   describe '#idle' do
     let(:imap) {stub}
-    let(:watcher) {MailRoom::MailboxWatcher.new(nil)}
+    let(:watcher) {MailRoom::MailboxWatcher.new(mailbox)}
 
     before :each do
       watcher.stubs(:imap).returns(imap)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_room
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -200,6 +200,7 @@ files:
 - lib/mail_room/arbitration.rb
 - lib/mail_room/arbitration/noop.rb
 - lib/mail_room/arbitration/redis.rb
+- lib/mail_room/backports/imap.rb
 - lib/mail_room/cli.rb
 - lib/mail_room/configuration.rb
 - lib/mail_room/coordinator.rb