https://github.com/is2ei/ueberauth_typetalk

Typetalk OAuth2 Strategy for Überauth
https://github.com/is2ei/ueberauth_typetalk

Last synced: about 1 month ago
JSON representation

Typetalk OAuth2 Strategy for Überauth

• Host: GitHub
• URL: https://github.com/is2ei/ueberauth_typetalk
• Owner: is2ei
• License: mit
• Created: 2019-02-04T14:29:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-06-30T02:47:18.000Z (almost 7 years ago)
• Last Synced: 2026-02-14T05:40:16.060Z (4 months ago)
• Language: Elixir
• Size: 37.1 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Überauth Typetalk

===

[![Build Status](https://travis-ci.com/is2ei/ueberauth_typetalk.svg?branch=master)][travis]

[![Codecov](https://codecov.io/gh/is2ei/ueberauth_typetalk/branch/master/graph/badge.svg)][codecov]

[![Hex Version](http://img.shields.io/hexpm/v/ueberauth_typetalk.svg)][hex]

[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg)][docs]

[travis]: https://travis-ci.com/is2ei/ueberauth_typetalk

[codecov]: https://codecov.io/gh/is2ei/ueberauth_typetalk

[hex]: https://hex.pm/packages/ueberauth_typetalk

[docs]: https://hexdocs.pm/ueberauth_typetalk

Typetalk OAuth2 Strategy for Überauth 

## Installation

1. Setup your application at [Typetalk Developer page](https://typetalk.com/my/develop/applications).

2. Add ueberauth_typetalk to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:ueberauth_typetalk, "~> 0.2"}]

end

```

3. Add the strategy to your applications:

```elixir

def application do

  [application: [:ueberauth_typetalk]]

end

```

4. Add Typetalk to your Überauth configuration:

```elixir

config :ueberauth, Ueberauth,

  providers: [

    typetalk: {Ueberauth.Strategy.Typetalk, []}

  ]

```

5. Update your provider configuration:

```elixir

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

  client_id: System.get_env("TYPETALK_CLIENT_ID")

  client_secret: System.get_env("TYPETALK_CLIENT_SECRET")

```

6. Include the Überauth plug in your controller:

```elixir

defmodule MyApp.AuthController do

  use MyApp.Web, :controller

  pipeline :browser do

    plug Ueberauth

    ...

  end

end

```

7. 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

```

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

For an example implementation see [the Example applciation](https://github.com/is2ei/ueberauth_typetalk_example).