gitlab-mail_room 0.0.4 → 0.0.10

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,30 +38,24 @@ 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
 
-      mailbox.stubs(:deliver?).returns(true)
+      attr = { 'UID' => uid, 'RFC822' => new_message.body }
+      fetch_data = Net::IMAP::FetchData.new(seqno, attr)
 
-      imap.stubs(:idle)
-      imap.stubs(:uid_search).returns([]).then.returns([1])
-      imap.stubs(:uid_fetch).returns([new_message])
-      imap.stubs(:store)
-      imap.stubs(:expunge)
+      imap.expects(:idle)
+      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
-
-      expect(imap).to have_received(:idle)
-      expect(imap).to have_received(:uid_search).with(mailbox.search_command).twice
-      expect(imap).to have_received(:uid_fetch).with([1], "RFC822")
-      expect(mailbox).to have_received(:deliver?).with(1)
-      expect(imap).to have_received(:store).with(8, "+FLAGS", [Net::IMAP::DELETED])
-      expect(imap).to have_received(:expunge).once
     end
   end
 end

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/logger/structured_spec.rb

@@ -5,6 +5,7 @@ describe MailRoom::Logger::Structured do
   subject { described_class.new $stdout }
 
   let!(:now) { Time.now }
+  let(:timestamp) { now.to_datetime.iso8601(3) }
   let(:message) { { action: 'exciting development', message: 'testing 123' } }
 
   before do
@@ -32,7 +33,7 @@ describe MailRoom::Logger::Structured do
       }
       expected = {
           severity: 'DEBUG',
-          time: now,
+          time: timestamp,
           additional_field: "some value"
       }
 
@@ -40,10 +41,41 @@ describe MailRoom::Logger::Structured do
     end
   end
 
+  describe '#format_message' do
+    shared_examples 'timestamp formatting' do
+      it 'outputs ISO8601 timestamps' do
+        data = JSON.parse(subject.format_message('debug', input_timestamp, 'test', { message: 'hello' } ))
+
+        expect(data['time']).to eq(expected_timestamp)
+      end
+    end
+
+    context 'with no timestamp' do
+      let(:input_timestamp) { nil }
+      let(:expected_timestamp) { timestamp }
+
+      it_behaves_like 'timestamp formatting'
+    end
+
+    context 'with DateTime' do
+      let(:input_timestamp) { now.to_datetime }
+      let(:expected_timestamp) { timestamp }
+
+      it_behaves_like 'timestamp formatting'
+    end
+
+    context 'with string' do
+      let(:input_timestamp) { now.to_s }
+      let(:expected_timestamp) { input_timestamp }
+
+      it_behaves_like 'timestamp formatting'
+    end
+  end
+
   def json_matching(level, message)
     contents = {
         severity: level,
-        time: now
+        time: timestamp
     }.merge(message)
 
     as_regex(contents)

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
@@ -12,9 +12,9 @@ describe MailRoom::Mailbox do
 
         uid = 123
 
-        mailbox.deliver?(uid)
+        noop.expects(:deliver?).with(uid)
 
-        expect(noop).to have_received(:deliver?).with(uid)
+        mailbox.deliver?(uid)
       end
     end
 
@@ -23,12 +23,10 @@ describe MailRoom::Mailbox do
         mailbox = build_mailbox({:arbitration_method => 'redis'})
         redis = stub(:deliver?)
         MailRoom::Arbitration['redis'].stubs(:new => redis)
-
         uid = 123
+        redis.expects(:deliver?).with(uid)
 
         mailbox.deliver?(uid)
-
-        expect(redis).to have_received(:deliver?).with(uid)
       end
     end
 
@@ -38,9 +36,9 @@ describe MailRoom::Mailbox do
         noop = stub(:deliver)
         MailRoom::Delivery['noop'].stubs(:new => noop)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        noop.expects(:deliver).with(sample_message.body)
 
-        expect(noop).to have_received(:deliver).with('a message')
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -50,9 +48,9 @@ describe MailRoom::Mailbox do
         logger = stub(:deliver)
         MailRoom::Delivery['logger'].stubs(:new => logger)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        logger.expects(:deliver).with(sample_message.body)
 
-        expect(logger).to have_received(:deliver).with('a message')
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -62,9 +60,9 @@ describe MailRoom::Mailbox do
         postback = stub(:deliver)
         MailRoom::Delivery['postback'].stubs(:new => postback)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        postback.expects(:deliver).with(sample_message.body)
 
-        expect(postback).to have_received(:deliver).with('a message')
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -74,9 +72,9 @@ describe MailRoom::Mailbox do
         letter_opener = stub(:deliver)
         MailRoom::Delivery['letter_opener'].stubs(:new => letter_opener)
 
-        mailbox.deliver(stub(:attr => sample_message))
+        letter_opener.expects(:deliver).with(sample_message.body)
 
-        expect(letter_opener).to have_received(:deliver).with('a message')
+        mailbox.deliver(sample_message)
       end
     end
 
@@ -85,10 +83,9 @@ describe MailRoom::Mailbox do
         mailbox = build_mailbox({ name: "magic mailbox", delivery_method: 'noop' })
         noop = stub(:deliver)
         MailRoom::Delivery['noop'].stubs(:new => noop)
+        noop.expects(:deliver).never
 
-        mailbox.deliver(stub(:attr => {'FLAGS' => [:Seen, :Recent]}))
-
-        expect(noop).to have_received(:deliver).never
+        mailbox.deliver(MailRoom::Message.new(uid: 1234, body: nil))
       end
     end
 

data/spec/lib/mailbox_watcher_spec.rb

@@ -19,20 +19,16 @@ describe MailRoom::MailboxWatcher do
     end
 
     it 'loops over wait while running' do
-      connection = MailRoom::Connection.new(mailbox)
-      connection.stubs(:on_new_message)
-      connection.stubs(:wait)
+      connection = MailRoom::IMAP::Connection.new(mailbox)
 
-      MailRoom::Connection.stubs(:new).returns(connection)
+      MailRoom::IMAP::Connection.stubs(:new).returns(connection)
 
-      watcher.stubs(:running?).returns(true).then.returns(false)
+      watcher.expects(:running?).twice.returns(true, false)
+      connection.expects(:wait).once
+      connection.expects(:on_new_message).once
 
       watcher.run
       watcher.watching_thread.join # wait for finishing run
-
-      expect(watcher).to have_received(:running?).times(2)
-      expect(connection).to have_received(:wait).once
-      expect(connection).to have_received(:on_new_message).once
     end
   end
 
@@ -45,19 +41,20 @@ 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
 
       expect(watcher.running?).to eq(true)
 
+      connection.expects(:quit)
+
       watcher.quit
 
-      expect(connection).to have_received(:quit)
       expect(watcher.running?).to eq(false)
     end
   end

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

data/spec/spec_helper.rb

@@ -2,10 +2,10 @@ require 'simplecov'
 SimpleCov.start
 
 require 'bundler/setup'
+require 'date'
 
 require 'rspec'
 require 'mocha/api'
-require 'bourne'
 
 require File.expand_path('../../lib/mail_room', __FILE__)
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-mail_room
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.10
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-imap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -28,32 +42,32 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: bourne
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +202,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/issue_templates/Release.md"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
@@ -213,9 +228,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
@@ -223,7 +243,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
@@ -231,9 +250,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: []
@@ -253,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: mail_room will proxy email (gmail) from IMAP to a callback URL, logger, or
@@ -263,7 +286,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
@@ -271,7 +293,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