gemfather-stable 2.2.5 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b083e80e457b2993012a45df31d48e659a899ed56699919d47b3460a0c13212
-  data.tar.gz: e0fa6ba27a533da3a5ecbb2bb0ea5c885ba1c09d36e5cba2d023bec6f76ed902
+  metadata.gz: d18a71b66ba4a336f532fa372a6a5b529827de01dd121a2cfa6a96e4b1aab044
+  data.tar.gz: a44cdc356a8dcc8fcbe5a45ad66c3ad048a2c0c7e1955b2b34e09dad3afea930
 SHA512:
-  metadata.gz: d23c99be0d5c7d758be93ef4e9cf340ff12f325106ef3577d8e90aa326dceee0251f5742571c88312ca87ee19049eee59763244b12ee4310ae0904a07840292d
-  data.tar.gz: e03bf0e8b32a16d25414443e3f529aff7e62dd31b9c176ee942d566caf24978aa48bbb912e2563e2d1f02c72aefbae59acf8e641c60a9c8613395b4c6a8f9cce
+  metadata.gz: 680945767d4b70caa22f18c68295407ff70d54893eea0ac3ad8f92dd3bf98be8f3bfe12821e5f06504c9dfc3d3dc05c03c28c1f6035e687dfaf8a52992e509d7
+  data.tar.gz: e42cae60fe2c2f5952d9ceaa89fb75f8d06327a1baa686a6305623185503ef3c1d955e8e46efc588af21df48391be89c031f5185b7d9b3f6702008fe0ed6d998

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/%app_name%.gemspec.tt

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable', '~> 2.3'
   spec.add_dependency 'dry-configurable', '~> 0.11'
-  spec.add_dependency 'gemfather-stable', '~> <%= version %>'
+  spec.add_dependency 'gemfather', '~> <%= version %>'
   spec.add_dependency 'faraday', '>= 0.17', '< 2'
   spec.add_dependency 'faraday_middleware', '>= 0.13', '< 2'
   spec.add_dependency 'hashie', '>= 3.0', '< 5'

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

@@ -11,7 +11,7 @@ module ApiGenerator
       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
 
@@ -34,11 +34,12 @@ module ApiGenerator
           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, 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/pagination/cursor_relation.rb

@@ -0,0 +1,19 @@
+class ApiGenerator::Pagination::CursorRelation < ApiGenerator::Pagination::Relation
+  def size(size)
+    expand(size: size)
+  end
+
+  def next_cursor(cursor)
+    expand(next_cursor: cursor)
+  end
+
+  private
+
+  def next_relation
+    expand(next_cursor: response['cursor'])
+  end
+
+  def last_page?
+    response['cursor'].nil?
+  end
+end

data/lib/api_generator/pagination/dsl.rb

@@ -3,6 +3,7 @@ module ApiGenerator::Pagination
     STRATEGIES = {
       limit_offset: LimitOffsetRelation,
       page: PageRelation,
+      cursor: CursorRelation,
     }.freeze
 
     # rubocop:disable Metrics/MethodLength

data/lib/api_generator/services/base_create.rb

@@ -33,7 +33,7 @@ module ApiGenerator
       end
 
       def source_root
-        gemfather_lib_path = $LOAD_PATH.grep(/gems\/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,13 +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?
+        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
@@ -73,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.5'.freeze
+  VERSION = '2.4.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemfather-stable
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.4.1
 platform: ruby
 authors:
 - Domclick Ruby Team and Daniil Kachur
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,11 +170,13 @@ 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
 - lib/api_generator/models/data.rb
 - lib/api_generator/pagination.rb
+- lib/api_generator/pagination/cursor_relation.rb
 - lib/api_generator/pagination/dsl.rb
 - lib/api_generator/pagination/limit_offset_relation.rb
 - lib/api_generator/pagination/page_relation.rb
@@ -197,15 +199,15 @@ files:
 - templates/specs/api_spec.erb
 - templates/specs/request_spec.erb
 - templates/specs/response_spec.erb
-homepage: https://github.com/DDKatch/gemfather/tree/stable
+homepage: https://github.com/domclick/gemfather
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/DDKatch/gemfather/tree/stable/issues
-  changelog_uri: https://github.com/DDKatch/gemfather/tree/stable/blob/main/CHANGELOG.md
-  documentation_uri: https://github.com/DDKatch/gemfather/tree/stable/blob/main/README.md
-  homepage_uri: https://github.com/DDKatch/gemfather/tree/stable
-  source_code_uri: https://github.com/DDKatch/gemfather/tree/stable
+  bug_tracker_uri: https://github.com/domclick/gemfather/issues
+  changelog_uri: https://github.com/domclick/gemfather/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/domclick/gemfather/blob/main/README.md
+  homepage_uri: https://github.com/domclick/gemfather
+  source_code_uri: https://github.com/domclick/gemfather
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []