dadata-rb 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4282ab1b196c52619d9caa5874dba8b3f6eb68770fb0958d9de05633adcedcf9
+  data.tar.gz: 04a96cd667879a35f2fd34b69c3b01e08ce29e055893f58da1388c20db047004
+SHA512:
+  metadata.gz: 1f72031f482ef11ab15415396da0dc00da2f350db2e350f274e8d79e53b938c75c26f0dd2e8e1b65c6068d2193accaa7df3221747385cfc0ab06ef3ad47bfc59
+  data.tar.gz: 2c924cf578c1fb906a7aac22cfe15a2490386e503d3c42010222e5cd4a9f5216c55b3462348fa02d1c9d4eb405d0b8cb812b95009c73bd2bd026cebb9123ecd4

data/.rubocop.yml

@@ -0,0 +1,134 @@
+AllCops:
+  TargetRubyVersion: 3.3
+  SuggestExtensions: false  # Disable extension suggestions
+  NewCops: enable
+  Exclude:
+    - 'Gemfile.lock'
+    - '.*/**'
+    - 'test/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+    - '.idea/**/*'
+    - '.vscode/**/*'
+    - '.ruby-lsp/**/*'
+    - 'vendor/**/*'
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
+  - rubocop-performance
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+  # Allow long lines in test assertions, error messages, and gem requirement messages
+  AllowedPatterns:
+    - '^(\s+)?#'  # Allow long comments
+    - 'assert(_\w+)?\s+.+,\s+".*"$'  # Allow long assertion messages
+    - ".*gem '.*' is required.*"  # Allow long gem requirement messages
+    - ".*gem install.*"  # Allow long gem install instructions
+    - ".*unless.*"  # Allow unless conditions that make code more readable
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_first_argument
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+  EnforcedLastArgumentHashStyle: always_inspect
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'test/**/*'
+    - 'lib/generators/**/*'
+    - 'lib/dadata/api_exceptions.rb'
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: nested
+  Exclude:
+    - 'test/**/*'
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NumericPredicate:
+  Enabled: true
+  EnforcedStyle: predicate
+  Exclude:
+    - 'test/**/*'
+
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: true
+
+Minitest/MultipleAssertions:
+  Enabled: true
+  Max: 10
+  Exclude:
+    - 'test/generators/**/*'  # Generator tests often need multiple assertions
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+    - '*.gemspec'
+    - 'Rakefile'
+    - 'lib/dadata/client/base.rb'  # Allow longer blocks for connection setup
+
+Metrics/MethodLength:
+  Max: 40
+  Exclude:
+    - 'test/**/*'
+
+Metrics/AbcSize:
+  Max: 40
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 150
+  Exclude:
+    - 'test/**/*'
+
+Metrics/CyclomaticComplexity:
+  Max: 8  # Increased from 7 to accommodate validate! and build_connection methods
+
+Metrics/PerceivedComplexity:
+  Max: 9  # Increased to match our codebase's needs
+
+Naming/FileName:
+  Exclude:
+    - 'lib/dadata.rb'
+    - 'lib/dadata-rb.rb'  # gem-name require shim; hyphen matches spec.name
+
+Gemspec/RequiredRubyVersion:
+  Enabled: true
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded  # Prefer raise ErrorClass, 'message' style
+
+Style/GuardClause:
+  Enabled: false  # Sometimes if/else is more readable than guard clauses
+
+Style/IfUnlessModifier:
+  Enabled: false  # Sometimes multi-line if statements are more readable

data/CHANGELOG.md

