imap-feeder 0.1.0 → 0.2.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.2.0 2008-07-5
+
+* 1 major enhancement:
+  * HTML support! The new default format is set to HTML, for old configurations,
+    set $format = :html.
+* Several bugfixes and improved documentation.
+
 == 0.1.0 2008-06-9
 
 * 1 major enhancement:

data/README.txt

@@ -70,6 +70,36 @@ the script should generate some folders on your IMAP server and fetch the
 first round of feeds. If you are happy with the results, you can run the
 script regularly, for example using cron.
 
+== Check Configuration
+
+Imap feeder can check your feeds file for validity with regards to IMAP folder
+names and connectivity to the webservers. Use the -c FEEDS_FILE option to run
+the check and watch the output for errors and warnings.
+
+== Troubleshooting
+
+This section hopefully helps dealing with common problems that you might
+encounter.
+
+=== Already running
+
+If you're getting an error about imap-feeder "already running", this means that
+imap-feeder either really is still running or it crashed during the last run and
+couldn't clean up properly. In the last case, just remove the running_instance file
+and rerun it.
+
+=== OPML file
+
+The OPML import is not very well tested, it should certainly work with
+Akregator's OPML files. If it doesn't work for you, don't hesitate to contact me
+and send me your OPML file.
+
+=== Crashes
+
+If imap-feeder crashes with a stacktrace, take a look at the log file for more
+information. You might also want to raise the log level, see the settings file
+for instructions.
+
 == Comments
 
 Thank you for using imap-feeder and don't forget to drop me an email if you

data/TODO.txt

@@ -1,8 +1,6 @@
 Ideas for further development:
 * Adding new feeds through rssimap, without manually editing the file.
-* HTML-Mails (really?)
 * make the position of the link to the original configurable
-* embed images (e.g. for dilbert)
 
 * user-hooks that can interact with the feed processing:
  * to ignore items

data/bin/imap-feeder

@@ -9,11 +9,12 @@ opts = CreateConfigParser.parse(ARGV)
 
 if opts.create
   $stdout.puts "Creating new configuration."
+  $log = Logger.new($stdout)
   ImapFeederConfig.create(opts.create_file, opts.folder)
   $stdout.puts "Please edit your settings.rb file now."
 
 elsif opts.check
-  $stdout.puts "Checking configuration #{opts.check}"
+  $stdout.puts "Checking feeds #{opts.check}"
   $log = Logger.new($stdout)
   ImapFeederConfig.check(File.open(opts.check))
 
@@ -39,7 +40,8 @@ elsif ARGV.first and load(ARGV.first)
     :user => $user,
     :pass => $pass,
     :port => $port || "143",
-    :use_ssl => $use_ssl || false
+    :use_ssl => $use_ssl || false,
+    :format => $format || :plain
   }
 
   if opts.pretend
@@ -55,10 +57,12 @@ elsif ARGV.first and load(ARGV.first)
     end
   end
 
-  config = File.open($config)
-  imapfeeder = ImapFeeder.new(@server, store, config)
-  imapfeeder.run
-  @server.disconnect
+  if @server
+    config = File.open($config)
+    imapfeeder = ImapFeeder.new(@server, store, config)
+    imapfeeder.run
+    @server.disconnect
+  end
 
   File.delete $running_instance
 

data/config/hoe.rb

@@ -2,7 +2,7 @@ require 'imap-feeder/version'
 
 AUTHOR = 'Mirko Stocker'  # can also be an array of Authors
 EMAIL = "me@misto.ch"
-DESCRIPTION = "Imap-feeder pushes your RSS and Atom feeds to an IMAP server."
+DESCRIPTION = "Imap-feeder pushes entries from RSS and Atom feeds to an IMAP server."
 GEM_NAME = 'imap-feeder' # what ppl will type to install your gem
 RUBYFORGE_PROJECT = 'imap-feeder' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"

data/lib/imap-feeder/createconfigparser.rb

@@ -11,8 +11,8 @@ Usage: #{$0} [options] to create or check your configuration
 or     #{$0} SETTINGS_FILE to run the script
 EOF
 
-      opts.on("-c", "--check-settings SETTINGS_FILE",
-              "Check an existing configuration") do |file|
+      opts.on("-c", "--check-settings FEEDS_FILE",
+              "Check a feed file") do |file|
         options.check = file
       end
 

data/lib/imap-feeder/message.rb

@@ -28,10 +28,18 @@ class Message
     @body ||= strip_html(@params[:body] || @params[:url] || "")
   end
 
+  def html_body
+    dec(@params[:body])
+  end
+
   def time
     @time ||= (@params[:time] || Time.now.localtime).rfc2822
   end
 
+  def url
+    @url ||= @params[:url]
+  end
+
   def quote(str)
     return "" if not str
     str.gsub(/[^a-zA-Z0-9 -_:,\.]+/) {|to_quote| quote_if_necessary(to_quote, "UTF-8")}
@@ -42,21 +50,28 @@ class Message
   end
 
   def format
-    url   = @params[:url]
+    construct_message "plain", "#{body}" + (url ? "\n\n#{url}" : "")
+  end
+
+  def as_html
+    construct_message "html", "#{html_body}" + (url ? "<br/><br/><a href='#{url}'>#{url}</a>" : "")
+  end
+
+  private
+
+  def construct_message(type, body)
     return <<-EOF
 Date: #{time}
 Subject: #{quote(title)}
 From: #{quote(from)}
-Content-Type: text/plain;
+Content-Type: text/#{type};
   charset="utf-8"
 Content-Transfer-Encoding: 8bit
 
-#{body}#{"\n\n" + url if url}
+#{body}
 EOF
   end
 
-  private
-
   def replace(doc, element)
     doc.search(element) do |found|
       replacement = block_given? ? yield(found) : found.innerHTML

data/lib/imap-feeder/messagestore.rb

@@ -19,7 +19,7 @@ class MessageStore
   def add_new(folder, titles, number_of_entries = MESSAGES_TO_STORE)
     @root[folder] ||= []
     @root[folder].unshift(*titles)
-    @root[folder].slice!((number_of_entries * 2)..-1)
+    @root[folder].slice!((number_of_entries * 10)..-1)
     @root[folder].compact!
   end
 

data/lib/imap-feeder/server.rb

@@ -9,6 +9,7 @@ class Server
   def initialize(params)
     @connection = Net::IMAP.new(params[:host], params[:port], params[:use_ssl])
     result = @connection.login(params[:user], params[:pass])
+    @format = params[:format]
   end
 
   def disconnect
@@ -17,7 +18,14 @@ class Server
 
   def send(message, folder="INBOX")
     @connection.select(folder)
-    message = message.format.gsub(/\n/, "\r\n")
+
+    if @format == :html
+      message = message.as_html
+    else
+      message = message.format
+    end
+
+    message.gsub!(/\n/, "\r\n")
     @connection.append(folder, message, nil, Time.now)
   end
 

data/lib/imap-feeder/version.rb

@@ -1,7 +1,7 @@
 class ImapFeeder #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/settings.rb.example

@@ -17,6 +17,11 @@ BASEDIR="#{ENV['HOME']}/.imap-feeder"
 $tidy_path = "/usr/lib/libtidy.so"
 
 
+# Controls if the entries are sent as html or plain-text
+# Values are:
+#   :html
+#   :plain
+$format = :html
 
 # imap-feeder needs a file to store the last message for each feed
 # so it doesn't fetch old entries. Where should that file be?

data/test/test_message.rb

@@ -118,6 +118,39 @@ EOF
   end
 end
 
+class HtmlMessageTest < Test::Unit::TestCase
+
+  def test_bold_text
+    t = Time.parse("Mon, Mar 05 2007 15:26:16 +0100")
+    m = Message.new(:title => "something bold", :body => "<strong>body</strong>second", :time => t)
+    assert_equal(<<-EOF, m.as_html)
+Date: Mon, 05 Mar 2007 15:26:16 +0100
+Subject: something bold
+From: Unknown <spam@example.org>
+Content-Type: text/html;
+  charset="utf-8"
+Content-Transfer-Encoding: 8bit
+
+<strong>body</strong>second
+    EOF
+  end
+
+  def test_url
+    t = Time.parse("Mon, Mar 05 2007 15:26:16 +0100")
+    m = Message.new(:title => "with url", :body => "body", :time => t, :url => "http://url")
+    assert_equal(<<-EOF, m.as_html)
+Date: Mon, 05 Mar 2007 15:26:16 +0100
+Subject: with url
+From: Unknown <spam@example.org>
+Content-Type: text/html;
+  charset="utf-8"
+Content-Transfer-Encoding: 8bit
+
+body<br/><br/><a href='http://url'>http://url</a>
+    EOF
+  end
+
+end
 
 class MessageFormatterTest < Test::Unit::TestCase
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: imap-feeder
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Mirko Stocker
@@ -29,11 +29,12 @@ cert_chain:
   uqXC6cgFmydQfHaHeH24NZ6LBcoaacZYI/xsdm+9S18u2P+G/LAGOg==
   -----END CERTIFICATE-----
 
-date: 2008-06-09 00:00:00 +02:00
+date: 2008-07-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -43,6 +44,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -52,6 +54,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: htmlentities
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -61,6 +64,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: tidy
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -70,6 +74,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: simple-rss
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -77,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.1"
     version: 
-description: Imap-feeder pushes your RSS and Atom feeds to an IMAP server.
+description: Imap-feeder pushes entries from RSS and Atom feeds to an IMAP server.
 email: 
 - me@misto.ch
 executables: 
@@ -162,10 +167,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: imap-feeder
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Imap-feeder pushes your RSS and Atom feeds to an IMAP server.
+summary: Imap-feeder pushes entries from RSS and Atom feeds to an IMAP server.
 test_files: 
 - test/test_imapfeederconfig.rb
 - test/test_opmlreader.rb