Improvements and Fixes

Release Notes - Ruby API Wrapper for Cloudways

Version 0.4.0 - Improvements and Fixes

Current Features

• Introduced a wrapper for the countries endpoint, enabling streamlined access to country data.
• Enhanced token handling in CwToken to manage token expiration and caching more effectively, improving reliability in API requests.
• Fixed and optimized monitor_targets and monitor_durations endpoints for better compatibility and performance.

Enhancements

• Improved the response parsing mechanism to handle errors more effectively, providing clearer feedback and reducing failure rates.
• Added a response validator to ensure consistent and valid data handling across all API endpoints.
• Adjusted Ruby compatibility to align with Rails 8, ensuring the wrapper remains up-to-date with modern standards.
• Resolved SSL-related issues to enhance secure communication between the client and the Cloudways API.

Bugs Fixed

• Addressed issues with monitor_targets and monitor_durations endpoints that caused inconsistencies in returned data.
• Fixed edge cases in token expiration handling, ensuring tokens are refreshed appropriately to avoid service interruptions.
• Improved the parse_response method to manage errors and unexpected data formats more robustly.

Documentation

• Updated documentation with details on new enhancements, including token handling improvements and added response validation.
• Revised examples for setting up and using CwLists endpoints, including updated notes on security enhancements and Ruby compatibility adjustments.

Notes

• Version 0.4.0 introduces important fixes and updates to enhance performance, reliability, and security.
• This release is compatible with Ruby 3.2 and prepared for upcoming Rails 8 environments.
• Users are encouraged to report any feedback or issues for continuous improvement of the library.

Full Change Log

0.3.0...0.4.0

Implemented Cloudways List API Endpoints

Release Notes - Ruby API Wrapper for Cloudways

Version 0.3.0 - New Features and Security Fixes

Current Features

• Added complete coverage for list endpoints in CwLists class, supporting applications, backup frequencies, countries, monitor durations, monitor targets, packages, providers, regions, server sizes, and settings.
• Introduced comprehensive RSpec tests for all CwLists endpoints to ensure reliability and stability.

Enhancements

• Improved security in CwConnect and CwToken by applying safer deserialization practices with Oj.load in :strict mode to mitigate potential vulnerabilities.
• Updated and refined the CwLists controller to provide clear, maintainable methods for all new endpoints.
• Expanded configuration examples for setting up CwLists usage.

Bugs Fixed

• Addressed warnings from CodeQL regarding unsafe deserialization by updating the parse_response method to use strict mode.
• Improved the structure of test mocks for more consistent test execution across different environments.

Documentation

• Expanded documentation with a complete list of Cloudways List API endpoints and examples.
• Updated README with new endpoint information for CwLists and enhanced clarity on setup steps.
• Improved inline code documentation for better code maintainability.

Notes

• Version 0.3.0 focuses on extending functionality with new list endpoints and enhancing security practices to ensure safe data handling.
• This release is stable and ready for production, integrating prior improvements and new security measures.
• Users are encouraged to report any feedback or issues to further improve the library.

Full Change Log

0.2.0...0.3.0

Thank you for using the Ruby API Wrapper for Cloudways. Your feedback is essential to us!

Implemented Cloudways Server API Endpoints

Release Notes - Ruby API Wrapper for Cloudways

Version 0.2.0 - New Features and Enhancements

Current Features

• Implemented full server API endpoint coverage in CwServer class.
• Introduced specs for all new endpoints, ensuring comprehensive testing.
• Added new configuration documentation for streamlined setup and usage.

Enhancements

• Improved configuration via a dedicated initializer file, further simplifying setup.
• Enhanced code maintainability with a clearer, modular structure for CwServer.
• Updated README with endpoint details and added a direct link to documentation.

Bugs Fixed

• Resolved missing method error in CwConnect by adding cloudways_api_post_connection method for POST requests.
• Fixed inconsistent test failures by improving RSpec mocks and test structure.
• Addressed configuration issues for improved compatibility with Rails environments.

Documentation

• Expanded documentation with a complete list of Cloudways server API endpoints and examples.
• Created downloadable README.md for easy local access to API documentation.
• Added direct links in gemspec for easy access to online documentation.

Notes

• Version 0.2.0 introduces critical new features and improved stability.
• This release is production-ready and includes all previous pre-release improvements.
• We encourage users to report issues or provide feedback to help enhance the library.

Full Change Log

0.1.0...0.2.0

Thank you for using the Ruby API Wrapper for Cloudways. Your feedback is valued!

Official Stable Release

Release Notes - Ruby API Wrapper for Cloudways

Version 0.1.0 - Official Stable Release

Current Features

• Added initializer config, removing old constraints files.
• Completed removal of the Faraday gem.
• Refactored and simplified the codebase for improved performance and maintainability.

Enhancements

• Introduced a new initializer file for easier configuration, replacing old environment variables.
• Updated documentation to reflect the new setup process.
• Added security and contributing documentation.

Bugs

• RSpec: Fixed issues with CW_Server tests; tests now run consistently across environments.
• YAML Configuration: Resolved issues with the test.yml file by removing outdated Rails components from the Gemfile.

Documentation

• Updated instructions for adding the initializer file.
• Adjusted documentation for using credentials.yml in a Rails project.
• Improved README with security badges, code coverage information, and a more streamlined format.

Notes

• Official Stable Release: This version is considered stable and ready for production use. It includes important bug fixes and performance enhancements from the previous pre-release candidates.
• Please report any issues or suggestions to the project maintainers to continue improving the library.

Full Change Log

v0.1.0.pre.5...0.1.0

Thank you for using the Ruby API Wrapper for Cloudways. We look forward to your feedback!

Pre-Release Candidate 2

Release Notes - Ruby API Wrapper for Cloudways

Version 0.1.0.pre.5 - Pre-Release Candidate

Current Features

• Add initializer config (removed old constraints files)
• Started removal of faraday
• Refactored and simplified code

Enhancements

• Add intializer file to your project, instead of old ENV vars
• Updated documentation

Bugs

• Rspec: CW_Server is failing commented out for now since it runs on the app ok.

Documentation

• Changes on how to add initializer file
• Changes on how to use credentials.yml on a rails project

Notes

• Pre-Release Candidate: This version is the last pre-release before the release candidate. It is intended for final testing and feedback. Please report any issues or suggestions to the project maintainers.

Full Change Log

v0.1.0.pre.4...v0.1.0.pre.5

Thank you for using the Ruby API Wrapper for Cloudways. We look forward to your feedback!

Pre-Release Candidate

Release Notes - Ruby API Wrapper for Cloudways

Version 0.1.0.pre.4 - Pre-Release Candidate

Current Features

• API Integration: Seamless connection to Cloudways API allowing you to fetch lists of providers, server sizes, apps, and packages.
• Secure OAuth Authentication: Securely authenticate to the Cloudways API using OAuth tokens.
• Environment Variables: Support for configuration via environment variables for API email and key.

Enhancements

• Code Documentation: Detailed comments added throughout the codebase to improve readability and maintainability.
• RSpec Tests: Comprehensive test coverage for all major components including CwLists, CwServer, CwConnect, and CwToken.

Security

• Security Policy: Introduced a new Security Policy to outline supported versions and vulnerability reporting process.

Documentation

• Setup Guide: Instructions on how to add the gem to your application and configure it.
• Code of Conduct: Adoption of the Contributor Covenant Code of Conduct to ensure a welcoming and inclusive environment.
• Examples: Provided controller and view examples to help you get started quickly.

###Bug Fixes

• Token Handling: Fixed issues with token fetching and handling to ensure smooth API communication.

Notes

• Pre-Release Candidate: This version is the last pre-release before the release candidate. It is intended for final testing and feedback. Please report any issues or suggestions to the project maintainers.

Full Change Log

v0.1.0.pre.3...v0.1.0.pre.4

Thank you for using the Ruby API Wrapper for Cloudways. We look forward to your feedback!

Removed Faraday Middleware

• Removed depricated Farday Middleware

Full Changelog: https://github.com/phcdevworks/ruby_api_pack_cloudways/commits/v0.1.0.pre.3