faraday-webdav 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cfbdcfe6b8287960a01188af99ec4d10c8f70f720bd4ac67ba3a6e4c5860df8
+  data.tar.gz: 9a3dc26ed3fe11ae058fe2579d9d28776bafd5ce44174ce1fe796ed6123d9bb8
+SHA512:
+  metadata.gz: 7012ac683dc11395bcd310d5f2dc07aa231544cb674774892ded3090ba279225dddce6919a4c0d1f9532c34c0144d527f6cc89fcf91025c60ff761bc4e4bbf84
+  data.tar.gz: a89a84b5bae852486ac23511c101be35f41dbd88d3bb6de09c0a4d3e42cf414ead57d57c3ff08feef6713700b18cf942f1b34b9f060387c62ea6217d376561b0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# [Faraday-Webdav changelog]
+
+## [0.1.0] - 2026-07-21
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Olejniczak Jeremi Jan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Faraday::Webdav
+
+Adds WebDAV HTTP methods to [Faraday](https://github.com/lostisland/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:
+
+```bash
+bundle add faraday-webdav
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install faraday-webdav
+```
+
+## Usage
+
+Requiring `faraday/webdav` adds the WebDAV methods to every `Faraday::Connection`:
+
+```ruby
+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](https://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](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/faraday/webdav/connection_methods.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Webdav
+    module ConnectionMethods
+      METHODS_WITH_BODY = %i[
+        propfind
+        proppatch
+        lock
+        report
+        search
+      ].freeze
+
+      METHODS_WITH_QUERY = %i[
+        mkcol
+        copy
+        unlock
+        move
+      ].freeze
+
+      class << self
+        def included(base)
+          base::METHODS.merge(Faraday::Webdav::METHODS)
+        end
+      end
+
+      METHODS_WITH_QUERY.each do |method|
+        define_method(method) do |url = nil, params = nil, headers = nil, &block|
+          run_request(method, url, nil, headers) do |request|
+            request.params.update(params) if params
+            block&.call(request)
+          end
+        end
+      end
+
+      METHODS_WITH_BODY.each do |method|
+        define_method(method) do |url = nil, body = nil, headers = nil, &block|
+          run_request(method, url, body, headers, &block)
+        end
+      end
+    end
+  end
+end
+
+Faraday::Connection.include(Faraday::Webdav::ConnectionMethods)

data/lib/faraday/webdav/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Webdav
+    VERSION = '0.1.0'
+  end
+end

data/lib/faraday/webdav.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require_relative 'webdav/version'
+
+module Faraday
+  module Webdav
+    METHODS = %i[
+      copy
+      lock
+      mkcol
+      move
+      propfind
+      proppatch
+      unlock
+      report
+      search
+    ].freeze
+  end
+end
+
+require_relative 'webdav/connection_methods'

data/sig/faraday/webdav.rbs

@@ -0,0 +1,26 @@
+module Faraday
+  class Connection
+    def copy: (?String | URI url, ?untyped params, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def move: (?String | URI url, ?untyped params, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def mkcol: (?String | URI url, ?untyped params, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def unlock: (?String | URI url, ?untyped params, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def propfind: (?String | URI url, ?untyped body, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def proppatch: (?String | URI url, ?untyped body, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def lock: (?String | URI url, ?untyped body, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def report: (?String | URI url, ?untyped body, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+
+    def search: (?String | URI url, ?untyped body, ?untyped headers) ?{ (Faraday::Request) -> void } -> Faraday::Response
+  end
+
+  module Webdav
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: faraday-webdav
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olejniczak Jeremi Jan
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Adds WebDAV HTTP methods (PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK,
+  UNLOCK, REPORT, SEARCH) to Faraday connections.
+email:
+- tsubait8@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/faraday/webdav.rb
+- lib/faraday/webdav/connection_methods.rb
+- lib/faraday/webdav/version.rb
+- sig/faraday/webdav.rbs
+homepage: https://github.com/cub8/faraday-webdav
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cub8/faraday-webdav
+  source_code_uri: https://github.com/cub8/faraday-webdav
+  changelog_uri: https://github.com/cub8/faraday-webdav/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.1
+specification_version: 4
+summary: WebDAV support for Faraday.
+test_files: []