@@ -0,0 +1,129 @@
+# Changelog
+
+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).
+
+## [3.0.0] - 2026-05-31
+
+### Added
+- `config.log_request_bodies` option (default `false`) to opt into logging request payloads at `:debug`
+- Granular API error classes are now actually raised: `BadRequestError` (400), `UnauthorizedError` (401), `NotFoundError` (404), in addition to `AuthenticationError` (403) and `RateLimitError` (429)
+- `Dadata::TimeoutError` (subclass of `ConnectionError`), raised on request timeouts
+- `ClientBase#close` to release persistent connections (previously `Client#close` raised `NoMethodError`)
+
+### Changed
+- **BREAKING**: Published to RubyGems as `dadata-rb` (the `dadata` name was already taken). Installs from git must change `gem 'dadata'` to `gem 'dadata-rb'`; `require 'dadata'` is unchanged (a `dadata-rb` shim is also provided).
+- **BREAKING**: Request bodies are no longer logged by default. They contain personal data (passports, names, phones, emails); set `config.log_request_bodies = true` to restore the previous debug behavior.
+- **BREAKING**: Timeouts now raise `Dadata::TimeoutError` instead of `Dadata::ConnectionError`. `TimeoutError` subclasses `ConnectionError`, so existing `rescue ConnectionError` keeps working.
+- **BREAKING**: `400`/`401`/`404` responses now raise `BadRequestError`/`UnauthorizedError`/`NotFoundError` instead of generic `ApiError`. All remain subclasses of `ApiError`.
+- `SecureLogger` log lines now use the correct severity letter (`E`, `W`, …) instead of a hardcoded `I`
+- Single request-logging path via `SensitiveDataMiddleware` (removed duplicate logging in `ClientBase`)
+- Header/message sanitization consolidated into the shared `SensitiveData` module
+
+### Removed
+- **BREAKING**: `config.connection_pool_size` and `config.connection_pool_timeout` — these were never wired into the HTTP layer. The gem still uses persistent connections via `net-http-persistent`.
+- **BREAKING**: `zeitwerk` runtime dependency — it was declared but never used (loading is via `require_relative`).
+- RBS signatures under `sig/` (were stale and shipped with the gem); will be regenerated once the API stabilizes.
+
+### Fixed
+- Removed a bogus `'Error'` entry from the Faraday retry exception list
+- `Client#close` now works instead of raising `NoMethodError`
+
+### Security
+- Personal data in request payloads is no longer written to logs unless explicitly enabled via `config.log_request_bodies`
+
+## [2.0.0] - 2025-01-25
+
+### Added
+- Secure logging system with automatic filtering of sensitive data
+- `SecureLogger` class that extends Ruby's Logger to sanitize sensitive information
+- `SensitiveData` module for handling sensitive data in logs and error messages
+- Connection pooling for improved performance
+- New configuration options:
+  - `connection_pool_size` for controlling concurrent connections
+  - `connection_pool_timeout` for connection pool timeout
+  - `log_level` for setting logging verbosity
+  - Custom logger support with automatic secure wrapping
+
+### Changed
+- **BREAKING**: All loggers are now automatically wrapped in `SecureLogger`
+- **BREAKING**: Configuration syntax changed from hash-style to method calls
+- Improved HTTP connection handling with persistent connections
+- Enhanced error handling with sanitized error messages
+- Updated documentation with security best practices
+
+### Security
+- Automatic filtering of sensitive headers (Authorization, X-Secret, API-Key)
+- Secure handling of API keys and secrets in logs
+- Protection against accidental exposure of sensitive data in error messages
+
+## [1.1.2] - 2024-01-26
+
+### Changed
+- Updated Ruby version requirement to >= 3.3.0
+- Updated development dependencies to their latest versions
+- Improved code formatting and alignment in test files
+- Enhanced RuboCop configuration with additional rules and extensions
+- Added warning suppression for third-party gem warnings in test suite
+- Replaced OpenStruct with Struct in tests for better performance
+
+### Fixed
+- Fixed method redefinition warnings in generator tests
+- Fixed API error handling in tests to use correct error message assertions
+- Fixed connection error tests to properly test different network failure scenarios
+- Fixed initializer generator tests to match actual template content
+- Fixed test assertions to use proper configuration syntax
+- Fixed test warnings related to Rails generator testing
+- Fixed non-atomic file operations in generator tests
+- Removed unnecessary access modifiers in tests
+
+## [1.1.1] - 2024-01-25
+
+### Fixed
+- Fixed API error handling in tests to use correct error message assertions
+- Fixed connection error tests to properly test different network failure scenarios
+- Fixed initializer generator tests to match actual template content
+- Fixed test assertions to use proper configuration syntax
+- Fixed test warnings related to Rails generator testing
+
+## [1.1.0] - 2024-01-24
+
+### Added
+- Comprehensive test suite for Rails generator
+- Support for storing API keys in Rails credentials
+- New generator options:
+  - `--use-credentials` (default: true) for secure API key storage
+  - `--timeout` for configuring request timeout
+  - `--suggestions-count` for setting default suggestions limit
+- Improved documentation in generator templates
+- Type definitions using RBS for all clients
+- Bilingual documentation (Russian and English) in README
+- Enhanced error handling in initializer templates
+- Extended test coverage for initializer generator
+
+### Changed
+- Replaced `http` gem with `faraday` for better HTTP handling
+- Improved initializer template with better code organization and error handling
+- Renamed initializer template to use `.rb.tt` extension for better Rails integration
+- Updated Rakefile to include all test files including initializer tests
+- Improved code style and fixed RuboCop warnings:
+  - Fixed string literals in Gemfile
+  - Improved file operations safety in tests
+  - Enhanced error handling in API exceptions
+  - Fixed code style issues across the codebase
+
+### Fixed
+- Proper error classes in initializer templates
+- Configuration validation in initializer templates
+- Various code style issues and RuboCop warnings
+
+### Security
+- Added secure credentials storage option for API keys
+- Warning messages when storing API keys directly in initializer
+- Improved file operations safety in tests
+
+## [1.0.0] - 2023-05-24
+
+- Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,153 @@
+# Contributing Guidelines | Руководство по участию в разработке
+
+[English](#english) | [Русский](#russian)
+
+---
+
+<a name="russian"></a>
+# Руководство по участию в разработке
+
+## Структура веток
+
+Проект использует следующую структуру веток:
+
+- `master` - основная ветка, содержащая только релизы с чистой историей коммитов
+- `dev` - ветка разработки, интеграционная ветка для новых функций
+- `vX.Y.Z` - ветки для поддержки предыдущих мажорных версий (например, `v1.0.0`)
+- `feature/*` - ветки для разработки новых функций
+- `fix/*` - ветки для исправления ошибок
+- `refactor/*` - ветки для рефакторинга кода
+
+## Процесс разработки
+
+1. **Начало работы над новой функцией**:
+   ```bash
+   git checkout dev            # Переключаемся на ветку dev
+   git pull                   # Получаем последние изменения
+   git checkout -b feature/X  # Создаем новую ветку для функции
+   ```
+
+2. **Разработка**:
+   - Следуйте стилю кода проекта
+   - Добавляйте тесты для новой функциональности
+   - Используйте [Conventional Commits](https://www.conventionalcommits.org/) для сообщений коммитов
+
+3. **Интеграция**:
+   ```bash
+   git checkout dev           # Переключаемся на dev
+   git pull                  # Получаем последние изменения
+   git merge feature/X       # Интегрируем новую функцию
+   ```
+
+4. **Подготовка релиза**:
+   - Обновите CHANGELOG.md
+   - Обновите версию в lib/dadata/version.rb
+   - Обновите документацию
+
+5. **Релиз**:
+   ```bash
+   git checkout master       # Переключаемся на master
+   git merge --squash dev   # Сливаем изменения из dev с объединением коммитов
+   git commit -m "..."      # Создаем релизный коммит
+   git tag vX.Y.Z          # Создаем тег для версии
+   ```
+
+6. **После релиза**:
+   ```bash
+   git checkout dev         # Переключаемся на dev
+   git reset --hard master # Синхронизируем dev с master
+   ```
+
+## Правила именования коммитов
+
+Используйте [Conventional Commits](https://www.conventionalcommits.org/):
+
+- `feat:` - новая функциональность
+- `fix:` - исправление ошибок
+- `docs:` - изменения в документации
+- `style:` - форматирование, отступы и т.д.
+- `refactor:` - рефакторинг кода
+- `test:` - добавление или изменение тестов
+- `chore:` - обслуживание кода
+
+Для breaking changes добавляйте `!` и описание в теле коммита:
+```
+feat!: изменение API клиента
+
+BREAKING CHANGE: Изменен способ инициализации клиента
+```
+
+---
+
+<a name="english"></a>
+# Contributing Guidelines
+
+## Branch Structure
+
+The project uses the following branch structure:
+
+- `master` - release branch containing only releases with clean commit history
+- `dev` - development branch, integration branch for new features
+- `vX.Y.Z` - branches for supporting previous major versions (e.g., `v1.0.0`)
+- `feature/*` - branches for new feature development
+- `fix/*` - branches for bug fixes
+- `refactor/*` - branches for code refactoring
+
+## Development Process
+
+1. **Starting a New Feature**:
+   ```bash
+   git checkout dev            # Switch to dev branch
+   git pull                   # Get latest changes
+   git checkout -b feature/X  # Create new feature branch
+   ```
+
+2. **Development**:
+   - Follow the project's code style
+   - Add tests for new functionality
+   - Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages
+
+3. **Integration**:
+   ```bash
+   git checkout dev           # Switch to dev
+   git pull                  # Get latest changes
+   git merge feature/X       # Integrate new feature
+   ```
+
+4. **Release Preparation**:
+   - Update CHANGELOG.md
+   - Update version in lib/dadata/version.rb
+   - Update documentation
+
+5. **Release**:
+   ```bash
+   git checkout master       # Switch to master
+   git merge --squash dev   # Merge changes from dev with squash
+   git commit -m "..."      # Create release commit
+   git tag vX.Y.Z          # Create version tag
+   ```
+
+6. **Post-Release**:
+   ```bash
+   git checkout dev         # Switch to dev
+   git reset --hard master # Sync dev with master
+   ```
+
+## Commit Naming Rules
+
+Use [Conventional Commits](https://www.conventionalcommits.org/):
+
+- `feat:` - new feature
+- `fix:` - bug fix
+- `docs:` - documentation changes
+- `style:` - formatting, indentation, etc.
+- `refactor:` - code refactoring
+- `test:` - adding or modifying tests
+- `chore:` - code maintenance
+
+For breaking changes, add `!` and description in commit body:
+```
+feat!: change client API
+
+BREAKING CHANGE: Changed client initialization method
+```

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 ad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.