Faraday::Webdav

Adds WebDAV HTTP methods to Faraday connections: propfind, proppatch, mkcol, copy, move, lock, unlock, report, and search.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add faraday-webdav

If bundler is not being used to manage dependencies, install the gem by executing:

gem install faraday-webdav

Usage

Requiring faraday/webdav adds the WebDAV methods to every Faraday::Connection:

require 'faraday/webdav'

connection = Faraday.new(url: 'https://example.com')

# PROPFIND / PROPPATCH / LOCK / REPORT / SEARCH take a request body
response = connection.propfind('/file', propfind_body, { 'Depth' => '0' })

# MKCOL / COPY / UNLOCK / MOVE take query params instead of a body
response = connection.copy('/container/', nil, { 'Destination' => 'https://example.com/other/' })

# all methods yield the request to a block, like Faraday's built-in verbs
response = connection.propfind('/file') do |req|
  req.headers['Depth'] = '1'
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cub8/faraday-webdav.

License

The gem is available as open source under the terms of the MIT License.