oa-vkontakte_alexandrov 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nick Recobra, Igor Alexandrov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,78 @@
+= oa-vkontakte
+
+Расширение для OmniAuth, реализующее аутентификацию через Vkontate Open Api.
+
+== Установка
+
+  gem install oa-vkontakte
+
+Добавить в config/initializers/omniauth.rb:
+
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :vkontakte, <ID приложения>, <Защищенный ключ приложения>
+  end
+
+Если ещё не определен, добавить путь в config/routes.rb:
+
+  match '/auth/:provider/callback' => 'authentications#create'
+
+В нужную вьюху добавить хелпер, рисующий кнопку входа:
+
+  <%= vkontakte_login_button %>
+
+Также кнопка доступна по адресу /auth/vkontakte, но форма там передается GET-запросом. Можно пропробовать встроить её как iframe.
+
+После клика на кнопку и разрешения добавления приложения, будет совершен POST-запрос на /auth/vkontakte/callback.
+В action, к которому будет привязан этот путь, будет доступна переменная
+
+  request["omniauth.auth"]
+
+Содержание этой переменной примерно следующее:
+
+  {
+    'uid' => '1234567890', # ID пользователя vkontakte.ru
+    'provider' => 'vkontakte',
+    'user_info' => {
+      'name' => 'Nick Recobra',
+      'nickname' => 'oruen',
+      'first_name' => 'Nick',
+      'last_name' => 'Recobra',
+      'image' => 'http://cs191.vkontakte.ru/u00001/e_375bc433.jpg', # путь до вконтактовского аватара
+      'urls' => { 'Page' => 'http://vkontakte.ru/id1234567890' } 
+    }
+  }
+
+== Интеграция с Devise
+
+Devise с версии 1.2.rc интегрирован с OmniAuth. Подключить к нему <tt>oa-vkontakte</tt> достаточно просто, дописав в <tt>config/initializers/devise.rb</tt>:
+  config.omniauth :vkontakte, <ID приложения>, <Защищенный ключ приложения>
+Callback будет приходить действию Devise::OmniauthCallbacks#vkontakte, так что придется озаботиться его наличием. Это удобно сделать, поменяв контроллер для callback'ов OmniAuth в <tt>routes.rb</tt>:
+  devise_for :users, :controllers => { :omniauth_callbacks => "authentications" }
+AuthenticationsController в этом случае выглядит как-то так:
+  class AuthenticationsController < Devise::OmniauthCallbacksController
+    def vkontakte
+      omniauth = request.env["omniauth.auth"]
+      # создание или аутентификация пользователя
+      ...
+    end
+  end
+
+== Ссылки
+
+OmniAuth: http://github.com/intridea/omniauth
+
+Интеграция OmniAuth и Devise: http://railscasts.com/episodes/235-omniauth-part-1 и http://railscasts.com/episodes/236-omniauth-part-2
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Nick Recobra. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+    gem.name = "oa-vkontakte_alexandrov"
+    gem.homepage = "http://github.com/igor-alexandrov/oa-vkontakte"
+    gem.license = "MIT"
+    gem.summary = %Q{VKontakte OmniAuth module with view helpers}
+    gem.description = %Q{Include this gem into your project with OmniAuth gem and you will get VKontakte login in one line of code.}
+    gem.email = "igor.alexandrov@gmail.com"
+    gem.authors = ["Igor Alexandrov"]
+    gem.add_dependency 'oa-core', '~>0.1.4'
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+  end
+  Jeweler::RubygemsDotOrgTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+  
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/oa-vkontakte.rb

@@ -0,0 +1,5 @@
+require 'omniauth/vkontakte'
+
+if defined?(Rails)
+  ActionController::Base.helper OmniAuth::Strategies::Vkontakte::ViewHelper::PageHelper
+end

data/lib/omniauth/strategies/vkontakte.rb

@@ -0,0 +1,58 @@
+require 'omniauth/vkontakte'
+require 'omniauth/strategies/vkontakte/view_helper'
+
+module OmniAuth
+  class Configuration
+    attr_accessor :vkontakte_app_id
+    attr_accessor :vkontakte_app_key
+  end
+end
+
+module OmniAuth
+  module Strategies
+    class Vkontakte
+      include OmniAuth::Strategy
+      include ViewHelper::PageHelper
+
+      def initialize(app, app_id, app_key, options = {})
+        @options = options
+        OmniAuth.config.vkontakte_app_id = app_id
+        OmniAuth.config.vkontakte_app_key = app_key
+        super(app, :vkontakte)
+      end
+
+      attr_reader :app_id
+      
+      def request_phase
+        Rack::Response.new(vkontakte_login_page).finish
+      end
+
+      def callback_phase
+        app_cookie = request.cookies["vk_app_#{OmniAuth.config.vkontakte_app_id}"]
+        return fail!(:invalid_credentials) unless app_cookie
+        args = app_cookie.split("&")
+        sig_index = args.index { |arg| arg =~ /^sig=/ }
+        return fail!(:invalid_credentials) unless sig_index
+        sig = args.delete_at(sig_index)
+        puts Digest::MD5.new.hexdigest(args.sort.join('') + OmniAuth.config.vkontakte_app_key)
+        puts sig
+        return fail!(:invalid_credentials) unless Digest::MD5.new.hexdigest(args.sort.join('') + OmniAuth.config.vkontakte_app_key) == sig[4..-1]
+        super
+      end
+
+      def auth_hash
+        OmniAuth::Utils.deep_merge(super(), {
+          'uid' => request[:uid],
+          'user_info' => {
+            'nickname' => request[:nickname],
+            'name' => "#{request[:first_name]} #{request[:last_name]}",
+            'first_name' => request[:first_name],
+            'last_name' => request[:last_name],
+            'image' => request[:photo],
+            'urls' => { 'Page' => 'http://vkontakte.ru/id' + request[:uid] }
+          }
+        })
+      end
+    end
+  end
+end

data/lib/omniauth/strategies/vkontakte/view_helper.rb

@@ -0,0 +1,130 @@
+# coding: utf-8
+module OmniAuth
+  module Strategies
+    class Vkontakte
+      class ViewHelper
+        module PageHelper
+          def vkontakte_login_page
+            vkontakte_header +
+            vkontakte_login_button +
+            vkontakte_footer
+          end
+
+          def vkontakte_header
+<<-HEADER
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 
+  <html xmlns="http://www.w3.org/1999/xhtml"> 
+  <head> 
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>Вход во ВКонтакте</title>
+  </head> 
+  <body>
+HEADER
+          end
+          
+          def vkontakte_login_button
+<<-BUTTON
+<div id="vk_api_transport"></div>
+<script type="text/javascript">
+  window.vkAsyncInit = function() {
+    VK.init({
+      apiId: '#{OmniAuth.config.vkontakte_app_id}',
+      nameTransportPath: "/xd_receiver.html"
+    });
+    VK.UI.button('vk_login');
+  };
+  vkLogin = {
+    doLogin: function() {
+      VK.Auth.login(vkLogin.loginResult);
+    },
+    redirectWithPost: function(url, data) {
+      data = data || {};
+      #{ respond_to?(:request_forgery_protection_token) && respond_to?(:form_authenticity_token) ?
+      "data['#{request_forgery_protection_token}'] = '#{form_authenticity_token}'; var method = 'POST';" :
+      "var method = 'GET';" }
+      var form = document.createElement("form"),
+          input;
+      form.setAttribute("action", url);
+      form.setAttribute("method", method);
+  
+      for (var property in data) {
+        if (data.hasOwnProperty(property)) {
+          var value = data[property];
+          if (value instanceof Array) {
+            for (var i = 0, l = value.length; i < l; i++) {
+              input = document.createElement("input");
+              input.setAttribute("type", "hidden");
+              input.setAttribute("name", property);
+              input.setAttribute("value", value[i]);
+              form.appendChild(input);
+            }
+          }
+          else {
+            input = document.createElement("input");
+            input.setAttribute("type", "hidden");
+            input.setAttribute("name", property);
+            input.setAttribute("value", value);
+            form.appendChild(input);
+          }
+        }
+      }
+      document.body.appendChild(form);
+      form.submit();
+      document.body.removeChild(form);
+    },
+    loginResult: function (r) {
+      if (r.session) {
+        if (r.session.expire != "0") {
+          vkLogin.getUserProfile(vkLogin.putUserProfile);
+        } else if (r.session.expire == "0") {
+          VK.Observer.subscribe("auth.sessionChange", function (r) {
+            VK.Observer.unsubscribe("auth.sessionChange");
+            if (r.session && r.session.expire != "0") {
+              vkLogin.getUserProfile(vkLogin.putUserProfile)
+            } else {
+            }
+          });
+          VK.Auth.login()
+        }
+      }
+    },
+    getUserProfile: function (callFunc) {
+      var code;
+      code = 'return {';
+      code += 'me: API.getProfiles({uids: API.getVariable({key: 1280}), fields: "nickname,sex,photo"})[0]';
+      code += '};';
+      VK.Api.call('execute', {
+        'code': code
+      },
+      callFunc);
+    },
+    putUserProfile: function (data) {
+      if (data.response) {
+        r = data.response;
+        vkLogin.redirectWithPost('#{OmniAuth.config.path_prefix}/vkontakte/callback', r.me);
+      }
+    }
+	};
+  (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);
+  }());
+</script>
+<div id="vk_login" onclick="vkLogin.doLogin();"></div>
+BUTTON
+          end
+
+          def vkontakte_footer
+<<-FOOTER
+  </body></html>
+FOOTER
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/vkontakte.rb

@@ -0,0 +1,8 @@
+require 'omniauth/core'
+
+module OmniAuth
+  module Strategies
+    autoload :Vkontakte, 'omniauth/strategies/vkontakte'
+  end
+end
+

data/oa-vkontakte.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "oa-vkontakte/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{oa-vkontakte}
+  s.version = Oa::Vkontakte::VERSION
+  s.authors = ["Nick Recobra"]
+  s.summary = %q{OmniAuth extension for vkontakte.ru authentication}
+  s.description = %q{OmniAuth extension for vkontakte.ru authentication}
+  s.email = %q{oruenu@gmail.com}
+  s.homepage = %q{http://github.com/oruen/oa-vkontakte}
+  s.rubyforge_project = %q{oa-vkontakte}
+  
+  s.add_dependency(%q<oa-core>, [">= 0.1.6"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+  s.add_development_dependency(%q<yard>, [">= 0"])
+  s.add_development_dependency(%q<rack-test>, ["~> 0.5.6"])
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/spec/oa-vkontakte_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "OaVkontakte" do
+end

data/spec/omniauth/strategires/vkontakte_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe OmniAuth::Strategies::Vkontakte, :type => :strategy do
+
+  include OmniAuth::Test::StrategyTestCase
+
+  def strategy
+    [OmniAuth::Strategies::Vkontakte, 1983892, '6FF1PUlZfEyutJxctvtd']
+  end
+
+  describe 'POST /auth/vkontakte_open_api/callback с логином и паролем' do
+    before(:each) do
+      @params = {
+        'nickname' => 'oruen',
+        'first_name' => 'Nick',
+        'last_name' => 'Recobra',
+        'photo' => 'http://cs191.vkontakte.ru/u00001/e_375bc433.jpg',
+        'uid' => '1234567890'
+      }
+    end
+
+    context "неуспешный запрос" do
+      it "не должен быть успешным при отсутствии куки vk_app_<APP_ID>" do
+        clear_cookies
+        post '/auth/vkontakte/callback', @params
+        last_response.should_not be_ok
+      end
+
+      it "не должен быть успешным при невалидной куке vk_app_<APP_ID>" do
+        set_cookie "vk_app_#{OmniAuth.config.vkontakte_app_id}=expire"
+        post '/auth/vkontakte/callback', @params
+        last_response.should_not be_ok
+      end
+    end
+
+    context "успешный запрос" do
+      before(:each) do
+        strategy = nil
+        string = "expire=1271238742&mid=100172&secret=97c1e8933e&sid=549b550f608e4a4d247734941debb5e68df50a66c58dc6ee2a4f60a2&sig=372df9795fe8dd29684a2f996872457c"
+        set_cookie "vk_app_#{OmniAuth.config.vkontakte_app_id}=#{Rack::Utils::escape string}"
+        post '/auth/vkontakte/callback', @params
+      end
+
+      it "должен устанавливаться защищенный ключ" do
+        OmniAuth.config.vkontakte_app_key.should == '6FF1PUlZfEyutJxctvtd'
+      end
+  
+      
+      it 'должен быть успешным' do
+        last_response.should be_ok
+      end
+
+      sets_an_auth_hash
+
+      sets_provider_to 'vkontakte'
+
+      it 'должен устанавливать параметры' do
+        hash = last_request.env['omniauth.auth']
+        hash.should == {
+          'uid' => '1234567890',
+          'provider' => 'vkontakte',
+          'user_info' => {
+            'name' => 'Nick Recobra',
+            'nickname' => 'oruen',
+            'first_name' => 'Nick',
+            'last_name' => 'Recobra',
+            'image' => 'http://cs191.vkontakte.ru/u00001/e_375bc433.jpg',
+            'urls' => { 'Page' => 'http://vkontakte.ru/id1234567890' } 
+          }
+        }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'rspec'
+require 'omniauth/test'
+require 'rack/test'
+require 'oa-vkontakte'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+  c.include Rack::Test::Methods
+  c.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: oa-vkontakte_alexandrov
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Igor Alexandrov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oa-core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Include this gem into your project with OmniAuth gem and you will get VKontakte login in one line of code.
+email: igor.alexandrov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/oa-vkontakte.rb
+- lib/omniauth/strategies/vkontakte.rb
+- lib/omniauth/strategies/vkontakte/view_helper.rb
+- lib/omniauth/vkontakte.rb
+- oa-vkontakte.gemspec
+- spec/oa-vkontakte_spec.rb
+- spec/omniauth/strategires/vkontakte_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/igor-alexandrov/oa-vkontakte
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: VKontakte OmniAuth module with view helpers
+test_files: 
+- spec/oa-vkontakte_spec.rb
+- spec/omniauth/strategires/vkontakte_spec.rb
+- spec/spec_helper.rb