rospatent 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02b32bdfdedb6dd788856f5335d17ed7c739449e111fc72ea96cc8768bbe47a8
-  data.tar.gz: 1de3f7131127a1b68e69e99c370abe67825c922ac511e26c0e99ca0440969cfb
+  metadata.gz: 4a3938079b33ac5c291c85501df526ec12b7721a91c9f7c9a4b5c35c56a8fdab
+  data.tar.gz: 2a8cb80112a1c0380f2dd15f2e3e4909ae37f84e7ef3a819aa9d86fce6d1e765
 SHA512:
-  metadata.gz: fcc95897171c5b6f7edbd10209a806b7cac6c19254fdc9c96176479c6f2b6cb284446089b2ca39f57e20ef7bd7484500b570498884f45c0321da76eb6e299723
-  data.tar.gz: 392587596ad48ecbc5d65ee54f8c518c388315137a1dbbebb00dc2728ea9a5011157afceb679e2939e0350b8e48a43e50f961d07328a20e5d2d77c8325e43644
+  metadata.gz: 8843ca4bd8c87de711bed059c9f315a8d46a6123c0763a3eb7dcbfc5af6512e1d35b03782a22b37eb74578942592cb699b4ab8eb07c7744f651230b950c03e41
+  data.tar.gz: 29896e1b71030d368a54fc4d40bc3a9cd79318b82089618f71e98eafee65ce266d781dd2d1518001e0bd388af0937f2d46a5c7f911673d155738fa61e48fda44

data/CHANGELOG.md

@@ -5,10 +5,53 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.0] - 2025-06-09
+
+### Added
+- **Configurable Validation Limits**: Major enhancement to configuration system with customizable validation thresholds
+  - New `validation_limits` hash in configuration with 16 configurable parameters
+  - Users can now customize query length limits, pagination limits, array sizes, and more
+  - Fine-grained control over validation behavior without code modifications
+  - Environment-specific validation tuning support
+- **Comprehensive Validation Configuration**: All validation limits now centralized and configurable
+  - Query parameters: `query_max_length`, `natural_query_max_length` (default: 2000)
+  - Pagination: `limit_max_value` (default: 100), `offset_max_value` (default: 10,000)
+  - Arrays: `array_max_size` (default: 10), various tag limits
+  - Classification: `classification_query_max_length`, `classification_code_max_length`
+  - Similar search: `similar_text_min_words`, `similar_text_max_length`, `similar_count_max_value`
+  - Batch operations: `batch_size_max_value`, `batch_ids_max_size`
+
+### Changed
+- **Consolidated Validation Logic**: Eliminated code duplication by centralizing validation in Search class
+  - Removed duplicate validation limits from Client class
+  - All validation now happens in single location (Search class)
+  - Improved maintainability and reduced code duplication
+- **Enhanced Configuration System**: Extended configuration to support nested validation limits
+  - Configuration now supports hash-based validation limits
+  - All validation methods updated to use configurable limits
+  - Backward compatible configuration structure
+
+### Deprecated
+- **Client#validate_search_params**: Method deprecated in favor of centralized validation
+  - Method now returns parameters as-is for backward compatibility
+  - Validation responsibility moved to Search class
+  - Marked with deprecation notice for future removal
+
+### Fixed
+- **Validation Duplication**: Resolved issue where validation limits were hardcoded in multiple places
+  - Single source of truth for validation configuration
+  - Easier maintenance when API specifications change
+  - Consistent validation behavior across all methods
+
+## [1.4.2] - 2025-07-15
+
+## Fixed
+Updated the maximum length for the q and qn query parameters from 1000 to 2000 to accommodate larger input values in `Rospatent::Client#validate_search_params`.
+
 ## [1.4.1] - 2025-07-15
 
 ## Fixed
-Updated the maximum length for the q and qn query parameters from 1000 to 2000 to accommodate larger input values.
+Updated the maximum length for the q and qn query parameters from 1000 to 2000 to accommodate larger input values in `Rospatent::Search#validate_and_normalize_params`.
 
 ## [1.4.0] - 2025-06-09
 

data/README.md

@@ -11,7 +11,7 @@ A comprehensive Ruby client for the Rospatent patent search API with advanced fe
 - 🔍 **Complete API Coverage** - Search, retrieve patents, media files, and datasets
 - 🛡️ **Robust Error Handling** - Comprehensive error types with detailed context
 - ⚡ **Intelligent Caching** - In-memory caching with TTL and LRU eviction
-- ✅ **Input Validation** - Automatic parameter validation with helpful error messages
+- ✅ **Input Validation** - Automatic parameter validation with configurable limits and helpful error messages
 - 📊 **Structured Logging** - JSON/text logging with request/response tracking
 - 🚀 **Batch Operations** - Process multiple patents concurrently
 - ⚙️ **Environment-Aware** - Different configurations for dev/staging/production
