railsware-gcal4ruby 0.5.5

data/lib/gcal4ruby/recurrence.rb

@@ -0,0 +1,273 @@
+# Author:: Mike Reich (mike@seabourneconsulting.com)
+# Copyright:: Copyright (C) 2010 Mike Reich
+# License:: GPL v2
+#--
+# Licensed under the General Public License (GPL), Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+# Feel free to use and update, but be sure to contribute your
+# code back to the project and attribute as required by the license.
+#++
+
+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_time
+    #The event end date/time
+    attr_reader :end_time
+    #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 = Time.parse_complete(value)
+          when 'DTSTART;VALUE=DATE'
+            @start_time = Time.parse(value)
+            @all_day = true
+          when 'DTSTART;VALUE=DATE-TIME'
+            @start_time = Time.parse_complete(value)
+          when 'DTEND'
+            @end_time = Time.parse_complete(value)
+          when 'DTEND;VALUE=DATE'
+            @end_time = Time.parse(value)
+          when 'DTEND;VALUE=DATE-TIME'
+            @end_time = 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
+    
+    def to_s
+      output = ''
+      if @frequency
+        f = ''
+        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.downcase} " if key != 'interval'
+          case key.downcase
+            when "secondly"
+              by += "every #{value} second"
+            when "minutely"
+              by += "every #{value} minute"
+            when "hourly"
+              by += "every #{value} hour"
+            when "weekly"
+              by += "on #{value}" if value
+            when "monthly"
+              by += "on #{value}"
+            when "yearly"
+              by += "on the #{value} day of the year"
+            when 'interval'
+              i += "for #{value} times"
+          end
+        end
+        output += f+i+by
+      end      
+      if @repeat_until
+        output += " and repeats until #{@repeat_until.strftime("%m/%d/%Y")}"
+      end
+      output
+    end
+    
+    #Returns a string with the correctly formatted ISO 8601 recurrence rule
+    def to_recurrence_string
+      
+      output = ''
+      if @all_day
+        output += "DTSTART;VALUE=DATE:#{@start_time.utc.strftime("%Y%m%d")}\n"
+      else
+        output += "DTSTART;VALUE=DATE-TIME:#{@start_time.complete}\n"
+      end
+      if @all_day
+        output += "DTEND;VALUE=DATE:#{@end_time.utc.strftime("%Y%m%d")}\n"
+      else
+        output += "DTEND;VALUE=DATE-TIME:#{@end_time.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_time=(s)
+      if not s.is_a?(Time)
+        raise RecurrenceValueError, "Start must be a date or a time"
+      else
+        @start_time = s
+      end
+    end
+    
+    #Sets the end Date/Time. Must be a Time object.
+    def end_time=(e)
+      if not e.is_a?(Time)
+        raise RecurrenceValueError, "End must be a date or a time"
+      else
+        @end_time = 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,160 @@
+# Author:: Mike Reich (mike@seabourneconsulting.com)
+# Copyright:: Copyright (C) 2010 Mike Reich
+# License:: GPL v2
+#--
+# Licensed under the General Public License (GPL), Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+# Feel free to use and update, but be sure to contribute your
+# code back to the project and attribute as required by the license.
+#++
+require 'gdata4ruby'
+require 'gdata4ruby/gdata_object'
+require 'gdata4ruby/utils/utils'
+require 'gdata4ruby/acl/access_rule'
+require 'gcal4ruby/calendar'
+require 'gcal4ruby/event'
+require 'gcal4ruby/recurrence'
+require 'rexml/document'
+
+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 < GData4Ruby::Service
+    CALENDAR_LIST_FEED = 'http://www.google.com/calendar/feeds/default/allcalendars/full'
+    
+    #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
+    
+    #Accepts an optional attributes hash for initialization values
+    def initialize(attributes = {})
+      super(attributes)
+      attributes.each do |key, value|
+        self.send("#{key}=", value)
+      end    
+      @check_public ||= true
+    end
+    
+    def default_event_feed
+      return "http://www.google.com/calendar/feeds/#{@account}/private/full"
+    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, service='cl')
+      super(username, password, service)
+    end
+    
+    #Helper function to reauthenticate to a new Google service without having to re-set credentials.
+    def reauthenticate(service='cl')
+      authenticate(@account, @password, service)
+    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_request(GData4Ruby::Request.new(:get, CALENDAR_LIST_FEED, nil, {"max-results" => "10000"}))
+      cals = []
+      REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
+        entry = GData4Ruby::Utils.add_namespaces(entry)
+        cal = Calendar.new(self)
+        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
+      if not @auth_token
+         raise NotAuthenticated
+      end
+      ret = send_request(GData4Ruby::Request.new(:get, default_event_feed, nil, {"max-results" => "10000"}))
+      events = []
+      REXML::Document.new(ret.body).root.elements.each("entry"){}.map do |entry|
+        entry = GData4Ruby::Utils.add_namespaces(entry)
+        event = Event.new(self)
+        event.load(entry.to_s)
+        events << event
+      end
+      return events
+    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:
+    #   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.
+    #   showTitle:: set to '0' to hide the title
+    #   showDate:: set to '0' to hide the current date
+    #   showNav:: set to '0 to hide the navigation tools
+    #   showPrint:: set to '0' to hide the print icon
+    #   showTabs:: set to '0' to hide the tabs
+    #   showCalendars:: set to '0' to hide the calendars selection drop down
+    #   showTz:: set to '0' 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.
+    #   ctz:: The timezone to convert event times to
+    #3. *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 = {}, colors = {})
+      params[:height] ||= "600"
+      params[:width] ||= "600"
+      params[:title] ||= (self.account ? self.account : '')
+      params[:bgcolor] ||= "#FFFFFF"
+      params[:border] ||= "0"
+      params.each{|key, value| params[key] = CGI::escape(value)}
+      output = "#{params.to_a.collect{|a| a.join("=")}.join("&")}&"
+      
+      if cals.is_a?(Array)
+        for c in cals
+          output += "src=#{c}&"
+          if colors and colors[c]
+            output += "color=%23#{colors[c].gsub("#", "")}&"
+          end
+        end
+      elsif cals == :all
+        cal_list = calendars()
+        for c in cal_list
+          output += "src=#{c.id}&"
+        end
+      elsif cals == :first
+        cal_list = calendars()
+        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>"
+    end
+  end
+end

data/lib/gcal4ruby.rb

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

data/test/unit.rb

@@ -0,0 +1,182 @@
+#!/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, {:id => 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.exists?
+    successful
+  else
+    failed
+  end
+end
+
+def event_test
+  puts "---Starting Event Test---"
+  
+  puts "1. Create Event"
+  event = Event.new(@service)
+  event.calendar = @service.calendars[0]
+  event.title = "Test Event"
+  event.content = "Test event content"
+  event.start_time = Time.now+1800
+  event.end_time = 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, {:id => 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)
+  event.calendar = @service.calendars[0]
+  event.title = "Test Recurring Event"
+  event.content = "Test event content"
+  event.recurrence = Recurrence.new({:start_time => @first_start, :end_time => @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_time => @second_start, :end_time => @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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: railsware-gcal4ruby
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 5
+  version: 0.5.5
+platform: ruby
+authors: 
+- Mike Reich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-08 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gdata4ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  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."
+email: mike@seabourneconsulting.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- CHANGELOG
+- lib/gcal4ruby.rb
+- lib/gcal4ruby/service.rb
+- lib/gcal4ruby/calendar.rb
+- lib/gcal4ruby/event.rb
+- lib/gcal4ruby/recurrence.rb
+- test/unit.rb
+has_rdoc: true
+homepage: http://cookingandcoding.com/gcal4ruby/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: gcal4ruby
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A full featured wrapper for interacting with the Google Calendar API
+test_files: 
+- test/unit.rb