fixup! un-deprecate stream-like objects

Author: urkle

README.md

@@ -3168,7 +3168,9 @@ end
 
 Use `body false` to return `204 No Content` without any data or content-type.
 
-You can also set the response to a file with `sendfile`
+You can also set the response to a file with `sendfile`. This works with the
+[Rack::Sendfile](https://www.rubydoc.info/gems/rack/Rack/Sendfile) middleware to optimally send
+the file through your web server software.
 
 ```ruby
 class API < Grape::API
@@ -3178,7 +3180,7 @@ class API < Grape::API
 end
 ```
 
-To stream a file use `stream`
+To stream a file in chunks use `stream`
 
 ```ruby
 class API < Grape::API
@@ -3188,7 +3190,7 @@ class API < Grape::API
 end
 ```
 
-If you want to stream non-file data you use the stream method and a `Stream` object.
+If you want to stream non-file data use the `stream` method and a `Stream` object.
 This is an object that responds to `each` and yields for each chunk to send to the client.
 Each chunk will be sent as it is yielded instead of waiting for all of the content to be available.
 

UPGRADING.md

@@ -1,15 +1,15 @@
 Upgrading Grape
 ===============
 
-### Upgrading to >= 1.3.4
+### Upgrading to >= 1.4.0
 
 #### Reworking stream and file and un-deprecating stream like-objects
 
 Previously in 0.16 stream-like objects were deprecated. This release restores their functionality for use-cases other than file streaming.
 
-This release also renamed `file` to `sendfile` to better document it's purpose.
+This release deprecated `file` in favor of `sendfile` to better document its purpose.
 
-To deliver a file via `sendfile` if available do this.
+To deliver a file via the Sendfile support in your web server and have the Rack::Sendfile middleware enabled. See [`Rack::Sendfile`](https://www.rubydoc.info/gems/rack/Rack/Sendfile)
 ```ruby
 class API < Grape::API
   get '/' do
@@ -18,7 +18,7 @@ class API < Grape::API
 end
 ```
 
-Use `stream` to stream files
+Use `stream` to stream file content in chunks
 
 ```ruby
 class API < Grape::API

spec/grape/integration/rack_sendfile_spec.rb

@@ -4,12 +4,16 @@
 
 describe Rack::Sendfile do
   subject do
-    send_file = file_streamer
+    contet_object = file_object
     app = Class.new(Grape::API) do
       use Rack::Sendfile
       format :json
       get do
-        file send_file
+        if contet_object.is_a?(String)
+          sendfile contet_object
+        else
+          stream contet_object
+        end
       end
     end
 
@@ -22,9 +26,9 @@
     app.call(env)
   end
 
-  context do
-    let(:file_streamer) do
-      double(:file_streamer, to_path: '/accel/mapping/some/path')
+  context 'when calling sendfile' do
+    let(:file_object) do
+      '/accel/mapping/some/path'
     end
 
     it 'contains Sendfile headers' do
@@ -33,9 +37,9 @@
     end
   end
 
-  context do
-    let(:file_streamer) do
-      double(:file_streamer)
+  context 'when streaming non file content' do
+    let(:file_object) do
+      double(:file_object, each: nil)
     end
 
     it 'not contains Sendfile headers' do