podgraph 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Alexander Gromnitsky.
+
+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,95 @@
+-*- text -*-
+= Name
+
+podgraph -- Create an email from a XHTML and inline images and send it
+to posterous.com.
+
+= Synopsis
+
+podgraph [-Sv] [-m ARG] file.html
+
+= Description
+
+It's a simple program that reads a XHTML file, extracts subject and body
+from the file, constructs an email and delivers it.
+
+The options are as follows:
+
+ -v           Be more verbose.
+ -S           Don't send, just dump the mail to stdout.
+ -m ARG       1 of modes: Podgraph::["related", "mixed"].
+
+The file is supposed to be a XHTML result from python's docutils
+reStructuredText. The idea is:
+
+1. You're writing a post (for example, for posterous.com) in
+   reStructuredText in Emacs.
+
+2. You're converting it with help of docutils to the XHTML.
+
+3. Finally, you're creating a proper MIME mail from raw XHTML and
+   sending it to posterous.com.
+
+Step 3 is what podgraph does.
+
+== Features
+
+* Creates mails with inline images if it can found links in the XHTML
+  file to local images.
+
+* Charset of 'text/html' portion of a mail is always UTF-8.
+
+= Exit status
+
+Program exits 0 on success (something was generated or even delivered),
+or >= 1 if en error occurs.
+
+= Examples
+
+Create a config.yaml file in the directory with your writing. For
+example:
+
+ % cd ~/lib/writing/posterous
+ % cat config.yaml
+ :to: post@posterous.com
+ :from: me@example.org
+
+Start writing a .rest file:
+
+ % emacsclient 0001.rest &
+
+[...]
+
+To give podgraph a chance to find a subject for the mail, write .rest
+file as:
+
+ This is a subject
+ *****************
+
+ My usual reStructuredText.
+
+Or in another words, the first 2 tags in the body of the the XHTML must
+be:
+
+  <div><h1>My subject</h1> [...]
+
+Convert it to XHTML:
+
+ % rst2html < 0001.rest > 0001.html
+
+Send to posterous.com:
+
+ % podgraph 0001.html
+
+Also, you can preview the mail without sending it:
+
+ % podgraph -S 0001.html
+
+If you have links to local images in your .rest file (and
+correspondingly in .html) then podgraph will include images in the mail as
+inline images. But if you don't want this and want images to become a
+typical gallery on posterous.com, run:
+
+ % podgraph -m mixed 0001.html
+
+This will generate the mail with usual boring attachments.

data/Rakefile

@@ -0,0 +1,38 @@
+# -*- ruby -*-
+
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new do |s|
+  s.name = "podgraph"
+  s.summary = 'Creates a MIME mail from a XHTML source and delivers it to Posterous.com.'
+  s.version = '0.0.1'
+  s.author = 'Alexander Gromnitsky'
+  s.email = 'alexander.gromnitsky@gmail.com'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9'
+  s.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+  s.executables = ['podgraph']
+  s.has_rdoc = true
+  s.test_files = FileList['test/ts_*.rb'].to_a
+  s.rdoc_options << '-m' << 'Podgraph'
+end
+spec.add_dependency('mail', '>= 2.1.3')
+
+Rake::GemPackageTask.new(spec).define
+
+task :default => %(repackage)
+
+Rake::RDocTask.new('doc') do |rd|
+  rd.main = "Podgraph"
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.include("lib/**/*.rb")
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/ts_*.rb']
+  t.verbose = true
+end

data/TODO

@@ -0,0 +1,12 @@
+-*- text -*-
+
+0.0.2
+
+- read input from stdin
+- CL options for email
+
+0.0.1
+
++ rewrite README.rdoc to make it look more like a manpage
++ add simple tests
++ check for hostname

data/bin/podgraph

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby19
+# -*- ruby -*-
+
+# Copyright (c) 2010 Alexander Gromnitsky <mailto:alexander.gromnitsky@gmail.com>.
+#
+# $Id: podgraph 102 2010-03-10 18:41:28Z alex $
+
+require_relative '../lib/podgraph/posterous'
+
+$conf = {
+  prog_ver: '0.0.1',
+  send?: true,
+  config: 'config.yaml',
+  modes: %w(related mixed),
+  mode: 'related',
+  to: nil,
+  from: nil
+}
+
+def config_load()
+  begin
+    myconf = YAML.load_file($conf[:config])
+  rescue
+    abort("cannot parse #{$conf[:config]} in the current directory")
+  end
+  %w(to from).each { |i|
+    abort("missing #{i} in #{$conf[:config]}") if ! myconf.key?(i.to_sym)
+  }
+  $conf.merge!(myconf)
+end
+
+def cl_parse(myargs)
+  o = OptionParser.new()
+  o.banner = "#{File.basename($PROGRAM_NAME)} #{$conf[:prog_ver]}.
+Create an email from a XHTML and inline images and send it to posterous.com.
+http://podgraph.posterous.com/
+
+Usage: #{File.basename($PROGRAM_NAME)} [options] file.html"
+  o.separator ""
+  o.on('-v', 'Be more verbose.') { |v| Podgraph::cfg[:verbose] += 1 }
+  o.on('-S', "Don't send, just dump the mail to stdout.") { |v| $conf[:send?] = false }
+  o.on('-m ARG', "1 of modes: Podgraph::#{$conf[:modes]}.",
+       $conf[:modes]) { |v| $conf[:mode] = v }
+
+  begin
+    o.parse!(myargs)
+  rescue
+    abort("cl parse error: #{$!}")
+  end
+end
+
+# --[ main ]------------------------------------------------------------
+
+config_load()
+
+cl_parse ARGV
+Podgraph::veputs(1, "CL options: #{ARGV}")
+unless ARGV.size >= 1
+  abort("Usage: #{File.basename($PROGRAM_NAME)} [options] filename.html
+Type \"#{File.basename($PROGRAM_NAME)} -h\" for the help.")
+end
+
+Podgraph::veputs(2, "cfg #{Podgraph::cfg}")
+begin
+  p = Podgraph::Posterous.new(ARGV[0], $conf[:to], $conf[:from], $conf[:mode])
+  Podgraph::veputs(2, "o: #{p.o}".to_s.encode('koi8-u'))
+  mail = p.generate()
+rescue
+  abort("HTML parsing failed: #{$!}")
+end
+
+if ! $conf[:send?]
+  puts mail.to_s()
+  exit 0
+end
+
+begin
+  mail.delivery_method :sendmail
+  mail.deliver
+rescue
+  abort("cannot send mail: #{$!}")
+end

data/lib/podgraph/posterous.rb

