clio-gcal4ruby 0.3.2

data/lib/gcal4ruby/recurrence.rb

@@ -0,0 +1,213 @@
+class Time
+  #Returns a ISO 8601 complete formatted string of the time
+  def complete
+    self.utc.strftime("%Y%m%dT%H%M%S")
+  end
+  
+  def self.parse_complete(value)
+    d, h = value.split("T")
+    return Time.parse(d+" "+h.gsub("Z", ""))
+  end
+end
+
+module GCal4Ruby
+  #The Recurrence class stores information on an Event's recurrence.  The class implements
+  #the RFC 2445 iCalendar recurrence description.
+  class Recurrence
+    #The event start date/time
+    attr_reader :start
+    #The event end date/time
+    attr_reader :end
+    #the event reference
+    attr_reader :event
+    #The date until which the event will be repeated
+    attr_reader :repeat_until
+    #The event frequency
+    attr_reader :frequency
+    #True if the event is all day (i.e. no start/end time)
+    attr_accessor :all_day
+    
+    #Accepts an optional attributes hash or a string containing a properly formatted ISO 8601 recurrence rule.  Returns a new Recurrence object
+    def initialize(vars = {})
+      if vars.is_a? Hash
+        vars.each do |key, value|
+          self.send("#{key}=", value)
+        end
+      elsif vars.is_a? String
+        self.load(vars)
+      end
+      @all_day ||= false
+    end
+    
+    #Accepts a string containing a properly formatted ISO 8601 recurrence rule and loads it into the recurrence object
+    def load(rec)
+      attrs = rec.split("\n")
+      attrs.each do |val|
+        key, value = val.split(":")
+        case key
+          when 'DTSTART'
+            @start = Time.parse_complete(value)
+          when 'DTSTART;VALUE=DATE'
+            @start = Time.parse(value)
+            @all_day = true
+          when 'DTSTART;VALUE=DATE-TIME'
+            @start = Time.parse_complete(value)
+          when 'DTEND'
+            @end = Time.parse_complete(value)
+          when 'DTEND;VALUE=DATE'
+            @end = Time.parse(value)
+          when 'DTEND;VALUE=DATE-TIME'
+            @end = Time.parse_complete(value)
+          when 'RRULE'
+            vals = value.split(";")
+            key = ''
+            by = ''
+            int = nil
+            vals.each do |rr|
+              a, h = rr.split("=")
+              case a 
+                when 'FREQ'
+                  key = h.downcase.capitalize
+                when 'INTERVAL'
+                  int = h
+                when 'UNTIL'
+                  @repeat_until = Time.parse(value)
+                else
+                  by = h.split(",")
+              end
+            end
+            @frequency = {key => by}
+            @frequency.merge({'interval' => int}) if int
+        end
+      end
+    end
+    
+    #Returns a string with the correctly formatted ISO 8601 recurrence rule
+    def to_s
+      
+      output = ''
+      if @all_day
+        output += "DTSTART;VALUE=DATE:#{@start.utc.strftime("%Y%m%d")}\n"
+      else
+        output += "DTSTART;VALUE=DATE-TIME:#{@start.complete}\n"
+      end
+      if @all_day
+        output += "DTEND;VALUE=DATE:#{@end.utc.strftime("%Y%m%d")}\n"
+      else
+        output += "DTEND;VALUE=DATE-TIME:#{@end.complete}\n"
+      end
+      output += "RRULE:"
+      if @frequency
+        f = 'FREQ='
+        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.upcase};" if key != 'interval'
+          case key.downcase
+            when "secondly"
+              by += "BYSECOND=#{value};"
+            when "minutely"
+              by += "BYMINUTE=#{value};"
+            when "hourly"
+              by += "BYHOUR=#{value};"
+            when "weekly"
+              by += "BYDAY=#{value};" if value
+            when "monthly"
+              by += "BYDAY=#{value};"
+            when "yearly"
+              by += "BYYEARDAY=#{value};"
+            when 'interval'
+              i += "INTERVAL=#{value};"
+          end
+        end
+        output += f+i+by
+      end      
+      if @repeat_until
+        output += "UNTIL=#{@repeat_until.strftime("%Y%m%d")}"
+      end
+      
+      output += "\n"
+    end
+    
+    #Sets the start date/time.  Must be a Time object.
+    def start=(s)
+      if not s.is_a?(Time)
+        raise RecurrenceValueError, "Start must be a date or a time"
+      else
+        @start = s
+      end
+    end
+    
+    #Sets the end Date/Time. Must be a Time object.
+    def end=(e)
+      if not e.is_a?(Time)
+        raise RecurrenceValueError, "End must be a date or a time"
+      else
+        @end = e
+      end
+    end
+    
+    #Sets the parent event reference
+    def event=(e)
+      if not e.is_a?(Event)
+        raise RecurrenceValueError, "Event must be an event"
+      else
+        @event = e
+      end
+    end
+    
+    #Sets the end date for the recurrence
+    def repeat_until=(r)
+      if not  r.is_a?(Date)
+        raise RecurrenceValueError, "Repeat_until must be a date"
+      else
+        @repeat_until = r
+      end
+    end
+    
+    #Sets the frequency of the recurrence.  Should be a hash with one of 
+    #"SECONDLY", "MINUTELY", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY" as the key,
+    #and as the value, an array containing zero to n of the following:
+    #- *Secondly*: A value between 0 and 59.  Causes the event to repeat on that second of each minut.
+    #- *Minutely*: A value between 0 and 59.  Causes the event to repeat on that minute of every hour.
+    #- *Hourly*: A value between 0 and 23.  Causes the even to repeat on that hour of every day.
+    #- *Daily*: No value needed - will cause the event to repeat every day until the repeat_until date.
+    #- *Weekly*: A value of the first two letters of a day of the week.  Causes the event to repeat on that day.
+    #- *Monthly*: A value of a positive or negative integer (i.e. +1) prepended to a day-of-week string ('TU') to indicate the position of the day within the month.  E.g. +1TU would be the first tuesday of the month.
+    #- *Yearly*: A value of 1 to 366 indicating the day of the year.  May be negative to indicate counting down from the last day of the year.
+    #
+    #Optionally, you may specific a second hash pair to set the interval the event repeats:
+    #   "interval" => '2'
+    #If the interval is missing, it is assumed to be 1.
+    #
+    #===Examples
+    #Repeat event every Tuesday:
+    #   frequency = {"Weekly" => ["TU"]}
+    #
+    #Repeat every first and third Monday of the month
+    #   frequency = {"Monthly" => ["+1MO", "+3MO"]}
+    #
+    #Repeat on the last day of every year
+    #   frequency = {"Yearly" => [366]}
+    #
+    #Repeat every other week on Friday
+    #   frequency = {"Weekly" => ["FR"], "interval" => "2"}
+    
+    def frequency=(f)
+      if f.is_a?(Hash)
+        @frequency = f
+      else
+        raise RecurrenceValueError, "Frequency must be a hash (see documentation)"
+      end
+    end
+  end
+end

data/lib/gcal4ruby/service.rb

@@ -0,0 +1,100 @@
+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
+  AUTH_TYPE_OAUTH = 'OAuth'
+  
+  attr_accessor :account, :auth_token, :check_public, :auth_type
+  
+  def initialize(attributes = {})
+    super()
+    attributes.each do |key, value|
+      self.send("#{key}=", value)
+    end    
+    @check_public ||= true
+  end
+
+  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
+      @auth_type = 'ClientLogin'
+      return true
+    else
+      raise AuthenticationFailed
+    end
+  end
+  
+  # added authsub authentication.  pass in the upgraded authsub token and the username/email address
+  def authsub_authenticate(authsub_token, account)
+    @auth_token = authsub_token
+    @account = account
+    @auth_type = 'AuthSub'
+    return true
+  end
+  
+  def oauth_authenticate(access_token)
+    @auth_token = access_token
+    @auth_type = AUTH_TYPE_OAUTH
+  end
+  
+  def oauth?
+    @auth_type == AUTH_TYPE_OAUTH
+  end
+
+  #Returns an array of Calendar objects for each calendar associated with 
+  #the authenticated account.
+  def calendars
+    unless @auth_token
+      raise NotAuthenticated
+    end
+    ret = send_get(CALENDAR_LIST_FEED+"?max-results=100")
+    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
+  
+  # This is for building a composite calendar
+  # I'm sure it doesn't work, needs review!
+  def to_iframe(cals, params = {})
+    calendar_set = case cals
+      when :all then calendars
+      when :first then calendars[0]
+      else cals
+    end
+
+    units = calendar_set.collect do |cal|
+      "src=#{cal.id}" + cal.build_options_set(params).join("&amp;")
+    end
+          
+    "<iframe src='http://www.google.com/calendar/embed?#{units.join("&amp;")}' width='#{params[:width]}' height='#{params[:height]}' frameborder='#{params[:border]}' scrolling='no'></iframe>"
+  end
+end
+
+end

data/test/unit.rb

@@ -0,0 +1,180 @@
+#!/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
+  event_recurrence_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 event_recurrence_test
+  puts "---Starting Event Recurrence Test---"
+  
+  @first_start = Time.now
+  @first_end = Time.now+3600
+  @first_freq = {'weekly' => ['TU']}
+  @second_start = Time.now+86000
+  @second_end = Time.now+89600
+  @second_freq = {'weekly' => ['SA']}
+  
+  puts "1. Create Recurring Event"
+  event = Event.new(@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})
+  if event.save 
+    successful event.to_xml
+  else
+    failed("recurrence = "+event.recurrence.to_s)
+  end
+  
+  puts "2. Edit Recurrence"
+  event.title = "Edited recurring title"
+  event.recurrence = Recurrence.new({:start => @second_start, :end => @second_end, :frequency => @second_freq})
+  if event.save 
+    successful event.to_xml
+  else
+    failed
+  end
+  
+  puts "3. 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