gitlab-mail_room 0.0.7 → 0.0.12

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/lib/microsoft_graph/connection_spec.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'spec_helper'
+require 'json'
+require 'webmock/rspec'
+
+describe MailRoom::MicrosoftGraph::Connection do
+  let(:tenant_id) { options[:inbox_options][:tenant_id] }
+  let(:options) do
+    {
+      delete_after_delivery: true,
+      expunge_deleted: true
+    }.merge(REQUIRED_MICROSOFT_GRAPH_DEFAULTS)
+  end
+  let(:mailbox) { build_mailbox(options) }
+  let(:base_url) { 'https://graph.microsoft.com/v1.0/users/user@example.com/mailFolders/inbox/messages' }
+  let(:message_base_url) { 'https://graph.microsoft.com/v1.0/users/user@example.com/messages' }
+
+  before do
+    WebMock.enable!
+  end
+
+  context '#wait' do
+    let(:connection) { described_class.new(mailbox) }
+    let(:uid) { 1 }
+    let(:access_token) { SecureRandom.hex }
+    let(:refresh_token) { SecureRandom.hex }
+    let(:expires_in) { Time.now + 3600 }
+    let(:unread_messages_body) { '' }
+    let(:status) { 200 }
+    let!(:stub_token) do
+      stub_request(:post, "https://login.microsoftonline.com/#{tenant_id}/oauth2/v2.0/token").to_return(
+        body: { 'access_token' => access_token, 'refresh_token' => refresh_token, 'expires_in' => expires_in }.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+    let!(:stub_unread_messages_request) do
+      stub_request(:get, "#{base_url}?$filter=isRead%20eq%20false").to_return(
+        status: status,
+        body: unread_messages_body.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    before do
+      connection.stubs(:wait_for_new_messages)
+    end
+
+    describe 'poll interval' do
+      it 'defaults to 60 seconds' do
+        expect(connection.send(:poll_interval)).to eq(60)
+      end
+
+      context 'interval set to 10' do
+        let(:options) do
+          {
+            inbox_method: :microsoft_graph,
+            inbox_options: {
+              tenant_id: '98776',
+              client_id: '12345',
+              client_secret: 'MY-SECRET',
+              poll_interval: '10'
+            }
+          }
+        end
+
+        it 'sets the poll interval to 10' do
+          expect(connection.send(:poll_interval)).to eq(10)
+        end
+      end
+    end
+
+    context 'with a single message' do
+      let(:message_id) { SecureRandom.hex }
+      let(:unread_messages_body) { { value: ['id' => message_id] } }
+      let(:message_url) { "#{message_base_url}/#{message_id}" }
+      let(:message_body) { 'hello world' }
+
+      it 'requests message ID' do
+        stub_get = stub_request(:get, "#{message_url}/$value").to_return(
+          status: 200,
+          body: message_body
+        )
+        stub_patch = stub_request(:patch, message_url).with(body: { "isRead": true }.to_json)
+        stub_delete = stub_request(:delete, message_url)
+        message_count = 0
+
+        connection.on_new_message do |message|
+          message_count += 1
+          expect(message.uid).to eq(message_id)
+          expect(message.body).to eq(message_body)
+        end
+
+        connection.wait
+
+        assert_requested(stub_token)
+        assert_requested(stub_unread_messages_request)
+        assert_requested(stub_get)
+        assert_requested(stub_patch)
+        assert_requested(stub_delete)
+        expect(message_count).to eq(1)
+      end
+    end
+
+    context 'with multiple pages of messages' do
+      let(:message_ids) { [SecureRandom.hex, SecureRandom.hex] }
+      let(:next_page_url) { 'https://graph.microsoft.com/v1.0/nextPage' }
+      let(:unread_messages_body) { { value: ['id' => message_ids.first], '@odata.nextLink' => next_page_url } }
+      let(:message_body) { 'hello world' }
+
+      it 'requests message ID' do
+        stub_request(:get, next_page_url).to_return(
+          status: 200,
+          body: { value: ['id' => message_ids[1]] }.to_json
+        )
+
+        stubs = []
+        message_ids.each do |message_id|
+          rfc822_msg_url = "#{message_base_url}/#{message_id}/$value"
+          stubs << stub_request(:get, rfc822_msg_url).to_return(
+            status: 200,
+            body: message_body
+          )
+
+          msg_url = "#{message_base_url}/#{message_id}"
+          stubs << stub_request(:patch, msg_url).with(body: { "isRead": true }.to_json)
+          stubs << stub_request(:delete, msg_url)
+        end
+
+        message_count = 0
+
+        connection.on_new_message do |message|
+          expect(message.uid).to eq(message_ids[message_count])
+          expect(message.body).to eq(message_body)
+          message_count += 1
+        end
+
+        connection.wait
+
+        stubs.each { |stub| assert_requested(stub) }
+        expect(message_count).to eq(2)
+      end
+    end
+
+    shared_examples 'request backoff' do
+      it 'backs off' do
+        connection.expects(:backoff)
+
+        connection.on_new_message {}
+        connection.wait
+
+        expect(connection.throttled_count).to eq(1)
+      end
+    end
+
+    context 'too many requests' do
+      let(:status) { 429 }
+
+      it_behaves_like 'request backoff'
+    end
+
+    context 'too much bandwidth' do
+      let(:status) { 509 }
+
+      it_behaves_like 'request backoff'
+    end
+
+    context 'invalid JSON response' do
+      let(:body) { 'this is something' }
+
+      it 'ignores the message and logs a warning' do
+        mailbox.logger.expects(:warn)
+
+        connection.on_new_message {}
+        connection.wait
+      end
+    end
+
+    context '500 error' do
+      let(:status) { 500 }
+
+      it 'terminates due to error' do
+        connection.on_new_message {}
+
+        expect { connection.wait }.to raise_error(OAuth2::Error)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'simplecov'
 SimpleCov.start
 
 require 'bundler/setup'
+require 'date'
 
 require 'rspec'
 require 'mocha/api'
@@ -21,11 +22,21 @@ RSpec.configure do |config|
 end
 
 REQUIRED_MAILBOX_DEFAULTS = {
-  :name => "inbox",
-  :email => "user@example.com",
-  :password => "password123"
+  name: "inbox",
+  email: "user@example.com",
+  password: "password123"
 }
 
+REQUIRED_MICROSOFT_GRAPH_DEFAULTS = {
+  password: nil,
+  inbox_method: :microsoft_graph,
+  inbox_options: {
+    tenant_id: '98776',
+    client_id: '12345',
+    client_secret: 'MY-SECRET',
+  }.freeze
+}.freeze
+
 def build_mailbox(options = {})
   MailRoom::Mailbox.new(REQUIRED_MAILBOX_DEFAULTS.merge(options))
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-mail_room
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.12
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2021-05-16 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: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +108,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
@@ -164,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: mail_room will proxy email (gmail) from IMAP to a delivery method
 email:
 - tpitale@gmail.com
@@ -175,6 +245,8 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".gitlab/issue_templates/Release.md"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
@@ -200,9 +272,16 @@ 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/microsoft_graph.rb
+- lib/mail_room/microsoft_graph/connection.rb
 - lib/mail_room/version.rb
 - logfile.log
 - mail_room.gemspec
@@ -210,7 +289,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 +296,14 @@ 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/lib/microsoft_graph/connection_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tpitale/mail_room
 licenses: []
@@ -240,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+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
@@ -250,7 +333,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 +340,12 @@ 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/lib/microsoft_graph/connection_spec.rb
 - spec/spec_helper.rb