shrine 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6d199c94a3b0f6454d8423cc1ae63e31c78979328b064364abc8119ce9c98b
-  data.tar.gz: c384cee91997dfa2927938d959362982274adf6befc1ffe1d98be6605f4c4206
+  metadata.gz: 6a54ce86ad9f430b7c0896fa83db280316dd3e48a27bff320445b561b966bdcd
+  data.tar.gz: 2924f5048e3ff3991d49da834000564612eba1749576c7ea42cf446cb025c7ed
 SHA512:
-  metadata.gz: 904c4b61e43102efbc95dbfff02e16af95df2d88fd2ce68a29fa54dff82e512f5801f671eb865527ed892fd34905448871fb120e6133955d20d87f5568c3f5d7
-  data.tar.gz: e7742141f3693e862a5d13aa0752b59820415ca9bbf62674842730b3962a1452b71c33ea631dd65bec9e0b16aef189387bb545d958edeb80e707d506385e8c3f
+  metadata.gz: 7a0e9566b2b6b7a78c2a85019108147bcd071b46cef63fb1cdc848ee1fb1a8cf086afce8bf62d966e88cbeefe35d4437d471c7a7180a8abd34682d47fe62b60b
+  data.tar.gz: 013cb42c24c2af94c2aa84344c5ce9e07e6001dfb56a06e2b6f4c4805969c4fa2d45421a455e34d1ec9290607c5ffebddd0114d91871cd99e84b6623cb65527e

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+## 2.16.0 (2019-02-18)
+
+* `derivation_endpoint` – Add `:upload_open_options` for download option for derivation result (@janko)
+
+* `derivation_endpoint` – Fix `:upload` option being incompatible with `delete_raw` plugin (@janko)
+
+* `derivation_endpoint` – Require input file in `Derivation#upload` to respond to `#path` (@janko)
+
+* `derivation_endpoint` – Delete generated derivation result after uploading in `Derivation#upload` (@janko)
+
+* `derivation_endpoint` – Fix `Derivation#processed` breaking when derivation result is a `File` object (@janko)
+
+* `derivation_endpoint` – Don't close input file on `Derivation#upload` (@janko)
+
+* Add `:delete` parameter for skipping delete when `delete_raw` plugin is loaded (@janko)
+
+* Don't return `Content-Type` when it couldn't be determined from file extension in `derivation_endpoint` (@janko)
+
+* Add `:download_options` option to `download_endpoint` plugin for specifying options for `Storage#open` (@janko)
+
+* Don't return `Content-Type` header in `rack_response` when MIME type could not be determined (@janko)
+
+* Open the `UploadedFile` object in `#to_rack_response` in `rack_response` plugin (@janko)
+
+* Fix `store_dimensions` plugin making second argument in `Shrine#extract_metadata` mandatory (@jrochkind)
+
 ## 2.15.0 (2019-02-08)
 
 * Add `derivation_endpoint` plugin for processing uploaded files on-the-fly (@janko)

data/doc/advantages.md

@@ -181,6 +181,10 @@ class ImageUploader < Shrine
   end
 end
 ```
+```rb
+photo.image_url(:large)
+#=> "https://s3.amazonaws.com/path/to/large.jpg"
+```
 
 or generate thumbnails on-demand:
 

data/doc/plugins/activerecord.md

@@ -1,7 +1,7 @@
 # Active Record
 
-The `activerecord` plugin extends the "attachment" interface with support for
-ActiveRecord.
+The [`activerecord`][activerecord] plugin extends the "attachment" interface
+with support for ActiveRecord.
 
 ```rb
 plugin :activerecord
@@ -89,4 +89,5 @@ model errors, you can disable it:
 plugin :activerecord, validations: false
 ```
 
+[activerecord]: /lib/shrine/plugins/activerecord.rb
 [bug with transaction callbacks]: https://github.com/rails/rails/issues/14493

data/doc/plugins/add_metadata.md

@@ -1,7 +1,7 @@
 # Add Metadata
 
-The `add_metadata` plugin provides a convenient method for extracting and
-adding custom metadata values.
+The [`add_metadata`][add_metadata] plugin provides a convenient method for
+extracting and adding custom metadata values.
 
 ```rb
 plugin :add_metadata
