tilia-dav 3.1.0.pre.alpha2

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

@@ -0,0 +1,108 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        # schedule-calendar-transp property.
+        #
+        # This property is a representation of the schedule-calendar-transp property.
+        # This property is defined in:
+        #
+        # http://tools.ietf.org/html/rfc6638#section-9.1
+        #
+        # Its values are either 'transparent' or 'opaque'. If it's transparent, it
+        # means that this calendar will not be taken into consideration when a
+        # different user queries for free-busy information. If it's 'opaque', it will.
+        class ScheduleCalendarTransp
+          include Tilia::Xml::Element
+
+          TRANSPARENT = 'transparent'
+          OPAQUE = 'opaque'
+
+          # value
+          #
+          # @var string
+          # protected value
+
+          # Creates the property
+          #
+          # @param string value
+          def initialize(value)
+            if value != TRANSPARENT && value != OPAQUE
+              fail ArgumentError, 'The value must either be specified as "transparent" or "opaque"'
+            end
+            @value = value
+          end
+
+          # Returns the current value
+          #
+          # @return string
+          attr_reader :value
+
+          # 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)
+            case @value
+            when TRANSPARENT
+              writer.write_element("{#{Plugin::NS_CALDAV}}transparent")
+            when OPAQUE
+              writer.write_element("{#{Plugin::NS_CALDAV}}opaque")
+            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)
+            elems = Tilia::Xml::Element::Elements.xml_deserialize(reader)
+
+            value = nil
+
+            elems.each do |elem|
+              case elem
+              when "{#{Plugin::NS_CALDAV}}opaque"
+                value = OPAQUE
+              when "{#{Plugin::NS_CALDAV}}transparent"
+                value = TRANSPARENT
+              end
+            end
+
+            return nil unless value
+
+            new(value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        # SupportedCalendarComponentSet property.
+        #
+        # This class represents the
+        # {urn:ietf:params:xml:ns:caldav}supported-calendar-component-set property, as
+        # defined in:
+        #
+        # https://tools.ietf.org/html/rfc4791#section-5.2.3
+        class SupportedCalendarComponentSet
+          include Tilia::Xml::Element
+
+          # @!attribute [r] components
+          #   @!visibility private
+          #   List of supported components.
+          #
+          #   This array will contain values such as VEVENT, VTODO and VJOURNAL.
+          #
+          #   @var array
+
+          # Creates the property.
+          #
+          # @param array components
+          def initialize(components)
+            @components = components
+          end
+
+          # Returns the list of supported components
+          #
+          # @return array
+          def value
+            @components
+          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)
+            @components.each do |component|
+              writer.start_element("{#{Plugin::NS_CALDAV}}comp")
+              writer.write_attributes('name' => component)
+              writer.end_element
+            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)
+            elems = reader.parse_inner_tree || []
+
+            components = []
+
+            elems.each do |elem|
+              components << elem['attributes']['name'] if elem['name'] == "{#{Plugin::NS_CALDAV}}comp"
+            end
+
+            if components.empty?
+              fail Tilia::Xml::ParseException, 'supported-calendar-component-set must have at least one CALDAV:comp element'
+            end
+
+            new(components)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        # Supported-calendar-data property
+        #
+        # This property is a representation of the supported-calendar-data property
+        # in the CalDAV namespace. SabreDAV only has support for text/calendar;2.0
+        # so the value is currently hardcoded.
+        #
+        # This property is defined in:
+        # http://tools.ietf.org/html/rfc4791#section-5.2.4
+        class SupportedCalendarData
+          include Tilia::Xml::XmlSerializable
+
+          # 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.start_element("{#{Plugin::NS_CALDAV}}calendar-data")
+            writer.write_attributes(
+              'content-type' => 'text/calendar',
+              'version'      => '2.0'
+            )
+            writer.end_element # calendar-data
+            writer.start_element("{#{Plugin::NS_CALDAV}}calendar-data")
+            writer.write_attributes(
+              'content-type' => 'application/calendar+json'
+            )
+            writer.end_element # calendar-data
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Property
+        # supported-collation-set property
+        #
+        # This property is a representation of the supported-collation-set property
+        # in the CalDAV namespace.
+        #
+        # This property is defined in:
+        # http://tools.ietf.org/html/rfc4791#section-7.5.1
+        class SupportedCollationSet
+          include Tilia::Xml::XmlSerializable
+
+          # 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)
+            collations = [
+              'i;ascii-casemap',
+              'i;octet',
+              'i;unicode-casemap'
+            ]
+
+            collations.each do |collation|
+              writer.write_element("{#{Plugin::NS_CALDAV}}supported-collation", collation)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Request
+        require 'tilia/cal_dav/xml/request/calendar_multi_get_report'
+        require 'tilia/cal_dav/xml/request/calendar_query_report'
+        require 'tilia/cal_dav/xml/request/free_busy_query_report'
+        require 'tilia/cal_dav/xml/request/invite_reply'
+        require 'tilia/cal_dav/xml/request/mk_calendar'
+        require 'tilia/cal_dav/xml/request/share'
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/request/calendar_multi_get_report.rb

