tiktok-oauth-strategy 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a63dcfcd8cad661a3223322fcaea5761da061cdf0175f1a20a8dbc698ad8628c
+  data.tar.gz: ab727a28724c7c5ff8a5b2d6df4b368affecbb66abf736491a3bb7cd87519d17
+SHA512:
+  metadata.gz: 79d3c61cb27c2773c0b0b5e82c805d5c690045c9b43782fae7d7dce49fec2d9c995eae43da07fb13b0ff52d125b4a859d07065d71ee1652954cacdb70379e1db
+  data.tar.gz: 8e7195bd62130d444781983616ea3f1afdc174ce5532e69db72ef383d3812a6331b6803cc7f0c287a9c74208c224fc41f5e628d33b3182d8c11952ac06282719

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rubocop', '>= 0.48.1'
+end
+
+group :test do
+  gem 'webmock', '~> 3.13'
+  gem 'rack-test'
+  gem 'rspec', '~> 3.6.0' # '~> 3.6.0'
+  gem 'simplecov', require: false
+end
+
+gemspec

data/README.md

@@ -0,0 +1,22 @@
+# tiktok_oauth_strategy
+
+An unofficial OmniAuth strategy for TikTok authentication with the [TikTok Login Kit](https://developers.tiktok.com/doc/login-kit-web/). 
+
+
+## Usage
+
+Install the gem 
+
+```ruby
+gem 'tiktok_oauth_strategy'
+bundle install
+```
+
+Make a TikTok developer account and create an application. Retrieve the app's `TIKTOK_CLIENT_ID` and `TIKTOK_CLIENT_SECRET` once it is approved and add a middleware to your ruby project, typically in a config/initializers/omniauth.rb file :
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :tiktok, ENV['TIKTOK_CLIENT_ID'], ENV['TIKTOK_CLIENT_SECRET']
+end
+```
+

data/lib/strategies/tiktok.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class Tiktok < OmniAuth::Strategies::OAuth2
+  option :name, "tiktok"
+  option :response_type, "code"
+
+  uid { raw_info["open_id"] }
+
+  extra do
+    {
+      raw_info: raw_info
+    }
+  end
+
+  info do
+    {
+      name: raw_info["display_name"],
+      description: raw_info["description"],
+      image: raw_info["avatar"],
+      large_image: raw_info["avatar_larger"],
+      secondary_social_id: raw_info["union_id"],
+      refresh_token_expiry: access_token["refresh_expires_in"].seconds.from_now,
+      access_token_expiry: Time.at(access_token.expires_at).utc.to_datetime
+    }
+  end
+
+  def client
+    # config/initializers/tiktok_oauth2.rb
+    ::TiktokOAuth2Client.new(options.client_id, options.client_secret, deep_symbolize(options.client_options))
+  end
+
+  # overriding method to pass in client_key to authorization url
+  def authorize_params
+    super.tap do |params|
+      params[:client_key] = options[:client_key]
+      session["omniauth.state"] = params[:state] if params[:state]
+    end
+  end
+
+  def raw_info
+    uri = "https://open-api.tiktok.com/oauth/userinfo/"
+
+    query_params = {
+      open_id: access_token.params['open_id'],
+      access_token: access_token.token
+    }
+
+    result = HTTParty.get(uri, query: query_params)
+    @raw_info ||= result.parsed_response["data"]
+  end
+end

data/lib/strategies/tiktok_oauth2_client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Overriding a few methods for the OAuth2::Client (https://github.com/oauth-xx/oauth2/blob/422d3132343227cec84d5d34a7a8ce4825439bdb/lib/oauth2/client.rb)
+#
+# TikTok Returns it's access_token inside of a data attribute which is unexpected by OAuth2. Overriding methods to look inside of the data attribute for
+# the access_token
+
+class TiktokOAuth2Client < OAuth2::Client
+  # Initializes an AccessToken by making a request to the token endpoint
+  #
+  # @param params [Hash] a Hash of params for the token endpoint
+  # @param access_token_opts [Hash] access token options, to pass to the AccessToken object
+  # @param access_token_class [Class] class of access token for easier subclassing OAuth2::AccessToken
+  # @return [AccessToken] the initialized AccessToken
+  def get_token(params, access_token_opts = {}, access_token_class = OAuth2::AccessToken) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    params = params.map do |key, value|
+      if RESERVED_PARAM_KEYS.include?(key)
+        [key.to_sym, value]
+      else
+        [key, value]
+      end
+    end
+
+    params = authenticator.apply(params.to_h)
+    opts = { raise_errors: options[:raise_errors], parse: params.delete(:parse) }
+    headers = params.delete(:headers) || {}
+    if options[:token_method] == :post
+      opts[:body] = params
+      opts[:headers] = { "Content-Type" => "application/x-www-form-urlencoded" }
+    else
+      opts[:params] = params
+      opts[:headers] = {}
+    end
+    opts[:headers].merge!(headers)
+    http_method = options[:token_method] == :post_with_query_string ? :post : options[:token_method]
+    response = request(http_method, token_url, opts)
+    response_contains_token = response.parsed.is_a?(Hash) &&
+                              (response.parsed.dig("data", "access_token") || response.parsed.dig("data", "id_token"))
+
+    raise OAuth2::Error, response if options[:raise_errors] && !response_contains_token
+
+    return nil if !response_contains_token
+
+    build_access_token(response, access_token_opts, access_token_class)
+  end
+
+  private
+
+  # Returns the authenticator object
+  #
+  # @return [OAuth2::Authenticator] the initialized Authenticator
+  def authenticator
+    OAuth2::Authenticator.new(id, secret, options[:auth_scheme])
+  end
+
+  # Builds the access token from the response of the HTTP call
+  #
+  # @return [AccessToken] the initialized AccessToken
+  def build_access_token(response, access_token_opts, access_token_class)
+    access_token_class.from_hash(self, response.parsed["data"].merge(access_token_opts)).tap do |access_token|
+      access_token.response = response if access_token.respond_to?(:response=)
+    end
+  end
+end

data/lib/tiktok_oauth_strategy/version.rb

@@ -0,0 +1,3 @@
+module TiktokOAuthStrategy
+    VERSION = '0.0.0'
+end

data/lib/tiktok_oauth_strategy.rb

@@ -0,0 +1,2 @@
+require 'tiktok-oauth-strategy/version'
+require 'omniauth/strategies/tiktok'

data/tiktok_oauth_strategy.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/tiktok_oauth_strategy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name          = 'tiktok-oauth-strategy'
+    gem.version       = TiktokOAuthStrategy::VERSION
+    gem.authors       = ['Fariha Hossain']
+    gem.email         = ['fthossain220@gmail.com']
+    gem.description   = 'OmniAuth strategy for TikTok.'
+    gem.summary       = 'OmniAuth strategy for TikTok.'
+    gem.homepage      = 'https://github.com/f-hossain/tiktok_oauth_strategy'
+
+    gem.files         = `git ls-files`.split("\n")
+    gem.require_paths = ['lib']
+    
+    gem.add_dependency 'omniauth', '~> 2.0'
+    gem.add_dependency 'omniauth-oauth2', '~> 1.7'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: tiktok-oauth-strategy
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Fariha Hossain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-08-05 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: OmniAuth strategy for TikTok.
+email:
+- fthossain220@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/strategies/tiktok.rb
+- lib/strategies/tiktok_oauth2_client.rb
+- lib/tiktok_oauth_strategy.rb
+- lib/tiktok_oauth_strategy/version.rb
+- tiktok_oauth_strategy.gemspec
+homepage: https://github.com/f-hossain/tiktok_oauth_strategy
+licenses: []
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for TikTok.
+test_files: []