cs210-gcal4ruby 0.5.8.5 → 0.6.9

data/CHANGELOG

@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 #=CHANGELOG
 #==version 0.5.8
 #* Calculate event feed URI instead of querying Google for content URI
@@ -90,4 +91,91 @@
 #==version 0.1.1
 #* Added all_day indicator to event to indicate an all day event
 #==version 0.1.0
-#* Initial Version
+#* Initial Version
+=======
+=CHANGELOG
+==version 0.6.0
+* Updated Service to work with multiple types of GData4Ruby services
+==version 0.5.5 
+* Fixed calendar::find method.  Thanks to AB <a.berezovskiy@gmail.com>.
+* Improved recurrence handling.  Thanks to John Paul Narowski <jnarowski@gmail.com>.
+* Fixed documentation bug for event reminders.
+* Changed license to LGPLv3.
+==version 0.5.4
+* Fixed Serviceto_iframe bgcolor bug
+==version 0.5.3
+* Fixed bug when loading event attributes when initializing
+==version 0.5.2
+* Fixed calendar.public functionality for making calendars publicly viewable.
+* Fixed to_iframe output methods
+* Fixed issue with creating new events
+==version 0.5.1
+* Minor fixes to to_iframe methods
+==version 0.5.0 - MAJOR CHANGES
+* Now using GData4Ruby library as base class for service, calendar, and event objects.  This removed the base.rb class, which is now inherited from
+  GData4ruby
+* Added 'events' method to service to get all events for an account.
+* Major interface changes to find methods - these are not backwards compatible changes.
+* Changed Eventfind default behavior to search all calendars.
+* Major interface changes to to_iframe methods - these are not backwards compatible changes.
+* Added support for multiple reminders.
+* Improved object relationship for events.  Events are now service-centric, i.e. events are instantiated with a service object.
+* Event calendar is now set through a 'calendar' attribute.
+* Fixes to event recurrence handling and display.
+* Added support for reminders with recurring events.
+* Numerous improvements to performance.
+* Calendar objects no longer have to query ACL feed to determine editability.
+* Added support for event statuses: cancelled, tentative or confirmed.
+==version 0.3.2
+* Updated the Event.find method to support finding all events by passing :all as the query term.
+==version 0.3.1
+* Fixed Event.find method to work with secondary calendars and google apps accounts.  Fix provided by groesser3.
+* Added max results to Calendar.find.
+==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.
+==version 0.2.10
+* Fixed library support for Google Hosted Apps accounts running in forced SSL mode.
+==version 0.2.9
+* Fixed small SSL redirect bug due to variable misnaming in base.rb.  Fix provided by JohnMetta
+==version 0.2.8
+* Merged changes from edruder and h13ronim from the unofficial github repo - http://github.com/h13ronim/gcal4ruby/commits/master
+==version 0.2.7
+* Added fix for finding events in calendars that have more than 25 entries
+==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 Calendarload
+==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
+>>>>>>> edave/master

data/README.md

@@ -1,131 +1,114 @@
 #GCal4Ruby
 
-##Introduction
-       
+## 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,
+all of the functionality available through the Google Calendar 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) 
+## Author and Contact Information
+GCal4Ruby was created and is maintained by {Mike Reich}[mailto:mike@seabourneconsulting.com] 
 and is licenses under the LGPL v3.  Feel free to use and update, but be sure to contribute your
 code back to the project and attribute as required by the license.  You can find the text of the LGPL 
-here: [http://www.gnu.org/licenses/lgpl.html](http://www.gnu.org/licenses/lgpl.html).
-
-##Website
+here: http://www.gnu.org/licenses/lgpl.html.
 
-[http://cookingandcoding.com/gcal4ruby/](http://cookingandcoding.com/gcal4ruby/)
+### Website
+http://cookingandcoding.com/gcal4ruby/ (original GCal4Ruby plugin)
 
-##Description
+### 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
+## 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 for all calendars
-
-    	calendars = service.calendars
+####Service
 
-3. Get Calendar List for all calendars that the authenticated user has owner access level
+##### Authenticate with the AuthSub service (quickest, dirtiest)
+    service = Service.new
+    service.authenticate({:username => "user@gmail.com", :password => "password"})
 
-    	calendars = service.calendars(:only_owner_access_level => true)
+##### Authenticate using OAuth (more setup, easier for an app)
+	service = Service.new({:GData4RubyService => :OAuthService})
+	service.authenticate({:access_token=>my_oauth_accesstoken})
+	
+	See [edave-GData4Ruby](https://github.com/edave/GData4Ruby) for more details
+	
+##### Get Calendar List for all calendars that the authenticated user has owner access level
+	calendars = service.calendars(:only_owner_access_level => true)
 
-###Calendar
+# Get Calendar List
+    calendars = service.calendars
 
+### Calendar
 All usages assume a successfully authenticated Service.
-
 1. Create a new Calendar
-
-		cal = Calendar.new(service)
+    cal = Calendar.new(service)
 
 2. Find a calendar by ID
-
-	    cal = Calendar.find(service, {:id => cal_id})
+    cal = Calendar.find(service, {:id => cal_id})
 
 3. Get all calendar events
-
-	    cal = Calendar.find(service, {:id => cal_id})
-	    events = cal.events
+    cal = Calendar.find(service, {:id => cal_id})
+    events = cal.events
 
 4. Find an existing calendar by title
-
-	    cal = Calendar.find(service, {:title => "New Calendar"})
+    cal = Calendar.find(service, {:title => "New Calendar"})
 
 5. Find all calendars containing a search term
+    cal = Calendar.find(service, "Soccer Team")
 
-	    cal = Calendar.find(service, "Soccer Team")
-
-###Event
+### Event
 
 All usages assume a successfully authenticated Service and valid Calendar.
-
 1. Create a new Event
-
-	    event = Event.new(service, {:calendar => cal, :title => "Soccer Game", :start => Time.parse("12-06-2009 at 12:30 PM"), :end > Time.parse("12-06-2009 at 1:30 PM"), :where => "Merry Playfields"})
-	    event.save
+    event = Event.new(service, {:calendar => cal, :title => "Soccer Game", :start => Time.parse("12-06-2009 at 12:30 PM"), :end => Time.parse("12-06-2009 at 1:30 PM"), :where => "Merry Playfields"})
+    event.save
 
 2. Find an existing Event by title
-
-	    event = Event.find(service, {:title => "Soccer Game"})
+    event = Event.find(service, {:title => "Soccer Game"})
 
 3. Find an existing Event by ID
-
-	    event = Event.find(service, {:id => event.id})
+    event = Event.find(service, {:id => event.id})
 
 4. Find all events containing the search term
-
-	    event = Event.find(service, "Soccer Game")
+    event = Event.find(service, "Soccer Game")
 
 5. Find all events on a calendar containing the search term
-
-	    event = Event.find(service, "Soccer Game", {:calendar => cal.id})
+    event = Event.find(service, "Soccer Game", {:calendar => cal.id})
 
 6. Find events within a date range
-
-	    event = Event.find(service, "Soccer Game", {'start-min' => Time.parse("01/01/2010").utc.xmlschema, 'start-max' => Time.parse("06/01/2010").utc.xmlschema})
+    event = Event.find(service, "Soccer Game", {'start-min' => Time.parse("01/01/2010").utc.xmlschema, 'start-max' => Time.parse("06/01/2010").utc.xmlschema})
 
 7. Create a recurring event for every saturday
-
-		event = Event.new(service)
-	    event.title = "Baseball Game"
-	    event.calendar = cal
-	    event.where = "Municipal Stadium"
-	    event.recurrence = Recurrence.new
-		event.recurrence.start_time = Time.parse("06/20/2009 at 4:30 PM")
-		event.recurrence.end_time = Time.parse("06/20/2009 at 6:30 PM")
-		event.recurrence.frequency = {"weekly" => ["SA"]}
-		event.save 
+    event = Event.new(service)
+    event.title = "Baseball Game"
+    event.calendar = cal
+    event.where = "Municipal Stadium"
+    event.recurrence = Recurrence.new
+    event.recurrence.start_time = Time.parse("06/20/2009 at 4:30 PM")
+    event.recurrence.end_time = Time.parse("06/20/2009 at 6:30 PM")
+    event.recurrence.frequency = {"weekly" => ["SA"]}
+    event.save 
 
 8. Create an event with a 15 minute email reminder
-
-		event = Event.new(service)
-		event.calendar = cal
-		event.title = "Dinner with Kate"
-		event.start_time = Time.parse("06/20/2009 at 5 pm")
-		event.end_time = Time.parse("06/20/2009 at 8 pm")
-		event.where = "Luigi's"
-		event.reminder = {:minutes => 15, :method => 'email'}
-		event.save
+    event = Event.new(service)
+    event.calendar = cal
+    event.title = "Dinner with Kate"
+    event.start_time = Time.parse("06/20/2009 at 5 pm")
+    event.end_time = Time.parse("06/20/2009 at 8 pm")
+    event.where = "Luigi's"
+    event.reminder = {:minutes => 15, :method => 'email'}
+    event.save
 
 9. Create an event with attendees
-
-		event = Event.new(service)
-		event.calendar = cal
-		event.title = "Dinner with Kate"
-		event.start_time = Time.parse("06/20/2009 at 5 pm")
-		event.end_time = Time.parse("06/20/2009 at 8 pm")
-		event.attendees => {:name => "Kate", :email => "kate@gmail.com"}
-		event.save
+    event = Event.new(service)
+    event.calendar = cal
+    event.title = "Dinner with Kate"
+    event.start_time = Time.parse("06/20/2009 at 5 pm")
+    event.end_time = Time.parse("06/20/2009 at 8 pm")
+    event.attendees => {:name => "Kate", :email => "kate@gmail.com"}
+    event.save

data/lib/gcal4ruby/calendar.rb

@@ -44,7 +44,7 @@ module GCal4Ruby
   class Calendar < GData4Ruby::GDataObject
     ALL_CALENDARS_FEED = 'https://www.google.com/calendar/feeds/default/allcalendars/full'
     OWN_CALENDARS_FEED = 'https://www.google.com/calendar/feeds/default/owncalendars/full'
-    CALENDAR_XML = "<entry xmlns='http://www.w3.org/2005/Atom' 
+    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>
@@ -89,7 +89,7 @@ module GCal4Ruby
       if !service.is_a?(Service)
         raise InvalidService
       end
-      @xml = CALENDAR_XML
+      @xml = @@calendar_xml
       @service ||= service
       @updated_at = nil
       @exists = false
@@ -101,8 +101,11 @@ module GCal4Ruby
       @color ||= "#2952A3"
       @where ||= ""
       attributes.each do |key, value|
-        self.send("#{key}=", value)
+        if self.respond_to?("#{key}=")
+          self.send("#{key}=", value)
+        end
       end
+      @debug ||= false
       return true
     end
     
@@ -120,7 +123,7 @@ module GCal4Ruby
     #Returns an array of Event objects corresponding to each event in the calendar.
     def events
       events = []
-      ret = @service.send_request(GData4Ruby::Request.new(:get, @content_uri))
+      ret = service.send_request(GData4Ruby::Request.new(:get, @content_uri))
       REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
         entry = GData4Ruby::Utils.add_namespaces(entry)
         e = Event.new(service)
@@ -138,12 +141,12 @@ module GCal4Ruby
       ret = super
       return ret if public == @public
       if public
-        puts 'setting calendar to public' if service.debug
-        rule = GData4Ruby::ACL::AccessRule.new(service, self)
+        log('setting calendar to public')
+        rule = GData4Ruby::ACL::AccessRule.new(service.gdata_service, self)
         rule.role = 'http://schemas.google.com/gCal/2005#read'
         rule.save
       else
-        rule = GData4Ruby::ACL::AccessRule.find(service, self, {:user => 'default'})
+        rule = GData4Ruby::ACL::AccessRule.find(service.gdata_service, self, {:user => 'default'})
         rule.delete if rule
       end
       reload
@@ -263,25 +266,33 @@ module GCal4Ruby
         end
       end
       
-      if @service.check_public
-        puts "Getting ACL Feed" if @service.debug
+      if service.check_public
+        log("Getting ACL Feed")
+        
+        # If the ACL URI doesn't exist, then its definitely not public
+        if (@acl_uri == nil)
+          log("Not Public")
+          @public = false
+          return true
+        end
         
         #rescue error on shared calenar ACL list access
         begin 
-          ret = @service.send_request(GData4Ruby::Request.new(:get, @acl_uri))
+          log("ACL URI: #{@acl_uri}")
+          ret = service.send_request(GData4Ruby::Request.new(:get, @acl_uri))
         rescue Exception => e
-          puts "ACL Feed Get Failed: #{e.inspect}" if @service.debug
+          log("ACL Feed Get Failed: #{e.inspect}")
           @public = false
           return true
         end
         r = REXML::Document.new(ret.read_body)
         r.root.elements.each("entry") do |ele|
-          e = GData4Ruby::ACL::AccessRule.new(service, self)
+          e = GData4Ruby::ACL::AccessRule.new(service.gdata_service, self)
           ele = GData4Ruby::Utils.add_namespaces(ele)
           e.load(ele.to_s)
-          puts 'acl rule = '+e.inspect if service.debug
+          log('ACL Rule: '+e.inspect)
           @public = (e.role.include? 'read' and e.user == 'default')
-          puts 'public = '+@public.to_s if service.debug
+          log('Public: '+@public.to_s)
           break if @public
         end
       else
@@ -320,7 +331,7 @@ module GCal4Ruby
       
       output += "&src=#{id}"
       
-      "<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>"  
+      "<iframe src='#{service.create_url("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
@@ -353,7 +364,7 @@ module GCal4Ruby
       
       output += "&src=#{id}"
       
-      "<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>"  
+      "<iframe src='#{service.create_url("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

data/lib/gcal4ruby/event.rb

@@ -402,6 +402,9 @@ module GCal4Ruby
           end
         else
           service.calendars.each do |cal|
+            puts "Event.find() searching calendar: " if service.debug
+            puts cal.content_uri if service.debug
+            puts args.inspect if service.debug
             ret = service.send_request(GData4Ruby::Request.new(:get, cal.content_uri, nil, nil, args))
             xml = REXML::Document.new(ret.body).root
             xml.elements.each("entry") do |e|

data/lib/gcal4ruby/service.rb

@@ -43,12 +43,12 @@ module GCal4Ruby
   #
   class Service < GData4Ruby::Service
     
-    #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
+    # The type of GData4Ruby service we want to use
+    attr_accessor :gdata_service
     
+    # Convenience attribute contains the currently authenticated account name
+    attr_accessor :account
+         
     # 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
@@ -56,24 +56,71 @@ module GCal4Ruby
     
     #Accepts an optional attributes hash for initialization values
     def initialize(attributes = {})
-      super(attributes)
+      # If the user has specified the type of GData4Ruby class they want, instantiate it
+      if(attributes.has_key?(:GData4RubyService))
+        @gdata_service = GData4Ruby.const_get(attributes[:GData4RubyService]).new(attributes)
+      end
+      # Otherwise use the default service
+      @gdata_service ||= GData4Ruby::Service.new(attributes)
       attributes.each do |key, value|
-        self.send("#{key}=", value)
+        if self.respond_to?("#{key}=")
+          self.send("#{key}=", value)
+        end
       end    
       @check_public ||= true
+      @account ||= "default"
+      @debug ||= false
+      log("Check Public: #{check_public}")
+    end
+    
+    def debug
+      return @debug
+    end
+    
+    def debug=(value)
+      @debug=value
+      @gdata_service.debug = value
     end
+    
+    def log(string)
+      puts string if debug
+    end
+<<<<<<< HEAD
 
     # The authenticate method passes the username and password to google servers.  
+=======
+    
+    def default_event_feed
+      return create_url("www.google.com/calendar/feeds/#{@account}/private/full")
+    end
+  
+    # The authenticate method passes an  for the service to use to access Google's servers  
+>>>>>>> edave/master
     # If authentication succeeds, returns true, otherwise raises the AuthenticationFailed error.
-    def authenticate(username, password, service='cl')
-      super(username, password, service)
+    def authenticate(options = {})
+      if not options.has_key?(:service)
+        options[:service] = 'cl'
+      end
+      @gdata_service.authenticate(options)
     end
     
     #Helper function to reauthenticate to a new Google service without having to re-set credentials.
-    def reauthenticate(service='cl')
-      authenticate(@account, @password, service)
+    def reauthenticate(options = {})
+      if not options.has_key?(:service)
+        options[:service] = 'cl'
+      end
+      @gdata_service.reauthenticate(options)
     end
-  
+    
+    # Passes a request along from a GData4Ruby GDataObject to a GData4Ruby Base (Service) to be invoked
+    def send_request(request)
+      if not @gdata_service.authenticated?
+         raise GData4Ruby::NotAuthenticated
+      end
+      @gdata_service.send_request(request)
+    end
+    
+    
     #Returns an array of Calendar objects for each calendar associated with 
     #the authenticated account.  An optional hash of options is the only parameter. The
     #available options are:
@@ -87,12 +134,14 @@ module GCal4Ruby
       cals = []
       REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
         entry = GData4Ruby::Utils.add_namespaces(entry)
-        cal = Calendar.new(self)
+        cal = Calendar.new(self, {:debug => debug})
+        log(entry.inspect)
         cal.load(entry.to_s)
         cals << cal
       end
       return cals
     end
+
     
     #Returns an array of Event objects for each event in this account
     def events
@@ -103,13 +152,18 @@ module GCal4Ruby
       events = []
       REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
         entry = GData4Ruby::Utils.add_namespaces(entry)
-        event = Event.new(self)
+        event = Event.new(self, {:debug => debug})
         event.load(entry.to_s)
         events << event
       end
       return events
     end
     
+    # Builds a URL
+    def create_url(path)
+      return @gdata_service.create_url(path)
+    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.  Accepts any parameter that the google iframe recognizes.  Here are the most common:
@@ -155,7 +209,7 @@ module GCal4Ruby
         output += "src=#{cal_list[0].id}&"
       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>"
+      "<iframe src='#{create_url("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

metadata

@@ -2,7 +2,7 @@
 name: cs210-gcal4ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.8.5
+  version: 0.6.9
 platform: ruby
 authors: 
 - Mike Reich
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-25 00:00:00 Z
+date: 2011-04-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cs210-gdata4ruby
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.5
+        version: 0.2.0
   type: :runtime
   version_requirements: *id001
 description: "GCal4Ruby is a Ruby Gem that can be used to interact with the current version of the Google Calendar API. GCal4Ruby provides the following features: Create and edit calendar events, Add and invite users to events, Set reminders, Make recurring events."