tiktok-open-sdk 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49fd72cee8903953251d98a9bd2952e08e11ebb480df678a3758214bc6aed326
-  data.tar.gz: 53887f2fce24bf2784762a9a44acc497e5c6209eabcdc2c41809ec9b40f60016
+  metadata.gz: 804836be4e23b6a46c29c263b7b6d802cd2e6a70c61ed02a8f70328715649236
+  data.tar.gz: d2dee367fb303f07078a5e07a5a303f163db4895bb3e7468bbdeb2678308e1db
 SHA512:
-  metadata.gz: 50bd4af46c1e7a05bdcfec937eb040e7d078ebc5b3a951fd1288cdb824fb32a20453e2e4527f9642345c4aefa6b9c9c83306dea78ee166e1c86b07bad6f0ceb2
-  data.tar.gz: 8a8d4b6827e25a81720b30aee2f296fbaf0b328a0a57c7c9a3286c49de3e338a274b3b65f9b39bc67846113612542a5e7b22e74db99eda68d011519441077195
+  metadata.gz: 860dfd7da6a964785d661f1e6c9b2fd84bb324f1c8511207c0b3f981239b5d361490b8c410f31d0600bd5b4302c21b3b0cc69e370ad80814c1dc24c05b03ab06
+  data.tar.gz: 7707f1602f9c088c7d84aff5c20101138fd30e9bfb91569f13062c7e56591361fe4b1ecff06ee6b26b82ee89f362ffb2b5244fb4823c7989b8d9c125df9f9bd2

data/.rubocop.yml

@@ -7,6 +7,9 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
 
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
 Metrics/MethodLength:
   Max: 15
 

data/.yardopts

@@ -0,0 +1,12 @@
+--markup markdown
+--markup-provider redcarpet
+--output-dir doc/
+--no-private
+--protected
+--exclude spec/
+--exclude coverage/
+--exclude tmp/
+--exclude pkg/
+--exclude .github/
+--title "TikTok Open SDK Documentation"
+--main README.md

data/CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2025-10-06
+### Added
+- **OmniAuth Strategy** - Ready-to-use OmniAuth strategy for TikTok Open Platform integration in Rails applications
+  - Supports multiple TikTok OAuth scopes (user.info.basic, user.info.profile, user.info.stats)
+  - Automatic token handling and user info retrieval
+  - Rails/Devise integration examples and callbacks
+- **Post API** - New module for interacting with TikTok's Post API endpoints
+  - Creator info query functionality for video publishing workflows
+  - Support for querying creator settings and capabilities
+
+## [0.3.0] - 2025-09-20
+### Added
+- User information retrieval from TikTok API
+- Improved request validation and error handling
+
 ## [0.2.0] - 2025-09-17
 ### Added
 - Support for obtaining a client access token directly from the TikTok Open API, enabling secure server-to-server authentication for backend integrations and service authentication flows.

data/README.md

@@ -1,6 +1,6 @@
 # TikTok Open SDK
 
-[![Gem Version](https://img.shields.io/badge/gem-v0.2.0-blue.svg)](https://rubygems.org/gems/tiktok-open-sdk)
+[![Gem Version](https://img.shields.io/badge/gem-v0.4.0-blue.svg)](https://rubygems.org/gems/tiktok-open-sdk)
 [![Ruby Version](https://img.shields.io/badge/ruby-%3E%3D%203.0.0-red.svg)](https://www.ruby-lang.org/en/downloads/)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.txt)
 [![CI](https://github.com/pochkuntaras/tiktok-open-sdk/actions/workflows/main.yml/badge.svg)](https://github.com/pochkuntaras/tiktok-open-sdk/actions/workflows/main.yml)
@@ -10,8 +10,11 @@ A comprehensive Ruby SDK for integrating with TikTok Open API. This gem provides
 ## Features
 
 - **OAuth 2.0 Authentication** – Seamless OAuth flow for secure integration
+- **OmniAuth Strategy** – Ready-to-use OmniAuth strategy for Rails applications
 - **Client Authentication** – Server-to-server authentication with client credentials
 - **Token Management** – Easy access token exchange and refresh
+- **User API** – Convenient methods to access user information
+- **Post API** – Methods for querying creator information and video publishing
 - **HTTP Client** – Built-in client for interacting with TikTok APIs
 
 ## Installation
@@ -54,6 +57,11 @@ Tiktok::Open::Sdk.configure do |config|
   config.user_auth.auth_url         = 'https://www.tiktok.com/v2/auth/authorize/'
   config.user_auth.token_url        = 'https://open.tiktokapis.com/v2/oauth/token/'
   config.user_auth.revoke_token_url = 'https://open.tiktokapis.com/v2/oauth/revoke/'
+  config.user_info_url              = 'https://open.tiktokapis.com/v2/user/info/'
+  config.creator_info_query_url     = 'https://open.tiktokapis.com/v2/post/publish/creator_info/query/'
+
+  # Optional: Enable OmniAuth strategy auto-loading
+  config.load_omniauth = true
 end
 ```
 
@@ -156,12 +164,132 @@ end
 
 **Note:** Client tokens are used for server-to-server authentication and have different scopes and permissions than user tokens.
 
+### Using the Post API
+
+The SDK provides convenient methods for interacting with TikTok's Post API:
+
+#### Creator Info Query
+
+Query creator information for video publishing:
+
+```ruby
+# Get creator information
+response = Tiktok::Open::Sdk.post.creator_info_query(access_token: access_token)
+
+if response[:success]
+  creator_data = response[:response][:data]
+
+  puts "Creator Avatar: #{creator_data[:creator_avatar_url]}"
+  puts "Creator Nickname: #{creator_data[:creator_nickname]}"
+  puts "Max Video Duration: #{creator_data[:max_video_post_duration_sec]} seconds"
+  puts "Privacy Options: #{creator_data[:privacy_level_options]}"
+else
+  puts "Error: #{response[:response][:error][:message]}"
+end
+```
+
+### Using the User API
+
+The SDK provides a convenient way to access user information:
+
+```ruby
+# Get user information
+response = Tiktok::Open::Sdk.user.get_user_info(
+  access_token: access_token,
+  fields: %w[open_id union_id avatar_url display_name]
+)
+
+if response[:success]
+  user_data = response[:response][:data][:user]
+  
+  puts "User ID: #{user_data[:open_id]}"
+  puts "Display Name: #{user_data[:display_name]}"
+else
+  puts "Error: #{response[:response][:error][:message]}"
+end
+```
+
+Available user fields include:
+- `open_id` - User's Open ID
+- `union_id` - User's Union ID
+- `avatar_url` - User's avatar URL
+- `display_name` - User's display name
+- `username` - User's username
+- And more (see documentation for full list)
+
+### Using OmniAuth Strategy
+
+The SDK provides a ready-to-use OmniAuth strategy for Rails applications:
+
+#### Rails Setup
+
+Add the OmniAuth strategy to your Rails application:
+
+```ruby
+# config/initializers/devise.rb
+Devise.setup do |config|
+  config.omniauth(
+    :tiktok_open_sdk,
+    Rails.application.credentials.dig(:tiktok, :client_key),
+    Rails.application.credentials.dig(:tiktok, :client_secret),
+    scope:         'user.info.basic,user.info.profile,user.info.stats',
+  )
+end
+```
+
+Or use the SDK configuration:
+
+```ruby
+# config/initializers/tiktok_sdk.rb
+Tiktok::Open::Sdk.configure do |config|
+  config.client_key             = Rails.application.credentials.dig(:tiktok, :client_key)
+  config.client_secret          = Rails.application.credentials.dig(:tiktok, :client_secret)
+  config.user_auth.scopes       = %w[user.info.basic video.publish]
+  config.user_auth.redirect_uri = "#{Rails.application.config.action_mailer.asset_host.chomp('/')}/users/auth/tiktok_open_sdk/callback"
+  config.load_omniauth          = true
+end
+```
+
+#### OmniAuth Callback
+
+Handle the OmniAuth callback in your controller:
+
+```ruby
+# app/controllers/omniauth_callbacks_controller.rb
+class OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def tiktok_open_sdk
+    @auth = request.env['omniauth.auth']
+
+    # Find or create user based on TikTok auth data
+    @user = User.find_for_oauth(@auth)
+
+    # ...
+
+    if @user.persisted?
+      sign_in_and_redirect @user, event: :authentication
+      set_flash_message :notice, :success, kind: 'TikTok'
+    else
+      session['devise.provider_data'] = @auth.except('extra')
+      redirect_to new_user_registration_url
+    end
+  end
+end
+```
+
+#### Supported Scopes
+
+The OmniAuth strategy supports the following TikTok scopes:
+
+- `user.info.basic` - Basic user info: open_id, union_id, display_name, avatar URLs
+- `user.info.profile` - Profile info: username, bio_description, profile_deep_link, is_verified
+- `user.info.stats` - Statistics: follower_count, following_count, likes_count, video_count
+
 ### Using the HTTP Client
 
 The SDK includes a flexible HTTP client for making API calls:
 
 ```ruby
-# GET request
+# GET request using request method
 response = Tiktok::Open::Sdk::HttpClient.request(
   :get,
   'https://open.tiktokapis.com/v2/user/info/',
@@ -173,6 +301,17 @@ response = Tiktok::Open::Sdk::HttpClient.request(
   }
 )
 
+# GET request using get method
+response = Tiktok::Open::Sdk::HttpClient.get(
+  'https://open.tiktokapis.com/v2/user/info/',
+  params: {
+    fields: 'open_id,union_id,avatar_url'
+  },
+  headers: {
+    'Authorization' => "Bearer #{access_token}"
+  }
+)
+
 # POST request
 response = Tiktok::Open::Sdk::HttpClient.post(
   'https://open.tiktokapis.com/v2/video/list/',
@@ -241,6 +380,18 @@ class TiktokAuthController < ApplicationController
       session[:tiktok_access_token]  = token_data[:access_token]
       session[:tiktok_refresh_token] = token_data[:refresh_token]
       
+      # Fetch user information
+      user_response = Tiktok::Open::Sdk::OpenApi::User.get_user_info(
+        access_token: token_data[:access_token],
+        fields: %w[open_id display_name avatar_url]
+      )
+      
+      if user_response[:success]
+        user_data = user_response[:response][:data][:user]
+        session[:tiktok_user_name] = user_data[:display_name]
+        session[:tiktok_avatar] = user_data[:avatar_url]
+      end
+      
       redirect_to dashboard_path, notice: 'Successfully connected to TikTok!'
     else
       redirect_to root_path, alert: 'Failed to authenticate with TikTok'
@@ -276,6 +427,7 @@ Tiktok::Open::Sdk.configure do |config|
   config.client_secret          = 'your_client_secret' # Required
   config.user_auth.scopes       = %w[user.info.basic]  # Optional
   config.user_auth.redirect_uri = 'https://...'        # Optional
+  config.user_info_url          = 'https://open.tiktokapis.com/v2/user/info/' # Optional
 end
 ```
 
@@ -341,6 +493,56 @@ Obtains a client access token for server-to-server authentication.
 }
 ```
 
+### User API
+
+#### `get_user_info(access_token:, fields:, validate: true)`
+
+Retrieves user information from the TikTok Open API.
+
+**Parameters:**
+- `access_token` (String, required) - OAuth2 access token for authentication
+- `fields` (Array<String>, required) - User fields to retrieve (must be valid fields)
+- `validate` (Boolean, optional) - Whether to validate the token and fields (default: true)
+
+**Returns:** Hash with `:success`, `:code`, and `:response` keys
+
+**Available Fields:**
+- `open_id` - Unique identifier for the user within the current application
+- `union_id` - Persistent identifier for the user across different applications from the same developer
+- `avatar_url` - URL to the user's profile image
+- `avatar_url_100` - URL to the user's profile image in 100x100 pixel size
+- `avatar_large_url` - URL to the user's profile image in higher resolution
+- `display_name` - User's display name shown on their TikTok profile
+- `bio_description` - User's biography text (if available)
+- `profile_deep_link` - Direct link to the user's TikTok profile page
+- `is_verified` - Boolean indicating if the account is verified by TikTok
+- `username` - User's unique TikTok username
+- `follower_count` - Number of followers the user has
+- `following_count` - Number of accounts the user is following
+- `likes_count` - Total number of likes received across all user's videos
+- `video_count` - Total number of publicly posted videos by the user
+
+### Post API
+
+#### `creator_info_query(access_token:)`
+
+Queries creator information from the TikTok Open API for video publishing.
+
+**Parameters:**
+- `access_token` (String, required) - OAuth2 access token for authentication
+
+**Returns:** Hash with `:success`, `:code`, and `:response` keys
+
+**Response Data:**
+- `creator_avatar_url` - Creator's avatar URL
+- `creator_nickname` - Creator's display name
+- `creator_username` - Creator's username
+- `stitch_disabled` - Whether stitch is disabled for the creator
+- `comment_disabled` - Whether comments are disabled for the creator
+- `duet_disabled` - Whether duet is disabled for the creator
+- `max_video_post_duration_sec` - Maximum video duration in seconds
+- `privacy_level_options` - Available privacy level options
+
 ### HTTP Client
 
 #### `request(method, url, params: {}, headers: {}, body: nil)`
@@ -356,6 +558,17 @@ Performs HTTP requests.
 
 **Returns:** `Net::HTTPResponse` object
 
+#### `get(url, params: {}, headers: {})`
+
+Convenience method for GET requests.
+
+**Parameters:**
+- `url` (String) - Request URL
+- `params` (Hash, optional) - Query parameters
+- `headers` (Hash, optional) - HTTP headers
+
+**Returns:** `Net::HTTPResponse` object
+
 #### `post(url, params: {}, headers: {}, body: nil)`
 
 Convenience method for POST requests.

data/lib/tiktok/open/omniauth/strategies/tiktok_open_sdk.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module Tiktok
+  module Open
+    module Omniauth
+      module Strategies
+        # OmniAuth strategy for TikTok Open Platform.
+        #
+        # Integrates TikTok OAuth2 authentication with OmniAuth.
+        #
+        # @example
+        #   use OmniAuth::Builder do
+        #     provider :tiktok_open, 'CLIENT_KEY', 'CLIENT_SECRET'
+        #   end
+        #
+        # Supported scopes and their user info fields:
+        #   - user.info.basic:   open_id, union_id, display_name, avatar_url, avatar_url_100, avatar_large_url
+        #   - user.info.profile: profile_deep_link, bio_description, is_verified, username
+        #   - user.info.stats:   follower_count, following_count, likes_count, video_count
+        class TiktokOpenSdk < ::OmniAuth::Strategies::OAuth2
+          # Custom access token class for TikTok.
+          class AccessToken < ::OAuth2::AccessToken; end
+
+          # Maps TikTok OAuth scopes to user info fields.
+          SCOPE_FIELDS = {
+            'user.info.basic'   => %w[open_id union_id display_name avatar_url avatar_url_100 avatar_large_url],
+            'user.info.profile' => %w[profile_deep_link bio_description is_verified username],
+            'user.info.stats'   => %w[follower_count following_count likes_count video_count]
+          }.freeze
+
+          private_constant :SCOPE_FIELDS
+
+          # The name of this OmniAuth strategy.
+          option :name, :tiktok_open_sdk
+
+          # OAuth2 client options for TikTok endpoints.
+          #   - :site: TikTok Open API base URL
+          #   - :authorize_url: TikTok OAuth2 authorization endpoint
+          #   - :token_url: TikTok OAuth2 token endpoint
+          option :client_options, {
+            site:             ::Tiktok::Open::Sdk::Config::OPEN_API_BASE_URL,
+            authorize_url:    ::Tiktok::Open::Sdk.config.user_auth.auth_url,
+            token_url:        ::Tiktok::Open::Sdk.config.user_auth.token_url,
+            auth_scheme:      :request_body,
+            auth_token_class: AccessToken
+          }
+
+          # List of parameters allowed in the authorization request.
+          option :authorize_options, %i[scope state redirect_uri]
+
+          # Default scope and redirect_uri from SDK config.
+          option :scope, ::Tiktok::Open::Sdk.config.user_auth.scopes.join(',')
+          option :redirect_uri, ::Tiktok::Open::Sdk.config.user_auth.redirect_uri
+
+          # Returns the unique TikTok user ID (open_id).
+          #
+          # @return [String] TikTok user's open_id.
+          uid { raw_info[:open_id].to_s }
+
+          # Returns a hash of user information.
+          #
+          # @return [Hash] User info with :name and :image keys, and profile fields if scope is present.
+          info do
+            { name: raw_info[:display_name], image: raw_info[:avatar_url_100] }.tap do |info|
+              if request_scopes.include?('user.info.profile')
+                info.merge!(raw_info.slice(:username, :bio_description, :profile_deep_link))
+              end
+            end
+          end
+
+          # Returns extra raw user information from TikTok.
+          #
+          # @return [Hash] Raw user info data from TikTok API.
+          extra { raw_info }
+
+          # Returns the callback URL without query parameters.
+          #
+          # @return [String] Callback URL.
+          def callback_url
+            super.split('?').first
+          end
+
+          # Builds the access token from TikTok's token endpoint.
+          #
+          # @raise [OAuth2::Error] if the token response is unsuccessful.
+          # @return [AccessToken] OAuth2 access token object.
+          def build_access_token
+            response = fetch_access_token
+            validate_token_response(response)
+            create_access_token(response[:response])
+          end
+
+          # Handles the initial OAuth2 request phase.
+          #
+          # @raise [ArgumentError] if client_secret is present in params.
+          def request_phase
+            params = authorize_params.merge('response_type' => 'code')
+
+            if params.key?(:client_secret) || params.key?('client_secret')
+              raise ArgumentError, 'client_secret is not allowed in authorize URL query params'
+            end
+
+            redirect client.authorize_url(params)
+          end
+
+          # Builds the authorization parameters for the OAuth2 request,
+          # adding the TikTok client_key.
+          #
+          # @return [Hash] Authorization parameters.
+          def authorize_params
+            super.tap do |params|
+              params[:client_key] = options.client_id
+            end
+          end
+
+          private
+
+          # Fetches access token from TikTok API
+          #
+          # @return [Hash] Token response from TikTok
+          def fetch_access_token
+            Tiktok::Open::Sdk.user_auth.fetch_access_token(
+              code:         request.params['code'],
+              redirect_uri: callback_url
+            )
+          end
+
+          # Validates the token response
+          #
+          # @param response [Hash] Token response
+          # @raise [OAuth2::Error] if response is unsuccessful
+          def validate_token_response(response)
+            raise OAuth2::Error, response[:response] unless response[:success]
+          end
+
+          # Creates AccessToken from response data
+          #
+          # @param data [Hash] Token data from response
+          # @return [AccessToken] OAuth2 access token object
+          def create_access_token(data)
+            AccessToken.from_hash(
+              client,
+              access_token:  data[:access_token],
+              refresh_token: data[:refresh_token],
+              expires_at:    Time.now.to_i + data[:expires_in].to_i
+            )
+          end
+
+          # Returns the list of requested OAuth scopes.
+          #
+          # @return [Array<String>] List of scope strings.
+          def request_scopes
+            @request_scopes ||= request.params.fetch('scopes', 'user.info.basic').split(',')
+          end
+
+          # Returns the list of user info fields to request from TikTok,
+          # based on the requested scopes.
+          #
+          # @return [Array<String>] List of user info field names.
+          def user_info_fields
+            request_scopes.flat_map { |scope| SCOPE_FIELDS[scope] }.compact
+          end
+
+          # Fetches and memoizes the raw user info from the TikTok API.
+          #
+          # @return [Hash] Raw user info data, or empty hash if unavailable.
+          def raw_info
+            @raw_info ||= Tiktok::Open::Sdk.user.get_user_info(
+              access_token: access_token.token,
+              fields:       user_info_fields
+            ).dig(:response, :data, :user) || {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tiktok/open/sdk/config.rb

@@ -13,44 +13,71 @@ module Tiktok
       #   config.client_secret = 'your_secret'
       #   config.user_auth.scopes = %w[user.info.basic]
       class Config
-        # @return [String] The TikTok client key.
+        # Base domains for constructing TikTok API URLs.
+        AUTH_BASE_URL     = 'https://www.tiktok.com'
+        OPEN_API_BASE_URL = 'https://open.tiktokapis.com'
+
+        # @!attribute [rw] client_key
+        #   @return [String] TikTok client key.
         attr_accessor :client_key
 
-        # @return [String] The TikTok client secret.
+        # @!attribute [rw] client_secret
+        #   @return [String] TikTok client secret.
         attr_accessor :client_secret
 
-        # @return [UserAuth] The user authentication configuration.
+        # @!attribute [rw] user_info_url
+        #   @return [String] TikTok user info endpoint URL.
+        attr_accessor :user_info_url
+
+        # @!attribute [rw] creator_info_query_url
+        #   @return [String] TikTok Query Creator Info endpoint URL.
+        attr_accessor :creator_info_query_url
+
+        # @!attribute [rw] user_auth
+        #   @return [UserAuth] User authentication configuration.
         attr_accessor :user_auth
 
-        # Initializes a new Config object with default user authentication settings.
+        # @!attribute [rw] load_omniauth
+        #   @return [Boolean] Whether to automatically load OmniAuth strategy.
+        attr_accessor :load_omniauth
+
+        # Create a new Config with default user authentication settings.
         def initialize
-          @user_auth = UserAuth.new
+          @user_info_url          = "#{OPEN_API_BASE_URL}/v2/user/info/"
+          @creator_info_query_url = "#{OPEN_API_BASE_URL}/v2/post/publish/creator_info/query/"
+          @user_auth              = UserAuth.new
+          @load_omniauth          = false
         end
 
         # User authentication configuration for TikTok Open SDK.
         #
         # Holds OAuth URLs, scopes, and redirect URI.
         class UserAuth
-          # @return [String] The OAuth authorization URL.
+          # @!attribute [rw] auth_url
+          #   @return [String] OAuth authorization URL.
           attr_accessor :auth_url
 
-          # @return [String] The OAuth token exchange URL.
-          attr_accessor :token_url
-
-          # @return [String] The OAuth token revoke URL.
+          # @!attribute [rw] revoke_token_url
+          #   @return [String] OAuth token revocation URL.
           attr_accessor :revoke_token_url
 
-          # @return [Array<String>] The list of OAuth scopes.
+          # @!attribute [rw] token_url
+          #   @return [String] OAuth token exchange URL.
+          attr_accessor :token_url
+
+          # @!attribute [rw] scopes
+          #   @return [Array<String>] List of OAuth scopes.
           attr_accessor :scopes
 
-          # @return [String, nil] The OAuth redirect URI.
+          # @!attribute [rw] redirect_uri
+          #   @return [String, nil] OAuth redirect URI.
           attr_accessor :redirect_uri
 
           # Initializes a new UserAuth object with default URLs and empty scopes.
           def initialize
-            @auth_url         = 'https://www.tiktok.com/v2/auth/authorize/'
-            @revoke_token_url = 'https://open.tiktokapis.com/v2/oauth/revoke/'
-            @token_url        = 'https://open.tiktokapis.com/v2/oauth/token/'
+            @auth_url         = "#{AUTH_BASE_URL}/v2/auth/authorize/"
+            @revoke_token_url = "#{OPEN_API_BASE_URL}/v2/oauth/revoke/"
+            @token_url        = "#{OPEN_API_BASE_URL}/v2/oauth/token/"
             @scopes           = []
             @redirect_uri     = nil
           end

data/lib/tiktok/open/sdk/helpers/auth_helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Tiktok
+  module Open
+    module Sdk
+      module Helpers
+        # Shared authentication helper methods for TikTok Open SDK auth modules.
+        module AuthHelper
+          private
+
+          # Returns the HTTP headers for requests.
+          #
+          # @return [Hash] The headers for HTTP requests.
+          def headers
+            {
+              'Content-Type':  'application/x-www-form-urlencoded',
+              'Cache-Control': 'no-cache'
+            }
+          end
+
+          # Returns the client credentials for authentication.
+          #
+          # @return [Hash] The client credentials.
+          def credentials
+            {
+              client_key:    Tiktok::Open::Sdk.config.client_key,
+              client_secret: Tiktok::Open::Sdk.config.client_secret
+            }
+          end
+
+          # Returns the default query parameters for the authorization URI.
+          #
+          # @return [Hash] The default query parameters:
+          #   - :client_key [String] The TikTok client key.
+          #   - :response_type [String] Always 'code'.
+          #   - :scope [String] Comma-separated scopes.
+          #   - :redirect_uri [String] The redirect URI.
+          #   - :state [nil] Default state is nil.
+          def authorization_uri_default_params
+            {
+              client_key:    Tiktok::Open::Sdk.config.client_key,
+              response_type: 'code',
+              scope:         Tiktok::Open::Sdk.config.user_auth.scopes.join(','),
+              redirect_uri:  Tiktok::Open::Sdk.config.user_auth.redirect_uri,
+              state:         nil
+            }
+          end
+
+          # render_response moved to ::Tiktok::Open::Sdk::ResponseHelpers
+        end
+      end
+    end
+  end
+end

data/lib/tiktok/open/sdk/helpers/response_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Tiktok
+  module Open
+    module Sdk
+      module Helpers
+        # Helper methods for formatting HTTP responses across the SDK.
+        module ResponseHelper
+          include ::Tiktok::Open::Sdk::Helpers::StringUtilsHelper
+
+          # Parses and formats the HTTP response.
+          #
+          # @param response [Net::HTTPResponse] The HTTP response object.
+          # @return [Hash] The formatted response with keys:
+          #   - :success [Boolean] Whether the response is a Net::HTTPSuccess.
+          #   - :code [Integer] HTTP status code.
+          #   - :response [Hash] Parsed JSON body or a hash with the raw string if parsing fails.
+          def render_response(response)
+            {
+              success:  response.is_a?(Net::HTTPSuccess),
+              code:     response.code.to_i,
+              response: parse_json(response.body)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tiktok/open/sdk/helpers/string_utils_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Tiktok
+  module Open
+    module Sdk
+      module Helpers
+        # Utility methods for string and JSON handling.
+        module StringUtilsHelper
+          # Parses a JSON string into a Ruby hash with symbolized keys.
+          #
+          # @param str [String] JSON string to parse.
+          # @return [Hash] Parsed hash with symbolized keys, or a hash with the raw string if parsing fails.
+          def parse_json(str)
+            JSON.parse(str, symbolize_names: true)
+          rescue JSON::ParserError
+            { raw: str }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tiktok/open/sdk/helpers/validators/token_validator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Tiktok
+  module Open
+    module Sdk
+      module Helpers
+        module Validators
+          # Provides token validation methods for TikTok Open SDK.
+          module TokenValidator
+            # Regular expression to validate tokens.
+            # Ensures the token consists of at least 10 printable characters.
+            TOKEN_REGEX = /\A[[:print:]]{10,}\z/
+
+            # Checks if the given token is a valid string of at least 10 printable characters.
+            #
+            # @param token [String] The token to check.
+            # @return [Boolean] true if the token is valid, false otherwise.
+            def valid_token?(token)
+              token.is_a?(String) && !token.empty? && TOKEN_REGEX.match?(token)
+            end
+
+            # Validates the given token and raises an error if it is invalid.
+            #
+            # @param token [String] The token to validate.
+            # @raise [::Tiktok::Open::Sdk::RequestValidationError] if the token is invalid.
+            # @return [void]
+            def validate_token!(token)
+              return if valid_token?(token)
+
+              raise ::Tiktok::Open::Sdk::RequestValidationError,
+                    'Invalid token format: must be at least 10 printable characters.'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tiktok/open/sdk/http_client.rb

@@ -13,8 +13,6 @@ module Tiktok
       module HttpClient
         extend self
 
-        include StringUtils
-
         # Supported HTTP methods.
         SUPPORTED_METHODS = %i[get post].freeze
 
@@ -53,6 +51,16 @@ module Tiktok
           request(:post, url, params: params, headers: headers, body: body)
         end
 
+        # Performs a GET HTTP request.
+        #
+        # @param url [String] The request URL.
+        # @param params [Hash] Query parameters.
+        # @param headers [Hash] HTTP headers.
+        # @return [Net::HTTPResponse] The HTTP response object.
+        def get(url, params: {}, headers: {})
+          request(:get, url, params: params, headers: headers)
+        end
+
         private
 
         # Ensures the HTTP method is supported.
@@ -77,7 +85,7 @@ module Tiktok
           case content_type
           when 'application/x-www-form-urlencoded'
             request.set_form_data(body)
-          when 'application/json'
+          when 'application/json', 'application/json; charset=UTF-8'
             request.body = body.to_json
           else
             raise ArgumentError, "Unsupported content type: #{content_type}"

data/lib/tiktok/open/sdk/open_api/auth/client.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'uri'
-
 module Tiktok
   module Open
     module Sdk
@@ -11,7 +9,8 @@ module Tiktok
           module Client
             extend self
 
-            include Helpers
+            include ::Tiktok::Open::Sdk::Helpers::AuthHelper
+            include ::Tiktok::Open::Sdk::Helpers::ResponseHelper
 
             # Fetches a client access token from the TikTok Open API.
             #

data/lib/tiktok/open/sdk/open_api/auth/user.rb

@@ -11,7 +11,8 @@ module Tiktok
           module User
             extend self
 
-            include Helpers
+            include ::Tiktok::Open::Sdk::Helpers::AuthHelper
+            include ::Tiktok::Open::Sdk::Helpers::ResponseHelper
 
             # Constructs the TikTok OAuth authorization URI.
             #
@@ -22,7 +23,7 @@ module Tiktok
             # @return [URI] The constructed authorization URI.
             def authorization_uri(params = {})
               allowed_params = params.slice(:scope, :redirect_uri, :state)
-              uri            = URI(Tiktok::Open::Sdk.config.user_auth.auth_url)
+              uri            = URI.parse(Tiktok::Open::Sdk.config.user_auth.auth_url)
               query_params   = authorization_uri_default_params.merge(allowed_params)
               uri.query      = URI.encode_www_form(query_params)
 

data/lib/tiktok/open/sdk/open_api/post/publish.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Provides methods to interact with TikTok Open API post endpoints.
+module Tiktok
+  module Open
+    module Sdk
+      module OpenApi
+        module Post
+          # Provides methods for handling TikTok Open API post endpoints.
+          module Publish
+            extend self
+
+            include ::Tiktok::Open::Sdk::Helpers::ResponseHelper
+            include ::Tiktok::Open::Sdk::Helpers::Validators::TokenValidator
+
+            # Queries creator information from the TikTok Open API.
+            #
+            # @param access_token [String] OAuth2 access token for authentication.
+            # @return [Hash] Parsed API response containing creator information.
+            # @raise [::Tiktok::Open::Sdk::RequestValidationError] If the access token is invalid.
+            #
+            # @example
+            #   Tiktok::Open::Sdk.post.creator_info_query(access_token: 'your_access_token')
+            def creator_info_query(access_token:)
+              validate_token!(access_token)
+
+              render_response Tiktok::Open::Sdk::HttpClient.post(
+                Tiktok::Open::Sdk.config.creator_info_query_url,
+                headers: {
+                  Authorization: "Bearer #{access_token}"
+                }
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tiktok/open/sdk/open_api/user.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Provides methods to interact with TikTok Open API user endpoints.
+module Tiktok
+  module Open
+    module Sdk
+      module OpenApi
+        # Provides user-related methods for the TikTok Open API.
+        module User
+          # List of valid user info fields that can be requested from the API.
+          FIELDS = %w[
+            open_id
+            union_id
+            avatar_url
+            avatar_url_100
+            avatar_large_url
+            display_name
+            bio_description
+            profile_deep_link
+            is_verified
+            username
+            follower_count
+            following_count
+            likes_count
+            video_count
+          ].freeze
+
+          extend self
+
+          include ::Tiktok::Open::Sdk::Helpers::ResponseHelper
+          include ::Tiktok::Open::Sdk::Helpers::Validators::TokenValidator
+
+          # Retrieves user information from the TikTok Open API.
+          #
+          # @param access_token [String] OAuth2 access token for authentication.
+          # @param fields [Array<String>] User fields to retrieve. Must be a subset of FIELDS.
+          # @param validate [Boolean] Whether to validate the token and fields. Defaults to true.
+          # @return [Hash] Parsed API response containing user information.
+          # @raise [::Tiktok::Open::Sdk::RequestValidationError] If the access token or any requested field is invalid.
+          def get_user_info(access_token:, fields:, validate: true)
+            if validate
+              validate_token!(access_token)
+              validate_fields!(fields)
+            end
+
+            render_response Tiktok::Open::Sdk::HttpClient.get(
+              Tiktok::Open::Sdk.config.user_info_url,
+              params:  {
+                fields: fields.join(',')
+              },
+              headers: {
+                Authorization: "Bearer #{access_token}"
+              }
+            )
+          end
+
+          private
+
+          # Ensures all requested fields are supported by the API.
+          #
+          # @param fields [Array<String>] Fields to validate against FIELDS.
+          # @raise [::Tiktok::Open::Sdk::RequestValidationError] If any field is not supported.
+          def validate_fields!(fields)
+            invalid = fields - FIELDS
+
+            return if invalid.empty?
+
+            raise ::Tiktok::Open::Sdk::RequestValidationError, "Invalid fields: #{invalid.join(", ")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tiktok/open/sdk/version.rb

@@ -3,7 +3,7 @@
 module Tiktok
   module Open
     module Sdk
-      VERSION = '0.2.0'
+      VERSION = '0.4.0'
     end
   end
 end

data/lib/tiktok/open/sdk.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'sdk/string_utils'
-
-require_relative 'sdk/open_api/auth/helpers'
+require_relative 'sdk/helpers/string_utils_helper'
+require_relative 'sdk/helpers/response_helper'
+require_relative 'sdk/helpers/auth_helper'
+require_relative 'sdk/helpers/validators/token_validator'
 require_relative 'sdk/open_api/auth/user'
 require_relative 'sdk/open_api/auth/client'
+require_relative 'sdk/open_api/post/publish'
+require_relative 'sdk/open_api/user'
 require_relative 'sdk/version'
 require_relative 'sdk/http_client'
 require_relative 'sdk/config'
@@ -19,6 +22,8 @@ module Tiktok
       #   raise Tiktok::Open::Sdk::Error, "Something went wrong"
       class Error < StandardError; end
 
+      class RequestValidationError < Error; end
+
       class << self
         # SDK configuration object
         #
@@ -41,12 +46,15 @@ module Tiktok
         #     config.user_auth.token_url = 'https://open.tiktokapis.com/v2/oauth/token/'
         #     config.user_auth.scopes = %w[user.info.basic video.list]
         #     config.user_auth.redirect_uri = 'https://your-redirect-uri.example.com'
+        #     config.load_omniauth = true
         #   end
         def configure
           self.config ||= Config.new
 
           yield(config)
 
+          load_omniauth! if config.load_omniauth
+
           config
         end
 
@@ -69,6 +77,44 @@ module Tiktok
         def client_auth
           OpenApi::Auth::Client
         end
+
+        # Convenience accessor for post publish functionality
+        #
+        # @return [OpenApi::Post::Publish] the Post publish module
+        #
+        # @example
+        #   Tiktok::Open::Sdk.post.video_init(access_token: 'token', post_info: post_info, source_info: source_info)
+        def post
+          OpenApi::Post::Publish
+        end
+
+        # Convenience accessor for user functionality
+        #
+        # @return [OpenApi::User] the User module
+        #
+        # @example
+        #   Tiktok::Open::Sdk.user.info(access_token: 'token')
+        def user
+          OpenApi::User
+        end
+
+        private
+
+        # Loads the OmniAuth strategy for TikTok Open Platform.
+        #
+        # Attempts to require the necessary OmniAuth dependencies for TikTok Open integration.
+        # Raises an error if the required gems are not available.
+        #
+        # @raise [Tiktok::Open::Sdk::Error] if 'omniauth-oauth2' or the TikTok strategy cannot be loaded
+        # @example
+        #   Tiktok::Open::Sdk.load_omniauth!
+        def load_omniauth!
+          require 'omniauth-oauth2'
+          require 'tiktok/open/omniauth/strategies/tiktok_open_sdk'
+        rescue LoadError => e
+          raise ::Tiktok::Open::Sdk::Error,
+                "OmniAuth is not loaded! Error: #{e.message}"
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiktok-open-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Taras Pochkun
@@ -20,18 +20,24 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/tiktok/open/omniauth/strategies/tiktok_open_sdk.rb
 - lib/tiktok/open/sdk.rb
 - lib/tiktok/open/sdk/config.rb
+- lib/tiktok/open/sdk/helpers/auth_helper.rb
+- lib/tiktok/open/sdk/helpers/response_helper.rb
+- lib/tiktok/open/sdk/helpers/string_utils_helper.rb
+- lib/tiktok/open/sdk/helpers/validators/token_validator.rb
 - lib/tiktok/open/sdk/http_client.rb
 - lib/tiktok/open/sdk/open_api/auth/client.rb
-- lib/tiktok/open/sdk/open_api/auth/helpers.rb
 - lib/tiktok/open/sdk/open_api/auth/user.rb
-- lib/tiktok/open/sdk/string_utils.rb
+- lib/tiktok/open/sdk/open_api/post/publish.rb
+- lib/tiktok/open/sdk/open_api/user.rb
 - lib/tiktok/open/sdk/version.rb
 - sig/tiktok/open/sdk.rbs
 homepage: https://github.com/pochkuntaras/tiktok-open-sdk
@@ -40,9 +46,10 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/pochkuntaras/tiktok-open-sdk
-  source_code_uri: https://github.com/pochkuntaras/tiktok-open-sdk
+  source_code_uri: https://github.com/pochkuntaras/tiktok-open-sdk.git
   changelog_uri: https://github.com/pochkuntaras/tiktok-open-sdk/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
+  documentation_uri: https://rubydoc.info/gems/tiktok-open-sdk
 rdoc_options: []
 require_paths:
 - lib

data/lib/tiktok/open/sdk/open_api/auth/helpers.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Tiktok
-  module Open
-    module Sdk
-      module OpenApi
-        module Auth
-          # Shared authentication helper methods for TikTok Open SDK auth modules.
-          module Helpers
-            include StringUtils
-
-            private
-
-            # Returns the HTTP headers for requests.
-            #
-            # @return [Hash] The headers for HTTP requests.
-            def headers
-              {
-                'Content-Type':  'application/x-www-form-urlencoded',
-                'Cache-Control': 'no-cache'
-              }
-            end
-
-            # Returns the client credentials for authentication.
-            #
-            # @return [Hash] The client credentials.
-            def credentials
-              {
-                client_key:    Tiktok::Open::Sdk.config.client_key,
-                client_secret: Tiktok::Open::Sdk.config.client_secret
-              }
-            end
-
-            # Returns the default query parameters for the authorization URI.
-            #
-            # @return [Hash] The default query parameters:
-            #   - :client_key [String] The TikTok client key.
-            #   - :response_type [String] Always 'code'.
-            #   - :scope [String] Comma-separated scopes.
-            #   - :redirect_uri [String] The redirect URI.
-            #   - :state [nil] Default state is nil.
-            def authorization_uri_default_params
-              {
-                client_key:    Tiktok::Open::Sdk.config.client_key,
-                response_type: 'code',
-                scope:         Tiktok::Open::Sdk.config.user_auth.scopes.join(','),
-                redirect_uri:  Tiktok::Open::Sdk.config.user_auth.redirect_uri,
-                state:         nil
-              }
-            end
-
-            # Parses and formats the HTTP response.
-            #
-            # @param response [Net::HTTPResponse] The HTTP response object.
-            # @return [Hash] The formatted response with keys:
-            #   - :success [Boolean] Whether the response is a Net::HTTPSuccess.
-            #   - :code [Integer] HTTP status code.
-            #   - :response [Hash] Parsed JSON body or a hash with the raw string if parsing fails.
-            def render_response(response)
-              {
-                success:  response.is_a?(Net::HTTPSuccess),
-                code:     response.code.to_i,
-                response: parse_json(response.body)
-              }
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/tiktok/open/sdk/string_utils.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Tiktok
-  module Open
-    module Sdk
-      # Utility methods for string and JSON handling.
-      module StringUtils
-        module_function
-
-        # Parses a JSON string into a Ruby hash with symbolized keys.
-        #
-        # @param str [String] JSON string to parse.
-        # @return [Hash] Parsed hash with symbolized keys, or a hash with the raw string if parsing fails.
-        def parse_json(str)
-          JSON.parse(str, symbolize_names: true)
-        rescue JSON::ParserError
-          { raw: str }
-        end
-      end
-    end
-  end
-end