my_api_client 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb356bb66e525d2980381826847669f7393ee2d3cc5c97691af823045e44396
-  data.tar.gz: f91f20e3fbcaf40211593be9ee722aa4bb0b270071784476f8a806c675af2f36
+  metadata.gz: 625b09ebe3b913ebf52c369554945368280eedb5610c6c9af64d0f0115ff4414
+  data.tar.gz: e2bd5807d57814f29ffed4cbc4a708f21925ab3546734d00e10296073a987240
 SHA512:
-  metadata.gz: 1bf2454a9a0d0ae0bc9e706d20f75016c59dd307942eb8ae28b3a0cfd0dc8d3964deb1eb097945c92eeb841c949bf0d670d34f2d979f50bdb6f7a2d332333823
-  data.tar.gz: b5fb69885d68fc31bd06e11c743d2b9b2044bab403e3b0eb9f67421d44587813095677ec41ea657844ead2325ab71a8b5edead53be8051e38602c64c47755e4f
+  metadata.gz: 7e4b479a449d2c7d06953b9daf954c37d4861fa02f42af93275774668c690792292784ca69cdc9fae68d3ee347bc09e595ac15837904ada9635526448afd146d
+  data.tar.gz: f0e4b6b765fb5e14080531ea09d51226cea45fa6b6ad81077b39ffa41ade1656dc4cf2818bbbded6955ed91117df7e2093ec0f89969990734a8b6d6baaccf3f0

data/.rubocop.yml

@@ -56,3 +56,7 @@ RSpec/NestedGroups:
 
 RSpec/MultipleExpectations:
   Max: 4
+
+RSpec/Rails/HaveHttpStatus:
+  Exclude:
+    - "my_api/spec/controllers/**/*"

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-06-06 23:31:13 UTC using RuboCop version 1.30.1.
+# on 2022-10-23 23:31:24 UTC using RuboCop version 1.33.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change log
 
+## v0.24.0 (Nov 07, 2022)
+
+### Feature
+
+- [#792](https://github.com/ryz310/my_api_client/pull/792) Support response header error handling ([@okumud](https://github.com/okumud))
+
+### Rubocop Challenge
+
+- [#757](https://github.com/ryz310/my_api_client/pull/757) RSpec/Rails/HaveHttpStatus-20220712233101 ([@ryz310](https://github.com/ryz310))
+- [#777](https://github.com/ryz310/my_api_client/pull/777) RSpec/ClassCheck-20220912233101 ([@ryz310](https://github.com/ryz310))
+- [#790](https://github.com/ryz310/my_api_client/pull/790) RSpec/Rails/InferredSpecType-20221023233100 ([@ryz310](https://github.com/ryz310))
+
+### Dependabot
+
+- [#758](https://github.com/ryz310/my_api_client/pull/758) ryz310/dependabot/bundler/rubocop-performance-1.14.3 ([@ryz310](https://github.com/ryz310))
+- [#772](https://github.com/ryz310/my_api_client/pull/772) Bump pry-byebug from 3.10.0 to 3.10.1 ([@ryz310](https://github.com/ryz310))
+- [#773](https://github.com/ryz310/my_api_client/pull/773) Bump webmock from 3.17.1 to 3.18.1 ([@ryz310](https://github.com/ryz310))
+- [#775](https://github.com/ryz310/my_api_client/pull/775) Bump activesupport from 7.0.3.1 to 7.0.4 ([@ryz310](https://github.com/ryz310))
+- [#778](https://github.com/ryz310/my_api_client/pull/778) Bump rspec_junit_formatter from 0.5.1 to 0.6.0 ([@ryz310](https://github.com/ryz310))
+- [#780](https://github.com/ryz310/my_api_client/pull/780) Bump faraday from 2.5.2 to 2.6.0 ([@ryz310](https://github.com/ryz310))
+- [#791](https://github.com/ryz310/my_api_client/pull/791) Bump rspec from 3.11.0 to 3.12.0 ([@ryz310](https://github.com/ryz310))
+
+### Misc
+
+- [#784](https://github.com/ryz310/my_api_client/pull/784) Pin the version of the jets gem ([@ryz310](https://github.com/ryz310))
+
 ## v0.23.0 (Jun 08, 2022)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.23.0)
+    my_api_client (0.24.0)
       activesupport (>= 5.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -10,13 +10,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    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.2)
       concurrent-ruby (~> 1.0)
@@ -27,63 +27,65 @@ GEM
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
+    faraday-net_http (3.0.1)
     hashdiff (1.0.1)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 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)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    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.7)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.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)
+    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.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rspec_junit_formatter (0.5.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.30.1)
+    rubocop (1.38.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.14.2)
+    rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sawyer (0.9.2)
@@ -95,10 +97,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    tzinfo (2.0.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)

data/README.jp.md

@@ -221,6 +221,23 @@ error_handling json: { '$.errors.code': 10..19 }, with: :my_error_handling
 }
 ```
 
+`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

data/README.md

@@ -223,6 +223,21 @@ In the above case, it matches JSON as below:
 }
 ```
 
+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

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  VERSION = '0.23.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.13.6'
+gem 'nokogiri', '~> 1.13.8'
 
 # development and test groups are not bundled as part of the deployment
 group :development, :test do

data/my_api/Gemfile.lock

@@ -1,35 +1,35 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.1.5.1)
-      actionpack (= 6.1.5.1)
-      actionview (= 6.1.5.1)
-      activejob (= 6.1.5.1)
-      activesupport (= 6.1.5.1)
+    actionmailer (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      actionview (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.5.1)
-      actionview (= 6.1.5.1)
-      activesupport (= 6.1.5.1)
+    actionpack (6.1.6.1)
+      actionview (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.5.1)
-      activesupport (= 6.1.5.1)
+    actionview (6.1.6.1)
+      activesupport (= 6.1.6.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.5.1)
-      activesupport (= 6.1.5.1)
+    activejob (6.1.6.1)
+      activesupport (= 6.1.6.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.5.1)
-      activesupport (= 6.1.5.1)
-    activerecord (6.1.5.1)
-      activemodel (= 6.1.5.1)
-      activesupport (= 6.1.5.1)
-    activesupport (6.1.5.1)
+    activemodel (6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activerecord (6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activesupport (6.1.6.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -46,47 +46,47 @@ GEM
       rainbow
       thor
       zeitwerk
-    aws-partitions (1.579.0)
-    aws-sdk-apigateway (1.76.0)
+    aws-partitions (1.616.0)
+    aws-sdk-apigateway (1.78.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudformation (1.68.0)
+    aws-sdk-cloudformation (1.70.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudwatchlogs (1.52.0)
+    aws-sdk-cloudwatchlogs (1.53.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.130.2)
+    aws-sdk-core (3.132.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
-      jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.74.0)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-dynamodb (1.75.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-kinesis (1.41.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-kms (1.56.0)
+    aws-sdk-kms (1.58.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-lambda (1.83.0)
+    aws-sdk-lambda (1.84.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.113.0)
+    aws-sdk-s3 (1.114.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.4)
     aws-sdk-sns (1.53.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.51.0)
+    aws-sdk-sqs (1.51.1)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ssm (1.135.0)
+    aws-sdk-ssm (1.138.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.5.0)
+    aws-sigv4 (1.5.1)
       aws-eventstream (~> 1, >= 1.0.2)
     aws_config (0.1.0)
     builder (3.2.4)
@@ -110,19 +110,19 @@ GEM
     concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.5.0)
-    dotenv (2.7.6)
-    dynomite (1.2.6)
+    dotenv (2.8.1)
+    dynomite (1.2.7)
       activesupport
       aws-sdk-dynamodb
       rainbow
-    erubi (1.10.0)
+    erubi (1.11.0)
     gems (1.2.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
     hashie (5.0.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jets (3.1.2)
+    jets (3.1.5)
       actionmailer (~> 6.1.0)
       actionpack (~> 6.1.0)
       actionview (~> 6.1.0)
@@ -140,7 +140,7 @@ GEM
       aws-sdk-sqs
       aws-sdk-ssm
       cfn-status
-      cfn_camelizer (~> 0.4.6)
+      cfn_camelizer (>= 0.4.9)
       cfn_response
       dotenv
       gems
@@ -153,19 +153,19 @@ GEM
       railties (~> 6.1.0)
       rainbow
       recursive-open-struct
-      serverlessgems (~> 0.1.4)
+      serverlessgems (>= 0.2.0)
       shotgun
       text-table
       thor
-      zeitwerk (~> 2.5.0)
+      zeitwerk (>= 2.6.0)
     jets-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
     jmespath (1.6.1)
-    kramdown (2.3.2)
+    kramdown (2.4.0)
       rexml
     launchy (2.5.0)
       addressable (~> 2.7)
-    loofah (2.16.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -175,26 +175,26 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
-    minitest (5.15.0)
+    minitest (5.16.2)
     nio4r (2.5.8)
-    nokogiri (1.13.6)
+    nokogiri (1.13.8)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     public_suffix (4.0.7)
-    puma (5.6.4)
+    puma (5.6.5)
       nio4r (~> 2.0)
     racc (1.6.0)
-    rack (2.2.3.1)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (6.1.5.1)
-      actionpack (= 6.1.5.1)
-      activesupport (= 6.1.5.1)
+    railties (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -215,10 +215,10 @@ GEM
     rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rspec_junit_formatter (0.5.1)
+    rspec-support (3.11.1)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    serverlessgems (0.1.6)
+    serverlessgems (0.2.0)
       gems
       memoist
       zeitwerk
@@ -226,11 +226,11 @@ GEM
       rack (>= 1.0)
     text-table (1.2.4)
     thor (1.2.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby
@@ -239,9 +239,9 @@ DEPENDENCIES
   byebug
   capybara
   dynomite
-  jets
+  jets (~> 3.1.5)
   launchy
-  nokogiri (~> 1.13.6)
+  nokogiri (~> 1.13.8)
   puma
   rack
   rspec

data/my_api/app/controllers/header_controller.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# The header API
+class HeaderController < ApplicationController
+  # GET header
+  def index
+    params.each do |header_name, header_value|
+      response.set_header(header_name, header_value)
+    end
+    render status: :ok, json: {}
+  end
+end

data/my_api/config/routes.rb

@@ -6,6 +6,7 @@ Jets.application.routes.draw do
   resources 'rest', only: %i[index show create update delete]
 
   get 'status/:status', to: 'status#show'
+  get 'header', to: 'header#index'
   get 'error/:code', to: 'error#show'
   get 'pagination', to: 'pagination#index'
 

data/my_api/spec/controllers/error_controller_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe ErrorController, type: :controller do
+describe ErrorController do
   describe '#show' do
     context 'when request error code 10' do
       let(:code) { 10 }

data/my_api/spec/controllers/header_controller_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+describe HeaderController do
+  describe '#index' do
+    context 'when request header with a header' do
+      let(:headers) { { 'x-header': 'value' } }
+
+      it 'returns 200 OK request with header' do
+        get '/header', query: headers
+        expect(response.status).to eq 200
+        expect(response.body).to eq '{}'
+        expect(response.headers['x-header']).to eq 'value'
+      end
+    end
+
+    context 'when request header with multiple headers' do
+      let(:headers) do
+        {
+          'x-header': 'value1',
+          'x-second-header': 'value2',
+        }
+      end
+
+      it 'returns 200 OK request with header' do
+        get '/header', query: headers
+        expect(response.status).to eq 200
+        expect(response.body).to eq '{}'
+        expect(response.headers['x-header']).to eq 'value1'
+        expect(response.headers['x-second-header']).to eq 'value2'
+      end
+    end
+  end
+end

data/my_api/spec/controllers/pagination_controller_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe PaginationController, type: :controller do
+describe PaginationController do
   describe '#index' do
     let(:first_page) do
       {

data/my_api/spec/controllers/rest_controller_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe RestController, type: :controller do
+describe RestController do
   describe '#index' do
     context 'with order = asc' do
       let(:array_of_posts) do

data/my_api/spec/controllers/status_controller_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe StatusController, type: :controller do
+describe StatusController do
   describe '#show' do
     context 'when request status code 200' do
       let(:status) { 200 }

data/rails_app/rails_5.2/Gemfile.lock

@@ -81,7 +81,7 @@ GEM
       concurrent-ruby (~> 1.0)
     jsonpath (1.1.0)
       multi_json
-    loofah (2.10.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -95,7 +95,7 @@ GEM
     multi_json (1.15.0)
     multipart-post (2.1.1)
     nio4r (2.5.7)
-    nokogiri (1.13.6)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     public_suffix (4.0.6)
@@ -119,7 +119,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
     railties (5.2.6)
       actionpack (= 5.2.6)
@@ -159,7 +159,7 @@ GEM
       sprockets (>= 3.0.0)
     thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.9)
+    tzinfo (1.2.10)
       thread_safe (~> 0.1)
     websocket-driver (0.7.4)
       websocket-extensions (>= 0.1.0)

data/rails_app/rails_6.0/Gemfile.lock

@@ -85,7 +85,7 @@ GEM
       concurrent-ruby (~> 1.0)
     jsonpath (1.1.2)
       multi_json
-    loofah (2.17.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -98,7 +98,7 @@ GEM
     msgpack (1.4.2)
     multi_json (1.15.0)
     nio4r (2.5.8)
-    nokogiri (1.13.6)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     psych (3.3.2)
@@ -125,7 +125,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
     railties (6.0.4.8)
       actionpack (= 6.0.4.8)
@@ -165,7 +165,7 @@ GEM
       sprockets (>= 3.0.0)
     thor (1.2.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.9)
+    tzinfo (1.2.10)
       thread_safe (~> 0.1)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)

data/rails_app/rails_6.1/Gemfile.lock

@@ -91,7 +91,7 @@ GEM
     listen (3.3.3)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.17.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -103,7 +103,7 @@ GEM
     minitest (5.15.0)
     multi_json (1.15.0)
     nio4r (2.5.8)
-    nokogiri (1.13.6)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     public_suffix (4.0.7)
@@ -129,7 +129,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
     railties (6.1.5.1)
       actionpack (= 6.1.5.1)

data/rails_app/rails_7.0/Gemfile.lock

@@ -99,7 +99,7 @@ GEM
       reline (>= 0.3.0)
     jsonpath (1.1.2)
       multi_json
-    loofah (2.17.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -124,9 +124,9 @@ GEM
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.6-x86_64-darwin)
+    nokogiri (1.13.9-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.6-x86_64-linux)
+    nokogiri (1.13.9-x86_64-linux)
       racc (~> 1.4)
     public_suffix (4.0.7)
     racc (1.6.0)
@@ -150,7 +150,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
     railties (7.0.2.4)
       actionpack (= 7.0.2.4)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_api_client
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-11-07 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_header_api_client.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
@@ -306,6 +307,7 @@ files:
 - my_api/Rakefile
 - my_api/app/controllers/application_controller.rb
 - my_api/app/controllers/error_controller.rb
+- my_api/app/controllers/header_controller.rb
 - my_api/app/controllers/pagination_controller.rb
 - my_api/app/controllers/rest_controller.rb
 - my_api/app/controllers/status_controller.rb
@@ -326,6 +328,7 @@ files:
 - my_api/public/favicon.ico
 - my_api/public/index.html
 - my_api/spec/controllers/error_controller_spec.rb
+- my_api/spec/controllers/header_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