omniauth-etencent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f048e04baf77bb7597b9b29291993e886d917844bf3af04f82bfa10067180bf
+  data.tar.gz: 26510297e6733032ab0949c36fac2ad5a834ba5fb0ca9810e84744a7edc67ff2
+SHA512:
+  metadata.gz: 8d3e357912de3de231bec567a9a61752207675349ea400aa31aac2ccd2475619987edc52806fef869ae44aa2803370dbfa4a98e50cbf70ac517071c4f59d68dd
+  data.tar.gz: 14534c50851b6d63358802712d9a39cb88147eb2ed97bfb9f019ac37ed441031ac15bc3e9ce9dbe853bf4d14f1e63446edc924ab0f541a1f430ba5e341d695bc

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-etencent.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    omniauth-etencent (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.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      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-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.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.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  omniauth-etencent!
+  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-etencent.svg)](https://badge.fury.io/rb/omniauth-etencent)
+[![Build Status](https://github.com/jinhucheung/omniauth-etencent/actions/workflows/main.yml/badge.svg)](https://github.com/jinhucheung/omniauth-etencent/actions)
+
+# Omniauth Etencent
+
+This is the official OmniAuth strategy for authenticating to Tencent Marketing. To use it, you'll need to sign up for an OAuth2 Application ID and Secret on the [Tencent Marketing Applications Page](https://developers.e.qq.com/app).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-etencent'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install omniauth-etencent
+```
+
+## Usage
+
+`OmniAuth::Strategies::Etencent` 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 :etencent, ENV['ETENCENT_APP_ID'], ENV['ETENCENT_APP_SECRET']
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jinhucheung/omniauth-etencent.
+
+## 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/etencent"
+
+# 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-etencent.rb

@@ -0,0 +1,4 @@
+require 'omniauth-oauth2'
+require 'omniauth-etencent/version'
+require 'omniauth-etencent/access_token'
+require 'omniauth/strategies/etencent'

data/lib/omniauth-etencent/access_token.rb

@@ -0,0 +1,15 @@
+module OmniAuth
+  module Etencent
+    class AccessToken < ::OAuth2::AccessToken
+      class << self
+        def from_hash(client, hash)
+          return unless hash && hash['code'] == 0 && hash.dig('data', 'access_token')
+
+          data = hash['data'].merge('expires_in' => hash.dig('data', 'access_token_expires_in'))
+          data['refresh_token_expires_at'] ||= Time.now.to_i + data['refresh_token_expires_in'].to_i if data['refresh_token_expires_in'].to_i > 0
+          super(client, data)
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-etencent/version.rb

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

data/lib/omniauth/strategies/etencent.rb

@@ -0,0 +1,77 @@
+module OmniAuth
+  module Strategies
+    class Etencent < OmniAuth::Strategies::OAuth2
+      option :name, 'etencent'
+
+      option :client_options, {
+        site: 'https://developers.e.qq.com',
+        authorize_url: '/oauth/authorize',
+        token_url: '/oauth/token',
+        token_method: :get,
+        extract_access_token: ::OmniAuth::Etencent::AccessToken
+      }
+
+      option :authorize_options, %i[scope state account_type account_display_number]
+
+      option :sandbox, false
+
+      def authorize_params
+        super.tap do |params|
+          %w[scope client_options].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+              # to support omniauth-oauth2's auto csrf protection
+              session['omniauth.state'] = params[:state] if v == 'state'
+            end
+          end
+        end
+      end
+
+      uid { authorizer_info['account_id'] }
+
+      info do
+        authorizer_info
+      end
+
+      credentials do
+        hash = {'token' => access_token.token}
+        hash['refresh_token'] = access_token.refresh_token if access_token.expires? && access_token.refresh_token
+        hash['expires_at'] = access_token.expires_at if access_token.expires?
+        hash['expires'] = access_token.expires?
+        hash['refresh_token_expires_at'] = access_token['refresh_token_expires_at'] if access_token['refresh_token_expires_at']
+        hash
+      end
+
+      extra do
+        {
+          scope: scope
+        }
+      end
+
+      def authorizer_info
+        @authorizer_info ||= access_token.to_hash.dig('authorizer_info') || {}
+      end
+
+      def scope
+        authorizer_info['scope_list']
+      end
+
+      protected
+
+      def client
+        ::OAuth2::Client.new(options.client_id, options.client_secret, deep_symbolize(client_options))
+      end
+
+      def client_options
+        options.client_options[:token_url] = "#{api_base_url}#{options.client_options[:token_url]}" if options.client_options[:token_url] !~ /https?:\/\//
+        options.client_options
+      end
+
+      def api_base_url
+        options.sandbox ? 'https://sandbox-api.e.qq.com' : 'https://api.e.qq.com'
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'etencent', 'Etencent'

data/omniauth-etencent.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/omniauth-etencent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-etencent"
+  spec.version       = OmniAuth::Etencent::VERSION
+  spec.authors       = ["jimcheung"]
+  spec.email         = ["hi.jinhu.zhang@gmail.com"]
+
+  spec.summary       = %q{Omniauth strategy for Tencent Marketing}
+  spec.description   = %q{Wrapper the Tencent Marketing Oauth2 API}
+  spec.homepage      = "https://github.com/jinhucheung/omniauth-etencent"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jinhucheung/omniauth-etencent"
+
+  # 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,88 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-etencent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jimcheung
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-27 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 Tencent Marketing 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-etencent.rb
+- lib/omniauth-etencent/access_token.rb
+- lib/omniauth-etencent/version.rb
+- lib/omniauth/strategies/etencent.rb
+- omniauth-etencent.gemspec
+homepage: https://github.com/jinhucheung/omniauth-etencent
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jinhucheung/omniauth-etencent
+  source_code_uri: https://github.com/jinhucheung/omniauth-etencent
+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 Tencent Marketing
+test_files: []