gitlab-mail_room 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367b6c3327d94d056144113b001df4d6255ab16c6aedcfdb400b413eadd3e07e
-  data.tar.gz: 31ca4ff3025b9fd3ee67b1bb72203d5da46c3367830623f991bcf7b064043857
+  metadata.gz: 046d032389d041dfea1d880c47ff567ad6ccd97439ba05db04f49fe8f6fd8596
+  data.tar.gz: c1eda45ae5d2cbab863eabb843adfb89694ea563f73101bbf268fba18c25d175
 SHA512:
-  metadata.gz: 55b4dce8b77c87a550e088344593490190975fffd13a7c6aed28316cd4524054fd209b476eae29d235413f33bbcc0b0abba1ff6eb3b1c2ba9c008dcc611ba20e
-  data.tar.gz: d8245f80b571b7c9a6c42c9280fd5d99db4705b4b067d6baeef6cd9dd623de69b44a75d9504ddf0fab9eb5bd566e11e72caefe9674ffff33b6e673149ed8458c
+  metadata.gz: 58986de036f80e17d25440c25d4d6bbdb54a0340f865b455847f7a7bf4d2206ae4fefccb91edbb3b56990cf468505501ad1fa30f5223f589483a1e291a59c49a
+  data.tar.gz: a085cd90036662bf26516bd5574a64d921cfff6b0728ec3350cac8eba80f75faef08dc0a69bf4909adb6e31a1f62ff9e4f2d62560eff5226e493af777eaa5810

data/.gitlab-ci.yml

@@ -10,7 +10,7 @@ services:
   variables:
     REDIS_URL: redis://redis:6379
   script:
-  - bundle exec rspec spec
+    - bundle exec rspec spec
   before_script:
     - apt update && apt install -y libicu-dev
     - ruby -v                                   # Print out ruby version for debugging
@@ -30,3 +30,11 @@ rspec-2.5:
 rspec-2.6:
   image: "ruby:2.6"
   <<: *test
+
+rspec-2.7:
+  image: "ruby:2.7"
+  <<: *test
+
+rspec-3.0:
+  image: "ruby:3.0"
+  <<: *test

data/README.md

@@ -55,6 +55,9 @@ You will also need to install `faraday` or `letter_opener` if you use the `postb
 
 ```yaml
 ---
+:health_check:
+  - :address: "127.0.0.1"
+    :port: 8080
 :mailboxes:
   -
     :email: "user1@gmail.com"
