my_api_client 0.16.0 → 0.20.0

data/Gemfile

@@ -4,9 +4,6 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Workaound for ruby 2.4. Because activesupport v6.0.0 requires ruby 2.5 over.
-gem 'activesupport', '< 6.0.0'
-
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'
 end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.16.0)
-      activesupport (>= 4.2.0)
+    my_api_client (0.20.0)
+      activesupport (>= 5.2.0)
       faraday (>= 0.17.1)
       jsonpath
       sawyer (>= 0.8.2)
@@ -10,103 +10,109 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.2)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    bugsnag (6.13.0)
+    ast (2.4.2)
+    bugsnag (6.19.0)
       concurrent-ruby (~> 1.0)
-    byebug (11.1.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    faraday (1.0.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    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)
     hashdiff (1.0.1)
-    i18n (1.8.2)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
-    jsonpath (1.0.5)
+    jsonpath (1.1.0)
       multi_json
-      to_regexp (~> 0.2.1)
     method_source (1.0.0)
-    minitest (5.14.0)
-    multi_json (1.14.1)
+    minitest (5.14.4)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
-    parallel (1.19.1)
-    parser (2.7.0.5)
-      ast (~> 2.4.0)
-    pry (0.13.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    public_suffix (4.0.3)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.11.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
+      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 (>= 0.4.0)
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    simplecov (0.17.1)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    to_regexp (0.2.1)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    webmock (3.8.3)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    webmock (3.12.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.24)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (< 6.0.0)
   bugsnag (>= 6.11.0)
   bundler (>= 2.0)
   my_api_client!
@@ -117,9 +123,9 @@ DEPENDENCIES
   rubocop
   rubocop-performance
   rubocop-rspec
-  simplecov (= 0.17.1)
+  simplecov (= 0.21.2)
   webmock
   yard
 
 BUNDLED WITH
-   2.1.2
+   2.2.3

data/README.jp.md

@@ -12,8 +12,8 @@ MyApiClient は API リクエストクラスを作成するための汎用的な
 
 ## Supported Versions
 
-* Ruby 2.4, 2.5, 2.6, 2.7
-* Rails 4.2, 5.0, 5.1, 5.2, 6.0
+* Ruby 2.5, 2.6, 2.7, 3.0
+* Rails 5.2, 6.0, 6.1
 
 ## Installation
 
@@ -26,7 +26,7 @@ gem 'my_api_client'
 Ruby on Rails を利用している場合は `generator` 機能を利用できます。
 
 ```sh
-$ rails g api_client path/to/resource get:path/to/resource
+$ rails g api_client path/to/resource get:path/to/resource --endpoint https://example.com
 
 create  app/api_clients/application_api_client.rb
 create  app/api_clients/path/to/resource_api_client.rb
@@ -551,6 +551,8 @@ end
 
 ### Stubbing
 
+#### `response` option
+
 以下のような `ApiClient` を定義しているとします。
 
 ```ruby
@@ -587,6 +589,7 @@ response = ExampleApiClient.new.request(user_id: 1)
 response.id # => 12345
 ```
 
+#### Proc
 
 リクスエストパラメータを使ったレスポンスを返すようにスタブ化したい場合は、 `Proc` を利用することで実現できます。
 
@@ -600,7 +603,9 @@ response = ExampleApiClient.new.request(user_id: 1)
 response.id # => 1
 ```
 
-`receive` や `have_received` を使ったテストを書きたい場合は、 `stub_api_client_all` や `stub_api_client` の戻り値を利用すると良いでしょう。
+#### Return value of `#stub_api_client_all` and `#stub_api_client`
+
+`#stub_api_client_all` や `#stub_api_client` の戻り値はスタブ化した API Client のスタブオブジェクトです。`receive` や `have_received` を使ったテストを書きたい場合は、これらの値を利用すると良いでしょう。
 
 ```ruby
 def execute_api_request
@@ -612,7 +617,9 @@ execute_api_request
 expect(api_client).to have_received(:request).with(user_id: 1)
 ```
 
-また、例外が発生する場合のテストを書きたい場合は、 `raise` オプションを利用することができます。
+#### `raise` option
+
+例外が発生する場合のテストを書きたい場合は、 `raise` オプションを利用することができます。
 
 ```ruby
 def execute_api_request
@@ -642,6 +649,120 @@ rescue MyApiClient::Error => e
 end
 ```
 
+#### `pageable` option
+
+`#pageable_get`  (`#pget`) を使った実装用に `pageable` というオプションが利用できます。
+`pageable` に設定する値は `Enumerable` である必要があります。
+
+```ruby
+stub_api_client_all(
+  MyPaginationApiClient,
+  pagination: {
+    pageable: [
+      { page: 1 },
+      { page: 2 },
+      { page: 3 },
+    ],
+  }
+)
+
+MyPaginationApiClient.new.pagination.each do |response|
+  response.page #=> 1, 2, 3
+end
+```
+
+なお、 `Enumerable` の各値にはここまで紹介した `response`, `raise`, `Prox` など全てのオプションが利用可能です。
+
+```ruby
+stub_api_client_all(
+  MyPaginationApiClient,
+  pagination: {
+    pageable: [
+      { response: { page: 1 } },
+      { page: 2 },
+      ->(params) { { page: 3, user_id: params[:user_id] } },
+      { raise: MyApiClient::ClientError::IamTeapot },
+    ],
+  }
+)
+```
+
+また、 `Enumerator` を使えば無限に続くページネーションを定義することもできます。
+
+
+```ruby
+stub_api_client_all(
+  MyPaginationApiClient,
+  pagination: {
+    pageable: Enumerator.new do |y|
+      loop.with_index(1) do |_, i|
+        y << { page: i }
+      end
+    end,
+  }
+)
+```
+
+## Deployment
+
+この gem のリリースには [gem_comet](https://github.com/ryz310/gem_comet) を利用しています。
+`gem_comet` の README.md にも使い方が載っていますが、備忘録のため、こちらにもリリースフローを記載しておきます。
+
+### Preparement
+
+以下のコマンドで `.envrc` を作成し、 `GITHUB_ACCESS_TOKEN` を設定します。
+
+```sh
+$ cp .envrc.skeleton .envrc
+```
+
+以下のコマンドで `gem_comet` をインストールします。
+
+```sh
+$ gem install gem_comet
+```
+
+### USAGE
+
+以下のコマンドで、最後のリリースから現在までに merge した PR の一覧を確認できます。
+
+```sh
+$ gem_comet changelog
+```
+
+以下のコマンドで gem のリリースを実行します。
+`{VERSION}` には新しく付与するバージョン番号を指定します。
+
+```sh
+$ 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 v{VERSION}`  という PR から merge に取り掛かります。
+
+PR のコメントにも TODO が記載されていますが、まず、バージョン番号が正しく採番されているかを確認します。
+
+See: [314a4c0](https://github.com/ryz310/my_api_client/pull/297/commits/314a4c06f66324ce77b640b1ee8db5c84ee038a2)
+
+次に `CHANGELOG.md` を編集して、 CHANGELOG を見やすく整理します。
+
+See: [33a2d17](https://github.com/ryz310/my_api_client/pull/297/commits/33a2d1703c773813c837e74ee3181906b2f2e502)
+
+これらが整ったら、 `Update v{VERSION}`  を merge します。
+
+これでリリース準備が整ったので、`Release v{VERSION}`  の merge に取り掛かります。
+
+この PR にこれからリリースする gem に対する変更が全て載っています。
+変更内容の最終確認をして、 CI も通ったことを確認したら `Release v{VERSION}`  を merge します。
+
+あとは Circle CI 側で gem のリリースが自動実行されるので、暫く待ちましょう。
+
+お疲れさまでした :tea:
+
 ## Contributing
 
 不具合の報告や Pull Request を歓迎しています。OSS という事で自分はなるべく頑張って英語を使うようにしていますが、日本語での報告でも大丈夫です :+1:

data/bin/console

@@ -3,6 +3,10 @@
 
 require 'bundler/setup'
 require 'my_api_client'
+require './example/api_clients/my_error_api_client'
+require './example/api_clients/my_rest_api_client'
+require './example/api_clients/my_pagination_api_client'
+require './example/api_clients/my_status_api_client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/example/api_clients/application_api_client.rb

@@ -8,6 +8,6 @@ class ApplicationApiClient < MyApiClient::Base
 
   self.logger = ::Logger.new(nil)
 
-  http_open_timeout 2.seconds
-  http_read_timeout 3.seconds
+  http_open_timeout 5.seconds
+  http_read_timeout 5.seconds
 end

data/example/api_clients/my_rest_api_client.rb

@@ -18,13 +18,19 @@ class MyRestApiClient < ApplicationApiClient
   end
 
   # POST rest
-  def create_post(title:)
+  def post_post(title:)
     body = { title: title }
     post 'rest', body: body, headers: headers
   end
 
-  # POST/PUT/PATCH rest/:id
-  def update_post(id:, title:)
+  # PUT rest/:id
+  def put_post(id:, title:)
+    body = { title: title }
+    put "rest/#{id}", body: body, headers: headers
+  end
+
+  # PATCH rest/:id
+  def patch_post(id:, title:)
     body = { title: title }
     patch "rest/#{id}", body: body, headers: headers
   end

data/gemfiles/{rails_4.2.gemfile → rails_6.1.gemfile}

@@ -6,7 +6,7 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'activesupport', '~> 4.2.0'
+gem 'activesupport', '~> 6.1.0'
 
 group :integrations, optional: true do
   gem 'bugsnag', '>= 6.11.0'

data/lib/generators/rails/USAGE

@@ -2,7 +2,7 @@ Description:
     Generate a new api client class files.
 
 Example:
-    `rails g api_client path/to/resource get:path/to/resource`
+    `rails g api_client path/to/resource get:path/to/resource` --endpoint https://example.com
 
     This will create:
         create  app/api_clients/application_api_client.rb

data/lib/generators/rails/api_client_generator.rb

@@ -15,6 +15,12 @@ module Rails
              default: %w[get:path/to/resource post:path/to/resource],
              banner: '{method}:{path} {method}:{path}'
 
+    class_option :endpoint,
+                 type: :string,
+                 default: 'https://example.com',
+                 banner: 'https://example.com',
+                 desc: 'Common part of the target API endpoint'
+
     def generate_root_class
       file_path = File.join('app/api_clients', 'application_api_client.rb')
       return if File.exist?(file_path)