mailman-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mailman-rails.gemspec
+gemspec
+# Uncomment this line to get tests working:
+#gem 'mailman', :git => 'https://github.com/titanous/mailman' # The version in rubygems isn't yet compatible with this gem at time of writing

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Cant
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Mailman::Rails
+
+This gem helps you integrate <a href="https://github.com/titanous/mailman">ruby Mailman</a> with Rails. It adds rake tasks to manage a mailman daemon and allows you to configure a Mailman::Application instance from within your models.
+
+## Installation
+
+Add these line to your application's Gemfile:
+
+    gem 'mailman-rails'
+    gem 'mailman', :git => 'https://github.com/titanous/mailman' # The version in rubygems isn't yet compatible with this gem
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mailman-rails
+
+## Usage
+
+Put your Mailman config in config/initializers/mailman.rb
+
+Match Mailman stuff from your models:
+<pre>
+class Post < ActiveRecord::Base # Or whatever
+
+  Mailman::Rails.receive do
+    to "posts@example.com" do
+      Post.create(JSON.parse(message.body))
+    end
+  end
+
+  # The daemon would be started from the rake task but only after all the code is loaded.
+
+end
+</pre>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/new/1353967927.V801I42421M758136.example

@@ -0,0 +1,13 @@
+Return-Path: <test@example.com>
+X-Original-To: email1@example.com
+Delivered-To: email1@example.com
+Received: from localhost (localhost [127.0.0.1])
+	by mail.example.com (Postfix) with SMTP id BC4F6421C5
+	for <email1@example.com>; Mon, 26 Nov 2012 22:11:45 +0000 (UTC)
+Message-Id: <20121126221205.BC4F6421C5@mail.example.com>
+Date: Mon, 26 Nov 2012 22:11:45 +0000 (UTC)
+From: test@example.com
+To: Email1 <email1@example.com>
+Subject: Foo to email1
+
+Foo

data/examples/new/1353967928.V801I42421M758136.example

@@ -0,0 +1,13 @@
+Return-Path: <test@example.com>
+X-Original-To: email2@example.com
+Delivered-To: email2@example.com
+Received: from localhost (localhost [127.0.0.1])
+	by mail.example.com (Postfix) with SMTP id BC4F6421C5
+	for <email2@example.com>; Mon, 26 Nov 2012 22:11:45 +0000 (UTC)
+Message-Id: <20121126221205.BC4F6421C5@mail.example.com>
+Date: Mon, 26 Nov 2012 22:11:45 +0000 (UTC)
+From: test@example.com
+To: Email2 <email2@example.com>
+Subject: Bar to email2
+
+Bar

data/lib/mailman-rails.rb

@@ -0,0 +1,11 @@
+require "mailman-rails/version"
+require "mailman"
+require "mailman/rails"
+require "mailman/rails/railtie"
+require File.expand_path("../mailman", __FILE__)
+
+module Mailman
+  module Rails
+    # Railtie added further down the tree
+  end
+end

data/lib/mailman-rails/version.rb

@@ -0,0 +1,5 @@
+module Mailman
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/lib/mailman.rb

@@ -0,0 +1,23 @@
+module Mailman
+  @@application = nil
+
+  def self.application
+    @@application ||= Mailman::Application.new do end # Avoid forcing Mailman to require a block
+  end
+
+  def self.configure(&block)
+    Mailman.config.instance_exec(&block)
+  end
+
+  def self.receive(&block)
+    self.application.instance_exec(&block)
+  end
+
+  def self.run!
+
+    # Under no circumstances should Mailman itself load the Rails enviroment!
+    Mailman.config.rails_root = false
+
+    self.application.run
+  end
+end

data/lib/mailman/rails.rb

@@ -0,0 +1,4 @@
+module Mailman
+  module Rails
+  end
+end

data/lib/mailman/rails/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module Mailman
+  module Rails
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        Dir[File.expand_path('../tasks/*.rake', __FILE__)].each { |f| puts f ; load f }
+      end
+    end
+  end
+end

data/lib/mailman/rails/tasks/mailman.rake

@@ -0,0 +1,33 @@
+namespace :mailman do
+
+  mailman_tasks = [:start, :stop, :restart, :status]
+
+  mailman_tasks.each do |task_name|
+
+    # Generate description
+    if task_name == :status
+      desc "Check the status of the Mailman service"
+    else
+      desc "#{task_name.to_s.camelize} the Mailman service"
+    end
+
+    task task_name do
+      Daemons.run_proc("mailman_daemon", :ARGV => [task_name.to_s]) do
+        Rake::Task["mailman"].invoke
+      end
+    end
+
+  end
+
+end
+
+
+desc "Mailman service in the foreground"
+task :mailman => :environment do
+
+  Mailman.config.logger = Logger.new("#{Rails.root}/log/mailman.#{Rails.env}.log")
+
+  Mailman.run!
+
+end
+

data/mailman-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailman-rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mailman-rails"
+  gem.version       = Mailman::Rails::VERSION
+  gem.authors       = ["John Cant"]
+  gem.email         = ["a.johncant@gmail.com"]
+  gem.description   = %q{Ease Mailman integration with Rails}
+  gem.summary       = %q{Ease Mailman integration with Rails}
+  gem.homepage      = "https://github.com/johncant/mailman-rails"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "mailman"
+  gem.add_dependency "rails"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "daemons"
+end

data/spec/mailman_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+# WARNING - Requires mailman version from GitHub to run the tests
+
+describe Mailman do
+
+  def gem_root
+    File.expand_path('../../', __FILE__)
+  end
+
+  before do
+    `cp -r #{gem_root}/examples #{gem_root}/tmp/examples`
+  end
+
+  it "Should store one instance configurable from different places" do
+
+    # Imagine that these next two blocks are in separate Rails models
+    # This spec reports that only 1 spec has been executed, despite my best efforts. (See hackery below)
+    # It's not true though, if one of the "ghost" specs fails, you still notice.
+    spec = self
+
+    Mailman.configure do
+      self.maildir = "#{spec.gem_root}/tmp/examples/"
+    end
+
+    emails_parsed = 0
+
+    Mailman.receive do
+      to('email1@example') do
+        route = self
+        spec.instance_eval do
+          # Tried making sure that self refers to the spec
+          route.message.body.should match(/Foo/)
+          emails_parsed += 1
+        end
+      end
+    end
+
+    Mailman.receive do
+      to('email2@example') do
+        route = self
+        spec.instance_eval do
+          # Tried making sure that self refers to the spec
+          route.message.body.should spec.match(/Bar/)
+          emails_parsed += 1
+        end
+      end
+    end
+
+    Mailman.application.process_maildir # If this had already happened, the spec would fail
+
+    emails_parsed.should == 2
+
+  end
+
+  after do
+    `rm -r #{gem_root}/tmp/examples`
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'mailman-rails'
+
+RSpec.configure do |config|
+  # Don't need to configure anything yet
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mailman-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Cant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mailman
+  requirement: &18860620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18860620
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &18860200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18860200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18859740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18859740
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: &18859280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18859280
+description: Ease Mailman integration with Rails
+email:
+- a.johncant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/new/1353967927.V801I42421M758136.example
+- examples/new/1353967928.V801I42421M758136.example
+- lib/mailman-rails.rb
+- lib/mailman-rails/version.rb
+- lib/mailman.rb
+- lib/mailman/rails.rb
+- lib/mailman/rails/railtie.rb
+- lib/mailman/rails/tasks/mailman.rake
+- mailman-rails.gemspec
+- spec/mailman_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/johncant/mailman-rails
+licenses: []
+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.15
+signing_key: 
+specification_version: 3
+summary: Ease Mailman integration with Rails
+test_files:
+- spec/mailman_spec.rb
+- spec/spec_helper.rb