tilia-dav 3.1.0.pre.alpha2

data/test/dav/mock/collection.rb

@@ -0,0 +1,113 @@
+module Tilia
+  module Dav
+    module Mock
+      # Mock Collection.
+      #
+      # This collection quickly allows you to create trees of nodes.
+      # Children are specified as an array.
+      #
+      # Every key a filename, every array value is either:
+      #   * an array, for a sub-collection
+      #   * a string, for a file
+      #   * An instance of \Sabre\DAV\INode.
+      class Collection < Dav::Collection
+        protected
+
+        attr_accessor :name
+        attr_accessor :children
+        attr_accessor :parent
+
+        public
+
+        # Creates the object
+        #
+        # @param string name
+        # @param array children
+        # @return void
+        def initialize(name, children = {}, parent = nil)
+          @name = name
+          @children = []
+          children.each do |key, value|
+            if value.is_a?(String)
+              @children << File.new(key, value, self)
+            elsif value.is_a?(Hash)
+              @children << self.class.new(key, value, self)
+            elsif value.is_a?(Dav::INode)
+              @children << value
+            else
+              fail ArgumentError, 'Unknown value passed in children'
+            end
+          end
+          @parent = parent
+        end
+
+        # Returns the name of the node.
+        #
+        # This is used to generate the url.
+        #
+        # @return string
+        attr_reader :name
+
+        # Creates a new file in the directory
+        #
+        # Data will either be supplied as a stream resource, or in certain cases
+        # as a string. Keep in mind that you may have to support either.
+        #
+        # After successful creation of the file, you may choose to return the ETag
+        # of the new file here.
+        #
+        # The returned ETag must be surrounded by double-quotes (The quotes should
+        # be part of the actual string).
+        #
+        # If you cannot accurately determine the ETag, you should not return it.
+        # If you don't store the file exactly as-is (you're transforming it
+        # somehow) you should also not return an ETag.
+        #
+        # This means that if a subsequent GET to this new file does not exactly
+        # return the same contents of what was submitted here, you are strongly
+        # recommended to omit the ETag.
+        #
+        # @param string name Name of the file
+        # @param resource|string data Initial payload
+        # @return null|string
+        def create_file(name, data = nil)
+          data = data.readlines.join('') if data.respond_to?(:readlines)
+
+          @children << File.new(name, data, self)
+          "\"#{Digest::MD5.hexdigest(data)}\""
+        end
+
+        # Creates a new subdirectory
+        #
+        # @param string name
+        # @return void
+        def create_directory(name)
+          @children << self.class.new(name)
+        end
+
+        # Returns an array with all the child nodes
+        #
+        # @return \Sabre\DAV\INode[]
+        attr_reader :children
+
+        # Removes a childnode from this node.
+        #
+        # @param string name
+        # @return void
+        def delete_child(name)
+          @children.delete_if do |value|
+            value.name == name
+          end
+        end
+
+        # Deletes this collection and all its children,.
+        #
+        # @return void
+        def delete
+          @children = []
+          @parent.delete_child(name)
+        end
+      end
+    end
+  end
+end

data/test/dav/mock/file.rb

@@ -0,0 +1,100 @@
+module Tilia
+  module Dav
+    module Mock
+      # Mock File
+      #
+      # See the Collection in this directory for more details.
+      class File < Dav::File
+        protected
+
+        attr_accessor :name
+        attr_accessor :contents
+        attr_accessor :parent
+
+        public
+
+        # Creates the object
+        #
+        # @param string name
+        # @param array children
+        # @return void
+        def initialize(name, contents, parent = nil)
+          @name = name
+          put(contents)
+          @parent = parent
+        end
+
+        # Returns the name of the node.
+        #
+        # This is used to generate the url.
+        #
+        # @return string
+        attr_reader :name
+
+        # Changes the name of the node.
+        #
+        # @return void
+        attr_writer :name
+
+        # Updates the data
+        #
+        # The data argument is a readable stream resource.
+        #
+        # After a succesful put operation, you may choose to return an ETag. The
+        # etag must always be surrounded by double-quotes. These quotes must
+        # appear in the actual string you're returning.
+        #
+        # Clients may use the ETag from a PUT request to later on make sure that
+        # when they update the file, the contents haven't changed in the mean
+        # time.
+        #
+        # If you don't plan to store the file byte-by-byte, and you return a
+        # different object on a subsequent GET you are strongly recommended to not
+        # return an ETag, and just return null.
+        #
+        # @param resource data
+        # @return string|null
+        def put(data)
+          data = data.readlines.join('') if data.respond_to?(:readlines)
+
+          @contents = data
+          "\"#{Digest::MD5.hexdigest(data)}\""
+        end
+
+        # Returns the data
+        #
+        # This method may either return a string or a readable stream resource
+        #
+        # @return mixed
+        def get
+          @contents
+        end
+
+        # Returns the ETag for a file
+        #
+        # An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.
+        #
+        # Return null if the ETag can not effectively be determined
+        #
+        # @return void
+        def etag
+          "\"#{Digest::MD5.hexdigest(@contents)}\""
+        end
+
+        # Returns the size of the node, in bytes
+        #
+        # @return int
+        def size
+          @contents.bytesize
+        end
+
+        # Delete the node
+        #
+        # @return void
+        def delete
+          @parent.delete_child(@name)
+        end
+      end
+    end
+  end
+end

data/test/dav/mock/properties_collection.rb

@@ -0,0 +1,80 @@
+module Tilia
+  module Dav
+    module Mock
+      # A node specifically for testing property-related operations
+      class PropertiesCollection < Collection
+        include IProperties
+
+        attr_accessor :fail_mode
+
+        attr_accessor :properties
+
+        # Creates the object
+        #
+        # @param string name
+        # @param array children
+        # @param array properties
+        # @return void
+        def initialize(name, children, properties = {})
+          @fail_mode = false
+
+          super(name, children, nil)
+          @properties = properties
+        end
+
+        # Updates properties on this node.
+        #
+        # This method received a PropPatch object, which contains all the
+        # information about the update.
+        #
+        # To update specific properties, call the 'handle' method on this object.
+        # Read the PropPatch documentation for more information.
+        #
+        # @param array mutations
+        # @return bool|array
+        def prop_patch(proppatch)
+          proppatch.handle_remaining(
+            lambda do |update_properties|
+              case @fail_mode
+              when 'updatepropsfalse'
+                return false
+              when 'updatepropsarray'
+                r = {}
+                update_properties.each do |k, _v|
+                  r[k] = 402
+                end
+                return r
+              when 'updatepropsobj'
+                return Class.new
+              end
+            end
+          )
+        end
+
+        # Returns a list of properties for this nodes.
+        #
+        # The properties list is a list of propertynames the client requested,
+        # encoded in clark-notation {xmlnamespace}tagname
+        #
+        # If the array is empty, it means 'all properties' were requested.
+        #
+        # Note that it's fine to liberally give properties back, instead of
+        # conforming to the list of requested properties.
+        # The Server class will filter out the extra.
+        #
+        # @param array properties
+        # @return array
+        def properties(requested_properties)
+          returned_properties = {}
+          requested_properties.each do |requested_property|
+            if @properties.key?(requested_property)
+              returned_properties[requested_property] = @properties[requested_property]
+            end
+          end
+
+          returned_properties
+        end
+      end
+    end
+  end
+end

data/test/dav/mock/streaming_file.rb

@@ -0,0 +1,66 @@
+module Tilia
+  module Dav
+    module Mock
+      # Mock Streaming File File
+      #
+      # Works similar to the mock file, but this one works with streams and has no
+      # content-length or etags.
+      class StreamingFile < File
+        # Updates the data
+        #
+        # The data argument is a readable stream resource.
+        #
+        # After a succesful put operation, you may choose to return an ETag. The
+        # etag must always be surrounded by double-quotes. These quotes must
+        # appear in the actual string you're returning.
+        #
+        # Clients may use the ETag from a PUT request to later on make sure that
+        # when they update the file, the contents haven't changed in the mean
+        # time.
+        #
+        # If you don't plan to store the file byte-by-byte, and you return a
+        # different object on a subsequent GET you are strongly recommended to not
+        # return an ETag, and just return null.
+        #
+        # @param resource data
+        # @return string|null
+        def put(data)
+          if data.is_a?(String)
+            stream = StringIO.new
+            stream.write(data)
+            stream.rewind
+            data = stream
+          end
+          @contents = data
+        end
+
+        # Returns the data
+        #
+        # This method may either return a string or a readable stream resource
+        #
+        # @return mixed
+        def get
+          @contents
+        end
+
+        # Returns the ETag for a file
+        #
+        # An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.
+        #
+        # Return null if the ETag can not effectively be determined
+        #
+        # @return void
+        def etag
+          nil
+        end
+
+        # Returns the size of the node, in bytes
+        #
+        # @return int
+        def size
+          nil
+        end
+      end
+    end
+  end
+end

data/test/dav/mount/plugin_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+module Tilia
+  module Dav
+    module Mount
+      class PluginTest < AbstractServer
+        def setup
+          super
+          @server.add_plugin(Plugin.new)
+        end
+
+        def test_pass_through
+          server_vars = {
+            'REQUEST_PATH'   => '/',
+            'REQUEST_METHOD' => 'GET'
+          }
+
+          request = Http::Sapi.create_from_server_array(server_vars)
+          @server.http_request = (request)
+          @server.exec
+
+          assert_equal(501, @response.status, "We expected GET to not be implemented for Directories. Response body: #{@response.body_as_string}")
+        end
+
+        def test_mount_response
+          server_vars = {
+            'REQUEST_PATH'   => '/',
+            'REQUEST_METHOD' => 'GET',
+            'QUERY_STRING'   => 'mount',
+            'HTTP_HOST'      => 'example.org'
+          }
+
+          request = Http::Sapi.create_from_server_array(server_vars)
+          @server.http_request = (request)
+          @server.exec
+
+          assert_equal(200, @response.status)
+
+          body = @response.body.gsub(/xmlns(:[A-Za-z0-9_])?=("|')DAV:("|')/) { "xmlns#{Regexp.last_match(1)}=\"urn:DAV\"" }
+          xml = LibXML::XML::Document.string(body)
+
+          url = xml.find('//dm:url')
+          assert_equal('http://example.org/', url[0].content)
+        end
+      end
+    end
+  end
+end

data/test/dav/object_tree_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+module Tilia
+  module Dav
+    class ObjectTreeTest < Minitest::Test
+      def setup
+        @temp_dir = Dir.mktmpdir
+        Dir.mkdir("#{@temp_dir}/subdir")
+        ::File.open("#{@temp_dir}/file.txt", 'w') { |f| f.write('contents') }
+        ::File.open("#{@temp_dir}/subdir/subfile.txt", 'w') { |f| f.write('subcontents') }
+        root_node = FsExt::Directory.new(@temp_dir)
+        @tree = Tree.new(root_node)
+      end
+
+      def teardown
+        FileUtils.remove_entry @temp_dir
+      end
+
+      def test_get_root_node
+        root = @tree.node_for_path('')
+        assert_kind_of(FsExt::Directory, root)
+      end
+
+      def test_get_sub_dir
+        root = @tree.node_for_path('subdir')
+        assert_kind_of(FsExt::Directory, root)
+      end
+
+      def test_copy_file
+        @tree.copy('file.txt', 'file2.txt')
+        assert(::File.exist?("#{@temp_dir}/file2.txt"))
+        assert_equal('contents', ::File.read("#{@temp_dir}/file2.txt"))
+      end
+
+      def test_copy_directory
+        @tree.copy('subdir', 'subdir2')
+        assert(::File.exist?("#{@temp_dir}/subdir2"))
+        assert(::File.exist?("#{@temp_dir}/subdir2/subfile.txt"))
+        assert_equal('subcontents', ::File.read("#{@temp_dir}/subdir2/subfile.txt"))
+      end
+
+      def test_move_file
+        @tree.move('file.txt', 'file2.txt')
+        assert(::File.exist?("#{@temp_dir}/file2.txt"))
+        refute(::File.exist?("#{@temp_dir}/file.txt"))
+        assert_equal('contents', ::File.read("#{@temp_dir}/file2.txt"))
+      end
+
+      def test_move_file_new_parent
+        @tree.move('file.txt', 'subdir/file2.txt')
+        assert(::File.exist?("#{@temp_dir}/subdir/file2.txt"))
+        refute(::File.exist?("#{@temp_dir}/file.txt"))
+        assert_equal('contents', ::File.read("#{@temp_dir}/subdir/file2.txt"))
+      end
+
+      def test_move_directory
+        @tree.move('subdir', 'subdir2')
+        assert(::File.exist?("#{@temp_dir}/subdir2"))
+        assert(::File.exist?("#{@temp_dir}/subdir2/subfile.txt"))
+        refute(::File.exist?("#{@temp_dir}/subdir"))
+        assert_equal('subcontents', ::File.read("#{@temp_dir}/subdir2/subfile.txt"))
+      end
+    end
+  end
+end