twmail 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 182039b12dd834cc9fc05937002ef6072cd0c4c9
-  data.tar.gz: eba7257ed83db3960f98ef42821372d278ae1cc7
+  metadata.gz: 8f272ba50aeca1889982465e087e6c0a93d339a6
+  data.tar.gz: 9f9d78c93ae97f5cb17656c5d2e90f60672d72ac
 SHA512:
-  metadata.gz: 71199bf9f6e4759f6b236d7da0a48666510f9eefd3a5e391a327249cb1d4166dc511a29dcccdd5e0569d509ade886adfcdf19cf868421114126bf9dae5d9b8d1
-  data.tar.gz: 327ff6c55daaa660f7364cf6c609e17ff5a84208ada8a938dde7870ec27bd726bb68d4524d3f85fb8014c4d40a644638b9e7558f0e6b7bffebc5eb5240ddb140
+  metadata.gz: 57bfec02d7f362c097b6d3c35d8214b8dcacd40ec2416d5b659b122c3ad495af5e709a1995abb9265b189aad46c683835a626583918dedaea15b1d17eedaa353
+  data.tar.gz: 75567e5613f8f112abbf11a9b97030fec4af4db5941e5b7a47cea691f857eaab0811afc61667ec4297e5c69c89603919dc47e377713df8780c94bdc28dd3fdd5

data/.gitignore

@@ -7,7 +7,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc
@@ -15,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.cache_rake_t

data/README.md

@@ -80,7 +80,7 @@ The approach chosen for `twmail` also addresses SPAM filtering. Handling that re
 ### Hooks
 `twmail` comes with an advanced implementation that supports hooks. This makes handling incoming mail very simple for someone familiar with shell scripting, and there is no need to edit the `twmail` scripts in order to customize its behavior.
 
-When `fetchmail` is configured to use `twmail_hooks` instead of `twmail`, the script will call the `twmail_hook` command (must be in the user's `$PATH`). Within the hook script, the fields of the parsed email are available as environment variables:
+When `fetchmail` is configured to use `twmail-hook` instead of `twmail`, the script will call the `twmail-hook` command (must be in the user's `$PATH`). Within the hook script, the fields of the parsed email are available as environment variables:
 
     TWMAIL_DATE
     TWMAIL_MESSAGE_ID
@@ -93,7 +93,7 @@ Have a look at test/helpers/test_hook for a very simple implementation.
 
 If you prefer a hook with a different name, specify it in the `TWMAIL_HOOK` environment variable in your `.fetchmailrc`. For example, if your home directory contains a script called `taskwarrior-import.sh`, edit the `mda` line to look like this:
 
-    mda TWMAIL_HOOK=~/taskwarrior-import.sh twmail_hooks
+    mda TWMAIL_HOOK=~/taskwarrior-import.sh twmail-hook
 
 ## Housekeeping
 By default `fetchmail` will mark retrieved messages as read, but leave them on the server. For housekeeping purposes, it may be desirable to delete messages from the server once they were successfully imported into TaskWarrior.

data/bin/task-uuid

@@ -1,9 +1,25 @@
 #!/usr/bin/env ruby
 require 'securerandom'
+require 'optparse'
+require 'twmail'
 
-#
-# Creates a new task using TaskWarrior and prints its UUID to STDOUT.
-#
+OptionParser.new do |opts|
+  banner = <<-HERE
+#{opts.program_name} creates a new TaskWarrior task and prints its UUID to STDOUT using the following approach:
+
+  1. Make up a temporary tag name that is very unlikely to exist yet.
+
+  2. Create the new task tagged with our temporary tag
+
+  3. Use the name of our temporary tag to find the actual UUID generated by TaskWarrior
+
+  4. Remove the temporary tag from the new task
+
+  5. Print the UUID to STDOUT
+HERE
+  opts.banner = banner#.wrap
+  opts.version = TaskWarriorMail::VERSION
+end.parse!
 
 # 1. Make a temporary tag that unlikely to exist yet.
 # To avoid shell troubles, we have it start with a character.

data/bin/twmail

@@ -1,9 +1,24 @@
 #!/usr/bin/env ruby
 
 require 'mail'
+require 'optparse'
+require 'twmail'
+
+OptionParser.new do |opts|
+  banner = <<-HERE
+#{opts.program_name} is a simple Mail Delivery Agent (MDA) that parses received mail and creates a new TaskWarrior task from the subject of the mail.
+
+USAGE
+
+Configure fetchmail to use #{opts.program_name} as MDA:
+
+    # ~/.fetchmailrc
+    mda #{opts.program_name}
+HERE
+  opts.banner = banner#.wrap
+  opts.version = TaskWarriorMail::VERSION
+end.parse!
 
-# This script is a dead-simple Mail Delivery Agent (MDA) that parses the received email
-# and creates a new TaskWarrior task from the subject of the mail.
 mail = Mail.new(ARGF.read)
 task_uuid = %x[task-uuid \"#{mail.subject}\"]
 

data/bin/twmail-hook

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'mail'
+require 'optparse'
+require 'twmail'
+
+OptionParser.new do |opts|
+  banner = <<-HERE
+#{opts.program_name} is a simple Mail Delivery Agent (MDA) that that exports the parts of the received email as environment variables and calls a shell script that can make use of these variables to further process the mail.
+
+USAGE
+
+  Configure fetchmail to use #{opts.program_name} as MDA:
+
+    # ~/.fetchmailrc
+    mda #{opts.program_name}
+
+HERE
+  opts.banner = banner#.wrap
+  opts.version = TaskWarriorMail::VERSION
+end.parse!
+
+mail = Mail.new(ARGF.read)
+
+# Expose mail properties as environment variables
+%w[date message_id from to subject body].each{|field|
+  value = mail.send(field.to_sym)
+  value = value.join(',') if value.respond_to?(:join)
+  ENV["TWMAIL_#{field.upcase}"] = Shellwords.escape(value.to_s)
+}
+
+# The hook to be executed is read from the environment variable TWMAIL_HOOK
+# If none is set, this script will assume that twmail_on_new_mail is in the
+# $PATH and executable.
+cmd = ENV.fetch("TWMAIL_HOOK", 'twmail-hook')
+
+# Call hook script
+%x[#{cmd}]

data/doc/fetchmailrc.sample

@@ -0,0 +1,4 @@
+poll "imap.gmail.com" proto imap port 993
+user "tasks@example.com" password "passw0rd"
+ssl
+mda twmail

data/lib/extensions/string.rb

@@ -0,0 +1,6 @@
+class String
+  # http://www.java2s.com/Code/Ruby/String/WordwrappingLinesofText.htm
+  def wrap(width = 78)
+    gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
+  end
+end

data/lib/twmail/version.rb

@@ -1,3 +1,3 @@
 module TaskWarriorMail
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/twmail.rb

@@ -1,6 +1,5 @@
-require 'mail'
-
-require "twmail/version"
+require 'twmail/version'
+require 'extensions/string'
 
 module TaskWarriorMail
   # Your code goes here...

data/test/unit/test_twmail_hooks

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 #
-# Unit test for twmail_hooks
+# Unit test for twmail-hook
 #
 
 # Data locations
@@ -19,10 +19,10 @@ verbose=off
 HERE
 
 # Canonical path to test_hook
-export TWMAIL_HOOK=$DIRNAME/../helpers/test_hook
+export twmail-hook=$DIRNAME/../helpers/test_hook
 
 # Create new task using mail fixture
-cat $DIRNAME/../fixtures/mail01.txt | $DIRNAME/../../bin/twmail_hooks
+cat $DIRNAME/../fixtures/mail01.txt | $DIRNAME/../../bin/twmail-hook
 
 # Read back and run assertions
 SUBJECT=$(task export | ruby -r json -e "puts JSON[ARGF.read].first['description']")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twmail
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nicholas E. Rabenau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-15 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twtest
@@ -100,7 +100,7 @@ email:
 executables:
 - task-uuid
 - twmail
-- twmail_hooks
+- twmail-hook
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,7 +112,9 @@ files:
 - Rakefile
 - bin/task-uuid
 - bin/twmail
-- bin/twmail_hooks
+- bin/twmail-hook
+- doc/fetchmailrc.sample
+- lib/extensions/string.rb
 - lib/twmail.rb
 - lib/twmail/version.rb
 - test/fixtures/mail_empty.txt

data/bin/twmail_hooks

@@ -1,22 +0,0 @@
-#!/usr/bin/env ruby
-require 'mail'
-
-# This script is a dead-simple Mail Delivery Agent (MDA) that exports the parts of the received email as
-# environment variables and calls a shell script that can make use of these variables to further process
-# the mail.
-mail = Mail.new(ARGF.read)
-
-# Expose mail properties as environment variables
-%w[date message_id from to subject body].each{|field|
-  value = mail.send(field.to_sym)
-  value = value.join(',') if value.respond_to?(:join)
-  ENV["TWMAIL_#{field.upcase}"] = Shellwords.escape(value.to_s)
-}
-
-# The hook to be executed is read from the environment variable TWMAIL_HOOK
-# If none is set, this script will assume that twmail_on_new_mail is in the
-# $PATH and executable.
-cmd = ENV["TWMAIL_HOOK"] || 'twmail_hook'
-
-# Call hook script
-%x[#{cmd}]