Add Gists API

[XAMPPRocky]

No description provided.

[envp]

@XAMPPRocky is there still interest in reviewing a contribution for this?

[XAMPPRocky]

@envp Contibutions are always welcome and encouraged 🙂

[envp]

@envp Contibutions are always welcome and encouraged 🙂

Thanks! I've made a couple of PRs to familiarize myself.

[envp]

I've tried to tabulate what the TODOs would be acc to GitHub API docs (API Version 2022-11-28)

• Create a gist (POST /gists)
• Get a gist (GET /gists/{gist_id})
• Update a gist (PATCH /gists/{gist_id})
• List gist commits (GET /gists/{gist_id}/commits)
• Get a gist revision (GET /gists/{gist_id}/{sha})
• List gists for authenticated user (GET /gists) (current: Add CurrentAuthHandler::list_gists_for_authenticated_user #328)
• Star a gist (PUT /gists/{gist_id}/star) (gists+examples: Extend GistsHandler through star(...), unstar(...), is_starred(...) #330)
• Unstar a gist (DELETE /gists/{gist_id}/star) (gists+examples: Extend GistsHandler through star(...), unstar(...), is_starred(...) #330)
• Check if a gist is starred (GET /gists/{gist_id}/star) (gists+examples: Extend GistsHandler through star(...), unstar(...), is_starred(...) #330)
• Delete a gist (DELETE /gists/{gist_id}) (Handle DELETE /gists/{gist_id} #333)
• List gist forks (GET /gists/{gist_id}/forks) (gists: Handle fork related operations #339)
• Fork a gist (POST /gists/{gist_id}/forks) (gists: Handle fork related operations #339)
• List starred gists (GET /gists/starred) (current: Handle GET /gists/starred #340)
• List gists for a user (GET /users/{username}/gists) (Gists API: Complete support #371)
• List all public gists (GET /gists) (Gists API: Complete support #371)
• List public gists (GET /gists/public) (Gists API: Complete support #371)

let me know if I missed something.

[envp]

@XAMPPRocky Some of github's APIs (e.g PUT /gists/{gist_id}/star) return an empty response body on success, these can't be deserialized with the current FromResponse trait which assumes there's always valid JSON.

I tried implementing FromResponse for () so callers can ask to discard the response body. However, that conflicts with the current implementation. WDYT is a good way to handle this?

[XAMPPRocky]

@envp There are other parts of the API that do that, in general for those you should use the _ prefixed versions in the Octocrab client like _put that do no processing on the response.

[envp]

@XAMPPRocky Not sure how important these three are. I personally don't have a use-case for the bulk gist retrival endpoints (GET /gists[/public]). And GET /users/{username}/gists seems to (slightly) overlap with the endpoint for retrieving the authenticated user's gists.

List gists for a user (GET /users/{username}/gists)
List all public gists (GET /gists)
List public gists (GET /gists/public)

Will continue on these if you think they're useful to have. Thanks again :)

[XAMPPRocky]

Will continue on these if you think they're useful to have.

In general the goal of the project is to support as much of GitHub's API as possible, so adding support for these APIs is always useful and appreciated if you want to contribute them. 🙂