authlogic_vkontakte 0.1.0

data/Manifest

@@ -0,0 +1,11 @@
+README.rdoc
+Rakefile
+authlogic_vkontakte.gemspec
+init.rb
+js/vkontakte.js
+lib/profile_loader.rb
+lib/settings.rb
+lib/tasks/vkontakte.rake
+lib/vkontakte_authentication.rb
+lib/vkontakte_helper.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,50 @@
+Bind vkontakte authentication to your authlogic project.
+== Install
+    gem install authlogic_vkontakte
+
+== Setup
+Run rake task to init resources (javascripts and other)
+    rake vkontakte:init
+
+Edit vkontakte.yml file in your project directory
+    vk_app_id: <YOUR_APP_ID>
+    vk_app_password: <YOUR_PASSWORD>
+
+Create migration like this one:
+    class AddVkontakteIdToUser < ActiveRecord::Migration
+      def self.up
+        add_column :users, :vk_id, :string
+      end
+    
+      def self.down
+       remove_column :users, :vk_id
+      end
+    end
+
+Add "vontakte_authentication" to your User model
+    class User < ActiveRecord::Base
+        vkontakte_authentication
+    end
+And a little requirement now - jQuery (see vkontakte.js) for posting to "create" action of UserSessionController. But
+you can use Ajax.Request if you prefer Prototype. And so, TODO is to create version independent of the javascript framework.
+
+== Usage
+To include javascript file in layout:
+    <%= vkontakte_javascript_include_tag %>
+
+Creating "vk_api_transport" 'div' and initializing OpenAPI:
+    <%= vkontakte_init_tag %>
+
+To add Vkontakte button to your page, simply write this in view:
+    <%= vk_login_button %>
+
+or, in haml
+    = vk_login_button 
+In your controller (UserSession):
+    def create
+      @user_session = UserSession.new(params[:status] ? cookies : params[:user_session])
+      if @user_session.save
+        ..
+...and you're in Vkontakte!
+
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "rubygems"
+require "rake"
+require "echoe"
+
+Echoe.new("authlogic_vkontakte", "0.1.0") do |p|
+  p.description= "Bind vkontakte authentication to your authlogic project"
+  p.url= "http://github.com/GarPit/authlogic_vkontakte"
+  p.author= "Igor Petrov"
+  p.email= "garik.piton@gmail.com"
+  p.ignore_pattern= ["tmp/*", "script/*", ".idea/*"]
+  p.development_dependencies= []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext}

data/authlogic_vkontakte.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{authlogic_vkontakte}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Igor Petrov"]
+  s.date = %q{2010-10-15}
+  s.description = %q{Bind vkontakte authentication to your authlogic project}
+  s.email = %q{garik.piton@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/profile_loader.rb", "lib/settings.rb", "lib/tasks/vkontakte.rake", "lib/vkontakte_authentication.rb", "lib/vkontakte_helper.rb"]
+  s.files = ["README.rdoc", "Rakefile", "authlogic_vkontakte.gemspec", "init.rb", "js/vkontakte.js", "lib/profile_loader.rb", "lib/settings.rb", "lib/tasks/vkontakte.rake", "lib/vkontakte_authentication.rb", "lib/vkontakte_helper.rb", "Manifest"]
+  s.homepage = %q{http://github.com/GarPit/authlogic_vkontakte}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Authlogic_vkontakte", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{authlogic_vkontakte}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Bind vkontakte authentication to your authlogic project}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+require "vkontakte_authentication"
+require "vkontakte_helper"
+ActionView::Base.send :include, VkontakteAuthentication::Helper

data/js/vkontakte.js

@@ -0,0 +1,36 @@
+function init(id)
+{
+    window.vkAsyncInit = function() {
+        VK.init({
+            apiId: id,
+            nameTransportPath: '/xd_receiver.html'
+        });
+        VK.UI.button('vk_login');
+    };
+    (function() {
+        var el = document.createElement("script");
+        el.type = "text/javascript";
+        el.charset = "windows-1251";
+        el.src = "http://vkontakte.ru/js/api/openapi.js";
+        el.async = true;
+        document.getElementById("vk_api_transport").appendChild(el);
+    }());
+}
+
+
+function doLogin() {
+    VK.Auth.login(
+            loginInternal,
+            VK.access.FRIENDS | VK.access.WIKI
+            );
+
+}
+function doLogout() {
+    VK.Auth.logout(logoutOpenAPI);
+}
+
+function loginInternal(response)
+{
+    $.post("/user_session", response, "script" );
+    return false;
+}

data/lib/profile_loader.rb

@@ -0,0 +1,42 @@
+module VkontakteAuthentication
+
+  class YmlLoadError < StandardError; end
+  class NoSettingsError < StandardError; end
+
+  class ProfileLoader
+
+    def initialize
+      @vkontakte_yml = nil
+    end
+
+    def vkontakte_yml_defined?
+        vkontakte_file && File.exist?(vkontakte_file)
+    end
+
+    def param(key)
+      vkontakte_yml[key.to_s]
+    end
+
+    private
+
+      def vkontakte_yml
+        return @vkontakte_yml if @vkontakte_yml
+        unless vkontakte_yml_defined?
+          raise(NoSettingsError,"vkontakte.yml was not found.\n")
+        end
+
+        require "yaml"
+
+        begin
+          @vkontakte_yml = YAML.load_file(vkontakte_file)
+        rescue StandardError => e
+          raise(YmlLoadError,"vkontakte.yml was found, but could not be parsed.\n")                    
+        end
+      end
+
+      def vkontakte_file
+        @vkontakte_file ||= Dir.glob('{,.config/,config/}vkontakte{.yml,.yaml}').first
+      end
+    
+  end
+end

data/lib/settings.rb

@@ -0,0 +1,21 @@
+module VkontakteAuthentication
+
+  module Settings
+    def profile_loader
+      @profile_loader ||= ProfileLoader.new
+    end
+
+    def vk_app_id
+      @vk_app_id ||= profile_loader.param(:vk_app_id)
+    end
+
+    def vk_app_password
+      @vk_app_password ||= profile_loader.param(:vk_app_password)
+    end
+
+    def vk_app_cookie
+      'vk_app_' + vk_app_id.to_s
+    end
+
+  end
+end

data/lib/tasks/vkontakte.rake

@@ -0,0 +1,22 @@
+namespace :vkontakte do
+    desc "Init resources for plugin"
+    task :init => [:yml, :javascripts]
+
+    desc "Copy vkontakte.yml to current rails application"
+    task :yml do
+      puts "Copying YAML file..."
+      project_dir = RAILS_ROOT
+      yml = File.join(File.dirname(__FILE__), '..', '..', 'vkontakte.yml')    
+      FileUtils.cp(yml, project_dir)
+      puts "vkontakte.yml copied successfully!"
+    end 
+
+    desc "Copy javascript to current rails application"
+    task :javascripts do
+      puts "Copying javascript files..."
+      project_dir = RAILS_ROOT + '/public/javascripts/'
+      scripts = Dir[File.join(File.dirname(__FILE__), '..', '..', '/js/', '*.js')]     
+      FileUtils.cp(scripts, project_dir)
+      puts "Files copied successfully!"
+    end  
+end

data/lib/vkontakte_authentication.rb

@@ -0,0 +1,94 @@
+require "profile_loader"
+require "settings"
+require "md5"
+
+module VkontakteAuthentication
+
+  class NotInitializedError < StandardError;
+  end
+
+  module ClassMethods
+    include Settings    
+
+    def find_by_vk_id_method(value = nil)
+      rw_config(:find_by_vk_id_method, value, "find_by_vk_id")
+    end
+    alias_method :find_by_vk_id_method=, :find_by_vk_id_method
+
+    def vk_id_field(value = nil)
+      rw_config(:vk_id_field, value, :vk_id)
+    end
+    alias_method :vk_id_field=, :vk_id_field
+
+    def vkontakte_authentication
+      raise(NotInitializedError, "create and initialize vkontakte.yml") unless profile_loader.vkontakte_yml_defined? && vk_app_id && vk_app_password
+    end
+    
+  end
+
+  module InstanceMethods
+
+    private
+
+    def credentials=(value)
+      super
+      cookies = value.is_a?(Array) ? value.first : value
+      if cookies.is_a?(ActionController::CookieJar) && cookies[vk_app_cookie]
+        @vk_cookies = CGI::parse(cookies[vk_app_cookie])        
+      end
+    end
+
+    def authenticating_with_vkontakte?
+      @vk_cookies
+    end
+
+    def validate_by_vk_cookie
+      result = "expire=%smid=%ssecret=%ssid=%s%s" % [@vk_cookies['expire'], @vk_cookies['mid'], @vk_cookies['secret'], @vk_cookies['sid'], self.class.vk_app_password]
+      if MD5.md5(result).to_s == @vk_cookies['sig'].to_s
+        raise(NotInitializedError, "you must define vk_id column in your User model") unless record_class.respond_to? find_by_vk_id_method
+        mid_cookie = @vk_cookies['mid'].first
+        possible_record = search_for_record(find_by_vk_id_method, mid_cookie)
+        if possible_record.nil?
+          possible_record = record_class.new(vk_id_field => mid_cookie)
+          possible_record.send :persistence_token=, Authlogic::Random.hex_token if possible_record.respond_to? :persistence_token=
+          possible_record.send :save, false
+        end
+        self.attempted_record = possible_record
+      end
+    end
+
+    def vk_app_cookie
+      self.class.vk_app_cookie
+    end
+
+    def find_by_vk_id_method
+      self.class.find_by_vk_id_method      
+    end
+
+    def vk_id_field
+      self.class.vk_id_field
+    end
+
+    def record_class
+      self.class.klass
+    end
+
+    def destroy_vkontakte_cookies
+      controller.cookies.delete vk_app_cookie
+    end
+  end
+
+
+end
+
+ActiveRecord::Base.class_eval do
+  extend VkontakteAuthentication::ClassMethods
+  attr_accessible vk_id_field
+end
+
+Authlogic::Session::Base.class_eval do
+  include VkontakteAuthentication::InstanceMethods
+  extend VkontakteAuthentication::ClassMethods
+  after_destroy :destroy_vkontakte_cookies
+  validate :validate_by_vk_cookie, :if => :authenticating_with_vkontakte?
+end

data/lib/vkontakte_helper.rb

@@ -0,0 +1,20 @@
+require "settings"
+
+module VkontakteAuthentication  
+  module Helper
+    include Settings
+
+    def vkontakte_init_tag
+      content_tag(:div, "", :id => "vk_api_transport") +
+      content_tag(:script, "init(#{vk_app_id});")            
+    end
+
+    def vkontakte_javascript_include_tag
+      javascript_include_tag "vkontakte"
+    end
+
+    def vk_login_button
+      content_tag(:div, "", {:id => "vk_login", :onclick => "doLogin(); return false;"})
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: authlogic_vkontakte
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Igor Petrov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: Bind vkontakte authentication to your authlogic project
+email: garik.piton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/profile_loader.rb
+- lib/settings.rb
+- lib/tasks/vkontakte.rake
+- lib/vkontakte_authentication.rb
+- lib/vkontakte_helper.rb
+files: 
+- README.rdoc
+- Rakefile
+- authlogic_vkontakte.gemspec
+- init.rb
+- js/vkontakte.js
+- lib/profile_loader.rb
+- lib/settings.rb
+- lib/tasks/vkontakte.rake
+- lib/vkontakte_authentication.rb
+- lib/vkontakte_helper.rb
+- Manifest
+has_rdoc: true
+homepage: http://github.com/GarPit/authlogic_vkontakte
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Authlogic_vkontakte
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: authlogic_vkontakte
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bind vkontakte authentication to your authlogic project
+test_files: []
+