h13ronim-gcal4ruby 0.2.6

data/lib/gcal4ruby/service.rb

@@ -0,0 +1,151 @@
+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
+#
+#1. Authenticate
+#    service = Service.new
+#    service.authenticate("user@gmail.com", "password")
+#
+#2. Get Calendar List
+#    calendars = service.calendars
+#
+
+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
+  
+  def initialize
+    super
+    @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
+    end
+  end
+
+  #Returns an array of Calendar objects for each calendar associated with 
+  #the authenticated account.
+  def calendars
+    if not @auth_token
+       raise NotAuthenticated
+    end
+    ret = send_get(CALENDAR_LIST_FEED)
+    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
+    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}"
+      end
+      output += "&amp;"
+    end
+    
+    puts "output = #{output}" if self.debug
+    
+    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;"
+        end
+      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

data/lib/gcal4ruby.rb

@@ -0,0 +1 @@
+require "gcal4ruby/service" 

data/test/unit.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'gcal4ruby'
+include GCal4Ruby
+
+@service = Service.new
+@username = nil
+@password = nil
+
+def tester
+  if ARGV.include?("-d")
+      @service.debug = true
+  end
+  ARGV.each do |ar|
+    if ar.match("username=")
+      @username = ar.gsub("username=", "")
+    end
+    if ar.match("password=")
+      @password = ar.gsub("password=", "")
+    end
+  end
+  service_test
+  calendar_test
+  event_test
+end
+
+def service_test
+  puts "---Starting Service Test---"
+  puts "1. Authenticate"
+  if @service.authenticate(@username, @password)
+    successful
+  else
+    failed
+  end
+  
+  puts "2. Calendar List"
+  cals = @service.calendars
+  if cals
+    successful "Calendars for this Account:"
+    cals.each do |cal|
+      puts cal.title
+    end
+  else
+    failed
+  end
+end
+
+def calendar_test
+  puts "---Starting Calendar Test---"
+  
+  puts "1. Create Calendar"
+  cal = Calendar.new(@service)
+  cal.title = "test calendar"+Time.now.to_s
+  puts "Calender exists = "+cal.exists?.to_s
+  if cal.save
+    successful cal.to_xml
+  else
+    failed
+  end
+  
+  puts "2. Edit Calendar"
+  cal.title = "renamed title"
+  if cal.save
+    successful cal.to_xml
+  else
+    puts "Test 2 Failed"
+  end
+  
+  puts "3. Find Calendar by ID"
+  c = Calendar.find(@service, cal.id)
+  if c.title == cal.title
+    successful
+  else
+    failed "#{c.title} not equal to #{cal.title}"
+  end
+  
+  puts "4. Delete Calendar"
+  if cal.delete and not cal.title
+    successful
+  else
+    failed
+  end
+end
+
+def event_test
+  puts "---Starting Event Test---"
+  
+  puts "1. Create Event"
+  event = Event.new(@service.calendars[0])
+  event.title = "Test Event"
+  event.content = "Test event content"
+  event.start = Time.now+1800
+  event.end = Time.now+5400
+  if event.save
+    successful event.to_xml
+  else
+    failed
+  end
+  
+  puts "2. Edit Event"
+  event.title = "Edited title"
+  if event.save
+    successful event.to_xml
+  else
+    failed
+  end
+  
+  puts "3. Reload Event"
+  if event.reload
+    successful
+  end
+  
+  puts "4. Find Event by id"
+  e = Event.find(@service.calendars[0], event.id)
+  if e.title == event.title
+    successful
+  else
+    failed "Found event doesn't match existing event"
+  end
+  
+  puts "5. Delete Event"
+  if event.delete
+    successful 
+  else
+    failed
+  end
+end
+
+def failed(m = nil)
+  puts "Test Failed"
+  puts m if m
+  exit()
+end
+
+def successful(m = nil)
+  puts "Test Successful"
+  puts m if m
+end
+
+tester

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: h13ronim-gcal4ruby
+version: !ruby/object:Gem::Version 
+  version: 0.2.6
+platform: ruby
+authors: 
+- Mike Reich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-01 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A full featured wrapper for interacting with the Google Calendar API
+email: mike@seabourneconsulting.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- CHANGELOG
+- lib/gcal4ruby.rb
+- lib/gcal4ruby/base.rb
+- lib/gcal4ruby/service.rb
+- lib/gcal4ruby/calendar.rb
+- lib/gcal4ruby/event.rb
+- lib/gcal4ruby/recurrence.rb
+has_rdoc: true
+homepage: http://gcal4ruby.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gcal4ruby
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A full featured wrapper for interacting with the Google Calendar API
+test_files: 
+- test/unit.rb