tilia-vobject 4.0.0.pre.alpha5 → 4.0.2

data/lib/tilia/v_object/i_tip.rb

@@ -1,5 +1,6 @@
 module Tilia
   module VObject
+    # Namespace of the ITip functionality
     module ITip
       require 'tilia/v_object/i_tip/i_tip_exception'
       require 'tilia/v_object/i_tip/same_organizer_for_all_components_exception'

data/lib/tilia/v_object/i_tip/broker.rb

@@ -37,7 +37,7 @@ module Tilia
         # server, but if you're writing an iTip application that doesn't deal with
         # CalDAV, you may want to ignore this parameter.
         #
-        # @var bool
+        # @return [Boolean]
         attr_accessor :schedule_agent_server_rules
 
         # The broker will try during 'parseEvent' figure out whether the change
@@ -49,7 +49,7 @@ module Tilia
         # This list is taken from:
         # * http://tools.ietf.org/html/rfc5546#section-2.1.4
         #
-        # @var string[]
+        # @return [Array<String>]
         attr_accessor :significant_change_properties
 
         # This method is used to process an incoming itip message.
@@ -78,10 +78,10 @@ module Tilia
         #
         # If the iTip message was not supported, we will always return false.
         #
-        # @param Message itip_message
-        # @param VCalendar existing_object
+        # @param [Message] itip_message
+        # @param [VCalendar] existing_object
         #
-        # @return VCalendar|null
+        # @return [VCalendar, nil]
         def process_message(itip_message, existing_object = nil)
           # We only support events at the moment.
           return false unless itip_message.component == 'VEVENT'
@@ -118,11 +118,11 @@ module Tilia
         # people. If the user was an attendee, we need to make sure that the
         # organizer gets the 'declined' message.
         #
-        # @param VCalendar|string calendar
-        # @param string|array user_href
-        # @param VCalendar|string old_calendar
+        # @param [VCalendar, String] calendar
+        # @param [String, Array<String>] user_href
+        # @param [VCalendar, String, nil] old_calendar
         #
-        # @return array
+        # @return [Array]
         def parse_event(calendar, user_href, old_calendar = nil)
           if old_calendar
             if old_calendar.is_a?(String)
@@ -196,11 +196,11 @@ module Tilia
             else
               # This is an attendee deleting the event.
               event_info['attendees'].each do |key, attendee|
-                if user_href.include?(attendee['href'])
-                  event_info['attendees'][key]['instances'] = {
-                    'master' => { 'id' => 'master', 'partstat' => 'DECLINED' }
-                  }
-                end
+                next unless user_href.include?(attendee['href'])
+
+                event_info['attendees'][key]['instances'] = {
+                  'master' => { 'id' => 'master', 'partstat' => 'DECLINED' }
+                }
               end
             end
 
@@ -220,7 +220,7 @@ module Tilia
             end
           end
 
-          return []
+          []
         end
 
         protected
@@ -231,10 +231,10 @@ module Tilia
         # invite, or an update to an existing one.
         #
         #
-        # @param Message itip_message
-        # @param VCalendar existing_object
+        # @param [Message] itip_message
+        # @param [VCalendar, nil] existing_object
         #
-        # @return VCalendar|null
+        # @return [VCalendar, nil]
         def process_message_request(itip_message, existing_object = nil)
           if !existing_object
             # This is a new invite, and we're just going to copy over
@@ -264,10 +264,10 @@ module Tilia
         # attendee got removed from an event, or an event got cancelled
         # altogether.
         #
-        # @param Message itip_message
-        # @param VCalendar existing_object
+        # @param [Message] itip_message
+        # @param [VCalendar, nil] existing_object
         #
-        # @return VCalendar|null
+        # @return [VCalendar, nil]
         def process_message_cancel(itip_message, existing_object = nil)
           if !existing_object
             # The event didn't exist in the first place, so we're just
@@ -287,10 +287,10 @@ module Tilia
         # The message is a reply. This is for example an attendee telling
         # an organizer he accepted the invite, or declined it.
         #
-        # @param Message itip_message
-        # @param VCalendar existing_object
+        # @param [Message] itip_message
+        # @param [VCalendar, nil] existing_object
         #
-        # @return VCalendar|null
+        # @return [VCalendar, nil]
         def process_message_reply(itip_message, existing_object = nil)
           # A reply can only be processed based on an existing object.
           # If the object is not available, the reply is ignored.
@@ -317,33 +317,33 @@ module Tilia
             recur_id = vevent.key?('RECURRENCE-ID') ? vevent['RECURRENCE-ID'].value : 'master'
             master_object = vevent if recur_id == 'master'
 
-            if instances.key?(recur_id)
-              attendee_found = false
-              if vevent.key?('ATTENDEE')
-                vevent['ATTENDEE'].each do |attendee|
-                  if attendee.value == itip_message.sender
-                    attendee_found = true
-                    attendee['PARTSTAT'] = instances[recur_id]
-                    attendee['SCHEDULE-STATUS'] = request_status
-                    # Un-setting the RSVP status, because we now know
-                    # that the attendee already replied.
-                    attendee.delete('RSVP')
-                    break
-                  end
-                end
-              end
+            next unless instances.key?(recur_id)
 
-              unless attendee_found
-                # Adding a new attendee. The iTip documentation calls this
-                # a party crasher.
-                attendee = vevent.add('ATTENDEE', itip_message.sender, 'PARTSTAT' => instances[recur_id])
-                if itip_message.sender_name
-                  attendee['CN'] = itip_message.sender_name
-                end
+            attendee_found = false
+            if vevent.key?('ATTENDEE')
+              vevent['ATTENDEE'].each do |attendee|
+                next unless attendee.value == itip_message.sender
+
+                attendee_found = true
+                attendee['PARTSTAT'] = instances[recur_id]
+                attendee['SCHEDULE-STATUS'] = request_status
+                # Un-setting the RSVP status, because we now know
+                # that the attendee already replied.
+                attendee.delete('RSVP')
+                break
               end
+            end
 
-              instances.delete(recur_id)
+            unless attendee_found
+              # Adding a new attendee. The iTip documentation calls this
+              # a party crasher.
+              attendee = vevent.add('ATTENDEE', itip_message.sender, 'PARTSTAT' => instances[recur_id])
+              if itip_message.sender_name
+                attendee['CN'] = itip_message.sender_name
+              end
             end
+
+            instances.delete(recur_id)
           end
 
           unless master_object
@@ -380,17 +380,17 @@ module Tilia
             attendee_found = false
             if new_object.key?('ATTENDEE')
               new_object['ATTENDEE'].each do |attendee|
-                if attendee.value == itip_message.sender
-                  attendee_found = true
-                  attendee['PARTSTAT'] = partstat
-                  break
-                end
+                next unless attendee.value == itip_message.sender
+
+                attendee_found = true
+                attendee['PARTSTAT'] = partstat
+                break
               end
             end
 
             unless attendee_found
               # Adding a new attendee
-              attendee = new_object.add('ATTENDEE', itip_message.sender, 'PARTSTAT' => partstat )
+              attendee = new_object.add('ATTENDEE', itip_message.sender, 'PARTSTAT' => partstat)
 
               if itip_message.sender_name
                 attendee['CN'] = itip_message.sender_name
@@ -410,11 +410,11 @@ module Tilia
         # We will detect which attendees got added, which got removed and create
         # specific messages for these situations.
         #
-        # @param VCalendar calendar
-        # @param array event_info
-        # @param array old_event_info
+        # @param [VCalendar] calendar
+        # @param [Hash] event_info
+        # @param [Hash] old_event_info
         #
-        # @return array
+        # @return [Array<Message>]
         def parse_event_for_organizer(calendar, event_info, old_event_info)
           # Merging attendee lists.
           attendees = {}
@@ -478,6 +478,12 @@ module Tilia
               end
 
               event.add(calendar['VEVENT']['DTSTART'].clone)
+              if calendar['VEVENT'].key?('DTEND')
+                event.add(calendar['VEVENT']['DTEND'].clone)
+              elsif calendar['VEVENT'].key?('DURATION')
+                event.add(calendar['VEVENT']['DURATION'].clone)
+              end
+
               org = event.add('ORGANIZER', event_info['organizer'])
               if event_info['organizer_name']
                 org['CN'] = event_info['organizer_name']
@@ -519,10 +525,10 @@ module Tilia
                   # We need to find a list of events that the attendee
                   # is not a part of to add to the list of exceptions.
                   exceptions = []
-                  event_info['instances'].each do |instance_id, _vevent|
-                    unless attendee['newInstances'].key?(instance_id)
-                      exceptions << instance_id
-                    end
+                  event_info['instances'].each do |id, _vevent|
+                    next if attendee['newInstances'].key?(id)
+
+                    exceptions << id
                   end
 
                   # If there were exceptions, we need to add it to an
@@ -540,15 +546,15 @@ module Tilia
                   current_event['ORGANIZER'].delete('SCHEDULE-FORCE-SEND')
                   current_event['ORGANIZER'].delete('SCHEDULE-STATUS')
 
-                  current_event['ATTENDEE'].each do |attendee|
-                    attendee.delete('SCHEDULE-FORCE-SEND')
-                    attendee.delete('SCHEDULE-STATUS')
+                  current_event['ATTENDEE'].each do |event_attendee|
+                    event_attendee.delete('SCHEDULE-FORCE-SEND')
+                    event_attendee.delete('SCHEDULE-STATUS')
 
                     # We're adding PARTSTAT=NEEDS-ACTION to ensure that
                     # iOS shows an "Inbox Item"
-                    unless attendee.key?('PARTSTAT')
-                      attendee['PARTSTAT'] = 'NEEDS-ACTION'
-                    end
+                    next if event_attendee.key?('PARTSTAT')
+
+                    event_attendee['PARTSTAT'] = 'NEEDS-ACTION'
                   end
                 end
 
@@ -560,19 +566,19 @@ module Tilia
             messages << message
           end
 
-          return messages
+          messages
         end
 
         # Parse an event update for an attendee.
         #
         # This function figures out if we need to send a reply to an organizer.
         #
-        # @param VCalendar calendar
-        # @param array event_info
-        # @param array old_event_info
-        # @param string attendee
+        # @param [VCalendar] calendar
+        # @param [Hash] event_info
+        # @param [Hash] old_event_info
+        # @param [String] attendee
         #
-        # @return Message[]
+        # @return [Array<Message>]
         def parse_event_for_attendee(calendar, event_info, old_event_info, attendee)
           if schedule_agent_server_rules && event_info['organizer_schedule_agent'] == 'CLIENT'
             return []
@@ -616,16 +622,16 @@ module Tilia
           # We only need to do that though, if the master event is not declined.
           if instances.key?('master') && instances['master']['newstatus'] != 'DECLINED'
             event_info['exdate'].each do |ex_date|
-              unless old_event_info['exdate'].include?(ex_date)
-                if instances.key?(ex_date)
-                  instances[ex_date]['newstatus'] = 'DECLINED'
-                else
-                  instances[ex_date] = {
-                    'id'        => ex_date,
-                    'oldstatus' => nil,
-                    'newstatus' => 'DECLINED'
-                  }
-                end
+              next if old_event_info['exdate'].include?(ex_date)
+
+              if instances.key?(ex_date)
+                instances[ex_date]['newstatus'] = 'DECLINED'
+              else
+                instances[ex_date] = {
+                  'id'        => ex_date,
+                  'oldstatus' => nil,
+                  'newstatus' => 'DECLINED'
+                }
               end
             end
           end
@@ -672,6 +678,12 @@ module Tilia
               instance_obj = event_info['instances'][instance['id']]
 
               event.add(instance_obj['DTSTART'].clone)
+              if instance_obj.key?('DTEND')
+                event.add(instance_obj['DTEND'].clone)
+              elsif instance_obj.key?('DURATION')
+                event.add(instance_obj['DURATION'].clone)
+              end
+
               if instance_obj.key?('SUMMARY')
                 event.add('SUMMARY', instance_obj['SUMMARY'].value)
               elsif !summary.blank?
@@ -686,9 +698,9 @@ module Tilia
 
               # Treat is as a DATE field
               if instance['id'].size <= 8
-                recur = event.add('DTSTART', dt, 'VALUE' => 'DATE')
+                event.add('DTSTART', dt, 'VALUE' => 'DATE')
               else
-                recur = event.add('DTSTART', dt)
+                event.add('DTSTART', dt)
               end
 
               event.add('SUMMARY', summary) unless summary.blank?
@@ -698,9 +710,9 @@ module Tilia
               dt = Tilia::VObject::DateTimeParser.parse(instance['id'], event_info['timezone'])
               # Treat is as a DATE field
               if instance['id'].size <= 8
