mail_room 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5a6b5950db35515bea9f2f82bdde5e7dd1ff367
+  data.tar.gz: d051cde6554df19f74cea7054b94673c5fb0a718
+SHA512:
+  metadata.gz: 8aef87866ce7bdea33d3490adb6046e6eeea50fc07b46dd21924bec5e9ead803695eb901637f8c18448cd29d03208f0ca2f8fd47a3735153e08f4cc88e2647de
+  data.tar.gz: c0e0ed306a8b784234d8edf544133c3ee0382e647236a2f29f154e1284a1e627d0d9f0fafae09b61ff35f34b36aa69435027dea8e886e6465500dab5d8a4ba0e

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p362
+2.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: bundle exec rspec spec

data/README.md

@@ -2,6 +2,8 @@
 
 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.
 
+[![Build Status](https://travis-ci.org/tpitale/mail_room.png?branch=master)](https://travis-ci.org/tpitale/mail_room)
+
 ## Installation ##
 
 Add this line to your application's Gemfile:
@@ -16,9 +18,11 @@ Or install it yourself as:
 
     $ gem install mail_room
 
+You will also need to install `faraday` or `letter_opener` if you use the `postback` or `letter_opener` delivery methods, respectively.
+
 ## Usage ##
 
-    bin/mail_room -c /path/to/config.yml
+    mail_room -c /path/to/config.yml
 
 ## Configuration ##
 
@@ -54,7 +58,19 @@ Or install it yourself as:
 
 ### postback ###
 
-The default delivery method, requires _delivery_url_ and _delivery_token_ in configuration.
+Requires `faraday` gem be installed.
+
+*NOTE:* If you're using Ruby `>= 2.0`, you'll need
+to use Faraday from `master` for the time being. I will investigate any issues
+once version `0.9.0` final is released.
+
+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 
+disabled.
 
 ### logger ###
 
@@ -70,10 +86,20 @@ Does nothing, like it says.
 
 ### letter_opener ###
 
+Requires `letter_opener` gem be installed.
+
 Configured with `:delivery_method: letter_opener`.
 
 Uses Ryan Bates' excellent [letter_opener](https://github.com/ryanb/letter_opener) gem.
 
+## Receiving `postback` in Rails ##
+
+If you have a controller that you're sending to, with forgery protection
+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)`.
+
 ## Contributing ##
 
 1. Fork it

data/lib/mail_room/cli.rb

@@ -31,7 +31,7 @@ module MailRoom
 
     def start
       Signal.trap(:INT) do
-        stop
+        coordinator.running = false
       end
 
       Signal.trap(:TERM) do
@@ -40,9 +40,5 @@ module MailRoom
 
       coordinator.run
     end
-
-    def stop
-      coordinator.quit
-    end
   end
 end

data/lib/mail_room/coordinator.rb

@@ -12,16 +12,20 @@ module MailRoom
 
     def run
       watchers.each(&:run)
-
+      
       self.running = true
+      
+      sleep_while_running
 
+      quit
+    end
+    
+    def sleep_while_running
       while(running?) do; sleep 1; end
     end
 
     def quit
       watchers.each(&:quit)
-
-      self.running = false
     end
   end
 end

data/lib/mail_room/version.rb

@@ -1,3 +1,3 @@
 module MailRoom
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/lib/cli_spec.rb

@@ -38,19 +38,4 @@ describe MailRoom::CLI do
       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/coordinator_spec.rb

@@ -21,12 +21,38 @@ describe MailRoom::Coordinator do
 
   describe '#run' do
     it 'runs each watcher' do
-      watcher = stub(:run)
+      watcher = stub
+      watcher.stubs(:run)
+      watcher.stubs(:quit)
       MailRoom::MailboxWatcher.stubs(:new).returns(watcher)
       coordinator = MailRoom::Coordinator.new(['mailbox1'])
-      coordinator.stubs(:running?).returns(false)
+      coordinator.stubs(:sleep_while_running)
       coordinator.run
       watcher.should have_received(:run)
+      watcher.should have_received(:quit)
+    end
+    
+    it 'should go to sleep after running watchers' do
+      coordinator = MailRoom::Coordinator.new([])
+      coordinator.stubs(:sleep_while_running)
+      coordinator.run
+      coordinator.should have_received(:sleep_while_running)
+    end
+
+    it 'should set attribute running to true' do
+      coordinator = MailRoom::Coordinator.new([])
+      coordinator.stubs(:sleep_while_running)
+      coordinator.run
+      coordinator.running.should eq(true)
+    end
+  end
+
+  describe '#sleep_while_running' do
+    it 'should check the running state' do
+      coordinator = MailRoom::Coordinator.new([])
+      coordinator.stubs(:running?).returns(false)
+      coordinator.sleep_while_running
+      coordinator.should have_received(:running?)
     end
   end
 
@@ -35,7 +61,6 @@ describe MailRoom::Coordinator do
       watcher = stub(:quit)
       MailRoom::MailboxWatcher.stubs(:new).returns(watcher)
       coordinator = MailRoom::Coordinator.new(['mailbox1'])
-      coordinator.stubs(:running?).returns(true)
       coordinator.quit
       watcher.should have_received(:quit)
     end

metadata

@@ -1,142 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: mail_room
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2014-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bourne
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: letter_opener
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: mail_room will proxy email (gmail) from IMAP to a delivery method
@@ -150,6 +133,7 @@ files:
 - .gitignore
 - .rspec
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -181,27 +165,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/tpitale/mail_room
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: mail_room will proxy email (gmail) from IMAP to a callback URL, logger, or
   letter_opener
 test_files: