omniauth-open-wechat-oauth2 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 898204931fda39d598afa5167f614ec00d1a906c
+  data.tar.gz: 8bb7018958785517be7e0463cd431cab7b0723cd
+SHA512:
+  metadata.gz: 91d3556864d848465f01503e8a9447a0e6ff144e0f8f39f5cc40ab918e3d3321453612cba22e88386f4753101f6ef9dbc7c319a675eac25493ca7f7b8511b3d8
+  data.tar.gz: 80509ae0d755a1d1c6a5349d2799ac7acef68e7c70e1f99f3cdad04a2416723aa5884ba3869d9906dc9a1123f3088f95ce88be1ff64f5f877a9c6ee1e16d8cac

data/.gitignore

@@ -0,0 +1,46 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# ===
+# vim
+# ===
+# https://github.com/github/gitignore/blob/master/Global/vim.gitignore
+.*.sw[a-z]
+*.un~
+Session.vim
+.netrwhist
+
+# ========
+# textmate
+# ========
+# https://github.com/github/gitignore/blob/master/Global/TextMate.gitignore
+*.tmproj
+*.tmproject
+tmtags
+
+# =======
+# sublime
+# =======
+# https://github.com/github/gitignore/blob/master/Global/SublimeText.gitignore
+# SublimeText project files
+*.sublime-workspace

data/Gemfile

@@ -0,0 +1,8 @@
+if ENV['NOGFW']
+    source 'https://rubygems.org'
+else
+    source 'https://ruby.taobao.org'
+end
+
+# Specify your gem's dependencies in omniauth-open-wechat-oauth2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Special Leung
+
+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/README.md

@@ -0,0 +1,78 @@
+# omniauth-open-wechat-oauth2
+
+Using OAuth2 to authenticate wechat user in web application.
+Base on [https://github.com/skinnyworm/omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2)
+
+Open Wechat Document: [https://open.weixin.qq.com/cgi-bin/frame?t=resource/res_main_tmpl&verify=1&lang=zh_CN](https://open.weixin.qq.com/cgi-bin/frame?t=resource/res_main_tmpl&verify=1&lang=zh_CN)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-open-wechat-oauth2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-open-wechat-oauth2
+
+## Usage
+
+Add provider to `config/initializers/omniauth.rb`
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :open_wechat, 'open_wechat_app_id', 'open_wechat_app_secret'
+end
+```
+
+Access the OmniAuth Open Wechat OAuth2 URL: /auth/open_wechat
+
+## Auth Hash
+
+A example of `request.env["omniauth.auth"]` :
+
+```ruby
+{
+    :provider => "open_wechat",
+    :uid => "unionid",
+    :info => {
+          openid:     "openid",
+          nickname:   "Nickname",
+          sex:        1,
+          province:   "Changning",
+          city:       "Shanghai",
+          country:    "China",
+          headimgurl: "http://image_url"
+        },
+    :credentials => {
+            :token => "token",
+            :refresh_token => "another_token",
+            :expires_at => 7200,
+            :expires => true
+        },
+    :extra => {
+            :raw_info => {
+                      openid:     "openid"
+                      nickname:   "Nickname",
+                      sex:        1,
+                      province:   "Changning",
+                      city:       "Shanghai",
+                      country:    "China",
+                      headimgurl: "http://image_url",
+                      unionid:    "xxxxxxxxx"
+                    }
+        }
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/omniauth-open-wechat-oauth2/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/VERSION

@@ -0,0 +1 @@
+1.0.3

data/lib/omniauth-open-wechat-oauth2.rb

@@ -0,0 +1 @@
+require "omniauth/strategies/open_wechat"

data/lib/omniauth/strategies/open_wechat.rb

@@ -0,0 +1,70 @@
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class OpenWechat < OmniAuth::Strategies::OAuth2
+      option :name, "open_wechat"
+
+      option :client_options, {
+        site:          "https://api.weixin.qq.com",
+        authorize_url: "https://open.weixin.qq.com/connect/qrconnect#wechat_redirect",
+        token_url:     "/sns/oauth2/access_token",
+        token_method:  :get
+      }
+
+      option :authorize_params, {scope: "snsapi_login"}
+
+      option :token_params, {parse: :json}
+
+      uid do
+        raw_info['unionid']
+      end
+
+      info do
+        {
+          openid:     raw_info["openid"],
+          nickname:   raw_info['nickname'],
+          sex:        raw_info['sex'],
+          province:   raw_info['province'],
+          city:       raw_info['city'],
+          country:    raw_info['country'],
+          headimgurl: raw_info['headimgurl']
+        }
+      end
+
+      extra do
+        {raw_info: raw_info}
+      end
+
+      def request_phase
+        params = client.auth_code.authorize_params.merge(redirect_uri: callback_url).merge(authorize_params)
+        params["appid"] = params.delete("client_id")
+        redirect client.authorize_url(params)
+      end
+
+      def raw_info
+        @uid ||= access_token["openid"]
+        @raw_info ||= begin
+          access_token.options[:mode] = :query
+          if access_token["scope"] && access_token["scope"].include?("snsapi_login")
+            @raw_info = access_token.get("/sns/userinfo", :params => {"openid" => @uid}, parse: :json).parsed
+          else
+            @raw_info = {"openid" => @uid }
+          end
+        end
+      end
+
+      protected
+      def build_access_token
+        params = {
+          'appid' => client.id, 
+          'secret' => client.secret,
+          'code' => request.params['code'],
+          'grant_type' => 'authorization_code' 
+          }.merge(token_params.to_hash(symbolize_keys: true))
+        client.get_token(params, deep_symbolize(options.auth_token_params))
+      end
+
+    end
+  end
+end

data/omniauth-open-wechat-oauth2.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-open-wechat-oauth2"
+  spec.version       = version
+  spec.authors       = ["Special Leung"]
+  spec.email         = ["specialcyci@gmail.com"]
+  spec.summary       = 'Omniauth strategy for open wechat(weixin), https://open.weixin.qq.com/'
+  spec.description   = 'Using OAuth2 to authenticate wechat user in web application.'
+  spec.homepage      = "https://github.com/mycolorway/omniauth-open-wechat-oauth2"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             'omniauth',        '~> 1.0'
+  spec.add_dependency             'omniauth-oauth2', '~> 1.0'
+  spec.add_development_dependency 'rspec',           '~> 2.7'
+  spec.add_development_dependency "bundler",         '~> 1.6'
+  spec.add_development_dependency "rake",            '~> 10.4'
+end

data/spec/omniauth/strategies/open_wechat_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::OpenWechat do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}, :scheme=>"http", :url=>"localhost") }
+  let(:app) { ->{[200, {}, ["Hello."]]}}
+  let(:client){OAuth2::Client.new('appid', 'secret')}
+
+  subject do
+    OmniAuth::Strategies::OpenWechat.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe '#client_options' do
+    specify 'has site' do
+      expect(subject.client.site).to eq('https://api.weixin.qq.com')
+    end
+
+    specify 'has authorize_url' do
+      expect(subject.client.options[:authorize_url]).to eq('https://open.weixin.qq.com/connect/qrconnect#wechat_redirect')
+    end
+
+    specify 'has token_url' do
+      expect(subject.client.options[:token_url]).to eq('/sns/oauth2/access_token')
+    end
+  end
+
+  describe "#authorize_params" do
+    specify "default scope is snsapi_login" do
+      expect(subject.authorize_params[:scope]).to eq("snsapi_login")
+    end
+  end
+
+  describe "#token_params" do
+    specify "token response should be parsed as json" do
+      expect(subject.token_params[:parse]).to eq(:json)
+    end
+  end
+
+  describe 'state' do
+    specify 'should set state params for request as a way to verify CSRF' do
+      expect(subject.authorize_params['state']).not_to be_nil
+      expect(subject.authorize_params['state']).to eq(subject.session['omniauth.state'])
+    end
+  end
+
+
+  describe "#request_phase" do
+    specify "redirect uri includes'appid','redirect_uri','response_type','scope','state'and'wechat_redirect'fragment" do
+      callback_url = "http://exammple.com/callback"
+
+      subject.stub(:callback_url=>callback_url)
+      subject.should_receive(:redirect).with do |redirect_url|
+        uri = URI.parse(redirect_url)
+        expect(uri.fragment).to eq("wechat_redirect")
+        params = CGI::parse(uri.query)
+        expect(params["appid"]).to eq(['appid'])
+        expect(params["redirect_uri"]).to eq([callback_url])
+        expect(params["response_type"]).to eq(['code'])
+        expect(params["scope"]).to eq(['snsapi_login'])
+        expect(params["state"]).to eq([subject.session['omniauth.state']])
+      end
+
+      subject.request_phase
+    end
+  end
+
+  describe "#build_access_token" do
+    specify "request includes'appid','secret','code','grant_type'and will parse response as json"do 
+      subject.stub(:client => client, :request=>double("request", params:{"code"=>"server_code"}))
+      client.should_receive(:get_token).with({
+        "appid" => "appid",
+        "secret" => "secret",
+        "code" => "server_code",
+        "grant_type" => "authorization_code",
+        :parse => :json
+      },{})
+      subject.send(:build_access_token)
+    end
+  end
+
+  describe "#raw_info" do
+    let(:access_token) { OAuth2::AccessToken.from_hash(client, {}) }
+    before { subject.stub(:access_token => access_token) }
+
+    context "when scope is snsapi_base" do
+      let(:access_token) { OAuth2::AccessToken.from_hash(client, {
+        "openid"=>"openid", 
+        "scope"=>"snsapi_base", 
+        "access_token"=>"access_token"
+      })}
+
+      specify "only have openid" do
+        expect(subject.raw_info).to eq("openid" => "openid")
+      end
+    end
+
+    context "when scope is snsapi_userinfo" do
+      let(:access_token) { OAuth2::AccessToken.from_hash(client, {
+        "openid"=>"openid", 
+        "scope"=>"snsapi_userinfo", 
+        "access_token"=>"access_token"
+      })}
+
+      specify "will query for user info" do
+        response_hash = {
+          "openid" => "OPENID",
+          "nickname" => "NICKNAME",
+          "sex" => "1",
+          "province" => "PROVINCE",
+          "city" => "CITY",
+          "country" => "COUNTRY",
+          "headimgurl" => "header_image_url", 
+          "privilege" => [ "PRIVILEGE1" "PRIVILEGE2"]
+        }
+
+        client.should_receive(:request).with do |verb, path, opts|
+          expect(verb).to eq(:get)
+          expect(path).to eq("/sns/userinfo")
+          expect(opts[:params]).to eq("openid"=> "openid", "access_token"=> "access_token")
+          expect(opts[:parse]).to eq(:json)
+        end.and_return(double("response", parsed:response_hash))
+
+        expect(subject.raw_info).to eq(response_hash)
+      end
+
+    end
+
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'omniauth-open-wechat-oauth2'
+require 'rspec'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-open-wechat-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Special Leung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: Using OAuth2 to authenticate wechat user in web application.
+email:
+- specialcyci@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/omniauth-open-wechat-oauth2.rb
+- lib/omniauth/strategies/open_wechat.rb
+- omniauth-open-wechat-oauth2.gemspec
+- spec/omniauth/strategies/open_wechat_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mycolorway/omniauth-open-wechat-oauth2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Omniauth strategy for open wechat(weixin), https://open.weixin.qq.com/
+test_files:
+- spec/omniauth/strategies/open_wechat_spec.rb
+- spec/spec_helper.rb