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

FFS-2490 Wrap Argyle Data Fetch API's #496

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open

FFS-2490 Wrap Argyle Data Fetch API's #496

wants to merge 33 commits into from
+4,299 −34

Conversation

jeffcatania-usds
Copy link
Contributor

@jeffcatania-usds jeffcatania-usds commented Mar 10, 2025 •
edited
Loading

Ticket

Resolves FFS-2490.

Changes

  • Implemented wrappers around Argyle SDK methods: "/users", "/identities", "/accounts", "/paystubs", "/employments"
  • Implemented convenience methods fetch_paystubs, fetch_employment, fetch_income, fetch_employment that call the underlying SDK functions and return normalized ResponseObjects.
  • Mock data added for the three mock Argyle sandbox users: Bob, Sarah, and Joe available in app/spec/support/fixtures/argyle.
  • Test cases provided to validate returned ResponseObjects in fetch_paystubs, fetch_employment, fetch_income, fetch_employment
  • Introduced "argyle_sandbox_data" rake tool for easy downloading of Argyle sandbox mock data to fixtures.

Context for reviewers

  • This PR sets up for FFS-2562 to refactor PinwheelDataHelper and associated views to be able to pull data from the ArgyleService
  • To run new rake:
rake argyle_sandbox_data:fetch[darren,11111111-1111-111-1111-111111111111]

Results:

:mock_folder_name was: 'darren'
:argyle_user_id was: '11111111-1111-111-1111-111111111111'
File written at spec/support/fixtures/argyle/darren/request_user.json
File written at spec/support/fixtures/argyle/darren/request_identity.json
File written at spec/support/fixtures/argyle/darren/request_employment.json
File written at spec/support/fixtures/argyle/darren/request_accounts.json
File written at spec/support/fixtures/argyle/darren/request_paystubs.json

Acceptance testing

  • No acceptance testing needed
    • This change will not affect the user experience (bugfix, dependency updates, etc.)
  • Acceptance testing prior to merge
    • This change can be verified visually via screenshots attached below or by sending a link to a local development environment to the acceptance tester
    • Acceptance testing should be done by design for visual changes, product for behavior/logic changes, or both for changes that impact both.
  • Acceptance testing after merge
    • This change is hard to test locally, so we'll test it in the demo environment (deployed automatically after merge.)
    • Make sure to notify the team once this PR is merged so we don't inadvertently deploy the unaccepted change to production. (e.g. :alert: Deploy block! @ffs-eng I just merged PR [#123] and will be doing acceptance testing in demo - please don't deploy until I'm finished!)

jeffcatania-usds and others added 14 commits March 4, 2025 19:46
@jeffcatania-usds jeffcatania-usds self-assigned this Mar 10, 2025
@jeffcatania-usds jeffcatania-usds marked this pull request as draft March 10, 2025 20:39
@jeffcatania-usds jeffcatania-usds marked this pull request as ready for review March 11, 2025 01:18
tdooner
tdooner approved these changes Mar 11, 2025
View reviewed changes
Copy link
Contributor

@tdooner tdooner 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. Just a bunch of style nitpicks.

app/app/services/argyle_service.rb Outdated
@http.build_url(endpoint).to_s
end

def store_mock_response(responsePayload:, folderName: "other", fileName:)
Copy link
Contributor

Choose a reason for hiding this comment

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

idiomatic ruby would have these as snake_case. I'm going to follow up with a Rubocop rule to enforce this automatically.

app/spec/services/argyle_service_spec.rb
})
expect(employment).to have_attributes(
status: "terminated",
)
Copy link
Contributor

Choose a reason for hiding this comment

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

There's still some very strange indenting in here. Maybe installing some kind of ruby plugin to do indenting will allow it to autoformat correctly? Rubocop does not seem to have a linter for this one either (not 100% sure, but I tried the obvious ones to no avail).

app/app/services/argyle_service.rb Outdated
store_mock_response(
folderName: folderName,
fileName: "request_paystubs",
responsePayload: fetch_paystubs_api(user: argyle_user_id))
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, maybe at some point we should move these methods into a helper module of some sort so they're not chilling on ArgyleService for the future.

@tdooner tdooner mentioned this pull request Mar 11, 2025
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tdooner tdooner tdooner approved these changes

Assignees

@jeffcatania-usds jeffcatania-usds

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jeffcatania-usds @tdooner