my_api_client 1.1.0 → 1.3.0

data/lib/my_api_client/params/request.rb

@@ -10,20 +10,20 @@ module MyApiClient
       #
       # @param method [Symbol] describe_method_here
       # @param uri [URI] describe_uri_here
-      # @param headers [Hash, nil] describe_headers_here
-      # @param body [Hash, nil] describe_body_here
+      # @param headers [Hash, Proc<Hash>, nil] describe_headers_here
+      # @param body [Hash, Proc<Hash>, nil] describe_body_here
       def initialize(method, uri, headers, body)
         @method = method
         @uri = uri
-        @headers = headers
-        @body = body
+        @headers = headers.is_a?(Proc) ? headers.call : headers
+        @body = body.is_a?(Proc) ? body.call : body
       end
 
       # Description of #to_sawyer_args
       #
       # @return [Array<Object>] Arguments for Sawyer::Agent#call
       def to_sawyer_args
-        [method, uri.to_s, body, { headers: headers }]
+        [method, uri.to_s, body, { headers: }]
       end
 
       # Generate metadata for bugsnag.
@@ -33,8 +33,8 @@ module MyApiClient
       def metadata
         {
           line: "#{method.upcase} #{uri}",
-          headers: headers,
-          body: body,
+          headers:,
+          body:,
         }.compact
       end
       alias to_bugsnag metadata
@@ -43,7 +43,7 @@ module MyApiClient
       #
       # @return [String] Contents as string
       def inspect
-        { method: method, uri: uri.to_s, headers: headers, body: body }.inspect
+        { method:, uri: uri.to_s, headers:, body: }.inspect
       end
     end
   end

data/lib/my_api_client/request/basic.rb

@@ -13,11 +13,11 @@ module MyApiClient
           # @param pathname [String]
           #   Pathname of the request target URL.
           #   It's joined with the defined by `endpoint`.
-          # @param headers [Hash, nil]
+          # @param headers [Hash, Proc<Hash>, nil]
           #   Request headers.
           # @param query [Hash, nil]
           #   Query string.
-          # @param body [Hash, nil]
+          # @param body [Hash, Proc<Hash>, nil]
           #   Request body. You should not specify it when use GET method.
           # @return [Sawyer::Resource]
           #   Response body instance if the block is not given.

data/lib/my_api_client/request/executor.rb

@@ -22,7 +22,7 @@ module MyApiClient
         @request_params = request_params
         @request_logger = request_logger
         faraday = Faraday.new(nil, faraday_options)
-        @agent = Sawyer::Agent.new('', faraday: faraday)
+        @agent = Sawyer::Agent.new('', faraday:)
       end
 
       private

data/lib/my_api_client/request/pagination.rb

@@ -11,12 +11,10 @@ module MyApiClient
       #   Pathname of the request target URL. It's joined with the defined by `endpoint`.
       # @param paging [String, Proc]
       #   Specify the pagination link path included in the response body as JsonPath expression
-      # @param headers [Hash, nil]
+      # @param headers [Hash, Proc<Hash>, nil]
       #   Request headers.
       # @param query [Hash, nil]
       #   Query string.
-      # @param body [Hash, nil]
-      #   Request body. You should not specify it when use GET method.
       # @return [Enumerator::Lazy]
       #   Yields the pagination API response.
       def pageable_get(pathname, paging:, headers: nil, query: nil)

data/lib/my_api_client/request.rb

@@ -15,11 +15,11 @@ module MyApiClient
     # @param pathname [String]
     #   Pathname of the request target URL.
     #   It's joined with the defined by `endpoint`.
-    # @param headers [Hash, nil]
+    # @param headers [Hash, Proc<Hash>, nil]
     #   Request headers.
     # @param query [Hash, nil]
     #   Query string.
-    # @param body [Hash, nil]
+    # @param body [Hash, Proc<Hash>, nil]
     #   Request body.
     # @return [Sawyer::Response]
     #   Response instance.
@@ -35,9 +35,9 @@ module MyApiClient
     #   HTTP method. e.g. `:get`, `:post`, `:put`, `:patch` and `:delete`.
     # @param uri [URI]
     #   Request target URI including query strings.
-    # @param headers [Hash, nil]
+    # @param headers [Hash, Proc<Hash>, nil]
     #   Request headers.
-    # @param body [Hash, nil]
+    # @param body [Hash, Proc<Hash>, nil]
     #   Request body.
     # @return [Sawyer::Response]
     #   Response instance.
@@ -46,7 +46,7 @@ module MyApiClient
         instance: self,
         request_params: Params::Request.new(http_method, uri, headers, body),
         request_logger: Logger.new(logger, http_method, uri),
-        faraday_options: faraday_options
+        faraday_options:
       )
     end
 

data/lib/my_api_client/rspec/matcher_helper.rb

@@ -13,9 +13,9 @@ module MyApiClient
         Sawyer::Response,
         timing: 0.0,
         data: instance_double(Sawyer::Resource),
-        status: status,
-        headers: headers,
-        body: body
+        status:,
+        headers:,
+        body:
       )
     end
 

data/lib/my_api_client/rspec/matchers/request_to.rb

@@ -21,7 +21,7 @@ RSpec::Matchers.define :request_to do |expected_method, expected_url|
       @actual =
         {
           request_line: request_line(method, @actual_schema_and_hostname + pathname),
-          body: body,
+          body:,
           headers: options[:headers],
         }.compact
     end.and_return(dummy_response)

data/lib/my_api_client/version.rb

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

data/my_api/Gemfile

@@ -7,7 +7,7 @@ gem 'jets', '~> 4.0.10'
 gem 'dynomite'
 
 # See: https://github.com/boltops-tools/jets/issues/523
-gem 'nokogiri', '~> 1.16.0'
+gem 'nokogiri', '~> 1.17.2'
 
 # development and test groups are not bundled as part of the deployment
 group :development, :test do

data/my_api/Gemfile.lock

@@ -1,43 +1,43 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.1.7.6)
-      actionpack (= 6.1.7.6)
-      actionview (= 6.1.7.6)
-      activejob (= 6.1.7.6)
-      activesupport (= 6.1.7.6)
+    actionmailer (6.1.7.9)
+      actionpack (= 6.1.7.9)
+      actionview (= 6.1.7.9)
+      activejob (= 6.1.7.9)
+      activesupport (= 6.1.7.9)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.7.6)
-      actionview (= 6.1.7.6)
-      activesupport (= 6.1.7.6)
+    actionpack (6.1.7.9)
+      actionview (= 6.1.7.9)
+      activesupport (= 6.1.7.9)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.7.6)
-      activesupport (= 6.1.7.6)
+    actionview (6.1.7.9)
+      activesupport (= 6.1.7.9)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.7.6)
-      activesupport (= 6.1.7.6)
+    activejob (6.1.7.9)
+      activesupport (= 6.1.7.9)
       globalid (>= 0.3.6)
-    activemodel (6.1.7.6)
-      activesupport (= 6.1.7.6)
-    activerecord (6.1.7.6)
-      activemodel (= 6.1.7.6)
-      activesupport (= 6.1.7.6)
-    activesupport (6.1.7.6)
+    activemodel (6.1.7.9)
+      activesupport (= 6.1.7.9)
+    activerecord (6.1.7.9)
+      activemodel (= 6.1.7.9)
+      activesupport (= 6.1.7.9)
+    activesupport (6.1.7.9)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    addressable (2.8.4)
-      public_suffix (>= 2.0.2, < 6.0)
-    aws-eventstream (1.3.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    aws-eventstream (1.4.0)
     aws-mfa-secure (0.4.4)
       activesupport
       aws-sdk-core
@@ -46,7 +46,7 @@ GEM
       rainbow
       thor
       zeitwerk
-    aws-partitions (1.863.0)
+    aws-partitions (1.1113.0)
     aws-sdk-apigateway (1.90.0)
       aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
@@ -56,14 +56,16 @@ GEM
     aws-sdk-cloudwatchlogs (1.75.0)
       aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.190.0)
+    aws-sdk-core (3.225.1)
       aws-eventstream (~> 1, >= 1.3.0)
