gcal4ruby 0.3.1 → 0.5.0

data/lib/gcal4ruby/recurrence.rb

@@ -1,3 +1,21 @@
+# Author:: Mike Reich (mike@seabourneconsulting.com)
+# Copyright:: Copyright (C) 2010 Mike Reich
+# License:: GPL v2
+#--
+# Licensed under the General Public License (GPL), Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+# Feel free to use and update, but be sure to contribute your
+# code back to the project and attribute as required by the license.
+#++
+
 class Time
   #Returns a ISO 8601 complete formatted string of the time
   def complete
@@ -15,9 +33,9 @@ module GCal4Ruby
   #the RFC 2445 iCalendar recurrence description.
   class Recurrence
     #The event start date/time
-    attr_reader :start
+    attr_reader :start_time
     #The event end date/time
-    attr_reader :end
+    attr_reader :end_time
     #the event reference
     attr_reader :event
     #The date until which the event will be repeated
@@ -46,18 +64,18 @@ module GCal4Ruby
         key, value = val.split(":")
         case key
           when 'DTSTART'
-            @start = Time.parse_complete(value)
+            @start_time = Time.parse_complete(value)
           when 'DTSTART;VALUE=DATE'
-            @start = Time.parse(value)
+            @start_time = Time.parse(value)
             @all_day = true
           when 'DTSTART;VALUE=DATE-TIME'
-            @start = Time.parse_complete(value)
+            @start_time = Time.parse_complete(value)
           when 'DTEND'
-            @end = Time.parse_complete(value)
+            @end_time = Time.parse_complete(value)
           when 'DTEND;VALUE=DATE'
-            @end = Time.parse(value)
+            @end_time = Time.parse(value)
           when 'DTEND;VALUE=DATE-TIME'
-            @end = Time.parse_complete(value)
+            @end_time = Time.parse_complete(value)
           when 'RRULE'
             vals = value.split(";")
             key = ''
@@ -82,19 +100,61 @@ module GCal4Ruby
       end
     end
     
-    #Returns a string with the correctly formatted ISO 8601 recurrence rule
     def to_s
+      output = ''
+      if @frequency
+        f = ''
+        i = ''
+        by = ''
+        @frequency.each do |key, v|
+          if v.is_a?(Array) 
+            if v.size > 0
+              value = v.join(",") 
+            else
+              value = nil
+            end
+          else
+            value = v
+          end
+          f += "#{key.downcase} " if key != 'interval'
+          case key.downcase
+            when "secondly"
+              by += "every #{value} second"
+            when "minutely"
+              by += "every #{value} minute"
+            when "hourly"
+              by += "every #{value} hour"
+            when "weekly"
+              by += "on #{value}" if value
+            when "monthly"
+              by += "on #{value}"
+            when "yearly"
+              by += "on the #{value} day of the year"
+            when 'interval'
+              i += "for #{value} times"
+          end
+        end
+        output += f+i+by
+      end      
+      if @repeat_until
+        output += " and repeats until #{@repeat_until.strftime("%m/%d/%Y")}"
+      end
+      output
+    end
+    
+    #Returns a string with the correctly formatted ISO 8601 recurrence rule
+    def to_recurrence_string
       
       output = ''
       if @all_day
-        output += "DTSTART;VALUE=DATE:#{@start.utc.strftime("%Y%m%d")}\n"
+        output += "DTSTART;VALUE=DATE:#{@start_time.utc.strftime("%Y%m%d")}\n"
       else
-        output += "DTSTART;VALUE=DATE-TIME:#{@start.complete}\n"
+        output += "DTSTART;VALUE=DATE-TIME:#{@start_time.complete}\n"
       end
       if @all_day
-        output += "DTEND;VALUE=DATE:#{@end.utc.strftime("%Y%m%d")}\n"
+        output += "DTEND;VALUE=DATE:#{@end_time.utc.strftime("%Y%m%d")}\n"
       else
