toodledo 1.3.5 → 1.3.8

data/lib/toodledo/command_line/parser_helper.rb

@@ -9,6 +9,7 @@ module Toodledo
     # 
     module ParserHelper
       
+      # TODO These regexps are highly repetitive. Refactor
       FOLDER_REGEXP = /\*((\w+)|\[(.*?)\])/
   
       GOAL_REGEXP = /\^((\w+)|\[(.*?)\])/
@@ -17,6 +18,10 @@ module Toodledo
       
       PRIORITY_REGEXP = /!(top|high|medium|low|negative)/
       
+      DATE_REGEXP = /\#(([^\[]\S*)|\[(.*?)\])/
+      
+      TAGS_REGEXP = /\%((\w+)|\[(.*?)\])/
+      
       # Note that level must exist at the beginning of the line
       LEVEL_REGEXP = /^(life|medium|short)/
       
@@ -25,7 +30,9 @@ module Toodledo
         FOLDER_REGEXP, 
         GOAL_REGEXP,
         CONTEXT_REGEXP, 
-        PRIORITY_REGEXP
+        PRIORITY_REGEXP,
+        DATE_REGEXP,
+        TAGS_REGEXP
       ]
   
       # Parses a context in the format @Context or @[Spaced Context]
@@ -48,9 +55,25 @@ module Toodledo
         return match_data if (match_data == nil)    
         return strip_brackets(match_data[1])
       end
+      
+      # Parses a date in the format #[2011-03-17]
+      def parse_date(input)
+        match_data = DATE_REGEXP.match(input)
+        return match_data if (match_data == nil)    
+        return strip_brackets(match_data[1])
+      end
+      
+      # Parses a list of tags in the format %[tag1 tag2 tag3]
+      # TODO Allow %tag1, tag2, tag3 ? (This is the format Toodledo's Twitter client uses)
+      def parse_tag(input)
+        match_data = TAGS_REGEXP.match(input)
+        return match_data if (match_data == nil)    
+        return strip_brackets(match_data[1]).split(/\s+/)
+      end
   
       # Parses priority in the format !priority (top, high, medium, low,
       # negative)
+      # TODO Refactor using data-driven design
       def parse_priority(input)
         match_data = PRIORITY_REGEXP.match(input)
         if (match_data == nil)

data/lib/toodledo/command_line/task_formatter.rb

@@ -1,151 +1,175 @@
-
-module Toodledo
-  module CommandLine    
-    class TaskFormatter
-      
-      # Formats the task for a command line.
-      def format(task)
-        fancyp = '!' + readable_priority(task.priority)
-  
-        msg = "<#{task.server_id}> -- #{fancyp}"
-  
-        if (task.folder != Folder::NO_FOLDER)
-          msg += " *[#{task.folder.name}]"
-        end
-  
-        if (task.context != Context::NO_CONTEXT)
-          msg += " @[#{task.context.name}]"
-        end
-  
-        if (task.goal != Goal::NO_GOAL)
-          msg += " ^[#{task.goal.name}]"
-        end
-  
-        if (task.repeat != Repeat::NONE)
-          msg += " repeat[#{readable_repeat(task.repeat)}]"
-        end
-  
-        if (task.duedate != nil)
-          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}]"
-        end
-        
-        if (task.parent_id != nil)
-          msg += " parent[#{task.parent.title}]"
-        end
-  
-        if (task.length != nil)
-          msg += " length[#{task.length}]"
-        end
-        
-        if (task.timer != nil)
-          msg += " timer[#{task.timer}]"
-        end
-        
-        if (task.num_children != nil && task.num_children > 0)
-          msg += " children[#{task.num_children}]"
-        end
-        
-        msg += " #{task.title}"
-              
-        if (task.note != nil)
-          msg += "\n      #{task.note}"
-        end
-  
-        return msg
-      end
-      
-      def readable_priority(priority)
-        case priority
-          when Priority::TOP
-            return 'top'
-          when Priority::HIGH
-            return 'high'
-          when Priority::MEDIUM
-            return 'medium'
-          when Priority::LOW
-            return 'low'
-          when Priority::NEGATIVE
-            return 'negative'
-          else
-            return ''
-        end
-      end
-      
-      #
-      # Returns a string matching the numeric repeat code.
-      #
-      def readable_repeat(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
-      
-      #
-      # 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
+
+module Toodledo
+  module CommandLine    
+    class TaskFormatter
+
+      DUEDATE_BY = 0
+      DUEDATE_ON = 1
+      DUEDATE_AFTER = 2
+      DUEDATE_OPTIONALLY = 3
+
+      # Formats the task for a command line.
+      def format(task)
+        fancyp = '!' + readable_priority(task.priority)
+  
+        msg = "<#{task.server_id}> -- #{fancyp}"
+  
+        # TODO Only include [ ] if needed
+        if (task.folder != Folder::NO_FOLDER)
+          msg += " *[#{task.folder.name}]"
+        end
+  
+        if (task.context != Context::NO_CONTEXT)
+          msg += " @[#{task.context.name}]"
+        end
+  
+        if (task.goal != Goal::NO_GOAL)
+          msg += " ^[#{task.goal.name}]"
+        end
+  
+        if (task.repeat != Repeat::NONE)
+          msg += " repeat[#{readable_repeat(task.repeat)}]"
+        end
+  
+        if (task.duedate != nil)
+          fmt = '%m/%d/%Y %I:%M %p'
+          msg += " #[#{readable_duedatemodifier(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 += " %[#{task.tag}]"
+        end
+        
+        if (task.parent_id != nil)
+          msg += " parent[#{task.parent.title}]"
+        end
+  
+        if (task.length != nil)
+          msg += " length[#{task.length}]"
+        end
+        
+        if (task.timer != nil)
+          msg += " timer[#{task.timer}]"
+        end
+        
+        if (task.num_children != nil && task.num_children > 0)
+          msg += " children[#{task.num_children}]"
+        end
+        
+        msg += " #{task.title}"
+              
+        if (task.note != nil)
+          msg += "\n      #{task.note}"
+        end
+  
+        return msg
+      end
+      
+      # TODO Refactor using symbols -- so much simpler to convert
+      def readable_priority(priority)
+        case priority
+          when Priority::TOP
+            return 'top'
+          when Priority::HIGH
+            return 'high'
+          when Priority::MEDIUM
+            return 'medium'
+          when Priority::LOW
+            return 'low'
+          when Priority::NEGATIVE
+            return 'negative'
+          else
+            return ''
+        end
+      end
+
+      def readable_duedatemodifier(duedate_modifier)
+        # The modifier is passed in as [0..3] but may come back as
+        # <duedate modifier='?'>2011-06-30</duedate>
+        case duedate_modifier
+          when DUEDATE_BY then
+            return ''
+          when DUEDATE_ON then
+            return '='
+          when DUEDATE_AFTER then
+            return '>'
+          when DUEDATE_OPTIONALLY then
+            return '?'
+          else
+            return duedate_modifier
+        end
+      end
+      
+      #
+      # Returns a string matching the numeric repeat code.
+      #
+      def readable_repeat(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
+      
+      #
+      # 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/priority.rb

@@ -3,6 +3,7 @@ module Toodledo
   #
   # A priority enum.
   #
+  # TODO Refactor using symbols?
   class Priority
     
     NEGATIVE = -1

data/lib/toodledo/repeat.rb

@@ -4,6 +4,7 @@
 module Toodledo
   class Repeat
     
+    # TODO Refactor
     NONE = 0
     WEEKLY = 1
     MONTHLY = 2
@@ -32,6 +33,7 @@ module Toodledo
       REPEAT_ARRAY.each{|value| yield(value)}
     end
     
+    # TODO replace with include?
     def self.valid?(input)
       for repeat in REPEAT_ARRAY
         if (repeat == input) 

data/lib/toodledo/server_error.rb

@@ -8,10 +8,27 @@ module Toodledo
   
   end
   
+  #
+  # Thrown when a call to a server returns 'Invalid ID number'
+  #
+  class ItemNotFoundError < ServerError
+  
+  end
+  
   # Thrown when the key is invalid (usually because we're using an old key or 
   # the expiration timed out for some reason)
   class InvalidKeyError < ServerError
     
   end
   
+  # Thrown when no key is specified at all.
+  class NoKeySpecifiedError < ServerError
+    
+  end
+  
+  # Thrown when too many requests have been made.
+  class ExcessiveTokenRequestsError < ServerError
+    
+  end
+  
 end

data/lib/toodledo/session.rb

@@ -17,6 +17,11 @@ module Toodledo
   #
   class Session
     
+    INVALID_ID_MESSAGE = 'Invalid ID number'
+    INVALID_KEY_MESSAGE = 'key did not validate'
+    NO_KEY_SPECIFIED_MESSAGE = 'No Key Specified'
+    EXCESSIVE_TOKEN_MESSAGE = 'Excessive API token requests over the last 1 hour.  This user is temporarily blocked.'
+
     DEFAULT_API_URL = 'http://www.toodledo.com/api.php'
 
     USER_AGENT = "Ruby/#{Toodledo::VERSION} (#{RUBY_PLATFORM})"
@@ -27,8 +32,8 @@ module Toodledo
       'Keep-Alive' => '300'
     }
     
-    # Make it a little less than 4 hours, so the file should always be fresher.
-    FILE_EXPIRATION_TIME_IN_SECS = (60 * 60 * 4) - 300
+    # Make file expiration be 4 hours.
+    FILE_EXPIRATION_TIME_IN_SECS = (60 * 60 * 4)
 
     DATE_FORMAT = '%Y-%m-%d'
     
@@ -67,7 +72,7 @@ module Toodledo
       return Digest::MD5.hexdigest(input_string)
     end
     
-    # Connects to the server, asking for a new key that's good for an hour.
+    # Connects to the server, asking for a new key that's good for four hours.
     # Optionally takes a base URL as a parameter.  Defaults to DEFAULT_API_URL.
     def connect(base_url = DEFAULT_API_URL, proxy = nil)
       logger.debug("connect(#{base_url}, #{proxy.inspect})") if logger
@@ -105,10 +110,12 @@ module Toodledo
     def disconnect()
       logger.debug("disconnect()") if logger
       
-      token_path = get_token_file(user_id)
-      if token_path
-        logger.debug("deleting token path()") if logger        
-        File.delete(token_path)
+      if expired?
+        token_path = get_token_file(user_id)
+        if token_path
+          logger.debug("deleting token path(#{token_path})") if logger
+          File.delete(token_path)
+        end
       end
       
       @key = nil
@@ -126,10 +133,11 @@ module Toodledo
 
     # Returns true if the session has expired.
     def expired?
+      logger.debug("Expiration time #{@expiration_time} ") if logger
       current_time = Time.now
       has_expired = (@expiration_time != nil) && (current_time > @expiration_time)
       if (has_expired) 
-        logger.debug("#{@expiration_time} > #{current_time}, expired == true") if logger
+        logger.debug("Expiration time #{@expiration_time} > current time #{current_time}, expired == true") if logger
       end
       has_expired
     end
@@ -240,21 +248,22 @@ module Toodledo
       if (root_node.name == 'error')
         error_text = root_node.text        
         case error_text
-        when 'Invalid ID number' then
+        when INVALID_ID_MESSAGE then
           raise Toodledo::ItemNotFoundError.new(error_text)
-        when 'key did not validate', 'No Key Specified' then 
-          retry_error = true    
+        when INVALID_KEY_MESSAGE then
+          disconnect()
+          raise Toodledo::InvalidKeyError.new(error_text)    
+        when NO_KEY_SPECIFIED_MESSAGE then
+          disconnect()
+          raise Toodledo::NoKeySpecifiedError.new(error_text)              
+        when EXCESSIVE_TOKEN_MESSAGE
+          disconnect()
+          raise Toodledo::ExcessiveTokenRequestsError.new(error_text)
         else
           raise Toodledo::ServerError.new(error_text)
         end
       end
       
-      if (retry_error)
-        logger.debug("call(#{method}): invalid key, reconnecting") if logger
-        reconnect(@base_url, @proxy);
-        root_node = call(method, params);
-      end
-      
       return root_node
     end
 
@@ -462,11 +471,14 @@ module Toodledo
     # * star
     # * status
     # * startdate
+    # * tag
     #
     # Returns an array of tasks.  This information is never cached.
     def get_tasks(params={})
       logger.debug("get_tasks(#{params.inspect})") if logger
       myhash = {}
+      
+      # TODO Very repetitious. Refactor
     
       # * title : A text string up to 255 characters.
       handle_string(myhash, params, :title)
@@ -548,6 +560,8 @@ module Toodledo
       # * 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)
+      
+      handle_tag(myhash, params)
     
       result = call('getTasks', myhash, @key)
       tasks = []
@@ -587,6 +601,7 @@ module Toodledo
     #         :bimonthly, :semiannually, :quarterly }
     #   length: a Number, number of minutes
     #   priority: one of { :negative, :low, :medium, :high, :top }
+    #   tag: an Array of strings
     #
     # Returns: the id of the added task as a String.
     def add_task(title, params={})
@@ -625,6 +640,8 @@ module Toodledo
       # priority use the map to change from the symbol to the raw numeric value.
       handle_priority(myhash, params)
       
+      handle_tag(myhash, params)
+      
       # Handle the star.
       handle_boolean(myhash, params, :star)
 
@@ -653,6 +670,7 @@ module Toodledo
     # * length : An integer representing the number of minutes that the task will take to complete.
     # * priority : Use the PRIORITY_MAP with the relevant symbol here.
     # * note : A text string.  
+    # * tag: An Array of Strings (tags)
     def edit_task(id, params = {})
       logger.debug("edit_task(#{id}, #{params.inspect})") if logger
       raise "Nil id" if (id == nil)
@@ -691,6 +709,8 @@ module Toodledo
 
       # priority use the map to change from the symbol to the raw numeric value.
       handle_priority(myhash, params)
+      
+      handle_tag(myhash, params)
   
       handle_string(myhash, params, :note)
     
@@ -1075,7 +1095,7 @@ module Toodledo
     def handle_number(myhash, params, symbol)
       value = params[symbol]
       if (value != nil)
-        if (value.kind_of? FixNum)
+        if (value.kind_of? Integer)
           myhash.merge!({ symbol => value.to_s})
         end
       end        
@@ -1122,6 +1142,21 @@ module Toodledo
       myhash.merge!({ symbol => value }) 
     end
   
+
+    def handle_tag(myhash, params)
+      value = params[:tag]
+      if (value == nil)
+        return
+      end
+    
+      case value
+      when Array
+        value = value.join(' ')   
+      end
+    
+      myhash.merge!({ :tag => value }) 
+    end
+  
     def handle_time(myhash, params, symbol)      
       value = params[symbol]
       if (value == nil)