teleruby 1.5.1 → 1.5.4

data/lib/objects/message_entity.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'user'
+
+##
+# +Monday+, +August+ +24+ +2020+ +EAT+
+# ===This object represents one special entity in a text message.
+# For example, +hashtags,+ +usernames+, +URLs,+ etc.
+class MessageEntity
+  def initialize(msg) # :nodoc:
+    @msg = msg
+    freeze
+  end
+
+  # Type of the entity. Can be +mention+( @username ), +hashtag+( #hashtag ),
+  # +cashtag+( $USD ), +bot_command+( /start@jobs_bot ),
+  # +url+( https://telegram.org ), +email+( do-not-reply@telegram.org ),
+  # +phone_number+( +1-212-555-0123 ), +bold+(bold text),
+  # *italic*(italic text), +underline+(underlined text), 
+  # +strikethrough+(strikethrough text), +code+
+  # (monowidth string), +pre+ (monowidth block),
+  # +text_link+(for clickable text URLs),
+  # +text_mention+ (for users without usernames)
+  def type
+    @msg.type
+  end
+
+  # Offset in UTF-16 code units to the start of the entity.
+  def offset
+    @msg.offset
+  end
+
+  # Length of the entity in UTF-16 code units.
+  def length
+    @msg.length
+  end
+
+  # +Optional.+ For +text_link+ only, url that will be opened after user
+  # taps on the text.
+  def url
+    @msg.url
+  end
+
+  # +Optional.+ For +pre+ only, the programming language of the entity text.
+  def language
+    @msg.language
+  end
+
+  # +Optional+. For text_mention? only, the mentioned user.
+  # Returns User object
+  def user
+    usr = @msg.user
+    return User.new(usr) if usr
+
+    false
+  end
+
+  # Returns true if entity #type is mention else false is returned.
+  def mention?
+    type.eql? 'mention'
+  end
+
+  # Returns true if entity #type is bot_command else false is returned.
+  def bot_command?
+    type.eql? 'bot_command'
+  end
+
+  # Return true if entity #type is url else false is returned.
+  def link?
+    type.elq? 'url'
+  end
+
+  # Returns true if entity #type is email else false is returned.
+  def email?
+    type.eql? 'email'
+  end
+
+  # Return true if entity #type is +phone_number+ else false is returned.
+  def phone_number?
+    type.eql? 'phone_number'
+  end
+
+  # Returns true if entity #type is +text_link+ else false is returned.
+  def text_link?
+    type.eql? 'text_link'
+  end
+
+  # Returns true if entity #type is +text_mention+ else false is returned.
+  def text_mention?
+    type.eql? 'text_mention'
+  end
+end

data/lib/objects/order_info.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'shipping_address'
+
+# This object represents information about an order.
+class OrderInfo
+  def initialize(info) # :nodoc:
+    @info = info
+  end
+
+  # Optional. User name
+  def name
+    @info.name
+  end
+
+  # Optional. User's phone number.
+  def phone_number
+    @info.phone_number
+  end
+
+  # Optional. User email
+  def email
+    @info.email
+  end
+
+  # Optional. User shipping address
+  def shipping_address
+    address = @info.shipping_address
+    return ShippingAddress.new(address) if address
+
+    false
+  end
+end

data/lib/objects/photo_size.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'same/common'
+
+##
+# +Monday,+ +August+ +24+ +2020+
+# ===This object represents one size of a photo or a file/sticker thumbnail.
+# Extends Common class.
+class PhotoSize < Common
+  def initialize(photo) # :nodoc:
+    super(photo)
+  end
+end

data/lib/objects/poll.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'poll_option'
+require_relative 'message_entity'
+
+# ===This object contains information about a poll.
+class Poll
+  def initialize(poll) # :nodoc:
+    @poll = poll
+    freeze
+  end
+
+  # Unique poll identifier.
+  def id
+    @poll.id
+  end
+
+  # Poll question, 1-255 characters.
+  def question
+    @poll.question
+  end
+
+  # Returns array of PollOption s. else false is returned.
+  def options
+    opt = @poll.options
+    unless opt
+      return false
+    end
+
+    poll_options = []
+    opt.each do |o|
+      poll_options << PollOption.new(o)
+    end
+    poll_options
+  end
+
+  # Total number of users that voted in the poll.
+  def total_voter_count
+    @poll.total_voter_count
+  end
+
+  # True, if the poll is closed.
+  def closed?
+    @poll.is_closed
+  end
+
+  # True, if the poll is anonymous.
+  def anonymous?
+    @poll.is_anonymous
+  end
+
+  # Poll type, currently can be "regular" or "quiz"
+  def type
+    @poll.type
+  end
+
+  # +Optional+. 0-based identifier of the correct answer option.
+  # Available only for polls in the quiz mode, which are closed, or was
+  # sent (not forwarded) by the bot or to the private chat with the bot.
+  def correct_option_id
+    @poll.correct_option_id
+  end
+
+  # +Optional.+ Text that is shown when a user chooses an incorrect answer
+  # or taps on the lamp icon in a quiz-style poll, 0-200 characters.
+  def explanation
+    @poll.explanation
+  end
+
+  # +Optional.+ Special entities like *usernames*, *URLs*, bot commands,
+  # etc. that appear in the explanation.
+  def explanation_entities
+    data = @poll.explanation_entities
+    unless data
+      return false
+    end
+
+    explanations = []
+    data.each do |exp|
+      explanations << MessageEntity.new(exp)
+    end
+    explanations
+  end
+
+  # +Optional.+ Amount of time in seconds the poll will be active after
+  # creation.
+  def open_period
+    @poll.open_period
+  end
+
+  # +Optional.+ Point in time (Unix timestamp) when the poll will be
+  # automatically closed.
+  def close_date
+    @poll.close_date
+  end
+end

data/lib/objects/poll_answer.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'user'
+
+# +Sunday,+ +August+ +23+ +2020+
+
+# ===This object represents an answer of a user in a non-anonymous poll.
+class PollAnswer
+  def initialize(poll) # :nodoc:
+    @poll = poll
+  end
+
+  # Unique poll identifier.
+  def poll_id
+    @poll.poll_id
+  end
+
+  # The user, who changed the answer to the poll. Return User object
+  def user
+    User.new(@poll.user)
+  end
+
+  # 0-based identifiers of answer options, chosen by the user.
+  # May be empty if the user retracted their vote.
+  def option_ids
+    @poll.option_ids
+  end
+end

data/lib/objects/poll_option.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday,+ +August+ +24+ 2020+ +EAT+
+# ===This object contains information about one answer option in a poll.
+class PollOption
+  def initialize(poll) # :nodoc:
+    @poll = poll
+    freeze
+  end
+
+  # +Option+ text, 1-100 characters.
+  def text
+    @poll.text
+  end
+
+  # Number of users that voted for this option.
+  def voter_count
+    @poll.voter_count
+  end
+end

data/lib/objects/pre_checkout_query.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'user'
+require_relative 'order_info'
+
+# This object contains information about an incoming pre-checkout query.
+class PreCheckoutQuery
+  def initialize(query) # :nodoc:
+    @query = query
+  end
+
+  # Unique query identifier.
+  def id
+    @query.id
+  end
+
+  # User who sent the query.
+  def from
+    User.new(@query.from)
+  end
+
+  # Three-letter ISO 4217 currency code
+  def currency
+    @query.currency
+  end
+
+  # Total price in the smallest units of the currency 
+  # (integer, not float/double). For example, for a price of US$ 1.45
+  #  pass amount = 145 . See the exp parameter in currencies.json,
+  # it shows the number of digits past the decimal point for each 
+  # currency (2 for the majority of currencies).
+  def total_count
+    @query.total_count
+  end
+
+  # Bot specified invoice payload.
+  def invoice_option_id
+    @query.invoice_option_id
+  end
+
+  def order_info
+    info = @query.order_info
+    return OrderInfo.new(info) if info
+
+    false
+  end
+end

data/lib/objects/same/common.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday+, +August+ +24+ +2020+ +EAT+
+# ===Common class
+class Hash
+  def method_missing(method_name)
+    self[method_name.to_s]
+  end
+end
+
+class Common
+  def initialize(obj) # :nodoc:
+    @obj = obj
+  end
+
+  def file_id
+    @obj.file_id
+  end
+
+  def file_unique_id
+    @obj.file_unique_id
+  end
+
+  def width
+    @ob.width
+  end
+
+  def heigth
+    @obj.heigth
+  end
+
+  def file_size
+    @obj.file_size
+  end
+end

data/lib/objects/same/common_2.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday,+ +August+ +24+ +2020+
+class Hash
+  def method_missing(method_name)
+    self[method_name.to_s]
+  end
+end
+
+# ===common class for Audio, Video, and Document and Voice
+class Common2
+  def initialize(obj) # :nodoc:
+    @obj = obj
+    freeze
+  end
+
+  # File id for the object
+  def file_id
+    @obj.file_id
+  end
+
+  # File unique id for the object.
+  def file_unique_id
+    @obj.file_unique_id
+  end
+
+  # +Optional+. MIME type of the file as defined by sender.
+  def mime_type
+    @obj.mime_type
+  end
+
+  # +Optional.+ File size
+  def file_size
+    @obj.file_size
+  end
+end

data/lib/objects/shipping_address.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+# ===This object represents a shipping address
+class ShippingAddress
+  def initialize(shipping) # :nodoc:
+    @shipping = shipping
+  end
+
+  # ISO 3166-1 alpha-2 country code.
+  def country_code
+    @shipping.country_code
+  end
+
+  # State, if applicable.
+  def state
+    @shipping.state
+  end
+
+  # City
+  def city
+    @shipping.city
+  end
+
+  # First line for the address.
+  def street_line1
+    @shipping.street_lin2
+  end
+
+  # Second line for the address
+  def street_line2
+    @shipping.street_line2
+  end
+
+  # Address post code
+  def post_code
+    @shipping.post_code
+  end
+end