my_api_client 0.14.0 → 0.18.0

data/lib/my_api_client/errors/api_limit_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  # For API request limit error
+  class ApiLimitError < Error; end
+end

data/lib/my_api_client/errors/client_error.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  # For 4xx client error
+  class ClientError < Error
+    # 400 Bad Request
+    class BadRequest < ClientError; end
+
+    # 401 Unauthorized
+    class Unauthorized < ClientError; end
+
+    # 402 Payment Required
+    class PaymentRequired < ClientError; end
+
+    # 403 Forbidden
+    class Forbidden < ClientError; end
+
+    # 404 Not Found
+    class NotFound < ClientError; end
+
+    # 405 Method Not Allowed
+    class MethodNotAllowed < ClientError; end
+
+    # 406 Not Acceptable
+    class NotAcceptable < ClientError; end
+
+    # 407 Proxy Authentication Required
+    class ProxyAuthenticationRequired < ClientError; end
+
+    # 408 Request Timeout
+    class RequestTimeout < ClientError; end
+
+    # 409 Conflict
+    class Conflict < ClientError; end
+
+    # 410 Gone
+    class Gone < ClientError; end
+
+    # 411 Length Required
+    class LengthRequired < ClientError; end
+
+    # 412 Precondition Failed
+    class PreconditionFailed < ClientError; end
+
+    # 413 Payload Too Large
+    class RequestEntityTooLarge < ClientError; end
+
+    # 414 URI Too Long
+    class RequestUriTooLong < ClientError; end
+
+    # 415 Unsupported Media Type
+    class UnsupportedMediaType < ClientError; end
+
+    # 416 Range Not Satisfiable
+    class RequestedRangeNotSatisfiable < ClientError; end
+
+    # 417 Expectation Failed
+    class ExpectationFailed < ClientError; end
+
+    # 418 I'm a teapot
+    class IamTeapot < ClientError; end
+
+    # 421 Misdirected Request
+    class MisdirectedRequest < ClientError; end
+
+    # 422 Unprocessable Entity
+    class UnprocessableEntity < ClientError; end
+
+    # 423 Locked
+    class Locked < ClientError; end
+
+    # 424 Failed Dependency
+    class FailedDependency < ClientError; end
+
+    # 425 Too Early
+    class TooEarly < ClientError; end
+
+    # 426 Upgrade Required
+    class UpgradeRequired < ClientError; end
+
+    # 428 Precondition Required
+    class PreconditionRequired < ClientError; end
+
+    # 429 Too Many Requests
+    class TooManyRequests < ClientError; end
+
+    # 431 Request Header Fields Too Large
+    class RequestHeaderFieldsTooLarge < ClientError; end
+
+    # 451 Unavailable for Legal Reasons
+    class UnavailableForLegalReasons < ClientError; end
+  end
+end

data/lib/my_api_client/errors/network_error.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  NETWORK_ERRORS = [
+    Faraday::TimeoutError,
+    Faraday::ConnectionFailed,
+    Faraday::SSLError,
+    OpenSSL::SSL::SSLError,
+    Net::OpenTimeout,
+    Net::ReadTimeout,
+    SocketError,
+  ].freeze
+
+  # Raises it when occurred to some network error
+  class NetworkError < Error
+    attr_reader :original_error
+
+    # Initialize the error class
+    #
+    # @param params [MyApiClient::Params::Params]
+    #   The request and response parameters
+    # @param original_error [StandardError]
+    #   Some network error
+    def initialize(params, original_error)
+      @original_error = original_error
+      super params, original_error.message
+    end
+
+    # Returns contents as string for to be readable for human
+    #
+    # @return [String] Contents as string
+    def inspect
+      { error: original_error, params: params }.inspect
+    end
+
+    # Generate metadata for bugsnag.
+    #
+    # @return [Hash] Metadata for bugsnag
+    def metadata
+      super.merge(original_error: original_error.inspect)
+    end
+  end
+end

data/lib/my_api_client/errors/server_error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  # For 5xx server error
+  class ServerError < Error
+    # 500 Internal Server Error
+    class InternalServerError < ServerError; end
+
+    # 501 Not Implemented
+    class NotImplemented < ServerError; end
+
+    # 502 Bad Gateway
+    class BadGateway < ServerError; end
+
+    # 503 Service Unavailable
+    class ServiceUnavailable < ServerError; end
+
+    # 504 Gateway Timeout
+    class GatewayTimeout < ServerError; end
+
+    # 505 HTTP Version Not Supported
+    class HttpVersionNotSupported < ServerError; end
+
+    # 506 Variant Also Negotiates
+    class VariantAlsoNegotiates < ServerError; end
+
+    # 507 Insufficient Storage
+    class InsufficientStorage < ServerError; end
+
+    # 508 Loop Detected
+    class LoopDetected < ServerError; end
+
+    # 509 Bandwidth Limit Exceeded
+    class BandwidthLimitExceeded < ServerError; end
+
+    # 510 Not Extended
+    class NotExtended < ServerError; end
+
+    # 511 Network Authentication Required
+    class NetworkAuthenticationRequired < ServerError; end
+  end
+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

@@ -1,41 +1,38 @@
 # frozen_string_literal: true
 
 module MyApiClient
-  # Description of Request
+  # Provides HTTP request method.
   module Request
-    HTTP_METHODS = %i[get post patch delete].freeze
-
-    HTTP_METHODS.each do |http_method|
-      class_eval <<~METHOD, __FILE__, __LINE__ + 1
-        # Executes HTTP request with #{http_method.upcase} method
-        #
-        # @param pathname [String]
-        #   Pathname of the request target URL.
-        #   It's joined with the defined `endpoint`.
-        # @param headers [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 [Sawyer::Resouce]
-        #   Response body instance.
-        def #{http_method}(pathname, headers: nil, query: nil, body: nil)
-          query_strings = query.present? ? '?' + query&.to_query : ''
-          uri = URI.join(File.join(endpoint, pathname), query_strings)
-          response = call(:_request, :#{http_method}, uri, headers, body)
-          response.data
-        end
-      METHOD
-    end
-    alias put patch
+    include Basic
+    include Pagination
 
     private
 
-    # Executes HTTP request.
+    # Executes HTTP request with relative URI.
+    #
+    # @param http_method [Symbol]
+    #   HTTP method. e.g. `:get`, `:post`, `:put`, `:patch` and `:delete`.
+    # @param pathname [String]
+    #   Pathname of the request target URL.
+    #   It's joined with the defined by `endpoint`.
+    # @param headers [Hash, nil]
+    #   Request headers.
+    # @param query [Hash, nil]
+    #   Query string.
+    # @param body [Hash, nil]
+    #   Request body.
+    # @return [Sawyer::Response]
+    #   Response instance.
+    def _request_with_relative_uri(http_method, pathname, headers, query, body)
+      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
+
+    # Executes HTTP request with absolute URI.
     #
     # @param http_method [Symbol]
-    #   HTTP method. e.g. `:get`, `:post`, `:patch` and `:delete`.
+    #   HTTP method. e.g. `:get`, `:post`, `:put`, `:patch` and `:delete`.
     # @param uri [URI]
     #   Request target URI including query strings.
     # @param headers [Hash, nil]
@@ -44,13 +41,11 @@ module MyApiClient
     #   Request body.
     # @return [Sawyer::Response]
     #   Response instance.
-    def _request(http_method, uri, headers, body)
-      request_params = Params::Request.new(http_method, uri, headers, body)
-      request_logger = Logger.new(logger, http_method, uri)
+    def _request_with_absolute_uri(http_method, uri, headers, body)
       Executor.call(
         instance: self,
-        request_params: request_params,
-        request_logger: request_logger,
+        request_params: Params::Request.new(http_method, uri, headers, body),
+        request_logger: Logger.new(logger, http_method, uri),
         faraday_options: faraday_options
       )
     end

data/lib/my_api_client/request/basic.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module Request
+    # Provides basic HTTP request method.
+    module Basic
+      HTTP_METHODS = %i[get post put patch delete].freeze
+
+      HTTP_METHODS.each do |http_method|
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          # Executes HTTP request with #{http_method.upcase} method
+          #
+          # @param pathname [String]
+          #   Pathname of the request target URL.
+          #   It's joined with the defined by `endpoint`.
+          # @param headers [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 [Sawyer::Resource]
+          #   Response body instance.
+          def #{http_method}(pathname, headers: nil, query: nil, body: nil)
+            response = call(:_request_with_relative_uri, :#{http_method}, pathname, headers, query, body)
+            response.data
+          end
+        METHOD
+      end
+    end
+  end
+end

data/lib/my_api_client/request/executor.rb

@@ -32,7 +32,7 @@ module MyApiClient
       def call
         request_logger.info('Start')
         response = api_request
-        request_logger.info("Duration #{response.timing} sec")
+        request_logger.info("Duration #{response.timing.in_milliseconds} msec")
         verify(response)
       rescue MyApiClient::Error => e
         request_logger.warn("Failure (#{e.message})")

data/lib/my_api_client/request/pagination.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MyApiClient
+  module Request
+    # Provides enumerable HTTP request method.
+    module Pagination
+      # Executes HTTP request with GET method, for pagination API. Expects the
+      # pagination API to provide pagination links as part of the content of the response.
+      #
+      # @param pathname [String]
+      #   Pathname of the request target URL. It's joined with the defined by `endpoint`.
+      # @param paging [String]
+      #   Specify the pagination link path included in the response body as JsonPath expression
+      # @param headers [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)
+        Enumerator.new do |y|
+          response = call(:_request_with_relative_uri, :get, pathname, headers, query, nil)
+          loop do
+            y << response.data
+
+            next_uri = JsonPath.new(paging).first(response.body)
+            break if next_uri.blank?
+
+            response = call(:_request_with_absolute_uri, :get, next_uri, headers, nil)
+          end
+        end.lazy
+      end
+
+      alias pget pageable_get
+    end
+  end
+end

data/lib/my_api_client/version.rb

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

data/my_api/.ruby-version

@@ -1 +1 @@
-2.7.0
+2.5.7

data/my_api/Gemfile.lock

@@ -1,43 +1,43 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    aws-eventstream (1.0.3)
-    aws-mfa-secure (0.4.0)
+    aws-eventstream (1.1.0)
+    aws-mfa-secure (0.4.2)
       activesupport
       aws-sdk-core
       aws_config
@@ -45,52 +45,52 @@ GEM
       rainbow
       thor
       zeitwerk
-    aws-partitions (1.278.0)
-    aws-sdk-apigateway (1.36.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-partitions (1.358.0)
+    aws-sdk-apigateway (1.49.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudformation (1.30.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-cloudformation (1.41.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudwatchlogs (1.28.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-cloudwatchlogs (1.34.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.90.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-sdk-core (3.104.4)
+      aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.43.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-dynamodb (1.51.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-kinesis (1.20.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-kinesis (1.27.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-kms (1.29.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-kms (1.36.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-lambda (1.36.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-lambda (1.48.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.60.2)
-      aws-sdk-core (~> 3, >= 3.83.0)
+    aws-sdk-s3 (1.78.0)
+      aws-sdk-core (~> 3, >= 3.104.3)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sns (1.21.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-sns (1.29.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.23.1)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-sqs (1.30.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ssm (1.71.0)
-      aws-sdk-core (~> 3, >= 3.71.0)
+    aws-sdk-ssm (1.86.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.1.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
     aws_config (0.1.0)
     builder (3.2.4)
-    byebug (11.1.1)
-    capybara (3.31.0)
+    byebug (11.1.3)
+    capybara (3.34.0)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
@@ -103,11 +103,11 @@ GEM
       memoist
       rainbow
     cfnresponse (0.4.0)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     crass (1.0.6)
-    diff-lcs (1.3)
-    dotenv (2.7.5)
-    dynomite (1.2.5)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    dynomite (1.2.6)
       activesupport
       aws-sdk-dynamodb
       rainbow
@@ -116,9 +116,9 @@ GEM
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     hashie (4.1.0)
-    i18n (1.8.2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jets (2.3.13)
+    jets (2.3.17)
       actionmailer (~> 6.0.0)
       actionpack (~> 6.0.0)
       actionview (~> 6.0.0)
@@ -142,7 +142,6 @@ GEM
       hashie
       jets-gems
       jets-html-sanitizer
-      json
       kramdown
       memoist
       mimemagic
@@ -154,33 +153,33 @@ GEM
       text-table
       thor
       zeitwerk
-    jets-gems (0.2.0)
+    jets-gems (0.2.2)
       gems
     jets-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
     jmespath (1.4.0)
-    json (2.3.0)
-    kramdown (2.1.0)
+    kramdown (2.3.0)
+      rexml
     launchy (2.5.0)
       addressable (~> 2.7)
-    loofah (2.4.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     memoist (0.16.2)
-    method_source (0.9.2)
-    mimemagic (0.3.4)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nio4r (2.5.2)
-    nokogiri (1.10.8)
+    minitest (5.14.2)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    public_suffix (4.0.3)
-    puma (4.3.3)
+    public_suffix (4.0.6)
+    puma (5.1.0)
       nio4r (~> 2.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -188,29 +187,30 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    recursive-open-struct (1.1.0)
-    regexp_parser (1.7.0)
-    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.0)
+    recursive-open-struct (1.1.2)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    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)
     shotgun (0.9.2)
@@ -218,11 +218,11 @@ GEM
     text-table (1.2.4)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.2.2)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby