tilia-dav 3.1.0.pre.alpha2

data/lib/tilia/dav/exception.rb

@@ -0,0 +1,59 @@
+module Tilia
+  module Dav
+    # Main Exception class.
+    #
+    # This class defines a getHTTPCode method, which should return the appropriate HTTP code for the Exception occurred.
+    # The default for this is 500.
+    #
+    # This class also allows you to generate custom xml data for your exceptions. This will be displayed
+    # in the 'error' element in the failing response.
+    class Exception < StandardError
+      # Returns the HTTP statuscode for this exception
+      #
+      # @return int
+      def http_code
+        500
+      end
+
+      # This method allows the exception to include additional information into the WebDAV error response
+      #
+      # @param Server server
+      # @param \DOMElement error_node
+      # @return void
+      def serialize(server, error_node)
+      end
+
+      # This method allows the exception to return any extra HTTP response headers.
+      #
+      # The headers must be returned as an array.
+      #
+      # @param Server $server
+      # @return array
+      def http_headers(_server)
+        {}
+      end
+
+      require 'tilia/dav/exception/bad_request'
+      require 'tilia/dav/exception/conflict'
+      require 'tilia/dav/exception/locked'
+      require 'tilia/dav/exception/conflicting_lock'
+      require 'tilia/dav/exception/forbidden'
+      require 'tilia/dav/exception/insufficient_storage'
+      require 'tilia/dav/exception/invalid_resource_type'
+      require 'tilia/dav/exception/invalid_sync_token'
+      require 'tilia/dav/exception/length_required'
+      require 'tilia/dav/exception/lock_token_matches_request_uri'
+      require 'tilia/dav/exception/method_not_allowed'
+      require 'tilia/dav/exception/not_authenticated'
+      require 'tilia/dav/exception/not_found'
+      require 'tilia/dav/exception/not_implemented'
+      require 'tilia/dav/exception/payment_required'
+      require 'tilia/dav/exception/precondition_failed'
+      require 'tilia/dav/exception/unsupported_media_type'
+      require 'tilia/dav/exception/report_not_supported'
+      require 'tilia/dav/exception/requested_range_not_satisfiable'
+      require 'tilia/dav/exception/service_unavailable'
+      require 'tilia/dav/exception/too_many_matches'
+    end
+  end
+end

data/lib/tilia/dav/exception/bad_request.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # BadRequest
+      #
+      # The BadRequest is thrown when the user submitted an invalid HTTP request
+      # BadRequest
+      class BadRequest < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          400
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/conflict.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # Conflict
+      #
+      # A 409 Conflict is thrown when a user tried to make a directory over an existing
+      # file or in a parent directory that doesn't exist.
+      class Conflict < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          409
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/conflicting_lock.rb

@@ -0,0 +1,26 @@
+module Tilia
+  module Dav
+    class Exception
+      # ConflictingLock
+      #
+      # Similar to  the Locked exception, this exception thrown when a LOCK request
+      # was made, on a resource which was already locked
+      class ConflictingLock < Locked
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          if lock
+            error = LibXML::XML::Node.new('d:no-conflicting-lock')
+            error_node << error
+
+            href = LibXML::XML::Node.new('d:href', lock.uri)
+            error << href
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/forbidden.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # Forbidden
+      #
+      # This exception is thrown whenever a user tries to do an operation he's not
+      # allowed to
+      class Forbidden < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          403
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/insufficient_storage.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # InsufficientStorage
+      #
+      # This Exception can be thrown, when for example a harddisk is full or a quota
+      # is exceeded
+      class InsufficientStorage < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          507
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/invalid_resource_type.rb

@@ -0,0 +1,23 @@
+module Tilia
+  module Dav
+    class Exception
+      # InvalidResourceType
+      #
+      # This exception is thrown when the user tried to create a new collection, with
+      # a special resourcetype value that was not recognized by the server.
+      #
+      # See RFC5689 section 3.3
+      class InvalidResourceType < Forbidden
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:valid-resourcetype')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/invalid_sync_token.rb

@@ -0,0 +1,26 @@
+module Tilia
+  module Dav
+    class Exception
+      # InvalidSyncToken
+      #
+      # This exception is emited for the {DAV:}valid-sync-token pre-condition, as
+      # defined in rfc6578, section 3.2.
+      #
+      # http://tools.ietf.org/html/rfc6578#section-3.2
+      #
+      # This is emitted in cases where the the sync-token, supplied by a client is
+      # either completely unknown, or has expired.
+      class InvalidSyncToken < Forbidden
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:valid-sync-token')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/length_required.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # LengthRequired
+      #
+      # This exception is thrown when a request was made that required a
+      # Content-Length header, but did not contain one.
+      class LengthRequired < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          411
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/lock_token_matches_request_uri.rb

@@ -0,0 +1,25 @@
+module Tilia
+  module Dav
+    class Exception
+      # LockTokenMatchesRequestUri
+      #
+      # This exception is thrown by UNLOCK if a supplied lock-token is invalid
+      class LockTokenMatchesRequestUri < Conflict
+        # Creates the exception
+        def initialize(msg = 'The locktoken supplied does not match any locks on this entity')
+          super
+        end
+
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          error = LibXML::XML::Node.new('d:lock-token-matches-request-uri')
+          error_node << error
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/locked.rb

@@ -0,0 +1,48 @@
+module Tilia
+  module Dav
+    class Exception
+      # Locked
+      #
+      # The 423 is thrown when a client tried to access a resource that was locked,
+      # without supplying a valid lock token
+      class Locked < Exception
+        # Lock information
+        #
+        # @var Sabre\DAV\Locks\LockInfo
+        attr_accessor :lock
+
+        # Creates the exception
+        #
+        # A LockInfo object should be passed if the user should be informed
+        # which lock actually has the file locked.
+        #
+        # @param DAV\Locks\LockInfo lock
+        def initialize(lock = nil)
+          self.lock = lock
+        end
+
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          423
+        end
+
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          if lock
+            error = LibXML::XML::Node.new('d:lock-token-submitted')
+            error_node << error
+
+            href = LibXML::XML::Node.new('d:href', lock.uri)
+            error << href
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/method_not_allowed.rb

@@ -0,0 +1,29 @@
+module Tilia
+  module Dav
+    class Exception
+      # MethodNotAllowed
+      #
+      # The 405 is thrown when a client tried to create a directory on an already
+      # existing directory
+      class MethodNotAllowed < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          405
+        end
+
+        # This method allows the exception to return any extra HTTP response headers.
+        #
+        # The headers must be returned as an array.
+        #
+        # @param \Sabre\DAV\Server server
+        # @return array
+        def http_headers(server)
+          methods = server.allowed_methods(server.request_uri)
+          { 'Allow' => methods.join(', ').upcase }
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/not_authenticated.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # NotAuthenticated
+      #
+      # This exception is thrown when the client did not provide valid
+      # authentication credentials.
+      class NotAuthenticated < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          401
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/not_found.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # NotFound
+      #
+      # This Exception is thrown when a Node couldn't be found. It returns HTTP error
+      # code 404
+      class NotFound < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          404
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/not_implemented.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # NotImplemented
+      #
+      # This exception is thrown when the client tried to call an unsupported HTTP
+      # method or other feature
+      class NotImplemented < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          501
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/payment_required.rb

@@ -0,0 +1,18 @@
+module Tilia
+  module Dav
+    class Exception
+      # Payment Required
+      #
+      # The PaymentRequired exception may be thrown in a case where a user must pay
+      # to access a certain resource or operation.
+      class PaymentRequired < Exception
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          402
+        end
+      end
+    end
+  end
+end

data/lib/tilia/dav/exception/precondition_failed.rb

@@ -0,0 +1,47 @@
+module Tilia
+  module Dav
+    class Exception
+      # PreconditionFailed
+      #
+      # This exception is normally thrown when a client submitted a conditional request,
+      # like for example an If, If-None-Match or If-Match header, which caused the HTTP
+      # request to not execute (the condition of the header failed)
+      class PreconditionFailed < Exception
+        # When this exception is thrown, the header-name might be set.
+        #
+        # This allows the exception-catching code to determine which HTTP header
+        # caused the exception.
+        #
+        # @var string
+        attr_accessor :header
+
+        # Create the exception
+        #
+        # @param string $message
+        # @param string $header
+        def initialize(header = nil)
+          self.header = header
+        end
+
+        # Returns the HTTP statuscode for this exception
+        #
+        # @return int
+        def http_code
+          412
+        end
+
+        # This method allows the exception to include additional information into the WebDAV error response
+        #
+        # @param DAV\Server server
+        # @param \DOMElement error_node
+        # @return void
+        def serialize(_server, error_node)
+          if header
+            prop = LibXML::XML::Node.new('s:header', header)
+            error_node << prop
+          end
+        end
+      end
+    end
+  end
+end