my_api_client 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0b010bd5bb4ef7d0b3a99c826fefc67bedf5e9f51bcfd7779dc618c2b9a4f58
-  data.tar.gz: 4806eb56f7556728fc848c7e54408a127393a921a29e248a9d32ba950b4f3ef3
+  metadata.gz: 3b40beeb8a70a00452e59208a5c7e2d5dee2c8155d2e23b5cd950e1a7e6f3eb1
+  data.tar.gz: 15c927bb0954c12225a73955b23b7ccc71b784a2cb63832f7914a757f2ac2ed2
 SHA512:
-  metadata.gz: 6bc2efb59de265f84c727ce67e9717fff724251136ffe7159a0a61151d335bb476386649e23ef5bb8a9982e387bebd53c58064817517fdac855bd9ac3fc4d6e8
-  data.tar.gz: f0db303e86287d71099d0c0e29024663013cf4c44dffac1ac1d9c2a18113b34a4d5a1e9a6d3a4824833d1bb413a875deb0a45bb2f2becb25d4119d1028a1d10c
+  metadata.gz: c57cfcf7db9a8b9d45ee0c603402c910d2ea59bc0f3b406ba2c91388e9b0bab0997fe948dea5944fbc06499ea259c83579a154158808cce7433ea8d0beb02236
+  data.tar.gz: acc4846d877c8aace073858a102c72cc13245d6b13c94542b90d5da43798d04a6317533797b3e92a7e7710f532936ae551a0fa9cb1dcc8151bf58c68f5f06e24

data/.dependabot/config.yml

@@ -2,9 +2,30 @@ version: 1
 update_configs:
   - package_manager: "ruby:bundler"
     directory: "/"
-    update_schedule: "daily"
+    update_schedule: "weekly"
     default_reviewers:
       - "ryz310"
+    default_assignees:
+      - "ryz310"
+    default_labels:
+      - "dependabot"
+    ignored_updates:
+      - match:
+          dependency_name: "rubocop*"
+    automerged_updates:
+      - match:
+          dependency_type: "development"
+          update_type: "all"
+      - match:
+          dependency_type: "production"
+          update_type: "semver:patch"
+  - package_manager: "ruby:bundler"
+    directory: "/my_api"
+    update_schedule: "weekly"
+    default_reviewers:
+      - "ryz310"
+    default_assignees:
+      - "ryz310"
     default_labels:
       - "dependabot"
     automerged_updates:

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Change log
 
+## v0.15.0 (Mar 21, 2020)
+
+### Feature
+
+* [#220](https://github.com/ryz310/my_api_client/pull/220) Pageable HTTP request ([@ryz310](https://github.com/ryz310))
+    * Add `#pageable_get` method (alias: `#pget`)
+    * For example:
+        * API client definition
+          ```ruby
+          class MyPaginationApiClient < ApplicationApiClient
+            endpoint 'https://example.com/v1'
+
+            # GET pagination?page=1
+            def pagination
+              pageable_get 'pagination', paging: '$.links.next', headers: headers, query: { page: 1 }
+            end
+
+            private
+
+            def headers
+              { 'Content-Type': 'application/json;charset=UTF-8' }
+            end
+          end
+          ```
+        * The pagination API response
+          ```json
+          {
+            "links": {
+              "next": "https://example.com/pagination?page=3",
+              "previous": "https://example.com/pagination?page=1",
+            },
+            "page": 2
+          }
+          ```
+        * Usage
+          ```ruby
+          api_clinet = MyPaginationApiClient.new
+          api_clinet.pagination.each do |response|
+            # Do something.
+          end
+
+          p = api_clinet.pagination
+          p.next # => 1st page result
+          p.next # => 2nd page result
+          p.next # => 3rd page result
+          ```
+* [#223](https://github.com/ryz310/my_api_client/pull/223) Use Enumerator::Lazy instead of Enumerator ([@ryz310](https://github.com/ryz310))
+
 ## v0.14.0 (Mar 14, 2020)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.14.0)
+    my_api_client (0.15.0)
       activesupport (>= 4.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.1)
+    activesupport (5.2.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)

data/README.jp.md

@@ -83,6 +83,68 @@ api_clinet.get_users #=> #<Sawyer::Response>
 
 続いて、 `#get_users` や `#post_user` を定義します。メソッド名には API のタイトルを付けると良いと思います。メソッド内部で `#get` や `#post` を呼び出していますが、これがリクエスト時の HTTP Method になります。他にも `#patch` `#put` `#delete` が利用可能です。
 
+### Pagination
+
+API の中にはレスポンスに結果の続きを取得するための URL を含んでいるものがあります。
+
+MyApiClient では、このような API を enumerable に扱うための `#pageable_get` というメソッドを用意しています。以下に例を示します。
+
+```ruby
+class MyPaginationApiClient < ApplicationApiClient
+  endpoint 'https://example.com/v1'
+
+  # GET pagination?page=1
+  def pagination
+    pageable_get 'pagination', paging: '$.links.next', headers: headers, query: { page: 1 }
+  end
+
+  private
+
+  def headers
+    { 'Content-Type': 'application/json;charset=UTF-8' }
+  end
+end
+```
+
+上記の例の場合、最初に `GET https://example.com/v1/pagination?page=1` に対してリクエストが実行され、続けてレスポンス JSON の `$.link.next` に含まれる URL に対して enumerable にリクエストを実行します。
+
+例えば以下のようなレスポンスであれば、`$.link.next` は `"https://example.com/pagination?page=3"` を示します。
+
+```json
+{
+  "links": {
+    "next": "https://example.com/pagination?page=3",
+    "previous": "https://example.com/pagination?page=1",
+  },
+  "page": 2
+}
+```
+
+そして `#pageable_get` は [Enumerator::Lazy](https://docs.ruby-lang.org/ja/latest/class/Enumerator=3a=3aLazy.html) を返すので、 `#each` や `#next` を実行することで次の結果を取得できます。
+
+```ruby
+api_clinet = MyPaginationApiClient.new
+api_clinet.pagination.each do |response|
+  # Do something.
+end
+
+p = api_clinet.pagination
+p.next # => 1st page result
+p.next # => 2nd page result
+p.next # => 3rd page result
+```
+
+なお、`#each` はレスポンスに含まれる `paging` の値が nil になるまで繰り返されるのでご注意ください。例えば `#take` と組み合わせることでページネーションの上限を設定できます。
+
+`#pageable_get` の alias として `#pget` も利用可能です。
+
+```ruby
+# GET pagination?page=1
+def pagination
+  pget 'pagination', paging: '$.links.next', headers: headers, query: { page: 1 }
+end
+```
+
 ### Error handling
 
 上記のコードにエラーハンドリングを追加してみます。

data/example/api_clients/my_pagination_api_client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'application_api_client'
+
+# An usage example of the `my_api_client`.
+# See also: my_api/app/controllers/pagination_controller.rb
+class MyPaginationApiClient < ApplicationApiClient
+  # GET pagination?page=1
+  def pagination
+    pget 'pagination', paging: '$.links.next', headers: headers, query: { page: 1 }
+  end
+
+  private
+
+  def headers
+    { 'Content-Type': 'application/json;charset=UTF-8' }
+  end
+end

data/lib/my_api_client/error_handling.rb

@@ -29,8 +29,9 @@ module MyApiClient
       # @option status_code [String, Range, Integer, Regexp]
       #   Verifies response HTTP status code and raises error if matched
       # @option json [Hash, Symbol]
-      #   Verifies response body as JSON and raises error if matched.
-      #   If specified `:forbid_nil`, it forbid `nil` on response_body.
+      #   Specify the validation target value path included in the response body
+      #   as JsonPath expression.
+      #   If specified `:forbid_nil`, it forbid `nil` at the response body.
       # @option with [Symbol]
       #   Calls specified method when error detected
       # @option raise [MyApiClient::Error]

data/lib/my_api_client/request/basic.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module Request
+    # Provides basic HTTP request method.
+    module Basic
+      HTTP_METHODS = %i[get post patch delete].freeze
+
+      HTTP_METHODS.each do |http_method|
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          # Executes HTTP request with #{http_method.upcase} method
+          #
+          # @param pathname [String]
+          #   Pathname of the request target URL.
+          #   It's joined with the defined by `endpoint`.
+          # @param headers [Hash, nil]
+          #   Request headers.
+          # @param query [Hash, nil]
+          #   Query string.
+          # @param body [Hash, nil]
+          #   Request body. You should not specify it when use GET method.
+          # @return [Sawyer::Resource]
+          #   Response body instance.
+          def #{http_method}(pathname, headers: nil, query: nil, body: nil)
+            response = call(:_request_with_relative_uri, :#{http_method}, pathname, headers, query, body)
+            response.data
+          end
+        METHOD
+      end
+
+      alias put patch
+    end
+  end
+end

data/lib/my_api_client/request/pagination.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module Request
+    # Provides enumerable HTTP request method.
+    module Pagination
+      # Executes HTTP request with GET method, for pagination API. Expects the
+      # pagination API to provide pagination links as part of the content of the response.
+      #
+      # @param pathname [String]
+      #   Pathname of the request target URL. It's joined with the defined by `endpoint`.
+      # @param paging [String]
+      #   Specify the pagination link path included in the response body as JsonPath expression
+      # @param headers [Hash, nil]
+      #   Request headers.
+      # @param query [Hash, nil]
+      #   Query string.
+      # @param body [Hash, nil]
+      #   Request body. You should not specify it when use GET method.
+      # @return [Enumerator::Lazy]
+      #   Yields the pagination API response.
+      def pageable_get(pathname, paging:, headers: nil, query: nil)
+        Enumerator.new do |y|
+          response = call(:_request_with_relative_uri, :get, pathname, headers, query, nil)
+          loop do
+            y << response.data
+
+            next_uri = JsonPath.new(paging).first(response.body)
+            break if next_uri.blank?
+
+            response = call(:_request_with_absolute_uri, :get, next_uri, headers, nil)
+          end
+        end.lazy
+      end
+
+      alias pget pageable_get
+    end
+  end
+end

data/lib/my_api_client/request.rb

@@ -1,38 +1,35 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  # Description of Request
+  # Provides HTTP request method.
   module Request
-    HTTP_METHODS = %i[get post patch delete].freeze
-
-    HTTP_METHODS.each do |http_method|
-      class_eval <<~METHOD, __FILE__, __LINE__ + 1
-        # Executes HTTP request with #{http_method.upcase} method
-        #
-        # @param pathname [String]
-        #   Pathname of the request target URL.
-        #   It's joined with the defined `endpoint`.
-        # @param headers [Hash, nil]
-        #   Request headers.
-        # @param query [Hash, nil]
-        #   Query string.
-        # @param body [Hash, nil]
-        #   Request body. You should not specify it when use GET method.
-        # @return [Sawyer::Resouce]
-        #   Response body instance.
-        def #{http_method}(pathname, headers: nil, query: nil, body: nil)
-          query_strings = query.present? ? '?' + query&.to_query : ''
-          uri = URI.join(File.join(endpoint, pathname), query_strings)
-          response = call(:_request, :#{http_method}, uri, headers, body)
-          response.data
-        end
-      METHOD
-    end
-    alias put patch
+    include Basic
+    include Pagination
 
     private
 
-    # Executes HTTP request.
+    # Executes HTTP request with relative URI.
+    #
+    # @param http_method [Symbol]
+    #   HTTP method. e.g. `:get`, `:post`, `:patch` and `:delete`.
+    # @param pathname [String]
+    #   Pathname of the request target URL.
+    #   It's joined with the defined by `endpoint`.
+    # @param headers [Hash, nil]
+    #   Request headers.
+    # @param query [Hash, nil]
+    #   Query string.
+    # @param body [Hash, nil]
+    #   Request body.
+    # @return [Sawyer::Response]
+    #   Response instance.
+    def _request_with_relative_uri(http_method, pathname, headers, query, body)
+      query_strings = query.present? ? '?' + query&.to_query : ''
+      uri = URI.join(File.join(endpoint, pathname), query_strings)
+      _request_with_absolute_uri(http_method, uri, headers, body)
+    end
+
+    # Executes HTTP request with absolute URI.
     #
     # @param http_method [Symbol]
     #   HTTP method. e.g. `:get`, `:post`, `:patch` and `:delete`.
@@ -44,13 +41,11 @@ module MyApiClient
     #   Request body.
     # @return [Sawyer::Response]
     #   Response instance.
-    def _request(http_method, uri, headers, body)
-      request_params = Params::Request.new(http_method, uri, headers, body)
-      request_logger = Logger.new(logger, http_method, uri)
+    def _request_with_absolute_uri(http_method, uri, headers, body)
       Executor.call(
         instance: self,
-        request_params: request_params,
-        request_logger: request_logger,
+        request_params: Params::Request.new(http_method, uri, headers, body),
+        request_logger: Logger.new(logger, http_method, uri),
         faraday_options: faraday_options
       )
     end

data/lib/my_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end

data/lib/my_api_client.rb

@@ -16,6 +16,8 @@ require 'my_api_client/error_handling'
 require 'my_api_client/exceptions'
 require 'my_api_client/request/logger'
 require 'my_api_client/request/executor'
+require 'my_api_client/request/basic'
+require 'my_api_client/request/pagination'
 require 'my_api_client/errors'
 require 'my_api_client/params/params'
 require 'my_api_client/params/request'

data/my_api/.ruby-version

@@ -1 +1 @@
-2.7.0
+2.5.7

data/my_api/Gemfile.lock

@@ -1,34 +1,34 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
+    actionmailer (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      actionview (= 6.0.2.2)
+      activejob (= 6.0.2.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    activejob (6.0.2.2)
+      activesupport (= 6.0.2.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -45,44 +45,44 @@ GEM
       rainbow
       thor
       zeitwerk
-    aws-partitions (1.278.0)
-    aws-sdk-apigateway (1.36.0)
+    aws-partitions (1.285.0)
+    aws-sdk-apigateway (1.37.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudformation (1.30.0)
+    aws-sdk-cloudformation (1.31.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudwatchlogs (1.28.0)
+    aws-sdk-cloudwatchlogs (1.29.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.90.1)
+    aws-sdk-core (3.91.1)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.43.0)
+    aws-sdk-dynamodb (1.45.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-kinesis (1.20.0)
+    aws-sdk-kinesis (1.21.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-kms (1.29.0)
+    aws-sdk-kms (1.30.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-lambda (1.36.0)
+    aws-sdk-lambda (1.37.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.60.2)
+    aws-sdk-s3 (1.61.1)
       aws-sdk-core (~> 3, >= 3.83.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sns (1.21.0)
+    aws-sdk-sns (1.22.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.23.1)
+    aws-sdk-sqs (1.24.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ssm (1.71.0)
+    aws-sdk-ssm (1.73.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.1)
@@ -118,7 +118,7 @@ GEM
     hashie (4.1.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jets (2.3.13)
+    jets (2.3.14)
       actionmailer (~> 6.0.0)
       actionpack (~> 6.0.0)
       actionview (~> 6.0.0)
@@ -154,7 +154,7 @@ GEM
       text-table
       thor
       zeitwerk
-    jets-gems (0.2.0)
+    jets-gems (0.2.2)
       gems
     jets-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
@@ -169,13 +169,13 @@ GEM
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     memoist (0.16.2)
-    method_source (0.9.2)
+    method_source (1.0.0)
     mimemagic (0.3.4)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     nio4r (2.5.2)
-    nokogiri (1.10.8)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     public_suffix (4.0.3)
     puma (4.3.3)
@@ -188,15 +188,15 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    recursive-open-struct (1.1.0)
+    recursive-open-struct (1.1.1)
     regexp_parser (1.7.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -204,7 +204,7 @@ GEM
       rspec-mocks (~> 3.9.0)
     rspec-core (3.9.1)
       rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
@@ -222,7 +222,7 @@ GEM
       thread_safe (~> 0.1)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.2.2)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby

data/my_api/README.md

@@ -28,6 +28,12 @@ This API returns arbitrary error code as JSON.
 
 * `GET error/:code`
 
+### My Pagination API
+
+This API returns a response including pagination links.
+
+* `GET pagination?page=1`
+
 ## Deployment
 
 You need to prepare following environment variables:

data/my_api/app/controllers/pagination_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# A Pagination API
+class PaginationController < ApplicationController
+  # GET pagination
+  def index
+    case params[:page]
+    when '1', nil
+      render status: :ok, json: first_page
+    when '2'
+      render status: :ok, json: second_page
+    when '3'
+      render status: :ok, json: third_page
+    else
+      render status: :not_found, json: ''
+    end
+  end
+
+  private
+
+  def first_page
+    {
+      links: {
+        next: page_link(2),
+      },
+      page: 1,
+    }
+  end
+
+  def second_page
+    {
+      links: {
+        next: page_link(3),
+        previous: page_link(1),
+      },
+      page: 2,
+    }
+  end
+
+  def third_page
+    {
+      links: {
+        previous: page_link(2),
+      },
+      page: 3,
+    }
+  end
+
+  # NOTE: `#pagination_url` returns `http://xxxxx.execute-api.ap-northeast-1.amazonaws.com/pagination`
+  #       but it should be `https://xxxxx.execute-api.ap-northeast-1.amazonaws.com/dev/pagination`.
+  #       So this is workaround.
+  def page_link(page)
+    query_strings = '?' + { page: page }.to_query
+    uri = File.join(ENV['JETS_HOST'], ENV['JETS_STAGE'], pagination_path)
+    uri.sub!('http://', 'https://')
+    URI.join(uri, query_strings)
+  end
+end

data/my_api/config/routes.rb

@@ -7,6 +7,7 @@ Jets.application.routes.draw do
 
   get 'status/:status', to: 'status#show'
   get 'error/:code', to: 'error#show'
+  get 'pagination', to: 'pagination#index'
 
   # The jets/public#show controller can serve static utf8 content out of the public folder.
   # Note, as part of the deploy process Jets uploads files in the public folder to s3

data/my_api/spec/controllers/pagination_controller_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+describe PaginationController, type: :controller do
+  describe '#index' do
+    let(:first_page) do
+      {
+        links: {
+          next: 'https://example.com/test/pagination?page=2',
+        },
+        page: 1,
+      }.to_json
+    end
+
+    let(:second_page) do
+      {
+        links: {
+          next: 'https://example.com/test/pagination?page=3',
+          previous: 'https://example.com/test/pagination?page=1',
+        },
+        page: 2,
+      }.to_json
+    end
+
+    let(:third_page) do
+      {
+        links: {
+          previous: 'https://example.com/test/pagination?page=2',
+        },
+        page: 3,
+      }.to_json
+    end
+
+    context 'without page' do
+      it 'returns a 1st page contents including 2nd page link' do
+        get '/pagination'
+        expect(response.status).to eq 200
+        expect(response.body).to eq first_page
+      end
+    end
+
+    context 'with page = 1' do
+      it 'returns a 1st page contents including 2nd page link' do
+        get '/pagination', page: 1
+        expect(response.status).to eq 200
+        expect(response.body).to eq first_page
+      end
+    end
+
+    context 'with page = 2' do
+      it 'returns a 2nd page contents including 3rd page link' do
+        get '/pagination', page: 2
+        expect(response.status).to eq 200
+        expect(response.body).to eq second_page
+      end
+    end
+
+    context 'with page = 3' do
+      it 'returns a 3rd page contents not including next page link' do
+        get '/pagination', page: 3
+        expect(response.status).to eq 200
+        expect(response.body).to eq third_page
+      end
+    end
+
+    context 'with page = 4' do
+      it 'returns 404 NOT FOUND' do
+        get '/pagination', page: 4
+        expect(response.status).to eq 404
+        expect(response.body).to be_blank
+      end
+    end
+  end
+end

data/my_api/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 ENV['JETS_TEST'] = '1'
 ENV['JETS_ENV'] ||= 'test'
+ENV['JETS_STAGE'] ||= 'test'
 # Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
 ENV['HOME'] = 'spec/fixtures/home'
 
@@ -24,3 +25,7 @@ end
 RSpec.configure do |c|
   c.include Helpers
 end
+
+Jets.application.configure do
+  config.helpers.host = 'https://example.com'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2020-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -248,6 +248,7 @@ files:
 - example/api_clients/application_api_client.rb
 - example/api_clients/my_error_api_client.rb
 - example/api_clients/my_errors.rb
+- example/api_clients/my_pagination_api_client.rb
 - example/api_clients/my_rest_api_client.rb
 - example/api_clients/my_status_api_client.rb
 - gemfiles/rails_4.2.gemfile
@@ -275,8 +276,10 @@ files:
 - lib/my_api_client/params/params.rb
 - lib/my_api_client/params/request.rb
 - lib/my_api_client/request.rb
+- lib/my_api_client/request/basic.rb
 - lib/my_api_client/request/executor.rb
 - lib/my_api_client/request/logger.rb
+- lib/my_api_client/request/pagination.rb
 - lib/my_api_client/rspec.rb
 - lib/my_api_client/rspec/matcher_helper.rb
 - lib/my_api_client/rspec/matchers/be_handled_as_an_error.rb
@@ -297,6 +300,7 @@ files:
 - my_api/Rakefile
 - my_api/app/controllers/application_controller.rb
 - my_api/app/controllers/error_controller.rb
+- my_api/app/controllers/pagination_controller.rb
 - my_api/app/controllers/rest_controller.rb
 - my_api/app/controllers/status_controller.rb
 - my_api/app/helpers/application_helper.rb
@@ -316,13 +320,13 @@ files:
 - my_api/public/favicon.ico
 - my_api/public/index.html
 - my_api/spec/controllers/error_controller_spec.rb
+- my_api/spec/controllers/pagination_controller_spec.rb
 - my_api/spec/controllers/rest_controller_spec.rb
 - my_api/spec/controllers/status_controller_spec.rb
 - my_api/spec/fixtures/payloads/posts-index.json
 - my_api/spec/fixtures/payloads/posts-show.json
 - my_api/spec/spec_helper.rb
 - my_api_client.gemspec
-- renovate.json
 homepage: https://github.com/ryz310/my_api_client
 licenses:
 - MIT

data/renovate.json

@@ -1,21 +0,0 @@
-{
-  "extends": [
-    "config:base"
-  ],
-  "packageRules": [
-    {
-      "updateTypes": ["major"],
-      "labels": ["renovate", "major"]
-    },
-    {
-      "updateTypes": ["minor"],
-      "labels": ["renovate", "minor", "auto merge"],
-      "automerge": true
-    },
-    {
-      "updateTypes": ["patch"],
-      "labels": ["renovate", "patch", "auto merge"],
-      "automerge": true
-    }
-  ]
-}