mail_room 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18fcfd6db34934950b927ff4a8ab959e93e12eed
-  data.tar.gz: c1b229e83fe719ce86f0f72f1b14f32a7a8b4f3e
+  metadata.gz: ceb4dec276d2d4f97fe52bfad9bfe8d6872007dd
+  data.tar.gz: 84b9d66207d812a0a086dedab6d8362c2468c3e6
 SHA512:
-  metadata.gz: a73241070478126fbd770ae7b3fba7b443c86a732b79f9c3976f7e1296a07cb9262f44eeaf356e0e51f85c793edac2b37d81d0b588d0138e4a0eacf9cc94b2f5
-  data.tar.gz: 24d8dfc3bbcf59ed3ca84780992a75867af6568d503edfb7b40e4b99560aee3004569156f0cc8d3bde94c51fb87a1444fd373b269fdb730b0f801a5d357ee9ec
+  metadata.gz: 1547d51516853487da839d8ff00fe70be46dacb9689b8f47227cc55fbd5399de83a191ecf4e8e844bf86052d6d2406891b327a68e978b7527fca45da9bff4643
+  data.tar.gz: 3175e36ca4515ee0e9b1d85301bbdb8cb991b4509330b29efd8a4f3cf294e15f856d07cd8f6ff7e252849175f5a1495d7a9ff46d777afbb87fcabe8267f90acc

data/.travis.yml

@@ -5,3 +5,4 @@ rvm:
   - 2.1.5
   - 2.2.0
 script: bundle exec rspec spec
+sudo: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## mail_room 0.5.0 ##
+
+* Que delivery method
+
+    *Tony Pitale <@tpitale>*
+
 ## mail_room 0.4.2 ##
 
 * rescue from all IOErrors, not just EOFError

data/README.md

@@ -1,6 +1,10 @@
 # mail_room #
 
