my_api_client 0.23.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb356bb66e525d2980381826847669f7393ee2d3cc5c97691af823045e44396
-  data.tar.gz: f91f20e3fbcaf40211593be9ee722aa4bb0b270071784476f8a806c675af2f36
+  metadata.gz: c6c284685be8f55566beede15458b1a37dc948b09ce05bc264f23187fc266478
+  data.tar.gz: 3cc7d5acf9b8d53fde96270b6ef63baca986ba459f819ad53c11d71744004049
 SHA512:
-  metadata.gz: 1bf2454a9a0d0ae0bc9e706d20f75016c59dd307942eb8ae28b3a0cfd0dc8d3964deb1eb097945c92eeb841c949bf0d670d34f2d979f50bdb6f7a2d332333823
-  data.tar.gz: b5fb69885d68fc31bd06e11c743d2b9b2044bab403e3b0eb9f67421d44587813095677ec41ea657844ead2325ab71a8b5edead53be8051e38602c64c47755e4f
+  metadata.gz: 36ae22feafaddcab8f70f1c755c89d6cacd2bced91fe04c373c56d1e45c157c5c64188de9b1edd2f43eaa9ab1a50339e8c19ec94bd6a67802f83e28d6deb5228
+  data.tar.gz: 980a73834aa0c2e5b0c95d111b19466c8918a8ab5e43fdfefc46f7e4e4bc033b206dca290cfb0c9d5122ff9d6e4fa02b441c180150ccc4e05b4cbb26cc4c3546

data/.circleci/config.yml

@@ -12,12 +12,12 @@ references:
   - &ruby_version
     ruby_version:
       type: enum
-      enum: &ruby_version_enum ["2.7", "3.0", "3.1"]
-      default: "3.1"
+      enum: &ruby_version_enum ["2.7", "3.0", "3.1", "3.2"]
+      default: "3.2"
   - &rails_version
     rails_version:
       type: enum
-      enum: &rails_version_enum ["5.2", "6.0", "6.1", "7.0"]
+      enum: &rails_version_enum ["6.0", "6.1", "7.0"]
       default: "7.0"
   - &bundler_options
     bundler_options:
@@ -153,7 +153,7 @@ commands:
           name: Install Bundler 2.x
           command: gem install bundler -v '~> 2.0'
       - ruby-orbs/bundle-install:
-          cache_key_prefix: v1-dependencies-<< parameters.ruby_version >>
+          cache_key_prefix: v2-dependencies-<< parameters.ruby_version >>
           bundle_extra_args: << parameters.bundler_options >>
           restore_bundled_with: false
   test_and_deploy_for_api:
@@ -252,7 +252,7 @@ jobs:
       - code-climate/install
       - code-climate/sum-coverage:
           input: codeclimate.*.json
-          parts: 20
+          parts: 24
       - code-climate/upload-coverage
   rubocop:
     executor: gem_executor
@@ -287,30 +287,12 @@ workflows:
               ruby_version: *ruby_version_enum
               rails_version: *rails_version_enum
               bundler_options: ["--with integrations", "--without integrations"]
-            exclude:
-              - ruby_version: "3.0"
-                rails_version: "5.2"
-                bundler_options: "--with integrations"
-              - ruby_version: "3.0"
-                rails_version: "5.2"
-                bundler_options: "--without integrations"
-              - ruby_version: "3.1"
-                rails_version: "5.2"
-                bundler_options: "--with integrations"
-              - ruby_version: "3.1"
-                rails_version: "5.2"
-                bundler_options: "--without integrations"
       - verify_generator:
           name: verify_generator_on_ruby_<< matrix.ruby_version >>_and_rails_<< matrix.rails_version >>
           matrix:
             parameters:
               ruby_version: *ruby_version_enum
               rails_version: *rails_version_enum
-            exclude:
-              - ruby_version: "3.0"
-                rails_version: "5.2"
-              - ruby_version: "3.1"
-                rails_version: "5.2"
       - test_api:
           ruby_version: "2.7" # Jets supports only Ruby 2.x
       - rubocop

data/.rubocop.yml

@@ -1,5 +1,6 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 
 inherit_from: .rubocop_todo.yml
@@ -11,6 +12,9 @@ AllCops:
     - rails_app/**/*
     - vendor/bundle/**/*
 
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
 Layout/LineLength:
   Max: 100
   Exclude:
@@ -56,3 +60,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 2023-02-06 23:31:23 UTC using RuboCop version 1.41.1.
 # 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
@@ -32,7 +32,7 @@ Naming/VariableNumber:
     - 'spec/lib/my_api_client/error_handling_spec.rb'
     - 'spec/lib/my_api_client/request/executor_spec.rb'
 
-# Offense count: 60
+# Offense count: 101
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 15

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Change log
 
+## v0.25.0 (Feb 12, 2023)
+
+### Breaking Change
+
+- [#864](https://github.com/ryz310/my_api_client/pull/864) Support Ruby 3.2 and drop support for Rails 5.2 ([@ryz310](https://github.com/ryz310))
+
+### Rubocop Challenge
+
+- [#809](https://github.com/ryz310/my_api_client/pull/809) Style/RedundantConstantBase-20221208233100 ([@ryz310](https://github.com/ryz310))
+- [#812](https://github.com/ryz310/my_api_client/pull/812) Lint/RedundantCopDisableDirective-20221211233112 ([@ryz310](https://github.com/ryz310))
+- [#862](https://github.com/ryz310/my_api_client/pull/862) Performance/StringInclude-20230206233100 ([@ryz310](https://github.com/ryz310))
+
+### Dependabot
+
+- [#830](https://github.com/ryz310/my_api_client/pull/830) ryz310/dependabot/bundler/simplecov-0.22.0 ([@ryz310](https://github.com/ryz310))
+- [#858](https://github.com/ryz310/my_api_client/pull/858) Bump faraday from 2.7.3 to 2.7.4 ([@ryz310](https://github.com/ryz310))
+- [#859](https://github.com/ryz310/my_api_client/pull/859) Bump activesupport from 7.0.4.1 to 7.0.4.2 ([@ryz310](https://github.com/ryz310))
+- [#863](https://github.com/ryz310/my_api_client/pull/863) Bump bugsnag from 6.25.1 to 6.25.2 ([@ryz310](https://github.com/ryz310))
+
+## 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,8 +1,8 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.23.0)
-      activesupport (>= 5.2.0)
+    my_api_client (0.25.0)
+      activesupport (>= 6.0.0)
       faraday (>= 0.17.1)
       jsonpath
       sawyer (>= 0.8.2)
@@ -10,95 +10,102 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.4.2)
       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)
+    bugsnag (6.25.2)
       concurrent-ruby (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    json (2.6.3)
     jsonpath (1.1.2)
       multi_json
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.17.0)
     multi_json (1.15.0)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.2)
       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.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.7.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.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       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.3)
       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.45.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       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.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.14.2)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    webmock (3.14.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -119,10 +126,11 @@ DEPENDENCIES
   rspec_junit_formatter
   rubocop
   rubocop-performance
+  rubocop-rake
   rubocop-rspec
-  simplecov (= 0.21.2)
+  simplecov (= 0.22.0)
   webmock
   yard
 
 BUNDLED WITH
-   2.3.11
+   2.3.26

data/README.jp.md

@@ -12,8 +12,8 @@ MyApiClient は API リクエストクラスを作成するための汎用的な
 
 ## Supported Versions
 
-- Ruby 2.7, 3.0, 3.1
-- Rails 5.2, 6.0, 6.1, 7.0
+- Ruby 2.7, 3.0, 3.1, 3.2
+- Rails 6.0, 6.1, 7.0
 
 ## Installation
 
@@ -221,6 +221,21 @@ 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

@@ -1,4 +1,8 @@
-[![CircleCI](https://circleci.com/gh/ryz310/my_api_client.svg?style=svg)](https://circleci.com/gh/ryz310/my_api_client) [![Gem Version](https://badge.fury.io/rb/my_api_client.svg)](https://badge.fury.io/rb/my_api_client) [![Maintainability](https://api.codeclimate.com/v1/badges/861a2c8f168bbe995107/maintainability)](https://codeclimate.com/github/ryz310/my_api_client/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/861a2c8f168bbe995107/test_coverage)](https://codeclimate.com/github/ryz310/my_api_client/test_coverage) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=ryz310/my_api_client)](https://dependabot.com)
+[![CircleCI](https://circleci.com/gh/ryz310/my_api_client.svg?style=svg)](https://circleci.com/gh/ryz310/my_api_client)
+[![Gem Version](https://badge.fury.io/rb/my_api_client.svg)](https://badge.fury.io/rb/my_api_client)
+[![Maintainability](https://api.codeclimate.com/v1/badges/861a2c8f168bbe995107/maintainability)](https://codeclimate.com/github/ryz310/my_api_client/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/861a2c8f168bbe995107/test_coverage)](https://codeclimate.com/github/ryz310/my_api_client/test_coverage)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/ryz310/my_api_client)
 
 日本語ドキュメントは [こちら](README.jp.md)
 
@@ -12,8 +16,8 @@ It is supposed to be used in Ruby on Rails, but it is made to work in other envi
 
 ## Supported Versions
 
-- Ruby 2.7, 3.0, 3.1
-- Rails 5.2, 6.0, 6.1, 7.0
+- Ruby 2.7, 3.0, 3.1, 3.2
+- Rails 6.0, 6.1, 7.0
 
 ## Installation
 
@@ -223,6 +227,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/rspec/stub.rb

@@ -86,7 +86,7 @@ module MyApiClient
       when Proc
         stub_as_resource(options.call(*request))
       when Hash
-        if options[:raise] # rubocop:disable Style/GuardClause
+        if options[:raise]
           raise process_raise_option(options[:raise], options[:response], options[:status_code])
         elsif options[:response]
           stub_as_resource(options[:response])

data/lib/my_api_client/version.rb

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

data/my_api/Gemfile

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