hyperclient 0.8.5 → 1.0.1

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

@@ -1,6 +1,17 @@
 require 'forwardable'
 
 module Hyperclient
+  # Public: Exception that is raised when passing in invalid representation data
+  # for the resource.
+  class InvalidRepresentationError < ArgumentError
+    attr_reader :representation
+
+    def initialize(error_description, representation)
+      super(error_description)
+      @representation = representation
+    end
+  end
+
   # Public: Represents a resource from your API. Its responsability is to
   # ease the way you access its  attributes, links and embedded resources.
   class Resource
@@ -29,8 +40,9 @@ module Hyperclient
     # representation - The hash with the HAL representation of the Resource.
     # entry_point    - The EntryPoint object to inject the configutation.
     def initialize(representation, entry_point, response = nil)
-      representation = representation ? representation.dup : {}
+      representation = validate(representation)
       links = representation['_links'] || {}
+
       @_links       = LinkCollection.new(links, links['curies'], entry_point)
       @_embedded    = ResourceCollection.new(representation['_embedded'], entry_point)
       @_attributes  = Attributes.new(representation)
@@ -43,11 +55,11 @@ module Hyperclient
     end
 
     def _success?
-      _response && _response.success?
+      _response&.success?
     end
 
     def _status
-      _response && _response.status
+      _response&.status
     end
 
     def [](name)
@@ -68,6 +80,21 @@ module Hyperclient
 
     private
 
+    # Internal: Ensures the received representation is a valid Hash-lookalike.
+    def validate(representation)
+      return {} if representation.nil? || representation.empty?
+
+      if representation.respond_to?(:to_hash)
+        representation.to_hash.dup
+      else
+        raise InvalidRepresentationError.new(
+          "Invalid representation for resource (got #{representation.class}, expected Hash). " \
+          "Is your web server returning JSON HAL data with a 'Content-Type: application/hal+json' header?",
+          representation
+        )
+      end
+    end
+
     # Internal: Returns the self Link of the Resource. Used to handle the HTTP
     # methods.
     def _self_link
@@ -82,9 +109,11 @@ module Hyperclient
       if args.any? && args.first.is_a?(Hash)
         _links.send(method, [], &block)._expand(*args)
       elsif !Array.method_defined?(method)
-        [:_attributes, :_embedded, :_links].each do |target|
+        %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
@@ -93,7 +122,7 @@ module Hyperclient
     # Internal: Accessory method to allow the resource respond to
     # methods that will hit method_missing.
     def respond_to_missing?(method, include_private = false)
-      [:_attributes, :_embedded, :_links].each do |target|
+      %i[_attributes _embedded _links].each do |target|
         return true if send(target).respond_to?(method, include_private)
       end
       false

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.8.5'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/test/fixtures/element.json

@@ -3,8 +3,8 @@
         "self": {
             "href": "/productions/1"
         },
-        "filter": {
-            "href": "/productions/1?categories={filter}",
+        "search": {
+            "href": "/productions/1?categories={search}",
             "templated": true
         },
         "gizmos": [
@@ -15,17 +15,17 @@
                 "href": "/gizmos/2"
             }
         ],
-        "curies" : [
+        "curies": [
             {
-              "name": "image",
-              "href": "/docs/images/{rel}",
-              "templated": true
+                "name": "image",
+                "href": "/docs/images/{rel}",
+                "templated": true
             }
         ],
         "null_link": null,
         "image:thumbnail": {
-          "href": "/images/thumbnails/{version}.jpg",
-          "templated": true
+            "href": "/images/thumbnails/{version}.jpg",
+            "templated": true
         }
     },
     "title": "Real World ASP.NET MVC3",
@@ -48,9 +48,9 @@
                         "href": "/episodes/1"
                     },
                     "media": {
-                            "type": "video/webm; codecs='vp8.0, vorbis'",
-                            "href": "/media/1"
-                        }
+                        "type": "video/webm; codecs='vp8.0, vorbis'",
+                        "href": "/media/1"
+                    }
                 },
                 "title": "Foundations",
                 "description": "In this episode we talk about what it is we're doing: building our startup and getting ourselves off the ground. We take..",
@@ -62,9 +62,9 @@
                         "href": "/episodes/2"
                     },
                     "media": {
-                            "type": "video/ogg; codecs='theora, vorbis'",
-                            "href": "/media/4"
-                        }
+                        "type": "video/ogg; codecs='theora, vorbis'",
+                        "href": "/media/4"
+                    }
                 },
                 "title": "Membership",
                 "description": "In this episode Rob hooks up testing in an effort to deal with ASP.NET Membership. The team has decided..",
@@ -72,4 +72,4 @@
             }
         ]
     }
-}
+}

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,59 +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
-          lambda { 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
-          lambda { 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'
-        end
-      end
-
-      describe 'options' do
-        it 'enables the async option by default' do
-          entry_point.options[:async].must_equal true
+          _(entry_point._url).must_equal 'http://my.api.org'
         end
       end
     end
@@ -76,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
@@ -100,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
@@ -133,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
@@ -164,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