@@ -0,0 +1,168 @@
+# $Id: posterous.rb 104 2010-03-10 18:46:53Z alex $
+
+require 'mail'
+require 'rexml/document'
+require 'yaml'
+require 'optparse'
+
+# :include: ../../README.rdoc
+module Podgraph
+
+  mattr_accessor :cfg
+  
+  self.cfg = Hash.new()
+  cfg[:verbose] = 0
+
+  def self.veputs(level, s)
+    puts(s) if cfg[:verbose] >= level
+  end
+
+  # Reads XHTML file, analyses it, finds images, checks if they can be inlined,
+  # generates multipart/relative or multipart/mixed MIME mail.
+  class Posterous
+
+    # some options for mail generator; change with care
+    attr_accessor :o
+
+    # Analyses _filename_. It must be a XHTML file.
+    # _to_, _from_ are email.
+    # _mode_ is 1 of 'related' or 'mixed' string.
+    def initialize(filename, to, from, mode)
+      @o = Hash.new()
+      @o[:lib_ver] = '0.0.1'
+      @o[:user_agent] = 'podgraph/' + @o[:lib_ver]
+      @o[:subject] = ''
+      @o[:body] = []
+      @o[:attachment] = []
+      @o[:a_marks] = {}
+      @o[:mode] = mode
+      @o[:to] = to
+      @o[:from] = from
+
+      fp = File.new(filename)
+      begin
+        make(fp)
+      rescue
+        raise $!
+      ensure
+        fp.close()
+      end
+    end
+
+    def make(fp)
+      xml = REXML::Document.new(fp)
+      begin
+        @o[:subject].replace(REXML::XPath.first(xml, "/html/body/div/h1").text.gsub(/\s+/, " "))
+        raise if @o[:subject] =~ /^\s*$/
+      rescue
+        raise 'cannot extract the subject from <h1>'
+      end
+
+      img_collect = ->(i, a) {
+        if i.name == 'img'
+          if (src = i.attributes['src']) =~ /^\s*$/
+            raise '<img> tag with missing or empty src attribute'
+          elsif src =~ /\s*(http|ftp):\/\//
+            # we are ignoring URL's
+            return
+          else
+            a << src
+            if @o[:mode] == 'related'
+              # replace src attribute with a random chars--later
+              # we'll replace such marks with corrent content-id
+              random = Mail.random_tag()
+              i.attributes['src'] = random
+              @o[:a_marks][src] = random   # save an act of the replacement
+              
+              @o.rehash()                  # does is this really necessary?
+            end
+          end
+        end
+      }
+      
+      f = 1
+      xml.elements.each('/html/body/div/*') { |i|
+        if f == 1
+          f = 0                     # skip first <h1>
+          next
+        end
+
+        Podgraph::veputs(2, "node: #{i.name}")
+        img_collect.call(i, @o[:attachment])
+        i.each_recursive { |j|
+          Podgraph::veputs(2, "node recursive: #{j.name}")
+          img_collect.call(j, @o[:attachment])
+        }
+        
+        @o[:body] << i
+      }
+
+      raise "body is empty or filled with nonsence" if @o[:body].size == 0
+    end
+    private :make
+
+    # Returns ready for delivery Mail object.
+    def generate()
+      m = Mail.new()
+      m.from(@o[:from])
+      m.to(@o[:to])
+      m.content_transfer_encoding('8bit')
+      m.subject(@o[:subject])
+      m.headers({'User-Agent' => @o[:user_agent]})
+
+      Podgraph::veputs(2, "Body lines=#{@o[:body].size}, bytes=#{@o[:body].to_s.bytesize}")
+      if @o[:attachment].size == 0
+        m.content_disposition('inline')
+        m.content_type('text/html; charset="UTF-8"')
+        m.body(@o[:body])
+      else
+        if @o[:mode] == 'related'
+          m.content_type('Multipart/Related')
+        end
+        m.html_part = Mail::Part.new {
+          content_transfer_encoding('8bit')
+          content_type('text/html; charset=UTF-8')
+        }
+        m.html_part.body = @o[:body]
+        m.html_part.content_disposition('inline') if @o[:mode] == 'mixed'
+        
+        begin
+          @o[:attachment].each { |i| m.add_file(i) }
+        rescue
+          raise("cannot attach: #{$!}")
+        end
+
+        if @o[:mode] == 'related'
+          if (fqdn = Socket.gethostname() ) == ''
+            raise 'hostname is not set!'
+          end
+          cid = {}
+          m.parts[1..-1].each { |i|
+            i.content_disposition('inline')
+            cid[i.filename] = i.content_id("<#{Mail.random_tag}@#{fqdn}.NO_mail>")
+          }
+
+          @o[:a_marks].each { |k, v|
+            if cid.key?(k)
+              Podgraph::veputs(2, "mark #{k} = #{v}; -> to #{cid[k]}")
+              # replace marks with corresponding content-id
+              m.html_part.body.raw_source.sub!(v, "cid:#{cid[k][1..-1]}")
+            else
+              raise("orphan key in cid: #{k}")
+            end
+          }
+        end
+      end # a.size
+      
+      return m
+    end
+  
+    # Print Mail object to stdout.
+    # _e_ is an optional encoding.
+    def dump(e = '')
+      puts (e == '' ? generate().to_s : generate().to_s.encode(e))
+    end
+    
+  end # Posterous
+  
+end # Podgraph

data/test/config.yaml

@@ -0,0 +1,3 @@
+:to: alex@goliard
+# :to: post@podgraph-test.posterous.com
+:from: alexander.gromnitsky@gmail.com

data/test/garbage_01.html

@@ -0,0 +1 @@
+fukuyama

data/test/garbage_02.html

@@ -0,0 +1 @@
+<html><lolipop>1</lolipop>

data/test/garbage_03.html

@@ -0,0 +1,8 @@
+<html>
+<body>
+<div>
+<h1>Really, dude</h1>
+This doesn't work.
+</div>
+</body>
+</html>

data/test/garbage_04.html

@@ -0,0 +1,9 @@
+<html>
+<body>
+<div>
+<h1>zzz</h1>
+<p>Missing <img src='yobo'/> inline image.</p>
+(hidden text)
+</div>
+</body>
+</html>