nextcloud / nextcloud/Android-SingleSignOn
Convenience features for `NextcloudRequest.Builder`
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 74
- Forks
- 36
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 17
Description
Issue
The following setup for a NextcloudRequest is quite verbose:
final var parameters = Collections.singleton(new QueryParam("foo", "bar"));
final var nextcloudRequest = new NextcloudRequest.Builder()
.setMethod("GET")
.setParameter(parameters)
.setUrl("/endpoint")
.build();
Especially for beginners, we should try to minimize the necessary boilerplate code to perform an actual request.
Proposal
Automatically parse QueryParams from the given URL
We could parse the QueryParams from the given URL and add them to our Collection (just as if .setParameter() would have been called). A working sample implementation (in Kotlin) is already in the nextcloud-commons library available.
final var nextcloudRequest = new NextcloudRequest.Builder()
.setMethod("GET")
.setParameter(parameters)
.setUrl("/endpoint?foo=bar")
.build();
Default method property to GET
It is the most often used HTTP verb and a natural choice to be preset (of course with keeping the possibility to override it):
final var parameters = Collections.singleton(new QueryParam("foo", "bar"));
final var nextcloudRequest = new NextcloudRequest.Builder()
.setParameter(parameters)
.setUrl("/endpoint")
.build();
Looking forward to some opinions 🙂
PS.: This issue has been split out of #266
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the NextcloudRequest.Builder implementation and inspect how setUrl, setParameter, and the HTTP method are stored before build(). Compare the requested URL parsing with the linked Kotlin sample, then verify that URL parameters are included, GET is the default, and an explicitly selected method still works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, java
- Domain
- mobile
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100