Update scopes used in OAuth #382
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- makes all scope parameters in OAuth and App methods optional. Endpoints not receiving a scope parameter will default to granting "read" permission. - removes default parameter value from Scope constructor. Users will need to define a certain scope if they want to use it. Closes andregasser#116. - adds all scopes as defined by Mastodon, marks existing scopes FOLLOW and ALL as deprecated. - removes all internal usage of the now deprecated ALL scope. Closes andregasser#143. - moves deduplication of scopes from a separate function into the one building the parameter string. This avoids unnecessarily throwing an IllegalArgumentException. Closes andregasser#381.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #382 +/- ##
============================================
+ Coverage 48.08% 48.33% +0.25%
+ Complexity 542 541 -1
============================================
Files 140 140
Lines 3864 3906 +42
Branches 256 259 +3
============================================
+ Hits 1858 1888 +30
- Misses 1816 1825 +9
- Partials 190 193 +3
|
PattaFeuFeu
added
enhancement
PattaFeuFeu
reviewed
Dec 8, 2023
bigbone/src/integrationTest/kotlin/social/bigbone/v300/V300StatusMethodsIntegrationTest.kt
Outdated
Show resolved
Hide resolved
bigbone/src/test/kotlin/social/bigbone/api/method/AppMethodsTest.kt
Outdated
Show resolved
Hide resolved
andregasser
reviewed
Dec 9, 2023
andregasser
previously requested changes
Dec 9, 2023
- in integration tests, declare "full scope" once - in unit tests, do not specify any Scope unless directly tested - remove deprecated "follow" scope from the access token asset
…token match those in OAuth URL.
This was referenced Dec 10, 2023
- replace Name enum with hierarchical structure for a more intuitive access to individual scopes - changing samples and USAGE.md to match Examples: - Scope(Scope.Name.READ) becomes Scope(Scope.READ.ALL) - Scope(Scope.Name.ADMIN_READ_ACCOUNTS) becomes Scope(Scope.ADMIN.READ.ACCOUNTS)
PattaFeuFeu
dismissed
andregasser’s stale review
scopes query parameter is correct, @bocops added a comment to code explaining what’s happening
PattaFeuFeu
approved these changes
Dec 15, 2023
Bumps com.gradle.enterprise from 3.15.1 to 3.16. --- updated-dependencies: - dependency-name: com.gradle.enterprise dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
PattaFeuFeu
approved these changes
Dec 15, 2023
|
@bocops Merged! Thanks for the efforts 🚀 Could you please make sure that other PRs that may no longer be necessary after these changes are closed? You’ve already linked the affected issues, so those should be fine I assume? |
|
Looks good regarding issues, thanks! @andregasser the only remaining PR in this area is your #119 - I think that is no longer necessary. Can you close it as time permits? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
makes all scope parameters in OAuth and App methods optional. Endpoints not receiving a scope parameter will default to granting "read" permission.
removes default parameter value from Scope constructor. Users will need to define a certain scope if they want to use it. Closes Align scope defaults with Mastodon API #116.
adds all scopes as defined by Mastodon, marks existing scopes FOLLOW and ALL as deprecated.
removes all internal usage of the now deprecated ALL scope. Closes Update OAuth scopes #143.
moves deduplication of scopes from a separate function into the one building the parameter string. This avoids unnecessarily throwing an IllegalArgumentException. Closes Change scope validation to avoid throwing IllegalArgumentException #381.
Type of Change
Breaking Changes
Scope.NAMEenum has been replaced with hierarchically arranged scope definitions in the class. Example:Scope.Name.READbecomesScope.READ.ALLFOLLOWscope has been removed. Use individual child scopes ofREADandWRITEinstead.ALLscope has been removed. Use individual scopes necessary for your use case instead.How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Mandatory Checklist
gradle checkand there were no errors reported