tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/cal_dav/xml/notification/notification_interface.rb

@@ -0,0 +1,41 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Notification
+        # This interface reflects a single notification type.
+        #
+        # @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
+        # @author Evert Pot (http://evertpot.com/)
+        # @license http://sabre.io/license/ Modified BSD License
+        module NotificationInterface
+          include Tilia::Xml::XmlSerializable
+
+          # This method serializes the entire notification, as it is used in the
+          # response body.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize_full(writer)
+          end
+
+          # Returns a unique id for this notification
+          #
+          # This is just the base url. This should generally be some kind of unique
+          # id.
+          #
+          # @return string
+          def id
+          end
+
+          # Returns the ETag for this notification.
+          #
+          # The ETag must be surrounded by literal double-quotes.
+          #
+          # @return string
+          def etag
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/notification/system_status.rb

@@ -0,0 +1,139 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Notification
+        # SystemStatus notification
+        #
+        # This notification can be used to indicate to the user that the system is
+        # down.
+        #
+        # @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
+        # @author Evert Pot (http://evertpot.com/)
+        # @license http://sabre.io/license/ Modified BSD License
+        class SystemStatus
+          include NotificationInterface
+
+          TYPE_LOW = 1
+          TYPE_MEDIUM = 2
+          TYPE_HIGH = 3
+
+          # A unique id
+          #
+          # @var string
+          # protected id
+
+          # @!attribute [r] type
+          #   @!visibility private
+          #   The type of alert. This should be one of the TYPE_ constants.
+          #
+          #   @var int
+
+          # @!attribute [r] description
+          #   @!visibility private
+          #   A human-readable description of the problem.
+          #
+          #   @var string
+
+          # @!attribute [r] href
+          #   @!visibility private
+          #   A url to a website with more information for the user.
+          #
+          #   @var string
+
+          # Notification Etag
+          #
+          # @var string
+          # protected etag
+
+          # Creates the notification.
+          #
+          # Some kind of unique id should be provided. This is used to generate a
+          # url.
+          #
+          # @param string id
+          # @param string etag
+          # @param int type
+          # @param string description
+          # @param string href
+          def initialize(id, etag, type = TYPE_HIGH, description = nil, href = nil)
+            @id = id
+            @type = type
+            @description = description
+            @href = href
+            @etag = etag
+          end
+
+          # The serialize method is called during xml writing.
+          #
+          # It should use the writer argument to encode this object into XML.
+          #
+          # Important note: it is not needed to create the parent element. The
+          # parent element is already created, and we only have to worry about
+          # attributes, child elements and text (if any).
+          #
+          # Important note 2: If you are writing any new elements, you are also
+          # responsible for closing them.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize(writer)
+            case @type
+            when TYPE_LOW
+              type = 'low'
+            when TYPE_MEDIUM
+              type = 'medium'
+            else
+              type = 'high'
+            end
+
+            writer.start_element("{#{Plugin::NS_CALENDARSERVER}}systemstatus")
+            writer.write_attribute('type', type)
+            writer.end_element
+          end
+
+          # This method serializes the entire notification, as it is used in the
+          # response body.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize_full(writer)
+            cs = "{#{Plugin::NS_CALENDARSERVER}}"
+            case @type
+            when TYPE_LOW
+              type = 'low'
+            when TYPE_MEDIUM
+              type = 'medium'
+            else
+              type = 'high'
+            end
+
+            writer.start_element(cs + 'systemstatus')
+            writer.write_attribute('type', type)
+
+            unless @description.blank?
+              writer.write_element(cs + 'description', @description)
+            end
+            writer.write_element('{DAV:}href', @href) unless @href.blank?
+
+            writer.end_element #  systemstatus
+          end
+
+          # Returns a unique id for this notification
+          #
+          # This is just the base url. This should generally be some kind of unique
+          # id.
+          #
+          # @return string
+          attr_reader :id
+
+          # Returns the ETag for this notification.
+          #
+          # The ETag must be surrounded by literal double-quotes.
+          #
+          # @return string
+          attr_reader :etag
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/property.rb

@@ -0,0 +1,15 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        require 'tilia/cal_dav/xml/property/allowed_sharing_modes'
+        require 'tilia/cal_dav/xml/property/email_address_set'
+        require 'tilia/cal_dav/xml/property/invite'
+        require 'tilia/cal_dav/xml/property/schedule_calendar_transp'
+        require 'tilia/cal_dav/xml/property/supported_calendar_component_set'
+        require 'tilia/cal_dav/xml/property/supported_calendar_data'
+        require 'tilia/cal_dav/xml/property/supported_collation_set'
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/property/allowed_sharing_modes.rb

@@ -0,0 +1,64 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        # AllowedSharingModes
+        #
+        # This property encodes the 'allowed-sharing-modes' property, as defined by
+        # the 'caldav-sharing-02' spec, in the http://calendarserver.org/ns/
+        # namespace.
+        #
+        # This property is a representation of the supported-calendar_component-set
+        # property in the CalDAV namespace. It simply requires an array of components,
+        # such as VEVENT, VTODO
+        class AllowedSharingModes
+          include Tilia::Xml::XmlSerializable
+
+          # @!attribute [r] can_be_shared
+          #   @!visibility private
+          #   Whether or not a calendar can be shared with another user
+          #
+          #   @var bool
+
+          # @!attribute [r] can_be_published
+          #   @!visibility private
+          #   Whether or not the calendar can be placed on a public url.
+          #
+          #   @var bool
+
+          # Constructor
+          #
+          # @param bool can_be_shared
+          # @param bool can_be_published
+          # @return void
+          def initialize(can_be_shared, can_be_published)
+            @can_be_shared = can_be_shared
+            @can_be_published = can_be_published
+          end
+
+          # The xmlSerialize metod is called during xml writing.
+          #
+          # Use the writer argument to write its own xml serialization.
+          #
+          # An important note: do _not_ create a parent element. Any element
+          # implementing XmlSerializble should only ever write what's considered
+          # its 'inner xml'.
+          #
+          # The parent of the current element is responsible for writing a
+          # containing element.
+          #
+          # This allows serializers to be re-used for different element names.
+          #
+          # If you are opening new elements, you must also close them again.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize(writer)
+            writer.write_element("{#{Plugin::NS_CALENDARSERVER}}can-be-shared") if @can_be_shared
+            writer.write_element("{#{Plugin::NS_CALENDARSERVER}}can-be-published") if @can_be_published
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/property/email_address_set.rb

@@ -0,0 +1,60 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        # email-address-set property
+        #
+        # This property represents the email-address-set property in the
+        # http://calendarserver.org/ns/ namespace.
+        #
+        # It's a list of email addresses associated with a user.
+        class EmailAddressSet
+          include Tilia::Xml::XmlSerializable
+
+          # @!attribute [r] emails
+          #   @!visibility private
+          #   emails
+          #
+          #   @var array
+
+          # __construct
+          #
+          # @param array emails
+          def initialize(emails)
+            @emails = emails
+          end
+
+          # Returns the email addresses
+          #
+          # @return array
+          def value
+            @emails
+          end
+
+          # The xmlSerialize metod is called during xml writing.
+          #
+          # Use the writer argument to write its own xml serialization.
+          #
+          # An important note: do _not_ create a parent element. Any element
+          # implementing XmlSerializble should only ever write what's considered
+          # its 'inner xml'.
+          #
+          # The parent of the current element is responsible for writing a
+          # containing element.
+          #
+          # This allows serializers to be re-used for different element names.
+          #
+          # If you are opening new elements, you must also close them again.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize(writer)
+            @emails.each do |email|
+              writer.write_element('{http://calendarserver.org/ns/}email-address', email)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/property/invite.rb

@@ -0,0 +1,207 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        # Invite property
+        #
+        # This property encodes the 'invite' property, as defined by
+        # the 'caldav-sharing-02' spec, in the http://calendarserver.org/ns/
+        # namespace.
+        class Invite
+          include Tilia::Xml::Element
+
+          # @!attribute [r] users
+          #   @!visibility private
+          #   The list of users a calendar has been shared to.
+          #
+          #   @var array
+
+          # @!attribute [r] organizer
+          #   @!visibility private
+          #   The organizer contains information about the person who shared the
+          #   object.
+          #
+          #   @var array
+
+          # Creates the property.
+          #
+          # Users is an array. Each element of the array has the following
+          # properties:
+          #
+          #   * href - Often a mailto: address
+          #   * commonName - Optional, for example a first and lastname for a user.
+          #   * status - One of the SharingPlugin::STATUS_* constants.
+          #   * readOnly - true or false
+          #   * summary - Optional, description of the share
+          #
+          # The organizer key is optional to specify. It's only useful when a
+          # 'sharee' requests the sharing information.
+          #
+          # The organizer may have the following properties:
+          #   * href - Often a mailto: address.
+          #   * commonName - Optional human-readable name.
+          #   * firstName - Optional first name.
+          #   * lastName - Optional last name.
+          #
+          # If you wonder why these two structures are so different, I guess a
+          # valid answer is that the current spec is still a draft.
+          #
+          # @param array users
+          def initialize(users, organizer = nil)
+            @users = users
+            @organizer = organizer
+          end
+
+          # Returns the list of users, as it was passed to the constructor.
+          #
+          # @return array
+          def value
+            @users
+          end
+
+          # The xmlSerialize metod is called during xml writing.
+          #
+          # Use the writer argument to write its own xml serialization.
+          #
+          # An important note: do _not_ create a parent element. Any element
+          # implementing XmlSerializble should only ever write what's considered
+          # its 'inner xml'.
+          #
+          # The parent of the current element is responsible for writing a
+          # containing element.
+          #
+          # This allows serializers to be re-used for different element names.
+          #
+          # If you are opening new elements, you must also close them again.
+          #
+          # @param Writer writer
+          # @return void
+          def xml_serialize(writer)
+            cs = "{#{Plugin::NS_CALENDARSERVER}}"
+
+            if @organizer
+              writer.start_element(cs + 'organizer')
+              writer.write_element('{DAV:}href', @organizer['href'])
+
+              unless @organizer['commonName'].blank?
+                writer.write_element(cs + 'common-name', @organizer['commonName'])
+              end
+              unless @organizer['firstName'].blank?
+                writer.write_element(cs + 'first-name', @organizer['firstName'])
+              end
+              unless @organizer['lastName'].blank?
+                writer.write_element(cs + 'last-name', @organizer['lastName'])
+              end
+
+              writer.end_element #  organizer
+            end
+
+            @users.each do |user|
+              writer.start_element(cs + 'user')
+              writer.write_element('{DAV:}href', user['href'])
+
+              unless user['commonName'].blank?
+                writer.write_element(cs + 'common-name', user['commonName'])
+              end
+
+              case user['status']
+              when SharingPlugin::STATUS_ACCEPTED
+                writer.write_element(cs + 'invite-accepted')
+              when SharingPlugin::STATUS_DECLINED
+                writer.write_element(cs + 'invite-declined')
+              when SharingPlugin::STATUS_NORESPONSE
+                writer.write_element(cs + 'invite-noresponse')
+              when SharingPlugin::STATUS_INVALID
+                writer.write_element(cs + 'invite-invalid')
+              end
+
+              writer.start_element(cs + 'access')
+              if user['readOnly']
+                writer.write_element(cs + 'read')
+              else
+                writer.write_element(cs + 'read-write')
+              end
+              writer.end_element # access
+
+              unless user['summary'].blank?
+                writer.write_element(cs + 'summary', user['summary'])
+              end
+
+              writer.end_element # user
+            end
+          end
+
+          # The deserialize method is called during xml parsing.
+          #
+          # This method is called statictly, this is because in theory this method
+          # may be used as a type of constructor, or factory method.
+          #
+          # Often you want to return an instance of the current class, but you are
+          # free to return other data as well.
+          #
+          # You are responsible for advancing the reader to the next element. Not
+          # doing anything will result in a never-ending loop.
+          #
+          # If you just want to skip parsing for this element altogether, you can
+          # just call reader.next
+          #
+          # reader.parse_inner_tree will parse the entire sub-tree, and advance to
+          # the next element.
+          #
+          # @param Reader reader
+          # @return mixed
+          def self.xml_deserialize(reader)
+            cs = "{#{Plugin::NS_CALENDARSERVER}}"
+
+            users = []
+
+            reader.parse_inner_tree.each do |elem|
+              next unless elem['name'] == cs + 'user'
+
+              user = {
+                'href'       => nil,
+                'commonName' => nil,
+                'readOnly'   => false,
+                'summary'    => nil,
+                'status'     => nil
+              }
+
+              elem['value'].each do |user_elem|
+                case user_elem['name']
+                when cs + 'invite-accepted'
+                  user['status'] = SharingPlugin::STATUS_ACCEPTED
+                when cs + 'invite-declined'
+                  user['status'] = SharingPlugin::STATUS_DECLINED
+                when cs + 'invite-noresponse'
+                  user['status'] = SharingPlugin::STATUS_NORESPONSE
+                when cs + 'invite-invalid'
+                  user['status'] = SharingPlugin::STATUS_INVALID
+                when '{DAV:}href'
+                  user['href'] = user_elem['value']
+                when cs + 'common-name'
+                  user['commonName'] = user_elem['value']
+                when cs + 'access'
+                  user_elem['value'].each do |access_href|
+                    if access_href['name'] == cs + 'read'
+                      user['readOnly'] = true
+                    end
+                  end
+                when cs + 'summary'
+                  user['summary'] = user_elem['value']
+                end
+              end
+
+              unless user['status']
+                fail ArgumentError, 'Every user must have one of cs:invite-accepted, cs:invite-declined, cs:invite-noresponse or cs:invite-invalid'
+              end
+
+              users << user
+            end
+
+            new(users)
+          end
+        end
+      end
+    end
+  end
+end