@@ -119,6 +122,18 @@ You will also need to install `faraday` or `letter_opener` if you use the `postb
 **Note:** If using `delete_after_delivery`, you also probably want to use
 `expunge_deleted` unless you really know what you're doing.
 
+## health_check ##
+
+Requires `webrick` gem to be installed.
+
+This option enables an HTTP server that listens to a bind address
+defined by `address` and `port`. The following endpoints are supported:
+
+* `/liveness`: This returns a 200 status code with `OK` as the body if
+the server is running. Otherwise, it returns a 500 status code.
+
+This feature is not included in upstream `mail_room` and is specific to GitLab.
+
 ## delivery_method ##
 
 ### postback ###

data/lib/mail_room.rb

@@ -7,8 +7,10 @@ end
 
 require "mail_room/version"
 require "mail_room/configuration"
+require "mail_room/health_check"
 require "mail_room/mailbox"
 require "mail_room/mailbox_watcher"
+require "mail_room/message"
 require "mail_room/connection"
 require "mail_room/coordinator"
 require "mail_room/cli"

data/lib/mail_room/cli.rb

@@ -42,7 +42,7 @@ module MailRoom
       end.parse!(args)
 
       self.configuration = Configuration.new(options)
-      self.coordinator = Coordinator.new(configuration.mailboxes)
+      self.coordinator = Coordinator.new(configuration.mailboxes, configuration.health_check)
     end
 
     # Start the coordinator running, sets up signal traps

data/lib/mail_room/configuration.rb

@@ -4,7 +4,7 @@ module MailRoom
   # Wraps configuration for a set of individual mailboxes with global config
   # @author Tony Pitale
   class Configuration
-    attr_accessor :mailboxes, :log_path, :quiet
+    attr_accessor :mailboxes, :log_path, :quiet, :health_check
 
     # Initialize a new configuration of mailboxes
     def initialize(options={})
@@ -18,6 +18,7 @@ module MailRoom
           config_file = YAML.load(erb.result)
 
           set_mailboxes(config_file[:mailboxes])
+          set_health_check(config_file[:health_check])
         rescue => e
           raise e unless quiet
         end
@@ -32,5 +33,14 @@ module MailRoom
         self.mailboxes << Mailbox.new(attributes)
       end
     end
+
+    # Builds the health checker from YAML configuration
+    #
+    # @param health_check_config nil or a Hash containing :address and :port
+    def set_health_check(health_check_config)
+      return unless health_check_config
+
+      self.health_check = HealthCheck.new(health_check_config)
+    end
   end
 end

data/lib/mail_room/connection.rb

@@ -1,197 +1,23 @@
+# frozen_string_literal: true
+
 module MailRoom
   class Connection
+    attr_reader :mailbox, :new_message_handler
+
     def initialize(mailbox)
       @mailbox = mailbox
-
-      # log in and set the mailbox
-      reset
-      setup
     end
 
     def on_new_message(&block)
       @new_message_handler = block
     end
 
-    # is the connection logged in?
-    # @return [Boolean]
-    def logged_in?
-      @logged_in
-    end
-
-    # is the connection blocked idling?
-    # @return [Boolean]
-    def idling?
-      @idling
-    end
-
-    # is the imap connection closed?
-    # @return [Boolean]
-    def disconnected?
-      imap.disconnected?
-    end
-
-    # is the connection ready to idle?
-    # @return [Boolean]
-    def ready_to_idle?
-      logged_in? && !idling?
-    end
-
-    def quit
-      stop_idling
-      reset
-    end
-
     def wait
-      begin
-        # in case we missed any between idles
-        process_mailbox
-
-        idle
-
-        process_mailbox
-      rescue Net::IMAP::Error, IOError => e
-        @mailbox.logger.warn({ context: @mailbox.context, action: "Disconnected. Resetting...", error: e.message })
-        reset
-        setup
-      end
-    end
-
-    private
-
-    def reset
-      @imap = nil
-      @logged_in = false
-      @idling = false
-    end
-
-    def setup
-      @mailbox.logger.info({ context: @mailbox.context, action: "Starting TLS session" })
-      start_tls
-
-      @mailbox.logger.info({ context: @mailbox.context, action: "Logging into mailbox" })
-      log_in
-
-      @mailbox.logger.info({ context: @mailbox.context, action: "Setting mailbox" })
-      set_mailbox
+      raise NotImplementedError
     end
 
-    # build a net/imap connection to google imap
-    def imap
-      @imap ||= Net::IMAP.new(@mailbox.host, :port => @mailbox.port, :ssl => @mailbox.ssl_options)
-    end
-
-    # start a TLS session
-    def start_tls
-      imap.starttls if @mailbox.start_tls
-    end
-
-    # send the imap login command to google
-    def log_in
-      imap.login(@mailbox.email, @mailbox.password)
-      @logged_in = true
-    end
-
-    # select the mailbox name we want to use
-    def set_mailbox
-      imap.select(@mailbox.name) if logged_in?
-    end
-
-    # is the response for a new message?
-    # @param response [Net::IMAP::TaggedResponse] the imap response from idle
-    # @return [Boolean]
-    def message_exists?(response)
-      response.respond_to?(:name) && response.name == 'EXISTS'
-    end
-
-    # @private
-    def idle_handler
-      lambda {|response| imap.idle_done if message_exists?(response)}
-    end
-
-    # maintain an imap idle connection
-    def idle
-      return unless ready_to_idle?
-
-      @mailbox.logger.info({ context: @mailbox.context, action: "Idling" })
-      @idling = true
-
-      imap.idle(@mailbox.idle_timeout, &idle_handler)
-    ensure
-      @idling = false
-    end
-
-    # trigger the idle to finish and wait for the thread to finish
-    def stop_idling
-      return unless idling?
-
-      imap.idle_done
-
-      # idling_thread.join
-      # self.idling_thread = nil
-    end
-
-    def process_mailbox
-      return unless @new_message_handler
-      @mailbox.logger.info({ context: @mailbox.context, action: "Processing started" })
-
-      msgs = new_messages
-
-      any_deletions = msgs.
-                      # deliver each new message, collect success
-                      map(&@new_message_handler).
-                      # include messages with success
-                      zip(msgs).
-                      # filter failed deliveries, collect message
-                      select(&:first).map(&:last).
-                      # scrub delivered messages
-                      map { |message| scrub(message) }.
-                      any?
-
-      imap.expunge if @mailbox.expunge_deleted && any_deletions
-    end
-
-    def scrub(message)
-      if @mailbox.delete_after_delivery
-        imap.store(message.seqno, "+FLAGS", [Net::IMAP::DELETED])
-        true
-      end
-    end
-
-    # @private
-    # fetch all messages for the new message ids
-    def new_messages
-      # Both of these calls may results in
-      #   imap raising an EOFError, we handle
-      #   this exception in the watcher
-      messages_for_ids(new_message_ids)
-    end
-
-    # TODO: label messages?
-    #   @imap.store(id, "+X-GM-LABELS", [label])
-
-    # @private
-    # search for all new (unseen) message ids
-    # @return [Array<Integer>] message ids
-    def new_message_ids
-      # uid_search still leaves messages UNSEEN
-      all_unread = imap.uid_search(@mailbox.search_command)
-
-      all_unread = all_unread.slice(0, @mailbox.limit_max_unread) unless @mailbox.limit_max_unread.nil? || @mailbox.limit_max_unread == 0
-
-      to_deliver = all_unread.select { |uid| @mailbox.deliver?(uid) }
-      @mailbox.logger.info({ context: @mailbox.context, action: "Getting new messages", unread: {count: all_unread.count, ids: all_unread}, to_be_delivered: { count: to_deliver.count, ids: to_deliver } })
-      to_deliver
-    end
-
-    # @private
-    # fetch the email for all given ids in RFC822 format
-    # @param ids [Array<Integer>] list of message ids
-    # @return [Array<Net::IMAP::FetchData>] the net/imap messages for the given ids
-    def messages_for_ids(uids)
-      return [] if uids.empty?
-
-      # uid_fetch marks as SEEN, will not be re-fetched for UNSEEN
-      imap.uid_fetch(uids, "RFC822")
+    def quit
+      raise NotImplementedError
     end
   end
 end

data/lib/mail_room/coordinator.rb

@@ -2,13 +2,15 @@ module MailRoom
   # Coordinate the mailbox watchers
   # @author Tony Pitale
   class Coordinator
-    attr_accessor :watchers, :running
+    attr_accessor :watchers, :running, :health_check
 
     # build watchers for a set of mailboxes
     # @params mailboxes [Array<MailRoom::Mailbox>] mailboxes to be watched
-    def initialize(mailboxes)
+    # @params health_check <MailRoom::HealthCheck> health checker to run
+    def initialize(mailboxes, health_check = nil)
       self.watchers = []
 
+      @health_check = health_check
       mailboxes.each {|box| self.watchers << MailboxWatcher.new(box)}
     end
 
@@ -16,10 +18,11 @@ module MailRoom
 
     # start each of the watchers to running
     def run
+      health_check&.run
       watchers.each(&:run)
-      
+
       self.running = true
-      
+
       sleep_while_running
     ensure
       quit
@@ -27,6 +30,7 @@ module MailRoom
 
     # quit each of the watchers when we're done running
     def quit
+      health_check&.quit
       watchers.each(&:quit)
     end
 

data/lib/mail_room/crash_handler.rb

@@ -1,7 +1,6 @@
 
 module MailRoom
   class CrashHandler
-
     SUPPORTED_FORMATS = %w[json none]
 
     def initialize(stream=STDOUT)

data/lib/mail_room/health_check.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module MailRoom
+  class HealthCheck
+    attr_reader :address, :port, :running
+
+    def initialize(attributes = {})
+      @address = attributes[:address]
+      @port = attributes[:port]
+
+      validate!
+    end
+
+    def run
+      @server = create_server
+
+      @thread = Thread.new do
+        @server.start
+      end
+
+      @thread.abort_on_exception = true
+      @running = true
+    end
+
+    def quit
+      @running = false
+      @server&.shutdown
+      @thread&.join(60)
+    end
+
+    private
+
+    def validate!
+      raise 'No health check address specified' unless address
+      raise "Health check port #{@port.to_i} is invalid" unless port.to_i.positive?
+    end
+
+    def create_server
+      require 'webrick'
+
+      server = ::WEBrick::HTTPServer.new(Port: port, BindAddress: address, AccessLog: [])
+
+      server.mount_proc '/liveness' do |_req, res|
+        handle_liveness(res)
+      end
+
+      server
+    end
+
+    def handle_liveness(res)
+      if @running
+        res.status = 200
+        res.body = "OK\n"
+      else
+        res.status = 500
+        res.body = "Not running\n"
+      end
+    end
+  end
+end

data/lib/mail_room/imap.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+ 
+module MailRoom
+  module IMAP
+    autoload :Connection, 'mail_room/imap/connection'
+    autoload :Message, 'mail_room/imap/message'
+  end
+end

data/lib/mail_room/imap/connection.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module MailRoom
+  module IMAP
+    class Connection < MailRoom::Connection
+      def initialize(mailbox)
+        super
+
+        # log in and set the mailbox
+        reset
+        setup
+      end
+
+      # is the connection logged in?
+      # @return [Boolean]
+      def logged_in?
+        @logged_in
+      end
+
+      # is the connection blocked idling?
+      # @return [Boolean]
+      def idling?
+        @idling
+      end
+
+      # is the imap connection closed?
+      # @return [Boolean]
+      def disconnected?
+        imap.disconnected?
+      end
+
+      # is the connection ready to idle?
+      # @return [Boolean]
+      def ready_to_idle?
+        logged_in? && !idling?
+      end
+
+      def quit
+        stop_idling
+        reset
+      end
+
+      def wait
+        # in case we missed any between idles
+        process_mailbox
+
+        idle
+
+        process_mailbox
+      rescue Net::IMAP::Error, IOError => e
+        @mailbox.logger.warn({ context: @mailbox.context, action: 'Disconnected. Resetting...', error: e.message })
+        reset
+        setup
+      end
+
+      private
+
+      def reset
+        @imap = nil
+        @logged_in = false
+        @idling = false
+      end
+
+      def setup
+        @mailbox.logger.info({ context: @mailbox.context, action: 'Starting TLS session' })
+        start_tls
+
+        @mailbox.logger.info({ context: @mailbox.context, action: 'Logging into mailbox' })
+        log_in
+
+        @mailbox.logger.info({ context: @mailbox.context, action: 'Setting mailbox' })
+        set_mailbox
+      end
+
+      # build a net/imap connection to google imap
+      def imap
+        @imap ||= Net::IMAP.new(@mailbox.host, port: @mailbox.port, ssl: @mailbox.ssl_options)
+      end
+
+      # start a TLS session
+      def start_tls
+        imap.starttls if @mailbox.start_tls
+      end
+
+      # send the imap login command to google
+      def log_in
+        imap.login(@mailbox.email, @mailbox.password)
+        @logged_in = true
+      end
+
+      # select the mailbox name we want to use
+      def set_mailbox
+        imap.select(@mailbox.name) if logged_in?
+      end
+
+      # is the response for a new message?
+      # @param response [Net::IMAP::TaggedResponse] the imap response from idle
+      # @return [Boolean]
+      def message_exists?(response)
+        response.respond_to?(:name) && response.name == 'EXISTS'
+      end
+
+      # @private
+      def idle_handler
+        ->(response) { imap.idle_done if message_exists?(response) }
+      end
+
+      # maintain an imap idle connection
+      def idle
+        return unless ready_to_idle?
+
+        @mailbox.logger.info({ context: @mailbox.context, action: 'Idling' })
+        @idling = true
+
+        imap.idle(@mailbox.idle_timeout, &idle_handler)
+      ensure
+        @idling = false
+      end
+
+      # trigger the idle to finish and wait for the thread to finish
+      def stop_idling
+        return unless idling?
+
+        imap.idle_done
+
+        # idling_thread.join
+        # self.idling_thread = nil
+      end
+
+      def process_mailbox
+        return unless @new_message_handler
+
+        @mailbox.logger.info({ context: @mailbox.context, action: 'Processing started' })
+
+        msgs = new_messages
+        any_deletions = msgs.
+                        # deliver each new message, collect success
+                        map(&@new_message_handler).
+                        # include messages with success
+                        zip(msgs).
+                        # filter failed deliveries, collect message
+                        select(&:first).map(&:last).
+                        # scrub delivered messages
+                        map { |message| scrub(message) }
+                            .any?
+
+        imap.expunge if @mailbox.expunge_deleted && any_deletions
+      end
+
+      def scrub(message)
+        if @mailbox.delete_after_delivery
+          imap.store(message.seqno, '+FLAGS', [Net::IMAP::DELETED])
+          true
+        end
+      end
+
+      # @private
+      # fetch all messages for the new message ids
+      def new_messages
+        # Both of these calls may results in
+        #   imap raising an EOFError, we handle
+        #   this exception in the watcher
+        messages_for_ids(new_message_ids)
+      end
+
+      # TODO: label messages?
+      #   @imap.store(id, "+X-GM-LABELS", [label])
+
+      # @private
+      # search for all new (unseen) message ids
+      # @return [Array<Integer>] message ids
+      def new_message_ids
+        # uid_search still leaves messages UNSEEN
+        all_unread = imap.uid_search(@mailbox.search_command)
+
+        all_unread = all_unread.slice(0, @mailbox.limit_max_unread) if @mailbox.limit_max_unread.to_i > 0
+
+        to_deliver = all_unread.select { |uid| @mailbox.deliver?(uid) }
+        @mailbox.logger.info({ context: @mailbox.context, action: 'Getting new messages',
+                               unread: { count: all_unread.count, ids: all_unread }, to_be_delivered: { count: to_deliver.count, ids: to_deliver } })
+        to_deliver
+      end
+
+      # @private
+      # fetch the email for all given ids in RFC822 format
+      # @param ids [Array<Integer>] list of message ids
+      # @return [Array<MailRoom::IMAP::Message>] the net/imap messages for the given ids
+      def messages_for_ids(uids)
+        return [] if uids.empty?
+
+        # uid_fetch marks as SEEN, will not be re-fetched for UNSEEN
+        imap_messages = imap.uid_fetch(uids, 'RFC822')
+
+        imap_messages.each_with_object([]) do |msg, messages|
+          messages << ::MailRoom::IMAP::Message.new(uid: msg.attr['UID'], body: msg.attr['RFC822'], seqno: msg.seqno)
+        end
+      end
+    end
+  end
+end

data/lib/mail_room/imap/message.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal:true
+
+module MailRoom
+  module IMAP
+    class Message < MailRoom::Message
+      attr_reader :seqno
+
+      def initialize(uid:, body:, seqno:)
+        super(uid: uid, body: body)
+
+        @seqno = seqno
+      end
+
+      def ==(other)
+        super && seqno == other.seqno
+      end
+    end
+  end
+end

data/lib/mail_room/mailbox.rb

@@ -1,5 +1,6 @@
 require "mail_room/delivery"
 require "mail_room/arbitration"
+require "mail_room/imap"
 
 module MailRoom
   # Mailbox Configuration fields
@@ -102,13 +103,13 @@ module MailRoom
       arbitrator.deliver?(uid)
     end
 
-    # deliver the imap email message
-    # @param message [Net::IMAP::FetchData]
+    # deliver the email message
+    # @param message [MailRoom::Message]
     def deliver(message)
-      body = message.attr['RFC822']
+      body = message.body
       return true unless body
 
-      logger.info({context: context, uid: message.attr['UID'], action: "sending to deliverer", deliverer: delivery.class.name, byte_size: body.bytesize})
+      logger.info({context: context, uid: message.uid, action: "sending to deliverer", deliverer: delivery.class.name, byte_size: body.bytesize})
       delivery.deliver(body)
     end
 

data/lib/mail_room/mailbox_watcher.rb

@@ -1,3 +1,5 @@
+require "mail_room/connection"
+
 module MailRoom
   # TODO: split up between processing and idling?
 
@@ -61,7 +63,7 @@ module MailRoom
 
     private
     def connection
-      @connection ||= Connection.new(@mailbox)
+      @connection ||= ::MailRoom::IMAP::Connection.new(@mailbox)
     end
   end
 end

data/lib/mail_room/message.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MailRoom
+  class Message
+    attr_reader :uid, :body
+
+    def initialize(uid:, body:)
+      @uid = uid
+      @body = body
+    end
+
+    def ==(other)
+      self.class == other.class && uid == other.uid && body == other.body
+    end
+  end
+end

data/lib/mail_room/version.rb

@@ -1,4 +1,4 @@
 module MailRoom
   # Current version of gitlab-mail_room gem
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/mail_room.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec", "~> 3.9"
   gem.add_development_dependency "mocha", "~> 1.11"
   gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "webrick", "~> 1.6"
 
   # for testing delivery methods
   gem.add_development_dependency "faraday"

data/spec/fixtures/test_config.yml

@@ -1,4 +1,7 @@
 ---
+:health_check:
+  :address: "127.0.0.1"
+  :port: 8080
 :mailboxes:
   -
     :email: "user1@gmail.com"

data/spec/lib/cli_spec.rb

@@ -5,14 +5,14 @@ describe MailRoom::CLI do
   let!(:configuration) {MailRoom::Configuration.new({:config_path => config_path})}
   let(:coordinator) {stub(:run => true, :quit => true)}
   let(:configuration_args) { anything }
-  let(:coordinator_args) { anything }
+  let(:coordinator_args) { [anything, anything] }
 
   describe '.new' do
     let(:args) {["-c", "a path"]}
 
     before :each do
       MailRoom::Configuration.expects(:new).with(configuration_args).returns(configuration)
-      MailRoom::Coordinator.stubs(:new).with(coordinator_args).returns(coordinator)
+      MailRoom::Coordinator.stubs(:new).with(*coordinator_args).returns(coordinator)
     end
 
     context 'with configuration args' do
@@ -27,7 +27,7 @@ describe MailRoom::CLI do
 
     context 'with coordinator args' do
       let(:coordinator_args) do
-        configuration.mailboxes
+        [configuration.mailboxes, anything]
       end
 
       it 'creates a new coordinator with configuration' do

data/spec/lib/configuration_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe MailRoom::Configuration do
   let(:config_path) {File.expand_path('../fixtures/test_config.yml', File.dirname(__FILE__))}
 
-  describe 'set_mailboxes' do
+  describe '#initalize' do
     context 'with config_path' do
       let(:configuration) { MailRoom::Configuration.new(:config_path => config_path) }
 
@@ -12,6 +12,10 @@ describe MailRoom::Configuration do
 
         expect(configuration.mailboxes).to eq(['mailbox1', 'mailbox2'])
       end
+
+      it 'parses health check' do
+        expect(configuration.health_check).to be_a(MailRoom::HealthCheck)
+      end
     end
 
     context 'without config_path' do
@@ -23,6 +27,10 @@ describe MailRoom::Configuration do
 
         expect(configuration.mailboxes).to eq([])
       end
+
+      it 'sets the health check to nil' do
+        expect(configuration.health_check).to be_nil
+      end
     end
   end
 end

data/spec/lib/coordinator_spec.rb

@@ -15,6 +15,13 @@ describe MailRoom::Coordinator do
       coordinator = MailRoom::Coordinator.new([])
       expect(coordinator.watchers).to eq([])
     end
+
+    it 'sets the health check' do
+      health_check = MailRoom::HealthCheck.new({ address: '127.0.0.1', port: 8080})
+      coordinator = MailRoom::Coordinator.new([], health_check)
+
+      expect(coordinator.health_check).to eq(health_check)
+    end
   end
 
   describe '#run' do
@@ -22,15 +29,22 @@ describe MailRoom::Coordinator do
       watcher = stub
       watcher.stubs(:run)
       watcher.stubs(:quit)
+
+      health_check = stub
+      health_check.stubs(:run)
+      health_check.stubs(:quit)
+
       MailRoom::MailboxWatcher.stubs(:new).returns(watcher)
-      coordinator = MailRoom::Coordinator.new(['mailbox1'])
+      coordinator = MailRoom::Coordinator.new(['mailbox1'], health_check)
       coordinator.stubs(:sleep_while_running)
       watcher.expects(:run)
       watcher.expects(:quit)
+      health_check.expects(:run)
+      health_check.expects(:quit)
 
       coordinator.run
     end
-    
+
     it 'should go to sleep after running watchers' do
       coordinator = MailRoom::Coordinator.new([])
       coordinator.stubs(:running=)

data/spec/lib/health_check_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe MailRoom::HealthCheck do
+  let(:address) { '127.0.0.1' }
+  let(:port) { 8000 }
+  let(:params) { { address: address, port: port } }
+  subject { described_class.new(params) }
+
+  describe '#initialize' do
+    context 'with valid parameters' do
+      it 'validates successfully' do
+        expect(subject).to be_a(described_class)
+      end
+    end
+
+    context 'with invalid address' do
+      let(:address) { nil }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error('No health check address specified')
+      end
+    end
+
+    context 'with invalid port' do
+      let(:port) { nil }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error('Health check port 0 is invalid')
+      end
+    end
+  end
+
+  describe '#run' do
+    it 'sets running to true' do
+      server = stub(start: true)
+      subject.stubs(:create_server).returns(server)
+
+      subject.run
+
+      expect(subject.running).to be true
+    end
+  end
+
+  describe '#quit' do
+    it 'sets running to false' do
+      server = stub(start: true, shutdown: true)
+      subject.stubs(:create_server).returns(server)
+
+      subject.run
+      subject.quit
+
+      expect(subject.running).to be false
+    end
+  end
+end

data/spec/lib/{connection_spec.rb → imap/connection_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe MailRoom::Connection do
+describe MailRoom::IMAP::Connection do
   let(:imap) {stub}
   let(:mailbox) {build_mailbox(delete_after_delivery: true, expunge_deleted: true)}
 
@@ -9,7 +9,9 @@ describe MailRoom::Connection do
   end
 
   context "with imap set up" do
-    let(:connection) {MailRoom::Connection.new(mailbox)}
+    let(:connection) {MailRoom::IMAP::Connection.new(mailbox)}
+    let(:uid) { 1 }
+    let(:seqno) { 8 }
 
     before :each do
       imap.stubs(:starttls)
@@ -36,19 +38,21 @@ describe MailRoom::Connection do
     end
 
     it "waits for a message to process" do
-      new_message = 'a message'
-      new_message.stubs(:seqno).returns(8)
+      new_message = MailRoom::IMAP::Message.new(uid: uid, body: 'a message', seqno: seqno)
 
       connection.on_new_message do |message|
         expect(message).to eq(new_message)
         true
       end
 
+      attr = { 'UID' => uid, 'RFC822' => new_message.body }
+      fetch_data = Net::IMAP::FetchData.new(seqno, attr)
+
       imap.expects(:idle)
-      imap.stubs(:uid_search).with(mailbox.search_command).returns([], [1])
-      imap.expects(:uid_fetch).with([1], "RFC822").returns([new_message])
-      mailbox.expects(:deliver?).with(1).returns(true)
-      imap.expects(:store).with(8, "+FLAGS", [Net::IMAP::DELETED])
+      imap.stubs(:uid_search).with(mailbox.search_command).returns([], [uid])
+      imap.expects(:uid_fetch).with([uid], "RFC822").returns([fetch_data])
+      mailbox.expects(:deliver?).with(uid).returns(true)
+      imap.expects(:store).with(seqno, "+FLAGS", [Net::IMAP::DELETED])
       imap.expects(:expunge).once
 
       connection.wait

data/spec/lib/imap/message_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal:true
+
+require 'spec_helper'
+require 'securerandom'
+
+describe MailRoom::IMAP::Message do
+  let(:uid) { SecureRandom.hex }
+  let(:body) { 'hello world' }
+  let(:seqno) { 5 }
+
+  subject { described_class.new(uid: uid, body: body, seqno: seqno) }
+
+  describe '#initalize' do
+    it 'initializes with required parameters' do
+      subject
+
+      expect(subject.uid).to eq(uid)
+      expect(subject.body).to eq(body)
+      expect(subject.seqno).to eq(seqno)
+    end
+  end
+
+  describe '#==' do
+    let(:dup) { described_class.new(uid: uid, body: body, seqno: seqno) }
+    let(:base_msg) { MailRoom::Message.new(uid: uid, body: body) }
+
+    it 'matches an equivalent message' do
+      expect(dup == subject).to be true
+    end
+
+    it 'does not match a base message' do
+      expect(subject == base_msg).to be false
+      expect(base_msg == subject).to be false
+    end
+  end
+end

data/spec/lib/mailbox_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe MailRoom::Mailbox do
-  let(:sample_message) { {'RFC822' => 'a message', 'UID' => 123} }
+  let(:sample_message) { MailRoom::Message.new(uid: 123, body: 'a message') }
 
   describe "#deliver" do
     context "with arbitration_method of noop" do
@@ -36,9 +36,9 @@ describe MailRoom::Mailbox do
         noop = stub(:deliver)
         MailRoom::Delivery['noop'].stubs(:new => noop)
 
-        noop.expects(:deliver).with('a message')
+        noop.expects(:deliver).with(sample_message.body)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -48,9 +48,9 @@ describe MailRoom::Mailbox do
         logger = stub(:deliver)
         MailRoom::Delivery['logger'].stubs(:new => logger)
 
-        logger.expects(:deliver).with('a message')
+        logger.expects(:deliver).with(sample_message.body)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -60,9 +60,9 @@ describe MailRoom::Mailbox do
         postback = stub(:deliver)
         MailRoom::Delivery['postback'].stubs(:new => postback)
 
-        postback.expects(:deliver).with('a message')
+        postback.expects(:deliver).with(sample_message.body)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -72,9 +72,9 @@ describe MailRoom::Mailbox do
         letter_opener = stub(:deliver)
         MailRoom::Delivery['letter_opener'].stubs(:new => letter_opener)
 
-        letter_opener.expects(:deliver).with('a message')
+        letter_opener.expects(:deliver).with(sample_message.body)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -85,7 +85,7 @@ describe MailRoom::Mailbox do
         MailRoom::Delivery['noop'].stubs(:new => noop)
         noop.expects(:deliver).never
 
-        mailbox.deliver(stub(:attr => {'FLAGS' => [:Seen, :Recent]}))
+        mailbox.deliver(MailRoom::Message.new(uid: 1234, body: nil))
       end
     end
 

data/spec/lib/mailbox_watcher_spec.rb

@@ -19,9 +19,9 @@ describe MailRoom::MailboxWatcher do
     end
 
     it 'loops over wait while running' do
-      connection = MailRoom::Connection.new(mailbox)
+      connection = MailRoom::IMAP::Connection.new(mailbox)
 
-      MailRoom::Connection.stubs(:new).returns(connection)
+      MailRoom::IMAP::Connection.stubs(:new).returns(connection)
 
       watcher.expects(:running?).twice.returns(true, false)
       connection.expects(:wait).once
@@ -41,11 +41,11 @@ describe MailRoom::MailboxWatcher do
     end
 
     it 'closes and waits for the connection' do
-      connection = MailRoom::Connection.new(mailbox)
+      connection = MailRoom::IMAP::Connection.new(mailbox)
       connection.stubs(:wait)
       connection.stubs(:quit)
 
-      MailRoom::Connection.stubs(:new).returns(connection)
+      MailRoom::IMAP::Connection.stubs(:new).returns(connection)
 
       watcher.run
 

data/spec/lib/message_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal:true
+
+require 'spec_helper'
+require 'securerandom'
+
+describe MailRoom::Message do
+  let(:uid) { SecureRandom.hex }
+  let(:body) { 'hello world' }
+
+  subject { described_class.new(uid: uid, body: body) }
+
+  describe '#initalize' do
+    it 'initializes with required parameters' do
+      subject
+
+      expect(subject.uid).to eq(uid)
+      expect(subject.body).to eq(body)
+    end
+  end
+
+  describe '#==' do
+    let(:dup) { described_class.new(uid: uid, body: body) }
+
+    it 'matches an equivalent message' do
+      expect(dup == subject).to be true
+    end
+
+    it 'does not match a message with a different UID' do
+      msg = described_class.new(uid: '12345', body: body)
+
+      expect(subject == msg).to be false
+      expect(msg == subject).to be false
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-mail_room
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -200,9 +214,14 @@ files:
 - lib/mail_room/delivery/postback.rb
 - lib/mail_room/delivery/que.rb
 - lib/mail_room/delivery/sidekiq.rb
+- lib/mail_room/health_check.rb
+- lib/mail_room/imap.rb
+- lib/mail_room/imap/connection.rb
+- lib/mail_room/imap/message.rb
 - lib/mail_room/logger/structured.rb
 - lib/mail_room/mailbox.rb
 - lib/mail_room/mailbox_watcher.rb
+- lib/mail_room/message.rb
 - lib/mail_room/version.rb
 - logfile.log
 - mail_room.gemspec
@@ -210,7 +229,6 @@ files:
 - spec/lib/arbitration/redis_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/configuration_spec.rb
-- spec/lib/connection_spec.rb
 - spec/lib/coordinator_spec.rb
 - spec/lib/crash_handler_spec.rb
 - spec/lib/delivery/letter_opener_spec.rb
@@ -218,9 +236,13 @@ files:
 - spec/lib/delivery/postback_spec.rb
 - spec/lib/delivery/que_spec.rb
 - spec/lib/delivery/sidekiq_spec.rb
+- spec/lib/health_check_spec.rb
+- spec/lib/imap/connection_spec.rb
+- spec/lib/imap/message_spec.rb
 - spec/lib/logger/structured_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb
+- spec/lib/message_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tpitale/mail_room
 licenses: []
@@ -250,7 +272,6 @@ test_files:
 - spec/lib/arbitration/redis_spec.rb
 - spec/lib/cli_spec.rb
 - spec/lib/configuration_spec.rb
-- spec/lib/connection_spec.rb
 - spec/lib/coordinator_spec.rb
 - spec/lib/crash_handler_spec.rb
 - spec/lib/delivery/letter_opener_spec.rb
@@ -258,7 +279,11 @@ test_files:
 - spec/lib/delivery/postback_spec.rb
 - spec/lib/delivery/que_spec.rb
 - spec/lib/delivery/sidekiq_spec.rb
+- spec/lib/health_check_spec.rb
+- spec/lib/imap/connection_spec.rb
+- spec/lib/imap/message_spec.rb
 - spec/lib/logger/structured_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb
+- spec/lib/message_spec.rb
 - spec/spec_helper.rb