shrine 3.0.1 → 3.3.0

data/lib/shrine/plugins/upload_endpoint.rb

@@ -9,11 +9,11 @@ class Shrine
   module Plugins
     # Documentation can be found on https://shrinerb.com/docs/plugins/upload_endpoint
     module UploadEndpoint
-      def self.load_dependencies(uploader, opts = {})
+      def self.load_dependencies(uploader, **)
         uploader.plugin :rack_file
       end
 
-      def self.configure(uploader, opts = {})
+      def self.configure(uploader, **opts)
         uploader.opts[:upload_endpoint] ||= {}
         uploader.opts[:upload_endpoint].merge!(opts)
       end
@@ -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`
@@ -156,7 +161,7 @@ class Shrine
       if @upload
         @upload.call(io, context, request)
       else
-        uploader.upload(io, context)
+        uploader.upload(io, **context)
       end
     end
 

data/lib/shrine/plugins/upload_options.rb

@@ -4,9 +4,9 @@ class Shrine
   module Plugins
     # Documentation can be found on https://shrinerb.com/docs/plugins/upload_options
     module UploadOptions
-      def self.configure(uploader, options = {})
+      def self.configure(uploader, **opts)
         uploader.opts[:upload_options] ||= {}
-        uploader.opts[:upload_options].merge!(options)
+        uploader.opts[:upload_options].merge!(opts)
       end
 
       module InstanceMethods

data/lib/shrine/plugins/url_options.rb

@@ -4,9 +4,9 @@ class Shrine
   module Plugins
     # Documentation can be found on https://shrinerb.com/docs/plugins/url_options
     module UrlOptions
-      def self.configure(uploader, **options)
+      def self.configure(uploader, **opts)
         uploader.opts[:url_options] ||= {}
-        uploader.opts[:url_options].merge!(options)
+        uploader.opts[:url_options].merge!(opts)
       end
 
       module FileMethods

data/lib/shrine/plugins/validation.rb

@@ -29,14 +29,16 @@ class Shrine
           @errors = []
         end
 
-        # Leaves out :validate option when calling `Shrine.upload`.
-        def upload(*args, validate: nil, **options)
-          super(*args, **options)
+        # Performs validations after attaching cached file.
+        def attach_cached(value, validate: nil, **options)
+          result = super(value, validate: false, **options)
+          validation(validate)
+          result
         end
 
-        # Performs validations after changing the file.
-        def change(file, validate: nil, **)
-          result = super
+        # Performs validations after attaching file.
+        def attach(io, validate: nil, **options)
+          result = super(io, **options)
           validation(validate)
           result
         end
@@ -52,7 +54,7 @@ class Shrine
         # Calls validation appropriately based on the :validate value.
         def validation(argument)
           case argument
-          when Hash  then validate(argument)
+          when Hash  then validate(**argument)
           when false then errors.clear # skip validation
           else            validate
           end

data/lib/shrine/storage/linter.rb

@@ -35,7 +35,7 @@ class Shrine
       end
 
       def call(io_factory = default_io_factory)
-        storage.upload(io_factory.call, id = "foo", {})
+        storage.upload(io_factory.call, id = "foo", shrine_metadata: { "foo" => "bar" })
 
         lint_open(id)
         lint_exists(id)
@@ -67,13 +67,13 @@ class Shrine
       end
 
       def lint_open(id)
-        opened = storage.open(id, {})
+        opened = storage.open(id)
         error :open, "doesn't return a valid IO object" if !io?(opened)
         error :open, "returns an empty IO object" if opened.read.empty?
         opened.close
 
         begin
-          storage.open(@nonexisting, {})
+          storage.open(@nonexisting)
           error :open, "should raise an exception on nonexisting file"
         rescue Shrine::FileNotFound
         rescue => exception
@@ -107,7 +107,7 @@ class Shrine
       end
 
       def lint_presign(id)
-        data = storage.presign(id, {})
+        data = storage.presign(id)
         error :presign, "result should be a Hash" unless data.respond_to?(:to_h)
         error :presign, "result should include :method key" unless data.to_h.key?(:method)
         error :presign, "result should include :url key" unless data.to_h.key?(:url)

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(object(id), options)
+        chunks, length = get(id, **options)
 
         Down::ChunkedIO.new(chunks: chunks, rewindable: rewindable, size: length)
       rescue Aws::S3::Errors::NoSuchKey
@@ -179,25 +180,7 @@ class Shrine
         options.merge!(@upload_options)
         options.merge!(presign_options)
 
-        if method == :post
-          presigned_post = object(id).presigned_post(options)
-
-          { method: method, url: presigned_post.url, fields: presigned_post.fields }
-        else
-          url = object(id).presigned_url(method, options)
-
-          # When any of these options are specified, the corresponding request
-          # headers must be included in the upload request.
-          headers = {}
-          headers["Content-Length"]      = options[:content_length]      if options[:content_length]
-          headers["Content-Type"]        = options[:content_type]        if options[:content_type]
-          headers["Content-Disposition"] = options[:content_disposition] if options[:content_disposition]
-          headers["Content-Encoding"]    = options[:content_encoding]    if options[:content_encoding]
-          headers["Content-Language"]    = options[:content_language]    if options[:content_language]
-          headers["Content-MD5"]         = options[:content_md5]         if options[:content_md5]
-
-          { method: method, url: url, headers: headers }
-        end
+        send(:"presign_#{method}", id, options)
       end
 
       # Deletes the file from the storage.
@@ -230,11 +213,22 @@ 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
 
+      # Uploads the file to S3. Uses multipart upload for large files.
+      def put(io, id, **options)
+        if io.respond_to?(:size) && io.size && io.size <= @multipart_threshold[:upload]
+          object(id).put(body: io, **options)
+        else # multipart upload
+          object(id).upload_stream(part_size: part_size(io), **options) do |write_stream|
+            IO.copy_stream(io, write_stream)
+          end
+        end
+      end
+
       # Copies an existing S3 object to a new location. Uses multipart copy for
       # large files.
       def copy(io, id, **copy_options)
@@ -250,15 +244,28 @@ class Shrine
         object(id).copy_from(io.storage.object(io.id), **options)
       end
 
-      # Uploads the file to S3. Uses multipart upload for large files.
-      def put(io, id, **options)
-        if io.respond_to?(:size) && io.size && io.size <= @multipart_threshold[:upload]
-          object(id).put(body: io, **options)
-        else # multipart upload
-          object(id).upload_stream(part_size: part_size(io), **options) do |write_stream|
-            IO.copy_stream(io, write_stream)
-          end
-        end
+      # Generates parameters for a POST upload request.
+      def presign_post(id, options)
+        presigned_post = object(id).presigned_post(options)
+
+        { method: :post, url: presigned_post.url, fields: presigned_post.fields }
+      end
+
+      # Generates parameters for a PUT upload request.
+      def presign_put(id, options)
+        url = object(id).presigned_url(:put, options)
+
+        # When any of these options are specified, the corresponding request
+        # headers must be included in the upload request.
+        headers = {}
+        headers["Content-Length"]      = options[:content_length]      if options[:content_length]
+        headers["Content-Type"]        = options[:content_type]        if options[:content_type]
+        headers["Content-Disposition"] = options[:content_disposition] if options[:content_disposition]
+        headers["Content-Encoding"]    = options[:content_encoding]    if options[:content_encoding]
+        headers["Content-Language"]    = options[:content_language]    if options[:content_language]
+        headers["Content-MD5"]         = options[:content_md5]         if options[:content_md5]
+
+        { method: :put, url: url, headers: headers }
       end
 
       # Determins the part size that should be used when uploading the given IO
@@ -274,17 +281,38 @@ class Shrine
       end
 
       # Aws::S3::Object#get doesn't allow us to get the content length of the
-      # object before the content is downloaded, so we hack our way around it.
-      def get_object(object, params)
-        req = client.build_request(:get_object, **params, bucket: bucket.name, key: object.key)
+      # 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(id, **params)
+          enum = object(id).enum_for(:get, **params)
+
+          begin
+            content_length = Integer(enum.peek.last["content-length"])
+          rescue StopIteration
+            content_length = 0
+          end
 
-        body = req.enum_for(:send_request)
-        body.peek # start the request
+          chunks = Enumerator.new { |y| loop { y << enum.next.first } }
+
+          [chunks, content_length]
+        end
+      else
+        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
+            body.peek # start the request
+          rescue StopIteration
+            # the S3 object is empty
+          end
 
-        content_length = Integer(req.context.http_response.headers["Content-Length"])
-        chunks         = Enumerator.new { |y| loop { y << body.next } }
+          content_length = Integer(req.context.http_response.headers["Content-Length"])
+          chunks         = Enumerator.new { |y| loop { y << body.next } }
 
-        [chunks, content_length]
+          [chunks, content_length]
+        end
       end
 
       # The file is copyable if it's on S3 and on the same Amazon account.
@@ -302,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/uploaded_file.rb

@@ -6,7 +6,6 @@ require "uri"
 
 class Shrine
   # Core class that represents a file uploaded to a storage.
-  # Base implementation is defined in InstanceMethods and ClassMethods.
   class UploadedFile
     @shrine_class = ::Shrine
 

data/lib/shrine/version.rb

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

data/shrine.gemspec

@@ -33,18 +33,17 @@ direct uploads for fully asynchronous user experience.
   gem.files        = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*.rb", "shrine.gemspec", "doc/**/*.md"]
   gem.require_path = "lib"
 
-  gem.add_dependency "down", "~> 5.0"
+  gem.add_dependency "down", "~> 5.1"
   gem.add_dependency "content_disposition", "~> 1.0"
 
   # general testing helpers
   gem.add_development_dependency "rake", ">= 11.1"
   gem.add_development_dependency "minitest", "~> 5.8"
-  gem.add_development_dependency "mocha", "~> 1.4"
-  gem.add_development_dependency "dry-initializer"
+  gem.add_development_dependency "mocha", "~> 1.11"
 
   # for endpoint plugins
   gem.add_development_dependency "rack", "~> 2.0"
-  gem.add_development_dependency "http-form_data", "~> 2.0"
+  gem.add_development_dependency "http-form_data", "~> 2.2"
   gem.add_development_dependency "rack-test_app"
 
   # for determine_mime_type plugin
@@ -62,15 +61,15 @@ 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
   gem.add_development_dependency "dry-monitor"
-  gem.add_development_dependency "activesupport", "~> 5.2.0"
+  gem.add_development_dependency "activesupport", RUBY_VERSION >= "2.5" ? "~> 6.0" : "~> 5.2"
 
   # for ORM plugins
   gem.add_development_dependency "sequel"
-  gem.add_development_dependency "activerecord", "~> 5.2.0"
-  gem.add_development_dependency "sqlite3", "~> 1.3.6" unless RUBY_ENGINE == "jruby"
+  gem.add_development_dependency "activerecord", RUBY_VERSION >= "2.5" ? "~> 6.0" : "~> 5.2"
+  gem.add_development_dependency "sqlite3", "~> 1.4" unless RUBY_ENGINE == "jruby"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2020-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: content_disposition
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: dry-initializer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rack-test_app
   requirement: !ruby/object:Gem::Requirement
@@ -254,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
@@ -296,14 +282,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -324,28 +310,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.4'
 description: |
   Shrine is a toolkit for file attachments in Ruby applications. It supports
   uploading, downloading, processing and deleting IO objects, backed by various
@@ -424,6 +410,7 @@ files:
 - doc/plugins/signature.md
 - doc/plugins/store_dimensions.md
 - doc/plugins/tempfile.md
+- doc/plugins/type_predicates.md
 - doc/plugins/upload_endpoint.md
 - doc/plugins/upload_options.md
 - doc/plugins/url_options.md
@@ -467,9 +454,15 @@ files:
 - doc/release_notes/2.9.0.md
 - doc/release_notes/3.0.0.md
 - doc/release_notes/3.0.1.md
+- doc/release_notes/3.1.0.md
+- 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
+- doc/storage/memory.md
 - doc/storage/s3.md
 - doc/testing.md
 - doc/upgrading_to_3.md
@@ -522,6 +515,7 @@ files:
 - lib/shrine/plugins/signature.rb
 - lib/shrine/plugins/store_dimensions.rb
 - lib/shrine/plugins/tempfile.rb
+- lib/shrine/plugins/type_predicates.rb
 - lib/shrine/plugins/upload_endpoint.rb
 - lib/shrine/plugins/upload_options.rb
 - lib/shrine/plugins/url_options.rb
@@ -559,7 +553,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Toolkit for file attachments in Ruby applications