gitlab-mail_room 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4c047999e1f2e3d77862ea0e65f146fe92c89de4d0367892649d518de8ad66
-  data.tar.gz: 36000daee0622b345eea3be14143652ce335ea9441ab012a4088d0038b7bef8c
+  metadata.gz: b38092bd49b7554fc1f14f45b250737db77a58ce851e78ac9c3eb89c17424881
+  data.tar.gz: 04a4a167905034fcab7ee3c095991103b2bb5f92ff414c0cb6ca360017ae6f3b
 SHA512:
-  metadata.gz: 9693c9ee292e8e45025d251c720d4bda9f80b121aa0524c6c2bad0924b5ec731fcb017f91641c27adf2c7a3321a59345d1f0b80177bbde998ac5b42bc080a13d
-  data.tar.gz: d8c733b9eaef28122e6b2533e1e5fca6a0aba6581b07be93189f498f38ad4845ef624016258c339a2e6cd8ac56e7eb2fbe3c52a9724d5d9363deb58ed1d8d431
+  metadata.gz: 9d09917cbc928d36ea820d06957ad9bc3d47726017abdb307dc734e2b6ef4203dc95866e0821821b461bc86384c7670ad187b3cae0d31e2294501a762d4a9ea9
+  data.tar.gz: acea6980fe10c44333325ffd57cd78007302abf5d58e8a11c12e70a0b0aaf61bcea627b14b31bc24dcfe68f938d50a15ba91e60130aeeafbe7fb079b38dddfad

data/.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
           - '3.0'
           - '2.7'
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:
@@ -43,7 +43,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:

data/.gitlab-ci.yml

@@ -10,11 +10,10 @@ services:
     paths:
       - vendor/ruby
   variables:
-    REDIS_URL: redis://redis:6379/0
+    REDIS_URL: redis://redis:6379
   before_script:
     - apt update && apt install -y libicu-dev
     - ruby -v                                   # Print out ruby version for debugging
-    - gem install bundler --no-document         # Bundler is not installed with the image
     - bundle config set --local path 'vendor'
     - bundle install -j $(nproc)
   script:
@@ -23,8 +22,8 @@ services:
 rspec:
   parallel:
     matrix:
-      - RUBY_VERSION: [ "2.6", "2.7", "3.0", "3.1", "3.2" ]
+      - RUBY_VERSION: [ "3.0", "3.1", "3.2" ]
   <<: *test
 
 include:
-  - template: Security/Dependency-Scanning.gitlab-ci.yml
+  - template: Security/Dependency-Scanning.gitlab-ci.yml

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+3.2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## mail_room 0.11.1 ##
+
+https://github.com/tpitale/mail_room/compare/v0.11.0...v0.11.1
+
+## mail_room 0.11.0 ##
+
+https://github.com/tpitale/mail_room/compare/v0.10.1...v0.11.0
+
 ## mail_room 0.10.1 ##
 
 * Fix db attribute on redis URL PR#130 - @jarkaK

data/README.md

@@ -489,13 +489,3 @@ respectively and MailRoom will log there.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 6. If accepted, ask for commit rights
-
-## TODO ##
-
-1. specs, this is just a (working) proof of concept √
-2. finish code for POSTing to callback with auth √
-3. accept mailbox configuration for one account directly on the commandline; or ask for it
-4. add example rails endpoint, with auth examples
-5. add example configs for upstart/init.d √
-6. log to stdout √
-7. add a development mode that opens in letter_opener by ryanb √

data/lib/mail_room/arbitration/redis.rb

@@ -3,11 +3,13 @@ require "redis"
 module MailRoom
   module Arbitration
     class Redis
-      Options = Struct.new(:redis_url, :namespace, :sentinels) do
+      Options = Struct.new(:redis_url, :namespace, :sentinels, :sentinel_username, :sentinel_password) do
         def initialize(mailbox)
           redis_url = mailbox.arbitration_options[:redis_url] || "redis://localhost:6379"
           namespace = mailbox.arbitration_options[:namespace]
           sentinels = mailbox.arbitration_options[:sentinels]
+          sentinel_username = mailbox.arbitration_options[:sentinel_username]
+          sentinel_password = mailbox.arbitration_options[:sentinel_password]
 
           if namespace
             warn <<~MSG
@@ -16,7 +18,7 @@ module MailRoom
             MSG
           end
 
-          super(redis_url, namespace, sentinels)
+          super(redis_url, namespace, sentinels, sentinel_username, sentinel_password)
         end
       end
 
@@ -48,6 +50,8 @@ module MailRoom
           sentinels = options.sentinels
           redis_options = { url: options.redis_url }
           redis_options[:sentinels] = sentinels if sentinels
+          redis_options[:sentinel_username] = options.sentinel_username if options.sentinel_username
+          redis_options[:sentinel_password] = options.sentinel_password if options.sentinel_password
 
           redis = ::Redis.new(redis_options)
 

data/lib/mail_room/delivery/postback.rb

@@ -71,7 +71,7 @@ module MailRoom
         connection = Faraday.new
 
         if @delivery_options.token_auth?
-          connection.token_auth @delivery_options.token
+          config_token_auth(connection)
         elsif @delivery_options.basic_auth?
           config_basic_auth(connection)
         end
@@ -101,6 +101,18 @@ module MailRoom
         request.headers[@delivery_options.jwt.header] = @delivery_options.jwt.token
       end
 
+      def config_token_auth(connection)
+        # connection.token_auth was removed in Faraday v2 in favor of connection.request(:authorization, 'Token', token)
+        if defined?(connection.token_auth)
+          connection.token_auth @delivery_options.token
+        else
+          connection.request(
+            :authorization, 'Token',
+            @delivery_options.token
+          )
+        end
+      end
+
       def config_basic_auth(connection)
         if defined?(connection.basic_auth)
           connection.basic_auth(

data/lib/mail_room/delivery/sidekiq.rb

@@ -8,12 +8,14 @@ module MailRoom
     # Sidekiq Delivery method
     # @author Douwe Maan
     class Sidekiq
-      Options = Struct.new(:redis_url, :namespace, :sentinels, :queue, :worker, :logger, :redis_db) do
+      Options = Struct.new(:redis_url, :namespace, :sentinels, :queue, :worker, :logger, :redis_db, :sentinel_username, :sentinel_password) do
         def initialize(mailbox)
           redis_url = mailbox.delivery_options[:redis_url] || "redis://localhost:6379"
           redis_db  = mailbox.delivery_options[:redis_db] || 0
           namespace = mailbox.delivery_options[:namespace]
           sentinels = mailbox.delivery_options[:sentinels]
+          sentinel_username = mailbox.delivery_options[:sentinel_username]
+          sentinel_password = mailbox.delivery_options[:sentinel_password]
           queue     = mailbox.delivery_options[:queue] || "default"
           worker    = mailbox.delivery_options[:worker]
           logger = mailbox.logger
@@ -25,7 +27,7 @@ module MailRoom
             MSG
           end
 
-          super(redis_url, namespace, sentinels, queue, worker, logger, redis_db)
+          super(redis_url, namespace, sentinels, queue, worker, logger, redis_db, sentinel_username, sentinel_password)
         end
       end
 
@@ -55,6 +57,8 @@ module MailRoom
           sentinels = options.sentinels
           redis_options = { url: options.redis_url, db: options.redis_db }
           redis_options[:sentinels] = sentinels if sentinels
+          redis_options[:sentinel_username] = options.sentinel_username if options.sentinel_username
+          redis_options[:sentinel_password] = options.sentinel_password if options.sentinel_password
 
           redis = ::Redis.new(redis_options)
 

data/lib/mail_room/version.rb

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

data/mail_room.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["tpitale@gmail.com"]
   gem.description   = %q{mail_room will proxy email (gmail) from IMAP to a delivery method}
   gem.summary       = %q{mail_room will proxy email (gmail) from IMAP to a callback URL, logger, or letter_opener}
-  gem.homepage      = "http://github.com/tpitale/mail_room"
+  gem.homepage      = "https://gitlab.com/gitlab-org/ruby/gems/gitlab-mail_room"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -20,13 +20,13 @@ Gem::Specification.new do |gem|
   gem.add_dependency             "net-imap", ">= 0.2.1"
   gem.add_dependency             "oauth2", [">= 1.4.4", "< 3"]
   gem.add_dependency             "jwt", ">= 2.0"
-  gem.add_dependency             "redis", [">= 4", "< 6"]
+  gem.add_dependency             "redis", [">= 5", "< 6"]
   gem.add_dependency             "redis-namespace", '>= 1.8.2'
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 3.9"
   gem.add_development_dependency "rubocop", "~> 1.11"
-  gem.add_development_dependency "mocha", "~> 1.11"
+  gem.add_development_dependency "mocha", "~> 2.0"
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency "webrick", "~> 1.6"
 

data/spec/lib/arbitration/redis_spec.rb

@@ -11,21 +11,12 @@ describe MailRoom::Arbitration::Redis do
     )
   }
   let(:options) { described_class::Options.new(mailbox) }
-  let(:redis5) { Gem::Version.new(Redis::VERSION) >= Gem::Version.new('5.0') }
   subject       { described_class.new(options) }
 
   # Private, but we don't care.
   let(:redis) { subject.send(:client) }
   let(:raw_client) { redis._client }
 
-  let(:server_url) do
-    if redis5
-      raw_client.config.server_url
-    else
-      raw_client.options[:url]
-    end
-  end
-
   describe '#deliver?' do
     context "when called the first time" do
       after do
@@ -89,7 +80,7 @@ describe MailRoom::Arbitration::Redis do
 
   context 'redis client connection params' do
     context 'when only url is present' do
-      let(:redis_url) { ENV.fetch('REDIS_URL', 'redis://localhost:6379/0') }
+      let(:redis_url) { ENV.fetch('REDIS_URL', 'redis://localhost:6379') }
       let(:mailbox) {
         build_mailbox(
           arbitration_options: {
@@ -105,7 +96,7 @@ describe MailRoom::Arbitration::Redis do
       it 'client has same specified url' do
         subject.deliver?(123)
 
-        expect(server_url).to eq redis_url
+        expect(raw_client.config.server_url).to eq redis_url
       end
 
       it 'client is a instance of Redis class' do
@@ -144,17 +135,37 @@ describe MailRoom::Arbitration::Redis do
         )
       }
 
+      before { ::RedisClient::SentinelConfig.any_instance.stubs(:resolve_master).returns(RedisClient::Config.new(**sentinels.first)) }
+
       it 'client has same specified sentinel params' do
-        if redis5
+        expect(raw_client.config).to be_a RedisClient::SentinelConfig
+        expect(raw_client.config.name).to eq('sentinel-master')
+        expect(raw_client.config.host).to eq('10.0.0.1')
+        expect(raw_client.config.password).to eq('mypassword')
+        expect(raw_client.config.sentinels.map(&:server_url)).to eq(["redis://10.0.0.1:26379"])
+      end
+
+      context 'with separate Sentinel username and password' do
+        let(:sentinel_username) { 'my-sentinel-user' }
+        let(:sentinel_password) { 'my-sentinel-pass' }
+        let(:mailbox) {
+          build_mailbox(
+            arbitration_options: {
+              redis_url: redis_url,
+              sentinels: sentinels,
+              sentinel_username: sentinel_username,
+              sentinel_password: sentinel_password
+            }
+          )
+        }
+
+        it 'client uses Sentinel username and password' do
+          expect(raw_client.config).to be_a RedisClient::SentinelConfig
           expect(raw_client.config.password).to eq('mypassword')
-          client_sentinels = raw_client.config.sentinels
-          expect(client_sentinels.length).to eq(sentinels.length)
-          expect(client_sentinels[0].host).to eq('10.0.0.1')
-          expect(client_sentinels[0].port).to eq(26379) # rubocop:disable Style/NumericLiterals
-        else
-          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)
+
+          sentinels = raw_client.config.sentinels
+          expect(sentinels.map(&:username).uniq).to eq([sentinel_username])
+          expect(sentinels.map(&:password).uniq).to eq([sentinel_password])
         end
       end
     end

data/spec/lib/delivery/sidekiq_spec.rb

@@ -6,17 +6,9 @@ describe MailRoom::Delivery::Sidekiq do
   let(:redis) { subject.send(:client) }
   let(:raw_client) { redis._client }
   let(:options) { MailRoom::Delivery::Sidekiq::Options.new(mailbox) }
-  let(:redis5) { Gem::Version.new(Redis::VERSION) >= Gem::Version.new('5.0') }
-  let(:server_url) do
-    if redis5
-      raw_client.config.server_url
-    else
-      raw_client.options[:url]
-    end
-  end
 
   describe '#options' do
-    let(:redis_url) { 'redis://localhost' }
+    let(:redis_url) { 'redis://localhost:6379' }
     let(:redis_options) { { redis_url: redis_url } }
 
     context 'when only redis_url is specified' do
@@ -28,10 +20,8 @@ describe MailRoom::Delivery::Sidekiq do
       }
 
       context 'with simple redis url' do
-        let(:expected_url) { redis5 ? "#{redis_url}:6379/0" : redis_url }
-
         it 'client has same specified redis_url' do
-          expect(raw_client.server_url).to eq(expected_url)
+          expect(raw_client.config.server_url).to eq(redis_url)
         end
 
         it 'client is a instance of RedisNamespace class' do
@@ -45,19 +35,17 @@ describe MailRoom::Delivery::Sidekiq do
       end
 
       context 'with redis_db specified in options' do
-        let(:expected_url) { redis5 ? "#{redis_url}:6379/4" : redis_url }
-
         before do
           redis_options[:redis_db] = 4
         end
 
         it 'client has correct redis_url' do
-          expect(raw_client.server_url).to eq(expected_url)
+          expect(raw_client.config.server_url).to eq("#{redis_url}/4")
         end
 
         it 'connection has correct values' do
-          expect(redis.connection[:host]).to eq('localhost')
-          expect(redis.connection[:db]).to eq(4)
+          expect(raw_client.config.host).to eq('localhost')
+          expect(raw_client.config.db).to eq(4)
         end
       end
     end
@@ -96,17 +84,39 @@ describe MailRoom::Delivery::Sidekiq do
         )
       }
 
+      before { ::RedisClient::SentinelConfig.any_instance.stubs(:resolve_master).returns(RedisClient::Config.new(**sentinels.first)) }
+
       it 'client has same specified sentinel params' do
-        if redis5
+        expect(raw_client.config).to be_a RedisClient::SentinelConfig
+        expect(raw_client.config.host).to eq('10.0.0.1')
+        expect(raw_client.config.name).to eq('sentinel-master')
+        expect(raw_client.config.password).to eq('mypassword')
+        expect(raw_client.config.sentinels.map(&:server_url)).to eq(["redis://10.0.0.1:26379"])
+      end
+
+      context 'with separate Sentinel username and password' do
+        let(:sentinel_username) { 'my-sentinel-user' }
+        let(:sentinel_password) { 'my-sentinel-pass' }
+        let(:mailbox) {
+          build_mailbox(
+            delivery_method: :sidekiq,
+            delivery_options: {
+              redis_url: redis_url,
+              sentinels: sentinels,
+              sentinel_username: sentinel_username,
+              sentinel_password: sentinel_password
+            }
+          )
+        }
+
+        it 'client uses Sentinel username and password' do
+          expect(raw_client.config).to be_a RedisClient::SentinelConfig
           expect(raw_client.config.password).to eq('mypassword')
-          client_sentinels = raw_client.config.sentinels
-          expect(client_sentinels.length).to eq(sentinels.length)
-          expect(client_sentinels[0].host).to eq('10.0.0.1')
-          expect(client_sentinels[0].port).to eq(26379) # rubocop:disable Style/NumericLiterals
-        else
-          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)
+
+          sentinels = raw_client.config.sentinels
+
+          expect(sentinels.map(&:username).uniq).to eq([sentinel_username])
+          expect(sentinels.map(&:password).uniq).to eq([sentinel_password])
         end
       end
     end

data/spec/lib/health_check_spec.rb

@@ -34,12 +34,14 @@ describe MailRoom::HealthCheck do
 
   describe '#run' do
     it 'sets running to true' do
-      server = stub(start: true)
+      server = stub(start: true, shutdown: true)
       subject.stubs(:create_server).returns(server)
 
       subject.run
 
       expect(subject.running).to be true
+
+      subject.quit
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-mail_room
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
 platform: ruby
 authors:
 - Tony Pitale
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-imap
@@ -64,7 +64,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -140,14 +140,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
@@ -277,6 +277,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -337,7 +338,7 @@ files:
 - spec/lib/message_spec.rb
 - spec/lib/microsoft_graph/connection_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/tpitale/mail_room
+homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-mail_room
 licenses: []
 metadata: {}
 post_install_message:
@@ -355,7 +356,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: mail_room will proxy email (gmail) from IMAP to a callback URL, logger, or