toodledo 1.2.0 → 1.3.0

data/History.txt

@@ -1,3 +1,7 @@
+== 1.3.0 / 2008-05-31
+
+* Added star, status and startdate to correspond to version 3.9.0
+
 == 1.2.0 / 2008-04-19
 
 * Added get_deleted() method

data/Manifest.txt

@@ -32,6 +32,7 @@ lib/toodledo/priority.rb
 lib/toodledo/repeat.rb
 lib/toodledo/server_error.rb
 lib/toodledo/session.rb
+lib/toodledo/status.rb
 lib/toodledo/task.rb
 test/client_test.rb
 test/parser_helper_test.rb

data/lib/toodledo.rb

@@ -5,7 +5,7 @@
 module Toodledo
 
   # Required for gem  
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
   
   # Returns the configuration object.
   def self.get_config()
@@ -24,11 +24,21 @@ module Toodledo
   # 
   # 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
+  #
+  #  require 'rubygems'
+  #  require 'toodledo'
+  #  require 'yaml'
+  #  config = {
+  #    "connection" => { 
+  #      "url" => "http://www.toodledo.com/api.php",
+  #      "user_id" => "<your user id>",
+  #      "password" => "<your password>"
+  #    }
+  #  }
+  #  Toodledo.set_config(config)
+  #  Toodledo.begin do |session|
+  #    session.add_task('foo')
+  #  end
   #
   def self.begin(logger = nil)
     config = Toodledo.get_config()
@@ -56,6 +66,7 @@ end
 require 'toodledo/server_error'
 require 'toodledo/item_not_found_error'
 require 'toodledo/invalid_configuration_error'
+require 'toodledo/status'
 require 'toodledo/task'
 require 'toodledo/context'
 require 'toodledo/goal'

data/lib/toodledo/command_line/client.rb

@@ -18,6 +18,7 @@ require 'toodledo/command_line/add_command'
 # READ
 require 'toodledo/command_line/hotlist_command'
 require 'toodledo/command_line/list_tasks_command'
+require 'toodledo/command_line/list_tasks_by_context_command'
 require 'toodledo/command_line/list_folders_command'
 require 'toodledo/command_line/list_contexts_command'
 require 'toodledo/command_line/list_goals_command'
@@ -76,10 +77,16 @@ module Toodledo
         }
       end
       
+      #
+      # Returns debugging status.
+      #
       def debug?
         return @debug
       end
       
+      #
+      # Sets the debugging on or off.
+      #
       def debug=(is_debug)
         @debug = is_debug
         if (@debug == true)
@@ -89,6 +96,9 @@ module Toodledo
         end
       end
             
+      #
+      # Returns the logger.
+      #
       def logger
         return @logger
       end
@@ -293,6 +303,20 @@ module Toodledo
         end
       end
       
+      #
+      # Prints all active tasks nested by context.
+      #
+      def list_tasks_by_context(session, line)
+        folder = parse_folder(line)
+        
+        session.get_contexts().each do |context|
+            criteria = { :folder => folder, :context => context, :notcomp => true }
+            tasks = session.get_tasks(criteria)        
+            print "#{context.name}" if (! tasks.empty?)
+            tasks.each { |task| print "  " + @formatters[:task].format(task) }
+        end
+      end
+        
       #
       # Lists the goals.  Takes an optional argument of 
       # 'short', 'medium' or 'life'.
@@ -359,10 +383,8 @@ module Toodledo
       # The order of symbols does not matter, but the title must be the last thing
       # on the line.
       #
-      # add @[Deep Space] *Action ^[For Great Justice] Take off every Zig
+      # add @[Deep Space] !top *Action ^[For Great Justice] Take off every Zig
       #
-      # There is no priority handling in this method.  It may be added if there is
-      # demand for it.
       def add_task(session, line)        
         context = parse_context(line)
         folder = parse_folder(line)
@@ -397,6 +419,9 @@ module Toodledo
         print "Task #{task_id} added."
       end
       
+      #
+      # Adds context.
+      #
       def add_context(session, input)
         
         title = input.strip
@@ -406,6 +431,9 @@ module Toodledo
         print "Context #{context_id} added."
       end
       
+      #
+      # Adds goal.
+      #
       def add_goal(session, input)
         input.strip!
         
@@ -455,7 +483,7 @@ module Toodledo
       # Edits a single task.  This method allows you to change the symbols on a
       # task.  Note that you must specify the ID here.  
       #
-      # edit *Action 12345
+      # edit *Action !top 12345
       def edit_task(session, input)  
         logger.debug("edit_task: #{input.inspect}")
         
@@ -522,7 +550,8 @@ module Toodledo
       #
       # delete 123 
       #
-      def delete_task(session, line)        
+      def delete_task(session, line)     
+        logger.debug("delete_task: #{line.inspect}")
         task_id = line
         
         if (task_id == nil)
@@ -538,7 +567,12 @@ module Toodledo
         end
       end
       
+      #
+      # Deletes context.
+      #
       def delete_context(session, line)
+        logger.debug("delete_context #{line.inspect}")
+        
         id = line
         
         id.strip!
@@ -550,6 +584,9 @@ module Toodledo
         end
       end
 
+      #
+      # Deletes goal.
+      #
       def delete_goal(session, line)
         id = line
         
@@ -562,6 +599,9 @@ module Toodledo
         end
       end
 
+      #
+      # Deletes folder
+      #
       def delete_folder(session, line)
         id = line
         
@@ -573,8 +613,10 @@ module Toodledo
           print "Folder #{id} could not be deleted!"      
         end
       end
-        
+      
+      #  
       # Prints out a single line.
+      #
       def print(line = nil)
         if (line == nil)
           puts

data/lib/toodledo/command_line/task_formatter.rb

@@ -29,6 +29,19 @@ module Toodledo
           fmt = '%m/%d/%Y %I:%M %p'
           msg += " \#[#{task.duedatemodifier}#{task.duedate.strftime(fmt)}]"
         end
+        
+        if (task.startdate != nil)
+          fmt = '%m/%d/%Y'
+          msg += " startdate[#{task.startdate.strftime(fmt)}]"
+        end
+        
+        if (task.status != Status::NONE)
+          msg += " status[#{readable_status(task.status)}]"
+        end
+        
+        if (task.star)
+          msg += " starred"
+        end
   
         if (task.tag != nil)
           msg += " tag[#{task.tag}]"
@@ -46,7 +59,7 @@ module Toodledo
           msg += " timer[#{task.timer}]"
         end
         
-        if (task.num_children != nil)
+        if (task.num_children != nil && task.num_children > 0)
           msg += " children[#{task.num_children}]"
         end
         
@@ -76,6 +89,9 @@ module Toodledo
         end
       end
       
+      #
+      # Returns a string matching the numeric repeat code.
+      #
       def readable_repeat(repeat)
         case repeat
         when Repeat::NONE
@@ -100,6 +116,36 @@ module Toodledo
           ''
         end
       end
+      
+      #
+      # Return a readable status given the numeric code.
+      #
+      def readable_status(status)
+        case status
+        when Status::NONE
+          'none'
+        when Status::NEXT_ACTION
+          'Next Action'
+        when Status::ACTIVE
+          'Active'
+        when Status::PLANNING
+          'Planning'
+        when Status::DELEGATED
+          'Delegated'
+        when Status::WAITING
+          'Waiting'
+        when Status::HOLD
+          'Hold'
+        when Status::POSTPONED
+          'Postponed'
+        when Status::SOMEDAY
+          'Someday'
+        when Status::CANCELLED
+          'Cancelled'
+        when Status::REFERENCE
+          'Reference'
+        end
+      end
     end
   end
 end

data/lib/toodledo/repeat.rb

@@ -1,8 +1,6 @@
-# 
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
- 
-
+#
+# The value values for repeats
+#
 module Toodledo
   class Repeat
     
@@ -15,6 +13,7 @@ module Toodledo
     BIMONTHLY = 6
     SEMIANNUALLY = 7
     QUARTERLY = 8
+    WITH_PARENT = 9
     
     REPEAT_ARRAY = [
       NONE,
@@ -25,7 +24,8 @@ module Toodledo
       BIWEEKLY,
       BIMONTHLY,
       SEMIANNUALLY,
-      QUARTERLY
+      QUARTERLY,
+      WITH_PARENT
     ]
     
     def self.each

data/lib/toodledo/session.rb

@@ -350,6 +350,9 @@ module Toodledo
     # * compbefore 
     # * compafter 
     # * notcomp 
+    # * star
+    # * status
+    # * startdate
     #
     # Returns an array of tasks.  This information is never cached.
     def get_tasks(params={})
@@ -420,7 +423,19 @@ module Toodledo
       # * compafter : A date formated as YYYY-MM-DD. Used to find tasks with a 
       # completed date after this date.
       handle_date(myhash, params, :compafter)
-    
+      
+      # startbefore:
+      handle_date(myhash, params, :startbefore)
+      
+      # startafter:
+      handle_date(myhash, params, :startafter)
+      
+      # star
+      handle_boolean(myhash, params, :star)
+      
+      # status
+      handle_status(myhash, params)
+      
       # * notcomp : Set to 1 to omit completed tasks. Omit variable, or set to 0
       # to retrieve both completed and uncompleted tasks.
       handle_boolean(myhash, params, :notcomp)
@@ -482,6 +497,9 @@ module Toodledo
     
       # Goal handling
       handle_goal(myhash, params)
+      
+      # Add the start date if it's been added.
+      handle_date(myhash, params, :startdate)
     
       # duedate handling.  Take either a string or a Time object.'YYYY-MM-DD'
       handle_date(myhash, params, :duedate)
@@ -497,7 +515,14 @@ module Toodledo
    
       # priority use the map to change from the symbol to the raw numeric value.
       handle_priority(myhash, params)
+      
+      # Handle the star.
+      handle_boolean(myhash, params, :star)
 
+      # Handle the status date.
+      handle_status(myhash, params)
+      
+      # Handle the note.
       handle_string(myhash, params, :note)
     
       result = call('addTask', myhash, @key)
@@ -1121,6 +1146,19 @@ module Toodledo
       
       myhash.merge!({ :repeat => repeat })
     end
+    
+    # Handles the status parameter
+    def handle_status(myhash, params)
+      status = params[:status]
+      
+      return if (status == nil)
+      
+      if (! Status.valid?(status))
+        raise "Invalid status value: #{status}"
+      end
+      
+      myhash.merge!({ :status => status })
+    end
 
     # Handles the priority.  This must be one of several values.
     def handle_priority(myhash, params)

data/lib/toodledo/status.rb

@@ -0,0 +1,44 @@
+#
+# The possible values for the status field of a task.
+#
+class Status
+  
+    NONE = 0
+    NEXT_ACTION = 1
+    ACTIVE = 2
+    PLANNING = 3
+    DELEGATED = 4
+    WAITING = 5
+    HOLD = 6
+    POSTPONED = 7
+    SOMEDAY = 8
+    CANCELLED = 9
+    REFERENCE = 10
+      
+    STATUS_ARRAY = [
+      NONE,
+      NEXT_ACTION,
+      ACTIVE,
+      PLANNING,
+      DELEGATED,
+      WAITING,
+      HOLD,
+      POSTPONED,
+      SOMEDAY,
+      CANCELLED,
+      REFERENCE
+    ]
+    
+    def self.each
+      STATUS_ARRAY.each{|value| yield(value)}
+    end
+    
+    def self.valid?(input)
+      for status in STATUS_ARRAY
+        if (status == input) 
+          return true
+        end
+      end
+      return false
+    end
+end

data/lib/toodledo/task.rb

@@ -26,7 +26,14 @@ module Toodledo
     attr_reader :parent_id, :parent, :title, :tag
     attr_reader :added, :modified, :completed
     attr_reader :duedate, :duedatemodifier
-    attr_reader :repeat, :priority, :length, :timer, :note
+    attr_reader :repeat, :priority 
+    attr_reader :length, :timer 
+    attr_reader :note
+    
+    # as of 3.90
+    attr_reader :status
+    attr_reader :startdate
+    attr_reader :star
 
     def server_id
       return @id
@@ -79,6 +86,10 @@ module Toodledo
       @length = params[:length]
       @timer = params[:timer]
       @note = params[:note]
+      
+      @startdate = params[:startdate]
+      @status = params[:status]
+      @star = params[:star]
     end
 
     def completed?
@@ -130,8 +141,11 @@ module Toodledo
       #   <repeat>1</repeat>
       #   <priority>2</priority>
       #   <length>20</length>
-      #   <timer>0</timer>
+      #   <timer onfor=''>0</timer>
       #   <note></note>
+      #   <startdate></startdate>
+      #   <status>0</status>
+      #   <star></star>
       # </task> #++
 
       id = el.elements['id'].text
@@ -220,6 +234,16 @@ module Toodledo
       note = el.elements['note'].text
       note = nil if (note == '0')
       
+      startdate = el.elements['startdate'].text
+      if (startdate != nil)
+        startdate = Date.strptime(startdate, Session::DATE_FORMAT)
+      end
+      
+      status = el.elements['status'].text
+      status = Status::NONE if (status == '0')
+      
+      star = (el.elements['star'].text.to_i == 1)
+      
       params = {
         :parent_id => parent_id,
         :parent => parent,
@@ -239,6 +263,9 @@ module Toodledo
         :length => length,
         :timer => timer,
         :note => note,
+        :startdate => startdate,
+        :status => status,
+        :star => star
       }
       return Task.new(id, params)
     end

data/test/client_test.rb

@@ -118,6 +118,7 @@ module Toodledo
           :folder => Folder::NO_FOLDER,
           :context => Context::NO_CONTEXT,
           :goal => Goal::NO_GOAL,
+          :status => Status::NONE,
           :repeat => Repeat::NONE
         }
         task = Task.new(1234, params)
@@ -139,16 +140,43 @@ module Toodledo
           :context => Context.new(345, 'test context'),
           :goal => Goal.new(342341, 0, 0, 'test goal'),
           :repeat => Repeat::BIWEEKLY,
-          :tag => 'some tag'
+          :status => Status::NEXT_ACTION,
+          :tag => 'some tag',
+          :star => true
         }
         task = Task.new(1234, params)
         tasks = [ task ]
         @session.should_receive(:get_tasks).and_return(tasks)
-        @client.should_receive(:print).with('<1234> -- !low *[test folder] @[test context] ^[test goal] repeat[biweekly] tag[some tag] foo')
+        @client.should_receive(:print).with('<1234> -- !low *[test folder] @[test context] ^[test goal] repeat[biweekly] status[Next Action] starred tag[some tag] foo')
 
         input = ''
         @client.list_tasks(@session, input)
       end
+      
+      def test_list_tasks_by_context()
+        context = Context.new(345, 'test context')
+        folder = Folder.new(1234, 0, 0, 'test folder')
+        
+        params = {
+          :priority => Priority::LOW,
+          :title => 'foo',
+          :folder => folder,
+          :goal => Goal::NO_GOAL,
+          :repeat => Repeat::NONE,
+          :status => Status::NONE,
+          :context => context
+        }
+        task = Task.new(1234, params)
+        tasks = [ task ]
+        contexts = [ context ]
+        @session.should_receive(:get_contexts).and_return(contexts)
+        @session.should_receive(:get_tasks).and_return(tasks)
+        @client.should_receive(:print).with('test context')
+        @client.should_receive(:print).with('  <1234> -- !low *[test folder] @[test context] foo')
+        
+        input = ''
+        @client.list_tasks_by_context(@session, input)        
+      end
 
       def test_list_contexts()
         context = Context.new(1234, 'Context')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: toodledo
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Will Sargent
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-19 00:00:00 -07:00
+date: 2008-05-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ files:
 - lib/toodledo/repeat.rb
 - lib/toodledo/server_error.rb
 - lib/toodledo/session.rb
+- lib/toodledo/status.rb
 - lib/toodledo/task.rb
 - test/client_test.rb
 - test/parser_helper_test.rb
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: toodledo
-rubygems_version: 1.0.1
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: A command line client and API to Toodledo