-                recur = event.add('RECURRENCE-ID', dt, 'VALUE' => 'DATE')
+                event.add('RECURRENCE-ID', dt, 'VALUE' => 'DATE')
               else
-                recur = event.add('RECURRENCE-ID', dt)
+                event.add('RECURRENCE-ID', dt)
               end
             end
 
@@ -736,9 +748,9 @@ module Tilia
         # 4. attendees
         # 5. instances
         #
-        # @param VCalendar calendar
+        # @param [VCalendar] calendar
         #
-        # @return array
+        # @return [Hash]
         def parse_event_info(calendar = nil)
           uid = nil
           organizer = nil
@@ -780,14 +792,18 @@ module Tilia
                   fail Tilia::VObject::ITip::SameOrganizerForAllComponentsException, 'Every instance of the event must have the same organizer.'
                 end
               end
-              organizer_force_send =
-                  vevent['ORGANIZER'].key?('SCHEDULE-FORCE-SEND') ?
-                  vevent['ORGANIZER']['SCHEDULE-FORCE-SEND'].to_s.upcase :
-                  nil
-              organizer_schedule_agent =
-                  vevent['ORGANIZER'].key?('SCHEDULE-AGENT') ?
-                  vevent['ORGANIZER']['SCHEDULE-AGENT'].to_s.upcase :
-                  'SERVER'
+
+              if vevent['ORGANIZER'].key?('SCHEDULE-FORCE-SEND')
+                organizer_force_send = vevent['ORGANIZER']['SCHEDULE-FORCE-SEND'].to_s.upcase
+              else
+                organizer_force_send = nil
+              end
+
+              if vevent['ORGANIZER'].key?('SCHEDULE-AGENT')
+                organizer_schedule_agent = vevent['ORGANIZER']['SCHEDULE-AGENT'].to_s.upcase
+              else
+                organizer_schedule_agent = 'SERVER'
+              end
             end
 
             if sequence.nil? && vevent.key?('SEQUENCE')
@@ -796,7 +812,7 @@ module Tilia
 
             if vevent.key?('EXDATE')
               vevent.select('EXDATE').each do |val|
-                exdate = exdate + val.parts
+                exdate += val.parts
               end
               exdate.sort!
             end
@@ -816,15 +832,17 @@ module Tilia
                   next
                 end
 
-                part_stat =
-                    attendee.key?('PARTSTAT') ?
-                    attendee['PARTSTAT'].to_s.upcase :
-                    'NEEDS-ACTION'
+                if attendee.key?('PARTSTAT')
+                  part_stat = attendee['PARTSTAT'].to_s.upcase
+                else
+                  part_stat = 'NEEDS-ACTION'
+                end
 
-                force_send =
-                    attendee.key?('SCHEDULE-FORCE-SEND') ?
-                    attendee['SCHEDULE-FORCE-SEND'].to_s.upcase :
-                    nil
+                if attendee.key?('SCHEDULE-FORCE-SEND')
+                  force_send = attendee['SCHEDULE-FORCE-SEND'].to_s.upcase
+                else
+                  force_send = nil
+                end
 
                 if attendees.key?(attendee.normalized_value)
                   attendees[attendee.normalized_value]['instances'][recur_id] = {
@@ -851,17 +869,17 @@ module Tilia
             end
 
             significant_change_properties.each do |prop|
-              if vevent.key?(prop)
-                property_values = vevent.select(prop)
+              next unless vevent.key?(prop)
 
-                significant_change_hash += prop + ':'
+              property_values = vevent.select(prop)
 
-                if prop == 'EXDATE'
-                  significant_change_hash += exdate.join(',') + ';'
-                else
-                  property_values.each do |val|
-                    significant_change_hash += val.value + ';'
-                  end
+              significant_change_hash += prop + ':'
+
+              if prop == 'EXDATE'
+                significant_change_hash += exdate.join(',') + ';'
+              else
+                property_values.each do |val|
+                  significant_change_hash += val.value + ';'
                 end
               end
             end
@@ -889,7 +907,7 @@ module Tilia
 
         public
 
-        # TODO: document
+        # Sets instance variables
         def initialize
           @schedule_agent_server_rules = true
           @significant_change_properties = [