Update Docs issue #32

[nelsonic]

This PR is meant to bring this package in-line with https://github.com/dwyl/elixir-auth-google

I've simplified the code by removing a bunch of functions that do not appear to be invoked by any of the @dwyl projects using this package. Cut the codebase in half without loss of functionality. ✂️ Introduced environment variables, refactored a few functions and simplified the tests. 👨‍💻

• [x] Tidy up package code and update Docs. #32
• [x] Add pure HTML + CSS (+ SVG) "Sign in with GitHub" button #33
• [x] Use environment variables to avoid potential security issue. #35
• [x] Remove "admin" scopes from list of @valid_scopes because we aren't using them. #36
• [x] Remove false positive filter_valid_scopes/1 #37
• [x] Remove unused login_url_with_scope/2 function #38
• [x] Remove unused github_auth/2 function #39

Read: https://github.com/dwyl/elixir-auth-github/tree/update-docs-issue%2332 Hex.pm: https://hex.pm/packages/elixir_auth_github Heroku Demo: https://elixir-auth-github-demo.herokuapp.com

[codecov[bot]]

Codecov Report

Merging #34 into master will not change coverage. The diff coverage is 100%.

@@          Coverage Diff          @@
##           master    #34   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           1      1           
  Lines          21     11   -10     
=====================================
- Hits           21     11   -10

Impacted Files	Coverage Δ
lib/elixir_auth_github.ex	100% <100%> (ø)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 4402123...8d0f73c. Read the comment docs.

[nelsonic]

Published a new version of the package: https://hex.pm/packages/elixir_auth_github

Going to use it to create: https://github.com/dwyl/elixir-auth-github-demo

[nelsonic]

Hi @SimonLab / @iteles! 👋 When you get back to your desks next week, please take a look at this PR. As stated above, my goal is to make this package as similar to our Google Auth plugin, such that there is consistency and maintainability across our Auth packages. I'm keen to use GitHub Auth in the App (and for @home ...) so I really wanted to get this done! Please let me know your thoughts. Thanks! ☀️

[nelsonic]

I went on a "side-quest" to re-make the button using SVG+CSS: https://github.com/dwyl/elixir-auth-github/issues/33 👨‍💻

Since the text/copy of the button is now just text in standard HTML, the user's web browser can automatically translate it! e.g: French 🇬🇧 > 🇫🇷 This is much better UX for the 80% of people in the world who do not speak English fluently. The single biggest engine for growth in startup companies is translating their interface into more languages. 📈

[nelsonic]

before: https://github.com/dwyl/elixir-auth-github/tree/44021233add025348f261f5bf0b9b32fe6c5711a after: https://github.com/dwyl/elixir-auth-github/tree/update-docs-issue%2332

[nelsonic]

@iteles this is an example of refactoring a project and updating the docs. ♻️ I don't know if many beginners would be comfortable doing this kind of thing. 💭 But I do hope that beginners can use the package and build their own apps with it. 👍 Thanks for reviewing. ❤️

@SimonLab over to you when you get back online. 🇧🇪 🙌