Class: Zimbra::Appointment::Invite

Inherits:
Object
  • Object
show all
Defined in:
lib/zimbra/appointment/invite.rb

Constant Summary collapse

ATTRS = 
[
  :appointment, 
  :id, :recurrence_id, :sequence_number, 
  
  :start_date_time, :end_date_time, :date,
  :name, :fragment, :description, :alarm, :alarm_zimbra_attributes, :alarm_attributes, :recurrence_rule, :recurrence_rule_zimbra_attributes, :recurrence_rule_attributes, 
  :attendees, :attendees_attributes, :attendees_zimbra_attributes, 
  :organizer_email_address, :is_organizer, :computed_free_busy_status,
  :free_busy_setting, :invite_status, :all_day, :visibility, :location, 
  :transparency, :replies, :never_sent,
  
  :comment, :recurrence_id_utc, :exception
]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Invite

Returns a new instance of Invite.



90
91
92
 
# File 'lib/zimbra/appointment/invite.rb', line 90

def initialize(args = {})
  self.attributes = args
end

Class Method Details

.new_from_zimbra_attributes(zimbra_attributes) ⇒ Object 



21
22
23
 
# File 'lib/zimbra/appointment/invite.rb', line 21

def new_from_zimbra_attributes(zimbra_attributes)
  new(parse_zimbra_attributes(zimbra_attributes))
end

.parse_zimbra_attributes(zimbra_attributes) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/zimbra/appointment/invite.rb', line 25

def parse_zimbra_attributes(zimbra_attributes)
  zimbra_attributes = Zimbra::Hash.symbolize_keys(zimbra_attributes.dup, true)
      
  attrs = {}
  
  attrs[:appointment] = zimbra_attributes[:appointment] if zimbra_attributes.has_key?(:appointment)
  
  if zimbra_attributes.has_key?(:attributes)
    attrs.merge!({
      :id              => zimbra_attributes[:attributes][:id],
      :recurrence_id   => zimbra_attributes[:attributes][:recurId],
      :sequence_number => zimbra_attributes[:attributes][:seq],
      })
  end
  
  zimbra_attributes = zimbra_attributes[:comp]
  return attrs unless zimbra_attributes
  
  attrs.merge!({
    :fragment                          => zimbra_attributes[:fr],
    :description                       => zimbra_attributes[:desc],
    :comment                           => zimbra_attributes[:comment],
    :alarm_zimbra_attributes           => zimbra_attributes[:alarm],
    :recurrence_rule_zimbra_attributes => zimbra_attributes[:recur],
    :attendees_zimbra_attributes       => zimbra_attributes[:at],
    :never_sent                        => zimbra_attributes[:neverSent]
    })
      
  if zimbra_attributes[:s]
    attrs[:start_date_time] = zimbra_attributes[:s][:attributes][:u]
  else
  
  end

  if zimbra_attributes[:e]
    attrs[:end_date_time] = zimbra_attributes[:e][:attributes][:u]
  end
  
  if zimbra_attributes[:exceptId] && zimbra_attributes[:exceptId][:attributes]
    attrs[:exception] = zimbra_attributes[:exceptId][:attributes]
  end
  
  attrs[:organizer_email_address] = zimbra_attributes[:or][:attributes][:a] rescue nil

  return attrs unless zimbra_attributes.has_key?(:attributes)

  attrs.merge!({
    :name                      => zimbra_attributes[:attributes][:name],
    :computed_free_busy_status => zimbra_attributes[:attributes][:fba],
    :free_busy_setting         => zimbra_attributes[:attributes][:fb],
    :date                      => zimbra_attributes[:attributes][:d],
    :invite_status             => zimbra_attributes[:attributes][:status],
    :all_day                   => zimbra_attributes[:attributes][:allDay],
    :visibility                => zimbra_attributes[:attributes][:class],
    :location                  => zimbra_attributes[:attributes][:loc],
    :date                      => zimbra_attributes[:attributes][:d],
    :transparency              => zimbra_attributes[:attributes][:transp],
    :is_organizer              => zimbra_attributes[:attributes][:isOrg],
    :recurrence_id_utc         => zimbra_attributes[:attributes][:ridZ]
    })
  
  attrs
end

Instance Method Details

#alarm_attributes=(attributes) ⇒ Object 



150
151
152
 
# File 'lib/zimbra/appointment/invite.rb', line 150

def alarm_attributes=(attributes)
  @alarm = attributes ? Zimbra::Appointment::Alarm.new(attributes.merge(:appointment_invite => self)) : nil
end

#alarm_zimbra_attributes=(attributes) ⇒ Object 



154
155
156
 
# File 'lib/zimbra/appointment/invite.rb', line 154

def alarm_zimbra_attributes=(attributes)
  @alarm = attributes ? Zimbra::Appointment::Alarm.new_from_zimbra_attributes(attributes.merge(:appointment_invite => self)) : nil
end

#all_day=(val) ⇒ Object 



194
195
196
 
# File 'lib/zimbra/appointment/invite.rb', line 194

def all_day=(val)
  @all_day = parse_all_day(val)
end

#attendees_attributes=(attributes) ⇒ Object 



143
144
145
146
147
148
 
# File 'lib/zimbra/appointment/invite.rb', line 143

def attendees_attributes=(attributes)
  return @attendees = [] unless attributes

  attributes = attributes.is_a?(Array) ? attributes : [attributes]
  @attendees = attributes.collect { |attrs| Zimbra::Appointment::Attendee.new(attrs) }
end

#attendees_zimbra_attributes=(attributes) ⇒ Object 



136
137
138
139
140
141
 
# File 'lib/zimbra/appointment/invite.rb', line 136

def attendees_zimbra_attributes=(attributes)
  return @attendees = [] unless attributes

  attributes = attributes.is_a?(Array) ? attributes : [attributes]
  @attendees = attributes.collect { |attrs| Zimbra::Appointment::Attendee.new_from_zimbra_attributes(attrs[:attributes]) }
end

#attributes=(args = {}) ⇒ Object

take attributes by the xml name or our more descriptive name



95
96
97
98
99
100
101
102
103
 
# File 'lib/zimbra/appointment/invite.rb', line 95

def attributes=(args = {})
  ATTRS.each do |attr_name|
    if args.has_key?(attr_name)
      self.send(:"#{attr_name}=", args[attr_name])
    elsif args.has_key?(attr_name.to_s)
      self.send(:"#{attr_name}=", args[attr_name.to_s])
    end
  end
end

#cancel ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/zimbra/appointment/invite.rb', line 115

def cancel
  return false unless appointment
  return false if appointment.new_record?
  
  Zimbra::AppointmentService.cancel(appointment, id)
end

#computed_free_busy_status=(val) ⇒ Object 



158
159
160
 
# File 'lib/zimbra/appointment/invite.rb', line 158

def computed_free_busy_status=(val)
  @computed_free_busy_status = parse_free_busy_status(val)
end

#create_xml(document) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/zimbra/appointment/invite.rb', line 210

def create_xml(document)
  document.set_attr "id", id if id
  document.set_attr "status", invite_status_to_zimbra if invite_status
  document.set_attr "isOrg", is_organizer ? 1 : 0
  #document.set_attr "d", date.to_i * 1000 if date
  
  document.add "comp" do |comp|
    comp.set_attr "loc", location if location
    comp.set_attr "allDay", all_day ? 1 : 0
    comp.set_attr "class", visibility_to_zimbra if visibility
    comp.set_attr "fb", free_busy_setting_to_zimbra if free_busy_setting
    comp.set_attr "isOrg", is_organizer ? 1 : 0
    comp.set_attr "name", name
    comp.set_attr "transp", transparency_to_zimbra if transparency
    comp.set_attr "d", date.to_i * 1000 if date
    
    if is_organizer
      comp.set_attr "neverSent", never_sent ? 1 : 0
    end
    
    if description && !description.empty?
      comp.add "desc", description
    end
    
    if comment && !comment.empty?
      comp.add "comment", comment
    end
    
    comp.add "s" do |s_element|
      s_element.set_attr "u", start_date_time.to_i * 1000
      s_element.set_attr "d", start_date_time.utc.strftime("%Y%m%dT%H%M%SZ")
    end
    
    comp.add "e" do |e_element|
      e_element.set_attr "u", end_date_time.to_i * 1000
      e_element.set_attr "d", end_date_time.utc.strftime("%Y%m%dT%H%M%SZ")
    end
    
    if alarm
      comp.add "alarm" do |alarm_element|
        alarm_element.set_attr "action", "DISPLAY"
        
        alarm.create_xml(alarm_element)
      end
    end
    
    if recurrence_rule
      comp.add "recur" do |recur_element|
        recur_element.add "add" do |add_element|
          recurrence_rule.create_xml(add_element)
        end
      end
    end
    
    if attendees && attendees.count > 0
      attendees.each do |attendee|
        attendee.create_xml(comp)
      end
    end
    
    if organizer_email_address
      comp.add "or" do |or_element|
        or_element.set_attr "a", organizer_email_address
      end
    end
    
    if exception
      exception.create_xml(comp)
    end
  end
  # 
  # ATTRS = [
  #  :recurrence_id, :sequence_number, :replies,
  # 
  #   :, :recurrence_id_utc, 
end

#date=(val) ⇒ Object 



206
207
208
 
# File 'lib/zimbra/appointment/invite.rb', line 206

def date=(val)
  @date = val.is_a?(Integer) ? parse_date_in_seconds(val) : val
end

#end_date_time=(val) ⇒ Object 



202
203
204
 
# File 'lib/zimbra/appointment/invite.rb', line 202

def end_date_time=(val)
  @end_date_time = val.is_a?(Integer) ? parse_date_in_seconds(val) : val
end

#exception=(exception_attributes) ⇒ Object 



122
123
124
125
126
 
# File 'lib/zimbra/appointment/invite.rb', line 122

def exception=(exception_attributes)
  return @exception = nil unless exception_attributes
  
  @exception = Zimbra::Appointment::RecurException.new_from_zimbra_attributes(exception_attributes)
end

#free_busy_setting=(val) ⇒ Object 



166
167
168
 
# File 'lib/zimbra/appointment/invite.rb', line 166

def free_busy_setting=(val)
  @free_busy_setting = parse_free_busy_status(val)
end

#free_busy_setting_to_zimbra ⇒ Object 



162
163
164
 
# File 'lib/zimbra/appointment/invite.rb', line 162

def free_busy_setting_to_zimbra
  possible_free_busy_status_values.find { |k ,v| v == free_busy_setting }.first rescue free_busy_setting
end

#invite_status=(val) ⇒ Object 



170
171
172
 
# File 'lib/zimbra/appointment/invite.rb', line 170

def invite_status=(val)
  @invite_status = parse_invite_status(val)
end

#invite_status_to_zimbra ⇒ Object 



174
175
176
 
# File 'lib/zimbra/appointment/invite.rb', line 174

def invite_status_to_zimbra
  possible_invite_status_values.find { |k, v| v == invite_status }.first rescue invite_status
end

#recurrence_rule_attributes=(attributes) ⇒ Object 



128
129
130
 
# File 'lib/zimbra/appointment/invite.rb', line 128

def recurrence_rule_attributes=(attributes)
  @recurrence_rule = attributes ? Zimbra::Appointment::RecurRule.new(attributes) : nil
end

#recurrence_rule_zimbra_attributes=(attributes) ⇒ Object 



132
133
134
 
# File 'lib/zimbra/appointment/invite.rb', line 132

def recurrence_rule_zimbra_attributes=(attributes)
  @recurrence_rule = attributes ? Zimbra::Appointment::RecurRule.new_from_zimbra_attributes(attributes) : nil
end

#save ⇒ Object 



105
106
107
108
109
110
111
112
113
 
# File 'lib/zimbra/appointment/invite.rb', line 105

def save
  return false unless appointment
  
  if appointment.new_record?
    appointment.save
  else
    Zimbra::AppointmentService.update(appointment, id)
  end
end

#start_date_time=(val) ⇒ Object 



198
199
200
 
# File 'lib/zimbra/appointment/invite.rb', line 198

def start_date_time=(val)
  @start_date_time = val.is_a?(Integer) ? parse_date_in_seconds(val) : val
end

#transparency=(val) ⇒ Object 



190
191
192
 
# File 'lib/zimbra/appointment/invite.rb', line 190

def transparency=(val)
  @transparency = parse_transparency_status(val)
end

#transparency_to_zimbra ⇒ Object 



186
187
188
 
# File 'lib/zimbra/appointment/invite.rb', line 186

def transparency_to_zimbra
  possible_transparency_status_values.find { |k, v| v == transparency }.first rescue transparency
end

#visibility=(val) ⇒ Object 



178
179
180
 
# File 'lib/zimbra/appointment/invite.rb', line 178

def visibility=(val)
  @visibility = parse_visibility_status(val)
end

#visibility_to_zimbra ⇒ Object 



182
183
184
 
# File 'lib/zimbra/appointment/invite.rb', line 182

def visibility_to_zimbra
  possible_visibility_values.find { |k, v| v == visibility }.first rescue visibility
end