omniauth-tiktok-oauth2 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cee8a6f58251444de9f7aa3275e934b9d18ac810231f67a72656107262a0e44
+  data.tar.gz: a4eeeeeae20bd7b0e7c29853a612aec78135c20c0d04e9316cc1ca0c07ffcd29
+SHA512:
+  metadata.gz: 5702d05d75b0297279ab748d93ebac390ecb5d1c838230e7870a615ce7578b9a353de099f351be822b1f31a3c7bde33b40a41e5a1c82d2173a8b45bab0527b8e
+  data.tar.gz: 54e6e3b59778874830c5ecfdcd933417a2380fe50142b9e8df8d99a6d77cd56bbbdb8c27db52106eac589f4bf569a675a6c5025a57a13f355d8b32264153d1a2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.powenv
+.idea/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Kristoffer Ek
+
+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,32 @@
+# OmniAuth TikTok (Marketing API) OAuth2 Strategy
+Strategy to authenticate with TikTok (Marketing API) via OAuth2 in OmniAuth
+
+Sign up and create your Application at https://ads.tiktok.com/i18n/login.  Note the App ID and the App Secret.
+
+For more details, read the docs: https://ads.tiktok.com/marketing_api/docs?rid=1dmrkuztuhi&id=100510
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-tiktok-oauth2'
+```
+
+Then `bundle install`.
+
+## Usage
+
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :tiktok_oauth2, ENV['TIKTOK_APP_ID'], ENV['TIKTOK_SECRET']
+end
+```
+
+You can now access the OmniAuth TikTok OAuth2 URL: `/auth/tiktok_oauth2`
+
+## Configuration
+
+* `name`: The name of the strategy. The default name is `tiktok_oauth2` but it can be changed to any value, for example `tiktok`. The OmniAuth URL will thus change to `/auth/tiktok` and the `provider` key in the auth hash will then return `tiktok`.

data/lib/omniauth/strategies/tiktok_oauth2.rb

@@ -0,0 +1,68 @@
+require 'oauth2'
+require 'omniauth/strategies/oauth2'
+
+OAuth2::Response.register_parser(:tiktok, ['application/json']) do |body|
+  JSON.parse(body)['data']
+end
+
+module OmniAuth
+  module Strategies
+    class TiktokOauth2 < OmniAuth::Strategies::OAuth2
+      USER_INFO_URL = 'https://ads.tiktok.com/open_api/v1.2/user/info/'
+      option :name, "tiktok_oauth2"
+      option :client_options,
+             site: 'https://ads.tiktok.com',
+             authorize_url: 'https://ads.tiktok.com/marketing_api/auth',
+             token_url: 'https://ads.tiktok.com/open_api/v1.2/oauth2/access_token'
+
+      option :pkce, true
+
+      def authorize_params
+        super.tap do |params|
+          params[:app_id] = options.client_id
+        end
+      end
+
+      uid{ raw_info['id'] }
+
+      info do
+        {
+          email: raw_info['email'],
+          name: raw_info['display_name'],
+          id: raw_info['id'],
+          create_time: raw_info['create_time'],
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      # Remove params as callback URL must match exactly the URL defined for the application
+      def callback_url
+        super.split('?').first
+      end
+
+      def token_params
+        options.token_params.merge(
+          app_id: options.client_id,
+          secret: options.client_secret,
+          auth_code: request.params["code"],
+          parse: :tiktok,
+        )
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(USER_INFO_URL, headers: headers, parse: :tiktok).parsed
+      end
+
+      def headers
+        {
+          'Access-Token' => access_token.token,
+        }
+      end
+    end
+  end
+end

data/lib/omniauth-tiktok-oauth2/version.rb

@@ -0,0 +1,3 @@
+module OmniAuthTiktokOauth2
+  VERSION = '0.1.4'
+end

data/lib/omniauth-tiktok-oauth2.rb

@@ -0,0 +1,2 @@
+require 'omniauth-tiktok-oauth2/version'
+require 'omniauth/strategies/tiktok_oauth2'

data/omniauth-tiktok-oauth2.gemspec

@@ -0,0 +1,17 @@
+require_relative 'lib/omniauth-tiktok-oauth2/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-tiktok-oauth2'
+  gem.version       = OmniAuthTiktokOauth2::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(A TikTok Marketing API OAuth2 strategy for OmniAuth)
+  gem.description   = %(A TikTok Marketing API OAuth2 strategy for OmniAuth. This allows you to login with TikTok in your ruby app.)
+  gem.authors       = ['Kristoffer Ek']
+  gem.homepage      = 'https://github.com/kristofferek/omniauth-tiktok-oauth2'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.6'
+  gem.add_runtime_dependency 'oauth2', '~> 1.1'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-tiktok-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Kristoffer Ek
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A TikTok Marketing API OAuth2 strategy for OmniAuth. This allows you
+  to login with TikTok in your ruby app.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/omniauth-tiktok-oauth2.rb
+- lib/omniauth-tiktok-oauth2/version.rb
+- lib/omniauth/strategies/tiktok_oauth2.rb
+- omniauth-tiktok-oauth2.gemspec
+homepage: https://github.com/kristofferek/omniauth-tiktok-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.7.6.2
+signing_key:
+specification_version: 4
+summary: A TikTok Marketing API OAuth2 strategy for OmniAuth
+test_files: []