@@ -91,3 +91,5 @@ add_metadata :bar do |io, context|
   "bar"
 end
 ```
+
+[add_metadata]: /lib/shrine/plugins/add_metadata.rb

data/doc/plugins/backgrounding.md

@@ -1,9 +1,9 @@
 # Backgrounding
 
-The `backgrounding` plugin enables you to move promoting and deleting of files
-from record's lifecycle into background jobs. This is especially useful if
-you're doing processing and/or you're storing files on an external storage
-service.
+The [`backgrounding`][backgrounding] plugin enables you to move promoting and
+deleting of files from record's lifecycle into background jobs. This is
+especially useful if you're doing processing and/or you're storing files on an
+external storage service.
 
 The plugin provides `Attacher.promote` and `Attacher.delete` methods, which
 allow you to hook up to promoting and deleting and spawn background jobs, by
@@ -146,3 +146,5 @@ class SomethingJob
   end
 end
 ```
+
+[backgrounding]: /lib/shrine/plugins/backgrounding.rb

data/doc/plugins/backup.md

@@ -1,7 +1,7 @@
 # Backup
 
-The `backup` plugin allows you to automatically back up stored files to an
-additional storage.
+The [`backup`][backup] plugin allows you to automatically back up stored files
+to an additional storage.
 
 ```rb
 storages[:backup_store] = Shrine::Storage::S3.new(options)
@@ -27,3 +27,5 @@ Note that when adding this plugin with already existing stored files, Shrine
 won't know whether a stored file is backed up or not, so attempting to delete
 the backup could result in an error. To avoid that you can set `delete: false`
 until you manually back up the existing stored files.
+
+[backup]: /lib/shrine/plugins/backup.rb

data/doc/plugins/cached_attachment_data.md

@@ -1,8 +1,8 @@
 # Cached Attachment Data
 
-The `cached_attachment_data` plugin adds the ability to retain the cached file
-across form redisplays, which means the file doesn't have to be reuploaded in
-case of validation errors.
+The [`cached_attachment_data`][cached_attachment_data] plugin adds the ability
+to retain the cached file across form redisplays, which means the file doesn't
+have to be reuploaded in case of validation errors.
 
 ```rb
 plugin :cached_attachment_data
@@ -21,3 +21,5 @@ This method delegates to `Attacher#read_cached`:
 ```rb
 attacher.read_cached #=> '{"id":"38k25.jpg","storage":"cache","metadata":{...}}'
 ```
+
+[cached_attachment_data]: /lib/shrine/plugins/cached_attachment_data.rb

data/doc/plugins/copy.md

@@ -1,6 +1,6 @@
 # Copy
 
-The `copy` plugin allows copying attachment from one record to another.
+The [`copy`][copy] plugin allows copying attachment from one record to another.
 
 ```rb
 plugin :copy
@@ -20,3 +20,5 @@ duplicated_photo = photo.dup
 duplicated_photo.image #=> #<Shrine::UploadedFile>
 duplicated_photo.image != photo.image
 ```
+
+[copy]: /lib/shrine/plugins/copy.rb

data/doc/plugins/data_uri.md

@@ -1,7 +1,7 @@
 # Data URI
 
-The `data_uri` plugin enables you to upload files as [data URIs]. This plugin
-is useful for example when using [HTML5 Canvas].
+The [`data_uri`][data_uri] plugin enables you to upload files as [data URIs].
+This plugin is useful for example when using [HTML5 Canvas].
 
 ```rb
 plugin :data_uri
@@ -88,5 +88,6 @@ uploaded_file.data_uri #=> "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA"
 uploaded_file.base64   #=> "iVBORw0KGgoAAAANSUhEUgAAAAUA"
 ```
 
+[data_uri]: /lib/shrine/plugins/data_uri.rb
 [data URIs]: https://tools.ietf.org/html/rfc2397
 [HTML5 Canvas]: https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API

data/doc/plugins/default_storage.md

@@ -1,7 +1,8 @@
 # Default Storage
 
-The `default_storage` plugin enables you to change which storages are going to
-be used for this uploader's attacher (the default is `:cache` and `:store`).
+The [`default_storage`][default_storage] plugin enables you to change which
+storages are going to be used for this uploader's attacher (the default is
+`:cache` and `:store`).
 
 ```rb
 plugin :default_storage, cache: :special_cache, store: :special_store
@@ -14,3 +15,5 @@ and the name of the attachment. This is useful if you're using the
 ```rb
 plugin :default_storage, store: ->(record, name) { :"store_#{record.username}" }
 ```
+
+[default_storage]: /lib/shrine/plugins/default_storage.rb

data/doc/plugins/default_url.md

@@ -1,7 +1,7 @@
 # Default URL
 
-The `default_url` plugin allows setting the URL which will be returned when the
-attachment is missing.
+The [`default_url`][default_url] plugin allows setting the URL which will be
+returned when the attachment is missing.
 
 ```rb
 plugin :default_url
@@ -31,3 +31,5 @@ Attacher.default_url do |options|
   record #=> #<User>
 end
 ```
+
+[default_url]: /lib/shrine/plugins/default_url.rb

data/doc/plugins/default_url_options.md

@@ -1,7 +1,8 @@
 # Default URL Options
 
-The `default_url_options` plugin allows you to specify URL options that will be
-applied by default for uploaded files of specified storages.
+The [`default_url_options`][default_url_options] plugin allows you to specify
+URL options that will be applied by default for uploaded files of specified
+storages.
 
 ```rb
 plugin :default_url_options, store: { download: true }
@@ -20,3 +21,5 @@ end
 In both cases the default options are merged with options passed to
 `UploadedFile#url`, and the latter will always have precedence over default
 options.
+
+[default_url_options]: /lib/shrine/plugins/default_url_options.rb

data/doc/plugins/delete_promoted.md

@@ -1,10 +1,12 @@
 # Delete Promoted
 
-The `delete_promoted` plugin deletes files that have been promoted, after the
-record is saved. This means that cached files handled by the attacher will
-automatically get deleted once they're uploaded to store. This also applies to
-any other uploaded file passed to `Attacher#promote`.
+The [`delete_promoted`][delete_promoted] plugin deletes files that have been
+promoted, after the record is saved. This means that cached files handled by
+the attacher will automatically get deleted once they're uploaded to store.
+This also applies to any other uploaded file passed to `Attacher#promote`.
 
 ```rb
 plugin :delete_promoted
 ```
+
+[delete_promoted]: /lib/shrine/plugins/delete_promoted.rb

data/doc/plugins/delete_raw.md

@@ -1,8 +1,8 @@
 # Delete Raw
 
-The `delete_raw` plugin will automatically delete raw files that have been
-uploaded. This is especially useful when doing processing, to ensure that
-temporary files have been deleted after upload.
+The [`delete_raw`][delete_raw] plugin will automatically delete raw files that
+have been uploaded. This is especially useful when doing processing, to ensure
+that temporary files have been deleted after upload.
 
 ```rb
 plugin :delete_raw
@@ -14,3 +14,12 @@ this only to files uploaded to certain storages:
 ```rb
 plugin :delete_raw, storages: [:store]
 ```
+
+If you want to skip deletion for a certain upload, you can pass `delete: false`
+to the uploader:
+
+```rb
+uploader.upload(file, delete: false)
+```
+
+[delete_raw]: /lib/shrine/plugins/delete_raw.rb

data/doc/plugins/derivation_endpoint.md

@@ -1,8 +1,9 @@
 # Derivation Endpoint
 
-The `derivation_endpoint` plugin provides a Rack app for dynamically processing
-uploaded files on request. This allows you to create URLs to files that might
-not have been generated yet, and have the endpoint process them on-the-fly.
+The [`derivation_endpoint`][derivation_endpoint] plugin provides a Rack app for
+dynamically processing uploaded files on request. This allows you to create
+URLs to files that might not have been generated yet, and have the endpoint
+process them on-the-fly.
 
 ## Quick start
 
@@ -349,9 +350,9 @@ uploaded_file.derivation_url(:webp, type: "image/webp")
 ### Content Disposition
 
 The derivation response includes the [`Content-Disposition`] header. By default
-the disposition is set to `inline`, while the download filename is generated
-from derivation name, arguments and source file id. These values can be changed
-with the `:disposition` and `:filename` options:
+the disposition is set to `inline`, with download filename generated from
+derivation name, arguments and source file id. These values can be changed with
+the `:disposition` and `:filename` options:
 
 ```rb
 plugin :derivation_endpoint,
@@ -434,6 +435,14 @@ plugin :derivation_endpoint, upload: true,
                              upload_options: { acl: "public-read" }
 ```
 
+Additional storage-specific download options for the uploaded derivation result
+can be passed via `:upload_open_options`:
+
+```rb
+plugin :derivation_endpoint, upload: true,
+                             upload_open_options: { response_content_encoding: "gzip" }
+```
+
 ### Redirecting
 
 You can configure the endpoint to redirect to the uploaded derivative on the
@@ -736,11 +745,13 @@ derivation.option(:upload_location)
 | `:upload`                      | Whether the generated derivatives will be cached on the storage                                                                       | `false`                                              |
 | `:upload_location`             | Location to which the derivatives will be uploaded on the storage                                                                     | `<source id>/<name>-<args>`                          |
 | `:upload_options`              | Additional options to be passed when uploading derivatives                                                                            | `{}`                                                 |
+| `:upload_open_options`         | Additional options to be passed when downloading the uploaded derivative                                                              | `{}`                                                 |
 | `:upload_redirect`             | Whether the derivation response should redirect to the uploaded derivative                                                            | `false`                                              |
 | `:upload_redirect_url_options` | Additional options to be passed when generating the URL for the uploaded derivative                                                   | `{}`                                                 |
 | `:upload_storage`              | Storage to which the derivations will be uploaded                                                                                     | same storage as the source file                      |
 | `:version`                     | Version number to append to the URL for cache busting                                                                                 | `nil`                                                |
 
+[derivation_endpoint]: /lib/shrine/plugins/derivation_endpoint.rb
 [ImageProcessing]: https://github.com/janko/image_processing
 [`Content-Type`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type
 [`Content-Disposition`]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition

data/doc/plugins/determine_mime_type.md

@@ -1,7 +1,7 @@
 # Determine MIME Type
 
-The `determine_mime_type` plugin allows you to determine and store the actual
-MIME type of the file analyzed from file content.
+The [`determine_mime_type`][determine_mime_type] plugin allows you to determine
+and store the actual MIME type of the file analyzed from file content.
 
 ```rb
 plugin :determine_mime_type
@@ -54,6 +54,7 @@ Shrine.mime_type_analyzers[:file].call(io) # calls a built-in analyzer
 #=> "image/jpeg"
 ```
 
+[determine_mime_type]: /lib/shrine/plugins/determine_mime_type.rb
 [file]: http://linux.die.net/man/1/file
 [Windows equivalent]: http://gnuwin32.sourceforge.net/packages/file.htm
 [ruby-filemagic]: https://github.com/blackwinter/ruby-filemagic

data/doc/plugins/direct_upload.md

@@ -3,8 +3,9 @@
 *[OBSOLETE] This plugin is obsolete, you should use `upload_endpoint` or
 `presign_endpoint` plugins instead.*
 
-The `direct_upload` plugin provides a Rack endpoint which can be used for
-uploading individual files asynchronously. It requires the [Roda] gem.
+The [`direct_upload`][direct_upload] plugin provides a Rack endpoint which can
+be used for uploading individual files asynchronously. It requires the [Roda]
+gem.
 
 ```rb
 plugin :direct_upload
@@ -164,6 +165,7 @@ Shrine::UploadEndpoint.use ShrineUploadMiddleware
 Upon subclassing uploader the upload endpoint is also subclassed. You can also
 call the plugin again in an uploader subclass to change its configuration.
 
+[direct_upload]: /lib/shrine/plugins/direct_upload.rb
 [Roda]: https://github.com/jeremyevans/roda
 [Uppy]: https://uppy.io
 [Roda request]: http://roda.jeremyevans.net/rdoc/classes/Roda/RodaPlugins/Base/RequestMethods.html

data/doc/plugins/download_endpoint.md

@@ -1,9 +1,9 @@
 # Download Endpoint
 
-The `download_endpoint` plugin provides a Rack app for downloading uploaded
-files from specified storages. This can be useful when files from your storage
-isn't accessible over URL (e.g. database storages) or if you want to
-authenticate your downloads. It requires the [Roda] gem.
+The [`download_endpoint`][download_endpoint] plugin provides a Rack app for
+downloading uploaded files from specified storages. This can be useful when
+files from your storage isn't accessible over URL (e.g. database storages) or
+if you want to authenticate your downloads. It requires the [Roda] gem.
 
 ```rb
 # Gemfile
@@ -59,6 +59,31 @@ uploaded_file.download_url(host: "http://example.com")
 #=> "http//example.com/attachments/eyJpZCI6ImFkdzlyeTM..."
 ```
 
+## Download options
+
+If you want to pass additional options to `Storage#open`, you can do so via
+`:download_options`:
+
+```rb
+plugin :download_endpoint, download_options: {
+  sse_customer_algorithm: "AES256",
+  sse_customer_key:       "secret_key",
+  sse_customer_key_md5:   "secret_key_md5",
+}
+```
+
+You can also specify a proc to generate download options dynamically:
+
+```rb
+plugin :download_enpdoint, download_options: -> (uploaded_file, request) {
+  {
+    sse_customer_algorithm: "AES256",
+    sse_customer_key:       "secret_key",
+    sse_customer_key_md5:   "secret_key_md5",
+  }
+}
+```
+
 ## Performance considerations
 
 Streaming files through the app might impact the request throughput, depending
@@ -69,9 +94,13 @@ Alternatively, you can have the endpoint redirect to the direct file URL:
 
 ```rb
 plugin :download_endpoint, redirect: true
-# or
+```
+
+You can also specify a proc to generate your own redirect URL:
+
+```rb
 plugin :download_endpoint, redirect: -> (uploaded_file, request) do
-  # return URL which the request will redirect to
+  uploaded_file.url(public: true)
 end
 ```
 
@@ -80,4 +109,15 @@ end
 If you want to have more control on download requests, you can use the
 `rack_response` plugin which this plugin uses internally.
 
+## Plugin options
+
+| Name                | Description                                                                       | Default  |
+| :--------           | :----------                                                                       | :------  |
+| `:disposition`      | Whether browser should render the file `inline` or download it as an `attachment` | `inline` |
+| `:download_options` | Hash of storage-specific options passed to `Storage#open`                         | `{}`     |
+| `:host`             | URL host that will be added to download URLs                                      | `nil`    |
+| `:prefix`           | Path prefix prepended to download URLs                                            | `nil`    |
+| `:redirect`         | Whether to redirect to uploaded files on the storage                              | `false`  |
+
+[download_endpoint]: /lib/shrine/plugins/download_endpoint.rb
 [Roda]: https://github.com/jeremyevans/roda

data/doc/plugins/dynamic_storage.md

@@ -1,7 +1,8 @@
 # Dynamic Storage
 
-The `dynamic_storage` plugin allows you to register a storage using a regex,
-and evaluate the storage class dynamically depending on the regex.
+The [`dynamic_storage`][dynamic_storage] plugin allows you to register a
+storage using a regex, and evaluate the storage class dynamically depending on
+the regex.
 
 Example:
 
@@ -18,3 +19,5 @@ name suffix. For example, `:store_foo` will use S3 storage which saves files to
 the bucket "foo". The block is yielded an instance of `MatchData`.
 
 This can be useful in combination with the `default_storage` plugin.
+
+[dynamic_storage]: /lib/shrine/plugins/dynamic_storage.rb