twmail 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f272ba50aeca1889982465e087e6c0a93d339a6
-  data.tar.gz: 9f9d78c93ae97f5cb17656c5d2e90f60672d72ac
+  metadata.gz: 9f8387ff67c2e8b5ee9b4061dfa36dddddd26e9b
+  data.tar.gz: 886975f525e024cba8d9d8ec86a55eec4880c70b
 SHA512:
-  metadata.gz: 57bfec02d7f362c097b6d3c35d8214b8dcacd40ec2416d5b659b122c3ad495af5e709a1995abb9265b189aad46c683835a626583918dedaea15b1d17eedaa353
-  data.tar.gz: 75567e5613f8f112abbf11a9b97030fec4af4db5941e5b7a47cea691f857eaab0811afc61667ec4297e5c69c89603919dc47e377713df8780c94bdc28dd3fdd5
+  metadata.gz: d7236e1a61c4addf575f3625a3195a16fefd2fdbe24baa66d341613fc00d46e52c8a119aea257e1a9a37bd8800174f258debf72eb1c48da14e828298bbdcb849
+  data.tar.gz: 507d2712dc34bdbe418f61b8eeb4d0d69bb28feb75ed05dfe2453add66710b5fac60f652d9d5ffb94984d18fa25f7553beb24ecf353b6ef6463c3d9e1703eb56

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CONTRIBUTING.markdown

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Gemfile

@@ -1,7 +1,8 @@
 source 'https://rubygems.org'
 
 # use local twtest while developing
-# gem "twtest", :path => "../twtest"
+group :development do
+  gem "twtest", :path => "../twtest"
+end
 
-# Specify your gem's dependencies in twmail.gemspec
 gemspec

data/README.md

@@ -13,6 +13,7 @@
 1. Edit `~/.fetchmailrc` and adjust mail account settings (the example was made for Google Mail account). If in doubt, consult the `fetchmail` documentation, e.g. by executing `man fetchmailconf` in a terminal.
 
 ## Motivation
+
 I would like to add new tasks to my TaskWarrior inbox from remote places where I don't have immediate access to my personal TaskWarrior database; e.g. from my iPhone, from work (where I don't have access to my personal TaskWarrior installation) or from another computer.
 
 Using eMail for this looks like a great candidate:
@@ -24,6 +25,7 @@ Using eMail for this looks like a great candidate:
 What is missing from a TaskWarrior perspective right now is a way to add these mails to a TaskWarrior installation automatically.
 
 ## Architecture
+
 The simplest solution I could come up with is this:
 
 1. A dedicated email account is used to collect the tasks.
@@ -43,25 +45,24 @@ As a prerequisite, TaskWarrior is assumed to be installed and configured. With t
 
 The solution presented here maintains a one-to-one relation between the INBOX of an mail account and the TaskWarrior database.
 
-TODO Describe how to use fetchmail's daemon mode
-
-TODO Describe how to use fetchmail's IMAP IDLE flag
-
 ## Components
+
 Mail fetching is done with `fetchmail`, a proven solution available on all major Unices incl. MacOS. It will be configured to use the `twmail` script as a mail delivery agent (mda), which means nothing more than that `fetchmail` fetches the mail from the configured account and hands it over to our script. There is no further storage of the received mails except in TaskWarrior.
 
 ## Error Handling
-If our MDA returns non-zero, `fetchmail` will not assume the message to be processed and it will try again.
 
-TODO Do we need a dedicated dead-letter queue for all mails fetched, but not successfully processed?
+If our MDA returns non-zero, `fetchmail` will not assume the message to be processed and it will try again.
 
 ## Alternatives
+
 One might think of more elaborate applications that do more clever things, but I wanted to create this solution with as few external dependencies as possible. `fetchmail` is available on all Unices, and who can afford to live without TaskWarrior anyway? I also played with the thought of a central tasks server that receives mail from services like CloudMailIn and auto-adds them to the server, but the result would not be much different (besides being more complex) to the solution presented here: No task will be fetched into TaskWarrior until the machine with the TaskWarrior database is online.
 
 Another alternative would be to convert the email to JSON and use TaskWarrior's import command. This would allow to create and annotate a new task in one step without the `bin/task-uuid` workaround.
 
 ## Advanced Usage
+
 ### Filtering and Routing
+
 Many more advanced use cases like filtering and routing can be implemented on the mail server side. There are plenty of user interfaces for routing eMails based on their subject, sender, body text, etc. The simplest way to integrate these features with `twmail` is to use IMAP folders. After all filtering and routing, each eMail must end up in a dedicated IMAP folder (by default, all tasks are fetched from the INBOX folder). `twmail` can then be configured to do different things depending on which IMAP folder a mail came from.
 
 As an example, here is a simple way to route eMails to different projects in TaskWarrior, based on their subject line:
@@ -73,11 +74,10 @@ As an example, here is a simple way to route eMails to different projects in Tas
   1. "Get Rich Fast" folder if the mail subject contains "project:GetRichFast"
 1. Tell `twmail` to fetch mails from the "Build Bikeshed", "Reading List", and "Get Rich Fast" IMAP folders (in addition to the INBOX):
 
-TODO Continue description ... may need tracepolls for it.
-
 The approach chosen for `twmail` also addresses SPAM filtering. Handling that remains the responsibility of the mail server. Anything that makes it to the INBOX is treated as task.
 
 ### 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-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:
@@ -96,6 +96,7 @@ If you prefer a hook with a different name, specify it in the `TWMAIL_HOOK` envi
     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.
 
 There are two ways to achieve this:
@@ -106,12 +107,5 @@ There are two ways to achieve this:
 Which option to choose depends on the capabilities of your mail server (Google Mail cannot handle mails based on their read status), and on your level of trust in `twmail`. I recommend leaving mails on the server until you are confident that everything works as expected.
 
 ## Testing
-`twmail` comes with a basic set of tests. Execute them by running `rake` in the cloned source repo.
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+`twmail` comes with a basic set of tests. Execute them by running `rake` in the cloned source repo.

data/TODO.markdown

@@ -0,0 +1,4 @@
+* Describe how to use fetchmail's daemon mode
+* Describe how to use fetchmail's IMAP IDLE flag
+* Do we need a dedicated dead-letter queue for all mails fetched, but not successfully processed?
+* Consider the [gmail gem](https://github.com/gmailgem/gmail) instead of fetchmail

data/bin/task-uuid

@@ -17,22 +17,22 @@ OptionParser.new do |opts|
 
   5. Print the UUID to STDOUT
 HERE
-  opts.banner = banner#.wrap
+  opts.banner = banner
   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.
-tag = "T#{SecureRandom.hex}"
+tag = 'tag_' + SecureRandom.hex.tr('-', '')
 
 # 2. Create the new task tagged with our temporary tag
 %x|task rc.verbose=nothing add +#{tag} #{ARGV.join(' ')}|
 
 # 3. Remember the UUID generated by TaskWarrior
-task_uuid = %x|task "+#{tag}" uuid|
+task_uuid = %x|task rc.verbose=nothing +#{tag} _uuid|.chomp
 
 # 4. Remove the temporary tag from the new task
-%x|task rc.verbose=nothing '#{task_uuid}' modify -#{tag}|
+%x|task rc.verbose=nothing #{task_uuid} modify -#{tag.to_s}|
 
 # 5. Print the UUID to STDOUT
 puts task_uuid

data/bin/twmail

@@ -21,7 +21,6 @@ end.parse!
 
 mail = Mail.new(ARGF.read)
 task_uuid = %x[task-uuid \"#{mail.subject}\"]
-
 body = mail.text? ? mail.body.decoded : mail.text_part.body.decoded
 
 SEPARATOR = '-- '

data/lib/twmail/version.rb

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

data/test/unit/test_task_uuid.rb

@@ -1,3 +1,4 @@
+require 'shellwords'
 require 'open3'
 require 'test/unit'
 
@@ -54,7 +55,7 @@ class TaskWarriorCommand < Command
   end
 
   def default_args
-    {'rc.verbose' => 'off', 'rc.json.array' => 'on'}
+    {'rc.verbose' => 'nothing', 'rc.json.array' => 'on'}
   end
 
   def executable
@@ -80,13 +81,12 @@ class TaskUUID < TaskWarriorCommand
   end
 end
 
-class TestTaskUUID < Test::Unit::TestCase#Minitest::Test
+class TestTaskUUID < Test::Unit::TestCase
   def setup
     @tw = TaskWarriorCommand.new
     @tw.data_dir = Dir.mktmpdir(name)
 
     raise "TASKRC must not be set, but it is #{ENV['TASKRC']}" if ENV['TASKRC']
-
   end
 
   def teardown
@@ -98,7 +98,7 @@ class TestTaskUUID < Test::Unit::TestCase#Minitest::Test
     assert(status.success?)
     assert_empty(err)
     assert_not_empty(out)
-    assert_equal('2.3.0', out.chomp)
+    assert_match(/\d\.\d\.\d/, out.chomp)
   end
 
   def test_empty
@@ -112,7 +112,7 @@ class TestTaskUUID < Test::Unit::TestCase#Minitest::Test
   def test_task_uuid
     task_uuid = TaskUUID.new
     task_uuid.data_dir = Dir.mktmpdir(name)
-    out, err, status = task_uuid.create('foo bar')
+    out, err, _ = task_uuid.create('foo bar')
     assert_empty(err)
     assert_not_empty(out)
     assert_match(/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/, out.chomp)

data/twmail.gemspec

@@ -15,11 +15,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = TaskWarriorMail::VERSION
 
-  gem.add_dependency 'twtest'
   gem.add_dependency 'mail'
-  gem.add_dependency 'multi_json'
 
+  gem.add_development_dependency 'twtest', '> 0.0.6'
   gem.add_development_dependency 'guard-test'
   gem.add_development_dependency 'guard-bundler'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: twmail
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Nicholas E. Rabenau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2017-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: twtest
+  name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,27 +25,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mail
+  name: twtest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 0.0.6
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: guard-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-test
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -105,11 +105,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
+- CONTRIBUTING.markdown
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- TODO.markdown
 - bin/task-uuid
 - bin/twmail
 - bin/twmail-hook
@@ -151,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Use fetchmail and the scripts in this project to mail tasks to your local