Merge pull request #745 from akabraham/feature/add-octet-stream-conte…

…nt-type

Feature/add octet stream content type

CHANGELOG.md

@@ -3,6 +3,8 @@
 
 * [#743](https://github.com/intridea/grape/pull/743): Added `allow_blank` parameter validator to validate non-empty strings - [@elado](https://github.com/elado).
 * Your contribution here.
+* [#745](https://github.com/intridea/grape/pull/745): Removed `atom+xml`, `rss+xml`, and `jsonapi` content-types - [@akabraham](https://github.com/akabraham).
+* [#745](https://github.com/intridea/grape/pull/745): Added `:binary, application/octet-stream` content-type - [@akabraham](https://github.com/akabraham).
 
 0.9.0 (8/27/2014)
 =================

README.md

@@ -1209,7 +1209,7 @@ end
 
 ## API Formats
 
-By default, Grape supports _XML_, _JSON_, and _TXT_ content-types. The default format is `:txt`.
+By default, Grape supports _XML_, _JSON_, _BINARY_, and _TXT_ content-types. The default format is `:txt`.
 
 Serialization takes place automatically. For example, you do not have to call `to_json` in each JSON API implementation.
 
@@ -1273,10 +1273,11 @@ end
 
 Built-in formats are the following.
 
-* `:json` and `:jsonapi`: use object's `to_json` when available, otherwise call `MultiJson.dump`
+* `:json`: use object's `to_json` when available, otherwise call `MultiJson.dump`
 * `:xml`: use object's `to_xml` when available, usually via `MultiXml`, otherwise call `to_s`
 * `:txt`: use object's `to_txt` when available, otherwise `to_s`
 * `:serializable_hash`: use object's `serializable_hash` when available, otherwise fallback to `:json`
+* `:binary`
 
 Use `default_format` to set the fallback format when the format could not be determined from the `Accept` header.
 See below for the order for choosing the API format.

UPGRADING.md

@@ -1,6 +1,18 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 0.9.1
+
+#### Changes to content-types
+
+The following content-types have been removed:
+
+* atom (application/atom+xml)
+* rss (application/rss+xml)
+* jsonapi (application/jsonapi)
+
+This is because they have never been properly supported.
+
 ### Upgrading to >= 0.9.0 
 
 #### Changes in Authentication

lib/grape/util/content_types.rb

@@ -5,10 +5,8 @@ module ContentTypes
       :xml,  'application/xml',
       :serializable_hash, 'application/json',
       :json, 'application/json',
-      :jsonapi, 'application/vnd.api+json',
-      :atom, 'application/atom+xml',
-      :rss,  'application/rss+xml',
-      :txt,  'text/plain',
+      :binary, 'application/octet-stream',
+      :txt,  'text/plain'
    ]
 
     def self.content_types_for(from_settings)

spec/grape/api_spec.rb

@@ -742,12 +742,37 @@ def subject.enable_root_route!
 
     it 'sets content type for txt format' do
       get '/foo'
-      expect(last_response.headers['Content-Type']).to eql 'text/plain'
+      expect(last_response.headers['Content-Type']).to eq('text/plain')
+    end
+
+    it 'sets content type for xml' do
+      get '/foo.xml'
+      expect(last_response.headers['Content-Type']).to eq('application/xml')
     end
 
     it 'sets content type for json' do
       get '/foo.json'
-      expect(last_response.headers['Content-Type']).to eql 'application/json'
+      expect(last_response.headers['Content-Type']).to eq('application/json')
+    end
+
+    it 'sets content type for serializable hash format' do
+      get '/foo.serializable_hash'
+      expect(last_response.headers['Content-Type']).to eq('application/json')
+    end
+
+    it 'sets content type for binary format' do
+      get '/foo.binary'
+      expect(last_response.headers['Content-Type']).to eq('application/octet-stream')
+    end
+
+    it 'returns raw data when content type binary' do
+      image_filename = 'grape.png'
+      file = File.open(image_filename, 'rb') { |io| io.read }
+      subject.format :binary
+      subject.get('/binary_file') { File.binread(image_filename) }
+      get '/binary_file'
+      expect(last_response.headers['Content-Type']).to eq('application/octet-stream')
+      expect(last_response.body).to eq(file)
     end
 
     it 'sets content type for error' do
@@ -756,14 +781,14 @@ def subject.enable_root_route!
       expect(last_response.headers['Content-Type']).to eql 'text/plain'
     end
 
-    it 'sets content type for error' do
+    it 'sets content type for json error' do
       subject.format :json
       subject.get('/error') { error!('error in json', 500) }
       get '/error.json'
       expect(last_response.headers['Content-Type']).to eql 'application/json'
     end
 
-    it 'sets content type for xml' do
+    it 'sets content type for xml error' do
       subject.format :xml
       subject.get('/error') { error!('error in xml', 500) }
       get '/error.xml'

spec/grape/dsl/request_response_spec.rb

@@ -93,10 +93,8 @@ def self.imbue(key, value)
           expect(subject.content_types).to eq(xml: "application/xml",
                                               serializable_hash: "application/json",
                                               json: "application/json",
-                                              jsonapi: "application/vnd.api+json",
-                                              atom: "application/atom+xml",
-                                              rss: "application/rss+xml",
-                                              txt: "text/plain")
+                                              txt: "text/plain",
+                                              binary: "application/octet-stream")
         end
       end