Accessor and Mutator Methods for VAT Rates

[AlexTheWizardL]

Enhancements to CashCtrlLedger for Improved VAT Code Management

This pull request introduces significant enhancements to the CashCtrlLedger module, focusing on robust integration with the CashCtrl API for VAT rate management. We have added new functionalities for mirroring VAT rates onto CashCtrl, along with comprehensive error handling and code improvements to boost performance and maintainability.

• Encapsulated client management with getter and setter.
• Extended VAT code management functionalities (create, update, delete).
• Robust synchronization method to mirror VAT codes between local desired state and remote state.
• Comprehensive error handling and input validation.
• Detailed unit tests to cover a wide range of scenarios.

Changes

• Implemented getter and setter for client to ensure type safety.

• Added get_vat_codes, mirror_vat_codes, add_vat_code, update_vat_code, and delete_vat_code methods.

• Each method is equipped with detailed docstrings and error handling.

• Added extensive tests using pytest to ensure functionality works as expected under various conditions.

• Error Handling Enhancements:

  • Enhanced error handling across methods to throw more specific exceptions, improving the clarity and response strategies in error scenarios.
  • Validation steps were added to setter methods to ensure that only valid instances of CashCtrlClient are assigned, preventing runtime errors.

• Testing and Quality Assurance:

  • Extensive test suite added in tests/test_mirror_vat_code.py, covering a variety of scenarios from basic functionality tests to complex integration and error handling tests.
  • Utilized unittest.mock for dependency injections, ensuring that unit tests are robust and not dependent on external systems.

ChatGPT review:

Click for ChatGPT prompt

## Code Review for CashCtrlLedger Class Enhancements ### Overview This review examines the newly added functions and tests in the `CashCtrlLedger` class which extends the `LedgerEngine`. These additions are intended to manage VAT codes through the CashCtrl system. ### Code Review #### General Observations - **Code Duplication**: The `client` instance is created twice in the constructor which is redundant. Consider initializing it once. - **Error Handling**: It's good to see consistent error handling across the methods, especially with clear exception messages. - **Docstrings**: The documentation is detailed and helpful, making the code easier to understand and maintain. #### Specific Feedback ##### 1. Constructor Redundancy - **Issue**: The client attribute is assigned twice redundantly. - **Recommendation**: Initialize the _client attribute once and use the property setters/getters to manage it. ##### 2. Properties and Setters - **Best Practice**: Good use of property decorators to manage encapsulation of internal state. - **Issue**: The setter for client does not add much value as it merely checks the instance type. Consider whether this check could be enforced elsewhere to simplify the property. ##### 3. Method get_vat_codes - **Best Practice**: Good transformation and renaming of dataframe columns to match expected output. - **Potential Improvement**: Consider catching exceptions that might occur during API calls or data manipulation to enhance robustness. ##### 4. Method mirror_vat_codes - **Complexity**: This method is quite complex and handles multiple functionalities (delete, update, create). - **Recommendation**: Break down this method into smaller functions to improve readability and maintainability. ##### 5. Error Handling Consistency - **Observation**: Different methods handle similar errors (like API failures) in slightly different ways. - **Recommendation**: Standardize error handling across methods to maintain consistency and reduce code duplication. ##### 6. Tests - **Coverage**: Tests cover a broad range of scenarios, which is excellent for ensuring robustness. - **Improvement**: Some tests could be parameterized to reduce redundancy and increase the breadth of test cases with less code. ### Conclusion These changes aim to align the CashCtrlLedger class with best practices observed in other successful open-source Python projects, improving both the readability and the robustness of the codebase.

Review Request:

• Please review the error handling and suggest if specific exceptions are handled properly.
• Feedback on the test scenarios and any missing edge cases would be highly appreciated.
• @lasuk Please provide your insights and approval to merge this feature into the main branch.

[lasuk]

Merging. Thanks a lot for the contribution, endurance and great result!