hyperclient 0.9.1 → 1.0.1

data/lib/hyperclient/link.rb

@@ -4,6 +4,8 @@ module Hyperclient
   # Internal: The Link is used to let a Resource interact with the API.
   #
   class Link
+    include Enumerable
+
     # Public: Initializes a new Link.
     #
     # key           - The key or name of the link.
@@ -19,6 +21,25 @@ module Hyperclient
       @resource      = nil
     end
 
+    # Public: Each implementation to allow the class to use the Enumerable
+    # benefits for paginated, embedded items.
+    #
+    # Returns an Enumerator.
+    def each(&block)
+      if block_given?
+        current = self
+        while current
+          coll = current.respond_to?(@key) ? current.send(@key) : _resource
+          coll.each(&block)
+          break unless current._links[:next]
+
+          current = current._links.next
+        end
+      else
+        to_enum(:each)
+      end
+    end
+
     # Public: Indicates if the link is an URITemplate or a regular URI.
     #
     # Returns true if it is templated.

data/lib/hyperclient/link_collection.rb

@@ -15,7 +15,9 @@ module Hyperclient
     # curies      - The Hash with link curies.
     # entry_point - The EntryPoint object to inject the configuration.
     def initialize(collection, curies, entry_point)
-      raise "Invalid response for LinkCollection. The response was: #{collection.inspect}" if collection && !collection.respond_to?(:collect)
+      if collection && !collection.respond_to?(:collect)
+        raise "Invalid response for LinkCollection. The response was: #{collection.inspect}"
+      end
 
       @_curies = (curies || {}).reduce({}) do |hash, curie_hash|
         curie = build_curie(curie_hash, entry_point)

data/lib/hyperclient/resource.rb

@@ -111,7 +111,9 @@ module Hyperclient
       elsif !Array.method_defined?(method)
         %i[_attributes _embedded _links].each do |target|
           target = send(target)
-          return target.send(method, *args, &block) if target.respond_to?(method.to_s)
+          if target.respond_to?(method.to_s)
+            return target.send(method, *args, &block)
+          end
         end
         super
       end

data/lib/hyperclient/resource_collection.rb

@@ -23,7 +23,9 @@ module Hyperclient
     private
 
     def build_resource(representation)
-      return representation.map(&method(:build_resource)) if representation.is_a?(Array)
+      if representation.is_a?(Array)
+        return representation.map(&method(:build_resource))
+      end
 
       Resource.new(representation, @entry_point)
     end

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = '0.9.1'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/test/hyperclient/attributes_test.rb

@@ -12,29 +12,29 @@ module Hyperclient
     end
 
     it 'does not set _links as an attribute' do
-      attributes.wont_respond_to :_links
+      _(attributes).wont_respond_to :_links
     end
 
     it 'does not set _embedded as an attribute' do
-      attributes.wont_respond_to :_embedded
+      _(attributes).wont_respond_to :_embedded
     end
 
     it 'sets normal attributes' do
-      attributes.must_respond_to :permitted
-      attributes.permitted.must_equal true
+      _(attributes).must_respond_to :permitted
+      _(attributes.permitted).must_equal true
 
-      attributes.must_respond_to :title
-      attributes.title.must_equal 'Real World ASP.NET MVC3'
+      _(attributes).must_respond_to :title
+      _(attributes.title).must_equal 'Real World ASP.NET MVC3'
     end
 
     # Underscores should be allowed per http://tools.ietf.org/html/draft-kelly-json-hal#appendix-B.4
     it 'sets _hidden_attribute as an attribute' do
-      attributes.must_respond_to :_hidden_attribute
-      attributes._hidden_attribute.must_equal 'useful value'
+      _(attributes).must_respond_to :_hidden_attribute
+      _(attributes._hidden_attribute).must_equal 'useful value'
     end
 
     it 'is a collection' do
-      Attributes.ancestors.must_include Collection
+      _(Attributes.ancestors).must_include Collection
     end
   end
 end

data/test/hyperclient/collection_test.rb

@@ -12,19 +12,19 @@ module Hyperclient
     end
 
     it 'exposes the collection as methods' do
-      collection.title.must_equal 'Real World ASP.NET MVC3'
-      collection.description.must_match(/production/)
-      collection.permitted.must_equal true
+      _(collection.title).must_equal 'Real World ASP.NET MVC3'
+      _(collection.description).must_match(/production/)
+      _(collection.permitted).must_equal true
     end
 
     it 'exposes collection as a hash' do
-      collection['title'].must_equal 'Real World ASP.NET MVC3'
-      collection['description'].must_match(/production/)
-      collection['permitted'].must_equal true
+      _(collection['title']).must_equal 'Real World ASP.NET MVC3'
+      _(collection['description']).must_match(/production/)
+      _(collection['permitted']).must_equal true
     end
 
     it 'correctly responds to methods' do
-      collection.must_respond_to :title
+      _(collection).must_respond_to :title
     end
 
     it 'acts as enumerable' do
@@ -32,41 +32,41 @@ module Hyperclient
         name
       end
 
-      names.must_equal %w[_links title description permitted _hidden_attribute _embedded]
+      _(names).must_equal %w[_links title description permitted _hidden_attribute _embedded]
     end
 
     describe '#to_hash' do
       it 'returns the wrapped collection as a hash' do
-        collection.to_hash.must_be_kind_of Hash
+        _(collection.to_hash).must_be_kind_of Hash
       end
     end
 
     describe 'include?' do
       it 'returns true for keys that exist' do
-        collection.include?('_links').must_equal true
+        _(collection.include?('_links')).must_equal true
       end
 
       it 'returns false for missing keys' do
-        collection.include?('missing key').must_equal false
+        _(collection.include?('missing key')).must_equal false
       end
     end
 
     describe '#fetch' do
       it 'returns the value for keys that exist' do
-        collection.fetch('title').must_equal 'Real World ASP.NET MVC3'
+        _(collection.fetch('title')).must_equal 'Real World ASP.NET MVC3'
       end
 
       it 'raises an error for missing keys' do
-        proc { collection.fetch('missing key') }.must_raise KeyError
+        _(proc { collection.fetch('missing key') }).must_raise KeyError
       end
 
       describe 'with a default value' do
         it 'returns the value for keys that exist' do
-          collection.fetch('title', 'default').must_equal 'Real World ASP.NET MVC3'
+          _(collection.fetch('title', 'default')).must_equal 'Real World ASP.NET MVC3'
         end
 
         it 'returns the default value for missing keys' do
-          collection.fetch('missing key', 'default').must_equal 'default'
+          _(collection.fetch('missing key', 'default')).must_equal 'default'
         end
       end
     end

data/test/hyperclient/curie_test.rb

@@ -11,13 +11,13 @@ module Hyperclient
       it 'returns true if the curie is templated' do
         curie = Curie.new({ 'name' => 'image', 'templated' => true }, entry_point)
 
-        curie.templated?.must_equal true
+        _(curie.templated?).must_equal true
       end
 
       it 'returns false if the curie is not templated' do
         curie = Curie.new({ 'name' => 'image' }, entry_point)
 
-        curie.templated?.must_equal false
+        _(curie.templated?).must_equal false
       end
     end
 
@@ -26,12 +26,12 @@ module Hyperclient
     end
     describe '_name' do
       it 'returns curie name' do
-        curie.name.must_equal 'image'
+        _(curie.name).must_equal 'image'
       end
     end
     describe 'expand' do
       it 'expands link' do
-        curie.expand('thumbnail').must_equal '/images/thumbnail'
+        _(curie.expand('thumbnail')).must_equal '/images/thumbnail'
       end
     end
   end

data/test/hyperclient/entry_point_test.rb

@@ -10,53 +10,52 @@ module Hyperclient
 
       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/'
+          _(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/hal+json'
-          entry_point.headers['Accept'].must_equal 'application/hal+json,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
-          entry_point.connection.must_be_kind_of Faraday::Connection
+          _(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'
+          _(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).must_be_kind_of Faraday::Connection
           entry_point.connection.use :instrumentation
           handlers = entry_point.connection.builder.handlers
-          handlers.must_include FaradayMiddleware::Instrumentation
+          _(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::EncodeHalJson
-          handlers.must_include FaradayMiddleware::ParseHalJson
-          handlers.must_include Faraday::Adapter::NetHttp
+          _(handlers).must_include Faraday::Response::RaiseError
+          _(handlers).must_include FaradayMiddleware::FollowRedirects
+          _(handlers).must_include FaradayMiddleware::EncodeHalJson
+          _(handlers).must_include FaradayMiddleware::ParseHalJson
 
-          entry_point.connection.options.params_encoder.must_equal Faraday::FlatParamsEncoder
+          _(entry_point.connection.options.params_encoder).must_equal Faraday::FlatParamsEncoder
         end
 
         it 'raises a  ConnectionAlreadyInitializedError if attempting to modify headers' do
-          entry_point.connection.must_be_kind_of Faraday::Connection
-          -> { entry_point.headers = {} }.must_raise ConnectionAlreadyInitializedError
+          _(entry_point.connection).must_be_kind_of Faraday::Connection
+          _(-> { 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
-          -> { entry_point.connection {} }.must_raise ConnectionAlreadyInitializedError
+          _(entry_point.connection).must_be_kind_of Faraday::Connection
+          _(-> { 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'
+          _(entry_point._url).must_equal 'http://my.api.org'
         end
       end
     end
@@ -70,17 +69,17 @@ module Hyperclient
 
       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/'
+          _(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/hal+json'
-          entry_point.headers['Accept'].must_equal 'application/hal+json,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 'creates a Faraday connection with options' do
-          entry_point.connection.proxy.must_be_kind_of Faraday::ProxyOptions
-          entry_point.connection.proxy.uri.to_s.must_equal 'http://my.proxy:8080'
+          _(entry_point.connection.proxy).must_be_kind_of Faraday::ProxyOptions
+          _(entry_point.connection.proxy.uri.to_s).must_equal 'http://my.proxy:8080'
         end
       end
     end
@@ -94,17 +93,17 @@ module Hyperclient
 
       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/'
+          _(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/hal+json'
-          entry_point.headers['Accept'].must_equal 'application/hal+json,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 'creates a Faraday connection with options' do
-          entry_point.connection.proxy.must_be_kind_of Faraday::ProxyOptions
-          entry_point.connection.proxy.uri.to_s.must_equal 'http://my.proxy:8080'
+          _(entry_point.connection.proxy).must_be_kind_of Faraday::ProxyOptions
+          _(entry_point.connection.proxy.uri.to_s).must_equal 'http://my.proxy:8080'
         end
       end
     end
@@ -127,21 +126,20 @@ module Hyperclient
 
       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/'
+          _(entry_point.connection.url_prefix.to_s).must_equal 'http://my.api.org/'
         end
 
         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'
+          _(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.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
+          _(handlers).wont_include Faraday::Response::RaiseError
+          _(handlers).wont_include FaradayMiddleware::FollowRedirects
+          _(handlers).must_include FaradayMiddleware::EncodeJson
+          _(handlers).must_include FaradayMiddleware::ParseJson
         end
       end
     end
@@ -158,26 +156,25 @@ 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/hal+json'
-          entry_point.headers['Accept'].must_equal 'application/hal+json,application/json'
-          entry_point.headers['Access-Token'].must_equal 'token'
+          _(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
 
         it 'creates a Faraday connection with the entry point url' do
-          entry_point.connection.url_prefix.to_s.must_equal 'http://my.api.org/'
+          _(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::EncodeHalJson
-          handlers.must_include FaradayMiddleware::ParseHalJson
-          handlers.must_include Faraday::Adapter::NetHttp
+          _(handlers).must_include Faraday::Request::OAuth
+          _(handlers).must_include Faraday::Response::RaiseError
+          _(handlers).must_include FaradayMiddleware::FollowRedirects
+          _(handlers).must_include FaradayMiddleware::EncodeHalJson
+          _(handlers).must_include FaradayMiddleware::ParseHalJson
 
-          entry_point.connection.options.params_encoder.must_equal Faraday::FlatParamsEncoder
+          _(entry_point.connection.options.params_encoder).must_equal Faraday::FlatParamsEncoder
         end
       end
     end

data/test/hyperclient/link_collection_test.rb

@@ -14,33 +14,33 @@ module Hyperclient
     end
 
     it 'is a collection' do
-      LinkCollection.ancestors.must_include Collection
+      _(LinkCollection.ancestors).must_include Collection
     end
 
     it 'initializes the collection with links' do
-      links.must_respond_to :search
-      links.must_respond_to :gizmos
+      _(links).must_respond_to :search
+      _(links).must_respond_to :gizmos
     end
 
     it 'returns link objects for each link' do
-      links.search.must_be_kind_of Link
-      links['self'].must_be_kind_of Link
+      _(links.search).must_be_kind_of Link
+      _(links['self']).must_be_kind_of Link
 
-      links.gizmos.must_be_kind_of Array
-      links['gizmos'].must_be_kind_of Array
+      _(links.gizmos).must_be_kind_of Array
+      _(links['gizmos']).must_be_kind_of Array
     end
 
     describe 'plain link' do
       let(:plain_link) { links.self }
       it 'must be correct' do
-        plain_link._url.must_equal '/productions/1'
+        _(plain_link._url).must_equal '/productions/1'
       end
     end
 
     describe 'templated link' do
       let(:templated_link) { links.search }
       it 'must expand' do
-        templated_link._expand(search: 'gizmos')._url.must_equal '/productions/1?categories=gizmos'
+        _(templated_link._expand(search: 'gizmos')._url).must_equal '/productions/1?categories=gizmos'
       end
     end
 
@@ -48,10 +48,10 @@ module Hyperclient
       let(:curied_link) { links['image:thumbnail'] }
       let(:curie) { links._curies['image'] }
       it 'must expand' do
-        curied_link._expand(version: 'small')._url.must_equal '/images/thumbnails/small.jpg'
+        _(curied_link._expand(version: 'small')._url).must_equal '/images/thumbnails/small.jpg'
       end
       it 'exposes curie' do
-        curie.expand('thumbnail').must_equal '/docs/images/thumbnail'
+        _(curie.expand('thumbnail')).must_equal '/docs/images/thumbnail'
       end
     end
 
@@ -59,12 +59,12 @@ module Hyperclient
       let(:gizmos) { links.gizmos }
 
       it 'should have 2 items' do
-        gizmos.length.must_equal 2
+        _(gizmos.length).must_equal 2
       end
 
       it 'must be an array of Links' do
         gizmos.each do |link|
-          link.must_be_kind_of Link
+          _(link).must_be_kind_of Link
         end
       end
     end
@@ -72,7 +72,7 @@ module Hyperclient
     describe 'null link value' do
       let(:null_link) { links.null_link }
       it 'must be nil' do
-        null_link.must_be_nil
+        _(null_link).must_be_nil
       end
     end
   end