omniauth-dingding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08a27f7614372b4b0a77aa178407a7141320d25006b1c7a5ff7c8c84279fc53c'
+  data.tar.gz: b8e96667d34dc7309df94e884736ea201eb59b3f7ec7009d12a544b09c2c6c41
+SHA512:
+  metadata.gz: 59b71c90db10c699872b6b161f2fb84b287dc18651b4eb10dd2fd8444211ab0b0705590222a2d242c2509ea6ec9acfc539afd95560095058fc412d60f85ab4b7
+  data.tar.gz: e74acddaac22ca4521d2485f1744e7ff2cbdfa91b8bc67134b076e27b0a8a2f1a50c469cc2c45511b7c78a13ac5a1281ba80de26d23251b56f83489c5aa9516b

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Main
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '**'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-dingding.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    omniauth-dingding (0.1.0)
+      omniauth (~> 2.0)
+      omniauth-oauth2 (~> 1.7.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    faraday (1.5.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    hashie (4.1.0)
+    jwt (2.2.3)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (2.0.4)
+      hashie (>= 3.4.6)
+      rack (>= 1.6.2, < 3)
+      rack-protection
+    omniauth-oauth2 (1.7.1)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  omniauth-dingding!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 jimcheung
+
+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,46 @@
+[![Gem Version](https://badge.fury.io/rb/omniauth-dingding.svg)](https://badge.fury.io/rb/omniauth-dingding)
+[![Build Status](https://github.com/jinhucheung/omniauth-dingding/actions/workflows/main.yml/badge.svg)](https://github.com/jinhucheung/omniauth-dingding/actions)
+
+# Omniauth Dingding
+
+This is the official OmniAuth strategy for authenticating to DingTalk. To use it, you'll need to sign up for an OAuth2 Application ID and Secret on the [DingTalk Applications Page](https://open-dev.dingtalk.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-dingding'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install omniauth-dingding
+```
+
+## Usage
+
+`OmniAuth::Strategies::Dingding` is simply a Rack middleware. Read the OmniAuth 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 :dingding, ENV['DINGDING_APP_ID'], ENV['DINGDING_APP_SECRET']
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jinhucheung/omniauth-dingding.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/dingding"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth-dingding.rb

@@ -0,0 +1,3 @@
+require 'omniauth-oauth2'
+require 'omniauth-dingding/version'
+require 'omniauth/strategies/dingding'

data/lib/omniauth-dingding/client.rb

@@ -0,0 +1,19 @@
+require 'omniauth-dingding/client/third_party_personal'
+require 'omniauth-dingding/client/enterprise_internal'
+
+module OmniAuth
+  module Dingding
+    module Client
+      class << self
+        def get(client_type)
+          case client_type.to_s
+          when 'third_party_personal'
+            ::OmniAuth::Dingding::Client::ThirdPartyPersonal
+          else
+            ::OmniAuth::Dingding::Client::EnterpriseInternal
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-dingding/client/base.rb

@@ -0,0 +1,78 @@
+require 'openssl'
+require 'base64'
+require 'cgi'
+require 'json'
+
+module OmniAuth
+  module Dingding
+    module Client
+      class Base < ::OAuth2::Client
+        AUTHORIZE_URL = {
+          'qrcode' => '/connect/qrconnect',
+          'account' => '/connect/oauth2/sns_authorize'
+        }.freeze
+
+        GET_USER_INFO_BY_CODE_URL = '/sns/getuserinfo_bycode'
+
+        GET_USER_ID_BY_UNIONID_URL = '/topapi/user/getbyunionid'
+
+        GET_USER_INFO_BY_ID_URL = 'topapi/v2/user/get'
+
+        def initialize(client_id, client_secret, options = {}, &block)
+          opts = {
+            authorize_url: AUTHORIZE_URL.fetch(options[:authorize_method].to_s, AUTHORIZE_URL['qrcode']),
+            token_url: token_url,
+            token_method: :get
+          }.merge(options)
+
+          super(client_id, client_secret, opts, &block)
+        end
+
+        def get_user_info_by_code(code)
+          t = (Time.now.to_f * 1000).to_i.to_s
+          raw_sign = Base64.encode64(OpenSSL::HMAC.digest('SHA256', secret, t)).strip
+          sign = CGI.escape(raw_sign)
+
+          url = "#{GET_USER_INFO_BY_CODE_URL}?accessKey=#{id}&timestamp=#{t}&signature=#{sign}"
+
+          request(:post, url,
+            headers: { 'Content-Type' => 'application/json' },
+            body: { tmp_auth_code: code }.to_json
+          ).parsed
+        end
+
+        def get_user_id_by_unionid(access_token, unionid)
+          request(:post, GET_USER_ID_BY_UNIONID_URL,
+            headers: { 'Content-Type' => 'application/json' },
+            body: { unionid: unionid }.to_json,
+            params: { access_token: access_token }
+          ).parsed
+        end
+
+        def get_user_info_by_id(access_token, id)
+          request(:post, GET_USER_INFO_BY_ID_URL,
+            headers: { 'Content-Type' => 'application/json' },
+            body: { userid: id }.to_json,
+            params: { access_token: access_token }
+          ).parsed
+        end
+
+        def get_user_info(params = {})
+          raise NotImplementedError
+        end
+
+        def token_url
+          self.class.const_get(:TOKEN_URL) rescue nil
+        end
+
+        def token_params
+          { appid: id, appsecret: secret }
+        end
+
+        def get_token(params, access_token_opts = {}, extract_access_token = options[:extract_access_token])
+          super(token_params.merge(params), access_token_opts, extract_access_token)
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-dingding/client/enterprise_internal.rb

@@ -0,0 +1,27 @@
+require 'omniauth-dingding/client/base'
+
+module OmniAuth
+  module Dingding
+    module Client
+      class EnterpriseInternal < ::OmniAuth::Dingding::Client::Base
+        TOKEN_URL = '/gettoken'
+
+        def token_params
+          { appkey: id, appsecret: secret }
+        end
+
+        def get_user_info(params = {})
+          resp = get_user_info_by_code(params[:code])
+          user_info = resp['user_info'] || {}
+          return user_info if user_info['unionid'].to_s.empty?
+
+          user_id = get_user_id_by_unionid(params[:access_token], user_info['unionid']).dig('result', 'userid')
+          return user_info if user_id.to_s.empty?
+
+          result = get_user_info_by_id(params[:access_token], user_id)['result']
+          user_info.merge(result || {})
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-dingding/client/third_party_personal.rb

@@ -0,0 +1,16 @@
+require 'omniauth-dingding/client/base'
+
+module OmniAuth
+  module Dingding
+    module Client
+      class ThirdPartyPersonal < ::OmniAuth::Dingding::Client::Base
+        TOKEN_URL = '/sns/gettoken'
+
+        def get_user_info(params = {})
+          resp = get_user_info_by_code(params[:code])
+          resp['user_info'] || {}
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-dingding/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Dingding
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/dingding.rb

@@ -0,0 +1,64 @@
+require 'omniauth-dingding/client'
+
+module OmniAuth
+  module Strategies
+    class Dingding < OmniAuth::Strategies::OAuth2
+      option :name, 'dingding'
+
+      option :client_options, {
+        site: 'https://oapi.dingtalk.com',
+        # one of qrcode, account, default is qrcode
+        authorize_method: :qrcode
+      }
+
+      # one of enterprise_internal, third_party_personal, default is enterprise_internal
+      option :client_type, :enterprise_internal
+
+      # one of snsapi_login, snsapi_auth, default is snsapi_login
+      option :authorize_params, scope: 'snsapi_login'
+
+      uid do
+        user_info['openid']
+      end
+
+      info do
+        {
+          unionid: user_info['unionid'],
+          name: user_info['nick'],
+          ding_id: user_info['dingId']
+        }.merge(user_info)
+      end
+
+      extra do
+        { raw_info: user_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
+
+      protected
+
+      def client
+        ::OmniAuth::Dingding::Client.get(options.client_type).new(
+          options.client_id,
+          options.client_secret,
+          deep_symbolize(options.client_options)
+        )
+      end
+
+      def build_access_token
+        verifier = request.params['code']
+        client.auth_code.get_token(verifier, { redirect_uri: callback_url }.merge(token_params.to_hash(symbolize_keys: true)), deep_symbolize(options.auth_token_params))
+      end
+
+      def user_info
+        @user_info ||= client.get_user_info(code: request.params['code'], access_token: access_token.token)
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'dingding', 'Dingding'

data/omniauth-dingding.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/omniauth-dingding/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-dingding"
+  spec.version       = OmniAuth::Dingding::VERSION
+  spec.authors       = ["jimcheung"]
+  spec.email         = ["hi.jinhu.zhang@gmail.com"]
+
+  spec.summary       = %q{Omniauth strategy for DingTalk}
+  spec.description   = %q{Wrapper the DingTalk Oauth2 API}
+  spec.homepage      = "https://github.com/jinhucheung/omniauth-dingding"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jinhucheung/omniauth-dingding"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'omniauth', '~> 2.0'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.7.1'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-dingding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jimcheung
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+description: Wrapper the DingTalk Oauth2 API
+email:
+- hi.jinhu.zhang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-dingding.rb
+- lib/omniauth-dingding/client.rb
+- lib/omniauth-dingding/client/base.rb
+- lib/omniauth-dingding/client/enterprise_internal.rb
+- lib/omniauth-dingding/client/third_party_personal.rb
+- lib/omniauth-dingding/version.rb
+- lib/omniauth/strategies/dingding.rb
+- omniauth-dingding.gemspec
+homepage: https://github.com/jinhucheung/omniauth-dingding
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jinhucheung/omniauth-dingding
+  source_code_uri: https://github.com/jinhucheung/omniauth-dingding
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Omniauth strategy for DingTalk
+test_files: []