telbe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e42bc9b3ba26ce5475bd53652e612411b8503a935dd7d93069ee21aa89259cb7
+  data.tar.gz: 6ef864e72b29856c78e63bb08f796504e81d3b0688422edb2314c72ea9f93508
+SHA512:
+  metadata.gz: caeac2384355c9564da6237140dea46d4a29f30ed2d3530761e3c680f0e77a4ea178585ceba2c0e855a5a2bc8089210cecb3e030c23e50c6ec84b76c87e4ae13
+  data.tar.gz: 11257f6e714730882ce6843cc4acb49b4a2280a11764a8a565df83f2716351138de405b57b8cfbea1c8a3f95e4db765e1d8225126473b999f9636d37c242b478

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/Gemfile.lock
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bot_engine.gemspec
+gemspec

data/README.md

@@ -0,0 +1,40 @@
+# Telbe
+
+A complete ruby client that implements [Telegram's Bot API](https://core.telegram.org/bots).
+
+Ruby is such a beautiful and productive language.
+
+[Virtus](https://github.com/solnic/virtus) is heavilly used, mainly because it's easy to instantiate objects from hashes, even complex objects. Virtus is deprecated, at a future release we'll evaulate differente approaches to address the problem.
+
+Currently under heavy development.
+
+Please [collaborate](https://github.com/rodgco/telbe/issues/new) with your questions, ideas or problems!
+
+## Installation
+
+Add this line to your application's Gemfile (currently under development):
+
+```ruby
+gem 'telbe'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+## How do I get a Bot Token
+
+Talk to the [@BotFather](https://telegram.me/botfather).
+You can find more info [here](https://core.telegram.org/bots).
+
+![How to get Token](http://i.imgur.com/90ya4Oe.png)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rodgco/telbe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/telbe/bot.rb

@@ -0,0 +1,187 @@
+module Telbe
+  class Bot
+    ENDPOINT = 'https://api.telegram.org/'
+
+    def initialize(token:, proxy: nil)
+      @token = token
+      @proxy = proxy
+      @connection = Excon.new(ENDPOINT, persistent: true, proxy: @proxy)
+    end
+
+    def request(action, query = {})
+      path = "/bot#{@token}/#{action}"
+      response = @connection.post(path: path, query: query.to_h)
+      if response.status == 200
+        body = response.body
+        data = JSON.parse(body)
+        data["result"]
+      else
+        raise ResponseError, response.body
+      end
+    end
+
+    def send_message(message_descriptor)
+      Message.new(request(:sendMessage, message_descriptor))
+    end
+
+    def get_updates(update_descriptor)
+      request(:getUpdates, update_descriptor).collect do |update_hash|
+        Update.new(update_hash)
+      end
+    end
+
+    def get_me
+      User.new(request(:getMe))
+    end
+
+    def get_chat(chatid_descriptor)
+      Chat.new(request(:getChat, chatid_descriptor))
+    end
+
+    def download_file(file)
+      # https://api.telegram.org/file/bot<token>/<file_path>
+    end
+  end
+
+  class MessageEntity
+    include Virtus.model
+  end
+
+  class ForceReply
+    include Virtus.model
+    attribute :force_reply, Boolean
+    attribute :selective, Boolean
+  end
+
+  class MessageDescriptor
+    include Virtus.model
+    attribute :chat_id, Object # Integer or String - Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+    attribute :text, String 	# Text of the message to be sent
+    attribute :parse_mode, String # Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
+    attribute :disable_web_page_preview, Boolean # Optional Disables link previews for links in this message
+    attribute :disable_notification, Boolean # Optional Sends the message silently. Users will receive a notification with no sound.
+    attribute :reply_to_message_id, Integer # Optional If the message is a reply, ID of the original message
+    attribute :reply_markup, Object # InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply - Optional Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
+  end
+
+  class ChatPhoto
+    include Virtus.model
+    attribute :small_file_id, String
+    attribute :big_file_id, String
+  end
+
+  class Chat
+    include Virtus.model
+    attribute :id, Integer
+    attribute :type, String
+    attribute :title, String
+    attribute :username, String
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :all_members_are_administrators, Boolean
+    attribute :photo, ChatPhoto
+    attribute :description, String
+    attribute :invite_link, String
+    attribute :sticker_set_name, String
+    attribute :can_set_sticker_set, Boolean
+  end
+
+  class Message
+    include Virtus.model
+    attribute :message_id, Integer
+    alias_method :id, :message_id
+    alias_method :to_i, :id
+    attribute :from, User
+    alias_method :user, :from
+    attribute :text, String
+    attribute :date, DateTime
+    attribute :chat, Chat
+    attribute :forward_from, User
+    attribute :forward_from_chat, Chat
+    attribute :forward_from_message_id, Integer
+    attribute :forward_signature, String
+    attribute :forward_sender_name, String
+    attribute :forward_date, Integer
+    attribute :reply_to_message, Message
+    attribute :edit_date, Integer
+    attribute :media_group_id, String
+    attribute :author_signature, String
+    attribute :text, String
+    attribute :entities, Array # of MessageEntity
+    attribute :caption_entities, Array # of MessageEntity
+    attribute :audio, Audio
+    attribute :document, Document
+    attribute :animation, Animation
+    # attribute :game, Game
+    attribute :photo, Array # of PhotoSize
+    attribute :sticker, Sticker
+    attribute :video, Video
+    attribute :voice, Voice
+    attribute :video_note, VideoNote
+    attribute :caption, String
+    attribute :contact, Contact
+    attribute :location, Location
+    attribute :venue, Venue
+    attribute :poll, Poll
+    attribute :new_chat_members, Array # of User
+    attribute :left_chat_member , User
+    attribute :new_chat_title, String
+    attribute :new_chat_photo, Array # of PhotoSize
+    attribute :delete_chat_photo, Boolean
+    attribute :group_chat_created, Boolean
+    attribute :supergroup_chat_created, Boolean
+    attribute :channel_chat_created, Boolean
+    attribute :migrate_to_chat_id, Integer
+    attribute :migrate_from_chat_id, Integer
+    attribute :pinned_message, Message
+    # attribute :invoice, Invoice
+    # attribute :successful_payment, SuccessfulPayment
+    attribute :connected_website, String
+    # attribute :passport_data, PassportData 	
+
+    def reply(&block)
+      reply = MessageDescriptor.new(chat_id: chat.id)
+      yield reply if block_given?
+      reply
+    end
+
+    def get_command_for(bot)
+      text && text.sub(Regexp.new("@#{bot.identity.username}($|\s|\.|,)", Regexp::IGNORECASE), '').strip
+    end
+  end
+
+  class Chat
+    attribute :pinned_message, Message
+  end
+
+  class Update
+    include Virtus.model
+    attribute :update_id, Integer
+    alias_method :id, :update_id
+    alias_method :to_i, :id
+    attribute :message, Message
+    alias_method :edited_message, :message
+    alias_method :channel_post, :message
+    alias_method :edited_channel_post, :message
+    # attribute :inline_query, InlineQuery
+    # attribute :chosen_inline_result, ChosenInlineResult
+    # attribute :callback_query, CallbackQuery
+    # attribute :shipping_query, ShippingQuery
+    # attribute :pre_checkout_query, PreCheckoutQuery
+    attribute :poll, Poll
+  end
+
+  class UpdateDescriptor
+    include Virtus.model
+    attribute :offset, Integer
+    attribute :limit, Integer
+    attribute :timeout, Integer
+    attribute :allowed_updates, Array # of String
+  end
+
+  class ResponseError < StandardError
+    def initialize(msg = "Bot Response Error")
+      super
+    end
+  end
+end

data/lib/telbe/contact.rb

@@ -0,0 +1,28 @@
+module Telbe
+  class Bot
+    def send_contact(contact_descriptor)
+      Message.new(request(:sendContact, contact_descriptor))
+    end
+  end
+
+  class Contact
+    include Virtus.model
+    attribute :phone_number, String
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :user_id, Integer
+    attribute :vcard, String
+  end
+
+  class ContactDescriptor
+    include Virtus.model
+    attribute :chat_id, Integer or String
+    attribute :phone_number, String
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :vcard, String
+    attribute :disable_notification, Boolean
+    attribute :reply_to_message_id, Integer
+    attribute :reply_markup, Object #InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply
+  end
+end

data/lib/telbe/keyboard.rb

@@ -0,0 +1,38 @@
+module Telbe
+  class KeyboardButton
+    include Virtus.model
+    attribute :text, String
+    attribute :request_contact, Boolean
+    attribute :request_location, Boolean
+  end
+
+  class ReplyKeyboardRemove
+    include Virtus.model
+    attribute :remove_keyboard, Boolean
+    attribute :selective, Boolean
+  end
+
+  class ReplyKeyboardMarkup
+    include Virtus.model
+    attribute :keyboard, Array # of Array of KeyboardButton
+    attribute :resize_keyboard, Boolean
+    attribute :one_time_keyboard, Boolean
+    attribute :selective, Boolean
+  end
+
+  class InlineKeyboardMarkup
+    include Virtus.model
+    attribute :inline_keyboard, Array # of Array of InlineKeyboardButton
+  end
+
+  class InlineKeyboardButton
+    include Virtus.model
+    attribute :text, String
+    attribute :url, String
+    attribute :callback_data, String
+    attribute :switch_inline_query, String
+    attribute :switch_inline_query_current_chat, String
+    # attribute :callback_game, CallbackGame
+    # attribute :pay, Boolean
+  end
+end

data/lib/telbe/location.rb

@@ -0,0 +1,16 @@
+module Telbe
+  class Location
+    include Virtus.model
+    attribute :longitude, Float
+    attribute :latitude, Float
+  end
+
+  class Venue
+    include Virtus.model
+    attribute :location, Location
+    attribute :address, String
+    attribute :title, String
+    attribute :foursquare_id, String
+    attribute :foursquare_type, String
+  end
+end

data/lib/telbe/media.rb

@@ -0,0 +1,108 @@
+module Telbe
+  class PhotoSize
+    include Virtus.model
+    attribute :file_id, String
+    attribute :width, Integer
+    attribute :height, Integer
+    attribute :file_size, Integer
+  end
+
+  class Animation
+    include Virtus.model
+    attribute :file_id, String
+    attribute :width, Integer
+    attribute :height, Integer
+    attribute :duration, Integer
+    attribute :thumb, PhotoSize
+    attribute :file_name, String
+    attribute :mime_type, String
+    attribute :file_size, Integer
+  end
+
+  class Document
+    include Virtus.model
+    attribute :file_id, String
+    attribute :thumb, PhotoSize
+    attribute :file_name, String
+    attribute :mime_type, String
+    attribute :file_size, Integer
+  end
+
+  class Audio
+    include Virtus.model
+    attribute :file_id, String
+    attribute :duration, Integer
+    attribute :performer, String
+    attribute :title, String
+    attribute :mime_type, String
+    attribute :file_size, Integer
+    attribute :thumb, PhotoSize
+  end
+
+  class Video
+    include Virtus.model
+    attribute :file_id, String
+    attribute :width, Integer
+    attribute :height, Integer
+    attribute :duration, Integer
+    attribute :thumb, PhotoSize
+    attribute :mime_type, String
+    attribute :file_size, Integer
+  end
+
+  class Voice
+    include Virtus.model
+    attribute :file_id, String
+    attribute :duration, Integer
+    attribute :mime_type, String
+    attribute :file_size, Integer
+  end
+
+  class VideoNote
+    include Virtus.model
+    attribute :file_id, String
+    attribute :length, Integer
+    attribute :duration, Integer
+    attribute :thumb, PhotoSize
+    attribute :file_size, Integer
+  end
+
+  class InputMedia
+    include Virtus.model
+    attribute :type, String
+    attribute :media, String
+    attribute :caption, String
+    attribute :parse_mode, String
+  end
+    
+  class InputMediaAnimation < InputMedia
+    attribute :thumb, Object
+    attribute :width, Integer
+    attribute :height, Integer
+    attribute :duration, Integer
+  end
+
+  class InputMediaDocument < InputMedia
+    include Virtus.model
+    attribute :thumb, Object
+  end
+
+  class InputMediaAudio < InputMedia
+    include Virtus.model
+    attribute :thumb, Object
+    attribute :duration, Integer
+    attribute :performer, String
+    attribute :title, String
+  end
+
+  class InputMediaPhoto < InputMedia
+  end
+
+  class InputMediaVideo < InputMedia
+    attribute :thumb, Object
+    attribute :width, Integer
+    attribute :height, Integer
+    attribute :duration, Integer
+    attribute :supports_streaming, Boolean
+  end
+end

data/lib/telbe/poll.rb

@@ -0,0 +1,18 @@
+module Telbe
+  class Bot
+  end
+
+  class PollOption
+    include Virtus.model
+    attribute :text, String
+    attribute :voter_count, Integer
+  end
+
+  class Poll
+    include Virtus.model
+    attribute :id, String
+    attribute :question, String
+    attribute :options, Array # of PollOption
+    attribute :is_closed, Boolean
+  end
+end

data/lib/telbe/sticker.rb

@@ -0,0 +1,32 @@
+module Telbe
+  class Bot
+  end
+
+  class MaskPosition
+    include Virtus.model
+    attribute :point, String
+    attribute :x_shift, Float
+    attribute :y_shift, Float
+    attribute :scale, Float
+  end
+
+  class Sticker
+    include Virtus.model
+    attribute :file_id, String
+    attribute :width, Integer
+    attribute :height, Integer
+    attribute :thumb, PhotoSize
+    attribute :emoji, String
+    attribute :set_name, String
+    attribute :mask_position, MaskPosition
+    attribute :file_size, Integer
+  end
+
+  class StickerSet
+    include Virtus.model
+    attribute :name, String
+    attribute :title, String
+    attribute :contains_masks, Boolean
+    attribute :stickers, Array # of Sticker
+  end
+end

data/lib/telbe/user.rb

@@ -0,0 +1,45 @@
+module Telbe
+  class Bot
+    def get_chat_administrators(chatid_descriptor)
+      request(:getChatAdministrators, chatid_descriptor).collect do |member_hash|
+        ChatMember.new(member_hash)
+      end
+    end
+
+    def get_chat_members_count(chatid_descriptor)
+      request(:getChatMembersCount, chatid_descriptor)
+    end
+  end
+  
+  class User
+    include Virtus.model
+    attribute :id, Integer #Unique identifier for this user or bot
+    alias_method :to_i, :id
+    attribute :is_bot, Boolean
+    attribute :first_name, String #User‘s or bot’s first name
+    attribute :last_name, String
+    attribute :username, String
+    attribute :language_code, String
+  end
+
+  class ChatMember
+    include Virtus.model
+    attribute :user, User
+    attribute :status, String
+    attribute :until_date, Integer
+    attribute :can_be_edited, Boolean
+    attribute :can_change_info, Boolean
+    attribute :can_post_messages, Boolean
+    attribute :can_edit_messages, Boolean
+    attribute :can_delete_messages, Boolean
+    attribute :can_invite_users, Boolean
+    attribute :can_restrict_members, Boolean
+    attribute :can_pin_messages, Boolean
+    attribute :can_promote_members, Boolean
+    attribute :is_member, Boolean
+    attribute :can_send_messages, Boolean
+    attribute :can_send_media_messages, Boolean
+    attribute :can_send_other_messages, Boolean
+    attribute :can_add_web_page_previews, Boolean
+  end
+end

data/lib/telbe/version.rb

@@ -0,0 +1,3 @@
+module Telbe
+  VERSION = "0.0.1"
+end

data/lib/telbe/webhook.rb

@@ -0,0 +1,37 @@
+module Telbe
+  class Bot
+    def set_webhook(webhook_descriptor)
+      request(:setWebhook, webhook_descriptor)
+    end
+
+    def delete_webhook
+      request(:deleteWebhook)
+    end
+
+    def get_webhookinfo
+      WebHookInfo.new(request(:getWebhookInfo))
+    end
+  end
+  
+  class WebHookInfo
+    include Virtus.model
+    attribute :url, String
+    attribute :has_custom_certificate, Boolean
+    attribute :pending_update_count, Integer
+    attribute :last_error_date, Integer
+    attribute :last_error_message, String
+    attribute :max_connections, Integer
+    attribute :allowed_updates, Array # of String
+  end
+
+  class InputFile
+  end
+  
+  class WebHookDescriptor
+    include Virtus.model
+    attribute :url, String
+    attribute :certificate, InputFile
+    attribute :max_connections, Integer
+    attribute :allowed_updates, Array # of String
+  end
+end

data/lib/telbe.rb

@@ -0,0 +1,19 @@
+require 'excon'
+require 'virtus'
+require 'json'
+
+require 'telbe/webhook'
+require 'telbe/user'
+require 'telbe/contact'
+require 'telbe/keyboard'
+require 'telbe/poll'
+require 'telbe/media'
+require 'telbe/sticker'
+require 'telbe/location'
+require 'telbe/bot'
+
+module BotEngine
+  def self.new(opts)
+    Bot.new(opts)
+  end
+end

data/telbe.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telbe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telbe"
+  spec.version       = Telbe::VERSION
+  spec.date          = "2019-05-07"
+  spec.authors       = ["Rodrigo Garcia Couto"]
+  spec.email         = ["r@rodg.co"]
+  spec.summary       = %q{A Telegram Bot Engine}
+  spec.description   = %q{Still in development. A Telegram Bot Engine that eventually will support all of Telegrams features.}
+  spec.homepage      = "https://github.com/rodgco/telbe"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "excon", ">= 0.64.0"
+  spec.add_dependency "virtus", ">= 0.64.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: telbe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rodrigo Garcia Couto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Still in development. A Telegram Bot Engine that eventually will support
+  all of Telegrams features.
+email:
+- r@rodg.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/telbe.rb
+- lib/telbe/bot.rb
+- lib/telbe/contact.rb
+- lib/telbe/keyboard.rb
+- lib/telbe/location.rb
+- lib/telbe/media.rb
+- lib/telbe/poll.rb
+- lib/telbe/sticker.rb
+- lib/telbe/user.rb
+- lib/telbe/version.rb
+- lib/telbe/webhook.rb
+- telbe.gemspec
+homepage: https://github.com/rodgco/telbe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A Telegram Bot Engine
+test_files: []