Class: Google::Calendar

Inherits:

Object

• Object
• Google::Calendar

show all

Defined in:

lib/google/calendar.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) app_name

  Calendar attributes.

• - (Object) auth_url

  Calendar attributes.

• - (Object) calendar

  Calendar attributes.

• - (Object) connection

  Calendar attributes.

• - (Object) password

  Calendar attributes.

• - (Object) username

  Calendar attributes.

Instance Method Summary (collapse)

• - (Object) create_event(&blk)

  Creates a new event and immediatly saves it.

• - (Object) delete_event(event)

  Deletes the specified event.

• - (Object) display_color
• - (Object) events

  Find all of the events associated with this calendar.

• - (Object) find_event_by_id(id)

  Attempts to find the event specified by the id.

• - (Object) find_events(query)

  This is equivalnt to running a search in the google calendar web application.

• - (Object) find_events_in_range(start_min, start_max, options = {})

  Find all of the events associated with this calendar that start in the given time frame.

• - (Object) find_or_create_event_by_id(id, &blk)

  looks for the spedified event id.

• - (Calendar) initialize(params) constructor

  A new instance of Calendar.

• - (Object) reload

  Explicitly reload the connection to google calendar.

• - (Object) save_event(event)

  Saves the specified event.

34
35
36
37
38
39
40
41
42
43
44
45

# File 'lib/google/calendar.rb', line 34

def initialize(params)
  self.username = params[:username]
  self.password = params[:password]
  self.calendar = params[:calendar]
  self.app_name = params[:app_name]
  self.auth_url = params[:auth_url]

  self.connection = Connection.new(:username => username,
                               :password => password,
                               :app_name => app_name,
                               :auth_url => auth_url)
end

32
33
34

# File 'lib/google/calendar.rb', line 32

def app_name
  @app_name
end

32
33
34

# File 'lib/google/calendar.rb', line 32

def auth_url
  @auth_url
end

32
33
34

# File 'lib/google/calendar.rb', line 32

def calendar
  @calendar
end

32
33
34

# File 'lib/google/calendar.rb', line 32

def connection
  @connection
end

32
33
34

# File 'lib/google/calendar.rb', line 32

def password
  @password
end

32
33
34

# File 'lib/google/calendar.rb', line 32

def username
  @username
end

# Use a block
cal.create_event do |e|
  e.title = "A New Event"
  e.where = "Room 101"
end

# Don't use a block (need to call save maunally)
event  = cal.create_event
event.title = "A New Event"
event.where = "Room 101"
event.save

115
116
117

# File 'lib/google/calendar.rb', line 115

def create_event(&blk)
  setup_event(Event.new, &blk)
end

140
141
142

# File 'lib/google/calendar.rb', line 140

def delete_event(event)
  @connection.send(Addressable::URI.parse(events_url + "/#{event.id}"), :delete)
end

165
166
167

# File 'lib/google/calendar.rb', line 165

def display_color
  calendar_data.xpath("//entry[title='#{@calendar}']/color/@value").first.value
end

Returns:
 nil if nothing found.
 a single event if only one found.
 an array of events if many found.

53
54
55

# File 'lib/google/calendar.rb', line 53

def events
  event_lookup()
end

Returns:
 nil if nothing found.
 a single event if only one found.
 an array of events if many found.

94
95
96
97

# File 'lib/google/calendar.rb', line 94

def find_event_by_id(id)
  return nil unless id && id.strip != ''
  event_lookup("/#{id}")
end

Returns:
 nil if nothing found.
 a single event if only one found.
 an array of events if many found.

67
68
69

# File 'lib/google/calendar.rb', line 67

def find_events(query)
  event_lookup("?q=#{query}")
end

Returns:
 nil if nothing found.
 a single event if only one found.
 an array of events if many found.

79
80
81
82
83
84
85
86

# File 'lib/google/calendar.rb', line 79

def find_events_in_range(start_min, start_max,options = {})
	options[:max_results] ||=  25
  formatted_start_min = start_min.strftime("%Y-%m-%dT%H:%M:%S")
  formatted_start_max = start_max.strftime("%Y-%m-%dT%H:%M:%S")
  query = "?start-min=#{formatted_start_min}&start-max=#{formatted_start_max}&recurrence-expansion-start=#{formatted_start_min}&recurrence-expansion-end=#{formatted_start_max}"
	query = "#{query}&max-results=#{options[:max_results]}"
  event_lookup(query)
end

124
125
126

# File 'lib/google/calendar.rb', line 124

def find_or_create_event_by_id(id, &blk)
  setup_event(find_event_by_id(id) || Event.new, &blk)
end

def calendar
  @calendar ||= Google::Calendar.new :username => "foo@gmail.com", :password => "bar"
end

157
158
159
160
161
162
163

# File 'lib/google/calendar.rb', line 157

def reload
  self.connection = Connection.new(:username => username,
                               :password => password,
                               :app_name => app_name,
                               :auth_url => auth_url)
  self
end

131
132
133
134
135

# File 'lib/google/calendar.rb', line 131

def save_event(event)
  method = (event.id == nil || event.id == '') ? :post : :put
  query_string = (method == :put) ? "/#{event.id}" : ''
  @connection.send(Addressable::URI.parse(events_url + query_string), method, event.to_xml)
end