mailfakk2 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Sean Treadway
+
+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.markdown

@@ -0,0 +1,52 @@
+MailFaKK2
+=========
+
+A email to fax gateway for asterisk. It will work as a procmail filter.
+
+
+Motivation
+==========
+
+After trying out several other email to fax gateways we came to the conclusion that not any of them
+
+ * does not need java
+ * is compatible with asterisk 1.6
+ * does not cost money
+ * has tests
+ * just works
+
+MailFaKK2 tries to live up to all these requirements.
+
+
+Installation
+============
+
+Debian / Ubuntu
+---------------
+
+ * sudo apt-get install ruby ruby-dev gs unoconv openoffice.org-headless rubygems xvfb librmagick-ruby 
+ * sudo gem install activesupport andand mail prawn
+
+Cons
+====
+
+If you plan to spam by fax you should consider another product. MailFaKK2 is
+kind of slow. This is caused by launching OpenOffice.org for every conversion.
+Speed is not a priority for us (yet).
+
+TODO
+====
+
+ * [x] generate cover sheet TIFF frame from email body
+ * [x] append OpenOffice.org documents 
+ * [ ] append MS Office documents
+ * [ ] write TIFF and callfile
+ * [-] procmail mode (untested)
+ * [ ] header and footer for every frame
+ * [ ] gemspec
+ * [ ] check if fax was delivered (callfile moved to outgoing_done)
+
+Meta
+====
+
+This product is proudly presented to you by [Planetary Networks](http://planetary-networks.de).

data/Rakefile

@@ -0,0 +1,44 @@
+begin  
+  require 'rubygems'
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name        = %q{mailfakk2}
+    gemspec.summary     = %q{email to fax gateway in ruby}
+    gemspec.description = %q{
+      MailFaKK2 acts as a fax gateway. With the proper setup you can send
+      an email to <number>@fax.local and it generates a multipage tiff and
+      a callfile for asterisk
+    }
+    gemspec.email       = %q{niklas+mailfakk2@lanpartei.de}
+    gemspec.homepage    = %q{http://github.com/niklas/MailFaKK2/}
+    gemspec.authors     = ["Niklas Hofer"]
+    gemspec.executables = %w{mailfakk2}
+
+    gemspec.has_rdoc    = false
+    gemspec.files       = %w{
+      README.mardown
+      Rakefile
+
+      bin/mailfakk2
+
+      config/env.rb
+      config/forward
+      config/procmail
+
+      lib/logging.rb
+      lib/configuration.rb
+      lib/facsimile.rb
+      lib/mailfakk2.rb
+
+      MIT-LICENSE
+    }
+
+    gemspec.add_dependency('activesupport', '>=2.3.5')
+    gemspec.add_dependency('andand', '>=1.3.1')
+    gemspec.add_dependency('mail', '>=2.2.0')
+    gemspec.add_dependency('prawn', '>=0.8.4')
+  end  
+  Jeweler::GemcutterTasks.new  
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"  
+end

data/bin/mailfakk2

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','config','env'))
+
+
+include Logging
+begin
+  fakk = MailFakk2.deliver!(STDIN)
+rescue Exception => e
+  log(e.message, :err)
+  STDERR.puts e.message
+end

data/config/env.rb

@@ -0,0 +1,14 @@
+APP_ROOT   = File.join File.basename(__FILE__), '..'
+require 'rubygems'
+require 'active_support'
+require 'fileutils'
+require 'andand'
+require 'mail'
+require 'prawn'
+require 'RMagick'
+require 'tempfile'
+
+require 'logging'
+require 'facsimile'
+require 'configuration'
+require 'mailfakk2'

data/config/forward

@@ -0,0 +1,2 @@
+# put this in ~/.forward
+"|/usr/bin/procmail"

data/config/procmail

@@ -0,0 +1,3 @@
+# put this into ~fax/.procmailrc
+:0
+| mailfakk2

data/lib/configuration.rb

@@ -0,0 +1,50 @@
+require 'ostruct'
+class Configuration < Hash
+  Defaults = {
+    'outgoing_call_dir' => '/var/spool/asterisk/outgoing',
+    'archive_path'      => File.join(ENV['HOME'], 'facsimiles')
+  }
+
+  # Config files are read in this order
+  Sources = [
+    '/etc/mailfakk2.yml',
+    File.join( ENV['HOME'], '.mailfakk2.yml')
+  ]
+
+  def method_missing(methname, *args, &block)
+    methname = methname.to_s
+    if has_key?(methname)
+      self[methname]
+    else
+      if !block_given? && args.empty?
+        raise NoMethodError, "unknown configuration field: #{methname}"
+      else
+        super
+      end
+    end
+  end
+
+  def self.load
+    conf = returning(Defaults) do |h|
+      Sources.each do |source|
+
+        if File.file?(source) && File.readable?(source)
+          loaded = YAML.load_file source
+          if loaded.is_a?(Hash)
+            h.merge! loaded
+          end
+        end
+
+      end
+    end
+    build conf
+  end
+
+  def self.default
+    build Defaults
+  end
+
+  def self.build(hash)
+    new.update(Defaults).update(hash)
+  end
+end

data/lib/facsimile.rb

@@ -0,0 +1,170 @@
+class Facsimile
+  include Logging
+
+  Width = 1728
+  Height = 2156
+
+  #include ActiveSupport::Memoization
+
+  class NoPhoneNumberFound < Exception; end
+  class NoContentFound < Exception; end
+
+  attr_reader :frames
+  attr_reader :mail
+
+  def initialize(source)
+    if source.is_a?(IO)
+      @mail = Mail.new(source.read)
+    else
+      @mail = Mail.read(source)
+    end
+    @frames = Magick::ImageList.new
+    @tempfiles = []
+  end
+
+  def number
+    n = mail.header['X-Original-To'].andand.to_s || mail.to.andand.first
+    if n.present? && n.to_s =~ /^(\d{5,})/
+      return $1
+    else
+      raise NoPhoneNumberFound, "could not find any phone number"
+    end
+  end
+  
+  #memoize :number
+
+  def render
+
+    if mail.multipart?
+
+      mail.parts.each do |part|
+        case part.content_type
+        when %r'text/plain'
+          add_frames text2tiff( part.decoded )
+        when %r'opendocument\.text'
+          add_frames oo2tiff( part.decoded )
+        when %r'text/html'
+          # FIXME ignore html, let's hope a plain text contained everything important
+        else
+          STDERR.puts "unsupported content type: #{part.content_type}"
+        end
+      end
+
+    else
+
+      unless mail.body.decoded.blank?
+        text2tiff( mail.body.decoded ).each do |tiff|
+          frames << tiff
+        end
+      end
+
+    end
+
+  end
+
+  def write(path)
+    render
+    raise NoContentFound if frames.empty?
+    path = File.expand_path path
+    log("writing facsimile to #{path}")
+    path += '.tiff' unless path.ends_with?('.tiff')
+    dir = File.dirname path
+    FileUtils.mkdir_p(dir) unless File.directory?(dir)
+    frames.write(path)
+  end
+
+  def filename
+    "#{id}.tiff"
+  end
+
+  def callfile_name
+    "#{id}.call"
+  end
+
+  def id
+    unless mail.has_message_id?
+      mail.add_message_id("#{Time.now.iso8601}-#{Process.pid}")
+    end
+    mail.message_id
+  end
+
+  private
+
+  def add_frames(tiffs=nil)
+    return unless tiffs
+    tiffs.each do |tiff|
+      frames << tiff
+    end
+  end
+
+  def text2tiff(text)
+    pdf = text2pdf(text)
+    pdf2tiff(pdf)
+  end
+
+  def pdf2tiff(source)
+    dest = mktemp('tiff')
+    command = returning ['gs'] do |gs|
+      gs << '-dQUIET'
+      gs << '-sDEVICE=tiffg3'
+      gs << "-sPAPERSIZE=#{pagesize}"
+      gs << '-r204x196'
+      gs << '-dNOPAUSE'
+      gs << "-sOutputFile=#{dest.path}"
+      gs << '-c save pop'
+      gs << '-c "<< /Policies << /PageSize 5 >> /PageSize [595 842] /InputAttributes << 0 << /PageSize [595 842] >> >> >> setpagedevice"'
+      gs << "-f #{source}"
+      gs << '-c quit'
+    end.join(' ')
+    system(command)
+    read_frame dest.path
+  end
+
+  def oo2tiff(source_data)
+    source = mktemp('oo', false)
+    source.write source_data
+    source.close
+
+    dest = mktemp('pdf')
+    xvfb("unoconv -f pdf #{source.path}")
+    FileUtils.mv source.path + '.pdf', dest.path
+    pdf2tiff(dest.path)
+  end
+
+  def text2pdf(source)
+    document = Prawn::Document.new(:page_size => pagesize.upcase)
+    document.text source
+
+    dest = mktemp('pdf')
+    document.render_file dest.path
+    
+    dest.path
+  end
+
+  def new_frame
+    tiff = Magick::Image.new(Width, Height) do
+      self.background_color = 'white'
+    end
+    tiff
+  end
+
+  def read_frame(source)
+    Magick::Image.read(source)
+  end
+
+  def mktemp(name,close=true)
+    tmp = Tempfile.new(name)
+    tmp.close if close
+    tmp
+  end
+
+  def pagesize
+    'a4'
+  end
+
+  def xvfb(command)
+    system("xvfb-run --auto-servernum --server-num=23 #{command}")
+  end
+
+
+end

data/lib/logging.rb

@@ -0,0 +1,6 @@
+require 'syslog'
+module Logging
+  def log(message, severity=:warning)
+    Syslog.open('mailfakk2', Syslog::LOG_PID | Syslog::LOG_CONS) { |s| s.send(severity, message) }
+  end
+end

data/lib/mailfakk2.rb

@@ -0,0 +1,53 @@
+class MailFakk2
+  include Logging
+
+  def self.deliver!(source)
+    new(source).deliver!
+  end
+
+  attr_reader :fax
+
+  def initialize(source)
+    @fax = Facsimile.new(source)
+  end
+
+  def deliver!
+    log("sending fax to #{@fax.number}")
+    @fax.write( archive_path )
+    write_callfile
+    self
+  end
+
+  def archive_path
+    File.expand_path File.join( config.archive_path, @fax.filename)
+  end
+
+  def callfile_path
+    File.join( config.outgoing_call_dir, @fax.callfile_name)
+  end
+
+  def config
+    @config ||= Configuration.load
+  end
+
+  def write_callfile
+    tmp = Tempfile.new('call')
+    tmp.puts callfile_contents
+    tmp.close
+    FileUtils.mkdir_p config.outgoing_call_dir
+    FileUtils.mv tmp.path, callfile_path
+    FileUtils.chmod 0666, callfile_path
+  end
+
+  def callfile_contents
+    <<-EOCALL
+Channel: DAHDI/g0/#{@fax.number}
+MaxRetries: 5
+WaitTime: 20
+Context: incoming-fax
+Application: SendFax
+Data:#{archive_path}
+Archive: yes
+    EOCALL
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Configuration do
+  describe "loading" do
+    it 'should try system, then home' do
+      File.should_receive(:file?).ordered.with('/etc/mailfakk2.yml').and_return(false)
+      File.should_receive(:file?).ordered.with( File.join(ENV['HOME'], '.mailfakk2.yml') ).and_return(false)
+      c = Configuration.load
+      c.should be_a(Configuration)
+    end
+
+    it 'should fall back to defaults' do
+      File.stub!(:file?).and_return(false)
+      c = Configuration.load
+      Configuration::Defaults.each do |k,v|
+        c[k].should == v
+        c.send(k).should == v
+      end
+    end
+  end
+end

data/spec/facsimile_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe "text only" do
+  before(:each) do
+    @mail_path = mail_path('only_text')
+    @fax = Facsimile.new @mail_path
+  end
+
+  it 'should find #number' do
+    @fax.number.should == '01189998819991197253'
+  end
+
+  it 'should render 1 frame from body' do
+    @fax.write result_path('only_text')
+    @fax.frames.should be_an(Magick::ImageList)
+    @fax.should have(1).frame
+  end
+
+  it 'should add footer and header'
+end
+
+describe "text only as IO (like STDIN)" do
+  before(:each) do
+    @fax = Facsimile.new File.open( mail_path('only_text') )
+  end
+
+  it 'should find #number' do
+    @fax.number.should == '01189998819991197253'
+  end
+
+  it 'should provide id (even if no message_id in mail)' do
+    @fax.id.should_not be_blank
+  end
+
+  it 'should provide filename' do
+    @fax.filename.should =~ /.{10,}\.tiff/
+  end
+
+end
+
+describe "multipart from word mail client" do
+  before(:each) do
+    @mail_path = mail_path('multipart')
+    @fax = Facsimile.new @mail_path
+  end
+
+  it 'should find #number' do
+    @fax.number.should == '01189998819991197253'
+  end
+
+  it 'should render 1 frame from parts' do
+    @fax.write result_path('multipart')
+    @fax.frames.should be_an(Magick::ImageList)
+    @fax.should have(1).frame
+  end
+end
+
+
+describe "text with attached OpenOffice Writer Document (2 Pages)" do
+  before(:each) do
+    @mail_path = mail_path('oo_writer_attached')
+    @fax = Facsimile.new @mail_path
+  end
+
+  it 'should produce 1+2 frames' do
+    @fax.write result_path('oo_writer_attached')
+    @fax.should have(3).frames
+  end
+  
+end

data/spec/mailfakk2_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe "MailFakk2" do
+  before(:each) do
+    @mail = mail_path('only_text')
+    @fakk = MailFakk2.new @mail
+  end
+
+  it 'should create a Facsimile' do
+    @fakk.fax.should be_a(Facsimile)
+  end
+
+  it 'should load configuration' do
+    Configuration.should_receive(:load).once.and_return('config')
+    @fakk.config.should == 'config'
+  end
+
+  describe "delivery" do
+
+    before(:each) do
+      @conf = test_configuration
+      @fax_path = File.expand_path File.join( @conf.archive_path, @fakk.fax.filename)
+      @fakk.stub!(:config).and_return(@conf)
+      @fax = @fakk.fax
+      @fax.stub!(:render)
+      frames_mock = mock(:empty? => false, :write => true)
+      @fakk.fax.stub!(:frames).and_return(frames_mock)
+      @delivering = lambda { @fakk.deliver! }
+    end
+
+    after(:each) do
+    end
+
+    it 'should render the fax' do
+      @fax.should_receive(:render).once
+      @delivering.call
+    end
+
+    it 'should save the tiff to the archive path' do
+      @fax.should_receive(:write).with( @fax_path )
+      @delivering.call
+    end
+
+    it 'should create and move a callfile with proper permissions' do
+      @delivering.call
+      callfile_path = File.join( @conf.outgoing_call_dir, @fax.callfile_name)
+      File.file?(callfile_path).should be_true
+      # TODO permissions should be 0666, just to be sure. How to test this?
+    end
+
+    it 'should wait for the callfile to be moved to outgoing_done'
+    it 'should deliver a mail if no number was found'
+    it 'should deliver a mail if sending the fax failed'
+    it 'may deliver a mail report for successfull delivery'
+  end
+  it 'maybe should detach from procmail to enhance processing speed'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'spec/autorun'
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','config','env'))
+
+ResultsDir = File.join APP_ROOT, 'tmp', 'results'
+
+FileUtils.rm_rf ResultsDir if File.exists?(ResultsDir)
+FileUtils.mkdir_p ResultsDir
+
+def mail_path(name)
+  name += '.mail' unless name.ends_with?('.mail')
+  File.join APP_ROOT, 'spec', 'fixtures', name
+end
+
+def result_path(name)
+  name += '.tiff' unless name.ends_with?('.tiff')
+  File.join ResultsDir, name
+end
+
+def test_configuration
+  @@test_configuration ||= Configuration.build({
+    'outgoing_call_dir' => ResultsDir,
+    'archive_path'      => ResultsDir
+  })
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: mailfakk2
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Niklas Hofer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-16 00:00:00 +02:00
+default_executable: mailfakk2
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: andand
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 4
+        version: 0.8.4
+  type: :runtime
+  version_requirements: *id004
+description: "\n      MailFaKK2 acts as a fax gateway. With the proper setup you can send\n      an email to <number>@fax.local and it generates a multipage tiff and\n      a callfile for asterisk\n    "
+email: niklas+mailfakk2@lanpartei.de
+executables: 
+- mailfakk2
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- Rakefile
+- bin/mailfakk2
+- config/env.rb
+- config/forward
+- config/procmail
+- lib/configuration.rb
+- lib/facsimile.rb
+- lib/logging.rb
+- lib/mailfakk2.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/niklas/MailFaKK2/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: email to fax gateway in ruby
+test_files: 
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/mailfakk2_spec.rb
+- spec/facsimile_spec.rb