Skip to content
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

22235 Legal API - Create endpoint for retrieving stage 1 AR letter #2849

Merged
merged 14 commits into from
Jul 24, 2024
Merged

22235 Legal API - Create endpoint for retrieving stage 1 AR letter #2849

merged 14 commits into from
Jul 24, 2024

Conversation

chenhongjing
Copy link
Collaborator

@chenhongjing chenhongjing commented Jul 19, 2024 •
edited
Loading

Issue #: /bcgov/entity#22235

Description of changes:

  • Created a new endpoint for generating furnishing AR letter, the query parameter is optional and it's default for colored version by default
GET <base_url>/businesses/<business_identifier>/furnishings/<furnishing_id>/document
Content-Type: application/pdf
Accept: application/pdf

GET <base_url>/businesses/<business_identifier>/furnishings/<furnishing_id>/document?variant=default
GET <base_url>/businesses/<business_identifier>/furnishings/<furnishing_id>/document?variant=greyscale
  • Added ReportV2 class. This is only used for calling GCP report service.
  • Added report templates for AR letter. The design is here. Note that there are colored version and greyscale version of the letter. The greyscale version may need some tweaks in the future to better align with the requirements of BCMail+.
  • Added unit tests
  • Update furnishing job stage one to populate address information for both email and mail scenario
  • 1Password update for GCP report service
  • Other misc updates
  • Removed Address.FURNSIHING and related code

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the lear license (Apache 2.0).

@chenhongjing
22235-legal-api-create endpoint for retrieving stage 1 AR (major upda…
7cfea00 
…tes)

Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
misc related updates
3481d60 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
update furnishing job stage one to populate address for both email & …
0ed5b24 
…mail scenarios

Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing chenhongjing self-assigned this Jul 19, 2024
@chenhongjing
fix linting
a6e38d5 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
Copy link
Collaborator Author

The generated outputs. The address position still needs to be tested. (Looks weird? 🤔 )

  • Email letter without EP registrations
    image

  • Mail letter without EP reigistrations
    image

  • Email letter with EP registrations
    image

  • Mail letter with EP registrations
    image

@chenhongjing
handle bad data
cda2989 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
Copy link
Collaborator Author

chenhongjing commented Jul 22, 2024 •
edited
Loading

@andyyanggov FYI

@chenhongjing
fix typo
6e2726b 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
specify user roles for endpoint
2d30695 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
fix typo
3edea97 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
1password & related updates
89474e2 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
leodube-aot
leodube-aot approved these changes Jul 23, 2024
View reviewed changes
Copy link
Collaborator

@leodube-aot leodube-aot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, great job on this one!

@chenhongjing
update address position
9ca6019 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
update address type for furnishing address
5edef1e 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
remove handling for bad data
c1a8a0f 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
remove FURNISHING type in address model & fix broken tests in furnish…
0dd0b66 
…ings job

Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@chenhongjing
Copy link
Collaborator Author

The updated outputs

  • Email letter without EP registrations
    image

  • Mail letter without EP reigistrations
    image

  • Email letter with EP registrations
    image

  • Mail letter with EP registrations
    image

@andyyanggov
Copy link

@chenhongjing Looking good!

@chenhongjing
rename 'output_type' to 'variant'
cdc356d 
Signed-off-by: Hongjing Chen <Hongjing.Chen@gov.bc.ca>
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Jul 24, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot
47.8% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

@chenhongjing chenhongjing merged commit e36f105 into bcgov:main Jul 24, 2024
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leodube-aot leodube-aot leodube-aot approved these changes

@argush3 argush3 argush3 approved these changes

@kzdev420 kzdev420 Awaiting requested review from kzdev420

Assignees

@chenhongjing chenhongjing

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@chenhongjing @andyyanggov @argush3 @leodube-aot