lib/httpx/plugins/webdav.rb
# frozen_string_literal: true module HTTPX module Plugins # # This plugin implements convenience methods for performing WEBDAV requests. # # https://gitlab.com/honeyryderchuck/httpx/wikis/WEBDAV # module WebDav module InstanceMethods def copy(src, dest) request("COPY", src, headers: { "destination" => @options.origin.merge(dest) }) end def move(src, dest) request("MOVE", src, headers: { "destination" => @options.origin.merge(dest) }) end def lock(path, timeout: nil, &blk) headers = {} headers["timeout"] = if timeout && timeout.positive? "Second-#{timeout}" else "Infinite, Second-4100000000" end xml = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>" \ "<D:lockinfo xmlns:D=\"DAV:\">" \ "<D:lockscope><D:exclusive/></D:lockscope>" \ "<D:locktype><D:write/></D:locktype>" \ "<D:owner>null</D:owner>" \ "</D:lockinfo>" response = request("LOCK", path, headers: headers, xml: xml) return response unless response.is_a?(Response) return response unless blk && response.status == 200 lock_token = response.headers["lock-token"] begin blk.call(response) ensure unlock(path, lock_token) end end def unlock(path, lock_token) request("UNLOCK", path, headers: { "lock-token" => lock_token }) end def mkcol(dir) request("MKCOL", dir) end def propfind(path, xml = nil) body = case xml when :acl '<?xml version="1.0" encoding="utf-8" ?><D:propfind xmlns:D="DAV:"><D:prop><D:owner/>' \ "<D:supported-privilege-set/><D:current-user-privilege-set/><D:acl/></D:prop></D:propfind>" when nil '<?xml version="1.0" encoding="utf-8"?><DAV:propfind xmlns:DAV="DAV:"><DAV:allprop/></DAV:propfind>' else xml end request("PROPFIND", path, headers: { "depth" => "1" }, xml: body) end def proppatch(path, xml) body = "<?xml version=\"1.0\"?>" \ "<D:propertyupdate xmlns:D=\"DAV:\" xmlns:Z=\"http://ns.example.com/standards/z39.50/\">#{xml}</D:propertyupdate>" request("PROPPATCH", path, xml: body) end # %i[ orderpatch acl report search] end end register_plugin(:webdav, WebDav) end end