async-caldav 1.2.4 → 1.3.0

data/lib/async/caldav/handlers/proppatch.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "scampi"
-require "async/caldav"
-
 module Async
   module Caldav
     module Handlers
@@ -14,105 +10,114 @@ module Async
           col_path = path.ensure_trailing_slash
           col = storage.get_collection(col_path.to_s)
 
-          return [404, { 'content-type' => 'text/plain' }, ['Not Found']] unless col
-
-          updates = {}
-
-          # Check for removals
-          is_remove = body&.match?(/<[^>]*remove[^>]*>/m)
-
-          dn = Protocol::Caldav::Xml.extract_value(body, 'displayname')
-          desc = Protocol::Caldav::Xml.extract_value(body, 'calendar-description')
-          color = Protocol::Caldav::Xml.extract_value(body, 'calendar-color')
-
-          if is_remove
-            updates[:displayname] = nil if body.match?(/displayname/i) && !dn
-            updates[:description] = nil if body.match?(/calendar-description/i) && !desc
-            updates[:color] = nil if body.match?(/calendar-color/i) && !color
-          end
-
-          updates[:displayname] = dn if dn
-          updates[:description] = desc if desc
-          updates[:color] = color if color
-
-          storage.update_collection(col_path.to_s, updates)
-
-          xml = Protocol::Caldav::Multistatus.new.to_xml do |x|
-            Protocol::Caldav::XmlBuilder.response(x, href: col_path.to_s) do
-              x.tag!("d:propstat") do
-                x.tag!("d:prop")
-                x.tag!("d:status", "HTTP/1.1 200 OK")
+          if col
+            updates = {}
+            is_remove = body&.match?(/<[^>]*remove[^>]*>/m)
+            dn = Protocol::Caldav::Xml.extract_value(body, 'displayname')
+            desc = Protocol::Caldav::Xml.extract_value(body, 'calendar-description')
+            color = Protocol::Caldav::Xml.extract_value(body, 'calendar-color')
+            if is_remove
+              if body.match?(/displayname/i) && !dn
+                updates[:displayname] = nil
+              end
+              if body.match?(/calendar-description/i) && !desc
+                updates[:description] = nil
+              end
+              if body.match?(/calendar-color/i) && !color
+                updates[:color] = nil
+              end
+            end
+            if dn
+              updates[:displayname] = dn
+            end
+            if desc
+              updates[:description] = desc
+            end
+            if color
+              updates[:color] = color
+            end
+            storage.update_collection(col_path.to_s, updates)
+            xml = Protocol::Caldav::Multistatus.new.to_xml do |x|
+              Protocol::Caldav::XmlBuilder.response(x, href: col_path.to_s) do
+                x.tag!("d:propstat") do
+                  x.tag!("d:prop")
+                  x.tag!("d:status", "HTTP/1.1 200 OK")
+                end
               end
             end
+            [207, Protocol::Caldav::Constants::DAV_HEADERS, [xml]]
+          else
+            [404, { 'content-type' => 'text/plain' }, ['Not Found']]
           end
-          [207, Protocol::Caldav::Constants::DAV_HEADERS, [xml]]
         end
       end
     end
   end
 end
 
-test do
-  describe "Async::Caldav::Handlers::Proppatch" do
-    def call(**opts)
-      Async::Caldav::Handlers::Proppatch.call(**opts)
-    end
+__END__
 
-    def path(p, s)
-      Protocol::Caldav::Path.new(p, storage_class: s)
-    end
+require_relative "../../caldav"
 
-    it "updates displayname and returns 207" do
-      s = Async::Caldav::Storage::Mock.new
-      s.create_collection('/cal/', displayname: 'Old')
-      status, = call(
-        path: path('/cal/', s), storage: s,
-        body: '<d:set><d:prop><d:displayname>New</d:displayname></d:prop></d:set>'
-      )
-      status.should.equal 207
-      s.get_collection('/cal/')[:displayname].should.equal 'New'
-    end
+describe "Async::Caldav::Handlers::Proppatch" do
+  def call(**opts)
+    Async::Caldav::Handlers::Proppatch.call(**opts)
+  end
 
-    it "returns 404 for non-existent collection" do
-      s = Async::Caldav::Storage::Mock.new
-      status, = call(path: path('/nope/', s), storage: s, body: '')
-      status.should.equal 404
-    end
+  def path(p, s)
+    Protocol::Caldav::Path.new(p, storage_class: s)
+  end
 
-    it "updates multiple properties at once" do
-      s = Async::Caldav::Storage::Mock.new
-      s.create_collection('/cal/', displayname: 'Old', description: 'OldDesc')
-      status, = call(
-        path: path('/cal/', s), storage: s,
-        body: '<d:set><d:prop><d:displayname>New</d:displayname><c:calendar-description>NewDesc</c:calendar-description></d:prop></d:set>'
-      )
-      status.should.equal 207
-      col = s.get_collection('/cal/')
-      col[:displayname].should.equal 'New'
-      col[:description].should.equal 'NewDesc'
-    end
+  it "updates displayname and returns 207" do
+    s = Async::Caldav::Storage::Mock.new
+    s.create_collection('/cal/', displayname: 'Old')
+    status, = call(
+      path: path('/cal/', s), storage: s,
+      body: '<d:set><d:prop><d:displayname>New</d:displayname></d:prop></d:set>'
+    )
+    status.should.equal 207
+    s.get_collection('/cal/')[:displayname].should.equal 'New'
+  end
 
-    it "handles mixed set and remove in one request" do
-      s = Async::Caldav::Storage::Mock.new
-      s.create_collection('/cal/', displayname: 'Keep', description: 'Remove', color: '#ff0000')
-      call(
-        path: path('/cal/', s), storage: s,
-        body: '<d:set><d:prop><d:displayname>Updated</d:displayname></d:prop></d:set><d:remove><d:prop><c:calendar-description/></d:prop></d:remove>'
-      )
-      col = s.get_collection('/cal/')
-      col[:displayname].should.equal 'Updated'
-      col[:description].should.be.nil
-      col[:color].should.equal '#ff0000'
-    end
+  it "returns 404 for non-existent collection" do
+    s = Async::Caldav::Storage::Mock.new
+    status, = call(path: path('/nope/', s), storage: s, body: '')
+    status.should.equal 404
+  end
 
-    it "removes a property" do
-      s = Async::Caldav::Storage::Mock.new
-      s.create_collection('/cal/', displayname: 'Work')
-      call(
-        path: path('/cal/', s), storage: s,
-        body: '<d:remove><d:prop><d:displayname/></d:prop></d:remove>'
-      )
-      s.get_collection('/cal/')[:displayname].should.be.nil
-    end
+  it "updates multiple properties at once" do
+    s = Async::Caldav::Storage::Mock.new
+    s.create_collection('/cal/', displayname: 'Old', description: 'OldDesc')
+    status, = call(
+      path: path('/cal/', s), storage: s,
+      body: '<d:set><d:prop><d:displayname>New</d:displayname><c:calendar-description>NewDesc</c:calendar-description></d:prop></d:set>'
+    )
+    status.should.equal 207
+    col = s.get_collection('/cal/')
+    col[:displayname].should.equal 'New'
+    col[:description].should.equal 'NewDesc'
   end
-end
+
+  it "handles mixed set and remove in one request" do
+    s = Async::Caldav::Storage::Mock.new
+    s.create_collection('/cal/', displayname: 'Keep', description: 'Remove', color: '#ff0000')
+    call(
+      path: path('/cal/', s), storage: s,
+      body: '<d:set><d:prop><d:displayname>Updated</d:displayname></d:prop></d:set><d:remove><d:prop><c:calendar-description/></d:prop></d:remove>'
+    )
+    col = s.get_collection('/cal/')
+    col[:displayname].should.equal 'Updated'
+    col[:description].should.be.nil
+    col[:color].should.equal '#ff0000'
+  end
+
+  it "removes a property" do
+    s = Async::Caldav::Storage::Mock.new
+    s.create_collection('/cal/', displayname: 'Work')
+    call(
+      path: path('/cal/', s), storage: s,
+      body: '<d:remove><d:prop><d:displayname/></d:prop></d:remove>'
+    )
+    s.get_collection('/cal/')[:displayname].should.be.nil
+  end
+end

data/lib/async/caldav/handlers/put.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "scampi"
-require "async/caldav"
-
 module Async
   module Caldav
     module Handlers
@@ -11,153 +7,177 @@ module Async
         module_function
 
         def call(path:, body:, storage:, headers: {}, resource_type: nil, **)
-          return [400, { 'content-type' => 'text/plain' }, ['Empty body']] if body.nil? || body.strip.empty?
+          rejected = rejection(body, resource_type)
+          if rejected
+            rejected
+          else
+            content_type = headers['content-type'] || default_content_type(resource_type)
+            store(
+              path,
+              body,
+              content_type,
+              storage,
+              headers,
+            )
+          end
+        end
 
-          # Validate body format
+        # Everything judged from the body alone, before anything is looked up or
+        # written. nil when the body is acceptable, otherwise the response.
+        def rejection(body, resource_type)
+          if body.nil? || body.strip.empty?
+            [400, { 'content-type' => 'text/plain' }, ['Empty body']]
+          elsif resource_type == :calendar && !body.start_with?('BEGIN:VCALENDAR')
+            [400, { 'content-type' => 'text/plain' }, ['Invalid calendar data']]
+          elsif resource_type == :addressbook && !body.start_with?('BEGIN:VCARD')
+            [400, { 'content-type' => 'text/plain' }, ['Invalid vCard data']]
+          end
+        end
+
+        def default_content_type(resource_type)
           if resource_type == :calendar
-            return [400, { 'content-type' => 'text/plain' }, ['Invalid calendar data']] unless body.start_with?('BEGIN:VCALENDAR')
-            content_type = headers['content-type'] || 'text/calendar'
+            'text/calendar'
           elsif resource_type == :addressbook
-            return [400, { 'content-type' => 'text/plain' }, ['Invalid vCard data']] unless body.start_with?('BEGIN:VCARD')
-            content_type = headers['content-type'] || 'text/vcard'
+            'text/vcard'
           else
-            content_type = headers['content-type'] || 'application/octet-stream'
+            'application/octet-stream'
           end
+        end
 
+        def store(path, body, content_type, storage, headers)
           existing = storage.get_item(path.to_s)
-
-          # Precondition checks
           if_match = headers['if-match']
           if_none_match = headers['if-none-match']
-
           if if_match && (!existing || existing[:etag] != if_match)
-            return [412, { 'content-type' => 'text/plain' }, ['Precondition Failed']]
-          end
-
-          if if_none_match == '*' && existing
-            return [412, { 'content-type' => 'text/plain' }, ['Precondition Failed']]
-          end
-
-          # UID conflict check for new items
-          if !existing
-            uid = extract_uid(body)
-            if uid
-              collection_path = path.parent.to_s
-              items = storage.list_items(collection_path)
-              items.each do |item_path, item_data|
-                next if item_path == path.to_s
-                if extract_uid(item_data[:body]) == uid
-                  return [409, { 'content-type' => 'text/plain' }, ['UID conflict']]
-                end
-              end
+            [412, { 'content-type' => 'text/plain' }, ['Precondition Failed']]
+          elsif if_none_match == '*' && existing
+            [412, { 'content-type' => 'text/plain' }, ['Precondition Failed']]
+          elsif !existing && uid_conflict?(path, body, storage)
+            [409, { 'content-type' => 'text/plain' }, ['UID conflict']]
+          else
+            item, is_new = storage.put_item(path.to_s, body, content_type)
+            if is_new
+              [201, { 'etag' => item[:etag], 'content-type' => 'text/plain' }, ['']]
+            else
+              [204, { 'etag' => item[:etag] }, ['']]
             end
           end
+        end
 
-          item, is_new = storage.put_item(path.to_s, body, content_type)
-
-          if is_new
-            [201, { 'etag' => item[:etag], 'content-type' => 'text/plain' }, ['']]
+        # A UID may appear once per collection. The item at `path` itself is
+        # skipped: replacing it with a body carrying its own UID is not a clash.
+        def uid_conflict?(path, body, storage)
+          uid = extract_uid(body)
+          if uid
+            storage.list_items(path.parent.to_s).any? do |item_path, item_data|
+              item_path != path.to_s && extract_uid(item_data[:body]) == uid
+            end
           else
-            [204, { 'etag' => item[:etag] }, ['']]
+            false
           end
         end
 
         def extract_uid(body)
-          return nil unless body
-          match = body.match(/^UID:(.+)/i)
-          match ? match[1].strip : nil
+          if body
+            match = body.match(/^UID:(.+)/i)
+            match ? match[1].strip : nil
+          else
+            nil
+          end
         end
 
-        private_class_method :extract_uid
+        private_class_method :extract_uid, :rejection, :default_content_type, :store, :uid_conflict?
       end
     end
   end
 end
 
-test do
-  describe "Async::Caldav::Handlers::Put" do
-    def call(**opts)
-      Async::Caldav::Handlers::Put.call(**opts)
-    end
+__END__
 
-    def path(p, s)
-      Protocol::Caldav::Path.new(p, storage_class: s)
-    end
+require_relative "../../caldav"
 
-    it "creates a new calendar item and returns 201" do
-      s = Async::Caldav::Storage::Mock.new
-      s.create_collection('/calendars/admin/cal/')
-      status, headers, = call(
-        path: path('/calendars/admin/cal/ev.ics', s), storage: s,
-        body: "BEGIN:VCALENDAR\r\nUID:123\r\nEND:VCALENDAR",
-        resource_type: :calendar
-      )
-      status.should.equal 201
-      headers['etag'].should.not.be.nil
-    end
+describe "Async::Caldav::Handlers::Put" do
+  def call(**opts)
+    Async::Caldav::Handlers::Put.call(**opts)
+  end
 
-    it "updates an existing item and returns 204" do
-      s = Async::Caldav::Storage::Mock.new
-      s.create_collection('/calendars/admin/cal/')
-      s.put_item('/calendars/admin/cal/ev.ics', "BEGIN:VCALENDAR\r\nUID:123\r\nEND:VCALENDAR", 'text/calendar')
-      status, = call(
-        path: path('/calendars/admin/cal/ev.ics', s), storage: s,
-        body: "BEGIN:VCALENDAR\r\nUID:123\r\nSUMMARY:Updated\r\nEND:VCALENDAR",
-        resource_type: :calendar
-      )
-      status.should.equal 204
-    end
+  def path(p, s)
+    Protocol::Caldav::Path.new(p, storage_class: s)
+  end
 
-    it "returns 400 for empty body" do
-      s = Async::Caldav::Storage::Mock.new
-      status, = call(path: path('/cal/ev.ics', s), storage: s, body: "")
-      status.should.equal 400
-    end
+  it "creates a new calendar item and returns 201" do
+    s = Async::Caldav::Storage::Mock.new
+    s.create_collection('/calendars/admin/cal/')
+    status, headers, = call(
+      path: path('/calendars/admin/cal/ev.ics', s), storage: s,
+      body: "BEGIN:VCALENDAR\r\nUID:123\r\nEND:VCALENDAR",
+      resource_type: :calendar
+    )
+    status.should.equal 201
+    headers['etag'].should.not.be.nil
+  end
 
-    it "returns 400 for invalid calendar data" do
-      s = Async::Caldav::Storage::Mock.new
-      status, = call(path: path('/cal/ev.ics', s), storage: s, body: "NOT ICAL", resource_type: :calendar)
-      status.should.equal 400
-    end
+  it "updates an existing item and returns 204" do
+    s = Async::Caldav::Storage::Mock.new
+    s.create_collection('/calendars/admin/cal/')
+    s.put_item('/calendars/admin/cal/ev.ics', "BEGIN:VCALENDAR\r\nUID:123\r\nEND:VCALENDAR", 'text/calendar')
+    status, = call(
+      path: path('/calendars/admin/cal/ev.ics', s), storage: s,
+      body: "BEGIN:VCALENDAR\r\nUID:123\r\nSUMMARY:Updated\r\nEND:VCALENDAR",
+      resource_type: :calendar
+    )
+    status.should.equal 204
+  end
 
-    it "returns 400 for invalid vCard data" do
-      s = Async::Caldav::Storage::Mock.new
-      status, = call(path: path('/addr/c.vcf', s), storage: s, body: "NOT VCARD", resource_type: :addressbook)
-      status.should.equal 400
-    end
+  it "returns 400 for empty body" do
+    s = Async::Caldav::Storage::Mock.new
+    status, = call(path: path('/cal/ev.ics', s), storage: s, body: "")
+    status.should.equal 400
+  end
 
-    it "returns 412 on If-Match mismatch" do
-      s = Async::Caldav::Storage::Mock.new
-      s.put_item('/cal/ev.ics', 'BEGIN:VCALENDAR', 'text/calendar')
-      status, = call(
-        path: path('/cal/ev.ics', s), storage: s,
-        body: "BEGIN:VCALENDAR\r\nNEW", resource_type: :calendar,
-        headers: { 'if-match' => '"wrong"' }
-      )
-      status.should.equal 412
-    end
+  it "returns 400 for invalid calendar data" do
+    s = Async::Caldav::Storage::Mock.new
+    status, = call(path: path('/cal/ev.ics', s), storage: s, body: "NOT ICAL", resource_type: :calendar)
+    status.should.equal 400
+  end
 
-    it "returns 412 on If-None-Match=* when item exists" do
-      s = Async::Caldav::Storage::Mock.new
-      s.put_item('/cal/ev.ics', 'BEGIN:VCALENDAR', 'text/calendar')
-      status, = call(
-        path: path('/cal/ev.ics', s), storage: s,
-        body: "BEGIN:VCALENDAR\r\nNEW", resource_type: :calendar,
-        headers: { 'if-none-match' => '*' }
-      )
-      status.should.equal 412
-    end
+  it "returns 400 for invalid vCard data" do
+    s = Async::Caldav::Storage::Mock.new
+    status, = call(path: path('/addr/c.vcf', s), storage: s, body: "NOT VCARD", resource_type: :addressbook)
+    status.should.equal 400
+  end
 
-    it "returns 409 on UID conflict" do
-      s = Async::Caldav::Storage::Mock.new
-      s.create_collection('/cal/')
-      s.put_item('/cal/a.ics', "BEGIN:VCALENDAR\r\nUID:same\r\nEND:VCALENDAR", 'text/calendar')
-      status, = call(
-        path: path('/cal/b.ics', s), storage: s,
-        body: "BEGIN:VCALENDAR\r\nUID:same\r\nEND:VCALENDAR",
-        resource_type: :calendar
-      )
-      status.should.equal 409
-    end
+  it "returns 412 on If-Match mismatch" do
+    s = Async::Caldav::Storage::Mock.new
+    s.put_item('/cal/ev.ics', 'BEGIN:VCALENDAR', 'text/calendar')
+    status, = call(
+      path: path('/cal/ev.ics', s), storage: s,
+      body: "BEGIN:VCALENDAR\r\nNEW", resource_type: :calendar,
+      headers: { 'if-match' => '"wrong"' }
+    )
+    status.should.equal 412
   end
-end
+
+  it "returns 412 on If-None-Match=* when item exists" do
+    s = Async::Caldav::Storage::Mock.new
+    s.put_item('/cal/ev.ics', 'BEGIN:VCALENDAR', 'text/calendar')
+    status, = call(
+      path: path('/cal/ev.ics', s), storage: s,
+      body: "BEGIN:VCALENDAR\r\nNEW", resource_type: :calendar,
+      headers: { 'if-none-match' => '*' }
+    )
+    status.should.equal 412
+  end
+
+  it "returns 409 on UID conflict" do
+    s = Async::Caldav::Storage::Mock.new
+    s.create_collection('/cal/')
+    s.put_item('/cal/a.ics', "BEGIN:VCALENDAR\r\nUID:same\r\nEND:VCALENDAR", 'text/calendar')
+    status, = call(
+      path: path('/cal/b.ics', s), storage: s,
+      body: "BEGIN:VCALENDAR\r\nUID:same\r\nEND:VCALENDAR",
+      resource_type: :calendar
+    )
+    status.should.equal 409
+  end
+end