imap_tickler 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in imap_tickler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    imap_tickler (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    chronic (0.3.0)
+    delorean (0.2.1)
+      chronic
+    diff-lcs (1.1.2)
+    mocha (0.9.11)
+      rake
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  delorean
+  imap_tickler!
+  mocha
+  rspec

data/README.markdown

@@ -0,0 +1,57 @@
+imap\_tickler
+===========
+
+imap\_tickler is a utility that ticklers your _43 folders_ style mailfolders. It expects the following folderstructure in your mail.
+
+    @Tickler
+      Month
+        01 Jan
+        02 Feb
+        03 Mar
+        04 Apr
+        05 May
+        06 Jun
+        07 Jul
+        08 Aug
+        09 Sep
+        10 Oct
+        11 Nov
+        12 Dec
+      Week 1
+        1
+        2
+        3
+        4
+        5
+        6
+        7
+      Week 2
+        8
+        9
+        10
+        11
+        12
+        13
+        14
+      Week 3
+        15
+        16
+        17
+        18
+        19
+        20
+        21
+      Week 4
+        22
+        23
+        24
+        25
+        26
+        27
+        28
+      Week 5
+        29
+        30
+        31
+
+It will move all mail from today's mailbox and this month's mailbox into your inbox.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+require "rspec/core/rake_task"
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/autotest/discover.rb

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

data/bin/imap_tickler

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "imap_tickler/cli"
+exit ImapTickler::CLI.execute(STDIN,STDOUT,ARGV)

data/imap_tickler.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "imap_tickler/version"
+
+Gem::Specification.new do |s|
+  s.name        = "imap_tickler"
+  s.version     = ImapTickler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jelle Helsen"]
+  s.email       = ["jelle.helsen@hcode.be"]
+  s.homepage    = "http://rubygems.org/gems/imap_tickler"
+  s.summary     = %q{an imap tickler}
+  s.description = %q{imap_tickler is a utility that ticklers your 43 folders style mailfolders. It expects the following folderstructure in your mail.}
+
+  s.rubyforge_project = "imap_tickler"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "delorean"
+  s.add_development_dependency "mocha"
+end

data/lib/imap_tickler/cli.rb

@@ -0,0 +1,24 @@
+require 'optparse'
+require "yaml"
+require "imap_tickler/tickler"
+module ImapTickler
+  class CLI
+    def self.execute(input,output,arguments=[])
+      options = {:config_file => "~/.imap_tickler.conf"}
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+            Usage: #{File.basename($0)} [options]
+
+            Options are:
+        BANNER
+        opts.on( "-F path", "", String,
+                "Load an alternate config file") do |opt|
+          options[:config_file] = opt
+                end
+      end
+      parser.parse(arguments)
+      config = YAML.load_file(File.expand_path(options[:config_file]))
+      Tickler.new(config).start
+    end
+  end
+end

data/lib/imap_tickler/tickler.rb

@@ -0,0 +1,51 @@
+require "date"
+require "net/imap"
+module ImapTickler
+  class Tickler
+    attr_reader :config, :connection
+    def initialize(config)
+      @day_list = ["Week 1/1", "Week 1/2", "Week 1/3", "Week 1/4", "Week 1/5", "Week 1/6", "Week 1/7", "Week 2/8", "Week 2/9",
+        "Week 2/10", "Week 2/11", "Week 2/12", "Week 2/13", "Week 2/14", "Week 3/15", "Week 3/16", "Week 3/17", "Week 3/18",
+        "Week 3/19", "Week 3/20", "Week 3/21", "Week 4/22", "Week 4/23", "Week 4/24", "Week 4/25", "Week 4/26", "Week 4/27", 
+        "Week 4/28", "Week 5/29", "Week 5/30", "Week 5/31"]
+
+      @month_list = ["Month/01 Jan", "Month/02 Feb", "Month/03 Mar", "Month/04 Apr", "Month/05 May", "Month/06 Jun", 
+        "Month/07 Jul", "Month/08 Aug", "Month/09 Sep", "Month/10 Oct", "Month/11 Nov", "Month/12 Dec"]
+      
+      @config = config
+    end
+
+    def connect
+      @connection = Net::IMAP.new(config[:mailserver], 993, true) if config[:use_ssl]
+      @connection ||= Net::IMAP.new(config[:mailserver])
+      if @connection
+        @connection.login(config[:username],config[:password])
+      end
+    end
+  
+    def this_months_mailbox
+      @month_list[Date.today.month - 1]
+    end
+  
+    def todays_mailbox
+      @day_list[Date.today.day - 1]
+    end
+
+    def tickle_mailbox mailbox
+      connection.select("@Tickler/#{mailbox}")
+      messages = connection.responses["EXISTS"][-1]
+      if messages > 0
+        connection.copy(1..messages,"INBOX")
+        connection.store(1..messages,"+FLAGS", [:Deleted])
+      end
+    end
+
+    def start
+      connect
+      [todays_mailbox, this_months_mailbox].each do |mailbox|
+        tickle_mailbox(mailbox)
+      end
+      return 0
+    end
+  end
+end

data/lib/imap_tickler/version.rb

@@ -0,0 +1,3 @@
+module ImapTickler
+  VERSION = "0.0.1"
+end

data/lib/imap_tickler.rb

@@ -0,0 +1,4 @@
+module ImapTickler
+  require "imap_tickler/version"
+  require "imap_tickler/tickler"
+end

data/spec/lib/cli_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require "imap_tickler/cli"
+describe ImapTickler::CLI do 
+  it "should load the default config file" do
+    YAML.expects(:load_file).with(File.expand_path('~/.imap_tickler.conf')).returns(config = mock)
+    ImapTickler::Tickler.expects(:new).with(config).returns(tickler = mock(:start => nil))
+    ImapTickler::CLI.execute(STDIN,STDOUT,[])
+  end
+
+  it "should load the given config file" do
+    YAML.expects(:load_file).with(File.expand_path('/tmp/imap_tickler.conf')).returns(config = mock)
+    ImapTickler::Tickler.expects(:new).with(config).returns(tickler = mock(:start => nil))
+    ImapTickler::CLI.execute(STDIN,STDOUT,%w(-F /tmp/imap_tickler.conf))
+  end
+
+  it "should start the tickler" do
+    YAML.expects(:load_file).with(File.expand_path('/tmp/imap_tickler.conf')).returns(config = mock)
+    ImapTickler::Tickler.expects(:new).with(config).returns(tickler = mock)
+    tickler.expects(:start).returns(0)
+    ImapTickler::CLI.execute(STDIN,STDOUT,%w(-F /tmp/imap_tickler.conf)).should == 0
+  end
+end

data/spec/lib/ticker_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+describe ImapTickler::Tickler do 
+  before do
+    @tickler = ImapTickler::Tickler.new({:mailserver => 'imap.example.com', :username => "user@domain", :password => "secret"})
+  end
+  it "should get the correct mailbox for this month" do
+    Delorean.time_travel_to "5 Jan 2011"
+    @tickler.this_months_mailbox.should == "Month/01 Jan"
+    Delorean.time_travel_to "5 Feb 2011"
+    @tickler.this_months_mailbox.should == "Month/02 Feb"
+    Delorean.time_travel_to "5 Dec 2011"
+    @tickler.this_months_mailbox.should == "Month/12 Dec"
+    Delorean.back_to_the_present
+  end
+
+  it "should get the correct mailbox for today" do
+    Delorean.time_travel_to "5 Jan 2011"
+    @tickler.todays_mailbox.should == "Week 1/5"
+    Delorean.time_travel_to "15 Feb 2011"
+    @tickler.todays_mailbox.should == "Week 3/15"
+    Delorean.time_travel_to "25 Dec 2011"
+    @tickler.todays_mailbox.should == "Week 4/25"
+    Delorean.back_to_the_present
+  end
+
+  it "should conect to the mailserver" do
+    Net::IMAP.expects(:new).with('imap.example.com').returns(connection = mock)
+    connection.expects(:login).with("user@domain","secret")
+    @tickler.connect
+  end
+
+  it "should select the mailbox" do
+    @tickler.expects(:connection).times(2).returns(connection = mock)
+    connection.expects(:select).with("@Tickler/Week 1/5")
+    connection.expects(:responses).returns({"EXISTS" => [0]})
+    @tickler.tickle_mailbox("Week 1/5")
+  end
+  
+  it "should copy and delete all mails in the mailbox" do
+    @tickler.expects(:connection).times(4).returns(connection ||= mock)
+    connection.expects(:select).with("@Tickler/Week 1/5")
+    connection.expects(:responses).returns({"EXISTS" => [21]})
+    connection.expects(:copy).with(1..21,"INBOX")
+    connection.expects(:store).with(1..21, "+FLAGS", [:Deleted] )
+    @tickler.tickle_mailbox("Week 1/5")
+  end
+  
+  it "should use ssl if instructed" do
+    @tickler = ImapTickler::Tickler.new({:mailserver => 'imap.example.com', :username => "user@domain", :password => "secret",:use_ssl => true})
+    Net::IMAP.expects(:new).with('imap.example.com', 993, true).returns(connection = mock)
+    connection.expects(:login).with("user@domain","secret")
+    @tickler.connect
+  end
+
+  it "should connect and tickle todays and this months mailbox" do
+    Delorean.time_travel_to "5 Jan 2011"
+    @tickler.expects(:connect)
+    @tickler.expects(:tickle_mailbox).with("Week 1/5")
+    @tickler.expects(:tickle_mailbox).with("Month/01 Jan")
+    @tickler.start
+  end
+
+end

data/spec/lib/version_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+describe "version" do 
+  it "equals 0.0.1" do
+    ImapTickler::VERSION.should == "0.0.1"
+  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_tickler"
+require "delorean"
+
+RSpec.configure do |c|
+  c.color_enabled = true
+  c.mock_framework = :mocha
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: imap_tickler
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jelle Helsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 +01: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: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: delorean
+  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
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: imap_tickler is a utility that ticklers your 43 folders style mailfolders. It expects the following folderstructure in your mail.
+email: 
+- jelle.helsen@hcode.be
+executables: 
+- imap_tickler
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- autotest/discover.rb
+- bin/imap_tickler
+- imap_tickler.gemspec
+- lib/imap_tickler.rb
+- lib/imap_tickler/cli.rb
+- lib/imap_tickler/tickler.rb
+- lib/imap_tickler/version.rb
+- spec/lib/cli_spec.rb
+- spec/lib/ticker_spec.rb
+- spec/lib/version_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/imap_tickler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: imap_tickler
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: an imap tickler
+test_files: 
+- spec/lib/cli_spec.rb
+- spec/lib/ticker_spec.rb
+- spec/lib/version_spec.rb
+- spec/spec_helper.rb