gcal4ruby 0.2.11 → 0.3.0

data/CHANGELOG

@@ -1,4 +1,9 @@
 #=CHANGELOG
+#==version 0.3.0
+#* Rewrote Event.find to improve performance significantly.
+#* Added improvements to event recurrence handling, including loading existing recurrences, changing recurring events to non recurring and vice versa.
+#* Added support for initialization attributes to Event, Calendar, Service and Recurrence.
+#* Fixed query string typo in Event.find.  Fix provided by nat.lownes.
 #==version 0.2.11
 #* Added support for GML elements in calendar events.  Fix provided by nat.lownes.
 #* Fixed event status bug where cancelled events were marked confirmed.  Fix provided by rifraf.

data/lib/gcal4ruby/calendar.rb

@@ -116,24 +116,26 @@ class Calendar
     #end
   end
 
-  #Accepts a Service object.  Returns the new Calendar if successful, otherwise raises the InvalidService
-  #error.
-  def initialize(service)
+  #Accepts a Service object and an optional attributes hash for initialization.  Returns the new Calendar 
+  #if successful, otherwise raises the InvalidService error.
+  def initialize(service, attributes = {})
     super()
     if !service.is_a?(Service)
       raise InvalidService
     end
-    @xml = CALENDAR_XML
-    @service = service
+    attributes.each do |key, value|
+      self.send("#{key}=", value)
+    end
+    @xml ||= CALENDAR_XML
+    @service ||= service
     @exists = false
-    @title = ""
-    @summary = ""
-    @public = false
-    @id = nil
-    @hidden = false
-    @timezone = "America/Los_Angeles"
-    @color = "#2952A3"
-    @where = ""
+    @title ||= ""
+    @summary ||= ""
+    @public ||= false
+    @hidden ||= false
+    @timezone ||= "America/Los_Angeles"
+    @color ||= "#2952A3"
+    @where ||= ""
     return true
   end
   

data/lib/gcal4ruby/event.rb

@@ -115,8 +115,8 @@ module GCal4Ruby
     #Sets the event's recurrence information to a Recurrence object.  Returns the recurrence if successful,
     #false otherwise
     def recurrence=(r)
-      if r.is_a?(Recurrence)
-        r.event = self
+      if r.is_a?(Recurrence) or r.nil?
+        r.event = self unless r.nil?
         @recurrence = r
       else
         return false
@@ -178,24 +178,21 @@ module GCal4Ruby
         end
     end
     
-    #Creates a new Event.  Accepts a valid Calendar object.
-    def initialize(calendar)
+    #Creates a new Event.  Accepts a valid Calendar object and optional attributes hash.
+    def initialize(calendar, attributes = {})
       if not calendar.editable
         raise CalendarNotEditable
       end
       super()
-      @xml = EVENT_XML
-      @calendar = calendar
-      @title = nil
-      @content = nil
-      @start = nil
-      @end = nil
-      @where = nil
-      @transparency = "http://schemas.google.com/g/2005#event.opaque"
-      @status = "http://schemas.google.com/g/2005#event.confirmed"
-      @attendees = []
-      @reminder = nil
-      @all_day = false
+      attributes.each do |key, value|
+        self.send("#{key}=", value)
+      end
+      @xml ||= EVENT_XML
+      @calendar ||= calendar
+      @transparency ||= "http://schemas.google.com/g/2005#event.opaque"
+      @status ||= "http://schemas.google.com/g/2005#event.confirmed"
+      @attendees ||= []
+      @all_day ||= false
     end
     
     #If the event does not exist on the Google Calendar service, save creates it.  Otherwise
@@ -268,6 +265,19 @@ module GCal4Ruby
             end
         when "where"
           ele.attributes["valueString"] = @where
+        when "recurrence"
+          puts 'recurrence element found' if @calendar.service.debug
+          if @recurrence
+            puts 'setting recurrence' if @calendar.service.debug
+            ele.text = @recurrence.to_s
+          else
+            puts 'no recurrence, adding when' if @calendar.service.debug
+            w = xml.root.add_element("gd:when")
+            xml.root.delete_element("/entry/gd:recurrence")
+            w.attributes["startTime"] = @all_day ? @start.strftime("%Y-%m-%d") : @start.xmlschema
+            w.attributes["endTime"] = @all_day ? @end.strftime("%Y-%m-%d") : @end.xmlschema
+            set_reminder(w)
+          end
         end
       end        
       if not @attendees.empty?
@@ -332,6 +342,8 @@ module GCal4Ruby
                 when "http://schemas.google.com/g/2005#event.cancelled"
                   @status = :cancelled
               end
+            when 'recurrence'
+              @recurrence = Recurrence.new(ele.text)
             when "transparency"
                case ele.attributes["value"]
                   when "http://schemas.google.com/g/2005#event.transparent" 
@@ -380,18 +392,18 @@ module GCal4Ruby
       
       if test
         puts "id passed, finding event by id" if calendar.service.debug
-        es = calendar.service.send_get("http://www.google.com/calendar/feeds/#{calendar.id}/private/full?max-results=1000000")
-        REXML::Document.new(es.read_body).root.elements.each("entry"){}.map do |entry|
-          puts "element = "+entry.name if calendar.service.debug
-          id = ''
-          entry.elements.each("id") {|v| id = v.text}
-          puts "id = #{id}" if calendar.service.debug
-          if id == query
-            Event.define_xml_namespaces(entry)
-            event = Event.new(calendar)
-            event.load("<?xml version='1.0' encoding='UTF-8'?>#{entry.to_s}")
-            return event
-          end
+        #ugly, but Google doesn't return the self url as ID as described in the API reference http://code.google.com/apis/calendar/data/2.0/developers_guide_protocol.html#RetrievingEvents
+        event_id = query.gsub("http://www.google.com/calendar/feeds/#{CGI::escape(calendar.service.account)}/events/", 
+                              "http://www.google.com/calendar/feeds/#{CGI::escape(calendar.service.account)}/private/full/")
+        es = calendar.service.send_get(event_id)
+        puts es.inspect if calendar.service.debug
+        if es
+          entry = REXML::Document.new(es.read_body).root
+          puts 'event found' if calendar.service.debug
+          Event.define_xml_namespaces(entry)
+          event = Event.new(calendar)
+          event.load("<?xml version='1.0' encoding='UTF-8'?>#{entry.to_s}")
+          return event
         end
         return nil
       end
@@ -420,7 +432,7 @@ module GCal4Ruby
       query_string += "&max-results=#{max_results}" if max_results
       query_string += "&sortorder=#{sort_order}" if sort_order
       query_string += "&ctz=#{timezone.gsub(" ", "_")}" if timezone
-      query_string += "&singleevents#{single_events}" if single_events
+      query_string += "&singleevents=#{single_events}" if single_events
       if query_string
         events = calendar.service.send_get("http://www.google.com/calendar/feeds/#{calendar.id}/private/full?"+query_string)
         ret = []

data/lib/gcal4ruby/recurrence.rb

@@ -3,6 +3,11 @@ class Time
   def complete
     self.utc.strftime("%Y%m%dT%H%M%S")
   end
+  
+  def self.parse_complete(value)
+    d, h = value.split("T")
+    return Time.parse(d+" "+h.gsub("Z", ""))
+  end
 end
 
 module GCal4Ruby
@@ -22,15 +27,59 @@ module GCal4Ruby
     #True if the event is all day (i.e. no start/end time)
     attr_accessor :all_day
     
-    #Returns a new Recurrence object
-    def initialize
-      @start = nil
-      @end = nil
-      @event = nil
-      @day_of_week = nil
-      @repeat_until = nil
-      @frequency = nil
-      @all_day = false
+    #Accepts an optional attributes hash or a string containing a properly formatted ISO 8601 recurrence rule.  Returns a new Recurrence object
+    def initialize(vars = {})
+      if vars.is_a? Hash
+        vars.each do |key, value|
+          self.send("#{key}=", value)
+        end
+      elsif vars.is_a? String
+        self.load(vars)
+      end
+      @all_day ||= false
+    end
+    
+    #Accepts a string containing a properly formatted ISO 8601 recurrence rule and loads it into the recurrence object
+    def load(rec)
+      attrs = rec.split("\n")
+      attrs.each do |val|
+        key, value = val.split(":")
+        case key
+          when 'DTSTART'
+            @start = Time.parse_complete(value)
+          when 'DTSTART;VALUE=DATE'
+            @start = Time.parse(value)
+            @all_day = true
+          when 'DTSTART;VALUE=DATE-TIME'
+            @start = Time.parse_complete(value)
+          when 'DTEND'
+            @end = Time.parse_complete(value)
+          when 'DTEND;VALUE=DATE'
+            @end = Time.parse(value)
+          when 'DTEND;VALUE=DATE-TIME'
+            @end = Time.parse_complete(value)
+          when 'RRULE'
+            vals = value.split(";")
+            key = ''
+            by = ''
+            int = nil
+            vals.each do |rr|
+              a, h = rr.split("=")
+              case a 
+                when 'FREQ'
+                  key = h.downcase.capitalize
+                when 'INTERVAL'
+                  int = h
+                when 'UNTIL'
+                  @repeat_until = Time.parse(value)
+                else
+                  by = h.split(",")
+              end
+            end
+            @frequency = {key => by}
+            @frequency.merge({'interval' => int}) if int
+        end
+      end
     end
     
     #Returns a string with the correctly formatted ISO 8601 recurrence rule
@@ -75,7 +124,7 @@ module GCal4Ruby
             when "monthly"
               by += "BYDAY=#{value};"
             when "yearly"
-              by += "BYYEARDAY=#{value}"
+              by += "BYYEARDAY=#{value};"
             when 'interval'
               i += "INTERVAL=#{value};"
           end
@@ -83,7 +132,7 @@ module GCal4Ruby
         output += f+i+by
       end      
       if @repeat_until
-        output += ";UNTIL=#{@repeat_until.strftime("%Y%m%d")}"
+        output += "UNTIL=#{@repeat_until.strftime("%Y%m%d")}"
       end
       
       output += "\n"
@@ -136,7 +185,7 @@ module GCal4Ruby
     #- *Monthly*: A value of a positive or negative integer (i.e. +1) prepended to a day-of-week string ('TU') to indicate the position of the day within the month.  E.g. +1TU would be the first tuesday of the month.
     #- *Yearly*: A value of 1 to 366 indicating the day of the year.  May be negative to indicate counting down from the last day of the year.
     #
-    #Optionally, you may specific a second hash pair to set the internal the even repeats:
+    #Optionally, you may specific a second hash pair to set the interval the event repeats:
     #   "interval" => '2'
     #If the interval is missing, it is assumed to be 1.
     #

data/lib/gcal4ruby/service.rb

@@ -29,9 +29,13 @@ class Service < Base
   # adequate permissions
   attr_accessor :check_public
   
-  def initialize
-    super
-    @check_public = true
+  #Accepts an optional attributes hash for initialization values
+  def initialize(attributes = {})
+    super()
+    attributes.each do |key, value|
+      self.send("#{key}=", value)
+    end    
+    @check_public ||= true
   end
 
   # The authenticate method passes the username and password to google servers.  

data/test/unit.rb

@@ -23,6 +23,7 @@ def tester
   service_test
   calendar_test
   event_test
+  event_recurrence_test
 end
 
 def service_test
@@ -127,6 +128,44 @@ def event_test
   end
 end
 
+def event_recurrence_test
+  puts "---Starting Event Recurrence Test---"
+  
+  @first_start = Time.now
+  @first_end = Time.now+3600
+  @first_freq = {'weekly' => ['TU']}
+  @second_start = Time.now+86000
+  @second_end = Time.now+89600
+  @second_freq = {'weekly' => ['SA']}
+  
+  puts "1. Create Recurring Event"
+  event = Event.new(@service.calendars[0])
+  event.title = "Test Recurring Event"
+  event.content = "Test event content"
+  event.recurrence = Recurrence.new({:start => @first_start, :end => @first_end, :frequency => @first_freq})
+  if event.save 
+    successful event.to_xml
+  else
+    failed("recurrence = "+event.recurrence.to_s)
+  end
+  
+  puts "2. Edit Recurrence"
+  event.title = "Edited recurring title"
+  event.recurrence = Recurrence.new({:start => @second_start, :end => @second_end, :frequency => @second_freq})
+  if event.save 
+    successful event.to_xml
+  else
+    failed
+  end
+  
+  puts "3. Delete Event"
+  if event.delete
+    successful 
+  else
+    failed
+  end
+end
+
 def failed(m = nil)
   puts "Test Failed"
   puts m if m

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gcal4ruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.11
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mike Reich
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-23 00:00:00 +11:00
+date: 2010-01-25 00:00:00 +11:00
 default_executable: 
 dependencies: []