imap-feeder 0.1.0

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,15 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  sh %{ #{RUBY_APP} script/txt2html README.txt > website/index.html}
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/data/encoded.rss

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8" ?>
+
+<rss version="2.0" 
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:admin="http://webns.net/mvcb/"
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
+   xmlns:wfw="http://wellformedweb.org/CommentAPI/"
+   xmlns:content="http://purl.org/rss/1.0/modules/content/"
+   >
+<channel>
+<item>
+    <title>This is the title!</title>
+    <link>http://test.ch</link>
+    <author>Mirko Stocker</author>
+    <content:encoded>
+    &lt;&quot;ja!&quot; &gt;
+    </content:encoded>
+    <pubDate>Thu, 12 Apr 2007 19:06:00 +0200</pubDate>
+</item>
+</channel>
+</rss>

data/test/data/erroneous.yml

@@ -0,0 +1,7 @@
+---
+- feed:
+    url: http://misto.chh
+    path: "INBOX.Planets.Planet KDE's"
+- feed:
+    url: http://misto.ch/invalid.html
+    path: INBOX.Planets.Planet Gentoo

data/test/data/rss20_no_body.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<rss version="2.0">
+	<channel>
+		<item>
+			<title>Mirko Stocker: KDE in Heroes!</title>
+			<link>http://blog.misto.ch/archives/324</link>
+			<pubDate>Wed, 15 Feb 2007 00:05 +0100</pubDate>
+		</item>
+	</channel>
+</rss>

data/test/data/rss20_one_entry.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<rss version="2.0">
+	<channel>
+		<item>
+			<title>title1</title>
+			<link>http://link1</link>
+			<description>description1</description>
+			<pubDate>Wed, 15 Feb 2007 00:05 +0100</pubDate>
+		</item>
+	</channel>
+</rss>

data/test/data/rss20_two_entries.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rss version="2.0">
+  <channel>
+    <item>
+      <title>title1</title>
+      <link>http://link1</link>
+      <description>description1</description>
+      <pubDate>Wed, 15 Feb 2007 00:05 +0100</pubDate>
+    </item>
+    <item>
+      <title>title2</title>
+      <link>http://link2</link>
+      <description>description2</description>
+      <pubDate>Monday 12 February 2007 17:09</pubDate>
+    </item>
+  </channel>
+</rss>

data/test/data/rss20_with_authors.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="ISO-8859-15"?>
+<rss version="2.0">
+    <channel>
+      <item>
+        <title>
+        WikifeatureUpdates
+        </title>
+        <author>MaxMuster</author>
+        <link>http://http</link>
+        <description>Changed..</description>
+        <pubDate>Wed, 07 Feb 2007 15:29:01 +0100</pubDate></item>
+      <item>
+        <title>
+        WikiInput
+        </title>
+        <author>MirkoStocker</author>
+        <link>http://http</link>
+        <description>MirkoStocker changed something</description>
+        <pubDate>Wed, 31 Jan 2007 14:03:18 +0100</pubDate></item>
+    </channel>
+  </rss>

data/test/data/simple.opml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<opml version="1.0" >
+ <body>
+  <outline isOpen="false" text="Planets">
+    <outline title="Planet KDE" xmlUrl="http://planetkde.org/rss20.xml"/>
+    <outline xmlUrl="http://planet.gentoo.org/rss20.xml" title="Planet Gentoo"/>
+  </outline>
+ </body>
+</opml>

data/test/functional_test_server.rb

@@ -0,0 +1,95 @@
+require 'imap-feeder/server'
+require 'imap-feeder/message'
+
+class ServerConnectionTest < Test::Unit::TestCase
+  
+  def test_server_host_not_found
+    assert_throws :host_not_found do
+      @server = Server.new(:host => "misto.chh")
+    end
+  end
+  
+  def test_server_login_failed
+    assert_throws :login_failed do
+      @server = Server.new(:host => $host, :user => $user, :pass => "a")
+    end
+  end
+  
+  def test_server_creation
+    assert_nothing_thrown do
+      @server = Server.new :host => $host, :user => $user, :pass => $pass
+      assert @server.connected
+    end
+  end
+end
+
+class ServerTest < Test::Unit::TestCase
+  
+  def setup
+    @server = Server.new :host => $host, :user => $user, :pass => $pass
+  end
+  
+  def teardown
+    @server.disconnect if @server
+  end
+  
+  def test_server_send_simple_message
+    m = Message.new(:title => "test-message", :body => "body")
+    assert @server.send(m, "INBOX")
+    assert @server.has?("test-message", "INBOX")
+    m = @server.retrieve("test-message", "INBOX")
+    assert_equal("test-message", m.title)
+  ensure
+    @server.delete(m, "INBOX")
+  end
+  
+  def test_server_send_simple_message_to_subfolder
+    @server.create_folder "INBOX.test-folder"
+    
+    m = Message.new(:title => "test-message2", :body => "body")
+    assert @server.send(m, "INBOX.test-folder")
+    assert ! @server.has?("test-message2", "INBOX")
+    assert @server.has?("test-message2", "INBOX.test-folder")
+  ensure
+    @server.delete_folder "INBOX.test-folder"
+  end
+  
+  def test_server_retrieve_invalid_message_header
+    m = @server.retrieve("test-message invalid", "INBOX")
+    assert_nil m
+  end
+  
+  def test_server_has_invalid_message?
+    assert ! @server.has?("test-message invalid", "INBOX")
+  end
+  
+  def test_has_folder_inbox?
+    assert @server.has_folder?("INBOX")
+  end
+  
+  def test_has_invalid_folder?
+    assert ! @server.has_folder?("InvalidFolder")
+  end
+  
+  def test_delete_not_existing
+    assert_throws :cannot_delete do
+      @server.delete_folder "Inbox.not-existing-folder"
+    end
+  end
+  
+  def test_create_already_existing
+    @server.create_folder "INBOX.test_dir"
+    assert_throws :cannot_create do
+      @server.create_folder "INBOX.test_dir"
+    end
+  ensure
+    @server.delete_folder "Inbox.test_dir"
+  end
+  
+  def test_create_and_delete_folder
+    assert_nothing_thrown { @server.create_folder "INBOX.test_dir" }
+    assert @server.has_folder?("INBOX.test_dir")
+    assert_nothing_thrown { @server.delete_folder "INBOX.test_dir" }
+    assert ! @server.has_folder?("INBOX.test_dir")
+  end
+end

data/test/test_feedreader.rb

@@ -0,0 +1,92 @@
+require 'imap-feeder/feedreader'
+require 'imap-feeder/message'
+
+class TestFeedReader < Test::Unit::TestCase
+  
+  RSS20_ONE_ENTRY    = "#{File.dirname(__FILE__)}/data/rss20_one_entry.xml"
+  RSS20_TWO_ENTRIES  = "#{File.dirname(__FILE__)}/data/rss20_two_entries.xml"
+  RSS20_WITH_AUTHORS = "#{File.dirname(__FILE__)}/data/rss20_with_authors.xml"
+  RSS20_NO_BODY      = "#{File.dirname(__FILE__)}/data/rss20_no_body.xml"
+  ENCODED_RSS        = "#{File.dirname(__FILE__)}/data/encoded.rss"
+ 
+  def test_reading_first_feed
+    messages = FeedReader.new(RSS20_ONE_ENTRY).get_new []
+    assert_equal(1, messages.size)
+    assert_equal(Time.parse("Wed, 15 Feb 2007 00:05 +0100").rfc2822, messages.first.time)
+    assert_equal("title1", messages.first.title)
+    assert_equal("description1", messages.first.body)
+  end  
+
+  def test_size_one
+    assert_equal(1, FeedReader.new(RSS20_ONE_ENTRY).number_of_entries)
+  end
+
+  def test_size_two
+    assert_equal(2, FeedReader.new(RSS20_TWO_ENTRIES).number_of_entries)
+  end
+  
+  def test_reading_second_feed
+    messages = FeedReader.new(RSS20_TWO_ENTRIES).get_new []
+    assert_equal(2, messages.size)
+    assert_equal(Time.parse("Wed, 15 Feb 2007 00:05 +0100").rfc2822, messages[0].time)
+    assert_equal("title1", messages[0].title)
+    assert_equal("description1", messages[0].body)
+    
+    assert_equal(Time.parse("Monday 12 February 2007 17:09").rfc2822, messages[1].time)
+    assert_equal("title2", messages[1].title)
+    assert_equal("description2", messages[1].body)
+  end
+  
+  def test_get_latest
+    reader = FeedReader.new(RSS20_TWO_ENTRIES)
+    messages = reader.get_new []
+    new_messages = reader.get_new([messages.last.generate_identifier])
+    
+    assert_equal(1, new_messages.size)
+    assert_equal("title1", new_messages.first.title)
+  end
+  
+  def test_get_latest_or_all
+    reader = FeedReader.new(RSS20_TWO_ENTRIES)
+    new_messages = reader.get_new(["Mirko Stocker: "])
+    
+    assert_equal(2, new_messages.size)
+    assert_equal("title1", new_messages.first.title)
+    assert_equal("title2", new_messages[1].title)
+  end
+  
+  def test_get_authors
+    messages = FeedReader.new(RSS20_WITH_AUTHORS).get_new []
+    assert_equal(2, messages.size)
+    assert_equal("MaxMuster", messages.first.from)
+    assert_equal("MirkoStocker", messages.last.from)
+  end  
+  
+  def test_no_body
+    messages = FeedReader.new(RSS20_NO_BODY).get_new []
+    assert_equal(1, messages.size)
+    assert_equal("", messages.first.body)
+  end
+  
+  def test_get_nothing
+    reader = FeedReader.new(RSS20_TWO_ENTRIES)
+    msgs = reader.get_new []
+    identifiers = msgs.map {|msg| msg.generate_identifier}
+    new_messages = reader.get_new(identifiers)
+    assert new_messages.empty?
+  end
+  
+  def test_get_all
+    reader = FeedReader.new(RSS20_TWO_ENTRIES)
+    messages = reader.messages
+    new_messages = reader.get_new(nil)
+    assert_equal(2, new_messages.size)
+  end
+
+  def test__content_encoded
+    reader = FeedReader.new(ENCODED_RSS)
+    messages = reader.messages
+    new_messages = reader.get_new(nil)
+    assert_equal  "<\"ja!\" >", new_messages.first.body
+  end
+end

data/test/test_imap-feeder.rb

@@ -0,0 +1,66 @@
+require 'tempfile'
+require 'imap-feeder'
+require 'test/testlogger'
+
+class TestServer
+  attr_reader :sent
+
+  def initialize
+    @sent = []
+  end
+
+  def has_folder?(folder)
+    true
+  end
+
+  def create_folder(folder)
+  end
+
+  def send(msg, complete_path)
+    @sent << [msg, complete_path]
+  end
+end
+
+class TestImapFeeder < Test::Unit::TestCase
+
+  TEST_FEEDS = "#{File.dirname(__FILE__)}/data"
+
+  def setup
+    $log = TestLogger.new
+    @server = TestServer.new
+    @store = MessageStore.new(Tempfile.new("message_store_temp").path)
+  end
+
+  def title(index)
+    @server.sent[index].first.title
+  end
+
+  def body(index)
+    @server.sent[index].first.body
+  end
+
+  def folder(index)
+    @server.sent[index].last
+  end
+
+  def test_simple_rss20
+    config = <<EOS
+- feed:
+    url: "#{TEST_FEEDS}/rss20_two_entries.xml"
+    path: INBOX.TestFolder
+EOS
+
+    ImapFeeder.new(@server, @store, config).run
+    assert_equal("Started", $log.info_msg[0])
+    assert_equal("Processing INBOX.TestFolder", $log.info_msg[1])
+
+    assert_equal(2, @server.sent.length)
+    assert_equal("INBOX.TestFolder", folder(0))
+    assert_equal("description1", body(0))
+    assert_equal("title1", title(0))
+    assert_equal("INBOX.TestFolder", folder(1))
+    assert_equal("description2", body(1))
+    assert_equal("title2", title(1))
+
+  end
+end

data/test/test_imapfeederconfig.rb

@@ -0,0 +1,56 @@
+require 'open-uri'
+
+require 'imap-feeder/imapfeederconfig'
+require 'test/testlogger'
+
+
+class ConfigTest < Test::Unit::TestCase
+
+  OPML_FILE = "#{File.dirname(__FILE__)}/data/simple.opml"
+  ERRONEOUS_FILE = "#{File.dirname(__FILE__)}/data/erroneous.yml"
+  FEEDS_FILE = "#{Dir.pwd}/feeds.yml"
+  SETTINGS_FILE = "#{Dir.pwd}/settings.rb"
+
+  def setup
+    $log = TestLogger.new
+  end
+
+  def test_create_with_root
+    ImapFeederConfig.create(OPML_FILE, "root")
+    result = YAML.load(open(FEEDS_FILE))
+    File.delete FEEDS_FILE
+
+    assert_equal("INBOX.root.Planets.Planet KDE", result.first['feed']['path'])
+
+    assert File.exists?(SETTINGS_FILE)
+    File.delete SETTINGS_FILE
+  end
+
+  def test_create
+    ImapFeederConfig.create(OPML_FILE, nil)
+    result = YAML.load(open(FEEDS_FILE))
+    File.delete FEEDS_FILE
+
+    assert_equal("http://planetkde.org/rss20.xml", result.first['feed']['url'])
+    assert_equal("INBOX.Planets.Planet KDE", result.first['feed']['path'])
+
+    assert_equal("http://planet.gentoo.org/rss20.xml", result.last['feed']['url'])
+    assert_equal("INBOX.Planets.Planet Gentoo", result.last['feed']['path'])
+
+    assert($log.error_msg.empty?)
+    assert($log.warn_msg.empty?)
+    assert_equal(2, $log.debug_msg.length)
+
+    assert File.exists?(SETTINGS_FILE)
+    File.delete SETTINGS_FILE
+  end
+
+  def test_check
+    ImapFeederConfig.check(File.open(ERRONEOUS_FILE))
+
+    assert_equal("Invalid character found in 'INBOX.Planets.Planet KDE's': '", $log.error_msg.first)
+    assert_match(/Exception while connecting to/, $log.warn_msg.first)
+    assert_match(/connecting/, $log.warn_msg.last)
+  end
+
+end