rospatent 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8da1e945c9c210cef707bd01b1c603a98ce95e9a7df67428214d08653282abc
-  data.tar.gz: 487776845930d34da3198ecb52a8a1fb0e8690dae4d099409721990c20ac7f70
+  metadata.gz: c95c34be848baa76a4286b680399c4b76a10b5d4e699776c9d6d735ccbcf4e07
+  data.tar.gz: fdc55a2649fbaa37d4af103929a1cd25747aae7a409512e052da187b832197ef
 SHA512:
-  metadata.gz: 7f5b2739d6c9c5759383e4439b8ffc3f3e17cc1384e5778dfd93b795b6da39bce8ab7887a6dd18a4294671741fccb731c0deaa475c8a04b0c42286ebcb75cee3
-  data.tar.gz: 5582c35ea773a88d4187c79ffa16d0b7cbed19d2915375b4740980fa716daff15a07c3730936562683fc8c7093e75d68d833e7dbe697ecf79ee5079b68887a23
+  metadata.gz: cdf8239372f22f997aaca78ec400574a6ad26e470f2827e8c465aba6e6a15958c6f3caf6efa602245d58be3f7612929da720cfb77ffe12a871bb77878b084bc1
+  data.tar.gz: d852ecfd4103fb1d4bd22b6bc64b1c22f5e63ea8329c01dabd554e8503f647b7f049680fc35ff43d5b30e5e3ca7d94e3f6daf83ea6446d3f6d20e4debe51ed54

data/CHANGELOG.md

@@ -5,6 +5,23 @@ 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.1.0] - 2025-06-04
+
+### Added
+- Word count validation for `similar_patents_by_text` method (minimum 50 words required)
+- New `validate_text_with_word_count` validation method with configurable minimum word requirements
+- Staging environment configuration documentation and examples
+- Enhanced Russian documentation sections
+
+### Changed
+- Improved error handling for insufficient word count with descriptive messages showing current vs required count
+- Error type changed from `InvalidRequestError` to `ValidationError` for text validation consistency
+
+### Fixed
+- Documentation clarifications for similar patents API response format (`data` vs `hits` naming)
+- Updated README examples to use correct API response structure
+- Corrected minimum word requirements documentation for text-based similarity search
+
 ## [1.0.0] - 2025-06-03
 
 ### Added

data/README.md

@@ -1,5 +1,7 @@
 # Rospatent
 
+[![Gem Version](https://badge.fury.io/rb/rospatent.svg)](https://badge.fury.io/rb/rospatent)
+
 A comprehensive Ruby client for the Rospatent patent search API with advanced features including intelligent caching, input validation, structured logging, and robust error handling.
 
 > 🇷🇺 **[Документация на русском языке](#-документация-на-русском-языке)** доступна ниже
@@ -211,13 +213,13 @@ similar = client.similar_patents_by_id("RU134694U1_20131120", count: 50)
 
 # Find similar patents by text description
 similar = client.similar_patents_by_text(
-  "Ракетный двигатель с улучшенной тягой",
+  "Ракетный двигатель с улучшенной тягой ...", # 50 words in request minimum
   count: 25
 )
 
 # Process similar patents
-similar["hits"]&.each do |patent|
-  puts "Similar: #{patent['id']} (score: #{patent['_score']})"
+similar["data"]&.each do |patent|
+  puts "Similar: #{patent['id']} (score: #{patent['similarity']} (#{patent['similarity_norm']}))"
 end
 ```
 
@@ -437,6 +439,20 @@ Rospatent.configure do |config|
 end
 ```
 
+### Staging Environment
+
+```ruby
+# Optimized for staging
+Rospatent.configure do |config|
+  config.environment = "staging"
+  config.token = ENV['ROSPATENT_TOKEN']
+  config.log_level = :info
+  config.cache_ttl = 300         # Longer cache for performance
+  config.timeout = 45            # Longer timeouts for reliability
+  config.retry_count = 3         # More retries for resilience
+end
+```
+
 ### Production Environment
 
 ```ruby
@@ -597,8 +613,10 @@ The library uses **Faraday** as the HTTP client with redirect support for all en
 - **All endpoints** (`/search`, `/docs/{id}`, `/similar_search`, `/datasets/tree`, etc.) - ✅ Working perfectly with Faraday
 - **Redirect handling**: Configured with `faraday-follow_redirects` middleware to handle server redirects automatically
 
-⚠️ **Minor server-side limitation**:
-- **Similar Patents by Text**: Occasionally returns `503 Service Unavailable` (server-side issue, not client implementation)
+⚠️ **Minor server-side limitations**:
+- **Similar Patents by Text**: Occasionally returns `503 Service Unavailable` (a server-side issue, not a client implementation issue)
+⚠️ **Documentation inconsistencies**:
+- **Similar Patents**: According to the documentation, the array of hits is named `hits`, but the real implementation uses the name `data`
 
 All core functionality works perfectly and is production-ready with a unified HTTP approach.
 
@@ -885,13 +903,13 @@ similar = client.similar_patents_by_id("RU134694U1_20131120", count: 50)
 
 # Поиск похожих патентов по описанию текста
 similar = client.similar_patents_by_text(
-  "Ракетный двигатель с улучшенной тягой",
+  "Ракетный двигатель с улучшенной тягой ...", # минимум 50 слов в запросе
   count: 25
 )
 
 # Обработка похожих патентов
-similar["hits"]&.each do |patent|
-  puts "Похожий: #{patent['id']} (оценка: #{patent['_score']})"
+similar["data"]&.each do |patent|
+  puts "Похожий: #{patent['id']} (оценка: #{patent['similarity']} (#{patent['similarity_norm']}))"
 end
 ```
 
@@ -1004,25 +1022,43 @@ end
 ### Разработка
 
 ```ruby
+# Оптимизировано для разработки
 Rospatent.configure do |config|
   config.environment = "development"
   config.token = ENV['ROSPATENT_DEV_TOKEN']
   config.log_level = :debug
   config.log_requests = true
-  config.cache_ttl = 60
+  config.log_responses = true
+  config.cache_ttl = 60          # Короткий кеш для разработки
+  config.timeout = 10            # Быстрые таймауты для быстрой обратной связи
+end
+```
+
+### Staging
+
+```ruby
+# Оптимизировано для staging
+Rospatent.configure do |config|
+  config.environment = "staging"
+  config.token = ENV['ROSPATENT_TOKEN']
+  config.log_level = :info
+  config.cache_ttl = 300         # Более длительный кеш для производительности
+  config.timeout = 45            # Более длительные таймауты для надежности
+  config.retry_count = 3         # Больше повторов для устойчивости
 end
 ```
 
 ### Продакшн
 
 ```ruby
+# Оптимизировано для продакшна
 Rospatent.configure do |config|
   config.environment = "production"
   config.token = ENV['ROSPATENT_TOKEN']
   config.log_level = :warn
-  config.cache_ttl = 600
-  config.timeout = 60
-  config.retry_count = 5
+  config.cache_ttl = 600         # Более длительный кеш для производительности
+  config.timeout = 60            # Более длительные таймауты для надежности
+  config.retry_count = 5         # Больше повторов для устойчивости
 end
 ```
 
@@ -1056,8 +1092,10 @@ end
 - **Все endpoints** (`/search`, `/docs/{id}`, `/similar_search`, `/datasets/tree`, и т.д.) - ✅ Работают идеально с Faraday
 - **Обработка редиректов**: Настроена с middleware `faraday-follow_redirects` для автоматической обработки серверных редиректов
 
-⚠️ **Незначительное серверное ограничение**:
+⚠️ **Незначительные серверные ограничения**:
 - **Поиск похожих патентов по тексту**: Иногда возвращает `503 Service Unavailable` (проблема сервера, не клиентской реализации)
+⚠️ **Неточности документации**:
+- **Поиск похожих патентов**: Массив совпадений в документации назван `hits`, фактическая реализация использует `data`
 
 Вся основная функциональность реализована и готова для продакшена.
 

data/lib/rospatent/client.rb

@@ -147,13 +147,14 @@ module Rospatent
     end
 
     # Find patents similar to a given text
-    # @param text [String] The text to find similar patents to
+    # @param text [String] The text to find similar patents to (minimum 50 words required)
     # @param count [Integer] Maximum number of results to return (default: 100)
     # @return [Hash] The similar search results
-    # @raise [Rospatent::Errors::InvalidRequestError] If text is not provided
+    # @raise [Rospatent::Errors::ValidationError] If text has insufficient words or other validation errors
     def similar_patents_by_text(text, count: 100)
-      # Validate inputs
-      validated_text = validate_string(text, "search_text", max_length: 10_000)
+      # 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)
 
       # Check cache first (using hash of text for key)

data/lib/rospatent/input_validator.rb

@@ -100,6 +100,29 @@ module Rospatent
       value.strip
     end
 
+    # Validate text with word count requirements
+    # @param value [String, nil] Text to validate
+    # @param field_name [String] Name of the field for error messages
+    # @param min_words [Integer] Minimum required word count
+    # @param max_length [Integer, nil] Maximum allowed character length
+    # @return [String] Validated text
+    # @raise [ValidationError] If text is invalid or has insufficient words
+    def validate_text_with_word_count(value, field_name, min_words:, max_length: nil)
+      # First, apply standard string validation
+      validated_text = validate_string(value, field_name, max_length: max_length)
+      return nil if validated_text.nil?
+
+      # Count words by splitting on whitespace
+      word_count = count_words(validated_text)
+
+      if word_count < min_words
+        raise Errors::ValidationError,
+              "#{field_name.capitalize} must contain at least #{min_words} words (currently has #{word_count})"
+      end
+
+      validated_text
+    end
+
     # Validate required non-empty string (does not allow nil)
     # @param value [String, nil] String to validate
     # @param field_name [String] Name of the field for error messages
@@ -302,5 +325,14 @@ module Rospatent
 
       validated.compact
     end
+
+    private
+
+    # Count words in a text by splitting on whitespace
+    # @param text [String] Text to count words in
+    # @return [Integer] Number of words
+    def count_words(text)
+      text.split.size
+    end
   end
 end

data/lib/rospatent/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rospatent
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Aleksandr Dryzhuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-03 00:00:00.000000000 Z
+date: 2025-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -134,16 +134,16 @@ files:
 - lib/rospatent/railtie.rb
 - lib/rospatent/search.rb
 - lib/rospatent/version.rb
-homepage: https://hub.mos.ru/ad/rospatent
+homepage: https://github.com/amdest/rospatent
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://hub.mos.ru/ad/rospatent
-  source_code_uri: https://hub.mos.ru/ad/rospatent
-  changelog_uri: https://hub.mos.ru/ad/rospatent/blob/main/CHANGELOG.md
-  documentation_uri: https://hub.mos.ru/ad/rospatent/blob/main/README.md
-  bug_tracker_uri: https://hub.mos.ru/ad/rospatent/issues
-  wiki_uri: https://hub.mos.ru/ad/rospatent/wiki
+  homepage_uri: https://github.com/amdest/rospatent
+  source_code_uri: https://github.com/amdest/rospatent
+  changelog_uri: https://github.com/amdest/rospatent/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/amdest/rospatent/blob/main/README.md
+  bug_tracker_uri: https://github.com/amdest/rospatent/issues
+  wiki_uri: https://github.com/amdest/rospatent/wiki
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []