tus-server 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16cf0c007be7d383ca0bf2d4aefa6d6c477ac7d32b1905a8ad6c0413da233e57
-  data.tar.gz: 258d7d591fc1416468ea21ea42d29ed53f2a64eeade9e5293bdbecc3e5f6a599
+  metadata.gz: 69d128e57072bd02cb340fa74fadce8b325a8163bfae16d96acfa17770ae2bd1
+  data.tar.gz: 46fd5fba0d0fde85385564ad46aa1ad71ed16dcb84022d7947a7970ac1bf40e0
 SHA512:
-  metadata.gz: d642a6f120fd220af27bfc7cf8904459acafa6191934a4922913b10b296e0308cd3093223b39317ffb901318e83da2bcd3fa056cf7d2a36a2f7131ce18b8d8ca
-  data.tar.gz: c0bf56b77ee95fa1aab167f29fd38feabb1919f7e7d85b1c7705c5adbcba97f9612b5633880af9b603b433a3778518b7875bd5bfafff4f446c476d621c0b9c99
+  metadata.gz: 02df94c40fe475de5c3b9e23e0089a827aed7f8970a6c248abe8e64106b5d4babb5f957bfadfe7571e16eaf41ba50f0d5c3d9cfcdf63e8567cf0e9e79318ffec
+  data.tar.gz: 47d2d27bbb014e489d6393af0d5e03c2583f78cb4d913c0d19a664150754f7de4d77bf21313c24072538b11735ad10a98c45ec8daa6f84324a0dad331aa0dfc8

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.1 (2018-15-26)
+
+* Rename `:download_url` option to `:redirect_download` (@janko-m)
+
 ## 2.1.0 (2018-05-15)
 
 * Add `:download_url` server option for redirecting to a download URL (@janko-m)

data/README.md

@@ -24,7 +24,6 @@ main application. If you're using Rails, you can mount it in `config/routes.rb`:
 ```rb
 # config/routes.rb (Rails)
 Rails.application.routes.draw do
-  # ...
   mount Tus::Server => "/files"
 end
 ```
@@ -54,8 +53,10 @@ new tus.Upload(file, {
 
 By default uploaded files will be stored in the `data/` directory. After the
 upload is complete, you'll probably want to attach the uploaded file to a
-database record. [Shrine] is one file attachment library that integrates nicely
-with tus-ruby-server, see [shrine-tus-demo] for an example integration.
+database record. [Shrine] is currently the only file attachment library that
+integrates well with tus-ruby-server, see [this walkthrough][shrine resumable
+walkthrough] that adds resumable uploads from scratch, and for a complete
+example you can check out the [demo app][shrine-tus-demo].
 
 ### Goliath
 
@@ -174,9 +175,9 @@ If you're using Rails, you can enable the `Rack::Sendfile` middleware by
 setting the `config.action_dispatch.x_sendfile_header` value accordingly:
 
 ```rb
-config.action_dispatch.x_sendfile_header = "X-Sendfile" # Apache and lighttpd
+Rails.application.config.action_dispatch.x_sendfile_header = "X-Sendfile" # Apache and lighttpd
 # or
-config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # Nginx
+Rails.application.config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # Nginx
 ```
 
 Otherwise you can add the `Rack::Sendfile` middleware to the stack in
@@ -216,22 +217,22 @@ last to be **5MB or larger**, so that is the minimum chunk size that you can
 specify on your tus client if you want to use the S3 storage.
 
 If you'll be retrieving uploaded files through the tus server app, it's
-recommended to set `Tus::Server.opts[:download_url]` to `true`. This will avoid
-tus server downloading and serving the file from S3, and instead have the
+recommended to set `Tus::Server.opts[:redirect_download]` to `true`. This will
+avoid tus server downloading and serving the file from S3, and instead have the
 download endpoint redirect to the direct S3 object URL.
 
 ```rb
-Tus::Server.opts[:download_url] = true
+Tus::Server.opts[:redirect_download] = true
 ```
 
 You can customize how the S3 object URL is being generated by passing a block
-to `:download_url`, which will then be evaluated in the context of the
+to `:redirect_download`, which will then be evaluated in the context of the
 `Tus::Server` instance (which allows accessing the `request` object). See
 [`Aws::S3::Object#get`] for the list of options that
 `Tus::Storage::S3#file_url` accepts.
 
 ```rb
-Tus::Server.opts[:download_url] = -> (uid, info, **options) do
+Tus::Server.opts[:redirect_download] = -> (uid, info, **options) do
   storage.file_url(uid, info, response_expires: 10, **options) # link expires after 10 seconds
 end
 ```
@@ -386,6 +387,8 @@ $ bundle exec rake test # unit tests
 $ bundle exec cucumber  # acceptance tests
 ```
 
+Set `MONGO=1` environment variable if you want to also run MongoDB tests.
+
 ## Inspiration
 
 The tus-ruby-server was inspired by [rubytus].
@@ -416,3 +419,4 @@ The tus-ruby-server was inspired by [rubytus].
 [goliath-rack_proxy]: https://github.com/janko-m/goliath-rack_proxy
 [Rack::Sendfile]: https://www.rubydoc.info/github/rack/rack/master/Rack/Sendfile
 [`Aws::S3::Object#get`]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Object.html#get-instance_method
+[shrine resumable walkthrough]: https://github.com/shrinerb/shrine/wiki/Adding-Resumable-Uploads

data/lib/tus/server.rb

@@ -23,10 +23,10 @@ module Tus
     SUPPORTED_CHECKSUM_ALGORITHMS = %w[sha1 sha256 sha384 sha512 md5 crc32]
     RESUMABLE_CONTENT_TYPE = "application/offset+octet-stream"
 
-    opts[:max_size]        = nil
-    opts[:expiration_time] = 7*24*60*60
-    opts[:disposition]     = "inline"
-    opts[:download_url]    = nil
+    opts[:max_size]          = nil
+    opts[:expiration_time]   = 7*24*60*60
+    opts[:disposition]       = "inline"
+    opts[:redirect_download] = nil
 
     plugin :all_verbs
     plugin :default_headers, {"Content-Type" => ""}
@@ -168,11 +168,11 @@ module Tus
           content_disposition += "; filename=\"#{name}\"" if name
           content_type = type || "application/octet-stream"
 
-          if download_url
+          if redirect_download
             redirect_url = instance_exec(uid, info.to_h,
               content_type:        content_type,
               content_disposition: content_disposition,
-              &download_url)
+              &redirect_download)
 
             r.redirect redirect_url
           else
@@ -382,12 +382,17 @@ module Tus
       request.halt
     end
 
-    def download_url
-      if opts[:download_url] == true
-        storage.method(:file_url)
-      else
-        opts[:download_url]
+    def redirect_download
+      value = opts[:redirect_download]
+
+      if opts[:download_url]
+        value ||= opts[:download_url]
+        warn "[TUS-RUBY-SERVER DEPRECATION] The :download_url option has been renamed to :redirect_download."
       end
+
+      value = storage.method(:file_url) if value == true
+
+      value
     end
 
     def storage

data/tus-server.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name         = "tus-server"
-  gem.version      = "2.1.0"
+  gem.version      = "2.1.1"
 
   gem.required_ruby_version = ">= 2.2"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tus-server
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda