client-api-builder 0.2.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 201c8daf4abbc1489d26007b97c9b50145cffd98c699c2918d8f929138a1ef70
-  data.tar.gz: 627baef257a7d3a8037fa38eb5fa2e1c4f99f3ef0d191f083114f187e5690a30
+  metadata.gz: c22eb6c8362909af90380e2513875c7a82c4bd67028e5a601694c1d604fc599d
+  data.tar.gz: e6ad4f872b67a07563b88f3880bbd1f3375ed2d628a4c15cdedb0734fc9723a3
 SHA512:
-  metadata.gz: cc3b8a34104099c0ab3bdcbf66c611286fe07841eac76e7d6ddbfebe5e97d5b374c0f52e9c47b3d9f1e49761ee0fca02565862875f48c932a31bd7d8f07543aa
-  data.tar.gz: 00216ed9808389eb0f41c9a084527f7311c1e13ad525945a2a920d39aca55e48c395471dd3bcb0ead25db8f6bb08f73f99693cc853e232534d298eff3bfbba31
+  metadata.gz: 5bbe4fe12d3ea5ca240b445630360346a0a1628c340c9ce602efbacfb185ad23c7215233dcb84cb245ff5d3961b0695e8d177a15c39f87e9f6f6b4c0d030e60c
+  data.tar.gz: 44c82d195b80ad34205af3fa256523fa0a3a1e7249bd857ac7cc0cece431d9d75906f26a5714914075e0b9291d84ad5649704add740c099d960ad2e60ad3e2ee

data/README.md

@@ -1,2 +1,33 @@
 # client-api-builder
-Utility for creating methods to make api calls
+
+Utility for creating API clients through configuration
+
+Example:
+
+```
+class LoremIpsumClient
+  include ClientApiBuilder::Router
+
+  # by default it converts the body data to JSON
+  # to convert the body to query params (x=1&y=2) use the following
+  # if using active support change this to :to_query
+  body_builder :query_params
+
+  base_url 'https://www.lipsum.com'
+
+  header 'Content-Type', 'application/x-www-form-urlencoded'
+  header 'Accept', 'application/json'
+
+  # this creates a method called create_lorem_ipsum with 2 named arguments amont and what
+  route :create_lorem_ipsum, '/feed/json', body: {amount: :amount, what: :what, start: 'yes', generate: 'Generate Lorem Ipsum'}
+end
+```
+
+How to use:
+
+```
+client = LoremIpsumClient.new
+payload = client.create_lorem_ipsum(amount: 10, what: 'words')
+puts payload.dig('feed', 'lipsum')
+# outputs: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam at.
+```

data/client-api-builder.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name        = 'client-api-builder'
-  s.version     = '0.2.9'
+  s.version     = '0.4.0'
   s.licenses    = ['MIT']
-  s.summary     = 'Develop Client API libraries faster'
-  s.description = 'Utility for constructing API clients'
+  s.summary     = 'Utility for creating API clients through configuration'
+  s.description = 'Create API clients through configuration with complete transparency'
   s.authors     = ['Doug Youch']
   s.email       = 'dougyouch@gmail.com'
   s.homepage    = 'https://github.com/dougyouch/client-api-builder'

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/examples/lorem_ipsum_client.rb

@@ -0,0 +1,16 @@
+class LoremIpsumClient
+  include ClientApiBuilder::Router
+
+  # by default it converts the body data to JSON
+  # to convert the body to query params (x=1&y=2) use the following
+  # if using active support change this to :to_query
+  body_builder :query_params
+
+  base_url 'https://www.lipsum.com'
+
+  header 'Content-Type', 'application/x-www-form-urlencoded'
+  header 'Accept', 'application/json'
+
+  # this creates a method called create_lorem_ipsum with 2 named arguments amont and what
+  route :create_lorem_ipsum, '/feed/json', body: {amount: :amount, what: :what, start: 'yes', generate: 'Generate Lorem Ipsum'}
+end

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)
@@ -39,7 +41,7 @@ module ClientApiBuilder
     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] =
@@ -63,6 +65,7 @@ module ClientApiBuilder
 
     def build_query(query, options)
       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 = {}
 

data/lib/client_api_builder/router.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'inheritance-helper'
+require 'json'
 
 module ClientApiBuilder
   module Router
@@ -8,7 +9,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, :request_attempts)
     end
 
     module ClassMethods
@@ -26,7 +28,9 @@ 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
 
@@ -79,6 +83,14 @@ module ClientApiBuilder
         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
@@ -309,19 +321,21 @@ module ClientApiBuilder
         code += "\n"
 
         code += "def #{method_name}(" + method_args.join(', ') + ")\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"
+        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
@@ -439,5 +453,60 @@ module ClientApiBuilder
     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,10 @@ $LOAD_PATH << File.expand_path('../examples', __dir__)
 require 'client-api-builder'
 autoload :BasicAuthExampleClient, 'basic_auth_example_client'
 autoload :IMDBDatesetsClient, 'imdb_datasets_client'
+autoload :LoremIpsumClient, 'lorem_ipsum_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.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Doug Youch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inheritance-helper
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.5
-description: Utility for constructing API clients
+description: Create API clients through configuration with complete transparency
 email: dougyouch@gmail.com
 executables: []
 extensions: []
@@ -40,7 +40,10 @@ files:
 - client-api-builder.gemspec
 - examples/basic_auth_example_client.rb
 - examples/imdb_datasets_client.rb
+- examples/lorem_ipsum_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
@@ -69,5 +72,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Develop Client API libraries faster
+summary: Utility for creating API clients through configuration
 test_files: []