my_api_client 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eb52f8cf1220f7a0db30d5a6f83a8ef880315d6f23f878103ea234812c4071e
-  data.tar.gz: d6176d4ea51df4d2486be4150055b05b60ded0d674c937c61bc46dc9df79f0a6
+  metadata.gz: 4e3243e1c615b0f94cd59c9b0c47c9c8de69dd17c3113a0a5f32e3d1dfaebff5
+  data.tar.gz: 8b3405efa79ef2c94aa97b0bbb8b90e1c445f2b27bbe590d70a1cc2efac49466
 SHA512:
-  metadata.gz: 4bfcd9f62258c714797b9234959f53b2c84c2bc7c651d8ea6b4ba8ce2a6750c8528c8cd33ee842f090c01414c65028d0e8c412a2ec3e425b9382984f632cda37
-  data.tar.gz: 6f48b2d64393db7ca69da8e68236c095f5bf94fd424e87cd805cb264a09e616782816d7b83308b512d6e45a3f500b6c85f1a2f93e2ef6b96cb2a23d486909561
+  metadata.gz: 7ddd98c45754dd5bc65695e73671debea7467bc961bc35cc4ad5167d421e407260fd941eacc1ef264eed44ce588ef2a739cd075254353e14889bcafe176618f3
+  data.tar.gz: 574d774f927aca3693b7f11bb2d1aae12d1300625b492ccfb8c31d1313856c6f754f3d06524b85d60504bafac9f6b6ec2b89e9bdf3eb42995ef0658bbc39459e

data/.circleci/config.yml

@@ -25,18 +25,25 @@ references:
       default: ''
 
 executors:
-  executor_for_api:
+  api_executor:
     parameters:
       <<: *ruby_version
     docker:
-      - image: circleci/ruby:<< parameters.ruby_version >>-node-browsers
+      - image: circleci/ruby:<< parameters.ruby_version >>
     working_directory: ~/repo/my_api
-  executor_for_gem:
+  gem_executor:
     parameters:
       <<: *ruby_version
     docker:
-       - image: circleci/ruby:<< parameters.ruby_version >>-node-browsers
+       - image: circleci/ruby:<< parameters.ruby_version >>
     working_directory: ~/repo
+  rails_executor:
+    parameters:
+      <<: *ruby_version
+      <<: *rails_version
+    docker:
+       - image: circleci/ruby:<< parameters.ruby_version >>
+    working_directory: ~/repo/rails_app/rails_<< parameters.rails_version >>
 
 commands:
   modify_active_support_version:
@@ -144,18 +151,18 @@ commands:
           path: ~/repo
       - run:
           name: Install Bundler 2.x
-          command: gem install bundler:2.1.2
+          command: gem install bundler -v '~> 2.0'
       - ruby-orbs/bundle-install:
           cache_key_prefix: v1-dependencies-<< parameters.ruby_version >>
           bundle_extra_args: << parameters.bundler_options >>
           restore_bundled_with: false
   test_and_deploy_for_api:
-    description: Build the API
+    description: Test and build the API
     steps:
       - run_rspec_for_api
       - deploy_api_server
   test_and_build_for_gem:
-    description: Build the RubyGem
+    description: Test and build the RubyGem
     parameters:
       <<: *rails_version
     steps:
@@ -163,13 +170,33 @@ commands:
           rails_version: << parameters.rails_version >>
       - run_rspec_for_gem
       - rake_build
+  verify_api_client_generator:
+    description: Verify the API client generator
+    parameters:
+      <<: *rails_version
+    steps:
+      - run:
+          name: Generate new API client files
+          command: |
+            bin/rails g api_client path/to/resource \
+              get:path/to/resource \
+              post:path/to/resource
+      - run:
+          name: Check the API client files exists
+          command: |
+            test -e "app/api_clients/application_api_client.rb" & \
+            test -e "app/api_clients/path/to/resource_api_client.rb" & \
+            test -e "spec/api_clients/path/to/resource_api_client_spec.rb"
+      - run:
+          name: Run rspec with the generated spec file
+          command: bundle exec rspec -f d spec/api_clients/path/to
 
 jobs:
   test_api:
     parameters:
       <<: *ruby_version
     executor:
-      name: executor_for_api
+      name: api_executor
       ruby_version: << parameters.ruby_version >>
     steps:
       - setup:
@@ -179,7 +206,7 @@ jobs:
     parameters:
       <<: *ruby_version
     executor:
-      name: executor_for_api
+      name: api_executor
       ruby_version: << parameters.ruby_version >>
     steps:
       - setup:
@@ -191,7 +218,7 @@ jobs:
       <<: *rails_version
       <<: *bundler_options
     executor:
-      name: executor_for_gem
+      name: gem_executor
       ruby_version: << parameters.ruby_version >>
     steps:
       - setup:
@@ -199,8 +226,21 @@ jobs:
           bundler_options: << parameters.bundler_options >>
       - test_and_build_for_gem:
           rails_version: << parameters.rails_version >>
+  verify_generator:
+    parameters:
+      <<: *ruby_version
+      <<: *rails_version
+    executor:
+      name: rails_executor
+      ruby_version: << parameters.ruby_version >>
+      rails_version: << parameters.rails_version >>
+    steps:
+      - setup:
+          ruby_version: << parameters.ruby_version >>
+      - verify_api_client_generator:
+          rails_version: << parameters.rails_version >>
   upload-coverage:
-    executor: executor_for_gem
+    executor: gem_executor
     steps:
       - attach_workspace:
           at: ~/repo
@@ -210,22 +250,22 @@ jobs:
           parts: 19
       - code-climate/upload-coverage
   rubocop:
-    executor: executor_for_gem
+    executor: gem_executor
     steps:
       - setup
       - rubocop
   yardoc:
-    executor: executor_for_gem
+    executor: gem_executor
     steps:
       - setup
       - yardoc
   rubocop_challenge:
-    executor: executor_for_gem
+    executor: gem_executor
     steps:
       - checkout
       - rubocop_challenge
   release:
-    executor: executor_for_gem
+    executor: gem_executor
     steps:
       - setup
       - release
@@ -313,6 +353,34 @@ workflows:
           ruby_version:  '2.7'
           rails_version: '6.0'
           bundler_options: '--without integrations'
+      - verify_generator:
+          name: verify_generator_on_ruby_2.4_and_rails_5.2
+          ruby_version:  '2.4'
+          rails_version: '5.2'
+      - verify_generator:
+          name: verify_generator_on_ruby_2.5_and_rails_5.2
+          ruby_version:  '2.5'
+          rails_version: '5.2'
+      - verify_generator:
+          name: verify_generator_on_ruby_2.5_and_rails_6.0
+          ruby_version:  '2.5'
+          rails_version: '6.0'
+      - verify_generator:
+          name: verify_generator_on_ruby_2.6_and_rails_5.2
+          ruby_version:  '2.6'
+          rails_version: '5.2'
+      - verify_generator:
+          name: verify_generator_on_ruby_2.6_and_rails_6.0
+          ruby_version:  '2.6'
+          rails_version: '6.0'
+      - verify_generator:
+          name: verify_generator_on_ruby_2.7_and_rails_5.2
+          ruby_version:  '2.7'
+          rails_version: '5.2'
+      - verify_generator:
+          name: verify_generator_on_ruby_2.7_and_rails_6.0
+          ruby_version:  '2.7'
+          rails_version: '6.0'
       - test_api
       - rubocop
       - yardoc
@@ -359,6 +427,13 @@ workflows:
             - build_on_ruby_2.7_and_rails_5.2
             - build_on_ruby_2.7_and_rails_6.0_with_integrations
             - build_on_ruby_2.7_and_rails_6.0_without_integrations
+            - verify_generator_on_ruby_2.4_and_rails_5.2
+            - verify_generator_on_ruby_2.5_and_rails_5.2
+            - verify_generator_on_ruby_2.5_and_rails_6.0
+            - verify_generator_on_ruby_2.6_and_rails_5.2
+            - verify_generator_on_ruby_2.6_and_rails_6.0
+            - verify_generator_on_ruby_2.7_and_rails_5.2
+            - verify_generator_on_ruby_2.7_and_rails_6.0
             - rubocop
           filters:
             branches:

data/.rubocop.yml

@@ -6,6 +6,10 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.4
+  NewCops: enable
+  Exclude:
+    - rails_app/**/*
+    - vendor/bundle/**/*
 
 Layout/LineLength:
   Max: 100

data/.rubocop_challenge.yml

@@ -1,3 +1,5 @@
 ---
 Ignore:
 - Performance/StartWith
+- Style/HashTransformValues
+- Style/StringConcatenation

data/.rubocop_todo.yml

@@ -1,12 +1,35 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-08-17 23:30:51 UTC using RuboCop version 0.89.1.
+# on 2020-09-15 23:30:28 UTC using RuboCop version 0.91.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
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 5
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/my_api_client/error_handling/generator.rb'
+    - 'lib/my_api_client/error_handling/retry_option_processor.rb'
+    - 'lib/my_api_client/integrations/bugsnag.rb'
+    - 'lib/my_api_client/request/executor.rb'
+    - 'lib/my_api_client/sleeper.rb'
+
 # Offense count: 60
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 15
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/HashTransformValues:
+  Exclude:
+    - 'lib/my_api_client/integrations/bugsnag.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/my_api_client/request.rb'
+    - 'lib/my_api_client/rspec/matchers/request_to.rb'
+    - 'my_api/app/controllers/pagination_controller.rb'

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change log
 
+## v0.17.0 (Sep 20, 2020)
+
+### Feature
+
+* [#303](https://github.com/ryz310/my_api_client/pull/303) Change the duration format to milliseconds ([@ryz310](https://github.com/ryz310))
+* [#308](https://github.com/ryz310/my_api_client/pull/308) Add testing for api client generators ([@ryz310](https://github.com/ryz310))
+
+### Rubocop Challenge
+
+* [#311](https://github.com/ryz310/my_api_client/pull/311) Style/GlobalStdStream-20200906233350 ([@ryz310](https://github.com/ryz310))
+* [#312](https://github.com/ryz310/my_api_client/pull/312) Style/StringConcatenation-20200907233020 ([@ryz310](https://github.com/ryz310))
+* [#313](https://github.com/ryz310/my_api_client/pull/313) Style/HashTransformValues-20200908233016 ([@ryz310](https://github.com/ryz310))
+* [#316](https://github.com/ryz310/my_api_client/pull/316) Layout/EmptyLinesAroundAttributeAccessor-20200909233021 ([@ryz310](https://github.com/ryz310))
+* [#320](https://github.com/ryz310/my_api_client/pull/320) Re-generate .rubocop_todo.yml with RuboCop v0.91.0 ([@ryz310](https://github.com/ryz310))
+
+### Dependabot
+
+* [#299](https://github.com/ryz310/my_api_client/pull/299) ryz310/dependabot/bundler/bugsnag-6.17.0 ([@ryz310](https://github.com/ryz310))
+* [#310](https://github.com/ryz310/my_api_client/pull/310) ryz310/dependabot/bundler/rubocop-performance-1.8.0 ([@ryz310](https://github.com/ryz310))
+* [#314](https://github.com/ryz310/my_api_client/pull/314) ryz310/dependabot/bundler/activesupport-5.2.4.4 ([@ryz310](https://github.com/ryz310))
+* [#315](https://github.com/ryz310/my_api_client/pull/315) ryz310/dependabot/bundler/my_api/actionview-6.0.3.3 ([@ryz310](https://github.com/ryz310))
+* [#318](https://github.com/ryz310/my_api_client/pull/318) ryz310/dependabot/bundler/webmock-3.9.1 ([@ryz310](https://github.com/ryz310))
+* [#319](https://github.com/ryz310/my_api_client/pull/319) ryz310/dependabot/bundler/rubocop-0.91.0 ([@ryz310](https://github.com/ryz310))
+* [#321](https://github.com/ryz310/my_api_client/pull/321) ryz310/dependabot/bundler/my_api/puma-5.0.0 ([@ryz310](https://github.com/ryz310))
+
 ## v0.16.1 (Aug 27, 2020)
 
 ### Feature

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.16.1)
+    my_api_client (0.17.0)
       activesupport (>= 4.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.3)
+    activesupport (5.2.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -18,13 +18,12 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
-    bugsnag (6.16.0)
+    bugsnag (6.17.0)
       concurrent-ruby (~> 1.0)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    crack (0.4.4)
     diff-lcs (1.4.4)
     docile (1.3.2)
     faraday (1.0.1)
@@ -37,7 +36,7 @@ GEM
       multi_json
       to_regexp (~> 0.2.1)
     method_source (1.0.0)
-    minitest (5.14.1)
+    minitest (5.14.2)
     multi_json (1.15.0)
     multipart-post (2.1.1)
     parallel (1.19.2)
@@ -49,10 +48,10 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.0)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -69,23 +68,23 @@ GEM
     rspec-support (3.9.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.89.1)
+    rubocop (0.91.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 0.4.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
+    rubocop-ast (0.4.2)
       parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -99,7 +98,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    webmock (3.8.3)
+    webmock (3.9.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.jp.md

@@ -642,6 +642,66 @@ rescue MyApiClient::Error => e
 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: