edave-gcal4ruby 0.6.0

data/lib/gcal4ruby/service.rb

@@ -0,0 +1,196 @@
+# 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
+    @@calendar_list_feed = 'www.google.com/calendar/feeds/default/owncalendars/full'
+    
+    # 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
+    attr_accessor :check_public
+    
+    #Accepts an optional attributes hash for initialization values
+    def initialize(attributes = {}, service = nil)
+      # If the user has specified the type of GData4Ruby class they want, instantiate it
+      if(service != nil)
+        @gdata_service = GData4Ruby.const_get(service).new(attributes)
+      end
+      # Otherwise use the default service
+      @gdata_service ||= GData4Ruby::Service.new(attributes)
+      attributes.each do |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
+    
+    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  
+    # If authentication succeeds, returns true, otherwise raises the AuthenticationFailed error.
+    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(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.
+    def calendars
+      ret = send_request(GData4Ruby::Request.new(:get, create_url(@@calendar_list_feed + "?fields=entry(@gd:*,id,title)"), 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, {:debug => debug})
+        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
+     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, {: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:
+    #   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='#{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

data/test/unit.rb

@@ -0,0 +1,228 @@
+#!/usr/bin/ruby
+
+# Prefix LOAD_PATH with lib sub-directory to ensure we're
+# testing the intended version.
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+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
+  all_day_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 all_day_recurrence_test
+  puts "---Starting All Day Recurrence Test---"
+
+  start_time = Time.now
+  end_time = start_time + 60*60*24
+  freq = {'weekly' => ['MO','TU']}
+
+  puts "1. Create All Day Recurring Event"
+  event = Event.new(@service)
+  event.calendar = @service.calendars[0]
+  event.title = "Test All Day Recurring Event"
+  event.content = "Test all day event content"
+  event.recurrence = Recurrence.new({:start_time => start_time, :end_time => end_time, :frequency => freq, :all_day => true})
+  if event.save
+    successful event.to_xml
+  else
+    failed("recurrence = "+event.recurrence.to_s)
+  end
+
+  puts "2. Validate returned event is an all day event"
+  if event.recurrence.all_day
+    successful
+  else
+    failed("recurrence = "+event.recurrence.to_s)
+  end
+
+  puts "3. Validate frequency of event"
+  if event.recurrence.frequency['weekly'] == ['MO','TU']
+    successful
+  else
+    failed("recurrence = "+event.recurrence.to_s)
+  end
+
+  puts "4. 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,94 @@
+--- !ruby/object:Gem::Specification 
+name: edave-gcal4ruby
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
+platform: ruby
+authors: 
+- Mike Reich
+- Anthony Underwood
+- David Pitman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: edave-gdata4ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- mike@seabourneconsulting.com
+- email2ants@gmail.com
+- ui-design@vestaldesign.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- CHANGELOG
+- README
+- lib/gcal4ruby.rb
+- lib/gcal4ruby/calendar.rb
+- lib/gcal4ruby/event.rb
+- lib/gcal4ruby/recurrence.rb
+- lib/gcal4ruby/service.rb
+- test/unit.rb
+has_rdoc: true
+homepage: https://github.com/edave/GData4Ruby
+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: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: A full featured wrapper for interacting with the Google Calendar API
+test_files: 
+- test/unit.rb