feat: enhance note.template with validation and new features #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Closed

devin-ai-integration wants to merge 29 commits into main from devin/1738167114-template-system

Contributor

devin-ai-integration bot commented Jan 29, 2025

Template System Improvements

This PR enhances the note.template functionality with improved validation, binary record support, and compact format features.

Changes

Added type validation for template body fields (boolean, integer, float, string)
Implemented automatic float-to-int conversion for whole numbers
Added binary record support with length validation
Added port number validation (1-100)
Implemented compact format with metadata field validation
Updated API documentation
Added comprehensive test suite

Testing

Added unit tests for all new features and validation
Note: pytest installation is required to run the test suite

Documentation

Updated api.md with new parameters and features
Added detailed parameter descriptions
Updated return type documentation
Added metadata field restrictions for compact mode

Link to Devin run: https://app.devin.ai/sessions/95ffd763d71b445198b9370e49dcd93f


          feat: enhance note.template with validation and new features

46da58a

- Add type validation for template body fields
- Implement binary record support with length validation
- Add port number validation (1-100)
- Support compact format with metadata field validation
- Update API documentation with new features
- Add comprehensive test suite

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>

Contributor Author

devin-ai-integration bot commented Jan 29, 2025

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
Look at CI failures and help fix them

⚙️ Control Options:

Disable automatic comment and CI monitoring

devin-ai-integration bot and others added 26 commits

January 29, 2025 16:26


          fix: address linting issues in test_note_template.py and note.py

354f3a2

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: reduce blank lines and fix indentation

90e9777

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: align continuation line indentation

009181e

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to match flake8 requirements

2dcbe84

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to match flake8 requirements

72e216b

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to match flake8 E128 requir…

a6ecd20

…ement

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: align continuation line indentation with opening parenthesis

8d3effb

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: align continuation line with opening parenthesis

647388b

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to align with opening paren…

f9defd4

…thesis

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to match flake8 requirements

aadb14c

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to match flake8 requirements

7f0d214

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to match flake8 requirements

b830d8c

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: adjust continuation line indentation to match E127 requirements

aa2c3e9

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: simplify error message to single line to avoid indentation issues

d455085

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: use real Notecard instance with mocked Transaction in tests

73b21b0

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: use proper Notecard instance in test fixtures

1983eeb

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: update imports to resolve flake8 errors

db5e300

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: keep numeric values as integers in note.template

aca1fd6

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: align note.template implementation with test expectations

2b605cf

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: use boolean compact parameter instead of format key

fe9e928

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: use proper boolean comparison style in tests

64a9fbb

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: revert compact field to 'format':'compact' per official spec

fb81471

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          feat: allow compact=True to translate to format='compact'

299063b

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          feat: add binary data support to note.add and note.get

721fa35

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          fix: remove whitespace in blank line

f3f203b

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>


          feat: add verify and delete parameters to note.template

2afc2cc

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>

rdlauer reviewed

View reviewed changes

notecard/note.py Outdated

    
                      try:

                          binary_helpers.binary_store_reset(card)

                          binary_helpers.binary_store_transmit(card, binary, 0)

                          req["binary"] = "true"

Contributor

rdlauer Jan 30, 2025

shouldn't this be req["binary"] = True?


          fix: use Python boolean True for req['binary']

4c939e4

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>

Contributor Author

devin-ai-integration bot commented Jan 30, 2025

I've updated the code to use Python's boolean value instead of the string for the binary parameter. This change:

Maintains consistency with the rest of the codebase where Python booleans are used
Relies on the JSON serialization layer to properly convert Python's to JSON's
Has passed all tests and CI checks

Please review the changes and let me know if you'd like any adjustments.


          revert: remove changes to auto-generated docs/api.md

a286caf

Co-Authored-By: rlauer@blues.com <rlauer@blues.com>

rdlauer closed this

rdlauer deleted the devin/1738167114-template-system branch

February 10, 2025 17:07

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet