Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shmokmt/omniauth-line

Fork of https://github.com/kazasiki/omniauth-line
https://github.com/shmokmt/omniauth-line

Last synced: 9 days ago
JSON representation

Fork of https://github.com/kazasiki/omniauth-line

Awesome Lists containing this project

README

        

# OmniAuth Line
[![test](https://github.com/shmokmt/omniauth-line/actions/workflows/ruby.yml/badge.svg)](https://github.com/shmokmt/omniauth-line/actions/workflows/ruby.yml)

This gem contains the Line OAuth2 Strategy for OmniAuth.

Supports the OpenID Connect Web Login. Read the Line developers docs for more details: https://developers.line.me/en/docs/line-login/web/integrate-line-login/

## Using This Strategy

First start by adding this gem to your Gemfile:

```ruby
gem 'omniauth-line', :github => 'shmokmt/omniauth-line'
```

Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:

```ruby
# PROFILE permission required!!
Rails.application.config.middleware.use OmniAuth::Builder do
provider :line, "Channel_ID", "Channel_Secret"
end
```

## Authentication Hash
An example auth hash available in `request.env['omniauth.auth']`:

```ruby
{
:provider => "line",
:uid => "a123b4....",
:info => {
:name => "yamada tarou",
:image => "http://dl.profile.line.naver.jp/xxxxx",
:description => "breakfast now.",
},
:credentials => {
:token => "a1b2c3d4...", # The OAuth 2.0 access token
:secret => "abcdef1234"
},
:extra => {
# nil
}
}
```

## Supported Rubies

OmniAuth Line is tested under 2.7 and 3.0.