shrine 2.11.0 → 2.12.0

data/lib/shrine/plugins/dynamic_storage.rb

@@ -20,9 +20,13 @@ class Shrine
     #
     # This can be useful in combination with the `default_storage` plugin.
     module DynamicStorage
+      def self.configure(uploader, options = {})
+        uploader.opts[:dynamic_storages] ||= {}
+      end
+
       module ClassMethods
         def dynamic_storages
-          @dynamic_storages ||= {}
+          opts[:dynamic_storages]
         end
 
         def storage(regex, &block)

data/lib/shrine/plugins/parallelize.rb

@@ -68,7 +68,6 @@ class Shrine
 
         def spawn_thread
           Thread.new do
-            Thread.current.abort_on_exception = true
             loop do
               task = @tasks.deq(true) rescue break
               task.call

data/lib/shrine/plugins/presign_endpoint.rb

@@ -37,7 +37,7 @@ class Shrine
     # uploads to the temporary (`:cache`) storage.
     #
     # The above will create a `GET /images/presign` endpoint, which calls
-    # `#presign` on the storage and returns the HTTP verb, URL, fields, and
+    # `#presign` on the storage and returns the HTTP verb, URL, params, and
     # headers needed for a single upload directly to the storage service, in
     # JSON format.
     #
@@ -56,11 +56,6 @@ class Shrine
     #       "headers": {}
     #     }
     #
-    # * `method` – HTTP verb
-    # * `url` – request URL
-    # * `fields` – POST parameters
-    # * `headers` – request headers
-    #
     # ## Location
     #
     # By default the generated location won't have any file extension, but you

data/lib/shrine/plugins/processing.rb

@@ -34,15 +34,11 @@ class Shrine
     #     require "image_processing/mini_magick"
     #
     #     process(:store) do |io, context|
-    #       original = io.download
-    #
-    #       resized = ImageProcessing::MiniMagick
-    #         .source(original)
-    #         .resize_to_limit!(800, 800)
-    #
-    #       original.close!
-    #
-    #       resized
+    #       io.download do |original|
+    #         ImageProcessing::MiniMagick
+    #           .source(original)
+    #           .resize_to_limit!(800, 800)
+    #       end
     #     end
     #
     # The declarations are additive and inheritable, so for the same action you

data/lib/shrine/plugins/rack_response.rb

@@ -79,7 +79,7 @@ class Shrine
         # metadata. Also returns the correct "Content-Range" header on ranged
         # requests.
         def rack_headers(disposition:, range: false)
-          length   = range ? range.end - range.begin + 1 : size || io.size
+          length   = range ? range.size : size || io.size
           type     = mime_type || Rack::Mime.mime_type(".#{extension}")
           filename = original_filename || id.split("/").last
 

data/lib/shrine/plugins/remote_url.rb

@@ -28,6 +28,13 @@ class Shrine
     # around the `open-uri` standard library. Note that Down expects the given
     # URL to be URI-encoded.
     #
+    # ## Dynamic options
+    #
+    # You can dynamically pass options to the downloader by using
+    # `Attacher#assign_remote_url`:
+    #
+    #     attacher.assign_remote_url("http://example.com/cool-image.png", downloader: { 'Authorization' => 'Basic ...' })
+    #
     # ## Maximum size
     #
     # It's a good practice to limit the maximum filesize of the remote file:
@@ -50,8 +57,10 @@ class Shrine
     #
     #     require "down/http"
     #
-    #     plugin :remote_url, max_size: 20*1024*1024, downloader: ->(url, max_size:) do
-    #       Down::Http.download(url, max_size: max_size, follow: { max_hops: 4 }, timeout: { read: 3 })
+    #     plugin :remote_url, max_size: 20*1024*1024, downloader: -> (url, max_size:, **options) do
+    #       Down::Http.download(url, max_size: max_size, **options) do |http|
+    #         http.follow(max_hops: 2).timeout(connect: 2, read: 2)
+    #       end
     #     end
     #
     # ## Errors
@@ -60,7 +69,7 @@ class Shrine
     # equal to the error message. You can change the default error message:
     #
     #     plugin :remote_url, error_message: "download failed"
-    #     plugin :remote_url, error_message: ->(url, error) { I18n.t("errors.download_failed") }
+    #     plugin :remote_url, error_message: -> (url, error) { I18n.t("errors.download_failed") }
     #
     # ## Background
     #
@@ -109,11 +118,11 @@ class Shrine
         # Downloads the remote file and assigns it. If download failed, sets
         # the error message and assigns the url to an instance variable so that
         # it shows up in the form.
-        def remote_url=(url)
-          return if url == ""
+        def assign_remote_url(url, downloader: {})
+          return if url == "" || url.nil?
 
           begin
-            downloaded_file = download(url)
+            downloaded_file = download(url, downloader)
           rescue => error
             download_error = error
           end
@@ -127,6 +136,11 @@ class Shrine
           end
         end
 
+        # Alias for #assign_remote_url.
+        def remote_url=(url)
+          assign_remote_url(url)
+        end
+
         # Form builders require the reader as well.
         def remote_url
           @remote_url
@@ -137,18 +151,18 @@ class Shrine
         # Downloads the file using the "down" gem or a custom downloader.
         # Checks the file size and terminates the download early if the file
         # is too big.
-        def download(url)
+        def download(url, options)
           downloader = shrine_class.opts[:remote_url_downloader]
           downloader = method(:"download_with_#{downloader}") if downloader.is_a?(Symbol)
           max_size = shrine_class.opts[:remote_url_max_size]
 
-          downloader.call(url, max_size: max_size)
+          downloader.call(url, { max_size: max_size }.merge(options))
         end
 
         # We silence any download errors, because for the user's point of view
         # the download simply failed.
-        def download_with_open_uri(url, max_size:)
-          Down.download(url, max_size: max_size)
+        def download_with_open_uri(url, options)
+          Down.download(url, options)
         end
 
         def download_error_message(url, error)

data/lib/shrine/plugins/signature.rb

@@ -75,8 +75,7 @@ class Shrine
           hash = send(:"calculate_#{algorithm}", io)
           io.rewind
 
-          encoded_hash = send(:"encode_#{format}", hash)
-          encoded_hash
+          send(:"encode_#{format}", hash)
         end
 
         private

data/lib/shrine/plugins/validation_helpers.rb

@@ -44,8 +44,8 @@ class Shrine
       end
 
       DEFAULT_MESSAGES = {
-        max_size: ->(max) { "is too large (max is #{max.to_f/1024/1024} MB)" },
-        min_size: ->(min) { "is too small (min is #{min.to_f/1024/1024} MB)" },
+        max_size: ->(max) { "is too large (max is #{PRETTY_FILESIZE.call(max)})" },
+        min_size: ->(min) { "is too small (min is #{PRETTY_FILESIZE.call(min)})" },
         max_width: ->(max) { "is too wide (max is #{max} px)" },
         min_width: ->(min) { "is too narrow (min is #{min} px)" },
         max_height: ->(max) { "is too tall (max is #{max} px)" },
@@ -56,6 +56,19 @@ class Shrine
         extension_exclusion: ->(list) { "is of forbidden format" },
       }
 
+      FILESIZE_UNITS = ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"].freeze
+
+      # Returns filesize in a human readable format with units.
+      # Uses the binary JEDEC unit system, i.e. 1.0 KB = 1024 bytes
+      PRETTY_FILESIZE = lambda do |bytes|
+        return "0.0 B" if bytes == 0
+
+        exp = Math.log(bytes, 1024).floor
+        max_exp = FILESIZE_UNITS.length - 1
+        exp = max_exp if exp > max_exp
+        "%.1f %s" % [bytes.to_f / 1024 ** exp, FILESIZE_UNITS[exp]]
+      end
+
       module AttacherClassMethods
         def default_validation_messages
           @default_validation_messages ||= DEFAULT_MESSAGES.merge(

data/lib/shrine/plugins/versions.rb

@@ -15,16 +15,17 @@ class Shrine
     #     plugin :processing
     #
     #     process(:store) do |io, context|
-    #       original = io.download
-    #       pipeline = ImageProcessing::MiniMagick.source(original)
+    #       versions = { original: io } # retain original
     #
-    #       size_800 = pipeline.resize_to_limit!(800, 800)
-    #       size_500 = pipeline.resize_to_limit!(500, 500)
-    #       size_300 = pipeline.resize_to_limit!(300, 300)
+    #       io.download do |original|
+    #         pipeline = ImageProcessing::MiniMagick.source(original)
     #
-    #       original.close!
+    #         versions[:large]  = pipeline.resize_to_limit!(800, 800)
+    #         versions[:medium] = pipeline.resize_to_limit!(500, 500)
+    #         versions[:small]  = pipeline.resize_to_limit!(300, 300)
+    #       end
     #
-    #       { original: io, large: size_800, medium: size_500, small: size_300}
+    #       versions # return the hash of processed files
     #     end
     #
     # You probably want to load the `delete_raw` plugin to automatically
@@ -105,17 +106,18 @@ class Shrine
     # example, you might want to split a PDf into pages:
     #
     #     process(:store) do |io, context|
-    #       pdf        = io.download
-    #       page_count = MiniMagick::Image.new(pdf.path).pages.count
-    #       pipeline   = ImageProcessing::MiniMagick.source(pdf).convert("jpg")
+    #       versions = { pages: [] }
     #
-    #       pages = page_count.times.map do |page_number|
-    #         pipeline.loader(page: page_number).call
-    #       end
+    #       io.download do |pdf|
+    #         page_count = MiniMagick::Image.new(pdf.path).pages.count
+    #         pipeline   = ImageProcessing::MiniMagick.source(pdf).convert("jpg")
     #
-    #       pdf.close!
+    #         page_count.times do |page_number|
+    #           versions[:pages] << pipeline.loader(page: page_number).call
+    #         end
+    #       end
     #
-    #       { pages: pages } # array of pages
+    #       versions
     #     end
     #
     # You can also combine Hashes and Arrays, there is no limit to the level of
@@ -286,13 +288,7 @@ class Shrine
           shrine_class.opts[:versions_fallback_to_original]
         end
 
-        def assign_cached(value)
-          cached_file = uploaded_file(value)
-          Shrine.deprecation("Assigning cached hash of files is deprecated for security reasons and will be removed in Shrine 3.") if cached_file.is_a?(Hash) || cached_file.is_a?(Array)
-          super(cached_file)
-        end
-
-        # Converts the Hash of UploadedFile objects into a Hash of data.
+        # Converts the Hash/Array of UploadedFile objects into a Hash/Array of data.
         def convert_to_data(object)
           if object.is_a?(Hash)
             object.inject({}) do |hash, (name, value)|

data/lib/shrine/storage/file_system.rb

@@ -151,9 +151,10 @@ class Shrine
           (io.is_a?(UploadedFile) && io.storage.is_a?(Storage::FileSystem))
       end
 
-      # Opens the file on the given location in read mode.
-      def open(id, &block)
-        path(id).open("rb", &block)
+      # Opens the file on the given location in read mode. Accepts additional
+      # `File.open` arguments.
+      def open(id, *args, &block)
+        path(id).open("rb", *args, &block)
       end
 
       # Returns true if the file exists on the filesystem.

data/lib/shrine/storage/s3.rb

@@ -31,10 +31,10 @@ class Shrine
     # It can be initialized by providing the bucket name and credentials:
     #
     #     s3 = Shrine::Storage::S3.new(
+    #       bucket: "my-app", # required
     #       access_key_id: "abc",
     #       secret_access_key: "xyz",
     #       region: "eu-west-1",
-    #       bucket: "my-app",
     #     )
     #
     # The core features of this storage requires the following AWS permissions:
@@ -264,8 +264,9 @@ class Shrine
         end
       end
 
-      # Downloads the file from S3, and returns a `Tempfile`. Any additional
-      # options are forwarded to [`Aws::S3::Object#get`].
+      # Downloads the file from S3 and returns a `Tempfile`. The download will
+      # be automatically retried up to 3 times. Any additional options are
+      # forwarded to [`Aws::S3::Object#get`].
       #
       # [`Aws::S3::Object#get`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#get-instance_method
       def download(id, **options)
@@ -279,13 +280,21 @@ class Shrine
         raise
       end
 
-      # Returns a `Down::ChunkedIO` object representing the S3 object. Any
-      # additional options are forwarded to [`Aws::S3::Object#get`].
+      # Returns a `Down::ChunkedIO` object that downloads S3 object content
+      # on-demand. By default, read content will be cached onto disk so that
+      # it can be rewinded, but if you don't need that you can pass
+      # `rewindable: false`.
+      #
+      # Any additional options are forwarded to [`Aws::S3::Object#get`].
       #
       # [`Aws::S3::Object#get`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#get-instance_method
-      def open(id, **options)
+      def open(id, rewindable: true, **options)
         object = object(id)
-        io = Down::ChunkedIO.new(chunks: object.enum_for(:get, **options), data: { object: object })
+        io = Down::ChunkedIO.new(
+          chunks:     object.enum_for(:get, **options),
+          rewindable: rewindable,
+          data:       { object: object },
+        )
         io.size = object.content_length
         io
       end
@@ -430,7 +439,7 @@ class Shrine
           object(id).upload_file(path, **options)
           File.size(path)
         else
-          io.open if io.is_a?(UploadedFile)
+          io.to_io if io.is_a?(UploadedFile) # open if not already opened
 
           if io.respond_to?(:size) && io.size
             object(id).put(body: io, **options)
@@ -506,13 +515,12 @@ class Shrine
 
         # Uploads at most 5MB of IO content into a single multipart part.
         def upload_part(multipart_upload, io, part_number)
-          Tempfile.create("shrine-s3-part-#{part_number}") do |body|
-            multipart_part = multipart_upload.part(part_number)
-
+          Tempfile.create("shrine-s3-part-#{part_number}", binmode: true) do |body|
             IO.copy_stream(io, body, MIN_PART_SIZE)
             body.rewind
 
-            response = multipart_part.upload(body: body)
+            multipart_part = multipart_upload.part(part_number)
+            response       = multipart_part.upload(body: body)
 
             { part_number: part_number, size: body.size, etag: response.etag }
           end

data/lib/shrine/version.rb

@@ -7,7 +7,7 @@ class Shrine
 
   module VERSION
     MAJOR = 2
-    MINOR = 11
+    MINOR = 12
     TINY  = 0
     PRE   = nil
 

data/shrine.gemspec

@@ -45,16 +45,22 @@ direct uploads for fully asynchronous user experience.
   gem.add_development_dependency "mini_magick", "~> 4.0" unless ENV["CI"]
   gem.add_development_dependency "ruby-vips", "~> 2.0" unless ENV["CI"]
   gem.add_development_dependency "aws-sdk-s3", "~> 1.2"
+  gem.add_development_dependency "aws-sdk-core", "~> 3.23"
 
   unless RUBY_ENGINE == "jruby" || ENV["CI"]
     gem.add_development_dependency "ruby-filemagic", "~> 0.7"
   end
 
   gem.add_development_dependency "sequel"
-  gem.add_development_dependency "activerecord", "~> 4.2"
+
+  if RUBY_VERSION >= "2.2.2"
+    gem.add_development_dependency "activerecord", "~> 5.0"
+  else
+    gem.add_development_dependency "activerecord", "~> 4.2"
+  end
 
   if RUBY_ENGINE == "jruby"
-    gem.add_development_dependency "activerecord-jdbcsqlite3-adapter", "1.3.24"
+    gem.add_development_dependency "activerecord-jdbcsqlite3-adapter", "51"
   else
     gem.add_development_dependency "sqlite3"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -248,6 +248,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
 - !ruby/object:Gem::Dependency
   name: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
@@ -282,14 +296,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement