omniauth-ekuaishou 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 843966ec9516a983699d334a36915021457e21bb39829ef1073dd990c9008742
+  data.tar.gz: a087780d3564137e167e07bdc5acb74a8c5196affd7b1ba0d59868f3dbdeb90f
+SHA512:
+  metadata.gz: 1ee25f17a8edf0dad9948ad28427fe578ebca8a08bdc3398ef58ed035fdcd5153a69b9cb8c24dd9cc24eda04d624ba6e3a90ab188b751762f1a4ddddf6ebcf2a
+  data.tar.gz: 8b0872f8f400d0718924cadc3411c5b9542b9895496cf809b2e0fea81a9c44360bab2d40395dda19977497cd1ca6c9d72353ac33e7ea98ea62b617f0f1ab3b91

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: Main
+on:
+  push:
+    branches:
+      - master
+    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,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    omniauth-ekuaishou (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-ekuaishou!
+  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-ekuaishou.svg)](https://badge.fury.io/rb/omniauth-ekuaishou)
+[![Build Status](https://github.com/jinhucheung/omniauth-ekuaishou/actions/workflows/main.yml/badge.svg)](https:/github.com/jinhucheung/omniauth-ekuaishou/actions)
+
+# Omniauth Ekuaishou
+
+This is the official OmniAuth strategy for authenticating to Kuaishou Marketing. To use it, you'll need to sign up for an OAuth2 Application ID and Secret on the [Kuaishou Marketing Applications Page](https://developers.e.kuaishou.com/application).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-ekuaishou'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install omniauth-ekuaishou
+```
+
+## Usage
+
+`OmniAuth::Strategies::Ekuaishou` 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 :ekuaishou, ENV['EKUAISHOU_APP_ID'], ENV['EKUAISHOU_APP_SECRET']
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jinhucheung/omniauth-ekuaishou.
+
+## 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/ekuaishou"
+
+# 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-ekuaishou.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'omniauth-oauth2'
+require 'omniauth-ekuaishou/version'
+require 'omniauth-ekuaishou/access_token'
+require 'omniauth/strategies/ekuaishou'

data/lib/omniauth-ekuaishou/access_token.rb

@@ -0,0 +1,15 @@
+module OmniAuth
+  module Ekuaishou
+    class AccessToken < ::OAuth2::AccessToken
+      class << self
+        def from_hash(client, hash)
+          return unless hash && hash['code'] == 0 && hash.dig('data', 'access_token').present?
+          data = hash['data']
+          super(client, data.merge(
+            'expires_in' => data['access_token_expires_in']
+          ))
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-ekuaishou/version.rb

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

data/lib/omniauth/strategies/ekuaishou.rb

@@ -0,0 +1,104 @@
+module OmniAuth
+  module Strategies
+    class Ekuaishou < OmniAuth::Strategies::OAuth2
+      option :name, 'ekuaishou'
+
+      option :client_options, {
+        site: 'https://ad.e.kuaishou.com',
+        authorize_url: '/openapi/oauth',
+        token_url: '/rest/openapi/oauth2/authorize/access_token',
+        extract_access_token: ::OmniAuth::Ekuaishou::AccessToken
+      }
+
+      option :authorize_options, %i[app_id scope state]
+
+      def authorize_params
+        super.tap do |params|
+          params[:app_id] = options.client_id if params[:app_id].blank?
+
+          if params[:scope].present?
+            scope = params[:scope]
+            scope = JSON.parse(params[:scope]) && params[:scope] rescue params[:scope].split(',') if scope.is_a?(String)
+            params[:scope] = scope.is_a?(Array) ? scope.to_json : scope
+          end
+
+          %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 { access_token['advertiser_id'] }
+
+      info do
+        access_token.to_hash.slice('advertiser_id', 'advertiser_ids').merge(raw_info.slice(
+          'user_id',
+          'user_name',
+          'corporation_name',
+          'industry_id',
+          'industry_name',
+          'primary_industry_id',
+          'primary_industry_name'
+        ))
+      end
+
+      extra do
+        {
+          scope: scope,
+          raw_info: raw_info,
+          refresh_token_expires_in: access_token['refresh_token_expires_in']
+        }
+      end
+
+      def raw_info
+        @raw_info ||= begin
+          resp = client.request(:get, "#{options.client_options[:site]}/rest/openapi/v1/advertiser/info", headers: headers, body: access_token.to_hash.slice('advertiser_id'))
+          JSON.parse(resp.body)['data'] rescue {}
+        end
+      end
+
+      def scope
+        access_token['scope']
+      end
+
+      protected
+
+      def client
+        _client = super
+        _client.define_singleton_method(:request) do |verb, url, opts|
+          super(verb, url, opts) do |req|
+            req.body = req.body.to_json if req.body.is_a?(Hash)
+          end
+        end
+        _client
+      end
+
+      def build_access_token
+        request.params['code'] = request.params['auth_code']
+        super
+      end
+
+      def token_params
+        super.merge(
+          'app_id' => client.id,
+          'secret' => client.secret,
+          'auth_code' => request.params['auth_code'],
+          'parse' => :json,
+          'headers' => headers
+        )
+      end
+
+      def headers
+        result = { 'Content-Type' => 'application/json' }
+        result['Access-Token'] = access_token.token if access_token
+        result
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'ekuaishou', 'Ekuaishou'

data/omniauth-ekuaishou.gemspec

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