omniauth-tiktok-loginkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8b2ffe72f53ccfa1b75591363546ab768d90a4e65adc542f52d17e7afcfb03c
+  data.tar.gz: a2868ee84dee7346d1e16fe1fda4fee4ccf6c25f3b89f452b36d0ea4bed9daea
+SHA512:
+  metadata.gz: 0bacb2d0421d4792a4a785a10729c9d7ec99403ef0fdc7e0f0cc0baeef5f8915ef4caea73a77a76c269a04e0d9006aaa6e3d9488faff6a8612ce0d3a876b617d
+  data.tar.gz: a8cffef59a1af571f071b76cf380fc16bed369b0bd6e7600409a5b88d25dcf0b0d6160b75650c21d7eb80596d25e3bcb0daf5a94f09e268397e6f1ec25ab8c99

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Naming/FileName:
+  Exclude:
+    - 'lib/omniauth-tiktok-loginkit.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-13
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Michael Yin
+
+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,55 @@
+# omniauth-tiktok-loginkit
+
+OmniAuth Strategy for TikTok [LoginKit](https://developers.tiktok.com/doc/login-kit-overview/)
+
+Using TikTok Oauth API v2.
+
+## Config
+
+Configure with CLIENT_KEY and CLIENT_SECRET from TikTok Developers Portal (https://developers.tiktok.com/apps/). Note CLIENT_KEY is the value of "Client Key" field, not "App ID" on the portal.
+
+TikTok requires apps to be approved by review before it can access any APIs, including the Oauth APIs. Also any configuration change to the app will cause it to be back in "Staging" status. So please configure all neccessary "Redirect URI" correctly before submitting a review.
+
+TikTok also rejects any "Test App", so it's better to configure test / dev environment redirect URI on the production app.
+
+```
+Rails.application.config.middleware.use OmniAuth::Builder do
+    provider(
+        :tiktok_loginkit, 
+        CLIENT_KEY, 
+        CLIENT_SECRET,
+        *options
+    )
+end
+```
+
+...Or with devise (https://github.com/heartcombo/devise#omniauth)
+
+```
+# config/initializers/devise.rb
+config.omniauth(
+    :tiktok_loginkit, 
+    CLIENT_KEY, 
+    CLIENT_SECRET, 
+    ...options
+)
+
+```
+
+## Options
+
+* `name`: change endpoint to /auth/tiktok_another, /auth/tiktok_another/callback. default: `"tiktok_login"`
+* `skip_info`: skip User Info API call to retrieve `info` hash. default: `false`
+* `scope`: oauth scopes, seperated by comma. default: `"user.info.basic"`
+
+
+## Usage
+
+Example of `request.env["omniauth.auth"]` can be found in the specs:
+
+* [with default scope: user.info.basic](https://github.com/layerssss/omniauth-tiktok-loginkit/blob/main/spec/omniauth/strategies/tiktok_loginkit_spec.rb#L108)
+* [more detailed user info with scopes: user.info.basic,user.info.profile](https://github.com/layerssss/omniauth-tiktok-loginkit/blob/main/spec/omniauth/strategies/tiktok_loginkit_spec.rb#L263)
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/omniauth/strategies/tiktok_loginkit.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "oauth2"
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class TiktokLoginkit < OmniAuth::Strategies::OAuth2 # rubocop:disable Style/Documentation
+      class AccessToken < ::OAuth2::AccessToken
+      end
+
+      class NoAuthorizationCodeError < StandardError; end
+      USER_INFO_URL = "https://open.tiktokapis.com/v2/user/info/"
+
+      option :name, "tiktok-loginkit"
+      args %i[client_key client_secret]
+
+      option :client_options, {
+        site: "https://www.tiktok.com",
+        authorize_url: "https://www.tiktok.com/v2/auth/authorize/",
+        token_url: "https://open.tiktokapis.com/v2/oauth/token/",
+        auth_scheme: :request_body,
+        access_token_class: OmniAuth::Strategies::TiktokLoginkit::AccessToken
+      }
+      option "scope", "user.info.basic"
+
+      uid { access_token.params.fetch("open_id") }
+
+      # https://github.com/omniauth/omniauth/wiki/Auth-Hash-Schema
+      info do
+        hash = {
+          name: user_info.fetch("display_name"),
+          image: user_info.fetch("avatar_url_100")
+        }
+        if request.params.fetch("scopes").include?("user.info.profile")
+          hash.merge!(
+            nickname: user_info.fetch("username"),
+            description: user_info.fetch("bio_description"),
+            urls: {
+              "TikTok" => user_info.fetch("profile_web_link"),
+              "TikTok Deep Link" => user_info.fetch("profile_deep_link")
+            }
+          )
+        end
+        hash
+      end
+
+      extra do
+        user_info
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params[:client_key] = options.client_key
+        end
+      end
+
+      def token_params
+        super.tap do |params|
+          params[:client_key] = options.client_key
+          params[:client_secret] = options.client_secret
+        end
+      end
+
+      def callback_url
+        full_host + callback_path
+      end
+
+      private
+
+      def user_info # rubocop:disable Metrics/MethodLength
+        return {} if skip_info?
+
+        @user_info ||= begin
+          fields = %w[open_id avatar_url avatar_url_100 display_name]
+          scopes = request.params.fetch("scopes")
+          if scopes.include?("user.info.profile")
+            fields.push("profile_web_link", "profile_deep_link", "bio_description", "is_verified", "username")
+          end
+          response = access_token
+                     .get(
+                       USER_INFO_URL,
+                       params: {
+                         fields: fields.join(",")
+                       }
+                     )
+                     .parsed
+          response.fetch("data").fetch("user")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OmniauthTiktokLoginkit
+  VERSION = "0.1.0"
+end

data/lib/omniauth-tiktok-loginkit.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "omniauth-tiktok-loginkit/version"
+require "omniauth/strategies/tiktok_loginkit"
+
+module Omniauth
+  module TiktokLoginkit
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-tiktok-loginkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Yin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  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
+  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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- layerssss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-tiktok-loginkit.rb
+- lib/omniauth-tiktok-loginkit/version.rb
+- lib/omniauth/strategies/tiktok_loginkit.rb
+homepage: https://github.com/layerssss/omniauth-tiktok-loginkit.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/layerssss/omniauth-tiktok-loginkit
+  source_code_uri: https://github.com/layerssss/omniauth-tiktok-loginkit
+  changelog_uri: https://github.com/layerssss/omniauth-tiktok-loginkit/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: OmniAuth Strategy for TikTok LoginKit
+test_files: []