my_api_client 0.20.0 → 0.23.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.20.0)
+    my_api_client (0.23.0)
       activesupport (>= 5.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -10,40 +10,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    bugsnag (6.19.0)
+    bugsnag (6.24.2)
       concurrent-ruby (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
-    docile (1.3.5)
-    faraday (1.3.0)
-      faraday-net_http (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday-net_http (1.0.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
     hashdiff (1.0.1)
-    i18n (1.8.9)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jsonpath (1.1.0)
+    jsonpath (1.1.2)
       multi_json
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     multi_json (1.15.0)
-    multipart-post (2.1.1)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -51,63 +48,63 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
-    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)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.11.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.2.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    sawyer (0.8.2)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
+      faraday (>= 0.17.3, < 3)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+    simplecov_json_formatter (0.1.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    webmock (3.12.1)
-      addressable (>= 2.3.6)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.26)
-    zeitwerk (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
@@ -128,4 +125,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.3
+   2.3.11

data/README.jp.md

@@ -2,7 +2,7 @@
 
 # MyApiClient
 
-MyApiClient は API リクエストクラスを作成するための汎用的な機能を提供します。Sawyer や Faraday をベースにエラーハンドリングの機能を強化した構造になっています。
+MyApiClient は API リクエストクラスを作成するための汎用的な機能を提供します。[Sawyer](https://github.com/lostisland/sawyer) や [Faraday](https://github.com/lostisland/faraday) をベースにエラーハンドリングの機能を強化した構造になっています。
 
 ただし、 Sawyer はダミーデータの作成が難しかったり、他の gem で競合することがよくあるので、将来的には依存しないように変更していくかもしれません。
 
@@ -12,12 +12,12 @@ MyApiClient は API リクエストクラスを作成するための汎用的な
 
 ## Supported Versions
 
-* Ruby 2.5, 2.6, 2.7, 3.0
-* Rails 5.2, 6.0, 6.1
+- Ruby 2.7, 3.0, 3.1
+- Rails 5.2, 6.0, 6.1, 7.0
 
 ## Installation
 
-この gem は macOS と Linux で作動します。まずは `my_api_client` を Gemfile に追加します:
+`my_api_client` を Gemfile に追加して下さい:
 
 ```ruby
 gem 'my_api_client'
@@ -116,7 +116,7 @@ end
 {
   "links": {
     "next": "https://example.com/pagination?page=3",
-    "previous": "https://example.com/pagination?page=1",
+    "previous": "https://example.com/pagination?page=1"
   },
   "page": 2
 }
@@ -130,13 +130,13 @@ 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
+result = api_clinet.pagination
+result.next # => 1st page result
+result.next # => 2nd page result
+result.next # => 3rd page result
 ```
 
-なお、`#each` はレスポンスに含まれる `paging` の値が nil になるまで繰り返されるのでご注意ください。例えば `#take` と組み合わせることでページネーションの上限を設定できます。
+なお、`#each` はレスポンスに含まれる `paging` の値が `nil` になるまで繰り返されるのでご注意ください。例えば `#take` と組み合わせることでページネーションの上限を設定できます。
 
 `#pageable_get` の alias として `#pget` も利用可能です。
 
@@ -200,24 +200,24 @@ error_handling status_code: 500..599, raise: MyApiClient::ServerError do |_param
 end
 ```
 
-上記の例であれば、ステータスコードが `500..599` の場合に `MyApiClient::ServerError`  を発生させる前に `block` の内容が実行れます。引数の `params` にはリクエスト情報とレスポンス情報が含まれています。`logger` はログ出力用インスタンスですが、このインスタンスを使ってログ出力すると、以下のようにリクエスト情報がログ出力に含まれるようになり、デバッグの際に便利です。
+上記の例であれば、ステータスコードが `500..599` の場合に `MyApiClient::ServerError` を発生させる前に `block` の内容が実行れます。引数の `params` にはリクエスト情報とレスポンス情報が含まれています。`logger` はログ出力用インスタンスですが、このインスタンスを使ってログ出力すると、以下のようにリクエスト情報がログ出力に含まれるようになり、デバッグの際に便利です。
 
 ```text
 API request `GET https://example.com/path/to/resouce`: "Server error occurred."
 ```
 
+`json` には `Hash` の Key に [JSONPath](https://goessner.net/articles/JsonPath/) を指定して、レスポンス JSON から任意の値を取得し、 Value とマッチするかどうかでエラーハンドリングできます。Value には `String` `Integer` `Range` `Regexp` が指定可能です。上記の場合であれば、以下のような JSON にマッチします。
+
 ```ruby
 error_handling json: { '$.errors.code': 10..19 }, with: :my_error_handling
 ```
 
-`json` には `Hash` の Key に [JSONPath](https://goessner.net/articles/JsonPath/) を指定して、レスポンス JSON から任意の値を取得し、 Value とマッチするかどうかでエラーハンドリングできます。Value には `String` `Integer` `Range` `Regexp` が指定可能です。上記の場合であれば、以下のような JSON にマッチします。
-
 ```json
 {
-    "erros": {
-        "code": 10,
-        "message": "Some error has occurred."
-    }
+  "erros": {
+    "code": 10,
+    "message": "Some error has occurred."
+  }
 }
 ```
 
@@ -253,10 +253,10 @@ error_handling json: { '$.errors.code': :negative? }
 
 ```json
 {
-    "erros": {
-        "code": -1,
-        "message": "Some error has occurred."
-    }
+  "erros": {
+    "code": -1,
+    "message": "Some error has occurred."
+  }
 }
 ```
 
@@ -344,8 +344,8 @@ error_handling json: { '$.errors.code': 20 },
 
 `retry` オプションを使用する際は以下の点に注意が必要です。
 
-* `error_handling` に `raise` オプションの指定が必須となります。
-* Block を使った `error_handling` の定義は禁止されます。
+- `error_handling` に `raise` オプションの指定が必須となります。
+- Block を使った `error_handling` の定義は禁止されます。
 
 #### MyApiClient::NetworkError
 
@@ -630,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
   }
 )
 
@@ -646,12 +647,14 @@ 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_get` (`#pget`) を使った実装用に `pageable` というオプションが利用できます。
 `pageable` に設定する値は `Enumerable` である必要があります。
 
 ```ruby
@@ -671,7 +674,7 @@ MyPaginationApiClient.new.pagination.each do |response|
 end
 ```
 
-なお、 `Enumerable` の各値にはここまで紹介した `response`, `raise`, `Prox` など全てのオプションが利用可能です。
+なお、 `Enumerable` の各値にはここまで紹介した `response`, `raise`, `Proc` など全てのオプションが利用可能です。
 
 ```ruby
 stub_api_client_all(
@@ -689,7 +692,6 @@ stub_api_client_all(
 
 また、 `Enumerator` を使えば無限に続くページネーションを定義することもできます。
 
-
 ```ruby
 stub_api_client_all(
   MyPaginationApiClient,
@@ -739,10 +741,10 @@ $ gem_comet release {VERSION}
 
 実行すると、 https://github.com/ryz310/my_api_client/pulls に以下のような PR が作成されます。
 
-* [Update v0\.16\.1](https://github.com/ryz310/my_api_client/pull/297)
-* [Release v0\.16\.1](https://github.com/ryz310/my_api_client/pull/298)
+- [Update v0\.16\.1](https://github.com/ryz310/my_api_client/pull/297)
+- [Release v0\.16\.1](https://github.com/ryz310/my_api_client/pull/298)
 
-まず、 `Update v{VERSION}`  という PR から merge に取り掛かります。
+まず、 `Update v{VERSION}` という PR から merge に取り掛かります。
 
 PR のコメントにも TODO が記載されていますが、まず、バージョン番号が正しく採番されているかを確認します。
 
@@ -752,12 +754,12 @@ See: [314a4c0](https://github.com/ryz310/my_api_client/pull/297/commits/314a4c06
 
 See: [33a2d17](https://github.com/ryz310/my_api_client/pull/297/commits/33a2d1703c773813c837e74ee3181906b2f2e502)
 
-これらが整ったら、 `Update v{VERSION}`  を merge します。
+これらが整ったら、 `Update v{VERSION}` を merge します。
 
-これでリリース準備が整ったので、`Release v{VERSION}`  の merge に取り掛かります。
+これでリリース準備が整ったので、`Release v{VERSION}` の merge に取り掛かります。
 
 この PR にこれからリリースする gem に対する変更が全て載っています。
-変更内容の最終確認をして、 CI も通ったことを確認したら `Release v{VERSION}`  を merge します。
+変更内容の最終確認をして、 CI も通ったことを確認したら `Release v{VERSION}` を merge します。
 
 あとは Circle CI 側で gem のリリースが自動実行されるので、暫く待ちましょう。