tdlib-ruby 1.0.0 → 2.0.0

data/lib/tdlib/types/user_type/bot.rb

@@ -0,0 +1,18 @@
+module TD::Types
+  # A bot (see https://core.telegram.org/bots).
+  #
+  # @attr can_join_groups [Boolean] True, if the bot can be invited to basic group and supergroup chats.
+  # @attr can_read_all_group_messages [Boolean] True, if the bot can read all messages in basic group or supergroup
+  #   chats and not just those addressed to the bot.
+  #   In private and channel chats a bot can always read all messages.
+  # @attr is_inline [Boolean] True, if the bot supports inline queries.
+  # @attr inline_query_placeholder [String] Placeholder for inline queries (displayed on the client input field).
+  # @attr need_location [Boolean] True, if the location of the user should be sent with every inline query to this bot.
+  class UserType::Bot < UserType
+    attribute :can_join_groups, TD::Types::Bool
+    attribute :can_read_all_group_messages, TD::Types::Bool
+    attribute :is_inline, TD::Types::Bool
+    attribute :inline_query_placeholder, TD::Types::String
+    attribute :need_location, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/user_type/deleted.rb

@@ -0,0 +1,7 @@
+module TD::Types
+  # A deleted user or deleted bot.
+  # No information on the user besides the user_id is available.
+  # It is not possible to perform any active actions on this type of user.
+  class UserType::Deleted < UserType
+  end
+end

data/lib/tdlib/types/user_type/regular.rb

@@ -0,0 +1,5 @@
+module TD::Types
+  # A regular user.
+  class UserType::Regular < UserType
+  end
+end

data/lib/tdlib/types/user_type/unknown.rb

@@ -0,0 +1,7 @@
+module TD::Types
+  # No information on the user besides the user_id is available, yet this user has not been deleted.
+  # This object is extremely rare and must be handled like a deleted user.
+  # It is not possible to perform any actions on users of this type.
+  class UserType::Unknown < UserType
+  end
+end

data/lib/tdlib/types/users.rb

@@ -0,0 +1,10 @@
+module TD::Types
+  # Represents a list of users.
+  #
+  # @attr total_count [Integer] Approximate total count of users found.
+  # @attr user_ids [Array<Integer>] A list of user identifiers.
+  class Users < Base
+    attribute :total_count, TD::Types::Integer
+    attribute :user_ids, TD::Types::Array.of(TD::Types::Integer)
+  end
+end

data/lib/tdlib/types/validated_order_info.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Contains a temporary identifier of validated order information, which is stored for one hour.
+  # Also contains the available shipping options.
+  #
+  # @attr order_info_id [String] Temporary identifier of the order information.
+  # @attr shipping_options [Array<TD::Types::ShippingOption>] Available shipping options.
+  class ValidatedOrderInfo < Base
+    attribute :order_info_id, TD::Types::String
+    attribute :shipping_options, TD::Types::Array.of(TD::Types::ShippingOption)
+  end
+end

data/lib/tdlib/types/venue.rb

@@ -0,0 +1,19 @@
+module TD::Types
+  # Describes a venue.
+  #
+  # @attr location [TD::Types::Location] Venue location; as defined by the sender.
+  # @attr title [String] Venue name; as defined by the sender.
+  # @attr address [String] Venue address; as defined by the sender.
+  # @attr provider [String] Provider of the venue database; as defined by the sender.
+  #   Currently only "foursquare" needs to be supported.
+  # @attr id [String] Identifier of the venue in the provider database; as defined by the sender.
+  # @attr type [String] Type of the venue in the provider database; as defined by the sender.
+  class Venue < Base
+    attribute :location, TD::Types::Location
+    attribute :title, TD::Types::String
+    attribute :address, TD::Types::String
+    attribute :provider, TD::Types::String
+    attribute :id, TD::Types::String
+    attribute :type, TD::Types::String
+  end
+end

data/lib/tdlib/types/video.rb

@@ -0,0 +1,24 @@
+module TD::Types
+  # Describes a video file.
+  #
+  # @attr duration [Integer] Duration of the video, in seconds; as defined by the sender.
+  # @attr width [Integer] Video width; as defined by the sender.
+  # @attr height [Integer] Video height; as defined by the sender.
+  # @attr file_name [String] Original name of the file; as defined by the sender.
+  # @attr mime_type [String] MIME type of the file; as defined by the sender.
+  # @attr has_stickers [Boolean] True, if stickers were added to the photo.
+  # @attr supports_streaming [Boolean] True, if the video should be tried to be streamed.
+  # @attr thumbnail [TD::Types::PhotoSize, nil] Video thumbnail; as defined by the sender; may be null.
+  # @attr video [TD::Types::File] File containing the video.
+  class Video < Base
+    attribute :duration, TD::Types::Integer
+    attribute :width, TD::Types::Integer
+    attribute :height, TD::Types::Integer
+    attribute :file_name, TD::Types::String
+    attribute :mime_type, TD::Types::String
+    attribute :has_stickers, TD::Types::Bool
+    attribute :supports_streaming, TD::Types::Bool
+    attribute :thumbnail, TD::Types::PhotoSize.optional.default(nil)
+    attribute :video, TD::Types::File
+  end
+end

data/lib/tdlib/types/video_note.rb

@@ -0,0 +1,15 @@
+module TD::Types
+  # Describes a video note.
+  # The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format.
+  #
+  # @attr duration [Integer] Duration of the video, in seconds; as defined by the sender.
+  # @attr length [Integer] Video width and height; as defined by the sender.
+  # @attr thumbnail [TD::Types::PhotoSize, nil] Video thumbnail; as defined by the sender; may be null.
+  # @attr video [TD::Types::File] File containing the video.
+  class VideoNote < Base
+    attribute :duration, TD::Types::Integer
+    attribute :length, TD::Types::Integer
+    attribute :thumbnail, TD::Types::PhotoSize.optional.default(nil)
+    attribute :video, TD::Types::File
+  end
+end

data/lib/tdlib/types/voice_note.rb

@@ -0,0 +1,16 @@
+module TD::Types
+  # Describes a voice note.
+  # The voice note must be encoded with the Opus codec, and stored inside an OGG container.
+  # Voice notes can have only a single audio channel.
+  #
+  # @attr duration [Integer] Duration of the voice note, in seconds; as defined by the sender.
+  # @attr waveform [String] A waveform representation of the voice note in 5-bit format.
+  # @attr mime_type [String] MIME type of the file; as defined by the sender.
+  # @attr voice [TD::Types::File] File containing the voice note.
+  class VoiceNote < Base
+    attribute :duration, TD::Types::Integer
+    attribute :waveform, TD::Types::String
+    attribute :mime_type, TD::Types::String
+    attribute :voice, TD::Types::File
+  end
+end

data/lib/tdlib/types/wallpaper.rb

@@ -0,0 +1,14 @@
+module TD::Types
+  # Contains information about a wallpaper.
+  #
+  # @attr id [Integer] Unique persistent wallpaper identifier.
+  # @attr sizes [Array<TD::Types::PhotoSize>] Available variants of the wallpaper in different sizes.
+  #   These photos can only be downloaded; they can't be sent in a message.
+  # @attr color [Integer] Main color of the wallpaper in RGB24 format; should be treated as background color if no
+  #   photos are specified.
+  class Wallpaper < Base
+    attribute :id, TD::Types::Integer
+    attribute :sizes, TD::Types::Array.of(TD::Types::PhotoSize)
+    attribute :color, TD::Types::Integer
+  end
+end

data/lib/tdlib/types/wallpapers.rb

@@ -0,0 +1,8 @@
+module TD::Types
+  # Contains a list of wallpapers.
+  #
+  # @attr wallpapers [Array<TD::Types::Wallpaper>] A list of wallpapers.
+  class Wallpapers < Base
+    attribute :wallpapers, TD::Types::Array.of(TD::Types::Wallpaper)
+  end
+end

data/lib/tdlib/types/web_page.rb

@@ -0,0 +1,51 @@
+module TD::Types
+  # Describes a web page preview.
+  #
+  # @attr url [String] Original URL of the link.
+  # @attr display_url [String] URL to display.
+  # @attr type [String] Type of the web page.
+  #   Can be: article, photo, audio, video, document, profile, app, or something else.
+  # @attr site_name [String] Short name of the site (e.g., Google Docs, App Store).
+  # @attr title [String] Title of the content.
+  # @attr description [String] Description of the content.
+  # @attr photo [TD::Types::Photo, nil] Image representing the content; may be null.
+  # @attr embed_url [String] URL to show in the embedded preview.
+  # @attr embed_type [String] MIME type of the embedded preview, (e.g., text/html or video/mp4).
+  # @attr embed_width [Integer] Width of the embedded preview.
+  # @attr embed_height [Integer] Height of the embedded preview.
+  # @attr duration [Integer] Duration of the content, in seconds.
+  # @attr author [String] Author of the content.
+  # @attr animation [TD::Types::Animation, nil] Preview of the content as an animation, if available; may be null.
+  # @attr audio [TD::Types::Audio, nil] Preview of the content as an audio file, if available; may be null.
+  # @attr document [TD::Types::Document, nil] Preview of the content as a document, if available (currently only
+  #   available for small PDF files and ZIP archives); may be null.
+  # @attr sticker [TD::Types::Sticker, nil] Preview of the content as a sticker for small WEBP files, if available; may
+  #   be null.
+  # @attr video [TD::Types::Video, nil] Preview of the content as a video, if available; may be null.
+  # @attr video_note [TD::Types::VideoNote, nil] Preview of the content as a video note, if available; may be null.
+  # @attr voice_note [TD::Types::VoiceNote, nil] Preview of the content as a voice note, if available; may be null.
+  # @attr has_instant_view [Boolean] True, if the web page has an instant view.
+  class WebPage < Base
+    attribute :url, TD::Types::String
+    attribute :display_url, TD::Types::String
+    attribute :type, TD::Types::String
+    attribute :site_name, TD::Types::String
+    attribute :title, TD::Types::String
+    attribute :description, TD::Types::String
+    attribute :photo, TD::Types::Photo.optional.default(nil)
+    attribute :embed_url, TD::Types::String
+    attribute :embed_type, TD::Types::String
+    attribute :embed_width, TD::Types::Integer
+    attribute :embed_height, TD::Types::Integer
+    attribute :duration, TD::Types::Integer
+    attribute :author, TD::Types::String
+    attribute :animation, TD::Types::Animation.optional.default(nil)
+    attribute :audio, TD::Types::Audio.optional.default(nil)
+    attribute :document, TD::Types::Document.optional.default(nil)
+    attribute :sticker, TD::Types::Sticker.optional.default(nil)
+    attribute :video, TD::Types::Video.optional.default(nil)
+    attribute :video_note, TD::Types::VideoNote.optional.default(nil)
+    attribute :voice_note, TD::Types::VoiceNote.optional.default(nil)
+    attribute :has_instant_view, TD::Types::Bool
+  end
+end

data/lib/tdlib/types/web_page_instant_view.rb

@@ -0,0 +1,11 @@
+module TD::Types
+  # Describes an instant view page for a web page.
+  #
+  # @attr page_blocks [Array<TD::Types::PageBlock>] Content of the web page.
+  # @attr is_full [Boolean] True, if the instant view contains the full page.
+  #   A network request might be needed to get the full web page instant view.
+  class WebPageInstantView < Base
+    attribute :page_blocks, TD::Types::Array.of(TD::Types::PageBlock)
+    attribute :is_full, TD::Types::Bool
+  end
+end

data/lib/tdlib/update_handler.rb

@@ -0,0 +1,36 @@
+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)
+  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,20 +11,17 @@ class TD::UpdateManager
     @mutex.synchronize { @handlers << handler }
   end
 
-  def remove_handler(handler)
-    Thread.start do
-      @mutex.synchronize { @handlers.delete(handler) }
-    end
-  end
+  alias << add_handler
 
   def run
-    @update_loop_thread = Thread.start do
+    Thread.start do
       loop { stopped? ? break : handle_update }
     end
   end
 
   def stop
     @stopped = true
+    @mutex.synchronize { @handlers = [] }
   end
 
   def stopped?
@@ -35,9 +30,24 @@ class TD::UpdateManager
 
   private
 
+  attr_reader :handlers
+
   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?
+
+    unless update.nil?
+      extra  = update.delete('@extra')
+      update = TD::Types.wrap(update)
+
+      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 = "2.0.0"
 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|
@@ -24,32 +26,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) }.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 +69,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 +79,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,28 +14,23 @@ 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-struct',       '~> 0.5.1'
+  gem.add_runtime_dependency 'dry-types',        '~> 0.13.2'
+  gem.add_runtime_dependency 'concurrent-ruby',  '~> 1.0'
+  gem.add_runtime_dependency 'ffi',              '~> 1.0'
 
   gem.add_development_dependency 'bundler', '~> 1.10'
-  gem.add_development_dependency 'rake', '12.3.1'
+  gem.add_development_dependency 'rake', '~> 12.3'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
   gem.add_development_dependency 'yard', '~> 0.9'
   gem.add_development_dependency 'pry', '~> 0.11'
+  gem.add_development_dependency 'activesupport', '~> 5.2'
 end