shrine 3.2.2 → 3.3.0

data/lib/shrine/plugins/backgrounding.rb

@@ -36,8 +36,8 @@ class Shrine
 
       module AttacherMethods
         # Inherits global hooks if defined.
-        def initialize(*args)
-          super
+        def initialize(**args)
+          super(**args)
           @destroy_block = self.class.destroy_block
           @promote_block = self.class.promote_block
         end

data/lib/shrine/plugins/derivation_endpoint.rb

@@ -392,6 +392,7 @@ class Shrine
       options[:type]        = request.params["type"]        if request.params["type"]
       options[:disposition] = request.params["disposition"] if request.params["disposition"]
       options[:filename]    = request.params["filename"]    if request.params["filename"]
+      options[:version]     = request.params["version"]     if request.params["version"]
       options[:expires_in]  = expires_in(request)           if request.params["expires_at"]
 
       derivation = uploaded_file.derivation(name, *args, **options)
@@ -738,7 +739,7 @@ class Shrine
     def verify_signature(string, signature)
       if signature.nil?
         fail InvalidSignature, "missing \"signature\" param"
-      elsif signature != generate_signature(string)
+      elsif !Rack::Utils.secure_compare(signature, generate_signature(string))
         fail InvalidSignature, "provided signature does not match the calculated signature"
       end
     end

data/lib/shrine/plugins/derivatives.rb

@@ -4,8 +4,6 @@ class Shrine
   module Plugins
     # Documentation can be found on https://shrinerb.com/docs/plugins/derivatives
     module Derivatives
-      NOOP_PROCESSOR = -> (*) { Hash.new }
-
       LOG_SUBSCRIBER = -> (event) do
         Shrine.logger.info "Derivatives (#{event.duration}ms) – #{{
           processor:         event[:processor],
@@ -21,7 +19,7 @@ class Shrine
       end
 
       def self.configure(uploader, log_subscriber: LOG_SUBSCRIBER, **opts)
-        uploader.opts[:derivatives] ||= { processors: {}, storage: proc { store_key } }
+        uploader.opts[:derivatives] ||= { processors: {}, processor_settings: {}, storage: proc { store_key } }
         uploader.opts[:derivatives].merge!(opts)
 
         # instrumentation plugin integration
@@ -52,20 +50,37 @@ class Shrine
         #     Attacher.derivatives_processor :thumbnails do |original|
         #       # ...
         #     end
-        def derivatives_processor(name = :default, &block)
+        #
+        # By default, Shrine will convert the source IO object into a file
+        # before it's passed to the processor block. You can set `download:
+        # false` to pass the source IO object to the processor block as is.
+        #
+        #     Attacher.derivatives_processor :thumbnails, download: false do |original|
+        #       # ...
+        #     end
+        #
+        # This can be useful if you'd like to defer or avoid a possibly
+        # expensive download operation for processor logic that does not
+        # require it.
+        def derivatives_processor(name = :default, download: true, &block)
           if block
-            shrine_class.opts[:derivatives][:processors][name.to_sym] = block
+            shrine_class.derivatives_options[:processors][name.to_sym] = block
+            shrine_class.derivatives_options[:processor_settings][name.to_sym] = { download: download }
           else
-            processor   = shrine_class.opts[:derivatives][:processors][name.to_sym]
-            processor ||= NOOP_PROCESSOR if name == :default
-
-            fail Error, "derivatives processor #{name.inspect} not registered" unless processor
-
-            processor
+            shrine_class.derivatives_options[:processors].fetch(name.to_sym) do
+              fail Error, "derivatives processor #{name.inspect} not registered" unless name == :default
+            end
           end
         end
         alias derivatives derivatives_processor
 
+        # Returns settings for the given derivatives processor.
+        #
+        #     Attacher.derivatives_processor_settings(:thumbnails) #=> { download: true }
+        def derivatives_processor_settings(name)
+          shrine_class.derivatives_options[:processor_settings][name.to_sym] || {}
+        end
+
         # Specifies default storage to which derivatives will be uploaded.
         #
         #     Attacher.derivatives_storage :other_store
@@ -79,9 +94,9 @@ class Shrine
         #     end
         def derivatives_storage(storage_key = nil, &block)
           if storage_key || block
-            shrine_class.opts[:derivatives][:storage] = storage_key || block
+            shrine_class.derivatives_options[:storage] = storage_key || block
           else
-            shrine_class.opts[:derivatives][:storage]
+            shrine_class.derivatives_options[:storage]
           end
         end
       end
@@ -147,6 +162,7 @@ class Shrine
         def promote(**options)
           super
           promote_derivatives
+          create_derivatives if create_derivatives_on_promote?
         end
 
         # Uploads any cached derivatives to permanent storage.
@@ -268,8 +284,10 @@ class Shrine
 
           source ||= file!
 
-          if source.is_a?(UploadedFile)
-            source.download do |file|
+          processor_settings = self.class.derivatives_processor_settings(processor_name) || {}
+
+          if processor_settings[:download]
+            shrine_class.with_file(source) do |file|
               _process_derivatives(processor_name, file, **options)
             end
           else
@@ -472,6 +490,8 @@ class Shrine
         def _process_derivatives(processor_name, source, **options)
           processor = self.class.derivatives_processor(processor_name)
 
+          return {} unless processor
+
           result = instrument_derivatives(processor_name, source, options) do
             instance_exec(source, **options, &processor)
           end
@@ -521,6 +541,11 @@ class Shrine
             o2
           end
         end
+
+        # Whether to automatically create derivatives on promotion
+        def create_derivatives_on_promote?
+          shrine_class.derivatives_options[:create_on_promote]
+        end
       end
 
       module ClassMethods
@@ -577,6 +602,11 @@ class Shrine
             yield path, object
           end
         end
+
+        # Returns derivatives plugin options.
+        def derivatives_options
+          opts[:derivatives]
+        end
       end
 
       module FileMethods

data/lib/shrine/plugins/mirroring.rb

@@ -53,7 +53,7 @@ class Shrine
         # Mirrors upload to other mirror storages.
         def upload(io, mirror: true, **options)
           file = super(io, **options)
-          file.trigger_mirror_upload if mirror
+          file.trigger_mirror_upload(**options) if mirror
           file
         end
       end
@@ -61,31 +61,31 @@ class Shrine
       module FileMethods
         # Mirrors upload if mirrors are defined. Calls mirror block if
         # registered, otherwise mirrors synchronously.
-        def trigger_mirror_upload
+        def trigger_mirror_upload(**options)
           return unless shrine_class.mirrors[storage_key] && shrine_class.mirror_upload?
 
           if shrine_class.mirror_upload_block
-            mirror_upload_background
+            mirror_upload_background(**options)
           else
-            mirror_upload
+            mirror_upload(**options)
           end
         end
 
         # Calls mirror upload block.
-        def mirror_upload_background
+        def mirror_upload_background(**options)
           fail Error, "mirror upload block is not registered" unless shrine_class.mirror_upload_block
 
-          shrine_class.mirror_upload_block.call(self)
+          shrine_class.mirror_upload_block.call(self, **options)
         end
 
         # Uploads the file to each mirror storage.
-        def mirror_upload
+        def mirror_upload(**options)
           previously_opened = opened?
 
           each_mirror do |mirror|
             rewind if opened?
 
-            shrine_class.upload(self, mirror, location: id, close: false, action: :mirror)
+            shrine_class.upload(self, mirror, **options, location: id, close: false, action: :mirror)
           end
         ensure
           if opened? && !previously_opened

data/lib/shrine/plugins/presign_endpoint.rb

@@ -81,9 +81,14 @@ class Shrine
 
       status, headers, body = catch(:halt) do
         error!(404, "Not Found") unless ["", "/"].include?(request.path_info)
-        error!(405, "Method Not Allowed") unless request.get?
 
-        handle_request(request)
+        if request.get?
+          handle_request(request)
+        elsif request.options?
+          handle_options_request(request)
+        else
+          error!(405, "Method Not Allowed")
+        end
       end
 
       headers["Content-Length"] ||= body.map(&:bytesize).inject(0, :+).to_s
@@ -109,6 +114,13 @@ class Shrine
       make_response(presign, request)
     end
 
+    # Uppy client sends an OPTIONS request to fetch information about the
+    # Uppy Companion. Since our Rack app is only acting as Uppy Companion, we
+    # just return a successful response.
+    def handle_options_request(request)
+      [200, {}, []]
+    end
+
     # Generates the location using `Shrine#generate_uid`, and extracts the
     # extension from the `filename` query parameter. If `:presign_location`
     # option is given, calls that instead.

data/lib/shrine/plugins/remove_attachment.rb

@@ -32,6 +32,11 @@ class Shrine
 
         private
 
+        # Don't override previously removed attachment that wasn't yet deleted.
+        def change?(file)
+          super && !(changed? && remove?)
+        end
+
         # Rails sends "0" or "false" if the checkbox hasn't been ticked.
         def remove?
           remove && remove != "" && remove !~ /\A(0|false)\z/

data/lib/shrine/plugins/sequel.rb

@@ -62,7 +62,7 @@ class Shrine
           # reload the attacher on record reload
           define_method :_refresh do |*args|
             result = super(*args)
-            instance_variable_set(:"@#{name}_attacher", nil)
+            send(:"#{name}_attacher").reload
             result
           end
           private :_refresh

data/lib/shrine/plugins/store_dimensions.rb

@@ -12,7 +12,7 @@ class Shrine
       end
 
       def self.configure(uploader, log_subscriber: LOG_SUBSCRIBER, **opts)
-        uploader.opts[:store_dimensions] ||= { analyzer: :fastimage, on_error: :warn }
+        uploader.opts[:store_dimensions] ||= { analyzer: :fastimage, on_error: :warn, auto_extraction: true }
         uploader.opts[:store_dimensions].merge!(opts)
 
         # resolve error strategy
@@ -71,8 +71,10 @@ class Shrine
       end
 
       module InstanceMethods
-        # We update the metadata with "width" and "height".
         def extract_metadata(io, **options)
+          return super unless opts[:store_dimensions][:auto_extraction]
+
+          # We update the metadata with "width" and "height".
           width, height = self.class.extract_dimensions(io)
 
           super.merge!("width" => width, "height" => height)

data/lib/shrine/plugins/upload_endpoint.rb

@@ -135,9 +135,14 @@ class Shrine
       end
 
       error!(400, "Upload Not Found") if value.nil?
-      error!(400, "Upload Not Valid") unless value.is_a?(Hash) && value[:tempfile]
 
-      @shrine_class.rack_file(value)
+      if value.is_a?(Hash) && value[:tempfile]
+        @shrine_class.rack_file(value)
+      elsif %i[read rewind eof? close].all? { |m| value.respond_to?(m) }
+        value
+      else
+        error!(400, "Upload Not Valid")
+      end
     end
 
     # Returns a hash of information containing `:action` and `:request`

data/lib/shrine/storage/memory.rb

@@ -12,12 +12,14 @@ class Shrine
         @store = store
       end
 
-      def upload(io, id, *)
+      def upload(io, id, **)
         store[id] = io.read
       end
 
-      def open(id, *)
-        StringIO.new(store.fetch(id))
+      def open(id, **)
+        io = StringIO.new(store.fetch(id))
+        io.set_encoding(io.string.encoding) # Ruby 2.7.0 – https://bugs.ruby-lang.org/issues/16497
+        io
       rescue KeyError
         raise Shrine::FileNotFound, "file #{id.inspect} not found on storage"
       end

data/lib/shrine/storage/s3.rb

@@ -9,6 +9,7 @@ require "down/chunked_io"
 require "content_disposition"
 
 require "uri"
+require "tempfile"
 
 class Shrine
   module Storage
@@ -103,7 +104,7 @@ class Shrine
       #
       # [`Aws::S3::Object#get`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#get-instance_method
       def open(id, rewindable: true, **options)
-        chunks, length = get(object(id), options)
+        chunks, length = get(id, **options)
 
         Down::ChunkedIO.new(chunks: chunks, rewindable: rewindable, size: length)
       rescue Aws::S3::Errors::NoSuchKey
@@ -212,7 +213,7 @@ class Shrine
 
       # Returns an `Aws::S3::Object` for the given id.
       def object(id)
-        bucket.object([*prefix, id].join("/"))
+        bucket.object(object_key(id))
       end
 
       private
@@ -279,9 +280,12 @@ class Shrine
         end
       end
 
+      # Aws::S3::Object#get doesn't allow us to get the content length of the
+      # object before all content is downloaded, so we hack our way around it.
+      # This way get the content length without an additional HEAD request.
       if Gem::Version.new(Aws::CORE_GEM_VERSION) >= Gem::Version.new("3.104.0")
-        def get(object, params)
-          enum = object.enum_for(:get, **params)
+        def get(id, **params)
+          enum = object(id).enum_for(:get, **params)
 
           begin
             content_length = Integer(enum.peek.last["content-length"])
@@ -294,8 +298,8 @@ class Shrine
           [chunks, content_length]
         end
       else
-        def get(object, params)
-          req = client.build_request(:get_object, bucket: bucket.name, key: object.key, **params)
+        def get(id, **params)
+          req = client.build_request(:get_object, bucket: bucket.name, key: object_key(id), **params)
 
           body = req.enum_for(:send_request)
           begin
@@ -326,6 +330,57 @@ class Shrine
           bucket.delete_objects(delete: delete_params)
         end
       end
+
+      # Returns object key with potential prefix.
+      def object_key(id)
+        [*prefix, id].join("/")
+      end
+
+      # Adds support for Aws::S3::Encryption::Client.
+      module ClientSideEncryption
+        attr_reader :encryption_client
+
+        # Save the encryption client and continue initialization with normal
+        # client.
+        def initialize(client: nil, **options)
+          return super unless client.class.name.start_with?("Aws::S3::Encryption")
+
+          super(client: client.client, **options)
+          @encryption_client = client
+        end
+
+        private
+
+        # Encryption client doesn't support multipart uploads, so we always use
+        # #put_object.
+        def put(io, id, **options)
+          return super unless encryption_client
+
+          encryption_client.put_object(body: io, bucket: bucket.name, key: object_key(id), **options)
+        end
+
+        def get(id, **options)
+          return super unless encryption_client
+
+          # Encryption client v2 warns against streaming download, so we first
+          # download all content into a file.
+          tempfile = Tempfile.new("shrine-s3", binmode: true)
+          response = encryption_client.get_object(response_target: tempfile, bucket: bucket.name, key: object_key(id), **options)
+          tempfile.rewind
+
+          chunks = Enumerator.new do |yielder|
+            begin
+              yielder << tempfile.read(16*1024) until tempfile.eof?
+            ensure
+              tempfile.close!
+            end
+          end
+
+          [chunks, tempfile.size]
+        end
+      end
+
+      prepend ClientSideEncryption
     end
   end
 end

data/lib/shrine/version.rb

@@ -7,8 +7,8 @@ class Shrine
 
   module VERSION
     MAJOR = 3
-    MINOR = 2
-    TINY  = 2
+    MINOR = 3
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/shrine.gemspec

@@ -61,7 +61,7 @@ direct uploads for fully asynchronous user experience.
   gem.add_development_dependency "ruby-vips", "~> 2.0" unless ENV["CI"]
 
   # for S3 storage
-  gem.add_development_dependency "aws-sdk-s3", "~> 1.16"
+  gem.add_development_dependency "aws-sdk-s3", "~> 1.69"
   gem.add_development_dependency "aws-sdk-core", "~> 3.23"
 
   # for instrumentation plugin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -240,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.69'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.69'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
@@ -458,6 +458,7 @@ files:
 - doc/release_notes/3.2.0.md
 - doc/release_notes/3.2.1.md
 - doc/release_notes/3.2.2.md
+- doc/release_notes/3.3.0.md
 - doc/retrieving_uploads.md
 - doc/securing_uploads.md
 - doc/storage/file_system.md
@@ -552,7 +553,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Toolkit for file attachments in Ruby applications