my_api_client 0.14.0.pre → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d52de78feca8df4a1daac75f796382190d0f383c5f0e379111544d18ae863627
-  data.tar.gz: 76fd03b48893738aa1a1953592c877eba6dd43a6b9c4066a197453f9425ecfa7
+  metadata.gz: 4e3243e1c615b0f94cd59c9b0c47c9c8de69dd17c3113a0a5f32e3d1dfaebff5
+  data.tar.gz: 8b3405efa79ef2c94aa97b0bbb8b90e1c445f2b27bbe590d70a1cc2efac49466
 SHA512:
-  metadata.gz: 95069064c4d7e6f31abbe302db40d11f574726c11631513d3e40b3fd158e77e95ab81079d0fd4033833aac826722455938fc69605acbee0c2ecb58b11a3c949f
-  data.tar.gz: 2c5fceee08ba837afb4901feca3d531e09c8a5d4c2ba6756b2eddd9f185050686e1eed304e077f82aa2f4aa85fe1cb723c17ec7de32470210fc1347cc94ea5fa
+  metadata.gz: 7ddd98c45754dd5bc65695e73671debea7467bc961bc35cc4ad5167d421e407260fd941eacc1ef264eed44ce588ef2a739cd075254353e14889bcafe176618f3
+  data.tar.gz: 574d774f927aca3693b7f11bb2d1aae12d1300625b492ccfb8c31d1313856c6f754f3d06524b85d60504bafac9f6b6ec2b89e9bdf3eb42995ef0658bbc39459e

data/.circleci/config.yml

@@ -25,12 +25,25 @@ references:
       default: ''
 
 executors:
-  default:
+  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
+  gem_executor:
+    parameters:
+      <<: *ruby_version
+    docker:
+       - 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:
@@ -41,8 +54,28 @@ commands:
       - run: |
           cp gemfiles/rails_<< parameters.rails_version >>.gemfile Gemfile
           bundle update activesupport
-  run_rspec:
-    description: Run RSpec
+  run_rspec_for_api:
+    description: Run RSpec for the API
+    steps:
+      - run:
+          name: Execute RSpec
+          command: |
+            bundle exec rspec --format documentation \
+                              --color \
+                              --format RspecJunitFormatter
+  deploy_api_server:
+    description: Deploy the API server on the AWS
+    steps:
+      - run:
+          name: Install RSync
+          command: sudo apt-get install -y rsync
+      - run:
+          # This command is not currently work. It could't reference uploaded gem file.
+          # You can execute `$ bundle exec jets deploy` on your local.
+          name: Deploy the API server with jets
+          command: JETS_AGREE=yes bundle exec jets deploy
+  run_rspec_for_gem:
+    description: Run RSpec for the gem
     steps:
       - code-climate/install
       - run:
@@ -114,40 +147,100 @@ commands:
       <<: *ruby_version
       <<: *bundler_options
     steps:
-      - checkout
+      - checkout:
+          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 >>
-  test_and_build:
-    description: Build the RubyGem
+          restore_bundled_with: false
+  test_and_deploy_for_api:
+    description: Test and build the API
+    steps:
+      - run_rspec_for_api
+      - deploy_api_server
+  test_and_build_for_gem:
+    description: Test and build the RubyGem
     parameters:
       <<: *rails_version
     steps:
       - modify_active_support_version:
           rails_version: << parameters.rails_version >>
-      - run_rspec
+      - 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:
-  build:
+  test_api:
+    parameters:
+      <<: *ruby_version
+    executor:
+      name: api_executor
+      ruby_version: << parameters.ruby_version >>
+    steps:
+      - setup:
+          ruby_version: << parameters.ruby_version >>
+      - run_rspec_for_api
+  deploy_api:
+    parameters:
+      <<: *ruby_version
+    executor:
+      name: api_executor
+      ruby_version: << parameters.ruby_version >>
+    steps:
+      - setup:
+          ruby_version: << parameters.ruby_version >>
+      - test_and_deploy_for_api
+  build_gem:
     parameters:
       <<: *ruby_version
       <<: *rails_version
       <<: *bundler_options
     executor:
-      name: default
+      name: gem_executor
       ruby_version: << parameters.ruby_version >>
     steps:
       - setup:
           ruby_version: << parameters.ruby_version >>
           bundler_options: << parameters.bundler_options >>
-      - test_and_build:
+      - 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: default
+    executor: gem_executor
     steps:
       - attach_workspace:
           at: ~/repo
@@ -157,22 +250,22 @@ jobs:
           parts: 19
       - code-climate/upload-coverage
   rubocop:
-    executor: default
+    executor: gem_executor
     steps:
       - setup
       - rubocop
   yardoc:
-    executor: default
+    executor: gem_executor
     steps:
       - setup
       - yardoc
   rubocop_challenge:
-    executor: default
+    executor: gem_executor
     steps:
       - checkout
       - rubocop_challenge
   release:
-    executor: default
+    executor: gem_executor
     steps:
       - setup
       - release
@@ -182,84 +275,113 @@ workflows:
 
   commit:
     jobs:
-      - build:
+      - build_gem:
           name: build_on_ruby_2.4_and_rails_4.2
           ruby_version:  '2.4'
           rails_version: '4.2'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.4_and_rails_5.0
           ruby_version:  '2.4'
           rails_version: '5.0'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.4_and_rails_5.1
           ruby_version:  '2.4'
           rails_version: '5.1'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.4_and_rails_5.2
           ruby_version:  '2.4'
           rails_version: '5.2'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.5_and_rails_4.2
           ruby_version:  '2.5'
           rails_version: '4.2'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.5_and_rails_5.0
           ruby_version:  '2.5'
           rails_version: '5.0'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.5_and_rails_5.1
           ruby_version:  '2.5'
           rails_version: '5.1'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.5_and_rails_5.2
           ruby_version:  '2.5'
           rails_version: '5.2'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.5_and_rails_6.0
           ruby_version:  '2.5'
           rails_version: '6.0'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.6_and_rails_4.2
           ruby_version:  '2.6'
           rails_version: '4.2'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.6_and_rails_5.0
           ruby_version:  '2.6'
           rails_version: '5.0'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.6_and_rails_5.1
           ruby_version:  '2.6'
           rails_version: '5.1'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.6_and_rails_5.2
           ruby_version:  '2.6'
           rails_version: '5.2'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.6_and_rails_6.0
           ruby_version:  '2.6'
           rails_version: '6.0'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.7_and_rails_5.0
           ruby_version:  '2.7'
           rails_version: '5.0'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.7_and_rails_5.1
           ruby_version:  '2.7'
           rails_version: '5.1'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.7_and_rails_5.2
           ruby_version:  '2.7'
           rails_version: '5.2'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.7_and_rails_6.0_with_integrations
           ruby_version:  '2.7'
           rails_version: '6.0'
           bundler_options: '--with integrations'
-      - build:
+      - build_gem:
           name: build_on_ruby_2.7_and_rails_6.0_without_integrations
           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
       - upload-coverage:
@@ -305,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:
@@ -317,11 +446,23 @@ workflows:
           cron: "30 23 * * *" # 8:30am every day (JST)
           filters:
             branches:
-              only:
-                - master
+              only: [master]
     jobs:
       - rubocop_challenge
 
+  # deploy_api_server:
+  #   triggers:
+  #     - schedule:
+  #         cron: "0 12 * * *" # 3:00am every day (JST)
+  #         filters:
+  #           branches:
+  #             only: [master]
+  #   jobs:
+  #     - deploy_api:
+  #         ruby_version: '2.5'
+  #     - build_gem:
+  #         requires: [deploy_api]
+
 experimental:
   notify:
     branches:

data/.dependabot/config.yml

@@ -2,9 +2,27 @@ version: 1
 update_configs:
   - package_manager: "ruby:bundler"
     directory: "/"
-    update_schedule: "daily"
+    update_schedule: "live"
     default_reviewers:
       - "ryz310"
+    default_assignees:
+      - "ryz310"
+    default_labels:
+      - "dependabot"
+    automerged_updates:
+      - match:
+          dependency_type: "development"
+          update_type: "all"
+      - match:
+          dependency_type: "production"
+          update_type: "semver:patch"
+  - package_manager: "ruby:bundler"
+    directory: "/my_api"
+    update_schedule: "live"
+    default_reviewers:
+      - "ryz310"
+    default_assignees:
+      - "ryz310"
     default_labels:
       - "dependabot"
     automerged_updates:

data/.envrc.skeleton

@@ -1 +1,2 @@
 export GITHUB_ACCESS_TOKEN={GITHUB_ACCESS_TOKEN}
+export MY_API_ENDPOINT={API gateway endtpoint of "my_api" for integration testing}

data/.rubocop.yml

@@ -6,22 +6,29 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.4
+  NewCops: enable
+  Exclude:
+    - rails_app/**/*
+    - vendor/bundle/**/*
 
 Layout/LineLength:
   Max: 100
+  Exclude:
+    - my_api/config/application.rb
 
 Metrics/BlockLength:
   Exclude:
     - 'my_api_client.gemspec'
     - 'lib/my_api_client/rspec/matchers/**/*'
     - 'spec/**/*'
+    - 'my_api/spec/**/*'
 
 Metrics/MethodLength:
   Max: 15
 
 Naming/AccessorMethodName:
   Exclude:
-    - spec/dummy_app/api_clients/example_api_client.rb
+    - example/api_clients/**/*
     - spec/lib/my_api_client/rspec/matchers/be_handled_as_an_error_spec.rb
 
 Style/TrailingCommaInArrayLiteral:
@@ -32,6 +39,7 @@ Style/TrailingCommaInHashLiteral:
 
 RSpec/DescribeClass:
   Exclude:
+    - 'spec/integrations/api_clients/**/*'
     - 'spec/lib/my_api_client/rspec/matchers/**/*'
 
 RSpec/ExampleLength:

data/.rubocop_challenge.yml

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