Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/southbridgeio/tdlib-ruby
Ruby bindings and client for TDLib
https://github.com/southbridgeio/tdlib-ruby
libtdjson tdlib tdlib-ruby telegram telegram-api telegram-client
Last synced: 3 months ago
JSON representation
Ruby bindings and client for TDLib
- Host: GitHub
- URL: https://github.com/southbridgeio/tdlib-ruby
- Owner: southbridgeio
- License: mit
- Created: 2018-02-06T08:08:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T08:10:46.000Z (5 months ago)
- Last Synced: 2024-10-31T13:55:40.695Z (3 months ago)
- Topics: libtdjson, tdlib, tdlib-ruby, telegram, telegram-api, telegram-client
- Language: Ruby
- Size: 406 KB
- Stars: 95
- Watchers: 8
- Forks: 45
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# tdlib-ruby
[](https://codeclimate.com/github/centosadmin/tdlib-ruby/maintainability) [](https://travis-ci.org/centosadmin/tdlib-ruby)
## Description
Ruby bindings and client for TDLib (Telegram database library).
## Requirements
* Ruby 2.4+
* Compiled [tdlib](https://github.com/tdlib/td)
We have precompiled versions for CentOS 6 & 7 in our repositories:
http://rpms.southbridge.ru/rhel7/stable/x86_64/
http://rpms.southbridge.ru/rhel6/stable/x86_64/
And also SRPMS:
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 |
IMPORTANT: From version 3.0 types schema is extracted to a separate gem: https://github.com/southbridgeio/tdlib-schema
If you want to support specific tdlib version, just set a dependency in your Gemfile:
```ruby
gem 'tdlib-schema', '~> 1.7.0'
```
## Install
Add to your gemfile:
```ruby
gem 'tdlib-ruby'
```
and run *bundle install*.
Or just run *gem install tdlib-ruby*
## Basic authentication example
```ruby
require 'tdlib-ruby'
TD.configure do |config|
config.lib_path = 'path_to_dir_containing_tdlibjson'
config.client.api_id = your_api_id
config.client.api_hash = 'your_api_hash'
end
TD::Api.set_log_verbosity_level(1)
client = TD::Client.new
begin
state = nil
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_number
puts 'Please, enter your phone number:'
phone = STDIN.gets.strip
client.set_authentication_phone_number(phone_number: phone, settings: nil).wait
when :wait_code
puts 'Please, enter code from SMS:'
code = STDIN.gets.strip
client.check_authentication_code(code: code).wait
when :wait_password
puts 'Please, enter 2FA password:'
password = STDIN.gets.strip
client.check_authentication_password(password: password).wait
when :ready
client.get_me.then { |user| @me = user }.rescue { |err| puts "error: #{err}" }.wait
break
end
sleep 0.1
end
ensure
client.dispose
end
p @me
```
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
```ruby
TD.configure do |config|
config.lib_path = 'path/to/dir_containing_libtdjson' # libtdjson will be searched in this directory (*.so, *.dylib, *.dll are valid extensions). For Rails projects, if not set, will be considered as project_root_path/vendor. If not set and file doesn't exist in vendor, it will try to find lib by ldconfig (only on Linux).
config.encryption_key = 'your_encryption_key' # it's not required
config.client.api_id = 12345
config.client.api_hash = 'your_api_hash'
config.client.use_test_dc = true # default: false
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.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
```
## Advanced
You can get rid of large tdlib log with
```ruby
TD::Api.set_log_verbosity_level(1)
```
You can also set log file path:
```ruby
TD::Api.set_log_file_path('path/to/log_file')
```
Additional options can be passed to client:
```ruby
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)
## Authors
The gem is designed by [Southbridge](https://southbridge.io)
Typeization made by [Yuri Mikhaylov](https://github.com/yurijmi)