https://github.com/svycal/ueberauth_stripe

Stripe OAuth2 Strategy for Überauth
https://github.com/svycal/ueberauth_stripe

elixir oauth2 stripe

Last synced: about 1 month ago
JSON representation

Stripe OAuth2 Strategy for Überauth

• Host: GitHub
• URL: https://github.com/svycal/ueberauth_stripe
• Owner: svycal
• License: other
• Created: 2021-11-08T21:38:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-10T00:52:26.000Z (over 2 years ago)
• Last Synced: 2024-11-30T22:50:01.877Z (about 2 months ago)
• Topics: elixir, oauth2, stripe
• Language: Elixir
• Homepage: https://hexdocs.pm/ueberauth_stripe
• Size: 26.4 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Überauth Stripe [![Hex Version](https://img.shields.io/hexpm/v/ueberauth_stripe.svg)](https://hex.pm/packages/ueberauth_stripe)

> Stripe OAuth2 strategy for Überauth.

## Installation

1. Setup your application in your Stripe extension settings.

1. Add `:ueberauth_stripe` to your list of dependencies in `mix.exs`:

    ```elixir

    def deps do

      [{:ueberauth_stripe, "~> 0.2.0"}]

    end

    ```

1. Add Stripe to your Überauth configuration:

    ```elixir

    config :ueberauth, Ueberauth,

      providers: [

        stripe: {Ueberauth.Strategy.Stripe, []}

      ]

    ```

1.  Update your provider configuration:

    Use that if you want to read client ID/secret from the environment

    variables in the compile time:

    ```elixir

    config :ueberauth, Ueberauth.Strategy.Stripe.OAuth,

      client_id: System.get_env("STRIPE_CLIENT_ID"),

      client_secret: System.get_env("STRIPE_CLIENT_SECRET")

    ```

    Use that if you want to read client ID/secret from the environment

    variables in the run time:

    ```elixir

    config :ueberauth, Ueberauth.Strategy.Stripe.OAuth,

      client_id: {System, :get_env, ["STRIPE_CLIENT_ID"]},

      client_secret: {System, :get_env, ["STRIPE_CLIENT_SECRET"]}

    ```

1.  Include the Überauth plug in your controller:

    ```elixir

    defmodule MyApp.AuthController do

      use MyApp.Web, :controller

      plug Ueberauth

      ...

    end

    ```

1.  Create the request and callback routes if you haven't already:

    ```elixir

    scope "/auth", MyApp do

      pipe_through :browser

      get "/:provider", AuthController, :request

      get "/:provider/callback", AuthController, :callback

    end

    ```

1. Your controller needs to implement callbacks to deal with `Ueberauth.Auth` and `Ueberauth.Failure` responses.

For an example implementation see the [Überauth Example](https://github.com/ueberauth/ueberauth_example) application.

## Calling

Depending on the configured url you can initiate the request through:

    /auth/stripe

    

## License

Please see [LICENSE](https://github.com/svycal/ueberauth_stripe/blob/main/LICENSE.md) for licensing details.