@@ -101,6 +101,56 @@ Rospatent.configure do |config|
 end
 ```
 
+### Validation Limits Configuration
+
+Customize validation thresholds for different parameters to suit your specific needs:
+
+```ruby
+Rospatent.configure do |config|
+  config.token = "your_jwt_token"
+
+  # Customize validation limits
+  config.validation_limits = {
+    # Query parameters
+    query_max_length: 5000,              # Default: 2000
+    natural_query_max_length: 3000,      # Default: 2000
+    
+    # Pagination limits
+    limit_max_value: 200,                # Default: 100
+    offset_max_value: 50_000,            # Default: 10,000
+    
+    # Array and string limits
+    array_max_size: 20,                  # Default: 10
+    string_max_length: 2000,             # Default: 1000
+    
+    # Highlighting limits
+    pre_tag_max_length: 100,             # Default: 50
+    post_tag_max_length: 100,            # Default: 50
+    pre_tag_max_size: 20,                # Default: 10
+    post_tag_max_size: 20,               # Default: 10
+    
+    # Classification search limits
+    classification_query_max_length: 2000,  # Default: 1000
+    classification_code_max_length: 100,     # Default: 50
+    
+    # Similar search limits
+    similar_text_min_words: 30,          # Default: 50
+    similar_text_max_length: 20_000,     # Default: 10,000
+    similar_count_max_value: 2000,       # Default: 1000
+    
+    # Batch operation limits
+    batch_size_max_value: 100,           # Default: 50
+    batch_ids_max_size: 2000             # Default: 1000
+  }
+end
+```
+
+**Benefits of configurable validation limits:**
+- **Flexibility**: Adjust limits based on your application's requirements
+- **Performance**: Fine-tune validation for optimal performance
+- **API Evolution**: Easily adapt to changes in Rospatent API specifications
+- **Environment-specific**: Different limits for development, staging, and production
+
 ### Environment-Specific Configuration
 
 The gem automatically adjusts settings based on environment with sensible defaults:
@@ -1126,7 +1176,7 @@ $ bundle exec rake release
 - 🔍 **Полное покрытие API** - поиск, получение патентов, медиафайлы и датасеты
 - 🛡️ **Надежная обработка ошибок** - комплексные типы ошибок с детальным контекстом
 - ⚡ **Интеллектуальное кеширование** - кеширование в памяти с TTL и LRU исключением
-- ✅ **Валидация входных данных** - автоматическая валидация параметров с полезными сообщениями
+- ✅ **Валидация входных данных** - автоматическая валидация параметров с настраиваемыми лимитами и полезными сообщениями
 - 📊 **Структурированное логирование** - JSON/текстовое логирование с отслеживанием запросов/ответов
 - 🚀 **Пакетные операции** - параллельная обработка множества патентов
 - ⚙️ **Адаптивные окружения** - различные конфигурации для development/staging/production
@@ -1215,6 +1265,56 @@ Rospatent.configure do |config|
 end
 ```
 
+### Конфигурация лимитов валидации
+
+Настройте пороговые значения валидации для различных параметров в соответствии с вашими потребностями:
+
+```ruby
+Rospatent.configure do |config|
+  config.token = "ваш_jwt_токен"
+
+  # Настройка лимитов валидации
+  config.validation_limits = {
+    # Параметры запросов
+    query_max_length: 5000,              # По умолчанию: 2000
+    natural_query_max_length: 3000,      # По умолчанию: 2000
+    
+    # Лимиты пагинации
+    limit_max_value: 200,                # По умолчанию: 100
+    offset_max_value: 50_000,            # По умолчанию: 10,000
+    
+    # Лимиты массивов и строк
+    array_max_size: 20,                  # По умолчанию: 10
+    string_max_length: 2000,             # По умолчанию: 1000
+    
+    # Лимиты подсветки
+    pre_tag_max_length: 100,             # По умолчанию: 50
+    post_tag_max_length: 100,            # По умолчанию: 50
+    pre_tag_max_size: 20,                # По умолчанию: 10
+    post_tag_max_size: 20,               # По умолчанию: 10
+    
+    # Лимиты поиска по классификации
+    classification_query_max_length: 2000,  # По умолчанию: 1000
+    classification_code_max_length: 100,     # По умолчанию: 50
+    
+    # Лимиты поиска похожих патентов
+    similar_text_min_words: 30,          # По умолчанию: 50
+    similar_text_max_length: 20_000,     # По умолчанию: 10,000
+    similar_count_max_value: 2000,       # По умолчанию: 1000
+    
+    # Лимиты пакетных операций
+    batch_size_max_value: 100,           # По умолчанию: 50
+    batch_ids_max_size: 2000             # По умолчанию: 1000
+  }
+end
+```
+
+**Преимущества настраиваемых лимитов валидации:**
+- **Гибкость**: Настройка лимитов в соответствии с требованиями вашего приложения
+- **Производительность**: Точная настройка валидации для оптимальной производительности
+- **Эволюция API**: Легкая адаптация к изменениям в спецификациях API Роспатента
+- **Специфичность окружения**: Различные лимиты для разработки, staging и продакшна
+
 ### Конфигурация для конкретных окружений
 
 Gem автоматически настраивается под окружение с разумными значениями по умолчанию:

data/lib/rospatent/client.rb

@@ -35,9 +35,8 @@ module Rospatent
     # @param params [Hash] Search parameters
     # @return [Rospatent::SearchResult] Search result object
     def search(**params)
-      # Validate search parameters
-      validated_params = validate_search_params(params)
-      Search.new(self).execute(**validated_params)
+      # Validation is now handled by Search class to avoid duplication
+      Search.new(self).execute(**params)
     end
 
     # Fetch a specific patent by its document ID using dedicated endpoint
@@ -117,7 +116,7 @@ module Rospatent
     def similar_patents_by_id(document_id, count: 100)
       # Validate inputs
       validated_id = validate_patent_id(document_id)
-      validated_count = validate_positive_integer(count, "count", max_value: 1000)
+      validated_count = validate_positive_integer(count, "count", max_value: Rospatent.configuration.validation_limits[:similar_count_max_value])
 
       # Check cache first
       cache_key = "similar:id:#{validated_id}:#{validated_count}"
@@ -153,9 +152,10 @@ module Rospatent
     # @raise [Rospatent::Errors::ValidationError] If text has insufficient words or errors
     def similar_patents_by_text(text, count: 100)
       # Validate inputs - text must have at least 50 words for the API
-      validated_text = validate_text_with_word_count(text, "search_text", min_words: 50,
-                                                                          max_length: 10_000)
-      validated_count = validate_positive_integer(count, "count", max_value: 1000)
+              validated_text = validate_text_with_word_count(text, "search_text",
+                                                        min_words: Rospatent.configuration.validation_limits[:similar_text_min_words],
+                                                        max_length: Rospatent.configuration.validation_limits[:similar_text_max_length])
+        validated_count = validate_positive_integer(count, "count", max_value: Rospatent.configuration.validation_limits[:similar_count_max_value])
 
       # Check cache first (using hash of text for key)
       text_hash = validated_text.hash.abs.to_s(16)
@@ -337,7 +337,7 @@ module Rospatent
     def classification_search(classifier_id, query:, lang: "ru")
       # Validate inputs
       validated_classifier = validate_enum(classifier_id, %w[ipc cpc], "classifier_id").to_s
-      validated_query = validate_string(query, "query", max_length: 1000)
+      validated_query = validate_string(query, "query", max_length: Rospatent.configuration.validation_limits[:classification_query_max_length])
       validated_lang = validate_enum(lang, %w[ru en], "lang").to_s
 
       # Check cache first
@@ -378,7 +378,7 @@ module Rospatent
     def classification_code(classifier_id, code:, lang: "ru")
       # Validate inputs
       validated_classifier = validate_enum(classifier_id, %w[ipc cpc], "classifier_id").to_s
-      validated_code = validate_string(code, "code", max_length: 50)
+      validated_code = validate_string(code, "code", max_length: Rospatent.configuration.validation_limits[:classification_code_max_length])
       validated_lang = validate_enum(lang, %w[ru en], "lang").to_s
 
       # Check cache first
@@ -482,8 +482,8 @@ module Rospatent
     def batch_patents(document_ids, batch_size: 10)
       return enum_for(:batch_patents, document_ids, batch_size: batch_size) unless block_given?
 
-      validate_array(document_ids, "document_ids", max_size: 1000)
-      validated_batch_size = validate_positive_integer(batch_size, "batch_size", max_value: 50)
+      validate_array(document_ids, "document_ids", max_size: Rospatent.configuration.validation_limits[:batch_ids_max_size])
+      validated_batch_size = validate_positive_integer(batch_size, "batch_size", max_value: Rospatent.configuration.validation_limits[:batch_size_max_value])
 
       document_ids.each_slice(validated_batch_size) do |batch|
         threads = batch.map do |doc_id|
@@ -542,23 +542,11 @@ module Rospatent
     # Validate search parameters
     # @param params [Hash] Search parameters to validate
     # @return [Hash] Validated parameters
+    # @deprecated This method is deprecated. Validation now happens in Search class.
     def validate_search_params(params)
-      validations = {
-        q: { type: :string, max_length: 1000 },
-        qn: { type: :string, max_length: 1000 },
-        limit: { type: :positive_integer, min_value: 1, max_value: 100 },
-        offset: { type: :positive_integer, min_value: 0, max_value: 10_000 },
-        pre_tag: { type: :string_or_array, max_length: 50, max_size: 10 },
-        post_tag: { type: :string_or_array, max_length: 50, max_size: 10 },
-        sort: { type: :enum, allowed_values: %i[relevance pub_date filing_date] },
-        group_by: { type: :string_enum, allowed_values: %w[family:docdb family:dwpi] },
-        include_facets: { type: :boolean },
-        highlight: { type: :hash },
-        filter: { type: :filter },
-        datasets: { type: :array, max_size: 10 }
-      }
-
-      validate_params(params, validations)
+      # Validation is now handled by Search class to avoid duplication
+      # This method remains for backward compatibility but does no validation
+      params
     end
 
     # Parse a patent ID string into its component parts

data/lib/rospatent/configuration.rb

@@ -27,6 +27,8 @@ module Rospatent
     attr_accessor :token_expires_at, :token_refresh_callback
     # Connection pooling
     attr_accessor :connection_pool_size, :connection_keep_alive
+    # Validation limits
+    attr_accessor :validation_limits
 
     # Initialize a new configuration with default values
     def initialize
@@ -57,6 +59,27 @@ module Rospatent
       @connection_pool_size = ENV.fetch("ROSPATENT_POOL_SIZE", "5").to_i
       @connection_keep_alive = ENV.fetch("ROSPATENT_KEEP_ALIVE", "true") == "true"
 
+      # Validation limits
+      @validation_limits = {
+        query_max_length: 2000,
+        natural_query_max_length: 2000,
+        limit_max_value: 100,
+        offset_max_value: 10_000,
+        array_max_size: 10,
+        string_max_length: 1000,
+        pre_tag_max_length: 50,
+        post_tag_max_length: 50,
+        pre_tag_max_size: 10,
+        post_tag_max_size: 10,
+        classification_query_max_length: 1000,
+        classification_code_max_length: 50,
+        similar_text_min_words: 50,
+        similar_text_max_length: 10_000,
+        similar_count_max_value: 1000,
+        batch_size_max_value: 50,
+        batch_ids_max_size: 1000
+      }
+
       load_environment_config
     end
 

data/lib/rospatent/search.rb

@@ -97,17 +97,18 @@ module Rospatent
       validated = {}
 
       # Validate query parameters
-      validated[:q] = validate_string(params[:q], "q", max_length: 2000) if params[:q]
-      validated[:qn] = validate_string(params[:qn], "qn", max_length: 2000) if params[:qn]
+      config = Rospatent.configuration
+      validated[:q] = validate_string(params[:q], "q", max_length: config.validation_limits[:query_max_length]) if params[:q]
+      validated[:qn] = validate_string(params[:qn], "qn", max_length: config.validation_limits[:natural_query_max_length]) if params[:qn]
 
       # Validate pagination parameters (only if provided)
       if params[:limit]
         validated[:limit] =
-          validate_positive_integer(params[:limit], "limit", min_value: 1, max_value: 100)
+          validate_positive_integer(params[:limit], "limit", min_value: 1, max_value: config.validation_limits[:limit_max_value])
       end
       if params[:offset]
         validated[:offset] =
-          validate_positive_integer(params[:offset], "offset", min_value: 0, max_value: 10_000)
+          validate_positive_integer(params[:offset], "offset", min_value: 0, max_value: config.validation_limits[:offset_max_value])
       end
 
       # Validate highlighting parameters (only if provided)
@@ -119,9 +120,9 @@ module Rospatent
         end
 
         validated[:pre_tag] =
-          validate_string_or_array(params[:pre_tag], "pre_tag", max_length: 50, max_size: 10)
+          validate_string_or_array(params[:pre_tag], "pre_tag", max_length: config.validation_limits[:pre_tag_max_length], max_size: config.validation_limits[:pre_tag_max_size])
         validated[:post_tag] =
-          validate_string_or_array(params[:post_tag], "post_tag", max_length: 50, max_size: 10)
+          validate_string_or_array(params[:post_tag], "post_tag", max_length: config.validation_limits[:post_tag_max_length], max_size: config.validation_limits[:post_tag_max_size])
       end
 
       # Validate highlight parameter (complex object for advanced highlighting)
@@ -152,7 +153,7 @@ module Rospatent
 
       # Validate datasets parameter
       if params[:datasets]
-        validated[:datasets] = validate_array(params[:datasets], "datasets", max_size: 10) do |dataset|
+        validated[:datasets] = validate_array(params[:datasets], "datasets", max_size: config.validation_limits[:array_max_size]) do |dataset|
           validate_string(dataset, "dataset")
         end
       end

data/lib/rospatent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rospatent
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rospatent
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Aleksandr Dryzhuk