mail_room 0.10.1 → 0.11.1

data/spec/lib/delivery/sidekiq_spec.rb

@@ -4,6 +4,7 @@ require 'mail_room/delivery/sidekiq'
 describe MailRoom::Delivery::Sidekiq do
   subject { described_class.new(options) }
   let(:redis) { subject.send(:client) }
+  let(:raw_client) { redis._client }
   let(:options) { MailRoom::Delivery::Sidekiq::Options.new(mailbox) }
 
   describe '#options' do
@@ -20,7 +21,7 @@ describe MailRoom::Delivery::Sidekiq do
 
       context 'with simple redis url' do
         it 'client has same specified redis_url' do
-          expect(redis.client.options[:url]).to eq(redis_url)
+          expect(raw_client.options[:url]).to eq(redis_url)
         end
 
         it 'client is a instance of RedisNamespace class' do
@@ -39,10 +40,9 @@ describe MailRoom::Delivery::Sidekiq do
         end
 
         it 'client has correct redis_url' do
-          expect(redis.client.options[:url]).to eq(redis_url)
+          expect(raw_client.options[:url]).to eq(redis_url)
         end
 
-
         it 'connection has correct values' do
           expect(redis.connection[:host]).to eq('localhost')
           expect(redis.connection[:db]).to eq(4)
@@ -87,10 +87,10 @@ describe MailRoom::Delivery::Sidekiq do
       before { ::Redis::Client::Connector::Sentinel.any_instance.stubs(:resolve).returns(sentinels) }
 
       it 'client has same specified sentinel params' do
-        expect(redis.client.instance_variable_get(:@connector)).to be_a Redis::Client::Connector::Sentinel
-        expect(redis.client.options[:host]).to eq('sentinel-master')
-        expect(redis.client.options[:password]).to eq('mypassword')
-        expect(redis.client.options[:sentinels]).to eq(sentinels)
+        expect(raw_client.instance_variable_get(:@connector)).to be_a Redis::Client::Connector::Sentinel
+        expect(raw_client.options[:host]).to eq('sentinel-master')
+        expect(raw_client.options[:password]).to eq('mypassword')
+        expect(raw_client.options[:sentinels]).to eq(sentinels)
       end
     end
 

data/spec/lib/jwt_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+require 'mail_room/jwt'
+
+describe MailRoom::JWT do
+  let(:secret_path) { File.expand_path('../fixtures/jwt_secret', File.dirname(__FILE__)) }
+  let(:secret) { Base64.strict_decode64(File.read(secret_path).chomp) }
+
+  let(:standard_config) do
+    {
+      secret_path: secret_path,
+      issuer: 'mailroom',
+      header: 'Mailroom-Api-Request',
+      algorithm: 'HS256'
+    }
+  end
+
+  describe '#token' do
+    let(:jwt) { described_class.new(**standard_config) }
+
+    it 'generates a valid jwt token' do
+      token = jwt.token
+      expect(token).not_to be_empty
+
+      payload = nil
+      expect do
+        payload = JWT.decode(token, secret, true, iss: 'mailroom', verify_iat: true, verify_iss: true, algorithm: 'HS256')
+      end.not_to raise_error
+      expect(payload).to be_an(Array)
+      expect(payload).to match(
+        [
+          a_hash_including(
+            'iss' => 'mailroom',
+            'nonce' => be_a(String),
+            'iat' => be_a(Integer)
+          ),
+          { 'alg' => 'HS256' }
+        ]
+      )
+    end
+
+    it 'generates a different token for each invocation' do
+      expect(jwt.token).not_to eql(jwt.token)
+    end
+  end
+
+  describe '#valid?' do
+    it 'returns true if all essential components are present' do
+      jwt = described_class.new(**standard_config)
+      expect(jwt.valid?).to eql(true)
+    end
+
+    it 'returns true if header and secret path are present' do
+      jwt = described_class.new(
+        secret_path: secret_path,
+        header: 'Mailroom-Api-Request',
+        issuer: nil,
+        algorithm: nil
+      )
+      expect(jwt.valid?).to eql(true)
+      expect(jwt.issuer).to eql(described_class::DEFAULT_ISSUER)
+      expect(jwt.algorithm).to eql(described_class::DEFAULT_ALGORITHM)
+    end
+
+    it 'returns false if either header or secret_path are missing' do
+      expect(described_class.new(
+        secret_path: nil,
+        header: 'Mailroom-Api-Request',
+        issuer: nil,
+        algorithm: nil
+      ).valid?).to eql(false)
+      expect(described_class.new(
+        secret_path: secret_path,
+        header: nil,
+        issuer: nil,
+        algorithm: nil
+      ).valid?).to eql(false)
+    end
+  end
+end

data/spec/lib/microsoft_graph/connection_spec.rb

@@ -14,37 +14,58 @@ describe MailRoom::MicrosoftGraph::Connection do
     }.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' }
+  let(:graph_endpoint) { 'https://graph.microsoft.com' }
+  let(:azure_ad_endpoint) { 'https://login.microsoftonline.com' }
+  let(:base_url) { "#{graph_endpoint}/v1.0/users/user@example.com/mailFolders/inbox/messages" }
+  let(:message_base_url) { "#{graph_endpoint}/v1.0/users/user@example.com/messages" }
+
+  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, "#{azure_ad_endpoint}/#{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
     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' }
-      )
+  context '#quit' do
+    it 'returns false' do
+      expect(connection.stopped?).to be_falsey
     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' }
-      )
+
+    it 'returns true' do
+      connection.quit
+
+      expect(connection.stopped?).to be_truthy
     end
 
+    it 'does not attempt to process the mailbox' do
+      connection.quit
+
+      connection.expects(:process_mailbox).times(0)
+      connection.wait
+    end
+  end
+
+  context '#wait' do
     before do
-      connection.stubs(:wait_for_new_messages)
+      connection.stubs(:do_sleep)
     end
 
     describe 'poll interval' do
@@ -52,6 +73,12 @@ describe MailRoom::MicrosoftGraph::Connection do
         expect(connection.send(:poll_interval)).to eq(60)
       end
 
+      it 'calls do_sleep 60 times' do
+        connection.expects(:do_sleep).with(1).times(60)
+
+        connection.wait
+      end
+
       context 'interval set to 10' do
         let(:options) do
           {
@@ -68,10 +95,16 @@ describe MailRoom::MicrosoftGraph::Connection do
         it 'sets the poll interval to 10' do
           expect(connection.send(:poll_interval)).to eq(10)
         end
+
+        it 'calls do_sleep 10 times' do
+          connection.expects(:do_sleep).with(1).times(10)
+
+          connection.wait
+        end
       end
     end
 
-    context 'with a single message' do
+    shared_examples '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}" }
@@ -103,9 +136,38 @@ describe MailRoom::MicrosoftGraph::Connection do
       end
     end
 
+    context 'with default Azure settings' do
+      before do
+        puts options
+      end
+      it_behaves_like 'with a single message'
+    end
+
+    # https://docs.microsoft.com/en-us/graph/deployments
+    context 'with an alternative Azure deployment' do
+      let(:graph_endpoint) { 'https://graph.microsoft.us' }
+      let(:azure_ad_endpoint) { 'https://login.microsoftonline.us' }
+      let(:options) do
+        {
+          inbox_method: :microsoft_graph,
+          delete_after_delivery: true,
+          expunge_deleted: true,
+          inbox_options: {
+            tenant_id: '98776',
+            client_id: '12345',
+            client_secret: 'MY-SECRET',
+            graph_endpoint: 'https://graph.microsoft.us',
+            azure_ad_endpoint: 'https://login.microsoftonline.us'
+          }
+        }
+      end
+
+      it_behaves_like 'with a single message'
+    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(:next_page_url) { "#{graph_endpoint}/v1.0/nextPage" }
       let(:unread_messages_body) { { value: ['id' => message_ids.first], '@odata.nextLink' => next_page_url } }
       let(:message_body) { 'hello world' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_room
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.1
 platform: ruby
 authors:
 - Tony Pitale
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-13 00:00:00.000000000 Z
+date: 2024-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-imap
@@ -28,16 +28,36 @@ dependencies:
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
@@ -228,12 +248,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
-- ".travis.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -260,6 +282,7 @@ files:
 - lib/mail_room/imap.rb
 - lib/mail_room/imap/connection.rb
 - lib/mail_room/imap/message.rb
+- lib/mail_room/jwt.rb
 - lib/mail_room/logger/structured.rb
 - lib/mail_room/mailbox.rb
 - lib/mail_room/mailbox_watcher.rb
@@ -269,6 +292,7 @@ files:
 - lib/mail_room/version.rb
 - logfile.log
 - mail_room.gemspec
+- spec/fixtures/jwt_secret
 - spec/fixtures/test_config.yml
 - spec/lib/arbitration/redis_spec.rb
 - spec/lib/cli_spec.rb
@@ -282,6 +306,7 @@ files:
 - spec/lib/delivery/sidekiq_spec.rb
 - spec/lib/imap/connection_spec.rb
 - spec/lib/imap/message_spec.rb
+- spec/lib/jwt_spec.rb
 - spec/lib/logger/structured_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb
@@ -306,12 +331,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: mail_room will proxy email (gmail) from IMAP to a callback URL, logger, or
   letter_opener
 test_files:
+- spec/fixtures/jwt_secret
 - spec/fixtures/test_config.yml
 - spec/lib/arbitration/redis_spec.rb
 - spec/lib/cli_spec.rb
@@ -325,6 +351,7 @@ test_files:
 - spec/lib/delivery/sidekiq_spec.rb
 - spec/lib/imap/connection_spec.rb
 - spec/lib/imap/message_spec.rb
+- spec/lib/jwt_spec.rb
 - spec/lib/logger/structured_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-  - truffleruby
-services:
-  - redis
-script:
-  - bundle exec rspec spec
-
-jobs:
-  - language: ruby
-    rvm: 2.7
-    script:
-      - bundle exec rubocop