Adding utility functions for GitHub App #108

Mariatta · 2020-03-27T19:39:17Z

add get_jwt
add get_installation_access_token
add PyJWT and cryptography dependencies, needed to construct JWT

Hoping for inclusion in 4.1.0, and to get early feedback

Closes #71

Mariatta · 2020-03-27T22:09:20Z

I'm planning to prepare an online GitHub App tutorial and I'm kinda wanting for this to be included to gidgethub in time before I record the tutorial. I will try to find time to write the tests this weekend.

- add get_jwt - add get_installation_access_token - add PyJWT and cryptography dependencies, needed to construct JWT Hoping for inclusion in 4.1.0 Closes gidgethub#71

Black formatting

Mariatta · 2020-04-17T00:26:40Z

If possible I'd like to have this released soon.

I need this functionality for MY PyCon tutorial that is due onApril 24. (But it would be great if I can record my tutorial this weekend 🙏🏻)

brettcannon

A bunch of little things I trust you to touch up before merging. 😄

docs/app.rst

brettcannon · 2020-04-17T21:33:30Z

gidgethub/app.py

+
+async def get_installation_access_token(
+    gh: GitHubAPI, *, installation_id: str, app_id: str, private_key: str
+) -> Any:


Since this is calling a specific endpoint that has an expected value, maybe we should type this as Dict[str, str]?

This returns whatever gh.post returns, which is Any. When I tried to change this to Dict[str, str], it complained because it doesn't match gh.post's return type.

Yeah, you probably would have to cast it.

tests/test_app.py

brettcannon · 2020-04-17T21:40:54Z

BTW once you get this landed and the release out I want to set this project up on github.com/brettcannon/release-often so that we automate releases. 😁 (I would do it now but I haven't tested it against a flit project yet and I don't want to hold you up for your tutorial.)

Co-Authored-By: Brett Cannon <[email protected]>

Mariatta · 2020-04-18T19:18:56Z

gidgethub/app.py

+from gidgethub.abc import GitHubAPI
+
+
+def get_jwt(*, app_id: str, private_key: str) -> str:


I realized that there are other endpoints that require JWT, so I changed this from private to public. I've also adjusted the documentation.

Mariatta · 2020-04-18T19:20:28Z

tests/test_app.py

+import pytest
+
+from gidgethub import (
+    app as gh_app,


For some reason app is clashing with pytest-tornasync fixture, so I had to rename this to gh_app in tests.
I could also call the module apps instead of app if that's better? (just like actions with s)

Naming it 'apps' is fine by me.

Mariatta · 2020-04-18T19:21:15Z

@brettcannon mind re-reviewing one last time? I made get_jwt public and added it to the documentation.

brettcannon · 2020-04-18T21:48:46Z

gidgethub/app.py

+    """Obtain a GitHub App's installation access token.
+
+
+    Return a dictionary containing access token and expiration time.
+
+    Doc: https://developer.github.com/v3/apps/#create-a-new-installation-token


Suggested change

"""Obtain a GitHub App's installation access token.

Return a dictionary containing access token and expiration time.

Doc: https://developer.github.com/v3/apps/#create-a-new-installation-token

"""Obtain a GitHub App's installation access token.

Returns a dictionary containing access token and expiration time

(https://developer.github.com/v3/apps/#create-a-new-installation-token).

webknjaz · 2020-04-19T06:52:51Z

pyproject.toml

+requires = [
+    "uritemplate>=3.0.1",
+    "PyJWT>=1.7.1",
+    "cryptography>=2.9"


It's not a direct dependency, why do you specify it here?

webknjaz · 2020-04-19T06:53:57Z

pyproject.toml

-requires = ["uritemplate>=3.0.1"]
+requires = [
+    "uritemplate>=3.0.1",
+    "PyJWT>=1.7.1",


It should've been PyJWT[crypto] as per their docs:

I opened #116 to track this.

webknjaz · 2020-04-19T06:59:44Z

gidgethub/apps.py

+from gidgethub.abc import GitHubAPI
+
+
+def get_jwt(*, app_id: str, private_key: str) -> str:


In octomachinery, I used to have it as a function but then I implemented an object that represents a private key with fingerprint pinning and it turned out that it's handy to have it as a method:
https://github.com/sanitizers/octomachinery/blob/6b41c1df510f8bbf090ea290941261396e2cb559/octomachinery/github/models/private_key.py

Mariatta force-pushed the issue-71 branch 2 times, most recently from 4193ec9 to 457776d Compare April 16, 2020 22:14

Mariatta added 3 commits April 16, 2020 15:16

Adding utility functions for GitHub App

c7c86a5

- add get_jwt - add get_installation_access_token - add PyJWT and cryptography dependencies, needed to construct JWT Hoping for inclusion in 4.1.0 Closes gidgethub#71

Pin the pyjwt and cryptography versions

490e288

Black formatting

Write tests, documentation, and changelog entry.

5c332e2

Mariatta force-pushed the issue-71 branch from 457776d to 5c332e2 Compare April 16, 2020 22:17

Mariatta added 3 commits April 16, 2020 15:18

Adjust comment about copied test rsa key file

7551680

Fix tests

75a493f

Fix typo in the word Introduce

9fa267b

Mariatta marked this pull request as ready for review April 16, 2020 23:00

Mariatta added 2 commits April 16, 2020 17:19

add app documentation

5b0a1c4

put back removed empty line

9f35c2f

Mariatta requested a review from brettcannon April 17, 2020 00:22

brettcannon approved these changes Apr 17, 2020

View reviewed changes

Mariatta and others added 5 commits April 17, 2020 14:55

Update docs/app.rst

95ea2e5

Co-Authored-By: Brett Cannon <[email protected]>

Update app.rst

1235ae7

Make get_jwt public and add the documentation. Improve unittests.

1ef481b

app is clashing with pytest-tornasync's app fixture

9454ebf

Fix lint

cce20ad

Mariatta commented Apr 18, 2020

View reviewed changes

brettcannon approved these changes Apr 18, 2020

View reviewed changes

Mariatta added 2 commits April 18, 2020 21:09

Rename app to apps

956264f

Rename app to apps

d04a4d1

Mariatta merged commit 5a7bcf1 into gidgethub:master Apr 19, 2020

Mariatta deleted the issue-71 branch April 19, 2020 04:21

webknjaz reviewed Apr 19, 2020

View reviewed changes

brettcannon mentioned this pull request Apr 19, 2020

Specify PyJWT[crypto] as a dependency #116

Closed

		from gidgethub.abc import GitHubAPI


		def get_jwt(*, app_id: str, private_key: str) -> str:

Uh oh!

Adding utility functions for GitHub App #108

Adding utility functions for GitHub App #108

Uh oh!

Conversation

Mariatta commented Mar 27, 2020

Uh oh!

Mariatta commented Mar 27, 2020

Uh oh!

Mariatta commented Apr 17, 2020

Uh oh!

brettcannon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brettcannon commented Apr 17, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mariatta commented Apr 18, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants