gcal4ruby 0.2.2 → 0.2.3

data/CHANGELOG

@@ -1,4 +1,7 @@
 #=CHANGELOG
+#==version 0.2.3
+#* Implemented to_iframe method for calendars and services to output embeddable iframe text.
+#* Added switch to turn off ACL check for public calendars.  Can increase effeciency if turned off.
 #==version 0.2.2
 #* Fixed URL encoding problem in Event.find method.
 #* cleaned up Event.find method to allow for finding events by id

data/lib/gcal4ruby/calendar.rb

@@ -201,6 +201,20 @@ class Calendar
     ret
   end
   
+  def self.get(service, id)
+    url = 'http://www.google.com/calendar/feeds/default/allcalendars/full/'+id
+    ret = service.send_get(url)
+    puts "==return=="
+    puts ret.body
+  end
+  
+  def self.query(service, query_term)
+    url = 'http://www.google.com/calendar/feeds/default/allcalendars/full'+"?q="+CGI.escape(query_term)
+    ret = service.send_get(url)
+    puts "==return=="
+    puts ret.body
+  end
+  
   #Reloads the calendar objects information from the stored server version.  Returns true
   #if successful, otherwise returns false.  Any information not saved will be overwritten.
   def reload
@@ -267,39 +281,160 @@ class Calendar
     
     @event_feed = "http://www.google.com/calendar/feeds/#{@id}/private/full"
     
-    puts "Getting ACL Feed" if @service.debug
-    
-    #rescue error on shared calenar ACL list access
-    begin 
-      ret = @service.send_get("http://www.google.com/calendar/feeds/#{@id}/acl/full/")
-    rescue Exception => e
-      @public = false
-      @editable = false
-      return true
-    end
-    @editable = true
-    r = REXML::Document.new(ret.read_body)
-    r.root.elements.each("entry") do |ele|
-      ele.elements.each do |e|
-        #puts "e = "+e.to_s if @service.debug
-        #puts "previous element = "+e.previous_element.to_s if @service.debug
-        if e.name == 'role' and e.previous_element.name == 'scope' and e.previous_element.attributes['type'] == 'default'
-          if e.attributes['value'].match('#read')
-            @public = true
-          else
-            @public = false
+    if @check_public
+      puts "Getting ACL Feed" if @service.debug
+      
+      #rescue error on shared calenar ACL list access
+      begin 
+        ret = @service.send_get("http://www.google.com/calendar/feeds/#{@id}/acl/full/")
+      rescue Exception => e
+        @public = false
+        @editable = false
+        return true
+      end
+      @editable = true
+      r = REXML::Document.new(ret.read_body)
+      r.root.elements.each("entry") do |ele|
+        ele.elements.each do |e|
+          #puts "e = "+e.to_s if @service.debug
+          #puts "previous element = "+e.previous_element.to_s if @service.debug
+          if e.name == 'role' and e.previous_element.name == 'scope' and e.previous_element.attributes['type'] == 'default'
+            if e.attributes['value'].match('#read')
+              @public = true
+            else
+              @public = false
+            end
           end
         end
       end
+    else
+      @public = false
+      @editable = true
     end
     return true
   end
   
-  #Returns a HTML <iframe> tag displaying the calendar.
-  def to_iframe(height=300, width=400)
-    
+  #Helper function to return the currently loaded calendar formatted iframe embedded google calendar.  
+  #1. *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.
+  def to_iframe(params = {})
+    if not self.id
+      raise "The calendar must exist and be saved before you can use this method."
+    end
+    params[:id] = self.id
+    params[:height] ||= "600"
+    params[:width] ||= "600"
+    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 = ''
+    params.each do |key, value|
+      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}"
+      end
+      output += "&amp;"
+    end
+  
+    output += "src=#{params[:id]}&amp;"
+        
+    "<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
   
+  #Helper function to return a specified calendar id as a formatted iframe embedded google calendar.  This function does not require loading the calendar information from the Google calendar
+  #service, but does require you know the google calendar id. 
+  #1. *id*: the unique google assigned id for the calendar to display.
+  #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.
+  def self.to_iframe(id, params = {})
+    params[:id] = id
+    params[:height] ||= "600"
+    params[:width] ||= "600"
+    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 = ''
+    params.each do |key, value|
+      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}"
+      end
+      output += "&amp;"
+    end
+  
+    output += "src=#{params[:id]}&amp;"
+        
+    "<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
+
   private
   @xml 
   @exists = false

data/lib/gcal4ruby/service.rb

@@ -23,6 +23,15 @@ class Service < Base
       
   # 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
+  
+  def initialize
+    @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.
@@ -56,6 +65,81 @@ class Service < Base
     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.
+  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}"
+      end
+      output += "&amp;"
+    end
+    
+    puts "output = #{output}" if self.debug
+    
+    if cals.is_a?(Array)
+      for c in cals
+        output += "src=#{c}&amp;"
+      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;"
+    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
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gcal4ruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Mike Reich
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-16 00:00:00 -07:00
+date: 2009-08-14 00:00:00 +10:00
 default_executable: 
 dependencies: []