oa-mailru 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Alexander Gorkunov
+
+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,83 @@
+= oa-mailru
+
+Auhtorization with Mail.RU extension for OmniAuth
+
+== Installation
+
+  gem install oa-mailru
+
+Add to config/initializers/omniauth.rb:
+
+  #for rails3 projects
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :mail_ru_api, <Application ID>, <Private Key>
+  end
+  #for rails2 projects
+  ActionController::Dispatcher.middleware.use "OmniAuth::Builder" do
+    provider :mail_ru_api, <Application ID>, <Private Key>
+  end
+
+If omniauth routes doesn't exist add them to config/routes.rb (e.g.):
+
+  #rails3
+  match '/auth/:provider/callback' => 'authentications#create'
+  #rails2
+  map.auth_callback '/auth/:provider/callback', :controller => :authentications :action => :create
+
+Then use special helper method for generate mail.ru button:
+
+  <%= raw mailru_login_button %>
+
+or if you want use custom button then use:
+
+  <%= raw mailru_login_button("<a href='#' onclick='mailruLogin.login();'>Mail.RU Login</a>") %>
+
+or if you want use jquery ajaxForm then use:
+
+  <%= raw mailru_login_button(nil, true) %>
+
+ajaForm with custom button
+
+  <%= raw mailru_login_button("<a href='#' onclick='mailruLogin.login();'>Mail.RU Login</a>", true) %>
+
+After click on the button popup window with mail.ru auth-page will be shown and after user was signed in and added 
+permissions for the application then user-data will be transfered with POST-request to /auth/mailru/callback path.
+In action with this path you can use params from request["omniauth.auth"] which body look like:
+
+  {
+    'uid' => '1234567890', # user Id from mail.ru
+    'provider' => 'mailru',
+    'user_info' => {
+      'nick' => 'alexander.gorkunov',
+      'name' => 'Alexander Gorkunov',
+      'first_name' => 'Alexander',
+      'last_name' => 'Gorkunov',
+      'picture' => 'userpic url here'
+      'country' => 'Russia',
+      'town' => 'Samara'
+    },
+    'extra' => {'user_hash' => 'some additional data here'}
+  }
+
+== Debuging Information
+
+Mail.RU API has some host name permission restrictions, so correct debugging session is available only on public server with 
+some host name (don't forget to put receiver.html to root directory of your site).
+
+== Links
+
+OmniAuth: http://github.com/intridea/omniauth
+
+== 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 Alexander Gorkunov. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "oa-mailru"
+    gem.summary = %Q{OmniAuth extension for mail.ru authentication}
+    gem.description = %Q{OmniAuth extension for mail.ru authentication}
+    gem.email = "alexander.gorkunov@gmail.com"
+    gem.homepage = "http://github.com/gorkunov/oa-mailru"
+    gem.authors = ["Alexander Gorkunov"]
+    gem.rubyforge_project = "oa-mailru"
+    gem.add_dependency 'oa-core', '~>0.1.4'
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "yardoc"
+  end
+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.0.1

data/lib/oa-mailru.rb

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

data/lib/omniauth/mailru.rb

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

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

@@ -0,0 +1,128 @@
+# coding: utf-8
+module OmniAuth
+  module Strategies
+    class MailRuApi
+      class ViewHelper
+        module PageHelper
+          def mailru_login_page
+            mailru_header +
+            mailru_login_button +
+            mailru_footer
+          end
+
+          def mailru_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>Вход в Mail.RU</title>
+  </head> 
+  <body>
+HEADER
+          end
+          
+          def mailru_login_button(control = nil, use_jquery_form = false)
+            unless control.present?
+              control = "<a class='mrc__connectButton'></a>" 
+              init_control = "mailru.connect.initButton();"
+            end
+<<-BUTTON
+<div id="mailru_api_transport" style="display:inline;"></div>
+<script type="text/javascript">
+  mailruLogin = {
+    initialized: false,
+    initMailRuApi: function() {
+        mailru.connect.init('#{OmniAuth.config.mailru_app_id}', '#{OmniAuth.config.mailru_private_key}');
+        #{init_control}
+        mailru.events.listen(mailru.connect.events.login, function(session){
+                mailru.common.users.getInfo(function(result){
+                  mailruLogin.redirectWithPost('#{OmniAuth.config.path_prefix}/mailru/callback', result[0]);
+                });
+        });
+        mailruLogin.initialized = true;
+    },
+    onLoad: function() {
+      mailru.loader.require('api', function() {
+        mailruLogin.initMailRuApi();
+      });
+    },
+    login: function(){
+      if(!mailruLogin.initialized) mailruLogin.initMailRuApi();
+      mailru.connect.login();
+    },
+    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(property == 'location') {
+            input = document.createElement("input");
+            input.setAttribute("type", "hidden");
+            input.setAttribute("name", 'county');
+            input.setAttribute("value", value['country']['name']);
+            form.appendChild(input);
+            input = document.createElement("input");
+            input.setAttribute("type", "hidden");
+            input.setAttribute("name", 'city');
+            input.setAttribute("value", value['city']['name']);
+            form.appendChild(input);
+          }
+          else 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);
+      #{ user_ajax ? "$(form).ajaxSubmit({ dataType: 'script' });" : "form.submit();" }
+      document.body.removeChild(form);
+    }
+  };
+  (function() {
+    var el = document.createElement("script");
+    el.type = "text/javascript";
+    el.charset = "windows-1251";
+    el.src = "http://cdn.connect.mail.ru/js/loader.js";
+    el.async = true;
+    el.onreadystatechange= function () {
+      if (this.readyState == 'complete') mailruLogin.onLoad();
+    }
+    el.onload= mailruLogin.onLoad;
+    document.getElementById("mailru_api_transport").appendChild(el);
+  }());
+</script>
+#{control}
+BUTTON
+          end
+
+          def mailru_footer
+<<-FOOTER
+  </body></html>
+FOOTER
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/strategies/mailru_api.rb

@@ -0,0 +1,48 @@
+require 'omniauth/mailru'
+require 'omniauth/strategies/mailru_api/view_helper'
+
+module OmniAuth
+  class Configuration
+    attr_accessor :mailru_app_id, :mailru_private_key
+  end
+end
+
+module OmniAuth
+  module Strategies
+    class MailRuApi
+      include OmniAuth::Strategy
+      include ViewHelper::PageHelper
+
+      def initialize(app, app_id, app_private_key, options = {})
+        OmniAuth.config.mailru_app_id = app_id
+        OmniAuth.config.mailru_private_key = app_private_key
+        @options = options
+        super(app, :mailru)
+      end
+
+      attr_reader :app_id
+      attr_reader :app_private_key
+      
+      def request_phase
+        Rack::Response.new(mailru_login_page).finish
+      end
+      
+      def auth_hash
+        OmniAuth::Utils.deep_merge(super(), {
+          'uid' => request[:uid],
+          'user_info' => {
+            'nick' => request[:nick],
+            'name' => "#{request[:first_name]} #{request[:last_name]}",
+            'first_name' => request[:first_name],
+            'last_name' => request[:last_name],
+            'picture' => request[:has_pic] ? request[:pic] : nil,
+            'country' => request[:country],
+            'town' => request[:city],
+            'urls' => { 'Page' => request[:link] }
+          },
+          'extra' => {'user_hash' => request}
+        })
+      end
+    end
+  end
+end

data/oa-mailru.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{oa-mailru}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexander Gorkunov"]
+  s.date = %q{2010-10-29}
+  s.description = %q{OmniAuth extension for mail.ru authentication}
+  s.email = %q{alexander.gorkunov@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/oa-mailru.rb",
+     "lib/omniauth/mailru.rb",
+     "lib/omniauth/strategies/mailru_api.rb",
+     "lib/omniauth/strategies/mailru_api/view_helper.rb",
+     "oa-mailru.gemspec"
+  ]
+  s.homepage = %q{http://github.com/gorkunov/oa-mailru}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{oa-mailru}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{OmniAuth extension for mail.ru authentication}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/oa-mailru_spec.rb"
+  ]
+
+  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
+      s.add_runtime_dependency(%q<oa-core>, ["~> 0.1.4"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<oa-core>, ["~> 0.1.4"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<oa-core>, ["~> 0.1.4"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/oa-mailru_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'oa-mailru'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: oa-mailru
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexander Gorkunov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 +04: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: OmniAuth extension for mail.ru authentication
+email: alexander.gorkunov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/oa-mailru.rb
+- lib/omniauth/mailru.rb
+- lib/omniauth/strategies/mailru_api.rb
+- lib/omniauth/strategies/mailru_api/view_helper.rb
+- oa-mailru.gemspec
+- spec/spec_helper.rb
+- spec/oa-mailru_spec.rb
+has_rdoc: true
+homepage: http://github.com/gorkunov/oa-mailru
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: oa-mailru
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: OmniAuth extension for mail.ru authentication
+test_files: 
+- spec/spec_helper.rb
+- spec/oa-mailru_spec.rb