telegram-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 846c1cc10ffea65fd25ecac7a05884fa1edbc0e9321f81245558cffcc61c6984
+  data.tar.gz: f9545a566f47c5e98f5d312c6039d84eba1bd9f5dad210f76e241268ee4c5b7b
+SHA512:
+  metadata.gz: 429581b8f2e9fd438d44f5d2f4f62c3a6d2a27e57f267594e7732b886367ec980b33ad373d222da4e4f58b8b38dfff1753080090ad05919c3f82c02013c86e12
+  data.tar.gz: 460a6bd5ef2e217360785c0bad3a3fa59335ebd322856d786f081ad6e8e5a12b81c50a4c15d0c1bb4e614966adc8cefc70bb6fae1f404c2b0670e46f32abba4a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+##0.1.0
+- Initialize repo

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in telegram-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# telegram-ruby
+
+Ruby wrapper for [Telegram's Bot API](https://core.telegram.org/bots/api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telegram-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telegram-ruby
+    
+## Telegram API support
+All types and methods of the Telegram Bot API 3.5 are supported.
+
+## Configuration
+First of all you need create your own bot and obtain a token
+
+[How do I create a bot?](https://core.telegram.org/bots#3-how-do-i-create-a-bot)
+
+Then you can configure **Telegram::Bot** in config/initializers/telegram.rb
+
+    
+```
+require 'telegram/bot'
+    
+Telegram::Bot.configure do |conf|
+    conf.token = 'Here your token'
+    conf.raise_exceptions = false #By default true
+end
+```
+    
+    
+## Usage
+
+You can use **Telegram::Bot::Api** stand alone
+
+
+```
+api = Telegram::Bot::Api.new([Token key])
+api.getMe
+```
+
+Or by using **Telegram::Bot::Client** to receive updates from Telegram
+
+Create handler class
+
+```
+class MyHandler
+  include Telegram::Bot::ClientAccessors
+
+  # this method will be called if /test string was found in message text
+  def cmd_test
+    api.sendMessage(message.chat.id, 'Yes, it is test')
+  end
+
+  # this method will be called if no command found
+  def cmd_fallback
+    # log message
+  end
+end
+```
+
+In your controller add
+
+```
+def create
+ client = Telegram::Bot::Client.new(MyHandler)
+ client.handle(params)
+end
+```
+
+In your handler you can use helper accessors
+
+**api** - **Telegram::Bot::Api** instance  
+
+**update** - This [object](https://core.telegram.org/bots/api#update) represents an incoming update.
+
+**message** - This [object](https://core.telegram.org/bots/api#message) represents a message.
+
+**command** - current command if found in message text (without prefix cmd_)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Stajor/telegram-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "telegram/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/api/inline_keyboard_markup.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'telegram/bot'
+
+api = Telegram::Bot::Api.new('[place-your-token]')
+btn1 = Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Command 1', callback_data: '/command1')
+btn2 = Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Command 2', callback_data: '/command2')
+btn3 = Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Command 3', callback_data: '/command3')
+api.sendMessage('[chat-id]', 'some text', reply_markup: Telegram::Bot::Types::InlineKeyboardMarkup.new([
+  [btn1, btn2], [btn3]
+]))
+
+# or
+
+api.sendMessage('[chat-id]', 'some text', reply_markup: Telegram::Bot::Types::InlineKeyboardMarkup.new([
+  [{text: 'Command 1', callback_data: '/command1'}, {text: 'Command 2', callback_data: '/command2'}],
+  [{text: 'Command 3', callback_data: '/command3'}],
+]))

data/examples/api/send_message.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'telegram/bot'
+
+api = Telegram::Bot::Api.new('[place-your-token]')
+api.sendMessage('[chat-id]', '<b>some text</b>', {parse_mode: 'HTML'})

data/examples/client/handler.rb

@@ -0,0 +1,19 @@
+# In controller
+#...
+#def create
+# client = Telegram::Bot::Client.new(MyHandler)
+# client.handle(params)
+#end
+#...
+
+class MyHandler
+  include Telegram::Bot::ClientAccessors
+
+  def cmd_test
+    api.sendMessage(message.chat.id, 'Yes, it is test')
+  end
+
+  def cmd_fallback
+    # log message
+  end
+end

data/lib/telegram/bot.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'telegram/version'
+require 'telegram/bot/configuration'
+require 'telegram/bot/exceptions'
+require 'telegram/bot/api'
+require 'telegram/bot/types'
+require 'telegram/bot/client'
+require 'telegram/bot/client_accessors'
+
+module Telegram
+  module Bot
+    API_VERSION = 3.5.freeze
+    API_URL = 'https://api.telegram.org'.freeze
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+  end
+end

data/lib/telegram/bot/api.rb

@@ -0,0 +1,261 @@
+module Telegram
+  module Bot
+    class Api
+      def initialize(token = nil)
+        @token = token || Bot.configuration.token
+      end
+
+      def token
+        @token
+      end
+
+      def getMe
+        request('getMe', {}, Types::User)
+      end
+
+      def setWebhook(url, options = {})
+        request('setWebhook', {url: url}.merge(options))
+      end
+
+      def deleteWebhook
+        request('deleteWebhook')
+      end
+
+      def getWebhookInfo
+        request('getWebhookInfo', {}, Types::WebhookInfo)
+      end
+
+      def getUpdates(options = {})
+        request('getWebhookInfo', options, Types::Update, true)
+      end
+
+      def getFile(file_id)
+        request('getFile', {file_id: file_id}, Types::File)
+      end
+
+      def sendMessage(chat_id, text, options = {})
+        request('sendMessage', {chat_id: chat_id, text: text}.merge(options), Types::Message)
+      end
+
+      def forwardMessage(chat_id, from_chat_id, message_id, options = {})
+        request('forwardMessage', {
+            chat_id: chat_id, from_chat_id: from_chat_id, message_id: message_id
+        }.merge(options), Types::Message)
+      end
+
+      def sendPhoto(chat_id, photo, options = {})
+        request('sendPhoto', {chat_id: chat_id, photo: photo}.merge(options), Types::Message)
+      end
+
+      def sendAudio(chat_id, audio, options = {})
+        request('sendAudio', {chat_id: chat_id, audio: audio}.merge(options), Types::Message)
+      end
+
+      def sendDocument(chat_id, document, options = {})
+        request('sendDocument', {chat_id: chat_id, document: document}.merge(options), Types::Message)
+      end
+
+      def sendVideo(chat_id, video, options = {})
+        request('sendVideo', {chat_id: chat_id, video: video}.merge(options), Types::Message)
+      end
+
+      def sendVoice(chat_id, voice, options = {})
+        request('sendVoice', {chat_id: chat_id, voice: voice}.merge(options), Types::Message)
+      end
+
+      def sendMediaGroup(chat_id, video_note, options = {})
+        request('sendMediaGroup', {chat_id: chat_id, video_note: video_note}.merge(options), Types::Message)
+      end
+
+      def sendVideoNote(chat_id, media, options = {})
+        request('sendVideoNote', {chat_id: chat_id, media: media}.merge(options), Types::Message, true)
+      end
+
+      def sendLocation(chat_id, latitude, longitude, options = {})
+        request('sendLocation', {
+            chat_id: chat_id, latitude: latitude, longitude: longitude
+        }.merge(options), Types::Message)
+      end
+
+      def editMessageLiveLocation(latitude, longitude, options = {})
+        request('editMessageLiveLocation', {latitude: latitude, longitude: longitude}.merge(options), Types::Message)
+      end
+
+      def stopMessageLiveLocation(options = {})
+        request('stopMessageLiveLocation', options, Types::Message)
+      end
+
+      def sendVenue(chat_id, latitude, longitude, title, address, options = {})
+        request('sendVenue', {
+            chat_id: chat_id, latitude: latitude, longitude: longitude, title: title, address: address
+        }.merge(options), Types::Message)
+      end
+
+      def sendContact(chat_id, phone_number, first_name, options = {})
+        request('sendContact', {
+            chat_id: chat_id, phone_number: phone_number, first_name: first_name
+        }.merge(options), Types::Message)
+      end
+
+      def sendChatAction(chat_id, action, options = {})
+        request('sendChatAction', {chat_id: chat_id, action: action}.merge(options))
+      end
+
+      def getUserProfilePhotos(user_id, options = {})
+        request('getUserProfilePhotos', {user_id: user_id}.merge(options), Types::UserProfilePhotos)
+      end
+
+      def kickChatMember(chat_id, user_id, options = {})
+        request('kickChatMember', {chat_id: chat_id, user_id: user_id}.merge(options))
+      end
+
+      def unbanChatMember(chat_id, user_id, options = {})
+        request('unbanChatMember', {chat_id: chat_id, user_id: user_id}.merge(options))
+      end
+
+      def promoteChatMember(chat_id, user_id, options = {})
+        request('promoteChatMember', {chat_id: chat_id, user_id: user_id}.merge(options))
+      end
+
+      def restrictChatMember(chat_id, user_id, options = {})
+        request('restrictChatMember', {chat_id: chat_id, user_id: user_id}.merge(options))
+      end
+
+      def exportChatInviteLink(chat_id)
+        request('exportChatInviteLink', {chat_id: chat_id})
+      end
+
+      def setChatPhoto(chat_id, photo)
+        request('setChatPhoto', {chat_id: chat_id, photo: photo})
+      end
+
+      def deleteChatPhoto(chat_id)
+        request('deleteChatPhoto', {chat_id: chat_id})
+      end
+
+      def setChatTitle(chat_id, title)
+        request('setChatTitle', {chat_id: chat_id, title: title})
+      end
+
+      def setChatDescription(chat_id, options = {})
+        request('setChatDescription', {chat_id: chat_id}.merge(options))
+      end
+
+      def pinChatMessage(chat_id, message_id, options = {})
+        request('pinChatMessage', {chat_id: chat_id, message_id: message_id}.merge(options))
+      end
+
+      def unpinChatMessage(chat_id)
+        request('unpinChatMessage', {chat_id: chat_id})
+      end
+
+      def leaveChat(chat_id)
+        request('leaveChat', {chat_id: chat_id})
+      end
+
+      def getChat(user_id)
+        request('getChat', {chat_id: user_id}, Types::Chat)
+      end
+
+      def getChatAdministrators(chat_id)
+        request('getChatAdministrators', {chat_id: chat_id}, Types::ChatMember, true)
+      end
+
+      def getChatMembersCount(chat_id)
+        request('getChatMembersCount', {chat_id: chat_id})
+      end
+
+      def getChatMember(chat_id, user_id)
+        request('getChatMember', {chat_id: chat_id, user_id: user_id}, Types::ChatMember)
+      end
+
+      def setChatStickerSet(chat_id, sticker_set_name)
+        request('setChatStickerSet', {chat_id: chat_id, sticker_set_name: sticker_set_name})
+      end
+
+      def deleteChatStickerSet(chat_id)
+        request('deleteChatStickerSet', {chat_id: chat_id})
+      end
+
+      def answerCallbackQuery(callback_query_id, options = {})
+        request('answerCallbackQuery', {callback_query_id: callback_query_id}.merge(options))
+      end
+
+      def editMessageText(text, options = {})
+        request('editMessageText', {text: text}.merge(options), Types::Message)
+      end
+
+      def editMessageCaption(options = {})
+        request('editMessageCaption', options, Types::Message)
+      end
+
+      def editMessageReplyMarkup(options = {})
+        request('editMessageReplyMarkup', options, Types::Message)
+      end
+
+      def deleteMessage(chat_id, message_id)
+        request('deleteMessage', {chat_id: chat_id, message_id: message_id})
+      end
+
+      def sendSticker(chat_id, sticker, options = {})
+        request('sendSticker', {chat_id: chat_id, sticker: sticker}.merge(options), Types::Message)
+      end
+
+      def getStickerSet(name)
+        request('getStickerSet', {name: name}, Types::StickerSet)
+      end
+
+      def uploadStickerFile(user_id, png_sticker)
+        request('uploadStickerFile', {user_id: user_id, png_sticker: png_sticker}, Types::File)
+      end
+
+      def createNewStickerSet(user_id, name, title, png_sticker, emojis, options = {})
+        request('createNewStickerSet', {
+            user_id: user_id, name: name, title: title, png_sticker: png_sticker, emojis: emojis
+        }.merge(options))
+      end
+
+      def addStickerToSet(user_id, name, png_sticker, emojis, options = {})
+        request('addStickerToSet', {
+            user_id: user_id, name: name, png_sticker: png_sticker, emojis: emojis
+        }.merge(options))
+      end
+
+      def setStickerPositionInSet(sticker, position)
+        request('setStickerPositionInSet', {sticker: sticker, position: position})
+      end
+
+      def deleteStickerFromSet(sticker)
+        request('deleteStickerFromSet', {sticker: sticker})
+      end
+
+      def request(method, query = {}, type_obj = nil, as_array = false)
+        query[:reply_markup] = query[:reply_markup].to_json if query.has_key?(:reply_markup)
+
+        response  = connection.post("/bot#{@token}/#{method}", query)
+        body      = response.body
+
+        if Bot.configuration.raise_exceptions && (response.status != 200 || body['ok'] != true)
+          raise Exceptions::ResponseError.new(body['description'])
+        end
+
+        if type_obj.nil?
+          body['result']
+        elsif as_array
+          body['result'].map {|r| type_obj.new(r) }
+        else
+          type_obj.new(body['result'])
+        end
+      end
+
+      def connection
+        @conn ||= Faraday.new(url: API_URL) do |faraday|
+          faraday.response :json, content_type: /\bjson$/
+          faraday.request :multipart
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end