@@ -0,0 +1,99 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Request
+        # CalendarMultiGetReport request parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:caldav}calendar-multiget
+        # REPORT, as defined in:
+        #
+        # https://tools.ietf.org/html/rfc4791#section-7.9
+        class CalendarMultiGetReport
+          include Tilia::Xml::XmlDeserializable
+
+          # An array with requested properties.
+          #
+          # @var array
+          attr_accessor :properties
+
+          # This is an array with the urls that are being requested.
+          #
+          # @var array
+          attr_accessor :hrefs
+
+          # If the calendar data must be expanded, this will contain an array with 2
+          # elements: start and end.
+          #
+          # Each may be a DateTime or null.
+          #
+          # @var array|null
+          attr_accessor :expand
+
+          # The mimetype of the content that should be returend. Usually
+          # text/calendar.
+          #
+          # @var string
+          attr_accessor :content_type
+
+          # The version of calendar-data that should be returned. Usually '2.0',
+          # referring to iCalendar 2.0.
+          #
+          # @var string
+          attr_accessor :version
+
+          # 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)
+            elems = reader.parse_inner_tree(
+              '{urn:ietf:params:xml:ns:caldav}calendar-data' => Filter::CalendarData,
+              '{DAV:}prop'                                   => Tilia::Xml::Element::KeyValue
+            )
+
+            new_props = {
+              'hrefs'      => [],
+              'properties' => []
+            }
+
+            elems.each do |elem|
+              case elem['name']
+              when '{DAV:}prop'
+                new_props['properties'] = elem['value'].keys
+                if elem['value'].key?("{#{Plugin::NS_CALDAV}}calendar-data")
+                  new_props = new_props.merge(elem['value']["{#{Plugin::NS_CALDAV}}calendar-data"])
+                end
+              when '{DAV:}href'
+                new_props['hrefs'] << Uri.resolve(reader.context_uri, elem['value'])
+              end
+            end
+
+            obj = new
+            new_props.each do |key, value|
+              key = key.underscore
+              next unless %w(properties hrefs expand content_type version).include?(key)
+              obj.send("#{key}=".to_sym, value)
+            end
+
+            obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/cal_dav/xml/request/calendar_query_report.rb

@@ -0,0 +1,112 @@
+module Tilia
+  module CalDav
+    module Xml
+      module Request
+        # CalendarQueryReport request parser.
+        #
+        # This class parses the {urn:ietf:params:xml:ns:caldav}calendar-query
+        # REPORT, as defined in:
+        #
+        # https://tools.ietf.org/html/rfc4791#section-7.9
+        class CalendarQueryReport
+          include Tilia::Xml::XmlDeserializable
+
+          # An array with requested properties.
+          #
+          # @var array
+          attr_accessor :properties
+
+          # List of property/component filters.
+          #
+          # @var array
+          attr_accessor :filters
+
+          # If the calendar data must be expanded, this will contain an array with 2
+          # elements: start and end.
+          #
+          # Each may be a DateTime or null.
+          #
+          # @var array|null
+          attr_accessor :expand
+
+          # The mimetype of the content that should be returend. Usually
+          # text/calendar.
+          #
+          # @var string
+          attr_accessor :content_type
+
+          # The version of calendar-data that should be returned. Usually '2.0',
+          # referring to iCalendar 2.0.
+          #
+          # @var string
+          attr_accessor :version
+
+          # 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)
+            elems = reader.parse_inner_tree(
+              '{urn:ietf:params:xml:ns:caldav}comp-filter'   => Filter::CompFilter,
+              '{urn:ietf:params:xml:ns:caldav}prop-filter'   => Filter::PropFilter,
+              '{urn:ietf:params:xml:ns:caldav}param-filter'  => Filter::ParamFilter,
+              '{urn:ietf:params:xml:ns:caldav}calendar-data' => Filter::CalendarData,
+              '{DAV:}prop'                                   => Tilia::Xml::Element::KeyValue
+            )
+
+            new_props = {
+              'filters'    => nil,
+              'properties' => []
+            }
+
+            elems = [] unless elems.is_a?(Array)
+
+            elems.each do |elem|
+              case elem['name']
+              when '{DAV:}prop'
+                new_props['properties'] = elem['value'].keys
+                if elem['value'].key?("{#{Plugin::NS_CALDAV}}calendar-data")
+                  new_props = new_props.merge(elem['value']["{#{Plugin::NS_CALDAV}}calendar-data"])
+                end
+              when "{#{Plugin::NS_CALDAV}}filter"
+                elem['value'].each do |sub_elem|
+                  next unless sub_elem['name'] == "{#{Plugin::NS_CALDAV}}comp-filter"
+                  unless new_props['filters'].nil?
+                    fail Dav::Exception::BadRequest, 'Only one top-level comp-filter may be defined'
+                  end
+                  new_props['filters'] = sub_elem['value']
+                end
+              end
+            end
+
+            fail Dav::Exception::BadRequest, "The {#{Plugin::NS_CALDAV}}filter element is required for this request" unless new_props['filters'] && new_props['filters'].any?
+
+            obj = new
+            new_props.each do |key, value|
+              key = key.underscore
+              next unless %w(properties filters expand content_type version).include?(key)
+              obj.send("#{key}=".to_sym, value)
+            end
+
+            obj
+          end
+        end
+      end
+    end
+  end
+end