shrine 2.17.1 → 2.18.0

data/lib/shrine/plugins/remove_attachment.rb

@@ -7,11 +7,9 @@ class Shrine
     # [doc/plugins/remove_attachment.md]: https://github.com/shrinerb/shrine/blob/master/doc/plugins/remove_attachment.md
     module RemoveAttachment
       module AttachmentMethods
-        def initialize(*)
+        def initialize(name, **options)
           super
 
-          name = attachment_name
-
           define_method :"remove_#{name}=" do |value|
             send(:"#{name}_attacher").remove = value
           end

data/lib/shrine/plugins/signature.rb

@@ -10,8 +10,7 @@ class Shrine
         # Calculates `algorithm` hash of the contents of the IO object, and
         # encodes it into `format`.
         def calculate_signature(io, algorithm, format: :hex)
-          algorithm = algorithm.downcase # support uppercase algorithm names like :MD5
-          SignatureCalculator.new(algorithm, format: format).call(io)
+          SignatureCalculator.new(algorithm.downcase, format: format).call(io)
         end
       end
 

data/lib/shrine/plugins/upload_endpoint.rb

@@ -36,6 +36,27 @@ class Shrine
             **options,
           )
         end
+
+        # Calls the upload endpoint passing the request information, and
+        # returns the Rack response triple.
+        #
+        # It performs the same mounting logic that Rack and other web
+        # frameworks use, and is meant for cases where statically mounting the
+        # endpoint in the router isn't enough.
+        def upload_response(storage_key, env, **options)
+          script_name = env["SCRIPT_NAME"]
+          path_info   = env["PATH_INFO"]
+
+          begin
+            env["SCRIPT_NAME"] += path_info
+            env["PATH_INFO"]    = ""
+
+            upload_endpoint(storage_key, **options).call(env)
+          ensure
+            env["SCRIPT_NAME"] = script_name
+            env["PATH_INFO"]   = path_info
+          end
+        end
       end
     end
 
@@ -95,18 +116,30 @@ class Shrine
       make_response(uploaded_file, request)
     end
 
-    # Retrieves the "file" multipart request parameter, and returns an
-    # IO-like object that can be passed to `Shrine#upload`.
+    # Retrieves the upload from the request and verifies it.
     def get_io(request)
-      file = request.params["file"]
+      file = get_multipart_upload(request)
+
+      verify_size!(file, request)
+      verify_checksum!(file, request)
 
-      error!(400, "Upload Not Found") if file.nil?
-      error!(400, "Upload Not Valid") unless file.is_a?(Hash) && file[:tempfile]
-      error!(413, "Upload Too Large") if @max_size && file[:tempfile].size > @max_size
+      file
+    end
+
+    # Retrieves the file from "file" or "files[]" multipart POST param, and
+    # converts it into an IO-like object that can be passed to `Shrine#upload`.
+    def get_multipart_upload(request)
+      if request.params.key?("file")
+        value = request.params["file"]
+      elsif request.params["files"].is_a?(Array)
+        error!(400, "Too Many Files") if request.params["files"].count > 1
+        value = request.params["files"].first
+      end
 
-      verify_checksum!(file[:tempfile], request.env["HTTP_CONTENT_MD5"]) if request.env["HTTP_CONTENT_MD5"]
+      error!(400, "Upload Not Found") if value.nil?
+      error!(400, "Upload Not Valid") unless value.is_a?(Hash) && value[:tempfile]
 
-      @shrine_class.rack_file(file)
+      @shrine_class.rack_file(value)
     end
 
     # Returns a hash of information containing `:action` and `:request`
@@ -137,12 +170,32 @@ class Shrine
       if @rack_response
         @rack_response.call(object, request)
       else
-        [200, { "Content-Type" => CONTENT_TYPE_JSON }, [object.to_json]]
+        if @url
+          url = case @url
+                when true then object.url
+                when Hash then object.url(**@url)
+                else           @url.call(object, request)
+                end
+
+          body = { data: object, url: url }.to_json
+        else
+          body = object.to_json
+        end
+
+        [200, { "Content-Type" => CONTENT_TYPE_JSON }, [body]]
       end
     end
 
+    def verify_size!(file, request)
+      error!(413, "Upload Too Large") if @max_size && file.size > @max_size
+    end
+
     # Verifies the provided checksum against the received file.
-    def verify_checksum!(file, provided_checksum)
+    def verify_checksum!(file, request)
+      return unless request.env.key?("HTTP_CONTENT_MD5")
+
+      provided_checksum = request.env["HTTP_CONTENT_MD5"]
+
       error!(400, "The Content-MD5 you specified was invalid") if provided_checksum.length != 24
 
       calculated_checksum = Digest::MD5.file(file.path).base64digest

data/lib/shrine/storage/s3.rb

@@ -5,11 +5,13 @@ begin
   require "aws-sdk-s3"
   if Gem::Version.new(Aws::S3::GEM_VERSION) < Gem::Version.new("1.2.0")
     raise "Shrine::Storage::S3 requires aws-sdk-s3 version 1.2.0 or above"
+  elsif Gem::Version.new(Aws::S3::GEM_VERSION) < Gem::Version.new("1.14.0")
+    Shrine.deprecation("Using aws-sdk-s3 < 1.14 is deprecated and support for it will be removed in Shrine 3. Update to aws-sdk-s3 version 1.14 or higher")
   end
 rescue LoadError => exception
   begin
     require "aws-sdk"
-    Shrine.deprecation("Using aws-sdk 2.x is deprecated and support for it will be removed in Shrine 3, use the new aws-sdk-s3 gem instead.")
+    Shrine.deprecation("Using aws-sdk 2.x is deprecated and support for it will be removed in Shrine 3. Use the new aws-sdk-s3 gem instead.")
     Aws.eager_autoload!(services: ["S3"])
   rescue LoadError
     raise exception
@@ -115,8 +117,7 @@ class Shrine
         if copyable?(io)
           copy(io, id, **options)
         else
-          bytes_uploaded = put(io, id, **options)
-          shrine_metadata["size"] ||= bytes_uploaded
+          put(io, id, **options)
         end
       end
 
@@ -153,10 +154,9 @@ class Shrine
       #    typically useful for setting CDN hosts (e.g.
       #    `http://abc123.cloudfront.net`)
       #
-      # :download
-      # :  If set to `true`, creates a "forced download" link, which means that
-      #    the browser will never display the file and always ask the user to
-      #    download it.
+      # :public
+      # :  Returns the unsigned URL to the S3 object. This requires the S3
+      #    object to be public.
       #
       # All other options are forwarded to [`Aws::S3::Object#presigned_url`] or
       # [`Aws::S3::Object#public_url`].
@@ -164,7 +164,10 @@ class Shrine
       # [`Aws::S3::Object#presigned_url`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#presigned_url-instance_method
       # [`Aws::S3::Object#public_url`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#public_url-instance_method
       def url(id, download: nil, public: self.public, host: self.host, **options)
-        options[:response_content_disposition] ||= "attachment" if download
+        if download
+          Shrine.deprecation("The :download option in Shrine::Storage::S3#url is deprecated and will be removed in Shrine 3. Use the :response_content_disposition option directly, e.g. `response_content_disposition: \"attachment\"`.")
+          options[:response_content_disposition] ||= "attachment"
+        end
         options[:response_content_disposition] = encode_content_disposition(options[:response_content_disposition]) if options[:response_content_disposition]
 
         if public || signer
@@ -285,35 +288,27 @@ class Shrine
 
       # Uploads the file to S3. Uses multipart upload for large files.
       def put(io, id, **options)
-        bytes_uploaded = nil
-
         if (path = extract_path(io))
           # use `upload_file` for files because it can do multipart upload
           options = { multipart_threshold: @multipart_threshold[:upload] }.merge!(options)
           object(id).upload_file(path, **options)
-          bytes_uploaded = File.size(path)
         else
           io.to_io if io.is_a?(UploadedFile) # open if not already opened
 
           if io.respond_to?(:size) && io.size && (io.size <= @multipart_threshold[:upload] || !object(id).respond_to?(:upload_stream))
             object(id).put(body: io, **options)
-            bytes_uploaded = io.size
           elsif object(id).respond_to?(:upload_stream)
             # `upload_stream` uses multipart upload
             object(id).upload_stream(tempfile: true, **options) do |write_stream|
-              bytes_uploaded = IO.copy_stream(io, write_stream)
+              IO.copy_stream(io, write_stream)
             end
           else
-            Shrine.deprecation "Uploading a file of unknown size with aws-sdk-s3 older than 1.14 is deprecated and will be removed in Shrine 3. Update to aws-sdk-s3 1.14 or higher."
-
             Tempfile.create("shrine-s3", binmode: true) do |file|
-              bytes_uploaded = IO.copy_stream(io, file.path)
+              IO.copy_stream(io, file.path)
               object(id).upload_file(file.path, **options)
             end
           end
         end
-
-        bytes_uploaded
       end
 
       # Aws::S3::Object#load doesn't support passing options to #head_object,

data/lib/shrine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 2.17.1
+  version: 2.18.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2019-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -433,6 +433,7 @@ files:
 - doc/release_notes/2.15.0.md
 - doc/release_notes/2.16.0.md
 - doc/release_notes/2.17.0.md
+- doc/release_notes/2.18.0.md
 - doc/release_notes/2.2.0.md
 - doc/release_notes/2.3.0.md
 - doc/release_notes/2.3.1.md