Use application/hal+json as default Content-Type and add to Accept header

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 * Your contribution here.
 
+### 0.7.0-pre (December 1, 2014)
+
+This version introduces several backwards incompatible changes. See [UPGRADING](UPGRADING.md) for details.
+
+* [#81](https://github.com/codegram/hyperclient/pull/81): The default Content-Type is now `application/hal+json` - [@koenpunt](https://github.com/koenpunt).
+
 ### 0.6.1 (October 17, 2014)
 
 This version introduces several backwards incompatible changes. See [UPGRADING](UPGRADING.md) for details.

README.md

@@ -20,7 +20,7 @@ require 'hyperclient'
 api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api')
 ```
 
-By default, Hyperclient adds `application/json` as `Content-Type` and `Accept` headers. It will also send requests as JSON and parse JSON responses. Specify additional headers or authentication if necessary.
+By default, Hyperclient adds `application/hal+json` as `Content-Type` and `Accept` headers. It will also send requests as JSON and parse JSON responses. Specify additional headers or authentication if necessary.
 
 ```ruby
 api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|

UPGRADING.md

@@ -1,6 +1,19 @@
 Upgrading Hyperclient
 =====================
 
+### Upgrading to >= 0.7.0
+
+#### Changes in default headers
+
+The default `Content-Type` is now `application/hal+json` and the `Accept` header includes `application/hal+json` as well.
+If your API only accepts `application/json` as Content-Type, you can override the default headers in the client initialization block as such:
+
+```rb
+Hyperclient.new('https://api.example.org/') do |client|
+  client.headers = { 'Content-Type' => 'application/json', 'Accept' => 'application/json,application/hal+json' }
+end
+```
+
 ### Upgrading to >= 0.6.0
 
 #### Changes in HTTP Error Handling

features/steps/default_config.rb

@@ -6,7 +6,9 @@ class Spinach::Features::DefaultConfig < Spinach::FeatureSteps
   end
 
   step 'the request should have been sent with the correct JSON headers' do
-    assert_requested :get, 'api.example.org', headers: { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+    assert_requested :get, 'api.example.org', headers: {
+      'Content-Type' => 'application/hal+json', 'Accept' => 'application/hal+json,application/json'
+    }
   end
 
   step 'I send some data to the API' do

features/support/api.rb

@@ -5,9 +5,9 @@ module API
   include Spinach::Fixtures
 
   before do
-    stub_request(:any, %r{api.example.org*}).to_return(body: root_response, headers: { 'Content-Type' => 'application/json' })
-    stub_request(:get, 'api.example.org/posts').to_return(body: posts_response, headers: { 'Content-Type' => 'application/json' })
-    stub_request(:get, 'api.example.org/posts/1').to_return(body: post_response, headers: { 'Content-Type' => 'application/json' })
+    stub_request(:any, %r{api.example.org*}).to_return(body: root_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/posts').to_return(body: posts_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/posts/1').to_return(body: post_response, headers: { 'Content-Type' => 'application/hal+json' })
   end
 
   def api

hyperclient.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday', '~> 0.8'
   gem.add_dependency 'futuroscope', '>= 0.0.10'
   gem.add_dependency 'faraday_middleware', '~> 0.9'
+  gem.add_dependency 'faraday_hal_middleware', '~> 0.0.1'
   gem.add_dependency 'uri_template', '~> 0.5'
   gem.add_dependency 'net-http-digest_auth', '~> 1.2'
   gem.add_dependency 'faraday-digestauth', '~> 0.2'

lib/hyperclient/entry_point.rb

@@ -1,5 +1,6 @@
 require 'hyperclient/link'
 require 'faraday_middleware'
+require 'faraday_hal_middleware'
 require_relative '../faraday/connection'
 
 module Hyperclient
@@ -109,8 +110,8 @@ def default_faraday_block
       lambda do |conn|
         conn.use Faraday::Response::RaiseError
         conn.use FaradayMiddleware::FollowRedirects
-        conn.request :json
-        conn.response :json, content_type: /\bjson$/
+        conn.request :hal_json
+        conn.response :hal_json, content_type: /\bjson$/
         conn.adapter :net_http
       end
     end
@@ -120,7 +121,7 @@ def default_faraday_block
     #
     # Returns a Hash.
     def default_headers
-      { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+      { 'Content-Type' => 'application/hal+json', 'Accept' => 'application/hal+json,application/json' }
     end
   end
 end

lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = '0.6.2'
+  VERSION = '0.7.0-pre'
 end

test/hyperclient/entry_point_test.rb

@@ -14,8 +14,8 @@ module Hyperclient
         end
 
         it 'creates a Faraday connection with the default headers' do
-          entry_point.headers['Content-Type'].must_equal 'application/json'
-          entry_point.headers['Accept'].must_equal 'application/json'
+          entry_point.headers['Content-Type'].must_equal 'application/hal+json'
+          entry_point.headers['Accept'].must_equal 'application/hal+json,application/json'
         end
 
         it 'can update headers after a connection has been constructed' do
@@ -35,8 +35,8 @@ module Hyperclient
           handlers = entry_point.connection.builder.handlers
           handlers.must_include Faraday::Response::RaiseError
           handlers.must_include FaradayMiddleware::FollowRedirects
-          handlers.must_include FaradayMiddleware::EncodeJson
-          handlers.must_include FaradayMiddleware::ParseJson
+          handlers.must_include FaradayMiddleware::EncodeHalJson
+          handlers.must_include FaradayMiddleware::ParseHalJson
           handlers.must_include Faraday::Adapter::NetHttp
         end
 
@@ -108,8 +108,8 @@ module Hyperclient
 
     describe 'connection' do
       it 'creates a Faraday connection with the default and additional headers' do
-        entry_point.headers['Content-Type'].must_equal 'application/json'
-        entry_point.headers['Accept'].must_equal 'application/json'
+        entry_point.headers['Content-Type'].must_equal 'application/hal+json'
+        entry_point.headers['Accept'].must_equal 'application/hal+json,application/json'
         entry_point.headers['Access-Token'].must_equal 'token'
       end
 
@@ -122,8 +122,8 @@ module Hyperclient
         handlers.must_include Faraday::Request::OAuth
         handlers.must_include Faraday::Response::RaiseError
         handlers.must_include FaradayMiddleware::FollowRedirects
-        handlers.must_include FaradayMiddleware::EncodeJson
-        handlers.must_include FaradayMiddleware::ParseJson
+        handlers.must_include FaradayMiddleware::EncodeHalJson
+        handlers.must_include FaradayMiddleware::ParseHalJson
         handlers.must_include Faraday::Adapter::NetHttp
       end
     end

test/hyperclient_test.rb

@@ -20,8 +20,8 @@
       end
 
       it 'creates a Faraday connection with the default and additional headers' do
-        client.headers['Content-Type'].must_equal 'application/json'
-        client.headers['Accept'].must_equal 'application/json'
+        client.headers['Content-Type'].must_equal 'application/hal+json'
+        client.headers['Accept'].must_equal 'application/hal+json,application/json'
         client.headers['Access-Token'].must_equal 'token'
       end
 
@@ -34,8 +34,8 @@
         handlers.must_include Faraday::Request::OAuth
         handlers.must_include Faraday::Response::RaiseError
         handlers.must_include FaradayMiddleware::FollowRedirects
-        handlers.must_include FaradayMiddleware::EncodeJson
-        handlers.must_include FaradayMiddleware::ParseJson
+        handlers.must_include FaradayMiddleware::EncodeHalJson
+        handlers.must_include FaradayMiddleware::ParseHalJson
         handlers.must_include Faraday::Adapter::NetHttp
       end
     end