imap_archiver 0.0.1

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 Jelle Helsen
+
+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,17 @@
+= imap_archiver
+
+Description goes here.
+
+== 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 Jelle Helsen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "imap_archiver"
+    gem.summary = %Q{Tool to archive lots of messages in an imap server}
+    gem.description = %Q{imap_archiver is a command line tool to archive messages on an imap server. 
+      You tell it what folders to archive and where to archive it.
+      For every folder that is archived a series of folders (one for each month) is created inside the archive folder.}
+    gem.email = "jelle.helsen@hcode.be"
+    gem.homepage = "http://github.com/jellehelsen/imap_archiver"
+    gem.authors = ["Jelle Helsen"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "aruba", ">= 0"
+    
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# Spec::Rake::SpecTask.new(:rcov) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+
+# task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "imap_archiver #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/bin/imap_archiver

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'imap_archiver'
+exit ImapArchiver::CLI.execute(STDOUT,STDIN, ARGV)

data/cucumber.yml

@@ -0,0 +1,10 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --color"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
+autotest: --format pretty --tags @wip --wip features --color
+autotest-all: <%= std_opts %> features

data/features/configuration.feature

@@ -0,0 +1,44 @@
+Feature: Configuring imaparchiver
+  In order to configure imaparchiver
+  A configuration file should be read
+
+  Scenario: Parsing the configuration file
+    Given a file named "/tmp/imap_archiver_config.rb" with:
+    """
+    ImapArchiver::Config.run do |config|
+       config.imap_server = 'imap.example.net'
+       config.username = 'jhelsen'
+       config.password = 'secret'
+       config.folders_to_archive = /test/
+       config.archive_folder = "/Archive/test"
+    end
+    """
+    When I load the configuration file "/tmp/imap_archiver_config.rb"
+    Then the configuration imap_server should be "imap.example.net"
+    And the configuration username should be "jhelsen"
+    And the configuration password should be "secret"
+    And the configuration folders_to_archive should be "/test/"
+    And the configuration archive_folder should be "/Archive/test"
+    
+  Scenario: starting without a configuration file
+    Given I have no file "/tmp/imap_archiver_config.rb"
+    When I run "../../bin/imap_archiver -F /tmp/imap_archiver_config.rb"
+    Then it should fail with:
+    """
+    Config_file not found!
+    """
+  
+  
+  Scenario: starting with an invalid configuration file
+    Given a file named "/tmp/imap_archiver_config.rb" with:
+    """
+    ImapArchiver::Config.run do |config|
+    end
+    """
+    When I run "../../bin/imap_archiver -F /tmp/imap_archiver_config.rb"
+    Then it should fail with:
+    """
+    No imap server in configuration file!
+    """
+  
+  

data/features/step_definitions/configuration_steps.rb

@@ -0,0 +1,14 @@
+Given /^I have no file "([^"]*)"$/ do |filename|
+  `rm -f #{filename}` 
+end
+
+When /^I load the configuration file "([^"]*)"$/ do |filename|
+  @archiver = ImapArchiver::Archiver.new(filename)
+end
+
+Then /^the configuration ([^"]*) should be "([^"]*)"$/ do |key,value|
+  if value =~ /^\/.*\/$/
+    value = Regexp.compile(value.gsub("/",""))
+  end
+  @archiver.send(key).should == value
+end

data/features/support/env.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'imap_archiver'
+
+require "aruba"
+# require 'rspec/expectations'
+# require 'cucumber/rspec/doubles'
+require 'rspec/core'
+require "rspec/mocks"
+RSpec.configure do |c|
+ # c.mock_framework = :rspec
+ c.mock_framework = :mocha
+ # c.mock_framework = :rr
+ # c.mock_framework = :flexmock
+end
+
+require 'cucumber/rspec/doubles'
+# require 'spec/stubs/cucumber'

data/lib/imap_archiver.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$:.unshift(File.dirname(__FILE__)+'/imap_archiver')
+require "rubygems"
+require "net/imap"
+require "date"
+require "active_support/all"
+require "pathname"
+require "archiver"
+require "cli"
+require "config"
+require "ostruct"
+module ImapArchiver
+  Version = File.exist?('VERSION') ? File.read('VERSION').strip : ""
+end

data/lib/imap_archiver/archiver.rb

@@ -0,0 +1,105 @@
+require "config"
+module ImapArchiver
+  class Archiver
+    include ::ImapArchiver::Config
+    attr_accessor :connection
+    def initialize(config_file)
+      self.load_config(config_file)
+      config_valid?
+    end
+    
+    def connect
+      self.reconnect
+      @msg_count = 0
+    end
+    
+    def reconnect
+      self.connection = Net::IMAP.new(imap_server) rescue nil
+      capability = self.connection.capability rescue nil
+      if capability.detect {|c| c =~ /AUTH=(CRAM|DIGEST)-MD5/}
+        puts "loging in with #{auth_mech}"
+        self.connection.authenticate(auth_mech,username,password)
+      else
+        puts "plain login"
+        self.connection.login(username,password) rescue nil
+      end
+    end
+    
+    def folder_list
+      connect if connection.nil?
+      if folders_to_archive.is_a? Array
+        folders = folders_to_archive.map {|f| connection.list('',f)}
+        return folders.delete_if(&:nil?).map(&:first)
+      end
+      if folders_to_archive.is_a? Regexp
+        folders = connection.list("","*")
+        return folders.delete_if {|f| (f.name =~ folders_to_archive).nil? }
+      end
+      connection.list(base_folder,"*")
+    end
+    
+    def start 
+      folder_list.each do |folder|        
+        since_date = Date.today.months_ago(3).beginning_of_month 
+        before_date= Date.today.months_ago(3).end_of_month 
+        archive_folder_between_dates(folder.name,since_date,before_date) #if folder.name =~ /^Public Folders\/Team\//
+      end
+    end
+    
+    def archive_folder_between_dates(folder, since_date, before_date)
+      tmp_folder = Pathname.new(folder).relative_path_from(Pathname.new(base_folder)).to_s
+      current_archive_folder = "#{archive_folder}/#{tmp_folder}/#{since_date.strftime("%b %Y")}"
+      # puts archive_folder
+      conditions = ["SINCE", since_date.strftime("%d-%b-%Y"), "BEFORE", before_date.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]
+      retry_count = 0
+      begin
+        connection.select(folder)
+        # puts "will search 1"
+        msgs_to_archive = connection.search(conditions)
+        if msgs_to_archive.size > 0
+          # puts "will archive #{msgs_to_archive.size} messages"
+          if connection.list("",current_archive_folder).nil?
+            connection.create(current_archive_folder)
+            if connection.capability.include?("ACL")
+              self.archive_folder_acl.each do |key,value|
+                connection.setacl(current_archive_folder,key,value)
+              end
+            end
+          end
+          connection.copy(msgs_to_archive, current_archive_folder)
+          connection.store(msgs_to_archive, "+FLAGS",[:Deleted])
+          @msg_count += msgs_to_archive.size
+          connection.expunge
+        end
+        if connection.search(["BEFORE", since_date.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]).size > 0
+          archive_folder_between_dates(folder,since_date.months_ago(1), since_date-1)
+        end
+      rescue IOError => e
+        retry_count += 1
+        # puts "retrying"
+        if retry_count < 3
+          reconnect
+          retry
+        else
+          puts "Error archiving #{folder} to #{archive_folder}: #{e}"
+          puts e.backtrace
+        end
+        rescue Net::IMAP::NoResponseError => e
+          puts "#{e}: #{folder}: #{e.backtrace.join("\n")}"
+      # rescue Exception => e
+      #   retry_count += 1
+      #   if retry_count < 3
+      #     puts "retrying #{e}"
+      #     retry
+      #   else
+      #     puts "Error archiving #{folder} to #{archive_folder}: #{e}"
+      #     puts e.backtrace
+      #   end
+      end
+    end
+    
+    def self.run(config_file)
+      self.new(config_file).start
+    end    
+  end
+end

data/lib/imap_archiver/cli.rb

@@ -0,0 +1,38 @@
+require 'optparse'
+
+module ImapArchiver
+  class CLI
+    def self.execute(stdout,stdin, arguments=[])
+
+      # NOTE: the option -p/--path= is given as an example, and should be replaced in your application.
+      options = {
+        :config_file => "~/.imap_archiver.rb"
+      }
+      mandatory_options = %w(  )
+
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+          This application is wonderful because...
+
+          Usage: #{File.basename($0)} [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+        opts.on("-h", "--help",
+                "Show this help message.") { stdout.puts opts; exit }
+        opts.on("-F PATH", "", String, "Configuration file", "Default: ~/.imap_archiver.yml"){|arg| options[:config_file] = arg}
+        opts.parse!(arguments)
+
+        if mandatory_options && mandatory_options.find { |option| options[option.to_sym].nil? }
+          stdout.puts opts; exit
+        end
+      end
+      
+      # Config.load_config(options[:config_file])
+      Archiver.run(options[:config_file])
+      
+      return 0
+    end
+  end
+end

data/lib/imap_archiver/config.rb

@@ -0,0 +1,47 @@
+require "ostruct"
+module ImapArchiver
+  module Config
+    attr_accessor :imap_server, :username, :password, :auth_mech, :base_folder, :archive_folder, :folders_to_archive, :archive_folder_acl
+    
+    # @@config_struct = ::OpenStruct.new({:imap_server => '', 
+    #                                   :username => '',
+    #                                   :password => ''})
+    
+    def self.load_config(config_file)
+      begin
+        load config_file
+      rescue LoadError => e
+        raise "Config_file not found! #{config_file} #{e}"
+      end
+    end
+    
+    def load_config(config_file)
+      @@base = self
+      ImapArchiver::Config.load_config(config_file)
+    end
+    
+    def self.run
+      yield self
+    end
+    
+    def self.included(base)
+      base.extend(self)
+    end
+    
+    # def method_missing(method, *args)
+    #   @@config_struct.send(method,*args)
+    # end
+    
+    def config_valid?
+      self.auth_mech ||= "CRAM-MD5"
+      raise "No imap server in configuration file!" if self.imap_server.nil?
+      raise "No username in configuration file!" if username.nil?
+      raise "No password in configuration file!" if password.nil?
+    end
+    # private
+    def self.method_missing(method, *args)
+      @@base.send(method,*args)
+    end
+    
+  end
+end

data/spec/archiver_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe ImapArchiver::Archiver do
+  it "should load and validate the configuration" do
+    ImapArchiver::Config.expects(:load_config)
+    ImapArchiver::Archiver.any_instance.expects(:config_valid?)
+    ImapArchiver::Archiver.new("configfile")
+  end
+  
+  describe "IMAP connection" do
+    before(:each) do
+      ImapArchiver::Config.expects(:load_config)
+      ImapArchiver::Archiver.any_instance.expects(:config_valid?)
+      @archiver = ImapArchiver::Archiver.new("configfile")
+      @archiver.imap_server = "mailserver"
+      @archiver.username = "user"
+      @archiver.password = "password"
+      @archiver.auth_mech = 'CRAM-MD5'
+      @archiver.base_folder = 'Public Folders'
+    end
+    
+    it "should create and authenticate an imap connection when calling reconnect" do
+      connection = mock(:capability => ["AUTH=CRAM-MD5"])
+      Net::IMAP.expects(:new).with("mailserver").returns(connection)
+      connection.expects(:authenticate).with("CRAM-MD5","user","password")
+      @archiver.reconnect
+    end
+    
+    it "should fallback to plain login if no other authentication mechanisms are available" do
+      connection = mock()
+      Net::IMAP.expects(:new).with("mailserver").returns(connection)
+      connection.expects(:capability).returns(%w(AUTH=PLAIN AUTH=LOGIN))
+      connection.expects(:login).with("user","password")
+      @archiver.connect
+      
+    end
+    it "should reconnect when calling connect" do
+      @archiver.expects(:reconnect)
+      @archiver.connect
+    end
+    
+    it "should reconnect when an IOError is raised during archiving" do
+      @archiver.instance_variable_set(:@msg_count, 0)
+      @archiver.connection.expects(:select).times(2)
+      @archiver.connection.expects(:search).times(3).returns([1],[1],[])
+      @archiver.connection.expects(:list).times(2).returns(true)
+      @archiver.connection.stubs(:copy).raises(IOError).then.returns(nil)
+      @archiver.expects(:reconnect).times(1)
+      @archiver.connection.expects(:store)
+      @archiver.connection.expects(:expunge)
+      @archiver.archive_folder_between_dates('Public Folders/test',Date.today,Date.today)
+    end
+    
+    it "should list all folders in base_folder when starting archiving" do
+      @archiver.expects(:folder_list).returns([])
+      @archiver.start
+    end
+    
+    it "should copy and delete all found messages" do
+
+    end
+  end
+  
+  describe "listing folders" do
+    before(:each) do
+      ImapArchiver::Config.expects(:load_config)
+      ImapArchiver::Archiver.any_instance.expects(:config_valid?)
+      @archiver = ImapArchiver::Archiver.new("configfile")
+      @archiver.imap_server = "mailserver"
+      @archiver.username = "user"
+      @archiver.password = "password"
+      @archiver.auth_mech = 'CRAM-MD5'
+      @archiver.archive_folder = 'archive'
+      @archiver.base_folder = 'Public Folders'
+      # @archiver.expects(:connect)
+      @archiver.connection = stub_everything
+    end
+    it "should list all folders in folders_to_archive array" do
+      @archiver.folders_to_archive = ["Public Folders/test1", "test2"]
+      @archiver.connection.expects(:list).with('',"Public Folders/test1").returns([stub(:name => 'Public Folders/test1')])
+      @archiver.connection.expects(:list).with('',"test2").returns([stub(:name => 'test2')])
+      @archiver.connection.expects(:search).times(4).returns([])
+      @archiver.start
+    end
+    
+    it "should list all folders in folders_to_archive regexp" do
+      @archiver.folders_to_archive = /testregexp/
+      mock1 = mock(:name => 'hello')
+      mock2 = mock()
+      mock2.expects(:name).twice.returns('testregexp')
+      @archiver.connection.expects(:list).with('',"*").returns([mock1,mock2])
+      @archiver.expects(:archive_folder_between_dates)
+      @archiver.start
+    end
+    
+    it "should filter the folder_list when using a regexp" do
+      @archiver.folders_to_archive = /testregexp/
+      mock1 = mock(:name => 'hello')
+      mock2 = mock(:name => 'een testregexp test')
+      @archiver.connection.expects(:list).with('',"*").returns([mock1,mock2])
+      folder_list = @archiver.folder_list
+      folder_list.should == [mock2]
+    end
+    
+    it "should strip the folder_list of non-existing mailboxes" do
+      @archiver.folders_to_archive = ["Public Folders/test1", "test2"]
+      @archiver.connection.expects(:list).with('',"Public Folders/test1").returns([mock1 = mock()])
+      @archiver.connection.expects(:list).with('',"test2").returns(nil)
+      @archiver.folder_list.should == [mock1]
+    end  
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe ImapArchiver::CLI do
+  it "should start the archiver with the default config file if no options are given" do
+    ImapArchiver::Archiver.expects(:run).with('~/.imap_archiver.rb')
+    ImapArchiver::CLI.execute(STDOUT,STDIN,[])
+  end
+  
+  it "should display the help message" do
+    help_message = """This application is wonderful because...
+
+Usage: rspec [options]
+
+Options are:
+
+    -h, --help                       Show this help message.
+    -F PATH
+                                     Configuration file
+                                     Default: ~/.imap_archiver.yml
+"""
+    io = StringIO.new
+    
+    lambda { ImapArchiver::CLI.execute(io,STDIN,['-h']) }.should raise_error(SystemExit)
+    io.string.should == help_message
+  end
+  
+  it "should load the given config file" do
+    ImapArchiver::Archiver.expects(:run).with('/tmp/imap_archiver.rb')
+    ImapArchiver::CLI.execute(STDOUT,STDIN,%w(-F /tmp/imap_archiver.rb))
+  end
+end

data/spec/imap_archiver_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ImapArchiver" do
+  it "should read the correct version" do
+    ImapArchiver::Version.should == "0.0.1"
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,140 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "tempfile"
+describe "imap_archiver" do
+  describe "with configuration file with regexp folders_to_archive" do
+    before(:all) do
+      @config_file = File.new(File.join(Dir.tmpdir,"imap_archiver_config.rb"),'w+')
+      @config_file.write  """
+      ImapArchiver::Config.run do |config|
+         config.imap_server = 'imap.example.net'
+         config.username = 'jhelsen'
+         config.password = 'secret'
+         config.folders_to_archive = /^test/
+         config.archive_folder = '/Archive/test'
+         config.base_folder = ''
+         config.archive_folder_acl = {'jhelsen' => 'lrswpcda'}
+      end
+      """
+      @config_file.close
+    end
+
+    after(:all) do
+      # File.delete(@config_file.path)
+    end
+
+    before(:each) do
+      @connection = stub_everything(:capability => %w(AUTH=CRAM-MD5 ACL))
+      @expectation = Net::IMAP.expects(:new).with("imap.example.net").returns(@connection)
+      @archive_date = Date.today.months_ago(3).beginning_of_month
+    end
+    it "should create and authenticate an imap connection and list all folders" do
+      @connection.expects(:authenticate).with("CRAM-MD5","jhelsen","secret").returns(true)
+      @connection.expects(:list).with("","*").returns([])
+      flunk "Config file gone!!!" unless File.file?(@config_file.path)
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+    end
+
+    it "should select and search the matching mailboxes" do
+      @connection.expects(:list).with("","*").returns([mock1=stub(:name=>'testfolder'),mock2=stub(:name=>'foldertest')])
+      @connection.expects(:select).with('testfolder')
+      @connection.expects(:search).twice.returns([]) #search current range and before
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+    end
+
+    it "should create a mailbox for archiving if it does not exist" do
+      @connection.expects(:list).with("","*").returns([mock1=stub(:name=>'testfolder'),mock2=stub(:name=>'foldertest')])
+      @connection.expects(:select).with('testfolder')
+      @connection.expects(:search).twice.returns([1,2],[])
+      @connection.expects(:list).with('',"/Archive/test/testfolder/#{@archive_date.strftime("%b %Y")}")
+      @connection.expects(:create).with("/Archive/test/testfolder/#{@archive_date.strftime("%b %Y")}")
+
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+    end
+
+    it "should not create a mailbox for archiving if it does  exist" do
+      @connection.expects(:list).with("","*").returns([mock1=stub(:name=>'testfolder'),mock2=stub(:name=>'foldertest')])
+      @connection.expects(:select).with('testfolder')
+      @connection.expects(:search).twice.returns([1,2],[])
+      @connection.expects(:list).with('',"/Archive/test/testfolder/#{@archive_date.strftime("%b %Y")}").returns(stub_everything('archive folder'))
+      @connection.expects(:create).never
+
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+    end
+
+    it "should copy messages found to the archive folder" do
+      @connection.expects(:list).with("","*").returns([mock1=stub(:name=>'testfolder'),mock2=stub(:name=>'foldertest')])
+      @connection.expects(:select).with('testfolder')
+      # @connection.expects(:search).twice.returns([1,2],[])
+      @connection.expects(:search).with(["SINCE", @archive_date.strftime("%d-%b-%Y"), "BEFORE", @archive_date.end_of_month.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]).returns([1,2])
+      @connection.expects(:search).with(["BEFORE", @archive_date.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]).returns([])
+
+      @connection.expects(:copy).with([1,2],"/Archive/test/testfolder/#{@archive_date.strftime("%b %Y")}")
+
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+
+    end
+
+    it "should delete the copied messages" do
+      @connection.expects(:list).with("","*").returns([mock1=stub(:name=>'testfolder'),mock2=stub(:name=>'foldertest')])
+      @connection.expects(:select).with('testfolder')
+      @connection.expects(:search).twice.returns([1,2],[])
+      @connection.expects(:store).with([1,2],"+FLAGS",[:Deleted])
+      @connection.expects(:expunge)
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+
+    end
+
+    it "should search for messages older then the archiving period" do
+      @connection.expects(:list).with("","*").returns([mock1=stub(:name=>'testfolder'),mock2=stub(:name=>'foldertest')])
+      @connection.expects(:select).with('testfolder').twice
+      @connection.expects(:search).with(["SINCE", @archive_date.strftime("%d-%b-%Y"), "BEFORE", @archive_date.end_of_month.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]).returns([1,2])
+      @connection.expects(:search).with(["BEFORE", @archive_date.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]).returns([3,4])
+      @archive_date = @archive_date.prev_month
+      @connection.expects(:search).with(["SINCE", @archive_date.strftime("%d-%b-%Y"), "BEFORE", @archive_date.end_of_month.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]).returns([1,2])
+      @connection.expects(:search).with(["BEFORE", @archive_date.strftime("%d-%b-%Y"), "SEEN", "NOT", "FLAGGED"]).returns([])
+
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+    end
+  
+    it "should set the correct acl on newly created archive folders" do
+      @connection.expects(:list).with("","*").returns([mock1=stub(:name=>'testfolder'),mock2=stub(:name=>'foldertest')])
+      @connection.expects(:select).with('testfolder')
+      @connection.expects(:search).twice.returns([1,2],[])
+      @connection.expects(:list).with('',"/Archive/test/testfolder/#{@archive_date.strftime("%b %Y")}")
+      @connection.expects(:create).with("/Archive/test/testfolder/#{@archive_date.strftime("%b %Y")}")
+      @connection.expects(:setacl).with("/Archive/test/testfolder/#{@archive_date.strftime("%b %Y")}",'jhelsen','lrswpcda')
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+      
+    end
+  end
+
+  describe "with configuration file with array folders_to_archive" do
+    before(:all) do
+      @config_file = File.new(File.join(Dir.tmpdir,"imap_archiver_config.rb"),'w+')
+      @config_file.write  """
+      ImapArchiver::Config.run do |config|
+         config.imap_server = 'imap.example.net'
+         config.username = 'jhelsen'
+         config.password = 'secret'
+         config.folders_to_archive = %w(test1 test2)
+         config.archive_folder = '/Archive/test'
+         config.base_folder = ''
+      end
+      """
+      @config_file.close
+    end
+    
+    before(:each) do
+      @connection = stub_everything(:capability => %w(AUTH=CRAM-MD5))
+      @expectation = Net::IMAP.expects(:new).with("imap.example.net").returns(@connection)
+      @archive_date = Date.today.months_ago(3).beginning_of_month
+    end
+    
+    it "should select and search the matching mailboxes" do
+      @connection.expects(:list).with("","test1").returns([mock1=stub(:name=>'test1')])
+      @connection.expects(:select).with('test1')
+      @connection.expects(:search).twice.returns([]) #search current range and before
+      ImapArchiver::CLI.execute(STDOUT,STDIN,["-F",@config_file.path])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'imap_archiver'
+require 'rspec'
+require 'rspec/autorun'
+require "mocha"
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.mock_framework = :mocha
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: imap_archiver
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jelle Helsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-01 00:00:00 +02:00
+default_executable: imap_archiver
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  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: aruba
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: |-
+  imap_archiver is a command line tool to archive messages on an imap server. 
+        You tell it what folders to archive and where to archive it.
+        For every folder that is archived a series of folders (one for each month) is created inside the archive folder.
+email: jelle.helsen@hcode.be
+executables: 
+- imap_archiver
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- bin/imap_archiver
+- cucumber.yml
+- features/configuration.feature
+- features/step_definitions/configuration_steps.rb
+- features/support/env.rb
+- lib/imap_archiver.rb
+- lib/imap_archiver/archiver.rb
+- lib/imap_archiver/cli.rb
+- lib/imap_archiver/config.rb
+- spec/archiver_spec.rb
+- spec/cli_spec.rb
+- spec/imap_archiver_spec.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jellehelsen/imap_archiver
+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: Tool to archive lots of messages in an imap server
+test_files: 
+- spec/archiver_spec.rb
+- spec/cli_spec.rb
+- spec/imap_archiver_spec.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb