rtmapi 0.5.2 → 0.6

data/README

@@ -143,6 +143,17 @@ But this will allow you to add special functionality to tasks
 like).  If there is interest, we can do the same thing for 
 groups, lists, etc etc.
 
+RememberTheMilkTask also has a number of helper methods, so you can
+do this:
+
+task = @rtm.tasks.getList.values[0].values[0]  # grabs 1st task off of first list returned by API
+modified_task = task.setTags "tag1,tag2"
+modified_task_2 = modified_task.addTags "tag3"
+modified_task.tags => ['tag1','tag2']
+modified_task_2.tags => ['tag1','tag2', 'tag3']
+
+all the methods for rtm.tasks.* have helper methods defined (except for getList)
+
 Dates
 -----
 

data/lib/rtmapi.rb

@@ -31,7 +31,7 @@ require 'xml/libxml'
 #TODO:  allow specifying whether retval should be indexed by rtm_id or list name for lists
 
 class RememberTheMilk
-  RUBY_API_VERSION = '0.5'
+  RUBY_API_VERSION = '0.6'
   # you can just put set these here so you don't have to pass them in with 
   # every constructor call
   API_KEY = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
@@ -59,8 +59,12 @@ class RememberTheMilk
     @user_settings_cache[auth_token]
   end
   
+  def get_timeline
+    user[:timeline] ||= timelines.create
+  end
+  
   def time_to_user_tz( time )
-    return time unless(@use_user_tz && @auth_token && defined?(TZInfo::Timezone.get))
+    return time unless(@use_user_tz && @auth_token && defined?(TZInfo::Timezone))
     begin
       unless defined?(@user_settings_cache[auth_token]) && defined?(@user_settings_cache[auth_token][:tz])
         @user_settings_cache[auth_token] = settings.getList
@@ -296,7 +300,7 @@ class RememberTheMilk
     tasks = RememberTheMilkHash.new
 
     list.each do |taskseries_as_hash|
-      taskseries = RememberTheMilkTask.new.merge(taskseries_as_hash)
+      taskseries = RememberTheMilkTask.new(self).merge(taskseries_as_hash)
 
       taskseries[:parent_list] = list_id  # parent pointers are nice
       taskseries[:tasks] = taskseries.arrayify_value(:task)
@@ -489,109 +493,223 @@ class RememberTheMilkHash < Hash
 end
 
 
+## TODO -- better rrule support.  start here with this code, commented out for now
 ## DateSet is to manage rrules
 ## this comes from the iCal ruby module as mentioned here:
 ## http://www.macdevcenter.com/pub/a/mac/2003/09/03/rubycocoa.html
 
-class DateSet
-    
-    def initialize(startDate, rule)
-        @startDate = startDate
-        @frequency = nil
-        @count = nil
-        @untilDate = nil
-        @byMonth = nil
-        @byDay = nil
-        @starts = nil
-        if not rule.nil? then
-          @starts = rule.every == 1 ? 'every' : 'after'
-          parseRecurrenceRule(rule.rule)
-        end
-    end
-    
-    def parseRecurrenceRule(rule)
-      
-        if rule =~ /FREQ=(.*?);/ then
-            @frequency = $1
-        end
-        
-        if rule =~ /COUNT=(\d*)/ then
-            @count = $1.to_i
-        end
-        
-        if rule =~ /UNTIL=(.*?)[;\r]/ then
-            @untilDate = DateParser.parse($1)
-        end
-        
-        if rule =~ /INTERVAL=(\d*)/ then
-            @interval = $1.to_i
-        end
+# The API is aware it's creating tasks.  You may want to add semantics to a "task"
+# elsewhere in your program.  This gives you that flexibility
+# plus, we've added some helper methods
 
-        if rule =~ /BYMONTH=(.*?);/ then
-            @byMonth = $1
-        end
+class RememberTheMilkTask < RememberTheMilkHash
+  attr_accessor :rtm
+  
+  def timeline
+    @timeline ||= rtm.get_timeline  # this caches timelines per user
+  end
 
-        if rule =~ /BYDAY=(.*?);/ then
-            @byDay = $1
-            #puts "byDay = #{@byDay}"
-        end
+  def initialize( rtm_api_handle=nil )
+    super
+    @rtm = rtm_api_handle   # keep track of this so we can do setters (see factory below)
+  end
+  
+  def task() tasks[-1] end
+  def taskseries_id() rtm_id end
+  def task_id() task.rtm_id end
+  def list_id() parent_list end
+  def due() task.due  end
+
+  def has_due?()      due.class == Time                end
+  def has_due_time?() task.has_due_time == '1'         end
+  def complete?()     task[:completed] != ''          end
+  def to_s
+    "#{parent_list}/#{taskseries_id}/#{task_id}: #{name}"
+  end
+
+  def due_display
+    if has_due? 
+      if has_due_time?
+        due.strftime("%a %d %b %y at %I:%M%p")
+      else
+        due.strftime("%a %d %b %y")
+      end
+    else 
+      '[no due date]'
     end
-    
-    def to_s
-      # after/every  FREQ
-         puts "UNIMPLETEMENT"
-#        puts "#<DateSet: starts: #{@startDate.strftime("%m/%d/%Y")}, occurs: #{@frequency}, count: #{@count}, until: #{@untilDate}, byMonth: #{@byMonth}, byDay: #{@byDay}>"
+  end
+
+  @@BeginningOfEpoch = Time.parse("Jan 1 1904") # kludgey.. sure.  life's a kludge. deal with it.
+  include Comparable
+  def <=>(other)
+    due = (has_key?(:tasks) && tasks.class == Array) ? task[:due] : nil
+    due = @@BeginningOfEpoch unless due.class == Time
+    other_due = (other.has_key?(:tasks) && other.tasks.class == Array) ? other.task[:due] : nil
+    other_due = @@BeginningOfEpoch unless other_due.class == Time
+
+    # sort based on due date, then priority, then name
+    # if 0 was false in ruby, we could have done
+    # prio <=> other_due || due <=> other_due || self['name'].to_s <=> other['name'].to_s
+    # but it's not, so oh well....
+    prio = priority.to_i
+    prio += 666 if prio == 0  # prio of 0 is no priority which means it should show up below 1-3
+    other_prio = other.priority.to_i
+    other_prio += 666 if other_prio == 0
+
+    if prio != other_prio
+      return prio <=> other_prio
+    elsif due != other_due
+      return due <=> other_due
+    else 
+      # TODO: should this be case insensitive?  
+      return self[:name].to_s <=> other[:name].to_s
     end
-    
-    def includes?(date)
-        return true if date == @startDate
-        return false if @untilDate and date > @untilDate
-        
-        case @frequency
-            when 'DAILY'
-                #if @untilDate then
-                #   return (@startDate..@untilDate).include?(date)
-                #end
-                increment = @interval ? @interval : 1
-                d = @startDate
-                counter = 0
-                until d > date
-                    
-                    if @count then
-                        counter += 1
-                        if counter >= @count
-                            return false
-                        end
-                    end
-
-                    d += (increment * SECONDS_PER_DAY)
-                    if  d.day == date.day and 
-                        d.year == date.year and 
-                        d.month == date.month then
-                        puts "true for start: #{@startDate}, until: #{@untilDate}"
-                        return true
-                    end
-
-                end
-                
-            when 'WEEKLY'
-                return true if @startDate.wday == date.wday
-                
-            when 'MONTHLY'
-                
-            when 'YEARLY'
+  end
+  
+  # Factory Methods... 
+  # these are for methods that take arguments and apply to the taskseries
+  # if you have RememberTheMilkTask called task, you might do:
+  #  task.addTags( 'tag1, tag2, tag3' )
+  #  task.setRecurrence   # turns off all rrules
+  #  task.complete  # marks last task as complete
+  #  task.setDueDate # unsets due date for last task
+  #  task.setDueDate( nil, :task_id => task.tasks[0].id )  # unsets due date for first task in task array
+  #  task.setDueDate( "tomorrow at 1pm", :parse => 1 )  # sets due date for last task to tomorrow at 1pm
+  [['addTags','tags'], ['setTags', 'tags'], ['removeTags', 'tags'], ['setName', 'name'],
+   ['setRecurrence', 'repeat'], ['complete', ''], ['uncomplete', ''], ['setDueDate', 'due'], 
+    ['setPriority', 'priority'], ['movePriority', 'direction'], ['setEstimate', 'estimate'],
+    ['setURL', 'url'], ['postpone', ''], ['delete', ''] ].each do |method_name, arg|
+      class_eval <<-RTM_METHOD
+     def #{method_name} ( value=nil, args={} )
+       if @rtm == nil
+        raise RememberTheMilkAPIError.new( :code => '667', :msg => "#{method_name} called without a handle to an rtm object [#{self.to_s}]" )
+       end
+       method_args = {}
+       method_args["#{arg}"] = value if "#{arg}" != '' && value
+       method_args[:timeline] = timeline
+       method_args[:list_id] = list_id
+       method_args[:taskseries_id] = taskseries_id
+       method_args[:task_id] = task_id
+       method_args.merge!( args )
+       @rtm.call_api_method( "tasks.#{method_name}", method_args )  # returns the modified task
+     end
+     RTM_METHOD
+  end
 
-        end
-        
-        false
+  # We have to do this because moveTo takes a "from_list_id", not "list_id", so the above factory
+  #  wouldn't work.  sigh.
+  def moveTo( to_list_id, args = {} )
+    if @rtm == nil
+      raise RememberTheMilkAPIError.new( :code => '667', :msg => "moveTO called without a handle to an rtm object [#{self.to_s}]" )
     end
-    
-    attr_reader :frequency  
-    attr_accessor :startDate
+    method_args = {}
+    method_args[:timeline] = timeline
+    method_args[:from_list_id] = list_id
+    method_args[:to_list_id] = to_list_id
+    method_args[:taskseries_id] = taskseries_id
+    method_args[:task_id] = task_id
+    method_args.merge( args )
+    @rtm.call_api_method( :moveTo, method_args )
+  end
+
 end
 
 
-class RememberTheMilkTask < RememberTheMilkHash
-  # The API is aware it's creating tasks.  You may want to add semantics to a "task"
-  # elsewhere in your program.  This gives you that flexibility
-end
+# 
+# class DateSet
+#     
+#     def initialize(startDate, rule)
+#         @startDate = startDate
+#         @frequency = nil
+#         @count = nil
+#         @untilDate = nil
+#         @byMonth = nil
+#         @byDay = nil
+#         @starts = nil
+#         if not rule.nil? then
+#           @starts = rule.every == 1 ? 'every' : 'after'
+#           parseRecurrenceRule(rule.rule)
+#         end
+#     end
+#     
+#     def parseRecurrenceRule(rule)
+#       
+#         if rule =~ /FREQ=(.*?);/ then
+#             @frequency = $1
+#         end
+#         
+#         if rule =~ /COUNT=(\d*)/ then
+#             @count = $1.to_i
+#         end
+#         
+#         if rule =~ /UNTIL=(.*?)[;\r]/ then
+#             @untilDate = DateParser.parse($1)
+#         end
+#         
+#         if rule =~ /INTERVAL=(\d*)/ then
+#             @interval = $1.to_i
+#         end
+# 
+#         if rule =~ /BYMONTH=(.*?);/ then
+#             @byMonth = $1
+#         end
+# 
+#         if rule =~ /BYDAY=(.*?);/ then
+#             @byDay = $1
+#             #puts "byDay = #{@byDay}"
+#         end
+#     end
+#     
+#     def to_s
+#       # after/every  FREQ
+#          puts "UNIMPLETEMENT"
+# #        puts "#<DateSet: starts: #{@startDate.strftime("%m/%d/%Y")}, occurs: #{@frequency}, count: #{@count}, until: #{@untilDate}, byMonth: #{@byMonth}, byDay: #{@byDay}>"
+#     end
+#     
+#     def includes?(date)
+#         return true if date == @startDate
+#         return false if @untilDate and date > @untilDate
+#         
+#         case @frequency
+#             when 'DAILY'
+#                 #if @untilDate then
+#                 #   return (@startDate..@untilDate).include?(date)
+#                 #end
+#                 increment = @interval ? @interval : 1
+#                 d = @startDate
+#                 counter = 0
+#                 until d > date
+#                     
+#                     if @count then
+#                         counter += 1
+#                         if counter >= @count
+#                             return false
+#                         end
+#                     end
+# 
+#                     d += (increment * SECONDS_PER_DAY)
+#                     if  d.day == date.day and 
+#                         d.year == date.year and 
+#                         d.month == date.month then
+#                         puts "true for start: #{@startDate}, until: #{@untilDate}"
+#                         return true
+#                     end
+# 
+#                 end
+#                 
+#             when 'WEEKLY'
+#                 return true if @startDate.wday == date.wday
+#                 
+#             when 'MONTHLY'
+#                 
+#             when 'YEARLY'
+# 
+#         end
+#         
+#         false
+#     end
+#     
+#     attr_reader :frequency  
+#     attr_accessor :startDate
+# end
+# 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: rtmapi
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: "0.6"
 date: 2007-02-01 00:00:00 -05:00
 summary: Simple library for interfacing with rememberthemilk.com.
 require_paths: