toodledo 1.1.1 → 1.1.2

data/History.txt

@@ -1,36 +1,42 @@
-== 1.1.1 / 2008-02-29
-
-* Rake release was bad.  Re-releasing.
-
-== 1.1.0 / 2008-02-24
-
-* Add functionality to add, delete goals, contexts, and folders from client.
-* Add functionality to archive folders.
-* Add stdin command to read from pipe or redirected files
-* Add formatters for the client so it's easier to tweak line output.
-* Add proper priority support to the client (in the format !top, !high, etc.) 
-* Make filter able to take symbols.
-* Change symbol for goals from $ to ^ (was confusing when entering 'I owe $5')
-* Add unit tests for client.
-* Better error messages and explanation of toodledo setup.
-* Fix the debug command so it doesn't crash the interactive client.
-* Fixed some bugs in date processing.
-* Fixed bugs in priority handling.
-* Fixed session invalid bug on reconnect.
-
-== 1.0.2 / 2008-02-14
-
-* Fix a silly bug where whitespace wasn't stripped from edit, complete and delete.
-* Enable interactive debug, and refactor the logging to be in client, not commands.
-* Enable toodledo symbols to be anywhere in the string, not just before the task.
-* Cleaner error messages if the task id is not found.
-* Make sure failed commands exit with non-zero status.
-
-== 1.0.1 / 2008-02-11
-
-* Fix bug in client where priority filter was not being applied.
-
-== 1.0.0 / 2008-02-10
-
-* First version released!
-
+== 1.1.2 / 2008-03-22
+
+* Added get_session_info()
+* Added get_account_info()
+* Added get_task_by_id() and make task a little smarter about parents / subtasks.
+
+== 1.1.1 / 2008-02-29
+
+* Rake release was bad.  Rereleasing.
+
+== 1.1.0 / 2008-02-24
+
+* Add functionality to add, delete goals, contexts, and folders from client.
+* Add functionality to archive folders.
+* Add stdin command to read from pipe or redirected files
+* Add formatters for the client so it's easier to tweak line output.
+* Add proper priority support to the client (in the format !top, !high, etc.) 
+* Make filter able to take symbols.
+* Change symbol for goals from $ to ^ (was confusing when entering 'I owe $5')
+* Add unit tests for client.
+* Better error messages and explanation of toodledo setup.
+* Fix the debug command so it doesn't crash the interactive client.
+* Fixed some bugs in date processing.
+* Fixed bugs in priority handling.
+* Fixed session invalid bug on reconnect.
+
+== 1.0.2 / 2008-02-14
+
+* Fix a silly bug where whitespace wasn't stripped from edit, complete and delete.
+* Enable interactive debug, and refactor the logging to be in client, not commands.
+* Enable toodledo symbols to be anywhere in the string, not just before the task.
+* Cleaner error messages if the task id is not found.
+* Make sure failed commands exit with non-zero status.
+
+== 1.0.1 / 2008-02-11
+
+* Fix bug in client where priority filter was not being applied.
+
+== 1.0.0 / 2008-02-10
+
+* First version released!
+

data/Manifest.txt

@@ -1,39 +1,39 @@
-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/context_formatter.rb
-lib/toodledo/command_line/delete_command.rb
-lib/toodledo/command_line/edit_command.rb
-lib/toodledo/command_line/folder_formatter.rb
-lib/toodledo/command_line/goal_formatter.rb
-lib/toodledo/command_line/hotlist_command.rb
-lib/toodledo/command_line/interactive_command.rb
-lib/toodledo/command_line/list_contexts_command.rb
-lib/toodledo/command_line/list_folders_command.rb
-lib/toodledo/command_line/list_goals_command.rb
-lib/toodledo/command_line/list_tasks_command.rb
-lib/toodledo/command_line/parser_helper.rb
-lib/toodledo/command_line/setup_command.rb
-lib/toodledo/command_line/stdin_command.rb
-lib/toodledo/command_line/task_formatter.rb
-lib/toodledo/context.rb
-lib/toodledo/folder.rb
-lib/toodledo/goal.rb
-lib/toodledo/invalid_configuration_error.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/client_test.rb
-test/parser_helper_test.rb
-test/session_test.rb
-test/toodledo_functional_test.rb
+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/context_formatter.rb
+lib/toodledo/command_line/delete_command.rb
+lib/toodledo/command_line/edit_command.rb
+lib/toodledo/command_line/folder_formatter.rb
+lib/toodledo/command_line/goal_formatter.rb
+lib/toodledo/command_line/hotlist_command.rb
+lib/toodledo/command_line/interactive_command.rb
+lib/toodledo/command_line/list_tasks_command.rb
+lib/toodledo/command_line/list_contexts_command.rb
+lib/toodledo/command_line/list_folders_command.rb
+lib/toodledo/command_line/list_goals_command.rb
+lib/toodledo/command_line/parser_helper.rb
+lib/toodledo/command_line/setup_command.rb
+lib/toodledo/command_line/stdin_command.rb
+lib/toodledo/command_line/task_formatter.rb
+lib/toodledo/context.rb
+lib/toodledo/folder.rb
+lib/toodledo/goal.rb
+lib/toodledo/invalid_configuration_error.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/client_test.rb
+test/parser_helper_test.rb
+test/session_test.rb
+test/toodledo_functional_test.rb

data/lib/toodledo.rb

@@ -1,65 +1,65 @@
-#
-# 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.1.1'
-  
-  # 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/invalid_configuration_error'
-require 'toodledo/task'
-require 'toodledo/context'
-require 'toodledo/goal'
-require 'toodledo/folder'
-require 'toodledo/repeat'
-require 'toodledo/priority'
-require 'toodledo/session'
+#
+# 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.1.2'
+  
+  # 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/invalid_configuration_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/task_formatter.rb

@@ -35,7 +35,7 @@ module Toodledo
         end
         
         if (task.parent_id != nil)
-          msg += " parent[#{task.parent_id}]"
+          msg += " parent[#{task.parent.title}]"
         end
   
         if (task.length != nil)
@@ -46,7 +46,10 @@ module Toodledo
           msg += " timer[#{task.timer}]"
         end
         
-        # Use the highline color library
+        if (task.num_children != nil)
+          msg += " children[#{task.num_children}]"
+        end
+        
         msg += " #{task.title}"
               
         if (task.note != nil)

data/lib/toodledo/session.rb

@@ -244,7 +244,63 @@ module Toodledo
       result = call('getUserid', params)  
       return result.text
     end
-
+   
+    #
+    # Returns the information associated with this account.
+    # 
+    #   pro : Whether or not the user is a Pro member. You need to know this if you want to use subtasks.
+    #   dateformat : The user's prefered format for representing dates. (0=M D, Y, 1=M/D/Y, 2=D/M/Y, 3=Y-M-D)
+    #   timezone : The number of half hours that the user's timezone is offset from the server's timezone. A value of -4 means that the user's timezone is 2 hours earlier than the server's timezone.
+    #   hidemonths : If the task is due this many months into the future, the user wants them to be hidden.
+    #   hotlistpriority : The priority value above which tasks should appear on the hotlist.
+    #   hotlistduedate : The due date lead-time by which tasks should will appear on the hotlist.
+    def get_account_info()
+      result = call('getAccountInfo', {}, @key)
+      
+      pro = (result.elements['pro'].text.to_i == 1) ? true : false
+      
+      hash = {
+        :userid => result.elements['userid'].text,
+        :alias => result.elements['alias'].text,
+        :pro => pro,
+        :dateformat => result.elements['dateformat'].text.to_i,
+        :timezone => result.elements['timezone'].text.to_i,
+        :hidemonths => result.elements['hidemonths'].text.to_i,
+        :hotlistpriority => result.elements['hotlistpriority'].text.to_i,
+        :hotlistduedate => result.elements['hotlistduedate'].text.to_i
+      }
+      
+      return hash
+    end
+    
+    #
+    # The "getServerInfo" API call will return some information about the server and your current API session.
+    # 
+    #  unixtime: the time since epoch of the server.
+    #  date: the date of the server.
+    #  tokenexpires: how long in minutes before the current token expires. 
+    #
+    def get_server_info()
+      result = call('getServerInfo', {}, @key)
+      
+      # <server>
+      #<unixtime>1204569838</unixtime>
+      #<date>Mon,  3 Mar 2008 12:43:58 -0600</date>
+      #<tokenexpires>45.4</tokenexpires>
+      #</server>
+      
+      unixtime = result.elements['unixtime'].text.to_i
+      server_date = Time.at(unixtime)
+      token_expires = result.elements['tokenexpires'].text.to_i
+      hash = {
+        :unixtime => unixtime,
+        :date => server_date,
+        :tokenexpires => token_expires
+      }
+      
+      return hash
+    end
+    
     ############################################################################
     # Tasks
     ############################################################################
@@ -354,6 +410,17 @@ module Toodledo
       end
       return tasks
     end
+    
+    #
+    # Gets a single task by its id, and returns the task.
+    #
+    def get_task_by_id(id)
+      result = call('getTasks', {:id => id}, @key)
+      result.elements.each do |el| 
+        task = Task.parse(self, el)
+        return task
+      end
+    end
   
     # Adds a task to Toodledo.
     #

data/lib/toodledo/task.rb

@@ -22,8 +22,8 @@ module Toodledo
     # Indicates that the task's duedate is optional. See
     # http://www.toodledo.com/info/help.php?sel=42
     OPTIONAL = '?'
-
-    attr_reader :parent_id, :children, :title, :tag
+    
+    attr_reader :parent_id, :parent, :title, :tag
     attr_reader :added, :modified, :completed
     attr_reader :duedate, :duedatemodifier
     attr_reader :repeat, :priority, :length, :timer, :note
@@ -43,6 +43,10 @@ module Toodledo
     def goal
       return @goal
     end
+    
+    def num_children
+      return @num_children
+    end
 
     def initialize(id, params = {})
       @id = id
@@ -50,8 +54,9 @@ module Toodledo
       @title = params[:title]
       @tag = params[:tag]
 
-      @parent_id = params[:parent]
-      @children = params[:children]
+      @parent_id = params[:parent_id]
+      @parent = params[:parent]
+      @num_children = params[:num_children]
 
       # The folder, context and goals are parsed out from get_tasks() call into
       # the appropriate object.
@@ -81,7 +86,7 @@ module Toodledo
     end
 
     def is_parent?
-      return ! (@children == nil || @children == 0)
+      return ! (@num_children == nil || @num_children == 0)
     end
 
     # Parses a task element and returns a new Task.
@@ -164,15 +169,21 @@ module Toodledo
       priority = el.elements['priority'].text.to_i
 
       # Only set a parent if it's not the 'empty parent'.
-      parent_id = el.elements['parent'].text
-      if parent_id == '0'
+      parent_id_el = el.elements['parent']
+      if (parent_id_el != nil)
+        parent_id = parent_id_el.text
+        if parent_id == '0'
+          parent_id = nil
+        else
+          parent_id = parent_id.to_i
+          parent = session.get_task_by_id(parent_id)
+        end
+      else 
         parent_id = nil
-      else
-        parent_id = parent_id.to_i
       end
-
+      
       # This is actually the NUMBER of children.  Two children returns 2.
-      children = el.elements['children'].text.to_i
+      num_children = el.elements['children'].text.to_i
       
       title = el.elements['title'].text
       
@@ -189,8 +200,9 @@ module Toodledo
       note = nil if (note == '0')
       
       params = {
-        :parent => parent_id,
-        :children => children,
+        :parent_id => parent_id,
+        :parent => parent,
+        :num_children => num_children,
         :title => title,
         :tag => tag,
         :folder => folder,

data/test/session_test.rb

@@ -180,6 +180,8 @@ class SessionTest < Test::Unit::TestCase
     assert myhash[:parent] == task_id
   end
   
+  
+  
   #  handle_number
   #  handle_string
   #  

data/test/toodledo_functional_test.rb

@@ -22,7 +22,10 @@ class ToodledoFunctionalTest < Test::Unit::TestCase
     # proxy = { 'host' => '127.0.0.1', 'port' => '8080'}
     proxy = nil
     
-    @session = Session.new(@user_id, @password)
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::ERROR
+    
+    @session = Session.new(@user_id, @password, logger)
     @session.connect(base_url, proxy)
   end
   
@@ -31,11 +34,11 @@ class ToodledoFunctionalTest < Test::Unit::TestCase
   end
   
   # Always fails.
-  # def test_get_user_id()
+  #def test_get_user_id()
   #  user_id = @session.get_user_id(@email, @password)
   #     
-  #  # assert user_id == @user_id
-  # end
+  #  assert user_id == @user_id
+  #end
   
   def test_add_edit_and_remove_task
     title = 'test_add_task'
@@ -131,6 +134,27 @@ class ToodledoFunctionalTest < Test::Unit::TestCase
     assert folders.length == 0
   end
   
+  def test_get_server_info()
+    info_hash = @session.get_server_info()
+    
+    assert info_hash[:unixtime] != nil
+    assert info_hash[:date] != nil
+    assert info_hash[:tokenexpires] != nil
+  end
+  
+  def test_get_account_info()
+    info_hash = @session.get_account_info()
+    
+    assert info_hash[:userid] == @user_id
+    assert info_hash[:alias] == 'will.sargent+toodledo_rub'
+    assert info_hash[:pro] == false
+    assert info_hash[:dateformat] == 0
+    assert info_hash[:timezone] == 0
+    assert info_hash[:hidemonths] == 6
+    assert info_hash[:hotlistpriority] == 3
+    assert info_hash[:hotlistduedate] == 14   
+  end
+  
   #
   # Date functionality.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: toodledo
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Will Sargent
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-29 00:00:00 -08:00
+date: 2008-03-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,7 +37,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.0
+        version: 1.5.1
     version: 
 description: "== 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.  Custom private RSS feed?  Want to have the Mac  read out your top priority?  Input tasks through Quicksilver?  Print out tasks with a BetaBrite?  It can all happen."
 email: will@tersesystems.com
@@ -67,10 +67,10 @@ files:
 - lib/toodledo/command_line/goal_formatter.rb
 - lib/toodledo/command_line/hotlist_command.rb
 - lib/toodledo/command_line/interactive_command.rb
+- lib/toodledo/command_line/list_tasks_command.rb
 - lib/toodledo/command_line/list_contexts_command.rb
 - lib/toodledo/command_line/list_folders_command.rb
 - lib/toodledo/command_line/list_goals_command.rb
-- lib/toodledo/command_line/list_tasks_command.rb
 - lib/toodledo/command_line/parser_helper.rb
 - lib/toodledo/command_line/setup_command.rb
 - lib/toodledo/command_line/stdin_command.rb