tdlib-ruby 1.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4843f71309fcaf5799ce384c56d1df0a7d7d36131a5e162e3f3fd6d14dda68f7
-  data.tar.gz: eca6f03dd7e531f6a80595c562954427b71528c84d321a77e8babac791af9692
+  metadata.gz: 851d0531bf3de68a43c0f72acf22aa549142fd1b866f915df4af2bf919408211
+  data.tar.gz: '0320249654babf8f873936c5e74e09a03b24d1689a6019f9d7edccfc72c5d96c'
 SHA512:
-  metadata.gz: 3618eb07efe5081c116efb1ee9cc0cf39ccff51bd1fd1933e3c0e1690b27e1be12087faf91096e1636fc00a55f3edb9797b8c616e38418187fd2a3b2b3bdb157
-  data.tar.gz: a87798327ce6f1995fbce7f2c5a216ed7c4baa01b65bb81cc109fbca7c757f8e20dce56b2e373a703e83e7ddaaf4af6e69cbc697e8fd845ef2d8b7c4c86c7ad3
+  metadata.gz: 3a8ba653e0261bde8fd13e237846f052520d7d9cca6fd808cbbf31937a706978b7b04273931192b5494e6e004c1f06c823ed65615f3a52d5cbbd8da7c5c5bbe2
+  data.tar.gz: 93c09fc96b0881d372b46f4f2970b803f99f2bc569657946a431687b46ae6d8b0f47aa6e7437c580ede440248b3cc3802986dc9676084439616348107a57cdcc

data/.gitignore

@@ -6,3 +6,5 @@
 /vendor/cache/*.gem
 /.vscode/
 /.yardoc/
+/.idea/
+.DS_Store

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 rvm:
-- 2.3.6
-- 2.5.0
+- 2.6.7
+- 2.7.3
+- 3.0.1
+
 addons:
   apt:
     sources:
@@ -19,8 +21,9 @@ env:
   global:
     secure: DmAoRsr+dTPVNs486nBXzChjzCCVdoxfmSbvqMBBl0v8uuUIZD1rSfYKcEaL5pmE7vgYq3X+3Dk0gf4ef/p2xPVKqFKrkBiF/7t06WgQTH7003gHMLq3aC7R9+1xvqJDzpoc6UB59Y1fOJBe5YfqDuw1dT9a46tzY2uzoVpEpbN8M/hssaKf6Wuzvpz5yekFeXq2raPwi3aOqvkSG+ODoacVdYQgJ4Vn0//CI2HzWijkQCvdsefWQUKkbgtuLWRp3UNy8AEhVWzQnTcSM7oc+MwMsOI/90DZkTP5n2WJl/CFTM5b70VyrIciG92SvTAhhBo/p7t3QBJa6kJMPXAHh5q+3wqVQA411+CoVF48bO5rKjKY3Ply49uqAzVJRh+Tkhf5uC1pHiZ6QKGxu1Czde+mKItBpaDmJFmQi0CSdv2WYXLnJWOQIO6vc2P3liwpMDRDyaGWOQtUYS+gHAlRbD4NPycIkGjkcjmLMqSEEO1TdCpM+CYwTvNTkRS+9HrWXZNdEfWORDYHgYohoIP6kY6XWSgunUb6F6pVxLoPWJNEBEVuIMZeOa/s9oklxBzD5XXIzBx4QsPYanvfxoN1uOcXlBXbOGqwiqb+urokNDw+BzWhbA+xY03U2+yO0Ujh3HQDyMDtrXEQfaPC0SxpEvIINVYwznG4sMKvbOaCVSo=
 before_install:
+- gem install -v 2.1.2 bundler
 - set -e
-- git clone https://github.com/tdlib/td
+- git clone https://github.com/tdlib/td.git
 - cd td
 - mkdir -p build
 - cd build

data/ChangeLog.md

@@ -1,3 +1,25 @@
+### 3.0.1 / 2020-06-29
+
+* Fix client dispose
+
+### 3.0.0 / 2020-06-28
+
+* Extract schema to separate gem
+
+### 2.1.0 / 2019-10-18
+
+* Support tdlib 1.5
+* Fix TD::Client#dispose race condition and client crash
+
+### 2.0.0 / 2019-02-08
+
+* Generated types and client functions
+* Async handlers
+* Use ffi instead of fiddle
+* Use Concurrent::Promises
+* TD errors handling in promises
+* Add use_file_database setting to config
+
 ### 1.0.0 / 2018-05-27
 
 * Return promises from TD::Client#broadcast

data/README.md

@@ -1,6 +1,6 @@
 # tdlib-ruby
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/9362ca2682b7edbae205/maintainability)](https://codeclimate.com/github/centosadmin/tdlib-ruby/maintainability) [![Build Status](https://travis-ci.org/centosadmin/tdlib-ruby.svg?branch=master)](https://travis-ci.org/centosadmin/tdlib-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9362ca2682b7edbae205/maintainability)](https://codeclimate.com/github/centosadmin/tdlib-ruby/maintainability) [![Build Status](https://travis-ci.org/southbridgeio/tdlib-ruby.svg?branch=master)](https://travis-ci.org/centosadmin/tdlib-ruby)
 
 ## Description
 
@@ -8,7 +8,7 @@ Ruby bindings and client for TDLib (Telegram database library).
 
 ## Requirements
 
-* Ruby 2.3+
+* Ruby 2.4+
 * Compiled [tdlib](https://github.com/tdlib/td)
 
 We have precompiled versions for CentOS 6 & 7 in our repositories:
@@ -23,6 +23,15 @@ http://rpms.southbridge.ru/rhel7/stable/SRPMS/
 
 http://rpms.southbridge.ru/rhel6/stable/SRPMS/
 
+## Compatibility table
+
+| Gem Version   |   | tdlib version |
+|:-------------:|:-:| :-----------: |
+| 1.x           | → | 1.0 - 1.2     |
+| 2.0           | → | 1.3           |
+| 2.1           | → | 1.5           |
+| 2.2           | → | 1.6           |
+
 ## Install
 
 Add to your gemfile:
@@ -35,7 +44,7 @@ and run *bundle install*.
 
 Or just run *gem install tdlib-ruby*
 
-## Basic example
+## Basic authentication example
 
 ```ruby
 require 'tdlib-ruby'
@@ -54,59 +63,52 @@ client = TD::Client.new
 begin
   state = nil
 
-  client.on('updateAuthorizationState') do |update|
-    next unless update.dig('authorization_state', '@type') == 'authorizationStateWaitPhoneNumber'
-    state = :wait_phone
-  end
-
-  client.on('updateAuthorizationState') do |update|
-    next unless update.dig('authorization_state', '@type') == 'authorizationStateWaitCode'
-    state = :wait_code
-  end
-
-  client.on('updateAuthorizationState') do |update|
-    next unless update.dig('authorization_state', '@type') == 'authorizationStateReady'
-    state = :ready
+  client.on(TD::Types::Update::AuthorizationState) do |update|
+    state = case update.authorization_state
+            when TD::Types::AuthorizationState::WaitPhoneNumber
+              :wait_phone_number
+            when TD::Types::AuthorizationState::WaitCode
+              :wait_code
+            when TD::Types::AuthorizationState::WaitPassword
+              :wait_password
+            when TD::Types::AuthorizationState::Ready
+              :ready
+            else
+              nil
+            end
   end
+  
+  client.connect
 
   loop do
     case state
-    when :wait_phone
-      p 'Please, enter your phone number:'
+    when :wait_phone_number
+      puts 'Please, enter your phone number:'
       phone = STDIN.gets.strip
-      params = {
-        '@type' => 'setAuthenticationPhoneNumber',
-        'phone_number' => phone
-      }
-      client.broadcast_and_receive(params)
+      client.set_authentication_phone_number(phone, nil).wait
     when :wait_code
-      p 'Please, enter code from SMS:'
+      puts 'Please, enter code from SMS:'
       code = STDIN.gets.strip
-      params = {
-        '@type' => 'checkAuthenticationCode',
-        'code' => code
-      }
-      client.broadcast_and_receive(params)
+      client.check_authentication_code(code).wait
+    when :wait_password
+      puts 'Please, enter 2FA password:'
+      password = STDIN.gets.strip
+      client.check_authentication_password(password).wait
     when :ready
-      @me = client.broadcast_and_receive('@type' => 'getMe')
+      client.get_me.then { |user| @me = user }.rescue { |err| puts "error: #{err}" }.wait
       break
     end
+    sleep 0.1
   end
 
 ensure
-  client.close
+  client.dispose
 end
 
 p @me
 ```
 
-## TD::Client#broadcast
-
-From version 1.0 TD::Client##broadcast returns [Concurrent::Promise](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Promise.html) object.
-
-```ruby
-  me = client.broadcast('@type' => 'getMe').then { |result| puts result }.rescue { |error| puts error }.value
-```
+Client methods are being executed asynchronously and return Concurrent::Promises::Future (see: https://github.com/ruby-concurrency/concurrent-ruby/blob/master/docs-source/promises.in.md).
 
 ## Configuration
 
@@ -118,17 +120,18 @@ TD.configure do |config|
   config.client.api_id = 12345
   config.client.api_hash = 'your_api_hash'
   config.client.use_test_dc = true # default: false
-  config.database_directory = 'path/to/db/dir' # default: "#{Dir.home}/.tdlib-ruby/db"
-  config.files_directory = 'path/to/files/dir' # default: "#{Dir.home}/.tdlib-ruby/files"
+  config.client.database_directory = 'path/to/db/dir' # default: "#{Dir.home}/.tdlib-ruby/db"
+  config.client.files_directory = 'path/to/files/dir' # default: "#{Dir.home}/.tdlib-ruby/files"
+  config.client.use_file_database = true # default: true
   config.client.use_chat_info_database = true # default: true
-  config.use_secret_chats = true # default: true
-  config.use_message_database = true # default: true
-  config.system_language_code = 'ru' # default: 'en'
-  config.device_model = 'Some device model' # default: 'Ruby TD client'
-  config.system_version = '42' # default: 'Unknown'
-  config.application_version = '1.0' # default: '1.0'
-  config.enable_storage_optimizer = true # default: true
-  config.ignore_file_names = true # default: false
+  config.client.use_secret_chats = true # default: true
+  config.client.use_message_database = true # default: true
+  config.client.system_language_code = 'ru' # default: 'en'
+  config.client.device_model = 'Some device model' # default: 'Ruby TD client'
+  config.client.system_version = '42' # default: 'Unknown'
+  config.client.application_version = '1.0' # default: '1.0'
+  config.client.enable_storage_optimizer = true # default: true
+  config.client.ignore_file_names = true # default: false
 end
 ```
 
@@ -153,6 +156,12 @@ TD::Client.new(database_directory: 'will override value from config',
                files_directory: 'will override value from config')
 ```
 
+If the tdlib schema changes, then `./bin/parse` can be run to
+synchronize the Ruby types with the new schema. Please look through
+`lib/tdlib/client_methods.rb` carefully, especially the set_password
+method!
+
+
 ## License
 
 [MIT](https://github.com/centosadmin/tdlib-ruby/blob/master/LICENSE.txt)
@@ -160,3 +169,5 @@ TD::Client.new(database_directory: 'will override value from config',
 ## Authors
 
 The gem is designed by [Southbridge](https://southbridge.io)
+
+Typeization made by [Yuri Mikhaylov](https://github.com/yurijmi) 

data/bin/build

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'etc'
+
+`
+set -e
+cd td
+mkdir -p build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release #{'-DOPENSSL_ROOT_DIR=/opt/homebrew/Cellar/openssl@1.1/1.1.1k/' if RbConfig::CONFIG['host_os'] =~ /darwin|mac os/} -DCMAKE_INSTALL_PREFIX:PATH=../tdlib ..
+cmake --build . --target install -j #{Etc.nprocessors}
+`

data/lib/tdlib-ruby.rb

@@ -1,5 +1,6 @@
 require 'tdlib/version'
 require 'dry/configurable'
+require 'concurrent-ruby'
 
 module TD
   extend Dry::Configurable
@@ -15,11 +16,12 @@ module TD
   setting :encryption_key
 
   setting :client do
-    setting :api_id
+    setting :api_id, &:to_i
     setting :api_hash
     setting :use_test_dc, false
     setting :database_directory, "#{Dir.home}/.tdlib-ruby/db"
     setting :files_directory, "#{Dir.home}/.tdlib-ruby/data"
+    setting :use_file_database, true
     setting :use_chat_info_database, true
     setting :use_secret_chats, true
     setting :use_message_database, true
@@ -32,8 +34,9 @@ module TD
   end
 end
 
+require 'tdlib-schema'
 require 'tdlib/errors'
 require 'tdlib/api'
-require 'tdlib/utils'
 require 'tdlib/client'
+require 'tdlib/update_handler'
 require 'tdlib/update_manager'

data/lib/tdlib/api.rb

@@ -1,5 +1,5 @@
-require 'fiddle/import'
 require 'json'
+require 'ffi'
 
 module TD::Api
   module_function
@@ -18,7 +18,7 @@ module TD::Api
 
   def client_receive(client, timeout)
     update = Dl.td_json_client_receive(client, timeout)
-    update.null? ? nil : JSON.parse(update.to_s)
+    JSON.parse(update) if update
   end
 
   def client_destroy(client)
@@ -34,7 +34,7 @@ module TD::Api
   end
 
   module Dl
-    extend Fiddle::Importer
+    extend FFI::Library
 
     @mutex = Mutex.new
 
@@ -42,16 +42,18 @@ module TD::Api
 
     def method_missing(method_name, *args)
       @mutex.synchronize do
-        return if respond_to?(method_name)
-        dlload(find_lib)
+        return public_send(method_name, *args) if respond_to?(method_name)
 
-        extern 'void* td_json_client_create()'
-        extern 'void* td_json_client_send(void*, char*)'
-        extern 'char* td_json_client_receive(void*, double)'
-        extern 'char* td_json_client_execute(void*, char*)'
-        extern 'void td_set_log_verbosity_level(int)'
-        extern 'void td_json_client_destroy(void*)'
-        extern 'void td_set_log_file_path(char*)'
+        find_lib
+
+        attach_function :td_json_client_create, [], :pointer
+        attach_function :td_json_client_receive, [:pointer, :double], :string, blocking: true
+        attach_function :td_json_client_send, [:pointer, :string], :pointer, blocking: true
+        attach_function :td_json_client_execute, [:pointer, :string], :string, blocking: true
+        attach_function :td_json_client_destroy, [:pointer], :void
+        attach_function :td_set_log_file_path, [:string], :int
+        attach_function :td_set_log_max_file_size, [:long_long], :void
+        attach_function :td_set_log_verbosity_level, [:int], :void
 
         undef method_missing
         public_send(method_name, *args)
@@ -66,9 +68,12 @@ module TD::Api
         elsif defined?(Rails) && File.exist?(Rails.root.join('vendor', file_name))
           Rails.root.join('vendor')
         end
-      return `ldconfig -p | grep libtdjson`[/=> (.*?)\n/m, 1] if os == :linux && lib_path.nil?
-      raise TD::MissingLibPathError unless lib_path
-      File.join(lib_path, file_name)
+      full_path = File.join(lib_path.to_s, file_name)
+      ffi_lib full_path
+      full_path
+    rescue LoadError
+      ffi_lib 'tdjson'
+      ffi_libraries.first.name
     end
 
     def lib_extension

data/lib/tdlib/client.rb

@@ -1,108 +1,91 @@
+require 'securerandom'
+
 # Simple client for TDLib.
-# @example
-#   TD.configure do |config|
-#     config.lib_path = 'path_to_tdlibjson'
-#     config.encryption_key = 'your_encryption_key'
-#
-#     config.client.api_id = your_api_id
-#     config.client.api_hash = 'your_api_hash'
-#   end
-#
-#   client = TD::Client.new
-#
-#   begin
-#     state = nil
-#
-#     client.on('updateAuthorizationState') do |update|
-#       next unless update.dig('authorization_state', '@type') == 'authorizationStateWaitPhoneNumber'
-#       state = :wait_phone
-#     end
-#
-#     client.on('updateAuthorizationState') do |update|
-#       next unless update.dig('authorization_state', '@type') == 'authorizationStateWaitCode'
-#       state = :wait_code
-#     end
-#
-#     client.on('updateAuthorizationState') do |update|
-#       next unless update.dig('authorization_state', '@type') == 'authorizationStateReady'
-#       state = :ready
-#     end
-#
-#     loop do
-#       case state
-#       when :wait_phone
-#         p 'Please, enter your phone number:'
-#         phone = STDIN.gets.strip
-#         params = {
-#           '@type' => 'setAuthenticationPhoneNumber',
-#           'phone_number' => phone
-#         }
-#         client.broadcast_and_receive(params)
-#       when :wait_code
-#         p 'Please, enter code from SMS:'
-#         code = STDIN.gets.strip
-#         params = {
-#           '@type' => 'checkAuthenticationCode',
-#           'code' => code
-#         }
-#         client.broadcast_and_receive(params)
-#       when :ready
-#         @me = client.broadcast_and_receive('@type' => 'getMe')
-#         break
-#       end
-#     end
-#
-#   ensure
-#     client.close
-#   end
-#
-#   p @me
 class TD::Client
   include Concurrent
+  include TD::ClientMethods
 
   TIMEOUT = 20
 
+  def self.ready(*args)
+    new(*args).connect
+  end
+
+  # @param [FFI::Pointer] td_client
+  # @param [TD::UpdateManager] update_manager
+  # @param [Numeric] timeout
+  # @param [Hash] extra_config optional configuration hash that will be merged into tdlib client configuration
   def initialize(td_client = TD::Api.client_create,
                  update_manager = TD::UpdateManager.new(td_client),
-                 proxy: { '@type' => 'proxyEmpty' },
+                 timeout: TIMEOUT,
                  **extra_config)
     @td_client = td_client
+    @ready = false
+    @alive = true
     @update_manager = update_manager
+    @timeout = timeout
     @config = TD.config.client.to_h.merge(extra_config)
-    @proxy = proxy
     @ready_condition_mutex = Mutex.new
     @ready_condition = ConditionVariable.new
-    authorize
-    @update_manager.run
+  end
+
+  # Adds initial authorization state handler and runs update manager
+  # Returns future that will be fulfilled when client is ready
+  # @return [Concurrent::Promises::Future]
+  def connect
+    on TD::Types::Update::AuthorizationState do |update|
+      case update.authorization_state
+      when TD::Types::AuthorizationState::WaitTdlibParameters
+        set_tdlib_parameters(parameters: TD::Types::TdlibParameters.new(**@config))
+      when TD::Types::AuthorizationState::WaitEncryptionKey
+        check_database_encryption_key(encryption_key: TD.config.encryption_key).then do
+          @ready_condition_mutex.synchronize do
+            @ready = true
+            @ready_condition.broadcast
+          end
+        end
+      else
+        # do nothing
+      end
+    end
+
+    @update_manager.run(callback: method(:handle_update))
+    ready
   end
 
   # Sends asynchronous request to the TDLib client and returns Promise object
-  # @see https://www.rubydoc.info/github/ruby-concurrency/concurrent-ruby/Concurrent/Promise)
+  # @see TD::ClientMethods List of available queries as methods
+  # @see https://github.com/ruby-concurrency/concurrent-ruby/blob/master/docs-source/promises.in.md
+  #   Concurrent::Promise documentation
   # @example
-  #   client.broadcast(some_query).then { |result| puts result }.rescue
+  #   client.broadcast(some_query).then { |result| puts result }.rescue { |error| puts [error.code, error.message] }
   # @param [Hash] query
-  # @param [Numeric] timeout
-  # @return [Concurrent::Promise]
-  def broadcast(query, timeout: TIMEOUT)
-    Promise.execute do
+  # @return [Concurrent::Promises::Future]
+  def broadcast(query)
+    return dead_client_promise if dead?
+
+    Promises.future do
       condition = ConditionVariable.new
-      extra = TD::Utils.generate_extra(query)
+      extra = SecureRandom.uuid
       result = nil
       mutex = Mutex.new
-      handler = ->(update) do
-        return unless update['@extra'] == extra
+
+      @update_manager << TD::UpdateHandler.new(TD::Types::Base, extra, disposable: true) do |update|
         mutex.synchronize do
           result = update
-          @update_manager.remove_handler(handler)
           condition.signal
         end
       end
-      @update_manager.add_handler(handler)
+
       query['@extra'] = extra
+
       mutex.synchronize do
-        TD::Api.client_send(@td_client, query)
-        condition.wait(mutex, timeout)
-        raise TD::TimeoutError if result.nil?
+        send_to_td_client(query)
+        condition.wait(mutex, @timeout)
+        error = nil
+        error = result if result.is_a?(TD::Types::Error)
+        error = timeout_error if result.nil?
+        raise TD::Error.new(error) if error
         result
       end
     end
@@ -111,8 +94,8 @@ class TD::Client
   # Sends asynchronous request to the TDLib client and returns received update synchronously
   # @param [Hash] query
   # @return [Hash]
-  def fetch(query, timeout: TIMEOUT)
-    broadcast(query, timeout: timeout).value
+  def fetch(query)
+    broadcast(query).value!
   end
 
   alias broadcast_and_receive fetch
@@ -121,70 +104,91 @@ class TD::Client
   # Only a few requests can be executed synchronously
   # @param [Hash] query
   def execute(query)
+    return dead_client_error if dead?
     TD::Api.client_execute(@td_client, query)
   end
 
-  # Returns current authorization state (it's offline request)
-  # @return [Hash]
-  def authorization_state
-    broadcast_and_receive('@type' => 'getAuthorizationState')
-  end
-
   # Binds passed block as a handler for updates with type of *update_type*
-  # @param [String] update_type
+  # @param [String, Class] update_type
   # @yield [update] yields update to the block as soon as it's received
-  def on(update_type, &_)
-    handler = ->(update) do
-      return unless update['@type'] == update_type
-      yield update
+  def on(update_type, &action)
+    if update_type.is_a?(String)
+      if (type_const = TD::Types::LOOKUP_TABLE[update_type])
+        update_type = TD::Types.const_get("TD::Types::#{type_const}")
+      else
+        raise ArgumentError.new("Can't find class for #{update_type}")
+      end
     end
-    @update_manager.add_handler(handler)
+
+    unless update_type < TD::Types::Base
+      raise ArgumentError.new("Wrong type specified (#{update_type}). Should be of kind TD::Types::Base")
+    end
+
+    @update_manager << TD::UpdateHandler.new(update_type, &action)
   end
 
-  def on_ready(timeout: TIMEOUT, &_)
-    @ready_condition_mutex.synchronize do
-      return(yield self) if @ready || (@ready_condition.wait(@ready_condition_mutex, timeout) && @ready)
-      raise TD::TimeoutError
+  # returns future that will be fulfilled when client is ready
+  # @return [Concurrent::Promises::Future]
+  def ready
+    return dead_client_promise if dead?
+    return Promises.fulfilled_future(self) if ready?
+
+    Promises.future do
+      @ready_condition_mutex.synchronize do
+        next self if @ready || (@ready_condition.wait(@ready_condition_mutex, @timeout) && @ready)
+        raise TD::Error.new(timeout_error)
+      end
     end
   end
 
+  # @deprecated
+  def on_ready(&action)
+    ready.then(&action).value!
+  end
+
   # Stops update manager and destroys TDLib client
-  def close
-    @update_manager.stop
-    TD::Api.client_destroy(@td_client)
+  def dispose
+    return if dead?
+    close.then { get_authorization_state }
+  end
+
+  def alive?
+    @alive
+  end
+
+  def dead?
+    !alive?
+  end
+
+  def ready?
+    @ready
   end
 
   private
 
-  def authorize
-    tdlib_params_query = {
-      '@type' => 'setTdlibParameters',
-      parameters: { '@type' => 'tdlibParameters', **@config }
-    }
-    encryption_key_query = {
-      '@type' => 'checkDatabaseEncryptionKey',
-    }
-
-    if TD.config.encryption_key
-      encryption_key_query['encryption_key'] = TD.config.encryption_key
-    end
+  def handle_update(update)
+    return unless update.is_a?(TD::Types::Update::AuthorizationState) && update.authorization_state.is_a?(TD::Types::AuthorizationState::Closed)
+    @alive = false
+    @ready = false
+    sleep 0.001
+    TD::Api.client_destroy(@td_client)
+    throw(:client_closed)
+  end
 
-    handler = ->(update) do
-      return unless update['@type'] == 'updateAuthorizationState'
-      case update.dig('authorization_state', '@type')
-      when 'authorizationStateWaitTdlibParameters'
-        broadcast(tdlib_params_query)
-      when 'authorizationStateWaitEncryptionKey'
-        broadcast(encryption_key_query)
-      else
-        broadcast('@type' => 'setProxy', 'proxy' => @proxy)
-        @update_manager.remove_handler(handler)
-        @ready_condition_mutex.synchronize do
-          @ready = true
-          @ready_condition.broadcast
-        end
-      end
-    end
-    @update_manager.add_handler(handler)
+  def send_to_td_client(query)
+    return unless alive?
+    TD::Api.client_send(@td_client, query)
+  end
+
+  def timeout_error
+    TD::Types::Error.new(code: 0, message: 'Timeout error')
+  end
+
+  def dead_client_promise
+    Promises.rejected_future(dead_client_error)
+  end
+
+  def dead_client_error
+    TD::Error.new(TD::Types::Error.new(code: 0, message: 'TD client is dead'))
   end
 end

data/lib/tdlib/errors.rb

@@ -1,8 +1,32 @@
-class TD::MissingLibPathError < StandardError
-  def initialize(message = 'Please, configure the path to tdlibjson library')
-    super
+module TD
+  class MissingLibPathError < StandardError
+    def initialize(message = 'Please, configure the path to tdlibjson library')
+      super
+    end
   end
-end
 
-class TD::TimeoutError < Timeout::Error
+  # Proxy class that is used in failed promises to represent TDlib errors
+  class Error < StandardError
+    def initialize(td_error)
+      @td_error = td_error
+    end
+
+    def method_missing(method, *args)
+      @td_error.public_send(method, *args)
+    end
+
+    def respond_to_missing?(*args)
+      @td_error.respond_to?(*args)
+    end
+
+    def to_s
+      @td_error.inspect
+    end
+
+    def message
+      @td_error.message
+    end
+
+    alias inspect to_s
+  end
 end

data/lib/tdlib/update_handler.rb

@@ -0,0 +1,39 @@
+class TD::UpdateHandler
+  include Concurrent::Async
+
+  attr_reader :update_type, :extra
+
+  def initialize(update_type, extra = nil, disposable: false, &action)
+    super()
+
+    @action = action
+    @update_type = update_type
+    @extra = extra
+    @disposable = disposable
+  end
+
+  def run(update)
+    action.call(update)
+  rescue StandardError => e
+    warn("Uncaught exception in handler #{self}: #{e.message}")
+    raise
+  end
+
+  def match?(update, extra = nil)
+    update.is_a?(update_type) && (self.extra.nil? || self.extra == extra)
+  end
+
+  def disposable?
+    disposable
+  end
+
+  def to_s
+    "TD::UpdateHandler (#{update_type}#{": #{extra}" if extra})#{' disposable' if disposable?}"
+  end
+
+  alias inspect to_s
+
+  private
+
+  attr_reader :action, :disposable
+end

data/lib/tdlib/update_manager.rb

@@ -1,11 +1,9 @@
 class TD::UpdateManager
   TIMEOUT = 30
 
-  attr_reader :handlers
-
   def initialize(td_client)
     @td_client = td_client
-    @handlers = []
+    @handlers = Concurrent::Array.new
     @mutex = Mutex.new
   end
 
@@ -13,31 +11,36 @@ class TD::UpdateManager
     @mutex.synchronize { @handlers << handler }
   end
 
-  def remove_handler(handler)
+  alias << add_handler
+
+  def run(callback: nil)
     Thread.start do
-      @mutex.synchronize { @handlers.delete(handler) }
+      catch(:client_closed) { loop { handle_update(callback: callback) } }
+      @mutex.synchronize { @handlers = [] }
     end
   end
 
-  def run
-    @update_loop_thread = Thread.start do
-      loop { stopped? ? break : handle_update }
-    end
-  end
+  private
 
-  def stop
-    @stopped = true
-  end
+  attr_reader :handlers
 
-  def stopped?
-    !!@stopped
-  end
+  def handle_update(callback: nil)
+    update = TD::Api.client_receive(@td_client, TIMEOUT)
 
-  private
+    unless update.nil?
+      extra  = update.delete('@extra')
+      update = TD::Types.wrap(update)
+      callback&.call(update)
 
-  def handle_update
-    update = TD::Api.client_receive(@td_client, TIMEOUT)
-    @mutex.synchronize { handlers = @handlers.dup }
-    handlers.each { |h| h.call(update) } unless update.nil?
+      match_handlers!(update, extra).each { |h| h.async.run(update) }
+    end
+  end
+
+  def match_handlers!(update, extra)
+    @mutex.synchronize do
+      matched_handlers = handlers.select { |h| h.match?(update, extra) }
+      matched_handlers.each { |h| handlers.delete(h) if h.disposable? }
+      matched_handlers
+    end
   end
 end

data/lib/tdlib/version.rb

@@ -1,4 +1,4 @@
 module TD
   # tdlib-ruby version
-  VERSION = "1.0.0"
+  VERSION = "3.0.1"
 end

data/spec/integration/tdlib_spec.rb

@@ -2,8 +2,10 @@ require 'spec_helper'
 require 'tdlib-ruby'
 
 describe TD::Client do
-  let(:client) { TD::Client.new }
-  let(:payload) { { '@type': 'getTextEntities', 'text': '@telegram' } }
+  let(:client) { TD::Client.new(timeout: timeout).tap(&:connect) }
+  let!(:payload) { { '@type' => 'getTextEntities', 'text' => text } }
+  let!(:text) { '@telegram' }
+  let(:timeout) { TD::Client::TIMEOUT }
 
   before do
     TD.configure do |config|
@@ -17,6 +19,14 @@ describe TD::Client do
     TD::Api.set_log_verbosity_level(1)
   end
 
+  around do |example|
+    begin
+      example.run
+    ensure
+      client.dispose
+    end
+  end
+
   describe '#on_ready' do
     subject { client.on_ready { [client, 'ready'] } }
 
@@ -24,32 +34,35 @@ describe TD::Client do
     it { is_expected.to include('ready') }
 
     context 'when timeout reached' do
-      subject { client.on_ready(timeout: 0.0001) { [client, 'ready'] } }
+      let(:timeout) { 0.0001 }
 
-      it { expect { subject }.to raise_error(TD::TimeoutError) }
+      subject { client.on_ready { [client, 'ready'] } }
+
+      it { expect { subject }.to raise_error(TD::Error) }
     end
   end
 
   describe '#broadcast' do
     context 'when no block given' do
-      subject { client.on_ready { client.broadcast(payload) } }
+      subject { client.ready.then { client.get_text_entities(text: text) }.flat.wait }
 
       it { expect { subject }.not_to raise_error(Exception) }
-      it { is_expected.to satisfy { |result| result.state == :pending } }
-      it { is_expected.to satisfy { |result| sleep 1; result.state == :fulfilled } }
-      it { is_expected.to satisfy { |result| sleep 1; result.value['@type'] == 'textEntities' } }
+      it { is_expected.to satisfy(&:fulfilled?) }
+      it { is_expected.to satisfy { |result| result.value.is_a?(TD::Types::TextEntities) } }
     end
   end
 
-  describe '#broadcast_and_receive' do
-    subject { client.on_ready { client.broadcast_and_receive(payload) } }
+  describe '#fetch' do
+    subject { client.on_ready { client.fetch(payload) } }
 
-    it { is_expected.to include('@type', 'entities') }
+    it { is_expected.to respond_to(:entities) }
 
     context 'when timeout reached' do
-      subject { client.on_ready(timeout: 0.0001) { client.broadcast_and_receive(payload) } }
+      let(:timeout) { 0.0001 }
+
+      subject { client.on_ready { client.fetch(payload) } }
 
-      it { expect { subject }.to raise_error(TD::TimeoutError) }
+      it { expect { subject }.to raise_error(TD::Error) }
     end
   end
 
@@ -64,7 +77,7 @@ describe TD::Client do
     it 'runs block on update' do
       subject
       sleep 1
-      expect(@result).to include('@type', 'entities')
+      expect(@result).to respond_to(:entities)
     end
   end
 
@@ -74,7 +87,7 @@ describe TD::Client do
     subject do
       client.on_ready do
         client.broadcast(payload) do
-          client.broadcast_and_receive(payload)
+          client.fetch(payload)
         end
         sleep 1
       end

data/tdlib-ruby.gemspec

@@ -14,26 +14,19 @@ Gem::Specification.new do |gem|
   gem.email         = "ask@southbridge.io"
   gem.homepage      = "https://github.com/centosadmin/tdlib-ruby"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($/) - ['lib/tdlib/td_api_tl_parser.rb']
 
-  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
-    submodule.sub!("#{Dir.pwd}/",'')
-
-    Dir.chdir(submodule) do
-      `git ls-files`.split($/).map do |subpath|
-        gem.files << File.join(submodule,subpath)
-      end
-    end
-  end
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'dry-configurable', '~> 0.7'
-  gem.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  gem.add_runtime_dependency 'dry-configurable', '~> 0.9'
+  gem.add_runtime_dependency 'concurrent-ruby',  '~> 1.1'
+  gem.add_runtime_dependency 'ffi',              '~> 1.0'
+  gem.add_runtime_dependency 'tdlib-schema'
 
-  gem.add_development_dependency 'bundler', '~> 1.10'
-  gem.add_development_dependency 'rake', '12.3.1'
+  gem.add_development_dependency 'bundler', '~> 2.0'
+  gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
   gem.add_development_dependency 'yard', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdlib-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Southbridge
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-27 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -16,16 +16,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -38,34 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tdlib-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -125,12 +153,14 @@ dependencies:
 description: Ruby bindings and client for TDlib
 email: ask@southbridge.io
 executables:
+- build
 - console
 extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
@@ -139,13 +169,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/build
 - bin/console
 - lib/tdlib-ruby.rb
 - lib/tdlib/api.rb
 - lib/tdlib/client.rb
 - lib/tdlib/errors.rb
+- lib/tdlib/update_handler.rb
 - lib/tdlib/update_manager.rb
-- lib/tdlib/utils.rb
 - lib/tdlib/version.rb
 - spec/integration/tdlib_spec.rb
 - spec/spec_helper.rb
@@ -155,7 +186,7 @@ homepage: https://github.com/centosadmin/tdlib-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,9 +201,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby bindings and client for TDlib
 test_files:

data/lib/tdlib/utils.rb

@@ -1,7 +0,0 @@
-module TD::Utils
-  module_function
-
-  def generate_extra(query)
-    "#{query.hash}#{Time.now.to_f}"
-  end
-end