shrine 2.1.1 → 2.2.0

data/lib/shrine/plugins/versions.rb

@@ -1,25 +1,22 @@
 class Shrine
   module Plugins
-    # The versions plugin enables your uploader to deal with versions. To
-    # generate versions, you simply return a hash of versions in `Shrine#process`.
+    # The versions plugin enables your uploader to deal with versions, by
+    # allowing you to return a Hash of files when processing.
+    #
+    #     plugin :versions
+    #
     # Here is an example of processing image thumbnails using the
     # [image_processing] gem:
     #
-    #     require "image_processing/mini_magick"
-    #
-    #     class ImageUploader < Shrine
-    #       include ImageProcessing::MiniMagick
-    #       plugin :versions
+    #     include ImageProcessing::MiniMagick
+    #     plugin :processing
     #
-    #       def process(io, context)
-    #         if context[:phase] == :store
-    #           size_700 = resize_to_limit(io.download, 700, 700)
-    #           size_500 = resize_to_limit(size_700,    500, 500)
-    #           size_300 = resize_to_limit(size_500,    300, 300)
+    #     process(:store) do |io, context|
+    #       size_700 = resize_to_limit(io.download, 700, 700)
+    #       size_500 = resize_to_limit(size_700,    500, 500)
+    #       size_300 = resize_to_limit(size_500,    300, 300)
     #
-    #           {large: size_700, medium: size_500, small: size_300}
-    #         end
-    #       end
+    #       {large: size_700, medium: size_500, small: size_300}
     #     end
     #
     # Note that if you want to keep the original file, you can forward it as is
@@ -27,11 +24,9 @@ class Shrine
     # an IO-like object), which might avoid downloading depending on the
     # storage:
     #
-    #     def process(io, context)
-    #       if context[:phase] == :store
-    #         # ...
-    #         {original: io, thumb: thumb}
-    #       end
+    #     process(:store) do |io, context|
+    #       # processing thumbnail
+    #       {original: io, thumbnail: thumbnail}
     #     end
     #
     # Now when you access the stored attachment through the model, a hash of
@@ -89,8 +84,12 @@ class Shrine
     #
     #     user.avatar_url(:medium, download: true)
     #
-    # You can also easily generate default URLs for specific versions, since
-    # the `context` will include the version name:
+    # The `context` will now also include the version name, which you can use
+    # when generating a location or a default URL:
+    #
+    #     def generate_location(io, context)
+    #       "uploads/#{context[:version]}-#{super}"
+    #     end
     #
     #     plugin :default_url do |context|
     #       "/images/defaults/#{context[:version]}.jpg"
@@ -211,7 +210,7 @@ class Shrine
 
         def assign_cached(value)
           cached_file = uploaded_file(value)
-          warn "Generating versions in the :cache phase is deprecated and will be forbidden in Shrine 3." if cached_file.is_a?(Hash)
+          warn "Generating versions in the :cache action is deprecated and will be forbidden in Shrine 3." if cached_file.is_a?(Hash)
           super(cached_file)
         end
       end

data/lib/shrine/storage/file_system.rb

@@ -142,11 +142,6 @@ class Shrine
         path(id).open("rb", &block)
       end
 
-      # Returns the contents of the file as a String.
-      def read(id)
-        path(id).binread
-      end
-
       # Returns true if the file exists on the filesystem.
       def exists?(id)
         path(id).exist?

data/lib/shrine/storage/linter.rb

@@ -37,7 +37,6 @@ class Shrine
 
         lint_download(id)
         lint_open(id)
-        lint_read(id)
         lint_exists(id)
         lint_url(id)
         lint_delete(id)
@@ -52,8 +51,10 @@ class Shrine
           lint_multi_delete(id)
         end
 
-        storage.upload(io_factory.call, id = "quux")
-        lint_clear(id)
+        if storage.respond_to?(:clear!)
+          storage.upload(io_factory.call, id = "quux")
+          lint_clear(id)
+        end
       end
 
       def lint_download(id)
@@ -69,12 +70,6 @@ class Shrine
         opened.close
       end
 
-      def lint_read(id)
-        read = storage.read(id)
-        error :read, "doesn't return a string" if !read.is_a?(String)
-        error :read, "returns an empty string" if read.empty?
-      end
-
       def lint_exists(id)
         error :exists?, "returns false for a file that was uploaded" if !storage.exists?(id)
       end

data/lib/shrine/storage/s3.rb

@@ -97,18 +97,23 @@ class Shrine
       #     be passed to [`Aws::S3::Object#put`], [`Aws::S3::Object#copy_from`]
       #     and [`Aws::S3::Bucket#presigned_post`].
       #
+      # :multipart_threshold
+      # :   The file size over which the storage will use parallelized
+      #     multipart copy/upload. Default is `15*1024*1024` (15MB).
+      #
       # All other options are forwarded to [`Aws::S3::Client#initialize`].
       #
       # [`Aws::S3::Object#put`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Object.html#put-instance_method
       # [`Aws::S3::Object#copy_from`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Object.html#copy_from-instance_method
       # [`Aws::S3::Bucket#presigned_post`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Object.html#presigned_post-instance_method
       # [`Aws::S3::Client#initialize`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html#initialize-instance_method
-      def initialize(bucket:, prefix: nil, host: nil, upload_options: {}, **s3_options)
+      def initialize(bucket:, prefix: nil, host: nil, upload_options: {}, multipart_threshold: 15*1024*1024, **s3_options)
         @prefix = prefix
         @s3 = Aws::S3::Resource.new(**s3_options)
         @bucket = @s3.bucket(bucket)
         @host = host
         @upload_options = upload_options
+        @multipart_threshold = multipart_threshold
       end
 
       # If the file is an UploadedFile from S3, issues a COPY command, otherwise
@@ -130,7 +135,11 @@ class Shrine
 
       # Downloads the file from S3, and returns a `Tempfile`.
       def download(id)
-        Down.download(url(id), ssl_ca_cert: Aws.config[:ssl_ca_bundle])
+        tempfile = Tempfile.new(["s3", File.extname(id)], binmode: true)
+        (object = object(id)).get(response_target: tempfile.path)
+        tempfile.singleton_class.instance_eval { attr_accessor :content_type }
+        tempfile.content_type = object.content_type
+        tempfile.tap(&:open)
       end
 
       # Alias for #download.
@@ -138,11 +147,6 @@ class Shrine
         Down.open(url(id), ssl_ca_cert: Aws.config[:ssl_ca_bundle])
       end
 
-      # Returns the contents of the file as a String.
-      def read(id)
-        object(id).get.body.string
-      end
-
       # Returns true file exists on S3.
       def exists?(id)
         object(id).exists?
@@ -199,7 +203,12 @@ class Shrine
 
       # Deletes all files from the storage.
       def clear!
-        bucket.object_versions(prefix: prefix).delete
+        objects = bucket.object_versions(prefix: prefix)
+        if objects.respond_to?(:batch_delete!)
+          objects.batch_delete!
+        else
+          objects.delete
+        end
       end
 
       # Returns a signature for direct uploads. Internally it calls
@@ -239,13 +248,18 @@ class Shrine
 
       # Copies an existing S3 object to a new location.
       def copy(io, id, **options)
-        options.update(multipart_copy: true) if large?(io)
+        options = {multipart_copy: true, content_length: io.size}.update(options) if multipart?(io)
         object(id).copy_from(io.storage.object(io.id), **options)
       end
 
       # Uploads the file to S3.
       def put(io, id, **options)
-        object(id).put(body: io, **options)
+        if io.respond_to?(:path)
+          options = {multipart_threshold: @multipart_threshold}.update(options)
+          object(id).upload_file(io.path, **options)
+        else
+          object(id).put(body: io, **options)
+        end
       end
 
       # The file is copyable if it's on S3 and on the same Amazon account.
@@ -255,9 +269,10 @@ class Shrine
         io.storage.access_key_id == access_key_id
       end
 
-      # Amazon requires multipart copy from S3 objects larger than 5 GB.
-      def large?(io)
-        io.size && io.size >= 5*1024*1024*1024 # 5GB
+      # Determines whether multipart upload/copy should be used from
+      # `:multipart_threshold`.
+      def multipart?(io)
+        io.size && io.size >= @multipart_threshold
       end
     end
   end

data/lib/shrine/version.rb

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

data/shrine.gemspec

@@ -25,7 +25,7 @@ column, and tying them to record's lifecycle.
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine.gemspec", "doc/*.md"]
   gem.require_path = "lib"
 
-  gem.add_dependency "down", ">= 2.3.4"
+  gem.add_dependency "down", ">= 2.3.5"
 
   gem.add_development_dependency "rake", "~> 11.1"
   gem.add_development_dependency "minitest", "~> 5.8"
@@ -37,10 +37,11 @@ column, and tying them to record's lifecycle.
   gem.add_development_dependency "shrine-memory", ">= 0.2.1"
 
   gem.add_development_dependency "roda"
+  gem.add_development_dependency "rack", "~> 1.6.4"
   gem.add_development_dependency "mimemagic"
   gem.add_development_dependency "mime-types"
   gem.add_development_dependency "fastimage"
-  gem.add_development_dependency "aws-sdk"
+  gem.add_development_dependency "aws-sdk", "~> 2.1"
 
   unless RUBY_ENGINE == "jruby" || ENV["CI"]
     gem.add_development_dependency "ruby-filemagic", "~> 0.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 2.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: 2.3.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: mimemagic
   requirement: !ruby/object:Gem::Requirement
@@ -196,16 +210,16 @@ dependencies:
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
@@ -291,6 +305,7 @@ files:
 - doc/securing_uploads.md
 - lib/shrine.rb
 - lib/shrine/plugins/activerecord.rb
+- lib/shrine/plugins/add_metadata.rb
 - lib/shrine/plugins/background_helpers.rb
 - lib/shrine/plugins/backgrounding.rb
 - lib/shrine/plugins/backup.rb
@@ -316,6 +331,7 @@ files:
 - lib/shrine/plugins/parallelize.rb
 - lib/shrine/plugins/parsed_json.rb
 - lib/shrine/plugins/pretty_location.rb
+- lib/shrine/plugins/processing.rb
 - lib/shrine/plugins/rack_file.rb
 - lib/shrine/plugins/recache.rb
 - lib/shrine/plugins/remote_url.rb
@@ -357,4 +373,3 @@ signing_key:
 specification_version: 4
 summary: Toolkit for handling file uploads in Ruby
 test_files: []
-has_rdoc: