my_api_client 0.22.0 → 0.24.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.24.0)
       activesupport (>= 5.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -10,125 +10,108 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.4)
+    activesupport (7.0.4)
       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)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.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.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
       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 (3.0.1)
     hashdiff (1.0.1)
-    i18n (1.8.11)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jsonpath (1.1.0)
+    json (2.6.2)
+    jsonpath (1.1.2)
       multi_json
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.3)
     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.1)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.6.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.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       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.12.0)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.24.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       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.23.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.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.6.0)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
     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)
-    tzinfo (2.0.4)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    webmock (3.14.0)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       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 +127,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,13 +214,30 @@ 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."
+  }
 }
 ```
 
+`headers` には `Hash` の Key に レスポンスのヘッダーキーを指定して、 Value とマッチするかどうかでエラーハンドリングできます。Value には `String` `Regexp` が指定可能です。
+
+
+```ruby
+error_handling headers: { 'www-authenticate': /invalid token/ }, with: :my_error_handling
+```
+
+上記の場合であれば、以下のような レスポンスヘッダー にマッチします。
+
+```text
+cache-control: no-cache, no-store, max-age=0, must-revalidate
+content-type: application/json
+www-authenticate: Bearer error="invalid_token", error_description="invalid token"
+content-length: 104
+```
+
+
 `with` にはインスタンスメソッド名を指定することで、エラーを検出した際、例外を発生させる前に任意のメソッドを実行させることができます。メソッドに渡される引数は `block` 定義の場合と同じく `params` と `logger` です。なお、 `block` と `with` は同時には利用できません。
 
 ```ruby
@@ -253,10 +270,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 +361,8 @@ error_handling json: { '$.errors.code': 20 },
 
 `retry` オプションを使用する際は以下の点に注意が必要です。
 
-* `error_handling` に `raise` オプションの指定が必須となります。
-* Block を使った `error_handling` の定義は禁止されます。
+- `error_handling` に `raise` オプションの指定が必須となります。
+- Block を使った `error_handling` の定義は禁止されます。
 
 #### MyApiClient::NetworkError
 
@@ -654,7 +671,7 @@ end
 
 #### `pageable` option
 
-`#pageable_get`  (`#pget`) を使った実装用に `pageable` というオプションが利用できます。
+`#pageable_get` (`#pget`) を使った実装用に `pageable` というオプションが利用できます。
 `pageable` に設定する値は `Enumerable` である必要があります。
 
 ```ruby
@@ -692,7 +709,6 @@ stub_api_client_all(
 
 また、 `Enumerator` を使えば無限に続くページネーションを定義することもできます。
 
-
 ```ruby
 stub_api_client_all(
   MyPaginationApiClient,
@@ -742,10 +758,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 +771,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,13 +216,28 @@ 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."
+  }
 }
 ```
 
+For `headers`, specify response header for the Key of `Hash`, get an arbitrary value from the response header, and check whether it matches value. You can handle errors. You can specify `String` and `Regexp` for value.
+
+```ruby
+error_handling headers: { 'www-authenticate': /invalid token/ }, with: :my_error_handling
+```
+
+In the above case, it matches response header as below:
+
+```text
+cache-control: no-cache, no-store, max-age=0, must-revalidate
+content-type: application/json
+www-authenticate: Bearer error="invalid_token", error_description="invalid token"
+content-length: 104
+```
+
 By specifying the instance method name in `with`, when an error is detected, any method can be executed before raising an exception. The arguments passed to the method are `params` and `logger` as in the `block` definition. Note that `block` and` with` cannot be used at the same time.
 
 ```ruby
@@ -335,8 +350,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 +420,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/example/api_clients/my_errors.rb

@@ -24,4 +24,13 @@ module MyErrors
 
   # Error code: other
   class ErrorCodeOther < MyApiClient::ClientError; end
+
+  # Header: X-First-Header has invalid
+  class FirstHeaderIsInvalid < MyApiClient::ClientError; end
+
+  # Header: X-First-Header has nothing and status is 404
+  class FirstHeaderHasNothingAndNotFound < MyApiClient::ClientError; end
+
+  # Header: X-First-Header has unknown and X-Second-Header has error
+  class MultipleHeaderIsInvalid < MyApiClient::ClientError; end
 end

data/example/api_clients/my_header_api_client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'application_api_client'
+
+# An usage example of the `my_api_client`.
+# See also: my_api/app/controllers/header_controller.rb
+class MyHeaderApiClient < ApplicationApiClient
+  error_handling headers: { 'X-First-Header': /invalid/ },
+                 raise: MyErrors::FirstHeaderIsInvalid
+
+  error_handling headers: {
+                   'X-First-Header': /unknown/,
+                   'X-Second-Header': /error/,
+                 },
+                 raise: MyErrors::MultipleHeaderIsInvalid
+
+  error_handling headers: { 'X-First-Header': /nothing/ },
+                 status_code: 404,
+                 raise: MyErrors::FirstHeaderHasNothingAndNotFound
+
+  # GET header
+  #
+  # @param first_header [String] X-First-Header
+  # @param second_header [String] X-Second-Header
+  # @return [Sawyer::Resource]
+  def get_header(first_header:, second_header:)
+    get 'header', headers: headers, query: {
+      'X-First-Header': first_header,
+      'X-Second-Header': second_header,
+    }.compact
+  end
+
+  private
+
+  def headers
+    { 'Content-Type': 'application/json;charset=UTF-8' }
+  end
+end

data/lib/my_api_client/error_handling/generator.rb

@@ -4,7 +4,7 @@ module MyApiClient
   module ErrorHandling
     # Generates an error handler proc (or symbol)
     class Generator < ServiceAbstract
-      ARGUMENTS = %i[instance response status_code json with raise block].freeze
+      ARGUMENTS = %i[instance response status_code headers json with raise block].freeze
 
       # @param options [Hash]
       #   Options for this generator
@@ -14,6 +14,8 @@ module MyApiClient
       #   The target of verifying
       # @option status_code [String, Range, Integer, Regexp]
       #   Verifies response HTTP status code and raises error if matched
+      # @option headers [String, Regexp]
+      #   Verifies response HTTP header 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.
@@ -36,7 +38,8 @@ module MyApiClient
 
       def call
         return unless match?(_status_code, _response.status)
-        return unless match_all?(_json, _response.body)
+        return unless match_headers?(_headers, _response.headers)
+        return unless match_body?(_json, _response.body)
 
         generate_error_handler
       end
@@ -102,7 +105,17 @@ module MyApiClient
         end
       end
 
-      def match_all?(json, response_body)
+      def match_headers?(headers, response_headers)
+        return true if headers.nil?
+        return false if response_headers.blank?
+
+        headers.all? do |header_key, operator|
+          target = response_headers[header_key]
+          match?(operator, target)
+        end
+      end
+
+      def match_body?(json, response_body)
         return true if json.nil?
         return response_body.nil? if json == :forbid_nil
         return false if response_body.blank?

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.24.0'
 end

data/my_api/Gemfile

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