mail_processor 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rune Myrland
+
+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.rdoc

@@ -0,0 +1,61 @@
+= mail_processor
+
+Is a convenience processor for incoming mails. Pop3 and MailDir 
+is supported at the moment. The mail is deleted after it is processed.
+
+
+== Usage
+
+=== MailDir
+
+ processor = Processor.new do
+   retriever :mail_dir do
+     glob "#{ENV['HOME']}/MailDir/new/*"
+   end
+ end
+
+ # Process all mails in the directory 
+ processor.process do |popped|
+   # Popped is raw mail data, which may be fed
+   # to the 'mail' gem for further processing
+   puts popped
+ end
+
+
+=== Pop3
+
+ processor = Processor.new do
+   retriever :pop3 do
+     address "pop.example.com"
+     username "test@example.com"
+     password "**SECRET**"
+   end
+ end
+
+ # Process all mails in the queue
+ processor.process do |popped|
+   # Popped is raw mail data, which may be fed
+   # to the 'mail' gem for further processing
+   puts popped
+ end
+
+
+== Feature / problems
+
+Mails are automatically deleted from the server/directory after 
+they are processed.
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Rune Myrland. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mail_processor"
+    gem.summary = %Q{Is a convenience processor for incoming mails.}
+    gem.description = %Q{Pop3 and MailDir is supported at the moment.}
+    gem.email = "rune@epubify.com"
+    gem.homepage = "http://github.com/wrimle/mail_processor"
+    gem.authors = ["Rune Myrland"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mail_processor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/mail_processor/mail_dir.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'log4r'
+
+include Log4r
+include MailProcessor
+
+class File
+  def self.read_binary filename
+    f = File.new(filename, "rb")
+    content = f.read()
+    f.close()
+    content
+  end
+end
+
+module MailProcessor
+
+  class MailDir
+    def initialize options = {}, &block
+      @log = Logger.new self.class.to_s
+      @log.outputters = Outputter.stdout
+
+      @attributes = {
+        :glob => "#{ENV['HOME']}/MailDir/new/*",
+      }.merge(options)
+      instance_eval &block if block_given?
+    end
+
+
+    def glob v = nil
+      if v
+        @attributes[:glob] = v
+      else
+        @attributes[:glob]
+      end
+    end
+
+
+    def process(options = {}, &block)
+      a = @attributes.merge(options)
+
+      count = 0
+      Dir.glob(a[ :glob ]) do |filename|
+        yield(File.read_binary(filename))
+        FileUtils::rm(filename)
+        count += 1
+      end
+      @log.info "Processed #{count} mails"
+
+      count == 0
+    end
+
+  end
+end

data/lib/mail_processor/pop3.rb

@@ -0,0 +1,101 @@
+# -*- coding: utf-8 -*-
+
+require 'net/pop'
+require 'rubygems'
+require 'log4r'
+
+include MailProcessor
+
+module MailProcessor
+
+  class Pop3
+    def initialize options = {}, &block
+      @log = Logger.new self.class.to_s
+      @log.outputters = Outputter.stdout
+
+      @attributes = {
+        :address => "pop.gmail.com",
+        :port => 110, # 995,
+        :username => nil,
+        :password => nil,
+        # Must have ruby 1.9 to use this
+        :use_ssl => false, # true 
+      }.merge(options)
+      instance_eval &block if block_given?
+      self
+    end
+
+
+    def address v = nil
+      if v
+        @attributes[:address] = v
+      else
+        @attributes[:address]
+      end
+    end
+
+
+    def port v = nil
+      if v
+        @attributes[:port] = v
+      else
+        @attributes[:port]
+      end
+    end
+
+
+    def username v = nil
+      if v
+        @attributes[:username] = v
+      else
+        @attributes[:username]
+      end
+    end
+
+
+    def password v = nil
+      if v
+        @attributes[:password] = v
+      else
+        @attributes[:password]
+      end
+    end
+
+
+    def use_ssl?
+      @attributes[:use_ssl]
+    end
+
+
+    def use_ssl v = nil
+      if v
+        @attributes[:use_ssl] = v
+      else
+        @attributes[:use_ssl]
+      end
+    end
+
+
+    def process(options = {}, &block)
+      a = @attributes.merge(options)
+
+      didWork = false
+      Net::POP3.enable_ssl(OpenSSL::SSL::VERIFY_NONE) if a[:use_ssl]
+      pop = Net::POP3.new(a[:address], a[:port])
+      pop.start(a[:username], a[:password])
+      if pop.mails.empty?
+        @log.info 'No mail.'
+      else
+        pop.each_mail do |m|
+          yield m.pop
+          m.delete
+        end
+        @log.info "Processed #{pop.mails.size} mails."
+        pop.finish
+        didWork = true
+      end
+
+      didWork
+    end
+  end
+end

data/lib/mail_processor/processor.rb

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+module MailProcessor
+  class UnkownRetrieverError < StandardError; end
+
+
+  class Processor
+    def initialize options = {}, &block
+      @attributes = {
+        :retriever => nil
+      }
+      instance_eval &block
+      self
+    end
+
+
+    def retriever method, options = {}, &block
+      @retriever = case method
+                   when :pop3 then
+                     Pop3.new options, &block
+                   when :mail_dir then
+                     @retriever = MailDir.new options, &block
+                   else
+                     raise UnkownRetrieverError, "Retriever type #{method.to_s} not known"
+                   end
+    end
+
+
+    def process options = {}, &block
+      @retriever.process &block
+    end
+
+  end
+
+end

data/lib/mail_processor.rb

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+module MailProcessor; end
+
+require 'mail_processor/pop3'
+require 'mail_processor/mail_dir'
+require 'mail_processor/processor'

data/spec/data/mail_0001.eml

@@ -0,0 +1 @@
+First mail

data/spec/data/mail_0002.eml

@@ -0,0 +1 @@
+Second mail

data/spec/mail_processor_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MailProcessor" do
+
+  context "Pop3" do
+    it "works" do
+      pending("needs a real mail account")
+
+      processor = Processor.new do
+        retriever :pop3 do
+          address "pop.example.com"
+          username "test@example.com"
+          password "**SECRET**"
+        end
+      end
+
+      processor.process do |popped|
+        puts popped
+      end
+    end
+  end
+
+
+  context "MailDir" do
+    it "works" do
+      FileUtils::mkdir_p("spec/MailDir/new")
+      Dir.glob("spec/data/*.eml") do |filename|
+        FileUtils::cp(filename, "spec/MailDir/new/")
+      end
+      processor = Processor.new do
+        retriever :mail_dir do
+          glob "./spec/MailDir/new/mail*.eml"
+        end
+      end
+
+      processor.process do |popped|
+        puts popped
+      end
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mail_processor'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mail_processor'
+
+class Test::Unit::TestCase
+end

data/test/test_mail_processor.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMailProcessor < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: mail_processor
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Rune Myrland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-19 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Pop3 and MailDir is supported at the moment.
+email: rune@epubify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mail_processor.rb
+- lib/mail_processor/mail_dir.rb
+- lib/mail_processor/pop3.rb
+- lib/mail_processor/processor.rb
+- spec/data/mail_0001.eml
+- spec/data/mail_0002.eml
+- spec/mail_processor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_mail_processor.rb
+has_rdoc: true
+homepage: http://github.com/wrimle/mail_processor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Is a convenience processor for incoming mails.
+test_files: 
+- spec/mail_processor_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_mail_processor.rb