-        output += "DTEND;VALUE=DATE-TIME:#{@end.complete}\n"
+        output += "DTEND;VALUE=DATE-TIME:#{@end_time.complete}\n"
       end
       output += "RRULE:"
       if @frequency
@@ -139,20 +199,20 @@ module GCal4Ruby
     end
     
     #Sets the start date/time.  Must be a Time object.
-    def start=(s)
+    def start_time=(s)
       if not s.is_a?(Time)
         raise RecurrenceValueError, "Start must be a date or a time"
       else
-        @start = s
+        @start_time = s
       end
     end
     
     #Sets the end Date/Time. Must be a Time object.
-    def end=(e)
+    def end_time=(e)
       if not e.is_a?(Time)
         raise RecurrenceValueError, "End must be a date or a time"
       else
-        @end = e
+        @end_time = e
       end
     end
     

data/lib/gcal4ruby/service.rb

@@ -1,155 +1,163 @@
-require 'gcal4ruby/base' 
-require 'gcal4ruby/calendar'
-
-module GCal4Ruby
-
-#The service class is the main handler for all direct interactions with the 
-#Google Calendar API.  A service represents a single user account.  Each user
-#account can have multiple calendars, so you'll need to find the calendar you
-#want from the service, using the Calendar#find class method.
-#=Usage
+# Author:: Mike Reich (mike@seabourneconsulting.com)
+# Copyright:: Copyright (C) 2010 Mike Reich
+# License:: GPL v2
+#--
+# Licensed under the General Public License (GPL), Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-#1. Authenticate
-#    service = Service.new
-#    service.authenticate("user@gmail.com", "password")
+#      http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
 #
-#2. Get Calendar List
-#    calendars = service.calendars
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #
+# Feel free to use and update, but be sure to contribute your
+# code back to the project and attribute as required by the license.
+#++
+require 'gdata4ruby'
+require 'gdata4ruby/gdata_object'
+require 'gdata4ruby/utils/utils'
+require 'gdata4ruby/acl/access_rule'
+require 'gcal4ruby/calendar'
+require 'gcal4ruby/event'
+require 'gcal4ruby/recurrence'
+require 'rexml/document'
 
-class Service < Base
-  #Convenience attribute contains the currently authenticated account name
-  attr_reader :account
-      
-  # The token returned by the Google servers, used to authorize all subsequent messages
-  attr_reader :auth_token
-  
-  # Determines whether GCal4Ruby ensures a calendar is public.  Setting this to false can increase speeds by 
-  # 50% but can cause errors if you try to do something to a calendar that is not public and you don't have
-  # adequate permissions
-  attr_accessor :check_public
-  
-  #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.  
-  # If authentication succeeds, returns true, otherwise raises the AuthenticationFailed error.
-  def authenticate(username, password)
-    ret = nil
-    ret = send_post(AUTH_URL, "Email=#{username}&Passwd=#{password}&source=GCal4Ruby&service=cl&accountType=HOSTED_OR_GOOGLE")
-    if ret.class == Net::HTTPOK
-      @auth_token = ret.read_body.to_a[2].gsub("Auth=", "").strip
-      @account = username
-      return true
-    else
-      raise AuthenticationFailed
+module GCal4Ruby
+  #The service class is the main handler for all direct interactions with the 
+  #Google Calendar API.  A service represents a single user account.  Each user
+  #account can have multiple calendars, so you'll need to find the calendar you
+  #want from the service, using the Calendar#find class method.
+  #=Usage
+  #
+  #1. Authenticate
+  #    service = Service.new
+  #    service.authenticate("user@gmail.com", "password")
+  #
+  #2. Get Calendar List
+  #    calendars = service.calendars
+  #
+  class Service < GData4Ruby::Service
+    CALENDAR_LIST_FEED = 'http://www.google.com/calendar/feeds/default/allcalendars/full'
+    
+    #Convenience attribute contains the currently authenticated account name
+    attr_reader :account
+        
+    # The token returned by the Google servers, used to authorize all subsequent messages
+    attr_reader :auth_token
+    
+    # Determines whether GCal4Ruby ensures a calendar is public.  Setting this to false can increase speeds by 
+    # 50% but can cause errors if you try to do something to a calendar that is not public and you don't have
+    # adequate permissions
+    attr_accessor :check_public
+    
+    #Accepts an optional attributes hash for initialization values
+    def initialize(attributes = {})
+      super(attributes)
+      attributes.each do |key, value|
+        self.send("#{key}=", value)
+      end    
+      @check_public ||= true
     end
-  end
-
-  #Returns an array of Calendar objects for each calendar associated with 
-  #the authenticated account.
-  def calendars
-    if not @auth_token
-       raise NotAuthenticated
+    
+    def default_event_feed
+      return "http://www.google.com/calendar/feeds/#{@account}/private/full"
     end
-    ret = send_get(CALENDAR_LIST_FEED+"?max-results=10000")
-    cals = []
-    REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
-      entry.attributes["xmlns:gCal"] = "http://schemas.google.com/gCal/2005"
-      entry.attributes["xmlns:gd"] = "http://schemas.google.com/g/2005"
-      entry.attributes["xmlns:app"] = "http://www.w3.org/2007/app"
-      entry.attributes["xmlns"] = "http://www.w3.org/2005/Atom"
-      cal = Calendar.new(self)
-      cal.load("<?xml version='1.0' encoding='UTF-8'?>#{entry.to_s}")
-      cals << cal
+  
+    # The authenticate method passes the username and password to google servers.  
+    # If authentication succeeds, returns true, otherwise raises the AuthenticationFailed error.
+    def authenticate(username, password, service='cl')
+      super(username, password, service)
+    end
+    
+    #Helper function to reauthenticate to a new Google service without having to re-set credentials.
+    def reauthenticate(service='cl')
+      authenticate(@account, @password, service)
     end
-    return cals
-  end
   
-  #Helper function to return a formatted iframe embedded google calendar.  Parameters are:
-  #1. *cals*: either an array of calendar ids, or <em>:all</em> for all calendars, or <em>:first</em> for the first (usally default) calendar
-  #2. *params*: a hash of parameters that affect the display of the embedded calendar:
-  #   height:: the height of the embedded calendar in pixels
-  #   width:: the width of the embedded calendar in pixels
-  #   title:: the title to display
-  #   bgcolor:: the background color.  Limited choices, see google docs for allowable values.
-  #   color:: the color of the calendar elements.  Limited choices, see google docs for allowable values.
-  #   showTitle:: set to 'false' to hide the title
-  #   showDate:: set to 'false' to hide the current date
-  #   showNav:: set to 'false to hide the navigation tools
-  #   showPrint:: set to 'false' to hide the print icon
-  #   showTabs:: set to 'false' to hide the tabs
-  #   showCalendars:: set to 'false' to hide the calendars selection drop down
-  #   showTimezone:: set to 'false' to hide the timezone selection
-  #   border:: the border width in pixels
-  #   dates:: a range of dates to display in the format of 'yyyymmdd/yyyymmdd'.  Example: 20090820/20091001
-  #   privateKey:: use to display a private calendar.  You can find this key under the calendar settings pane of the Google Calendar website.
-  #   colors:: a hash of calendar ids as key and color values as associated hash values.  Example: {'test@gmail.com' => '#7A367A'} 
-  def to_iframe(cals, params = {})
-    params[:height] ||= "600"
-    params[:width] ||= "600"
-    params[:title] ||= (self.account ? self.account : '')
-    params[:bgcolor] ||= "#FFFFFF"
-    params[:color] ||= "#2952A3"
-    params[:showTitle] = params[:showTitle] == false ? "showTitle=0" : ''
-    params[:showNav] = params[:showNav] == false ? "showNav=0" : ''
-    params[:showDate] = params[:showDate] == false ? "showDate=0" : ''
-    params[:showPrint] = params[:showPrint] == false ? "showPrint=0" : ''
-    params[:showTabs] = params[:showTabs] == false ? "showTabs=0" : ''
-    params[:showCalendars] = params[:showCalendars] == false ? "showCalendars=0" : ''
-    params[:showTimezone] = params[:showTimezone] == false ? 'showTz=0' : ''
-    params[:border] ||= "0"
-    output = ''
-    puts "params = #{params.inspect}" if self.debug
-    params.each do |key, value|
-      puts "key = #{key} and value = #{value}" if self.debug
-      case key
-        when :height then output += "height=#{value}"
-        when :width then output += "width=#{value}"
-        when :title then output += "title=#{CGI.escape(value)}"
-        when :bgcolor then output += "bgcolor=#{CGI.escape(value)}"
-        when :color then output += "color=#{CGI.escape(value)}"
-        when :showTitle then output += value
-        when :showDate then output += value
-        when :showNav then output += value
-        when :showPrint then output += value
-        when :showTabs then output += value
-        when :showCalendars then output += value
-        when :showTimezone then output += value
-        when :viewMode then output += "mode=#{value}"
-        when :dates then output += "dates=#{CGI.escape(value)}"
-        when :privateKey then output += "pvttk=#{value}"
+    #Returns an array of Calendar objects for each calendar associated with 
+    #the authenticated account.
+    def calendars
+      if not @auth_token
+         raise NotAuthenticated
       end
-      output += "&amp;"
+      ret = send_request(GData4Ruby::Request.new(:get, CALENDAR_LIST_FEED, nil, {"max-results" => "10000"}))
+      cals = []
+      REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
+        entry = GData4Ruby::Utils.add_namespaces(entry)
+        cal = Calendar.new(self)
+        cal.load(entry.to_s)
+        cals << cal
+      end
+      return cals
     end
     
-    puts "output = #{output}" if self.debug
+    #Returns an array of Event objects for each event in this account
+    def events
+      if not @auth_token
+         raise NotAuthenticated
+      end
+      ret = send_request(GData4Ruby::Request.new(:get, default_event_feed, nil, {"max-results" => "10000"}))
+      events = []
+      REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
+        entry = GData4Ruby::Utils.add_namespaces(entry)
+        event = Event.new(self)
+        event.load(entry.to_s)
+        events << event
+      end
+      return events
+    end
     
-    if cals.is_a?(Array)
-      for c in cals
-        output += "src=#{c}&amp;"
-        if params[:colors] and params[:colors][c]
-          output += "color=#{CGI.escape(params[:colors][c])}&amp;"
+    #Helper function to return a formatted iframe embedded google calendar.  Parameters are:
+    #1. *cals*: either an array of calendar ids, or <em>:all</em> for all calendars, or <em>:first</em> for the first (usally default) calendar
+    #2. *params*: a hash of parameters that affect the display of the embedded calendar.  Accepts any parameter that the google iframe recognizes.  Here are the most common:
+    #   height:: the height of the embedded calendar in pixels
+    #   width:: the width of the embedded calendar in pixels
+    #   title:: the title to display
+    #   bgcolor:: the background color.  Limited choices, see google docs for allowable values.
+    #   color:: the color of the calendar elements.  Limited choices, see google docs for allowable values.
+    #   showTitle:: set to '0' to hide the title
+    #   showDate:: set to '0' to hide the current date
+    #   showNav:: set to '0 to hide the navigation tools
+    #   showPrint:: set to '0' to hide the print icon
+    #   showTabs:: set to '0' to hide the tabs
+    #   showCalendars:: set to '0' to hide the calendars selection drop down
+    #   showTz:: set to '0' to hide the timezone selection
+    #   border:: the border width in pixels
+    #   dates:: a range of dates to display in the format of 'yyyymmdd/yyyymmdd'.  Example: 20090820/20091001
+    #   privateKey:: use to display a private calendar.  You can find this key under the calendar settings pane of the Google Calendar website.
+    #   ctz:: The timezone to convert event times to
+    #3. *colors*: a hash of calendar ids as key and color values as associated hash values.  Example: {'test@gmail.com' => '#7A367A'} 
+    def to_iframe(cals, params = {}, colors = {})
+      params[:height] ||= "600"
+      params[:width] ||= "600"
+      params[:title] ||= (self.account ? self.account : '')
+      params[:bgcolor] ||= "#FFFFFF"
+      params[:color] ||= "#2952A3"
+      params[:border] ||= "0"
+      puts "params = #{params.inspect}" if self.debug
+      output = "?#{params.to_a.collect{|a| a.join("=")}.join("&")}&"
+      puts "param_string = #{output}" if self.debug
+      
+      if cals.is_a?(Array)
+        for c in cals
+          output += "src=#{c}&"
+          if colors and colors[c]
+            output += "color=#{colors[c]}&"
+          end
         end
+      elsif cals == :all
+        cal_list = calendars()
+        for c in cal_list
+          output += "src=#{c.id}&"
+        end
+      elsif cals == :first
+        cal_list = calendars()
+        output += "src=#{cal_list[0].id}&"
       end
-    elsif cals == :all
-      cal_list = calendars()
-      for c in cal_list
-        output += "src=#{c.id}&amp;"
-      end
-    elsif cals == :first
-      cal_list = calendars()
-      output += "src=#{cal_list[0].id}&amp;"
+          
+      "<iframe src='http://www.google.com/calendar/embed?#{CGI::escape(output)}' style='#{params[:border]} px solid;' width='#{params[:width]}' height='#{params[:height]}' frameborder='#{params[:border]}' scrolling='no'></iframe>"
     end
-        
-    "<iframe src='http://www.google.com/calendar/embed?#{output}' style='#{params[:border]} px solid;' width='#{params[:width]}' height='#{params[:height]}' frameborder='#{params[:border]}' scrolling='no'></iframe>"
   end
-end
-
 end

data/test/unit.rb

@@ -69,7 +69,7 @@ def calendar_test
   end
   
   puts "3. Find Calendar by ID"
-  c = Calendar.find(@service, cal.id)
+  c = Calendar.find(@service, {:id => cal.id})
   if c.title == cal.title
     successful
   else
@@ -77,7 +77,7 @@ def calendar_test
   end
   
   puts "4. Delete Calendar"
-  if cal.delete and not cal.title
+  if cal.delete and not cal.exists?
     successful
   else
     failed
@@ -88,11 +88,12 @@ def event_test
   puts "---Starting Event Test---"
   
   puts "1. Create Event"
-  event = Event.new(@service.calendars[0])
+  event = Event.new(@service)
+  event.calendar = @service.calendars[0]
   event.title = "Test Event"
   event.content = "Test event content"
-  event.start = Time.now+1800
-  event.end = Time.now+5400
+  event.start_time = Time.now+1800
+  event.end_time = Time.now+5400
   if event.save
     successful event.to_xml
   else
@@ -113,7 +114,7 @@ def event_test
   end
   
   puts "4. Find Event by id"
-  e = Event.find(@service.calendars[0], event.id)
+  e = Event.find(@service, {:id => event.id})
   if e.title == event.title
     successful
   else
@@ -139,10 +140,11 @@ def event_recurrence_test
   @second_freq = {'weekly' => ['SA']}
   
   puts "1. Create Recurring Event"
-  event = Event.new(@service.calendars[0])
+  event = Event.new(@service)
+  event.calendar = @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})
+  event.recurrence = Recurrence.new({:start_time => @first_start, :end_time => @first_end, :frequency => @first_freq})
   if event.save 
     successful event.to_xml
   else
@@ -151,7 +153,7 @@ def event_recurrence_test
   
   puts "2. Edit Recurrence"
   event.title = "Edited recurring title"
-  event.recurrence = Recurrence.new({:start => @second_start, :end => @second_end, :frequency => @second_freq})
+  event.recurrence = Recurrence.new({:start_time => @second_start, :end_time => @second_end, :frequency => @second_freq})
   if event.save 
     successful event.to_xml
   else