calligraphy 0.2.1 → 0.3.1

data/lib/calligraphy/{mkcol.rb → web_dav_request/mkcol.rb}

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module Calligraphy
+  # Responsible for creating a new collection resource at the location
+  # specified by the request.
   class Mkcol < WebDavRequest
-    def request
+    # Executes the WebDAV request for a particular resource.
+    def execute
       return :method_not_allowed if @resource.exists?
       return :conflict unless @resource.ancestor_exist?
       return :unsupported_media_type unless @resource.request_body.blank?
@@ -8,7 +13,7 @@ module Calligraphy
       @resource.create_collection
       set_content_location_header
 
-      return :created
+      :created
     end
 
     private

data/lib/calligraphy/web_dav_request/move.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Calligraphy
+  # Responsible for copying a resource then deleting the original source.
+  class Move < Copy
+    # Executes the WebDAV request for a particular resource.
+    def execute
+      return :locked if @resource.locked_to_user? @headers
+
+      if @resource.true? options[:overwrite]
+        previous_resource_existed = overwrite_destination
+      end
+
+      status = super
+      return status if %i[precondition_failed conflict].include? status
+
+      @resource.delete_collection
+
+      response_status status, previous_resource_existed
+    end
+
+    private
+
+    def options
+      copy_move_options
+    end
+
+    def overwrite_destination
+      to_path = options[:destination].tap { |s| s.slice! @resource.mount_point }
+      to_resource = destination_resource to_path
+
+      if to_resource.exists?
+        to_resource.delete_collection
+        previous_resource_existed = true
+      end
+
+      previous_resource_existed
+    end
+
+    def destination_resource(to_path)
+      @resource.class.new(
+        resource: to_path,
+        req: @request,
+        root_dir: @resource.root_dir
+      )
+    end
+
+    def response_status(status, previous_resource)
+      return :no_content if status == :created && previous_resource
+
+      response.headers['Location'] = options[:destination] if status == :created
+
+      status
+    end
+  end
+end

data/lib/calligraphy/web_dav_request/propfind.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Calligraphy
+  # Responsible for retrieving properties defined on the resource.
+  class Propfind < WebDavRequest
+    include Calligraphy::XML::Utils
+
+    # Executes the WebDAV request for a particular resource.
+    def execute
+      xml = xml_for body: body, node: 'propfind'
+      return :bad_request if xml == :bad_request
+
+      properties = @resource.propfind xml
+
+      builder = xml_builder
+      xml_res = builder.propfind_response(@resource.full_request_path,
+                                          properties)
+
+      set_xml_content_type
+
+      [:multi_status, xml_res]
+    end
+  end
+end

data/lib/calligraphy/web_dav_request/proppatch.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Calligraphy
+  # Responsible for processing instructions specified in the request body
+  # to set and/or remove properties defined on the resource.
+  class Proppatch < WebDavRequest
+    include Calligraphy::XML::Utils
+
+    # Executes the WebDAV request for a particular resource.
+    def execute
+      return :locked if @resource.locked_to_user? @headers
+
+      # The `propertyupdate` tag contains the request to alter properties
+      # on a resource.
+      xml = xml_for body: body, node: 'propertyupdate'
+      return :bad_request if xml == :bad_request
+
+      actions = @resource.proppatch xml
+
+      builder = xml_builder
+      xml_res = builder.proppatch_response(@resource.full_request_path,
+                                           actions)
+
+      set_xml_content_type
+
+      [:multi_status, xml_res]
+    end
+  end
+end

data/lib/calligraphy/web_dav_request/put.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Calligraphy
+  # Responsible for replacing the `Get` response entity of the resource.
+  class Put < WebDavRequest
+    # Executes the WebDAV request for a particular resource.
+    def execute
+      return :locked if @resource.locked_to_user? @headers
+      return :method_not_allowed if @resource.collection?
+
+      @resource.write
+
+      [:created, @resource.contents]
+    end
+  end
+end

data/lib/calligraphy/{unlock.rb → web_dav_request/unlock.rb}

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module Calligraphy
+  # Responsible for removing the lock identified by the lock token in the
+  # request header.
   class Unlock < WebDavRequest
-    def request
+    # Executes the WebDAV request for a particular resource.
+    def execute
       return :bad_request if @headers['Lock-Token'].nil?
 
       @resource.unlock lock_token_header

data/lib/calligraphy/web_dav_request/web_dav_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Calligraphy
+  # Base class for WebDavRequests.
+  #
+  # `WebDavRequest` exposes the `request` method, which is used by the
+  # `WebDavRequestsController` to execute the WebDAV request for a particular
+  # resource. This class also provides private methods for accessing the
+  # request body, setting response headers, and creating XML responses.
+  class WebDavRequest
+    attr_accessor :resource, :response
+    attr_reader :headers, :request
+
+    #:nodoc:
+    def initialize(headers:, request:, response:, resource:)
+      @headers = headers
+      @request = request
+      @response = response
+      @resource = resource
+    end
+
+    # Executes the WebDAV request for a particular resource.
+    def execute
+      raise NotImplemented
+    end
+
+    private
+
+    def body
+      @resource.request_body
+    end
+
+    def set_xml_content_type
+      @response.content_type = 'application/xml'
+    end
+
+    def xml_builder
+      protocol = @request.env['SERVER_PROTOCOL']
+
+      Calligraphy::XML::Builder.new server_protocol: protocol
+    end
+  end
+end

data/lib/calligraphy/xml/builder.rb

@@ -1,152 +1,118 @@
-module Calligraphy::XML
-  class Builder
-    SUPPORTED_NS_TAGS = %w(
-      creationdate displayname exclusive getcontentlanguage getcontentlength
-      getcontenttype getetag getlastmodified href lockdiscovery lockscope
-      locktype owner write
-    )
-    DAV_PROPERTIES = %w(
-      creationdate displayname getcontentlanguage getcontentlength
-      getcontenttype getetag getlastmodified lockdiscovery
-      resourcetype supportedlock
-    )
-
-    attr_reader :dav_ns, :default_ns, :server_protocol
-
-    def initialize(dav_ns: 'D', server_protocol: 'HTTP/1.1')
-      @dav_ns = dav_ns
-      @default_ns = { "xmlns:#{@dav_ns}" => 'DAV:' }
-      @server_protocol = server_protocol
-    end
+# frozen_string_literal: true
 
-    def lock_res(activelock_properties)
-      build :prop do |xml|
-        xml.lockdiscovery do
-          activelock_properties.each do |properties|
-            activelock xml, properties
-          end
-        end
-      end
-    end
+module Calligraphy
+  module XML
+    # Responsible for building XML responses for WebDAV requests.
+    class Builder
+      include Calligraphy::XML::WebDavElements
+
+      attr_reader :dav_ns, :default_ns, :server_protocol
 
-    def propfind_res(path, properties)
-      multistatus do |xml|
-        href xml, path
-        propstat xml, properties[:found], :ok
-        propstat xml, properties[:not_found], :not_found
+      #:nodoc:
+      def initialize(dav_ns: 'D', server_protocol: 'HTTP/1.1')
+        @dav_ns = dav_ns
+        @default_ns = { "xmlns:#{@dav_ns}" => 'DAV:' }
+        @server_protocol = server_protocol
       end
-    end
 
-    def proppatch_res(path, actions)
-      multistatus do |xml|
-        href xml, path
-        propstat xml, actions[:set]
-        propstat xml, actions[:remove]
+      private
+
+      def build(tag)
+        Nokogiri::XML::Builder.new do |xml|
+          xml[@dav_ns].send(tag, @default_ns) { yield xml }
+        end.to_xml
       end
-    end
 
-    private
+      def multistatus
+        build :multistatus do |xml|
+          xml.response { yield xml }
+        end
+      end
 
-    def build(tag)
-      Nokogiri::XML::Builder.new do |xml|
-        xml[@dav_ns].send(tag, @default_ns) do
-          yield xml
+      def property_drilldown(xml, property)
+        if property.is_a? Array
+          iterate_and_drilldown xml, property
+        elsif DAV_NS_TAGS.include? property.name
+          supported_ns_tag xml, property
+        elsif property.namespace&.href
+          non_supported_ns_tag xml, property
+        else
+          nil_ns_tag xml, property
         end
-      end.to_xml
-    end
+      end
 
-    def activelock(xml, property_set)
-      xml.activelock do
+      def iterate_and_drilldown(xml, property_set)
         property_set.each do |property|
           property_drilldown xml, property
         end
       end
-    end
 
-    def href(xml, path)
-      xml.href path
-    end
+      def supported_ns_tag(xml, property)
+        if DAV_NS_METHODS.include? property.name
+          return send property.name, xml, property
+        end
 
-    def multistatus
-      build :multistatus do |xml|
-        xml.response do
-          yield xml
+        xml[@dav_ns].send property.name do
+          if property.children
+            iterate_and_drilldown xml, property.children
+          else
+            xml.text property.text
+          end
         end
       end
-    end
 
-    def prop(xml, property_set)
-      xml.prop do
-        property_set.each do |property|
-          property_drilldown xml, property
+      def non_supported_ns_tag(xml, property)
+        xml.send property.name, xmlns: property.namespace.href do
+          if property.children
+            iterate_and_drilldown xml, property.children
+          else
+            xml.text property.text
+          end
         end
       end
-    end
 
-    def propstat(xml, property_set, status=:ok)
-      return unless property_set.length > 0
+      def nil_ns_tag(xml, property)
+        xml.send property.name, property.text do
+          xml.parent.namespace = nil
+        end
+      end
 
-      xml.propstat do
-        prop xml, property_set
-        status xml, status
+      def self_closing_tag(xml, text)
+        xml.send text
+      end
+
+      def href(xml, path)
+        xml[@dav_ns].href path
       end
-    end
 
-    def resourcetype(xml, property)
-      if property.children.text == 'collection'
-        xml[@dav_ns].resourcetype do
-          xml.send 'collection'
+      def prop(xml, property_set)
+        xml[@dav_ns].prop do
+          iterate_and_drilldown xml, property_set
         end
-      else
-        xml[@dav_ns].resourcetype
       end
-    end
 
-    def status(xml, status)
-      xml.status status_message status
-    end
+      def propstat(xml, property_set, status = :ok)
+        return if property_set.empty?
 
-    # NOTE: `xml[@dav_ns].send timeout` results in Timeout being called, so
-    # we have this timeout method for convenience
-    def timeout(xml, property)
-      xml[@dav_ns].timeout do
-        xml.text property.text
+        xml[@dav_ns].propstat do
+          prop xml, property_set
+          status xml, status
+        end
       end
-    end
 
-    def property_drilldown(xml, property)
-      if property.is_a? Array
-        property.each do |prop|
-          property_drilldown xml, prop
-        end
-      elsif property.children && property.text.nil?
-        xml.send property.name do
-          property.children.each do |child|
-            property_drilldown xml, child
-          end
-        end
-      elsif property.name == 'resourcetype'
-        resourcetype xml, property
-      elsif property.name == 'timeout'
-        timeout xml, property
-      elsif SUPPORTED_NS_TAGS.include? property.name
-        xml[@dav_ns].send property.name do
-          xml.text property.text
-        end
-      elsif property.namespace && property.namespace.href
-        xml.send property.name, xmlns: property.namespace.href do
-          xml.text property.text
-        end
-      else
-        xml.send property.name, property.text do
-          xml.parent.namespace = nil
-        end
+      def status(xml, status)
+        xml[@dav_ns].status status_message status
       end
-    end
 
-    def status_message(status)
-      status_code = Rack::Utils.status_code status
-      [@server_protocol, status_code, Rack::Utils::HTTP_STATUS_CODES[status_code]].join ' '
+      def status_message(status)
+        status_code = Rack::Utils.status_code status
+
+        [
+          @server_protocol,
+          status_code,
+          Rack::Utils::HTTP_STATUS_CODES[status_code]
+        ].join ' '
+      end
     end
   end
 end

data/lib/calligraphy/xml/namespace.rb

@@ -1,10 +1,16 @@
-module Calligraphy::XML
-  class Namespace
-    attr_accessor :href, :prefix
+# frozen_string_literal: true
 
-    def initialize(namespace)
-      @href = namespace.href if namespace.href
-      @prefix = namespace.prefix if namespace.prefix
+module Calligraphy
+  module XML
+    # Simple XML namespace, used to store a namespace's href and prefix values.
+    class Namespace
+      attr_accessor :href, :prefix
+
+      #:nodoc:
+      def initialize(namespace)
+        @href = namespace.href if namespace.href
+        @prefix = namespace.prefix if namespace.prefix
+      end
     end
   end
 end