agora-ruby 0.1.0

data/lib/agora/dynamic_key2/rtc_token_builder.rb

@@ -0,0 +1,215 @@
+module Agora::AgoraDynamicKey2
+  class RtcTokenBuilder
+    # RECOMMENDED. Use this role for a voice/video call or a live broadcast, if
+    # your scenario does not require authentication for
+    # [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication).
+    ROLE_PUBLISHER = 1
+
+    # Only use this role if your scenario require authentication for
+    # [Co-host](https://docs.agora.io/en/video-calling/get-started/authentication-workflow?#co-host-token-authentication).
+    # @note In order for this role to take effect, please contact our support team
+    # to enable authentication for Hosting-in for you. Otherwise, Role_Subscriber
+    # still has the same privileges as Role_Publisher.
+    ROLE_SUBSCRIBER = 2
+
+    # Build the RTC token with uid.
+    #
+    # app_id: The App ID issued to you by Agora. Apply for a new App ID from Agora Dashboard if it is missing
+    #     from your kit. See Get an App ID.
+    # app_certificate: Certificate of the application that you registered in the Agora Dashboard.
+    #     See Get an App Certificate.
+    # channel_name: Unique channel name for the AgoraRTC session in the string format.
+    # uid: User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
+    #     uid must be unique.
+    # role: ROLE_PUBLISHER: A broadcaster/host in a live-broadcast profile.
+    #     ROLE_SUBSCRIBER: An audience(default) in a live-broadcast profile.
+    # token_expire: represented by the number of seconds elapsed since now. If, for example,
+    #    you want to access the Agora Service within 10 minutes after the token is generated,
+    #    set token_expire as 600(seconds).
+    # privilege_expire: represented by the number of seconds elapsed since now. If, for example,
+    #    you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).
+    # return: The RTC token.
+    def self.build_token_with_uid(app_id, app_certificate, channel_name, uid, role, token_expire, privilege_expire = 0)
+      build_token_with_user_account(app_id, app_certificate, channel_name, uid, role, token_expire, privilege_expire)
+    end
+
+    # Build the RTC token with account.
+    #
+    # app_id: The App ID issued to you by Agora. Apply for a new App ID from Agora Dashboard if it is missing
+    #     from your kit. See Get an App ID.
+    # app_certificate: Certificate of the application that you registered in the Agora Dashboard.
+    #     See Get an App Certificate.
+    # channel_name: Unique channel name for the AgoraRTC session in the string format.
+    # uid: User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
+    #     uid must be unique.
+    # role: ROLE_PUBLISHER: A broadcaster/host in a live-broadcast profile.
+    #     ROLE_SUBSCRIBER: An audience(default) in a live-broadcast profile.
+    # token_expire: represented by the number of seconds elapsed since now. If, for example,
+    #    you want to access the Agora Service within 10 minutes after the token is generated,
+    #    set token_expire as 600(seconds).
+    # privilege_expire: represented by the number of seconds elapsed since now. If, for example,
+    #    you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).
+    # return: The RTC token.
+    def self.build_token_with_user_account(app_id, app_certificate, channel_name, account, role, token_expire, privilege_expire = 0)
+      access_token = Agora::AgoraDynamicKey2::AccessToken.new(app_id, app_certificate, token_expire)
+      service_rtc = Agora::AgoraDynamicKey2::ServiceRtc.new(channel_name, account)
+
+      service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_JOIN_CHANNEL, privilege_expire)
+      if role == ROLE_PUBLISHER
+        service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_AUDIO_STREAM, privilege_expire)
+        service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_VIDEO_STREAM, privilege_expire)
+        service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_DATA_STREAM, privilege_expire)
+      end
+      access_token.add_service(service_rtc)
+      access_token.build
+    end
+
+    # Generates an RTC token with the specified privilege.
+    #
+    # This method supports generating a token with the following privileges:
+    # - Joining an RTC channel.
+    # - Publishing audio in an RTC channel.
+    # - Publishing video in an RTC channel.
+    # - Publishing data streams in an RTC channel.
+    #
+    # The privileges for publishing audio, video, and data streams in an RTC channel apply only if you have
+    # enabled co-host authentication.
+    #
+    # A user can have multiple privileges. Each privilege is valid for a maximum of 24 hours.
+    # The SDK triggers the onTokenPrivilegeWillExpire and onRequestToken callbacks when the token is about to expire
+    # or has expired. The callbacks do not report the specific privilege affected, and you need to maintain
+    # the respective timestamp for each privilege in your app logic. After receiving the callback, you need
+    # to generate a new token, and then call renewToken to pass the new token to the SDK, or call joinChannel to re-join
+    # the channel.
+    #
+    # @note
+    # Agora recommends setting a reasonable timestamp for each privilege according to your scenario.
+    # Suppose the expiration timestamp for joining the channel is set earlier than that for publishing audio.
+    # When the token for joining the channel expires, the user is immediately kicked off the RTC channel
+    # and cannot publish any audio stream, even though the timestamp for publishing audio has not expired.
+    #
+    # @param app_id The App ID of your Agora project.
+    # @param app_certificate The App Certificate of your Agora project.
+    # @param channel_name The unique channel name for the Agora RTC session in string format. The string length must be less than 64 bytes. The channel name may contain the following characters:
+    # - All lowercase English letters: a to z.
+    # - All uppercase English letters: A to Z.
+    # - All numeric characters: 0 to 9.
+    # - The space character.
+    # - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+    # @param uid The user ID. A 32-bit unsigned integer with a value range from 1 to (2^32 - 1). It must be unique. Set uid as 0, if you do not want to authenticate the user ID, that is, any uid from the app client can join the channel.
+    # @param token_expire represented by the number of seconds elapsed since now. If, for example, you want to access the
+    # Agora Service within 10 minutes after the token is generated, set token_expire as 600(seconds).
+    # @param join_channel_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to join channel and expect stay in the channel for 10 minutes, set join_channel_privilege_expire as 600(seconds).
+    # @param pub_audio_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to enable publish audio privilege for 10 minutes, set pub_audio_privilege_expire as 600(seconds).
+    # @param pub_video_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to enable publish video privilege for 10 minutes, set pub_video_privilege_expire as 600(seconds).
+    # @param pub_data_stream_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to enable publish data stream privilege for 10 minutes, set pub_data_stream_privilege_expire as 600(seconds).
+    # @return The RTC Token
+    def self.build_token_with_uid_and_privilege(app_id, app_certificate, channel_name, uid, token_expire,
+                                                join_channel_privilege_expire, pub_audio_privilege_expire,
+                                                pub_video_privilege_expire, pub_data_stream_privilege_expire)
+      build_token_with_user_account_and_privilege(
+        app_id, app_certificate, channel_name, uid, token_expire, join_channel_privilege_expire,
+        pub_audio_privilege_expire, pub_video_privilege_expire, pub_data_stream_privilege_expire
+      )
+    end
+
+    # Generates an RTC token with the specified privilege.
+    #
+    # This method supports generating a token with the following privileges:
+    # - Joining an RTC channel.
+    # - Publishing audio in an RTC channel.
+    # - Publishing video in an RTC channel.
+    # - Publishing data streams in an RTC channel.
+    #
+    # The privileges for publishing audio, video, and data streams in an RTC channel apply only if you have
+    # enabled co-host authentication.
+    #
+    # A user can have multiple privileges. Each privilege is valid for a maximum of 24 hours.
+    # The SDK triggers the onTokenPrivilegeWillExpire and onRequestToken callbacks when the token is about to expire
+    # or has expired. The callbacks do not report the specific privilege affected, and you need to maintain
+    # the respective timestamp for each privilege in your app logic. After receiving the callback, you need
+    # to generate a new token, and then call renewToken to pass the new token to the SDK, or call joinChannel to re-join
+    # the channel.
+    #
+    # @note
+    # Agora recommends setting a reasonable timestamp for each privilege according to your scenario.
+    # Suppose the expiration timestamp for joining the channel is set earlier than that for publishing audio.
+    # When the token for joining the channel expires, the user is immediately kicked off the RTC channel
+    # and cannot publish any audio stream, even though the timestamp for publishing audio has not expired.
+    #
+    # @param app_id The App ID of your Agora project.
+    # @param app_certificate The App Certificate of your Agora project.
+    # @param channel_name The unique channel name for the Agora RTC session in string format. The string length must be less than 64 bytes. The channel name may contain the following characters:
+    # - All lowercase English letters: a to z.
+    # - All uppercase English letters: A to Z.
+    # - All numeric characters: 0 to 9.
+    # - The space character.
+    # - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
+    # @param account The user account.
+    # @param token_expire represented by the number of seconds elapsed since now. If, for example, you want to access the
+    # Agora Service within 10 minutes after the token is generated, set token_expire as 600(seconds).
+    # @param join_channel_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to join channel and expect stay in the channel for 10 minutes, set join_channel_privilege_expire as 600(seconds).
+    # @param pub_audio_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to enable publish audio privilege for 10 minutes, set pub_audio_privilege_expire as 600(seconds).
+    # @param pub_video_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to enable publish video privilege for 10 minutes, set pub_video_privilege_expire as 600(seconds).
+    # @param pub_data_stream_privilege_expire represented by the number of seconds elapsed since now.
+    # If, for example, you want to enable publish data stream privilege for 10 minutes, set pub_data_stream_privilege_expire as 600(seconds).
+    # @return The RTC Token
+    def self.build_token_with_user_account_and_privilege(app_id, app_certificate, channel_name, account, token_expire,
+                                                          join_channel_privilege_expire, pub_audio_privilege_expire,
+                                                          pub_video_privilege_expire, pub_data_stream_privilege_expire)
+      access_token = Agora::AgoraDynamicKey2::AccessToken.new(app_id, app_certificate, token_expire)
+      service_rtc = Agora::AgoraDynamicKey2::ServiceRtc.new(channel_name, account)
+
+      service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_JOIN_CHANNEL, join_channel_privilege_expire)
+      service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_AUDIO_STREAM, pub_audio_privilege_expire)
+      service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_VIDEO_STREAM, pub_video_privilege_expire)
+      service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_DATA_STREAM, pub_data_stream_privilege_expire)
+      access_token.add_service(service_rtc)
+      access_token.build
+    end
+
+    # Build the RTC and RTM token with account.
+    #
+    # app_id: The App ID issued to you by Agora. Apply for a new App ID from Agora Dashboard if it is missing
+    #     from your kit. See Get an App ID.
+    # app_certificate: Certificate of the application that you registered in the Agora Dashboard.
+    #     See Get an App Certificate.
+    # channel_name: Unique channel name for the AgoraRTC session in the string format.
+    # uid: User ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
+    #     uid must be unique.
+    # role: ROLE_PUBLISHER: A broadcaster/host in a live-broadcast profile.
+    #     ROLE_SUBSCRIBER: An audience(default) in a live-broadcast profile.
+    # token_expire: represented by the number of seconds elapsed since now. If, for example,
+    #    you want to access the Agora Service within 10 minutes after the token is generated,
+    #    set token_expire as 600(seconds).
+    # privilege_expire: represented by the number of seconds elapsed since now. If, for example,
+    #    you want to enable your privilege for 10 minutes, set privilege_expire as 600(seconds).
+    # return: The RTC and RTM token.
+    def self.build_token_with_rtm(app_id, app_certificate, channel_name, account, role, token_expire, privilege_expire = 0)
+      access_token = Agora::AgoraDynamicKey2::AccessToken.new(app_id, app_certificate, token_expire)
+      service_rtc = Agora::AgoraDynamicKey2::ServiceRtc.new(channel_name, account)
+
+      service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_JOIN_CHANNEL, privilege_expire)
+      if role == ROLE_PUBLISHER
+        service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_AUDIO_STREAM, privilege_expire)
+        service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_VIDEO_STREAM, privilege_expire)
+        service_rtc.add_privilege(Agora::AgoraDynamicKey2::ServiceRtc::PRIVILEGE_PUBLISH_DATA_STREAM, privilege_expire)
+      end
+      access_token.add_service(service_rtc)
+
+      service_rtm = Agora::AgoraDynamicKey2::ServiceRtm.new(account)
+
+      service_rtm.add_privilege(Agora::AgoraDynamicKey2::ServiceRtm::PRIVILEGE_JOIN_LOGIN, token_expire)
+      access_token.add_service(service_rtm)
+
+      access_token.build
+    end
+  end
+end

data/lib/agora/dynamic_key2/rtm_token_builder.rb

@@ -0,0 +1,22 @@
+module Agora::AgoraDynamicKey2
+  class RtmTokenBuilder
+    # Build the RTM token.
+    #
+    # @param app_id:          The App ID issued to you by Agora. Apply for a new App ID from
+    #                         Agora Dashboard if it is missing from your kit. See Get an App ID.
+    # @param app_certificate: Certificate of the application that you registered in
+    #                         the Agora Dashboard. See Get an App Certificate.
+    # @param user_id:         The user's account, max length is 64 Bytes.
+    # @param expire:          represented by the number of seconds elapsed since now. If, for example, you want to access the
+    #                         Agora Service within 10 minutes after the token is generated, set expire as 600(seconds).
+    # @return The RTM token.
+    def self.build_token(app_id, app_certificate, user_id, expire)
+      access_token = Agora::AgoraDynamicKey2::AccessToken.new(app_id, app_certificate, expire)
+      service_rtm = Agora::AgoraDynamicKey2::ServiceRtm.new(user_id)
+
+      service_rtm.add_privilege(Agora::AgoraDynamicKey2::ServiceRtm::PRIVILEGE_JOIN_LOGIN, expire)
+      access_token.add_service(service_rtm)
+      access_token.build
+    end
+  end
+end

data/lib/agora/dynamic_key2/util.rb

@@ -0,0 +1,60 @@
+require 'base64'
+
+module Agora::AgoraDynamicKey2
+  class Util
+    def self.pack_int16(int)
+      [int].pack('s')
+    end
+
+    def self.unpack_int16(data)
+      [data[0..2].unpack1('s'), data[2..-1]]
+    end
+
+    def self.pack_uint16(int)
+      [int].pack('v')
+    end
+
+    def self.unpack_uint16(data)
+      [data[0..2].unpack1('v'), data[2..-1]]
+    end
+
+    def self.pack_uint32(int)
+      [int].pack('V')
+    end
+
+    def self.unpack_uint32(data)
+      [data[0..4].unpack1('V'), data[4..-1]]
+    end
+
+    def self.pack_string(str)
+      pack_uint16(str.bytesize) + str
+    end
+
+    def self.unpack_string(data)
+      len, data = unpack_uint16(data)
+      if len.zero?
+        return ['', data[len..-1]]
+      end
+      [data[0..len - 1], data[len..-1]]
+    end
+
+    def self.pack_map_uint32(map)
+      kv = ''
+      Hash[map.sort].each do |k, v|
+        kv += pack_uint16(k) + pack_uint32(v)
+      end
+      (pack_uint16(map.size) + kv).force_encoding('utf-8')
+    end
+
+    def self.unpack_map_uint32(data)
+      len, data = unpack_uint16(data)
+      map = {}
+      (1..len).each do
+        k, data = unpack_uint16(data)
+        v, data = unpack_uint32(data)
+        map[k] = v
+      end
+      [map, data]
+    end
+  end
+end

data/lib/agora/dynamic_key2.rb

@@ -0,0 +1,12 @@
+module Agora
+  module DynamicKey2
+    require_relative 'dynamic_key2/access_token'
+    require_relative 'dynamic_key2/apaas_token_builder'
+    require_relative 'dynamic_key2/chat_token_builder'
+    require_relative 'dynamic_key2/education_token_builder'
+    require_relative 'dynamic_key2/fpa_token_builder'
+    require_relative 'dynamic_key2/rtc_token_builder'
+    require_relative 'dynamic_key2/rtm_token_builder'
+    require_relative 'dynamic_key2/util'
+  end
+end

data/lib/agora/errors.rb

@@ -0,0 +1,14 @@
+module Agora
+  module Errors
+    class AgoraError < StandardError; end
+    class ConfigurationError < AgoraError; end
+    class APIError < AgoraError
+      attr_reader :response
+
+      def initialize(message, response = nil)
+        super(message)
+        @response = response
+      end
+    end
+  end
+end

data/lib/agora/version.rb

@@ -0,0 +1,3 @@
+module Agora
+  VERSION = "0.1.0"
+end

data/lib/agora-ruby.rb

@@ -0,0 +1,18 @@
+require "httparty"
+require_relative "agora/version"
+require_relative "agora/config"
+require_relative "agora/errors"
+require_relative "agora/cloud_recording/client"
+require_relative "agora/dynamic_key"
+require_relative "agora/dynamic_key2"
+
+module Agora
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Agora::Config.new # 使用 Agora::Config 类
+    yield(config) if block_given?
+  end
+end

data/sample/README.md

@@ -0,0 +1,12 @@
+- **rtc_token_builder.rb**: Source code for generating a token for the following SDKs:
+  - Agora Native SDK v2.1+
+
+  - Agora Web SDK v2.4+
+
+  - Agora Recording SDK v2.1+
+
+  - Agora RTSA SDK
+
+> The Agora RTSA SDK supports joining multiple channels. If you join multiple channels at the same time, then you MUST generate a specific token for each channel you join. 
+- **rtm_token_builder.rb**: Source code for generating a token for the Agora RTM SDK. 
+- **access_token.rb**: Implements all the underlying algorithms for generating a token. Both **rtc_token_builder.rb** and **rtm_token_builder.rb** are a wrapper of **access_token.rb** and have much easier-to-use APIs. We recommend using **rtc_token_builder.rb** for generating an RTC token or **rtm_token_builder.rb** for an RTM token.

data/sample/apaas_token_builder_sample.rb

@@ -0,0 +1,29 @@
+require_relative '../lib/dynamic_key2'
+
+# Need to set environment variable AGORA_APP_ID
+app_id = ENV.fetch('AGORA_APP_ID', nil)
+# Need to set environment variable AGORA_APP_CERTIFICATE
+app_certificate = ENV.fetch('AGORA_APP_CERTIFICATE', nil)
+
+room_uuid = '123'
+user_uuid = '2882341273'
+role = 1
+token_expiration_in_seconds = 3600
+
+puts "App Id: #{app_id}"
+puts "App Certificate: #{app_certificate}"
+if !app_id || app_id == '' || !app_certificate || app_certificate == ''
+  puts 'Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE'
+  exit
+end
+
+token = Agora::AgoraDynamicKey2::ApaasTokenBuilder.build_room_user_token(app_id, app_certificate, room_uuid, user_uuid,
+                                                                  role, token_expiration_in_seconds)
+puts "Apaas room user token: #{token}"
+
+token = Agora::AgoraDynamicKey2::ApaasTokenBuilder.build_user_token(app_id, app_certificate, user_uuid,
+                                                             token_expiration_in_seconds)
+puts "Apaas user token: #{token}"
+
+token = Agora::AgoraDynamicKey2::ApaasTokenBuilder.build_app_token(app_id, app_certificate, token_expiration_in_seconds)
+puts "Apaas app token: #{token}"

data/sample/chat_token_builder_sample.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/dynamic_key2'
+
+# Need to set environment variable AGORA_APP_ID
+app_id = ENV['AGORA_APP_ID']
+# Need to set environment variable AGORA_APP_CERTIFICATE
+app_certificate = ENV['AGORA_APP_CERTIFICATE']
+
+user_id = '2882341273'
+token_expiration_in_seconds = 600
+
+puts "App Id: #{app_id}"
+puts "App Certificate: #{app_certificate}"
+if !app_id || app_id == '' || !app_certificate || app_certificate == ''
+  puts 'Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE'
+  exit
+end
+
+token = Agora::AgoraDynamicKey2::ChatTokenBuilder.build_user_token(app_id, app_certificate, user_id,
+                                                            token_expiration_in_seconds)
+puts "Chat user token : #{token}"
+
+token = Agora::AgoraDynamicKey2::ChatTokenBuilder.build_app_token(app_id, app_certificate, token_expiration_in_seconds)
+puts "Chat app token: #{token}"

data/sample/education_token_builder_sample.rb

