rospatent 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c95c34be848baa76a4286b680399c4b76a10b5d4e699776c9d6d735ccbcf4e07
-  data.tar.gz: fdc55a2649fbaa37d4af103929a1cd25747aae7a409512e052da187b832197ef
+  metadata.gz: 1834dfe049a29dc3991bfd687dc030d3ac1c8115fd650b295ebe123f76367285
+  data.tar.gz: 126863c21587c0246503f57d6dab07262e46d2332da6468a7a29d48b9736eb8a
 SHA512:
-  metadata.gz: cdf8239372f22f997aaca78ec400574a6ad26e470f2827e8c465aba6e6a15958c6f3caf6efa602245d58be3f7612929da720cfb77ffe12a871bb77878b084bc1
-  data.tar.gz: d852ecfd4103fb1d4bd22b6bc64b1c22f5e63ea8329c01dabd554e8503f647b7f049680fc35ff43d5b30e5e3ca7d94e3f6daf83ea6446d3f6d20e4debe51ed54
+  metadata.gz: 57c293f3d982670811e1bd3691e4f1feb8c3c7911eac411d92561a4e104695eba8bdfa043fead62aaa8367034d491b8e8699cc14cf23c13cb6285056c4865de5
+  data.tar.gz: 8bc73ec16b985041ba87944c3e4cb248f5508cecaa3f663f39fc21bfb2fcc196c40382d359e9a9faf43aa902145d4a88357514f49fad87577194be5d033b12ea

data/CHANGELOG.md

@@ -5,6 +5,64 @@ 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.0] - 2025-01-02
+
+### Added
+- **Complete Filter Parameter Validation System**: Comprehensive overhaul of filter parameter handling with API compliance
+  - New `validate_filter()`, `validate_filter_values()`, `validate_filter_range()`, and `validate_filter_date()` methods
+  - Field validation for all supported filter fields (authors, patent_holders, country, kind, ids, classification codes, dates)
+  - Structure validation requiring `{"values": [...]}` format for list filters and `{"range": {"operator": "YYYYMMDD"}}` for date filters
+  - Automatic date format conversion from "YYYY-MM-DD" and Date objects to "YYYYMMDD" API format
+  - Comprehensive error messages for invalid filter structures and unsupported fields
+- **Enhanced Highlight Parameter Support**: Complete rewrite according to API specification
+  - New `validate_string_or_array()` method for tag validation
+  - Support for independent `pre_tag` and `post_tag` parameters (both required together)
+  - Support for string or array tag values for multi-color highlighting
+  - Advanced `highlight` parameter for profile-based highlighting configuration
+- **Improved Error Message Extraction**: Enhanced error handling for Rospatent API responses
+  - Error parsing now checks `"result"` field (Rospatent API format) in addition to standard `"error"` and `"message"` fields
+  - Updated `extract_validation_errors()` to check `"details"` field for validation errors
+  - Applied improvements to both `handle_response()` and `handle_binary_response()` methods
+- **String Enum Validation**: New `validate_string_enum()` method preserving string types for API compliance
+- **Comprehensive Test Coverage**: Added 49+ new tests covering filter validation, highlight functionality, error handling scenarios
+- **Enhanced Rails Integration**: Improved Rails initializer with proper environment variable priority handling
+
+### Fixed
+- **Group_by Parameter API Compliance**: Fixed to use correct API values `"family:docdb"` and `"family:dwpi"` instead of symbol conversion
+- **Environment Variable Priority Issues**: Fixed Rails initializer to prevent DEBUG logs in production when `ROSPATENT_LOG_LEVEL=debug` is set
+- **Filter Parameter Missing Issue**: Added missing `filter` parameter to `validate_search_params` validation rules
+- **Token Configuration Priority**: Improved token loading priority (Rails credentials → `ROSPATENT_TOKEN` → `ROSPATENT_API_TOKEN`)
+- **Configuration Environment Conflicts**: Fixed `load_environment_config` to only override values not explicitly set by environment variables
+
+### Changed
+- **Input Validation Type System**: Extended to support `:string_enum`, `:string_or_array`, and `:hash` validation types
+- **Search Parameter Validation**: Updated client validation to use correct API-compliant parameter types and values
+- **Test Suite Growth**: Expanded from 170 to 219 tests with 465 assertions, all passing with comprehensive integration testing
+- **Documentation Overhaul**: Major README updates with comprehensive filter examples, environment variable documentation, and Rails integration guides
+- **Configuration Management**: Enhanced environment variable handling with clear priority documentation and troubleshooting guides
+
+### Security
+- **Input Validation Strengthening**: Stricter validation prevents invalid requests from reaching API endpoints
+- **Environment Configuration Hardening**: Improved handling of sensitive configuration in different environments
+
+## [1.2.0] - 2025-06-04
+
+### Added
+- Binary data support for `patent_media` and `patent_media_by_id` methods to properly handle PDF, image, and other media files
+- New `binary` parameter for `get` method to distinguish between JSON and binary responses
+- New `handle_binary_response` method for processing binary API responses with proper error handling
+- Russian patent number formatting with automatic zero-padding to 10 digits
+- New `format_publication_number` private method for consistent number formatting across media methods
+
+### Fixed
+- API endpoint paths for `classification_search` and `classification_code` methods now include trailing slashes to prevent 404 errors
+- Binary data corruption issue when downloading patent media files (PDFs, images) through media endpoints
+
+### Changed
+- Enhanced test coverage for binary data handling and publication number formatting
+- Updated README documentation for classification search examples and dataset display conventions
+- Improved error handling consistency for binary vs JSON responses
+
 ## [1.1.0] - 2025-06-04
 
 ### Added