lam_auth 1.1.0 → 2.0.0

data/README.md

@@ -0,0 +1,143 @@
+Аутентификация для спецпроектов [Lookatme](http://www.lookatme.ru) и [The Village](http://www.the-village.ru)
+
+## Установка
+
+    gem install lam_auth
+
+После установки/добавления в Gemfile:
+
+    rails generate lam_auth
+
+после этого нужно добавить настройки приложения в `config/lam_auth.yml`. 
+
+Для спецпроектов The Village необходимо в `config/lam_auth.yml` добавить:
+
+    site: village
+
+## Подключение панели
+
+Подключить js-код в head:
+  
+    <%= lam_auth_include_tag %>
+  
+Затем:
+
+    <div id="lam-root"></div>
+    <%= lam_auth_init_tag %>
+
+В случае с The Village дефолтный `id` панели `village-root`.
+
+## Модель
+
+При аутентификации Lookatme/The Village возвращают данные пользователя в следующем виде:
+
+```ruby
+{
+  "gender"     => "male",
+  "last_name"  => "Маковский",
+  "city"       => "Москва",
+  "email"      => "robotector@gmail.com",
+  "userpic"    => {
+    "medium"   => "http://assets3.lookatme.ru/assets/user-userpic/20/38/3/user-userpic-medium.jpg",
+    "big"      => "http://assets0.lookatme.ru/assets/user-userpic/20/38/3/user-userpic-big.jpg",
+    "icon"     => "http://assets3.lookatme.ru/assets/user-userpic/20/38/3/user-userpic-icon.jpg",
+    "thumb"    => "http://assets0.lookatme.ru/assets/user-userpic/20/38/3/user-userpic-thumb.jpg"
+  },
+  "first_name" => "Шляпа",
+  "birthday"   => "13-12-1979",
+  "login"      => "macovsky"}
+```
+
+В модели пользователя нужно подключить `LamAuth`:
+
+```ruby
+class User < ActiveRecord::Base
+  include LamAuth::Model
+end
+```
+
+Теперь класс `User` имеет метод `create_or_update_by_auth_data`, принимающий данные пользователя:
+
+```ruby
+def self.create_or_update_by_auth_data(data)
+  user = find_or_initialize_by_login(data['login'])
+  user.update_attributes! data.slice(*%w{email first_name last_name}).merge(
+    'userpic' => data['userpic']['icon'], 
+    'profile' => data.except(*%w{login email first_name last_name userpic})
+  )
+  user
+end
+```
+
+Предполагает наличие соответствующих атрибутов и сериализацию атрибута `profile`: 
+
+```ruby
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table(:users) do |t|
+      t.string :login, :null => false
+      t.string :email, :null => false
+      t.string :first_name
+      t.string :last_name
+      t.string :userpic
+      t.text :profile
+      t.timestamps
+    end
+    
+    add_index :users, :login
+    add_index :users, :email
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+```
+
+Метод переопределяется для конкретных случаев.
+
+## Контроллер
+
+Для подключения самого механизма аутентификации можно, например, использовать [RailsWarden](http://github.com/hassox/rails_warden):
+
+```ruby
+# config/initializers/warden.rb
+Rails.configuration.middleware.use RailsWarden::Manager do |manager|
+  manager.default_strategies :cookie_with_access_token
+  manager.failure_app = SessionsController
+end
+
+Warden::Strategies.add(:cookie_with_access_token) do
+  def authenticate!
+    access_token = LamAuth.access_token_from_cookie(request.cookies[LamAuth.cookie_id])
+    access_token ? success!(User.find_by_access_token(access_token)) : fail
+  end
+end
+
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  before_filter :authenticate
+  before_filter :logout_if_no_cookie_available, :if => :logged_in?
+
+  private
+
+  def logout_if_no_cookie_available
+    logout if !LamAuth.access_token_from_cookie(cookies[LamAuth.cookie_id])
+  end
+end
+
+# app/controllers/sessions_controller.rb 
+# Контроллер, который в #unauthenticated рендерит сообщение о необходимости авторизоваться/зарегистрироваться.
+class SessionsController < ApplicationController
+  def unauthenticated
+  end
+end
+```
+
+На страницах, где аутентификация обязательна, можно использовать соответствующий хелпер `RailsWarden`:
+
+```ruby
+before_filter :authenticate!
+```

data/lib/generators/lam_auth/lam_auth_generator.rb

@@ -1,16 +1,10 @@
 module LamAuth
   module Generators
-    class LamAuthGenerator < Rails::Generators::NamedBase
+    class LamAuthGenerator < Rails::Generators::Base
       namespace "lam_auth"
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Installs lam_auth: generates a model plus includes required extensions."
-      
-      hook_for :orm
-      
-      def inject_controller_content
-        inject_into_class(File.join("app", "controllers", "application_controller.rb"), 'ApplicationController', "  lam_auth_for :#{file_path}\n")
-      end
+      desc "Installs lam_auth"
       
       def copy_xd_receiver
         copy_file 'xd_receiver.html', 'public/xd_receiver.html'

data/lib/generators/templates/xd_receiver.html

@@ -4,12 +4,10 @@
   <meta charset="UTF-8">
   <title></title>
   <script type="text/javascript">
-    window.opener.LAM.successLogin(window.location.hash.substring(1));
+    (window.opener.LAM || window.opener.VLG).successLogin(window.location.hash.substring(1));
   </script>
 </head>
 <body><p>Loading...</p>
 </body>
 </html>
 
-
-

data/lib/lam_auth/helpers.rb

@@ -1,18 +1,18 @@
 module LamAuth
   module Helpers
     def lam_auth_include_tag
-      javascript_include_tag(LamAuth.url + "/api/js/LAM.Login.js")
+      javascript_include_tag(LamAuth.config['api_url'])
     end
   
     def lam_auth_init_tag(options = {})
       options.reverse_merge!(
-        :app_id          => LamAuth.config['app_id'],
-        :panel_node_id   => 'lam-root', 
+        :app_id          => LamAuth.app['app_id'],
+        :panel_node_id   => "#{LamAuth.config['prefix']}-root", 
         :fixed           => false
       )      
-      options.reverse_merge!(:xd_receiver_url => LamAuth.config['return_url']) if LamAuth.config['return_url']
+      options.reverse_merge!(:xd_receiver_url => LamAuth.app['return_url']) if LamAuth.app['return_url']
       
-      javascript_tag("LAM.init({#{options.map{|k, v| "#{k.to_s.camelize(:lower)}: #{v.inspect}"}.join(",\n")}});")
+      javascript_tag("#{LamAuth.config['api']}.init({#{options.map{|k, v| "#{k.to_s.camelize(:lower)}: #{v.inspect}"}.join(",\n")}});")
     end
   end
 end

data/lib/lam_auth/model.rb

@@ -3,19 +3,16 @@ require 'net/https'
 module LamAuth
   module Model
     def self.included(base)
-      base.validates_presence_of :login, :email
-      base.validates_uniqueness_of :login, :email
-      base.serialize :profile
-      base.send(:extend, ClassMethods)
+      base.extend ClassMethods
     end
-    
+
     module ClassMethods
       def find_by_access_token(access_token)
         Rails.logger.info("Trying to authorize a token #{access_token.inspect} ")
 
-        lam_uri = LamAuth.uri
-        http = Net::HTTP.new(lam_uri.host, lam_uri.port)
-        response = http.get("#{lam_uri.path}/users/me", {'Authorization' => "Token token=\"#{access_token}\""})
+        uri = URI.parse(LamAuth.url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        response = http.get("#{uri.path}/users/me", {'Authorization' => "Token token=\"#{access_token}\""})
         if response.code == "200"
           data = ActiveSupport::JSON.decode(response.body)
           Rails.logger.info("...success: #{data.inspect}")
@@ -24,31 +21,16 @@ module LamAuth
           Rails.logger.info("...failed with #{response.code}!")
           nil
         end
-      rescue Net::ProtoRetriableError => detail
-        Rails.logger.info("...failed!")
-        Rails.logger.info(detail)
-        nil
       end
 
       def create_or_update_by_auth_data(data)
         user = find_or_initialize_by_login(data['login'])
-        user.update_attributes data.slice(*%w{email first_name last_name}).merge(
+        user.update_attributes! data.slice(*%w{email first_name last_name}).merge(
           'userpic' => data['userpic']['icon'], 
           'profile' => data.except(*%w{login email first_name last_name userpic})
         )
         user
       end
     end
-    
-    def name
-      [first_name, last_name].select(&:present?).join(" ")
-    end
-    
-    def userpic(version = :icon)
-      pic = read_attribute(:userpic)
-      return nil if pic.blank?
-      pic.sub(/user-userpic-\w+/, "user-userpic-#{version}")
-    end  
-    
   end
 end

data/lib/lam_auth/version.rb

@@ -1,3 +1,3 @@
 module LamAuth
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/lib/lam_auth.rb

@@ -1,39 +1,48 @@
 require 'rack/utils'
 require 'digest/md5'
 
-require 'lam_auth/controller_extensions'
 require 'lam_auth/helpers'
 require 'lam_auth/model'
-ActionController::Base.extend(LamAuth::ControllerExtensions)
 ActionController::Base.helper(LamAuth::Helpers)
 
 module LamAuth
-  class LoginRequiredException < Exception
-  end
-  
   class << self
-    def config
-      @config ||= YAML.load_file(Rails.root.join("config/lam_auth.yml"))
+    def app
+      @app ||= YAML.load_file(Rails.root.join("config/lam_auth.yml"))
     end
-    
-    def url
-      "http://www.lookatme.ru"
+
+    def config
+      {
+        'lookatme' => {
+          'prefix' => 'lam', 
+          'url' => 'http://www.lookatme.ru',
+          'api' => 'LAM',
+          'api_url' => 'http://www.lookatme.ru/api/js/LAM.Login.js',
+        },
+        'village' => {
+          'prefix' => 'village', 
+          'url' => 'http://www.the-village.ru',
+          'api' => 'VLG',
+          'api_url' => 'http://assets0.the-village.ru/api/js/VLG.Login.js',
+        }
+      }[site]
     end
-    
-    def signup_url
-      "#{url}/signup"
+
+    def site
+      %w{lookatme village}.include?(app['site']) ? app['site'] : 'lookatme'
     end
     
-    def uri
-      URI.parse(url)
+    def url
+      config['url']
     end
     
     def cookie_id
-      "lam_#{config['app_id']}"
+      "#{config['prefix']}_#{app['app_id']}"
     end
-    
-    def valid_cookie?(data)
-      valid_hash?(parse_cookie_to_hash(data))
+
+    def access_token_from_cookie(cookie)
+      hash = parse_cookie_to_hash(cookie)
+      valid_hash?(hash) && hash['access_token']
     end
     
     def parse_cookie_to_hash(data)
@@ -41,7 +50,7 @@ module LamAuth
     end
     
     def valid_hash?(hash)
-      Digest::MD5.hexdigest(hash.except('sig').sort.map{|v| v.join('=')}.join + LamAuth.config['secret']) == hash['sig']
+      Digest::MD5.hexdigest(hash.except('sig').sort.map{|v| v.join('=')}.join + app['secret']) == hash['sig']
     end
   end
 end

metadata

@@ -1,63 +1,84 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: lam_auth
-version: !ruby/object:Gem::Version
-  version: 1.1.0
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
-authors:
+authors: 
 - Max Macovsky
 - Anton Platonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+
+date: 2012-08-21 00:00:00 -07:00
+default_executable: 
 dependencies: []
-description: ''
-email:
+
+description: ""
+email: 
 - robotector@gmail.com
 - platosha@lookatme.ru
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - lam_auth.gemspec
-- lib/generators/active_record/lam_auth_generator.rb
-- lib/generators/active_record/templates/migration.rb
-- lib/generators/lam_auth/helpers.rb
 - lib/generators/lam_auth/lam_auth_generator.rb
 - lib/generators/templates/lam_auth.yml
 - lib/generators/templates/xd_receiver.html
 - lib/lam_auth.rb
-- lib/lam_auth/controller_extensions.rb
 - lib/lam_auth/helpers.rb
 - lib/lam_auth/model.rb
 - lib/lam_auth/version.rb
+has_rdoc: true
 homepage: http://github.com/macovsky/lam_auth
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Аутентификация для спецпроектов Lookatme
+summary: !binary |
+  0JDRg9GC0LXQvdGC0LjRhNC40LrQsNGG0LjRjyDQtNC70Y8g0YHQv9C10YbQ
+  v9GA0L7QtdC60YLQvtCyIExvb2thdG1l
+
 test_files: []
+

data/README.rdoc

@@ -1,42 +0,0 @@
-Аутентификация для спецпроектов Lookatme
-
-== Установка
-
-  gem install lam_auth
-
-После установки/добавления в Gemfile:
-
-  rails generate lam_auth User
-
-после этого нужно добавить настройки приложения для соответствующих environment в config/lam_auth.yml.
-
-== Обработчик LoginRequiredException
-
-Для actions, где требуется залогиненный пользователь:
-
-  before_filter :login_required
-
-можно сделать обработчик для LoginRequiredException:
-
-  rescue_from LamAuth::LoginRequiredException, :with => :render_login_required
-
-  private
-
-  def render_login_required
-    render :file => 'shared/login_required', :layout => 'application', :status => 401
-  end
-  
-== Подключение панели
-
-Подключить js-код в head:
-  
-  <%= lam_auth_include_tag %>
-  
-Затем:
-
-  <div id="lam-root"></div>
-  <%= lam_auth_init_tag %>
-
-== Подробно о механизме аутентификации
-
-http://mindscan.msk.ru/downloads/lam_auth.pdf

data/lib/generators/active_record/lam_auth_generator.rb

@@ -1,23 +0,0 @@
-require 'rails/generators/active_record'
-require 'generators/lam_auth/helpers'
-
-module ActiveRecord
-  module Generators
-    class LamAuthGenerator < ActiveRecord::Generators::Base
-      include LamAuth::Generators::Helpers
-      source_root File.expand_path("../templates", __FILE__)
-
-      def generate_model
-        invoke "active_record:model", [name], :migration => false unless model_exists? && behavior == :invoke
-      end
-
-      def copy_lam_auth_migration
-        migration_template "migration.rb", "db/migrate/create_#{table_name}"
-      end
-
-      def inject_lam_auth_content
-        inject_into_class(model_path, class_name, model_contents) if model_exists?
-      end
-    end
-  end
-end

data/lib/generators/active_record/templates/migration.rb

@@ -1,20 +0,0 @@
-class Create<%= table_name.camelize %> < ActiveRecord::Migration
-  def self.up
-    create_table(:<%= table_name %>) do |t|
-      t.string :login, :null => false
-      t.string :email, :null => false
-      t.string :first_name
-      t.string :last_name
-      t.string :userpic
-      t.text :profile
-      t.timestamps
-    end
-    
-    add_index :<%= table_name %>, :login
-    add_index :<%= table_name %>, :email
-  end
-
-  def self.down
-    drop_table :<%= table_name %>
-  end
-end

data/lib/generators/lam_auth/helpers.rb

@@ -1,19 +0,0 @@
-module LamAuth
-  module Generators
-    module Helpers
-      def model_exists?
-        File.exists?(File.join(destination_root, model_path))
-      end
-
-      def model_path
-        @model_path ||= File.join("app", "models", "#{file_path}.rb")
-      end
-      
-      def model_contents
-<<-CONTENT
-  include LamAuth::Model
-CONTENT
-      end
-    end
-  end
-end

data/lib/lam_auth/controller_extensions.rb

@@ -1,53 +0,0 @@
-module LamAuth
-  module ControllerExtensions
-    def lam_auth_for(klass)
-      class_attribute :user_model_class_name
-      self.user_model_class_name = klass
-      
-      helper_method(:current_user, :logged_in?)
-      before_filter :login_from_cookie
-      
-      extend ClassMethods
-      include InstanceMethods
-      protected :logged_in?, :current_user, :current_user=, :access_token, :login_from_cookie, :login_required
-    end
-    
-    module ClassMethods
-      def user_model_class
-        user_model_class_name.to_s.classify.constantize
-      end
-    end
-    
-    module InstanceMethods
-      def logged_in?
-        !!current_user
-      end
-  
-      def current_user
-        @current_user ||= session[:user] && self.class.user_model_class.find_by_id(session[:user])
-      end
-  
-      def current_user=(new_user)
-        session[:user] = new_user && new_user.id
-        @current_user = new_user
-      end
-  
-      def access_token
-        cookie = cookies[LamAuth.cookie_id]
-        LamAuth.valid_cookie?(cookie) && LamAuth.parse_cookie_to_hash(cookie)['access_token']
-      end
-  
-      def login_from_cookie
-        if logged_in?
-          !access_token && self.current_user = nil
-        else
-          access_token && self.current_user = self.class.user_model_class.find_by_access_token(access_token)
-        end
-      end
-  
-      def login_required
-        logged_in? || raise(LoginRequiredException)
-      end
-    end
-  end
-end