hyperclient 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fef7b6957e239321aff88f157c57b669cdaa388
-  data.tar.gz: 5e1fc8350dbd97205743d716146a4b148202034e
+  metadata.gz: c935e08d5410e72969d8b83c213ef56d7ae5236e
+  data.tar.gz: a250cb39f383c471f637cec668ce683c0310e808
 SHA512:
-  metadata.gz: 8f005fb328d44e78d11d443184361a8709422977c10a574ef98d8a21694acb72930058ca05075d06baa5290be17502060f5efe09b9d604264f2d9f8a26ec9171
-  data.tar.gz: 7c587f7c4abfc82e571b3dc8a3b571521d13c077a84d12aca7497777b894630b648adf87e296e2f3f2d4806c3ed31a91152d8ced262f0dc9305a8f6814485da0
+  metadata.gz: 10c73a4a2d78e9947a69719e831d1dccd467fecf6006a21fba2561cd23e74e5c7b8604398dc75477a76a5327cf0dfc31e018424cf41c81067bb057854dbd5960
+  data.tar.gz: c4eba8f9223ccc8ffa166dc731e32ac842d8230f4e9ee507b9f175503ee935a235e5820d823a24378239080de2d8c74bfb2ee29a25949a841d44d78d5a4ff747

data/.rubocop_todo.yml

@@ -1,5 +1,6 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-10-17 09:13:36 -0400 using RuboCop version 0.26.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-15 16:01:39 -0400 using RuboCop version 0.33.0.
 # 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,40 +9,70 @@
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 129
+  Max: 103
 
-# Offense count: 72
+# Offense count: 80
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 140
+  Max: 142
 
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 14
 
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 238
+
 # Offense count: 1
 Style/AsciiComments:
-  Enabled: false
+  Exclude:
+    - 'lib/hyperclient/collection.rb'
 
 # Offense count: 2
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/ClassAndModuleChildren:
-  Enabled: false
+  Exclude:
+    - 'features/steps/api_navigation.rb'
+    - 'features/steps/default_config.rb'
 
 # Offense count: 14
 Style/Documentation:
-  Enabled: false
+  Exclude:
+    - 'features/steps/api_navigation.rb'
+    - 'features/steps/default_config.rb'
+    - 'features/support/api.rb'
+    - 'features/support/fixtures.rb'
+    - 'lib/hyperclient/version.rb'
+    - 'test/faraday/connection_test.rb'
+    - 'test/hyperclient/attributes_test.rb'
+    - 'test/hyperclient/collection_test.rb'
+    - 'test/hyperclient/curie_test.rb'
+    - 'test/hyperclient/entry_point_test.rb'
+    - 'test/hyperclient/link_collection_test.rb'
+    - 'test/hyperclient/link_test.rb'
+    - 'test/hyperclient/resource_collection_test.rb'
+    - 'test/hyperclient/resource_test.rb'
 
 # Offense count: 2
 Style/DoubleNegation:
-  Enabled: false
+  Exclude:
+    - 'lib/hyperclient/curie.rb'
+    - 'lib/hyperclient/link.rb'
 
 # Offense count: 5
+# Cop supports --auto-correct.
 Style/Lambda:
-  Enabled: false
+  Exclude:
+    - 'test/hyperclient/entry_point_test.rb'
+    - 'test/hyperclient/link_test.rb'
+    - 'test/hyperclient/resource_test.rb'
 
-# Offense count: 5
-# Configuration parameters: MaxSlashes.
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
 Style/RegexpLiteral:
-  Enabled: false
+  Exclude:
+    - 'features/support/api.rb'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.7.1 (August 15, 2015)
+
+* [#89](https://github.com/codegram/hyperclient/issues/89): Added `Hyperclient::Resource#fetch` - [@alabeduarte](https://github.com/alabeduarte).
+* [#87](https://github.com/codegram/hyperclient/pull/87): Fix: eager delegation causes link skipping - [@dblock](https://github.com/dblock).
+
 ### 0.7.0 (February 23, 2015)
 
 This version introduces several backwards incompatible changes. See [UPGRADING](UPGRADING.md) for details.

data/Gemfile

@@ -13,4 +13,4 @@ gem 'redcarpet'
 gem 'yard', '~> 0.8'
 gem 'yard-tomdoc'
 gem 'simplecov', require: false
-gem 'rubocop', '~> 0.27.0', require: false
+gem 'rubocop', '~> 0.33.0', require: false

data/README.md

@@ -95,6 +95,15 @@ api.splines.each do |spline|
 end
 ```
 
+Other methods, including `[]` and `fetch` are also available
+
+```ruby
+api.splines.each do |spline|
+  puts "A spline with ID #{spline[:uuid]}."
+  puts "Maybe with reticulated: #{spline.fetch(:reticulated, '-- no reticulated')}"
+end
+```
+
 ### Links and Embedded Resources
 
 The splines example above followed a link called "splines". While you can, you do not need to specify the HAL navigational structure, including links or embedded resources. Hyperclient will resolve these for you.  If you prefer, you can explicitly navigate the link structure via `_links`. In the following example the "splines" link leads to a collection of embedded splines. Invoking `api.splines` is equivalent to `api._links.splines._embedded.splines`.

data/RELEASING.md

@@ -0,0 +1,69 @@
+Releasing Hyperclient
+=====================
+
+There're no particular rules about when to release hyperclient. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/codegram/hyperclient) for all supported platforms.
+
+Increment the version, modify [lib/hyperclient/version.rb](lib/hyperclient/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.4.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+0.4.0 (2014-01-27)
+==================
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/hyperclient/version.rb
+git commit -m "Preparing for release, 0.4.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+hyperclient 0.4.0 built to pkg/hyperclient-0.4.0.gem.
+Tagged v0.4.0.
+Pushed git commits and tags.
+Pushed hyperclient 0.4.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Increment the minor version, modify [lib/hyperclient/version.rb](lib/hyperclient/version.rb).
+
+Comit your changes.
+
+```
+git add CHANGELOG.md lib/hyperclient/version.rb
+git commit -m "Preparing for next release, 0.4.1."
+git push origin master
+```

data/UPGRADING.md

@@ -14,6 +14,32 @@ Hyperclient.new('https://api.example.org/') do |client|
 end
 ```
 
+#### Changes to default headers may impact Hyperclient in test
+
+If you are using Hyperclient to test an API as [described in README.md](https://github.com/codegram/hyperclient#testing-using-hyperclient) and if the API expects 'application/hal+json' as the content_type for requests, you may need to update how you set up Hyperclient in your specs.  [As defined in the ```default_faraday_block``` method in ```Hyperclient::EntryPoint```](https://github.com/codegram/hyperclient/blob/9f908854395523b38e0d4fc834d6db1f8b6dfb22/lib/hyperclient/entry_point.rb#L129), you can specify that you are encoding requests via faraday as ```:hal_json```.
+
+```ruby
+Hyperclient.new('http://example.org/api') do |client|
+  client.connection(default: false) do |conn|
+    conn.request :hal_json
+    conn.response :json
+    conn.use Faraday::Adapter::Rack, app
+  end
+end
+```
+
+instead of:
+
+```ruby
+Hyperclient.new('http://example.org/api') do |client|
+  client.connection(default: false) do |conn|
+    conn.request :json
+    conn.response :json
+    conn.use Faraday::Adapter::Rack, app
+  end
+end
+```
+
 ### Upgrading to >= 0.6.0
 
 #### Changes in HTTP Error Handling
@@ -61,4 +87,3 @@ Instead Of                                              | Write This
 `api.links.widget.expand(id: 3).put(name: 'updated`)    | `api._links.widget._expand(id: 3)._put(name: 'updated')`
 
 For more information see [#63](https://github.com/codegram/hyperclient/pull/63).
-

data/features/api_navigation.feature

@@ -21,3 +21,8 @@ Feature: API navigation
     Given I connect to the API
     When I load a single post
     Then I should also be able to access it's embedded comments
+
+  Scenario: Navigation links
+    When I connect to the API
+    Then I should be able to navigate to next page
+    Then I should be able to navigate to next page without links

data/features/steps/api_navigation.rb

@@ -30,4 +30,12 @@ class Spinach::Features::ApiNavigation < Spinach::FeatureSteps
     comment = @post._embedded.comments.first
     comment._attributes.title.wont_equal nil
   end
+
+  step 'I should be able to navigate to next page' do
+    assert_equal '/posts_of_page2', api._links.next._links.posts._url
+  end
+
+  step 'I should be able to navigate to next page without links' do
+    assert_equal '/posts_of_page2', api.next.posts._url
+  end
 end

data/features/support/api.rb

@@ -8,6 +8,8 @@ module API
     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' })
+    stub_request(:get, 'api.example.org/page2').to_return(body: page2_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/page3').to_return(body: page3_response, headers: { 'Content-Type' => 'application/hal+json' })
   end
 
   def api

data/features/support/fixtures.rb

@@ -8,7 +8,8 @@ module Spinach
               "self": { "href": "/" },
               "posts": { "href": "/posts" },
               "search": { "href": "/search{?q}", "templated": true },
-              "api:authors": { "href": "/authors" }
+              "api:authors": { "href": "/authors" },
+              "next": { "href": "/page2" }
           }
       }'
     end
@@ -39,5 +40,25 @@ module Spinach
           }
       }'
     end
+
+    def page2_response
+      '{
+          "_links": {
+              "self": { "href": "/page2" },
+              "posts": { "href": "/posts_of_page2" },
+              "next": { "href": "/page3" }
+          }
+      }'
+    end
+
+    def page3_response
+      '{
+          "_links": {
+              "self": { "href": "/page3" },
+              "posts": { "href": "/posts_of_page3" },
+              "api:authors": { "href": "/authors" }
+          }
+      }'
+    end
   end
 end

data/lib/hyperclient/collection.rb

@@ -1,5 +1,5 @@
 module Hyperclient
-  # Public: A helper class to wrapp a collection of elements and provide
+  # Public: A helper class to wrap a collection of elements and provide
   # Hash-like access or via a method call.
   #
   # Examples
@@ -25,8 +25,13 @@ module Hyperclient
       @collection.each(&block)
     end
 
-    def include?(obj)
-      @collection.include?(obj)
+    # Public: Checks if this collection includes a given key.
+    #
+    # key - A String or Symbol to check for existance.
+    #
+    # Returns True/False.
+    def include?(key)
+      @collection.include?(key)
     end
 
     # Public: Returns a value from the collection for the given key.
@@ -51,7 +56,7 @@ module Hyperclient
       @collection[name.to_s]
     end
 
-    # Public: Returns the wrapped collection as a hash.
+    # Public: Returns the wrapped collection as a Hash.
     #
     # Returns a Hash.
     def to_h
@@ -70,7 +75,7 @@ module Hyperclient
     #
     # Returns an Object.
     def method_missing(method_name, *_args, &_block)
-      @collection.fetch(method_name.to_s)  do
+      @collection.fetch(method_name.to_s) do
         fail "Could not find `#{method_name}` in #{self.class.name}"
       end
     end

data/lib/hyperclient/curie.rb

@@ -7,8 +7,8 @@ module Hyperclient
   class Curie
     # Public: Initializes a new Curie.
     #
-    # curie          - The String with the URI of the curie.
-    # entry_point   - The EntryPoint object to inject the cofnigutation.
+    # curie_hash  - The String with the URI of the curie.
+    # entry_point - The EntryPoint object to inject the configuration.
     def initialize(curie_hash, entry_point)
       @curie_hash = curie_hash
       @entry_point = entry_point
@@ -22,12 +22,12 @@ module Hyperclient
       !!@curie_hash['templated']
     end
 
-    # Public: Returns the name property of the Curie
+    # Public: Returns the name property of the Curie.
     def name
       @curie_hash['name']
     end
 
-    # Public: Returns the href property of the Curie
+    # Public: Returns the href property of the Curie.
     def href
       @curie_hash['href']
     end
@@ -38,7 +38,7 @@ module Hyperclient
 
     # Public: Expands the Curie when is templated with the given variables.
     #
-    # rel - The rel to expand.
+    # rel - The String rel to expand.
     #
     # Returns a new expanded url.
     def expand(rel)

data/lib/hyperclient/entry_point.rb

@@ -29,6 +29,7 @@ module Hyperclient
   #
   class EntryPoint < Link
     extend Forwardable
+
     # Public: Delegates common methods to be used with the Faraday connection.
     def_delegators :connection, :basic_auth, :digest_auth, :token_auth, :headers, :headers=, :params, :params=
 
@@ -43,9 +44,9 @@ module Hyperclient
 
     # 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.
+    # options - A Hash containing additional options to pass to Farday. Use
+    # {default: false} if you want to skip using default Faraday options set by
+    # Hyperclient.
     #
     # Returns a Faraday::Connection.
     def connection(options = {}, &block)
@@ -123,12 +124,12 @@ module Hyperclient
     #
     # Returns a block.
     def default_faraday_block
-      lambda do |conn|
-        conn.use Faraday::Response::RaiseError
-        conn.use FaradayMiddleware::FollowRedirects
-        conn.request :hal_json
-        conn.response :hal_json, content_type: /\bjson$/
-        conn.adapter :net_http
+      lambda do |connection|
+        connection.use Faraday::Response::RaiseError
+        connection.use FaradayMiddleware::FollowRedirects
+        connection.request :hal_json
+        connection.response :hal_json, content_type: /\bjson$/
+        connection.adapter :net_http
       end
     end
 

data/lib/hyperclient/link.rb

@@ -10,7 +10,7 @@ module Hyperclient
     #
     # key           - The key or name of the link.
     # link          - The String with the URI of the link.
-    # entry_point   - The EntryPoint object to inject the cofnigutation.
+    # entry_point   - The EntryPoint object to inject the configuration.
     # uri_variables - The optional Hash with the variables to expand the link
     #                 if it is templated.
     def initialize(key, link, entry_point, uri_variables = nil)
@@ -80,76 +80,37 @@ module Hyperclient
       @link['hreflang']
     end
 
-    # Public: Returns the Resource which the Link is pointing to.
-    def _get
-      @resource = begin
-        response = Futuroscope::Future.new do
-          _connection.get(_url)
-        end
-        Resource.new(response.body, @entry_point, response)
-      end
-    end
-
     def _resource
       @resource || _get
     end
 
-    def _connection
-      @entry_point.connection
+    # Public: Returns the Resource which the Link is pointing to.
+    def _get
+      http_method(:get)
     end
 
     def _options
-      @resource = begin
-        response = Futuroscope::Future.new do
-          _connection.run_request(:options, _url, nil, nil)
-        end
-        Resource.new(response.body, @entry_point, response)
-      end
+      http_method(:options)
     end
 
     def _head
-      @resource = begin
-        response = Futuroscope::Future.new do
-          _connection.head(_url)
-        end
-        Resource.new(response.body, @entry_point, response)
-      end
+      http_method(:head)
     end
 
     def _delete
-      @resource = begin
-        response = Futuroscope::Future.new do
-          _connection.delete(_url)
-        end
-        Resource.new(response.body, @entry_point, response)
-      end
+      http_method(:delete)
     end
 
     def _post(params = {})
-      @resource = begin
-        response = Futuroscope::Future.new do
-          _connection.post(_url, params)
-        end
-        Resource.new(response.body, @entry_point, response)
-      end
+      http_method(:post, params)
     end
 
     def _put(params = {})
-      @resource = begin
-        response = Futuroscope::Future.new do
-          _connection.put(_url, params)
-        end
-        Resource.new(response.body, @entry_point, response)
-      end
+      http_method(:put, params)
     end
 
     def _patch(params = {})
-      @resource = begin
-        response = Futuroscope::Future.new do
-          _connection.patch(_url, params)
-        end
-        Resource.new(response.body, @entry_point, response)
-      end
+      http_method(:patch, params)
     end
 
     def inspect
@@ -162,20 +123,25 @@ module Hyperclient
 
     private
 
-    # Internal: Delegate the method to the API if it exists.
-    #
-    # This allows `api.posts` instead of `api.links.posts.embedded`
+    # Internal: Delegate the method further down the API if the resource cannot serve it.
     def method_missing(method, *args, &block)
-      if @key && _resource.respond_to?(@key) && (delegate = _resource.send(@key)) && delegate.respond_to?(method.to_s)
-        # named.named becomes named
-        delegate.send(method, *args, &block)
-      elsif _resource.respond_to?(method.to_s)
-        _resource.send(method, *args, &block)
+      if _resource.respond_to?(method.to_s)
+        _resource.send(method, *args, &block) || delegate_method(method, *args, &block)
       else
         super
       end
     end
 
+    # Internal: Delegate the method to the API if the resource cannot serve it.
+    #
+    # This allows `api.posts` instead of `api._links.posts.embedded.posts`
+    def delegate_method(method, *args, &block)
+      return unless @key && _resource.respond_to?(@key)
+      @delegate ||= _resource.send(@key)
+      return unless @delegate && @delegate.respond_to?(method.to_s)
+      @delegate.send(method, *args, &block)
+    end
+
     # Internal: Accessory method to allow the link respond to the
     # methods that will hit method_missing.
     def respond_to_missing?(method, _include_private = false)
@@ -198,5 +164,14 @@ module Hyperclient
     def _uri_template
       @uri_template ||= URITemplate.new(@link['href'])
     end
+
+    def http_method(method, body = nil)
+      @resource = begin
+        response = Futuroscope::Future.new do
+          @entry_point.connection.run_request(method, _url, body, nil)
+        end
+        Resource.new(response.body, @entry_point, response)
+      end
+    end
   end
 end

data/lib/hyperclient/link_collection.rb

@@ -13,8 +13,8 @@ module Hyperclient
   class LinkCollection < Collection
     # Public: Initializes a LinkCollection.
     #
-    # collection - The Hash with the links.
-    # curies - Link curies.
+    # collection  - The Hash with the links.
+    # curies      - The Hash with link curies.
     # entry_point - The EntryPoint object to inject the configuration.
     def initialize(collection, curies, entry_point)
       fail "Invalid response for LinkCollection. The response was: #{collection.inspect}" if collection && !collection.respond_to?(:collect)
@@ -33,13 +33,15 @@ module Hyperclient
 
     # Internal: Creates links from the response hash.
     #
+    # name          - A String to identify the link's name.
     # link_or_links - A Hash or an Array of hashes with the links to build.
-    # entry_point - The EntryPoint object to inject the configuration.
-    # curies - Optional curies for templated links.
+    # curies        - An Array of Curies for templated links.
+    # entry_point   - The EntryPoint object to inject the configuration.
     #
-    # Returns a Link or an array of Links when given an Array.
+    # Returns a Link or an Array of Links when given an Array.
     def build_link(name, link_or_links, curies, entry_point)
       return unless link_or_links
+
       if link_or_links.respond_to?(:to_ary)
         link_or_links.map do |link|
           build_link(name, link, curies, entry_point)

data/lib/hyperclient/resource.rb

@@ -57,6 +57,18 @@ module Hyperclient
       send(name) if respond_to?(name)
     end
 
+    def fetch(key, *args)
+      return self[key] if respond_to?(key)
+
+      if args.any?
+        args.first
+      elsif block_given?
+        yield key
+      else
+        fail KeyError
+      end
+    end
+
     private
 
     # Internal: Returns the self Link of the Resource. Used to handle the HTTP

data/lib/hyperclient/resource_collection.rb

@@ -14,7 +14,7 @@ module Hyperclient
     # Public: Initializes a ResourceCollection.
     #
     # collection  - The Hash with the embedded resources.
-    # entry_point - The EntryPoint object to inject the cofnigutation.
+    # entry_point - The EntryPoint object to inject the configuration.
     #
     def initialize(collection, entry_point)
       @entry_point = entry_point

data/lib/hyperclient/version.rb

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

data/test/hyperclient/collection_test.rb

@@ -70,6 +70,5 @@ module Hyperclient
         end
       end
     end
-
   end
 end

data/test/hyperclient/link_test.rb

@@ -117,12 +117,6 @@ module Hyperclient
       end
     end
 
-    describe '_connection' do
-      it 'returns the entry point connection' do
-        Link.new('key', {}, entry_point)._connection.must_equal entry_point.connection
-      end
-    end
-
     describe 'get' do
       it 'sends a GET request with the link url' do
         link = Link.new('key', { 'href' => '/productions/1' }, entry_point)
@@ -185,7 +179,6 @@ module Hyperclient
       let(:link) { Link.new('key', { 'href' => '/productions/1' }, entry_point) }
 
       it 'sends a POST request with the link url and params' do
-
         stub_request(entry_point.connection) do |stub|
           stub.post('http://api.example.org/productions/1') { [200, {}, nil] }
         end
@@ -194,7 +187,6 @@ module Hyperclient
       end
 
       it 'defaults params to an empty hash' do
-
         stub_request(entry_point.connection) do |stub|
           stub.post('http://api.example.org/productions/1') { [200, {}, nil] }
         end
@@ -207,7 +199,6 @@ module Hyperclient
       let(:link) { Link.new('key', { 'href' => '/productions/1' }, entry_point) }
 
       it 'sends a PUT request with the link url and params' do
-
         stub_request(entry_point.connection) do |stub|
           stub.put('http://api.example.org/productions/1', '{"foo":"bar"}') { [200, {}, nil] }
         end
@@ -216,7 +207,6 @@ module Hyperclient
       end
 
       it 'defaults params to an empty hash' do
-
         stub_request(entry_point.connection) do |stub|
           stub.put('http://api.example.org/productions/1') { [200, {}, nil] }
         end
@@ -229,7 +219,6 @@ module Hyperclient
       let(:link) { Link.new('key', { 'href' => '/productions/1' }, entry_point) }
 
       it 'sends a PATCH request with the link url and params' do
-
         stub_request(entry_point.connection) do |stub|
           stub.patch('http://api.example.org/productions/1', '{"foo":"bar"}') { [200, {}, nil] }
         end
@@ -278,11 +267,20 @@ module Hyperclient
           resource.foos._embedded.orders.first.id.must_equal 1
           resource.foos.first.must_equal nil
         end
+
+        it 'backtracks when navigating links' do
+          resource = Resource.new({ '_links' => { 'next' => { 'href' => '/page2' } } }, entry_point)
+
+          stub_request(entry_point.connection) do |stub|
+            stub.get('http://api.example.org/page2') { [200, {}, { '_links' => { 'next' => { 'href' => 'http://api.example.org/page3' } } }] }
+          end
+
+          resource.next._links.next._url.must_equal 'http://api.example.org/page3'
+        end
       end
 
       describe 'resource' do
         before do
-
           stub_request(entry_point.connection) do |stub|
             stub.get('http://myapi.org/orders') { [200, {}, '{"resource": "This is the resource"}'] }
           end

data/test/hyperclient/resource_test.rb

@@ -101,6 +101,44 @@ module Hyperclient
           resource._attributes.expects(:foo).returns('bar')
           resource['foo'].must_equal 'bar'
         end
+
+        describe '#fetch' do
+          it 'returns the value for keys that exist' do
+            resource._attributes.expects(:foo).returns('bar')
+
+            resource.fetch('foo').must_equal 'bar'
+          end
+
+          it 'raises an error for missing keys' do
+            proc { resource.fetch('missing key') }.must_raise KeyError
+          end
+
+          describe 'with a default value' do
+            it 'returns the value for keys that exist' do
+              resource._attributes.expects(:foo).returns('bar')
+              resource.fetch('foo', 'default value').must_equal 'bar'
+            end
+
+            it 'returns the default value for missing keys' do
+              resource.fetch('missing key', 'default value').must_equal 'default value'
+            end
+          end
+
+          describe 'with a block' do
+            it 'returns the value for keys that exist' do
+              resource._attributes.expects(:foo).returns('bar')
+              resource.fetch('foo') { 'default value' }.must_equal 'bar'
+            end
+
+            it 'returns the value from the block' do
+              resource.fetch('z') { 'go fish!' }.must_equal 'go fish!'
+            end
+
+            it 'returns the value with args from the block' do
+              resource.fetch('z') { |el| "go fish, #{el}" }.must_equal 'go fish, z'
+            end
+          end
+        end
       end
     end
 

data/test/test_helper.rb

@@ -9,10 +9,8 @@ require 'json'
 require 'pry'
 
 MiniTest::Unit::TestCase.class_eval do
-
   def stub_request(conn, adapter_class = Faraday::Adapter::Test, &stubs_block)
     adapter_handler = conn.builder.handlers.find { |h| h.klass < Faraday::Adapter }
     conn.builder.swap(adapter_handler, adapter_class, &stubs_block)
   end
-
 end

metadata

@@ -1,195 +1,195 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Oriol Gual
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: futuroscope
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.10
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday_hal_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: uri_template
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: net-http-digest_auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: faraday-digestauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: spinach
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: HyperClient is a Ruby Hypermedia API client.
@@ -199,17 +199,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .rubocop_todo.yml
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
 - UPGRADING.md
 - examples/splines_api.rb
@@ -255,17 +256,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: ''