-      aws-partitions (~> 1, >= 1.651.0)
-      aws-sigv4 (~> 1.8)
+      aws-partitions (~> 1, >= 1.992.0)
+      aws-sigv4 (~> 1.9)
+      base64
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-dynamodb (1.98.0)
-      aws-sdk-core (~> 3, >= 3.188.0)
-      aws-sigv4 (~> 1.1)
+      logger
+    aws-sdk-dynamodb (1.145.0)
+      aws-sdk-core (~> 3, >= 3.225.0)
+      aws-sigv4 (~> 1.5)
     aws-sdk-kinesis (1.54.0)
       aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
@@ -86,16 +88,17 @@ GEM
     aws-sdk-ssm (1.162.0)
       aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.8.0)
+    aws-sigv4 (1.12.0)
       aws-eventstream (~> 1, >= 1.0.2)
     aws_config (0.1.1)
-    builder (3.2.4)
+    base64 (0.3.0)
+    builder (3.3.0)
     byebug (11.1.3)
-    capybara (3.39.2)
+    capybara (3.40.0)
       addressable
       matrix
       mini_mime (>= 0.1.3)
-      nokogiri (~> 1.8)
+      nokogiri (~> 1.11)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
@@ -107,21 +110,27 @@ GEM
       memoist
       rainbow
     cfn_response (0.2.0)
-    concurrent-ruby (1.2.2)
+    childprocess (5.1.0)
+      logger (~> 1.5)
+    concurrent-ruby (1.3.5)
     crass (1.0.6)
-    date (3.3.4)
-    diff-lcs (1.5.0)
+    date (3.4.1)
+    diff-lcs (1.6.2)
     dotenv (2.8.1)
-    dynomite (1.2.7)
+    dynomite (2.0.3)
+      activemodel
       activesupport
       aws-sdk-dynamodb
+      memoist
       rainbow
-    erubi (1.12.0)
+      thor
+      zeitwerk
+    erubi (1.13.0)
     gems (1.2.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
     hashie (5.0.0)
-    i18n (1.14.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     jets (4.0.10)
       actionmailer (~> 6.1.0)
@@ -164,9 +173,12 @@ GEM
     jmespath (1.6.2)
     kramdown (2.4.0)
       rexml
-    launchy (2.5.2)
+    launchy (3.1.1)
       addressable (~> 2.8)
-    loofah (2.22.0)
+      childprocess (~> 5.0)
+      logger (~> 1.6)
+    logger (1.7.0)
+    loofah (2.24.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.8.1)
@@ -178,59 +190,59 @@ GEM
     memoist (0.16.2)
     method_source (1.0.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.5)
-    minitest (5.20.0)
-    net-imap (0.4.7)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
+    net-imap (0.4.20)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.7.0)
-    nokogiri (1.16.0)
+    nio4r (2.7.4)
+    nokogiri (1.17.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    public_suffix (5.0.1)
-    puma (6.4.2)
+    public_suffix (6.0.2)
+    puma (6.6.0)
       nio4r (~> 2.0)
-    racc (1.7.3)
-    rack (2.2.8)
+    racc (1.8.1)
+    rack (2.2.17)
     rack-test (2.1.0)
       rack (>= 1.3)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
+    rails-html-sanitizer (1.6.1)
       loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (6.1.7.6)
-      actionpack (= 6.1.7.6)
-      activesupport (= 6.1.7.6)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (6.1.7.9)
+      actionpack (= 6.1.7.9)
+      activesupport (= 6.1.7.9)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
     rainbow (3.1.1)
     rake (13.1.0)
     recursive-open-struct (1.1.3)
-    regexp_parser (2.8.1)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    regexp_parser (2.9.0)
+    rexml (3.3.9)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
     serverlessgems (0.4.0)
@@ -241,12 +253,12 @@ GEM
       rack (>= 1.0)
     text-table (1.2.4)
     thor (1.3.0)
-    timeout (0.4.1)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.6.12)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   ruby
@@ -257,7 +269,7 @@ DEPENDENCIES
   dynomite
   jets (~> 4.0.10)
   launchy
-  nokogiri (~> 1.16.0)
+  nokogiri (~> 1.17.2)
   puma
   rack
   rspec

data/my_api/app/controllers/error_controller.rb

@@ -13,7 +13,7 @@ class ErrorController < ApplicationController
     code = params[:code].to_i
     {
       error: {
-        code: code,
+        code:,
         message: "You requested error code: #{code}",
       },
     }

data/my_api/app/controllers/pagination_controller.rb

@@ -50,7 +50,7 @@ class PaginationController < ApplicationController
   #       but it should be `https://xxxxx.execute-api.ap-northeast-1.amazonaws.com/dev/pagination`.
   #       So this is workaround.
   def page_link(page)
-    query_strings = "?#{{ page: page }.to_query}"
+    query_strings = "?#{{ page: }.to_query}"
     uri = File.join(ENV.fetch('JETS_HOST', nil), ENV.fetch('JETS_STAGE', nil), pagination_path)
     uri.sub!('http://', 'https://')
     URI.join(uri, query_strings)

data/my_api/app/controllers/rest_controller.rb

@@ -10,7 +10,7 @@ class RestController < ApplicationController
 
   # GET rest/:id
   def show
-    render status: :ok, json: find_post(id: id)
+    render status: :ok, json: find_post(id:)
   end
 
   # POST rest
@@ -22,7 +22,7 @@ class RestController < ApplicationController
   # POST/PUT/PATCH rest/:id
   def update
     render status: :ok,
-           json: update_post(id: id, title: params[:title])
+           json: update_post(id:, title: params[:title])
   end
 
   # DELETE rest/:id
@@ -49,11 +49,11 @@ class RestController < ApplicationController
   end
 
   def create_post(title:)
-    { id: 4, title: title }
+    { id: 4, title: }
   end
 
   def update_post(id:, title:)
-    find_post(id: id).tap do |post|
+    find_post(id:).tap do |post|
       post[:title] = title
     end
   end

data/my_api/app/controllers/status_controller.rb

@@ -5,7 +5,7 @@ class StatusController < ApplicationController
   # GET status/:status
   def show
     status = params[:status].to_i
-    render status: status,
+    render status:,
            json: { message: "You requested status code: #{status}" }
   end
 end

data/my_api/spec/controllers/error_controller_spec.rb

@@ -8,14 +8,14 @@ describe ErrorController do
       let(:expected_response) do
         {
           error: {
-            code: code,
+            code:,
             message: 'You requested error code: 10',
           },
         }.to_json
       end
 
       it 'returns 400 Bad request with error code 10' do
-        get '/error/:code', code: code
+        get('/error/:code', code:)
         expect(response.status).to eq 400
         expect(response.body).to eq expected_response
       end
@@ -27,14 +27,14 @@ describe ErrorController do
       let(:expected_response) do
         {
           error: {
-            code: code,
+            code:,
             message: 'You requested error code: 20',
           },
         }.to_json
       end
 
       it 'returns 400 Bad request with error code 20' do
-        get '/error/:code', code: code
+        get('/error/:code', code:)
         expect(response.status).to eq 400
         expect(response.body).to eq expected_response
       end

data/my_api/spec/controllers/status_controller_spec.rb

@@ -10,7 +10,7 @@ describe StatusController do
       end
 
       it 'returns 200 OK' do
-        get '/status/:status', status: status
+        get('/status/:status', status:)
         expect(response.status).to eq status
         expect(response.body).to eq expected_response
       end
@@ -24,7 +24,7 @@ describe StatusController do
       end
 
       it 'returns 400 Bad request' do
-        get '/status/:status', status: status
+        get('/status/:status', status:)
         expect(response.status).to eq status
         expect(response.body).to eq expected_response
       end
@@ -38,7 +38,7 @@ describe StatusController do
       end
 
       it 'returns 500 Internal server error' do
-        get '/status/:status', status: status
+        get('/status/:status', status:)
         expect(response.status).to eq status
         expect(response.body).to eq expected_response
       end

data/my_api_client.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   spec.add_dependency 'activesupport', '>= 6.1.0'
   spec.add_dependency 'faraday', '>= 0.17.1'
@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-rspec_rails'
   spec.add_development_dependency 'simplecov', '0.22.0'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'yard'