Support the LINE login auth (#80)

* line provider
* require line provider
* spec
* fix response params
* set state
* fix spec

Author: sho ishihara

lib/generators/sorcery/templates/initializer.rb

@@ -77,7 +77,7 @@
 
   # -- external --
   # What providers are supported by this app
-  # i.e. [:twitter, :facebook, :github, :linkedin, :xing, :google, :liveid, :salesforce, :slack].
+  # i.e. [:twitter, :facebook, :github, :linkedin, :xing, :google, :liveid, :salesforce, :slack, :line].
   # Default: `[]`
   #
   # config.external_providers =
@@ -216,6 +216,10 @@
   # config.salesforce.scope = "full"
   # config.salesforce.user_info_mapping = {:email => "email"}
 
+  # config.line.key = ""
+  # config.line.secret = ""
+  # config.line.callback_url = "http://mydomain.com:3000/oauth/callback?provider=line"
+
   # --- user config ---
   config.user_config do |user|
     # -- core --

lib/sorcery/controller/submodules/external.rb

@@ -25,6 +25,7 @@ def self.included(base)
           require 'sorcery/providers/microsoft'
           require 'sorcery/providers/instagram'
           require 'sorcery/providers/auth0'
+          require 'sorcery/providers/line'
 
           Config.module_eval do
             class << self

lib/sorcery/providers/line.rb

@@ -0,0 +1,47 @@
+module Sorcery
+  module Providers
+    # This class adds support for OAuth with line.com.
+    #
+    #   config.line.key = <key>
+    #   config.line.secret = <secret>
+    #   ...
+    #
+    class Line < Base
+      include Protocols::Oauth2
+
+      attr_accessor :token_url, :user_info_path, :auth_path
+
+      def initialize
+        super
+
+        @site           = 'https://access.line.me'
+        @user_info_path = 'https://api.line.me/v2/profile'
+        @token_url      = 'https://api.line.me/v2/oauth/accessToken'
+        @auth_path      = 'dialog/oauth/weblogin'
+      end
+
+      def get_user_hash(access_token)
+        response = access_token.get(user_info_path)
+        auth_hash(access_token).tap do |h|
+          h[:user_info] = JSON.parse(response.body)
+          h[:uid] = h[:user_info]['userId'].to_s
+        end
+      end
+
+      # calculates and returns the url to which the user should be redirected,
+      # to get authenticated at the external provider's site.
+      def login_url(_params, _session)
+        @state = SecureRandom.hex(16)
+        authorize_url(authorize_url: auth_path)
+      end
+      # tries to login the user from access token
+      def process_callback(params, _session)
+        args = {}.tap do |a|
+          a[:code] = params[:code] if params[:code]
+        end
+
+        get_access_token(args, token_url: token_url, token_method: :post)
+      end
+    end
+  end
+end

spec/controllers/controller_oauth2_spec.rb

@@ -216,6 +216,7 @@
           microsoft
           instagram
           auth0
+          line
         ]
       )
 
@@ -257,6 +258,9 @@
       sorcery_controller_external_property_set(:auth0, :secret, 'XpbeSdCoaKSmQGSeokz5qcUATClRW5u08QWNfv71N8')
       sorcery_controller_external_property_set(:auth0, :callback_url, 'http://blabla.com')
       sorcery_controller_external_property_set(:auth0, :site, 'https://sorcery-test.auth0.com')
+      sorcery_controller_external_property_set(:line, :key, "eYVNBjBDi33aa9GkA3w")
+      sorcery_controller_external_property_set(:line, :secret, "XpbeSdCoaKSmQGSeokz5qcUATClRW5u08QWNfv71N8")
+      sorcery_controller_external_property_set(:line, :callback_url, "http://blabla.com")
     end
 
     after(:each) do
@@ -474,6 +478,7 @@ def set_external_property
         microsoft
         instagram
         auth0
+        line
       ]
     )
     sorcery_controller_external_property_set(:facebook, :key, 'eYVNBjBDi33aa9GkA3w')
@@ -513,6 +518,9 @@ def set_external_property
     sorcery_controller_external_property_set(:auth0, :secret, 'XpbeSdCoaKSmQGSeokz5qcUATClRW5u08QWNfv71N8')
     sorcery_controller_external_property_set(:auth0, :callback_url, 'http://blabla.com')
     sorcery_controller_external_property_set(:auth0, :site, 'https://sorcery-test.auth0.com')
+    sorcery_controller_external_property_set(:line, :key, "eYVNBjBDi33aa9GkA3w")
+    sorcery_controller_external_property_set(:line, :secret, "XpbeSdCoaKSmQGSeokz5qcUATClRW5u08QWNfv71N8")
+    sorcery_controller_external_property_set(:line, :callback_url, "http://blabla.com")
   end
 
   def provider_url(provider)

spec/rails_app/app/controllers/sorcery_controller.rb

@@ -142,6 +142,10 @@ def login_at_test_slack
     login_at(:slack)
   end
 
+  def login_at_test_line
+    login_at(:line)
+  end
+
   def login_at_test_with_state
     login_at(:facebook, state: 'bla')
   end
@@ -268,6 +272,14 @@ def test_login_from_auth0
     end
   end
 
+  def test_login_from_line
+    if @user = login_from(:line)
+      redirect_to 'bla', notice: 'Success!'
+    else
+      redirect_to 'blu', alert: 'Failed!'
+    end
+  end
+
   def test_return_to_with_external_twitter
     if (@user = login_from(:twitter))
       redirect_back_or_to 'bla', notice: 'Success!'
@@ -382,6 +394,14 @@ def test_return_to_with_external_auth0
     end
   end
 
+  def test_return_to_with_external_line
+    if @user = login_from(:line)
+      redirect_back_or_to 'bla', notice: 'Success!'
+    else
+      redirect_to 'blu', alert: 'Failed!'
+    end
+  end
+
   def test_create_from_provider
     provider = params[:provider]
     login_from(provider)

spec/rails_app/config/routes.rb

@@ -32,6 +32,7 @@
     get :test_login_from_slack
     get :test_login_from_instagram
     get :test_login_from_auth0
+    get :test_login_from_line
     get :login_at_test
     get :login_at_test_twitter
     get :login_at_test_facebook
@@ -47,6 +48,7 @@
     get :login_at_test_slack
     get :login_at_test_instagram
     get :login_at_test_auth0
+    get :login_at_test_line
     get :test_return_to_with_external
     get :test_return_to_with_external_twitter
     get :test_return_to_with_external_facebook
@@ -62,6 +64,7 @@
     get :test_return_to_with_external_slack
     get :test_return_to_with_external_instagram
     get :test_return_to_with_external_auth0
+    get :test_return_to_with_external_line
     get :test_http_basic_auth
     get :some_action_making_a_non_persisted_change_to_the_user
     post :test_login_with_remember