tilia-dav 3.1.0.pre.alpha2

data/test/cal_dav/backend/abstract_test.rb

@@ -0,0 +1,163 @@
+require 'test_helper'
+
+module Tilia
+  module CalDav
+    module Backend
+      class AbstractTest < Minitest::Test
+        def test_update_calendar
+          abstract = AbstractMock.new
+          prop_patch = Dav::PropPatch.new('{DAV:}displayname' => 'anything')
+
+          abstract.update_calendar('randomid', prop_patch)
+          result = prop_patch.commit
+
+          refute(result)
+        end
+
+        def test_calendar_query
+          abstract = AbstractMock.new
+          filters = {
+            'name' => 'VCALENDAR',
+            'comp-filters' => [
+              {
+                'name' => 'VEVENT',
+                'comp-filters' => [],
+                'prop-filters' => [],
+                'is-not-defined' => false,
+                'time-range' => {}
+              }
+            ],
+            'prop-filters' => [],
+            'is-not-defined' => false,
+            'time-range' => nil
+          }
+
+          assert_equal(['event1.ics'], abstract.calendar_query(1, filters))
+        end
+
+        def test_get_calendar_object_by_uid
+          abstract = AbstractMock.new
+
+          assert_nil(abstract.calendar_object_by_uid('principal1', 'zim'))
+          assert_equal('cal1/event1.ics', abstract.calendar_object_by_uid('principal1', 'foo'))
+          assert_nil(abstract.calendar_object_by_uid('principal3', 'foo'))
+          assert_nil(abstract.calendar_object_by_uid('principal1', 'shared'))
+        end
+
+        def test_get_multiple_calendar_objects
+          abstract = AbstractMock.new
+
+          result = abstract.multiple_calendar_objects(
+            1,
+            [
+              'event1.ics',
+              'task1.ics'
+            ]
+          )
+
+          expected = [
+            {
+              'id' => 1,
+              'calendarid' => 1,
+              'uri' => 'event1.ics',
+              'calendardata' => "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nUID:foo\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
+            },
+            {
+              'id' => 2,
+              'calendarid' => 1,
+              'uri' => 'task1.ics',
+              'calendardata' => "BEGIN:VCALENDAR\r\nBEGIN:VTODO\r\nEND:VTODO\r\nEND:VCALENDAR\r\n"
+            }
+          ]
+
+          assert_equal(expected, result)
+        end
+      end
+
+      class AbstractMock < AbstractBackend
+        def calendars_for_user(_principal_uri)
+          [
+            {
+              'id' => 1,
+              'principaluri' => 'principal1',
+              'uri' => 'cal1'
+            },
+            {
+              'id' => 2,
+              'principaluri' => 'principal1',
+              '{http://sabredav.org/ns}owner-principal' => 'principal2',
+              'uri' => 'cal1'
+            }
+          ]
+        end
+
+        def create_calendar(principal_uri, calendar_uri, properties)
+        end
+
+        def delete_calendar(calendar_id)
+        end
+
+        def calendar_objects(calendar_id)
+          case calendar_id
+          when 1
+            return [
+              {
+                'id' => 1,
+                'calendarid' => 1,
+                'uri' => 'event1.ics'
+              },
+              {
+                'id' => 2,
+                'calendarid' => 1,
+                'uri' => 'task1.ics'
+              }
+            ]
+          when 2
+            return [
+              {
+                'id' => 3,
+                'calendarid' => 2,
+                'uri' => 'shared-event.ics'
+              }
+            ]
+          end
+        end
+
+        def calendar_object(_calendar_id, object_uri)
+          case object_uri
+          when 'event1.ics'
+            {
+              'id' => 1,
+              'calendarid' => 1,
+              'uri' => 'event1.ics',
+              'calendardata' => "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nUID:foo\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
+            }
+          when 'task1.ics'
+            {
+              'id' => 2,
+              'calendarid' => 1,
+              'uri' => 'task1.ics',
+              'calendardata' => "BEGIN:VCALENDAR\r\nBEGIN:VTODO\r\nEND:VTODO\r\nEND:VCALENDAR\r\n"
+            }
+          when 'shared-event.ics'
+            {
+              'id' => 3,
+              'calendarid' => 2,
+              'uri' => 'event1.ics',
+              'calendardata' => "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nUID:shared\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
+            }
+          end
+        end
+
+        def create_calendar_object(calendar_id, object_uri, calendar_data)
+        end
+
+        def update_calendar_object(calendar_id, object_uri, calendar_data)
+        end
+
+        def delete_calendar_object(calendar_id, object_uri)
+        end
+      end
+    end
+  end
+end

data/test/cal_dav/backend/mock.rb

@@ -0,0 +1,169 @@
+module Tilia
+  module CalDav
+    module Backend
+      class Mock < AbstractBackend
+        def initialize(calendars = [], calendar_data = {})
+          calendars.each do |calendar|
+            calendar['id'] = Dav::UuidUtil.uuid unless calendar.key?('id')
+          end
+
+          @calendars = calendars
+          @calendar_data = calendar_data
+        end
+
+        # Returns a list of calendars for a principal.
+        #
+        # Every project is an array with the following keys:
+        #  * id, a unique id that will be used by other functions to modify the
+        #    calendar. This can be the same as the uri or a database key.
+        #  * uri, which the basename of the uri with which the calendar is
+        #    accessed.
+        #  * principalUri. The owner of the calendar. Almost always the same as
+        #    principalUri passed to this method.
+        #
+        # Furthermore it can contain webdav properties in clark notation. A very
+        # common one is '{DAV:}displayname'.
+        #
+        # @param string principal_uri
+        # @return array
+        def calendars_for_user(principal_uri)
+          @calendars.select do |row|
+            row['principaluri'] == principal_uri
+          end
+        end
+
+        # Creates a new calendar for a principal.
+        #
+        # If the creation was a success, an id must be returned that can be used to reference
+        # this calendar in other methods, such as updateCalendar.
+        #
+        # This function must return a server-wide unique id that can be used
+        # later to reference the calendar.
+        #
+        # @param string principal_uri
+        # @param string calendar_uri
+        # @param array properties
+        # @return string|int
+        def create_calendar(principal_uri, calendar_uri, properties)
+          id = Dav::UuidUtil.uuid
+
+          @calendars << {
+            'id' => id,
+            'principaluri' => principal_uri,
+            'uri' => calendar_uri,
+            "{#{Plugin::NS_CALDAV}}supported-calendar-component-set" => Xml::Property::SupportedCalendarComponentSet.new(['VEVENT', 'VTODO'])
+          }.merge(properties)
+
+          id
+        end
+
+        # Delete a calendar and all it's objects
+        #
+        # @param string calendar_id
+        # @return void
+        def delete_calendar(calendar_id)
+          @calendars.delete_if do |calendar|
+            calendar['id'] == calendar_id
+          end
+        end
+
+        # Returns all calendar objects within a calendar object.
+        #
+        # Every item contains an array with the following keys:
+        #   * id - unique identifier which will be used for subsequent updates
+        #   * calendardata - The iCalendar-compatible calendar data
+        #   * uri - a unique key which will be used to construct the uri. This can be any arbitrary string.
+        #   * lastmodified - a timestamp of the last modification time
+        #   * etag - An arbitrary string, surrounded by double-quotes. (e.g.:
+        #   '  "abcdef"')
+        #   * calendarid - The calendarid as it was passed to this function.
+        #
+        # Note that the etag is optional, but it's highly encouraged to return for
+        # speed reasons.
+        #
+        # The calendardata is also optional. If it's not returned
+        # 'getCalendarObject' will be called later, which *is* expected to return
+        # calendardata.
+        #
+        # @param string calendar_id
+        # @return array
+        def calendar_objects(calendar_id)
+          return [] unless @calendar_data.key?(calendar_id)
+
+          objects = @calendar_data[calendar_id]
+
+          objects.each do |uri, object|
+            object['calendarid'] = calendar_id
+            object['uri'] = uri
+            object['lastmodified'] = nil
+          end
+
+          objects.values
+        end
+
+        # Returns information from a single calendar object, based on it's object
+        # uri.
+        #
+        # The returned array must have the same keys as getCalendarObjects. The
+        # 'calendardata' object is required here though, while it's not required
+        # for getCalendarObjects.
+        #
+        # @param string calendar_id
+        # @param string object_uri
+        # @return array
+        def calendar_object(calendar_id, object_uri)
+          unless @calendar_data.key?(calendar_id) &&
+                 @calendar_data[calendar_id].key?(object_uri)
+            fail Dav::Exception::NotFound, 'Object could not be found'
+          end
+
+          object = @calendar_data[calendar_id][object_uri]
+          object['calendarid'] = calendar_id
+          object['uri'] = object_uri
+          object['lastmodified'] = nil
+          object
+        end
+
+        # Creates a new calendar object.
+        #
+        # @param string calendar_id
+        # @param string object_uri
+        # @param string calendar_data
+        # @return void
+        def create_calendar_object(calendar_id, object_uri, calendar_data)
+          @calendar_data[calendar_id] ||= {}
+          @calendar_data[calendar_id][object_uri] = {
+            'calendardata' => calendar_data,
+            'calendarid' => calendar_id,
+            'uri' => object_uri
+          }
+          "\"#{Digest::MD5.hexdigest(calendar_data)}\""
+        end
+
+        # Updates an existing calendarobject, based on it's uri.
+        #
+        # @param string calendar_id
+        # @param string object_uri
+        # @param string calendar_data
+        # @return void
+        def update_calendar_object(calendar_id, object_uri, calendar_data)
+          @calendar_data[calendar_id][object_uri] = {
+            'calendardata' => calendar_data,
+            'calendarid' => calendar_id,
+            'uri' => object_uri
+          }
+          "\"#{Digest::MD5.hexdigest(calendar_data)}\""
+        end
+
+        # Deletes an existing calendar object.
+        #
+        # @param string calendar_id
+        # @param string object_uri
+        # @return void
+        def delete_calendar_object(_calendar_id, _object_uri)
+          fail NotImplementedErrorthrow Exception.new('Not implemented')
+        end
+      end
+    end
+  end
+end

data/test/cal_dav/backend/mock_scheduling.rb

@@ -0,0 +1,84 @@
+module Tilia
+  module CalDav
+    module Backend
+      class MockScheduling < Mock
+        include SchedulingSupport
+
+        def initialize(*args)
+          super
+          @scheduling_objects = {}
+        end
+
+        # Returns a single scheduling object.
+        #
+        # The returned array should contain the following elements:
+        #   * uri - A unique basename for the object. This will be used to
+        #           construct a full uri.
+        #   * calendardata - The iCalendar object
+        #   * lastmodified - The last modification date. Can be an int for a unix
+        #                    timestamp, or a PHP DateTime object.
+        #   * etag - A unique token that must change if the object changed.
+        #   * size - The size of the object, in bytes.
+        #
+        # @param string principal_uri
+        # @param string object_uri
+        # @return array
+        def scheduling_object(principal_uri, object_uri)
+          if @scheduling_objects.key?(principal_uri) &&
+             @scheduling_objects[principal_uri].key?(object_uri)
+            return @scheduling_objects[principal_uri][object_uri]
+          else
+            return nil
+          end
+        end
+
+        # Returns all scheduling objects for the inbox collection.
+        #
+        # These objects should be returned as an array. Every item in the array
+        # should follow the same structure as returned from getSchedulingObject.
+        #
+        # The main difference is that 'calendardata' is optional.
+        #
+        # @param string principal_uri
+        # @return array
+        def scheduling_objects(principal_uri)
+          if @scheduling_objects.key?(principal_uri)
+            return @scheduling_objects[principal_uri].values
+          end
+
+          []
+        end
+
+        # Deletes a scheduling object
+        #
+        # @param string principal_uri
+        # @param string object_uri
+        # @return void
+        def delete_scheduling_object(principal_uri, object_uri)
+          if @scheduling_objects.key?(principal_uri) &&
+             @scheduling_objects[principal_uri].key?(object_uri)
+            @scheduling_objects[principal_uri].delete(object_uri)
+          end
+        end
+
+        # Creates a new scheduling object. This should land in a users' inbox.
+        #
+        # @param string principal_uri
+        # @param string object_uri
+        # @param string object_data
+        # @return void
+        def create_scheduling_object(principal_uri, object_uri, object_data)
+          @scheduling_objects[principal_uri] ||= {}
+
+          @scheduling_objects[principal_uri][object_uri] = {
+            'uri' => object_uri,
+            'calendardata' => object_data,
+            'lastmodified' => nil,
+            'etag' => "\"#{Digest::MD5.hexdigest(object_data)}\"",
+            'size' => object_data.bytesize
+          }
+        end
+      end
+    end
+  end
+end

data/test/cal_dav/backend/mock_sharing.rb

@@ -0,0 +1,124 @@
+module Tilia
+  module CalDav
+    module Backend
+      class MockSharing < Mock
+        include NotificationSupport
+        include SharingSupport
+
+        def initialize(calendars = [], calendar_data = {}, notifications = {})
+          super(calendars, calendar_data)
+          @shares = {}
+          @notifications = notifications
+        end
+
+        # Returns a list of notifications for a given principal url.
+        #
+        # The returned array should only consist of implementations of
+        # Notifications\INotificationType.
+        #
+        # @param string principal_uri
+        # @return array
+        def notifications_for_principal(principal_uri)
+          @notifications[principal_uri] || []
+        end
+
+        # This deletes a specific notifcation.
+        #
+        # This may be called by a client once it deems a notification handled.
+        #
+        # @param string principal_uri
+        # @param NotificationInterface notification
+        # @return void
+        def delete_notification(principal_uri, notification)
+          @notifications[principal_uri].delete_if do |value|
+            notification == value
+          end
+        end
+
+        # Updates the list of shares.
+        #
+        # The first array is a list of people that are to be added to the
+        # calendar.
+        #
+        # Every element in the add array has the following properties:
+        #   * href - A url. Usually a mailto: address
+        #   * commonName - Usually a first and last name, or false
+        #   * summary - A description of the share, can also be false
+        #   * readOnly - A boolean value
+        #
+        # Every element in the remove array is just the address string.
+        #
+        # Note that if the calendar is currently marked as 'not shared' by and
+        # this method is called, the calendar should be 'upgraded' to a shared
+        # calendar.
+        #
+        # @param mixed calendar_id
+        # @param array add
+        # @param array remove
+        # @return void
+        def update_shares(calendar_id, add, remove)
+          @shares[calendar_id] ||= []
+
+          add.each do |val|
+            val['status'] = SharingPlugin::STATUS_NORESPONSE
+            @shares[calendar_id] << val
+          end
+
+          @shares[calendar_id].delete_if do |share|
+            remove.include?(share['href'])
+          end
+        end
+
+        # Returns the list of people whom this calendar is shared with.
+        #
+        # Every element in this array should have the following properties:
+        #   * href - Often a mailto: address
+        #   * commonName - Optional, for example a first + last name
+        #   * status - See the SharingPlugin::STATUS_ constants.
+        #   * readOnly - boolean
+        #   * summary - Optional, a description for the share
+        #
+        # @param mixed calendar_id
+        # @return array
+        def shares(calendar_id)
+          @shares[calendar_id] || []
+        end
+
+        # This method is called when a user replied to a request to share.
+        #
+        # @param string href The sharee who is replying (often a mailto: address)
+        # @param int status One of the SharingPlugin::STATUS_* constants
+        # @param string calendar_uri The url to the calendar thats being shared
+        # @param string in_reply_to The unique id this message is a response to
+        # @param string summary A description of the reply
+        # @return void
+        def share_reply(_href, status, _calendar_uri, _in_reply_to, _summary = nil)
+          # This operation basically doesn't do anything yet
+          if status == SharingPlugin::STATUS_ACCEPTED
+            return 'calendars/blabla/calendar'
+          end
+          nil
+        end
+
+        # Publishes a calendar
+        #
+        # @param mixed calendar_id
+        # @param bool value
+        # @return void
+        def set_publish_status(calendar_id, value)
+          @calendars.each do |_k, cal|
+            next unless cal['id'] == calendar_id
+            if !value
+              cal.delete('{http://calendarserver.org/ns/}publish-url')
+            else
+              cal['{http://calendarserver.org/ns/}publish-url'] = 'http://example.org/public/ ' + calendar_id + '.ics'
+                          end
+            return nil
+          end
+
+          fail Dav::Exception, "Calendar with id '#{calendar_id}' not found"
+        end
+      end
+    end
+  end
+end