omniauth-qq 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-qq.gemspec
+gemspec

data/README.md

@@ -0,0 +1,133 @@
+# Omniauth QQ
+
+This is QQ strategies collection for OmniAuth 1.0, which includes TQQ and QQ-Connect.
+  
+## [TQQ](http://open.t.qq.com/) OAuth
+  Strategy from https://github.com/ballantyne/omniauth-tqq, credit go to Scott Ballantyne.
+  Please note that some modifies had written into for my own purpose, like: raw_info attributes rewrote.
+    
+## [QQ-Connect](http://connect.qq.com/intro/login/) OAuth2
+  Strategy from https://github.com/kaichen/omniauth-qq-connect, credit go to Kai Chen.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-qq'
+```
+
+Then `bundle install`.
+
+Or install it yourself as:
+
+    $ gem install omniauth-qq
+
+## Usage
+
+`OmniAuth::Strategies::Qq` is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :tqq, ENV['TQQ_KEY'], ENV['TQQ_SECRET']
+  provider :qq_connect, ENV['QQ_CONNECT_KEY'], ENV['QQ_CONNECT_SECRET']
+end
+```
+
+## Authentication Hash
+
+Here's an example *Authentication Hash* available in `request.env['omniauth.auth']`:
+
+### TQQ returns:
+
+```ruby
+{
+  :provider => 'tqq',
+  :uid => 'B11630C4...', # QQ call it openid
+  :info => {
+    :nickname => 'beenhero',
+    :email => '',
+    :name => 'beenhero',
+    :location => '杭州',
+    :image => 'http://app.qlogo.cn/mbloghead/b8bc8cee839d42d1824c/40',
+    :description => '碳水化合物而已',
+    :urls => { :Tqq => 't.qq.com/beenhero' },
+  },
+  :credentials => {
+    :token => '2.00JjgzmBd7F...', # OAuth access_token, which you may wish to store
+    :secret => 'ac737720847e...',
+  },
+  :extra => {
+    :raw_info => {
+      :data => {
+        ... # data from http://open.t.qq.com/api/user/info?format=json, check by yourself
+      },
+      # extracted some general named attribute from [date]
+      :gender => 'm', # m: male, f: female, '': none
+      :followers_count: 53,
+      :friends_count: 14,
+    }
+  }
+}
+```
+
+### QQ-Connect returns:
+
+```ruby
+{
+  :provider => 'qq_connect',
+  :uid => 'B11630C4...', # QQ call it openid
+  :info => {
+    :nickname => 'beenhero',
+    :image => 'http://qzapp.qlogo.cn/qzapp/100250034/B11630C4AAC8C17B57ECFEA80852C813/50',
+    # so little info !? I think so, QQ-Connect only provides so, you can check from the raw_info below. Or you can try TQQ instead :)
+  },
+  :credentials => {
+    :token => '2.00JjgzmBd7F...', # OAuth 2.0 access_token, which you may wish to store
+    :expires_at => 1331780640, # when the access token expires (if it expires)
+    :expires => true # if you request `offline_access` this will be false
+  },
+  :extra => {
+    :raw_info => {
+      ... # little info from https://graph.qq.com/user/get_user_info
+    }
+  }
+}
+```
+
+*PS.* Built and tested on MRI Ruby 1.9.3
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2012 by Bin He
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/omniauth-qq.rb

@@ -0,0 +1,3 @@
+require "omniauth-qq/version"
+require 'omniauth/strategies/qq_connect'
+require 'omniauth/strategies/tqq'

data/lib/omniauth-qq/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Qq
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/qq_connect.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class QQConnect < OmniAuth::Strategies::OAuth2
+      option :name, "qq_connect"
+
+      option :client_options, {
+        :site => 'https://graph.qq.com/oauth2.0/',
+        :authorize_url => '/oauth2.0/authorize',
+        :token_url => "/oauth2.0/token"
+      }
+
+      option :token_params, {
+        :state => 'foobar',
+        :parse => :query
+      }
+
+      uid do
+        @uid ||= begin
+          access_token.options[:mode] = :query
+          access_token.options[:param_name] = :access_token
+          # Response Example: "callback( {\"client_id\":\"11111\",\"openid\":\"000000FFFF\"} );\n"
+          response = access_token.get('/oauth2.0/me')
+          #TODO handle error case
+          matched = response.body.match(/"openid":"(?<openid>\w+)"/)
+          matched[:openid]
+        end
+      end
+
+      info do 
+        { 
+          :nickname => raw_info['nickname'],
+          :image => raw_info['figureurl_1'],
+        }
+      end
+      
+      extra do
+        {
+          :raw_info => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= begin
+          #TODO handle error case
+          #TODO make info request url configurable
+          client.request(:get, "https://graph.qq.com/user/get_user_info", :params => {
+              :format => :json,
+              :openid => uid,
+              :oauth_consumer_key => options[:client_id],
+              :access_token => access_token.token
+            }, :parse => :json).parsed
+        end
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization('qq_connect', 'QQConnect')

data/lib/omniauth/strategies/tqq.rb

@@ -0,0 +1,83 @@
+require 'omniauth-oauth'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class Tqq < OmniAuth::Strategies::OAuth
+      option :name, 'tqq'
+      option :sign_in, true
+      def initialize(*args)
+        super
+        # taken from https://github.com/intridea/omniauth/blob/0-3-stable/oa-oauth/lib/omniauth/strategies/oauth/tqq.rb#L15-24
+        options.client_options = {
+          :access_token_path => '/cgi-bin/access_token',
+          :authorize_path => '/cgi-bin/authorize',
+          :http_method => :get,
+          :nonce => nonce,
+          :realm => 'OmniAuth',
+          :request_token_path => '/cgi-bin/request_token',
+          :scheme => :query_string,
+          :site => 'https://open.t.qq.com',
+        }
+      end
+
+      # https://github.com/intridea/omniauth/blob/0-3-stable/oa-oauth/lib/omniauth/strategies/oauth/tqq.rb#L28-30
+      def nonce
+        Base64.encode64(OpenSSL::Random.random_bytes(32)).gsub(/\W/, '')[0, 32]
+      end
+
+      def consumer
+        consumer = ::OAuth::Consumer.new(options.consumer_key, options.consumer_secret, options.client_options)
+        consumer
+      end
+
+      uid { raw_info['data']['openid'] }
+
+      info do
+        {
+          :nickname => raw_info['data']['nick'],
+          :email => raw_info['data']['email'],
+          :name => raw_info['data']['name'],
+          :location => raw_info['data']['location'],
+          :image => raw_info['data']['head'] + '/40',
+          :description => raw_info['data']['introduction'],
+          :urls => {
+            'Tqq' => 't.qq.com/' + raw_info['data']['name']
+          }
+        }
+      end
+
+      extra do
+        # rename some attribute to my own needs.
+        raw_info['gender'] ||= raw_info['data']['sex'] == 1 ? 'm' : (raw_info['data']['sex'] == 2 ? 'f' : '')
+        raw_info['followers_count'] ||= raw_info['data']['fansnum']
+        raw_info['friends_count'] ||= raw_info['data']['idolnum']
+        { :raw_info => raw_info }
+      end
+
+      #taken from https://github.com/intridea/omniauth/blob/0-3-stable/oa-oauth/lib/omniauth/strategies/oauth/tsina.rb#L52-67
+      def request_phase
+        request_token = consumer.get_request_token(:oauth_callback => callback_url)
+        session['oauth'] ||= {}
+        session['oauth'][name.to_s] = {'callback_confirmed' => true, 'request_token' => request_token.token, 'request_secret' => request_token.secret}
+
+        if request_token.callback_confirmed?
+          redirect request_token.authorize_url(options[:authorize_params])
+        else
+          redirect request_token.authorize_url(options[:authorize_params].merge(:oauth_callback => callback_url))
+        end
+
+      rescue ::Timeout::Error => e
+        fail!(:timeout, e)
+      rescue ::Net::HTTPFatalError, ::OpenSSL::SSL::SSLError => e
+        fail!(:service_unavailable, e)
+      end
+
+      def raw_info
+        @raw_info ||= MultiJson.decode(access_token.get('http://open.t.qq.com/api/user/info?format=json').body)
+      rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+    end
+  end
+end

data/omniauth-qq.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-qq/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bin He"]
+  gem.email         = ["beenhero@gmail.com"]
+  gem.description   = %q{OmniAuth strategies for TQQ and QQ Connect).}
+  gem.summary       = %q{OmniAuth strategies for TQQ and QQ Connect).}
+  gem.homepage      = "https://github.com/beenhero/omniauth-qq"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-qq"
+  gem.require_paths = ["lib"]
+  gem.version       = Omniauth::Qq::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.0'
+  gem.add_dependency 'multi_json'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-qq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bin He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &70123960967340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70123960967340
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: &70123960966780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70123960966780
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70123960966380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70123960966380
+description: OmniAuth strategies for TQQ and QQ Connect).
+email:
+- beenhero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-qq.rb
+- lib/omniauth-qq/version.rb
+- lib/omniauth/strategies/qq_connect.rb
+- lib/omniauth/strategies/tqq.rb
+- omniauth-qq.gemspec
+homepage: https://github.com/beenhero/omniauth-qq
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategies for TQQ and QQ Connect).
+test_files: []