hyperclient 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bba91bc97f25344d522646fec5c34cb74b183d4
-  data.tar.gz: b8289075f6c69400d84da795751f404030b9fdaa
+  metadata.gz: 743f6bc67f84cca3d8e2994ad47a38d7e031a300
+  data.tar.gz: 689b06b2eb057ca7bd28e74071ecca60ba954344
 SHA512:
-  metadata.gz: 26e276baa5ea49d3e54c47b308c12efad26bb259cacc620cab7b44d84ff61e17296b904ea738b3a7917044044e37653944ef854577335575bc6f5d1f46b4a767
-  data.tar.gz: 69d655ed12c311619476b43b595b7705ad69d590a960a356775b0cdb554c95f6b20d4a9b0f3dc34ee9b1281566a8aee3e5881de99f32a2d04321bf8eb9b6bee8
+  metadata.gz: 17ea7ceb37ecc125395b13d37caf7e134b7b9ef1e21ee258a1d92309f2cc3fadbe398916c3642b50cda8ccd62260b57d5eea3b38f786c4c03a2fea5a97f6e1f2
+  data.tar.gz: 1f5b27c757676834dfb1aaa33741b7be19ce09e9822c869f4ecabcaceeaac868799eb96a92e0b4ecdc0290e807a0fc6fff6cba924f2270ef0e01204cb8e08e77

data/.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-09-18 12:21:47 -0400 using RuboCop version 0.26.0.
+# on 2014-10-17 09:13:36 -0400 using RuboCop version 0.26.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,26 +8,18 @@
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 118
+  Max: 129
 
-# Offense count: 2
-Metrics/CyclomaticComplexity:
-  Max: 8
-
-# Offense count: 39
-# Configuration parameters: AllowURI.
+# Offense count: 72
+# Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 145
+  Max: 140
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 14
 
-# Offense count: 2
-Metrics/PerceivedComplexity:
-  Max: 9
-
 # Offense count: 1
 Style/AsciiComments:
   Enabled: false
@@ -41,11 +33,11 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
-# Offense count: 1
+# Offense count: 2
 Style/DoubleNegation:
   Enabled: false
 
-# Offense count: 3
+# Offense count: 5
 Style/Lambda:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### Next
+
+* Your contribution here.
+
+### 0.6.1 (October 17, 2014)
+
+This version introduces several backwards incompatible changes. See [UPGRADING](UPGRADING.md) for details.
+
+* [#51](https://github.com/codegram/hyperclient/issues/51), [#75](https://github.com/codegram/hyperclient/pull/75): Added support for setting headers and overriding or extending the default Faraday connection block before a connection is constructed - [@dblock](https://github.com/dblock).
+* [#41](https://github.com/codegram/hyperclient/issues/41), [#73](https://github.com/codegram/hyperclient/pull/73): All Link HTTP methods now return a Resource, including `_get`, which has been aliased to `_resource`, `_post`, `_put`, `_patch`, `_head` and `_options` - [@dblock](https://github.com/dblock).
+* [#72](https://github.com/codegram/hyperclient/pull/72): The default Faraday block now uses `Faraday::Response::RaiseError` and will cause HTTP errors to be raised as exceptions - [@dblock](https://github.com/dblock).
+* [#77](https://github.com/codegram/hyperclient/pull/77): Added support for templated links with all optional arguments - [@dblock](https://github.com/dblock).
+
 ### 0.5.0 (October 1, 2014)
 
 This version introduces several backwards incompatible changes. See [UPGRADING](UPGRADING.md) for details.

data/README.md

@@ -8,7 +8,7 @@ Hyperclient is a Hypermedia API client written in Ruby. It fully supports [JSON
 
 ## Usage
 
-The examples in this README use the [Splines Demo API](https://github.com/dblock/grape-with-roar) running [here](https://grape-with-roar.herokuapp.com/api).
+The examples in this README use the [Splines Demo API](https://github.com/dblock/grape-with-roar) running [here](https://grape-with-roar.herokuapp.com/api). If you're upgrading from a previous version, please make sure to read [UPGRADING](UPGRADING.md).
 
 ### API Client
 
@@ -20,15 +20,51 @@ 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. Hyperclient supports Basic, Token or Digest auth as well as many other [Faraday](http://github.com/lostisland/faraday) extensions.
+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.
 
 ```ruby
-api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api').tap do |api|
-  api.digest_auth('username', 'password')
-  api.headers.update('Accept-Encoding' => 'deflate, gzip')
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|
+  client.headers['Access-Token'] = 'token'
 end
 ```
 
+Hyperclient constructs a connection using typical [Faraday](http://github.com/lostisland/faraday) middleware for handling JSON requests and responses. You can specify additional Faraday middleware if necessary.
+
+```ruby
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|
+  client.connection do |conn|
+    conn.use Faraday::Request::OAuth
+  end
+end
+```
+
+You can build a new Faraday connection block without inheriting default middleware by specifying `default: false` in the `connection` block.
+
+```ruby
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|
+  client.connection(default: false) do |conn|
+    conn.request :json
+    conn.response :json, content_type: /\bjson$/
+    conn.adapter :net_http
+  end
+end
+```
+
+You can modify headers or specify authentication after a connection has been created. Hyperclient supports Basic, Token or Digest auth as well as many other Faraday extensions.
+
+```ruby
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api')
+api.digest_auth('username', 'password')
+api.headers.update('Accept-Encoding' => 'deflate, gzip')
+```
+
+You can access the Faraday connection directly after it has been created and add middleware to it. As an example, you could use the [faraday-http-cache-middleware](https://github.com/plataformatec/faraday-http-cache).
+
+```ruby
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api')
+api.connection.use :http_cache
+```
+
 ### Resources and Attributes
 
 Hyperclient will fetch and discover the resources from your API.
@@ -58,6 +94,8 @@ puts "Spline #{spline.uuid} is #{spline.reticulated ? 'reticulated' : 'not retic
 
 Invoking `api.spline(uuid: 'uuid').reticulated` is equivalent to `api._links.spline._expand(uuid: 'uuid')._resource._attributes.reticulated`.
 
+The client is responsible for supplying all the necessary parameters. Templated links don't do any strict parameter name checking and don't support required vs. optional parameters. Parameters not declared by the API will be dropped and will not have any effect when passed to `_expand`.
+
 ### Curies
 
 Curies are named tokens that you can define in the document and use to express curie relation URIs in a friendlier, more compact fashion. For example, the demo API contains very long links to images that use an "images" curie. Hyperclient handles curies and resolves these into full links automatically.
@@ -117,14 +155,35 @@ spline = api.spline(uuid: 'uuid')
 spline._delete
 ```
 
-### Faraday Connection
+HTTP methods always return a new instance of Resource.
+
+## Testing Using Hyperclient
 
-You can access the Faraday connection directly to add middleware by calling `connection` on the entry point. As an example, you could use the [faraday-http-cache-middleware](https://github.com/plataformatec/faraday-http-cache).
+You can combine RSpec, Faraday::Adapter::Rack and Hyperclient to test your HAL API without having to ever examine the raw JSON response.
 
 ```ruby
-api.connection.use :http_cache
+describe Acme::Api do
+  def app
+    Acme::App.instance
+  end
+
+  let(:client) do
+    Hyperclient.new('http://example.org/api') do |client|
+      client.connection(default: false) do |conn|
+        conn.response :json
+        conn.use Faraday::Adapter::Rack, app
+      end
+    end
+  end
+
+  it 'splines returns 3 splines by default' do
+    expect(client.splines.count).to eq 3
+  end
+end
 ```
 
+For a complete example refer to [this Splines Demo API test](https://github.com/dblock/grape-with-roar/blob/master/spec/api/splines_endpoint_with_hyperclient_spec.rb).
+
 ## Reference
 
 [Hyperclient API Reference](http://rubydoc.org/github/codegram/hyperclient/master/frames).

data/UPGRADING.md

@@ -1,6 +1,20 @@
 Upgrading Hyperclient
 =====================
 
+### Upgrading to >= 0.6.0
+
+#### Changes in HTTP Error Handling
+
+The default Faraday block now uses `Faraday::Response::RaiseError` and will cause HTTP errors to be raised as exceptions. Older versions of Hyperclient swallowed the error and returned an empty resource. If you relied on checking for an HTTP response `status`, rescue `Faraday::ClientError`.
+
+#### Changes in Values Returned from HTTP Methods
+
+The `Link#_get` method has been aliased to `_resource`. All HTTP methods, including `_post`, `_put`, `_delete`, `_patch`, `_options` and `_head` now return instances of Resource. Older versions returned a `Faraday::Response`.
+
+#### Changes in URI Template Expansion
+
+A `MissingURITemplateVariablesException` exception will no longer be raised when expanding a link with no arguments. The `Link#_expand` method will now also accept zero arguments and default the variables to `{}`. This enables support for templated links with all optional arguments.
+
 ### Upgrading to >= 0.5.0
 
 #### Remove Navigational Elements

data/examples/splines_api.rb

@@ -1,7 +1,9 @@
 require 'hyperclient'
 
+# create a new client
 api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api')
 
+# enumerate splines
 api.splines.each do |spline|
   puts "#{spline.uuid}"
   puts " reticulated: #{spline.reticulated ? 'yes' : 'no'}"
@@ -14,9 +16,22 @@ end
 
 puts '*' * 10
 
-spline = api.spline(uuid: 'random-uuid')
+# retrieve an existing spline
+spline = api.spline(uuid: 123)
 puts "Spline #{spline.uuid} is #{spline.reticulated ? 'reticulated' : 'not reticulated'}."
 
 # puts api._links.spline._expand(uuid: 'uuid')._resource._attributes.reticulated
 
 # spline.to_h
+
+# create a new spline
+spline = api.splines._post(reticulated: true)
+puts "Created a #{spline.reticulated ? 'reticulated' : 'unreticulated'} spline #{spline.uuid}."
+
+# update an existing spline
+spline = api.spline(uuid: 123)._put(reticulated: true)
+puts "Updated spline #{spline.uuid}, now #{spline.reticulated ? 'reticulated' : 'not reticulated'}."
+
+# delete an existing spline
+spline = api.spline(uuid: 123)._delete
+puts "Deleted spline #{spline.uuid}."

data/features/steps/default_config.rb

@@ -11,7 +11,7 @@ class Spinach::Features::DefaultConfig < Spinach::FeatureSteps
 
   step 'I send some data to the API' do
     stub_request(:post, 'http://api.example.org/posts')
-    assert_equal 200, api._links.posts._post(title: 'My first blog post').status
+    assert_equal 200, api._links.posts._post(title: 'My first blog post')._response.status
   end
 
   step 'it should have been encoded as JSON' do

data/lib/hyperclient.rb

@@ -9,7 +9,7 @@ module Hyperclient
   # url - A String with the url of the API.
   #
   # Returns a Hyperclient::EntryPoint
-  def self.new(url)
-    Hyperclient::EntryPoint.new(url)
+  def self.new(url, &block)
+    Hyperclient::EntryPoint.new(url, &block)
   end
 end

data/lib/hyperclient/entry_point.rb

@@ -3,6 +3,15 @@ require 'faraday_middleware'
 require_relative '../faraday/connection'
 
 module Hyperclient
+  # Public: Exception that is raised when trying to modify an
+  # already initialized connection.
+  class ConnectionAlreadyInitializedError < StandardError
+    # Public: Returns a String with the exception message.
+    def message
+      'The connection has already been initialized.'
+    end
+  end
+
   # Public: The EntryPoint is the main public API for Hyperclient. It is used to
   # initialize an API client and setup the configuration.
   #
@@ -10,6 +19,13 @@ module Hyperclient
   #
   #  client = Hyperclient::EntryPoint.new('http://my.api.org')
   #
+  #  client = Hyperclient::EntryPoint.new('http://my.api.org') do |entry_point|
+  #    entry_point.connection(default: true) do |conn|
+  #      conn.use Faraday::Request::OAuth
+  #    end
+  #    entry_point.headers['Access-Token'] = 'token'
+  #  end
+  #
   class EntryPoint < Link
     extend Forwardable
     # Public: Delegates common methods to be used with the Faraday connection.
@@ -18,16 +34,64 @@ module Hyperclient
     # Public: Initializes an EntryPoint.
     #
     # url    - A String with the entry point of your API.
-    def initialize(url)
+    def initialize(url, &_block)
       @link = { 'href' => url }
       @entry_point = self
+      yield self if block_given?
     end
 
     # Public: A Faraday connection to use as a HTTP client.
     #
+    # options    - A Hash containing additional options.
+    #
+    #  default   - Set to true to reuse default Faraday connection options.
+    #
     # Returns a Faraday::Connection.
-    def connection
-      @connection ||= Faraday.new(_url, { headers: default_headers }, &default_faraday_block)
+    def connection(options = { default: true }, &block)
+      if block_given?
+        fail ConnectionAlreadyInitializedError if @connection
+        if options[:default]
+          @faraday_block = lambda do |conn|
+            default_faraday_block.call conn
+            block.call conn
+          end
+        else
+          @faraday_block = block
+        end
+      else
+        @connection ||= Faraday.new(_url, { headers: headers }, &faraday_block)
+      end
+    end
+
+    # Public: Set headers.
+    #
+    # value    - A Hash containing headers to include with every API request.
+    def headers=(value)
+      fail ConnectionAlreadyInitializedError if @connection
+      @headers = value
+    end
+
+    # Public: Headers included with every API request.
+    #
+    # Returns a Hash.
+    def headers
+      return @connection.headers if @connection
+      @headers ||= default_headers
+    end
+
+    # Public: Faraday block used with every API request.
+    #
+    # Returns a Proc.
+    def faraday_block
+      @faraday_block ||= default_faraday_block
+    end
+
+    # Public: Set a Faraday block to use with every API request.
+    #
+    # value    - A Proc accepting a Faraday::Connection.
+    def faraday_block=(value)
+      fail ConnectionAlreadyInitializedError if @connection
+      @faraday_block = value
     end
 
     private
@@ -42,11 +106,12 @@ module Hyperclient
     #
     # Returns a block.
     def default_faraday_block
-      lambda do |faraday|
-        faraday.use FaradayMiddleware::FollowRedirects
-        faraday.request :json
-        faraday.response :json, content_type: /\bjson$/
-        faraday.adapter :net_http
+      lambda do |conn|
+        conn.use Faraday::Response::RaiseError
+        conn.use FaradayMiddleware::FollowRedirects
+        conn.request :json
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter :net_http
       end
     end
 

data/lib/hyperclient/link.rb

@@ -33,19 +33,14 @@ module Hyperclient
     # uri_variables - The Hash with the variables to expand the URITemplate.
     #
     # Returns a new Link with the expanded variables.
-    def _expand(uri_variables)
+    def _expand(uri_variables = {})
       self.class.new(@key, @link, @entry_point, uri_variables)
     end
 
     # Public: Returns the url of the Link.
-    #
-    # Raises MissingURITemplateVariables if the Link is templated but there are
-    # no uri variables to expand it.
     def _url
       return @link['href'] unless _templated?
-      fail MissingURITemplateVariablesException if @uri_variables.nil?
-
-      @url ||= _uri_template.expand(@uri_variables)
+      @url ||= _uri_template.expand(@uri_variables || {})
     end
 
     # Public: Returns an array of variables from the URITemplate.
@@ -86,61 +81,74 @@ module Hyperclient
     end
 
     # Public: Returns the Resource which the Link is pointing to.
-    def _resource
-      @resource ||= begin
-        response = _get
-
-        if response.success?
-          Resource.new(response.body, @entry_point, response)
-        else
-          Resource.new(nil, @entry_point, response)
+    def _get
+      @resource = begin
+        response = Futuroscope::Future.new do
+          _connection.get(_url)
         end
+        Resource.new(response.body, @entry_point, response)
       end
     end
 
-    def _connection
-      @entry_point.connection
+    def _resource
+      @resource || _get
     end
 
-    def _get
-      Futuroscope::Future.new do
-        _connection.get(_url)
-      end
+    def _connection
+      @entry_point.connection
     end
 
     def _options
-      Futuroscope::Future.new do
-        _connection.run_request(:options, _url, nil, nil)
+      @resource = begin
+        response = Futuroscope::Future.new do
+          _connection.run_request(:options, _url, nil, nil)
+        end
+        Resource.new(response.body, @entry_point, response)
       end
     end
 
     def _head
-      Futuroscope::Future.new do
-        _connection.head(_url)
+      @resource = begin
+        response = Futuroscope::Future.new do
+          _connection.head(_url)
+        end
+        Resource.new(response.body, @entry_point, response)
       end
     end
 
     def _delete
-      Futuroscope::Future.new do
-        _connection.delete(_url)
+      @resource = begin
+        response = Futuroscope::Future.new do
+          _connection.delete(_url)
+        end
+        Resource.new(response.body, @entry_point, response)
       end
     end
 
     def _post(params = {})
-      Futuroscope::Future.new do
-        _connection.post(_url, params)
+      @resource = begin
+        response = Futuroscope::Future.new do
+          _connection.post(_url, params)
+        end
+        Resource.new(response.body, @entry_point, response)
       end
     end
 
     def _put(params = {})
-      Futuroscope::Future.new do
-        _connection.put(_url, params)
+      @resource = begin
+        response = Futuroscope::Future.new do
+          _connection.put(_url, params)
+        end
+        Resource.new(response.body, @entry_point, response)
       end
     end
 
     def _patch(params = {})
-      Futuroscope::Future.new do
-        _connection.patch(_url, params)
+      @resource = begin
+        response = Futuroscope::Future.new do
+          _connection.patch(_url, params)
+        end
+        Resource.new(response.body, @entry_point, response)
       end
     end
 
@@ -191,13 +199,4 @@ module Hyperclient
       @uri_template ||= URITemplate.new(@link['href'])
     end
   end
-
-  # Public: Exception that is raised when building a templated Link without uri
-  # variables.
-  class MissingURITemplateVariablesException < StandardError
-    # Public: Returns a String with the exception message.
-    def message
-      'The URL to this links is templated, but no variables where given.'
-    end
-  end
 end

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = '0.5.0'
+  VERSION = '0.6.1'
 end

data/test/hyperclient/entry_point_test.rb

@@ -3,8 +3,76 @@ require 'hyperclient/entry_point'
 
 module Hyperclient
   describe EntryPoint do
+    describe 'default' do
+      let(:entry_point) do
+        EntryPoint.new 'http://my.api.org'
+      end
+
+      describe 'connection' do
+        it 'creates a Faraday connection with the entry point url' do
+          entry_point.connection.url_prefix.to_s.must_equal 'http://my.api.org/'
+        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'
+        end
+
+        it 'can update headers after a connection has been constructed' do
+          entry_point.connection.must_be_kind_of Faraday::Connection
+          entry_point.headers.update('Content-Type' => 'application/foobar')
+          entry_point.headers['Content-Type'].must_equal 'application/foobar'
+        end
+
+        it 'can insert additional middleware after a connection has been constructed' do
+          entry_point.connection.must_be_kind_of Faraday::Connection
+          entry_point.connection.use :instrumentation
+          handlers = entry_point.connection.builder.handlers
+          handlers.must_include FaradayMiddleware::Instrumentation
+        end
+
+        it 'creates a Faraday connection with the default block' do
+          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 Faraday::Adapter::NetHttp
+        end
+
+        it 'raises a  ConnectionAlreadyInitializedError if attempting to modify headers' do
+          entry_point.connection.must_be_kind_of Faraday::Connection
+          lambda { entry_point.headers = {} }.must_raise ConnectionAlreadyInitializedError
+        end
+
+        it 'raises a  ConnectionAlreadyInitializedError if attempting to modify the faraday block' do
+          entry_point.connection.must_be_kind_of Faraday::Connection
+          lambda { entry_point.connection {} }.must_raise ConnectionAlreadyInitializedError
+        end
+      end
+
+      describe 'initialize' do
+        it 'sets a Link with the entry point url' do
+          entry_point._url.must_equal 'http://my.api.org'
+        end
+      end
+    end
+  end
+
+  describe 'custom' do
     let(:entry_point) do
-      EntryPoint.new 'http://my.api.org'
+      EntryPoint.new 'http://my.api.org' do |entry_point|
+        entry_point.connection(default: false) do |conn|
+          conn.request :json
+          conn.response :json, content_type: /\bjson$/
+          conn.adapter :net_http
+        end
+
+        entry_point.headers = {
+          'Content-Type' => 'application/foobar',
+          'Accept' => 'application/foobar'
+        }
+      end
     end
 
     describe 'connection' do
@@ -12,23 +80,51 @@ module Hyperclient
         entry_point.connection.url_prefix.to_s.must_equal 'http://my.api.org/'
       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'
+      it 'creates a Faraday connection with non-default headers' do
+        entry_point.headers['Content-Type'].must_equal 'application/foobar'
+        entry_point.headers['Accept'].must_equal 'application/foobar'
       end
 
       it 'creates a Faraday connection with the default block' do
         handlers = entry_point.connection.builder.handlers
-        handlers.must_include FaradayMiddleware::FollowRedirects
+        handlers.wont_include Faraday::Response::RaiseError
+        handlers.wont_include FaradayMiddleware::FollowRedirects
         handlers.must_include FaradayMiddleware::EncodeJson
         handlers.must_include FaradayMiddleware::ParseJson
         handlers.must_include Faraday::Adapter::NetHttp
       end
     end
+  end
+
+  describe 'inherited' do
+    let(:entry_point) do
+      EntryPoint.new 'http://my.api.org' do |entry_point|
+        entry_point.connection(default: true) do |conn|
+          conn.use Faraday::Request::OAuth
+        end
+        entry_point.headers['Access-Token'] = 'token'
+      end
+    end
+
+    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['Access-Token'].must_equal 'token'
+      end
 
-    describe 'initialize' do
-      it 'sets a Link with the entry point url' do
-        entry_point._url.must_equal 'http://my.api.org'
+      it 'creates a Faraday connection with the entry point url' do
+        entry_point.connection.url_prefix.to_s.must_equal 'http://my.api.org/'
+      end
+
+      it 'creates a Faraday connection with the default block plus any additional handlers' do
+        handlers = entry_point.connection.builder.handlers
+        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 Faraday::Adapter::NetHttp
       end
     end
   end

data/test/hyperclient/link_test.rb

@@ -51,24 +51,38 @@ module Hyperclient
     end
 
     describe '_expand' do
-      it 'buils a Link with the templated URI representation' do
-        link = Link.new('key', { 'href' => '/orders{?id}', 'templated' => true }, entry_point)
+      describe 'required argument' do
+        it 'builds a Link with the templated URI representation' do
+          link = Link.new('key', { 'href' => '/orders/{id}', 'templated' => true }, entry_point)
+          link._expand(id: '1')._url.must_equal '/orders/1'
+        end
 
-        Link.expects(:new).with('key', anything, entry_point, id: '1')
-        link._expand(id: '1')
+        it 'expands an uri template without variables' do
+          link = Link.new('key', { 'href' => '/orders/{id}', 'templated' => true }, entry_point)
+          link._expand._url.must_equal '/orders/'
+          link._url.must_equal '/orders/'
+        end
       end
 
-      it 'raises if no uri variables are given' do
-        link = Link.new('key', { 'href' => '/orders{?id}', 'templated' => true }, entry_point)
-        lambda { link._expand }.must_raise ArgumentError
+      describe 'query string argument' do
+        it 'builds a Link with the templated URI representation' do
+          link = Link.new('key', { 'href' => '/orders{?id}', 'templated' => true }, entry_point)
+          link._expand(id: '1')._url.must_equal '/orders?id=1'
+        end
+
+        it 'expands an uri template without variables' do
+          link = Link.new('key', { 'href' => '/orders{?id}', 'templated' => true }, entry_point)
+          link._expand._url.must_equal '/orders'
+          link._url.must_equal '/orders'
+        end
       end
     end
 
     describe '_url' do
-      it 'raises when missing required uri_variables' do
+      it 'expands an uri template without variables' do
         link = Link.new('key', { 'href' => '/orders{?id}', 'templated' => true }, entry_point)
 
-        lambda { link._url }.must_raise MissingURITemplateVariablesException
+        link._url.must_equal '/orders'
       end
 
       it 'expands an uri template with variables' do
@@ -91,23 +105,10 @@ module Hyperclient
 
     describe '_resource' do
       it 'builds a resource with the link href representation' do
-        mock_response = mock(body: {}, success?: true)
-
-        Resource.expects(:new).with({}, entry_point, mock_response)
-
-        link = Link.new('key', { 'href' => '/' }, entry_point)
-        link.expects(:_get).returns(mock_response)
-
-        link._resource
-      end
-
-      it 'has an empty body when the response fails' do
-        mock_response = mock(success?: false)
-
-        Resource.expects(:new).with(nil, entry_point, mock_response)
+        Resource.expects(:new)
 
         link = Link.new('key', { 'href' => '/' }, entry_point)
-        link.expects(:_get).returns(mock_response)
+        stub_request(:get, 'http://api.example.org/').to_return(body: {})
 
         link._resource
       end
@@ -123,8 +124,15 @@ module Hyperclient
       it 'sends a GET request with the link url' do
         link = Link.new('key', { 'href' => '/productions/1' }, entry_point)
 
-        entry_point.connection.expects(:get).with('/productions/1')
-        link._get.inspect
+        stub_request(:get, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._get.must_be_kind_of Resource
+      end
+
+      it 'raises exceptions by default' do
+        link = Link.new('key', { 'href' => '/productions/1' }, entry_point)
+
+        stub_request(:get, 'http://api.example.org/productions/1').to_return(status: 400)
+        lambda { link._get }.must_raise Faraday::ClientError
       end
     end
 
@@ -132,26 +140,24 @@ module Hyperclient
       it 'sends a OPTIONS request with the link url' do
         link = Link.new('key', { 'href' => '/productions/1' }, entry_point)
 
-        entry_point.connection.expects(:run_request).with(:options, '/productions/1', nil, nil)
-        link._options.inspect
+        stub_request(:options, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._options.must_be_kind_of Resource
       end
     end
 
     describe '_head' do
       it 'sends a HEAD request with the link url' do
         link = Link.new('key', { 'href' => '/productions/1' }, entry_point)
-
-        entry_point.connection.expects(:head).with('/productions/1')
-        link._head.inspect
+        stub_request(:head, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._head.must_be_kind_of Resource
       end
     end
 
     describe '_delete' do
       it 'sends a DELETE request with the link url' do
         link = Link.new('key', { 'href' => '/productions/1' }, entry_point)
-
-        entry_point.connection.expects(:delete).with('/productions/1')
-        link._delete.inspect
+        stub_request(:delete, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._delete.must_be_kind_of Resource
       end
     end
 
@@ -159,13 +165,13 @@ module Hyperclient
       let(:link) { Link.new('key', { 'href' => '/productions/1' }, entry_point) }
 
       it 'sends a POST request with the link url and params' do
-        entry_point.connection.expects(:post).with('/productions/1', 'foo' => 'bar')
-        link._post('foo' => 'bar').inspect
+        stub_request(:post, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._post('foo' => 'bar').must_be_kind_of Resource
       end
 
       it 'defaults params to an empty hash' do
-        entry_point.connection.expects(:post).with('/productions/1', {})
-        link._post.inspect
+        stub_request(:post, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._post.must_be_kind_of Resource
       end
     end
 
@@ -173,13 +179,13 @@ module Hyperclient
       let(:link) { Link.new('key', { 'href' => '/productions/1' }, entry_point) }
 
       it 'sends a PUT request with the link url and params' do
-        entry_point.connection.expects(:put).with('/productions/1', 'foo' => 'bar')
-        link._put('foo' => 'bar').inspect
+        stub_request(:put, 'http://api.example.org/productions/1').with(body: '{"foo":"bar"}').to_return(body: nil)
+        link._put('foo' => 'bar').must_be_kind_of Resource
       end
 
       it 'defaults params to an empty hash' do
-        entry_point.connection.expects(:put).with('/productions/1', {})
-        link._put.inspect
+        stub_request(:put, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._put.must_be_kind_of Resource
       end
     end
 
@@ -187,13 +193,13 @@ module Hyperclient
       let(:link) { Link.new('key', { 'href' => '/productions/1' }, entry_point) }
 
       it 'sends a PATCH request with the link url and params' do
-        entry_point.connection.expects(:patch).with('/productions/1', 'foo' => 'bar')
-        link._patch('foo' => 'bar').inspect
+        stub_request(:patch, 'http://api.example.org/productions/1').with(body: '{"foo":"bar"}').to_return(body: nil)
+        link._patch('foo' => 'bar').must_be_kind_of Resource
       end
 
       it 'defaults params to an empty hash' do
-        entry_point.connection.expects(:patch).with('/productions/1', {})
-        link._patch.inspect
+        stub_request(:patch, 'http://api.example.org/productions/1').to_return(body: nil)
+        link._patch.must_be_kind_of Resource
       end
     end
 

data/test/hyperclient_test.rb

@@ -8,5 +8,36 @@ describe Hyperclient do
 
       Hyperclient.new('http://api.example.org')
     end
+
+    describe 'with an optional block' do
+      let(:client) do
+        Hyperclient.new('http://api.example.org') do |client|
+          client.connection(default: true) do |conn|
+            conn.use Faraday::Request::OAuth
+          end
+          client.headers['Access-Token'] = 'token'
+        end
+      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['Access-Token'].must_equal 'token'
+      end
+
+      it 'creates a Faraday connection with the entry point url' do
+        client.connection.url_prefix.to_s.must_equal 'http://api.example.org/'
+      end
+
+      it 'creates a Faraday connection with the default block plus any additional handlers' do
+        handlers = client.connection.builder.handlers
+        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 Faraday::Adapter::NetHttp
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Oriol Gual
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -188,7 +188,6 @@ files:
 - .gitignore
 - .rubocop.yml
 - .rubocop_todo.yml
-- .rvmrc
 - .travis.yml
 - .yardopts
 - CHANGELOG.md

data/.rvmrc

@@ -1 +0,0 @@
-rvm use --create 2.0.0@hyperclient