my_api_client 0.22.0 → 0.23.0

data/Gemfile

@@ -4,8 +4,6 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'activesupport', '~> 6.1' # TODO: Remove this line at the end of Ruby 2.6 support
-
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.22.0)
+    my_api_client (0.23.0)
       activesupport (>= 5.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -10,54 +10,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.4)
+    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.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    bugsnag (6.24.1)
+    bugsnag (6.24.2)
       concurrent-ruby (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (1.8.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)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
       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)
+    faraday-net_http (2.0.3)
     hashdiff (1.0.1)
-    i18n (1.8.11)
+    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.15.0)
     multi_json (1.15.0)
-    multipart-post (2.1.1)
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -65,53 +48,53 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.5.0)
     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)
+    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.3)
-    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.24.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.15.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.15.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.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.6.0)
+    rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    sawyer (0.8.2)
+    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.3)
+    simplecov_json_formatter (0.1.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
@@ -120,15 +103,13 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 6.1)
   bugsnag (>= 6.11.0)
   bundler (>= 2.0)
   my_api_client!
@@ -144,4 +125,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.22
+   2.3.11

data/README.jp.md

@@ -12,8 +12,8 @@ MyApiClient は API リクエストクラスを作成するための汎用的な
 
 ## Supported Versions
 
-* Ruby 2.6, 2.7, 3.0
-* Rails 5.2, 6.0, 6.1, 7.0
+- Ruby 2.7, 3.0, 3.1
+- Rails 5.2, 6.0, 6.1, 7.0
 
 ## Installation
 
@@ -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
 }
@@ -200,7 +200,7 @@ 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."
@@ -214,10 +214,10 @@ error_handling json: { '$.errors.code': 10..19 }, with: :my_error_handling
 
 ```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
 
@@ -654,7 +654,7 @@ end
 
 #### `pageable` option
 
-`#pageable_get`  (`#pget`) を使った実装用に `pageable` というオプションが利用できます。
+`#pageable_get` (`#pget`) を使った実装用に `pageable` というオプションが利用できます。
 `pageable` に設定する値は `Enumerable` である必要があります。
 
 ```ruby
@@ -692,7 +692,6 @@ stub_api_client_all(
 
 また、 `Enumerator` を使えば無限に続くページネーションを定義することもできます。
 
-
 ```ruby
 stub_api_client_all(
   MyPaginationApiClient,
@@ -742,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 が記載されていますが、まず、バージョン番号が正しく採番されているかを確認します。
 
@@ -755,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 のリリースが自動実行されるので、暫く待ちましょう。
 

data/README.md

@@ -12,8 +12,8 @@ It is supposed to be used in Ruby on Rails, but it is made to work in other envi
 
 ## Supported Versions
 
-* Ruby 2.6, 2.7, 3.0
-* Rails 5.2, 6.0, 6.1, 7.0
+- Ruby 2.7, 3.0, 3.1
+- Rails 5.2, 6.0, 6.1, 7.0
 
 ## Installation
 
@@ -83,7 +83,7 @@ The `endpoint` defines the intersection of the request URL. Each method describe
 
 Next, define `#initialize`. Suppose you want to set an Access Token, API Key, etc. as in the example above. You can omit the definition if you don't need it.
 
-Then define `# get_users` and` # post_user`. It's a good idea to give the method name the title of the API. I'm calling `# get` and` # post` inside the method, which is the HTTP Method at the time of the request. You can also use `#patch`` #put` `#delete`.
+Then define `#get_users` and `#post_user`. It's a good idea to give the method name the title of the API. I'm calling `#get` and `#post` inside the method, which is the HTTP Method at the time of the request. You can also use `#patch` `#put` `#delete`.
 
 ### Pagination
 
@@ -116,7 +116,7 @@ For example, in the following response, `$.link.next` indicates `"https://exampl
 {
   "links": {
     "next": "https://example.com/pagination?page=3",
-    "previous": "https://example.com/pagination?page=1",
+    "previous": "https://example.com/pagination?page=1"
   },
   "page": 2
 }
@@ -216,10 +216,10 @@ In the above case, it matches JSON as below:
 
 ```json
 {
-    "erros": {
-        "code": 10,
-        "message": "Some error has occurred."
-    }
+  "erros": {
+    "code": 10,
+    "message": "Some error has occurred."
+  }
 }
 ```
 
@@ -335,8 +335,8 @@ error_handling json: { '$.errors.code': 20 },
 
 Keep the following in mind when using the `retry` option:
 
-* The `raise` option must be specified for `error_handling`
-* Definition of `error_handling` using `block` is prohibited
+- The `raise` option must be specified for `error_handling`
+- Definition of `error_handling` using `block` is prohibited
 
 #### MyApiClient::NetworkError
 
@@ -405,7 +405,6 @@ class ExampleApiClient < MyApiClient::Base
 end
 ```
 
-
 WIP
 
 ### Stubbing

data/example/api_clients/application_api_client.rb

@@ -4,7 +4,7 @@ require_relative 'my_errors'
 
 # An usage example of the `my_api_client`.
 class ApplicationApiClient < MyApiClient::Base
-  endpoint ENV['MY_API_ENDPOINT']
+  endpoint ENV.fetch('MY_API_ENDPOINT', nil)
 
   self.logger = ::Logger.new(nil)
 

data/lib/my_api_client/errors/network_error.rb

@@ -21,9 +21,9 @@ module MyApiClient
     #   The request and response parameters
     # @param original_error [StandardError]
     #   Some network error
-    def initialize(params, original_error)
+    def initialize(params = nil, original_error = nil)
       @original_error = original_error
-      super params, original_error.message
+      super params, original_error&.message
     end
 
     # Returns contents as string for to be readable for human
@@ -37,7 +37,7 @@ module MyApiClient
     #
     # @return [Hash] Metadata for bugsnag
     def metadata
-      super.merge(original_error: original_error.inspect)
+      super&.merge(original_error: original_error&.inspect)
     end
   end
 end

data/lib/my_api_client/errors.rb

@@ -5,7 +5,7 @@ module MyApiClient
   class Error < StandardError
     attr_reader :params
 
-    delegate :metadata, to: :params
+    delegate :metadata, to: :params, allow_nil: true
     alias to_bugsnag metadata
 
     # Initialize the error class
@@ -14,7 +14,7 @@ module MyApiClient
     #   The request and response parameters
     # @param error_message [String]
     #   The error description
-    def initialize(params, error_message = nil)
+    def initialize(params = nil, error_message = nil)
       @params = params
       super error_message
     end

data/lib/my_api_client/integrations/bugsnag.rb

@@ -6,12 +6,12 @@ module MyApiClient
     alias _original_initialize initialize
 
     # Override MyApiClient::Error#initialize
-    def initialize(params, error_message = nil)
+    def initialize(params = nil, error_message = nil)
       _original_initialize(params, error_message)
 
       Bugsnag.leave_breadcrumb(
         "#{self.class.name} occurred",
-        metadata.transform_values(&:inspect),
+        metadata&.transform_values(&:inspect),
         Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
       )
     end

data/lib/my_api_client/version.rb

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

data/my_api/Gemfile

@@ -7,7 +7,7 @@ gem 'jets'
 gem 'dynomite'
 
 # See: https://github.com/boltops-tools/jets/issues/523
-gem 'nokogiri', '~> 1.12.5'
+gem 'nokogiri', '~> 1.13.6'
 
 # development and test groups are not bundled as part of the deployment
 group :development, :test do