shrine-url 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a844c3ca62dcf102d0f08b4dc55f8fff6e14d265d1eeb39a5c7cae17578ca33
-  data.tar.gz: b5841496454d1e6a88a687140d624a6097e25d1dbaf096d546892e8e48d86919
+  metadata.gz: 3d71adf3e0289f46eb8d37e30fbe150d0437a7ab1c7c5792bac97a422ed06527
+  data.tar.gz: 3975124486888b299ee14fb31f4d33a7da0af429153a8af63db27619140540c8
 SHA512:
-  metadata.gz: 1c7684ea16e98cee1ea5b0a4cf13956285170fbfa4d69192d965ae58d6c34a5825047d5479e0faa9816c0fcc9ac9a11220dcfb69aaea30bd9ed1b77c8863eff4
-  data.tar.gz: 374b68a8fedb6a2bbd304cef2722ed9640a0ee8c3a05d9994772168b6d323a303bd1844246d15e2eefba1d4c353eeaeeffa3dc5e755847bf957df3f3629a4ef4
+  metadata.gz: 405e170fe35aa5e1ae3536872bebe93a1a6cbeb38c6f3d4e63de402a59963d31b87ada22d614345ca4bf6c12e06fcd56a21b72cbf9e43e3e9906b2ff94c17852
+  data.tar.gz: 17e3874c33214e2f488d0f8c3527926be6ae49e9125329305dbda9de1b9bb351d917d7e7ca665aa125593f1816c5c4b6a027ef2f5e79c9d367526e1bd49981ef

data/README.md

@@ -5,8 +5,8 @@ custom URL.
 
 ## Installation
 
-```ruby
-gem "shrine-url"
+```rb
+gem "shrine-url", "~> 2.0"
 ```
 
 ## Usage
@@ -35,18 +35,24 @@ Now you can assign this data as the cached attachment:
 ```rb
 photo = Photo.new(image: data)
 photo.image #=> #<Shrine::UploadedFile>
-
 photo.image.url           #=> "http://example.com/image.jpg"
-photo.image.download      # Sends a GET request and streams body to Tempfile
-photo.image.open { |io| } # Sends a GET request and yields `Down::ChunkedIO` ready for reading
-photo.image.exists?       # Sends a HEAD request and returns true if it's 2xx
-photo.image.delete        # Sends a DELETE request
 ```
 
-No HTTP requests are made at this point. When this "cached file" is about to be
-uploaded to a permanent storage, `shrine-url` will download the file from the
-given URL using [Down]. By default the `Down::NetHttp` backend will be used for
-downloading, but you can tell `shrine-url` to use another Down backend:
+No HTTP requests are made when file is assigned (but you can load the
+`restore_cached_data` Shrine plugin if you want metadata to be extracted on
+assignment). When this "cached file" is about to be uploaded to a permanent
+storage, `shrine-url` will download the file from the given URL using [Down].
+
+```rb
+uploaded_file.download      # Sends a GET request and streams body to Tempfile
+uploaded_file.open { |io| } # Sends a GET request and yields `Down::ChunkedIO` ready for reading
+uploaded_file.exists?       # Sends a HEAD request and returns true if response status is 2xx
+uploaded_file.delete        # Sends a DELETE request if :delete is set to true
+```
+
+By default the `Down::Http` backend will be used for downloading, which is
+implemented using [HTTP.rb]. You can change the Down backend via the
+`:downloader` option:
 
 ```rb
 Shrine::Storage::Url.new(downloader: :wget)
@@ -63,6 +69,16 @@ remote URL (like [shrine-cloudinary] or [shrine-uploadcare]), downloading will
 be completely skipped as the permanent storage will use only the URL for
 uploading the file.
 
+## Deleting
+
+Calling `Shrine::UploadedFile#delete` will call `Shrine::Storage::Url#delete`,
+which for safety doesn't do anything by default. If you want it to make a
+`DELETE` request to the URL, you can set `:delete` to `true` on initialization:
+
+```rb
+Shrine::Storage::Url.new(delete: true)
+```
+
 ## Advantages and Use Cases
 
 The main advantage of using `shrine-url` over the `remote_url` Shrine plugin is
@@ -98,4 +114,5 @@ you'll need to have Docker installed and running.
 [shrine-cloudinary]: https://github.com/shrinerb/shrine-cloudinary
 [shrine-uploadcare]: https://github.com/shrinerb/shrine-uploadcare
 [Down]: https://github.com/janko-m/down
+[HTTP.rb]: https://github.com/httprb/http
 [kennethreitz/httpbin]: https://github.com/kennethreitz/httpbin

data/lib/shrine/storage/url.rb

@@ -6,14 +6,9 @@ class Shrine
     class Url
       attr_reader :downloader
 
-      def initialize(downloader: :http)
-        if downloader.is_a?(Symbol)
-          require "down/#{downloader}"
-          const_name = downloader.to_s.split("_").map(&:capitalize).join
-          @downloader = Down.const_get(const_name)
-        else
-          @downloader = downloader
-        end
+      def initialize(downloader: :http, delete: false)
+        @downloader = resolve_downloader(downloader)
+        @delete     = false
       end
 
       def upload(io, id, **)
@@ -38,17 +33,26 @@ class Shrine
       end
 
       def delete(id)
-        request(:delete, id)
+        request(:delete, id) if @delete
       end
 
       private
 
-      def request(verb, url, follow: {}, headers: {}, **options)
-        options[:follow]  = { max_hops: 2 }.merge(follow)
-        options[:headers] = { user_agent: "shrine-url/1.0.2" }.merge(headers)
+      def request(verb, url, follow: {}, **options)
+        options[:follow] = { max_hops: 2 }.merge(follow)
 
         HTTP.request(verb, url, options)
       end
+
+      def resolve_downloader(downloader)
+        if downloader.is_a?(Symbol)
+          require "down/#{downloader}"
+          const_name = downloader.to_s.split("_").map(&:capitalize).join
+          Down.const_get(const_name)
+        else
+          downloader
+        end
+      end
     end
   end
 end

data/shrine-url.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-url"
-  gem.version       = "2.1.0"
+  gem.version       = "2.2.0"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "shrine", ">= 2.0"
   gem.add_dependency "down", "~> 4.4"
-  gem.add_dependency "http", "~> 3.2"
+  gem.add_dependency "http", ">= 3.2", "< 5"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-url
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2019-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -42,16 +42,22 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -138,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Provides a fake storage which allows you to create a Shrine attachment defined