rospatent 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1834dfe049a29dc3991bfd687dc030d3ac1c8115fd650b295ebe123f76367285
-  data.tar.gz: 126863c21587c0246503f57d6dab07262e46d2332da6468a7a29d48b9736eb8a
+  metadata.gz: 7a67e6d87f80561b12663934f8f521318ffba4a91bfcc2d9e8f0da69a37bb941
+  data.tar.gz: 144209fec90c09ef12ec3b8bfbe8ce25ef869956d42a4c99932c0ee8b8cd2152
 SHA512:
-  metadata.gz: 57c293f3d982670811e1bd3691e4f1feb8c3c7911eac411d92561a4e104695eba8bdfa043fead62aaa8367034d491b8e8699cc14cf23c13cb6285056c4865de5
-  data.tar.gz: 8bc73ec16b985041ba87944c3e4cb248f5508cecaa3f663f39fc21bfb2fcc196c40382d359e9a9faf43aa902145d4a88357514f49fad87577194be5d033b12ea
+  metadata.gz: f04c183c8b4896ebce31c73adfb59cf5134256feb075d881138e1e54547241216abda98c63500106a8649c6a6b2b18562cf40acddeed6d926b08162887de9dca
+  data.tar.gz: 0d3f2c86cc5cbfb58c69d0db1100e796adb42664251cd1812118889604a897b4c43b6986a0104660b6ce4cc8c3ea39adab1c27ffbbf0fa815f733da5466e1f72

data/CHANGELOG.md

@@ -5,6 +5,34 @@ 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.3.2] - 2025-06-07
+
+### Added
+- Notes about logger `formatter` parameter behavior when using `Rails.logger` as `output`
+
+## [1.3.1] - 2025-06-06
+
+### Fixed
+- **Include Facets Parameter Handling**: Fixed critical bug in `include_facets` parameter validation and API format conversion
+  - Fixed boolean validation logic that incorrectly converted `false` values to `true`
+  - Added proper boolean-to-numeric conversion for API compliance (true → 1, false → 0)
+  - Enhanced validation to handle various input formats ("true", "false", 0, 1, etc.)
+  - Updated documentation with conversion behavior notes
+- **Rails Logger Compatibility**: Fixed TypeError when using `Rails.logger` with `Rospatent::Logger`
+  - Added intelligent duck typing to detect existing logger instances vs IO objects
+  - `Rails.logger` can now be passed directly without creating wrapper Logger instances
+  - Maintains full compatibility with file paths, IO objects, and custom loggers
+  - Added comprehensive test coverage for Rails integration scenarios
+
+### Changed
+- Enhanced `Rospatent::Logger` to accept existing logger instances (Rails.logger, custom loggers) in addition to IO objects
+- Improved boolean parameter validation across the gem with better edge case handling
+- Updated README documentation with Rails.logger usage examples and boolean parameter conversion notes
+
+### Added
+- New comprehensive test suite for Logger class covering Rails integration scenarios
+- Test coverage for include_facets boolean-to-numeric conversion with various input types
+
 ## [1.3.0] - 2025-01-02
 
 ### Added

data/README.md

@@ -15,7 +15,7 @@ A comprehensive Ruby client for the Rospatent patent search API with advanced fe
 - 📊 **Structured Logging** - JSON/text logging with request/response tracking
 - 🚀 **Batch Operations** - Process multiple patents concurrently
 - ⚙️ **Environment-Aware** - Different configurations for dev/staging/production
-- 🧪 **Comprehensive Testing** - 219 tests with 465 assertions, comprehensive integration testing
+- 🧪 **Comprehensive Testing** - 232 tests with 483 assertions, comprehensive integration testing
 - 📚 **Excellent Documentation** - Detailed examples and API documentation
 
 ## Installation
@@ -270,7 +270,7 @@ results = client.search(
   },
   sort: "publication_date:desc", # same as 'sort: :pub_date'; see Search#validate_sort_parameter for other sort options
   group_by: "family:dwpi",         # Patent family grouping: "family:docdb" or "family:dwpi"
-  include_facets: true,
+  include_facets: true,            # Boolean: true/false (automatically converted to 1/0 for API)
   pre_tag: "<mark>",           # Both pre_tag and post_tag must be provided together
   post_tag: "</mark>",         # Can be strings or arrays for multi-color highlighting
   highlight: {                 # Advanced highlight configuration (independent of pre_tag/post_tag)
@@ -676,6 +676,10 @@ client = Rospatent.client(logger: logger)
 shared_logger = Rospatent.shared_logger(level: :debug)
 ```
 
+**Notes**:
+- When using `Rails.logger`, formatting is controlled by Rails configuration, `formatter` parameter ignored
+- When using IO objects, `formatter` parameter controls output format
+
 ### Error Handling
 
 Comprehensive error handling with specific error types and improved error message extraction:
@@ -1101,7 +1105,7 @@ $ bundle exec rake release
 - 📊 **Структурированное логирование** - JSON/текстовое логирование с отслеживанием запросов/ответов
 - 🚀 **Пакетные операции** - параллельная обработка множества патентов
 - ⚙️ **Адаптивные окружения** - различные конфигурации для development/staging/production
-- 🧪 **Комплексное тестирование** - 219 тестов с 465 проверками, комплексное интеграционное тестирование
+- 🧪 **Комплексное тестирование** - 232 теста с 483 проверками, комплексное интеграционное тестирование
 - 📚 **Отличная документация** - подробные примеры и документация API
 
 ## Установка
@@ -1353,7 +1357,7 @@ results = client.search(
   },
   sort: "publication_date:desc", # то же самое, что 'sort: :pub_date'; см. варианты параметров сортировки в Search#validate_sort_parameter
   group_by: "family:dwpi",       # Группировка по семействам: "family:docdb" или "family:dwpi"
-  include_facets: true,
+  include_facets: true,          # Boolean: true/false (автоматически конвертируется в 1/0 для API)
   pre_tag: "<mark>",             # Оба тега должны быть указаны вместе
   post_tag: "</mark>",           # Могут быть строками или массивами
   highlight: {                   # Продвинутая настройка подсветки (независимо от тегов)
@@ -1758,6 +1762,10 @@ client = Rospatent.client(logger: logger)
 shared_logger = Rospatent.shared_logger(level: :debug)
 ```
 
+**Комментарии**:
+- При использовании `Rails.logger`, форматирование контролируется конфигурацией Rails, параметр `formatter` игнорируется
+- При использовании IO объекта, формат определяется параметром `formatter`
+
 ### Обработка ошибок
 
 Комплексная обработка ошибок с конкретными типами ошибок и улучшенным извлечением сообщений об ошибках:

data/lib/rospatent/logger.rb

@@ -18,20 +18,30 @@ module Rospatent
     attr_reader :logger, :level
 
     # Initialize a new logger
-    # @param output [IO, String] Output destination (STDOUT, file path, etc.)
+    # @param output [IO, String, Logger] Output destination (STDOUT, file path, existing logger, etc.)
     # @param level [Symbol] Log level (:debug, :info, :warn, :error, :fatal)
     # @param formatter [Symbol] Log format (:json, :text)
     def initialize(output: $stdout, level: :info, formatter: :text)
-      @logger = ::Logger.new(output)
       @level = level
-      @logger.level = LEVELS[level] || ::Logger::INFO
 
-      @logger.formatter = case formatter
-                          when :json
-                            method(:json_formatter)
-                          else
-                            method(:text_formatter)
-                          end
+      # Handle different types of output
+      @logger = if output.respond_to?(:debug) && output.respond_to?(:info) && output.respond_to?(:error)
+                  # If it's already a logger instance (like Rails.logger), use it directly
+                  output
+                else
+                  # If it's an IO object or file path, create a new Logger
+                  new_logger = ::Logger.new(output)
+                  new_logger.formatter = case formatter
+                                         when :json
+                                           method(:json_formatter)
+                                         else
+                                           method(:text_formatter)
+                                         end
+                  new_logger
+                end
+
+      # Set the log level
+      @logger.level = LEVELS[level] || ::Logger::INFO
     end
 
     # Log an API request

data/lib/rospatent/search.rb

@@ -45,7 +45,7 @@ module Rospatent
     # @param post_tag [String, Array<String>] HTML tag(s) to append to highlighted matches
     # @param sort [Symbol, String] Sort option (:relevance, :pub_date, :filing_date)
     # @param group_by [String] Grouping option ("family:docdb", "family:dwpi")
-    # @param include_facets [Boolean] Whether to include facet information
+    # @param include_facets [Boolean] Whether to include facet information (true/false, converted to 1/0 for API)
     # @param filter [Hash] Filters to apply to the search
     # @param datasets [Array<String>] Datasets to search within
     # @param highlight [Hash] Advanced highlight configuration with profiles
@@ -136,7 +136,16 @@ module Rospatent
       end
 
       # Validate boolean parameters (only if provided)
-      validated[:include_facets] = !params[:include_facets].nil? if params.key?(:include_facets)
+      if params.key?(:include_facets)
+        value = params[:include_facets]
+        # Convert various representations to boolean
+        validated[:include_facets] = case value
+                                     when nil then nil
+                                     when true, "true", "1", 1, "yes", "on" then true
+                                     when false, "false", "0", 0, "no", "off", "" then false
+                                     else !!value # For any other truthy values
+                                     end
+      end
 
       # Validate filter parameter
       validated[:filter] = validate_filter(params[:filter], "filter") if params[:filter]
@@ -181,7 +190,10 @@ module Rospatent
       payload[:group_by] = params[:group_by] if params[:group_by]
 
       # Add other parameters (only if explicitly provided)
-      payload[:include_facets] = params[:include_facets] if params.key?(:include_facets)
+      # Convert boolean to numeric format for API (true → 1, false → 0)
+      if params.key?(:include_facets)
+        payload[:include_facets] = params[:include_facets] ? 1 : 0
+      end
       payload[:filter] = params[:filter] if params[:filter]
       payload[:datasets] = params[:datasets] if params[:datasets]
 

data/lib/rospatent/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rospatent
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Aleksandr Dryzhuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-05 00:00:00.000000000 Z
+date: 2025-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday