h13ronim-gcal4ruby 0.2.6

data/CHANGELOG

@@ -0,0 +1,32 @@
+#=CHANGELOG
+#==version 0.2.6
+#* Added fix for updated google calendar XML per http://cookingandcoding.wordpress.com/2009/06/08/new-ruby-google-calendar-api-gem-gcal4ruby/#comment-183
+#==version 0.2.5
+#* Added calendar color support to to_iframe methods in Calendar and Service.
+#==version 0.2.4
+#* Fixed bug with ACL check in Calendar#load
+#==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
+#* updated Calendar.find method to add params hash
+#* added 'published', 'updated', and 'edited' attributes
+#==version 0.2.1
+#* fixed Event.find calendar specification
+#==version 0.2.0
+#* Fixed redirect URI query params problem
+#* Updated syntax for finding events to include most google api parameters,  Non-backwards compatible.
+#==version 0.1.4
+#* Added additional search criteria for Event.find
+#==version 0.1.3
+#* Added support for authenticating with Google Hosted Apps accounts
+#* Added flag to indicate whether a calendar is editable
+#* Added handling to gracefully throw error when trying to create event on a non-editable (shared) calendar
+#==version 0.1.2
+#* Fixed to_xml dump problem with hidden and selected attributes
+#==version 0.1.1
+#* Added all_day indicator to event to indicate an all day event
+#==version 0.1.0
+#* Initial Version

data/README

@@ -0,0 +1,85 @@
+#=GCal4Ruby
+#
+#==Introduction
+#GCal4Ruby is a full featured wrapper for the google calendar API.  GCal4Ruby implements
+#all of the functionality available through the Google Calnedar API, including permissions,
+#attendees, reminders and event recurrence.  
+#
+#==Author and Contact Information
+#GCal4Ruby was created and is maintained by {Mike Reich}[mailto:mike@seabourneconsulting.com] 
+#and is licenses under the GPL v2.  Feel free to use and update, but be sure to contribute your
+#code back to the project and attribute as required by the license.
+#===Website
+#http://rubyforge.org/projects/gcal4ruby/
+#
+#==Description
+#GCal4Ruby has three major components: the service, calendar and event objects.  Each service
+#has many calendars, which in turn have many events.  Each service is the representation of a
+#google account, and thus must be successfully authenticated using valid Google Calendar
+#account credentials.  
+#
+#==Examples
+#Below are some common usage examples.  For more examples, check the documentation.
+#===Service
+#1. Authenticate
+#    service = Service.new
+#    service.authenticate("user@gmail.com", "password")
+#
+#2. Get Calendar List
+#    calendars = service.calendars
+#
+#===Calendar
+#All usages assume a successfully authenticated Service.
+#1. Create a new Calendar
+#    cal = Calendar.new(service)
+#
+#2. Find an existing Calendar
+#    cal = Calendar.find(service, "New Calendar", :first)
+#
+#3. Find all calendars containing the search term
+#    cal = Calendar.find(service, "Soccer Team")
+#
+#4. Find a calendar by ID
+#    cal = Calendar.find(service, id, :first)
+#===Event
+#All usages assume a successfully authenticated Service and valid Calendar.
+#1. Create a new Event
+#    event = Event.new(calendar)
+#    event.title = "Soccer Game"
+#    event.start = Time.parse("12-06-2009 at 12:30 PM")
+#    event.end = Time.parse("12-06-2009 at 1:30 PM")
+#    event.where = "Merry Playfields"
+#    event.save
+#
+#2. Find an existing Event
+#    event = Event.find(cal, "Soccer Game", {:scope => :first})
+#
+#3. Find all events containing the search term
+#    event = Event.find(cal, "Soccer Game")
+#
+#4. Create a recurring event for every saturday
+#    event = Event.new(calendar)
+#    event.title = "Baseball Game"
+#    event.where = "Municipal Stadium"
+#    event.recurrence = Recurrence.new
+#    event.recurrence.start = Time.parse("13-06-2009 at 4:30 PM")
+#    event.recurrence.end = Time.parse("13-06-2009 at 6:30 PM")
+#    event.recurrence.frequency = {"weekly" => ["SA"]}
+#    event.save 
+#
+#5. Create an event with a 15 minute email reminder
+#    event = Event.new(calendar)
+#    event.title = "Dinner with Kate"
+#    event.start = Time.parse("20-06-2009 at 5 pm")
+#    event.end = Time.parse("20-06-209 at 8 pm")
+#    event.where = "Luigi's"
+#    event.reminder = {:minutes => 15, :method => 'email'}
+#    event.save
+#
+#6. Create an event with attendees
+#    event = Event.new(calendar)
+#    event.title = "Dinner with Kate"
+#    event.start = Time.parse("20-06-2009 at 5 pm")
+#    event.end = Time.parse("20-06-209 at 8 pm")
+#    event.attendees => {:name => "Kate", :email => "kate@gmail.com"}
+#    event.save

data/lib/gcal4ruby/base.rb

@@ -0,0 +1,260 @@
+require "rexml/document"
+require "cgi"
+require "uri"
+require "net/http"
+require "net/https"
+require "open-uri"
+require "nkf"
+require "time"
+
+Net::HTTP.version_1_2
+
+# GCal4Ruby is a full featured wrapper for the google calendar API
+
+# =Usage:
+
+module GCal4Ruby
+  
+  CALENDAR_XML = "<entry xmlns='http://www.w3.org/2005/Atom' 
+       xmlns:gd='http://schemas.google.com/g/2005' 
+       xmlns:gCal='http://schemas.google.com/gCal/2005'>
+  <title type='text'></title>
+  <summary type='text'></summary>
+  <gCal:timezone value=''></gCal:timezone>
+  <gCal:hidden value=''></gCal:hidden>
+  <gCal:color value=''></gCal:color>
+  <gd:where rel='' label='' valueString=''></gd:where>
+  </entry>"
+  
+  ACL_XML = "<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gAcl='http://schemas.google.com/acl/2007'>
+                      <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/acl/2007#accessRule'/>
+                       <gAcl:scope type='default'></gAcl:scope>
+                       <gAcl:role value=''></gAcl:role>
+                    </entry>"
+                    
+  EVENT_XML = "<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gd='http://schemas.google.com/g/2005'>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/g/2005#event'></category>
+  <title type='text'></title>
+  <content type='text'></content>
+  <gd:transparency value=''></gd:transparency>
+  <gd:eventStatus value=''></gd:eventStatus>
+  <gd:where valueString=''></gd:where>
+  <gd:when startTime='' endTime=''></gd:when>
+</entry>
+  "
+  
+  class AuthenticationFailed < StandardError; end #:nodoc: all
+
+  class NotAuthenticated < StandardError; end
+    
+  class InvalidService < StandardError; end
+    
+  class HTTPPostFailed < StandardError; end
+    
+  class HTTPPutFailed < StandardError; end
+    
+  class HTTPGetFailed < StandardError; end
+    
+  class HTTPDeleteFailed < StandardError; end
+    
+  class CalendarSaveFailed < StandardError; end
+  
+  class EventSaveFailed < StandardError; end
+    
+  class RecurrenceValueError < StandardError; end
+    
+  class CalendarNotEditable < StandardError; end
+    
+  class QueryParameterError < StandardError; end
+
+  #The ProxyInfo class contains information for configuring a proxy connection
+
+  class ProxyInfo
+    attr_accessor :address, :port, :username, :password
+    @address = nil
+    @port = nil
+    @username = nil
+    @password = nil
+
+    #The initialize function accepts four variables for configuring the ProxyInfo object.  
+    #The proxy connection is initiated using the builtin Net::HTTP proxy support.
+
+    def initialize(address, port, username=nil, password=nil)
+      @address = address
+      @port = port
+      @username = username
+      @password = password
+    end
+  end
+  
+  #The Base class includes the basic HTTP methods for sending and receiving 
+  #messages from the Google Calendar API.  You shouldn't have to use this class 
+  #directly, rather access the functionality through the Service subclass.
+
+  class Base
+    AUTH_URL = "https://www.google.com/accounts/ClientLogin"
+    CALENDAR_LIST_FEED = "http://www.google.com/calendar/feeds/default/allcalendars/full"
+    @proxy_info = nil
+    @auth_token = nil
+    @debug = false
+
+    #Contains the ProxyInfo object for using a proxy server
+    attr_accessor :proxy_info
+    
+    #If set to true, debug will dump all raw HTTP requests and responses
+    attr_accessor :debug
+    
+    # Sends an HTTP POST request.  The header should be a hash of name/value pairs.  
+    # Returns the Net::HTTPResponse object on succces, or raises the appropriate
+    # error if a non 20x response code is received.
+    def send_post(url, content, header=nil)
+      header = auth_header(header)
+      ret = nil
+      location = URI.parse(url)
+      https = get_http_object(location)
+      puts "url = "+url if @debug
+      if location.scheme == 'https'
+        puts "SSL True" if @debug
+      	https.use_ssl = true
+      	https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      puts "Starting post\nHeader: #{header}\nContent: #{content}" if @debug
+      https.start do |http|
+        ret = http.post(location.to_s, content, header)
+      end
+      while ret.is_a?(Net::HTTPRedirection)
+        puts "Redirect recieved, resending post" if @debug
+        https.start do |http|
+          ret = http.post(ret['location'], content, header)
+        end
+      end
+      if ret.is_a?(Net::HTTPSuccess)
+        puts "20x response recieved\nResponse: \n"+ret.read_body if @debug
+        return ret
+      else
+        puts "invalid response received: "+ret.code if @debug
+        raise HTTPPostFailed, ret.body
+      end
+    end
+    
+    # Sends an HTTP PUT request.  The header should be a hash of name/value pairs.  
+    # Returns the Net::HTTPResponse object on succces, or raises the appropriate
+    # error if a non 20x response code is received.
+    def send_put(url, content, header=nil)
+      header = auth_header(header)
+      ret = nil
+      location = URI.parse(url)
+      https = get_http_object(location)
+      puts "url = "+url if @debug
+      if location.scheme == 'https'
+        puts "SSL True" if @debug
+        https.use_ssl = true
+        https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      puts "Starting post\nHeader: #{header}\nContent: #{content}" if @debug
+      https.start do |http|
+        ret = http.put(location.to_s, content, header)
+      end
+      while ret.is_a?(Net::HTTPRedirection)
+        puts "Redirect recieved, resending post" if @debug
+        https.start do |http|
+          ret = http.put(ret['location'], content, header)
+        end
+      end
+      if ret.is_a?(Net::HTTPSuccess)
+        puts "20x response recieved\nResponse: \n"+ret.read_body if @debug
+        return ret
+      else
+        puts "invalid response received: "+ret.code if @debug
+        raise HTTPPutFailed, ret.body
+      end
+    end
+
+    # Sends an HTTP GET request.  The header should be a hash of name/value pairs.  
+    # Returns the Net::HTTPResponse object on succces, or raises the appropriate
+    # error if a non 20x response code is received.
+    def send_get(url, header = nil)
+      header = auth_header(header)
+      ret = nil
+      location = URI.parse(url)
+      http = get_http_object(location)
+      puts "url = "+url if @debug
+      if location.scheme == 'https'
+        puts "SSL True" if @debug
+        https.use_ssl = true
+        https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      puts "Starting post\nHeader: #{header}\n" if @debug
+      http.start do |http|
+        ret = http.get(location.to_s, header)
+      end
+      while ret.is_a?(Net::HTTPRedirection)
+        puts "Redirect recieved, resending get to #{ret['location']}" if @debug
+    	  http.start do |http|
+    	    ret = http.get(ret['location'], header)
+    	  end
+      end
+      if ret.is_a?(Net::HTTPSuccess)
+        puts "20x response recieved\nResponse: \n"+ret.read_body if @debug
+        return ret
+      else
+        puts "Error recieved, resending get" if @debug
+        raise HTTPGetFailed, ret.body
+      end
+    end
+
+    # Sends an HTTP DELETE request.  The header should be a hash of name/value pairs.  
+    # Returns the Net::HTTPResponse object on succces, or raises the appropriate
+    # error if a non 20x response code is received.
+    def send_delete(url, header = nil)
+      header = auth_header(header)
+      ret = nil
+      location = URI.parse(url)
+      https = get_http_object(location)
+      puts "url = "+url if @debug
+      if location.scheme == 'https'
+        puts "SSL True" if @debug
+        https.use_ssl = true
+        https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      puts "Starting post\nHeader: #{header}\n" if @debug
+      https.start do |http|
+        ret = http.delete(location.to_s, header)
+      end
+      while ret.is_a?(Net::HTTPRedirection)
+        puts "Redirect recieved, resending post" if @debug
+        https.start do |http|
+          ret = http.delete(ret['location'], header)
+        end
+      end
+      if ret.is_a?(Net::HTTPSuccess)
+        puts "20x response recieved\nResponse: \n"+ret.read_body if @debug
+        return true
+      else
+        puts "invalid response received: "+ret.code if @debug
+        raise HTTPDeleteFailed, ret.body
+      end
+    end
+
+    private
+
+    def get_http_object(location)
+      if @proxy_info and @proxy_info.address
+	     return Net::HTTP.new(location.host, location.port, @proxy_info.address, @proxy_info.port, @proxy_info.username, @proxy_info.password)
+      else
+	     return Net::HTTP.new(location.host, location.port)
+      end      
+    end
+
+    def auth_header(header)
+      if @auth_token
+      	if header
+      	  header.merge!({'Authorization' => "GoogleLogin auth=#{@auth_token}", "GData-Version" => "2.1"})
+      	else 
+      	  header = {'Authorization' => "GoogleLogin auth=#{@auth_token}", "GData-Version" => "2.1"}
+      	end
+      end
+      return header
+    end
+  end
+end