-mail_room is a configuration based process that will idle on IMAP connections and POST to a delivery URL whenever a new message is received on the configured mailbox and folder.
+mail_room is a configuration based process that will idle on IMAP connections and execute a delivery method when a new message is received. Examples of delivery methods include:
+
+* POST to a delivery URL (Postback)
+* Queue a job to Sidekiq or Que for later processing (Sidekiq or Que)
+* Log the message or open with LetterOpener (Logger or LetterOpener)
 
 [![Build Status](https://travis-ci.org/tpitale/mail_room.png?branch=master)](https://travis-ci.org/tpitale/mail_room)
 [![Code Climate](https://codeclimate.com/github/tpitale/mail_room.png)](https://codeclimate.com/github/tpitale/mail_room)
@@ -123,6 +127,40 @@ class EmailReceiverWorker
 end
 ```
 
+### que ###
+
+Deliver the message by pushing it onto the configured Que queue to be handled by a custom worker.
+
+Requires `pg` gem to be installed.
+
+Configured with `:delivery_method: que`.
+
+Delivery options:
+- **host**: The postgresql server host to connect with. Use the database you use with Que.
+  Required, defaults to `localhost`.
+- **port**: The postgresql server port to connect with. Use the database you use with Que.
+  Required, defaults to `5432`.
+- **database**: The postgresql database to use. Use the database you use with Que.
+  Required.
+- **queue**: The Que queue the job is pushed onto. Make sure Que actually reads off this queue.
+  Required, defaults to `default`.
+- **job_class**: The worker class that will handle the message.
+  Required.
+- **priority**: The priority you want this job to run at.
+  Required, defaults to `100`, lowest Que default priority.
+
+An example worker implementation looks like this:
+
+```ruby
+class EmailReceiverJob < Que::Job
+  def run(message)
+    mail = Mail::Message.new(message)
+
+    puts "New mail from #{mail.from.first}: #{mail.subject}"
+  end
+end
+```
+
 ### logger ###
 
 Configured with `:delivery_method: logger`.

data/lib/mail_room/delivery/que.rb

@@ -0,0 +1,61 @@
+require 'pg'
+require 'json'
+
+module MailRoom
+  module Delivery
+    # Que Delivery method
+    # @author Tony Pitale
+    class Que
+      Options = Struct.new(:host, :port, :database, :username, :password, :queue, :priority, :job_class) do
+        def initialize(mailbox)
+          host = mailbox.delivery_options[:host] || "localhost"
+          port = mailbox.delivery_options[:port] || 5432
+          database = mailbox.delivery_options[:database]
+          username = mailbox.delivery_options[:username]
+          password = mailbox.delivery_options[:password]
+
+          queue = mailbox.delivery_options[:queue] || ''
+          priority = mailbox.delivery_options[:priority] || 100 # lowest priority for Que
+          job_class = mailbox.delivery_options[:job_class]
+
+          super(host, port, database, username, password, queue, priority, job_class)
+        end
+      end
+
+      attr_reader :options
+
+      # Build a new delivery, hold the mailbox configuration
+      # @param [MailRoom::Delivery::Que::Options]
+      def initialize(options)
+        @options = options
+      end
+
+      # deliver the message by pushing it onto the configured Sidekiq queue
+      # @param message [String] the email message as a string, RFC822 format
+      def deliver(message)
+        queue_job(message)
+      end
+
+      private
+      def connection
+        PG.connect(connection_options)
+      end
+
+      def connection_options
+        {
+          host: options.host,
+          port: options.port,
+          dbname: options.database,
+          user: options.username,
+          password: options.password
+        }
+      end
+
+      def queue_job(*args)
+        sql = "INSERT INTO que_jobs (priority, job_class, queue, args) VALUES ($1, $2, $3, $4)"
+
+        connection.exec(sql, [options.priority, options.job_class, options.queue, JSON.dump(args)])
+      end
+    end
+  end
+end

data/lib/mail_room/delivery/sidekiq.rb

@@ -4,8 +4,8 @@ require "json"
 
 module MailRoom
   module Delivery
-    # Postback Delivery method
-    # @author Tony Pitale
+    # Sidekiq Delivery method
+    # @author Douwe Maan
     class Sidekiq
       Options = Struct.new(:redis_url, :namespace, :queue, :worker) do
         def initialize(mailbox)
@@ -21,7 +21,7 @@ module MailRoom
       attr_accessor :options
 
       # Build a new delivery, hold the mailbox configuration
-      # @param [MailRoom::Mailbox]
+      # @param [MailRoom::Delivery::Sidekiq::Options]
       def initialize(options)
         @options = options
       end

data/lib/mail_room/mailbox.rb

@@ -50,6 +50,8 @@ module MailRoom
         Delivery::LetterOpener
       when "sidekiq"
         Delivery::Sidekiq
+      when "que"
+        Delivery::Que
       else
         Delivery::Postback
       end

data/lib/mail_room/version.rb

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

data/mail_room.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "mail"
   gem.add_development_dependency "letter_opener"
   gem.add_development_dependency "redis"
+  gem.add_development_dependency "pg"
 end

data/spec/lib/delivery/que_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'mail_room/delivery/que'
+
+describe MailRoom::Delivery::Que do
+  describe '#deliver' do
+    let(:mailbox) {MailRoom::Mailbox.new({
+      delivery_options: {
+        database: 'delivery_test',
+        username: 'postgres',
+        password: '',
+        queue: 'default',
+        priority: 5,
+        job_class: 'ParseMailJob'
+      }
+    })}
+
+    let(:connection) {stub}
+    let(:options) {MailRoom::Delivery::Que::Options.new(mailbox)}
+
+    it 'stores the message in que_jobs table' do
+      PG.stubs(:connect).returns(connection)
+      connection.stubs(:exec)
+
+      MailRoom::Delivery::Que.new(options).deliver('email')
+
+      expect(PG).to have_received(:connect).with({
+        host: 'localhost',
+        port: 5432,
+        dbname: 'delivery_test',
+        user: 'postgres',
+        password: ''
+      })
+
+      expect(connection).to have_received(:exec).with(
+        "INSERT INTO que_jobs (priority, job_class, queue, args) VALUES ($1, $2, $3, $4)",
+        [
+          5,
+          'ParseMailJob',
+          'default',
+          JSON.dump(['email'])
+        ]
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_room
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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
@@ -162,6 +176,7 @@ files:
 - lib/mail_room/delivery/logger.rb
 - lib/mail_room/delivery/noop.rb
 - lib/mail_room/delivery/postback.rb
+- lib/mail_room/delivery/que.rb
 - lib/mail_room/delivery/sidekiq.rb
 - lib/mail_room/mailbox.rb
 - lib/mail_room/mailbox_handler.rb
@@ -175,6 +190,7 @@ files:
 - spec/lib/delivery/letter_opener_spec.rb
 - spec/lib/delivery/logger_spec.rb
 - spec/lib/delivery/postback_spec.rb
+- spec/lib/delivery/que_spec.rb
 - spec/lib/mailbox_handler_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb
@@ -211,6 +227,7 @@ test_files:
 - spec/lib/delivery/letter_opener_spec.rb
 - spec/lib/delivery/logger_spec.rb
 - spec/lib/delivery/postback_spec.rb
+- spec/lib/delivery/que_spec.rb
 - spec/lib/mailbox_handler_spec.rb
 - spec/lib/mailbox_spec.rb
 - spec/lib/mailbox_watcher_spec.rb