mail_room 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b5c7ee5327fe4bf1a8f3b5743ad5c39e274430a
-  data.tar.gz: 0a4d4858b8c82da1fb27a3915906adc270bce87e
+  metadata.gz: ee519fad16a2cfffc77987222062d15f59da6081
+  data.tar.gz: e403cac3cc18fe5a258d892dc69481535e01c4b6
 SHA512:
-  metadata.gz: 42c2777a6056a5a555a184eadcd4c603419a03f90eb2a5d3ebcd46e496fe395fcf29a238506f26f26271a1e079217aa398b561ce2019c1d95a6010a349141e6a
-  data.tar.gz: 2cb1c45b90cbf2d1b35533db8bcfd153db3b0b019a25ce70df0b31f342f6e1326441c7904fba4f4fcc6521ebc2f01c8da85340685e992f372c8a363590e0a9db
+  metadata.gz: 3b001def60c902e4efab7b4708c655e6c07d2d1b4b94cd1d0a0703c91a987c05ba218834a9e711f377a2c38c524134de73a0b184d3e676b188cd077a1a3cf94c
+  data.tar.gz: 8df7ff1eb78ec3eb6f19d976c5b6fc3a884194daede0af990a4f2c74b2efcdd04b6c8dfd7f9dd2f8e7ee3fd156696ab5104062abfa6ea1f4d640d2cc2a9f7a53

data/.gitlab-ci.yml

@@ -0,0 +1,31 @@
+# Cache gems in between builds
+
+.test-template: &test
+  cache:
+    paths:
+      - vendor/ruby
+  script:
+  - bundle exec rspec spec
+  before_script:
+    - apt update && apt install -y libicu-dev
+    - ruby -v                                   # Print out ruby version for debugging
+    # Uncomment next line if your rails app needs a JS runtime:
+    # - apt-get update -q && apt-get install nodejs -yqq
+    - gem install bundler  --no-ri --no-rdoc    # Bundler is not installed with the image
+    - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+rspec-2.0:
+  image: "ruby:2.0"
+  <<: *test
+
+rspec-2.1:
+  image: "ruby:2.1"
+  <<: *test
+
+rspec-2.2:
+  image: "ruby:2.2"
+  <<: *test
+
+rspec-2.3:
+  image: "ruby:2.3"
+  <<: *test

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## mail_room 0.9.0 ##
+
+* Redis Sentinel configuration support - PR#79
+
+    *Gabriel Mazetto <@brodock>*
+
 ## mail_room 0.8.1 ##
 
 * Check watching thread exists before joining - PR#78

data/README.md

@@ -44,7 +44,7 @@ You will also need to install `faraday` or `letter_opener` if you use the `postb
     :delivery_options:
       :delivery_url: "http://localhost:3000/inbox"
       :delivery_token: "abcdefg"
-    
+
   -
     :email: "user2@gmail.com"
     :password: "password"
@@ -76,6 +76,20 @@ You will also need to install `faraday` or `letter_opener` if you use the `postb
     :delivery_options:
       :redis_url: redis://localhost:6379
       :worker: EmailReceiverWorker
+  -
+    :email: "user6@gmail.com"
+    :password: "password"
+    :name: "inbox"
+    :delivery_method: sidekiq
+    :delivery_options:
+      # When pointing to sentinel, follow this sintax for redis URLs:
+      # redis://:<password>@<master-name>/
+      :redis_url: redis://:password@my-redis-sentinel/
+      :sentinels:
+        -
+          :host: 127.0.0.1
+          :port: 26379
+      :worker: EmailReceiverWorker
 ```
 
 ## delivery_method ##
@@ -86,12 +100,12 @@ Requires `faraday` gem be installed.
 
 *NOTE:* If you're using Ruby `>= 2.0`, you'll need to use Faraday from `>= 0.8.9`. Versions before this seem to have some weird behavior with `mail_room`.
 
-The default delivery method, requires `delivery_url` and `delivery_token` in 
+The default delivery method, requires `delivery_url` and `delivery_token` in
 configuration.
 
-As the postback is essentially using your app as if it were an API endpoint, 
-you may need to disable forgery protection as you would with a JSON API. In 
-our case, the postback is plaintext, but the protection will still need to be 
+As the postback is essentially using your app as if it were an API endpoint,
+you may need to disable forgery protection as you would with a JSON API. In
+our case, the postback is plaintext, but the protection will still need to be
 disabled.
 
 ### sidekiq ###
@@ -105,6 +119,8 @@ Configured with `:delivery_method: sidekiq`.
 Delivery options:
 - **redis_url**: The Redis server to connect with. Use the same Redis URL that's used to configure Sidekiq.
   Required, defaults to `redis://localhost:6379`.
+- **sentinels**: A list of sentinels servers used to provide HA to Redis. (see [Sentinel Support](#sentinel-support))
+  Optional.
 - **namespace**: The Redis namespace Sidekiq works under. Use the same Redis namespace that's used to configure Sidekiq.
   Optional.
 - **queue**: The Sidekiq queue the job is pushed onto. Make sure Sidekiq actually reads off this queue.
@@ -224,20 +240,57 @@ When running multiple instances of MailRoom against a single mailbox, to try to
     :delivery_options:
       :delivery_url: "http://localhost:3000/inbox"
       :delivery_token: "abcdefg"
-     
+
     :arbitration_method: redis
     :arbitration_options:
       # The Redis server to connect with. Defaults to redis://localhost:6379.
       :redis_url: redis://redis.example.com:6379
-      # The Redis namespace to house the Redis keys under. Optional. 
+      # The Redis namespace to house the Redis keys under. Optional.
       :namespace: mail_room
+  -
+    :email: "user2@gmail.com"
+    :password: "password"
+    :name: "inbox"
+    :delivery_method: postback
+    :delivery_options:
+      :delivery_url: "http://localhost:3000/inbox"
+      :delivery_token: "abcdefg"
 
+    :arbitration_method: redis
+    :arbitration_options:
+      # When pointing to sentinel, follow this sintax for redis URLs:
+      # redis://:<password>@<master-name>/
+      :redis_url: redis://:password@my-redis-sentinel/
+      :sentinels:
+        -
+          :host: 127.0.0.1
+          :port: 26379
+      # The Redis namespace to house the Redis keys under. Optional.
+      :namespace: mail_room
 ```
 
 **Note:** This will likely never be a _perfect_ system for preventing multiple deliveries of the same message, so I would advise checking the unique `message_id` if you are running in this situation.
 
 **Note:** There are other scenarios for preventing duplication of messages at scale that _may_ be more appropriate in your particular setup. One such example is using multiple inboxes in reply-by-email situations. Another is to use labels and configure a different `SEARCH` command for each instance of MailRoom.
 
+## Sentinel Support
+
+Redis Sentinel provides high availability for Redis. Please read their [documentation](http://redis.io/topics/sentinel)
+first, before enabling it with mail_room.
+
+To connect to a Sentinel, you need to setup authentication to both sentinels and redis daemons first, and make sure
+both are binding to a reachable IP address.
+
+In mail_room, when you are connecting to a Sentinel, you have to inform the `master-name` and the `password` through
+`redis_url` param, following this syntax:
+
+```
+redis://:<password>@<master-name>/
+```
+
+You also have to inform at least one pair of `host` and `port` for a sentinel in your cluster.
+To have a minimum reliable setup, you need at least `3` sentinel nodes and `3` redis servers (1 master, 2 slaves).
+
 ## Contributing ##
 
 1. Fork it

data/lib/mail_room/arbitration/redis.rb

@@ -3,12 +3,13 @@ require "redis"
 module MailRoom
   module Arbitration
     class Redis
-      Options = Struct.new(:redis_url, :namespace) do
+      Options = Struct.new(:redis_url, :namespace, :sentinels) do
         def initialize(mailbox)
           redis_url = mailbox.arbitration_options[:redis_url] || "redis://localhost:6379"
           namespace = mailbox.arbitration_options[:namespace]
+          sentinels = mailbox.arbitration_options[:sentinels]
 
-          super(redis_url, namespace)
+          super(redis_url, namespace, sentinels)
         end
       end
 
@@ -25,12 +26,12 @@ module MailRoom
         key = "delivered:#{uid}"
 
         incr = nil
-        redis.multi do |client|
-          # At this point, `incr` is a future, which will get its value after 
+        client.multi do |c|
+          # At this point, `incr` is a future, which will get its value after
           # the MULTI command returns.
-          incr = client.incr(key)
+          incr = c.incr(key)
 
-          client.expire(key, EXPIRATION)
+          c.expire(key, EXPIRATION)
         end
 
         # If INCR returns 1, that means the key didn't exist before, which means
@@ -42,9 +43,13 @@ module MailRoom
 
       private
 
-      def redis
-        @redis ||= begin
-          redis = ::Redis.new(url: options.redis_url)
+      def client
+        @client ||= begin
+          sentinels = options.sentinels
+          redis_options = { url: options.redis_url }
+          redis_options[:sentinels] = sentinels if sentinels
+
+          redis = ::Redis.new(redis_options)
 
           namespace = options.namespace
           if namespace

data/lib/mail_room/delivery/sidekiq.rb

@@ -8,14 +8,15 @@ module MailRoom
     # Sidekiq Delivery method
     # @author Douwe Maan
     class Sidekiq
-      Options = Struct.new(:redis_url, :namespace, :queue, :worker) do
+      Options = Struct.new(:redis_url, :namespace, :sentinels, :queue, :worker) do
         def initialize(mailbox)
           redis_url = mailbox.delivery_options[:redis_url] || "redis://localhost:6379"
           namespace = mailbox.delivery_options[:namespace]
+          sentinels = mailbox.delivery_options[:sentinels]
           queue     = mailbox.delivery_options[:queue] || "default"
           worker    = mailbox.delivery_options[:worker]
 
-          super(redis_url, namespace, queue, worker)
+          super(redis_url, namespace, sentinels, queue, worker)
         end
       end
 
@@ -40,14 +41,20 @@ module MailRoom
       private
 
       def client
-        client = Redis.new(url: options.redis_url)
-
-        namespace = options.namespace
-        if namespace
-          require 'redis/namespace'
-          Redis::Namespace.new(namespace, redis: client)
-        else
-          client
+        @client ||= begin
+          sentinels = options.sentinels
+          redis_options = { url: options.redis_url }
+          redis_options[:sentinels] = sentinels if sentinels
+
+          redis = ::Redis.new(redis_options)
+
+          namespace = options.namespace
+          if namespace
+            require 'redis/namespace'
+            Redis::Namespace.new(namespace, redis: redis)
+          else
+            redis
+          end
         end
       end
 

data/lib/mail_room/version.rb

@@ -1,4 +1,4 @@
 module MailRoom
   # Current version of MailRoom gem
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/spec/lib/arbitration/redis_spec.rb

@@ -2,18 +2,18 @@ require 'spec_helper'
 require 'mail_room/arbitration/redis'
 
 describe MailRoom::Arbitration::Redis do
-  let(:mailbox) { 
+  let(:mailbox) {
     MailRoom::Mailbox.new(
       arbitration_options: {
         namespace: "mail_room"
       }
-    ) 
+    )
   }
   let(:options) { described_class::Options.new(mailbox) }
   subject       { described_class.new(options) }
 
   # Private, but we don't care.
-  let(:redis) { subject.send(:redis) }
+  let(:client) { subject.send(:client) }
 
   describe '#deliver?' do
     context "when called the first time" do
@@ -24,13 +24,13 @@ describe MailRoom::Arbitration::Redis do
       it "increments the delivered flag" do
         subject.deliver?(123)
 
-        expect(redis.get("delivered:123")).to eq("1")
+        expect(client.get("delivered:123")).to eq("1")
       end
 
       it "sets an expiration on the delivered flag" do
         subject.deliver?(123)
 
-        expect(redis.ttl("delivered:123")).to be > 0
+        expect(client.ttl("delivered:123")).to be > 0
       end
     end
 
@@ -46,7 +46,7 @@ describe MailRoom::Arbitration::Redis do
       it "increments the delivered flag" do
         subject.deliver?(123)
 
-        expect(redis.get("delivered:123")).to eq("2")
+        expect(client.get("delivered:123")).to eq("2")
       end
     end
 
@@ -60,4 +60,68 @@ describe MailRoom::Arbitration::Redis do
       end
     end
   end
+
+  context 'redis client connection params' do
+    context 'when only url is present' do
+      let(:redis_url) { "redis://redis.example.com:8888" }
+      let(:mailbox) {
+        MailRoom::Mailbox.new(
+          arbitration_options: {
+            redis_url: redis_url
+          }
+        )
+      }
+
+      it 'client has same specified url' do
+        subject.deliver?(123)
+
+        expect(client.options[:url]).to eq redis_url
+      end
+
+      it 'client is a instance of Redis class' do
+        expect(client).to be_a Redis
+      end
+    end
+
+    context 'when namespace is present' do
+      let(:namespace) { 'mail_room' }
+      let(:mailbox) {
+        MailRoom::Mailbox.new(
+          arbitration_options: {
+            namespace: namespace
+          }
+        )
+      }
+
+      it 'client has same specified namespace' do
+        expect(client.namespace).to eq(namespace)
+      end
+
+      it 'client is a instance of RedisNamespace class' do
+        expect(client).to be_a ::Redis::Namespace
+      end
+    end
+
+    context 'when sentinel is present' do
+      let(:redis_url) { 'redis://:mypassword@sentinel-master:6379' }
+      let(:sentinels) { [{ host: '10.0.0.1', port: '26379' }] }
+      let(:mailbox) {
+        MailRoom::Mailbox.new(
+          arbitration_options: {
+            redis_url: redis_url,
+            sentinels: sentinels
+          }
+        )
+      }
+
+      before { ::Redis::Client::Connector::Sentinel.any_instance.stubs(:resolve).returns(sentinels) }
+
+      it 'client has same specified sentinel params' do
+        expect(client.client.instance_variable_get(:@connector)).to be_a Redis::Client::Connector::Sentinel
+        expect(client.client.options[:host]).to eq('sentinel-master')
+        expect(client.client.options[:password]).to eq('mypassword')
+        expect(client.client.options[:sentinels]).to eq(sentinels)
+      end
+    end
+  end
 end

data/spec/lib/delivery/sidekiq_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'mail_room/delivery/sidekiq'
+
+describe MailRoom::Delivery::Sidekiq do
+  subject { described_class.new(options) }
+  let(:redis) { subject.send(:client) }
+  let(:options) { MailRoom::Delivery::Sidekiq::Options.new(mailbox) }
+
+  describe '#options' do
+    let(:redis_url) { 'redis://redis.example.com' }
+
+    context 'when only redis_url is specified' do
+      let(:mailbox) {
+        MailRoom::Mailbox.new(
+          delivery_method: :sidekiq,
+          delivery_options: {
+            redis_url: redis_url
+          }
+        )
+      }
+
+      it 'client has same specified redis_url' do
+        expect(redis.options[:url]).to eq(redis_url)
+      end
+
+      it 'client is a instance of RedisNamespace class' do
+        expect(redis).to be_a ::Redis
+      end
+    end
+
+    context 'when namespace is specified' do
+      let(:namespace) { 'sidekiq_mailman' }
+      let(:mailbox) {
+        MailRoom::Mailbox.new(
+          delivery_method: :sidekiq,
+          delivery_options: {
+            redis_url: redis_url,
+            namespace: namespace
+          }
+        )
+      }
+
+      it 'client has same specified namespace' do
+        expect(redis.namespace).to eq(namespace)
+      end
+
+      it 'client is a instance of RedisNamespace class' do
+        expect(redis).to be_a ::Redis::Namespace
+      end
+    end
+
+    context 'when sentinel is specified' do
+      let(:redis_url) { 'redis://:mypassword@sentinel-master:6379' }
+      let(:sentinels) { [{ host: '10.0.0.1', port: '26379' }] }
+      let(:mailbox) {
+        MailRoom::Mailbox.new(
+          delivery_method: :sidekiq,
+          delivery_options: {
+            redis_url: redis_url,
+            sentinels: sentinels
+          }
+        )
+      }
+
+      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)
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_room
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -187,6 +187,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
@@ -226,6 +227,7 @@ files:
 - spec/lib/delivery/logger_spec.rb
 - spec/lib/delivery/postback_spec.rb
 - spec/lib/delivery/que_spec.rb
+- spec/lib/delivery/sidekiq_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb
 - spec/spec_helper.rb
@@ -264,6 +266,7 @@ test_files:
 - spec/lib/delivery/logger_spec.rb
 - spec/lib/delivery/postback_spec.rb
 - spec/lib/delivery/que_spec.rb
+- spec/lib/delivery/sidekiq_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb
 - spec/spec_helper.rb