toodledo 1.0.0

data/CHANGELOG

@@ -0,0 +1 @@
+1.0.0 - initial release

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2008-02-10
+
+* First version released!
+

data/Manifest.txt

@@ -0,0 +1,30 @@
+CHANGELOG
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/toodledo
+lib/toodledo.rb
+lib/toodledo/command_line/add_command.rb
+lib/toodledo/command_line/base_command.rb
+lib/toodledo/command_line/client.rb
+lib/toodledo/command_line/complete_command.rb
+lib/toodledo/command_line/delete_command.rb
+lib/toodledo/command_line/edit_command.rb
+lib/toodledo/command_line/hotlist_command.rb
+lib/toodledo/command_line/list_command.rb
+lib/toodledo/command_line/main_command.rb
+lib/toodledo/command_line/parser_helper.rb
+lib/toodledo/command_line/setup_command.rb
+lib/toodledo/context.rb
+lib/toodledo/folder.rb
+lib/toodledo/goal.rb
+lib/toodledo/item_not_found_error.rb
+lib/toodledo/priority.rb
+lib/toodledo/repeat.rb
+lib/toodledo/server_error.rb
+lib/toodledo/session.rb
+lib/toodledo/task.rb
+test/parser_helper_test.rb
+test/session_test.rb
+test/toodledo_functional_test.rb

data/README.txt

@@ -0,0 +1,272 @@
+= toodledo
+
+* http://toodledo.rubyforge.org
+* mailto:will@tersesystems.com
+
+== DESCRIPTION:
+
+This is a Ruby API and client for http://toodledo.com, a task management 
+website. It implements all of the calls from Toodledo's developer API, and 
+provides a nice wrapper around the functionality.
+
+The client allows you to work with Toodledo from the command line. It will
+work in either interactive or command line mode.
+
+You can also use the client in your shell scripts, or use the API directly
+as part of a web application.  Don't like Toodledo's interface?  Write 
+your own.
+
+== FEATURES/PROBLEMS:
+
+* Command line client interface
+* Interactive client interface
+* Fully featured session based API
+* Supports Proxy and SSL usage
+* Easy configuration and automation (Quicksilver / Scripts / Automator)
+
+== SYNOPSIS:
+ 
+Toodledo has a particularly rich model of a task, and allows full GTD
+type state to be attached to them.  The client syntax for the client
+is as follows:
+
+  *Folder
+  @Context
+  $Goal
+
+You can encase the symbol with square brackets if there is a space
+involved:
+
+  *[Blue Sky]
+  @[Someday / Maybe]
+  $[Write Toodledo Ruby API]
+  
+Let's use the command line client to list only the tasks you have in the office:
+
+  toodledo list '@Office *Action'
+
+In interactive mode, the client will also allow you to set up filters.  If you 
+type 'folder', 'context' or 'goal' with an argument, then only tasks that match 
+those criteria will be displayed.  That is, if you do this:
+
+  context Office
+  folder Action
+  list
+
+Then it produces the same results as the previous list command.
+
+You can add tasks.  The simplest form is here:
+
+  toodledo add 'This is a test'
+
+Now let's add a task with several symbols:
+
+  toodledo add '*Action @Programming $[Write Toodledo Ruby API] Write documentation'
+
+You can also edit tasks, using the task id.  This sets the folder to Someday:
+
+  toodledo edit '*Someday 15934131'
+
+And finally you can complete or delete tasks, again using the task id.
+
+  toodledo complete 15934131
+  toodledo delete 15934131
+
+If you want to write your own scripts, working with Toodledo is very
+simple, since it will use the YAML config file:
+
+  require 'rubygems'
+  require 'toodledo'
+  Toodledo.begin do |session|
+    # work with session
+  end
+
+If you want to work with the session directly, then you should do
+this instead:
+
+  require 'rubygems'
+  require 'toodledo'
+  session = Session.new(userid, password)
+  session.connect()
+
+== REQUIREMENTS:
+
+* A connection to the Internet
+* An account to http://toodledo.com
+* Your Toodledo userid (see http://www.toodledo.com/info/api_doc.php)
+* cmdparse
+* highline
+* rubygems
+
+== INSTALL:
+
+* sudo gem install toodledo
+* toodledo setup (sets up the YAML file with your credentials)
+* toodledo interactive
+
+== LICENSE:
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Rakefile

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'toodledo'
+
+Hoe.new('toodledo', Toodledo::VERSION) do |p|
+  p.rubyforge_name = 'toodledo'
+  p.author = 'Will Sargent'
+  p.email = 'will@tersesystems.com'
+  p.summary = 'A command line client and API to Toodledo'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = 'http://rubyforge.org/projects/toodledo'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.rsync_args << ' --exclude=statsvn/'
+  p.extra_deps = ['cmdparse', 'highline']
+end
+
+# vim: syntax=Ruby

data/bin/toodledo

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# Add the lib directory to the ruby search path.
+$: << File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require 'rubygems'
+require 'toodledo'
+require 'toodledo/command_line/client'
+
+client = Toodledo::CommandLine::Client.new
+exit client.main()

data/lib/toodledo.rb

@@ -0,0 +1,64 @@
+#
+# The top level Toodledo module.  This does very little that is
+# interesting.  You probably want to look at Toodledo::Session
+#
+module Toodledo
+
+  # Required for gem  
+  VERSION = '1.0.0'
+  
+  # Returns the configuration object.
+  def self.get_config()
+    return @@config
+  end
+  
+  # Sets the configuration explicitly.  Useful when you
+  # want to specifically set the configuration without
+  # using the file system.
+  def self.set_config(override_config)
+    @@config = override_config
+  end
+  
+  #
+  # Provides a convenient way of connecting and running a session.
+  # 
+  # The following will do most everything you want, assuming you've set
+  # the config correctly:
+  #   
+  #   require 'toodledo'
+  #   Toodledo.begin do |session|
+  #     session.add_task('foo')
+  #   end
+  #
+  def self.begin(logger = nil)
+    config = Toodledo.get_config()
+          
+    proxy = config['proxy']
+          
+    connection = config['connection']
+    base_url = connection['url']
+    user_id = connection['user_id']
+    password = connection['password']
+    
+    session = Session.new(user_id, password, logger)
+
+    base_url = Session::DEFAULT_API_URL if (base_url == nil)
+    session.connect(base_url, proxy)
+    
+    if (block_given?)
+      yield(session)
+    end
+    
+    session.disconnect()
+  end  
+end
+
+require 'toodledo/server_error'
+require 'toodledo/item_not_found_error'
+require 'toodledo/task'
+require 'toodledo/context'
+require 'toodledo/goal'
+require 'toodledo/folder'
+require 'toodledo/repeat'
+require 'toodledo/priority'
+require 'toodledo/session'

data/lib/toodledo/command_line/add_command.rb

@@ -0,0 +1,29 @@
+
+module Toodledo  
+  module CommandLine
+    class AddCommand < BaseCommand
+      
+      include Toodledo::CommandLine::ParserHelper
+      
+      def initialize(client)
+        super(client, 'add', false)
+        self.short_desc = "Add a task"
+        self.description = "Adds a task to Toodledo"
+      end
+      
+      def execute(args)
+        return if (args == nil)
+        
+        if (client.debug?)
+          logger = Logger.new(STDOUT)
+          logger.level = Logger::DEBUG
+        end
+        
+        Toodledo.begin(logger) do |session|            
+          line = args.join(' ')
+          client.add_task(session, line)
+        end
+      end      
+    end
+  end  
+end

data/lib/toodledo/command_line/base_command.rb

@@ -0,0 +1,25 @@
+require 'cmdparse'
+
+module Toodledo  
+  module CommandLine        
+    class BaseCommand < CmdParse::Command      
+      def initialize(client, name, subtasks = false)
+        super(name, subtasks)
+        raise "Nil client!" if (client == nil)
+        @client = client        
+      end
+      
+      def client
+        return @client
+      end
+      
+      def logger
+        return @logger
+      end
+      
+    end
+  end
+end
+  
+  
+