omniauth-tiktok_business-oauth2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f2f9c124c2231c56b4463696cf44b0d284f65049c5e95bb0752929f3072a9e5
+  data.tar.gz: 58bdf534f93a729b097e659420cf83348a6b4e67706fd81d570578e87ae895bc
+SHA512:
+  metadata.gz: 7d40c9e41e07b376fa5b76dd38234e3e75737b27d7dc686c4ce2160d53ec1aa327e0c489c4df1fcc0f7f059144c5c262881807a22f563988eb04e0919c455833
+  data.tar.gz: 6887e416a7818cb62fe4c7c548ef21de20057baf217894018b1dfdc9110bd44494204f63521ff841be74566a126677c7f90ca64c45611a2a00629417105f2145

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Damian Aberbuj
+
+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,34 @@
+# OmniAuth TikTok (Accounts API) OAuth2 Strategy
+Strategy to authenticate with TikTok (Accounts API) via OAuth2 in OmniAuth
+
+Sign up and create your Application https://business-api.tiktok.com/portal/docs?id=1760334598980610. 
+Note the App ID and the App Secret.
+
+For more details, read the docs: 
+https://business-api.tiktok.com/portal/docs?id=1735713875563521
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-tiktok_business-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_business_oauth2, ENV['TIKTOK_APP_ID'], ENV['TIKTOK_SECRET']
+end
+```
+
+You can now access the OmniAuth TikTok OAuth2 URL: `/auth/tiktok_business_oauth2`
+
+## Configuration
+
+* `name`: The name of the strategy. The default name is `tiktok_business_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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/omniauth/strategies/tiktok_business_oauth2.rb

@@ -0,0 +1,89 @@
+module OmniAuth
+  module Strategies
+    class TiktokBusinessOauth2 < OmniAuth::Strategies::OAuth2
+      USER_INFO_URL = 'https://business-api.tiktok.com/open_api/v1.3/business/get/'
+      USER_FIELDS = '["username","display_name","profile_image","is_business_account"]'
+
+      option :name, "tiktok_business_oauth2"
+      option :client_options,
+             site: 'https://business-api.tiktok.com/',
+             authorize_url: 'https://www.tiktok.com/v2/auth/authorize/',
+             token_url: 'https://business-api.tiktok.com/open_api/v1.3/tt_user/oauth2/token/'
+
+      option :pkce, true
+
+      def authorize_params
+        super.tap do |params|
+          params[:client_key] = options.client_id
+          params[:scope] = 'user.info.basic,user.info.username,user.info.stats,user.account.type,user.insights,video.list,video.insights,comment.list,comment.list.manage'
+        end
+      end
+
+      uid do
+        raw_info['open_id']
+      end
+
+      info do
+        {
+          id: raw_info['open_id'],
+          name: raw_info['user']['display_name'],
+          username: raw_info['user']['username'],
+          profile_image: raw_info['user']['profile_image'],
+          is_business_account: raw_info['user']['is_business_account']
+        }
+      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(
+          headers: { 'Content-Type' => 'application/json' },
+          client_id: options.client_id,
+          client_secret: options.client_secret,
+          auth_code: request.params["code"],
+          parse: :tiktok_business,
+        )
+      end
+
+      def raw_info
+        @raw_info ||= access_token_info.merge('user' => tiktok_user_info)
+      end
+
+      def tiktok_user_info
+        @tiktok_user_info ||= begin
+          headers = {
+            'Access-Token' => access_token.token
+          }
+
+          params = {
+            business_id: access_token_info['open_id'],
+            fields: USER_FIELDS
+          }
+          
+          access_token.get(USER_INFO_URL, headers: headers, params: params, parse: :tiktok_business).parsed
+        end
+      end
+
+      def access_token_info
+        access_token.to_hash.stringify_keys
+      end
+
+      # It is necessary to override this method to avoid the "Content-Type" string getting turned into a symbol.
+      # Unfortunately you can't just pass headers in `token_params` method because the original `build_access_token` deep symbolizes all parameters, and the OAuth2 gem expects the headers to be strings
+      def build_access_token
+        verifier = request.params["code"]
+        client.auth_code.get_token(verifier, {:redirect_uri => callback_url}.merge(token_params), deep_symbolize(options.auth_token_params))
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module OmniAuthTiktokBusinessOauth2
+  VERSION = '1.0.0'
+end

data/lib/omniauth-tiktok_business-oauth2.rb

@@ -0,0 +1,9 @@
+require 'oauth2'
+require 'omniauth/strategies/oauth2'
+
+require 'omniauth-tiktok_business-oauth2/version'
+require 'omniauth/strategies/tiktok_business_oauth2'
+
+OAuth2::Response.register_parser(:tiktok_business, []) do |body|
+  JSON.parse(body).fetch('data') rescue body
+end

data/omniauth-tiktok_business-oauth2.gemspec

@@ -0,0 +1,19 @@
+require_relative 'lib/omniauth-tiktok_business-oauth2/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-tiktok_business-oauth2'
+  gem.version       = OmniAuthTiktokBusinessOauth2::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(A TikTok Business API OAuth2 strategy for OmniAuth)
+  gem.description   = %(A TikTok Business API OAuth2 strategy for OmniAuth. This allows you to login with TikTok in your ruby app.)
+  gem.authors       = ['Damian Aberbuj']
+  gem.homepage      = 'https://github.com/daberbuj/omniauth-tiktok_business-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'
+
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-tiktok_business-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Damian Aberbuj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-11 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A TikTok Business 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
+- Rakefile
+- lib/omniauth-tiktok_business-oauth2.rb
+- lib/omniauth-tiktok_business-oauth2/version.rb
+- lib/omniauth/strategies/tiktok_business_oauth2.rb
+- omniauth-tiktok_business-oauth2.gemspec
+homepage: https://github.com/daberbuj/omniauth-tiktok_business-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: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: A TikTok Business API OAuth2 strategy for OmniAuth
+test_files: []