GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

No menu could be recovered. Follow the blue links in the page.

This view

  • Original page
  • New address

GeezerVison is showing elixir-auth-github.hexdocs.pm — ElixirAuthGithub — ElixirAuthGithub v1.6.6

ElixirAuthGithub
v1.6.6
  • Pages
  • Modules

    View Source ElixirAuthGithub (ElixirAuthGithub v1.6.6)

    ElixirAuthGithub is an Elixir package that handles all your GitHub OAuth needs so you can add "Sign in with GitHub" to any Elixir/Phoenix App.

    For all setup details, please see: https://github.com/dwyl/elixir-auth-github

    Link to this section Summary

    Functions

    client_id()

    client_id/0 returns a String of the GITHUB_CLIENT_ID e.g: "d6fca75c63daa014c187"

    client_secret()

    client_secret/0 returns a String of the GITHUB_CLIENT_SECRET e.g: "8eeb143935d1a505692aaef856db9b"

    github_auth(code)

    When called with a valid OAuth callback code, github_auth/1 makes a number of authentication requests to GitHub and returns a tuple with :ok and a map with GitHub user details and an access_token.

    inject_poison()

    inject_poison/0 injects a TestDouble of HTTPoison in Test so that we don't have duplicate mock in consuming apps. see: https://github.com/dwyl/elixir-auth-google/issues/35

    login_url()

    login_url/0 returns a String URL to be used as the initial OAuth redirect.

    login_url(map)

    Identical to login_url/0 except with an additional state and scope properties appended to the URL.

    Link to this section Functions

    Link to this function

    client_id()

    View Source

    client_id/0 returns a String of the GITHUB_CLIENT_ID e.g: "d6fca75c63daa014c187"

    Link to this function

    client_secret()

    View Source

    client_secret/0 returns a String of the GITHUB_CLIENT_SECRET e.g: "8eeb143935d1a505692aaef856db9b"

    Link to this function

    github_auth(code)

    View Source

    When called with a valid OAuth callback code, github_auth/1 makes a number of authentication requests to GitHub and returns a tuple with :ok and a map with GitHub user details and an access_token.

    Bad authentication codes will return a tuple with :error and an error map.

    Link to this function

    inject_poison()

    View Source

    inject_poison/0 injects a TestDouble of HTTPoison in Test so that we don't have duplicate mock in consuming apps. see: https://github.com/dwyl/elixir-auth-google/issues/35

    Link to this function

    login_url()

    View Source

    login_url/0 returns a String URL to be used as the initial OAuth redirect.

    Requires GITHUB_CLIENT_ID environment variable to be set. See step 2 of setup instructions.

    Link to this function

    login_url(map)

    View Source

    Identical to login_url/0 except with an additional state and scope properties appended to the URL.

    You are visitor 01402503 — GeezerVison does not store the pages you look up.
    Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.