sorcery 0.7.4 → 0.7.5

data/Gemfile.lock

@@ -61,7 +61,7 @@ GEM
     oauth2 (0.4.1)
       faraday (~> 0.6.1)
       multi_json (>= 0.0.5)
-    polyglot (0.3.2)
+    polyglot (0.3.3)
     rack (1.3.5)
     rack-cache (1.1)
       rack (>= 0.4)
@@ -129,7 +129,7 @@ GEM
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.30)
+    tzinfo (0.3.31)
     yard (0.6.8)
 
 PLATFORMS

data/README.rdoc

@@ -28,7 +28,7 @@ Railscast: http://railscasts.com/episodes/283-authentication-with-sorcery
 
 Example Rails 3 app using sorcery: https://github.com/NoamB/sorcery-example-app
 
-Documentation: http://rubydoc.info/gems/sorcery/0.7.4/frames
+Documentation: http://rubydoc.info/gems/sorcery/0.7.5/frames
 
 Check out the tutorials in the github wiki!
 

data/VERSION

@@ -1 +1 @@
-0.7.4
+0.7.5

data/lib/generators/sorcery/install_generator.rb

@@ -39,6 +39,9 @@ module Sorcery
 
       # Copy the migrations files to db/migrate folder
       def copy_migration_files
+        # Copy core migration file in all cases except when you pass --migrations.
+        migration_template "migration/core.rb", "db/migrate/sorcery_core.rb" unless options[:migrations]
+
         if submodules
           submodules.each do |submodule|
             unless submodule == "http_basic_auth" || submodule == "session_timeout"
@@ -47,8 +50,7 @@ module Sorcery
           end
         end
         
-        # Copy core migration file in all cases except when you pass --migrations.
-        migration_template "migration/core.rb", "db/migrate/sorcery_core.rb" unless options[:migrations]
+
       end
       
       # Define the next_migration_number method (necessary for the migration_template method to work)
@@ -69,4 +71,4 @@ module Sorcery
       end
     end
   end
-end
+end

data/lib/generators/sorcery/templates/initializer.rb

@@ -29,19 +29,22 @@ Rails.application.config.sorcery.configure do |config|
   # -- http_basic_auth --
   # config.controller_to_realm_map = {"application" => "Application"} # What realm to display for which controller name.
                                                                       # For example {"My App" => "Application"}
-  
+
   # -- activity logging --
   # config.register_login_time = true                                 # will register the time of last user login, every login.
   # config.register_logout_time = true                                # will register the time of last user logout, every logout.
   # config.register_last_activity_time = true                         # will register the time of last user action, every action.
-                                                                                                                                          
+
   # -- external --
   # config.external_providers = []                                    # What providers are supported by this app,
-                                                                      # i.e. [:twitter, :facebook, :github] .
+                                                                      # i.e. [:twitter, :facebook, :github, :google, :liveid] .
   # config.ca_file = 'path/to/ca_file'                                # Path to ca_file. By default use a internal ca-bundle.crt.
                                                                       # You can change it by your local ca_file.
                                                                       # i.e. '/etc/pki/tls/certs/ca-bundle.crt'
 
+  # Twitter wil not accept any requests nor redirect uri containing localhost,
+  # make sure you use 0.0.0.0:3000 to access your app in development
+  #
   # config.twitter.key = "eYVNBjBDi33aa9GkA3w"
   # config.twitter.secret = "XpbeSdCoaKSmQGSeokz5qcUATClRW5u08QWNfv71N8"
   # config.twitter.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=twitter"
@@ -56,6 +59,20 @@ Rails.application.config.sorcery.configure do |config|
   # config.github.secret = ""
   # config.github.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=github"
   # config.github.user_info_mapping = {:email => "name"}
+  #
+  # config.google.key = "491253340633.apps.googleusercontent.com"
+  # config.google.secret = "4oE6kXqbL_LN-VGcGcg7qgdL"
+  # config.google.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=google"
+  # config.google.user_info_mapping = {:email => "email", :username => "name"}
+  #
+  # To use liveid in development mode you have to replace mydomain.com with
+  # a valid domain even in development. To use a valid domain in development
+  # simply add your domain in your /etc/hosts file in front of 127.0.0.1
+  #
+  # config.liveid.key = ""
+  # config.liveid.secret = ""
+  # config.liveid.callback_url = "http://mydomain.com:3000/oauth/callback?provider=liveid"
+  # config.liveid.user_info_mapping = {:username => "name"}
 
   # --- user config ---
   config.user_config do |user|
@@ -69,6 +86,10 @@ Rails.application.config.sorcery.configure do |config|
                                                                                       # until an encrypted one is
                                                                                       # generated.
 
+    # user.downcase_username_before_authenticating = false                            # downcase the username before 
+                                                                                      # trying to authenticate, default
+                                                                                      # is false
+
     # user.email_attribute_name = :email                                              # change default email attribute.
 
     # user.crypted_password_attribute_name =  :crypted_password                       # change default crypted_password
@@ -88,7 +109,7 @@ Rails.application.config.sorcery.configure do |config|
                                                                                       #
                                                                                       # WARNING:
                                                                                       #
-                                                                                      # If used for users' passwords, changing this key 
+                                                                                      # If used for users' passwords, changing this key
                                                                                       # will leave passwords undecryptable!
 
     # user.custom_encryption_provider = nil                                           # use an external encryption

data/lib/sorcery.rb

@@ -34,6 +34,8 @@ module Sorcery
           autoload :Twitter, 'sorcery/controller/submodules/external/providers/twitter'
           autoload :Facebook, 'sorcery/controller/submodules/external/providers/facebook'
           autoload :Github, 'sorcery/controller/submodules/external/providers/github'
+          autoload :Google, 'sorcery/controller/submodules/external/providers/google'
+          autoload :Liveid, 'sorcery/controller/submodules/external/providers/liveid'
         end
       end
     end

data/lib/sorcery/controller/submodules/external/protocols/oauth2.rb

@@ -8,35 +8,34 @@ module Sorcery
             def oauth_version
               "2.0"
             end
-            
+
             def authorize_url(options = {})
-              defaults = {
-                :site => @site,
-                :ssl => { :ca_file => Config.ca_file }
-              }
-              client = ::OAuth2::Client.new(
-                @key,
-                @secret,
-                defaults.merge!(options)
-              )
+              client = build_client(options)
               client.web_server.authorize_url(
                 :redirect_uri => @callback_url,
                 :scope => @scope
               )
             end
-            
-            def get_access_token(args)
-              client = ::OAuth2::Client.new(
-                @key,
-                @secret,
-                :site => @site,
-                :ssl => { :ca_file => Config.ca_file }
-              )
+
+            def get_access_token(args, options = {})
+              client = build_client(options)
               client.web_server.get_access_token(
                 args[:code],
                 :redirect_uri => @callback_url
               )
             end
+
+            def build_client(options = {})
+              defaults = {
+                :site => @site,
+                :ssl => { :ca_file => Config.ca_file }
+              }
+              ::OAuth2::Client.new(
+                @key,
+                @secret,
+                defaults.merge!(options)
+              )
+            end
           end
         end
       end

data/lib/sorcery/controller/submodules/external/providers/github.rb

@@ -31,6 +31,8 @@ module Sorcery
                 attr_accessor :key,
                               :secret,
                               :callback_url,
+                              :auth_path,
+                              :token_path,
                               :site,
                               :user_info_path,
                               :user_info_mapping
@@ -39,7 +41,9 @@ module Sorcery
 
                 def init
                   @site           = "https://github.com/"
-                  @user_info_path = "/api/v2/json/user/show"
+                  @user_info_path = "https://api.github.com/user"
+                  @auth_path      = "/login/oauth/authorize"
+                  @token_path     = "/login/oauth/access_token"
                   @user_info_mapping = {}
                 end
 
@@ -58,14 +62,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_path => '/login/oauth/authorize'})
+                  self.authorize_url({:authorize_path => @auth_path})
                 end
 
                 # tries to login the user from access token
                 def process_callback(params,session)
                   args = {}
                   args.merge!({:code => params[:code]}) if params[:code]
-                  @access_token = self.get_access_token(args)
+                  options = {
+                    :access_token_path => @token_path,
+                    :access_token_method => :post
+                  }
+                  @access_token = self.get_access_token(args, options)
                 end
 
               end

data/lib/sorcery/controller/submodules/external/providers/google.rb

@@ -0,0 +1,89 @@
+module Sorcery
+  module Controller
+    module Submodules
+      module External
+        module Providers
+          # This module adds support for OAuth with google.com.
+          # When included in the 'config.providers' option, it adds a new option, 'config.google'.
+          # Via this new option you can configure Google specific settings like your app's key and secret.
+          #
+          #   config.google.key = <key>
+          #   config.google.secret = <secret>
+          #   ...
+          #
+          module Google
+            def self.included(base)
+              base.module_eval do
+                class << self
+                  attr_reader :google                           # access to google_client.
+
+                  def merge_google_defaults!
+                    @defaults.merge!(:@google => GoogleClient)
+                  end
+                end
+                merge_google_defaults!
+                update!
+              end
+            end
+
+            module GoogleClient
+              class << self
+                attr_accessor :key,
+                              :secret,
+                              :callback_url,
+                              :site,
+                              :auth_url,
+                              :token_path,
+                              :user_info_url,
+                              :scope,
+                              :user_info_mapping
+
+                include Protocols::Oauth2
+
+                def init
+                  @site              = "https://accounts.google.com"
+                  @auth_url          = "/o/oauth2/auth"
+                  @token_path        = "/o/oauth2/token"
+                  @user_info_url     = "https://www.googleapis.com/oauth2/v1/userinfo"
+                  @scope             = "https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile"
+                  @user_info_mapping = {}
+                end
+
+                def get_user_hash
+                  user_hash = {}
+                  response = @access_token.get(@user_info_url)
+                  user_hash[:user_info] = JSON.parse(response)
+                  user_hash[:uid] = user_hash[:user_info]['id']
+                  user_hash
+                end
+
+                def has_callback?
+                  true
+                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)
+                  self.authorize_url({:authorize_url => @auth_url})
+                end
+
+                # tries to login the user from access token
+                def process_callback(params,session)
+                  args = {}
+                  args.merge!({:code => params[:code]}) if params[:code]
+                  options = {
+                    :access_token_path => @token_path,
+                    :access_token_method => :post
+                  }
+                  @access_token = self.get_access_token(args, options)
+                end
+              end
+              init
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/controller/submodules/external/providers/liveid.rb

@@ -0,0 +1,90 @@
+module Sorcery
+  module Controller
+    module Submodules
+      module External
+        module Providers
+          # This module adds support for OAuth with microsoft liveid
+          # When included in the 'config.providers' option, it adds a new option, 'config.liveid'.
+          # Via this new option you can configure LiveId specific settings like your app's key and secret.
+          #
+          #   config.liveid.key = <key>
+          #   config.liveid.secret = <secret>
+          #   ...
+          #
+          module Liveid
+            def self.included(base)
+              base.module_eval do
+                class << self
+                  attr_reader :liveid                           # access to liveid_client.
+
+                  def merge_liveid_defaults!
+                    @defaults.merge!(:@liveid => LiveidClient)
+                  end
+                end
+                merge_liveid_defaults!
+                update!
+              end
+            end
+
+            module LiveidClient
+              class << self
+                attr_accessor :key,
+                              :secret,
+                              :callback_url,
+                              :site,
+                              :auth_url,
+                              :token_path,
+                              :user_info_url,
+                              :scope,
+                              :user_info_mapping
+
+                include Protocols::Oauth2
+
+                def init
+                  @site              = "https://oauth.live.com/"
+                  @auth_url          = "/authorize"
+                  @token_path        = "/token"
+                  @user_info_url     = "https://apis.live.net/v5.0/me"
+                  @scope             = "wl.basic wl.emails wl.offline_access"
+                  @user_info_mapping = {}
+                end
+
+                def get_user_hash
+                  user_hash = {}
+                  @access_token.token_param = "access_token"
+                  response = @access_token.get(@user_info_url)
+                  user_hash[:user_info] = JSON.parse(response)
+                  user_hash[:uid] = user_hash[:user_info]['id']
+                  user_hash
+                end
+
+                def has_callback?
+                  true
+                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)
+                  self.authorize_url({:authorize_url => @auth_url})
+                end
+
+                # tries to login the user from access token
+                def process_callback(params,session)
+                  args = {}
+                  args.merge!({:code => params[:code]}) if params[:code]
+                  options = {
+                    :access_token_path => @token_path,
+                    :access_token_method => :post
+                  }
+                  @access_token = self.get_access_token(args, options)
+                end
+              end
+              init
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/model.rb

@@ -104,7 +104,11 @@ module Sorcery
       # returns the user if success, nil otherwise.
       def authenticate(*credentials)
         raise ArgumentError, "at least 2 arguments required" if credentials.size < 2
+        credentials[0].downcase! if @sorcery_config.downcase_username_before_authenticating
         user = find_by_credentials(credentials)
+
+        set_encryption_attributes()
+
         _salt = user.send(@sorcery_config.salt_attribute_name) if user && !@sorcery_config.salt_attribute_name.nil? && !@sorcery_config.encryption_provider.nil?
         user if user && @sorcery_config.before_authenticate.all? {|c| user.send(c)} && credentials_match?(user.send(@sorcery_config.crypted_password_attribute_name),credentials[1],_salt)
       end
@@ -113,14 +117,19 @@ module Sorcery
       def encrypt(*tokens)
         return tokens.first if @sorcery_config.encryption_provider.nil?
         
-        @sorcery_config.encryption_provider.stretches = @sorcery_config.stretches if @sorcery_config.encryption_provider.respond_to?(:stretches) && @sorcery_config.stretches
-        @sorcery_config.encryption_provider.join_token = @sorcery_config.salt_join_token if @sorcery_config.encryption_provider.respond_to?(:join_token) && @sorcery_config.salt_join_token
+        set_encryption_attributes()
+
         CryptoProviders::AES256.key = @sorcery_config.encryption_key
         @sorcery_config.encryption_provider.encrypt(*tokens)
       end
       
       protected
-      
+
+      def set_encryption_attributes()
+        @sorcery_config.encryption_provider.stretches = @sorcery_config.stretches if @sorcery_config.encryption_provider.respond_to?(:stretches) && @sorcery_config.stretches
+        @sorcery_config.encryption_provider.join_token = @sorcery_config.salt_join_token if @sorcery_config.encryption_provider.respond_to?(:join_token) && @sorcery_config.salt_join_token
+      end
+
       # Calls the configured encryption provider to compare the supplied password with the encrypted one.
       def credentials_match?(crypted, *tokens)
         return crypted == tokens.join if @sorcery_config.encryption_provider.nil?
@@ -193,6 +202,9 @@ module Sorcery
                                                         # until an encrypted one is generated.
                                                         
                     :email_attribute_name,              # change default email attribute.
+
+                    :downcase_username_before_authenticating, # downcase the username before trying to authenticate, default is false
+
                     :crypted_password_attribute_name,   # change default crypted_password attribute.
                     :salt_join_token,                   # what pattern to use to join the password with the salt
                     :salt_attribute_name,               # change default salt attribute.
@@ -220,6 +232,7 @@ module Sorcery
           :@submodules                           => [],
           :@username_attribute_names              => [:username],
           :@password_attribute_name              => :password,
+          :@downcase_username_before_authenticating => false,
           :@email_attribute_name                 => :email,
           :@crypted_password_attribute_name      => :crypted_password,
           :@encryption_algorithm                 => :bcrypt,
@@ -268,4 +281,4 @@ module Sorcery
     end
     
   end
-end
+end