sorcery 0.9.1 → 0.10.0

data/lib/sorcery/providers/linkedin.rb

@@ -7,7 +7,6 @@ module Sorcery
     #   ...
     #
     class Linkedin < Base
-
       include Protocols::Oauth
 
       attr_accessor :authorize_path, :access_permissions, :access_token_path,
@@ -26,13 +25,13 @@ module Sorcery
       # Override included get_consumer method to provide authorize_path
       def get_consumer
         # Add access permissions to request token path
-        @configuration[:request_token_path] += '?scope=' + access_permissions.join('+') unless access_permissions.blank? or @configuration[:request_token_path].include? '?scope='
+        @configuration[:request_token_path] += '?scope=' + access_permissions.join('+') unless access_permissions.blank? || @configuration[:request_token_path].include?('?scope=')
         ::OAuth::Consumer.new(@key, @secret, @configuration)
       end
 
       def get_user_hash(access_token)
-        fields = self.user_info_fields.join(',')
-        response = access_token.get("#{@user_info_path}:(#{fields})", 'x-li-format' => 'json')
+        fields = user_info_fields.join(',')
+        response = access_token.get("#{@user_info_path}:(id,#{fields})", 'x-li-format' => 'json')
 
         auth_hash(access_token).tap do |h|
           h[:user_info] = JSON.parse(response.body)
@@ -42,11 +41,11 @@ module Sorcery
 
       # 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)
+      def login_url(_params, session)
         req_token = get_request_token
         session[:request_token]         = req_token.token
         session[:request_token_secret]  = req_token.secret
-        authorize_url({ request_token: req_token.token, request_token_secret: req_token.secret })
+        authorize_url(request_token: req_token.token, request_token_secret: req_token.secret)
       end
 
       # tries to login the user from access token
@@ -57,10 +56,9 @@ module Sorcery
           request_token_secret: session[:request_token_secret]
         }
 
-        args.merge!({ code: params[:code] }) if params[:code]
+        args[:code] = params[:code] if params[:code]
         get_access_token(args)
       end
-
     end
   end
 end

data/lib/sorcery/providers/liveid.rb

@@ -7,7 +7,6 @@ module Sorcery
     #   ...
     #
     class Liveid < Base
-
       include Protocols::Oauth2
 
       attr_accessor :auth_url, :token_path, :user_info_url, :scope
@@ -34,20 +33,18 @@ module Sorcery
 
       # 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)
-        self.authorize_url({ authorize_url: auth_url })
+      def login_url(_params, _session)
+        authorize_url(authorize_url: auth_url)
       end
 
       # tries to login the user from access token
-      def process_callback(params, session)
+      def process_callback(params, _session)
         args = {}.tap do |a|
           a[:code] = params[:code] if params[:code]
         end
 
-        get_access_token(args, access_token_path: token_path,
-          access_token_method: :post)
+        get_access_token(args, access_token_path: token_path, access_token_method: :post)
       end
-
     end
   end
 end

data/lib/sorcery/providers/paypal.rb

@@ -0,0 +1,60 @@
+module Sorcery
+  module Providers
+    # This class adds support for OAuth with paypal.com.
+    #
+    #   config.paypal.key = <key>
+    #   config.paypal.secret = <secret>
+    #   ...
+    #
+    class Paypal < Base
+      include Protocols::Oauth2
+
+      attr_accessor :auth_url, :scope, :token_url, :user_info_url
+
+      def initialize
+        super
+
+        @scope           = 'openid email'
+        @site            = 'https://api.paypal.com'
+        @auth_url        = 'https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize'
+        @user_info_url   = 'https://api.paypal.com/v1/identity/openidconnect/userinfo?schema=openid'
+        @token_url       = 'https://api.paypal.com/v1/identity/openidconnect/tokenservice'
+        @state           = SecureRandom.hex(16)
+      end
+
+      def get_user_hash(access_token)
+        response = access_token.get(user_info_url)
+        body = JSON.parse(response.body)
+        auth_hash(access_token).tap do |h|
+          h[:user_info] = body
+          h[:uid] = body['user_id']
+          h[:email] = body['email']
+        end
+      end
+
+      def get_access_token(args, options = {})
+        client = build_client(options)
+        client.auth_code.get_token(
+          args[:code],
+          {
+            redirect_uri: @callback_url,
+            parse: options.delete(:parse)
+          },
+          options
+        )
+      end
+
+      def login_url(_params, _session)
+        authorize_url(authorize_url: auth_url)
+      end
+
+      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

data/lib/sorcery/providers/salesforce.rb

@@ -7,7 +7,6 @@ module Sorcery
     #   ...
     #
     class Salesforce < Base
-
       include Protocols::Oauth2
 
       attr_accessor :auth_url, :token_url, :scope
@@ -32,19 +31,18 @@ module Sorcery
 
       # 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)
-        authorize_url({ authorize_url: auth_url })
+      def login_url(_params, _session)
+        authorize_url(authorize_url: auth_url)
       end
 
       # tries to login the user from access token
-      def process_callback(params, session)
+      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

data/lib/sorcery/providers/slack.rb

@@ -0,0 +1,45 @@
+module Sorcery
+  module Providers
+    # This class adds support for OAuth with slack.com.
+
+    class Slack < Base
+      include Protocols::Oauth2
+
+      attr_accessor :auth_path, :scope, :token_url, :user_info_path
+
+      def initialize
+        super
+
+        @scope          = 'identity.basic, identity.email'
+        @site           = 'https://slack.com/'
+        @user_info_path = 'https://slack.com/api/users.identity'
+        @auth_path      = '/oauth/authorize'
+        @token_url      = '/api/oauth.access'
+      end
+
+      def get_user_hash(access_token)
+        response = access_token.get(user_info_path, params: { token: access_token.token })
+        auth_hash(access_token).tap do |h|
+          h[:user_info] = JSON.parse(response.body)
+          h[:user_info]['email'] = h[:user_info]['user']['email']
+          h[:uid] = h[:user_info]['user']['id']
+        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)
+        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

data/lib/sorcery/providers/twitter.rb

@@ -7,7 +7,6 @@ module Sorcery
     #   ...
     #
     class Twitter < Base
-
       include Protocols::Oauth
 
       attr_accessor :state, :user_info_path
@@ -35,11 +34,11 @@ module Sorcery
 
       # 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)
-        req_token = self.get_request_token
+      def login_url(_params, session)
+        req_token = get_request_token
         session[:request_token]         = req_token.token
         session[:request_token_secret]  = req_token.secret
-        self.authorize_url({ request_token: req_token.token, request_token_secret: req_token.secret })
+        authorize_url(request_token: req_token.token, request_token_secret: req_token.secret)
       end
 
       # tries to login the user from access token
@@ -50,10 +49,9 @@ module Sorcery
           request_token_secret: session[:request_token_secret]
         }
 
-        args.merge!({ code: params[:code] }) if params[:code]
+        args[:code] = params[:code] if params[:code]
         get_access_token(args)
       end
-
     end
   end
 end

data/lib/sorcery/providers/vk.rb

@@ -7,7 +7,6 @@ module Sorcery
     #   ...
     #
     class Vk < Base
-
       include Protocols::Oauth2
 
       attr_accessor :auth_path, :token_path, :user_info_url, :scope
@@ -45,19 +44,18 @@ module Sorcery
 
       # 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)
-        self.authorize_url({ authorize_url: auth_path })
+      def login_url(_params, _session)
+        authorize_url(authorize_url: auth_path)
       end
 
       # tries to login the user from access token
-      def process_callback(params, session)
+      def process_callback(params, _session)
         args = {}.tap do |a|
           a[:code] = params[:code] if params[:code]
         end
 
         get_access_token(args, token_url: token_path, token_method: :post)
       end
-
     end
   end
 end

data/lib/sorcery/providers/wechat.rb

@@ -0,0 +1,79 @@
+module Sorcery
+  module Providers
+    # This class adds support for OAuth with open.wx.qq.com.
+    #
+    #   config.wechat.key = <key>
+    #   config.wechat.secret = <secret>
+    #   ...
+    #
+    class Wechat < Base
+      include Protocols::Oauth2
+
+      attr_reader   :mode, :param_name, :parse
+      attr_accessor :auth_url, :scope, :token_url, :user_info_path
+
+      def initialize
+        super
+
+        @scope = 'snsapi_login'
+        @auth_url = 'https://open.weixin.qq.com/connect/qrconnect'
+        @user_info_path = 'https://api.weixin.qq.com/sns/userinfo'
+        @token_url = 'https://api.weixin.qq.com/sns/oauth2/access_token'
+        @state = SecureRandom.hex(16)
+        @mode = :body
+        @parse = :json
+        @param_name = 'access_token'
+      end
+
+      def authorize_url(options = {})
+        oauth_params = {
+          appid: @key,
+          redirect_uri: @callback_url,
+          response_type: 'code',
+          scope: scope,
+          state: @state
+        }
+        "#{options[:authorize_url]}?#{oauth_params.to_query}#wechat_redirect"
+      end
+
+      def get_user_hash(access_token)
+        response = access_token.get(user_info_path, params: {
+          access_token: access_token.token,
+          openid: access_token.params['openid'],
+        })
+
+        {}.tap do |h|
+          h[:user_info] = JSON.parse(response.body)
+          h[:uid] = h[:user_info]['unionid']
+        end
+      end
+
+      def get_access_token(args, options = {})
+        client = build_client(options)
+        client.auth_code.get_token(
+          args[:code],
+          { appid: @key, secret: @secret, parse: parse },
+          options
+        )
+      end
+
+      def login_url(_params, _session)
+        authorize_url authorize_url: auth_url
+      end
+
+      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,
+          mode: mode,
+          param_name: param_name,
+        )
+      end
+    end
+  end
+end
+

data/lib/sorcery/providers/xing.rb

@@ -7,19 +7,17 @@ module Sorcery
     #   ...
     #
     class Xing < Base
-
       include Protocols::Oauth
 
       attr_accessor :access_token_path, :authorize_path, :request_token_path,
                     :user_info_path
 
-
       def initialize
         @configuration = {
-            site: 'https://api.xing.com/v1',
-            authorize_path: '/authorize',
-            request_token_path: '/request_token',
-            access_token_path: '/access_token'
+          site: 'https://api.xing.com/v1',
+          authorize_path: '/authorize',
+          request_token_path: '/request_token',
+          access_token_path: '/access_token'
         }
         @user_info_path = '/users/me'
       end
@@ -40,11 +38,11 @@ module Sorcery
 
       # 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)
+      def login_url(_params, session)
         req_token = get_request_token
         session[:request_token]         = req_token.token
         session[:request_token_secret]  = req_token.secret
-        authorize_url({ request_token: req_token.token, request_token_secret: req_token.secret })
+        authorize_url(request_token: req_token.token, request_token_secret: req_token.secret)
       end
 
       # tries to login the user from access token
@@ -55,10 +53,9 @@ module Sorcery
           request_token_secret: session[:request_token_secret]
         }
 
-        args.merge!({ code: params[:code] }) if params[:code]
+        args[:code] = params[:code] if params[:code]
         get_access_token(args)
       end
-
     end
   end
 end

data/lib/sorcery/test_helpers/internal.rb

@@ -3,7 +3,7 @@ module Sorcery
     # Internal TestHelpers are used to test the gem, internally, and should not be used to test apps *using* sorcery.
     # This file will be included in the spec_helper file.
     module Internal
-      def self.included(base)
+      def self.included(_base)
         # reducing default cost for specs speed
         CryptoProviders::BCrypt.class_eval do
           class << self
@@ -24,31 +24,31 @@ module Sorcery
       end
 
       def build_new_user(attributes_hash = nil)
-        user_attributes_hash = attributes_hash || {:username => 'gizmo', :email => "bla@bla.com", :password => 'secret'}
+        user_attributes_hash = attributes_hash || { username: 'gizmo', email: 'bla@bla.com', password: 'secret' }
         @user = User.new(user_attributes_hash)
       end
 
       def create_new_user(attributes_hash = nil)
         @user = build_new_user(attributes_hash)
-        @user.sorcery_adapter.save(:raise_on_failure => true)
+        @user.sorcery_adapter.save(raise_on_failure: true)
         @user
       end
 
       def create_new_external_user(provider, attributes_hash = nil)
-        user_attributes_hash = attributes_hash || {:username => 'gizmo'}
+        user_attributes_hash = attributes_hash || { username: 'gizmo' }
         @user = User.new(user_attributes_hash)
-        @user.sorcery_adapter.save(:raise_on_failure => true)
-        @user.authentications.create!({:provider => provider, :uid => 123})
+        @user.sorcery_adapter.save(raise_on_failure: true)
+        @user.authentications.create!(provider: provider, uid: 123)
         @user
       end
 
       def custom_create_new_external_user(provider, authentication_class, attributes_hash = nil)
         authentication_association = authentication_class.name.underscore.pluralize
 
-        user_attributes_hash = attributes_hash || {:username => 'gizmo'}
+        user_attributes_hash = attributes_hash || { username: 'gizmo' }
         @user = User.new(user_attributes_hash)
-        @user.sorcery_adapter.save(:raise_on_failure => true)
-        @user.send(authentication_association).create!({:provider => provider, :uid => 123})
+        @user.sorcery_adapter.save(raise_on_failure: true)
+        @user.send(authentication_association).create!(provider: provider, uid: 123)
         @user
       end
 
@@ -67,7 +67,7 @@ module Sorcery
       # reload user class between specs
       # so it will be possible to test the different submodules in isolation
       def reload_user_class
-        Object.send(:remove_const, "User")
+        Object.send(:remove_const, 'User')
         load 'user.rb'
         if User.respond_to?(:reset_column_information)
           User.reset_column_information