hyperclient 0.8.5 → 1.0.1

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+
 require 'rubygems'
 require 'bundler'
 Bundler.setup :default, :test, :development
@@ -13,13 +14,6 @@ if ENV['COVERAGE']
   end
 end
 
-require 'yard'
-YARD::Config.load_plugin('yard-tomdoc')
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
-  t.options = %w(-r README.md)
-end
-
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
@@ -38,4 +32,4 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :test, :spinach]
+task default: %i[test spinach rubocop]

data/UPGRADING.md

@@ -1,6 +1,22 @@
 Upgrading Hyperclient
 =====================
 
+### Upgrading to >= 0.9.0
+
+Previous versions of Hyperclient performed asynchronous requests using [futuroscope](https://github.com/codegram/futuroscope) by default, which could be disabled by providing the `:async` option to each Hyperclient instance. This has been removed and you can remove any such code.
+
+```ruby
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|
+  client.options[:async] = false
+end
+```
+
+The default new behavior is synchronous. We recommend [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) for your asynchronous needs.
+
+Include [futuroscope](https://github.com/codegram/futuroscope) in your `Gemfile` and wrap Hyperclient requests into `Futuroscope::Future.new` blocks to get the old behavior.
+
+See [#133](https://github.com/codegram/hyperclient/pull/133) and [#123](https://github.com/codegram/hyperclient/issues/123) for more information.
+
 ### Upgrading to >= 0.8.0
 
 ### Changes in curies

data/features/api_navigation.feature

@@ -7,6 +7,11 @@ Feature: API navigation
     When I connect to the API
     Then I should be able to navigate to posts and authors
 
+  Scenario: Links
+    When I connect to the API
+    Then I should be able to paginate posts
+    Then I should be able to paginate authors
+
   Scenario: Templated links
     Given I connect to the API
     When I search for a post with a templated link

data/features/steps/api_navigation.rb

@@ -9,6 +9,19 @@ class Spinach::Features::ApiNavigation < Spinach::FeatureSteps
     assert_requested :get, 'http://api.example.org/authors'
   end
 
+  step 'I should be able to paginate posts' do
+    assert_kind_of Enumerator, api.posts.each
+    assert_equal 4, api.posts.to_a.count
+    assert_requested :get, 'http://api.example.org/posts'
+    assert_requested :get, 'http://api.example.org/posts?page=2'
+    assert_requested :get, 'http://api.example.org/posts?page=3'
+  end
+
+  step 'I should be able to paginate authors' do
+    assert_equal 1, api._links['api:authors'].to_a.count
+    assert_requested :get, 'http://api.example.org/authors'
+  end
+
   step 'I search for a post with a templated link' do
     api._links.search._expand(q: 'something')._resource
   end
@@ -18,7 +31,7 @@ class Spinach::Features::ApiNavigation < Spinach::FeatureSteps
   end
 
   step 'I search for posts by tag with a templated link' do
-    api._links.tagged._expand(tags: %w(foo bar))._resource
+    api._links.tagged._expand(tags: %w[foo bar])._resource
   end
 
   step 'the API should receive the request for posts by tag with all the params' do
@@ -50,8 +63,8 @@ class Spinach::Features::ApiNavigation < Spinach::FeatureSteps
   step 'I should be able to count embedded items' do
     assert_equal 2, api._links.posts._resource._embedded.posts.count
     assert_equal 2, api.posts._embedded.posts.count
-    assert_equal 2, api.posts.count
-    assert_equal 2, api.posts.map.count
+    assert_equal 4, api.posts.count
+    assert_equal 4, api.posts.map.count
   end
 
   step 'I should be able to iterate over embedded items' do
@@ -59,6 +72,6 @@ class Spinach::Features::ApiNavigation < Spinach::FeatureSteps
     api.posts.each do |_post|
       count += 1
     end
-    assert_equal 2, count
+    assert_equal 4, count
   end
 end

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
 
@@ -25,7 +25,7 @@ class Spinach::Features::DefaultConfig < Spinach::FeatureSteps
   end
 
   step 'it should have been parsed as JSON' do
-    @posts._attributes.total_posts.to_i.must_equal 2
-    @posts._attributes['total_posts'].to_i.must_equal 2
+    @posts._attributes.total_posts.to_i.must_equal 4
+    @posts._attributes['total_posts'].to_i.must_equal 4
   end
 end

data/features/support/api.rb

@@ -7,9 +7,15 @@ module API
   before do
     WebMock::Config.instance.query_values_notation = :flat_array
 
-    stub_request(:any, %r{api.example.org*}).to_return(body: root_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:any, /api.example.org*/).to_return(body: root_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org').to_return(body: root_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/authors').to_return(body: authors_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/posts?page=2').to_return(body: posts_page2_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/posts?page=3').to_return(body: posts_page3_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/posts/1').to_return(body: post1_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/posts/2').to_return(body: post2_response, headers: { 'Content-Type' => 'application/hal+json' })
+    stub_request(:get, 'api.example.org/posts/3').to_return(body: post3_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

data/features/support/fixtures.rb

@@ -15,13 +15,32 @@ module Spinach
       }'
     end
 
+    def authors_response
+      '{
+          "_links": {
+            "self": { "href": "/authors" }
+          },
+          "_embedded": {
+            "api:authors": [
+              {
+                "name": "Lorem Ipsum",
+                "_links": {
+                  "self": { "href": "/authors/1" }
+                }
+              }
+            ]
+          }
+      }'
+    end
+
     def posts_response
       '{
           "_links": {
             "self": { "href": "/posts" },
+            "next": {"href": "/posts?page=2"},
             "last_post": {"href": "/posts/1"}
           },
-          "total_posts": "2",
+          "total_posts": "4",
           "_embedded": {
             "posts": [
               {
@@ -43,7 +62,48 @@ module Spinach
       }'
     end
 
-    def post_response
+    def posts_page2_response
+      '{
+          "_links": {
+            "self": { "href": "/posts?page=2" },
+            "next": { "href": "/posts?page=3" }
+          },
+          "total_posts": "4",
+          "_embedded": {
+            "posts": [
+              {
+                "title": "My third blog post",
+                "body":  "Lorem ipsum dolor sit amet",
+                "_links": {
+                  "self": { "href": "/posts/3" }
+                }
+              }
+            ]
+          }
+      }'
+    end
+
+    def posts_page3_response
+      '{
+          "_links": {
+            "self": { "href": "/posts?page=3" }
+          },
+          "total_posts": "4",
+          "_embedded": {
+            "posts": [
+              {
+                "title": "My third blog post",
+                "body":  "Lorem ipsum dolor sit amet",
+                "_links": {
+                  "self": { "href": "/posts/4" }
+                }
+              }
+            ]
+          }
+      }'
+    end
+
+    def post1_response
       '{
           "_links": {
             "self": { "href": "/posts/1" }
@@ -60,6 +120,40 @@ module Spinach
       }'
     end
 
+    def post2_response
+      '{
+          "_links": {
+            "self": { "href": "/posts/2" }
+          },
+          "title": "My first blog post",
+          "body":  "Lorem ipsum dolor sit amet",
+          "_embedded": {
+            "comments": [
+              {
+                "title": "Some comment"
+              }
+            ]
+          }
+      }'
+    end
+
+    def post3_response
+      '{
+          "_links": {
+            "self": { "href": "/posts/3" }
+          },
+          "title": "My first blog post",
+          "body":  "Lorem ipsum dolor sit amet",
+          "_embedded": {
+            "comments": [
+              {
+                "title": "Some comment"
+              }
+            ]
+          }
+      }'
+    end
+
     def page2_response
       '{
           "_links": {

data/hyperclient.gemspec

@@ -1,10 +1,9 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/hyperclient/version', __FILE__)
+require File.expand_path('lib/hyperclient/version', __dir__)
 
 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) }
@@ -14,11 +13,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Hyperclient::VERSION
 
+  gem.add_dependency 'addressable'
   gem.add_dependency 'faraday', '>= 0.9.0'
-  gem.add_dependency 'futuroscope'
-  gem.add_dependency 'faraday_middleware'
   gem.add_dependency 'faraday_hal_middleware'
-  gem.add_dependency 'uri_template'
-  gem.add_dependency 'net-http-digest_auth'
-  gem.add_dependency 'faraday-digestauth'
+  gem.add_dependency 'faraday_middleware'
 end

data/lib/hyperclient/collection.rb

@@ -35,7 +35,7 @@ module Hyperclient
     end
 
     # Public: Returns a value from the collection for the given key.
-    # If the key can’t be found, there are several options:
+    # If the key can't be found, there are several options:
     # With no other arguments, it will raise an KeyError exception;
     # if default is given, then that will be returned;
     #

data/lib/hyperclient/curie.rb

@@ -41,7 +41,8 @@ module Hyperclient
     # Returns a new expanded url.
     def expand(rel)
       return rel unless rel && templated?
-      href.gsub('{rel}', rel) if href
+
+      href&.gsub('{rel}', rel)
     end
   end
 end

data/lib/hyperclient/entry_point.rb

@@ -1,6 +1,5 @@
 require 'faraday_middleware'
 require 'faraday_hal_middleware'
-require_relative '../faraday/connection'
 
 module Hyperclient
   # Public: Exception that is raised when trying to modify an
@@ -30,7 +29,7 @@ module Hyperclient
     extend Forwardable
 
     # Public: Delegates common methods to be used with the Faraday connection.
-    def_delegators :connection, :basic_auth, :digest_auth, :token_auth, :params, :params=
+    def_delegators :connection, :params, :params=
 
     # Public: Initializes an EntryPoint.
     #
@@ -38,9 +37,11 @@ module Hyperclient
     def initialize(url, &_block)
       @link = { 'href' => url }
       @entry_point = self
-      @options = { async: true }
+      @options = {}
       @connection = nil
       @resource = nil
+      @key = nil
+      @uri_variables = nil
       yield self if block_given?
     end
 
@@ -55,12 +56,12 @@ module Hyperclient
       @faraday_options ||= options.dup
       if block_given?
         raise ConnectionAlreadyInitializedError if @connection
+
         @faraday_block = if @faraday_options.delete(:default) == false
                            block
                          else
                            lambda do |conn|
-                             default_faraday_block.call conn
-                             yield conn
+                             default_faraday_block.call(conn, &block)
                            end
                          end
       else
@@ -73,6 +74,7 @@ module Hyperclient
     # Returns a Hash.
     def headers
       return @connection.headers if @connection
+
       @headers ||= default_headers
     end
 
@@ -81,6 +83,7 @@ module Hyperclient
     # value    - A Hash containing headers to include with every API request.
     def headers=(value)
       raise ConnectionAlreadyInitializedError if @connection
+
       @headers = value
     end
 
@@ -96,6 +99,7 @@ module Hyperclient
     # value    - A Hash containing options to pass to Faraday
     def faraday_options=(value)
       raise ConnectionAlreadyInitializedError if @connection
+
       @faraday_options = value
     end
 
@@ -111,14 +115,13 @@ module Hyperclient
     # value    - A Proc accepting a Faraday::Connection.
     def faraday_block=(value)
       raise ConnectionAlreadyInitializedError if @connection
+
       @faraday_block = value
     end
 
     # Public: Read/Set options.
     #
-    # value    - A Hash containing the client options. Use { async: false } to
-    # to disable the default behavior of performing requests asynchronously
-    # using futures.
+    # value    - A Hash containing the client options.
     attr_accessor :options
 
     private
@@ -133,11 +136,14 @@ module Hyperclient
     #
     # Returns a block.
     def default_faraday_block
-      lambda do |connection|
+      lambda do |connection, &block|
         connection.use Faraday::Response::RaiseError
         connection.use FaradayMiddleware::FollowRedirects
         connection.request :hal_json
         connection.response :hal_json, content_type: /\bjson$/
+
+        block&.call(connection)
+
         connection.adapter :net_http
         connection.options.params_encoder = Faraday::FlatParamsEncoder
       end

data/lib/hyperclient/link.rb

@@ -1,10 +1,11 @@
-require 'uri_template'
-require 'futuroscope'
+require 'addressable'
 
 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.
@@ -20,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.
@@ -40,7 +60,8 @@ module Hyperclient
     # Public: Returns the url of the Link.
     def _url
       return @link['href'] unless _templated?
-      @url ||= _uri_template.expand(@uri_variables || {})
+
+      @url ||= _uri_template.expand(@uri_variables || {}).to_s
     end
 
     # Public: Returns an array of variables from the URITemplate.
@@ -126,7 +147,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
@@ -137,8 +159,10 @@ module Hyperclient
     # 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)
+      return unless @delegate&.respond_to?(method.to_s)
+
       @delegate.send(method, *args, &block)
     end
 
@@ -162,20 +186,12 @@ module Hyperclient
 
     # Internal: Memoization for a URITemplate instance
     def _uri_template
-      @uri_template ||= URITemplate.new(@link['href'])
+      @uri_template ||= Addressable::Template.new(@link['href'])
     end
 
     def http_method(method, body = nil)
       @resource = begin
-        response =
-          if @entry_point.options[:async]
-            Futuroscope::Future.new do
-              @entry_point.connection.run_request(method, _url, body, nil)
-            end
-          else
-            @entry_point.connection.run_request(method, _url, body, nil)
-          end
-
+        response = @entry_point.connection.run_request(method, _url, body, nil)
         Resource.new(response.body, @entry_point, response)
       end
     end