bugfix: revise search algorithm for GitHub token

[prjemian]

• FIX Unit test for GitHub token fails when specific file name is provided #156

[prjemian]

@carterbox This is ready for review.

[carterbox]

Wow, this function has gotten pretty complicated! 😆

What if the search order is in order of user-controlled to developer-controlled because this function is not part of the public API? Or the opposite ordering?

^ more user-y
GH_TOKEN
GITHUB_TOKEN
~/.config/__github_creds__.txt
~/.config/punx/__github_creds__.txt
creds_file_name This is the optional parameter; it is a path to any arbitrarily named text tile.
[punx source directory]/__github_creds__.txt
v more developer-y

[prjemian]

I agree this is too complicated. Can we simplify to require only either of the two environment variables?

[carterbox]

Do you mean the search order would be:

GH_TOKEN
GITHUB_TOKEN

and the function would take no parameters? Sounds good to me.

[prjemian]

Yes

…

On Fri, Nov 5, 2021, 2:51 PM Daniel Ching ***@***.***> wrote: Do you mean the search order would be: GH_TOKEN GITHUB_TOKEN and the function would take no parameters? Sounds good to me. — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#157 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AARMUMCNH2UJZR4NWRNYHX3UKQ7UFANCNFSM5HM5GK7Q> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

[prjemian]

Now, still returns None if token not found but also issues a warning (that appears in the CI workflow):

================================================================== warnings summary ==================================================================
punx/tests/test_github_handler.py::test_connect_repo
punx/tests/test_github_handler.py::test_connected_GitHub_Repository_Reference
punx/tests/test_github_handler.py::test_Github_download_default
  /home/prjemian/Documents/projects/prjemian/punx/punx/github_handler.py:80: UserWarning: Did not find environment variables GH_TOKEN or GITHUB_TOKEN
    warnings.warn(

-- Docs: https://docs.pytest.org/en/stable/warnings.html
=========================================================== 8 passed, 3 warnings in 0.87s ============================================================

[prjemian]

@carterbox - Docs will be modified if you agree on this approach.

[carterbox]

I agree with the approach overall. Comments about warning implementation below.

[prjemian]

@carterbox Thanks for the review. Feel free to merge and delete the branch.