mail_room 0.9.1 → 0.10.0

data/lib/mail_room/mailbox_watcher.rb

@@ -23,6 +23,7 @@ module MailRoom
 
     # run the mailbox watcher
     def run
+      @mailbox.logger.info({ context: @mailbox.context, action: "Setting up watcher" })
       @running = true
 
       connection.on_new_message do |message|
@@ -40,6 +41,7 @@ module MailRoom
 
     # stop running, cleanup connection
     def quit
+      @mailbox.logger.info({ context: @mailbox.context, action: "Quitting connection..." })
       @running = false
 
       if @connection

data/lib/mail_room/version.rb

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

data/logfile.log

@@ -0,0 +1 @@
+# Logfile created on 2019-09-26 08:59:35 -0500 by logger.rb/66358

data/mail_room.gemspec

@@ -22,12 +22,12 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "mocha"
   gem.add_development_dependency "bourne"
   gem.add_development_dependency "simplecov"
-  gem.add_development_dependency "fakeredis"
 
   # for testing delivery methods
   gem.add_development_dependency "faraday"
   gem.add_development_dependency "mail"
   gem.add_development_dependency "letter_opener"
+  gem.add_development_dependency "redis", "~> 3.3.1"
   gem.add_development_dependency "redis-namespace"
   gem.add_development_dependency "pg"
   gem.add_development_dependency "charlock_holmes"

data/spec/fixtures/test_config.yml

@@ -6,6 +6,8 @@
     :name: "inbox"
     :delivery_url: "http://localhost:3000/inbox"
     :delivery_token: "abcdefg"
+    :logger:
+      :log_path: "logfile.log"
   -
     :email: "user2@gmail.com"
     :password: "password"

data/spec/lib/arbitration/redis_spec.rb

@@ -3,7 +3,7 @@ require 'mail_room/arbitration/redis'
 
 describe MailRoom::Arbitration::Redis do
   let(:mailbox) {
-    MailRoom::Mailbox.new(
+    build_mailbox(
       arbitration_options: {
         namespace: "mail_room"
       }
@@ -13,10 +13,14 @@ describe MailRoom::Arbitration::Redis do
   subject       { described_class.new(options) }
 
   # Private, but we don't care.
-  let(:client) { subject.send(:client) }
+  let(:redis) { subject.send(:client) }
 
   describe '#deliver?' do
     context "when called the first time" do
+      after do
+        redis.del("delivered:123")
+      end
+
       it "returns true" do
         expect(subject.deliver?(123)).to be_truthy
       end
@@ -24,29 +28,35 @@ describe MailRoom::Arbitration::Redis do
       it "increments the delivered flag" do
         subject.deliver?(123)
 
-        expect(client.get("delivered:123")).to eq("1")
+        expect(redis.get("delivered:123")).to eq("1")
       end
 
       it "sets an expiration on the delivered flag" do
         subject.deliver?(123)
 
-        expect(client.ttl("delivered:123")).to be > 0
+        expect(redis.ttl("delivered:123")).to be > 0
       end
     end
 
     context "when called the second time" do
       before do
-        subject.deliver?(123)
+        #Short expiration, 1 second, for testing
+        subject.deliver?(123, 1)
       end
 
-      it "returns false" do
-        expect(subject.deliver?(123)).to be_falsey
+      after do
+        redis.del("delivered:123")
       end
 
-      it "increments the delivered flag" do
-        subject.deliver?(123)
+      it "returns false" do
+        expect(subject.deliver?(123, 1)).to be_falsey
+      end
 
-        expect(client.get("delivered:123")).to eq("2")
+      it "after expiration returns true" do
+        # Fails locally because fakeredis returns 0, not false
+        expect(subject.deliver?(123, 1)).to be_falsey
+        sleep(redis.ttl("delivered:123")+1)
+        expect(subject.deliver?(123, 1)).to be_truthy
       end
     end
 
@@ -55,38 +65,47 @@ describe MailRoom::Arbitration::Redis do
         subject.deliver?(123)
       end
 
+      after do
+        redis.del("delivered:123")
+        redis.del("delivered:124")
+      end
+
       it "returns true" do
-        expect(subject.deliver?(234)).to be_truthy
+        expect(subject.deliver?(124)).to be_truthy
       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(:redis_url) { "redis://localhost:6379" }
       let(:mailbox) {
-        MailRoom::Mailbox.new(
+        build_mailbox(
           arbitration_options: {
             redis_url: redis_url
           }
         )
       }
 
+      after do
+        redis.del("delivered:123")
+      end
+
       it 'client has same specified url' do
         subject.deliver?(123)
 
-        expect(client.options[:url]).to eq redis_url
+        expect(redis.client.options[:url]).to eq redis_url
       end
 
       it 'client is a instance of Redis class' do
-        expect(client).to be_a Redis
+        expect(redis).to be_a Redis
       end
     end
 
     context 'when namespace is present' do
       let(:namespace) { 'mail_room' }
       let(:mailbox) {
-        MailRoom::Mailbox.new(
+        build_mailbox(
           arbitration_options: {
             namespace: namespace
           }
@@ -94,11 +113,11 @@ describe MailRoom::Arbitration::Redis do
       }
 
       it 'client has same specified namespace' do
-        expect(client.namespace).to eq(namespace)
+        expect(redis.namespace).to eq(namespace)
       end
 
       it 'client is a instance of RedisNamespace class' do
-        expect(client).to be_a ::Redis::Namespace
+        expect(redis).to be_a ::Redis::Namespace
       end
     end
 
@@ -106,7 +125,7 @@ describe MailRoom::Arbitration::Redis do
       let(:redis_url) { 'redis://:mypassword@sentinel-master:6379' }
       let(:sentinels) { [{ host: '10.0.0.1', port: '26379' }] }
       let(:mailbox) {
-        MailRoom::Mailbox.new(
+        build_mailbox(
           arbitration_options: {
             redis_url: redis_url,
             sentinels: sentinels
@@ -117,10 +136,10 @@ describe MailRoom::Arbitration::Redis do
       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)
+        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

data/spec/lib/configuration_spec.rb

@@ -4,22 +4,26 @@ describe MailRoom::Configuration do
   let(:config_path) {File.expand_path('../fixtures/test_config.yml', File.dirname(__FILE__))}
 
   describe 'set_mailboxes' do
-    it 'parses yaml into mailbox objects' do
-      MailRoom::Mailbox.stubs(:new).returns('mailbox1', 'mailbox2')
+    context 'with config_path' do
+      let(:configuration) { MailRoom::Configuration.new(:config_path => config_path) }
 
-      configuration = MailRoom::Configuration.new(:config_path => config_path)
+      it 'parses yaml into mailbox objects' do
+        MailRoom::Mailbox.stubs(:new).returns('mailbox1', 'mailbox2')
 
-      expect(configuration.mailboxes).to eq(['mailbox1', 'mailbox2'])
+        expect(configuration.mailboxes).to eq(['mailbox1', 'mailbox2'])
+      end
     end
 
-    it 'sets mailboxes to an empty set when config_path is missing' do
-      MailRoom::Mailbox.stubs(:new)
+    context 'without config_path' do
+      let(:configuration) { MailRoom::Configuration.new }
 
-      configuration = MailRoom::Configuration.new
+      it 'sets mailboxes to an empty set' do
+        MailRoom::Mailbox.stubs(:new)
 
-      expect(configuration.mailboxes).to eq([])
+        expect(configuration.mailboxes).to eq([])
 
-      expect(MailRoom::Mailbox).to have_received(:new).never
+        expect(MailRoom::Mailbox).to have_received(:new).never
+      end
     end
   end
 end

data/spec/lib/connection_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe MailRoom::Connection do
   let(:imap) {stub}
-  let(:mailbox) {MailRoom::Mailbox.new(delete_after_delivery: true)}
+  let(:mailbox) {build_mailbox(delete_after_delivery: true, expunge_deleted: true)}
 
   before :each do
-    MailRoom::IMAP.stubs(:new).returns(imap)
+    Net::IMAP.stubs(:new).returns(imap)
   end
 
   context "with imap set up" do
@@ -50,6 +50,7 @@ describe MailRoom::Connection do
       imap.stubs(:uid_search).returns([]).then.returns([1])
       imap.stubs(:uid_fetch).returns([new_message])
       imap.stubs(:store)
+      imap.stubs(:expunge)
 
       connection.wait
 
@@ -58,6 +59,7 @@ describe MailRoom::Connection do
       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/delivery/letter_opener_spec.rb

@@ -3,7 +3,7 @@ require 'mail_room/delivery/letter_opener'
 
 describe MailRoom::Delivery::LetterOpener do
   describe '#deliver' do
-    let(:mailbox) {MailRoom::Mailbox.new(:location => '/tmp/somewhere')}
+    let(:mailbox) {build_mailbox(:location => '/tmp/somewhere')}
     let(:delivery_method) {stub(:deliver!)}
     let(:mail) {stub}
 

data/spec/lib/delivery/logger_spec.rb

@@ -4,7 +4,7 @@ require 'mail_room/delivery/logger'
 describe MailRoom::Delivery::Logger do
   describe '#initialize' do
     context "without a log path" do
-      let(:mailbox) {MailRoom::Mailbox.new}
+      let(:mailbox) {build_mailbox}
 
       it 'creates a new ruby logger' do
         ::Logger.stubs(:new)
@@ -16,7 +16,7 @@ describe MailRoom::Delivery::Logger do
     end
 
     context "with a log path" do
-      let(:mailbox) {MailRoom::Mailbox.new(:log_path => '/var/log/mail-room.log')}
+      let(:mailbox) {build_mailbox(:log_path => '/var/log/mail-room.log')}
 
       it 'creates a new file to append to' do
         ::Logger.stubs(:new)
@@ -32,7 +32,7 @@ describe MailRoom::Delivery::Logger do
   end
 
   describe '#deliver' do
-    let(:mailbox) {MailRoom::Mailbox.new}
+    let(:mailbox) {build_mailbox}
 
     it 'writes the message to info' do
       logger = stub(:info)

data/spec/lib/delivery/postback_spec.rb

@@ -3,29 +3,69 @@ require 'mail_room/delivery/postback'
 
 describe MailRoom::Delivery::Postback do
   describe '#deliver' do
-    let(:mailbox) {MailRoom::Mailbox.new({
-      :delivery_url => 'http://localhost/inbox',
-      :delivery_token => 'abcdefg'
-    })}
+    context 'with token auth delivery' do
+      let(:mailbox) {build_mailbox({
+        :delivery_url => 'http://localhost/inbox',
+        :delivery_token => 'abcdefg'
+      })}
 
-    it 'posts the message with faraday' do
-      connection = stub
-      request = stub
-      Faraday.stubs(:new).returns(connection)
+      let(:delivery_options) {
+        MailRoom::Delivery::Postback::Options.new(mailbox)
+      }
 
-      connection.stubs(:token_auth)
-      connection.stubs(:post).yields(request)
+      it 'posts the message with faraday' do
+        connection = stub
+        request = stub
+        Faraday.stubs(:new).returns(connection)
 
-      request.stubs(:url)
-      request.stubs(:body=)
+        connection.stubs(:token_auth)
+        connection.stubs(:post).yields(request)
 
-      MailRoom::Delivery::Postback.new(mailbox).deliver('a message')
+        request.stubs(:url)
+        request.stubs(:body=)
 
-      expect(connection).to have_received(:token_auth).with('abcdefg')
-      expect(connection).to have_received(:post)
+        MailRoom::Delivery::Postback.new(delivery_options).deliver('a message')
 
-      expect(request).to have_received(:url).with('http://localhost/inbox')
-      expect(request).to have_received(:body=).with('a message')
+        expect(connection).to have_received(:token_auth).with('abcdefg')
+        expect(connection).to have_received(:post)
+
+        expect(request).to have_received(:url).with('http://localhost/inbox')
+        expect(request).to have_received(:body=).with('a message')
+      end
+    end
+
+    context 'with basic auth delivery options' do
+      let(:mailbox) {build_mailbox({
+        :delivery_options => {
+          :url => 'http://localhost/inbox',
+          :username => 'user1',
+          :password => 'password123abc'
+        }
+      })}
+
+      let(:delivery_options) {
+        MailRoom::Delivery::Postback::Options.new(mailbox)
+      }
+
+      it 'posts the message with faraday' do
+        connection = stub
+        request = stub
+        Faraday.stubs(:new).returns(connection)
+
+        connection.stubs(:basic_auth)
+        connection.stubs(:post).yields(request)
+
+        request.stubs(:url)
+        request.stubs(:body=)
+
+        MailRoom::Delivery::Postback.new(delivery_options).deliver('a message')
+
+        expect(connection).to have_received(:basic_auth).with('user1', 'password123abc')
+        expect(connection).to have_received(:post)
+
+        expect(request).to have_received(:url).with('http://localhost/inbox')
+        expect(request).to have_received(:body=).with('a message')
+      end
     end
   end
 end

data/spec/lib/delivery/que_spec.rb

@@ -3,7 +3,7 @@ require 'mail_room/delivery/que'
 
 describe MailRoom::Delivery::Que do
   describe '#deliver' do
-    let(:mailbox) {MailRoom::Mailbox.new({
+    let(:mailbox) {build_mailbox({
       delivery_options: {
         database: 'delivery_test',
         username: 'postgres',

data/spec/lib/delivery/sidekiq_spec.rb

@@ -7,11 +7,11 @@ describe MailRoom::Delivery::Sidekiq do
   let(:options) { MailRoom::Delivery::Sidekiq::Options.new(mailbox) }
 
   describe '#options' do
-    let(:redis_url) { 'redis://redis.example.com' }
+    let(:redis_url) { 'redis://localhost' }
 
     context 'when only redis_url is specified' do
       let(:mailbox) {
-        MailRoom::Mailbox.new(
+        build_mailbox(
           delivery_method: :sidekiq,
           delivery_options: {
             redis_url: redis_url
@@ -20,7 +20,7 @@ describe MailRoom::Delivery::Sidekiq do
       }
 
       it 'client has same specified redis_url' do
-        expect(redis.options[:url]).to eq(redis_url)
+        expect(redis.client.options[:url]).to eq(redis_url)
       end
 
       it 'client is a instance of RedisNamespace class' do
@@ -31,7 +31,7 @@ describe MailRoom::Delivery::Sidekiq do
     context 'when namespace is specified' do
       let(:namespace) { 'sidekiq_mailman' }
       let(:mailbox) {
-        MailRoom::Mailbox.new(
+        build_mailbox(
           delivery_method: :sidekiq,
           delivery_options: {
             redis_url: redis_url,
@@ -53,7 +53,7 @@ describe MailRoom::Delivery::Sidekiq do
       let(:redis_url) { 'redis://:mypassword@sentinel-master:6379' }
       let(:sentinels) { [{ host: '10.0.0.1', port: '26379' }] }
       let(:mailbox) {
-        MailRoom::Mailbox.new(
+        build_mailbox(
           delivery_method: :sidekiq,
           delivery_options: {
             redis_url: redis_url,

data/spec/lib/logger/structured_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe MailRoom::Logger::Structured do
+
+  subject { described_class.new $stdout }
+
+  let!(:now) { Time.now }
+  let(:message) { { action: 'exciting development', message: 'testing 123' } }
+
+  before do
+    Time.stubs(:now).returns(now)
+  end
+
+  [:debug, :info, :warn, :error, :fatal].each do |level|
+    it "logs #{level}" do
+      expect { subject.send(level, message) }.to output(json_matching(level.to_s.upcase, message)).to_stdout_from_any_process
+    end
+  end
+
+  it 'logs unknown' do
+    expect { subject.unknown(message) }.to output(json_matching("ANY", message)).to_stdout_from_any_process
+  end
+
+  it 'only accepts strings' do
+    expect { subject.unknown("just a string!") }.to raise_error(ArgumentError, /must be a Hash/)
+  end
+
+  context 'logging a hash as a message' do
+    it 'merges the contents' do
+      input = {
+          additional_field: "some value"
+      }
+      expected = {
+          severity: 'DEBUG',
+          time: now,
+          additional_field: "some value"
+      }
+
+      expect { subject.debug(input) }.to output(as_regex(expected)).to_stdout_from_any_process
+    end
+  end
+
+  def json_matching(level, message)
+    contents = {
+        severity: level,
+        time: now
+    }.merge(message)
+
+    as_regex(contents)
+  end
+
+  def as_regex(contents)
+    /#{Regexp.quote(contents.to_json)}/
+  end
+end