fast_send 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1df225aaf4d88c9a194879693f2469882fa1acc6
-  data.tar.gz: 8f5eaa3d4a6d4600f7ae01ed2bae972da10f1c3d
+  metadata.gz: ea16771c56f207d5c40555b4981d955e20724177
+  data.tar.gz: 691ef28f1a505a95c974c5060fc66eff6147ad22
 SHA512:
-  metadata.gz: 03e9b6a4439667c658de6cc7f9e377cadd50f7eed94dc4e085b2e5e8cd55f0944ac3794fdcaab1c68785408224fa6d8054ca1263cffa6d405c460c00ce65d7f2
-  data.tar.gz: ed25fcedadd280d9400415190b8c34aa1020f95d4caef80e9a5ead3ff3e3b662f6204ea5f18c9619f0b7b80daa963dadfcbba9b7e3bc59a7b1bcd8865e79e9fd
+  metadata.gz: a354a9e5b09f1d598147428351f824f39b42c1b29e48633ee334791bc68d3c95edc2bc551f2eb7087c8e29f37b20c9ff33360528f7424422e0de403575cda916
+  data.tar.gz: eae00df9f9beb28595c2de2023915245525a27892ed67e2b6ee192446e24822b9f80929051ad6f1bf1a8bb2ede2529bf3ae6364758db3166097ff8466d9ac7e3

data/.gitignore

@@ -0,0 +1,51 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+.ruby-version
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/Gemfile

@@ -1,9 +1,7 @@
 source 'https://rubygems.org'
 
+gemspec
+
 group :development do
-  gem 'rake'
-  gem 'jeweler', '> 2'
-  gem 'rspec', '~> 3'
-  gem 'puma'
   gem 'sendfile', platforms: :mri
 end

data/Rakefile

@@ -1,38 +1,5 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-require_relative 'lib/fast_send'
-Jeweler::Tasks.new do |gem|
-  gem.version = FastSend::VERSION
-  gem.name = "fast_send"
-  gem.homepage = "https://github.com/WeTransfer/fast_send"
-  gem.license = "MIT"
-  gem.description = %Q{Send bursts of large files quickly via Rack}
-  gem.summary = %Q{and do so bypassing the Ruby VM}
-  gem.email = "me@julik.nl"
-  gem.authors = ["Julik Tarkhanov"]
-  # dependencies defined in Gemfile
-end
-
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ["-c"]
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-task :default => :spec
 
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/fast_send.gemspec

@@ -1,13 +1,9 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 # stub: fast_send 1.1.2 ruby lib
-
+require File.dirname(__FILE__) + '/lib/fast_send/version'
 Gem::Specification.new do |s|
   s.name = "fast_send"
-  s.version = "1.1.2"
-
+  s.version = FastSend::VERSION
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
@@ -18,47 +14,14 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "config.ru",
-    "fast_send.gemspec",
-    "lib/fast_send.rb",
-    "lib/fast_send/null_logger.rb",
-    "lib/fast_send/socket_handler.rb",
-    "spec/fast_send_with_mocks_spec.rb",
-    "spec/fast_send_with_puma_spec.rb",
-    "spec/test_app.ru"
-  ]
+  s.files = `git ls-files -z`.split("\x0")
   s.homepage = "https://github.com/WeTransfer/fast_send"
   s.licenses = ["MIT"]
   s.rubygems_version = "2.4.5.1"
   s.summary = "and do so bypassing the Ruby VM"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["> 2"])
-      s.add_development_dependency(%q<rspec>, ["~> 3"])
-      s.add_development_dependency(%q<puma>, [">= 0"])
-      s.add_development_dependency(%q<sendfile>, [">= 0"])
-    else
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["> 2"])
-      s.add_dependency(%q<rspec>, ["~> 3"])
-      s.add_dependency(%q<puma>, [">= 0"])
-      s.add_dependency(%q<sendfile>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["> 2"])
-    s.add_dependency(%q<rspec>, ["~> 3"])
-    s.add_dependency(%q<puma>, [">= 0"])
-    s.add_dependency(%q<sendfile>, [">= 0"])
-  end
+  s.add_development_dependency("rake", [">= 0"])
+  s.add_development_dependency("rspec", ["~> 3"])
+  s.add_development_dependency("puma", [">= 0"])
+  s.add_development_dependency("sendfile", [">= 0"])
 end
-

data/lib/fast_send/socket_handler.rb

@@ -12,6 +12,10 @@ class FastSend::SocketHandler < Struct.new(:stream, :logger, :started_proc, :abo
   # Is raised when it is not possible to send a chunk of data
   # to the client using non-blocking sends for longer than the preset timeout
   SlowLoris = Class.new(StandardError)
+
+  # Exceptions that indicate a client being too slow or dropping out
+  # due to failing reads/writes
+  CLIENT_DISCONNECT_EXCEPTIONS = [SlowLoris] + ::FastSend::CLIENT_DISCONNECTS
   
   # Whether we are forced to use blocking IO for sendfile()
   USE_BLOCKING_SENDFILE = !!(RUBY_PLATFORM =~ /darwin/)
@@ -55,13 +59,14 @@ class FastSend::SocketHandler < Struct.new(:stream, :logger, :started_proc, :abo
       
       logger.info { "Response written in full - %d bytes" % bytes_written }
       done_proc.call(bytes_written)
-    rescue *client_disconnect_exeptions => e
+    rescue *CLIENT_DISCONNECT_EXCEPTIONS => e
       logger.warn { "Client closed connection: #{e.class}(#{e.message})" }
       aborted_proc.call(e)
     rescue Exception => e
-      logger.fatal { "Aborting response due to error: #{e.class}(#{e.message})" }
+      logger.fatal { "Aborting response due to error: #{e.class}(#{e.message}) and will propagate" }
       aborted_proc.call(e)
       error_proc.call(e)
+      raise e unless StandardError === e # Re-raise system errors, signals and other Exceptions
     ensure
       # With rack.hijack the consensus seems to be that the hijack
       # proc is responsible for closing the socket. We also use no-keepalive
@@ -71,14 +76,6 @@ class FastSend::SocketHandler < Struct.new(:stream, :logger, :started_proc, :abo
       cleanup_proc.call(bytes_written)
     end
   end
-  
-  # Returns an array of Exception classes we can rescue from (using a splat)
-  #
-  # @return [Array<Class>] the classes
-  def client_disconnect_exeptions
-    [SlowLoris] + ::FastSend::CLIENT_DISCONNECTS
-  end
-  
 
   # This is majorly useful - if the socket is not selectable after a certain
   # timeout, it might be a slow loris or a connection that hung up on us. So if
@@ -110,7 +107,7 @@ class FastSend::SocketHandler < Struct.new(:stream, :logger, :started_proc, :abo
   #
   # @param socket[Socket] the socket to write to
   # @param file[File] the IO you can read from
-  # @yields num_bytes_written[Fixnum] the number of bytes written on each `IO.copy_stream() call`
+  # @yields num_bytes_written[Integer] the number of bytes written on each `IO.copy_stream() call`
   # @return [void]
   def sendfile(socket, file)
     chunk = SENDFILE_CHUNK_SIZE
@@ -152,7 +149,7 @@ class FastSend::SocketHandler < Struct.new(:stream, :logger, :started_proc, :abo
   #
   # @param socket[Socket] the socket to write to
   # @param file[File] the IO you can read from
-  # @yields num_bytes_written[Fixnum] the number of bytes written on each `IO.copy_stream() call`
+  # @yields num_bytes_written[Integer] the number of bytes written on each `IO.copy_stream() call`
   # @return [void]
   def copy_stream(socket, file)
     chunk = SENDFILE_CHUNK_SIZE
@@ -177,7 +174,7 @@ class FastSend::SocketHandler < Struct.new(:stream, :logger, :started_proc, :abo
   #
   # @param socket[Socket] the socket to write to
   # @param file[File] the IO you can read from
-  # @yields num_bytes_written[Fixnum] the number of bytes written on each `IO.copy_stream() call`
+  # @yields num_bytes_written[Integer] the number of bytes written on each `IO.copy_stream() call`
   # @return [void]
   def copy_nio(socket, file)
     chunk = SENDFILE_CHUNK_SIZE

data/lib/fast_send/version.rb

@@ -0,0 +1,3 @@
+class FastSend
+  VERSION = "1.1.3"
+end

data/lib/fast_send.rb

@@ -31,11 +31,6 @@
 #    `fast_send.error' => ->(exception) { } # the response is not sent completely due to an error in the application
 #    `fast_send.cleanup' => ->(sent_total) { } # Called at the end of the response, in an ensure block
 class FastSend
-  require_relative 'fast_send/socket_handler'
-  require_relative 'fast_send/null_logger'
-  
-  VERSION = '1.1.2'
-  
   # All exceptions that get raised when the client closes a connection before receiving the entire response
   CLIENT_DISCONNECTS = [Errno::EPIPE, Errno::ECONNRESET, Errno::ENOTCONN, Errno::EPROTOTYPE]
   
@@ -43,8 +38,11 @@ class FastSend
     require 'java'
     CLIENT_DISCONNECTS << Java::JavaIo::IOException
   end
-  
-  
+
+  require_relative 'fast_send/version'
+  require_relative 'fast_send/socket_handler'
+  require_relative 'fast_send/null_logger'
+
   # Gets raised if a fast_send.something is mentioned in
   # the response headers but is not supported as a callback
   # (the dangers of hashmaps as datastructures is that you

data/spec/fast_send_with_mocks_spec.rb

@@ -1,5 +1,7 @@
 require_relative '../lib/fast_send'
 require 'logger'
+require 'tempfile'
+
 describe 'FastSend when used with a mock Socket' do
   let(:logger) {
     Logger.new(nil).tap{|l| l.level = Logger::DEBUG }
@@ -327,8 +329,8 @@ describe 'FastSend when used with a mock Socket' do
     
     bytes_sent_cbs = callbacks[1..-3]
     bytes_sent_cbs.each_with_index do | c, i |
-      expect(c[1]).to be_kind_of(Fixnum)
-      expect(c[2]).to be_kind_of(Fixnum)
+      expect(c[1]).to be_kind_of(Integer)
+      expect(c[2]).to be_kind_of(Integer)
     end
   end
   

data/spec/fast_send_with_puma_spec.rb

@@ -1,5 +1,6 @@
 require_relative '../lib/fast_send'
 require 'net/http'
+require 'tempfile'
 
 describe 'FastSend when used in combination with Puma' do
   before :all do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fast_send
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +74,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,6 +84,7 @@ files:
 - lib/fast_send.rb
 - lib/fast_send/null_logger.rb
 - lib/fast_send/socket_handler.rb
+- lib/fast_send/version.rb
 - spec/fast_send_with_mocks_spec.rb
 - spec/fast_send_with_puma_spec.rb
 - spec/test_app.ru
@@ -120,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: and do so bypassing the Ruby VM