mail_room 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/README.md

@@ -18,28 +18,47 @@ Or install it yourself as:
 
 ## Usage ##
 
-    bin/mail_room -f /path/to/config.yml -d
+    bin/mail_room -c /path/to/config.yml
 
 ## Configuration ##
 
     ---
-      :mailboxes:
-        -
-          :email: "user1@gmail.com"
-          :password: "password"
-          :name: "inbox"
-          :delivery_url: "http://localhost:3000/inbox"
-          :delivery_token: "abcdefg"
-        -
-          :email: "user2@gmail.com"
-          :password: "password"
-          :name: "inbox"
-          :delivery_url: "http://localhost:3000/inbox"
-          :delivery_token: "abcdefg"
-
-## Dependencies ##
-
-* celluloid
+    :mailboxes:
+      -
+        :email: "user1@gmail.com"
+        :password: "password"
+        :name: "inbox"
+        :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"
+      -
+        :email: "user3@gmail.com"
+        :password: "password"
+        :name: "inbox"
+        :delivery_method: logger
+        :log_path: "/var/log/user3-email.log"
+      -
+        :email: "user4@gmail.com"
+        :password: "password"
+        :name: "inbox"
+        :delivery_method: letter_opener
+        :location: "/tmp/user4-email"
+
+## delivery_method ##
+
+### postback ###
+
+### logger ###
+
+### noop ###
+
+### letter_opener ###
 
 ## Contributing ##
 
@@ -49,3 +68,13 @@ Or install it yourself as:
 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 god/upstart
+6. log to stdout √
+7. add a development mode that opens in letter_opener by ryanb √

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/mail_room

@@ -2,4 +2,4 @@
 
 require 'mail_room'
 
-MailRoom::CLI.new(ARGV).run
+MailRoom::CLI.new(ARGV).start

data/lib/mail_room/cli.rb

@@ -1,6 +1,6 @@
 module MailRoom
   class CLI
-    attr_accessor :configuration
+    attr_accessor :configuration, :coordinator
 
     def initialize(args)
       options = {}
@@ -15,17 +15,9 @@ module MailRoom
           options[:config_path] = path
         end
 
-        parser.on("-d", "--daemon", "Daemonize mode") do |v|
-          options[:daemonize] = v
-        end
-
-        parser.on("-l", "--log FILE") do |path|
-          options[:log_path] = path
-        end
-
-        parser.on("-p", "--pid FILE") do |path|
-          options[:pid_path] = path
-        end
+        # parser.on("-l", "--log FILE") do |path|
+        #   options[:log_path] = path
+        # end
 
         parser.on_tail("-?", "--help", "Display this usage information.") do
           puts "#{parser}\n"
@@ -34,39 +26,10 @@ module MailRoom
       end.parse!(args)
 
       self.configuration = Configuration.new(options)
-    end
-
-    def run
-      if configuration.daemonize?
-        daemonize
-      else
-        start
-      end
-    end
-
-    def running?
-      @running
-    end
-
-    def daemonize
-      exit if fork
-      Process.setsid
-      exit if fork
-      store_pid(Process.pid)
-      File.umask 0000
-      redirect_output!
-
-      start
-
-      clean_pid
+      self.coordinator = Coordinator.new(configuration.mailboxes)
     end
 
     def start
-      @running = true
-
-      @coordinator ||= Coordinator.new(configuration.mailboxes)
-      @coordinator.run
-
       Signal.trap(:INT) do
         stop
       end
@@ -75,56 +38,11 @@ module MailRoom
         exit
       end
 
-      while(running?) do; sleep 1; end
+      coordinator.run
     end
 
     def stop
-      return unless @coordinator
-
-      @coordinator.quit
-
-      @running = false
-    end
-
-    def store_pid(pid)
-      pid_path = configuration.pid_path
-
-      puts pid_path
-
-      FileUtils.mkdir_p(File.dirname(pid_path))
-      File.open(pid_path, 'w'){|f| f.write("#{pid}\n")}
-    end
-
-    def clean_pid
-      pid_path = configuration.pid_path
-
-      begin
-        FileUtils.rm pid_path if File.exists?(pid_path)
-      rescue => e
-      end
-    end
-
-
-    def redirect_output!
-      if log_path = configuration.log_path
-        # if the log directory doesn't exist, create it
-        FileUtils.mkdir_p File.dirname(log_path), :mode => 0755
-        # touch the log file to create it
-        FileUtils.touch log_path
-        # Set permissions on the log file
-        File.chmod(0644, log_path)
-        # Reopen $stdout (NOT +STDOUT+) to start writing to the log file
-        $stdout.reopen(log_path, 'a')
-        # Redirect $stderr to $stdout
-        $stderr.reopen $stdout
-        $stdout.sync = true
-      else # redirect to /dev/null
-        # We're not bothering to sync if we're dumping to /dev/null
-        # because /dev/null doesn't care about buffered output
-        $stdin.reopen '/dev/null'
-        $stdout.reopen '/dev/null', 'a'
-        $stderr.reopen $stdout
-      end
+      coordinator.quit
     end
   end
 end

data/lib/mail_room/configuration.rb

@@ -3,22 +3,19 @@ module MailRoom
     attr_accessor :mailboxes, :daemonize, :log_path, :pid_path
 
     def initialize(options={})
-      config_file = YAML.load_file(options[:config_path]) if options.has_key?(:config_path)
-
       self.mailboxes = []
-      load_mailboxes(config_file[:mailboxes])
 
-      self.daemonize = options.fetch(:daemonize, false)
-      self.log_path = options.fetch(:log_path, nil)
-      self.pid_path = options.fetch(:pid_path, "/var/run/mail_room.pid")
+      if options.has_key?(:config_path)
+        config_file = YAML.load_file(options[:config_path])
+
+        set_mailboxes(config_file[:mailboxes])
+      end
     end
 
-    def load_mailboxes(mailboxes_config)
+    def set_mailboxes(mailboxes_config)
       mailboxes_config.each do |attributes|
         self.mailboxes << Mailbox.new(attributes)
       end
     end
-
-    alias :daemonize? :daemonize
   end
 end

data/lib/mail_room/coordinator.rb

@@ -1,19 +1,27 @@
 module MailRoom
   class Coordinator
-    attr_accessor :handlers
+    attr_accessor :watchers, :running
 
     def initialize(mailboxes)
-      self.handlers = []
+      self.watchers = []
 
-      mailboxes.each {|mb| self.handlers << MessageHandler.new(mb)}
+      mailboxes.each {|box| self.watchers << MailboxWatcher.new(box)}
     end
 
+    alias :running? :running
+
     def run
-      handlers.each(&:run!)
+      watchers.each(&:run)
+
+      self.running = true
+
+      while(running?) do; sleep 1; end
     end
 
     def quit
-      handlers.each(&:quit!)
+      watchers.each(&:quit)
+
+      self.running = false
     end
   end
 end

data/lib/mail_room/delivery/letter_opener.rb

@@ -0,0 +1,17 @@
+require 'mail'
+require 'letter_opener'
+
+module MailRoom
+  module Delivery
+    class LetterOpener
+      def initialize(mailbox)
+        @mailbox = mailbox
+      end
+
+      def deliver(message)
+        method = ::LetterOpener::DeliveryMethod.new(:location => @mailbox.location)
+        method.deliver!(Mail.read_from_string(message))
+      end
+    end
+  end
+end

data/lib/mail_room/delivery/logger.rb

@@ -0,0 +1,20 @@
+require 'logger'
+
+module MailRoom
+  module Delivery
+    class Logger
+      def initialize(mailbox)
+        io = File.open(mailbox.log_path, 'a') if mailbox.log_path
+        io ||= STDOUT
+
+        io.sync = true
+
+        @logger = ::Logger.new(io)
+      end
+
+      def deliver(message)
+        @logger.info message
+      end
+    end
+  end
+end

data/lib/mail_room/delivery/noop.rb

@@ -0,0 +1,11 @@
+module MailRoom
+  module Delivery
+    class Noop
+      def initialize(*)
+      end
+
+      def deliver(*)
+      end
+    end
+  end
+end

data/lib/mail_room/delivery/postback.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+
+module MailRoom
+  module Delivery
+    class Postback
+      def initialize(mailbox)
+        @mailbox = mailbox
+      end
+
+      def deliver(message)
+        connection = Faraday.new
+        connection.token_auth @mailbox.delivery_token
+
+        connection.post do |request|
+          request.url @mailbox.delivery_url
+          request.body = message
+          # request.options[:timeout] = 3
+          # request.headers['Content-Type'] = 'text/plain'
+        end
+      end
+    end
+  end
+end

data/lib/mail_room/mailbox.rb

@@ -1,9 +1,38 @@
 module MailRoom
-  Mailbox = Struct.new(:email, :password, :name, :delivery_url, :delivery_token)
+  Mailbox = Struct.new(*[
+    :email,
+    :password,
+    :name,
+    :delivery_method, # :noop, :logger, :postback, :letter_opener
+    :log_path, # for logger
+    :delivery_url, # for postback
+    :delivery_token, # for postback
+    :location # for letter_opener
+  ])
 
   class Mailbox
     def initialize(attributes={})
       super(*attributes.values_at(*members))
+
+      require_relative("./delivery/#{(delivery_method || 'postback')}")
+    end
+
+    # move to a mailbox deliverer class?
+    def delivery_klass
+      case delivery_method
+      when "noop"
+        Delivery::Noop
+      when "logger"
+        Delivery::Logger
+      when "letter_opener"
+        Delivery::LetterOpener
+      else
+        Delivery::Postback
+      end
+    end
+
+    def deliver(message)
+      delivery_klass.new(self).deliver(message.attr['RFC822'])
     end
   end
 end

data/lib/mail_room/mailbox_handler.rb

@@ -0,0 +1,36 @@
+module MailRoom
+  class MailboxHandler
+    def initialize(mailbox, imap)
+      @mailbox = mailbox
+      @imap = imap
+    end
+
+    def process
+      # return if idling? || !running?
+
+      new_messages.each do |msg|
+        # puts msg.attr['RFC822']
+
+        # loop over delivery methods and deliver each
+        @mailbox.deliver(msg)
+      end
+    end
+
+    def new_messages
+      messages_for_ids(new_message_ids)
+    end
+
+    # label messages?
+    # @imap.store(id, "+X-GM-LABELS", [label])
+
+    def new_message_ids
+      @imap.search('UNSEEN')
+    end
+
+    def messages_for_ids(ids)
+      return [] if ids.empty?
+
+      @imap.fetch(ids, "RFC822")
+    end
+  end
+end

data/lib/mail_room/mailbox_watcher.rb

@@ -0,0 +1,93 @@
+module MailRoom
+  # split up between processing and idling?
+  class MailboxWatcher
+    attr_accessor :idling_thread
+
+    def initialize(mailbox)
+      @mailbox = mailbox
+
+      @running = false
+      @logged_in = false
+      @idling = false
+    end
+
+    def imap
+      @imap ||= Net::IMAP.new('imap.gmail.com', :port => 993, :ssl => true)
+    end
+
+    def handler
+      @handler ||= MailboxHandler.new(@mailbox, imap)
+    end
+
+    def running?
+      @running
+    end
+
+    def logged_in?
+      @logged_in
+    end
+
+    def idling?
+      @idling
+    end
+
+    def setup
+      log_in
+      set_mailbox
+    end
+
+    def log_in
+      imap.login(@mailbox.email, @mailbox.password)
+      @logged_in = true
+    end
+
+    def set_mailbox
+      imap.select(@mailbox.name) if logged_in?
+    end
+
+    def idle
+      return unless logged_in?
+
+      @idling = true
+
+      imap.idle do |response|
+        if response.respond_to?(:name) && response.name == 'EXISTS'
+          imap.idle_done
+        end
+      end
+
+      @idling = false
+    end
+
+    def process_mailbox
+      handler.process
+    end
+
+    def stop_idling
+      return unless idling?
+
+      imap.idle_done
+      idling_thread.join
+    end
+
+    def run
+      setup
+
+      @running = true
+
+      self.idling_thread = Thread.start do
+        while(running?) do
+          # block until we stop idling
+          idle
+          # when new messages are ready
+          process_mailbox
+        end
+      end
+    end
+
+    def quit
+      @running = false
+      stop_idling
+    end
+  end
+end

data/lib/mail_room/version.rb

@@ -1,3 +1,3 @@
 module MailRoom
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mail_room.rb

@@ -1,15 +1,17 @@
-require 'celluloid'
 require 'net/imap'
-require 'fileutils'
 require 'optparse'
 require 'yaml'
 
 module MailRoom
+  # def self.logger
+  #   @logger ||= Logger.new(STDOUT)
+  # end
 end
 
 require "mail_room/version"
 require "mail_room/configuration"
 require "mail_room/mailbox"
-require "mail_room/message_handler"
+require "mail_room/mailbox_watcher"
+require "mail_room/mailbox_handler"
 require "mail_room/coordinator"
 require "mail_room/cli"

data/mail_room.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = MailRoom::VERSION
   gem.authors       = ["Tony Pitale"]
   gem.email         = ["tpitale@gmail.com"]
-  gem.description   = %q{mail_room will proxy email (gmail) from IMAP to a callback URL}
-  gem.summary       = %q{mail_room will proxy email (gmail) from IMAP to a callback URL}
+  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.files         = `git ls-files`.split($/)
@@ -17,5 +17,14 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'celluloid'
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "bourne"
+  gem.add_development_dependency "simplecov"
+
+  # for testing delivery methods
+  gem.add_development_dependency "faraday"
+  gem.add_development_dependency "mail"
+  gem.add_development_dependency "letter_opener"
 end

data/spec/fixtures/test_config.yml

@@ -0,0 +1,14 @@
+---
+:mailboxes:
+  -
+    :email: "user1@gmail.com"
+    :password: "password"
+    :name: "inbox"
+    :delivery_url: "http://localhost:3000/inbox"
+    :delivery_token: "abcdefg"
+  -
+    :email: "user2@gmail.com"
+    :password: "password"
+    :name: "inbox"
+    :delivery_url: "http://localhost:3000/inbox"
+    :delivery_token: "abcdefg"

data/spec/lib/cli_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe MailRoom::CLI do
+  let(:config_path) {File.expand_path('../fixtures/test_config.yml', File.dirname(__FILE__))}
+  let!(:configuration) {MailRoom::Configuration.new({:config_path => config_path})}
+  let(:coordinator) {stub(:run => true, :quit => true)}
+
+  describe '.new' do
+    let(:args) {["-c", "a path"]}
+
+    before :each do
+      MailRoom::Configuration.stubs(:new).returns(configuration)
+      MailRoom::Coordinator.stubs(:new).returns(coordinator)
+    end
+
+    it 'parses arguments into configuration' do
+      MailRoom::CLI.new(args).configuration.should eq(configuration)
+      MailRoom::Configuration.should have_received(:new).with({:config_path => 'a path'})
+    end
+
+    it 'creates a new coordinator with configuration' do
+      MailRoom::CLI.new(args).coordinator.should eq(coordinator)
+      MailRoom::Coordinator.should have_received(:new).with(configuration.mailboxes)
+    end
+  end
+
+  describe '#start' do
+    let(:cli) {MailRoom::CLI.new([])}
+
+    before :each do
+      cli.configuration = configuration
+      cli.coordinator = coordinator
+    end
+
+    it 'starts running the coordinator' do
+      cli.start
+
+      coordinator.should have_received(:run)
+    end
+  end
+
+  describe '#stop' do
+    let(:cli) {MailRoom::CLI.new([])}
+
+    before :each do
+      cli.configuration = configuration
+      cli.coordinator = coordinator
+    end
+
+    it 'quits the coordinator' do
+      cli.stop
+
+      coordinator.should have_received(:quit)
+    end
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+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')
+
+      configuration = MailRoom::Configuration.new(:config_path => config_path)
+
+      configuration.mailboxes.should eq(['mailbox1', 'mailbox2'])
+    end
+
+    it 'sets mailboxes to an empty set when config_path is missing' do
+      MailRoom::Mailbox.stubs(:new)
+
+      configuration = MailRoom::Configuration.new
+
+      configuration.mailboxes.should eq([])
+
+      MailRoom::Mailbox.should have_received(:new).never
+    end
+  end
+end