hyperclient 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59e7c90ae5eff9f4fcc9b99b104bbde8ae457182
-  data.tar.gz: d1c162933122ca4f64e3528f997056310672d03e
+  metadata.gz: 54fef5d6ab73927e7ac10dbccf6c1be3b4b7e32a
+  data.tar.gz: 41bf760d61b6f09bcf6a4526df9dcb04c56f1430
 SHA512:
-  metadata.gz: 25c690009c59d36791adb84400db774a7713a752c6ca9daffe42cea2334ccea4b7fc008a174749d5db8496ed1f7542fa7881297ad390f0f218351340c4731d16
-  data.tar.gz: 04bf4aa53c9ae55096b2eff9627006e22f3abd59af5732589080bd77173a6abe38d8bbc0fbe506d9f3cb0af1d3efe85b0cf8feaa59e3f6d5552192f1caac36ee
+  metadata.gz: b669fbd6b1be2cf46568da0e9351524602dc86eb0120168be5c1cbbf9cc22a50ee2f94985f315890507923db4d15f5350770a02b986fc7337bd4d0cec5e3c8ee
+  data.tar.gz: f7184b27bc26289af1e05b7f957a2ec44ecdd11bea8546ab608e875ee1c5f5f8d1b2efb8c80d9bd6c005710c4e3dc19c34edb450b4f39845aa10084acd65327a

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-12-21 20:00:37 +0000 using RuboCop version 0.42.0.
+# on 2017-08-26 18:01:43 +0100 using RuboCop version 0.42.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
@@ -9,9 +9,9 @@
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 109
+  Max: 110
 
-# Offense count: 89
+# Offense count: 97
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:

data/.travis.yml

@@ -4,17 +4,16 @@ sudo: false
 
 matrix:
   include:
-    - rvm: 2.3.1
+    - rvm: 2.4.1
+    - rvm: 2.4.1
       script:
         - bundle exec danger
-    - rvm: 2.3.1
-    - rvm: 2.3.0
-    - rvm: 2.2.5
-    - rvm: 2.4.0
+    - rvm: jruby-9.1.12.0
+    - rvm: jruby-head
+    - rvm: 2.2.7
+    - rvm: 2.3.4
     - rvm: rbx-2
     - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: jruby-9.1.7.0
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.8.6 (August 27, 2017)
+
+* [#122](https://github.com/codegram/hyperclient/pull/122): Improve error message when server returns invalid data - [@ivoanjo](https://github.com/ivoanjo).
+* [#125](https://github.com/codegram/hyperclient/pull/125): Add table of contents to readme and add note asking users to add their projects to the wiki - [@ivoanjo](https://github.com/ivoanjo).
+* [#127](https://github.com/codegram/hyperclient/pull/127): Minor fixes: Fix warnings, and pry-byebug to dev Gemfile and tweak rubocop execution - [@ivoanjo](https://github.com/ivoanjo).
+* [#128](https://github.com/codegram/hyperclient/pull/128): Fix link delegation returning nil for field with value false - [@ivoanjo](https://github.com/ivoanjo).
+
 ### 0.8.5 (July 5, 2017)
 
 * [#120](https://github.com/codegram/hyperclient/pull/120): Replace non-working homepage link in gemspec - [@ivoanjo](https://github.com/ivoanjo).

data/Gemfile

@@ -8,6 +8,7 @@ group :development do
   gem 'guard-minitest'
   gem 'guard-spinach'
   gem 'pry'
+  gem 'pry-byebug', platforms: :ruby
 end
 
 group :development, :test do

data/README.md

@@ -8,11 +8,29 @@
 
 Hyperclient is a Hypermedia API client written in Ruby. It fully supports [JSON HAL](http://stateless.co/hal_specification.html).
 
-## Usage
+* [Hyperclient](#hyperclient)
+* [Usage](#usage)
+  * [API Client](#api-client)
+  * [Resources and Attributes](#resources-and-attributes)
+  * [Links and Embedded Resources](#links-and-embedded-resources)
+  * [Templated Links](#templated-links)
+  * [Curies](#curies)
+  * [Attributes](#attributes)
+  * [HTTP](#http)
+  * [Asynchronous requests](#asynchronous-requests)
+* [Testing Using Hyperclient](#testing-using-hyperclient)
+* [Reference](#reference)
+* [Hyperclient Users](#hyperclient-users)
+* [Contributing](#contributing)
+* [License](#license)
+
+<sub><sup>ToC created with [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)</sup></sub>
+
+# Usage
 
 The examples in this README use the [Splines Demo API](https://github.com/ruby-grape/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
+## API Client
 
 Create an API client.
 
@@ -85,7 +103,7 @@ api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api')
 api.connection.use :http_cache
 ```
 
-### Resources and Attributes
+## Resources and Attributes
 
 Hyperclient will fetch and discover the resources from your API.
 
@@ -104,7 +122,7 @@ api.splines.each do |spline|
 end
 ```
 
-### Links and Embedded Resources
+## 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`.
 
@@ -112,7 +130,7 @@ The splines example above followed a link called "splines". While you can, you d
 api._links.splines
 ```
 
-### Templated Links
+## Templated Links
 
 Templated links require variables to be expanded. For example, the demo API has a link called "spline" that requires a spline "uuid".
 
@@ -125,7 +143,7 @@ Invoking `api.spline(uuid: 'uuid').reticulated` is equivalent to `api._links.spl
 
 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
 
 Curies are a suggested means by which to link documentation of a given resource. For example, the demo API contains very long links to images that use an "images" curie.
 
@@ -134,7 +152,7 @@ puts spline['image:thumbnail'] # => https://grape-with-roar.herokuapp.com/api/sp
 puts spline.links._curies['image'].expand('thumbnail') # => /docs/images/thumbnail
 ```
 
-### Attributes
+## Attributes
 
 Resource attributes can also be accessed as a hash.
 
@@ -144,7 +162,7 @@ puts spline.to_h # => {"uuid" => "uuid", "reticulated" => true}
 
 The above is equivalent to `spline._attributes.to_h`.
 
-### HTTP
+## HTTP
 
 Hyperclient uses [Faraday](http://github.com/lostisland/faraday) under the hood to perform HTTP calls. You can call any valid HTTP method on any resource.
 
@@ -187,7 +205,7 @@ spline._delete
 
 HTTP methods always return a new instance of Resource.
 
-### Asynchronous requests
+## Asynchronous requests
 
 By default, Hyperclient requests are performed asynchronously in a background thread pool via the [Futuroscope](https://github.com/codegram/futuroscope) gem. You can control the size of this pool by setting the `min_workers` and `max_workers` settings:
 
@@ -204,7 +222,7 @@ api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|
 end
 ```
 
-## Testing Using Hyperclient
+# Testing Using Hyperclient
 
 You can combine RSpec, Faraday::Adapter::Rack and Hyperclient to test your HAL API without having to ever examine the raw JSON response.
 
@@ -233,14 +251,18 @@ end
 
 For a complete example refer to [this Splines Demo API test](https://github.com/ruby-grape/grape-with-roar/blob/master/spec/api/splines_endpoint_with_hyperclient_spec.rb).
 
-## Reference
+# Reference
 
 [Hyperclient API Reference](http://rubydoc.org/github/codegram/hyperclient/master/frames).
 
-## Contributing
+# Hyperclient Users
+
+Using Hyperclient? Add your project to our wiki, please: <https://github.com/codegram/hyperclient/wiki>.
+
+# Contributing
 
 Hyperclient is work of [many people](https://github.com/codegram/hyperclient/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/codegram/hyperclient/pulls), [propose features and discuss issues](https://github.com/codegram/hyperclient/issues). See [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-## License
+# License
 
 MIT License, see [LICENSE](LICENSE) for details. Copyright 2012-2014 [Codegram Technologies](http://codegram.com).

data/Rakefile

@@ -38,4 +38,4 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :test, :spinach]
+task default: [:test, :spinach, :rubocop]

data/features/steps/default_config.rb

@@ -12,7 +12,7 @@ class Spinach::Features::DefaultConfig < Spinach::FeatureSteps
   end
 
   step 'I send some data to the API' do
-    stub_request(:post, 'http://api.example.org/posts')
+    stub_request(:post, 'http://api.example.org/posts').to_return(headers: { 'Content-Type' => 'application/hal+json' })
     assert_equal 200, api._links.posts._post(title: 'My first blog post')._response.status
   end
 

data/hyperclient.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/hyperclient/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ['Oriol Gual']
   gem.email         = ['oriol.gual@gmail.com']
-  gem.description   = 'HyperClient is a Ruby Hypermedia API client.'
+  gem.description   = 'Hyperclient is a Ruby Hypermedia API client.'
   gem.summary       = ''
   gem.homepage      = 'https://github.com/codegram/hyperclient/'
   gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }

data/lib/hyperclient/entry_point.rb

@@ -41,6 +41,8 @@ module Hyperclient
       @options = { async: true }
       @connection = nil
       @resource = nil
+      @key = nil
+      @uri_variables = nil
       yield self if block_given?
     end
 

data/lib/hyperclient/link.rb

@@ -126,7 +126,8 @@ module Hyperclient
     # Internal: Delegate the method further down the API if the resource cannot serve it.
     def method_missing(method, *args, &block)
       if _resource.respond_to?(method.to_s)
-        _resource.send(method, *args, &block) || delegate_method(method, *args, &block)
+        result = _resource.send(method, *args, &block)
+        result.nil? ? delegate_method(method, *args, &block) : result
       else
         super
       end

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)
@@ -68,6 +80,21 @@ module Hyperclient
 
     private
 
+    # Internal: Ensures the received representation is a valid Hash-lookalike.
+    def validate(representation)
+      return {} unless representation
+
+      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

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = '0.8.5'.freeze
+  VERSION = '0.8.6'.freeze
 end

data/test/hyperclient/link_test.rb

@@ -479,6 +479,16 @@ module Hyperclient
           resource.orders.first.id.must_equal 1
         end
 
+        it 'can handle false values in the response' do
+          resource = Resource.new({ '_links' => { 'orders' => { 'href' => '/orders' } } }, entry_point)
+
+          stub_request(entry_point.connection) do |stub|
+            stub.get('http://api.example.org/orders') { [200, {}, { 'any' => false }] }
+          end
+
+          resource.orders.any.must_equal false
+        end
+
         it "doesn't delegate when link key doesn't match" do
           resource = Resource.new({ '_links' => { 'foos' => { 'href' => '/orders' } } }, entry_point)
 

data/test/hyperclient/resource_test.rb

@@ -40,6 +40,12 @@ module Hyperclient
 
         resource._response.body.must_equal body
       end
+
+      describe 'with an invalid representation' do
+        it 'raises an InvalidRepresentationError' do
+          proc { Resource.new('invalid representation data', entry_point) }.must_raise InvalidRepresentationError
+        end
+      end
     end
 
     describe '_links' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Oriol Gual
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: HyperClient is a Ruby Hypermedia API client.
+description: Hyperclient is a Ruby Hypermedia API client.
 email:
 - oriol.gual@gmail.com
 executables: []
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: ''