carrierwave-webdav 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 104e3949932f6d0d79ecc6e963ec20e22933ce97
-  data.tar.gz: 3ef2f1fb1586bf186c5a9c44e7e1721beae7bffa
+  metadata.gz: fbbacc8489704bb68e0c181f4819f5e835b9df21
+  data.tar.gz: f170dd3e53ecd19028177d6b64b800fbd70c55a1
 SHA512:
-  metadata.gz: 172a6e8b9adb899ecdb5fecaeb67e99518554ac49bab2e644b1f9266d8f1147f0a9c74e150f49511b4c096361756ed31d103de63ea42c5ce4aa56cabe378c491
-  data.tar.gz: 2099b07cfcbf6264bfb83e780ce874c6aace8ad37eff9692b8346eeefc0fe163678813b45e78b32df44da29ec0034f55a58b93d2ea50dd6a405e0177ffa590ff
+  metadata.gz: b63df00595ec605460c02e9c34b6e7535d587afee7f80c7876ae0fdcd8236c2e20fe4125d7f061a82246fbf775f032b9e5ee27fcece8969683c771f2d3d93fe9
+  data.tar.gz: 38332a2224a0f1707dd12c3456aafa3cdb8c7e5808c13afbb05761e0b80a2b37da8ab4006d88b29f375c60bcd16b8cd43705f10e205177661f69eb003dcdb526

data/.coveralls.yml

@@ -1 +1 @@
-repo_token: vED8szM0CKiJzSUuQmmbuuWStRxi3wMSV
+repo_token: 9Fl9auxZBvbw6mQ2MDCN6HAs0qeBSANwg

data/Gemfile

@@ -5,4 +5,4 @@ gemspec
 gem 'rake'
 gem 'rspec'
 gem 'webmock', :require => 'webmock/rspec'
-gem 'coveralls', require: false
+gem 'coveralls', require: false

data/carrierwave-webdav.gemspec

@@ -19,5 +19,4 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'carrierwave'
   gem.add_dependency 'httparty'
-
 end

data/lib/carrierwave/storage/webdav.rb

@@ -1,8 +1,57 @@
 require 'carrierwave/httparty_monkey'
+require 'carrierwave/webdav/file'
 
 module CarrierWave
   module Storage
     class WebDAV < Abstract
+      # Store file in WebDAV cache directory
+      #
+      # === Parameters
+      #
+      # [ file (CarrierWave::SanitizedFile) ] the file to store
+      #
+      # === Returns
+      #
+      # [ CarrierWave::WebDAV::File ] a sanitized file
+      #
+      def cache!(file)
+        cached = build_webdav_file(uploader.cache_path)
+        cached.write(file.read)
+        cached
+      end
+
+      # Retrieve file with given cache identifier from WebDAV
+      #
+      # === Parameters
+      #
+      # [ identifier (String) ] cache identifier
+      #
+      # === Returns
+      #
+      # [ CarrierWave::WebDAV::File ] a sanitized file
+      #
+      def retrieve_from_cache!(identifier)
+        build_webdav_file(uploader.cache_path(identifier))
+      end
+
+      # Delete cache directory from WebDAV
+      #
+      # === Parameters
+      #
+      # [ path (String) ] cache path
+      #
+      # === Returns
+      #
+      # [ HTTParty::Response ] httparty response object
+      #
+      # === Raises
+      #
+      # [ CarrierWave::IntegrityError ]
+      #
+      def delete_dir!(path)
+        cached = build_webdav_file(path)
+        cached.delete_dir
+      end
 
       # Store the file in WebDAV
       #
@@ -12,10 +61,10 @@ module CarrierWave
       #
       # === Returns
       #
-      # [ CarrierWave::SanitizedFile ] a sanitized file
+      # [ CarrierWave::WebDAV::File ] a sanitized file
       #
       def store!(file)
-        stored = CarrierWave::Storage::WebDAV::File.new(uploader, uploader.store_path)
+        stored = build_webdav_file(uploader.store_path)
         stored.write(file.read)
         stored
       end
@@ -28,113 +77,17 @@ module CarrierWave
       #
       # === Returns
       #
-      # [ CarrierWave::Store::WebDAV::File ] a sanitized file
+      # [ CarrierWave::WebDAV::File ] a sanitized file
       #
       def retrieve!(identifier)
-        CarrierWave::Storage::WebDAV::File.new(uploader, uploader.store_path(identifier))
+        build_webdav_file(uploader.store_path(identifier))
       end
 
-      class File
-        attr_reader :path
-        attr_reader :uploader
-        attr_reader :options
-        attr_reader :server # Like 'https://www.WebDAV.com/dav'
-
-        def initialize(uploader, path)
-          @path = path
-          @path.sub! /^\//, ''
-          @uploader = uploader
-          @server = uploader.webdav_server
-          @server.sub! /\/$/, ''
-          @write_server = uploader.webdav_write_server
-          @write_server.sub!(/\/$/, '') if @write_server
-          @username = uploader.webdav_username
-          @password = uploader.webdav_password || ''
-          @options = {}
-          @options = { basic_auth: { username: @username, password: @password } } if @username
-          @create_dirs = !uploader.webdav_autocreates_dirs
-        end
-
-        def read
-          res = HTTParty.get(read_url, options)
-          if res.code != 200
-            raise CarrierWave::IntegrityError.new("Can't download a file: #{res.inspect}")
-          end
-          res.body
-        end
-
-        def headers
-          res = HTTParty.head(read_url, options)
-          if res.code != 200
-            raise CarrierWave::IntegrityError.new("Can't headers for a file: #{res.inspect}")
-          end
-          res.headers
-        end
-
-        def write(file)
-          if @create_dirs
-            res = mkcol
-          end
-
-          res = HTTParty.put(write_url, options.merge({ body: file }))
-          if res.code != 201 and res.code != 204
-            raise CarrierWave::IntegrityError.new("Can't put a new file: #{res.inspect}")
-          end
-          res
-        end
-
-        def length
-          read.bytesize
-        end
-
-        def content_type
-          headers.content_type
-        end
-
-        def delete
-          res = HTTParty.delete(write_url, options)
-          if res.code != 200 and res.code != 204 and res.code != 404
-            raise CarrierWave::IntegrityError.new("Can't delete a file: #{res.inspect}")
-          end
-          res
-        end
-
-        def url
-          if host = uploader.asset_host
-            host.respond_to?(:call) ? host.call(self) : [host, path].join('/')
-          else
-            read_url
-          end
-        end
-
-        alias :content_length :length
-        alias :file_length :length
-        alias :size :length
-
       private
 
-        def read_url
-          "#{server}/#{path}"
-        end
-
-        def write_url
-          @write_server ? "#{@write_server}/#{path}" : read_url
-        end
-
-        def mkcol
-          dirs = []
-          path.split('/')[0...-1].each do |dir|
-            dirs << "#{dirs[-1]}/#{dir}"
-          end # Make path like a/b/c/t.txt to array ['/a', '/a/b', '/a/b/c']
-          use_server = @write_server ? @write_server : server
-          dirs.each do |dir|
-            res = HTTParty.mkcol("#{use_server}#{dir}", options)
-            unless [200, 201, 207, 409].include? res.code
-              raise CarrierWave::IntegrityError.new("Can't create a new collection: #{res.inspect}")
-            end
-          end # Make collections recursively
-        end
-      end # File
+      def build_webdav_file(path)
+        CarrierWave::WebDAV::File.new(uploader, path)
+      end
     end # WebDAV
   end # Storage
 end # CarrierWave

data/lib/carrierwave/webdav/file.rb

@@ -0,0 +1,110 @@
+module CarrierWave
+  module WebDAV
+    class File
+      attr_reader :path
+      attr_reader :uploader
+      attr_reader :options
+      attr_reader :server # Like 'https://www.WebDAV.com/dav'
+
+      def initialize(uploader, path)
+        @path = path
+        @path.sub! /^\//, ''
+        @uploader = uploader
+        @server = uploader.webdav_server
+        @server.sub! /\/$/, ''
+        @write_server = uploader.webdav_write_server
+        @write_server.sub!(/\/$/, '') if @write_server
+        @username = uploader.webdav_username
+        @password = uploader.webdav_password || ''
+        @options = {}
+        @options = { basic_auth: { username: @username, password: @password } } if @username
+        @create_dirs = !uploader.webdav_autocreates_dirs
+      end
+
+      def read
+        res = HTTParty.get(read_url, options)
+        if res.code != 200
+          raise CarrierWave::IntegrityError.new("Can't download a file: #{res.inspect}")
+        end
+        res.body
+      end
+
+      def headers
+        res = HTTParty.head(read_url, options)
+        if res.code != 200
+          raise CarrierWave::IntegrityError.new("Can't headers for a file: #{res.inspect}")
+        end
+        res.headers
+      end
+
+      def write(file)
+        if @create_dirs
+          res = mkcol
+        end
+
+        res = HTTParty.put(write_url, options.merge({ body: file }))
+        if res.code != 201 and res.code != 204
+          raise CarrierWave::IntegrityError.new("Can't put a new file: #{res.inspect}")
+        end
+        res
+      end
+
+      def length
+        read.bytesize
+      end
+
+      def content_type
+        headers.content_type
+      end
+
+      def delete
+        res = HTTParty.delete(write_url, options)
+        if res.code != 200 and res.code != 204 and res.code != 404
+          raise CarrierWave::IntegrityError.new("Can't delete a file: #{res.inspect}")
+        end
+        res
+      end
+
+      def delete_dir
+        @path += '/' unless path.end_with?('/')
+        delete
+      end
+
+      def url
+        if host = uploader.asset_host
+          host.respond_to?(:call) ? host.call(self) : [host, path].join('/')
+        else
+          read_url
+        end
+      end
+
+      alias :content_length :length
+      alias :file_length :length
+      alias :size :length
+
+    private
+
+      def read_url
+        "#{server}/#{path}"
+      end
+
+      def write_url
+        @write_server ? "#{@write_server}/#{path}" : read_url
+      end
+
+      def mkcol
+        dirs = []
+        path.split('/')[0...-1].each do |dir|
+          dirs << "#{dirs[-1]}/#{dir}"
+        end # Make path like a/b/c/t.txt to array ['/a', '/a/b', '/a/b/c']
+        use_server = @write_server ? @write_server : server
+        dirs.each do |dir|
+          res = HTTParty.mkcol("#{use_server}#{dir}", options)
+          unless [200, 201, 207, 409].include? res.code
+            raise CarrierWave::IntegrityError.new("Can't create a new collection: #{res.inspect}")
+          end
+        end # Make collections recursively
+      end
+    end # File
+  end # WebDAV
+end # CarrierWave

data/lib/carrierwave/webdav/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module WebDAV
-    VERSION = "0.4.3"
+    VERSION = "0.5.0"
   end
 end

data/spec/fixtures/tmp_test.txt

@@ -0,0 +1 @@
+Hello, this is tmp test data.

data/spec/lib/webdav_file_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe CarrierWave::WebDAV::File do
+  describe '#url' do
+    let(:webdav_server) { 'https://your.webdavserver.com/dav/' }
+
+    before do
+      CarrierWave.configure do |config|
+        config.storage = :webdav
+        config.cache_storage = :webdav
+        config.webdav_server = webdav_server
+        config.asset_host = host
+
+        config.webdav_autocreates_dirs = true
+      end
+
+      @uploader = CarrierWave::Uploader::Base.new
+      @file = File.open(file_path('test.txt'))
+
+      stub_request(:put, %r{#{Regexp.escape(webdav_server)}}).to_return(status: 201)
+    end
+
+    context 'when asset_host is set' do
+      let(:host) { 'http://asset.host' }
+
+      it 'path contains asset_host' do
+        @uploader.cache!(@file)
+        expect(@uploader.file.url).to eq [host, @uploader.file.path].join('/')
+      end
+    end
+
+    context 'when asset_host is not set' do
+      let(:host) { nil }
+
+      it 'path does not contain asset_host' do
+        @uploader.cache!(@file)
+        expect(@uploader.file.url).to eq [webdav_server, @uploader.file.path].join('/')
+      end
+    end
+  end
+end

data/spec/lib/{webdav_spec.rb → webdav_storage_spec.rb}

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'carrierwave/webdav'
 require 'uri'
 
 describe CarrierWave::Storage::WebDAV do
@@ -13,15 +12,46 @@ describe CarrierWave::Storage::WebDAV do
     end
 
     @uploader = CarrierWave::Uploader::Base.new
-    @uploader.stub store_path: 'uploads/test.txt'
+
+    allow(@uploader).to receive(:store_path) { 'uploads/test.txt' }
+    allow(@uploader).to receive(:cache_path) { 'uploads/tmp_test.txt' }
 
     @storage = CarrierWave::Storage::WebDAV.new(@uploader)
     @file = CarrierWave::SanitizedFile.new(file_path('test.txt'))
 
-    @uri = URI(@uploader.webdav_server)
-    @uri.user = @uploader.webdav_username
-    @uri.password = @uploader.webdav_password
-    @uri.merge! @uploader.store_path
+    # NOTE: specs fail with this options
+    #
+    # @uri.user = @uploader.webdav_username
+    # @uri.password = @uploader.webdav_password
+
+    @uri = URI(File.join(@uploader.webdav_server, @uploader.store_path))
+    @cache_uri = URI(File.join(@uploader.webdav_server, @uploader.cache_path))
+  end
+
+  describe '#cache!' do
+    it 'should cache from WebDAV' do
+      stub_mkcol @cache_uri
+      stub_put @cache_uri
+      webdav_file = @storage.cache!(@file)
+      stub_get @cache_uri
+      expect(@file.read).to eq(webdav_file.read)
+    end
+  end
+
+  describe '#retrieve_from_cache!' do
+    it 'should retreive a cache file from WebDAV' do
+      stub_get @cache_uri
+      webdav_file = @storage.retrieve_from_cache!('tmp_test.txt')
+      expect(@file.read).to eq(webdav_file.read)
+    end
+  end
+
+  describe '#delete_dir!' do
+    it 'should delete cache directory' do
+      stub_delete File.join(@uploader.webdav_server, 'uploads/')
+      result = @storage.delete_dir!('uploads')
+      expect(Net::HTTPOK).to eq(result.response.class)
+    end
   end
 
   it 'should store from WebDAV' do
@@ -73,51 +103,34 @@ describe CarrierWave::Storage::WebDAV do
     expect("#{@uploader.webdav_server}/#{@uploader.store_path}").to eq(webdav_file.url)
   end
 
-  it 'should save through secure server' do
-    CarrierWave.configure do |config|
-      config.webdav_write_server = 'https://secure.your.webdavserver.com/dav/'
-    end
-
-    secure_uri = URI(@uploader.webdav_write_server)
-    secure_uri.user = @uploader.webdav_username
-    secure_uri.password = @uploader.webdav_password
-    secure_uri.merge! @uploader.store_path
-
-    stub_mkcol secure_uri
-    stub_put secure_uri
-    webdav_file = @storage.store!(@file)
-
-    stub_get @uri
-    expect(@file.read).to eq(webdav_file.read)
-  end
-
-  describe 'File#url' do
-    let(:root) { Pathname.new(@file.path).dirname }
-    let(:path) { @uploader.path.sub(root.to_path, '') }
-
+  context 'when use write server' do
     before do
       CarrierWave.configure do |config|
-        config.asset_host = host
-        config.root = root
+        config.webdav_write_server = 'https://secure.your.webdavserver.com/dav/'
       end
     end
 
-    context 'when asset_host is set' do
-      let(:host) { 'http://asset.host' }
-
-      it 'path contains asset_host' do
-        @uploader.cache!(@file)
-        expect(@uploader.url).to eq [host, path].join
+    after do
+      CarrierWave.configure do |config|
+        config.webdav_write_server = nil
       end
     end
 
-    context 'when asset_host is not set' do
-      let(:host) { nil }
+    it 'should save through secure server' do
+      secure_uri = URI(File.join(@uploader.webdav_write_server, @uploader.store_path))
 
-      it 'path does not contain asset_host' do
-        @uploader.cache!(@file)
-        expect(@uploader.url).to eq path
-      end
+      # NOTE: specs fail with this options
+      #
+      # secure_uri.user = @uploader.webdav_username
+      # secure_uri.password = @uploader.webdav_password
+
+      stub_mkcol secure_uri
+      stub_put secure_uri
+      webdav_file = @storage.store!(@file)
+
+      stub_get @uri
+      expect(@file.read).to eq(webdav_file.read)
     end
   end
+
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'webmock/rspec'
 Dir['spec/supports/**/*.rb'].each { |f| require File.expand_path(f) }
 
 require 'carrierwave'
+require 'carrierwave/webdav'
 
 if ENV['TRAVIS']
   require 'coveralls'
@@ -14,4 +15,3 @@ RSpec.configure do |config|
   WebMock.disable_net_connect!
   config.include Helpers
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-webdav
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Qinix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -56,9 +56,12 @@ files:
 - lib/carrierwave/httparty_monkey.rb
 - lib/carrierwave/storage/webdav.rb
 - lib/carrierwave/webdav.rb
+- lib/carrierwave/webdav/file.rb
 - lib/carrierwave/webdav/version.rb
 - spec/fixtures/test.txt
-- spec/lib/webdav_spec.rb
+- spec/fixtures/tmp_test.txt
+- spec/lib/webdav_file_spec.rb
+- spec/lib/webdav_storage_spec.rb
 - spec/spec_helper.rb
 - spec/supports/helpers.rb
 homepage: https://github.com/qinix/carrierwave-webdav
@@ -86,7 +89,8 @@ specification_version: 4
 summary: WebDAV support for CarrierWave
 test_files:
 - spec/fixtures/test.txt
-- spec/lib/webdav_spec.rb
+- spec/fixtures/tmp_test.txt
+- spec/lib/webdav_file_spec.rb
+- spec/lib/webdav_storage_spec.rb
 - spec/spec_helper.rb
 - spec/supports/helpers.rb
-has_rdoc: