shrine 2.15.0 → 2.16.0

data/lib/shrine/plugins/determine_mime_type.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/determine_mime_type.md] on GitHub.
+    #
+    # [doc/plugins/determine_mime_type.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/determine_mime_type.md
     module DetermineMimeType
       def self.configure(uploader, opts = {})
         if opts[:analyzer] == :default

data/lib/shrine/plugins/direct_upload.rb

@@ -7,6 +7,9 @@ require "json"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/direct_upload.md] on GitHub.
+    #
+    # [doc/plugins/direct_upload.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/direct_upload.md
     module DirectUpload
       def self.load_dependencies(uploader, *)
         uploader.plugin :rack_file

data/lib/shrine/plugins/download_endpoint.rb

@@ -4,36 +4,19 @@ require "roda"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/download_endpoint.md] on GitHub.
+    #
+    # [doc/plugins/download_endpoint.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/download_endpoint.md
     module DownloadEndpoint
       def self.load_dependencies(uploader, opts = {})
         uploader.plugin :rack_response
         uploader.plugin :_urlsafe_serialization
       end
 
-      # Accepts the following options:
-      #
-      # :prefix
-      # :  The location where the download endpoint was mounted. If it was
-      #    mounted at the root level, this should be set to nil.
-      #
-      # :host
-      # :  The host that you want the download URLs to use (e.g. your app's domain
-      #    name or a CDN). By default URLs are relative.
-      #
-      # :disposition
-      # :  Can be set to "attachment" if you want that the user is always
-      #    prompted to download the file when visiting the download URL.
-      #    The default is "inline".
-      #
-      # :redirect
-      # :  If set to `true`, requests will redirect to the direct file URL. If
-      #    set to a proc object, the proc will called with the `UploadedFile`
-      #    instance and the `Rack::Request` object, and is expected to return
-      #    the URL to which the request will redirect to. Defaults to `false`,
-      #    meaning that the file content will be served through the endpoint.
       def self.configure(uploader, opts = {})
         uploader.opts[:download_endpoint_storages] = opts.fetch(:storages, uploader.opts[:download_endpoint_storages])
         uploader.opts[:download_endpoint_prefix] = opts.fetch(:prefix, uploader.opts[:download_endpoint_prefix])
+        uploader.opts[:download_endpoint_download_options] = opts.fetch(:download_options, uploader.opts.fetch(:download_endpoint_download_options, {}))
         uploader.opts[:download_endpoint_disposition] = opts.fetch(:disposition, uploader.opts.fetch(:download_endpoint_disposition, "inline"))
         uploader.opts[:download_endpoint_host] = opts.fetch(:host, uploader.opts[:download_endpoint_host])
         uploader.opts[:download_endpoint_redirect] = opts.fetch(:redirect, uploader.opts.fetch(:download_endpoint_redirect, false))
@@ -68,8 +51,9 @@ class Shrine
         def new_download_endpoint(klass)
           endpoint_class = Class.new(klass)
           endpoint_class.opts[:shrine_class] = self
-          endpoint_class.opts[:disposition]  = opts[:download_endpoint_disposition]
-          endpoint_class.opts[:redirect]     = opts[:download_endpoint_redirect]
+          endpoint_class.opts[:download_options] = opts[:download_endpoint_download_options]
+          endpoint_class.opts[:disposition]      = opts[:download_endpoint_disposition]
+          endpoint_class.opts[:redirect]         = opts[:download_endpoint_redirect]
           endpoint_class
         end
       end
@@ -165,12 +149,16 @@ class Shrine
 
         # Streams the uploaded file content.
         def stream_file(uploaded_file)
-          range = env["HTTP_RANGE"]
+          open_file(uploaded_file)
 
-          status, headers, body = uploaded_file.to_rack_response(disposition: disposition, range: range)
-          headers["Cache-Control"] = "max-age=#{365*24*60*60}" # cache for a year
+          response = uploaded_file.to_rack_response(
+            disposition: disposition,
+            range:       env["HTTP_RANGE"],
+          )
 
-          request.halt [status, headers, body]
+          response[1]["Cache-Control"] = "max-age=#{365*24*60*60}" # cache for a year
+
+          request.halt response
         end
 
         # Redirects to the uploaded file's direct URL or the specified URL proc.
@@ -184,6 +172,14 @@ class Shrine
           request.redirect redirect_url
         end
 
+        def open_file(uploaded_file)
+          if download_options.respond_to?(:call)
+            uploaded_file.open(**download_options.call(uploaded_file, request))
+          else
+            uploaded_file.open(**download_options)
+          end
+        end
+
         # Returns a Shrine::UploadedFile, or returns 404 if file doesn't exist.
         def get_uploaded_file(serialized)
           uploaded_file = shrine_class::UploadedFile.urlsafe_load(serialized)
@@ -205,8 +201,8 @@ class Shrine
           request.halt
         end
 
-        def storage_names
-          shrine_class.storages.keys.map(&:to_s)
+        def download_options
+          opts[:download_options]
         end
 
         def redirect
@@ -220,6 +216,10 @@ class Shrine
         def shrine_class
           opts[:shrine_class]
         end
+
+        def storage_names
+          shrine_class.storages.keys.map(&:to_s)
+        end
       end
     end
 

data/lib/shrine/plugins/dynamic_storage.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/dynamic_storage.md] on GitHub.
+    #
+    # [doc/plugins/dynamic_storage.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/dynamic_storage.md
     module DynamicStorage
       def self.configure(uploader, options = {})
         uploader.opts[:dynamic_storages] ||= {}

data/lib/shrine/plugins/hooks.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/hooks.md] on GitHub.
+    #
+    # [doc/plugins/hooks.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/hooks.md
     module Hooks
       module InstanceMethods
         def upload(io, context = {})

data/lib/shrine/plugins/included.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/included.md] on GitHub.
+    #
+    # [doc/plugins/included.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/included.md
     module Included
       def self.configure(uploader, &block)
         uploader.opts[:included_block] = block

data/lib/shrine/plugins/infer_extension.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/infer_extension.md] on GitHub.
+    #
+    # [doc/plugins/infer_extension.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/infer_extension.md
     module InferExtension
       def self.configure(uploader, opts = {})
         uploader.opts[:infer_extension_inferrer] = opts.fetch(:inferrer, uploader.opts.fetch(:infer_extension_inferrer, :mime_types))

data/lib/shrine/plugins/keep_files.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/keep_files.md] on GitHub.
+    #
+    # [doc/plugins/keep_files.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/keep_files.md
     module KeepFiles
       def self.configure(uploader, opts = {})
         keep_files = (uploader.opts[:keep_files] ||= [])

data/lib/shrine/plugins/logging.rb

@@ -6,6 +6,9 @@ require "time"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/logging.md] on GitHub.
+    #
+    # [doc/plugins/logging.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/logging.md
     module Logging
       def self.load_dependencies(uploader, *)
         uploader.plugin :hooks

data/lib/shrine/plugins/metadata_attributes.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/metadata_attributes.md] on GitHub.
+    #
+    # [doc/plugins/metadata_attributes.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/metadata_attributes.md
     module MetadataAttributes
       def self.configure(uploader, mappings = {})
         uploader.opts[:metadata_attributes_mappings] ||= {}

data/lib/shrine/plugins/migration_helpers.rb

@@ -4,6 +4,9 @@ Shrine.deprecation("The migration_helpers plugin is deprecated and will be remov
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/migration_helpers.md] on GitHub.
+    #
+    # [doc/plugins/migration_helpers.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/migration_helpers.md
     module MigrationHelpers
       def self.configure(uploader, delegate: false)
         uploader.opts[:migration_helpers_delegate] = delegate

data/lib/shrine/plugins/module_include.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/module_include.md] on GitHub.
+    #
+    # [doc/plugins/module_include.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/module_include.md
     module ModuleInclude
       module ClassMethods
         def attachment_module(mod = nil, &block)

data/lib/shrine/plugins/moving.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/moving.md] on GitHub.
+    #
+    # [doc/plugins/moving.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/moving.md
     module Moving
       def self.configure(uploader, opts = {})
         uploader.opts[:moving_storages] = opts.fetch(:storages, uploader.opts[:moving_storages])

data/lib/shrine/plugins/multi_delete.rb

@@ -4,6 +4,9 @@ Shrine.deprecation("The multi_delete plugin is deprecated and will be removed in
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/multi_delete.md] on GitHub.
+    #
+    # [doc/plugins/multi_delete.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/multi_delete.md
     module MultiDelete
       module InstanceMethods
         private

data/lib/shrine/plugins/parallelize.rb

@@ -4,6 +4,9 @@ require "thread"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/parallelize.md] on GitHub.
+    #
+    # [doc/plugins/parallelize.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/parallelize.md
     module Parallelize
       def self.configure(uploader, opts = {})
         uploader.opts[:parallelize_threads] = opts.fetch(:threads, uploader.opts.fetch(:parallelize_threads, 3))
@@ -52,6 +55,7 @@ class Shrine
         end
 
         def perform
+          @tasks.close
           threads = @size.times.map { spawn_thread }
           threads.each(&:join)
         end
@@ -61,7 +65,7 @@ class Shrine
         def spawn_thread
           Thread.new do
             loop do
-              task = @tasks.deq(true) rescue break
+              task = @tasks.deq or break
               task.call
             end
           end

data/lib/shrine/plugins/parsed_json.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/parsed_json.md] on GitHub.
+    #
+    # [doc/plugins/parsed_json.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/parsed_json.md
     module ParsedJson
       module AttacherMethods
         def assign(value)

data/lib/shrine/plugins/presign_endpoint.rb

@@ -6,6 +6,9 @@ require "json"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/presign_endpoint.md] on GitHub.
+    #
+    # [doc/plugins/presign_endpoint.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/presign_endpoint.md
     module PresignEndpoint
       def self.configure(uploader, opts = {})
         uploader.opts[:presign_endpoint_presign_location] = opts.fetch(:presign_location, uploader.opts[:presign_endpoint_presign_location])

data/lib/shrine/plugins/pretty_location.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/pretty_location.md] on GitHub.
+    #
+    # [doc/plugins/pretty_location.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/pretty_location.md
     module PrettyLocation
       def self.configure(uploader, opts = {})
         uploader.opts[:pretty_location_namespace] = opts.fetch(:namespace, uploader.opts[:pretty_location_namespace])

data/lib/shrine/plugins/processing.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/processing.md] on GitHub.
+    #
+    # [doc/plugins/processing.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/processing.md
     module Processing
       def self.configure(uploader)
         uploader.opts[:processing] ||= {}

data/lib/shrine/plugins/rack_file.rb

@@ -4,6 +4,9 @@ require "forwardable"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/rack_file.md] on GitHub.
+    #
+    # [doc/plugins/rack_file.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/rack_file.md
     module RackFile
       module ClassMethods
         # Accepts a Rack uploaded file hash and wraps it in an IO object.

data/lib/shrine/plugins/rack_response.rb

@@ -5,6 +5,9 @@ require "content_disposition"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/rack_response.md] on GitHub.
+    #
+    # [doc/plugins/rack_response.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/rack_response.md
     module RackResponse
       module FileMethods
         # Returns a Rack response triple for the uploaded file.
@@ -22,6 +25,8 @@ class Shrine
 
         # Returns a Rack response triple for the uploaded file.
         def call(**options)
+          file.open unless file.opened?
+
           options[:range] = parse_content_range(options[:range]) if options[:range]
 
           status  = rack_status(**options)
@@ -44,15 +49,15 @@ class Shrine
         # metadata. Also returns the correct "Content-Range" header on ranged
         # requests.
         def rack_headers(filename: nil, type: nil, disposition: "inline", range: false)
-          length     = range ? range.size : size
-          type     ||= @file.mime_type || Rack::Mime.mime_type(".#{@file.extension}")
-          filename ||= @file.original_filename || @file.id.split("/").last
+          length     = range ? range.size : file.size
+          type     ||= file.mime_type || Rack::Mime.mime_type(".#{file.extension}", nil)
+          filename ||= file.original_filename || file.id.split("/").last
 
           headers = {}
           headers["Content-Length"]      = length.to_s if length
-          headers["Content-Type"]        = type
-          headers["Content-Disposition"] = content_disposition(disposition: disposition, filename: filename)
-          headers["Content-Range"]       = "bytes #{range.begin}-#{range.end}/#{size}" if range
+          headers["Content-Type"]        = type if type
+          headers["Content-Disposition"] = content_disposition(disposition, filename)
+          headers["Content-Range"]       = "bytes #{range.begin}-#{range.end}/#{file.size}" if range
           headers["Accept-Ranges"]       = "bytes" unless range == false
 
           headers
@@ -67,22 +72,17 @@ class Shrine
         # Parses the value of a "Range" HTTP header.
         def parse_content_range(range_header)
           if Rack.release >= "2.0"
-            ranges = Rack::Utils.get_byte_ranges(range_header, size)
+            ranges = Rack::Utils.get_byte_ranges(range_header, file.size)
           else
-            ranges = Rack::Utils.byte_ranges({"HTTP_RANGE" => range_header}, size)
+            ranges = Rack::Utils.byte_ranges({ "HTTP_RANGE" => range_header }, file.size)
           end
 
           ranges.first if ranges && ranges.one?
         end
 
-        def content_disposition(disposition:, filename:)
+        def content_disposition(disposition, filename)
           ContentDisposition.format(disposition: disposition, filename: filename)
         end
-
-        # Read size from metadata, otherwise retrieve the size from the storage.
-        def size
-          @file.size || @file.to_io.size
-        end
       end
 
       # Implements the interface of a Rack response body object.

data/lib/shrine/plugins/recache.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/recache.md] on GitHub.
+    #
+    # [doc/plugins/recache.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/recache.md
     module Recache
       module AttacherMethods
         def save

data/lib/shrine/plugins/refresh_metadata.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/refresh_metadata.md] on GitHub.
+    #
+    # [doc/plugins/refresh_metadata.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/refresh_metadata.md
     module RefreshMetadata
       module FileMethods
         def refresh_metadata!(context = {})

data/lib/shrine/plugins/remote_url.rb

@@ -4,6 +4,9 @@ require "down"
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/remote_url.md] on GitHub.
+    #
+    # [doc/plugins/remote_url.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remote_url.md
     module RemoteUrl
       def self.configure(uploader, opts = {})
         raise Error, "The :max_size option is required for remote_url plugin" if !opts.key?(:max_size) && !uploader.opts.key?(:remote_url_max_size)

data/lib/shrine/plugins/remove_attachment.rb

@@ -2,6 +2,9 @@
 
 class Shrine
   module Plugins
+    # Documentation lives in [doc/plugins/remove_attachment.md] on GitHub.
+    #
+    # [doc/plugins/remove_attachment.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remove_attachment.md
     module RemoveAttachment
       module AttachmentMethods
         def initialize(*)