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.

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

Quality/change saml endpoint name #370

Draft
wants to merge 2,311 commits into
base: development
Choose a base branch
from

Conversation

sneaky-patriki
Copy link

@sneaky-patriki sneaky-patriki commented Mar 27, 2022

Description

  • Added a new endpoint /auth/saml2 for SAML authentication

  • This uses the same logic as /auth/jwt (which should be SAML and will be decommissioned)

  • Pulled out logic into a seperate function

Fixes # (issue)

Type of change

Refactoring

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Ran unit test suite locally

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation if appropriate
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have created or extended unit tests to address my new additions
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

If you have any questions, please contact @macite or @jakerenzella.

jakerenzella and others added 30 commits September 18, 2021 00:12
macite and others added 17 commits March 12, 2022 09:04
…ete-pid

fix:fix the manual delete servers.pid file after restart container
…ms#364)

refactor ternary operator which creates student_name to ensure nicknames with a value of "" are not rendered
…-unit-load-times

Perf/fix project and unit load times
Currently the endpoint that handles SAML authentication is named /auth/jwt. This endpoint still exists, and there is a new endpoint called /auth/saml2 which will eventually replace the former.
Moved copied /auth/jwt and /auth/saml2 logic into a seperate file with function
Copy link
Member

@jakerenzella jakerenzella 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 @sneaky-patriki, congrats on first PR - a quick small change

app/api/authentication_api.rb Show resolved Hide resolved
@macite
Copy link
Member

macite commented Mar 29, 2022

Hi @sneaky-patriki, Thanks for the PR. Can you make a small change? Move the AuthSaml to a "helper" - put it in app/helpers folder. Rename it and the file to AuthSamlHelper. Then you can include this in the authentication API like the authentication helper.

@jakerenzella
Copy link
Member

Just thinking @macite should we move into a helpers/auth dir? I think all the auth handlers could be brought out into their own file - AAF/SAML/database etc?

@macite
Copy link
Member

macite commented Mar 29, 2022

Yes that would be a good idea. Then that would clear up the API a lot...

@jakerenzella
Copy link
Member

@sneaky-patriki sorry as per my comment above can we get this into /helpers/auth/... then this looks good to approve

Change authsamlhelper class to module, mark as helper for and prefix
correctly
Remove import authsamlhelper since helpers are imported by default
@sneaky-patriki sneaky-patriki force-pushed the quality/change-saml-endpoint-name branch from 1460564 to 8aa1203 Compare April 15, 2022 09:01
@macite macite marked this pull request as draft April 27, 2024 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants