зеркало из
https://github.com/glebtv/telegram-bot.git
synced 2026-08-28 15:26:18 +03:00
Сравнить коммиты
25 Коммитов
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
07faf87ed7 | ||
|
|
ac45940937 | ||
|
|
a49ef51da9 | ||
|
|
4f669fccc4 | ||
|
|
e06252907a | ||
|
|
af229c8bcc | ||
|
|
a7cf3754be | ||
|
|
783d9c13e9 | ||
|
|
5417511f06 | ||
|
|
a0ca383bab | ||
|
|
1c141f782e | ||
|
|
791c4233ca | ||
|
|
036fbd20d5 | ||
|
|
0590967694 | ||
|
|
4ab1f07bed | ||
|
|
8cd948a544 | ||
|
|
863e838533 | ||
|
|
2a2fafa536 | ||
|
|
4b9eedb5a2 | ||
|
|
f654071c4c | ||
|
|
e178f808b6 | ||
|
|
d173443c56 | ||
|
|
97e45d94f2 | ||
|
|
03472e3d46 | ||
|
|
bc2b09a3b0 |
@@ -40,6 +40,7 @@ Style/IfUnlessModifier: {Enabled: false}
|
||||
# Consistent to other definitions.
|
||||
Style/EmptyMethod: {EnforcedStyle: expanded}
|
||||
|
||||
Style/Lambda: {EnforcedStyle: literal}
|
||||
Style/ModuleFunction: {Enabled: false}
|
||||
Style/NestedParenthesizedCalls: {Enabled: false}
|
||||
Style/SignalException: {EnforcedStyle: only_raise}
|
||||
|
||||
19
.travis.yml
19
.travis.yml
@@ -1,13 +1,21 @@
|
||||
os: linux
|
||||
dist: xenial
|
||||
language: ruby
|
||||
cache: bundler
|
||||
rvm:
|
||||
- 2.6
|
||||
- 2.5
|
||||
gemfile:
|
||||
- gemfiles/rails_61.gemfile
|
||||
- gemfiles/rails_60.gemfile
|
||||
- gemfiles/rails_52.gemfile
|
||||
matrix:
|
||||
jobs:
|
||||
include:
|
||||
# ruby 3.x
|
||||
- rvm: 3.0
|
||||
gemfile: gemfiles/rails_61.gemfile
|
||||
- rvm: 3.0
|
||||
gemfile: gemfiles/rails_60.gemfile
|
||||
# old rails
|
||||
- rvm: 2.5
|
||||
gemfile: gemfiles/rails_51.gemfile
|
||||
@@ -18,14 +26,5 @@ matrix:
|
||||
# old rubies
|
||||
- rvm: 2.4
|
||||
gemfile: gemfiles/rails_52.gemfile
|
||||
- rvm: 2.3
|
||||
gemfile: gemfiles/rails_52.gemfile
|
||||
# future rails
|
||||
- rvm: 2.5
|
||||
gemfile: gemfiles/rails_61.gemfile
|
||||
# Allow rails 6.1 to fail while master branch is used
|
||||
allow_failures:
|
||||
- rvm: 2.5
|
||||
gemfile: gemfiles/rails_61.gemfile
|
||||
notifications:
|
||||
email: false
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
appraise 'rails-61' do
|
||||
git 'https://github.com/rails/rails.git' do
|
||||
gem 'actionpack', '~> 6.1.0.alpha'
|
||||
gem 'railties', '~> 6.1.0.alpha'
|
||||
end
|
||||
gem 'actionpack', '~> 6.1.0'
|
||||
gem 'railties', '~> 6.1.0'
|
||||
end
|
||||
|
||||
appraise 'rails-60' do
|
||||
|
||||
24
CHANGELOG.md
24
CHANGELOG.md
@@ -1,5 +1,29 @@
|
||||
# Unreleased
|
||||
|
||||
# 0.15.4
|
||||
|
||||
- Update to Bot API 5.3
|
||||
|
||||
# 0.15.3
|
||||
|
||||
- Ruby 3.0 support: fix translation helpers.
|
||||
|
||||
# 0.15.2
|
||||
|
||||
- Ruby 3.0 support. Drop support for Ruby < 2.4.
|
||||
|
||||
# 0.15.1
|
||||
|
||||
- Rails 6.1 support.
|
||||
|
||||
# 0.15.0
|
||||
|
||||
- Add `:path` option to `telegram_webhook` route helper.
|
||||
- __Breaking change!__ Default route is generated using hashed bot token.
|
||||
Please reconfigure webhook after update (`rake telegram:bot:set_webhook`).
|
||||
- Update to Bot API 5.0, add rake tasks for `deleteWebhook`, `close` & `logOut`.
|
||||
- Add `server` option for client to support local bot API servers.
|
||||
|
||||
# 0.14.4
|
||||
|
||||
- Update to Bot API 4.7
|
||||
|
||||
16
Gemfile
16
Gemfile
@@ -4,17 +4,17 @@ gemspec
|
||||
group :development do
|
||||
gem 'appraisal', '~> 2.2'
|
||||
|
||||
gem 'pry', '~> 0.10.1'
|
||||
gem 'pry-byebug', '~> 3.2.0'
|
||||
gem 'sdoc', '~> 0.4.1'
|
||||
gem 'pry', '~> 0.13.1'
|
||||
gem 'pry-byebug', '~> 3.9.0'
|
||||
gem 'sdoc', '~> 2.0.3'
|
||||
|
||||
gem 'telegram-bot-types', '~> 0.6.2'
|
||||
gem 'telegram-bot-types', '~> 0.6.3'
|
||||
|
||||
gem 'rspec', '~> 3.5.0'
|
||||
gem 'rspec-its', '~> 1.1.0'
|
||||
gem 'rspec-rails', '~> 3.5.0'
|
||||
gem 'rspec', '~> 3.10.0'
|
||||
gem 'rspec-its', '~> 1.3.0'
|
||||
gem 'rspec-rails', '~> 4.0.2'
|
||||
|
||||
gem 'rubocop', '~> 0.52.1'
|
||||
|
||||
gem 'coveralls', '~> 0.8.2', require: false
|
||||
gem 'coveralls', '~> 0.8.23', require: false
|
||||
end
|
||||
|
||||
85
README.md
85
README.md
@@ -2,9 +2,7 @@
|
||||
|
||||
[](http://badge.fury.io/rb/telegram-bot)
|
||||
[](https://codeclimate.com/github/telegram-bot-rb/telegram-bot)
|
||||
[](https://travis-ci.org/telegram-bot-rb/telegram-bot)
|
||||
|
||||
__Breaking changes in v0.14!__ See [upgrade guide](https://github.com/telegram-bot-rb/telegram-bot/wiki/Upgrading-to-0.14).
|
||||
[](https://travis-ci.com/telegram-bot-rb/telegram-bot)
|
||||
|
||||
Tools for developing Telegram bots. Best used with Rails, but can be used in
|
||||
[standalone app](https://github.com/telegram-bot-rb/telegram-bot/wiki/Not-rails-application).
|
||||
@@ -27,9 +25,33 @@ with session, keyboards and inline queries.
|
||||
Run it on your local machine in 1 minute!
|
||||
|
||||
And here is [app template](https://github.com/telegram-bot-rb/rails_template)
|
||||
to generate clean app in seconds.
|
||||
to generate new rails app in seconds.
|
||||
|
||||
Examples and cookbook in [wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
|
||||
See examples and cookbook in [the wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [Installation](#installation)
|
||||
* [Usage](#usage)
|
||||
* [Configuration](#configuration)
|
||||
* [Configuration in Rails app](#configuration-in-rails-app)
|
||||
* [Client](#client)
|
||||
* [Typed responses](#typed-responses)
|
||||
* [Controller](#controller)
|
||||
* [Reply helpers](#reply-helpers)
|
||||
* [Optional typecasting](#optional-typecasting)
|
||||
* [Session](#session)
|
||||
* [Message context](#message-context)
|
||||
* [Callback queries](#callback-queries)
|
||||
* [Routes in Rails app](#routes-in-rails-app)
|
||||
* [Processing updates](#processing-updates)
|
||||
* [Development & Debugging](#development--debugging)
|
||||
* [Testing](#testing)
|
||||
* [Deployment](#deployment)
|
||||
* [Async mode](#async-mode)
|
||||
* [Limitations](#limitations)
|
||||
* [Development](#development)
|
||||
* [Contributing](#contributing)
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -41,11 +63,15 @@ gem 'telegram-bot'
|
||||
|
||||
And then execute:
|
||||
|
||||
$ bundle
|
||||
```
|
||||
bundle
|
||||
```
|
||||
|
||||
Or install it yourself as:
|
||||
|
||||
$ gem install telegram-bot
|
||||
```
|
||||
gem install telegram-bot
|
||||
```
|
||||
|
||||
Require if necessary:
|
||||
|
||||
@@ -65,7 +91,11 @@ which is used for `Telegram.bot`.
|
||||
```ruby
|
||||
Telegram.bots_config = {
|
||||
default: DEFAULT_BOT_TOKEN,
|
||||
chat: {token: CHAT_BOT_TOKEN, username: 'chatbot'},
|
||||
chat: {
|
||||
token: CHAT_BOT_TOKEN,
|
||||
username: 'ChatBot', # to support commands with mentions (/help@ChatBot)
|
||||
server: 'http://local.bot.api.server', # for Local Bot API Server
|
||||
},
|
||||
}
|
||||
|
||||
Telegram.bot.get_updates
|
||||
@@ -87,6 +117,7 @@ development:
|
||||
bot:
|
||||
token: TOKEN
|
||||
username: SomeBot
|
||||
server: http://local.bot.api.server
|
||||
|
||||
# For multiple bots in single app use hash of `internal_bot_id => settings`
|
||||
bots:
|
||||
@@ -128,9 +159,9 @@ bot.send_message(chat_id: chat_id, text: 'Test')
|
||||
```
|
||||
|
||||
There is no magic, they just pass params as is and set `path_suffix`.
|
||||
See [`Client`](https://github.com/telegram-bot-rb/telegram-bot/blob/master/lib/telegram/bot/client.rb)
|
||||
class for list of available methods. Please open PR or issue if it misses methods from
|
||||
new API versions.
|
||||
See [list of available methods](https://github.com/telegram-bot-rb/telegram-bot/blob/master/lib/telegram/bot/client/api_methods.txt)
|
||||
fetched from [API docs](https://core.telegram.org/bots/api).
|
||||
Please open PR or issue if it misses methods from new API versions.
|
||||
|
||||
Any API request error will raise `Telegram::Bot::Error` with description in its message.
|
||||
Special `Telegram::Bot::Forbidden` is raised when bot can't post messages to the chat anymore.
|
||||
@@ -167,19 +198,18 @@ Bot controllers like usual rails controllers provides features like callbacks,
|
||||
|
||||
```ruby
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
# use callbacks like in any other controllers
|
||||
# use callbacks like in any other controller
|
||||
around_action :with_locale
|
||||
|
||||
# Every update can have one of: message, inline_query, chosen_inline_result,
|
||||
# Every update has one of: message, inline_query, chosen_inline_result,
|
||||
# callback_query, etc.
|
||||
# Define method with same name to respond to this updates.
|
||||
# Define method with the same name to handle this type of update.
|
||||
def message(message)
|
||||
# message can be also accessed via instance method
|
||||
message == self.payload # true
|
||||
# store_message(message['text'])
|
||||
end
|
||||
|
||||
# This basic methods receives commonly used params:
|
||||
# For the following types of updates commonly used params are passed as arguments,
|
||||
# full payload object is available with `payload` instance method.
|
||||
#
|
||||
# message(payload)
|
||||
# inline_query(query, offset)
|
||||
@@ -190,14 +220,19 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
# Command arguments will be parsed and passed to the method.
|
||||
# Be sure to use splat args and default values to not get errors when
|
||||
# someone passed more or less arguments in the message.
|
||||
def start!(data = nil, *)
|
||||
# do_smth_with(data)
|
||||
def start!(word = nil, *other_words)
|
||||
# do_smth_with(word)
|
||||
|
||||
# full message object is also available via `payload` instance method:
|
||||
# process_raw_message(payload['text'])
|
||||
|
||||
# There are `chat` & `from` shortcut methods.
|
||||
# For callback queries `chat` if taken from `message` when it's available.
|
||||
# For callback queries `chat` is taken from `message` when it's available.
|
||||
response = from ? "Hello #{from['username']}!" : 'Hi there!'
|
||||
|
||||
# There is `respond_with` helper to set `chat_id` from received message:
|
||||
respond_with :message, text: response
|
||||
|
||||
# `reply_with` also sets `reply_to_message_id`:
|
||||
reply_with :photo, photo: File.open('party.jpg')
|
||||
end
|
||||
@@ -220,10 +255,10 @@ end
|
||||
|
||||
#### Reply helpers
|
||||
|
||||
There are helpers to respond for basic actions. They just set chat/message/query
|
||||
identifiers from update. See
|
||||
There are helpers for basic responses. They just set chat/message/query
|
||||
identifiers from the update. See
|
||||
[`ReplyHelpers`](https://github.com/telegram-bot-rb/telegram-bot/blob/master/lib/telegram/bot/updates_controller/reply_helpers.rb)
|
||||
module for more information. Here are this methods signatures:
|
||||
module for more information. Here are these methods signatures:
|
||||
|
||||
```ruby
|
||||
def respond_with(type, params); end
|
||||
@@ -366,7 +401,7 @@ end
|
||||
### Routes in Rails app
|
||||
|
||||
There is `telegram_webhook` helper for rails app to define routes for webhooks.
|
||||
It defines routes at `telegram/#{bot.token}` and connects bots with controller.
|
||||
It defines routes at `telegram/#{hash_of(bot.token)}` and connects bots with controller.
|
||||
|
||||
```ruby
|
||||
# Most off apps would require
|
||||
@@ -386,7 +421,7 @@ telegram_webhook TelegramAuctionController, :auction
|
||||
telegram_webhook TelegramController, as: :custom_telegram_webhook
|
||||
```
|
||||
|
||||
#### Processesing updates
|
||||
#### Processing updates
|
||||
|
||||
To process update with controller call `.dispatch(bot, update)` on it.
|
||||
There are several options to run it automatically:
|
||||
|
||||
@@ -25,7 +25,7 @@ method_list = headers.
|
||||
map { |g| g.reject { |x| x.match?(NOT_METHOD_REGEXP) } }.
|
||||
reject(&:empty?)
|
||||
|
||||
api_version = doc.text.match(/^(Bot API ([\d\.]+))\.?$/)
|
||||
api_version = doc.text.match(/^(?:Introducing )?(Bot API ([\d\.]+))\.?$/)
|
||||
|
||||
result = ['# Generated with bin/fetch-telegram-methods']
|
||||
result << "# #{api_version[1]}" if api_version
|
||||
|
||||
@@ -7,15 +7,15 @@ gem "railties", "~> 4.2.0"
|
||||
|
||||
group :development do
|
||||
gem "appraisal", "~> 2.2"
|
||||
gem "pry", "~> 0.10.1"
|
||||
gem "pry-byebug", "~> 3.2.0"
|
||||
gem "sdoc", "~> 0.4.1"
|
||||
gem "pry", "~> 0.13.1"
|
||||
gem "pry-byebug", "~> 3.9.0"
|
||||
gem "sdoc", "~> 2.0.3"
|
||||
gem "telegram-bot-types", "~> 0.6.2"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rspec", "~> 3.10.0"
|
||||
gem "rspec-its", "~> 1.3.0"
|
||||
gem "rspec-rails", "~> 4.0.2"
|
||||
gem "rubocop", "~> 0.52.1"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
gem "coveralls", "~> 0.8.23", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
|
||||
@@ -7,15 +7,15 @@ gem "railties", "~> 5.0.0"
|
||||
|
||||
group :development do
|
||||
gem "appraisal", "~> 2.2"
|
||||
gem "pry", "~> 0.10.1"
|
||||
gem "pry-byebug", "~> 3.2.0"
|
||||
gem "sdoc", "~> 0.4.1"
|
||||
gem "pry", "~> 0.13.1"
|
||||
gem "pry-byebug", "~> 3.9.0"
|
||||
gem "sdoc", "~> 2.0.3"
|
||||
gem "telegram-bot-types", "~> 0.6.2"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rspec", "~> 3.10.0"
|
||||
gem "rspec-its", "~> 1.3.0"
|
||||
gem "rspec-rails", "~> 4.0.2"
|
||||
gem "rubocop", "~> 0.52.1"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
gem "coveralls", "~> 0.8.23", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
|
||||
@@ -7,15 +7,15 @@ gem "railties", "~> 5.1.0"
|
||||
|
||||
group :development do
|
||||
gem "appraisal", "~> 2.2"
|
||||
gem "pry", "~> 0.10.1"
|
||||
gem "pry-byebug", "~> 3.2.0"
|
||||
gem "sdoc", "~> 0.4.1"
|
||||
gem "pry", "~> 0.13.1"
|
||||
gem "pry-byebug", "~> 3.9.0"
|
||||
gem "sdoc", "~> 2.0.3"
|
||||
gem "telegram-bot-types", "~> 0.6.2"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rspec", "~> 3.10.0"
|
||||
gem "rspec-its", "~> 1.3.0"
|
||||
gem "rspec-rails", "~> 4.0.2"
|
||||
gem "rubocop", "~> 0.52.1"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
gem "coveralls", "~> 0.8.23", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
|
||||
@@ -7,15 +7,15 @@ gem "railties", "~> 5.2.0"
|
||||
|
||||
group :development do
|
||||
gem "appraisal", "~> 2.2"
|
||||
gem "pry", "~> 0.10.1"
|
||||
gem "pry-byebug", "~> 3.2.0"
|
||||
gem "sdoc", "~> 0.4.1"
|
||||
gem "pry", "~> 0.13.1"
|
||||
gem "pry-byebug", "~> 3.9.0"
|
||||
gem "sdoc", "~> 2.0.3"
|
||||
gem "telegram-bot-types", "~> 0.6.2"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rspec", "~> 3.10.0"
|
||||
gem "rspec-its", "~> 1.3.0"
|
||||
gem "rspec-rails", "~> 4.0.2"
|
||||
gem "rubocop", "~> 0.52.1"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
gem "coveralls", "~> 0.8.23", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
|
||||
@@ -7,15 +7,15 @@ gem "railties", "~> 6.0.0"
|
||||
|
||||
group :development do
|
||||
gem "appraisal", "~> 2.2"
|
||||
gem "pry", "~> 0.10.1"
|
||||
gem "pry-byebug", "~> 3.2.0"
|
||||
gem "sdoc", "~> 0.4.1"
|
||||
gem "pry", "~> 0.13.1"
|
||||
gem "pry-byebug", "~> 3.9.0"
|
||||
gem "sdoc", "~> 2.0.3"
|
||||
gem "telegram-bot-types", "~> 0.6.2"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rspec", "~> 3.10.0"
|
||||
gem "rspec-its", "~> 1.3.0"
|
||||
gem "rspec-rails", "~> 4.0.2"
|
||||
gem "rubocop", "~> 0.52.1"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
gem "coveralls", "~> 0.8.23", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
|
||||
@@ -2,22 +2,20 @@
|
||||
|
||||
source "https://rubygems.org"
|
||||
|
||||
git "https://github.com/rails/rails.git" do
|
||||
gem "actionpack", "~> 6.1.0.alpha"
|
||||
gem "railties", "~> 6.1.0.alpha"
|
||||
end
|
||||
gem "actionpack", "~> 6.1.0"
|
||||
gem "railties", "~> 6.1.0"
|
||||
|
||||
group :development do
|
||||
gem "appraisal", "~> 2.2"
|
||||
gem "pry", "~> 0.10.1"
|
||||
gem "pry-byebug", "~> 3.2.0"
|
||||
gem "sdoc", "~> 0.4.1"
|
||||
gem "pry", "~> 0.13.1"
|
||||
gem "pry-byebug", "~> 3.9.0"
|
||||
gem "sdoc", "~> 2.0.3"
|
||||
gem "telegram-bot-types", "~> 0.6.2"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rspec", "~> 3.10.0"
|
||||
gem "rspec-its", "~> 1.3.0"
|
||||
gem "rspec-rails", "~> 4.0.2"
|
||||
gem "rubocop", "~> 0.52.1"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
gem "coveralls", "~> 0.8.23", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
|
||||
@@ -14,15 +14,22 @@ namespace :telegram do
|
||||
|
||||
desc 'Set webhook urls for all bots'
|
||||
task set_webhook: :environment do
|
||||
routes = Rails.application.routes.url_helpers
|
||||
cert_file = ENV['CERT']
|
||||
cert = File.open(cert_file) if cert_file
|
||||
Telegram.bots.each do |key, bot|
|
||||
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
||||
url = routes.send("#{route_name}_url")
|
||||
puts "Setting webhook for #{key}..."
|
||||
bot.async(false) { bot.set_webhook(url: url, certificate: cert) }
|
||||
end
|
||||
Telegram::Bot::Tasks.set_webhook
|
||||
end
|
||||
|
||||
desc 'Delete webhooks for all or specific BOT'
|
||||
task :delete_webhook do
|
||||
Telegram::Bot::Tasks.delete_webhook
|
||||
end
|
||||
|
||||
desc 'Perform logOut command for all or specific BOT'
|
||||
task :log_out do
|
||||
Telegram::Bot::Tasks.log_out
|
||||
end
|
||||
|
||||
desc 'Perform `close` command for all or specific BOT'
|
||||
task :close do
|
||||
Telegram::Bot::Tasks.close
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -14,10 +14,10 @@ module Telegram
|
||||
|
||||
module_function
|
||||
|
||||
def deprecation_0_15
|
||||
def deprecation_0_16
|
||||
@deprecation ||= begin
|
||||
require 'active_support/deprecation'
|
||||
ActiveSupport::Deprecation.new('0.15', 'Telegram::Bot')
|
||||
ActiveSupport::Deprecation.new('0.16', 'Telegram::Bot')
|
||||
end
|
||||
end
|
||||
|
||||
@@ -25,9 +25,9 @@ module Telegram
|
||||
autoload :Client, 'telegram/bot/client'
|
||||
autoload :ClientStub, 'telegram/bot/client_stub'
|
||||
autoload :DebugClient, 'telegram/bot/debug_client'
|
||||
autoload :Initializers, 'telegram/bot/initializers'
|
||||
autoload :Middleware, 'telegram/bot/middleware'
|
||||
autoload :RSpec, 'telegram/bot/rspec'
|
||||
autoload :Tasks, 'telegram/bot/tasks'
|
||||
autoload :UpdatesController, 'telegram/bot/updates_controller'
|
||||
autoload :UpdatesPoller, 'telegram/bot/updates_poller'
|
||||
end
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
require 'active_support/core_ext/hash/keys'
|
||||
require 'json'
|
||||
require 'httpclient'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
class Client
|
||||
URL_TEMPLATE = 'https://api.telegram.org/bot%<token>s/'.freeze
|
||||
SERVER = 'https://api.telegram.org'.freeze
|
||||
URL_TEMPLATE = '%<server>s/bot%<token>s/'.freeze
|
||||
|
||||
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
||||
extend Initializers
|
||||
prepend Async
|
||||
include DebugClient
|
||||
|
||||
@@ -15,6 +16,16 @@ module Telegram
|
||||
include ApiHelper
|
||||
|
||||
class << self
|
||||
# Accepts different options to initialize bot.
|
||||
def wrap(input, **options)
|
||||
case input
|
||||
when Symbol then by_id(input) or raise "#{name} #{input.inspect} not configured"
|
||||
when self then input
|
||||
when Hash then new(**input.symbolize_keys, **options)
|
||||
else new(input, **options)
|
||||
end
|
||||
end
|
||||
|
||||
def by_id(id)
|
||||
Telegram.bots[id]
|
||||
end
|
||||
@@ -51,11 +62,11 @@ module Telegram
|
||||
|
||||
attr_reader :client, :token, :username, :base_uri
|
||||
|
||||
def initialize(token = nil, username = nil, **options)
|
||||
def initialize(token = nil, username = nil, server: SERVER, **options)
|
||||
@client = HTTPClient.new
|
||||
@token = token || options[:token]
|
||||
@username = username || options[:username]
|
||||
@base_uri = format(URL_TEMPLATE, token: self.token)
|
||||
@base_uri = format(URL_TEMPLATE, server: server, token: self.token)
|
||||
end
|
||||
|
||||
def request(action, body = {})
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Generated with bin/fetch-telegram-methods
|
||||
# Bot API 4.7
|
||||
# Bot API 5.3
|
||||
|
||||
getUpdates
|
||||
setWebhook
|
||||
@@ -7,8 +7,11 @@ deleteWebhook
|
||||
getWebhookInfo
|
||||
|
||||
getMe
|
||||
logOut
|
||||
close
|
||||
sendMessage
|
||||
forwardMessage
|
||||
copyMessage
|
||||
sendPhoto
|
||||
sendAudio
|
||||
sendDocument
|
||||
@@ -27,28 +30,33 @@ sendDice
|
||||
sendChatAction
|
||||
getUserProfilePhotos
|
||||
getFile
|
||||
kickChatMember
|
||||
banChatMember
|
||||
unbanChatMember
|
||||
restrictChatMember
|
||||
promoteChatMember
|
||||
setChatAdministratorCustomTitle
|
||||
setChatPermissions
|
||||
exportChatInviteLink
|
||||
createChatInviteLink
|
||||
editChatInviteLink
|
||||
revokeChatInviteLink
|
||||
setChatPhoto
|
||||
deleteChatPhoto
|
||||
setChatTitle
|
||||
setChatDescription
|
||||
pinChatMessage
|
||||
unpinChatMessage
|
||||
unpinAllChatMessages
|
||||
leaveChat
|
||||
getChat
|
||||
getChatAdministrators
|
||||
getChatMembersCount
|
||||
getChatMemberCount
|
||||
getChatMember
|
||||
setChatStickerSet
|
||||
deleteChatStickerSet
|
||||
answerCallbackQuery
|
||||
setMyCommands
|
||||
deleteMyCommands
|
||||
getMyCommands
|
||||
|
||||
editMessageText
|
||||
|
||||
@@ -5,11 +5,11 @@ module Telegram
|
||||
attr_reader :requests
|
||||
|
||||
module StubbedConstructor
|
||||
def new(*args)
|
||||
def new(*args, **kwargs)
|
||||
if self == ClientStub || !ClientStub.stub_all?
|
||||
super
|
||||
else
|
||||
ClientStub.new(*args)
|
||||
ClientStub.new(*args, **kwargs)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
require 'active_support/core_ext/hash/keys'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
module Initializers
|
||||
# Accepts different options to initialize bot.
|
||||
def wrap(input, **options)
|
||||
case input
|
||||
when Symbol then by_id(input) or raise "#{name} #{input.inspect} not configured"
|
||||
when self then input
|
||||
when Hash then new(**input.symbolize_keys, **options)
|
||||
else new(input, **options)
|
||||
end
|
||||
end
|
||||
|
||||
def by_id(_id)
|
||||
raise 'Not implemented'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,3 +1,6 @@
|
||||
require 'base64'
|
||||
require 'openssl'
|
||||
|
||||
require 'telegram/bot'
|
||||
require 'active_support/core_ext/array/wrap'
|
||||
|
||||
@@ -17,10 +20,8 @@ module Telegram
|
||||
end || 'telegram_webhook'
|
||||
end
|
||||
|
||||
# Replaces colon with underscore so rails don't treat it as
|
||||
# route parameter.
|
||||
def escape_token(token)
|
||||
token && token.tr(':', '_')
|
||||
def token_hash(token)
|
||||
Base64.urlsafe_encode64(OpenSSL::Digest::SHA1.digest(token), padding: false)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -34,14 +35,17 @@ module Telegram
|
||||
#
|
||||
# # pass additional options
|
||||
# telegram_webhook TelegramController, :default, as: :custom_route_name
|
||||
def telegram_webhook(controller, bot = :default, **options)
|
||||
#
|
||||
# # Default path is generated using hashed bot token. Override it using:
|
||||
# telegram_webhook TelegramController, :default, path: 'top/secret'
|
||||
def telegram_webhook(controller, bot = :default, path: nil, **options)
|
||||
bot = Client.wrap(bot)
|
||||
params = {
|
||||
to: Middleware.new(bot, controller),
|
||||
as: RoutesHelper.route_name_for_bot(bot),
|
||||
format: false,
|
||||
}.merge!(options)
|
||||
post("telegram/#{RoutesHelper.escape_token bot.token}", params)
|
||||
post(path || "telegram/#{bot.token && RoutesHelper.token_hash(bot.token)}", params)
|
||||
UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
require 'telegram/bot'
|
||||
Telegram::Bot.deprecation_0_15.warn(
|
||||
"`require 'telegram/bot/rspec/integration'` is deprecated in favor of " \
|
||||
"`require 'telegram/bot/rspec/integration/rails'`"
|
||||
)
|
||||
require 'telegram/bot/rspec/integration/rails'
|
||||
|
||||
Telegram::Bot::RSpec.with_include_context do |config|
|
||||
config.include_context 'telegram/bot/integration/rails', telegram_bot: true
|
||||
end
|
||||
63
lib/telegram/bot/tasks.rb
Обычный файл
63
lib/telegram/bot/tasks.rb
Обычный файл
@@ -0,0 +1,63 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
module Tasks
|
||||
extend self
|
||||
|
||||
def set_webhook
|
||||
routes = Rails.application.routes.url_helpers
|
||||
cert_file = ENV['CERT']
|
||||
cert = File.open(cert_file) if cert_file
|
||||
each_bot do |key, bot|
|
||||
route_name = RoutesHelper.route_name_for_bot(bot)
|
||||
url = routes.send("#{route_name}_url")
|
||||
say("Setting webhook for #{key}...")
|
||||
bot.set_webhook(
|
||||
url: url,
|
||||
certificate: cert,
|
||||
ip_address: ENV['IP_ADDRESS'],
|
||||
drop_pending_updates: drop_pending_updates,
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
def delete_webhook
|
||||
each_bot do |key, bot|
|
||||
say("Deleting webhook for #{key}...")
|
||||
bot.delete_webhook(drop_pending_updates: drop_pending_updates)
|
||||
end
|
||||
end
|
||||
|
||||
def log_out
|
||||
each_bot do |key, bot|
|
||||
say("Logging out #{key}...")
|
||||
bot.log_out
|
||||
end
|
||||
end
|
||||
|
||||
def close
|
||||
each_bot do |key, bot|
|
||||
say("Closing #{key}...")
|
||||
bot.close
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def say(text)
|
||||
puts(text) unless Rails.env.test? # rubocop:disable Rails/Output
|
||||
end
|
||||
|
||||
def each_bot(&block)
|
||||
id = ENV['BOT'].try!(:to_sym)
|
||||
bots = id ? {id => Client.by_id(id)} : Telegram.bots
|
||||
bots.each { |key, bot| bot.async(false) { block[key, bot] } }
|
||||
end
|
||||
|
||||
def drop_pending_updates
|
||||
ENV['DROP_PENDING_UPDATES'].try!(:downcase) == 'true'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -99,6 +99,8 @@ module Telegram
|
||||
pre_checkout_query
|
||||
poll
|
||||
poll_answer
|
||||
my_chat_member
|
||||
chat_member
|
||||
].freeze
|
||||
|
||||
class << self
|
||||
|
||||
@@ -49,7 +49,7 @@ module Telegram
|
||||
private
|
||||
|
||||
# A hook invoked every time a before callback is halted.
|
||||
def halted_callback_hook(filter)
|
||||
def halted_callback_hook(filter, *)
|
||||
Instrumentation.instrument(:halted_callback, filter: filter)
|
||||
end
|
||||
|
||||
|
||||
@@ -12,15 +12,15 @@ module Telegram
|
||||
|
||||
module ClassMethods
|
||||
# Class-level helper for lazy translations.
|
||||
def translate(key, options = {})
|
||||
def translate(key, **options)
|
||||
key = "#{controller_path.tr('/', '.')}#{key}" if key.to_s.start_with?('.')
|
||||
I18n.translate(key, options)
|
||||
I18n.translate(key, **options)
|
||||
end
|
||||
alias :t :translate
|
||||
end
|
||||
|
||||
# See toplevel description.
|
||||
def translate(key, options = {})
|
||||
def translate(key, **options)
|
||||
if key.to_s.start_with?('.')
|
||||
path = controller_path.tr('/', '.')
|
||||
defaults = [:"#{path}#{key}"]
|
||||
@@ -28,7 +28,7 @@ module Telegram
|
||||
options[:default] = defaults.flatten
|
||||
key = "#{path}.#{action_name_i18n_key}#{key}"
|
||||
end
|
||||
I18n.translate(key, options)
|
||||
I18n.translate(key, **options)
|
||||
end
|
||||
alias :t :translate
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ module Telegram
|
||||
ensure
|
||||
@running = false
|
||||
end
|
||||
log { 'Stoped polling bot updates.' }
|
||||
log { 'Stopped polling bot updates.' }
|
||||
end
|
||||
|
||||
def run
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
VERSION = '0.14.4'.freeze
|
||||
VERSION = '0.15.4'.freeze
|
||||
|
||||
def self.gem_version
|
||||
Gem::Version.new VERSION
|
||||
|
||||
74
spec/integration/tasks_spec.rb
Обычный файл
74
spec/integration/tasks_spec.rb
Обычный файл
@@ -0,0 +1,74 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'integration_helper'
|
||||
|
||||
RSpec.describe Telegram::Bot::Tasks, type: :request do
|
||||
include Telegram::Bot::RSpec::ClientMatchers
|
||||
|
||||
def stub_env(new_values)
|
||||
new_values.stringify_keys!
|
||||
old_values = ENV.to_h.slice(new_values.keys)
|
||||
new_values.each { |k, v| ENV[k] = v.to_s }
|
||||
yield
|
||||
ensure
|
||||
new_values.each_key { |k| ENV[k] = old_values[k] }
|
||||
end
|
||||
|
||||
shared_examples 'uses BOT envar' do |bot_matcher|
|
||||
it 'runs for all bots by default' do
|
||||
matcher = Telegram.bots.values.map { |x| instance_exec(x, &bot_matcher) }.reduce(&:and)
|
||||
expect(subject).to matcher
|
||||
end
|
||||
|
||||
context 'when BOT specified' do
|
||||
around { |ex| stub_env(BOT: :other) { ex.run } }
|
||||
|
||||
it 'runs for this bot only' do
|
||||
expect(subject).to instance_exec(Telegram.bots[:other], &bot_matcher)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#log_out' do
|
||||
subject { -> { described_class.log_out } }
|
||||
include_examples 'uses BOT envar', ->(bot) { make_telegram_request(bot, :logOut) }
|
||||
end
|
||||
|
||||
describe '#close' do
|
||||
subject { -> { described_class.close } }
|
||||
include_examples 'uses BOT envar', ->(bot) { make_telegram_request(bot, :close) }
|
||||
end
|
||||
|
||||
describe '#set_webhook' do
|
||||
subject { -> { described_class.set_webhook } }
|
||||
include_examples 'uses BOT envar', ->(bot) { make_telegram_request(bot, :setWebhook) }
|
||||
|
||||
context 'with options in env' do
|
||||
around do |ex|
|
||||
stub_env(IP_ADDRESS: '1.2.3.4', DROP_PENDING_UPDATES: 'TrUe') do
|
||||
ex.run
|
||||
end
|
||||
end
|
||||
include_examples 'uses BOT envar', ->(bot) {
|
||||
make_telegram_request(bot, :setWebhook).with(hash_including(
|
||||
ip_address: '1.2.3.4',
|
||||
drop_pending_updates: true,
|
||||
))
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
describe '#delete_webhook' do
|
||||
subject { -> { described_class.delete_webhook } }
|
||||
include_examples 'uses BOT envar', ->(bot) { make_telegram_request(bot, :deleteWebhook) }
|
||||
|
||||
context 'with options in env' do
|
||||
around { |ex| stub_env(DROP_PENDING_UPDATES: 'TrUe') { ex.run } }
|
||||
include_examples 'uses BOT envar', ->(bot) {
|
||||
make_telegram_request(bot, :deleteWebhook).with(hash_including(
|
||||
drop_pending_updates: true,
|
||||
))
|
||||
}
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -14,6 +14,7 @@ class TestApplication < Rails::Application
|
||||
config.eager_load = false
|
||||
config.log_level = :debug
|
||||
config.action_dispatch.show_exceptions = false
|
||||
routes.default_url_options = {host: 'test.rpsec'}
|
||||
|
||||
telegram_config = {
|
||||
bot: 'default_token',
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
RSpec.shared_examples 'async' do |request_args: -> {}|
|
||||
RSpec.shared_examples 'async' do |request_args:|
|
||||
let(:instance) { described_class.new(token: token, id: id, async: async) }
|
||||
let(:id) { :default_bot }
|
||||
let(:async) { true }
|
||||
@@ -103,7 +103,7 @@ RSpec.shared_examples 'async' do |request_args: -> {}|
|
||||
end
|
||||
|
||||
describe '#request' do
|
||||
subject { ->(*args) { instance.request(*(args.empty? ? self.args : args)) } }
|
||||
subject { ->(*args) { instance.request(*args) } }
|
||||
let(:args, &request_args)
|
||||
let(:result) { double(:result) }
|
||||
|
||||
@@ -112,7 +112,7 @@ RSpec.shared_examples 'async' do |request_args: -> {}|
|
||||
expect(instance).to_not receive(:http_request)
|
||||
expect(described_class).to receive(:prepare_async_args).with(*args) { args }
|
||||
expect(instance.async).to receive(:perform_later).with(id.to_s, *args) { result }
|
||||
expect(subject.call).to eq result
|
||||
expect(subject.call(*args)).to eq result
|
||||
end
|
||||
end
|
||||
|
||||
@@ -131,12 +131,11 @@ RSpec.shared_examples 'async' do |request_args: -> {}|
|
||||
context 'when async is disabled' do
|
||||
let(:async) { false }
|
||||
let(:result) { double(status: 200, body: '{"test":"ok"}') }
|
||||
let(:args, &request_args)
|
||||
|
||||
it 'performs request immediately' do
|
||||
expect(instance).to receive(:request).with(*args).and_call_original
|
||||
expect(instance).to receive(:http_request) { result }
|
||||
expect(subject[]).to eq 'test' => 'ok'
|
||||
expect(subject.call(*args)).to eq 'test' => 'ok'
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,65 +0,0 @@
|
||||
RSpec.shared_examples 'initializers' do |config_method = :bots|
|
||||
describe '.wrap' do
|
||||
subject { described_class.wrap(input, **options) }
|
||||
let(:options) { {} }
|
||||
let(:result) { double(:result) }
|
||||
let(:username) { 'username' }
|
||||
|
||||
context 'when input is a string' do
|
||||
let(:input) { token }
|
||||
|
||||
it 'treats string as token' do
|
||||
expect(described_class).to receive(:new).with(token, {}) { result }
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'and additional options are given' do
|
||||
let(:options) { {id: :test} }
|
||||
|
||||
it 'passes them to initializer' do
|
||||
expect(described_class).to receive(:new).with(input, **options) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is a hash' do
|
||||
let(:input) { {token: token, 'username' => username, other: :options} }
|
||||
|
||||
it 'passes it with symbolized keys' do
|
||||
expect(described_class).to receive(:new).with(**input.symbolize_keys) { result }
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'and additional options are given' do
|
||||
let(:options) { {id: :test} }
|
||||
|
||||
it 'passes them to initializer' do
|
||||
expect(described_class).to receive(:new).
|
||||
with(**input.symbolize_keys, **options) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is an instance of described_class' do
|
||||
let!(:input) { instance }
|
||||
|
||||
it 'returns input' do
|
||||
expect(described_class).to_not receive(:new)
|
||||
should eq input
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is a Symbol' do
|
||||
let(:input) { :client_1 }
|
||||
before { allow(Telegram).to receive(config_method) { {client_1: instance} } }
|
||||
it { should eq Telegram.send(config_method)[:client_1] }
|
||||
|
||||
context 'and there is no such bot' do
|
||||
let(:input) { :invalid }
|
||||
it { expect { subject }.to raise_error(/not configured/) }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -2,9 +2,75 @@ RSpec.describe Telegram::Bot::Client do
|
||||
let(:instance) { described_class.new 'token' }
|
||||
let(:token) { 'token' }
|
||||
|
||||
include_examples 'initializers'
|
||||
it_behaves_like 'async', request_args: -> { [double(:action), {body: :content}] }
|
||||
|
||||
describe '.wrap' do
|
||||
subject { described_class.wrap(input, **options) }
|
||||
let(:options) { {} }
|
||||
let(:result) { double(:result) }
|
||||
let(:username) { 'username' }
|
||||
|
||||
context 'when input is a string' do
|
||||
let(:input) { token }
|
||||
|
||||
it 'treats string as token' do
|
||||
expect(described_class).to receive(:new) do |*args, **kwargs|
|
||||
expect([*args, kwargs]).to eq([token, {}]) # not using .with to support ruby 2.x and 3.x
|
||||
result
|
||||
end
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'and additional options are given' do
|
||||
let(:options) { {id: :test} }
|
||||
|
||||
it 'passes them to initializer' do
|
||||
expect(described_class).to receive(:new).with(input, **options) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is a hash' do
|
||||
let(:input) { {token: token, 'username' => username, other: :options} }
|
||||
|
||||
it 'passes it with symbolized keys' do
|
||||
expect(described_class).to receive(:new).with(**input.symbolize_keys) { result }
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'and additional options are given' do
|
||||
let(:options) { {id: :test} }
|
||||
|
||||
it 'passes them to initializer' do
|
||||
expect(described_class).to receive(:new).
|
||||
with(**input.symbolize_keys, **options) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is an instance of described_class' do
|
||||
let!(:input) { instance }
|
||||
|
||||
it 'returns input' do
|
||||
expect(described_class).to_not receive(:new)
|
||||
should eq input
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is a Symbol' do
|
||||
let(:input) { :client_1 }
|
||||
before { allow(Telegram).to receive(:bots) { {client_1: instance} } }
|
||||
it { should eq Telegram.bots[:client_1] }
|
||||
|
||||
context 'and there is no such bot' do
|
||||
let(:input) { :invalid }
|
||||
it { expect { subject }.to raise_error(/not configured/) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '.prepare_body' do
|
||||
subject { described_class.prepare_body(input) }
|
||||
|
||||
@@ -31,27 +97,49 @@ RSpec.describe Telegram::Bot::Client do
|
||||
end
|
||||
|
||||
describe '.new' do
|
||||
subject { described_class.new(*args) }
|
||||
subject { described_class.new(*args, **kwargs) }
|
||||
let(:args) { [] }
|
||||
let(:kwargs) { {} }
|
||||
let(:token) { 'secret' }
|
||||
let(:username) { 'superbot' }
|
||||
|
||||
context 'when multiple args are given' do
|
||||
let(:args) { %w[secret superbot] }
|
||||
its(:token) { should eq args[0] }
|
||||
its(:username) { should eq args[1] }
|
||||
its(:base_uri) { should include args[0] }
|
||||
let(:args) { [token, username] }
|
||||
its(:token) { should eq token }
|
||||
its(:username) { should eq username }
|
||||
its(:base_uri) { should eq "#{described_class::SERVER}/bot#{token}/" }
|
||||
end
|
||||
|
||||
context 'when hash is given' do
|
||||
let(:args) { [token: 'secret', username: 'superbot'] }
|
||||
its(:token) { should eq args[0][:token] }
|
||||
its(:username) { should eq args[0][:username] }
|
||||
its(:base_uri) { should include args[0][:token] }
|
||||
let(:kwargs) { {token: 'secret', username: 'superbot'} }
|
||||
its(:token) { should eq token }
|
||||
its(:username) { should eq username }
|
||||
its(:base_uri) { should eq "#{described_class::SERVER}/bot#{token}/" }
|
||||
end
|
||||
|
||||
context 'with custom server' do
|
||||
let(:server) { 'http://my.server' }
|
||||
let(:args) { [token, username] }
|
||||
let(:kwargs) { {server: server} }
|
||||
its(:base_uri) { should eq "#{server}/bot#{token}/" }
|
||||
|
||||
context 'and hash options' do
|
||||
let(:kwargs) { {token: token, username: username, server: server} }
|
||||
its(:base_uri) { should eq "#{server}/bot#{token}/" }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#request' do
|
||||
subject { -> { instance.request(action, request_body) } }
|
||||
let(:action) { :some_action }
|
||||
let(:url) { "#{format(described_class::URL_TEMPLATE, token: token)}#{action}" }
|
||||
let(:url) do
|
||||
base_uri = format(described_class::URL_TEMPLATE,
|
||||
server: described_class::SERVER,
|
||||
token: token,
|
||||
)
|
||||
"#{base_uri}#{action}"
|
||||
end
|
||||
let(:request_body) { double(:body) }
|
||||
let(:prepared_body) { double(:prepared_body) }
|
||||
let(:response) { HTTP::Message.new_response(body).tap { |x| x.status = status } }
|
||||
|
||||
@@ -37,11 +37,13 @@ RSpec.describe Telegram::Bot::ClientStub do
|
||||
end
|
||||
|
||||
describe '#new' do
|
||||
subject { described_class.new(*args) }
|
||||
subject { described_class.new(*args, **kwargs) }
|
||||
let(:args) { [] }
|
||||
let(:kwargs) { {} }
|
||||
|
||||
context 'when only username is given' do
|
||||
let(:args) { 'superbot' }
|
||||
its(:username) { should eq args }
|
||||
let(:args) { ['superbot'] }
|
||||
its(:username) { should eq args[0] }
|
||||
end
|
||||
|
||||
context 'when username and token are given' do
|
||||
@@ -51,9 +53,9 @@ RSpec.describe Telegram::Bot::ClientStub do
|
||||
end
|
||||
|
||||
context 'when hash config is given' do
|
||||
let(:args) { [token: 'token', username: 'superbot'] }
|
||||
its(:token) { should eq args[0][:token] }
|
||||
its(:username) { should eq args[0][:username] }
|
||||
let(:kwargs) { {token: 'token', username: 'superbot'} }
|
||||
its(:token) { should eq kwargs[:token] }
|
||||
its(:username) { should eq kwargs[:username] }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -41,57 +41,61 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
end
|
||||
|
||||
describe '#telegram_webhook' do
|
||||
subject { mapper.telegram_webhook(*input) }
|
||||
subject { ->(*args, **kwargs) { mapper.telegram_webhook(*args, **kwargs) } }
|
||||
let(:mapper) { double(:mapper).tap { |x| x.extend described_class } }
|
||||
let(:bots) { {default: bot, other: other_bot} }
|
||||
let(:controller) { double(:controller, name: :controller) }
|
||||
let(:other_controller) { double(:other_controller, name: :other_controller) }
|
||||
before { allow(Telegram).to receive(:bots) { bots } }
|
||||
|
||||
def assert_routes(bot, controller, route_name, options) # rubocop:disable AbcSize
|
||||
expected_path = options.delete(:path) || "telegram/#{bot.token}"
|
||||
expect(mapper).to receive(:post) do |path, params|
|
||||
expect(path).to eq expected_path
|
||||
middleware = params[:to]
|
||||
def assert_route(bot, controller, path: nil, **expected_options) # rubocop:disable AbcSize
|
||||
path ||= "telegram/#{described_class.token_hash(bot.token)}"
|
||||
expect(mapper).to receive(:post) do |actual_path, actual_options|
|
||||
expect(actual_path).to eq(path)
|
||||
middleware = actual_options[:to]
|
||||
expect(middleware.controller).to eq(controller)
|
||||
expect(middleware.bot.token).to eq(bot.token)
|
||||
expect(middleware.bot.username).to eq(bot.username)
|
||||
expect(params[:as]).to eq route_name
|
||||
expect(params).to include(options) if options
|
||||
expect(actual_options).to include(expected_options)
|
||||
end
|
||||
subject
|
||||
yield
|
||||
end
|
||||
|
||||
context 'when called with controller' do
|
||||
let(:input) { [controller, option: :val] }
|
||||
|
||||
it 'creates routes for default bot and this controller' do
|
||||
assert_routes bot, controller, 'default_telegram_webhook', option: :val
|
||||
it 'creates routes for default bot' do
|
||||
assert_route(bot, controller, as: 'default_telegram_webhook') do
|
||||
subject[controller]
|
||||
end
|
||||
|
||||
context 'and bot does not have configured token' do
|
||||
let(:bot) { create_bot(nil) }
|
||||
it 'creates routes for default bot and this controller' do
|
||||
assert_routes bot, controller, 'default_telegram_webhook', option: :val
|
||||
end
|
||||
other_controller = double(:other_controller, name: :other_controller)
|
||||
assert_route(bot, other_controller, as: 'custom_route') do
|
||||
subject[other_controller, as: 'custom_route']
|
||||
end
|
||||
end
|
||||
|
||||
context 'and bot has colon in token' do
|
||||
let(:bot) { create_bot('some:token') }
|
||||
it 'replaces colon with underscore' do
|
||||
assert_routes bot, controller, 'default_telegram_webhook',
|
||||
option: :val,
|
||||
path: 'telegram/some_token'
|
||||
it 'passes extra options' do
|
||||
assert_route(bot, controller, as: 'default_telegram_webhook', option: :val, other: 2) do
|
||||
subject[controller, option: :val, other: 2]
|
||||
end
|
||||
end
|
||||
|
||||
it 'uses :path param to override default path' do
|
||||
assert_route(bot, controller, as: 'default_telegram_webhook', path: 'custom/path') do
|
||||
subject[controller, path: 'custom/path']
|
||||
end
|
||||
end
|
||||
|
||||
context 'when bot does not have configured token' do
|
||||
let(:bot) { create_bot(nil) }
|
||||
it 'creates route anyway' do
|
||||
assert_route(bot, controller, as: 'default_telegram_webhook', path: 'telegram/') do
|
||||
subject[controller]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when called with controller and smth castable to bot' do
|
||||
let(:input) { [controller, 'custom_token', option: :val] }
|
||||
|
||||
it 'creates routes for every created bot and controller' do
|
||||
assert_routes create_bot('custom_token'), controller, 'telegram_webhook',
|
||||
option: :val
|
||||
assert_route(create_bot('custom_token'), controller, as: 'telegram_webhook') do
|
||||
subject[controller, 'custom_token']
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,5 +1,26 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController::Translation do
|
||||
def self.stub_translations(translations)
|
||||
around do |ex|
|
||||
backend = I18n.backend
|
||||
I18n.backend = I18n::Backend::Simple.new
|
||||
begin
|
||||
I18n.backend.store_translations 'en', telegram: {webhooks: translations}
|
||||
ex.run
|
||||
ensure
|
||||
I18n.backend = backend
|
||||
end
|
||||
end
|
||||
end
|
||||
let(:result) { double(:result) }
|
||||
|
||||
describe '#translate' do
|
||||
stub_translations(
|
||||
start: {
|
||||
hello: 'Hello from start!',
|
||||
hi: 'Hi %{name} from start', # rubocop:disable Style/FormatStringToken
|
||||
},
|
||||
)
|
||||
|
||||
let(:controller) do
|
||||
double(
|
||||
controller_path: 'telegram/webhooks',
|
||||
@@ -10,12 +31,28 @@ RSpec.describe Telegram::Bot::UpdatesController::Translation do
|
||||
it 'uses action_name without ! for lazy translations' do
|
||||
expect(I18n).to receive(:translate).with('telegram.webhooks.start.hello',
|
||||
default: [:'telegram.webhooks.hello'],
|
||||
)
|
||||
controller.t('.hello')
|
||||
) { result }
|
||||
expect(controller.t('.hello')).to eq(result)
|
||||
|
||||
expect(I18n).to receive(:translate).with('telegram.webhooks.start.hi',
|
||||
default: [:'telegram.webhooks.hi'],
|
||||
name: 'Dude',
|
||||
) { result }
|
||||
expect(controller.t('.hi', name: 'Dude')).to eq(result)
|
||||
end
|
||||
|
||||
it 'translates' do
|
||||
expect(controller.t('.hello')).to eq('Hello from start!')
|
||||
expect(controller.t('.hi', name: 'Dude')).to eq('Hi Dude from start')
|
||||
end
|
||||
end
|
||||
|
||||
describe described_class::ClassMethods do
|
||||
stub_translations(
|
||||
hello: 'Hello!',
|
||||
hi: 'Hi %{name}', # rubocop:disable Style/FormatStringToken
|
||||
)
|
||||
|
||||
describe '#translate' do
|
||||
let(:controller_class) do
|
||||
double(controller_path: 'telegram/webhooks').
|
||||
@@ -23,8 +60,20 @@ RSpec.describe Telegram::Bot::UpdatesController::Translation do
|
||||
end
|
||||
|
||||
it 'uses controller_path for lazy translations' do
|
||||
expect(I18n).to receive(:translate).with('telegram.webhooks.hello', {})
|
||||
controller_class.t('.hello')
|
||||
expect(I18n).to receive(:translate) do |*args, **kwargs|
|
||||
# not using .with to support ruby 2.x and 3.x
|
||||
expect([*args, kwargs]).to eq(['telegram.webhooks.hello', {}])
|
||||
result
|
||||
end
|
||||
expect(controller_class.t('.hello')).to eq(result)
|
||||
|
||||
expect(I18n).to receive(:translate).with('telegram.webhooks.hi', name: 'Dude') { result }
|
||||
expect(controller_class.t('.hi', name: 'Dude')).to eq(result)
|
||||
end
|
||||
|
||||
it 'translates' do
|
||||
expect(controller_class.t('.hello')).to eq('Hello!')
|
||||
expect(controller_class.t('.hi', name: 'Dude')).to eq('Hi Dude')
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -9,14 +9,19 @@ RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate do
|
||||
|
||||
context 'when `update` is a virtus model' do
|
||||
subject { controller }
|
||||
unique_types = Telegram::Bot::UpdatesController::PAYLOAD_TYPES - %w[
|
||||
unique_types = (Telegram::Bot::UpdatesController::PAYLOAD_TYPES - %w[
|
||||
edited_message
|
||||
channel_post
|
||||
edited_channel_post
|
||||
]
|
||||
unique_types.each do |type|
|
||||
my_chat_member
|
||||
chat_member
|
||||
]).
|
||||
map { |x| [x, Telegram::Bot::Types.const_get(type.camelize)] }.to_h.
|
||||
merge(
|
||||
'chat_member' => Telegram::Bot::Types::ChatMemberUpdated
|
||||
)
|
||||
unique_types.each do |type, type_class|
|
||||
context "with #{type}" do
|
||||
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
||||
let(:payload_type) { type }
|
||||
let(:payload) do
|
||||
{}.tap do |result|
|
||||
|
||||
@@ -17,13 +17,10 @@ Gem::Specification.new do |spec|
|
||||
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
||||
spec.require_paths = ['lib']
|
||||
|
||||
spec.post_install_message = 'Breaking changes in v0.14! ' \
|
||||
'See upgrade guide at https://github.com/telegram-bot-rb/telegram-bot/wiki/Upgrading-to-0.14'
|
||||
spec.required_ruby_version = '>= 2.4'
|
||||
|
||||
spec.required_ruby_version = '~> 2.0'
|
||||
|
||||
spec.add_dependency 'actionpack', '>= 4.0', '< 6.1'
|
||||
spec.add_dependency 'activesupport', '>= 4.0', '< 6.1'
|
||||
spec.add_dependency 'actionpack', '>= 4.0', '< 6.2'
|
||||
spec.add_dependency 'activesupport', '>= 4.0', '< 6.2'
|
||||
spec.add_dependency 'httpclient', '~> 2.7'
|
||||
|
||||
spec.add_development_dependency 'bundler', '> 1.16'
|
||||
|
||||
Ссылка в новой задаче
Block a user