mail_room 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c0b28556cd79e44120d69d286b076cd39af324
-  data.tar.gz: b10afb798abf73ec2ac1c2d414f2b52ed16ee851
+  metadata.gz: 495c36dd61e6ddd5f5a259594d414942055446ad
+  data.tar.gz: 9bb752935c2713d74d9ffb8c0c8b3a57d39f2a1d
 SHA512:
-  metadata.gz: 15825ce04783e5e712ffac32e92bd352de1ea1d1a83914f07bdf2a1ca130e7c4e3be484f1388a4068ac9dbcc4d24847fb04ee790501de55008a7f5c0211a6ecd
-  data.tar.gz: 37edddf51b38af8dc589da7c7ffea01ac3b98370e653c93ca4e917e0dd51aa03632c8921e5cd54be321b3594d73c57ef4ae30e96ea146394bb9977564e0f71fd
+  metadata.gz: d8271126e54103017c167bdbd42138284f863481b9dd3b47bae0e490135d04ad70b5cced5221b1fa64320e8e0e36013c9f6540e426573a0164b394bd28492f86
+  data.tar.gz: a5883a201543fec388de4a86f070592def4a1c22345dbc92f6c0aba149bf862c8179f4532483c256ffd706aba471f392622088d8e6fde186e9bfaf4bdac94325

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.2.2

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## mail_room 0.4.0 ##
+
+* Sidekiq delivery method
+* Option to delete messages after delivered
+
+    *Douwe Mann <@DouweM>*
+
+* -q/--quiet do not raise errors on missing configuration
+* prefetch mail messages before idling
+* delivery-method-specific delivery options configuration
+
+    *Tony Pitale <@tpitale>*
+
 ## mail_room 0.3.1 ##
 
 * Rescue from EOFError and re-setup mailroom

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/README.md

@@ -25,6 +25,8 @@ You will also need to install `faraday` or `letter_opener` if you use the `postb
 
     mail_room -c /path/to/config.yml
 
+**Note:** To ignore missing config file or missing `mailboxes` key, use `-q` or `--quiet`
+
 ## Configuration ##
 
 ```yaml
@@ -34,27 +36,42 @@ You will also need to install `faraday` or `letter_opener` if you use the `postb
     :email: "user1@gmail.com"
     :password: "password"
     :name: "inbox"
-    :delivery_url: "http://localhost:3000/inbox"
-    :delivery_token: "abcdefg"
+    :search_command: 'NEW'
+    :delivery_options:
+      :delivery_url: "http://localhost:3000/inbox"
+      :delivery_token: "abcdefg"
+    
   -
     :email: "user2@gmail.com"
     :password: "password"
     :name: "inbox"
     :delivery_method: postback
-    :delivery_url: "http://localhost:3000/inbox"
-    :delivery_token: "abcdefg"
+    :delivery_options:
+      :delivery_url: "http://localhost:3000/inbox"
+      :delivery_token: "abcdefg"
   -
     :email: "user3@gmail.com"
     :password: "password"
     :name: "inbox"
     :delivery_method: logger
-    :log_path: "/var/log/user3-email.log"
+    :delivery_options:
+      :log_path: "/var/log/user3-email.log"
   -
     :email: "user4@gmail.com"
     :password: "password"
     :name: "inbox"
     :delivery_method: letter_opener
-    :location: "/tmp/user4-email"
+    :delete_after_delivery: true
+    :delivery_options:
+      :location: "/tmp/user4-email"
+  -
+    :email: "user5@gmail.com"
+    :password: "password"
+    :name: "inbox"
+    :delivery_method: sidekiq
+    :delivery_options:
+      :redis_url: redis://localhost:6379
+      :worker: EmailReceiverWorker
 ```
 
 ## delivery_method ##
@@ -73,6 +90,39 @@ 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 ###
+
+Deliver the message by pushing it onto the configured Sidekiq queue to be handled by a custom worker.
+
+Requires `redis` gem to be installed.
+
+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`.
+- **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.
+  Required, defaults to `default`.
+- **worker**: The worker class that will handle the message.
+  Required.
+
+An example worker implementation looks like this:
+
+
+```ruby
+class EmailReceiverWorker
+  include Sidekiq::Worker
+
+  def perform(message)
+    mail = Mail::Message.new(message)
+
+    puts "New mail from #{mail.from.first}: #{mail.subject}"
+  end
+end
+```
+
 ### logger ###
 
 Configured with `:delivery_method: logger`.
@@ -101,6 +151,16 @@ disabled, you can get the raw string of the email using `request.body.read`.
 I would recommend having the `mail` gem bundled and parse the email using
 `Mail.read_from_string(request.body.read)`.
 
+## Search Command ##
+
+This setting allows configuration of the IMAP search command sent to the server. This still defaults 'UNSEEN'. You may find that 'NEW' works better for you.
+
+## IMAP Server Configuration ##
+
+You can set per-mailbox configuration for the IMAP server's `host` (default: 'imap.gmail.com'), `port` (default: 993), and `ssl` (default: true). 
+
+If you're seeing the error `Please log in via your web browser: https://support.google.com/mail/accounts/answer/78754 (Failure)`, you need to configure your Gmail account to allow less secure apps to access it: https://support.google.com/accounts/answer/6010255.
+
 ## Running in Production ##
 
 I suggest running with either upstart or init.d. Check out this wiki page for some example scripts for both: https://github.com/tpitale/mail_room/wiki/Init-Scripts-for-Running-mail_room

data/lib/mail_room/cli.rb

@@ -21,6 +21,10 @@ module MailRoom
           options[:config_path] = path
         end
 
+        parser.on('-q', '--quiet') do
+          options[:quiet] = true
+        end
+
         # parser.on("-l", "--log FILE") do |path|
         #   options[:log_path] = path
         # end

data/lib/mail_room/configuration.rb

@@ -2,16 +2,21 @@ module MailRoom
   # Wraps configuration for a set of individual mailboxes with global config
   # @author Tony Pitale
   class Configuration
-    attr_accessor :mailboxes, :daemonize, :log_path, :pid_path
+    attr_accessor :mailboxes, :daemonize, :log_path, :pid_path, :quiet
 
     # Initialize a new configuration of mailboxes
     def initialize(options={})
       self.mailboxes = []
+      self.quiet = options.fetch(:quiet, false)
 
       if options.has_key?(:config_path)
-        config_file = YAML.load_file(options[:config_path])
+        begin
+          config_file = YAML.load_file(options[:config_path])
 
-        set_mailboxes(config_file[:mailboxes])
+          set_mailboxes(config_file[:mailboxes])
+        rescue => e
+          raise e unless quiet
+        end
       end
     end
 

data/lib/mail_room/delivery/letter_opener.rb

@@ -7,17 +7,27 @@ module MailRoom
     # LetterOpener Delivery method
     # @author Tony Pitale
     class LetterOpener
-      # Build a new delivery, hold the mailbox configuration
-      # @param [MailRoom::Mailbox]
-      def initialize(mailbox)
-        @mailbox = mailbox
+      Options = Struct.new(:location) do
+        def initialize(mailbox)
+          location = mailbox.location || mailbox.delivery_options[:location]
+
+          super(location)
+        end
+      end
+
+      # Build a new delivery, hold the delivery options
+      # @param [MailRoom::Delivery::LetterOpener::Options]
+      def initialize(delivery_options)
+        @delivery_options = delivery_options
       end
 
       # Trigger `LetterOpener` to deliver our message
       # @param message [String] the email message as a string, RFC822 format
       def deliver(message)
-        method = ::LetterOpener::DeliveryMethod.new(:location => @mailbox.location)
+        method = ::LetterOpener::DeliveryMethod.new(:location => @delivery_options.location)
         method.deliver!(Mail.read_from_string(message))
+
+        true
       end
     end
   end

data/lib/mail_room/delivery/logger.rb

@@ -5,11 +5,19 @@ module MailRoom
     # File/STDOUT Logger Delivery method
     # @author Tony Pitale
     class Logger
-      # Build a new delivery, hold the mailbox configuration
-      #   open a file or stdout for IO depending on the configuration
-      # @param [MailRoom::Mailbox]
-      def initialize(mailbox)
-        io = File.open(mailbox.log_path, 'a') if mailbox.log_path
+      Options = Struct.new(:log_path) do
+        def initialize(mailbox)
+          log_path = mailbox.log_path || mailbox.delivery_options[:log_path]
+
+          super(log_path)
+        end
+      end
+
+      # Build a new delivery, hold the delivery options
+      #   open a file or stdout for IO depending on the options
+      # @param [MailRoom::Delivery::Logger::Options]
+      def initialize(delivery_options)
+        io = File.open(delivery_options.log_path, 'a') if delivery_options.log_path
         io ||= STDOUT
 
         io.sync = true
@@ -21,6 +29,8 @@ module MailRoom
       # @param message [String] the email message as a string, RFC822 format
       def deliver(message)
         @logger.info message
+
+        true
       end
     end
   end

data/lib/mail_room/delivery/noop.rb

@@ -3,12 +3,19 @@ module MailRoom
     # Noop Delivery method
     # @author Tony Pitale
     class Noop
+      Options = Class.new do
+        def initialize(*)
+          super()
+        end
+      end
+
       # build a new delivery, do nothing
       def initialize(*)
       end
 
       # accept the delivery, do nothing
       def deliver(*)
+        true
       end
     end
   end

data/lib/mail_room/delivery/postback.rb

@@ -5,24 +5,35 @@ module MailRoom
     # Postback Delivery method
     # @author Tony Pitale
     class Postback
-      # Build a new delivery, hold the mailbox configuration
-      # @param [MailRoom::Mailbox]
-      def initialize(mailbox)
-        @mailbox = mailbox
+      Options = Struct.new(:delivery_url, :delivery_token) do
+        def initialize(mailbox)
+          delivery_url = mailbox.delivery_url || mailbox.delivery_options[:delivery_url]
+          delivery_token = mailbox.delivery_token || mailbox.delivery_options[:delivery_token]
+
+          super(delivery_url, delivery_token)
+        end
       end
 
-      # deliver the message using Faraday to the configured mailbox url
+      # Build a new delivery, hold the delivery options
+      # @param [MailRoom::Delivery::Postback::Options]
+      def initialize(delivery_options)
+        @delivery_options = delivery_options
+      end
+
+      # deliver the message using Faraday to the configured delivery_options url
       # @param message [String] the email message as a string, RFC822 format
       def deliver(message)
         connection = Faraday.new
-        connection.token_auth @mailbox.delivery_token
+        connection.token_auth @delivery_options.delivery_token
 
         connection.post do |request|
-          request.url @mailbox.delivery_url
+          request.url @delivery_options.delivery_url
           request.body = message
           # request.options[:timeout] = 3
           # request.headers['Content-Type'] = 'text/plain'
         end
+
+        true
       end
     end
   end

data/lib/mail_room/delivery/sidekiq.rb

@@ -0,0 +1,66 @@
+require "redis"
+require "securerandom"
+require "json"
+
+module MailRoom
+  module Delivery
+    # Postback Delivery method
+    # @author Tony Pitale
+    class Sidekiq
+      Options = Struct.new(:redis_url, :namespace, :queue, :worker) do
+        def initialize(mailbox)
+          redis_url = mailbox.delivery_options[:redis_url]
+          namespace = mailbox.delivery_options[:namespace]
+          queue     = mailbox.delivery_options[:queue]  || "default"
+          worker    = mailbox.delivery_options[:worker] || "redis://localhost:6379"
+
+          super(redis_url, namespace, queue, worker)
+        end
+      end
+
+      attr_accessor :options
+
+      # Build a new delivery, hold the mailbox configuration
+      # @param [MailRoom::Mailbox]
+      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)
+        item = item_for(message)
+
+        client.lpush("queue:#{options.queue}", JSON.generate(item))
+
+        true
+      end
+
+      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
+        end
+      end
+
+      def item_for(message)
+        {
+          'class'       => options.worker,
+          'args'        => [message],
+
+          'queue'       => options.queue,
+          'jid'         => SecureRandom.hex(12),
+          'retry'       => false,
+          'enqueued_at' => Time.now.to_f
+        }
+      end
+    end
+  end
+end

data/lib/mail_room/mailbox.rb

@@ -1,25 +1,42 @@
 module MailRoom
   # Mailbox Configuration fields
-  FIELDS = [
+  MAILBOX_FIELDS = [
     :email,
     :password,
+    :host,
+    :port,
+    :ssl,
+    :search_command,
     :name,
+    :delete_after_delivery,
     :delivery_method, # :noop, :logger, :postback, :letter_opener
     :log_path, # for logger
     :delivery_url, # for postback
     :delivery_token, # for postback
-    :location # for letter_opener
+    :location, # for letter_opener
+    :delivery_options
   ]
 
   # Holds configuration for each of the email accounts we wish to monitor
   #   and deliver email to when new emails arrive over imap
-  Mailbox = Struct.new(*FIELDS) do
+  Mailbox = Struct.new(*MAILBOX_FIELDS) do
+    # Default attributes for the mailbox configuration
+    DEFAULTS = {
+      :search_command => 'UNSEEN',
+      :delivery_method => 'postback',
+      :host => 'imap.gmail.com',
+      :port => 993,
+      :ssl => true,
+      :delete_after_delivery => false,
+      :delivery_options => {}
+    }
+
     # Store the configuration and require the appropriate delivery method
     # @param attributes [Hash] configuration options
     def initialize(attributes={})
-      super(*attributes.values_at(*members))
+      super(*DEFAULTS.merge(attributes).values_at(*members))
 
-      require_relative("./delivery/#{(delivery_method || 'postback')}")
+      require_relative("./delivery/#{(delivery_method)}")
     end
 
     # move to a mailbox deliverer class?
@@ -31,6 +48,8 @@ module MailRoom
         Delivery::Logger
       when "letter_opener"
         Delivery::LetterOpener
+      when "sidekiq"
+        Delivery::Sidekiq
       else
         Delivery::Postback
       end
@@ -39,7 +58,12 @@ module MailRoom
     # deliver the imap email message
     # @param message [Net::IMAP::FetchData]
     def deliver(message)
-      delivery_klass.new(self).deliver(message.attr['RFC822'])
+      delivery_klass.new(parsed_delivery_options).deliver(message.attr['RFC822'])
+    end
+
+    private
+    def parsed_delivery_options
+      delivery_klass::Options.new(self)
     end
   end
 end

data/lib/mail_room/mailbox_handler.rb

@@ -18,8 +18,14 @@ module MailRoom
         # puts msg.attr['RFC822']
 
         # loop over delivery methods and deliver each
-        @mailbox.deliver(msg)
+        delivered = @mailbox.deliver(msg)
+
+        if delivered && @mailbox.delete_after_delivery
+          @imap.store(msg.seqno, "+FLAGS", [Net::IMAP::DELETED])
+        end
       end
+
+      @imap.expunge if @mailbox.delete_after_delivery
     end
 
     private
@@ -39,7 +45,7 @@ module MailRoom
     # search for all new (unseen) message ids
     # @return [Array<Integer>] message ids
     def new_message_ids
-      @imap.search('UNSEEN')
+      @imap.search(@mailbox.search_command)
     end
 
     # @private

data/lib/mail_room/mailbox_watcher.rb

@@ -17,7 +17,7 @@ module MailRoom
 
     # build a net/imap connection to google imap
     def imap
-      @imap ||= Net::IMAP.new('imap.gmail.com', :port => 993, :ssl => true)
+      @imap ||= Net::IMAP.new(@mailbox.host, :port => @mailbox.port, :ssl => @mailbox.ssl)
     end
 
     # build a handler to process mailbox messages
@@ -113,6 +113,9 @@ module MailRoom
 
       @running = true
 
+      # prefetch messages before first idle
+      process_mailbox
+
       self.idling_thread = Thread.start do
         while(running?) do
           begin

data/lib/mail_room/version.rb

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

data/mail_room.gemspec

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

data/spec/lib/mailbox_handler_spec.rb

@@ -22,12 +22,13 @@ describe MailRoom::MailboxHandler do
     it 'returns no messages if there are no ids' do
       imap.stubs(:search).returns([])
       imap.stubs(:fetch)
+      mailbox.search_command = 'NEW'
       mailbox.stubs(:deliver)
 
       handler = MailRoom::MailboxHandler.new(mailbox, imap)
       handler.process
 
-      imap.should have_received(:search).with('UNSEEN')
+      imap.should have_received(:search).with('NEW')
       imap.should have_received(:fetch).never
       mailbox.should have_received(:deliver).never
     end

data/spec/lib/mailbox_watcher_spec.rb

@@ -1,32 +1,36 @@
 require 'spec_helper'
 
 describe MailRoom::MailboxWatcher do
+  let(:mailbox) {MailRoom::Mailbox.new}
+
   describe '#running?' do
     it 'is false by default' do
-      watcher = MailRoom::MailboxWatcher.new(nil)
+      watcher = MailRoom::MailboxWatcher.new(mailbox)
       watcher.running?.should eq(false)
     end
   end
 
   describe '#logged_in?' do
     it 'is false by default' do
-      watcher = MailRoom::MailboxWatcher.new(nil)
+      watcher = MailRoom::MailboxWatcher.new(mailbox)
       watcher.logged_in?.should eq(false)
     end
   end
 
   describe '#idling?' do
     it 'is false by default' do
-      watcher = MailRoom::MailboxWatcher.new(nil)
+      watcher = MailRoom::MailboxWatcher.new(mailbox)
       watcher.idling?.should eq(false)
     end
   end
 
   describe '#imap' do
+    let(:mailbox) {MailRoom::Mailbox.new}
+
     it 'builds a new Net::IMAP object' do
       Net::IMAP.stubs(:new).returns('imap')
 
-      MailRoom::MailboxWatcher.new(nil).imap.should eq('imap')
+      MailRoom::MailboxWatcher.new(mailbox).imap.should eq('imap')
 
       Net::IMAP.should have_received(:new).with('imap.gmail.com', :port => 993, :ssl => true)
     end
@@ -157,11 +161,13 @@ describe MailRoom::MailboxWatcher do
   end
 
   describe '#run' do
-    let(:watcher) {MailRoom::MailboxWatcher.new(nil)}
+    let(:watcher) {MailRoom::MailboxWatcher.new(mailbox)}
 
     before :each do
+      Net::IMAP.stubs(:new).returns(stub)
       Thread.stubs(:start).yields.returns(stub(:abort_on_exception=))
       watcher.stubs(:setup)
+      watcher.handler.stubs(:process)
     end
 
     it 'sets up' do
@@ -184,7 +190,6 @@ describe MailRoom::MailboxWatcher do
       watcher.stubs(:running?).returns(true, false)
 
       watcher.stubs(:idle)
-      watcher.stubs(:process_mailbox)
 
       watcher.run
 
@@ -195,7 +200,6 @@ describe MailRoom::MailboxWatcher do
       watcher.stubs(:running?).returns(true, false)
 
       watcher.stubs(:idle)
-      watcher.stubs(:process_mailbox)
 
       watcher.run
 
@@ -206,16 +210,15 @@ describe MailRoom::MailboxWatcher do
       watcher.stubs(:running?).returns(true, false)
 
       watcher.stubs(:idle)
-      watcher.stubs(:process_mailbox)
 
       watcher.run
 
-      watcher.should have_received(:process_mailbox).once
+      watcher.handler.should have_received(:process).times(2)
     end
   end
 
   describe '#quit' do
-    let(:watcher) {MailRoom::MailboxWatcher.new(nil)}
+    let(:watcher) {MailRoom::MailboxWatcher.new(mailbox)}
 
     it 'stops idling' do
       watcher.stubs(:stop_idling)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_room
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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
@@ -134,6 +148,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -147,6 +162,7 @@ files:
 - lib/mail_room/delivery/logger.rb
 - lib/mail_room/delivery/noop.rb
 - lib/mail_room/delivery/postback.rb
+- lib/mail_room/delivery/sidekiq.rb
 - lib/mail_room/mailbox.rb
 - lib/mail_room/mailbox_handler.rb
 - lib/mail_room/mailbox_watcher.rb