my_api_client 0.17.0 → 0.21.0

data/Gemfile

@@ -4,9 +4,6 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Workaound for ruby 2.4. Because activesupport v6.0.0 requires ruby 2.5 over.
-gem 'activesupport', '< 6.0.0'
-
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'
 end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.17.0)
-      activesupport (>= 4.2.0)
+    my_api_client (0.21.0)
+      activesupport (>= 5.2.0)
       faraday (>= 0.17.1)
       jsonpath
       sawyer (>= 0.8.2)
@@ -10,37 +10,54 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.7.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    bugsnag (6.17.0)
+    ast (2.4.2)
+    bugsnag (6.21.0)
       concurrent-ruby (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    crack (0.4.4)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
-    docile (1.3.2)
-    faraday (1.0.1)
+    docile (1.4.0)
+    faraday (1.6.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    json (2.3.1)
-    jsonpath (1.0.5)
+    jsonpath (1.1.0)
       multi_json
-      to_regexp (~> 0.2.1)
     method_source (1.0.0)
-    minitest (5.14.2)
+    minitest (5.14.4)
     multi_json (1.15.0)
     multipart-post (2.1.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -50,65 +67,66 @@ GEM
       pry (~> 0.13.0)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.0)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.91.0)
+    rubocop (1.18.4)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 1.8.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.2)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.8.1)
-      rubocop (>= 0.87.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.9.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (1.43.2)
-      rubocop (~> 0.87)
-    ruby-progressbar (1.10.1)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    simplecov (0.17.1)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    to_regexp (0.2.1)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    webmock (3.9.1)
-      addressable (>= 2.3.6)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.25)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (< 6.0.0)
   bugsnag (>= 6.11.0)
   bundler (>= 2.0)
   my_api_client!
@@ -119,9 +137,9 @@ DEPENDENCIES
   rubocop
   rubocop-performance
   rubocop-rspec
-  simplecov (= 0.17.1)
+  simplecov (= 0.21.2)
   webmock
   yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.jp.md

@@ -12,8 +12,8 @@ MyApiClient は API リクエストクラスを作成するための汎用的な
 
 ## Supported Versions
 
-* Ruby 2.4, 2.5, 2.6, 2.7
-* Rails 4.2, 5.0, 5.1, 5.2, 6.0
+* Ruby 2.6, 2.7, 3.0
+* Rails 5.2, 6.0, 6.1
 
 ## Installation
 
@@ -26,7 +26,7 @@ gem 'my_api_client'
 Ruby on Rails を利用している場合は `generator` 機能を利用できます。
 
 ```sh
-$ rails g api_client path/to/resource get:path/to/resource
+$ rails g api_client path/to/resource get:path/to/resource --endpoint https://example.com
 
 create  app/api_clients/application_api_client.rb
 create  app/api_clients/path/to/resource_api_client.rb
@@ -551,6 +551,8 @@ end
 
 ### Stubbing
 
+#### `response` option
+
 以下のような `ApiClient` を定義しているとします。
 
 ```ruby
@@ -587,6 +589,7 @@ response = ExampleApiClient.new.request(user_id: 1)
 response.id # => 12345
 ```
 
+#### Proc
 
 リクスエストパラメータを使ったレスポンスを返すようにスタブ化したい場合は、 `Proc` を利用することで実現できます。
 
@@ -600,7 +603,9 @@ response = ExampleApiClient.new.request(user_id: 1)
 response.id # => 1
 ```
 
-`receive` や `have_received` を使ったテストを書きたい場合は、 `stub_api_client_all` や `stub_api_client` の戻り値を利用すると良いでしょう。
+#### Return value of `#stub_api_client_all` and `#stub_api_client`
+
+`#stub_api_client_all` や `#stub_api_client` の戻り値はスタブ化した API Client のスタブオブジェクトです。`receive` や `have_received` を使ったテストを書きたい場合は、これらの値を利用すると良いでしょう。
 
 ```ruby
 def execute_api_request
@@ -612,7 +617,9 @@ execute_api_request
 expect(api_client).to have_received(:request).with(user_id: 1)
 ```
 
-また、例外が発生する場合のテストを書きたい場合は、 `raise` オプションを利用することができます。
+#### `raise` option
+
+例外が発生する場合のテストを書きたい場合は、 `raise` オプションを利用することができます。
 
 ```ruby
 def execute_api_request
@@ -623,14 +630,15 @@ stub_api_client_all(ExampleApiClient, request: { raise: MyApiClient::Error })
 expect { execute_api_request }.to raise_error(MyApiClient::Error)
 ```
 
-なお、発生した例外に含まれるレスポンスパラメータもスタブ化したい場合は、 `response` オプションと同時に指定することが可能です。
+なお、発生した例外に含まれるレスポンスパラメータやステータスコードもスタブ化したい場合は、 `response` オプションと同時に指定することが可能です。
 
 ```ruby
 stub_api_client_all(
   ExampleApiClient,
   request: {
     raise: MyApiClient::Error,
-    response: { message: 'error' }
+    response: { message: 'error' },
+    status_code: 429
   }
 )
 
@@ -639,9 +647,65 @@ begin
 rescue MyApiClient::Error => e
   response_body = e.params.response.data.to_h
   expect(response_body).to eq(message: 'error')
+  status_code = e.params.response.status
+  expect(status_code).to eq(429)
+end
+```
+
+#### `pageable` option
+
+`#pageable_get`  (`#pget`) を使った実装用に `pageable` というオプションが利用できます。
+`pageable` に設定する値は `Enumerable` である必要があります。
+
+```ruby
+stub_api_client_all(
+  MyPaginationApiClient,
+  pagination: {
+    pageable: [
+      { page: 1 },
+      { page: 2 },
+      { page: 3 },
+    ],
+  }
+)
+
+MyPaginationApiClient.new.pagination.each do |response|
+  response.page #=> 1, 2, 3
 end
 ```
 
+なお、 `Enumerable` の各値にはここまで紹介した `response`, `raise`, `Proc` など全てのオプションが利用可能です。
+
+```ruby
+stub_api_client_all(
+  MyPaginationApiClient,
+  pagination: {
+    pageable: [
+      { response: { page: 1 } },
+      { page: 2 },
+      ->(params) { { page: 3, user_id: params[:user_id] } },
+      { raise: MyApiClient::ClientError::IamTeapot },
+    ],
+  }
+)
+```
+
+また、 `Enumerator` を使えば無限に続くページネーションを定義することもできます。
+
+
+```ruby
+stub_api_client_all(
+  MyPaginationApiClient,
+  pagination: {
+    pageable: Enumerator.new do |y|
+      loop.with_index(1) do |_, i|
+        y << { page: i }
+      end
+    end,
+  }
+)
+```
+
 ## Deployment
 
 この gem のリリースには [gem_comet](https://github.com/ryz310/gem_comet) を利用しています。

data/gemfiles/rails_5.0.gemfile

@@ -7,6 +7,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 5.0.0'
+gem 'tzinfo', '~> 1.1'
 
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'

data/gemfiles/rails_5.1.gemfile

@@ -7,6 +7,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 5.1.0'
+gem 'tzinfo', '~> 1.1'
 
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'

data/gemfiles/rails_5.2.gemfile

@@ -7,6 +7,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 5.2.0'
+gem 'tzinfo', '~> 1.1'
 
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'

data/gemfiles/rails_6.0.gemfile

@@ -7,6 +7,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'activesupport', '~> 6.0.0'
+gem 'tzinfo', '~> 1.1'
 
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'

data/gemfiles/{rails_4.2.gemfile → rails_6.1.gemfile}

@@ -6,7 +6,7 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'activesupport', '~> 4.2.0'
+gem 'activesupport', '~> 6.1.0'
 
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'

data/lib/generators/rails/USAGE

@@ -2,7 +2,7 @@ Description:
     Generate a new api client class files.
 
 Example:
-    `rails g api_client path/to/resource get:path/to/resource`
+    `rails g api_client path/to/resource get:path/to/resource` --endpoint https://example.com
 
     This will create:
         create  app/api_clients/application_api_client.rb

data/lib/generators/rails/api_client_generator.rb

@@ -15,6 +15,12 @@ module Rails
              default: %w[get:path/to/resource post:path/to/resource],
              banner: '{method}:{path} {method}:{path}'
 
+    class_option :endpoint,
+                 type: :string,
+                 default: 'https://example.com',
+                 banner: 'https://example.com',
+                 desc: 'Common part of the target API endpoint'
+
     def generate_root_class
       file_path = File.join('app/api_clients', 'application_api_client.rb')
       return if File.exist?(file_path)

data/lib/generators/rails/templates/api_client.rb.erb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class <%= "#{class_name}ApiClient" %> < ::ApplicationApiClient
-  endpoint 'https://example.com'
+  endpoint '<%= options[:endpoint] %>'
 
   # error_handling json: { '$.errors.code': 10 } do |params, logger|
   #   # Behavior when detected an error.

data/lib/generators/rspec/USAGE

@@ -2,7 +2,7 @@ Description:
     Generate a new api client spec files.
 
 Example:
-    rails g rspec:api_client path/to/resource get:path/to/resource`
+    rails g rspec:api_client path/to/resource get:path/to/resource` --endpoint https://example.com
 
     This will create:
         create  spec/api_clients/path/to/resource_api_client_spec.rb

data/lib/generators/rspec/api_client_generator.rb

@@ -16,6 +16,12 @@ module Rspec
                default: %w[get:path/to/resource post:path/to/resource],
                banner: '{method}:{path} {method}:{path}'
 
+      class_option :endpoint,
+                   type: :string,
+                   default: 'https://example.com',
+                   banner: 'https://example.com',
+                   desc: 'Common part of the target API endpoint'
+
       class_option :api_client_specs, type: :boolean, default: true
 
       def generate_api_client_spec