my_api_client 0.14.0.pre → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d52de78feca8df4a1daac75f796382190d0f383c5f0e379111544d18ae863627
-  data.tar.gz: 76fd03b48893738aa1a1953592c877eba6dd43a6b9c4066a197453f9425ecfa7
+  metadata.gz: f0b010bd5bb4ef7d0b3a99c826fefc67bedf5e9f51bcfd7779dc618c2b9a4f58
+  data.tar.gz: 4806eb56f7556728fc848c7e54408a127393a921a29e248a9d32ba950b4f3ef3
 SHA512:
-  metadata.gz: 95069064c4d7e6f31abbe302db40d11f574726c11631513d3e40b3fd158e77e95ab81079d0fd4033833aac826722455938fc69605acbee0c2ecb58b11a3c949f
-  data.tar.gz: 2c5fceee08ba837afb4901feca3d531e09c8a5d4c2ba6756b2eddd9f185050686e1eed304e077f82aa2f4aa85fe1cb723c17ec7de32470210fc1347cc94ea5fa
+  metadata.gz: 6bc2efb59de265f84c727ce67e9717fff724251136ffe7159a0a61151d335bb476386649e23ef5bb8a9982e387bebd53c58064817517fdac855bd9ac3fc4d6e8
+  data.tar.gz: f0db303e86287d71099d0c0e29024663013cf4c44dffac1ac1d9c2a18113b34a4d5a1e9a6d3a4824833d1bb413a875deb0a45bb2f2becb25d4119d1028a1d10c

data/.circleci/config.yml

@@ -25,7 +25,13 @@ references:
       default: ''
 
 executors:
-  default:
+  executor_for_api:
+    parameters:
+      <<: *ruby_version
+    docker:
+      - image: circleci/ruby:<< parameters.ruby_version >>-node-browsers
+    working_directory: ~/repo/my_api
+  executor_for_gem:
     parameters:
       <<: *ruby_version
     docker:
@@ -41,8 +47,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 +140,57 @@ commands:
       <<: *ruby_version
       <<: *bundler_options
     steps:
-      - checkout
+      - checkout:
+          path: ~/repo
       - run:
           name: Install Bundler 2.x
           command: gem install bundler:2.1.2
       - ruby-orbs/bundle-install:
           cache_key_prefix: v1-dependencies-<< parameters.ruby_version >>
           bundle_extra_args: << parameters.bundler_options >>
-  test_and_build:
+          restore_bundled_with: false
+  test_and_deploy_for_api:
+    description: Build the API
+    steps:
+      - run_rspec_for_api
+      - deploy_api_server
+  test_and_build_for_gem:
     description: Build the RubyGem
     parameters:
       <<: *rails_version
     steps:
       - modify_active_support_version:
           rails_version: << parameters.rails_version >>
-      - run_rspec
+      - run_rspec_for_gem
       - rake_build
 
 jobs:
-  build:
+  deploy_api:
+    parameters:
+      <<: *ruby_version
+    executor:
+      name: executor_for_api
+      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: executor_for_gem
       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 >>
   upload-coverage:
-    executor: default
+    executor: executor_for_gem
     steps:
       - attach_workspace:
           at: ~/repo
@@ -157,22 +200,22 @@ jobs:
           parts: 19
       - code-climate/upload-coverage
   rubocop:
-    executor: default
+    executor: executor_for_gem
     steps:
       - setup
       - rubocop
   yardoc:
-    executor: default
+    executor: executor_for_gem
     steps:
       - setup
       - yardoc
   rubocop_challenge:
-    executor: default
+    executor: executor_for_gem
     steps:
       - checkout
       - rubocop_challenge
   release:
-    executor: default
+    executor: executor_for_gem
     steps:
       - setup
       - release
@@ -182,80 +225,80 @@ 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'
@@ -317,11 +360,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/.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

@@ -9,19 +9,22 @@ AllCops:
 
 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 +35,7 @@ Style/TrailingCommaInHashLiteral:
 
 RSpec/DescribeClass:
   Exclude:
+    - 'spec/integrations/api_clients/**/*'
     - 'spec/lib/my_api_client/rspec/matchers/**/*'
 
 RSpec/ExampleLength:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-02-21 23:30:47 +0000 using RuboCop version 0.80.0.
+# on 2020-02-29 23:30:46 +0000 using RuboCop version 0.80.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

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change log
 
-## v0.14.0.pre (Feb 23, 2020)
+## v0.14.0 (Mar 14, 2020)
+
+### Feature
+
+* [#211](https://github.com/ryz310/my_api_client/pull/211) Integration testing using the jets framework ([@ryz310](https://github.com/ryz310))
+* [#213](https://github.com/ryz310/my_api_client/pull/213) Add status API to integration testing ([@ryz310](https://github.com/ryz310))
+* [#214](https://github.com/ryz310/my_api_client/pull/214) Add error API to integration testing ([@ryz310](https://github.com/ryz310))
+* [#215](https://github.com/ryz310/my_api_client/pull/215) Update the REST API to enhance integration testing ([@ryz310](https://github.com/ryz310))
 
 ### Refactoring
 
@@ -60,6 +67,7 @@
 ### Rubocop Challenge
 
 * [#205](https://github.com/ryz310/my_api_client/pull/205) Re-generate .rubocop_todo.yml with RuboCop v0.80.0 ([@ryz310](https://github.com/ryz310))
+* [#210](https://github.com/ryz310/my_api_client/pull/210) Re-generate .rubocop_todo.yml with RuboCop v0.80.1 ([@ryz310](https://github.com/ryz310))
 
 ### Dependabot
 
@@ -68,6 +76,7 @@
 * [#194](https://github.com/ryz310/my_api_client/pull/194) Bump bugsnag from 6.12.2 to 6.13.0 ([@ryz310](https://github.com/ryz310))
 * [#197](https://github.com/ryz310/my_api_client/pull/197) Bump webmock from 3.8.0 to 3.8.1 ([@ryz310](https://github.com/ryz310))
 * [#199](https://github.com/ryz310/my_api_client/pull/199) Bump webmock from 3.8.1 to 3.8.2 ([@ryz310](https://github.com/ryz310))
+* [#216](https://github.com/ryz310/my_api_client/pull/216) Bump webmock from 3.8.2 to 3.8.3 ([@ryz310](https://github.com/ryz310))
 
 ### Renovate
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_api_client (0.14.0.pre)
+    my_api_client (0.14.0)
       activesupport (>= 4.2.0)
       faraday (>= 0.17.1)
       jsonpath
@@ -29,7 +29,7 @@ GEM
     docile (1.3.2)
     faraday (1.0.0)
       multipart-post (>= 1.2, < 3)
-    hashdiff (1.0.0)
+    hashdiff (1.0.1)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
@@ -42,7 +42,7 @@ GEM
     multi_json (1.14.1)
     multipart-post (2.1.1)
     parallel (1.19.1)
-    parser (2.7.0.2)
+    parser (2.7.0.4)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -60,7 +60,7 @@ GEM
       rspec-mocks (~> 3.9.0)
     rspec-core (3.9.1)
       rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
@@ -69,7 +69,7 @@ GEM
     rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.80.0)
+    rubocop (0.80.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -96,7 +96,7 @@ GEM
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.1)
-    webmock (3.8.2)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/example/api_clients/application_api_client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'my_errors'
+
+# An usage example of the `my_api_client`.
+class ApplicationApiClient < MyApiClient::Base
+  endpoint ENV['MY_API_ENDPOINT']
+
+  self.logger = ::Logger.new(nil)
+
+  http_open_timeout 2.seconds
+  http_read_timeout 3.seconds
+
+  retry_on MyApiClient::NetworkError, wait: 0.seconds, attempts: 3
+
+  error_handling status_code: 400..499, raise: MyApiClient::ClientError
+  error_handling status_code: 500..599 do |params, logger|
+    logger.warn 'Server error occurred.'
+    raise MyApiClient::ServerError, params
+  end
+end

data/example/api_clients/my_error_api_client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'application_api_client'
+
+# An usage example of the `my_api_client`.
+# See also: my_api/app/controllers/status_controller.rb
+class MyErrorApiClient < ApplicationApiClient
+  error_handling json: { '$.error.message': /You requested error code/ },
+                 raise: MyErrors::ErrorCodeOther
+
+  error_handling json: { '$.error.code': :zero? },
+                 raise: MyErrors::ErrorCode00
+
+  error_handling json: { '$.error.code': 10 },
+                 raise: MyErrors::ErrorCode10
+
+  error_handling json: { '$.error.code': 20..29 },
+                 raise: MyErrors::ErrorCode2x
+
+  error_handling json: { '$.error.code': 30 },
+                 status_code: 400,
+                 raise: MyErrors::ErrorCode30
+
+  # GET error/:code
+  def get_error(code:)
+    get "error/#{code}", headers: headers
+  end
+
+  private
+
+  def headers
+    { 'Content-Type': 'application/json;charset=UTF-8' }
+  end
+end