toodledo 1.0.2 → 1.1.0

data/lib/toodledo/context.rb

@@ -22,9 +22,8 @@ module Toodledo
       return "@[#{name}]"
     end
     
-    
     # 
-    # Parses the context of an element.
+    # Parses the context of an REXML element.
     #
     def self.parse(session, el)
       id = el.attributes['id']

data/lib/toodledo/folder.rb

@@ -27,11 +27,8 @@ module Toodledo
     def archived?
       return @archived == 1
     end
-        
-    def to_s()
-      return "*[#{name}]"
-    end
-    
+      
+    # Creates a session object from an XML element.
     def self.parse(session, el)
       id = el.attributes['id']
       is_private = el.attributes['private']
@@ -46,5 +43,4 @@ module Toodledo
     end
   end
   
-  
 end

data/lib/toodledo/goal.rb

@@ -26,6 +26,7 @@ module Toodledo
       @id = id
       @level = level
       @contributes_id = contributes_id
+      @contributes = nil
       @name = name
     end
     
@@ -59,16 +60,9 @@ module Toodledo
     end
     
     def to_xml()
-      return "<goal id=\"#{@id}\" level=\"#{@level}\" contributes=\"#{@contributes.server_id}\" name=\"#{@name}\">"
+      return "<goal id=\"#{@id}\" level=\"#{@level}\" contributes=\"#{@contributes_id}\" name=\"#{@name}\">"
     end
     
-    def to_s()
-      msg = "$[#{name}]"
-      #if (contributes != NO_GOAL)
-      #  msg += " (Contributes to: #{contributes.name})"
-      #end
-      return msg
-    end
   end
   
 end

data/lib/toodledo/invalid_configuration_error.rb

@@ -0,0 +1,14 @@
+# 
+# 
+# 
+module Toodledo
+  
+  #
+  # Thrown when the session's configuration is invalid.
+  #
+  class InvalidConfigurationError < RuntimeError
+    def initialize(msg = nil)
+      super(msg)
+    end
+  end
+end

data/lib/toodledo/priority.rb

@@ -30,22 +30,5 @@ module Toodledo
       return false
     end
     
-    def self.convert(input)
-      case input 
-      when 'negative'
-        return Priority::NEGATIVE
-      when 'low'
-        return Priority::LOW
-      when 'medium'
-        return Priority::MEDIUM
-      when 'high'
-        return Priority::HIGH
-      when 'top'
-        return Priority::TOP
-      else
-        raise ArgumentError.new("Unknown priority: #{input}") 
-      end
-    end
-    
   end
 end

data/lib/toodledo/session.rb

@@ -21,7 +21,9 @@ module Toodledo
     USER_AGENT = "Ruby/#{Toodledo::VERSION} (#{RUBY_PLATFORM})"
     
     HEADERS = {
-      'User-Agent' => USER_AGENT
+      'User-Agent' => USER_AGENT,
+      'Connection' => 'keep-alive',
+      'Keep-Alive' => '300'
     }
     
     EXPIRATION_TIME_IN_SECS = 60 * 60
@@ -37,10 +39,10 @@ module Toodledo
     attr_reader :base_url, :user_id, :proxy
 
     # Creates a new session, using the given user name and password.
-    # throws exception if user_id or password are nil.
+    # throws InvalidConfigurationError if user_id or password are nil.
     def initialize(user_id, password, logger = nil)
-      raise "Nil user_id" if (user_id == nil)
-      raise "Nil password" if (password == nil)
+      raise InvalidConfigurationError.new("Nil user_id") if (user_id == nil)
+      raise InvalidConfigurationError.new("Nil password") if (password == nil)
     
       @user_id = user_id
       @password = password
@@ -72,11 +74,11 @@ module Toodledo
       # logger.debug("user_id = #{@user_id}, #{@email} #{@password}")
 
       if (@user_id == '1')
-        raise "No matching user_id found"
+        raise InvalidConfigurationError.new("Invalid user_id")
       end
       
       if (@user_id == '0')
-        raise "Server says we have a blank email or password"
+        raise InvalidConfigurationError.new("Invalid password")
       end
       
       # Set the base URL.
@@ -140,14 +142,6 @@ module Toodledo
         raise 'Must call connect() before this method'        
       end
 
-      # Break all the parameters down into key=value seperated by semi colons
-      stringified_params = (key != nil) ? ';key=' + key : ''
-
-      params.each { |k, v| 
-        stringified_params += ';' + k.to_s + '=' + escape_text(v) 
-      }
-      url = make_uri(method, stringified_params)
-
       # If it's been more than an hour, then ask for a new key.
       if (@key != nil && expired?)
         logger.debug("call(#{method}) connection expired, reconnecting...") if logger
@@ -157,8 +151,21 @@ module Toodledo
         proxy = @proxy
         disconnect() # ensures that key == nil, which is crucial to avoid an endless loop...
         connect(base_url, proxy)
+
+        # swap out the key (if any) before we start assembling the request
+        if (key != nil)
+          key = @key
+        end
       end
 
+      # Break all the parameters down into key=value seperated by semi colons
+      stringified_params = (key != nil) ? ';key=' + key : ''
+
+      params.each { |k, v| 
+        stringified_params += ';' + k.to_s + '=' + escape_text(v) 
+      }
+      url = make_uri(method, stringified_params)
+
       # Establish the proxy
       if (@proxy != nil)
         logger.debug("call(#{method}) establishing proxy...") if logger
@@ -215,7 +222,7 @@ module Toodledo
 
     # Gets the token method, given the id.
     def get_token(user_id)
-      raise "Nil user_id" if (user_id == nil)
+      raise "Nil user_id" if (user_id == nil || user_id.empty?)
 
       params = { :userid => user_id }
       result = call('getToken', params)    

data/lib/toodledo/task.rb

@@ -1,6 +1,7 @@
 
 require 'toodledo/repeat'
 require 'toodledo/priority'
+require 'date'
 
 module Toodledo
 
@@ -83,88 +84,6 @@ module Toodledo
       return ! (@children == nil || @children == 0)
     end
 
-    def to_s()
-      if (priority == Priority::NEGATIVE)
-        fancyp = 'v'
-      elsif (priority == Priority::LOW)
-        fancyp = '~'
-      else
-        fancyp = '!' * priority
-      end
-
-      msg = "#{fancyp}"
-
-      if (folder != Folder::NO_FOLDER)
-        msg += " *[#{folder.name}]"
-      end
-
-      if (context != Context::NO_CONTEXT)
-        msg += " @[#{context.name}]"
-      end
-
-      if (goal != Goal::NO_GOAL)
-        msg += " $[#{goal.name}]"
-      end
-
-      if (duedate != nil)
-        fmt = Session::DATE_FORMAT + ' ' + Session::TIME_FORMAT
-        msg += " \#[#{duedatemodifier}#{duedate.strftime(fmt)}]"
-      end
-
-      if (repeat != Repeat::NONE)
-        msg += " repeat[#{readable_repeat()}]"
-      end
-
-      if (tag != nil)
-        msg += " tag[#{tag}]"
-      end
-      
-      if (parent_id != nil)
-        msg += " parent[#{parent_id}]"
-      end
-
-      if (length != nil)
-        msg += " length[#{length}]"
-      end
-      
-      if (timer != nil)
-        msg += " timer[#{timer}]"
-      end
-      
-      msg += " #{title}"
-            
-      if (note != nil)
-        msg += "\n      #{note}"
-      end
-
-      return msg
-    end
-    
-    def readable_repeat()
-      case repeat
-      when Repeat::NONE
-        ''
-      when Repeat::WEEKLY
-        "weekly"
-      when Repeat::MONTHLY
-        "monthly"
-      when Repeat::YEARLY
-        "yearly"
-      when Repeat::DAILY
-        "daily"
-      when Repeat::BIWEEKLY
-        "biweekly"
-      when Repeat::BIMONTHLY
-        "bimonthly"
-      when Repeat::SEMIANNUALLY
-        "semiannually"
-      when Repeat::QUARTERLY
-        "quarterly"
-      else
-        ''
-      end
-    end
-
     # Parses a task element and returns a new Task.
     def self.parse(session, el)
 

data/test/client_test.rb

@@ -0,0 +1,192 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'toodledo/command_line/client'
+require 'flexmock/test_unit'
+
+module Toodledo
+  module CommandLine
+    class ClientTest < Test::Unit::TestCase
+
+      def setup()
+        client = Client.new()
+
+        # Set up a partial mock so we can override :print
+        @client = flexmock(client)
+        @session = flexmock('session')
+      end
+
+      def test_set_filter()
+        # We don't want an error message printed out here.
+        @client.should_receive(:print).never
+        @client.set_filter(@session, '!top')
+      end
+      
+      def test_add_task_with_no_args()
+
+        input = 'This is a test'
+        args = {}
+
+        @session.should_receive(:add_task).with(input, args).and_return 1
+        @client.should_receive(:print).with('Task 1 added.')
+        @client.add_task(@session, input)
+      end
+
+      def test_add_task_with_folder()
+
+        input = '*Inbasket This is a test'
+
+        args = { :folder => "Inbasket" }
+
+        @session.should_receive(:add_task).with('This is a test', args).and_return(1)
+        @client.should_receive(:print).with('Task 1 added.')
+        @client.add_task(@session, input)
+      end
+
+      def test_add_task_with_context()
+
+        input = '@Home This is a test'
+
+        args = { :context => "Home" }
+
+        @session.should_receive(:add_task).with('This is a test', args).and_return(1)
+        @client.should_receive(:print).with('Task 1 added.')
+
+        @client.add_task(@session, input)
+      end
+
+      def test_add_task_with_goal()
+
+        input = '^Goal This is a test'
+
+        args = { :goal => "Goal" }
+
+        @session.should_receive(:add_task).with('This is a test', args).and_return(1)
+        @client.should_receive(:print).with('Task 1 added.')
+
+        @client.add_task(@session, input)
+      end
+
+      def test_add_task_with_priority()
+
+        input = '!top This is a test'
+
+        args = { :priority => Priority::TOP }
+
+        @session.should_receive(:add_task).with('This is a test', args).and_return(1)
+        @client.should_receive(:print).with('Task 1 added.')
+
+        @client.add_task(@session, input)
+      end
+      
+      def test_add_folder()
+        input = 'name'
+        
+        id = '1234'
+        @session.should_receive(:add_folder).with(input).and_return(id)
+        @client.should_receive(:print).with('Folder 1234 added.')
+        
+        @client.add_folder(@session, input)
+      end
+      
+      def test_add_context()
+        input = 'name'
+        
+        id = '1234'
+        @session.should_receive(:add_context).with(input).and_return(id)
+        @client.should_receive(:print).with('Context 1234 added.')
+        
+        @client.add_context(@session, input)
+      end
+      
+      def test_add_goal()
+        input = 'name'
+        
+        id = '1234'
+        level = Goal::SHORT_LEVEL
+        @session.should_receive(:add_goal).with(input, level).and_return(id)
+        @client.should_receive(:print).with('Goal 1234 added.')
+        
+        @client.add_goal(@session, input)
+      end
+
+      def test_list_tasks_with_nothing()
+
+        params = {
+          :priority => Priority::LOW,
+          :title => 'foo',
+          :folder => Folder::NO_FOLDER,
+          :context => Context::NO_CONTEXT,
+          :goal => Goal::NO_GOAL,
+          :repeat => Repeat::NONE
+        }
+        task = Task.new(1234, params)
+        tasks = [ task ]
+        @session.should_receive(:get_tasks).and_return(tasks)
+        @client.should_receive(:print).with('<1234> -- !low foo')
+
+        input = ''
+        @client.list_tasks(@session, input)
+      end
+
+
+      def test_list_tasks_with_everything()
+
+        params = {
+          :priority => Priority::LOW,
+          :title => 'foo',
+          :folder => Folder.new(1234, 0, 0, 'test folder'),
+          :context => Context.new(345, 'test context'),
+          :goal => Goal.new(342341, 0, 0, 'test goal'),
+          :repeat => Repeat::BIWEEKLY,
+          :tag => 'some tag'
+        }
+        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')
+
+        input = ''
+        @client.list_tasks(@session, input)
+      end
+
+      def test_list_contexts()
+        context = Context.new(1234, 'Context')
+        contexts = [ context ]
+        @session.should_receive(:get_contexts).and_return(contexts)
+        @client.should_receive(:print).with('<1234> -- @[Context]')
+
+        input = ''
+        @client.list_contexts(@session, input)
+      end
+      
+      def test_list_goals()
+        goals = [ Goal.new(1234, Goal::LIFE_LEVEL, 0, 'Name') ]
+        @session.should_receive(:get_goals).and_return(goals)
+        @client.should_receive(:print).with('<1234> -- life ^[Name]')
+        
+        input = ''
+        @client.list_goals(@session, input)
+      end
+        
+      def test_list_folders()
+        folders = [ Folder.new(1234, 0, 0, 'Name') ]
+        @session.should_receive(:get_folders).and_return(folders)
+        @client.should_receive(:print).with('<1234> -- *[Name]')
+        
+        input = ''
+        @client.list_folders(@session, input)
+      end
+      
+      def test_archive_folder()
+        
+        @session.should_receive(:edit_folder).and_return(true)
+        @client.should_receive(:print).with('Folder 234 archived.')
+        
+        input = '234'
+        @client.archive_folder(@session, input)
+      end
+      
+    end
+  end
+end