sorcery 0.8.0 → 0.8.1

data/README.rdoc

@@ -29,7 +29,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.8.0/frames
+Documentation: http://rubydoc.info/gems/sorcery/0.8.1/frames
 
 Check out the tutorials in the github wiki!
 

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/lib/generators/sorcery/install_generator.rb

@@ -47,7 +47,7 @@ module Sorcery
 
         if submodules
           submodules.each do |submodule|
-            unless submodule == "http_basic_auth" || submodule == "session_timeout"
+            unless submodule == "http_basic_auth" || submodule == "session_timeout" || submodule == "core"
               migration_template "migration/#{submodule}.rb", "db/migrate/sorcery_#{submodule}.rb"
             end
           end

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

@@ -33,6 +33,10 @@ Rails.application.config.sorcery.configure do |config|
   #
   # user.remember_me_httponly =
   
+  # How long in seconds the session length will be
+  # Default: `604800`
+  #
+  # user.remember_me_for =
 
   # -- session timeout --
   # How long in seconds to keep the session alive.
@@ -122,6 +126,11 @@ Rails.application.config.sorcery.configure do |config|
   # config.google.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=google"
   # config.google.user_info_mapping = {:email => "email", :username => "name"}
   #
+  # config.vk.key = ""
+  # config.vk.secret = ""
+  # config.vk.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=vk"
+  # config.vk.user_info_mapping = {:login => "domain", :name => "full_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

data/lib/sorcery/controller/submodules/external/providers/{vkontakte.rb → vk.rb}

@@ -3,30 +3,30 @@ module Sorcery
     module Submodules
       module External
         module Providers
-          # This module adds support for OAuth with vkontakte.com.
-          # When included in the 'config.providers' option, it adds a new option, 'config.vkontakte'.
-          # Via this new option you can configure Vkontakte specific settings like your app's key and secret.
+          # This module adds support for OAuth with vk.com.
+          # When included in the 'config.providers' option, it adds a new option, 'config.vk'.
+          # Via this new option you can configure Vk specific settings like your app's key and secret.
           #
-          #   config.vkontakte.key = <key>
-          #   config.vkontakte.secret = <secret>
+          #   config.vk.key = <key>
+          #   config.vk.secret = <secret>
           #   ...
           #
-          module Vkontakte
+          module Vk
             def self.included(base)
               base.module_eval do
                 class << self
-                  attr_reader :vkontakte                           # access to vkontakte_client.
+                  attr_reader :vk                           # access to vk_client.
 
-                  def merge_vkontakte_defaults!
-                    @defaults.merge!(:@vkontakte => VkontakteClient)
+                  def merge_vk_defaults!
+                    @defaults.merge!(:@vk => VkClient)
                   end
                 end
-                merge_vkontakte_defaults!
+                merge_vk_defaults!
                 update!
               end
             end
 
-            module VkontakteClient
+            module VkClient
               class << self
                 attr_accessor :key,
                               :secret,
@@ -34,8 +34,6 @@ module Sorcery
                               :auth_path,
                               :token_path,
                               :site,
-                              :scope,
-                              :user_info_path,
                               :user_info_mapping
                 attr_reader   :access_token
 
@@ -43,8 +41,7 @@ module Sorcery
 
                 def init
                   @site           = "https://oauth.vk.com/"
-                  @user_info_url = "https://api.vk.com/method/getUserInfo"
-                  @scope          = nil
+                  @user_info_url  = "https://api.vk.com/method/getProfiles"
                   @auth_path      = "/authorize"
                   @token_path     = "/access_token"
                   @user_info_mapping = {}
@@ -52,12 +49,20 @@ module Sorcery
 
                 def get_user_hash
                   user_hash = {}
-                  response = @access_token.get("#{@user_info_url}?access_token=#{@access_token.token}")
-                  user_hash[:user_info] = JSON.parse(response.body)
-                  if user_hash[:user_info]
-                    user_hash[:user_info] = user_hash[:user_info]["response"]
+
+                  params = {
+                    :access_token => @access_token.token,
+                    :uids         => @access_token.params["user_id"],
+                    :fields       => @user_info_mapping.values.join(",")
+                  }
+
+                  response = @access_token.get(@user_info_url, :params => params)
+                  if user_hash[:user_info] = JSON.parse(response.body)
+                    user_hash[:user_info] = user_hash[:user_info]["response"][0]
+                    # add full_name - useful if you do not store it in separate fields
+                    user_hash[:user_info]["full_name"] = [user_hash[:user_info]["first_name"], user_hash[:user_info]["last_name"]].join(" ")
+                    user_hash[:uid] = user_hash[:user_info]["uid"]
                   end
-                  user_hash[:uid] = user_hash[:user_info]['user_id']
                   user_hash
                 end
 

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

@@ -31,29 +31,29 @@ module Sorcery
 
           # sends user to authenticate at the provider's website.
           # after authentication the user is redirected to the callback defined in the provider config
-          def login_at(provider, args = {})
-            @provider = Config.send(provider)
-            if @provider.callback_url.present? && @provider.callback_url[0] == '/'
+          def login_at(provider_name, args = {})
+            provider = Config.send(provider_name)
+            if provider.callback_url.present? && provider.callback_url[0] == '/'
               uri = URI.parse(request.url.gsub(/\?.*$/,''))
               uri.path = ''
               uri.query = nil
               uri.scheme = 'https' if(request.env['HTTP_X_FORWARDED_PROTO'] == 'https')
               host = uri.to_s
-              @provider.callback_url = "#{host}#{@provider.callback_url}"
+              provider.callback_url = "#{host}#{provider.callback_url}"
             end
-            if @provider.has_callback?
-              redirect_to @provider.login_url(params,session)
+            if provider.has_callback?
+              redirect_to provider.login_url(params,session)
             else
-              #@provider.login(args)
+              #provider.login(args)
             end
           end
 
           # tries to login the user from provider's callback
-          def login_from(provider)
-            @provider = Config.send(provider)
-            @provider.process_callback(params,session)
-            @user_hash = @provider.get_user_hash
-            if user = user_class.load_from_provider(provider,@user_hash[:uid].to_s)
+          def login_from(provider_name)
+            provider = Config.send(provider_name)
+            provider.process_callback(params,session)
+            user_hash = provider.get_user_hash
+            if user = user_class.load_from_provider(provider_name,user_hash[:uid].to_s)
               return_to_url = session[:return_to_url]
               reset_session
               session[:return_to_url] = return_to_url
@@ -64,22 +64,22 @@ module Sorcery
           end
 
           # get provider access account
-          def access_token(provider)
-            @provider = Config.send(provider)
-            @provider.access_token
+          def access_token(provider_name)
+            provider = Config.send(provider_name)
+            provider.access_token
           end
 
           # If user is logged, he can add all available providers into his account
-          def add_provider_to_user(provider)
-            provider_name = provider.to_sym
-            @provider = Config.send(provider_name)
-            @provider.process_callback(params,session)
-            @user_hash = @provider.get_user_hash
+          def add_provider_to_user(provider_name)
+            provider_name = provider_name.to_sym
+            provider = Config.send(provider_name)
+            provider.process_callback(params,session)
+            user_hash = provider.get_user_hash
             config = user_class.sorcery_config
 
             # first check to see if user has a particular authentication already
-            unless (current_user.send(config.authentications_class.to_s.downcase.pluralize).send("find_by_#{config.provider_attribute_name}_and_#{config.provider_uid_attribute_name}", provider, @user_hash[:uid].to_s))
-              user = current_user.send(config.authentications_class.to_s.downcase.pluralize).build(config.provider_uid_attribute_name => @user_hash[:uid], config.provider_attribute_name => provider_name.to_s)
+            unless (current_user.send(config.authentications_class.to_s.downcase.pluralize).send("find_by_#{config.provider_attribute_name}_and_#{config.provider_uid_attribute_name}", provider_name, user_hash[:uid].to_s))
+              user = current_user.send(config.authentications_class.to_s.downcase.pluralize).build(config.provider_uid_attribute_name => user_hash[:uid], config.provider_attribute_name => provider_name.to_s)
               user.save(:validate => false)
             else
               user = false
@@ -91,19 +91,19 @@ module Sorcery
           # Initialize new user from provider informations.
           # If a provider doesn't give required informations or username/email is already taken,
           # we store provider/user infos into a session and can be rendered into registration form
-          def create_and_validate_from(provider)
-            provider = provider.to_sym
-            @provider = Config.send(provider)
-            @user_hash = @provider.get_user_hash
+          def create_and_validate_from(provider_name)
+            provider_name = provider_name.to_sym
+            provider = Config.send(provider_name)
+            user_hash = provider.get_user_hash
             config = user_class.sorcery_config
 
-            attrs = user_attrs(@provider.user_info_mapping, @user_hash)
+            attrs = user_attrs(provider.user_info_mapping, user_hash)
 
             user = user_class.new(attrs)
-            user.send(config.authentications_class.to_s.downcase.pluralize).build(config.provider_uid_attribute_name => @user_hash[:uid], config.provider_attribute_name => provider)
+            user.send(config.authentications_class.to_s.downcase.pluralize).build(config.provider_uid_attribute_name => user_hash[:uid], config.provider_attribute_name => provider_name)
 
             session[:incomplete_user] = {
-              :provider => {config.provider_uid_attribute_name => @user_hash[:uid], config.provider_attribute_name => provider},
+              :provider => {config.provider_uid_attribute_name => user_hash[:uid], config.provider_attribute_name => provider_name},
               :user_hash => attrs
             } unless user.save
 
@@ -126,13 +126,13 @@ module Sorcery
           #
           #   create_from(provider) {|user| user.some_check }
           #
-          def create_from(provider)
-            provider = provider.to_sym
-            @provider = Config.send(provider)
-            @user_hash = @provider.get_user_hash
+          def create_from(provider_name)
+            provider_name = provider_name.to_sym
+            provider = Config.send(provider_name)
+            user_hash = provider.get_user_hash
             config = user_class.sorcery_config
 
-            attrs = user_attrs(@provider.user_info_mapping, @user_hash)
+            attrs = user_attrs(provider.user_info_mapping, user_hash)
 
             user_class.transaction do
               @user = user_class.new()
@@ -145,7 +145,7 @@ module Sorcery
               end
 
               @user.save(:validate => false)
-              user_class.sorcery_config.authentications_class.create!({config.authentications_user_id_attribute_name => @user.id, config.provider_attribute_name => provider, config.provider_uid_attribute_name => @user_hash[:uid]})
+              user_class.sorcery_config.authentications_class.create!({config.authentications_user_id_attribute_name => @user.id, config.provider_attribute_name => provider_name, config.provider_uid_attribute_name => user_hash[:uid]})
             end
             @user
           end

data/lib/sorcery/controller.rb

@@ -32,9 +32,9 @@ module Sorcery
         @current_user = nil
         user = user_class.authenticate(*credentials)
         if user
-          old_session = session.dup
+          old_session = session.dup.to_hash
           reset_session # protect from session fixation attacks
-          old_session.to_hash.each_pair do |k,v|
+          old_session.each_pair do |k,v|
             session[k.to_sym] = v
           end
           auto_login(user)

data/lib/sorcery.rb

@@ -37,7 +37,7 @@ module Sorcery
           autoload :Google, 'sorcery/controller/submodules/external/providers/google'
           autoload :Liveid, 'sorcery/controller/submodules/external/providers/liveid'
           autoload :Linkedin, 'sorcery/controller/submodules/external/providers/linkedin'
-          autoload :Vkontakte, 'sorcery/controller/submodules/external/providers/vkontakte'
+          autoload :Vk, 'sorcery/controller/submodules/external/providers/vk'
         end
       end
     end

data/sorcery.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sorcery"
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Noam Ben Ari"]
-  s.date = "2013-01-12"
+  s.date = "2013-01-25"
   s.description = "Provides common authentication needs such as signing in/out, activating by email and resetting password."
   s.email = "nbenari@gmail.com"
   s.extra_rdoc_files = [
@@ -50,7 +50,7 @@ Gem::Specification.new do |s|
     "lib/sorcery/controller/submodules/external/providers/linkedin.rb",
     "lib/sorcery/controller/submodules/external/providers/liveid.rb",
     "lib/sorcery/controller/submodules/external/providers/twitter.rb",
-    "lib/sorcery/controller/submodules/external/providers/vkontakte.rb",
+    "lib/sorcery/controller/submodules/external/providers/vk.rb",
     "lib/sorcery/controller/submodules/http_basic_auth.rb",
     "lib/sorcery/controller/submodules/remember_me.rb",
     "lib/sorcery/controller/submodules/session_timeout.rb",

metadata

@@ -2,7 +2,7 @@
 name: sorcery
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors: 
 - Noam Ben Ari
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-12 00:00:00 Z
+date: 2013-01-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth
@@ -253,7 +253,7 @@ files:
 - lib/sorcery/controller/submodules/external/providers/linkedin.rb
 - lib/sorcery/controller/submodules/external/providers/liveid.rb
 - lib/sorcery/controller/submodules/external/providers/twitter.rb
-- lib/sorcery/controller/submodules/external/providers/vkontakte.rb
+- lib/sorcery/controller/submodules/external/providers/vk.rb
 - lib/sorcery/controller/submodules/http_basic_auth.rb
 - lib/sorcery/controller/submodules/remember_me.rb
 - lib/sorcery/controller/submodules/session_timeout.rb