sorcery 0.7.4 → 0.7.6

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 gem 'oauth', "~> 0.4.4"
-gem 'oauth2', "~> 0.4.1"
+gem 'oauth2', "~> 0.5.1"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -1,44 +1,44 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.1.1)
-      actionpack (= 3.1.1)
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
       mail (~> 2.3.0)
-    actionpack (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       i18n (~> 0.6)
-      rack (~> 1.3.2)
+      rack (~> 1.3.5)
       rack-cache (~> 1.1)
       rack-mount (~> 0.8.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.0.2)
-    activemodel (3.1.1)
-      activesupport (= 3.1.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
       arel (~> 2.2.1)
       tzinfo (~> 0.3.29)
-    activeresource (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
-    activesupport (3.1.1)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
       multi_json (~> 1.0)
     addressable (2.2.6)
     archive-tar-minitar (0.5.2)
     arel (2.2.1)
     builder (3.0.0)
-    columnize (0.3.4)
+    columnize (0.3.6)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    faraday (0.6.1)
-      addressable (~> 2.2.4)
-      multipart-post (~> 1.1.0)
+    faraday (0.7.5)
+      addressable (~> 2.2.6)
+      multipart-post (~> 1.1.3)
       rack (>= 1.1.0, < 2)
     git (1.2.5)
     hike (1.2.1)
@@ -47,7 +47,7 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    json (1.6.1)
+    json (1.6.3)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
     mail (2.3.0)
@@ -55,13 +55,13 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
-    multi_json (1.0.3)
-    multipart-post (1.1.3)
+    multi_json (1.0.4)
+    multipart-post (1.1.4)
     oauth (0.4.5)
-    oauth2 (0.4.1)
-      faraday (~> 0.6.1)
-      multi_json (>= 0.0.5)
-    polyglot (0.3.2)
+    oauth2 (0.5.1)
+      faraday (~> 0.7.4)
+      multi_json (~> 1.0.3)
+    polyglot (0.3.3)
     rack (1.3.5)
     rack-cache (1.1)
       rack (>= 0.4)
@@ -71,23 +71,23 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.1.1)
-      actionmailer (= 3.1.1)
-      actionpack (= 3.1.1)
-      activerecord (= 3.1.1)
-      activeresource (= 3.1.1)
-      activesupport (= 3.1.1)
+    rails (3.1.3)
+      actionmailer (= 3.1.3)
+      actionpack (= 3.1.3)
+      activerecord (= 3.1.3)
+      activeresource (= 3.1.3)
+      activesupport (= 3.1.3)
       bundler (~> 1.0)
-      railties (= 3.1.1)
-    railties (3.1.1)
-      actionpack (= 3.1.1)
-      activesupport (= 3.1.1)
+      railties (= 3.1.3)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.6)
     rake (0.9.2.2)
-    rdoc (3.11)
+    rdoc (3.12)
       json (~> 1.4)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
@@ -120,7 +120,7 @@ GEM
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.4)
+    sqlite3 (1.3.5)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
     thor (0.14.6)
@@ -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
@@ -140,7 +140,7 @@ DEPENDENCIES
   jeweler (~> 1.5.2)
   json (>= 1.5.1)
   oauth (~> 0.4.4)
-  oauth2 (~> 0.4.1)
+  oauth2 (~> 0.5.1)
   rails (>= 3.0.0)
   rspec (~> 2.5.0)
   rspec-rails (~> 2.5.0)

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.6/frames
 
 Check out the tutorials in the github wiki!
 

data/Rakefile

@@ -27,7 +27,7 @@ Jeweler::Tasks.new do |gem|
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
   gem.add_runtime_dependency 'bcrypt-ruby', '~> 3.0.0'
   gem.add_runtime_dependency 'oauth', '~> 0.4.4'
-  gem.add_runtime_dependency 'oauth2', '~> 0.4.1'
+  gem.add_runtime_dependency 'oauth2', '~> 0.5.1'
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.7.4
+0.7.6

data/lib/generators/sorcery/install_generator.rb

@@ -39,6 +39,10 @@ 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.
+        return unless defined?(Sorcery::Generators::InstallGenerator::ActiveRecord)
+        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 +51,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 +72,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/generators/sorcery/templates/migration/reset_password.rb

@@ -8,7 +8,7 @@ class SorceryResetPassword < ActiveRecord::Migration
   end
 
   def self.down
-    remove_index :users, :reset_password_token
+    remove_index :<%= model_class_name.tableize %>, :reset_password_token
     
     remove_column :<%= model_class_name.tableize %>, :reset_password_email_sent_at
     remove_column :<%= model_class_name.tableize %>, :reset_password_token_expires_at

data/lib/sorcery/controller/submodules/activity_logging.rb

@@ -52,14 +52,14 @@ module Sorcery
           # This runs as a hook just after a successful login.
           def register_login_time_to_db(user, credentials)
             return unless Config.register_login_time
-            user.update_attribute(user.sorcery_config.last_login_at_attribute_name, Time.now.in_time_zone)
+            user.update_single_attribute(user.sorcery_config.last_login_at_attribute_name, Time.now.in_time_zone)
           end
           
           # registers last logout time on every logout.
           # This runs as a hook just before a logout.
           def register_logout_time_to_db(user)
             return unless Config.register_logout_time
-            user.update_attribute(user.sorcery_config.last_logout_at_attribute_name, Time.now.in_time_zone)
+            user.update_single_attribute(user.sorcery_config.last_logout_at_attribute_name, Time.now.in_time_zone)
           end
           
           # Updates last activity time on every request.
@@ -67,7 +67,7 @@ module Sorcery
           def register_last_activity_time_to_db
             return unless Config.register_last_activity_time
             return unless logged_in?
-            current_user.update_attribute(current_user.sorcery_config.last_activity_at_attribute_name, Time.now.in_time_zone)
+            current_user.update_single_attribute(current_user.sorcery_config.last_activity_at_attribute_name, Time.now.in_time_zone)
           end
         end
       end

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

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

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

@@ -34,8 +34,10 @@ module Sorcery
                               :site,
                               :user_info_path,
                               :scope,
-                              :user_info_mapping
-                            
+                              :user_info_mapping,
+                              :display
+                attr_reader   :access_token
+
                 include Protocols::Oauth2
             
                 def init
@@ -43,6 +45,7 @@ module Sorcery
                   @user_info_path = "/me"
                   @scope          = "email,offline_access"
                   @user_info_mapping = {}
+                  @display        = "page"
                 end
                 
                 def get_user_hash

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

@@ -31,15 +31,20 @@ module Sorcery
                 attr_accessor :key,
                               :secret,
                               :callback_url,
+                              :auth_path,
+                              :token_path,
                               :site,
                               :user_info_path,
                               :user_info_mapping
+                attr_reader   :access_token
 
                 include Protocols::Oauth2
 
                 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 +63,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,90 @@
+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
+                attr_reader   :access_token
+
+                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,91 @@
+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
+                attr_reader   :access_token
+
+                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/controller/submodules/external/providers/twitter.rb

@@ -37,7 +37,8 @@ module Sorcery
                               :site,
                               :user_info_path,
                               :user_info_mapping
-                
+                attr_reader   :access_token
+
                 include Protocols::Oauth1
 				
 				        # Override included get_consumer method to provide authorize_path

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

@@ -51,6 +51,12 @@ module Sorcery
               user
             end
           end
+
+          # get provider access account
+          def access_token(provider)
+            @provider = Config.send(provider)
+            @provider.access_token
+          end
           
           # this method automatically creates a new user from the data in the external user hash.
           # The mappings from user hash fields to user db fields are set at controller config.

data/lib/sorcery/model/adapters/active_record.rb

@@ -4,11 +4,26 @@ module Sorcery
       module ActiveRecord
         def self.included(klass)
           klass.extend ClassMethods
+          klass.send(:include, InstanceMethods)
         end
 
+        module InstanceMethods
+          def update_single_attribute(name, value)
+            self.send(:"#{name}=", value)
+            
+            primary_key = self.class.primary_key
+            self.class.where(:"#{primary_key}" => self.send(:"#{primary_key}")).update_all(name => value)
+          end
+        end
+        
         module ClassMethods
+          def column_name(attribute)
+            return "LOWER(#{attribute})" if (@sorcery_config.downcase_username_before_authenticating)
+            return "#{attribute}"
+          end
+
           def find_by_credentials(credentials)
-             sql = @sorcery_config.username_attribute_names.map{|attribute| "#{attribute} = :login"}
+             sql = @sorcery_config.username_attribute_names.map{|attribute| column_name(attribute) + " = :login"}
              where(sql.join(' OR '), :login => credentials[0]).first
           end