|
| 1 | +## [1.1.8] - 2025-03-13 |
| 2 | +# Changelog |
| 3 | + |
| 4 | +## Features |
| 5 | + |
| 6 | +### Added CLAUDE.md with Build Commands and Code Style Guidelines |
| 7 | +- A new `CLAUDE.md` file was created to document build commands and code style guidelines. |
| 8 | +- Provides commands for building, testing on specific JDK versions, running single tests, and publishing locally. |
| 9 | +- Establishes Java code style guidelines, including Java 17+ compatibility, Lombok annotations usage, documentation requirements, and package naming conventions. |
| 10 | +- Specifies best practices for dependency injection, exception handling, and consistent code formatting. ([commit 5de32522](https://github.com/devondragon/SpringCFTurnstile/commit/5de32522)) |
| 11 | + |
| 12 | +### Added Turnstile Captcha Validation Filter and Configuration |
| 13 | +- Introduced `TurnstileCaptchaFilter` to validate captcha tokens during Spring Security form login submissions. |
| 14 | +- Configuration properties allow customization of login submission paths, redirect URLs, and token parameter names. |
| 15 | +- Provides integration instructions with Spring Security Setup for streamlined captcha validation. ([commits 29db7fba](https://github.com/devondragon/SpringCFTurnstile/commit/29db7fba)) |
| 16 | + |
| 17 | +### Added Monitoring and Metrics Support |
| 18 | +- Implemented Spring Actuator metrics for validation counts, success/failure rates, and response times. |
| 19 | +- Added health check to monitor Cloudflare connectivity, configurable via the application properties. |
| 20 | +- Supports Micrometer metrics for integration with monitoring systems like Prometheus and Grafana. ([commits 24583689, 57516314](https://github.com/devondragon/SpringCFTurnstile/commit/24583689)) |
| 21 | + |
| 22 | +## Fixes |
| 23 | + |
| 24 | +### Improved Error Handling and Resilience |
| 25 | +- Added multiple custom exception classes for various error scenarios. |
| 26 | +- Introduced `ValidationResult` class for detailed validation error reporting. |
| 27 | +- Enhanced `TurnstileValidationService` to categorize and handle different error types, maintaining backward compatibility. ([commits 2a45c40e, 306bc141](https://github.com/devondragon/SpringCFTurnstile/commit/2a45c40e)) |
| 28 | + |
| 29 | +### Fixed Method Name Typo: `getTurnsiteSitekey` to `getTurnstileSitekey` |
| 30 | +- Corrected a method name typo in `TurnstileValidationService` for improved code clarity and usage. |
| 31 | +- Deprecated the old method while ensuring backward compatibility. ([commits e0880f76, f03e68bb](https://github.com/devondragon/SpringCFTurnstile/commit/e0880f76)) |
| 32 | + |
| 33 | +## Documentation |
| 34 | + |
| 35 | +### Improved Documentation Consistency and Completeness |
| 36 | +- Created `CONTRIBUTING.md` with guidelines for contributors. |
| 37 | +- Enhanced existing documentation with additional security best practices and architecture overview. |
| 38 | +- Fixed and updated the license information in the `README` to Apache 2.0 and added security best practices. ([commits 7e79b31f, 64199aa4](https://github.com/devondragon/SpringCFTurnstile/commit/7e79b31f)) |
| 39 | + |
| 40 | +### Added License Files |
| 41 | +- Introduced comprehensive `LICENSE.md` and `LICENSE.txt` files conveying Apache License 2.0 terms. ([commits 7e79b31f, 1e166f07](https://github.com/devondragon/SpringCFTurnstile/commit/7e79b31f)) |
| 42 | + |
| 43 | +## Testing |
| 44 | + |
| 45 | +### Added and Updated Tests for Turnstile Validation |
| 46 | +- Enhanced tests for `TurnstileValidationService`, ensuring coverage for new error handling and input validation scenarios. |
| 47 | +- Confirmed validation logic processes null, empty, and short tokens as well as remote IP address issues. ([commits 2ac832ac](https://github.com/devondragon/SpringCFTurnstile/commit/2ac832ac)) |
| 48 | + |
| 49 | +## Other Changes |
| 50 | + |
| 51 | +### Dependency Updates |
| 52 | +- Bumped `springBootVersion` to 3.4.3 and updated `com.vanniktech.maven.publish` and `com.github.ben-manes.versions` plugins versions for better compatibility and functionality. ([commits 494ee82c, 63dc315e](https://github.com/devondragon/SpringCFTurnstile/commit/494ee82c)) |
| 53 | +- Updated Gradle wrapper properties to version 8.12.1 for overall build tool enhancements. ([commit 6ba0ef13](https://github.com/devondragon/SpringCFTurnstile/commit/6ba0ef13)) |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +This changelog focuses on summarizing significant feature additions, fixes, and other enhancements for easy reference by developers and users alike. For detailed code reviews, refer to individual commit messages and linked pull requests. |
| 58 | + |
1 | 59 | ## [1.1.7] - 2024-12-31 |
2 | 60 | Based on the commit messages, the changelog would be: |
3 | 61 |
|
|
0 commit comments