client-api-builder 0.2.8 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9853c5806a999fe126ad1b1ce5fdeb6ea6bdb985142e36a1cbdcbbbac6434ae
-  data.tar.gz: 9bfb059e5adcbf18c55882d1fcca7d04d310e04dce915cd3d46e88f770e36650
+  metadata.gz: 06500a9c514d0979b01f672ae5bdac70c5dfc7b23b3633f0662a71c4a057a01b
+  data.tar.gz: c3a00f73d888ad6a19b98a9a0c172685fd5299b61fa99b41931c427db8d73470
 SHA512:
-  metadata.gz: 1896be3318d8f5362c8b367d9836854d8567f9e7a394cac645c126a866afd2eb53507721228ae78f7bc94d5625b5fdfe2abe2273320de04c844e94cbe1b8df5e
-  data.tar.gz: 90aaaf4e7a73452397c699f095b383397c9a9d715b91b20431f0faf798b00e716d387eef9280f8687e118538c6e9c1e56f894979559b96b3671f04cf75f5ea6e
+  metadata.gz: 2263f684643292a86895f23906e2d566043d914704b92db919a1f23e1d47c1f5371ef7ea344257a63b234aac6ce8e5f293d4cf16b20e08248c7859fb8b692448
+  data.tar.gz: 0a2508597031c861ea8ba44ac00f9fcd3596b040bde9df1d3724afdb4c5a0d4b4b463d19e75b0360a2987ba1ad7375bff8c25572cb6fced4e194a560bb6f927e

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.1.0

data/Gemfile

@@ -10,6 +10,7 @@ group :development do
 end
 
 group :spec do
+  gem 'activesupport'
   gem 'rspec'
   gem 'simplecov'
   gem 'webmock'

data/Gemfile.lock

@@ -1,64 +1,76 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
     hashdiff (1.0.1)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
     inheritance-helper (0.2.5)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
     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.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.18.2)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    unicode-display_width (2.0.0)
-    webmock (3.13.0)
-      addressable (>= 2.3.6)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  x86_64-darwin-20
+  x86_64-darwin-21
 
 DEPENDENCIES
+  activesupport
   inheritance-helper
   rake
   rspec
@@ -67,4 +79,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.3
+   2.3.3

data/client-api-builder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'client-api-builder'
-  s.version     = '0.2.8'
+  s.version     = '0.3.1'
   s.licenses    = ['MIT']
   s.summary     = 'Develop Client API libraries faster'
   s.description = 'Utility for constructing API clients'

data/examples/basic_auth_example_client.rb

@@ -11,6 +11,8 @@ class BasicAuthExampleClient < Struct.new(
 
   base_url 'https://www.example.com'
 
+  configure_retries(2)
+
   header 'Authorization', :basic_authorization
   query_param('cache_buster') { (Time.now.to_f * 1000).to_i }
 

data/lib/client-api-builder.rb

@@ -11,6 +11,12 @@ module ClientApiBuilder
     end
   end
 
+  class << self
+    attr_accessor :logger
+  end
+
+  autoload :ActiveSupportNotifications, 'client_api_builder/active_support_notifications'
+  autoload :ActiveSupportLogSubscriber, 'client_api_builder/active_support_log_subscriber'
   autoload :NestedRouter, 'client_api_builder/nested_router'
   autoload :QueryParams, 'client_api_builder/query_params'
   autoload :Router, 'client_api_builder/router'

data/lib/client_api_builder/active_support_log_subscriber.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'active_support'
+
+# Purpose is to log all requests
+module ClientApiBuilder
+  class ActiveSupportLogSubscriber
+    attr_reader :logger
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def subscribe!
+      ActiveSupport::Notifications.subscribe('client_api_builder.request') do |event|
+        logger.info(generate_log_message(event))
+      end
+    end
+
+    def generate_log_message(event)
+      client = event.payload[:client]
+      method = client.request_options[:method].to_s.upcase
+      uri = client.request_options[:uri]
+      response = client.response
+      response_code = response ? response.code : 'UNKNOWN'
+
+      "#{method} #{uri.scheme}://#{uri.host}#{uri.path}[#{response_code}] took #{event.duration.to_i}ms"
+    end
+  end
+end

data/lib/client_api_builder/active_support_notifications.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'active_support'
+
+# Purpose is to change the instrument_request to use ActiveSupport::Notifications.instrument
+module ClientApiBuilder
+  module ActiveSupportNotifications
+    def instrument_request
+      start_time = Time.now
+      error = nil
+      result = nil
+      ActiveSupport::Notifications.instrument('client_api_builder.request', client: self) do
+        begin
+          result = yield
+        rescue Exception => e
+          error = e
+        end
+      end
+
+      raise(error) if error
+      result
+    ensure
+      @total_request_time = Time.now - start_time
+    end
+  end
+end

data/lib/client_api_builder/nested_router.rb

@@ -8,10 +8,12 @@ module ClientApiBuilder
   class NestedRouter
     include ::ClientApiBuilder::Router
 
-    attr_reader :root_router
+    attr_reader :root_router,
+                :nested_router_options
 
-    def initialize(root_router)
+    def initialize(root_router, nested_router_options)
       @root_router = root_router
+      @nested_router_options = nested_router_options
     end
 
     def self.get_instance_method(var)
@@ -34,12 +36,12 @@ module ClientApiBuilder
       root_router.stream_to_file(**options, &block)
     end
 
-    def base_url(options)
-      self.class.base_url || root_router.base_url(options)
+    def base_url
+      self.class.base_url || root_router.base_url
     end
 
     def build_headers(options)
-      headers = root_router.build_headers(options)
+      headers = nested_router_options[:ignore_headers] ? {} : root_router.build_headers(options)
 
       add_header_proc = proc do |name, value|
         headers[name] =
@@ -52,7 +54,7 @@ module ClientApiBuilder
           end
       end
 
-      self.class.headers.each(&add_header_proc)
+      self.class.default_headers.each(&add_header_proc)
 
       headers
     end
@@ -62,7 +64,8 @@ module ClientApiBuilder
     end
 
     def build_query(query, options)
-      return nil if query.nil? && root_router.class.query_params.empty? && self.class.query_params.empty?
+      return nil if query.nil? && root_router.class.default_query_params.empty? && self.class.default_query_params.empty?
+      return nil if nested_router_options[:ignore_query] && query.nil? && self.class.default_query_params.empty?
 
       query_params = {}
 
@@ -77,12 +80,12 @@ module ClientApiBuilder
           end
       end
 
-      root_router.class.query_params.each(&add_query_param_proc)
-      self.class.query_params.each(&add_query_param_proc)
+      root_router.class.default_query_params.each(&add_query_param_proc)
+      self.class.default_query_params.each(&add_query_param_proc)
       query && query.each(&add_query_param_proc)
       options[:query] && options[:query].each(&add_query_param_proc)
 
-      self.class.build_query(query_params)
+      self.class.build_query(self, query_params)
     end
 
     def build_body(body, options)
@@ -96,5 +99,9 @@ module ClientApiBuilder
     def handle_response(response, options, &block)
       root_router.handle_response(response, options, &block)
     end
+
+    def escape_path(path)
+      root_router.escape_path(path)
+    end
   end
 end

data/lib/client_api_builder/query_params.rb

@@ -2,59 +2,72 @@
 require 'cgi'
 
 module ClientApiBuilder
-  module QueryParams
-    module_function
+  class QueryParams
+    attr_reader :name_value_separator,
+                :param_separator
 
-    def to_query(data, namespace = nil, name_value_separator = '=', param_separator = '&')
+    attr_accessor :custom_escape_proc
+
+    def initialize(name_value_separator: '=', param_separator: '&', custom_escape_proc: nil)
+      @name_value_separator = name_value_separator
+      @param_separator = param_separator
+      @custom_escape_proc = custom_escape_proc
+    end
+
+    def to_query(data, namespace = nil)
       case data
       when Hash
-        to_query_from_hash(data, (namespace ? CGI.escape(namespace) : nil), name_value_separator).join(param_separator)
+        to_query_from_hash(data, (namespace ? escape(namespace) : nil)).join(param_separator)
       when Array
-        to_query_from_array(data, (namespace ? "#{CGI.escape(namespace)}[]" : '[]'), name_value_separator).join(param_separator)
+        to_query_from_array(data, (namespace ? "#{escape(namespace)}[]" : '[]')).join(param_separator)
       else
         if namespace
-          "#{CGI.escape(namespace)}#{name_value_separator}#{CGI.escape(data.to_s)}"
+          "#{escape(namespace)}#{name_value_separator}#{escape(data.to_s)}"
         else
-          CGI.escape(data.to_s)
+          escape(data.to_s)
         end
       end
     end
 
-    def to_query_from_hash(hsh, namespace, name_value_separator)
+    def to_query_from_hash(hsh, namespace)
       query_params = []
 
       hsh.each do |key, value|
         case value
         when Array
-          array_namespace = namespace ? "#{namespace}[#{CGI.escape(key.to_s)}][]" : "#{CGI.escape(key.to_s)}[]"
-          query_params += to_query_from_array(value, array_namespace, name_value_separator)
+          array_namespace = namespace ? "#{namespace}[#{escape(key.to_s)}][]" : "#{escape(key.to_s)}[]"
+          query_params += to_query_from_array(value, array_namespace)
         when Hash
-          hash_namespace = namespace ? "#{namespace}[#{CGI.escape(key.to_s)}]" : "#{CGI.escape(key.to_s)}"
-          query_params += to_query_from_hash(value, hash_namespace, name_value_separator)
+          hash_namespace = namespace ? "#{namespace}[#{escape(key.to_s)}]" : "#{escape(key.to_s)}"
+          query_params += to_query_from_hash(value, hash_namespace)
         else
-          query_name = namespace ? "#{namespace}[#{CGI.escape(key.to_s)}]" : "#{CGI.escape(key.to_s)}"
-          query_params << "#{query_name}#{name_value_separator}#{CGI.escape(value.to_s)}"
+          query_name = namespace ? "#{namespace}[#{escape(key.to_s)}]" : "#{escape(key.to_s)}"
+          query_params << "#{query_name}#{name_value_separator}#{escape(value.to_s)}"
         end
       end
 
       query_params
     end
 
-    def to_query_from_array(array, namespace, name_value_separator)
+    def to_query_from_array(array, namespace)
       query_params = []
 
       array.each do |value|
         case value
         when Hash
-          query_params += to_query_from_hash(value, namespace, name_value_separator)
+          query_params += to_query_from_hash(value, namespace)
         when Array
-          query_params += to_query_from_array(value, "#{namespace}[]", name_value_separator)
+          query_params += to_query_from_array(value, "#{namespace}[]")
         else
-          query_params << "#{namespace}#{name_value_separator}#{CGI.escape(value.to_s)}"
+          query_params << "#{namespace}#{name_value_separator}#{escape(value.to_s)}"
         end
       end
 
       query_params
     end
+
+    def escape(str)
+      custom_escape_proc ? custom_escape_proc.call(str) : CGI.escape(str)
+    end
   end
 end

data/lib/client_api_builder/router.rb

@@ -8,7 +8,8 @@ module ClientApiBuilder
       base.extend ClassMethods
       base.include ::ClientApiBuilder::Section
       base.include ::ClientApiBuilder::NetHTTP::Request
-      base.send(:attr_reader, :response, :request_options)
+      base.include(::ClientApiBuilder::ActiveSupportNotifications) if defined?(ActiveSupport)
+      base.send(:attr_reader, :response, :request_options, :total_request_time, :retry_attempts)
     end
 
     module ClassMethods
@@ -26,97 +27,120 @@ module ClientApiBuilder
           headers: {},
           query_builder: Hash.method_defined?(:to_query) ? :to_query : :query_params,
           query_params: {},
-          response_procs: {}
+          response_procs: {},
+          max_retries: 1,
+          sleep: 0.05
         }.freeze
       end
 
-
-      def add_response_procs(method_name, proc)
+      # tracks the proc used to handle responses
+      def add_response_proc(method_name, proc)
         response_procs = default_options[:response_procs].dup
         response_procs[method_name] = proc
         add_value_to_class_method(:default_options, response_procs: response_procs)
       end
 
-      def response_proc(method_name)
-        proc = default_options[:response_procs][method_name]
-        proc
+      # retrieves the proc used to handle the response
+      def get_response_proc(method_name)
+        default_options[:response_procs][method_name]
       end
 
+      # set/get base url
       def base_url(url = nil)
         return default_options[:base_url] unless url
 
         add_value_to_class_method(:default_options, base_url: url)
       end
 
-      def body_builder(builder = nil)
-        return default_options[:body_builder] unless builder
+      # set the builder to :to_json, :to_query, :query_params or specify a proc to handle building the request body payload
+      # or get the body builder
+      def body_builder(builder = nil, &block)
+        return default_options[:body_builder] if builder.nil? && block.nil?
 
-        add_value_to_class_method(:default_options, body_builder: builder)
+        add_value_to_class_method(:default_options, body_builder: builder || block)
       end
 
-      def query_builder(builder = nil)
-        return default_options[:query_builder] unless builder
+      # set the builder to :to_query, :query_params or specify a proc to handle building the request query params
+      # or get the query builder
+      def query_builder(builder = nil, &block)
+        return default_options[:query_builder] if builder.nil? && block.nil?
 
-        add_value_to_class_method(:default_options, query_builder: builder)
+        add_value_to_class_method(:default_options, query_builder: builder || block)
       end
 
+      # add a request header
       def header(name, value = nil, &block)
         headers = default_options[:headers].dup
         headers[name] = value || block
         add_value_to_class_method(:default_options, headers: headers)
       end
 
+      # set a connection_option, specific to Net::HTTP
       def connection_option(name, value)
         connection_options = default_options[:connection_options].dup
         connection_options[name] = value
         add_value_to_class_method(:default_options, connection_options: connection_options)
       end
 
+      def configure_retries(max_retries, sleep_time_between_retries_in_seconds = 0.05)
+        add_value_to_class_method(
+          :default_options,
+          max_retries: max_retries,
+          sleep: sleep_time_between_retries_in_seconds
+        )
+      end
+
+      # add a query param to all requests
       def query_param(name, value = nil, &block)
         query_params = default_options[:query_params].dup
         query_params[name] = value || block
         add_value_to_class_method(:default_options, query_params: query_params)
       end
 
-      def headers
+      # get default headers
+      def default_headers
         default_options[:headers]
       end
 
-      def connection_options
+      # get configured connection_options
+      def default_connection_options
         default_options[:connection_options]
       end
 
-      def query_params
+      # get default query_params to add to all requests
+      def default_query_params
         default_options[:query_params]
       end
 
-      def build_body(router, body, options)
-        builder = options[:body_builder] || body_builder
-
-        case builder
+      def build_body(router, body)
+        case body_builder
         when :to_json
           body.to_json
         when :to_query
           body.to_query
         when :query_params
-          ClientApiBuilder::QueryParams.to_query(body)
+          ClientApiBuilder::QueryParams.new.to_query(body)
+        when Symbol
+          router.send(body_builder, body)
         else
-          router.instance_exec(body, &builder)
+          router.instance_exec(body, &body_builder)
         end
       end
 
-      def build_query(query)
+      def build_query(router, query)
         case query_builder
         when :to_query
           query.to_query
         when :query_params
-          ClientApiBuilder::QueryParams.to_query(query)
+          ClientApiBuilder::QueryParams.new.to_query(query)
+        when Symbol
+          router.send(query_builder, query)
         else
-          query_builder.call(query)
+          router.instance_exec(query, &query_builder)
         end
       end
 
-      def http_method(method_name)
+      def auto_detect_http_method(method_name)
         case method_name.to_s
         when /^(?:post|create|add|insert)/i
           :post
@@ -172,6 +196,7 @@ module ClientApiBuilder
         arguments
       end
 
+      # returns a list of arguments to add to the route method
       def get_arguments(value)
         case value
         when Hash
@@ -184,7 +209,7 @@ module ClientApiBuilder
       end
 
       def get_instance_method(var)
-         "#\{#{var}\}"
+         "#\{escape_path(#{var})\}"
       end
 
       @@namespaces = []
@@ -192,6 +217,7 @@ module ClientApiBuilder
         @@namespaces
       end
 
+      # a namespace is a top level path to apply to all routes within the namespace block
       def namespace(name)
         namespaces << name
         yield
@@ -199,7 +225,7 @@ module ClientApiBuilder
       end
 
       def generate_route_code(method_name, path, options = {})
-        http_method = options[:method] || http_method(method_name)
+        http_method = options[:method] || auto_detect_http_method(method_name)
 
         path = namespaces.join + path
 
@@ -211,7 +237,7 @@ module ClientApiBuilder
         path_arguments = []
         path.gsub!(/:([a-z0-9_]+)/i) do |_|
           path_arguments << $1
-          "#\{#{$1}\}"
+          "#\{escape_path(#{$1})\}"
         end
 
         has_body_param = options[:body].nil? && requires_body?(http_method, options)
@@ -268,12 +294,10 @@ module ClientApiBuilder
         method_args += ["#{stream_param}:"] if stream_param
         method_args += ['**__options__', '&block']
 
-        code = "def #{method_name}(" + method_args.join(', ') + ")\n"
-        code += "  block ||= self.class.response_proc(#{method_name.inspect})\n"
+        code = "def #{method_name}_raw_response(" + method_args.join(', ') + ")\n"
         code += "  __path__ = \"#{path}\"\n"
         code += "  __query__ = #{query}\n"
         code += "  __body__ = #{body}\n"
-        code += "  __expected_response_codes__ = #{expected_response_codes.inspect}\n"
         code += "  __uri__ = build_uri(__path__, __query__, __options__)\n"
         code += "  __body__ = build_body(__body__, __options__)\n"
         code += "  __headers__ = build_headers(__options__)\n"
@@ -292,30 +316,38 @@ module ClientApiBuilder
         else
           code += "  @response = request(**@request_options)\n"
         end
+        code += "end\n"
+        code += "\n"
 
-        code += "  expected_response_code!(@response, __expected_response_codes__, __options__)\n"
+        code += "def #{method_name}(" + method_args.join(', ') + ")\n"
+        code += "  request_wrapper(__options__) do\n"
+        code += "    block ||= self.class.get_response_proc(#{method_name.inspect})\n"
+        code += "    __expected_response_codes__ = #{expected_response_codes.inspect}\n"
+        code += "    #{method_name}_raw_response(" + method_args.map { |a| a =~ /:$/ ? "#{a} #{a.sub(':', '')}" : a }.join(', ') + ")\n"
+        code += "    expected_response_code!(@response, __expected_response_codes__, __options__)\n"
 
         if options[:stream] || options[:return] == :response
-          code += "  @response\n"
+          code += "    @response\n"
         elsif options[:return] == :body
-          code += "  @response.body\n"
+          code += "    @response.body\n"
         else
-          code += "  handle_response(@response, __options__, &block)\n"
+          code += "    handle_response(@response, __options__, &block)\n"
         end
 
+        code += "  end\n"
         code += "end\n"
         code
       end
 
       def route(method_name, path, options = {}, &block)
-        add_response_procs(method_name, block) if block
+        add_response_proc(method_name, block) if block
 
         self.class_eval generate_route_code(method_name, path, options), __FILE__, __LINE__
       end
     end
 
-    def base_url(options)
-      options[:base_url] || self.class.base_url
+    def base_url
+      self.class.base_url
     end
 
     def build_headers(options)
@@ -332,7 +364,7 @@ module ClientApiBuilder
           end
       end
 
-      self.class.headers.each(&add_header_proc)
+      self.class.default_headers.each(&add_header_proc)
       options[:headers] && options[:headers].each(&add_header_proc)
 
       headers
@@ -340,14 +372,14 @@ module ClientApiBuilder
 
     def build_connection_options(options)
       if options[:connection_options]
-        self.class.connection_options.merge(options[:connection_options])
+        self.class.default_connection_options.merge(options[:connection_options])
       else
-        self.class.connection_options
+        self.class.default_connection_options
       end
     end
 
     def build_query(query, options)
-      return nil if query.nil? && self.class.query_params.empty?
+      return nil if query.nil? && self.class.default_query_params.empty?
 
       query_params = {}
 
@@ -362,11 +394,11 @@ module ClientApiBuilder
           end
       end
 
-      self.class.query_params.each(&add_query_param_proc)
+      self.class.default_query_params.each(&add_query_param_proc)
       query && query.each(&add_query_param_proc)
       options[:query] && options[:query].each(&add_query_param_proc)
 
-      self.class.build_query(query_params)
+      self.class.build_query(self, query_params)
     end
 
     def build_body(body, options)
@@ -375,11 +407,11 @@ module ClientApiBuilder
       return nil unless body
       return body if body.is_a?(String)
 
-      self.class.build_body(self, body, options)
+      self.class.build_body(self, body)
     end
 
     def build_uri(path, query, options)
-      uri = URI(base_url(options) + path)
+      uri = URI(base_url + path)
       uri.query = build_query(query, options)
       uri
     end
@@ -416,5 +448,64 @@ module ClientApiBuilder
     def root_router
       self
     end
+
+    def escape_path(path)
+      path
+    end
+
+    def instrument_request
+      start_time = Time.now
+      yield
+    ensure
+      @total_request_time = Time.now - start_time
+    end
+
+    def retry_request(options)
+      @request_attempts = 0
+      max_attempts = get_retry_request_max_retries(options)
+      begin
+        @request_attempts += 1
+        yield
+      rescue Exception => e
+        log_request_exception(e)
+        raise(e) if @request_attempts >= max_attempts || !retry_request?(e, options)
+        sleep_time = get_retry_request_sleep_time(e, options)
+        sleep(sleep_time) if sleep_time && sleep_time > 0
+        retry
+      end
+    end
+
+    def get_retry_request_sleep_time(e, options)
+      options[:sleep] || self.class.default_options[:sleep] || 0.05
+    end
+
+    def get_retry_request_max_retries(options)
+      options[:retries] || self.class.default_options[:max_retries] || 1
+    end
+
+    def request_wrapper(options)
+      retry_request(options) do
+        instrument_request do
+          yield
+        end
+      end
+    end
+
+    def retry_request?(exception, options)
+      true
+    end
+
+    def log_request_exception(exception)
+      ::ClientApiBuilder.logger && ::ClientApiBuilder.logger.error(exception)
+    end
+
+    def request_log_message
+      method = request_options[:method].to_s.upcase
+      uri = request_options[:uri]
+      response_code = response ? response.code : 'UNKNOWN'
+
+      duration = (total_request_time * 1000).to_i
+      "#{method} #{uri.scheme}://#{uri.host}#{uri.path}[#{response_code}] took #{duration}ms"
+    end
   end
 end

data/lib/client_api_builder/section.rb

@@ -8,7 +8,7 @@ module ClientApiBuilder
     end
 
     module ClassMethods
-      def section(name, &block)
+      def section(name, nested_router_options={}, &block)
         kls = InheritanceHelper::ClassBuilder::Utils.create_class(
           self,
           name,
@@ -24,7 +24,7 @@ def self.#{name}_router
 end
 
 def #{name}
-  @#{name} ||= self.class.#{name}_router.new(self.root_router)
+  @#{name} ||= self.class.#{name}_router.new(self.root_router, #{nested_router_options.inspect})
 end
 CODE
         self.class_eval code, __FILE__, __LINE__

data/script/console

@@ -6,5 +6,9 @@ $LOAD_PATH << File.expand_path('../examples', __dir__)
 require 'client-api-builder'
 autoload :BasicAuthExampleClient, 'basic_auth_example_client'
 autoload :IMDBDatesetsClient, 'imdb_datasets_client'
+require 'logger'
+LOG = Logger.new(STDOUT)
+ClientApiBuilder.logger = LOG
+ClientApiBuilder::ActiveSupportLogSubscriber.new(LOG).subscribe!
 require 'irb'
 IRB.start(__FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: client-api-builder
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.1
 platform: ruby
 authors:
 - Doug Youch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inheritance-helper
@@ -41,6 +41,8 @@ files:
 - examples/basic_auth_example_client.rb
 - examples/imdb_datasets_client.rb
 - lib/client-api-builder.rb
+- lib/client_api_builder/active_support_log_subscriber.rb
+- lib/client_api_builder/active_support_notifications.rb
 - lib/client_api_builder/nested_router.rb
 - lib/client_api_builder/net_http_request.rb
 - lib/client_api_builder/query_params.rb
@@ -66,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Develop Client API libraries faster