protocol-caldav 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b119c6f8e0f3fa86e9ca3606eea776a73cd872049fac80674a4f8ffba0bfaf4
-  data.tar.gz: 7f4d5929f5c6227694375e5ec77130b18e7b7b72e72bc01f67c633a63f73aa3d
+  metadata.gz: f6f47958a3c9bccd45a0d66e1ab51c3f9dfb6a972831758f267e9181f25f46ba
+  data.tar.gz: 06142acc86bcf06cc71a4c148dd0e04793d48cd10ee5358a8e5fcf13258f110e
 SHA512:
-  metadata.gz: 4c842735fafa37d1d224ac8d8a48ee18237897baada5e8dc755a327bc0c9e67d29a4060ca9ca0f1d1cd435ec7d701462cdbe84c145579e720d1dad85b32031ce
-  data.tar.gz: b6187b613165259a2c277483f4ed46b404d103618545ff6b1c7caa77481428b96402c970711e70c9ea6db1e5bc8cbd5b70e942859a2d533dd2cb6ac9d7b8a9aa
+  metadata.gz: 77d54931bda2319b83cd344d3c89ee13675fbc381d00a35c0ec2618a117f096571b3f370f187bf02d15bd66a2eaf2f8805a58ab6312430523e59d630f491a621
+  data.tar.gz: c6501d31590539f4ca0f73bef8eaaaff00c411697944f52d429c227c4cf6946f0670f14b6ad92790953c2741de3a324f155e8af1e2b4a3e3f3d9150f56f0efa5

data/lib/protocol/caldav/collection.rb

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "scampi"
+require "builder"
 
 require "protocol/caldav"
 
@@ -27,73 +28,79 @@ module Protocol
         self
       end
 
-      def to_propfind_xml
-        prop_lines = []
-
-        if @type == :calendar
-          prop_lines << '<d:resourcetype><d:collection/><c:calendar/></d:resourcetype>'
-        elsif @type == :addressbook
-          prop_lines << '<d:resourcetype><d:collection/><cr:addressbook/></d:resourcetype>'
-        else
-          prop_lines << '<d:resourcetype><d:collection/></d:resourcetype>'
+      def build_propfind(xml)
+        XmlBuilder.response(xml, href: @path.to_s) do
+          XmlBuilder.propstat_ok(xml) do
+            xml.tag!("d:resourcetype") do
+              xml.tag!("d:collection")
+              xml.tag!("c:calendar") if @type == :calendar
+              xml.tag!("cr:addressbook") if @type == :addressbook
+            end
+
+            xml.tag!("d:displayname", @displayname) if @displayname
+            xml.tag!("c:calendar-description", @description) if @description
+            xml.tag!("x:calendar-color", @color) if @color
+
+            item_etags = @path.storage_class.list_items(@path.to_s).map { |_, data| data[:etag] }
+            ctag = CTag.compute(
+              path: @path.to_s,
+              displayname: @displayname,
+              description: @description,
+              color: @color,
+              item_etags: item_etags
+            )
+            xml.tag!("cs:getctag", ctag)
+            xml.tag!("d:sync-token", "http://caldav.local/sync/#{ctag}")
+
+            if @type == :calendar
+              xml.tag!("c:supported-calendar-component-set") do
+                xml.tag!("c:comp", name: "VEVENT")
+                xml.tag!("c:comp", name: "VTODO")
+                xml.tag!("c:comp", name: "VJOURNAL")
+              end
+            end
+
+            xml.tag!("d:current-user-privilege-set") do
+              xml.tag!("d:privilege") { xml.tag!("d:read") }
+              xml.tag!("d:privilege") { xml.tag!("d:write") }
+              xml.tag!("d:privilege") { xml.tag!("d:all") }
+            end
+
+            @props.each do |key, value|
+              xml.tag!(key, value)
+            end
+          end
         end
+      end
 
-        prop_lines << "<d:displayname>#{Xml.escape(@displayname)}</d:displayname>" if @displayname
-        prop_lines << "<c:calendar-description>#{Xml.escape(@description)}</c:calendar-description>" if @description
-        prop_lines << "<x:calendar-color>#{Xml.escape(@color)}</x:calendar-color>" if @color
-
-        item_etags = @path.storage_class.list_items(@path.to_s).map { |_, data| data[:etag] }
-        ctag = CTag.compute(
-          path: @path.to_s,
-          displayname: @displayname,
-          description: @description,
-          color: @color,
-          item_etags: item_etags
-        )
-        prop_lines << "<cs:getctag>#{ctag}</cs:getctag>"
-        prop_lines << "<d:sync-token>http://caldav.local/sync/#{ctag}</d:sync-token>"
-
-        if @type == :calendar
-          prop_lines << '<c:supported-calendar-component-set><c:comp name="VEVENT"/><c:comp name="VTODO"/><c:comp name="VJOURNAL"/></c:supported-calendar-component-set>'
+      def build_propname(xml)
+        XmlBuilder.response(xml, href: @path.to_s) do
+          XmlBuilder.propstat_ok(xml) do
+            xml.tag!("d:resourcetype")
+            xml.tag!("d:displayname") if @displayname
+            xml.tag!("c:calendar-description") if @description
+            xml.tag!("x:calendar-color") if @color
+            xml.tag!("cs:getctag")
+            xml.tag!("d:sync-token")
+            xml.tag!("c:supported-calendar-component-set") if @type == :calendar
+          end
         end
+      end
 
-        @props.each do |key, value|
-          prop_lines << "<#{key}>#{Xml.escape(value)}</#{key}>"
-        end
+      def build_xml(xml)
+        build_propfind(xml)
+      end
 
-        <<~XML
-          <d:response>
-            <d:href>#{Xml.escape(@path.to_s)}</d:href>
-            <d:propstat>
-              <d:prop>
-                #{prop_lines.join("\n          ")}
-              </d:prop>
-              <d:status>HTTP/1.1 200 OK</d:status>
-            </d:propstat>
-          </d:response>
-        XML
+      def to_propfind_xml
+        x = Builder::XmlMarkup.new
+        build_propfind(x)
+        x.target!
       end
 
       def to_propname_xml
-        names = ['<d:resourcetype/>']
-        names << '<d:displayname/>' if @displayname
-        names << '<c:calendar-description/>' if @description
-        names << '<x:calendar-color/>' if @color
-        names << '<cs:getctag/>'
-        names << '<d:sync-token/>'
-        names << '<c:supported-calendar-component-set/>' if @type == :calendar
-
-        <<~XML
-          <d:response>
-            <d:href>#{Xml.escape(@path.to_s)}</d:href>
-            <d:propstat>
-              <d:prop>
-                #{names.join("\n          ")}
-              </d:prop>
-              <d:status>HTTP/1.1 200 OK</d:status>
-            </d:propstat>
-          </d:response>
-        XML
+        x = Builder::XmlMarkup.new
+        build_propname(x)
+        x.target!
       end
     end
   end

data/lib/protocol/caldav/item.rb

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "scampi"
+require "builder"
 require "protocol/caldav"
 
 module Protocol
@@ -21,49 +22,53 @@ module Protocol
         @new_record
       end
 
+      def build_propfind(xml)
+        XmlBuilder.response(xml, href: @path.to_s) do
+          XmlBuilder.propstat_ok(xml) do
+            xml.tag!("d:getetag", @etag)
+            xml.tag!("d:getcontenttype", @content_type)
+          end
+        end
+      end
+
+      def build_propname(xml)
+        XmlBuilder.response(xml, href: @path.to_s) do
+          XmlBuilder.propstat_ok(xml) do
+            xml.tag!("d:getetag")
+            xml.tag!("d:getcontenttype")
+          end
+        end
+      end
+
+      def build_report(xml, data_tag:)
+        XmlBuilder.response(xml, href: @path.to_s) do
+          XmlBuilder.propstat_ok(xml) do
+            xml.tag!("d:getetag", @etag)
+            xml.tag!(data_tag, @body)
+          end
+        end
+      end
+
+      def build_xml(xml)
+        build_propfind(xml)
+      end
+
       def to_propfind_xml
-        <<~XML
-          <d:response>
-            <d:href>#{Xml.escape(@path.to_s)}</d:href>
-            <d:propstat>
-              <d:prop>
-                <d:getetag>#{Xml.escape(@etag)}</d:getetag>
-                <d:getcontenttype>#{Xml.escape(@content_type)}</d:getcontenttype>
-              </d:prop>
-              <d:status>HTTP/1.1 200 OK</d:status>
-            </d:propstat>
-          </d:response>
-        XML
+        x = Builder::XmlMarkup.new
+        build_propfind(x)
+        x.target!
       end
 
       def to_propname_xml
-        <<~XML
-          <d:response>
-            <d:href>#{Xml.escape(@path.to_s)}</d:href>
-            <d:propstat>
-              <d:prop>
-                <d:getetag/>
-                <d:getcontenttype/>
-              </d:prop>
-              <d:status>HTTP/1.1 200 OK</d:status>
-            </d:propstat>
-          </d:response>
-        XML
+        x = Builder::XmlMarkup.new
+        build_propname(x)
+        x.target!
       end
 
       def to_report_xml(data_tag:)
-        <<~XML
-          <d:response>
-            <d:href>#{Xml.escape(@path.to_s)}</d:href>
-            <d:propstat>
-              <d:prop>
-                <d:getetag>#{Xml.escape(@etag)}</d:getetag>
-                <#{data_tag}>#{Xml.escape(@body)}</#{data_tag}>
-              </d:prop>
-              <d:status>HTTP/1.1 200 OK</d:status>
-            </d:propstat>
-          </d:response>
-        XML
+        x = Builder::XmlMarkup.new
+        build_report(x, data_tag: data_tag)
+        x.target!
       end
     end
   end

data/lib/protocol/caldav/multistatus.rb

@@ -2,21 +2,23 @@
 
 require "bundler/setup"
 require "scampi"
+require "builder"
 
 module Protocol
   module Caldav
     class Multistatus
-      def initialize(responses)
+      def initialize(responses = [])
         @responses = responses
       end
 
-      def to_xml
-        <<~XML
-          <?xml version="1.0" encoding="UTF-8"?>
-          <d:multistatus xmlns:d="DAV:" xmlns:c="urn:ietf:params:xml:ns:caldav" xmlns:cr="urn:ietf:params:xml:ns:carddav" xmlns:cs="http://calendarserver.org/ns/" xmlns:x="http://apple.com/ns/ical/">
-          #{@responses.join}
-          </d:multistatus>
-        XML
+      def to_xml(&block)
+        XmlBuilder.multistatus do |xml|
+          if block
+            block.call(xml)
+          else
+            @responses.each { |r| r.build_xml(xml) }
+          end
+        end
       end
     end
   end
@@ -28,6 +30,17 @@ test do
     xml.gsub(/>\s+</, '><').strip
   end
 
+  # Minimal wrapper so tests can pass objects with build_xml
+  class FakeResponse
+    def initialize(href)
+      @href = href
+    end
+
+    def build_xml(xml)
+      xml.tag!("d:response") { xml.tag!("d:href", @href) }
+    end
+  end
+
   describe "Protocol::Caldav::Multistatus" do
     it "declares all four required namespaces" do
       xml = Protocol::Caldav::Multistatus.new([]).to_xml
@@ -38,8 +51,7 @@ test do
     end
 
     it "emits responses in the order given" do
-      responses = ["<d:response><d:href>/a</d:href></d:response>",
-                   "<d:response><d:href>/b</d:href></d:response>"]
+      responses = [FakeResponse.new("/a"), FakeResponse.new("/b")]
       xml = Protocol::Caldav::Multistatus.new(responses).to_xml
       xml.index("/a").should.be < xml.index("/b")
     end
@@ -51,11 +63,21 @@ test do
       xml.should.include '</d:multistatus>'
     end
 
-    it "does not double-escape pre-escaped XML in responses" do
-      response = "<d:response><d:href>/Work &amp; Personal</d:href></d:response>"
-      xml = Protocol::Caldav::Multistatus.new([response]).to_xml
+    it "does not double-escape when using builder" do
+      xml = Protocol::Caldav::Multistatus.new.to_xml do |x|
+        x.tag!("d:response") { x.tag!("d:href", "/Work & Personal") }
+      end
       xml.should.include '&amp;'
       xml.should.not.include '&amp;amp;'
     end
+
+    it "supports block form for custom content" do
+      xml = Protocol::Caldav::Multistatus.new.to_xml do |x|
+        x.tag!("d:response") { x.tag!("d:href", "/test") }
+        x.tag!("d:sync-token", "token-123")
+      end
+      xml.should.include '/test'
+      xml.should.include 'token-123'
+    end
   end
 end

data/lib/protocol/caldav/path.rb

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "scampi"
+require "builder"
 require "protocol/caldav"
 
 module Protocol
@@ -66,18 +67,22 @@ module Protocol
         to_s == other.to_s
       end
 
+      def build_propfind(xml)
+        XmlBuilder.response(xml, href: @to_s) do
+          XmlBuilder.propstat_ok(xml) do
+            xml.tag!("d:resourcetype") { xml.tag!("d:collection") }
+          end
+        end
+      end
+
+      def build_xml(xml)
+        build_propfind(xml)
+      end
+
       def to_propfind_xml
-        <<~XML
-          <d:response>
-            <d:href>#{Xml.escape(@to_s)}</d:href>
-            <d:propstat>
-              <d:prop>
-                <d:resourcetype><d:collection/></d:resourcetype>
-              </d:prop>
-              <d:status>HTTP/1.1 200 OK</d:status>
-            </d:propstat>
-          </d:response>
-        XML
+        x = Builder::XmlMarkup.new
+        build_propfind(x)
+        x.target!
       end
     end
   end

data/lib/protocol/caldav/version.rb

@@ -2,6 +2,6 @@
 
 module Protocol
   module Caldav
-    VERSION = "1.0.0"
+    VERSION = "1.0.2"
   end
 end

data/lib/protocol/caldav/xml_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "builder"
+
+module Protocol
+  module Caldav
+    module XmlBuilder
+      NAMESPACES = {
+        "xmlns:d"  => "DAV:",
+        "xmlns:c"  => "urn:ietf:params:xml:ns:caldav",
+        "xmlns:cr" => "urn:ietf:params:xml:ns:carddav",
+        "xmlns:cs" => "http://calendarserver.org/ns/",
+        "xmlns:x"  => "http://apple.com/ns/ical/"
+      }.freeze
+
+      module_function
+
+      def multistatus
+        xml = Builder::XmlMarkup.new
+        xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
+        xml.tag!("d:multistatus", NAMESPACES) do
+          yield xml
+        end
+        xml.target!
+      end
+
+      def response(xml, href:)
+        xml.tag!("d:response") do
+          xml.tag!("d:href", href)
+          yield xml if block_given?
+        end
+      end
+
+      def propstat_ok(xml)
+        xml.tag!("d:propstat") do
+          xml.tag!("d:prop") do
+            yield xml
+          end
+          xml.tag!("d:status", "HTTP/1.1 200 OK")
+        end
+      end
+    end
+  end
+end

data/lib/protocol/caldav.rb

@@ -5,6 +5,7 @@ require_relative 'caldav/constants'
 require_relative 'caldav/etag'
 require_relative 'caldav/ctag'
 require_relative 'caldav/xml'
+require_relative 'caldav/xml_builder'
 require_relative 'caldav/multistatus'
 require_relative 'caldav/path'
 require_relative 'caldav/storage'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-caldav
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Nathan K
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +84,7 @@ files:
 - lib/protocol/caldav/vcard/parser.rb
 - lib/protocol/caldav/version.rb
 - lib/protocol/caldav/xml.rb
+- lib/protocol/caldav/xml_builder.rb
 homepage: https://github.com/n-at-han-k/protocol-caldav
 licenses:
 - Apache-2.0