gemfather 2.2.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d710977302c99d922728945fcbdd442c7f1335820c9856d07852e3589a3fdd1
-  data.tar.gz: b489b32109592bfe1c0d20a1942cd3dd2e03ab7aa1d3537a9288089f83d8fb3e
+  metadata.gz: b76d8257b078b1c9a56c0c3fb4dff29509b2fb2da8862e682e2c2902c775b858
+  data.tar.gz: 0b4d42add75aa92abf940832cae146804053d183fd8d5aa7e4fccd18b615e64b
 SHA512:
-  metadata.gz: 65063d4799d4281f20878aed55f60ed2273530138400e4ce4d3bab6e19ae4a79c9ca7451f0993838277b6a46b0e26b1fe534388cce620c135dce5acc829e23cc
-  data.tar.gz: 1cb8c02edb4dd6b74ad69c12275eeb8a4503c0d62b0096af26b5a08573e920c589e79d033560706b0724b90b14324a68657876352fdee0ee54e8d21cae479ff3
+  metadata.gz: fcb5fca115a0d15433419d9eefe531c0e30b16a9253831b469ea43d24fc0a84a795b055536ff5bf18004ea9294915f03d35fa37865633dc15132ab9a048efcf9
+  data.tar.gz: 9696bfe5be260edb7b29093aef9db3181d4c1ecdaf0a4cb43e6ba6f9d4e4619d44aa171bacfdd7808845ef7e0c5a9249968cd53c36465a5850bea96e69b9073a

data/README.md

@@ -143,3 +143,7 @@ client.find_offers(company_id: 1).page(2).total
 # Получение общего количество элементов на всех страницах в сумме (сначала загрузит все страницы)
 client.find_offers(company_id: 1).page(2).total!
 ```
+
+## Улучшения.
+
+В файле [TODO.md](/TODO.md) вы можете найти известные проблемы, которые можно исправить и идеи для улучшений.

data/gem_template/README.md.tt

@@ -26,13 +26,14 @@ gem '<%= app_name %>'
 
 ```ruby
 <%= app_name_class %>::Client.configure do |config|
-  config.api_endpoint       = 'https://<%= app_name %>.dev/'
-  config.api_user           = 'user'
-  config.api_password       = 'password'
-  config.open_timeout       = 5
-  config.read_timeout       = 5
-  config.user_agent         = 'info for debugging' # default is `Ruby <%= app_name_class %> API Client`
-  config.logger             = Logger.new(STDERR) # по дефолту `Rails.logger` в development окружении, в других - nil
+  config.api_endpoint           = 'https://<%= app_name %>.dev/'
+  config.api_user               = 'user'
+  config.api_password           = 'password'
+  config.open_timeout           = 5
+  config.read_timeout           = 5
+  config.user_agent             = 'info for debugging' # default is `Ruby <%= app_name_class %> API Client`
+  config.logger                 = Logger.new(STDERR) # по дефолту `Rails.logger` в development окружении, в других - nil
+  config.enable_instrumentation = true # под дефолту выключен, включает отправку метрик гему domclick_bigbrother через ActiveSupport::Notifications
 end
 ```
 

data/lib/api_generator/client/config.rb

@@ -9,14 +9,15 @@ module ApiGenerator
       MAX_RETRIES = 3
       RETRY_INTERVAL = 1
       RETRY_BACKOFF_FACTOR = 1
+      CONNECTION_ERROR = ApiGenerator::Middleware::HttpErrors::ConnectionError
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def self.extended(klass)
         klass.extend Dry::Configurable
 
         klass.class_eval do
           setting :api_endpoint, reader: true
-          setting :user_agent, USER_AGENT, reader: true
+          setting :user_agent, default: USER_AGENT, reader: true
 
           setting :api_header, reader: true
           setting :api_token, reader: true
@@ -27,21 +28,18 @@ module ApiGenerator
           setting :ssl_verify, reader: true
           setting :ca_file, reader: true
 
-          setting :open_timeout, OPEN_TIMEOUT, reader: true
-          setting :read_timeout, READ_TIMEOUT, reader: true
-          setting :max_retries, MAX_RETRIES, reader: true
-          setting :retry_interval, RETRY_INTERVAL, reader: true
-          setting :retry_backoff_factor, RETRY_BACKOFF_FACTOR, reader: true
+          setting :open_timeout, default: OPEN_TIMEOUT, reader: true
+          setting :read_timeout, default: READ_TIMEOUT, reader: true
+          setting :max_retries, default: MAX_RETRIES, reader: true
+          setting :retry_interval, default: RETRY_INTERVAL, reader: true
+          setting :retry_backoff_factor, default: RETRY_BACKOFF_FACTOR, reader: true
           setting :logger, reader: true
+          setting :enable_instrumentation, reader: true
 
-          setting :retriable_errors,
-                  [
-                    ApiGenerator::Middleware::HttpErrors::ConnectionError,
-                  ],
-                  reader: true
+          setting :retriable_errors, default: [CONNECTION_ERROR], reader: true
         end
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
       def check_config
         raise ConfigurationError, 'API endpoint is not configured.' if config.api_endpoint.nil?

data/lib/api_generator/client/connection.rb

@@ -52,8 +52,10 @@ module ApiGenerator
 
       private
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def connection
+        set_instrumentation_context
+
         @connection ||= Faraday.new(url: self.class.api_endpoint) do |connection|
           setup_auth!(connection)
 
@@ -65,6 +67,7 @@ module ApiGenerator
           setup_error_handling!(connection)
           setup_error_code_middleware!(connection)
           setup_ssl(connection)
+          setup_instrumentation!(connection)
 
           customize_connection!(connection)
 
@@ -74,7 +77,7 @@ module ApiGenerator
           connection.adapter(Faraday.default_adapter)
         end
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
       # rubocop:disable Metrics/AbcSize
       def setup_auth!(connection)
@@ -109,6 +112,24 @@ module ApiGenerator
         connection.response(:logger, self.class.logger) if self.class.logger
       end
 
+      def setup_instrumentation!(connection)
+        return unless self.class.enable_instrumentation
+
+        connection.use ApiGenerator::Middleware::Instrumentation,
+                       name: 'gemfather_api_client.requests'
+      end
+
+      def set_instrumentation_context
+        return unless self.class.enable_instrumentation
+
+        action = caller_locations(4, 1)&.first&.label || 'unparsed_method'
+
+        Thread.current[:gemfather_api_client] = {
+          name: self.class.to_s,
+          action: action,
+        }
+      end
+
       def setup_ssl(connection)
         connection.ssl.verify = self.class.ssl_verify
         connection.ssl.ca_file = self.class.ca_file

data/lib/api_generator/middleware/error_handler_middleware.rb

@@ -1,6 +1,12 @@
 module ApiGenerator
   module Middleware
     class ErrorHandlerMiddleware < Faraday::Middleware
+      FARADAY_CONNECTION_ERRORS = [
+        Faraday::TimeoutError,
+        Faraday::ConnectionFailed,
+        Faraday::SSLError,
+      ].freeze
+
       def self.inherited(subclass)
         class << subclass
           attr_accessor :error_namespace
@@ -10,12 +16,6 @@ module ApiGenerator
         super
       end
 
-      FARADAY_CONNECTION_ERRORS = [
-        Faraday::TimeoutError,
-        Faraday::ConnectionFailed,
-        Faraday::SSLError,
-      ].freeze
-
       def call(env)
         @app.call(env)
       rescue *FARADAY_CONNECTION_ERRORS => e

data/lib/api_generator/middleware/instrumentation.rb

@@ -0,0 +1,10 @@
+module ApiGenerator
+  module Middleware
+    class Instrumentation < Faraday::Request::Instrumentation
+      def call(env)
+        env[:gemfather_api_client] = Thread.current[:gemfather_api_client]
+        super(env)
+      end
+    end
+  end
+end

data/lib/api_generator/services/base_create.rb

@@ -33,7 +33,7 @@ module ApiGenerator
       end
 
       def source_root
-        gemfather_lib_path = $LOAD_PATH.grep(/gemfather/).first
+        gemfather_lib_path = $LOAD_PATH.grep(%r{gems/gemfather}).first
 
         return File.expand_path('../', gemfather_lib_path) if gemfather_lib_path
 

data/lib/api_generator/services/gemfather.rb

@@ -10,6 +10,10 @@ module ApiGenerator
       attr_accessor :app_name, :app_name_class, :app_short_name,
                     :app_short_name_class, :author, :email, :version
 
+      def self.source_root
+        File.expand_path('./../../../', __dir__)
+      end
+
       # rubocop:disable Metrics/MethodLength
       desc 'generates API gem', 'generates basic API gem with the provided name'
       def generate_client(app_name)
@@ -32,12 +36,13 @@ module ApiGenerator
 
       private
 
-      private_class_method :source_root
-
+      # rubocop:disable Layout/LineLength
       def check_app_name(app_name)
         raise(Thor::Error, 'APP_NAME is not provided') unless app_name
         raise(Thor::Error, "Folder #{app_name} name already exists") if Dir.exist?("./#{app_name}")
+        raise(Thor::Error, 'Api name can start only with letter or _') if app_name.chr.match(/[a-zA-Z_]/).nil?
       end
+      # rubocop:enable Layout/LineLength
 
       def setup_template_variables(app_name)
         self.app_name = app_name
@@ -72,10 +77,6 @@ module ApiGenerator
           chmod(file, EXEC_MODE)
         end
       end
-
-      def self.source_root
-        File.expand_path('./../../../', __dir__)
-      end
     end
   end
 end

data/lib/api_generator/version.rb

@@ -1,3 +1,3 @@
 module ApiGenerator
-  VERSION = '2.2.1'.freeze
+  VERSION = '2.3.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemfather
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Domclick Ruby Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,6 +170,7 @@ files:
 - lib/api_generator/middleware/error_handler_middleware.rb
 - lib/api_generator/middleware/handle_unsuccessful_request_middleware.rb
 - lib/api_generator/middleware/http_errors.rb
+- lib/api_generator/middleware/instrumentation.rb
 - lib/api_generator/middleware/raise_error_base.rb
 - lib/api_generator/middleware/raise_error_dsl.rb
 - lib/api_generator/models/base.rb
@@ -222,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: 'Gemfather: API client generator'