shrine-webdav 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 776491068c8d8bba23c0af394143f2f2659922bb
-  data.tar.gz: 62b461a2672d70e1fd727a33202dc6fa1382d35f
+SHA256:
+  metadata.gz: 4871b3235c1d7ccf38a75dfa6d842b6a9eade6414f9ed93883505055c7849480
+  data.tar.gz: 262b824743eab4952ed8054bda6ca689187d41fbe17db27fefa87371aa756569
 SHA512:
-  metadata.gz: 92fef1a7062da132cc59cd672b7268a3badf9585d3ff23f9e1db16e4932cd4ce0a8259606fb5985b0530fe4ea2d0bd88da645973f33d1bd3c70f752fc35c83f7
-  data.tar.gz: 6d43c5aadac016760b66e97e6f6f0c3dd88027ebaaf319675af6ffa596d501adc657c3700cfeca4fd600e72d6c3ba41d1bef5ccd6eb5ee1f3d5c8eb6e83eabcd
+  metadata.gz: 45826788bc58b67b5ee5dad819d1558c0dd7de75aa86419783f59ac4f70973cb1785f7c1431a14eb9f1bc02a6e6c6a4c68689fcc770f9782fa7698479eb730d3
+  data.tar.gz: 4b5c8f96d13d14db918e6b56139a55049fee42d1a74a97b4bbfdeb96de416de3704fed116025204e6ab6a58665a46483d543f8d76b65a6bc8c418a1d88779213

data/README.md

@@ -1,9 +1,9 @@
 # Shrine::Storage::WebDAV
 
-Provides a simple WebDAV storage for Shrine.
-
 [![Build Status](https://travis-ci.org/funbox/shrine-webdav.svg?branch=master)](https://travis-ci.org/funbox/shrine-webdav)
 
+Provides a simple WebDAV storage for [Shrine](https://shrinerb.com/).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,6 +15,7 @@ gem 'shrine-webdav'
 ## Usage
 
 Suppose you have Report model which should be able to store data in a remote WebDAV storage.
+
 ```ruby
 class Report < ApplicationRecord
 end
@@ -27,7 +28,9 @@ end
 #  created_at        :datetime         not null
 #  updated_at        :datetime         not null
 ```
-Before you can add attributes pointing to remote files to your model you should describe Uploader class:
+
+Before you start add attributes pointing to remote files to your model you should describe Uploader class:
+
 ```ruby
 # app/models/reports/report_uploader.rb
 class ReportUploader < Shrine
@@ -40,16 +43,20 @@ class ReportUploader < Shrine
   end
 end
 ```
+
 You don't have to override method `generate_location`, but if you didn't you would have random file names.
 
 Now you can add the attributes:
+
 ```ruby
 class Report < ApplicationRecord
   include ReportUploader::Attachment.new(:pdf)
   include ReportUploader::Attachment.new(:xls)
 end
 ```
+
 Note corresponding migrations:
+
 ```ruby
 class AddFileAttributes < ActiveRecord::Migration[5.1]
   def change
@@ -60,6 +67,7 @@ end
 ```
 
 Create file `shrine.rb` in `config/initializers/` to configure WebDAV storage:
+
 ```ruby
 # config/initializers/shrine.rb
 require 'shrine'
@@ -72,6 +80,7 @@ Shrine.storages = {
 ```
 
 Now you can use your virtual attributes `pdf` and `xls` like this:
+
 ```ruby
 report = Report.new(name: 'Senseless report')
 
@@ -88,18 +97,46 @@ report.xls = File.open('sample.xls')
 report.save
 ```
 
+Gem also supports http options `timeout` and `basic auth` Basic usage:
+
+```
+Shrine::Storage::WebDAV.new(
+  host: 'http://webdav-server.com',
+  prefix: 'your_project/store',
+  http_options: {
+    basic_auth: { user: 'user', pass: 'pass' },
+    timeout: { connect: 5, write: 2, read: 10 }
+  }
+)
+```
+
+You can also use global timeouts like this:
+
+```
+Shrine::Storage::WebDAV.new(
+  host: 'http://webdav-server.com',
+  prefix: 'your_project/store',
+  http_options: {
+    timeout: 3
+  }
+)
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `shrine-webdav.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `shrine-webdav.gemspec`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, 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/funbox/shrine-webdav. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)

data/lib/shrine/storage/webdav.rb

@@ -5,11 +5,12 @@ require 'down/http'
 class Shrine
   module Storage
     class WebDAV
-      def initialize(host:, prefix: nil, upload_options: {})
+      def initialize(host:, prefix: nil, upload_options: {}, http_options: {})
         @host = host
         @prefix = prefix
         @prefixed_host = path(@host, @prefix)
         @upload_options = upload_options
+        @http_options = http_options
       end
 
       def upload(io, id, shrine_metadata: {}, **upload_options)
@@ -18,21 +19,26 @@ class Shrine
         put(id, io)
       end
 
-      def url(id, **options)
-        path(@prefixed_host, id)
+      def url(id, host: nil, **options)
+        base_url = path(host || @host, options[:prefix] || @prefix)
+        path(base_url, id)
       end
 
       def open(id)
-        Down::Http.open(path(@prefixed_host, id))
+        Down::Http.open(path(@prefixed_host, id)) do |client|
+          client.timeout(timeout) if http_timeout
+          client.basic_auth(http_basic_auth) if http_basic_auth
+          client
+        end
       end
 
       def exists?(id)
-        response = HTTP.head(path(@prefixed_host, id))
+        response = http_client.head(path(@prefixed_host, id))
         (200..299).cover?(response.code.to_i)
       end
 
       def delete(id)
-        HTTP.delete(path(@prefixed_host, id))
+        http_client.delete(path(@prefixed_host, id))
       end
 
       private
@@ -45,7 +51,7 @@ class Shrine
 
       def put(id, io)
         uri = path(@prefixed_host, id)
-        response = HTTP.put(uri, body: io)
+        response = http_client.put(uri, body: io)
         return if (200..299).cover?(response.code.to_i)
         raise Error, "uploading of #{uri} failed, the server response was #{response}"
       end
@@ -73,12 +79,29 @@ class Shrine
           dirs << "#{dirs[-1]}/#{dir}"
         end
         dirs.each do |dir|
-          response = HTTP.request(:mkcol, "#{host}#{dir}")
+          response = http_client.request(:mkcol, "#{host}#{dir}")
           unless (200..301).cover?(response.code.to_i)
             raise Error, "creation of directory #{host}#{dir} failed, the server response was #{response}"
           end
         end
       end
+
+      private
+
+      def http_client
+        client = HTTP
+        client = client.timeout(http_timeout) if http_timeout
+        client = client.basic_auth(http_basic_auth) if http_basic_auth
+        client
+      end
+
+      def http_timeout
+        @http_options.fetch(:timeout, false)
+      end
+
+      def http_basic_auth
+        @http_options.fetch(:basic_auth, false)
+      end
     end
   end
 end

data/shrine-webdav.gemspec

@@ -3,9 +3,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'shrine-webdav'
-  spec.version       = '0.1.8'
-  spec.authors       = ['Ivan Kushmantsev']
-  spec.email         = ['i.kushmantsev@fun-box.ru']
+  spec.version       = '0.2.0'
+  spec.authors       = ['Ivan Kushmantsev', 'Dmitry Efimov']
+  spec.email         = ['i.kushmantsev@fun-box.ru', 'tuwilof@gmail.com']
 
   spec.summary       = 'Provides a simple WebDAV storage for Shrine.'
   spec.description   = 'Provides a simple WebDAV storage for Shrine.'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: shrine-webdav
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Ivan Kushmantsev
+- Dmitry Efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -111,6 +112,7 @@ dependencies:
 description: Provides a simple WebDAV storage for Shrine.
 email:
 - i.kushmantsev@fun-box.ru
+- tuwilof@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -144,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides a simple WebDAV storage for Shrine.