@@ -0,0 +1,29 @@
+require_relative '../lib/dynamic_key2'
+
+# Need to set environment variable AGORA_APP_ID
+app_id = ENV['AGORA_APP_ID']
+# Need to set environment variable AGORA_APP_CERTIFICATE
+app_certificate = ENV['AGORA_APP_CERTIFICATE']
+
+room_uuid = '123'
+user_uuid = '2882341273'
+role = 1
+token_expiration_in_seconds = 3600
+
+puts "App Id: #{app_id}"
+puts "App Certificate: #{app_certificate}"
+if !app_id || app_id == '' || !app_certificate || app_certificate == ''
+  puts 'Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE'
+  exit
+end
+
+token = Agora::AgoraDynamicKey2::EducationTokenBuilder.build_room_user_token(app_id, app_certificate, room_uuid, user_uuid,
+                                                                      role, token_expiration_in_seconds)
+puts "Education room user token: #{token}"
+
+token = Agora::AgoraDynamicKey2::EducationTokenBuilder.build_user_token(app_id, app_certificate, user_uuid,
+                                                                 token_expiration_in_seconds)
+puts "Education user token: #{token}"
+
+token = Agora::AgoraDynamicKey2::EducationTokenBuilder.build_app_token(app_id, app_certificate, token_expiration_in_seconds)
+puts "Education app token: #{token}"

data/sample/fpa_token_builder_sample.rb

@@ -0,0 +1,16 @@
+require_relative '../lib/dynamic_key2'
+
+# Need to set environment variable AGORA_APP_ID
+app_id = ENV['AGORA_APP_ID']
+# Need to set environment variable AGORA_APP_CERTIFICATE
+app_certificate = ENV['AGORA_APP_CERTIFICATE']
+
+puts "App Id: #{app_id}"
+puts "App Certificate: #{app_certificate}"
+if !app_id || app_id == '' || !app_certificate || app_certificate == ''
+  puts 'Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE'
+  exit
+end
+
+token = Agora::AgoraDynamicKey2::FpaTokenBuilder.build_token(app_id, app_certificate)
+puts "Token with FPA service: #{token}"

data/sample/rtc_token_builder2_sample.rb

@@ -0,0 +1,55 @@
+require_relative '../lib/dynamic_key2'
+
+# Need to set environment variable AGORA_APP_ID
+app_id = ENV.fetch('AGORA_APP_ID', nil)
+# Need to set environment variable AGORA_APP_CERTIFICATE
+app_certificate = ENV.fetch('AGORA_APP_CERTIFICATE', nil)
+
+channel_name = '7d72365eb983485397e3e3f9d460bdda'
+uid = 2_882_341_273
+account = '2882341273'
+token_expiration_in_seconds = 3600
+privilege_expiration_in_seconds = 3600
+join_channel_privilege_expiration_in_seconds = 3600
+pub_audio_privilege_expiration_in_seconds = 3600
+pub_video_privilege_expiration_in_seconds = 3600
+pub_data_stream_privilege_expiration_in_seconds = 3600
+
+puts "App Id: #{app_id}"
+puts "App Certificate: #{app_certificate}"
+if !app_id || app_id == '' || !app_certificate || app_certificate == ''
+  puts 'Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE'
+  exit
+end
+
+token = Agora::AgoraDynamicKey2::RtcTokenBuilder.build_token_with_uid(
+  app_id, app_certificate, channel_name, uid,
+  Agora::AgoraDynamicKey2::RtcTokenBuilder::ROLE_PUBLISHER, token_expiration_in_seconds, privilege_expiration_in_seconds
+)
+puts "Token with int uid: #{token}"
+
+token = Agora::AgoraDynamicKey2::RtcTokenBuilder.build_token_with_user_account(
+  app_id, app_certificate, channel_name, account,
+  Agora::AgoraDynamicKey2::RtcTokenBuilder::ROLE_PUBLISHER, token_expiration_in_seconds, privilege_expiration_in_seconds
+)
+puts "Token with user account: #{token}"
+
+token = Agora::AgoraDynamicKey2::RtcTokenBuilder.build_token_with_uid_and_privilege(
+  app_id, app_certificate, channel_name, uid, token_expiration_in_seconds,
+  join_channel_privilege_expiration_in_seconds, pub_audio_privilege_expiration_in_seconds,
+  pub_video_privilege_expiration_in_seconds, pub_data_stream_privilege_expiration_in_seconds
+)
+puts "Token with int uid and privilege: #{token}"
+
+token = Agora::AgoraDynamicKey2::RtcTokenBuilder.build_token_with_user_account_and_privilege(
+  app_id, app_certificate, channel_name, account, token_expiration_in_seconds,
+  join_channel_privilege_expiration_in_seconds, pub_audio_privilege_expiration_in_seconds,
+  pub_video_privilege_expiration_in_seconds, pub_data_stream_privilege_expiration_in_seconds
+)
+puts "Token with user account and privilege: #{token}"
+
+token = Agora::AgoraDynamicKey2::RtcTokenBuilder.build_token_with_rtm(
+  app_id, app_certificate, channel_name, account,
+  Agora::AgoraDynamicKey2::RtcTokenBuilder::ROLE_PUBLISHER, token_expiration_in_seconds, privilege_expiration_in_seconds
+)
+puts "Token with RTM: #{token}"

data/sample/rtc_token_builder_sample.rb

@@ -0,0 +1,40 @@
+require_relative '../lib/dynamic_key'
+
+# Need to set environment variable AGORA_APP_ID
+app_id = ENV['AGORA_APP_ID']
+# Need to set environment variable AGORA_APP_CERTIFICATE
+app_certificate = ENV['AGORA_APP_CERTIFICATE']
+
+expiration_time_in_seconds = 3600
+current_time_stamps = Time.now.to_i
+
+puts "App Id: #{app_id}"
+puts "App Certificate: #{app_certificate}"
+if !app_id || app_id == '' || !app_certificate || app_certificate == ''
+  puts 'Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE'
+  exit
+end
+
+params = {
+  app_id: app_id,
+  app_certificate: app_certificate,
+  channel_name: '7d72365eb983485397e3e3f9d460bdda',
+  uid: 2_882_341_273,
+  role: Agora::AgoraDynamicKey::RTCTokenBuilder::Role::PUBLISHER,
+  privilege_expired_ts: current_time_stamps + expiration_time_in_seconds
+}
+
+result = Agora::AgoraDynamicKey::RTCTokenBuilder.build_token_with_uid params
+puts "Token With Int Uid: #{result}"
+
+params_with_account = {
+  app_id: app_id,
+  app_certificate: app_certificate,
+  channel_name: '7d72365eb983485397e3e3f9d460bdda',
+  account: 'test_user',
+  role: Agora::AgoraDynamicKey::RTCTokenBuilder::Role::PUBLISHER,
+  privilege_expired_ts: current_time_stamps + expiration_time_in_seconds
+}
+
+result = Agora::AgoraDynamicKey::RTCTokenBuilder.build_token_with_account params_with_account
+puts "Token With UserAccount: #{result}"

data/sample/rtm_token_builder_sample.rb

@@ -0,0 +1,27 @@
+require_relative '../lib/dynamic_key'
+
+# Need to set environment variable AGORA_APP_ID
+app_id = ENV['AGORA_APP_ID']
+# Need to set environment variable AGORA_APP_CERTIFICATE
+app_certificate = ENV['AGORA_APP_CERTIFICATE']
+
+expiration_time_in_seconds = 3600
+current_time_stamps = Time.now.to_i
+
+puts "App Id: #{app_id}"
+puts "App Certificate: #{app_certificate}"
+if !app_id || app_id == '' || !app_certificate || app_certificate == ''
+  puts 'Need to set environment variable AGORA_APP_ID and AGORA_APP_CERTIFICATE'
+  exit
+end
+
+params = {
+  app_id: app_id,
+  app_certificate: app_certificate,
+  account: 'test_user_id',
+  role: Agora::AgoraDynamicKey::RTMTokenBuilder::Role::RTM_USER,
+  privilege_expired_ts: current_time_stamps + expiration_time_in_seconds
+}
+
+result = Agora::AgoraDynamicKey::RTMTokenBuilder.build_token params
+puts "Rtm Token: #{result}"