my_api_client 0.17.0 → 0.21.0

data/lib/generators/rspec/templates/api_client_spec.rb.erb

@@ -44,7 +44,7 @@ RSpec.describe <%= "#{class_name}ApiClient" %>, <%= type_metatag(:api_client) %>
 
     it do
       expect { api_request }
-        .to request_to(:<%= http_method %>, 'https://example.com/<%= pathname %>')
+        .to request_to(:<%= http_method %>, '<%= options[:endpoint] %>/<%= pathname %>')
 <% if http_method == 'get' -%>
         .with(headers: headers, query: {})
 <% else -%>

data/lib/my_api_client/base.rb

@@ -8,15 +8,8 @@ module MyApiClient
     include MyApiClient::Exceptions
     include MyApiClient::Request
 
-    if ActiveSupport::VERSION::STRING >= '5.2.0'
-      class_attribute :logger, instance_writer: false, default: ::Logger.new($stdout)
-      class_attribute :error_handlers, instance_writer: false, default: []
-    else
-      class_attribute :logger
-      class_attribute :error_handlers
-      self.logger = ::Logger.new($stdout)
-      self.error_handlers = []
-    end
+    class_attribute :logger, instance_writer: false, default: ::Logger.new($stdout)
+    class_attribute :error_handlers, instance_writer: false, default: []
 
     include MyApiClient::DefaultErrorHandlers
 

data/lib/my_api_client/integrations/bugsnag.rb

@@ -11,7 +11,7 @@ module MyApiClient
 
       Bugsnag.leave_breadcrumb(
         "#{self.class.name} occurred",
-        metadata.each_with_object({}) { |(k, v), memo| memo[k] = v.inspect },
+        metadata.transform_values(&:inspect),
         Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
       )
     end

data/lib/my_api_client/params/params.rb

@@ -40,9 +40,7 @@ module MyApiClient
       # @return [Hash] Metadata for bugsnag
       def request_metadata
         if request.present?
-          request.metadata.each_with_object({}) do |(key, value), memo|
-            memo[:"request_#{key}"] = value
-          end
+          request.metadata.transform_keys { |key| :"request_#{key}" }
         else
           {}
         end

data/lib/my_api_client/request.rb

@@ -24,7 +24,7 @@ module MyApiClient
     # @return [Sawyer::Response]
     #   Response instance.
     def _request_with_relative_uri(http_method, pathname, headers, query, body)
-      query_strings = query.present? ? '?' + query&.to_query : ''
+      query_strings = query.present? ? "?#{query.to_query}" : ''
       uri = URI.join(File.join(endpoint, pathname), query_strings)
       _request_with_absolute_uri(http_method, uri, headers, body)
     end

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

@@ -30,17 +30,17 @@ RSpec::Matchers.define :be_handled_as_an_error do |expected_error_class|
     actual_error = handle_error(api_request)
     if actual_error.nil?
       "expected to be handled as #{expected_error_class.name}, " \
-      'but not to be handled'
+        'but not to be handled'
     else
       "expected to be handled as #{expected_error_class.name}, " \
-      "but it was handled as #{actual_error.class.name}"
+        "but it was handled as #{actual_error.class.name}"
     end
   end
 
   failure_message_when_negated do |api_request|
     actual_error = handle_error(api_request)
     'expected not to be handled as an error, ' \
-    "but it was handled as #{actual_error.class.name}"
+      "but it was handled as #{actual_error.class.name}"
   end
 
   attr_reader :sawyer

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

@@ -50,7 +50,7 @@ RSpec::Matchers.define :request_to do |expected_method, expected_url|
   end
 
   def request_line(method, url, query = nil)
-    url += '?' + query.to_query if query.present?
+    url += "?#{query.to_query}" if query.present?
     "#{method.upcase} #{url}"
   end
 

data/lib/my_api_client/rspec/stub.rb

@@ -18,13 +18,17 @@ module MyApiClient
     # @example
     #   stub_api_client_all(
     #     ExampleApiClient,
+    #     get_users: {                                     # Returns an arbitrary pageable response
+    #       pageable: [ { id: 1 }, { id: 2 }]              # for `#pageable_get`.
+    #     },
     #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
     #     post_users: { id: 1 },                           # You can ommit `response` keyword.
     #     patch_user: ->(params) { { id: params[:id] } },  # Returns calculated result as response.
     #     put_user: { raise: MyApiClient::ClientError }    # Raises an arbitrary error.
     #     delete_user: {
     #       raise: MyApiClient::ClientError,
-    #       response: { errors: [{ code: 10 }] },          # You can stub response with exception.
+    #       response: { errors: [{ code: 10 }] },          # You can stub response and statu code
+    #       status_code: 429,                              # with an arbitrary error.
     #     }
     #   )
     #   response = ExampleApiClient.new.get_user(id: 123)
@@ -46,13 +50,17 @@ module MyApiClient
     # @example
     #   api_client = stub_api_client(
     #     ExampleApiClient,
+    #     get_users: {                                     # Returns an arbitrary pageable response
+    #       pageable: [ { id: 1 }, { id: 2 }]              # for `#pageable_get`.
+    #     },
     #     get_user: { response: { id: 1 } },               # Returns an arbitrary response.
     #     post_users: { id: 1 },                           # You can ommit `response` keyword.
     #     patch_user: ->(params) { { id: params[:id] } },  # Returns calculated result as response.
     #     put_user: { raise: MyApiClient::ClientError }    # Raises an arbitrary error.
     #     delete_user: {
     #       raise: MyApiClient::ClientError,
-    #       response: { errors: [{ code: 10 }] },          # You can stub response with exception.
+    #       response: { errors: [{ code: 10 }] },          # You can stub response and status code
+    #       status_code: 403,                              # with exception.
     #     }
     #   )
     #   response = api_client.get_user(id: 123)
@@ -67,25 +75,40 @@ module MyApiClient
 
     private
 
-    # rubocop:disable Metrics/AbcSize
     def stubbing(instance, action, options)
+      allow(instance).to receive(action) do |*request|
+        generate_stubbed_response(options, *request)
+      end
+    end
+
+    def generate_stubbed_response(options, *request) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       case options
       when Proc
-        allow(instance).to receive(action) { |*request| stub_as_resource(options.call(*request)) }
+        stub_as_resource(options.call(*request))
       when Hash
-        if options[:raise].present?
-          exception = process_raise_option(options[:raise], options[:response])
-          allow(instance).to receive(action).and_raise(exception)
+        if options[:raise] # rubocop:disable Style/GuardClause
+          raise process_raise_option(options[:raise], options[:response], options[:status_code])
         elsif options[:response]
-          allow(instance).to receive(action).and_return(stub_as_resource(options[:response]))
+          stub_as_resource(options[:response])
+        elsif options[:pageable].is_a?(Enumerable)
+          stub_as_pageable_resource(options[:pageable].each, *request)
         else
-          allow(instance).to receive(action).and_return(stub_as_resource(options))
+          stub_as_resource(options)
         end
       else
-        allow(instance).to receive(action).and_return(stub_as_resource(options))
+        stub_as_resource(options)
       end
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def stub_as_pageable_resource(pager, *request)
+      Enumerator.new do |y|
+        loop do
+          y << generate_stubbed_response(pager.next, *request)
+        rescue StopIteration
+          break
+        end
+      end.lazy
+    end
 
     # Provides a shorthand for `raise` option.
     # `MyApiClient::Error` requires `MyApiClient::Params::Params` instance on
@@ -93,12 +116,14 @@ module MyApiClient
     # If given a error instance, it will return raw value without processing.
     #
     # @param exception [Clsas, MyApiClient::Error] Processing target.
+    # @param response [Hash] describe_response_here
+    # @param status_code [Integer] describe_status_code_here
     # @return [MyApiClient::Error] Processed exception.
     # @raise [RuntimeError] Unsupported error class was set.
-    def process_raise_option(exception, response = {})
+    def process_raise_option(exception, response, status_code)
       case exception
       when Class
-        params = MyApiClient::Params::Params.new(nil, stub_as_response(response))
+        params = MyApiClient::Params::Params.new(nil, stub_as_response(response, status_code))
         if exception == MyApiClient::NetworkError
           exception.new(params, Net::OpenTimeout.new)
         else
@@ -113,10 +138,10 @@ module MyApiClient
       end
     end
 
-    def stub_as_response(params)
+    def stub_as_response(params, status_code)
       instance_double(
         Sawyer::Response,
-        status: 400,
+        status: status_code.presence || 400,
         headers: {},
         data: stub_as_resource(params),
         timing: 0.123

data/lib/my_api_client/version.rb

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

data/my_api/.ruby-version

@@ -1 +1 @@
-2.5.7
+2.7.2

data/my_api/Gemfile

@@ -6,6 +6,9 @@ gem 'jets'
 
 gem 'dynomite'
 
+# See: https://github.com/boltops-tools/jets/issues/523
+gem 'nokogiri', '~> 1.12.2'
+
 # development and test groups are not bundled as part of the deployment
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console

data/my_api/Gemfile.lock

@@ -1,43 +1,44 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      actionview (= 6.0.3.3)
-      activejob (= 6.0.3.3)
+    actionmailer (6.1.4)
+      actionpack (= 6.1.4)
+      actionview (= 6.1.4)
+      activejob (= 6.1.4)
+      activesupport (= 6.1.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.3)
-      actionview (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      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.0.3.3)
-      activesupport (= 6.0.3.3)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.3)
-      activesupport (= 6.0.3.3)
+    activejob (6.1.4)
+      activesupport (= 6.1.4)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activerecord (6.0.3.3)
-      activemodel (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activesupport (6.0.3.3)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    aws-eventstream (1.1.0)
-    aws-mfa-secure (0.4.2)
+    aws-eventstream (1.1.1)
+    aws-mfa-secure (0.4.3)
       activesupport
       aws-sdk-core
       aws_config
@@ -45,85 +46,87 @@ GEM
       rainbow
       thor
       zeitwerk
-    aws-partitions (1.358.0)
-    aws-sdk-apigateway (1.49.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-partitions (1.479.0)
+    aws-sdk-apigateway (1.62.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudformation (1.41.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-cloudformation (1.53.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudwatchlogs (1.34.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-cloudwatchlogs (1.41.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.104.4)
+    aws-sdk-core (3.117.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.51.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-dynamodb (1.60.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-kinesis (1.27.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-kinesis (1.32.1)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-kms (1.36.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-kms (1.44.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-lambda (1.48.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-lambda (1.64.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.78.0)
-      aws-sdk-core (~> 3, >= 3.104.3)
+    aws-sdk-s3 (1.96.2)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sns (1.29.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-sns (1.42.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.30.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-sqs (1.40.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ssm (1.86.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-ssm (1.112.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.2.2)
+    aws-sigv4 (1.2.4)
       aws-eventstream (~> 1, >= 1.0.2)
     aws_config (0.1.0)
     builder (3.2.4)
     byebug (11.1.3)
-    capybara (3.33.0)
+    capybara (3.35.3)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
+    cfn-status (0.4.3)
+      aws-sdk-cloudformation
     cfn_camelizer (0.4.9)
       activesupport
       memoist
       rainbow
-    cfnresponse (0.4.0)
-    concurrent-ruby (1.1.7)
+    cfn_response (0.2.0)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     dotenv (2.7.6)
     dynomite (1.2.6)
       activesupport
       aws-sdk-dynamodb
       rainbow
-    erubi (1.9.0)
+    erubi (1.10.0)
     gems (1.2.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     hashie (4.1.0)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jets (2.3.17)
-      actionmailer (~> 6.0.0)
-      actionpack (~> 6.0.0)
-      actionview (~> 6.0.0)
-      activerecord (~> 6.0.0)
-      activesupport (~> 6.0.0)
+    jets (3.0.11)
+      actionmailer (~> 6.1.0)
+      actionpack (~> 6.1.0)
+      actionview (~> 6.1.0)
+      activerecord (~> 6.1.0)
+      activesupport (~> 6.1.0)
       aws-mfa-secure (~> 0.4.0)
       aws-sdk-apigateway
       aws-sdk-cloudformation
@@ -135,50 +138,50 @@ GEM
       aws-sdk-sns
       aws-sdk-sqs
       aws-sdk-ssm
+      cfn-status
       cfn_camelizer (~> 0.4.6)
-      cfnresponse
+      cfn_response
       dotenv
       gems
       hashie
-      jets-gems
       jets-html-sanitizer
       kramdown
       memoist
-      mimemagic
+      mini_mime
       rack
-      railties (~> 6.0.0)
+      railties (~> 6.1.0)
       rainbow
       recursive-open-struct
+      serverlessgems (~> 0.1.4)
       shotgun
       text-table
       thor
       zeitwerk
-    jets-gems (0.2.2)
-      gems
     jets-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
     jmespath (1.4.0)
-    kramdown (2.3.0)
+    kramdown (2.3.1)
       rexml
     launchy (2.5.0)
       addressable (~> 2.7)
-    loofah (2.7.0)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     memoist (0.16.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    public_suffix (4.0.5)
-    puma (5.0.0)
+    mini_mime (1.1.0)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.12.2)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    public_suffix (4.0.6)
+    puma (5.4.0)
       nio4r (~> 2.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -187,42 +190,45 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    recursive-open-struct (1.1.2)
-    regexp_parser (1.7.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)
+    rake (13.0.6)
+    recursive-open-struct (1.1.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       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.0)
       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.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
+    serverlessgems (0.1.4)
+      gems
+      memoist
+      zeitwerk
     shotgun (0.9.2)
       rack (>= 1.0)
     text-table (1.2.4)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -233,6 +239,7 @@ DEPENDENCIES
   dynomite
   jets
   launchy
+  nokogiri (~> 1.12.2)
   puma
   rack
   rspec