hyperclient 0.9.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30a6a424eb3f9cd9a70b19d49f3f9d3f3b952921fb6a2b034116296c7eb1e31f
-  data.tar.gz: b35c0cd0abaa39753b53f59c0f718152acf3a8915b498d0acef4e7b8f2f0d82c
+  metadata.gz: 5f55cb82362d8eca25347e15c91387bbf2957f1f1241af27fccff1086b412d1b
+  data.tar.gz: f31325a293b0aec888b94910b8c3dc28d2f30a6666fe59063b4112251f46e7c4
 SHA512:
-  metadata.gz: 93c51dca3fa731081e1e82540d0c0f2d22f17e65ae336021b4b7199eac4ff1eecd3bd37e840cc02831e2d62b98d20a4a1e696dd5fba8bdd5ff51516f6bc763b6
-  data.tar.gz: 9a2ad7090c37531384d42105754bc4d492ba711048d758b042863e43a43612317007d8446c02ad0efc88e09f95f6f5cdbb48239319724e1c2f35862f2ad92dcc
+  metadata.gz: e9b17e112614d3c600497c6c7cfd56268195427da789629d006742ff96e70d2b6972ba16fbfa075ab62613eeace923d8fdb4f231b9d86a04f82b75fa5d4a4826
+  data.tar.gz: 8a8861e266967702c86d5762ec5b786687298c37e797a5c324583c9d3c9d2fe4dc83cf8841c912db3d14a0bf731d1dbee0c1c85b3d43961589c5741b43b3f128

data/.rubocop.yml

@@ -3,8 +3,8 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.3
 
-Metrics/BlockLength:
-  ExcludedMethods: [it, describe]
+Metrics:
+  Enabled: false
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,26 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-05-10 19:37:12 -0400 using RuboCop version 0.81.0.
+# on 2020-12-03 14:08:14 -0500 using RuboCop version 0.81.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 103
-
-# Offense count: 4
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 25
-
-# Offense count: 3
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 265
-
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, EnforcedStyle.
@@ -59,9 +44,9 @@ Style/MethodMissingSuper:
   Exclude:
     - 'lib/hyperclient/collection.rb'
 
-# Offense count: 91
+# Offense count: 101
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 142
+  Max: 147

data/.travis.yml

@@ -5,21 +5,20 @@ sudo: false
 matrix:
   include:
     - rvm: 2.6.6
-    - rvm: 2.5.5
-    - rvm: 2.4.6
-    - rvm: 2.4.6
+      env: FARADAY_VERSION=0.9.0
+    - rvm: 2.6.6
+      env: FARADAY_VERSION=0.17.0
+    - rvm: 2.6.6
+      env: FARADAY_VERSION="~> 1.0"
+    - rvm: 2.6.6
       script:
         - bundle exec danger
+    - rvm: 2.3.8
     - rvm: jruby-9.2.7.0
     - rvm: jruby-head
-    - rvm: 2.3.8
     - rvm: ruby-head
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
 
-before_install:
-  - gem update --system
-  - gem install bundler
-
 bundler_args: --without development

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Changelog
 
+### 1.0.1 (2021/01/02)
+
+* [#193](https://github.com/codegram/hyperclient/pull/193): Auto-paginate collections - [@dblock](https://github.com/dblock).
+* [#163](https://github.com/codegram/hyperclient/pull/163): Test against Faraday 0.9, 0.17 and 1.0+ - [@dblock](https://github.com/dblock).
+* [#199](https://github.com/codegram/hyperclient/pull/199): Use digest_auth from faraday-digestauth - [@dblock](https://github.com/dblock).
+
+### 1.0.0 (2021/01/02)
+
+* NOTE: **⚠ This version has been yanked ⚠** - [@dblock](https://github.com/dblock).
+
 ### 0.9.3 (2020/05/14)
 
 * [#149](https://github.com/codegram/hyperclient/pull/149): Address Faraday warnings - [@yuki24](https://github.com/yuki24).

data/Gemfile

@@ -3,6 +3,8 @@ git_source(:github) { |repo| "https://github.com/#{repo['/'] ? repo : "#{repo}/#
 
 source 'https://rubygems.org'
 
+gem 'faraday', ENV['FARADAY_VERSION'] if ENV.key?('FARADAY_VERSION')
+
 gemspec
 
 group :development do

data/README.md

@@ -85,12 +85,19 @@ api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|
 end
 ```
 
-You can modify headers or specify authentication after a connection has been created. Hyperclient supports Basic, Token or Digest auth as well as many other Faraday extensions.
+You can modify headers or specify authentication after a connection has been created. Hyperclient supports Basic, Token or [Digest auth](https://github.com/bhaberer/faraday-digestauth) as well as many other Faraday extensions.
 
 ```ruby
-api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api')
-api.digest_auth('username', 'password')
-api.headers.update('Accept-Encoding' => 'deflate, gzip')
+require 'faraday/digestauth'
+
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api') do |client|
+  client.connection(default: false) do |conn|
+    conn.request :digest, 'username', 'password'
+    conn.request :json
+    conn.response :json, content_type: /\bjson$/
+    conn.adapter :net_http
+  end
+end
 ```
 
 You can access the Faraday connection directly after it has been created and add middleware to it. As an example, you could use the [faraday-http-cache-middleware](https://github.com/plataformatec/faraday-http-cache).
@@ -102,7 +109,7 @@ api.connection.use :http_cache
 
 ## Resources and Attributes
 
-Hyperclient will fetch and discover the resources from your API.
+Hyperclient will fetch and discover the resources from your API and automatically paginate when possible.
 
 ```ruby
 api.splines.each do |spline|

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
@@ -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

@@ -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

@@ -8,8 +8,14 @@ module API
     WebMock::Config.instance.query_values_notation = :flat_array
 
     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

@@ -15,8 +15,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'addressable'
   gem.add_dependency 'faraday', '>= 0.9.0'
-  gem.add_dependency 'faraday-digestauth', '>= 0.3.0'
   gem.add_dependency 'faraday_hal_middleware'
   gem.add_dependency 'faraday_middleware'
-  gem.add_dependency 'net-http-digest_auth'
 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.
     #

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/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = '0.9.3'.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