ruml 0.0.1 → 0.0.2

data/Gemfile

@@ -1,3 +1,3 @@
 source :rubygems
 
-gem 'mail'
+gemspec

data/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: .
+  specs:
+    ruml (0.0.1)
+      mail (~> 2.3.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -7,6 +13,7 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
+    minitest (2.7.0)
     polyglot (0.3.2)
     treetop (1.4.10)
       polyglot
@@ -16,4 +23,5 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  mail
+  minitest
+  ruml!

data/README.md

@@ -2,7 +2,10 @@
 
 Ruby mailing list software
 
-## File structure
+
+## Configration (ruml)
+
+### File based
 
 <pre>
 testml/
@@ -17,6 +20,33 @@ testml/
 * member    - List of member's addresses
 * bounce_to - Bounce mails go to this email (optional)
 
+
+## Configuration (Postfix)
+
+### Postfix
+
+#### /etc/postfix/ml-maps
+
+<pre>
+/^testml@example.com$/          ml-testml
+/^testml-bounce@mail.info$/     testml-bounce@mail.info
+</pre>
+
+#### /etc/postfix/ml-aliases
+
+<pre>
+ml-testml:    "|/path/to/bin/ruml /var/spool/ruml/lists/testml"
+</pre>
+
+#### /etc/postfix/main.cf
+
+<pre>
+virtual_alias_maps = regexp:/etc/postfix/ml-maps
+alias_maps = hash:/etc/postfix/ml-aliases
+alias_database = hash:/etc/postfix/ml-aliases
+</pre>
+
+
 ## TODO
 
 * Write tests!

data/Rakefile

@@ -1 +1,12 @@
 require "bundler/gem_tasks"
+
+# Test
+require 'rake/testtask'
+desc 'Default: run unit tests.'
+task :default => :test
+
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList.new('test/*_test.rb')
+  test.libs << 'test'
+  test.verbose = true
+end

data/bin/ruml

@@ -1,8 +1,26 @@
 #!/usr/bin/env ruby
 
-$debug = ENV['DEBUG']
-
 require 'ruml'
 
+# TODO test!
+if %w[true 1 on].include?(ENV['DEBUG'])
+  Mail.defaults do
+    spitter = Class.new do
+      def initialize(settings)
+      end
+
+      def deliver!(mail)
+        puts mail
+        puts "=" * 80
+      end
+    end
+    delivery_method spitter
+  end
+else
+  Mail.defaults do
+    delivery_method :sendmail
+  end
+end
+
 ml = Ruml.new(ARGV[0])
-ml.broadcast!(STDIN.read)
+ml.broadcast!($stdin.read)

data/lib/ruml/broadcaster.rb

@@ -47,6 +47,10 @@ module Ruml
       @ml.to
     end
 
+    def recipients
+      @ml.members
+    end
+
     def subject
       if @ml.name && !@message.subject.include?(@ml.name)
         "#{@ml.name} #{@message.subject}"
@@ -56,30 +60,16 @@ module Ruml
     end
 
     def send!
-      @ml.members.each do |recipient|
-        send_to(recipient)
-      end
-    end
-
-    def send_to(recipient)
       mail = Mail.new
       mail.subject  subject
       mail.from     from
       mail.to       to
-      mail.bcc      recipient
+      mail.bcc      recipients
 
       add_headers! mail
       add_body! mail
-      deliver! mail
-    end
 
-    def deliver! mail
-      if $debug
-        puts mail.to_s
-      else
-        mail.delivery_method :sendmail
-        mail.deliver
-      end
+      mail.deliver
     end
   end
 end

data/lib/ruml/list.rb

@@ -1,10 +1,10 @@
 module Ruml
   class List
-    attr_reader :name
+    attr_reader :dir
 
     def initialize(dir)
+      raise ArgumentError, "Couldn't find mailing list in #{dir.inspect}" unless File.directory?(dir)
       @dir = dir
-      raise "Unknown ml #{name} (#{@dir})" unless File.directory?(@dir)
     end
 
     def id
@@ -16,7 +16,7 @@ module Ruml
     end
 
     def members
-      @members ||= readlines("members").reject { |member| member =~ /^#|^$/ }
+      @members ||= readlines("members").map(&:downcase).uniq.reject { |member| member =~ /^#|^$/ }
     end
 
     def to

data/lib/ruml/version.rb

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

data/ruml.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "ruml"
+require "ruml/version"
 
 Gem::Specification.new do |s|
   s.name        = "ruml"
@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
+  s.add_development_dependency "minitest"
+
   s.add_runtime_dependency "mail", "~> 2.3.0"
 end

data/test/fixtures/example_ml/bounce_to

@@ -0,0 +1 @@
+test-ml-bounce@example.com

data/test/fixtures/example_ml/members

@@ -0,0 +1,7 @@
+info@example.com
+foo@example.com
+Foo@example.com
+# Some empty entries
+# commented unused@example.com
+ # with space
+  

data/test/fixtures/example_ml/name

@@ -0,0 +1 @@
+[Test ML]

data/test/fixtures/example_ml/to

@@ -0,0 +1 @@
+test-ml@example.com

data/test/helper.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'ruml'
+
+Mail.defaults do
+  delivery_method :test
+end
+
+module RumlTestSupport
+  def exec_ruml(arg, input)
+    # TODO execute "bin/ruml" directly
+    begin
+      ml = Ruml.new(arg)
+      ml.broadcast!(input)
+      "" # empty output
+    rescue => e
+      "#{e.message} (#{e.class})"
+    end
+  end
+
+  def fixture_path(*name)
+    File.join(File.dirname(__FILE__), "fixtures", *name.map(&:to_s))
+  end
+
+  def deliveries
+    Mail::TestMailer.deliveries
+  end
+
+  def example_ml_path
+    fixture_path "example_ml"
+  end
+end
+
+MiniTest::Unit::TestCase.send :include, RumlTestSupport
+
+MiniTest::Unit::TestCase.add_setup_hook do
+  Mail::TestMailer.deliveries.clear
+end
+
+module Kernel
+  def capture_output
+    out = StringIO.new
+    $stdout = out
+    $stderr = out
+    yield
+    return out.string
+  ensure
+    $stdout = STDOUT
+    $stdout = STDERR
+  end
+end

data/test/integration_test.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+describe "Ruml binary" do
+  it "fails with TypeError w/o arguments" do
+    output = exec_ruml nil, nil
+    output.must_match "can't convert nil into String (TypeError)"
+  end
+
+  it "fails with ArgumentError using invalid list path" do
+    output = exec_ruml "invalid path", nil
+    output.must_match "Couldn't find mailing list in \"invalid path\" (ArgumentError)"
+  end
+
+  it "fails with NoMethodError on empty input" do
+    output = exec_ruml example_ml_path, nil
+    output.must_match "undefined method `size' for nil:NilClass (NoMethodError)"
+  end
+
+  describe "with example_ml" do
+    let(:mailing_list) { Ruml::List.new(example_ml_path) }
+
+    it "refuse email from unknown member" do
+      mail = compose_mail(mailing_list, :from => "unknown@member.com")
+      output = exec_ruml mailing_list.dir, mail.to_s
+      output.must_be_empty
+      deliveries.must_be_empty
+    end
+
+    describe "from valid member" do
+      let(:mail) { compose_mail(mailing_list) }
+      let(:output) { exec_ruml mailing_list.dir, mail.to_s }
+      let(:delivery) { output; deliveries.first }
+
+      it "output is empty" do
+        output.must_be_empty
+      end
+
+      it "delivers to mailing list & its members" do
+        k = (mailing_list.members + [ mailing_list.to ]).sort
+        delivery.destinations.sort.must_equal k
+        deliveries.size.must_equal 1
+      end
+
+      it "contains valid headers" do
+        delivery.subject.must_include mailing_list.name
+        delivery.subject.must_include mail.subject
+        delivery.from.must_equal mail.from
+        delivery.to.must_equal [ mailing_list.to ]
+      end
+
+      it "contains valid extra headers" do
+        delivery['X-BeenThere'].value.must_equal mailing_list.to
+        delivery['List-Id'].value.must_include mailing_list.id
+        delivery['List-Post'].value.must_include "mailto:"
+        delivery['List-Post'].value.must_include mailing_list.to
+        delivery['Sender'].value.must_equal mailing_list.bounce_to
+        delivery['Errors-To'].value.must_equal mailing_list.bounce_to
+      end
+
+      #it "contains users agent" do
+      #end
+
+      it "contains correct body" do
+        delivery.body.encoded.must_equal mail.body.encoded
+      end
+    end
+  end
+
+  private
+
+  def compose_mail(ml, options={}, &block)
+    defaults = {
+      :from     => ml.members.first,
+      :to       => ml.to,
+      :subject  => "Some subject",
+      :body     => "some body"
+    }
+    Mail.new(defaults.merge(options), &block)
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruml
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Peter Suschlik
@@ -15,12 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-27 00:00:00 Z
+date: 2011-10-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: mail
+  name: minitest
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -32,7 +46,7 @@ dependencies:
         - 0
         version: 2.3.0
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 description: ""
 email: 
 - peter@suschlik.de
@@ -59,6 +73,12 @@ files:
 - lib/ruml/list.rb
 - lib/ruml/version.rb
 - ruml.gemspec
+- test/fixtures/example_ml/bounce_to
+- test/fixtures/example_ml/members
+- test/fixtures/example_ml/name
+- test/fixtures/example_ml/to
+- test/helper.rb
+- test/integration_test.rb
 homepage: https://github.com/splattael/ruml
 licenses: []