tus-server 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8315eaaeabacbc5351b82d8b5838c293e4f6e1e4
-  data.tar.gz: 3cce2414c7807e141d8373e74616df61a98a1947
+  metadata.gz: 75d994c5e03d4027f723c3bb32dc17589e1fe6bc
+  data.tar.gz: 300bcd61d11c05963fea1d6e02f4684b35a3a8e7
 SHA512:
-  metadata.gz: b03e67d013332433940a45ec00d972afe18336c2612f3735bb0ac8f301fad7407e1be13b9cc2c97538fab28cb5fa109c96d3620c8fbc30478f3dee9a1e4b79d5
-  data.tar.gz: 3cfdc95034e79c511bbcdf0d67e5000c568c7e6a05f7f1e32d7271354d9ed7b7efc42c29fcda34da4926fa1a70f1f49c4b8126f2de9b472ad5cb025b84964bbd
+  metadata.gz: f3e9d86ff10b063367dda70bd44bc38d8f56485fabfaa209f7f341ebd7c87b7cd3f0cf4e40855e142577c0e40cde763effe349fc54ed8bc2e7c93046eac566cb
+  data.tar.gz: 63e466d8dc751465871cd74d951357fc3918cb8ef0a60a35124dd88b452141be1a4c5e057c7a3944208ca4e039c76f555df86e319f63a75aeb188e6df65a5986

data/README.md

@@ -86,19 +86,50 @@ end
 $ ruby tus.rb --stdout # enable logging
 ```
 
+This will run the tus server app on the root URL; if you want to run it on some
+path you can use `Rack::Builder`:
+
+```rb
+class GoliathTusServer < Goliath::RackProxy
+  rack_app Rack::Builder.new {
+    map "/files" do
+      run Tus::Server
+    end
+  }
+  rewindable_input false # set to true if you're using checksums
+end
+```
+
 ### Unicorn
 
 Like Goliath, Unicorn also support streaming uploads, and tus-ruby-server knows
 how to automatically recover from `Unicorn::ClientShutdown` exceptions during
 upload, storing data that it has received up until that point. Just note that
 in order to achieve streaming uploads, Nginx should be configured **not** to
-buffer incoming requests.
+buffer incoming requests, and to disable worker timeout to enable long running
+upload requests:
+
+```rb
+timeout 60*60*24*30 # set worker timeout to 30 days
+```
 
 But it's also fine to have Nginx buffer requests, just note that in this case
 Nginx won't forward incomplete upload requests to tus-ruby-server, so in order
 for resumable upload to be possible the client needs to send data in multiple
 upload requests (which can then be retried individually).
 
+Unless you're using the "checksum" tus feature, you might want to consider
+disabling rewindability of request body, to prevent Unicorn from additionally
+caching received data onto the disk (since that's not necessary unless request
+body needs to be rewinded).
+
+```rb
+# config/unicorn.rb
+# ...
+
+rewindable_input false
+```
+
 ### Other web servers
 
 It's perfectly feasible to run tus-ruby-server on web servers other than
@@ -179,10 +210,10 @@ chunks, meaning the length of each partial upload needs to be a multiple of the
 
 Amazon S3 is probably one of the most popular services for storing files, and
 tus-ruby-server ships with `Tus::Storage::S3` which utilizes S3's multipart API
-to upload files, and depends on the [aws-sdk] gem.
+to upload files, and depends on the [aws-sdk-s3] gem.
 
 ```rb
-gem "aws-sdk", "~> 2.1"
+gem "aws-sdk-s3", "~> 1.2"
 ```
 
 ```rb
@@ -328,9 +359,9 @@ The tus-ruby-server was inspired by [rubytus].
 [Shrine]: https://github.com/janko-m/shrine
 [trailing headers]: https://tools.ietf.org/html/rfc7230#section-4.1.2
 [rubytus]: https://github.com/picocandy/rubytus
-[aws-sdk]: https://github.com/aws/aws-sdk-ruby
-[`Aws::S3::Client#initialize`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html#initialize-instance_method
-[`Aws::S3::Client#create_multipart_upload`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Client.html#create_multipart_upload-instance_method
+[aws-sdk-s3]: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-s3
+[`Aws::S3::Client#initialize`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#initialize-instance_method
+[`Aws::S3::Client#create_multipart_upload`]: http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/S3/Client.html#create_multipart_upload-instance_method
 [Range requests]: https://tools.ietf.org/html/rfc7233
 [Goliath]: https://github.com/postrank-labs/goliath
 [EventMachine]: https://github.com/eventmachine/eventmachine

data/lib/tus/storage/s3.rb

@@ -1,5 +1,13 @@
 # frozen-string-literal: true
-require "aws-sdk"
+begin
+  require "aws-sdk-s3"
+  if Gem::Version.new(Aws::S3::GEM_VERSION) < Gem::Version.new("1.2.0")
+    raise "Tus::Storage::S3 requires aws-sdk-s3 version 1.2.0 or above"
+  end
+rescue LoadError
+  require "aws-sdk"
+  Aws.eager_autoload!(services: ["S3"])
+end
 
 require "tus/info"
 require "tus/errors"
@@ -9,8 +17,6 @@ require "cgi"
 require "fiber"
 require "stringio"
 
-Aws.eager_autoload!(services: ["S3"])
-
 module Tus
   module Storage
     class S3
@@ -35,7 +41,7 @@ module Tus
         options[:content_type] = tus_info.metadata["content_type"]
 
         if filename = tus_info.metadata["filename"]
-          # Aws-sdk doesn't sign non-ASCII characters correctly, and browsers
+          # Aws-sdk-s3 doesn't sign non-ASCII characters correctly, and browsers
           # will automatically URI-decode filenames.
           filename = CGI.escape(filename).gsub("+", " ")
 

data/tus-server.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name         = "tus-server"
-  gem.version      = "1.1.1"
+  gem.version      = "1.1.2"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -22,7 +22,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "cucumber"
   gem.add_development_dependency "unicorn"
   gem.add_development_dependency "mongo"
-  gem.add_development_dependency "aws-sdk", "~> 2.0"
-  gem.add_development_dependency "goliath"
-  gem.add_development_dependency "async-rack", ">= 0.5.1"
+  gem.add_development_dependency "aws-sdk-s3", "~> 1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tus-server
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-23 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -109,47 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: goliath
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: async-rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '1.2'
 description: 
 email:
 - janko.marohnic@gmail.com
@@ -190,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby server implementation of tus.io, the open protocol for resumable file