зеркало из
https://github.com/glebtv/telegram-bot.git
synced 2026-09-03 17:55:52 +03:00
Сравнить коммиты
2 Коммитов
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
d1d15d9910 | ||
|
|
e557a217eb |
@@ -1,8 +0,0 @@
|
|||||||
checks:
|
|
||||||
method-complexity:
|
|
||||||
config:
|
|
||||||
threshold: 6 # should be just fine
|
|
||||||
|
|
||||||
plugins:
|
|
||||||
rubocop:
|
|
||||||
enabled: true
|
|
||||||
3
.gitignore
поставляемый
3
.gitignore
поставляемый
@@ -1,12 +1,9 @@
|
|||||||
/.bundle/
|
/.bundle/
|
||||||
/.yardoc
|
/.yardoc
|
||||||
/Gemfile.lock
|
/Gemfile.lock
|
||||||
/gemfiles/*.lock
|
|
||||||
/gemfiles/.bundle
|
|
||||||
/_yardoc/
|
/_yardoc/
|
||||||
/coverage/
|
/coverage/
|
||||||
/doc/
|
/doc/
|
||||||
/pkg/
|
/pkg/
|
||||||
/spec/reports/
|
/spec/reports/
|
||||||
/log/
|
|
||||||
/tmp/
|
/tmp/
|
||||||
|
|||||||
42
.rubocop.yml
42
.rubocop.yml
@@ -1,55 +1,29 @@
|
|||||||
# Rubocop does not support 2.0
|
|
||||||
Gemspec/RequiredRubyVersion: {Enabled: false}
|
|
||||||
|
|
||||||
Rails: {Enabled: true}
|
Rails: {Enabled: true}
|
||||||
|
|
||||||
Layout/AlignParameters:
|
Style/Alias: {Enabled: false}
|
||||||
|
Style/AlignParameters:
|
||||||
# Disable, till rubocop supports combination of styles.
|
# Disable, till rubocop supports combination of styles.
|
||||||
# Use one of this styles where appropriate, keep it clean, compact and readable.
|
# Use one of this styles where appropriate, keep it clean, compact and readable.
|
||||||
Enabled: false
|
Enabled: false
|
||||||
# EnforcedStyle:
|
# EnforcedStyle:
|
||||||
# - with_first_parameter
|
# - with_first_parameter
|
||||||
# - with_fixed_indentation
|
# - with_fixed_indentation
|
||||||
|
|
||||||
# Breaks
|
|
||||||
#
|
|
||||||
# I18n.t(key,
|
|
||||||
# param: val,
|
|
||||||
# # ...
|
|
||||||
# )
|
|
||||||
Layout/ClosingParenthesisIndentation: {Enabled: false}
|
|
||||||
Layout/DotPosition: {EnforcedStyle: trailing}
|
|
||||||
Layout/FirstParameterIndentation: {EnforcedStyle: consistent}
|
|
||||||
# Same as Layout/ClosingParenthesisIndentation
|
|
||||||
Layout/MultilineMethodCallBraceLayout: {Enabled: false}
|
|
||||||
Layout/MultilineMethodCallIndentation: {EnforcedStyle: indented}
|
|
||||||
Layout/MultilineOperationIndentation: {EnforcedStyle: indented}
|
|
||||||
Layout/SpaceInsideHashLiteralBraces: {EnforcedStyle: no_space}
|
|
||||||
|
|
||||||
# Offences named scopes and `expect {}.to change {}`.
|
|
||||||
Lint/AmbiguousBlockAssociation: {Enabled: false}
|
|
||||||
|
|
||||||
Naming/PredicateName: {Enabled: false}
|
|
||||||
Naming/VariableNumber: {EnforcedStyle: snake_case}
|
|
||||||
|
|
||||||
Style/Alias: {Enabled: false}
|
|
||||||
Style/AndOr: {EnforcedStyle: conditionals}
|
Style/AndOr: {EnforcedStyle: conditionals}
|
||||||
|
Style/ClosingParenthesisIndentation: {Enabled: false}
|
||||||
Style/Documentation: {Enabled: false}
|
Style/Documentation: {Enabled: false}
|
||||||
|
Style/DotPosition: {EnforcedStyle: trailing}
|
||||||
|
Style/FirstParameterIndentation: {EnforcedStyle: consistent}
|
||||||
Style/IfUnlessModifier: {Enabled: false}
|
Style/IfUnlessModifier: {Enabled: false}
|
||||||
|
|
||||||
# Consistent to other definitions.
|
|
||||||
Style/EmptyMethod: {EnforcedStyle: expanded}
|
|
||||||
|
|
||||||
Style/ModuleFunction: {Enabled: false}
|
Style/ModuleFunction: {Enabled: false}
|
||||||
|
Style/MultilineOperationIndentation: {EnforcedStyle: indented}
|
||||||
Style/NestedParenthesizedCalls: {Enabled: false}
|
Style/NestedParenthesizedCalls: {Enabled: false}
|
||||||
|
Style/PredicateName: {Enabled: false}
|
||||||
Style/SignalException: {EnforcedStyle: only_raise}
|
Style/SignalException: {EnforcedStyle: only_raise}
|
||||||
|
Style/SpaceInsideHashLiteralBraces: {EnforcedStyle: no_space}
|
||||||
Style/TrailingCommaInArguments: {Enabled: false}
|
Style/TrailingCommaInArguments: {Enabled: false}
|
||||||
Style/TrailingCommaInLiteral: {EnforcedStyleForMultiline: comma}
|
Style/TrailingCommaInLiteral: {EnforcedStyleForMultiline: comma}
|
||||||
|
|
||||||
Metrics/AbcSize: {Max: 21}
|
Metrics/AbcSize: {Max: 21}
|
||||||
# Other metrics are just enough.
|
|
||||||
# This one offences all specs, routes and some initializers.
|
|
||||||
Metrics/BlockLength: {Enabled: false}
|
|
||||||
Metrics/LineLength: {Max: 100}
|
Metrics/LineLength: {Max: 100}
|
||||||
Metrics/MethodLength: {Max: 30}
|
Metrics/MethodLength: {Max: 30}
|
||||||
Metrics/CyclomaticComplexity: {Max: 8}
|
Metrics/CyclomaticComplexity: {Max: 8}
|
||||||
|
|||||||
27
.travis.yml
27
.travis.yml
@@ -1,31 +1,6 @@
|
|||||||
language: ruby
|
language: ruby
|
||||||
cache: bundler
|
cache: bundler
|
||||||
rvm:
|
rvm:
|
||||||
- 2.6
|
- 2.2.3
|
||||||
- 2.5
|
|
||||||
gemfile:
|
|
||||||
- gemfiles/rails_60.gemfile
|
|
||||||
- gemfiles/rails_52.gemfile
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
# old rails
|
|
||||||
- rvm: 2.5
|
|
||||||
gemfile: gemfiles/rails_51.gemfile
|
|
||||||
- rvm: 2.5
|
|
||||||
gemfile: gemfiles/rails_50.gemfile
|
|
||||||
- rvm: 2.5
|
|
||||||
gemfile: gemfiles/rails_42.gemfile
|
|
||||||
# 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:
|
notifications:
|
||||||
email: false
|
email: false
|
||||||
|
|||||||
31
Appraisals
31
Appraisals
@@ -1,31 +0,0 @@
|
|||||||
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
|
|
||||||
end
|
|
||||||
|
|
||||||
appraise 'rails-60' do
|
|
||||||
gem 'actionpack', '~> 6.0.0'
|
|
||||||
gem 'railties', '~> 6.0.0'
|
|
||||||
end
|
|
||||||
|
|
||||||
appraise 'rails-52' do
|
|
||||||
gem 'actionpack', '~> 5.2.0'
|
|
||||||
gem 'railties', '~> 5.2.0'
|
|
||||||
end
|
|
||||||
|
|
||||||
appraise 'rails-51' do
|
|
||||||
gem 'actionpack', '~> 5.1.0'
|
|
||||||
gem 'railties', '~> 5.1.0'
|
|
||||||
end
|
|
||||||
|
|
||||||
appraise 'rails-50' do
|
|
||||||
gem 'actionpack', '~> 5.0.0'
|
|
||||||
gem 'railties', '~> 5.0.0'
|
|
||||||
end
|
|
||||||
|
|
||||||
appraise 'rails-42' do
|
|
||||||
gem 'actionpack', '~> 4.2.0'
|
|
||||||
gem 'railties', '~> 4.2.0'
|
|
||||||
end
|
|
||||||
135
CHANGELOG.md
135
CHANGELOG.md
@@ -1,137 +1,4 @@
|
|||||||
# Unreleased
|
# 0.7.1
|
||||||
|
|
||||||
- Rails 6.0 support.
|
|
||||||
- Update to Bot API 4.4.
|
|
||||||
|
|
||||||
# 0.14.2
|
|
||||||
|
|
||||||
- Add reply helpers: `answer_pre_checkout_query`, `answer_shipping_query`.
|
|
||||||
- Update to Bot API 4.3.
|
|
||||||
|
|
||||||
# 0.14.1
|
|
||||||
|
|
||||||
- Read config from secrets when credentials don't provide it in rails >= 5.2.
|
|
||||||
- Remove botan.io support. It's already shut down, so it should not be a braking change.
|
|
||||||
https://github.com/botanio/sdk#this-service-will-be-shut-down-on-25th-may-2018
|
|
||||||
- Update to Bot API 4.1.
|
|
||||||
|
|
||||||
# 0.14.0
|
|
||||||
|
|
||||||
- Make integration & controller specs consistent.
|
|
||||||
__Breaking changes__ for controller specs:
|
|
||||||
- Changed signature `dispatch(bot, update) => dispatch(update, bot)`.
|
|
||||||
- `update` helper is symbolized by default.
|
|
||||||
- `build_update(type, data)` is dropped in favor of `deep_stringify(type => data)`.
|
|
||||||
- Provide support for integration testing of bots in poller mode and non-Rails apps.
|
|
||||||
__Breaking changes__:
|
|
||||||
- Requiring `telegram/bot/rspec/integration` is deprecated in favor of
|
|
||||||
`telegram/bot/rspec/integration/rails`.
|
|
||||||
- `:telegram_bot` rspec tag is replaced with `telegram_bot: :rails`.
|
|
||||||
- __Breaking change__. Use bang-methods as actions for commands.
|
|
||||||
This prevents calling context contextual actions and payload specific actions with commands.
|
|
||||||
Translation helper strips `!` from action name for lazy translations.
|
|
||||||
- __Breaking change__. Drop `.context_handler`, `.context_to_action!` methods.
|
|
||||||
Use pass action name directly to `#save_context`.
|
|
||||||
It's the same as `.context_to_action!` is enabled by default.
|
|
||||||
- Class-level helper for lazy translations.
|
|
||||||
|
|
||||||
# 0.13.1
|
|
||||||
|
|
||||||
- Extracted typed response mappings to telegram-bot-types gem.
|
|
||||||
It now provides definitions for all API v3.5 methods.
|
|
||||||
- Fix #chat for non-message updates with TypedUpdates enabled
|
|
||||||
|
|
||||||
# 0.13.0
|
|
||||||
|
|
||||||
- `rescue_from`.
|
|
||||||
- Support for `credentials` store in Rails 5.2.
|
|
||||||
- Deprecate `telegram_webhooks` in favor of `telegram_webhook`.
|
|
||||||
It was too complicated and such routes looked ugly.
|
|
||||||
|
|
||||||
# 0.12.4
|
|
||||||
|
|
||||||
- Fix spec helpers for callback queries.
|
|
||||||
|
|
||||||
# 0.12.3
|
|
||||||
|
|
||||||
- New methods from Bot API v3.5
|
|
||||||
- Collect all api helper-methods in Client::ApiHelper module.
|
|
||||||
- Add `bin/fetch-telegram-methods` to update API methods list from website.
|
|
||||||
|
|
||||||
# 0.12.1
|
|
||||||
|
|
||||||
- Fix `set_webhook` rake task for async bots with self-issued certificates.
|
|
||||||
- Make `#session` raise error when store is not configured,
|
|
||||||
don't use Rails.cache as fallback for session_store.
|
|
||||||
- Allow use different sessions for MessageContext.
|
|
||||||
|
|
||||||
# 0.12.0
|
|
||||||
|
|
||||||
- New API methods and payload types (up to Bot API 3.2).
|
|
||||||
- Fix rails 5.1.x support.
|
|
||||||
- RSpec context for callback_query updates.
|
|
||||||
- `edit_message` helper.
|
|
||||||
- ClientStub saves and returns token. Fixes testing multiple bots.
|
|
||||||
- Raise descriptive error when accessing not-configured bot.
|
|
||||||
|
|
||||||
# 0.11.3
|
|
||||||
|
|
||||||
- Release dependencies for Rails 5.1.
|
|
||||||
|
|
||||||
# 0.11.2
|
|
||||||
|
|
||||||
- Rails 5.1 deep symbolized secrets support.
|
|
||||||
|
|
||||||
# 0.11.1
|
|
||||||
|
|
||||||
- Fixed poller for typed response.
|
|
||||||
|
|
||||||
# 0.11.0
|
|
||||||
|
|
||||||
- Remove Bot::StaleChat in favor of Bot::Forbidden, as Telegram adds more
|
|
||||||
and more new descriptions.
|
|
||||||
Please open an issue if you face a problem.
|
|
||||||
|
|
||||||
# 0.10.2
|
|
||||||
|
|
||||||
- Support `(edited_)channel_post` updates.
|
|
||||||
- New methods from 2.3, 2.3.1 API updates.
|
|
||||||
|
|
||||||
# 0.10.0
|
|
||||||
|
|
||||||
- Integration helpers for RSpec.
|
|
||||||
- Fix for ruby 2.2.0 bug by @bob-frost.
|
|
||||||
|
|
||||||
# 0.9.0
|
|
||||||
|
|
||||||
- Async API requests.
|
|
||||||
- One more description for StaleChat error.
|
|
||||||
- edit_message_* methods.
|
|
||||||
- API methods from 2016-10-03 update
|
|
||||||
- Fix typo in module name: CallbackQueyContext -> CallbackQueryContext.
|
|
||||||
- Take `chat` from `message` for callback queries
|
|
||||||
- RSpec matchers.
|
|
||||||
|
|
||||||
# 0.8.0
|
|
||||||
|
|
||||||
- Fixed `#reply_with`, now it sets `reply_to_message_id` as it's supposed to.
|
|
||||||
Added `#respond_with` which works the same way, but doesn't set `reply_to_message_id`.
|
|
||||||
Please, replace all occurrences of `reply_with` to `respond_with` to
|
|
||||||
keep it working the old way.
|
|
||||||
- Fixes for Rails 5:
|
|
||||||
- Controller callbacks
|
|
||||||
- Middleware
|
|
||||||
- Setup travis builds
|
|
||||||
|
|
||||||
# 0.7.4
|
|
||||||
|
|
||||||
- Rails 5 support by @dreyks (#4).
|
|
||||||
|
|
||||||
# 0.7.3
|
|
||||||
|
|
||||||
- Fixed issues with poller in production (#3)
|
|
||||||
|
|
||||||
# 0.7.2
|
|
||||||
|
|
||||||
- Bot API 2.1
|
- Bot API 2.1
|
||||||
- Fixed possible crashes when payload type is not supported.
|
- Fixed possible crashes when payload type is not supported.
|
||||||
|
|||||||
11
Gemfile
11
Gemfile
@@ -2,19 +2,16 @@ source 'https://rubygems.org'
|
|||||||
gemspec
|
gemspec
|
||||||
|
|
||||||
group :development do
|
group :development do
|
||||||
gem 'appraisal', '~> 2.2'
|
gem 'sdoc', '~> 0.4.1'
|
||||||
|
|
||||||
gem 'pry', '~> 0.10.1'
|
gem 'pry', '~> 0.10.1'
|
||||||
gem 'pry-byebug', '~> 3.2.0'
|
gem 'pry-byebug', '~> 3.2.0'
|
||||||
gem 'sdoc', '~> 0.4.1'
|
|
||||||
|
|
||||||
gem 'telegram-bot-types', '~> 0.6.0'
|
gem 'telegram-bot-types', '~> 0.2.0'
|
||||||
|
|
||||||
gem 'rspec', '~> 3.5.0'
|
gem 'rspec', '~> 3.3.0'
|
||||||
gem 'rspec-its', '~> 1.1.0'
|
gem 'rspec-its', '~> 1.1.0'
|
||||||
gem 'rspec-rails', '~> 3.5.0'
|
|
||||||
|
|
||||||
gem 'rubocop', '~> 0.52.1'
|
gem 'rubocop', '~> 0.37.0'
|
||||||
|
|
||||||
gem 'coveralls', '~> 0.8.2', require: false
|
gem 'coveralls', '~> 0.8.2', require: false
|
||||||
end
|
end
|
||||||
|
|||||||
506
README.md
506
README.md
@@ -4,33 +4,23 @@
|
|||||||
[](https://codeclimate.com/github/telegram-bot-rb/telegram-bot)
|
[](https://codeclimate.com/github/telegram-bot-rb/telegram-bot)
|
||||||
[](https://travis-ci.org/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).
|
Tools for developing bot for Telegram. Best used with Rails, but can be be used in
|
||||||
|
standalone app. Supposed to be used in webhook-mode in production, and poller-mode
|
||||||
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).
|
|
||||||
Supposed to be used in webhook-mode in production, and poller-mode
|
|
||||||
in development, but you can use poller in production if you want.
|
in development, but you can use poller in production if you want.
|
||||||
|
|
||||||
Package contains:
|
Package contains:
|
||||||
|
|
||||||
- Lightweight client for bot API (with fast and thread-safe
|
- Ligthweight client for bot API (with fast and thread-safe
|
||||||
[httpclient](https://github.com/nahi/httpclient) under the hood).
|
[httpclient](https://github.com/nahi/httpclient) under the hood).
|
||||||
- Controller with message parser: define methods for commands, not `case` branches.
|
- Controller with message parser. Allows to write separate methods for each command.
|
||||||
- Middleware and routes helpers for production env.
|
- Middleware and routes helpers for production env.
|
||||||
- Poller with automatic source-reloader for development env.
|
- Poller with automatic source-reloader for development env.
|
||||||
- Rake tasks to update webhook urls.
|
- Rake tasks to update webhook urls.
|
||||||
- __[Async mode](#async-mode)__.
|
|
||||||
Let the queue adapter handle network errors!
|
|
||||||
|
|
||||||
Here is sample [telegram_bot_app](https://github.com/telegram-bot-rb/telegram_bot_app)
|
Here is sample [telegram_bot_app](https://github.com/telegram-bot-rb/telegram_bot_app)
|
||||||
with session, keyboards and inline queries.
|
with session, keyboards and inline queries.
|
||||||
Run it on your local machine in 1 minute!
|
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.
|
|
||||||
|
|
||||||
Examples and cookbook in [wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Add this line to your application's Gemfile:
|
Add this line to your application's Gemfile:
|
||||||
@@ -47,100 +37,51 @@ Or install it yourself as:
|
|||||||
|
|
||||||
$ gem install telegram-bot
|
$ gem install telegram-bot
|
||||||
|
|
||||||
Require if necessary:
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
require 'telegram/bot'
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
While clients can be instantiated explicitly, there is `Telegram.bots_config=` method
|
Add `telegram` section into `secrets.yml`:
|
||||||
to configure app-wide clients, which are accessible via `Telegram.bots`.
|
|
||||||
It accepts hash of `{bot_id: bot_config}`, and there is special id `:default`
|
|
||||||
which is used for `Telegram.bot`.
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
Telegram.bots_config = {
|
|
||||||
default: DEFAULT_BOT_TOKEN,
|
|
||||||
chat: {token: CHAT_BOT_TOKEN, username: 'chatbot'},
|
|
||||||
}
|
|
||||||
|
|
||||||
Telegram.bot.get_updates
|
|
||||||
Telegram.bot == Telegram.bots[:default] # true
|
|
||||||
Telegram.bots[:chat].send_message(...)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Configuration in Rails app
|
|
||||||
|
|
||||||
In Rails app `Telegram.bots_config` is read from `secrets.yml` automatically
|
|
||||||
from `telegram` section:
|
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
development:
|
telegram:
|
||||||
telegram:
|
bots:
|
||||||
# Single bot can be specified like this
|
# just set the token
|
||||||
bot: TOKEN
|
chat: TOKEN_1
|
||||||
# or
|
# or add username to support commands with mentions (/help@ChatBot)
|
||||||
bot:
|
auction:
|
||||||
token: TOKEN
|
token: TOKEN_2
|
||||||
username: SomeBot
|
username: ChatBot
|
||||||
|
|
||||||
# For multiple bots in single app use hash of `internal_bot_id => settings`
|
# Single bot can be specified like this
|
||||||
bots:
|
bot: TOKEN
|
||||||
# just set the bot token
|
# or
|
||||||
chat: TOKEN_1
|
bot:
|
||||||
# or add username to support commands with mentions (/help@ChatBot)
|
token: TOKEN
|
||||||
auction:
|
username: SomeBot
|
||||||
token: TOKEN_2
|
|
||||||
username: ChatBot
|
|
||||||
```
|
```
|
||||||
|
|
||||||
For Rails >= 5.2 `Telegram::Bot` searches for config first in credentials and then in secrets.
|
### Client
|
||||||
To use credentials as config store, add telegram section to credentials instead of secrets using
|
|
||||||
`rails credentials:edit`. In this case be aware of that [Rails < 6.0 may not load
|
|
||||||
credentials in dev environment by default](https://github.com/telegram-bot-rb/telegram-bot/issues/74#issuecomment-384205609).
|
|
||||||
In Rails >= 6.0 run `rails credentials:edit --environment development` to configure bot
|
|
||||||
in each environment.
|
|
||||||
|
|
||||||
I suggest not using Rails 5.2 credentials because it can lead to leakage of sensitive data
|
|
||||||
and it's more difficult to use in multiple environments. See
|
|
||||||
[secure_credentials](https://github.com/printercu/secure_credentials) gem for better option.
|
|
||||||
|
|
||||||
From now clients will be accessible with `Telegram.bots[:chat]` or `Telegram.bots[:auction]`.
|
From now clients will be accessible with `Telegram.bots[:chat]` or `Telegram.bots[:auction]`.
|
||||||
Single bot can be accessed with `Telegram.bot` or `Telegram.bots[:default]`.
|
Single bot can be accessed with `Telegram.bot` or `Telegram.bots[:default]`.
|
||||||
|
|
||||||
### Client
|
You can create clients manually with `Telegram::Bot::Client.new(token, username)`.
|
||||||
|
|
||||||
Client is instantiated with `Telegram::Bot::Client.new(token, username)`.
|
|
||||||
Username is optional and used only to parse commands with mentions.
|
Username is optional and used only to parse commands with mentions.
|
||||||
|
|
||||||
There is `request(path_suffix, body)` method to perform any query.
|
There is `request(path_suffix, body)` method to perform any query.
|
||||||
And there are shortcuts for all available requests in underscored style
|
And there are also shortcuts for available queries in underscored style
|
||||||
(`answer_inline_query(params)` instead of `answerInlineQuery`).
|
(`answer_inline_query` instead of `answerInlineQuery`).
|
||||||
|
All this methods just post given params to specific URL.
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
bot.request(:getMe) or bot.get_me
|
bot.request(:getMe) or bot.get_me
|
||||||
bot.request(:getupdates, offset: 1) or bot.get_updates(offset: 1)
|
bot.request(:getupdates, offset: 1) or bot.get_updates(offset: 1)
|
||||||
bot.send_message(chat_id: chat_id, text: 'Test')
|
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.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
#### Typed responses
|
|
||||||
|
|
||||||
By default client will return parsed json responses. You can enable
|
By default client will return parsed json responses. You can enable
|
||||||
response typecasting to virtus models using
|
response typecasting to virtus models using `telegram-bot-types` gem:
|
||||||
[`telegram-bot-types`](https://github.com/telegram-bot-rb/telegram-bot-types) gem:
|
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
# Add to your gemfile:
|
# Add to your gemfile:
|
||||||
gem 'telegram-bot-types', '~> x.x.x'
|
gem 'telegram-bot-types', '~> x.x.x'
|
||||||
@@ -152,26 +93,18 @@ bot.extend Telegram::Bot::Client::TypedResponse
|
|||||||
bot.get_me.class # => Telegram::Bot::Types::User
|
bot.get_me.class # => Telegram::Bot::Types::User
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Any API request error will raise `Telegram::Bot::Error` with description in its message.
|
||||||
|
Special `Telegram::Bot::StaleChat` is raised when bot can't post messages to the chat anymore.
|
||||||
|
|
||||||
### Controller
|
### Controller
|
||||||
|
|
||||||
Controller makes it easy to keep bot's code readable.
|
|
||||||
It does nothing more than finding out action name for update and invoking it.
|
|
||||||
So there is almost no overhead comparing to large `switch`, while you
|
|
||||||
can represent actions as separate methods keeping source much more readable and supportable.
|
|
||||||
|
|
||||||
New instance of controller is instantiated for each update.
|
|
||||||
This way every update is processed in isolation from others.
|
|
||||||
|
|
||||||
Bot controllers like usual rails controllers provides features like callbacks,
|
|
||||||
`rescue_from` and instrumentation.
|
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
# use callbacks like in any other controllers
|
# use callbacks like in any other controllers
|
||||||
around_action :with_locale
|
around_action :with_locale
|
||||||
|
|
||||||
# Every update can have one of: message, inline_query, chosen_inline_result,
|
# Every update can have one of: message, inline_query, chosen_inline_result,
|
||||||
# callback_query, etc.
|
# callback_query.
|
||||||
# Define method with same name to respond to this updates.
|
# Define method with same name to respond to this updates.
|
||||||
def message(message)
|
def message(message)
|
||||||
# message can be also accessed via instance method
|
# message can be also accessed via instance method
|
||||||
@@ -186,20 +119,21 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
|||||||
# chosen_inline_result(result_id, query)
|
# chosen_inline_result(result_id, query)
|
||||||
# callback_query(data)
|
# callback_query(data)
|
||||||
|
|
||||||
# Define public methods ending with `!` to handle commands.
|
# Define public methods to respond to commands.
|
||||||
# Command arguments will be parsed and passed to the method.
|
# Command arguments will be parsed and passed to the method.
|
||||||
# Be sure to use splat args and default values to not get errors when
|
# Be sure to use splat args and default values to not get errors when
|
||||||
# someone passed more or less arguments in the message.
|
# someone passed more or less arguments in the message.
|
||||||
def start!(data = nil, *)
|
#
|
||||||
|
# For some commands like /message or /123 method names should start with
|
||||||
|
# `on_` to avoid conflicts.
|
||||||
|
def start(data = nil, *)
|
||||||
# do_smth_with(data)
|
# do_smth_with(data)
|
||||||
|
|
||||||
# There are `chat` & `from` shortcut methods.
|
# There are `chat` & `from` shortcut methods.
|
||||||
# For callback queries `chat` if taken from `message` when it's available.
|
|
||||||
response = from ? "Hello #{from['username']}!" : 'Hi there!'
|
response = from ? "Hello #{from['username']}!" : 'Hi there!'
|
||||||
# There is `respond_with` helper to set `chat_id` from received message:
|
# There is `reply_with` helper to set basic fields
|
||||||
respond_with :message, text: response
|
# like `reply_to_message` & `chat_id`.
|
||||||
# `reply_with` also sets `reply_to_message_id`:
|
reply_with :message, text: response
|
||||||
reply_with :photo, photo: File.open('party.jpg')
|
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
@@ -218,27 +152,10 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Reply helpers
|
|
||||||
|
|
||||||
There are helpers to respond for basic actions. They just set chat/message/query
|
|
||||||
identifiers from 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:
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
def respond_with(type, params); end
|
|
||||||
def reply_with(type, params); end
|
|
||||||
def answer_inline_query(results, params = {}); end
|
|
||||||
def answer_callback_query(text, params = {}); end
|
|
||||||
def edit_message(type, params = {}); end
|
|
||||||
def answer_pre_checkout_query(ok, params = {}); end
|
|
||||||
def answer_shipping_query(ok, params = {}); end
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Optional typecasting
|
#### Optional typecasting
|
||||||
|
|
||||||
You can enable typecasting of `update` with `telegram-bot-types` by including
|
You can enable typecasting of `update` with `telegram-bot-types` by including
|
||||||
`Telegram::Bot::UpdatesController::TypedUpdate`:
|
`Telegram::Bot::UpdatesPoller::TypedUpdate`:
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
@@ -252,56 +169,35 @@ end
|
|||||||
|
|
||||||
#### Session
|
#### Session
|
||||||
|
|
||||||
This API is very close to ActiveController's session API, but works different
|
There is support for sessions using `ActiveSupport::Cache` stores.
|
||||||
under the hood. Cookies can not be used to store session id or
|
|
||||||
whole session (like CookieStore does). So it uses key-value store and `session_key`
|
|
||||||
method to build identifier from update.
|
|
||||||
|
|
||||||
Store can be one of numerous `ActiveSupport::Cache` stores.
|
|
||||||
While `:file_store` is suitable for development and single-server deployments
|
|
||||||
without heavy load, it doesn't scale well. Key-value databases with persistance
|
|
||||||
like Redis are more appropriate for production use.
|
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
# In rails app store can be configured in env files:
|
# configure store in env files:
|
||||||
config.telegram_updates_controller.session_store = :redis_store, {expires_in: 1.month}
|
config.telegram_updates_controller.session_store = :redis_store, {expires_in: 1.month}
|
||||||
|
|
||||||
# In other app it can be done for all controllers with:
|
|
||||||
Telegram::Bot::UpdatesController.session_store = :redis_store, {expires_in: 1.month}
|
|
||||||
# or for specific one:
|
|
||||||
OneOfUpdatesController.session_store = :redis_store, {expires_in: 1.month}
|
|
||||||
```
|
|
||||||
|
|
||||||
Default session id is made from bot's username and `(from || chat)['id']`.
|
|
||||||
It means that session will be the same for updates from user in every chat,
|
|
||||||
and different for every user in the same group chat.
|
|
||||||
To change this behavior you can override `session_key` method, or even
|
|
||||||
define [multiple sessions](https://github.com/telegram-bot-rb/telegram-bot/wiki/Multiple-session-objects)
|
|
||||||
in single controller. For details see `Session` module.
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
include Telegram::Bot::UpdatesController::Session
|
include Telegram::Bot::UpdatesController::Session
|
||||||
# or just shortcut:
|
# or just shortcut:
|
||||||
use_session!
|
use_session!
|
||||||
|
|
||||||
# You can override global config for this controller.
|
# You can override global config
|
||||||
self.session_store = :file_store
|
self.session_store = :file_store
|
||||||
|
|
||||||
def write!(text = nil, *)
|
def write(text = nil, *)
|
||||||
session[:text] = text
|
session[:text] = text
|
||||||
end
|
end
|
||||||
|
|
||||||
def read!(*)
|
def read
|
||||||
respond_with :message, text: session[:text]
|
reply_with :message, text: session[:text]
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
# By default it uses bot's username and user's id as a session key.
|
||||||
# In this case session will persist for user only in specific chat.
|
# Chat's id is used only when `from` field is empty.
|
||||||
# Same user in other chat will have different session.
|
# Override `session_key` method to change this behavior.
|
||||||
def session_key
|
def session_key
|
||||||
"#{bot.username}:#{chat['id']}:#{from['id']}" if chat && from
|
# In this case session will persist for user only in specific chat:
|
||||||
|
"#{bot.username}:#{chat['id']}:#{from['id']}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
@@ -315,251 +211,171 @@ it asks you for additional argument. There is `MessageContext` for this:
|
|||||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
include Telegram::Bot::UpdatesController::MessageContext
|
include Telegram::Bot::UpdatesController::MessageContext
|
||||||
|
|
||||||
def rename!(*)
|
def rename(*)
|
||||||
# set context for the next message
|
# set context for the next message
|
||||||
save_context :rename_from_message
|
save_context :rename
|
||||||
respond_with :message, text: 'What name do you like?'
|
reply_with :message, text: 'What name do you like?'
|
||||||
end
|
end
|
||||||
|
|
||||||
# register context handlers to handle this context
|
# register context handlers to handle this context
|
||||||
def rename_from_message(*words)
|
context_handler :rename do |*words|
|
||||||
update_name words[0]
|
update_name words[0]
|
||||||
respond_with :message, text: 'Renamed!'
|
reply_with :message, text: 'Renamed!'
|
||||||
end
|
end
|
||||||
|
|
||||||
# You can use same action name as context name:
|
# You can do it in other way:
|
||||||
def rename!(name = nil, *)
|
def rename(name = nil, *)
|
||||||
if name
|
if name
|
||||||
update_name name
|
update_name name
|
||||||
respond_with :message, text: 'Renamed!'
|
reply_with :message, text: 'Renamed!'
|
||||||
else
|
else
|
||||||
save_context :rename!
|
save_context :rename
|
||||||
respond_with :message, text: 'What name do you like?'
|
reply_with :message, text: 'What name do you like?'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This will call #rename like if it is called with message '/rename %text%'
|
||||||
|
context_handler :rename
|
||||||
|
|
||||||
|
# If you have a lot of such methods you can use
|
||||||
|
context_to_action!
|
||||||
|
# It'll use context value as action name for all contexts which miss handlers.
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Callback queries
|
You can use `CallbackQueyContext` in the similar way to split `#callback_query` into
|
||||||
|
several specific methods. It doesn't require session support, and takes context from
|
||||||
You can include `CallbackQueryContext` module to split `#callback_query` into
|
data. If data has a prefix with colon like this `my_ctx:smth...` it'll call
|
||||||
several methods. It doesn't require session support, and takes context from
|
`my_ctx_callback_query('smth...')` when there is such action method. Otherwise
|
||||||
data: if data has a prefix with colon like this `my_ctx:smth...` it invokes
|
it'll call `callback_query('my_ctx:smth...')` as usual.
|
||||||
`my_ctx_callback_query('smth...')` when such action method is defined. Otherwise
|
|
||||||
it invokes `callback_query('my_ctx:smth...')` as usual.
|
|
||||||
Callback queries without prefix stay untouched.
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
# This one handles `set_value:%{something}`.
|
|
||||||
def set_value_callback_query(new_value = nil, *)
|
|
||||||
save_this(value)
|
|
||||||
answer_callback_query('Saved!')
|
|
||||||
end
|
|
||||||
|
|
||||||
# And this one is for `make_cool:%{something}`
|
|
||||||
def make_cool_callback_query(thing = nil, *)
|
|
||||||
do_it(thing)
|
|
||||||
answer_callback_query("#{thing} is cool now! Like a callback query context.")
|
|
||||||
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.
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
# Most off apps would require
|
|
||||||
telegram_webhook TelegramController
|
|
||||||
# which is same as
|
|
||||||
telegram_webhook TelegramController, :default
|
|
||||||
|
|
||||||
# Use different controllers for each bot:
|
|
||||||
telegram_webhook TelegramChatController, :chat
|
|
||||||
telegram_webhook TelegramAuctionController, :auction
|
|
||||||
|
|
||||||
# Defined route is named and its name depends on `Telegram.bots`.
|
|
||||||
# For single bot it will use 'telegram_webhook',
|
|
||||||
# for multiple bots it uses bot's key in the `Telegram.bots` as prefix
|
|
||||||
# (eg. `chat_telegram_webhook`).
|
|
||||||
# You can override this with `as` option:
|
|
||||||
telegram_webhook TelegramController, as: :custom_telegram_webhook
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Processesing updates
|
#### Processesing updates
|
||||||
|
|
||||||
To process update with controller call `.dispatch(bot, update)` on it.
|
To process update run:
|
||||||
There are several options to run it automatically:
|
|
||||||
|
|
||||||
- Use webhooks with routes helper (described above).
|
|
||||||
- Use `Telegram::Bot::Middleware` with rack ([example in wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki/Not-rails-application)).
|
|
||||||
- Use poller (described in the next section).
|
|
||||||
|
|
||||||
To run action without update (ex., send notifications from jobs),
|
|
||||||
you can call `#process` directly. In this case controller can be initialized
|
|
||||||
with `:from` and/or `:chat` options instead of `update` object:
|
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
controller = ControllerClass.new(bot, from: telegram_user, chat: telegram_chat)
|
ControllerClass.dispatch(bot, update)
|
||||||
controller.process(:welcome, *args)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
There is also ability to run action without update:
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
# Most likely you'll want to pass :from and :chat
|
||||||
|
controller = ControllerClass.new(bot, from: telegram_user, chat: telegram_chat)
|
||||||
|
controller.process(:help, *args)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Routes
|
||||||
|
|
||||||
|
Use `telegram_webhooks` helper to add routes. It will create routes for bots
|
||||||
|
at "telegram/#{bot.token}" path.
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
# Create routes for all Telegram.bots to use same controller:
|
||||||
|
telegram_webhooks TelegramController
|
||||||
|
|
||||||
|
# Or pass custom bots usin any of supported config options:
|
||||||
|
telegram_webhooks TelegramController,
|
||||||
|
bot,
|
||||||
|
{token: token, username: username},
|
||||||
|
other_bot_token
|
||||||
|
|
||||||
|
# Use different controllers for each bot:
|
||||||
|
telegram_webhooks bot => TelegramChatController,
|
||||||
|
other_bot => TelegramAuctionController
|
||||||
|
|
||||||
|
# telegram_webhooks creates named routes.
|
||||||
|
# Route name depends on `Telegram.bots`.
|
||||||
|
# When there is single bot it will use 'telegram_webhook'.
|
||||||
|
# When there are it will use bot's key in the `Telegram.bots` as prefix
|
||||||
|
# (eg. `chat_telegram_webhook`).
|
||||||
|
# You can override this options or specify others:
|
||||||
|
telegram_webhooks TelegramController, as: :my_webhook
|
||||||
|
telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
||||||
|
other_bot => TelegramAuctionController,
|
||||||
|
admin_chat: TelegramAdminChatController
|
||||||
|
```
|
||||||
|
|
||||||
|
For Rack applications you can also use `Telegram::Bot::Middleware` or just
|
||||||
|
call `.dispatch(bot, update)` on controller.
|
||||||
|
|
||||||
### Development & Debugging
|
### Development & Debugging
|
||||||
|
|
||||||
Use `rake telegram:bot:poller` to run poller in rails app. It automatically loads
|
Use `rake telegram:bot:poller` to run poller. It'll automatically load
|
||||||
changes without restart in development env.
|
changes without restart in development env. Optionally specify bot to run poller for
|
||||||
Optionally pass bot id in `BOT` envvar (`BOT=chat`) to specify bot to run poller for.
|
with `BOT` envvar (`BOT=chat`).
|
||||||
|
|
||||||
This task requires `telegram_webhook` helper to be used as it connects bots with controller.
|
This task will not work if you don't use `telegram_webhooks`.
|
||||||
To run poller in other cases use:
|
You can run poller manually with
|
||||||
|
`Telegram::Bot::UpdatesPoller.start(bot, controller_class)`.
|
||||||
```ruby
|
|
||||||
Telegram::Bot::UpdatesPoller.start(bot, controller_class)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
There is a `Telegram::Bot::ClientStub` class to stub client for tests.
|
There is `Telegram::Bot::ClientStub` class to stub client for tests.
|
||||||
Instead of performing API requests it stores them in a `requests` hash.
|
Instead of performing API requests it stores them in `requests` hash.
|
||||||
|
|
||||||
To stub all possible clients use `Telegram::Bot::ClientStub.stub_all!` before
|
To stub all possible clients use `Telegram::Bot::ClientStub.stub_all!` before
|
||||||
initializing clients. Here is a template for RSpec:
|
initializing clients. Most likely you'll want something like this:
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
# environments/test.rb
|
|
||||||
# Make sure to run it before defining routes or accessing any bot in the app!
|
|
||||||
Telegram.reset_bots
|
|
||||||
Telegram::Bot::ClientStub.stub_all!
|
|
||||||
|
|
||||||
# rails_helper.rb
|
|
||||||
RSpec.configure do |config|
|
RSpec.configure do |config|
|
||||||
# ...
|
# ...
|
||||||
|
Telegram.reset_bots
|
||||||
|
Telegram::Bot::ClientStub.stub_all!
|
||||||
config.after { Telegram.bot.reset }
|
config.after { Telegram.bot.reset }
|
||||||
# or for multiple bots:
|
|
||||||
config.after { Telegram.bots.each_value(&:reset) }
|
|
||||||
# ...
|
# ...
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
RSpec contexts and helpers are included automatically for groups and examples with matching
|
There are also some helpers for controller tests.
|
||||||
tags. In RSpec < 3.4 it's required to use `include_context` explicitly.
|
Check out `telegram/bot/updates_controller/rspec_helpers` and
|
||||||
See [list of available helpers](https://github.com/telegram-bot-rb/telegram-bot/tree/master/lib/telegram/bot/rspec)
|
`telegram/bot/updates_controller/testing`.
|
||||||
for details.
|
|
||||||
|
|
||||||
There are 3 types of integration tests:
|
### Deploying
|
||||||
|
|
||||||
- `:rails` - for testing bot in webhooks-mode in Rails application.
|
Use `rake telegram:bot:set_webhook` to update webhook url for all configured bots.
|
||||||
It simulates webhook requests POSTing data to controller's endpoint.
|
Certificate can be specified with `CERT=path/to/cert`.
|
||||||
It works on the top of requests specs, so `rspec-rails` gem is required.
|
|
||||||
- `:rack` - For testing bot in webhooks-mode in non-Rails application.
|
|
||||||
It uses `rack-test` gem to POST requests to bot's endpoint.
|
|
||||||
- `:poller` - Calls `.dispatch` directly on controller class.
|
|
||||||
|
|
||||||
Pick the appropriate one, then require `telegram/bot/rspec/integration/#{type}`
|
### Botan.io metrics
|
||||||
and mark spec group with tag `telegram_bot: type`. See configuration options
|
|
||||||
for each type in
|
|
||||||
[telegram/bot/rspec/integration/](https://github.com/telegram-bot-rb/telegram-bot/tree/master/lib/telegram/bot/rspec/integration).
|
|
||||||
|
|
||||||
Here is an example test for a Rails app:
|
Initialize with `bot = Telegram::Bot::Client.new(token, botan: 'botan token')`
|
||||||
|
or just add `botan` key in `secrets.yml`:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
telegram:
|
||||||
|
bot:
|
||||||
|
token: bot_token
|
||||||
|
botan: botan_token
|
||||||
|
```
|
||||||
|
|
||||||
|
Access to Botan client with `bot.botan`.
|
||||||
|
Use `bot.botan.track(event, uid, payload)` to track events.
|
||||||
|
|
||||||
|
There are some helpers for controllers in `Telegram::Bot::UpdatesController::Botan`:
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
# spec/requests/telegram_webhooks_spec.rb
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
require 'telegram/bot/rspec/integration/rails'
|
include Telegram::Bot::UpdatesController::Botan
|
||||||
|
|
||||||
RSpec.describe TelegramWebhooksController, telegram_bot: :rails do
|
# This will track with event: action_name & data: payload
|
||||||
# for old RSpec:
|
before_action :botan_track_action
|
||||||
# include_context 'telegram/bot/integration/rails'
|
|
||||||
|
|
||||||
# Main method is #dispatch(update). Some helpers are:
|
def smth(*)
|
||||||
# dispatch_message(text, options = {})
|
# This will track event for current user only when botan is configured.
|
||||||
# dispatch_command(cmd, *args)
|
botan_track :my_event, custom_data
|
||||||
|
|
||||||
# Available matchers can be found in Telegram::Bot::RSpec::ClientMatchers.
|
# or get access directly to botan client:
|
||||||
it 'shows usage of basic matchers'
|
botan.track(...)
|
||||||
# The most basic one is #make_telegram_request(bot, endpoint, params_matcher)
|
|
||||||
expect { dispatch_command(:start) }.
|
|
||||||
to make_telegram_request(bot, :sendMessage, hash_including(text: 'msg text'))
|
|
||||||
|
|
||||||
# There are some shortcuts for dispatching basic updates and testing responses.
|
|
||||||
expect { dispatch_message('Hi') }.to send_telegram_message(bot, /msg regexp/, some: :option)
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#start!' do
|
|
||||||
subject { -> { dispatch_command :start } }
|
|
||||||
# Using built in matcher for `respond_to`:
|
|
||||||
it { should respond_with_message 'Hi there!' }
|
|
||||||
end
|
|
||||||
|
|
||||||
# There is context for callback queries with related matchers,
|
|
||||||
# use :callback_query tag to include it.
|
|
||||||
describe '#hey_callback_query', :callback_query do
|
|
||||||
let(:data) { "hey:#{name}" }
|
|
||||||
let(:name) { 'Joe' }
|
|
||||||
it { should answer_callback_query('Hey Joe') }
|
|
||||||
it { should edit_current_message :text, text: 'Done' }
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
There is a context for testing bot controller in the way similar to Rails controller tests.
|
There is no stubbing for botan clients, so don't set botan token in tests.
|
||||||
It's supposed to be a low-level alternative for integration tests. Among the differences is
|
|
||||||
that controller tests use a single controller instance for all dispatches in specific exaple,
|
|
||||||
session is stubbed (does not use configured store engine), and update is not serialized
|
|
||||||
so it also supports mocks. This can be useful for unit testing, but should not be used as
|
|
||||||
the default way to test the bot.
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
require 'telegram/bot/updates_controller/rspec_helpers'
|
|
||||||
RSpec.describe TelegramWebhooksController, type: :telegram_bot_controller do
|
|
||||||
# for old RSpec:
|
|
||||||
# include_context 'telegram/bot/updates_controller'
|
|
||||||
|
|
||||||
# Same helpers and matchers like dispatch_command, answer_callback_query are available here.
|
|
||||||
end
|
|
||||||
```
|
|
||||||
|
|
||||||
See sample app for more examples.
|
|
||||||
|
|
||||||
### Deployment
|
|
||||||
|
|
||||||
While webhooks-mode is prefered, poller still can be used in production.
|
|
||||||
See [comparison and examples](https://github.com/telegram-bot-rb/telegram-bot/wiki/Deployment)
|
|
||||||
for details.
|
|
||||||
|
|
||||||
### Async mode
|
|
||||||
|
|
||||||
There is built in support for async requests using ActiveJob. Without Rails
|
|
||||||
you can implement your own worker class to handle such requests. This allows:
|
|
||||||
|
|
||||||
- Process updates very fast, without waiting for telegram responses.
|
|
||||||
- Handle and retry network and other errors with queue adapter.
|
|
||||||
- ???
|
|
||||||
|
|
||||||
Instead of performing request instantly client serializes it, pushes to queue,
|
|
||||||
and immediately return control back. The job is then fetched with a worker
|
|
||||||
and real API request is performed. And this all is absolutely transparent for the app.
|
|
||||||
|
|
||||||
To enable this mode add `async: true` to bot's config.
|
|
||||||
For more information and custom configuration check out
|
|
||||||
[docs](http://www.rubydoc.info/github/telegram-bot-rb/telegram-bot/master/Telegram/Bot/Async) or
|
|
||||||
[source](https://github.com/telegram-bot-rb/telegram-bot/blob/master/lib/telegram/bot/async.rb).
|
|
||||||
|
|
||||||
If you want async mode, but don't want to setup queue, know that Rails 5 are shipped
|
|
||||||
with Async adapter by default, and there is
|
|
||||||
[Sucker Punch](https://github.com/brandonhilkert/sucker_punch) for Rails 4.
|
|
||||||
|
|
||||||
To disable async mode for the block of code use `bot.async(false) { bot.send_photo }`.
|
|
||||||
Yes, it's threadsafe too.
|
|
||||||
|
|
||||||
#### Limitations
|
|
||||||
|
|
||||||
- Client will not return API response.
|
|
||||||
- Sending files is not available in async mode, because they can not be serialized.
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
After checking out the repo, run `bin/setup` to install dependencies and git hooks.
|
After checking out the repo, run `bin/setup` to install dependencies.
|
||||||
Then, run `appraisal rake spec` to run the tests.
|
Then, run `rake spec` to run the tests.
|
||||||
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
||||||
|
|
||||||
To install this gem onto your local machine, run `bundle exec rake install`.
|
To install this gem onto your local machine, run `bundle exec rake install`.
|
||||||
@@ -567,8 +383,6 @@ To release a new version, update the version number in `version.rb`,
|
|||||||
and then run `bundle exec rake release`, which will create a git tag for the version,
|
and then run `bundle exec rake release`, which will create a git tag for the version,
|
||||||
push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
||||||
|
|
||||||
Use `bin/fetch-telegram-methods` to update API methods list from Telegram website.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Bug reports and pull requests are welcome on GitHub at https://github.com/telegram-bot-rb/telegram-bot.
|
Bug reports and pull requests are welcome on GitHub at https://github.com/telegram-bot-rb/telegram-bot.
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
#!/usr/bin/env ruby
|
|
||||||
#
|
|
||||||
# Fetch list of methods from Telegram docs.
|
|
||||||
# Use it to update client.rb.
|
|
||||||
|
|
||||||
require 'net/http'
|
|
||||||
require 'nokogiri'
|
|
||||||
|
|
||||||
DOCS_URL = 'https://core.telegram.org/bots/api'.freeze
|
|
||||||
|
|
||||||
page_html = Net::HTTP.get(URI(DOCS_URL))
|
|
||||||
doc = Nokogiri::HTML(page_html)
|
|
||||||
|
|
||||||
# Select `h4`s, but use `h3`s to group them.
|
|
||||||
headers = doc.css('h3, h4').
|
|
||||||
chunk_while { |_, x| x.name == 'h4' }.
|
|
||||||
map { |g| g.select { |x| x.name == 'h4' } }.
|
|
||||||
map { |g| g.map(&:text) }
|
|
||||||
|
|
||||||
# Method starts with lowercase and does not have spaces.
|
|
||||||
NOT_METHOD_REGEXP = /(\A[^a-z])|\s/
|
|
||||||
|
|
||||||
# Filter method names.
|
|
||||||
method_list = headers.
|
|
||||||
map { |g| g.reject { |x| x.match?(NOT_METHOD_REGEXP) } }.
|
|
||||||
reject(&:empty?)
|
|
||||||
|
|
||||||
api_version = doc.text.match(/^(Bot API ([\d\.]+))\.?$/)
|
|
||||||
|
|
||||||
result = ['# Generated with bin/fetch-telegram-methods']
|
|
||||||
result << "# #{api_version[1]}" if api_version
|
|
||||||
result << ''
|
|
||||||
result << method_list.map { |g| g.join("\n") }.join("\n\n")
|
|
||||||
result << ''
|
|
||||||
result_txt = result.join("\n")
|
|
||||||
|
|
||||||
puts result_txt
|
|
||||||
|
|
||||||
API_METHODS_FILE = File.expand_path('../lib/telegram/bot/client/api_methods.txt', __dir__).freeze
|
|
||||||
File.write(API_METHODS_FILE, result_txt)
|
|
||||||
puts '', "Updated #{API_METHODS_FILE}"
|
|
||||||
@@ -3,7 +3,6 @@ set -euo pipefail
|
|||||||
IFS=$'\n\t'
|
IFS=$'\n\t'
|
||||||
|
|
||||||
bundle install
|
bundle install
|
||||||
appraisal install
|
|
||||||
bin/install_git_hooks
|
bin/install_git_hooks
|
||||||
|
|
||||||
# Do any other automated setup that you need to do here
|
# Do any other automated setup that you need to do here
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
# This file was generated by Appraisal
|
|
||||||
|
|
||||||
source "https://rubygems.org"
|
|
||||||
|
|
||||||
gem "actionpack", "~> 4.2.0"
|
|
||||||
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 "telegram-bot-types", "~> 0.6.0"
|
|
||||||
gem "rspec", "~> 3.5.0"
|
|
||||||
gem "rspec-its", "~> 1.1.0"
|
|
||||||
gem "rspec-rails", "~> 3.5.0"
|
|
||||||
gem "rubocop", "~> 0.52.1"
|
|
||||||
gem "coveralls", "~> 0.8.2", require: false
|
|
||||||
end
|
|
||||||
|
|
||||||
gemspec path: "../"
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# This file was generated by Appraisal
|
|
||||||
|
|
||||||
source "https://rubygems.org"
|
|
||||||
|
|
||||||
gem "actionpack", "~> 5.0.0"
|
|
||||||
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 "telegram-bot-types", "~> 0.6.0"
|
|
||||||
gem "rspec", "~> 3.5.0"
|
|
||||||
gem "rspec-its", "~> 1.1.0"
|
|
||||||
gem "rspec-rails", "~> 3.5.0"
|
|
||||||
gem "rubocop", "~> 0.52.1"
|
|
||||||
gem "coveralls", "~> 0.8.2", require: false
|
|
||||||
end
|
|
||||||
|
|
||||||
gemspec path: "../"
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# This file was generated by Appraisal
|
|
||||||
|
|
||||||
source "https://rubygems.org"
|
|
||||||
|
|
||||||
gem "actionpack", "~> 5.1.0"
|
|
||||||
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 "telegram-bot-types", "~> 0.6.0"
|
|
||||||
gem "rspec", "~> 3.5.0"
|
|
||||||
gem "rspec-its", "~> 1.1.0"
|
|
||||||
gem "rspec-rails", "~> 3.5.0"
|
|
||||||
gem "rubocop", "~> 0.52.1"
|
|
||||||
gem "coveralls", "~> 0.8.2", require: false
|
|
||||||
end
|
|
||||||
|
|
||||||
gemspec path: "../"
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# This file was generated by Appraisal
|
|
||||||
|
|
||||||
source "https://rubygems.org"
|
|
||||||
|
|
||||||
gem "actionpack", "~> 5.2.0"
|
|
||||||
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 "telegram-bot-types", "~> 0.6.0"
|
|
||||||
gem "rspec", "~> 3.5.0"
|
|
||||||
gem "rspec-its", "~> 1.1.0"
|
|
||||||
gem "rspec-rails", "~> 3.5.0"
|
|
||||||
gem "rubocop", "~> 0.52.1"
|
|
||||||
gem "coveralls", "~> 0.8.2", require: false
|
|
||||||
end
|
|
||||||
|
|
||||||
gemspec path: "../"
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
# This file was generated by Appraisal
|
|
||||||
|
|
||||||
source "https://rubygems.org"
|
|
||||||
|
|
||||||
gem "actionpack", "~> 6.0.0"
|
|
||||||
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 "telegram-bot-types", "~> 0.6.0"
|
|
||||||
gem "rspec", "~> 3.5.0"
|
|
||||||
gem "rspec-its", "~> 1.1.0"
|
|
||||||
gem "rspec-rails", "~> 3.5.0"
|
|
||||||
gem "rubocop", "~> 0.52.1"
|
|
||||||
gem "coveralls", "~> 0.8.2", require: false
|
|
||||||
end
|
|
||||||
|
|
||||||
gemspec path: "../"
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# This file was generated by Appraisal
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
group :development do
|
|
||||||
gem "appraisal", "~> 2.2"
|
|
||||||
gem "pry", "~> 0.10.1"
|
|
||||||
gem "pry-byebug", "~> 3.2.0"
|
|
||||||
gem "sdoc", "~> 0.4.1"
|
|
||||||
gem "telegram-bot-types", "~> 0.6.0"
|
|
||||||
gem "rspec", "~> 3.5.0"
|
|
||||||
gem "rspec-its", "~> 1.1.0"
|
|
||||||
gem "rspec-rails", "~> 3.5.0"
|
|
||||||
gem "rubocop", "~> 0.52.1"
|
|
||||||
gem "coveralls", "~> 0.8.2", require: false
|
|
||||||
end
|
|
||||||
|
|
||||||
gemspec path: "../"
|
|
||||||
@@ -1,14 +1,9 @@
|
|||||||
namespace :telegram do
|
namespace :telegram do
|
||||||
namespace :bot do
|
namespace :bot do
|
||||||
desc 'Run poller. It broadcasts Rails.logger to STDOUT in dev like `rails s` do. ' \
|
desc 'Run poller'
|
||||||
'Use LOG_TO_STDOUT to enable/disable broadcasting.'
|
task poller: :environment do
|
||||||
task :poller do
|
console = ActiveSupport::Logger.new(STDERR)
|
||||||
ENV['BOT_POLLER_MODE'] = 'true'
|
Rails.logger.extend ActiveSupport::Logger.broadcast console
|
||||||
Rake::Task['environment'].invoke
|
|
||||||
if ENV.fetch('LOG_TO_STDOUT') { Rails.env.development? }.present?
|
|
||||||
console = ActiveSupport::Logger.new(STDERR)
|
|
||||||
Rails.logger.extend ActiveSupport::Logger.broadcast console
|
|
||||||
end
|
|
||||||
Telegram::Bot::UpdatesPoller.start(ENV['BOT'].try!(:to_sym) || :default)
|
Telegram::Bot::UpdatesPoller.start(ENV['BOT'].try!(:to_sym) || :default)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -21,7 +16,7 @@ namespace :telegram do
|
|||||||
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
||||||
url = routes.send("#{route_name}_url")
|
url = routes.send("#{route_name}_url")
|
||||||
puts "Setting webhook for #{key}..."
|
puts "Setting webhook for #{key}..."
|
||||||
bot.async(false) { bot.set_webhook(url: url, certificate: cert) }
|
bot.set_webhook(url: url, certificate: cert)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,29 +5,31 @@ module Telegram
|
|||||||
|
|
||||||
module Bot
|
module Bot
|
||||||
class Error < StandardError; end
|
class Error < StandardError; end
|
||||||
|
|
||||||
# Raised for valid telegram response with 403 status code.
|
|
||||||
class Forbidden < Error; end
|
|
||||||
|
|
||||||
# Raised for valid telegram response with 404 status code.
|
|
||||||
class NotFound < Error; end
|
class NotFound < Error; end
|
||||||
|
|
||||||
module_function
|
# Error class for events when chat is not available anymore for bot.
|
||||||
|
# While Telegram has same error codes for different messages and there is no
|
||||||
|
# official docs for this error codes it uses `description` to
|
||||||
|
# check response.
|
||||||
|
class StaleChat < Error
|
||||||
|
DESCRIPTIONS = [
|
||||||
|
'bot was kicked',
|
||||||
|
"can't write to",
|
||||||
|
'group chat is deactivated',
|
||||||
|
].freeze
|
||||||
|
|
||||||
def deprecation_0_15
|
class << self
|
||||||
@deprecation ||= begin
|
def match_response?(response)
|
||||||
require 'active_support/deprecation'
|
description = response['description'].to_s
|
||||||
ActiveSupport::Deprecation.new('0.15', 'Telegram::Bot')
|
DESCRIPTIONS.any? { |x| description[x] }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
autoload :Async, 'telegram/bot/async'
|
autoload :Botan, 'telegram/bot/botan'
|
||||||
autoload :Client, 'telegram/bot/client'
|
autoload :Client, 'telegram/bot/client'
|
||||||
autoload :ClientStub, 'telegram/bot/client_stub'
|
autoload :ClientStub, 'telegram/bot/client_stub'
|
||||||
autoload :DebugClient, 'telegram/bot/debug_client'
|
|
||||||
autoload :Initializers, 'telegram/bot/initializers'
|
|
||||||
autoload :Middleware, 'telegram/bot/middleware'
|
autoload :Middleware, 'telegram/bot/middleware'
|
||||||
autoload :RSpec, 'telegram/bot/rspec'
|
|
||||||
autoload :UpdatesController, 'telegram/bot/updates_controller'
|
autoload :UpdatesController, 'telegram/bot/updates_controller'
|
||||||
autoload :UpdatesPoller, 'telegram/bot/updates_poller'
|
autoload :UpdatesPoller, 'telegram/bot/updates_poller'
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,157 +0,0 @@
|
|||||||
module Telegram
|
|
||||||
module Bot
|
|
||||||
# Telegram clients can perform requests in async way with
|
|
||||||
# any job adapter (ActiveJob by default). Using Rails you don't need any
|
|
||||||
# additional configuration. However you may want to enable async requests
|
|
||||||
# by default with `async: true` in `secrets.yml`.
|
|
||||||
#
|
|
||||||
# telegram:
|
|
||||||
# bots:
|
|
||||||
# chat_async:
|
|
||||||
# token: secret
|
|
||||||
# async: true # enable async mode for client
|
|
||||||
#
|
|
||||||
# Without Rails To start using async requests
|
|
||||||
# initialize client with `id` kwarg and make sure the client is
|
|
||||||
# accessible via `Teletgram.bots[id]` in job worker. Or just use
|
|
||||||
# `Telegram.bots_config=` for configuration.
|
|
||||||
#
|
|
||||||
# Being in async mode `#request` enqueues job instead to perform
|
|
||||||
# http request instead of performing it directly.
|
|
||||||
# Async behavior is controlled with `#async=` writer
|
|
||||||
# and can be enabled/disabled for the block with `#async`:
|
|
||||||
#
|
|
||||||
# client = Telegram::Bot::Client.new(**config, async: true)
|
|
||||||
# client.send_message(message)
|
|
||||||
# client.async(false) { client.send_message(other_one) }
|
|
||||||
#
|
|
||||||
# `#async=` sets global value for all threads,
|
|
||||||
# while `#async(val, &block)` is thread-safe.
|
|
||||||
#
|
|
||||||
# It can be set with custom job class or classname. By default it defines
|
|
||||||
# job classes for every client class, inherited from ApplicationRecord, which
|
|
||||||
# can be accessed via `.default_async_job`. You can integrate it with any
|
|
||||||
# other job provider by defining a class with `.perform_later(bot_id, *args)`
|
|
||||||
# method. See Async::Job for implemetation.
|
|
||||||
module Async
|
|
||||||
# Used to track missing key in a hash in local variable.
|
|
||||||
MISSING_VALUE = Object.new.freeze
|
|
||||||
|
|
||||||
module Job
|
|
||||||
class << self
|
|
||||||
def included(base)
|
|
||||||
base.singleton_class.send :attr_accessor, :client_class
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def perform(client_id, *args)
|
|
||||||
client = self.class.client_class.wrap(client_id.to_sym)
|
|
||||||
client.async(false) { client.request(*args) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
module ClassMethods
|
|
||||||
def default_async_job
|
|
||||||
@default_async_job ||= begin
|
|
||||||
begin
|
|
||||||
ApplicationJob
|
|
||||||
rescue NameError
|
|
||||||
raise 'Define ApplicationJob class or setup #async= with custom job class'
|
|
||||||
end
|
|
||||||
klass = Class.new(ApplicationJob) { include Job }
|
|
||||||
klass.client_class = self
|
|
||||||
const_set(:AsyncJob, klass)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# This is used in specs.
|
|
||||||
def default_async_job=(val)
|
|
||||||
@default_async_job = val
|
|
||||||
remove_const(:AsyncJob) if const_defined?(:AsyncJob, false)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Prepares argments for async job. ActiveJob doesn't support
|
|
||||||
# Symbol in argumens. Also we can encode json bodies only once here,
|
|
||||||
# so it would not be unnecessarily serialized-deserialized.
|
|
||||||
#
|
|
||||||
# This is stub method, which returns input. Every client class
|
|
||||||
# must prepare args itself.
|
|
||||||
def prepare_async_args(*args)
|
|
||||||
args
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns default_async_job if `true` is given,
|
|
||||||
# treats String as a constant name, or bypasses any other values.
|
|
||||||
def prepare_async_val(val)
|
|
||||||
case val
|
|
||||||
when true then default_async_job
|
|
||||||
when String then Object.const_get(val)
|
|
||||||
else val
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
class << self
|
|
||||||
def prepended(base)
|
|
||||||
base.extend(ClassMethods)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Transforms symbols to strings in hash values.
|
|
||||||
def prepare_hash(hash)
|
|
||||||
return hash unless hash.is_a?(Hash)
|
|
||||||
hash = hash.dup
|
|
||||||
hash.each { |key, val| hash[key] = val.to_s if val.is_a?(Symbol) }
|
|
||||||
end
|
|
||||||
|
|
||||||
# Thread-local hash to store async config for every client.
|
|
||||||
def thread_store
|
|
||||||
Thread.current[:telegram_bot_async] ||= {}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
attr_reader :id
|
|
||||||
|
|
||||||
def initialize(*, id: nil, async: nil, **options)
|
|
||||||
@id = id
|
|
||||||
self.async = async
|
|
||||||
super
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sets default async value for all threads.
|
|
||||||
# Uses `self.class.prepare_async_val` to prepare value.
|
|
||||||
def async=(val)
|
|
||||||
@async = self.class.prepare_async_val(val)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sets async value in a thread-safe way for the block.
|
|
||||||
# Uses `self.class.prepare_async_val` to prepare value.
|
|
||||||
#
|
|
||||||
# If no block is given returns previously set value or the global one,
|
|
||||||
# set by #async=.
|
|
||||||
def async(val = true)
|
|
||||||
thread_key = object_id
|
|
||||||
thread_store = Async.thread_store
|
|
||||||
return thread_store.fetch(thread_key) { @async } unless block_given?
|
|
||||||
begin
|
|
||||||
old_val = thread_store.fetch(thread_key) { MISSING_VALUE }
|
|
||||||
thread_store[thread_key] = self.class.prepare_async_val(val)
|
|
||||||
yield
|
|
||||||
ensure
|
|
||||||
if MISSING_VALUE == old_val
|
|
||||||
thread_store.delete(thread_key)
|
|
||||||
else
|
|
||||||
thread_store[thread_key] = old_val
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Uses job if #async is set.
|
|
||||||
def request(*args)
|
|
||||||
job_class = async
|
|
||||||
return super unless job_class
|
|
||||||
raise 'Can not enqueue job without client id' unless id
|
|
||||||
job_class.perform_later(id.to_s, *self.class.prepare_async_args(*args))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
36
lib/telegram/bot/botan.rb
Обычный файл
36
lib/telegram/bot/botan.rb
Обычный файл
@@ -0,0 +1,36 @@
|
|||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class Botan
|
||||||
|
TRACK_URI = 'https://api.botan.io/track'.freeze
|
||||||
|
|
||||||
|
class Error < Bot::Error; end
|
||||||
|
|
||||||
|
include DebugClient
|
||||||
|
|
||||||
|
attr_reader :client, :token
|
||||||
|
|
||||||
|
def initialize(token)
|
||||||
|
@client = HTTPClient.new
|
||||||
|
@token = token
|
||||||
|
end
|
||||||
|
|
||||||
|
def track(event, uid, payload = {})
|
||||||
|
res = http_request(
|
||||||
|
:post,
|
||||||
|
TRACK_URI,
|
||||||
|
{token: token, name: event, uid: uid},
|
||||||
|
payload.to_json,
|
||||||
|
)
|
||||||
|
status = res.status
|
||||||
|
return JSON.parse(res.body) if 300 > status
|
||||||
|
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
||||||
|
err_msg = "#{res.reason}: #{result && result['info'] || '-'}"
|
||||||
|
raise Error, err_msg
|
||||||
|
end
|
||||||
|
|
||||||
|
def http_request(method, uri, query, body)
|
||||||
|
client.request(method, uri, query, body)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,22 +1,32 @@
|
|||||||
require 'json'
|
require 'json'
|
||||||
require 'httpclient'
|
require 'httpclient'
|
||||||
|
require 'active_support/core_ext/string/inflections'
|
||||||
|
require 'active_support/core_ext/hash/keys'
|
||||||
|
require 'telegram/bot/debug_client'
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
module Bot
|
module Bot
|
||||||
class Client
|
class Client
|
||||||
URL_TEMPLATE = 'https://api.telegram.org/bot%<token>s/'.freeze
|
URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
|
||||||
|
|
||||||
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
||||||
extend Initializers
|
|
||||||
prepend Async
|
|
||||||
include DebugClient
|
include DebugClient
|
||||||
|
|
||||||
require 'telegram/bot/client/api_helper'
|
|
||||||
include ApiHelper
|
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
def by_id(id)
|
# Accepts different options to initialize bot.
|
||||||
Telegram.bots[id]
|
def wrap(input)
|
||||||
|
case input
|
||||||
|
when self then input
|
||||||
|
when Array then input.map(&method(__callee__))
|
||||||
|
when Hash then
|
||||||
|
input = input.stringify_keys
|
||||||
|
new input['token'], input['username'], botan: input['botan']
|
||||||
|
when Symbol
|
||||||
|
Telegram.bots[input] or
|
||||||
|
raise "Bot #{input} not configured, check Telegram.bots_config."
|
||||||
|
else
|
||||||
|
new(input)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Prepend TypedResponse module.
|
# Prepend TypedResponse module.
|
||||||
@@ -31,37 +41,56 @@ module Telegram
|
|||||||
body[k] = val.to_json if val.is_a?(Hash) || val.is_a?(Array)
|
body[k] = val.to_json if val.is_a?(Hash) || val.is_a?(Array)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def prepare_async_args(action, body = {})
|
|
||||||
[action.to_s, Async.prepare_hash(prepare_body(body))]
|
|
||||||
end
|
|
||||||
|
|
||||||
def error_for_response(response)
|
|
||||||
result = JSON.parse(response.body) rescue nil # rubocop:disable RescueModifier
|
|
||||||
return Error.new(response.reason) unless result
|
|
||||||
message = result['description'] || '-'
|
|
||||||
# This errors are raised only for valid responses from Telegram
|
|
||||||
case response.status
|
|
||||||
when 403 then Forbidden.new(message)
|
|
||||||
when 404 then NotFound.new(message)
|
|
||||||
else Error.new("#{response.reason}: #{message}")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
attr_reader :client, :token, :username, :base_uri
|
attr_reader :client, :token, :username, :base_uri, :botan
|
||||||
|
|
||||||
def initialize(token = nil, username = nil, **options)
|
def initialize(token, username = nil, botan: nil)
|
||||||
@client = HTTPClient.new
|
@client = HTTPClient.new
|
||||||
@token = token || options[:token]
|
@token = token
|
||||||
@username = username || options[:username]
|
@username = username
|
||||||
@base_uri = format(URL_TEMPLATE, token: self.token)
|
@base_uri = format URL_TEMPLATE, token
|
||||||
|
@botan = Botan.new(botan) if botan
|
||||||
end
|
end
|
||||||
|
|
||||||
def request(action, body = {})
|
def request(action, body = {}) # rubocop:disable PerceivedComplexity
|
||||||
response = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
|
res = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
|
||||||
raise self.class.error_for_response(response) if response.status >= 300
|
status = res.status
|
||||||
JSON.parse(response.body)
|
return JSON.parse(res.body) if 300 > status
|
||||||
|
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
||||||
|
err_msg = "#{res.reason}: #{result && result['description'] || '-'}"
|
||||||
|
if result
|
||||||
|
# NotFound is raised only for valid responses from Telegram
|
||||||
|
raise NotFound, err_msg if 404 == status
|
||||||
|
raise StaleChat, err_msg if StaleChat.match_response?(result)
|
||||||
|
end
|
||||||
|
raise Error, err_msg
|
||||||
|
end
|
||||||
|
|
||||||
|
%w(
|
||||||
|
answerCallbackQuery
|
||||||
|
answerInlineQuery
|
||||||
|
forwardMessage
|
||||||
|
getFile
|
||||||
|
getMe
|
||||||
|
getUpdates
|
||||||
|
getUserProfilePhotos
|
||||||
|
kickChatMember
|
||||||
|
sendAudio
|
||||||
|
sendChatAction
|
||||||
|
sendContact
|
||||||
|
sendDocument
|
||||||
|
sendLocation
|
||||||
|
sendMessage
|
||||||
|
sendPhoto
|
||||||
|
sendSticker
|
||||||
|
sendVenue
|
||||||
|
sendVideo
|
||||||
|
sendVoice
|
||||||
|
setWebhook
|
||||||
|
unbanChatMember
|
||||||
|
).each do |method|
|
||||||
|
define_method(method.underscore) { |*args| request(method, *args) }
|
||||||
end
|
end
|
||||||
|
|
||||||
# Endpoint for low-level request. For easy host highjacking & instrumentation.
|
# Endpoint for low-level request. For easy host highjacking & instrumentation.
|
||||||
|
|||||||
@@ -1,31 +0,0 @@
|
|||||||
require 'active_support/core_ext/string/inflections'
|
|
||||||
|
|
||||||
module Telegram
|
|
||||||
module Bot
|
|
||||||
class Client
|
|
||||||
module ApiHelper
|
|
||||||
METHODS_LIST_FILE = File.expand_path('../api_methods.txt', __FILE__)
|
|
||||||
|
|
||||||
class << self
|
|
||||||
def methods_list(file = METHODS_LIST_FILE)
|
|
||||||
File.read(file).lines.
|
|
||||||
map(&:strip).
|
|
||||||
reject { |x| x.empty? || x.start_with?('#') }
|
|
||||||
end
|
|
||||||
|
|
||||||
# Defines method with underscored name to post to specific endpoint:
|
|
||||||
#
|
|
||||||
# define_method :getMe
|
|
||||||
# # defines #get_me
|
|
||||||
def define_helpers(*list)
|
|
||||||
list.map(&:to_s).each do |method|
|
|
||||||
define_method(method.underscore) { |*args| request(method, *args) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
define_helpers(*methods_list)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
# Generated with bin/fetch-telegram-methods
|
|
||||||
# Bot API 4.4
|
|
||||||
|
|
||||||
getUpdates
|
|
||||||
setWebhook
|
|
||||||
deleteWebhook
|
|
||||||
getWebhookInfo
|
|
||||||
|
|
||||||
getMe
|
|
||||||
sendMessage
|
|
||||||
forwardMessage
|
|
||||||
sendPhoto
|
|
||||||
sendAudio
|
|
||||||
sendDocument
|
|
||||||
sendVideo
|
|
||||||
sendAnimation
|
|
||||||
sendVoice
|
|
||||||
sendVideoNote
|
|
||||||
sendMediaGroup
|
|
||||||
sendLocation
|
|
||||||
editMessageLiveLocation
|
|
||||||
stopMessageLiveLocation
|
|
||||||
sendVenue
|
|
||||||
sendContact
|
|
||||||
sendPoll
|
|
||||||
sendChatAction
|
|
||||||
getUserProfilePhotos
|
|
||||||
getFile
|
|
||||||
kickChatMember
|
|
||||||
unbanChatMember
|
|
||||||
restrictChatMember
|
|
||||||
promoteChatMember
|
|
||||||
setChatPermissions
|
|
||||||
exportChatInviteLink
|
|
||||||
setChatPhoto
|
|
||||||
deleteChatPhoto
|
|
||||||
setChatTitle
|
|
||||||
setChatDescription
|
|
||||||
pinChatMessage
|
|
||||||
unpinChatMessage
|
|
||||||
leaveChat
|
|
||||||
getChat
|
|
||||||
getChatAdministrators
|
|
||||||
getChatMembersCount
|
|
||||||
getChatMember
|
|
||||||
setChatStickerSet
|
|
||||||
deleteChatStickerSet
|
|
||||||
answerCallbackQuery
|
|
||||||
|
|
||||||
editMessageText
|
|
||||||
editMessageCaption
|
|
||||||
editMessageMedia
|
|
||||||
editMessageReplyMarkup
|
|
||||||
stopPoll
|
|
||||||
deleteMessage
|
|
||||||
|
|
||||||
sendSticker
|
|
||||||
getStickerSet
|
|
||||||
uploadStickerFile
|
|
||||||
createNewStickerSet
|
|
||||||
addStickerToSet
|
|
||||||
setStickerPositionInSet
|
|
||||||
deleteStickerFromSet
|
|
||||||
|
|
||||||
answerInlineQuery
|
|
||||||
|
|
||||||
sendInvoice
|
|
||||||
answerShippingQuery
|
|
||||||
answerPreCheckoutQuery
|
|
||||||
|
|
||||||
setPassportDataErrors
|
|
||||||
|
|
||||||
sendGame
|
|
||||||
setGameScore
|
|
||||||
getGameHighScores
|
|
||||||
@@ -1,23 +1,35 @@
|
|||||||
require 'telegram/bot/client/api_helper'
|
|
||||||
require 'active_support/core_ext/string/inflections'
|
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
module Bot
|
module Bot
|
||||||
class Client
|
class Client
|
||||||
# Actions with type-casted results. Install `telegram-bot-types` gem first.
|
# Actions with type-casted results. Install `telegram-bot-types` gem first.
|
||||||
module TypedResponse
|
module TypedResponse
|
||||||
# First we define methods for every available api method to return `result`
|
{
|
||||||
# field instead of object.
|
getFile: :File,
|
||||||
ApiHelper.methods_list.each do |method|
|
getMe: :User,
|
||||||
define_method(method.to_s.underscore) do |*args|
|
getUpdates: [:Update],
|
||||||
super(*args)['result']
|
getUserProfilePhotos: :UserProfilePhotos,
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# And then override some of them which has castable results.
|
forwardMessage: :Message,
|
||||||
Types::Response::WRAPPED_METHODS.each do |method, type|
|
sendAudio: :Message,
|
||||||
define_method(method.to_s.underscore) do |*args|
|
sendDocument: :Message,
|
||||||
Types::Response.wrap(super(*args)['result'], type)
|
sendLocation: :Message,
|
||||||
|
sendMessage: :Message,
|
||||||
|
sendPhoto: :Message,
|
||||||
|
sendSticker: :Message,
|
||||||
|
sendVideo: :Message,
|
||||||
|
sendVoice: :Message,
|
||||||
|
}.each do |method, type|
|
||||||
|
next unless type
|
||||||
|
if type.is_a?(Array)
|
||||||
|
type_class = Types.const_get(type.first)
|
||||||
|
define_method(method.to_s.underscore) do |*args|
|
||||||
|
request(method, *args)['result'].map { |x| type_class.new(x) }
|
||||||
|
end
|
||||||
|
else
|
||||||
|
type_class = Types.const_get(type)
|
||||||
|
define_method(method.to_s.underscore) do |*args|
|
||||||
|
type_class.new request(method, *args)['result']
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ module Telegram
|
|||||||
if self == ClientStub || !ClientStub.stub_all?
|
if self == ClientStub || !ClientStub.stub_all?
|
||||||
super
|
super
|
||||||
else
|
else
|
||||||
ClientStub.new(*args)
|
ClientStub.new(args[1])
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -34,9 +34,8 @@ module Telegram
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def initialize(token = nil, username = nil, **options)
|
def initialize(username = nil)
|
||||||
@token = token || options[:token]
|
@username = username
|
||||||
@username = username || options[:username] || token
|
|
||||||
reset
|
reset
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -44,7 +43,7 @@ module Telegram
|
|||||||
@requests = Hash.new { |h, k| h[k] = [] }
|
@requests = Hash.new { |h, k| h[k] = [] }
|
||||||
end
|
end
|
||||||
|
|
||||||
def request(action, body = {})
|
def request(action, body)
|
||||||
requests[action.to_sym] << body
|
requests[action.to_sym] << body
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
require 'active_support/core_ext/hash/keys'
|
require 'active_support/core_ext/hash/keys'
|
||||||
require 'active_support/core_ext/hash/indifferent_access'
|
require 'active_support/core_ext/hash/transform_values'
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
module Bot
|
module Bot
|
||||||
@@ -14,30 +14,19 @@ module Telegram
|
|||||||
# It just tells routes helpers whether to add routed bots to
|
# It just tells routes helpers whether to add routed bots to
|
||||||
# Bot::UpdatesPoller, so their config will be available by bot key in
|
# Bot::UpdatesPoller, so their config will be available by bot key in
|
||||||
# Bot::UpdatesPoller.start.
|
# Bot::UpdatesPoller.start.
|
||||||
#
|
|
||||||
# It's enabled by default in Rails dev environment and `rake telegram:bot:poller`
|
|
||||||
# task. Use `BOT_POLLER_MODE=true` envvar to set it manually.
|
|
||||||
def bot_poller_mode?
|
def bot_poller_mode?
|
||||||
return @bot_poller_mode if defined?(@bot_poller_mode)
|
return @bot_poller_mode if defined?(@bot_poller_mode)
|
||||||
@bot_poller_mode = ENV.fetch('BOT_POLLER_MODE') do
|
Rails.env.development? if defined?(Rails)
|
||||||
Rails.env.development? if defined?(Rails.env)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Hash of bots made with bots_config.
|
# Hash of bots made with bots_config.
|
||||||
def bots
|
def bots
|
||||||
@bots ||= bots_config.each_with_object({}) do |(id, config), h|
|
@bots ||= bots_config.transform_values(&Client.method(:wrap))
|
||||||
h[id] = Client.wrap(config, id: id)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Default bot.
|
# Default bot.
|
||||||
def bot
|
def bot
|
||||||
@bot ||= bots.fetch(:default) do
|
@bot ||= bots[:default]
|
||||||
raise 'Default bot is not configured.' \
|
|
||||||
' Add :default to bots_config' \
|
|
||||||
' or use telegram.bot/telegram.bots.default section in secrets.yml.'
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns config for .bots method. By default uses `telegram['bots']` section
|
# Returns config for .bots method. By default uses `telegram['bots']` section
|
||||||
@@ -45,20 +34,12 @@ module Telegram
|
|||||||
#
|
#
|
||||||
# Can be overwritten with .bots_config=
|
# Can be overwritten with .bots_config=
|
||||||
def bots_config
|
def bots_config
|
||||||
@bots_config ||=
|
return @bots_config if @bots_config
|
||||||
if defined?(Rails.application)
|
telegram_config = Rails.application.secrets[:telegram]
|
||||||
app = Rails.application
|
(telegram_config['bots'] || {}).symbolize_keys.tap do |config|
|
||||||
store = app.credentials[:telegram] if app.respond_to?(:credentials)
|
default = telegram_config['bot']
|
||||||
store ||= app.secrets[:telegram] if app.respond_to?(:secrets)
|
config[:default] = default if default
|
||||||
store ||= {}
|
end
|
||||||
store = store.with_indifferent_access
|
|
||||||
store.fetch(:bots, {}).symbolize_keys.tap do |config|
|
|
||||||
default = store[:bot]
|
|
||||||
config[:default] = default if default
|
|
||||||
end
|
|
||||||
else
|
|
||||||
{}
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Resets all cached bots and their configs.
|
# Resets all cached bots and their configs.
|
||||||
|
|||||||
@@ -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,7 +1,6 @@
|
|||||||
require 'active_support/concern'
|
require 'active_support/concern'
|
||||||
require 'active_support/core_ext/hash/indifferent_access'
|
require 'action_dispatch/http/mime_type'
|
||||||
require 'active_support/json'
|
require 'action_dispatch/middleware/params_parser'
|
||||||
require 'action_dispatch'
|
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
module Bot
|
module Bot
|
||||||
@@ -14,8 +13,7 @@ module Telegram
|
|||||||
end
|
end
|
||||||
|
|
||||||
def call(env)
|
def call(env)
|
||||||
request = ActionDispatch::Request.new(env)
|
update = env['action_dispatch.request.request_parameters']
|
||||||
update = request.request_parameters
|
|
||||||
controller.dispatch(bot, update)
|
controller.dispatch(bot, update)
|
||||||
[200, {}, ['']]
|
[200, {}, ['']]
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ module Telegram
|
|||||||
|
|
||||||
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
||||||
self.logger = options.logger || Rails.logger
|
self.logger = options.logger || Rails.logger
|
||||||
self.session_store = options.session_store if options.session_store
|
self.session_store = options.session_store || Rails.cache
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -20,29 +20,47 @@ module Telegram
|
|||||||
# Replaces colon with underscore so rails don't treat it as
|
# Replaces colon with underscore so rails don't treat it as
|
||||||
# route parameter.
|
# route parameter.
|
||||||
def escape_token(token)
|
def escape_token(token)
|
||||||
token && token.tr(':', '_')
|
token.tr(':', '_')
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Define route which processes requests using given controller and bot.
|
# # Create routes for all Telegram.bots to use same controller:
|
||||||
|
# telegram_webhooks TelegramController
|
||||||
#
|
#
|
||||||
# telegram_webhook TelegramController, bot
|
# # Or pass custom bots usin any of supported config options:
|
||||||
|
# telegram_webhooks TelegramController,
|
||||||
|
# bot,
|
||||||
|
# {token: token, username: username},
|
||||||
|
# other_bot_token
|
||||||
#
|
#
|
||||||
# telegram_webhook TelegramController
|
# # Use different controllers for each bot:
|
||||||
# # same as:
|
# telegram_webhooks bot => TelegramChatController,
|
||||||
# telegram_webhook TelegramController, :default
|
# other_bot => TelegramAuctionController
|
||||||
#
|
#
|
||||||
# # pass additional options
|
# # telegram_webhooks creates named routes. See
|
||||||
# telegram_webhook TelegramController, :default, as: :custom_route_name
|
# # RoutesHelper.route_name_for_bot for more info.
|
||||||
def telegram_webhook(controller, bot = :default, **options)
|
# # You can override this options or specify others:
|
||||||
bot = Client.wrap(bot)
|
# telegram_webhooks TelegramController, as: :my_webhook
|
||||||
params = {
|
# telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
||||||
to: Middleware.new(bot, controller),
|
# other_bot => TelegramAuctionController,
|
||||||
as: RoutesHelper.route_name_for_bot(bot),
|
# admin_chat: TelegramAdminChatController
|
||||||
format: false,
|
#
|
||||||
}.merge!(options)
|
def telegram_webhooks(controllers, bots = nil, **options)
|
||||||
post("telegram/#{RoutesHelper.escape_token bot.token}", params)
|
unless controllers.is_a?(Hash)
|
||||||
UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
|
bots = bots ? Array.wrap(bots) : Telegram.bots.values
|
||||||
|
controllers = Hash[bots.map { |x| [x, controllers] }]
|
||||||
|
end
|
||||||
|
controllers.each do |bot, controller|
|
||||||
|
bot = Client.wrap(bot)
|
||||||
|
controller, bot_options = controller if controller.is_a?(Array)
|
||||||
|
params = {
|
||||||
|
to: Middleware.new(bot, controller),
|
||||||
|
as: RoutesHelper.route_name_for_bot(bot),
|
||||||
|
format: false,
|
||||||
|
}.merge!(options).merge!(bot_options || {})
|
||||||
|
post("telegram/#{RoutesHelper.escape_token bot.token}", params)
|
||||||
|
UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
module Telegram
|
|
||||||
module Bot
|
|
||||||
module RSpec
|
|
||||||
autoload :ClientMatchers, 'telegram/bot/rspec/client_matchers'
|
|
||||||
|
|
||||||
module_function
|
|
||||||
|
|
||||||
# Yelds a block if `include_context` is supported.
|
|
||||||
def with_include_context
|
|
||||||
::RSpec.configure do |config|
|
|
||||||
yield(config) if config.respond_to?(:include_context)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
require 'telegram/bot/rspec'
|
|
||||||
require 'telegram/bot/rspec/message_helpers'
|
|
||||||
|
|
||||||
# Shared helpers for testing callback query updates.
|
|
||||||
RSpec.shared_context 'telegram/bot/callback_query' do
|
|
||||||
include_context 'telegram/bot/message_helpers'
|
|
||||||
|
|
||||||
subject { -> { dispatch callback_query: payload } }
|
|
||||||
let(:payload) { {id: callback_query_id, from: from, message: message, data: data} }
|
|
||||||
let(:callback_query_id) { 11 }
|
|
||||||
let(:message_id) { 22 }
|
|
||||||
let(:message) { {message_id: message_id, chat: chat, text: 'message text'} }
|
|
||||||
let(:data) { raise '`let(:data) { "callback query data here" }` is required' }
|
|
||||||
|
|
||||||
# Matcher to check that origin message got edited.
|
|
||||||
def edit_current_message(type, options = {})
|
|
||||||
description = 'edit current message'
|
|
||||||
options = options.merge(
|
|
||||||
message_id: message[:message_id],
|
|
||||||
chat_id: chat_id,
|
|
||||||
)
|
|
||||||
Telegram::Bot::RSpec::ClientMatchers::MakeTelegramRequest.new(
|
|
||||||
bot, :"editMessage#{type.to_s.camelize}", description: description
|
|
||||||
).with(hash_including(options))
|
|
||||||
end
|
|
||||||
|
|
||||||
# Matcher to check that callback query is answered.
|
|
||||||
def answer_callback_query(text = Regexp.new(''), options = {})
|
|
||||||
description = "answer callback query with #{text.inspect}"
|
|
||||||
text = a_string_matching(text) if text.is_a?(Regexp)
|
|
||||||
options = options.merge(
|
|
||||||
callback_query_id: payload[:id],
|
|
||||||
text: text,
|
|
||||||
)
|
|
||||||
Telegram::Bot::RSpec::ClientMatchers::MakeTelegramRequest.new(
|
|
||||||
bot, :answerCallbackQuery, description: description
|
|
||||||
).with(hash_including(options))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,151 +0,0 @@
|
|||||||
module Telegram
|
|
||||||
module Bot
|
|
||||||
module RSpec
|
|
||||||
# Proxy that uses RSpec::Mocks::ArgListMatcher when it's available.
|
|
||||||
# Otherwise just performs `#==` match.
|
|
||||||
#
|
|
||||||
# Also allows to check argumets with custom block.
|
|
||||||
class ArgListMatcher
|
|
||||||
attr_reader :expected, :expected_proc
|
|
||||||
|
|
||||||
def initialize(*args, &block)
|
|
||||||
@expected_proc = block if block_given?
|
|
||||||
@expected =
|
|
||||||
if mocks_matcher?
|
|
||||||
::RSpec::Mocks::ArgumentListMatcher.new(*args)
|
|
||||||
else
|
|
||||||
args
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def args_match?(*actual)
|
|
||||||
if expected_proc
|
|
||||||
expected_proc[*actual]
|
|
||||||
true
|
|
||||||
elsif mocks_matcher?
|
|
||||||
expected.args_match?(*actual)
|
|
||||||
else
|
|
||||||
expected == actual
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def args
|
|
||||||
mocks_matcher? ? expected.args : expected
|
|
||||||
end
|
|
||||||
|
|
||||||
def mocks_matcher?
|
|
||||||
defined?(::RSpec::Mocks::ArgumentListMatcher)
|
|
||||||
end
|
|
||||||
|
|
||||||
def to_s
|
|
||||||
if mocks_matcher?
|
|
||||||
expected.expected_args.inspect
|
|
||||||
elsif expected_proc
|
|
||||||
'(proc matcher)'
|
|
||||||
else
|
|
||||||
expected.inspect
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Matchers to test requests to Telegram API.
|
|
||||||
#
|
|
||||||
# Complex matchers requires `rspec-mocks` to be installed.
|
|
||||||
module ClientMatchers
|
|
||||||
class MakeTelegramRequest < ::RSpec::Matchers::BuiltIn::BaseMatcher
|
|
||||||
EXPECTATION_TYPES = {
|
|
||||||
exactly: :==,
|
|
||||||
at_most: :>=,
|
|
||||||
at_least: :<=,
|
|
||||||
}.freeze
|
|
||||||
|
|
||||||
attr_reader :performed_requests, :description
|
|
||||||
|
|
||||||
def initialize(bot, action, description: nil)
|
|
||||||
@bot = bot
|
|
||||||
@action = action
|
|
||||||
@description = description || "make #{action} telegram request"
|
|
||||||
exactly(1)
|
|
||||||
end
|
|
||||||
|
|
||||||
def matches?(proc) # rubocop:disable AbcSize
|
|
||||||
raise ArgumentError, 'matcher only supports block expectations' unless proc.is_a?(Proc)
|
|
||||||
original_requests_count = bot.requests[action].count
|
|
||||||
proc.call
|
|
||||||
@performed_requests = bot.requests[action].drop(original_requests_count)
|
|
||||||
@matching_requests_count = performed_requests.count do |request|
|
|
||||||
!arg_list_matcher || arg_list_matcher.args_match?(request)
|
|
||||||
end
|
|
||||||
expectation_method = EXPECTATION_TYPES[expectation_type]
|
|
||||||
expected_number.public_send(expectation_method, matching_requests_count)
|
|
||||||
end
|
|
||||||
|
|
||||||
def with(*args, &block)
|
|
||||||
@arg_list_matcher = ArgListMatcher.new(*args, &block)
|
|
||||||
self
|
|
||||||
end
|
|
||||||
|
|
||||||
EXPECTATION_TYPES.each_key do |type|
|
|
||||||
define_method type do |count|
|
|
||||||
@expectation_type = type
|
|
||||||
@expected_number = Integer(count)
|
|
||||||
self
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def times
|
|
||||||
self
|
|
||||||
end
|
|
||||||
|
|
||||||
def failure_message
|
|
||||||
"expected to #{base_message}"
|
|
||||||
end
|
|
||||||
|
|
||||||
def failure_message_when_negated
|
|
||||||
"expected not to #{base_message}"
|
|
||||||
end
|
|
||||||
|
|
||||||
def supports_block_expectations?
|
|
||||||
true
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
attr_reader :bot, :action, :expectation_type, :expected_number,
|
|
||||||
:arg_list_matcher, :matching_requests_count
|
|
||||||
|
|
||||||
def base_message
|
|
||||||
"make #{expectation_type.to_s.tr('_', ' ')} #{expected_number} " \
|
|
||||||
"#{bot.inspect}.#{action} requests,".tap do |msg|
|
|
||||||
msg << " with #{arg_list_matcher}," if arg_list_matcher
|
|
||||||
msg << " but made #{matching_requests_count}"
|
|
||||||
if performed_requests
|
|
||||||
actual_args = performed_requests.map(&:inspect).join(', ')
|
|
||||||
msg << ", and #{performed_requests.count} with #{actual_args}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Check that bot performed request to telegram API:
|
|
||||||
#
|
|
||||||
# expect { dispatch_message('Hi!') }.
|
|
||||||
# to make_telegram_request(bot, :sendMessage).
|
|
||||||
# with(text: 'Hello!', chat_id: chat_id)
|
|
||||||
def make_telegram_request(bot, action)
|
|
||||||
MakeTelegramRequest.new(bot, action)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Helper for asserting message is sent. Note that options are checked
|
|
||||||
# with `hash_including`. For strict checks use #make_telegram_request.
|
|
||||||
def send_telegram_message(bot, text = nil, options = {})
|
|
||||||
description = "send telegram message #{text.inspect}"
|
|
||||||
text = a_string_matching(text) if text.is_a?(Regexp)
|
|
||||||
options = options.merge(text: text) if text
|
|
||||||
MakeTelegramRequest.new(bot, :sendMessage, description: description).
|
|
||||||
with(hash_including(options))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
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
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/shared'
|
|
||||||
|
|
||||||
RSpec.shared_context 'telegram/bot/integration/poller' do
|
|
||||||
include_context 'telegram/bot/integration/shared'
|
|
||||||
let(:controller_class) { described_class }
|
|
||||||
|
|
||||||
def dispatch(update)
|
|
||||||
controller_class.dispatch(bot, update.as_json)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
Telegram::Bot::RSpec.with_include_context do |config|
|
|
||||||
config.include_context 'telegram/bot/integration/poller', telegram_bot: :poller
|
|
||||||
end
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/shared'
|
|
||||||
require 'rack/test'
|
|
||||||
|
|
||||||
RSpec.shared_context 'telegram/bot/integration/rack' do
|
|
||||||
include_context 'telegram/bot/integration/shared'
|
|
||||||
include Rack::Test::Methods
|
|
||||||
|
|
||||||
let(:request_path) { raise '`let(:request_path) { path to bot }` is required' }
|
|
||||||
let(:app) { raise '`let(:app) { your rack app here }` is required' }
|
|
||||||
let(:request_headers) do
|
|
||||||
{
|
|
||||||
'ACCEPT' => 'application/json',
|
|
||||||
'CONTENT_TYPE' => 'application/json',
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
def dispatch(update)
|
|
||||||
post request_path, update.to_json, request_headers
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
Telegram::Bot::RSpec.with_include_context do |config|
|
|
||||||
config.include_context 'telegram/bot/integration/rack', telegram_bot: :rack
|
|
||||||
end
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/shared'
|
|
||||||
|
|
||||||
RSpec.shared_context 'telegram/bot/integration/rails', type: :request do
|
|
||||||
include_context 'telegram/bot/integration/shared'
|
|
||||||
|
|
||||||
let(:controller_path) do
|
|
||||||
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
|
||||||
Rails.application.routes.url_helpers.public_send("#{route_name}_path")
|
|
||||||
end
|
|
||||||
let(:request_headers) do
|
|
||||||
{
|
|
||||||
'Accept' => 'application/json',
|
|
||||||
'Content-Type' => 'application/json',
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
def dispatch(update)
|
|
||||||
if ActionPack::VERSION::MAJOR >= 5
|
|
||||||
post(controller_path, params: update.to_json, headers: request_headers)
|
|
||||||
else
|
|
||||||
post(controller_path, update.to_json, request_headers)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
Telegram::Bot::RSpec.with_include_context do |config|
|
|
||||||
config.include_context 'telegram/bot/integration/rails', telegram_bot: :rails
|
|
||||||
end
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
require 'active_support/json'
|
|
||||||
require 'telegram/bot'
|
|
||||||
require 'telegram/bot/rspec/message_helpers'
|
|
||||||
require 'telegram/bot/rspec/callback_query_helpers'
|
|
||||||
|
|
||||||
RSpec.shared_context 'telegram/bot/integration/shared' do
|
|
||||||
include Telegram::Bot::RSpec::ClientMatchers
|
|
||||||
include_context 'telegram/bot/message_helpers'
|
|
||||||
include_context 'telegram/bot/callback_query', :callback_query
|
|
||||||
|
|
||||||
let(:bot) { Telegram.bot }
|
|
||||||
let(:clear_session?) { described_class.respond_to?(:session_store) }
|
|
||||||
before { described_class.session_store.try!(:clear) if clear_session? }
|
|
||||||
end
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# Shared helpers for testing message updates.
|
|
||||||
RSpec.shared_context 'telegram/bot/message_helpers' do
|
|
||||||
let(:default_message_options) { {from: from, chat: chat} }
|
|
||||||
let(:from) { {id: from_id} }
|
|
||||||
let(:from_id) { 123 }
|
|
||||||
let(:chat) { {id: chat_id} }
|
|
||||||
let(:chat_id) { 456 }
|
|
||||||
|
|
||||||
# Shortcut for dispatching messages with default params.
|
|
||||||
def dispatch_message(text, options = {})
|
|
||||||
dispatch message: default_message_options.merge(options).merge(text: text)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Dispatch command message.
|
|
||||||
def dispatch_command(cmd, *args)
|
|
||||||
options = args.last.is_a?(Hash) ? args.pop : {}
|
|
||||||
args.unshift("/#{cmd}")
|
|
||||||
dispatch_message(args.join(' '), options)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Matcher to check response. Make sure to define `let(:chat_id)`.
|
|
||||||
def respond_with_message(expected = Regexp.new(''))
|
|
||||||
raise 'Define chat_id to use respond_with_message' unless defined?(chat_id)
|
|
||||||
send_telegram_message(bot, expected, chat_id: chat_id)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
require 'abstract_controller'
|
require 'abstract_controller'
|
||||||
require 'active_support/core_ext/string/inflections'
|
|
||||||
require 'active_support/callbacks'
|
require 'active_support/callbacks'
|
||||||
require 'active_support/version'
|
require 'active_support/version'
|
||||||
|
|
||||||
@@ -7,13 +6,13 @@ module Telegram
|
|||||||
module Bot
|
module Bot
|
||||||
# Base class to create update processors. With callbacks, session and helpers.
|
# Base class to create update processors. With callbacks, session and helpers.
|
||||||
#
|
#
|
||||||
# Public methods ending with `!` handle messages with commands.
|
# Define public methods for each command and they will be called when
|
||||||
# Message text is automatically parsed into method arguments.
|
# update has this command. Message is automatically parsed and
|
||||||
# Be sure to use default values and
|
# words are passed as method arguments. Be sure to use default values and
|
||||||
# splat arguments in every action method to not get errors, when user
|
# splat arguments in every action method to not get errors, when user
|
||||||
# sends command without necessary args / with extra args.
|
# sends command without necessary args / with extra args.
|
||||||
#
|
#
|
||||||
# def start!(token = nil, *)
|
# def start(token = nil, *)
|
||||||
# if token
|
# if token
|
||||||
# # ...
|
# # ...
|
||||||
# else
|
# else
|
||||||
@@ -21,21 +20,25 @@ module Telegram
|
|||||||
# end
|
# end
|
||||||
# end
|
# end
|
||||||
#
|
#
|
||||||
# def help!(*)
|
# def help(*)
|
||||||
# respond_with :message, text:
|
# reply_with :message, text:
|
||||||
# end
|
# end
|
||||||
#
|
#
|
||||||
# To process plain text messages (without commands) or other updates just
|
# To process plain text messages (without commands) or other updates just
|
||||||
# define public method with name of payload type.
|
# define public method with name of payload type. They will receive payload
|
||||||
# By default they receive payload as an argument, but some of them are called
|
# as an argument.
|
||||||
# with more usefuk args:
|
|
||||||
#
|
#
|
||||||
# def message(message)
|
# def message(message)
|
||||||
# respond_with :message, text: "Echo: #{message['text']}"
|
# reply_with :message, text: "Echo: #{message['text']}"
|
||||||
# end
|
# end
|
||||||
#
|
#
|
||||||
# def inline_query(query, offset)
|
# def inline_query(query)
|
||||||
# answer_inline_query results_for_query(query, offset), is_personal: true
|
# answer_inline_query results_for_query(query), is_personal: true
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# # To process conflicting commands (`/message args`) just use `on_` prefix:
|
||||||
|
# def on_message(*args)
|
||||||
|
# # ...
|
||||||
# end
|
# end
|
||||||
#
|
#
|
||||||
# To process update run:
|
# To process update run:
|
||||||
@@ -50,25 +53,17 @@ module Telegram
|
|||||||
class UpdatesController < AbstractController::Base # rubocop:disable ClassLength
|
class UpdatesController < AbstractController::Base # rubocop:disable ClassLength
|
||||||
abstract!
|
abstract!
|
||||||
|
|
||||||
%w[
|
require 'telegram/bot/updates_controller/session'
|
||||||
Commands
|
require 'telegram/bot/updates_controller/log_subscriber'
|
||||||
Instrumentation
|
require 'telegram/bot/updates_controller/instrumentation'
|
||||||
LogSubscriber
|
require 'telegram/bot/updates_controller/reply_helpers'
|
||||||
ReplyHelpers
|
autoload :CallbackQueyContext, 'telegram/bot/updates_controller/callback_query_context'
|
||||||
Rescue
|
autoload :MessageContext, 'telegram/bot/updates_controller/message_context'
|
||||||
Session
|
autoload :Botan, 'telegram/bot/updates_controller/botan'
|
||||||
Translation
|
|
||||||
].each { |name| require "telegram/bot/updates_controller/#{name.underscore}" }
|
|
||||||
|
|
||||||
%w[
|
|
||||||
CallbackQueryContext
|
|
||||||
MessageContext
|
|
||||||
TypedUpdate
|
|
||||||
].each { |mod| autoload mod, "telegram/bot/updates_controller/#{mod.underscore}" }
|
|
||||||
|
|
||||||
include AbstractController::Callbacks
|
include AbstractController::Callbacks
|
||||||
# Redefine callbacks with default terminator.
|
# Redefine callbacks with default terminator.
|
||||||
if ActiveSupport::VERSION::MAJOR >= 5
|
if ActiveSupport.gem_version >= Gem::Version.new('5')
|
||||||
define_callbacks :process_action,
|
define_callbacks :process_action,
|
||||||
skip_after_callbacks_if_terminated: true
|
skip_after_callbacks_if_terminated: true
|
||||||
else
|
else
|
||||||
@@ -77,27 +72,22 @@ module Telegram
|
|||||||
skip_after_callbacks_if_terminated: true
|
skip_after_callbacks_if_terminated: true
|
||||||
end
|
end
|
||||||
|
|
||||||
include Commands
|
include AbstractController::Translation
|
||||||
include Rescue
|
|
||||||
include ReplyHelpers
|
include ReplyHelpers
|
||||||
include Translation
|
prepend Instrumentation
|
||||||
# Add instrumentations hooks at the bottom, to ensure they instrument
|
|
||||||
# all the methods properly.
|
|
||||||
include Instrumentation
|
|
||||||
|
|
||||||
extend Session::ConfigMethods
|
extend Session::ConfigMethods
|
||||||
|
|
||||||
PAYLOAD_TYPES = %w[
|
autoload :TypedUpdate, 'telegram/bot/updates_controller/typed_update'
|
||||||
|
|
||||||
|
PAYLOAD_TYPES = %w(
|
||||||
message
|
message
|
||||||
edited_message
|
|
||||||
channel_post
|
|
||||||
edited_channel_post
|
|
||||||
inline_query
|
inline_query
|
||||||
chosen_inline_result
|
chosen_inline_result
|
||||||
callback_query
|
callback_query
|
||||||
shipping_query
|
edited_message
|
||||||
pre_checkout_query
|
).freeze
|
||||||
].freeze
|
CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
|
||||||
|
CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
# Initialize controller and process update.
|
# Initialize controller and process update.
|
||||||
@@ -105,15 +95,30 @@ module Telegram
|
|||||||
new(*args).dispatch
|
new(*args).dispatch
|
||||||
end
|
end
|
||||||
|
|
||||||
def payload_from_update(update)
|
# Overrid it to filter or transform commands.
|
||||||
update && PAYLOAD_TYPES.find do |type|
|
# Default implementation is to convert to downcase and add `on_` prefix
|
||||||
item = update[type]
|
# for conflicting commands.
|
||||||
return [item, type] if item
|
def action_for_command(cmd)
|
||||||
end
|
cmd.downcase!
|
||||||
|
cmd.match(CONFLICT_CMD_REGEX) ? "on_#{cmd}" : cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetches command from text message. All subsequent words are returned
|
||||||
|
# as arguments.
|
||||||
|
# If command has mention (eg. `/test@SomeBot`), it returns commands only
|
||||||
|
# for specified username. Set `username` to `true` to accept
|
||||||
|
# any commands.
|
||||||
|
def command_from_text(text, username = nil)
|
||||||
|
return unless text
|
||||||
|
match = text.match CMD_REGEX
|
||||||
|
return unless match
|
||||||
|
return if match[3] && username != true && match[3] != username
|
||||||
|
[match[1], text.split.drop(1)]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
attr_internal_reader :update, :bot, :payload, :payload_type
|
attr_internal_reader :update, :bot, :payload, :payload_type, :is_command
|
||||||
|
alias_method :command?, :is_command
|
||||||
delegate :username, to: :bot, prefix: true, allow_nil: true
|
delegate :username, to: :bot, prefix: true, allow_nil: true
|
||||||
|
|
||||||
# Second argument can be either update object with hash access & string
|
# Second argument can be either update object with hash access & string
|
||||||
@@ -127,22 +132,19 @@ module Telegram
|
|||||||
@_update = update
|
@_update = update
|
||||||
@_bot = bot
|
@_bot = bot
|
||||||
@_chat, @_from = options && options.values_at(:chat, :from)
|
@_chat, @_from = options && options.values_at(:chat, :from)
|
||||||
@_payload, @_payload_type = self.class.payload_from_update(update)
|
|
||||||
|
payload_data = nil
|
||||||
|
update && PAYLOAD_TYPES.find do |type|
|
||||||
|
item = update[type]
|
||||||
|
payload_data = [item, type] if item
|
||||||
|
end
|
||||||
|
@_payload, @_payload_type = payload_data
|
||||||
end
|
end
|
||||||
|
|
||||||
# Accessor to `'chat'` field of payload. Also tries `'chat'` in `'message'`
|
# Accessor to `'chat'` field of payload. Can be overriden with `chat` option
|
||||||
# when there is no such field in payload.
|
# for #initialize.
|
||||||
#
|
|
||||||
# Can be overriden with `chat` option for #initialize.
|
|
||||||
def chat
|
def chat
|
||||||
@_chat ||=
|
@_chat ||= payload && payload['chat']
|
||||||
if payload
|
|
||||||
if payload.is_a?(Hash)
|
|
||||||
payload['chat'] || payload['message'] && payload['message']['chat']
|
|
||||||
else
|
|
||||||
payload.try(:chat) || payload.try(:message).try!(:chat)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Accessor to `'from'` field of payload. Can be overriden with `from` option
|
# Accessor to `'from'` field of payload. Can be overriden with `from` option
|
||||||
@@ -153,69 +155,52 @@ module Telegram
|
|||||||
|
|
||||||
# Processes current update.
|
# Processes current update.
|
||||||
def dispatch
|
def dispatch
|
||||||
action, args = action_for_payload
|
@_is_command, action, args = action_for_payload
|
||||||
process(action, *args)
|
process(action, *args)
|
||||||
end
|
end
|
||||||
|
|
||||||
attr_internal_reader :action_options
|
|
||||||
|
|
||||||
# It provides support for passing array as action, where first vaule
|
|
||||||
# is action name and second is action metadata.
|
|
||||||
# This metadata is stored inside action_options
|
|
||||||
def process(action, *args)
|
|
||||||
action, options = action if action.is_a?(Array)
|
|
||||||
@_action_options = options || {}
|
|
||||||
super
|
|
||||||
end
|
|
||||||
|
|
||||||
# There are multiple ways how action name is calculated for update
|
|
||||||
# (see Commands, MessageContext, etc.). This method represents the
|
|
||||||
# way how action was calculated for current udpate.
|
|
||||||
#
|
|
||||||
# Some of possible values are `:payload, :command, :message_context`.
|
|
||||||
def action_type
|
|
||||||
action_options[:type] || :payload
|
|
||||||
end
|
|
||||||
|
|
||||||
# Calculates action name and args for payload.
|
# Calculates action name and args for payload.
|
||||||
# Uses `action_for_#{payload_type}` methods.
|
# Uses `action_for_#{payload_type}` methods.
|
||||||
# If this method doesn't return anything
|
# If this method doesn't return anything
|
||||||
# it uses fallback with action same as payload type.
|
# it uses fallback with action same as payload type.
|
||||||
# Returns array `[action, args]`.
|
# Returns array `[is_command?, action, args]`.
|
||||||
def action_for_payload
|
def action_for_payload
|
||||||
if payload_type
|
if payload_type
|
||||||
send("action_for_#{payload_type}") || action_for_default_payload
|
send("action_for_#{payload_type}") || [false, payload_type, [payload]]
|
||||||
else
|
else
|
||||||
[:unsupported_payload_type, []]
|
[false, :unsupported_payload_type, []]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def action_for_default_payload
|
# If payload is a message with command, then returned action is an
|
||||||
[payload_type, [payload]]
|
# action for this command.
|
||||||
|
# Separate method, so it can be easily overriden (ex. MessageContext).
|
||||||
|
def action_for_message
|
||||||
|
cmd, args = self.class.command_from_text(payload['text'], bot_username)
|
||||||
|
cmd &&= self.class.action_for_command(cmd)
|
||||||
|
[true, cmd, args] if cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
# It doesn't extract commands from edited messages. Just process
|
||||||
|
# them as usual ones.
|
||||||
|
def action_for_edited_message
|
||||||
end
|
end
|
||||||
|
|
||||||
def action_for_inline_query
|
def action_for_inline_query
|
||||||
[payload_type, [payload['query'], payload['offset']]]
|
[false, payload_type, [payload['query'], payload['offset']]]
|
||||||
end
|
end
|
||||||
|
|
||||||
def action_for_chosen_inline_result
|
def action_for_chosen_inline_result
|
||||||
[payload_type, [payload['result_id'], payload['query']]]
|
[false, payload_type, [payload['result_id'], payload['query']]]
|
||||||
end
|
end
|
||||||
|
|
||||||
def action_for_callback_query
|
def action_for_callback_query
|
||||||
[payload_type, [payload['data']]]
|
[false, payload_type, [payload['data']]]
|
||||||
end
|
end
|
||||||
|
|
||||||
# Silently ignore unsupported messages to not fail when user crafts
|
# Silently ignore unsupported messages.
|
||||||
# an update with usupported command, callback query context, etc.
|
# Params are `action, *args`.
|
||||||
def action_missing(action, *_args)
|
def action_missing(*)
|
||||||
logger.debug { "The action '#{action}' is not defined in #{self.class.name}" } if logger
|
|
||||||
nil
|
|
||||||
end
|
|
||||||
|
|
||||||
PAYLOAD_TYPES.each do |type|
|
|
||||||
method = :"action_for_#{type}"
|
|
||||||
alias_method method, :action_for_default_payload unless instance_methods.include?(method)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
|
ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
|
||||||
|
|||||||
33
lib/telegram/bot/updates_controller/botan.rb
Обычный файл
33
lib/telegram/bot/updates_controller/botan.rb
Обычный файл
@@ -0,0 +1,33 @@
|
|||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class UpdatesController
|
||||||
|
# Helpers for botan.io metrics.
|
||||||
|
module Botan
|
||||||
|
class MissingFrom < Error; end
|
||||||
|
|
||||||
|
protected
|
||||||
|
|
||||||
|
def botan
|
||||||
|
@botan ||= bot.try!(:botan)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Track custom event for user taken from `from` field:
|
||||||
|
#
|
||||||
|
# botan_track :my_event, {data: :val}
|
||||||
|
#
|
||||||
|
def botan_track(event, data = {})
|
||||||
|
raise MissingFrom, 'Can not track without user' unless from
|
||||||
|
botan.try! { |x| x.track(event, from['id'], data) }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Track current action and payload for current user. Best used with `before_action`:
|
||||||
|
#
|
||||||
|
# before_action :botan_track_action
|
||||||
|
#
|
||||||
|
def botan_track_action
|
||||||
|
botan_track(action_name, payload)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -3,7 +3,7 @@ module Telegram
|
|||||||
class UpdatesController
|
class UpdatesController
|
||||||
# Use separate actions for different callback queries.
|
# Use separate actions for different callback queries.
|
||||||
# It doesn't require session support. Simply add `%{context}:` prefix to data.
|
# It doesn't require session support. Simply add `%{context}:` prefix to data.
|
||||||
module CallbackQueryContext
|
module CallbackQueyContext
|
||||||
protected
|
protected
|
||||||
|
|
||||||
# Uses #context_from_callback_query as context name.
|
# Uses #context_from_callback_query as context name.
|
||||||
@@ -15,14 +15,11 @@ module Telegram
|
|||||||
# because `data` param is controlled by client.
|
# because `data` param is controlled by client.
|
||||||
def action_for_callback_query
|
def action_for_callback_query
|
||||||
context, new_data = context_from_callback_query
|
context, new_data = context_from_callback_query
|
||||||
|
# binding.pry
|
||||||
if context
|
if context
|
||||||
action_name = "#{context}_callback_query"
|
action_name = "#{context}_callback_query"
|
||||||
if action_method?(action_name)
|
[false, action_name, [new_data]] if action_method?(action_name)
|
||||||
action_options = {type: :callback_query_context, context: context}
|
end || super
|
||||||
return [[action_name, action_options], [new_data]]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
super
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def context_from_callback_query
|
def context_from_callback_query
|
||||||
|
|||||||
@@ -1,44 +0,0 @@
|
|||||||
module Telegram
|
|
||||||
module Bot
|
|
||||||
class UpdatesController
|
|
||||||
# Support for parsing commands
|
|
||||||
module Commands
|
|
||||||
CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
|
|
||||||
|
|
||||||
class << self
|
|
||||||
# Fetches command from text message. All subsequent words are returned
|
|
||||||
# as arguments.
|
|
||||||
# If command has mention (eg. `/test@SomeBot`), it returns commands only
|
|
||||||
# for specified username. Set `username` to `true` to accept
|
|
||||||
# any commands.
|
|
||||||
def command_from_text(text, username = nil)
|
|
||||||
return unless text
|
|
||||||
match = text.match(CMD_REGEX)
|
|
||||||
return unless match
|
|
||||||
mention = match[3]
|
|
||||||
[match[1], text.split.drop(1)] if username == true || !mention || mention == username
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Override it to filter or transform commands.
|
|
||||||
# Default implementation is to downcase and add `!` suffix.
|
|
||||||
def action_for_command(cmd)
|
|
||||||
"#{cmd.downcase}!"
|
|
||||||
end
|
|
||||||
|
|
||||||
# If payload is a message with command, then returned action is an
|
|
||||||
# action for this command.
|
|
||||||
# Separate method, so it can be easily overriden (ex. MessageContext).
|
|
||||||
#
|
|
||||||
# This is not used for edited messages/posts. It process them as basic updates.
|
|
||||||
def action_for_message
|
|
||||||
cmd, args = Commands.command_from_text(payload['text'], bot_username)
|
|
||||||
return unless cmd
|
|
||||||
[[action_for_command(cmd), type: :command, command: cmd], args]
|
|
||||||
end
|
|
||||||
|
|
||||||
alias_method :action_for_channel_post, :action_for_message
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -4,13 +4,12 @@ module Telegram
|
|||||||
# Most methods are taken from ActionController::Instrumentation,
|
# Most methods are taken from ActionController::Instrumentation,
|
||||||
# some are slightly modified.
|
# some are slightly modified.
|
||||||
module Instrumentation
|
module Instrumentation
|
||||||
extend ActiveSupport::Concern
|
|
||||||
|
|
||||||
included do
|
|
||||||
config_accessor :logger
|
|
||||||
end
|
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
|
def prepended(base)
|
||||||
|
base.config_accessor :logger
|
||||||
|
base.extend ClassMethods
|
||||||
|
end
|
||||||
|
|
||||||
def instrument(action, *args, &block)
|
def instrument(action, *args, &block)
|
||||||
ActiveSupport::Notifications.instrument(
|
ActiveSupport::Notifications.instrument(
|
||||||
"#{action}.updates_controller.bot.telegram",
|
"#{action}.updates_controller.bot.telegram",
|
||||||
@@ -36,13 +35,13 @@ module Telegram
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def respond_with(type, *)
|
def reply_with(type, *)
|
||||||
Instrumentation.instrument(:respond_with, type: type) { super }
|
Instrumentation.instrument(:reply_with, type: type) { super }
|
||||||
end
|
end
|
||||||
|
|
||||||
%i[answer_callback_query answer_inline_query].each do |type|
|
%i(answer_callback_query answer_inline_query).each do |type|
|
||||||
define_method(type) do |*args|
|
define_method(type) do |*args|
|
||||||
Instrumentation.instrument(:respond_with, type: type) { super(*args) }
|
Instrumentation.instrument(:reply_with, type: type) { super(*args) }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -17,13 +17,13 @@ module Telegram
|
|||||||
payload = event.payload
|
payload = event.payload
|
||||||
additions = UpdatesController.log_process_action(payload)
|
additions = UpdatesController.log_process_action(payload)
|
||||||
message = "Completed in #{event.duration.round}ms"
|
message = "Completed in #{event.duration.round}ms"
|
||||||
message << " (#{additions.join(' | ')})" if additions.present?
|
message << " (#{additions.join(' | ')})" unless additions.blank?
|
||||||
message
|
message
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def respond_with(event)
|
def reply_with(event)
|
||||||
info { "Responded with #{event.payload[:type]}" }
|
info { "Replied with #{event.payload[:type]}" }
|
||||||
end
|
end
|
||||||
|
|
||||||
def halted_callback(event)
|
def halted_callback(event)
|
||||||
|
|||||||
@@ -2,75 +2,91 @@ module Telegram
|
|||||||
module Bot
|
module Bot
|
||||||
class UpdatesController
|
class UpdatesController
|
||||||
# Allows to store context in session and treat next message according to this context.
|
# Allows to store context in session and treat next message according to this context.
|
||||||
#
|
|
||||||
# It provides `save_context` method to store method name
|
|
||||||
# to be used as action for next update:
|
|
||||||
#
|
|
||||||
# def set_location!(*)
|
|
||||||
# save_context(:set_location_from_message)
|
|
||||||
# respond_with :message, text: 'Where are you?'
|
|
||||||
# end
|
|
||||||
#
|
|
||||||
# def set_location_from_messge(city = nil, *)
|
|
||||||
# # update
|
|
||||||
# end
|
|
||||||
#
|
|
||||||
# # OR
|
|
||||||
# # This will support both `/set_location city_name`, and `/set_location`
|
|
||||||
# # with subsequent refinement.
|
|
||||||
# def set_location!(city = nil, *)
|
|
||||||
# if city
|
|
||||||
# # update
|
|
||||||
# else
|
|
||||||
# save_context(:set_location!)
|
|
||||||
# respond_with :message, text: 'Where are you?'
|
|
||||||
# end
|
|
||||||
# end
|
|
||||||
module MessageContext
|
module MessageContext
|
||||||
extend ActiveSupport::Concern
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
include Session
|
include Session
|
||||||
|
|
||||||
|
included do
|
||||||
|
# As we use before_action context is cleared anyway,
|
||||||
|
# no matter we used it or not.
|
||||||
|
singleton_class.send :attr_reader, :context_handlers, :context_to_action
|
||||||
|
@context_handlers = {}
|
||||||
|
end
|
||||||
|
|
||||||
|
module ClassMethods
|
||||||
|
# Registers handler for context.
|
||||||
|
#
|
||||||
|
# context_handler :rename do |*|
|
||||||
|
# resource.update!(name: payload['text'])
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# # To run other action with all the callbacks:
|
||||||
|
# context_handler :rename do |*words|
|
||||||
|
# process(:rename, *words)
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# # Or just
|
||||||
|
# context_handler :rename, :your_action_to_call
|
||||||
|
# context_handler :rename # to call :rename
|
||||||
|
#
|
||||||
|
def context_handler(context = nil, action = nil, &block)
|
||||||
|
context &&= context.to_sym
|
||||||
|
if block
|
||||||
|
action = "_context_handler_#{context}"
|
||||||
|
define_method(action, &block)
|
||||||
|
end
|
||||||
|
context_handlers[context] = action || context
|
||||||
|
end
|
||||||
|
|
||||||
|
# Use it to use context value as action name for all contexts
|
||||||
|
# which miss handlers.
|
||||||
|
# For security reasons it supports only action methods and will
|
||||||
|
# raise AbstractController::ActionNotFound if context is invalid.
|
||||||
|
def context_to_action!
|
||||||
|
@context_to_action = true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
# Action to clear context.
|
# Action to clear context.
|
||||||
def cancel!
|
def cancel
|
||||||
# Context is already cleared in action_for_message
|
# Context is already cleared in action_for_message
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
# Controller may have multiple sessions, let it be possible
|
# Context is read from the session to treat messages
|
||||||
# to select session for message context.
|
# according to previous request.
|
||||||
def message_context_session
|
attr_reader :context
|
||||||
session
|
|
||||||
end
|
|
||||||
|
|
||||||
# Fetches context and finds handler for it. If message has new command,
|
# Fetches context and finds handler for it. If message has new command,
|
||||||
# it has higher priority than contextual action.
|
# it has higher priority than contextual action.
|
||||||
def action_for_message
|
def action_for_message
|
||||||
val = message_context_session.delete(:context)
|
val = session.delete(:context)
|
||||||
context = val && val.to_s
|
@context = val && val.to_sym
|
||||||
super || context && begin
|
super || context && begin
|
||||||
args = payload['text'].try!(:split) || []
|
handler = handler_for_context
|
||||||
action = action_for_message_context(context)
|
[true, handler, payload['text'].try!(:split) || []] if handler
|
||||||
[[action, type: :message_context, context: context], args]
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Save context for the next request.
|
# Save context for the next request.
|
||||||
def save_context(context)
|
def save_context(context)
|
||||||
message_context_session[:context] = context
|
session[:context] = context
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns action name for message context. By default it's the same as context name.
|
def handler_for_context
|
||||||
# Raises AbstractController::ActionNotFound if action is not available.
|
self.class.context_handlers[context] || self.class.context_to_action && begin
|
||||||
# This differs from other cases where invalid actions are silently ignored,
|
action_name = context.to_s
|
||||||
# because message context is controlled by developer, and users are not able
|
unless action_method?(action_name)
|
||||||
# to construct update to run any specific context.
|
raise AbstractController::ActionNotFound,
|
||||||
def action_for_message_context(context)
|
"The action '#{action_name}' could not be set from context " \
|
||||||
action = context.to_s
|
"for #{self.class.name}. " \
|
||||||
return action if action_method?(action)
|
'context_to_action! supports only action methods for security reasons. ' \
|
||||||
raise AbstractController::ActionNotFound,
|
'If you need to call this action use context_handler for it.'
|
||||||
"The context action '#{action}' is not found in #{self.class.name}"
|
end
|
||||||
|
action_name
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,26 +2,24 @@ module Telegram
|
|||||||
module Bot
|
module Bot
|
||||||
class UpdatesController
|
class UpdatesController
|
||||||
module ReplyHelpers
|
module ReplyHelpers
|
||||||
# Helper to call bot's `send_#{type}` method with already set `chat_id`:
|
# Helper to call bot's `send_#{type}` method with already set `chat_id` and
|
||||||
|
# `reply_to_message_id`:
|
||||||
#
|
#
|
||||||
# respond_with :message, text: 'Hello!'
|
# reply_with :message, text: 'Hello!'
|
||||||
# respond_with :message, text: '__Hello!__', parse_mode: :Markdown
|
# reply_with :message, text: '__Hello!__', parse_mode: :Markdown
|
||||||
# respond_with :photo, photo: File.open(photo_to_send), caption: "It's incredible!"
|
# reply_with :photo, photo: File.open(photo_to_send), caption: "It's incredible!"
|
||||||
def respond_with(type, params)
|
|
||||||
chat = self.chat
|
|
||||||
chat_id = chat && chat['id'] or raise 'Can not respond_with when chat is not present'
|
|
||||||
bot.public_send("send_#{type}", params.merge(chat_id: chat_id))
|
|
||||||
end
|
|
||||||
|
|
||||||
# Same as respond_with but also sets `reply_to_message_id`.
|
|
||||||
def reply_with(type, params)
|
def reply_with(type, params)
|
||||||
|
method = "send_#{type}"
|
||||||
|
chat = self.chat
|
||||||
payload = self.payload
|
payload = self.payload
|
||||||
message_id = payload && payload['message_id']
|
params = params.merge(
|
||||||
params = params.merge(reply_to_message_id: message_id) if message_id
|
chat_id: (chat && chat['id'] or raise 'Can not reply_with when chat is not present'),
|
||||||
respond_with(type, params)
|
reply_to_message: payload && payload['message_id'],
|
||||||
|
)
|
||||||
|
bot.public_send(method, params)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Same as respond_with, but for inline queries.
|
# Same as reply_with, but for inline queries.
|
||||||
def answer_inline_query(results, params = {})
|
def answer_inline_query(results, params = {})
|
||||||
params = params.merge(
|
params = params.merge(
|
||||||
inline_query_id: payload['id'],
|
inline_query_id: payload['id'],
|
||||||
@@ -30,7 +28,7 @@ module Telegram
|
|||||||
bot.answer_inline_query(params)
|
bot.answer_inline_query(params)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Same as respond_with, but for callback queries.
|
# Same as reply_with, but for callback queries.
|
||||||
def answer_callback_query(text, params = {})
|
def answer_callback_query(text, params = {})
|
||||||
params = params.merge(
|
params = params.merge(
|
||||||
callback_query_id: payload['id'],
|
callback_query_id: payload['id'],
|
||||||
@@ -38,36 +36,6 @@ module Telegram
|
|||||||
)
|
)
|
||||||
bot.answer_callback_query(params)
|
bot.answer_callback_query(params)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Same as respond_with, but for pre checkout queries.
|
|
||||||
def answer_pre_checkout_query(ok, params = {})
|
|
||||||
params = params.merge(
|
|
||||||
pre_checkout_query_id: payload['id'],
|
|
||||||
ok: ok,
|
|
||||||
)
|
|
||||||
bot.answer_pre_checkout_query(params)
|
|
||||||
end
|
|
||||||
|
|
||||||
def answer_shipping_query(ok, params = {})
|
|
||||||
params = params.merge(
|
|
||||||
shipping_query_id: payload['id'],
|
|
||||||
ok: ok,
|
|
||||||
)
|
|
||||||
bot.answer_shipping_query(params)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Edit message from callback query.
|
|
||||||
def edit_message(type, params = {})
|
|
||||||
params =
|
|
||||||
if message_id = payload['inline_message_id'] # rubocop:disable AssignmentInCondition
|
|
||||||
params.merge(inline_message_id: message_id)
|
|
||||||
elsif message = payload['message'] # rubocop:disable AssignmentInCondition
|
|
||||||
params.merge(chat_id: message['chat']['id'], message_id: message['message_id'])
|
|
||||||
else
|
|
||||||
raise 'Can not edit message without `inline_message_id` or `message`'
|
|
||||||
end
|
|
||||||
bot.public_send("edit_message_#{type}", params)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
require 'active_support/rescuable'
|
|
||||||
|
|
||||||
module Telegram
|
|
||||||
module Bot
|
|
||||||
class UpdatesController
|
|
||||||
module Rescue
|
|
||||||
extend ActiveSupport::Concern
|
|
||||||
include ActiveSupport::Rescuable
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def process_action(*)
|
|
||||||
super
|
|
||||||
rescue Exception => exception # rubocop:disable RescueException
|
|
||||||
rescue_with_handler(exception) || raise
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,41 +1,37 @@
|
|||||||
require 'telegram/bot/updates_controller/testing'
|
require 'telegram/bot/updates_controller/testing'
|
||||||
require 'telegram/bot/rspec/message_helpers'
|
|
||||||
require 'telegram/bot/rspec/callback_query_helpers'
|
|
||||||
|
|
||||||
RSpec.shared_context 'telegram/bot/updates_controller' do
|
RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||||
include Telegram::Bot::RSpec::ClientMatchers
|
|
||||||
include_context 'telegram/bot/message_helpers'
|
|
||||||
include_context 'telegram/bot/callback_query', :callback_query
|
|
||||||
|
|
||||||
let(:controller_class) { described_class }
|
let(:controller_class) { described_class }
|
||||||
let(:controller) do
|
let(:controller) do
|
||||||
controller_class.new(*controller_args).tap do |x|
|
controller_class.new(bot, update).tap do |x|
|
||||||
x.extend Telegram::Bot::UpdatesController::Testing
|
x.extend Telegram::Bot::UpdatesController::Testing
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
let(:controller_args) { [bot, deep_stringify(update)] }
|
let(:update) { build_update(payload_type, payload) }
|
||||||
let(:update) { {payload_type => payload} }
|
|
||||||
let(:payload_type) { :some_type }
|
let(:payload_type) { :some_type }
|
||||||
let(:payload) { double(:payload) }
|
let(:payload) { double(:payload) }
|
||||||
let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
|
let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
|
||||||
let(:bot_name) { 'bot' }
|
let(:bot_name) { 'bot' }
|
||||||
let(:session) { controller.send(:session) }
|
let(:session) { controller.send(:session) }
|
||||||
|
|
||||||
# Process update.
|
def dispatch(bot = self.bot, update = self.update)
|
||||||
def dispatch(update = self.update, bot = self.bot)
|
controller.dispatch_again(bot, update)
|
||||||
controller.dispatch_again(bot, deep_stringify(update))
|
end
|
||||||
|
|
||||||
|
def dispatch_message(text, options = {})
|
||||||
|
update = build_update :message, options.merge(text: text)
|
||||||
|
dispatch bot, update
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_update(type, content)
|
||||||
|
deep_stringify type => content
|
||||||
end
|
end
|
||||||
|
|
||||||
# Same as `.as_json` but mocks-friendly.
|
|
||||||
def deep_stringify(input)
|
def deep_stringify(input)
|
||||||
case input
|
case input
|
||||||
when Array then input.map(&method(__callee__))
|
when Array then input.map(&method(__callee__))
|
||||||
when Hash then input.map { |k, v| [k.to_s, deep_stringify(v)] }.to_h
|
when Hash then input.transform_keys(&:to_s).transform_values(&method(__callee__))
|
||||||
else input
|
else input
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
Telegram::Bot::RSpec.with_include_context do |config|
|
|
||||||
config.include_context 'telegram/bot/updates_controller', type: :telegram_bot_controller
|
|
||||||
end
|
|
||||||
|
|||||||
@@ -8,26 +8,19 @@ module Telegram
|
|||||||
module Session
|
module Session
|
||||||
extend ActiveSupport::Concern
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
module ClassMethods
|
|
||||||
# Builds session with given key and optional store (default to session_store).
|
|
||||||
# This way it's easier to define multiple custom sessions,
|
|
||||||
# ex. one for group chat and one for user.
|
|
||||||
def build_session(key, store = session_store)
|
|
||||||
raise 'session_store is not configured' unless store
|
|
||||||
key ? SessionHash.new(store, key) : NullSessionHash.new
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def process_action(*)
|
def process_action(*)
|
||||||
super
|
super
|
||||||
ensure
|
ensure
|
||||||
session.commit if @_session
|
session.commit
|
||||||
end
|
end
|
||||||
|
|
||||||
protected
|
protected
|
||||||
|
|
||||||
def session
|
def session
|
||||||
@_session ||= self.class.build_session(session_key)
|
@_session ||= begin
|
||||||
|
key = session_key
|
||||||
|
key ? SessionHash.new(self.class.session_store, key) : NullSessionHash.new
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def session_key
|
def session_key
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ module Telegram
|
|||||||
module Bot
|
module Bot
|
||||||
class UpdatesController
|
class UpdatesController
|
||||||
module Testing
|
module Testing
|
||||||
IVARS_TO_KEEP = %i[@_session].freeze
|
IVARS_TO_KEEP = %i(@_session).freeze
|
||||||
|
|
||||||
# Perform multiple dispatches on same instance.
|
# Perform multiple dispatches on same instance.
|
||||||
def dispatch_again(bot = nil, update = nil)
|
def dispatch_again(bot = nil, update = nil)
|
||||||
|
|||||||
@@ -1,47 +0,0 @@
|
|||||||
module Telegram
|
|
||||||
module Bot
|
|
||||||
class UpdatesController
|
|
||||||
# Provides helpers similar to AbstractController::Translation
|
|
||||||
# but by default uses `action_name_i18n_key` in lazy translation keys
|
|
||||||
# which strips `!` from action names by default. This makes translating
|
|
||||||
# strings for commands more convenient.
|
|
||||||
#
|
|
||||||
# To disable this behaviour use `alias_method :action_name_i18n_key, :action_name`.
|
|
||||||
module Translation
|
|
||||||
extend ActiveSupport::Concern
|
|
||||||
|
|
||||||
module ClassMethods
|
|
||||||
# Class-level helper for lazy translations.
|
|
||||||
def translate(key, options = {})
|
|
||||||
key = "#{controller_path.tr('/', '.')}#{key}" if key.to_s.start_with?('.')
|
|
||||||
I18n.translate(key, options)
|
|
||||||
end
|
|
||||||
alias :t :translate
|
|
||||||
end
|
|
||||||
|
|
||||||
# See toplevel description.
|
|
||||||
def translate(key, options = {})
|
|
||||||
if key.to_s.start_with?('.')
|
|
||||||
path = controller_path.tr('/', '.')
|
|
||||||
defaults = [:"#{path}#{key}"]
|
|
||||||
defaults << options[:default] if options[:default]
|
|
||||||
options[:default] = defaults.flatten
|
|
||||||
key = "#{path}.#{action_name_i18n_key}#{key}"
|
|
||||||
end
|
|
||||||
I18n.translate(key, options)
|
|
||||||
end
|
|
||||||
alias :t :translate
|
|
||||||
|
|
||||||
# Strips trailing `!` from action_name.
|
|
||||||
def action_name_i18n_key
|
|
||||||
action_name.chomp('!')
|
|
||||||
end
|
|
||||||
|
|
||||||
def localize(*args)
|
|
||||||
I18n.localize(*args)
|
|
||||||
end
|
|
||||||
alias :l :localize
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -27,12 +27,12 @@ module Telegram
|
|||||||
attr_reader :bot, :controller, :timeout, :offset, :logger, :running, :reload
|
attr_reader :bot, :controller, :timeout, :offset, :logger, :running, :reload
|
||||||
|
|
||||||
def initialize(bot, controller, **options)
|
def initialize(bot, controller, **options)
|
||||||
@logger = options.fetch(:logger) { defined?(Rails.logger) && Rails.logger }
|
@logger = options.fetch(:logger) { defined?(Rails) && Rails.logger }
|
||||||
@bot = bot
|
@bot = bot
|
||||||
@controller = controller
|
@controller = controller
|
||||||
@timeout = options.fetch(:timeout) { DEFAULT_TIMEOUT }
|
@timeout = options.fetch(:timeout) { DEFAULT_TIMEOUT }
|
||||||
@offset = options[:offset]
|
@offset = options[:offset]
|
||||||
@reload = options.fetch(:reload) { defined?(Rails.env) && Rails.env.development? }
|
@reload = options.fetch(:reload) { defined?(Rails) && Rails.env.development? }
|
||||||
end
|
end
|
||||||
|
|
||||||
def log(&block)
|
def log(&block)
|
||||||
@@ -41,77 +41,47 @@ module Telegram
|
|||||||
|
|
||||||
def start
|
def start
|
||||||
return if running
|
return if running
|
||||||
begin
|
@running = true
|
||||||
@running = true
|
log { 'Started bot poller.' }
|
||||||
log { 'Started bot poller.' }
|
|
||||||
run
|
|
||||||
rescue Interrupt
|
|
||||||
nil # noop
|
|
||||||
ensure
|
|
||||||
@running = false
|
|
||||||
end
|
|
||||||
log { 'Stoped polling bot updates.' }
|
|
||||||
end
|
|
||||||
|
|
||||||
def run
|
|
||||||
while running
|
while running
|
||||||
updates = fetch_updates
|
begin
|
||||||
process_updates(updates) if updates && updates.any?
|
fetch_updates do |update|
|
||||||
|
controller.dispatch(bot, update)
|
||||||
|
end
|
||||||
|
rescue Interrupt
|
||||||
|
@running = false
|
||||||
|
rescue => e
|
||||||
|
logger.error { ([e.message] + e.backtrace).join("\n") } if logger
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
log { 'Stop polling bot updates.' }
|
||||||
end
|
end
|
||||||
|
|
||||||
# Method to stop poller from other thread.
|
|
||||||
def stop
|
def stop
|
||||||
return unless running
|
return unless running
|
||||||
log { 'Stopping polling bot updates.' }
|
log { 'Killing polling thread.' }
|
||||||
@running = false
|
@running = false
|
||||||
end
|
end
|
||||||
|
|
||||||
def fetch_updates(offset = self.offset)
|
def fetch_updates
|
||||||
response = bot.async(false) { bot.get_updates(offset: offset, timeout: timeout) }
|
response = bot.get_updates(offset: offset, timeout: timeout)
|
||||||
response.is_a?(Array) ? response : response['result']
|
return unless response['ok'] && response['result'].any?
|
||||||
rescue Timeout::Error
|
|
||||||
log { 'Fetch timeout' }
|
|
||||||
nil
|
|
||||||
end
|
|
||||||
|
|
||||||
def process_updates(updates)
|
|
||||||
reload! do
|
reload! do
|
||||||
updates.each do |update|
|
response['result'].each do |update|
|
||||||
@offset = update['update_id'] + 1
|
@offset = update['update_id'] + 1
|
||||||
process_update(update)
|
yield update
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
rescue StandardError => e
|
rescue Timeout::Error # rubocop:disable HandleExceptions
|
||||||
logger.error { ([e.message] + e.backtrace).join("\n") } if logger
|
|
||||||
end
|
|
||||||
|
|
||||||
# Override this method to setup custom error collector.
|
|
||||||
def process_update(update)
|
|
||||||
controller.dispatch(bot, update)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def reload!
|
def reload!
|
||||||
return yield unless reload
|
return yield unless reload
|
||||||
reloading_code do
|
ActionDispatch::Reloader.prepare!
|
||||||
if controller.is_a?(Class) && controller.name
|
if controller.is_a?(Class) && controller.name
|
||||||
@controller = Object.const_get(controller.name)
|
@controller = Object.const_get(controller.name)
|
||||||
end
|
|
||||||
yield
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
if defined?(Rails.application) && Rails.application.respond_to?(:reloader)
|
|
||||||
def reloading_code
|
|
||||||
Rails.application.reloader.wrap do
|
|
||||||
yield
|
|
||||||
end
|
|
||||||
end
|
|
||||||
else
|
|
||||||
def reloading_code
|
|
||||||
ActionDispatch::Reloader.prepare!
|
|
||||||
yield.tap { ActionDispatch::Reloader.cleanup! }
|
|
||||||
end
|
end
|
||||||
|
yield.tap { ActionDispatch::Reloader.cleanup! }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
module Telegram
|
module Telegram
|
||||||
module Bot
|
module Bot
|
||||||
VERSION = '0.14.3'.freeze
|
VERSION = '0.7.1'.freeze
|
||||||
|
|
||||||
def self.gem_version
|
def self.gem_version
|
||||||
Gem::Version.new VERSION
|
Gem::Version.new VERSION
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
require 'integration_helper'
|
|
||||||
|
|
||||||
RSpec.describe DefaultBotController, telegram_bot: :rails do
|
|
||||||
describe '#start' do
|
|
||||||
subject { -> { dispatch_command :start } }
|
|
||||||
it { should respond_with_message 'from default' }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#load_session' do
|
|
||||||
subject { -> { dispatch_command :load_session } }
|
|
||||||
it { should_not raise_error }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
require 'integration_helper'
|
|
||||||
|
|
||||||
RSpec.describe NamedBotController, telegram_bot: :rails do
|
|
||||||
let(:bot) { Telegram.bots[:named] }
|
|
||||||
describe '#start' do
|
|
||||||
subject { -> { dispatch_command :start } }
|
|
||||||
it { should respond_with_message 'from named' }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
require 'integration_helper'
|
|
||||||
|
|
||||||
RSpec.describe OtherBotController, telegram_bot: :rails do
|
|
||||||
let(:bot) { Telegram.bots[:other] }
|
|
||||||
describe '#start' do
|
|
||||||
subject { -> { dispatch_command :start } }
|
|
||||||
it { should respond_with_message 'from other' }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#load_session' do
|
|
||||||
subject { -> { dispatch_command :load_session } }
|
|
||||||
it { should raise_error(/session_store is not configured/) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/rails'
|
|
||||||
require 'action_controller'
|
|
||||||
require 'action_dispatch'
|
|
||||||
|
|
||||||
require 'rails'
|
|
||||||
require 'telegram/bot/railtie'
|
|
||||||
require 'rspec/rails/adapters'
|
|
||||||
require 'rspec/rails/fixture_support'
|
|
||||||
require 'rspec/rails/example/rails_example_group'
|
|
||||||
require 'rspec/rails/example/request_example_group'
|
|
||||||
|
|
||||||
ENV['RAILS_ENV'] = 'test'
|
|
||||||
class TestApplication < Rails::Application
|
|
||||||
config.eager_load = false
|
|
||||||
config.log_level = :debug
|
|
||||||
config.action_dispatch.show_exceptions = false
|
|
||||||
|
|
||||||
telegram_config = {
|
|
||||||
bot: 'default_token',
|
|
||||||
bots: {
|
|
||||||
other: {token: 'other_token'},
|
|
||||||
named: {token: 'named_token', username: 'TestBot'},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
if respond_to?(:credentials)
|
|
||||||
credentials.config[:telegram] = telegram_config
|
|
||||||
else
|
|
||||||
secrets[:secret_key_base] = 'test'
|
|
||||||
secrets[:telegram] = telegram_config
|
|
||||||
end
|
|
||||||
end
|
|
||||||
Rails.application.initialize!
|
|
||||||
|
|
||||||
# # Controllers
|
|
||||||
%w[default other named].each do |bot_name|
|
|
||||||
controller = Class.new(Telegram::Bot::UpdatesController) do
|
|
||||||
define_method :start! do |*|
|
|
||||||
respond_with :message, text: "from #{bot_name}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
Object.const_set("#{bot_name}_bot_controller".camelize, controller)
|
|
||||||
end
|
|
||||||
|
|
||||||
[DefaultBotController, OtherBotController].each do |klass|
|
|
||||||
klass.class_eval do
|
|
||||||
use_session!
|
|
||||||
|
|
||||||
define_method :load_session! do |*|
|
|
||||||
session[:test]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
DefaultBotController.session_store = :memory_store
|
|
||||||
|
|
||||||
RSpec.configure do |config|
|
|
||||||
config.include RSpec::Rails::RequestExampleGroup, type: :request
|
|
||||||
|
|
||||||
config.around type: :request do |ex|
|
|
||||||
begin
|
|
||||||
Telegram.reset_bots
|
|
||||||
Telegram::Bot::ClientStub.stub_all!
|
|
||||||
ex.run
|
|
||||||
ensure
|
|
||||||
Telegram.reset_bots
|
|
||||||
Telegram::Bot::ClientStub.stub_all!(false)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
config.before type: :request do
|
|
||||||
# Redefine routes before every example, so it does not depent on order.
|
|
||||||
Rails.application.routes.draw do
|
|
||||||
require 'telegram/bot/routes_helper'
|
|
||||||
extend Telegram::Bot::RoutesHelper
|
|
||||||
|
|
||||||
telegram_webhook DefaultBotController, :default
|
|
||||||
telegram_webhook OtherBotController, :other
|
|
||||||
telegram_webhook NamedBotController, :named
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -16,9 +16,6 @@ $LOAD_PATH.unshift GEM_ROOT.join('lib')
|
|||||||
require 'telegram/bot'
|
require 'telegram/bot'
|
||||||
require 'telegram/bot/updates_controller/rspec_helpers'
|
require 'telegram/bot/updates_controller/rspec_helpers'
|
||||||
require 'telegram/bot/types'
|
require 'telegram/bot/types'
|
||||||
require 'active_support/json'
|
|
||||||
|
|
||||||
Dir[GEM_ROOT.join('spec/support/**/*.rb')].each { |f| require f }
|
|
||||||
|
|
||||||
RSpec.configure do |config|
|
RSpec.configure do |config|
|
||||||
config.expect_with :rspec do |expectations|
|
config.expect_with :rspec do |expectations|
|
||||||
@@ -32,14 +29,6 @@ RSpec.configure do |config|
|
|||||||
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
||||||
end
|
end
|
||||||
|
|
||||||
# This config option will be enabled by default on RSpec 4,
|
|
||||||
# but for reasons of backwards compatibility, you have to
|
|
||||||
# set it on RSpec 3.
|
|
||||||
#
|
|
||||||
# It causes the host group and examples to inherit metadata
|
|
||||||
# from the shared context.
|
|
||||||
config.shared_context_metadata_behavior = :apply_to_host_groups
|
|
||||||
|
|
||||||
config.mock_with :rspec do |mocks|
|
config.mock_with :rspec do |mocks|
|
||||||
# Prevents you from mocking or stubbing a method that does not exist on
|
# Prevents you from mocking or stubbing a method that does not exist on
|
||||||
# a real object. This is generally recommended, and will default to
|
# a real object. This is generally recommended, and will default to
|
||||||
|
|||||||
@@ -1,143 +0,0 @@
|
|||||||
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 }
|
|
||||||
let!(:application_job_class) do
|
|
||||||
klass = Class.new do
|
|
||||||
def self.perform_later(*)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
klass.tap { |x| stub_const('ApplicationJob', x) }
|
|
||||||
end
|
|
||||||
after { described_class.default_async_job = nil }
|
|
||||||
|
|
||||||
describe '#async' do
|
|
||||||
subject { ->(*args, &block) { instance.async(*args, &block) } }
|
|
||||||
its(:call) { should eq described_class.default_async_job }
|
|
||||||
|
|
||||||
context 'when async is disabled' do
|
|
||||||
let(:async) { false }
|
|
||||||
its(:call) { should eq false }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when using with block' do
|
|
||||||
it 'sets value inside block' do
|
|
||||||
expect do
|
|
||||||
expect do
|
|
||||||
subject.call(false) do
|
|
||||||
expect do
|
|
||||||
subject.call(nil) { expect(subject[]).to eq nil }
|
|
||||||
end.to_not change(&subject).from false
|
|
||||||
raise 'TestError'
|
|
||||||
end
|
|
||||||
end.to raise_error(/TestError/)
|
|
||||||
end.to_not change(instance, :async).from(described_class.default_async_job)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'in multi-threaded environment' do
|
|
||||||
it 'changes only in current thread' do
|
|
||||||
thread = nil
|
|
||||||
expect do
|
|
||||||
thread = Thread.new do
|
|
||||||
expect do
|
|
||||||
subject.call(false) do
|
|
||||||
expect(subject[]).to eq false
|
|
||||||
end
|
|
||||||
end.to_not change(instance, :async).from(described_class.default_async_job)
|
|
||||||
sleep 0.2
|
|
||||||
end
|
|
||||||
end.to_not change(instance, :async).from(described_class.default_async_job)
|
|
||||||
thread.join
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'uses default value after block' do
|
|
||||||
thread = Thread.new do
|
|
||||||
subject.call(false) {}
|
|
||||||
expect { sleep 0.2 }.to change(instance, :async).
|
|
||||||
from(described_class.default_async_job).to(nil)
|
|
||||||
end
|
|
||||||
sleep 0.1
|
|
||||||
instance.async = nil
|
|
||||||
thread.join
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#async=' do
|
|
||||||
subject { ->(val = new_val) { instance.async = val } }
|
|
||||||
let(:async) {}
|
|
||||||
|
|
||||||
context 'when true is given' do
|
|
||||||
let(:new_val) { true }
|
|
||||||
it { should change(instance, :async).to described_class.default_async_job }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when false is given' do
|
|
||||||
let(:new_val) { false }
|
|
||||||
it { should change(instance, :async).to false }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when string is given' do
|
|
||||||
let(:new_val) { 'Telegram::Bot::Client' }
|
|
||||||
it { should change(instance, :async).to Object.const_get(new_val) }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'in multi-threaded environment' do
|
|
||||||
subject { ->(val = new_val) { Thread.new { instance.async = val }.join } }
|
|
||||||
let(:new_val) { true }
|
|
||||||
it { should change(instance, :async).to described_class.default_async_job }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '.default_async_job' do
|
|
||||||
subject { described_class.default_async_job }
|
|
||||||
its(:superclass) { should eq application_job_class }
|
|
||||||
it { should include Telegram::Bot::Async::Job }
|
|
||||||
its(:client_class) { should eq described_class }
|
|
||||||
|
|
||||||
context 'when ApplicationJob is not defined' do
|
|
||||||
let(:application_job_class) {}
|
|
||||||
it { expect { subject }.to raise_error(/Define ApplicationJob/) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#request' do
|
|
||||||
subject { ->(*args) { instance.request(*(args.empty? ? self.args : args)) } }
|
|
||||||
let(:args, &request_args)
|
|
||||||
let(:result) { double(:result) }
|
|
||||||
|
|
||||||
shared_examples 'enqueues job' do
|
|
||||||
it 'enqueues job' do
|
|
||||||
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
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
include_examples 'enqueues job'
|
|
||||||
|
|
||||||
context 'with custom job class' do
|
|
||||||
let(:async) { double(:job_class) }
|
|
||||||
include_examples 'enqueues job'
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when id is not set' do
|
|
||||||
let(:id) {}
|
|
||||||
it { should raise_error(/Can not enqueue/) }
|
|
||||||
end
|
|
||||||
|
|
||||||
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'
|
|
||||||
end
|
|
||||||
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
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
RSpec.shared_examples 'shared integration examples' do
|
|
||||||
let(:bot) { Telegram::Bot::ClientStub.new('token') }
|
|
||||||
let(:controller_class) do
|
|
||||||
Class.new(Telegram::Bot::UpdatesController) do
|
|
||||||
def start!(data = nil, *)
|
|
||||||
respond_with :message, text: "Hi #{data}"
|
|
||||||
end
|
|
||||||
|
|
||||||
def callback_query(data, *)
|
|
||||||
answer_callback_query "pong: #{data}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#start' do
|
|
||||||
subject { -> { dispatch_command(:start, :test_data) } }
|
|
||||||
it { should respond_with_message('Hi test_data') }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#callback_query', :callback_query do
|
|
||||||
let(:data) { :test_data }
|
|
||||||
it { should answer_callback_query "pong: #{data}" }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
RSpec.describe Telegram::Bot::Async::Job do
|
|
||||||
let(:job_class) do
|
|
||||||
described_class = self.described_class
|
|
||||||
client_class = self.client_class
|
|
||||||
Class.new do
|
|
||||||
include described_class
|
|
||||||
self.client_class = client_class
|
|
||||||
end
|
|
||||||
end
|
|
||||||
let(:client_class) { Telegram::Bot::Client }
|
|
||||||
let(:instance) { job_class.new }
|
|
||||||
|
|
||||||
describe '#perform' do
|
|
||||||
subject { instance.perform(id, *args) }
|
|
||||||
let(:id) { 'bot_id' }
|
|
||||||
let(:args) { [double(:action), {body: :content}] }
|
|
||||||
let(:client) { Telegram::Bot::Client.new(async: custom_job_class) }
|
|
||||||
let(:custom_job_class) { Class.new }
|
|
||||||
let(:result) { double(status: 200, body: '{"test":"ok"}') }
|
|
||||||
|
|
||||||
it 'finds client and performs request' do
|
|
||||||
expect(client_class).to receive(:wrap).with(id.to_sym) { client }
|
|
||||||
expect(client).to receive(:request).with(*args).and_call_original
|
|
||||||
expect(client).to receive(:http_request) { result }
|
|
||||||
should eq 'test' => 'ok'
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -3,7 +3,7 @@ RSpec.describe Telegram::Bot::Client::TypedResponse do
|
|||||||
|
|
||||||
describe '#get_me' do
|
describe '#get_me' do
|
||||||
subject { bot.get_me }
|
subject { bot.get_me }
|
||||||
before { expect(bot).to receive(:request).with('getMe') { response } }
|
before { expect(bot).to receive(:request).with(:getMe) { response } }
|
||||||
let(:response) { {'ok' => true, 'result' => {'id' => user_id}} }
|
let(:response) { {'ok' => true, 'result' => {'id' => user_id}} }
|
||||||
let(:user_id) { 123 }
|
let(:user_id) { 123 }
|
||||||
it { should be_instance_of Telegram::Bot::Types::User }
|
it { should be_instance_of Telegram::Bot::Types::User }
|
||||||
@@ -17,7 +17,7 @@ RSpec.describe Telegram::Bot::Client::TypedResponse do
|
|||||||
|
|
||||||
describe '#get_updates' do
|
describe '#get_updates' do
|
||||||
subject { bot.get_updates }
|
subject { bot.get_updates }
|
||||||
before { expect(bot).to receive(:request).with('getUpdates') { response } }
|
before { expect(bot).to receive(:request).with(:getUpdates) { response } }
|
||||||
let(:response) { {'ok' => true, 'result' => [{'update_id' => update_id}]} }
|
let(:response) { {'ok' => true, 'result' => [{'update_id' => update_id}]} }
|
||||||
let(:update_id) { 123 }
|
let(:update_id) { 123 }
|
||||||
it { should be_instance_of Array }
|
it { should be_instance_of Array }
|
||||||
@@ -29,16 +29,4 @@ RSpec.describe Telegram::Bot::Client::TypedResponse do
|
|||||||
it { expect { subject }.to raise_error Telegram::Bot::Error }
|
it { expect { subject }.to raise_error Telegram::Bot::Error }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '#delete_webhook' do
|
|
||||||
subject { bot.delete_webhook }
|
|
||||||
before { expect(bot).to receive(:request).with('deleteWebhook') { response } }
|
|
||||||
let(:response) { {'ok' => true, 'result' => true} }
|
|
||||||
it { should eq true }
|
|
||||||
|
|
||||||
context 'on error' do
|
|
||||||
let(:response) { raise Telegram::Bot::Error }
|
|
||||||
it { expect { subject }.to raise_error Telegram::Bot::Error }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,9 +1,73 @@
|
|||||||
RSpec.describe Telegram::Bot::Client do
|
RSpec.describe Telegram::Bot::Client do
|
||||||
let(:instance) { described_class.new 'token' }
|
let(:instance) { described_class.new 'token' }
|
||||||
let(:token) { 'token' }
|
let(:token) { 'token' }
|
||||||
|
let(:botan_token) { double(:botan_token) }
|
||||||
|
|
||||||
include_examples 'initializers'
|
describe '.wrap' do
|
||||||
it_behaves_like 'async', request_args: -> { [double(:action), {body: :content}] }
|
subject { described_class.wrap(input) }
|
||||||
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when input is a hash' do
|
||||||
|
let(:input) { {token: token, username: username, ignore: :ignore} }
|
||||||
|
|
||||||
|
it 'extracts token & username' do
|
||||||
|
expect(described_class).to receive(:new).
|
||||||
|
with(token, username, botan: nil) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when `botan` is given' do
|
||||||
|
let(:input) { super().merge(botan: botan_token) }
|
||||||
|
|
||||||
|
it 'passes it to initializer' do
|
||||||
|
expect(described_class).to receive(:new).
|
||||||
|
with(token, username, botan: botan_token) { 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) { :bot_1 }
|
||||||
|
before { allow(Telegram).to receive(:bots) { {bot_1: instance} } }
|
||||||
|
it { should eq Telegram.bots[:bot_1] }
|
||||||
|
|
||||||
|
context 'and there is no such bot' do
|
||||||
|
let(:input) { :invalid }
|
||||||
|
it { expect { subject }.to raise_error(/not configured/) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when input is an array' do
|
||||||
|
let!(:input) { ['other_token', instance, token: token, username: username] }
|
||||||
|
let(:result_2) { double(:result_2) }
|
||||||
|
|
||||||
|
it 'calls wrap for every element' do
|
||||||
|
expect(described_class).to receive(:new).with('other_token') { result }
|
||||||
|
expect(described_class).to receive(:new).with(token, username, botan: nil) { result_2 }
|
||||||
|
should eq [result, instance, result_2]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
describe '.prepare_body' do
|
describe '.prepare_body' do
|
||||||
subject { described_class.prepare_body(input) }
|
subject { described_class.prepare_body(input) }
|
||||||
@@ -18,78 +82,20 @@ RSpec.describe Telegram::Bot::Client do
|
|||||||
|
|
||||||
it 'encodes nested hashes to json' do
|
it 'encodes nested hashes to json' do
|
||||||
expected = input.dup
|
expected = input.dup
|
||||||
%i[c d e].each { |x| expected[x] = expected[x].to_json }
|
%i(c d e).each { |x| expected[x] = expected[x].to_json }
|
||||||
should eq expected
|
should eq expected
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '.prepare_async_args' do
|
describe '#botan' do
|
||||||
subject { described_class.prepare_async_args(*input) }
|
subject { instance.botan }
|
||||||
let(:input) { [:action, a: 1, b: :sym, c: [:other], 'd' => 'str'] }
|
it { should eq nil }
|
||||||
it { should eq ['action', a: 1, b: 'sym', c: '["other"]', 'd' => 'str'] }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '.new' do
|
context 'when botan token is set' do
|
||||||
subject { described_class.new(*args) }
|
let(:instance) { described_class.new token, botan: botan_token }
|
||||||
|
it { should be_instance_of Telegram::Bot::Botan }
|
||||||
context 'when multiple args are given' do
|
its(:token) { should eq botan_token }
|
||||||
let(:args) { %w[secret superbot] }
|
|
||||||
its(:token) { should eq args[0] }
|
|
||||||
its(:username) { should eq args[1] }
|
|
||||||
its(:base_uri) { should include args[0] }
|
|
||||||
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] }
|
|
||||||
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(:request_body) { double(:body) }
|
|
||||||
let(:prepared_body) { double(:prepared_body) }
|
|
||||||
let(:response) { HTTP::Message.new_response(body).tap { |x| x.status = status } }
|
|
||||||
|
|
||||||
let(:status) { 200 }
|
|
||||||
let(:body) { body_json.to_json }
|
|
||||||
let(:body_json) { {'param' => 'val', 'description' => 'some description'} }
|
|
||||||
before do
|
|
||||||
expect(described_class).to receive(:prepare_body).with(request_body) { prepared_body }
|
|
||||||
expect(instance).to receive(:http_request).with(url, prepared_body) { response }
|
|
||||||
end
|
|
||||||
around { |ex| Telegram::Bot::ClientStub.stub_all!(false) { ex.run } }
|
|
||||||
|
|
||||||
shared_examples 'invalid body' do |error = Telegram::Bot::Error|
|
|
||||||
context 'when body is not json' do
|
|
||||||
let(:body) { '{' }
|
|
||||||
it { should raise_error error }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
its(:call) { should eq body_json }
|
|
||||||
include_examples 'invalid body', JSON::ParserError
|
|
||||||
|
|
||||||
context 'when status is 403' do
|
|
||||||
let(:status) { 403 }
|
|
||||||
it { should raise_error Telegram::Bot::Forbidden, body_json['description'] }
|
|
||||||
include_examples 'invalid body'
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when status is 404' do
|
|
||||||
let(:status) { 404 }
|
|
||||||
it { should raise_error Telegram::Bot::NotFound, body_json['description'] }
|
|
||||||
include_examples 'invalid body'
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when status is other' do
|
|
||||||
let(:status) { 500 }
|
|
||||||
it { should raise_error Telegram::Bot::Error, /#{body_json['description']}/ }
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
RSpec.describe Telegram::Bot::ClientStub do
|
RSpec.describe Telegram::Bot::ClientStub do
|
||||||
describe '#stub_all!' do
|
describe '#stub_all!' do
|
||||||
let(:client) { Telegram::Bot::Client.new('token', 'bot_name') }
|
let(:client) { Telegram::Bot::Client.new('token', 'bot_name') }
|
||||||
let(:clients) { ['token', token: 'token2'].map(&Telegram::Bot::Client.method(:wrap)) }
|
let(:clients) { Telegram::Bot::Client.wrap(['token', token: 'token2']) }
|
||||||
|
|
||||||
shared_examples 'constructors' do |expected_class|
|
shared_examples 'constructors' do |expected_class|
|
||||||
it 'makes Client.new return ClientStub' do
|
it 'makes Client.new return ClientStub' do
|
||||||
@@ -9,7 +9,7 @@ RSpec.describe Telegram::Bot::ClientStub do
|
|||||||
expect(client.username).to eq 'bot_name'
|
expect(client.username).to eq 'bot_name'
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'makes Client.wrap return ClientStub' do
|
it 'makes Client.wrap raturn ClientStub' do
|
||||||
expect(clients).to contain_exactly instance_of(expected_class),
|
expect(clients).to contain_exactly instance_of(expected_class),
|
||||||
instance_of(expected_class)
|
instance_of(expected_class)
|
||||||
end
|
end
|
||||||
@@ -35,25 +35,4 @@ RSpec.describe Telegram::Bot::ClientStub do
|
|||||||
include_examples 'constructors', Telegram::Bot::Client
|
include_examples 'constructors', Telegram::Bot::Client
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '#new' do
|
|
||||||
subject { described_class.new(*args) }
|
|
||||||
|
|
||||||
context 'when only username is given' do
|
|
||||||
let(:args) { 'superbot' }
|
|
||||||
its(:username) { should eq args }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when username and token are given' do
|
|
||||||
let(:args) { %w[token superbot] }
|
|
||||||
its(:token) { should eq args[0] }
|
|
||||||
its(:username) { should eq args[1] }
|
|
||||||
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] }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,100 +0,0 @@
|
|||||||
RSpec.describe Telegram::Bot::ConfigMethods do
|
|
||||||
let(:registry) do
|
|
||||||
Object.new.tap do |x|
|
|
||||||
x.extend described_class
|
|
||||||
x.bots_config = config
|
|
||||||
end
|
|
||||||
end
|
|
||||||
let(:config) do
|
|
||||||
{
|
|
||||||
default: 'default_token',
|
|
||||||
chat: {
|
|
||||||
token: 'chat_token',
|
|
||||||
username: 'Chat',
|
|
||||||
},
|
|
||||||
other_chat: {
|
|
||||||
'token' => 'other_chat_token',
|
|
||||||
'username' => 'OtherChat',
|
|
||||||
},
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#bot' do
|
|
||||||
subject { -> { registry.bot } }
|
|
||||||
its(:call) { should eq registry.bots[:default] }
|
|
||||||
|
|
||||||
context 'when bot is not configured' do
|
|
||||||
let(:config) { super().except(:default) }
|
|
||||||
it { should raise_error(/bot is not configured/) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#bots' do
|
|
||||||
context 'configured by token' do
|
|
||||||
subject { registry.bots[:default] }
|
|
||||||
its(:id) { should eq :default }
|
|
||||||
its(:token) { should eq config[:default] }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'configured by hash' do
|
|
||||||
subject { registry.bots[:chat] }
|
|
||||||
its(:id) { should eq :chat }
|
|
||||||
its(:token) { should eq config[:chat][:token] }
|
|
||||||
its(:username) { should eq config[:chat][:username] }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'configured by hash with stringified keys' do
|
|
||||||
subject { registry.bots[:other_chat] }
|
|
||||||
its(:id) { should eq :other_chat }
|
|
||||||
its(:token) { should eq config[:other_chat]['token'] }
|
|
||||||
its(:username) { should eq config[:other_chat]['username'] }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#bots_config' do
|
|
||||||
subject { registry.bots_config }
|
|
||||||
it { should eq config }
|
|
||||||
|
|
||||||
context 'when not configured' do
|
|
||||||
let(:registry) { Object.new.tap { |x| x.extend described_class } }
|
|
||||||
before { hide_const('Rails') }
|
|
||||||
it { should eq({}) }
|
|
||||||
|
|
||||||
context 'in rails environment' do
|
|
||||||
before { stub_const('Rails', double(application: double(app_stub))) }
|
|
||||||
let(:app_stub) { {secrets: secrets} }
|
|
||||||
let(:secrets) { {} }
|
|
||||||
it { should eq({}) }
|
|
||||||
|
|
||||||
context 'when there is telegram section in secrets' do
|
|
||||||
let(:secrets) { {telegram: secrets_config} }
|
|
||||||
let(:secrets_config) do
|
|
||||||
{
|
|
||||||
bot: double(:bot_config),
|
|
||||||
bots: {
|
|
||||||
chat: double(:chat_config),
|
|
||||||
other_chat: double(:other_chat_config),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
end
|
|
||||||
it { should include default: secrets_config[:bot] }
|
|
||||||
it { should include secrets_config[:bots] }
|
|
||||||
|
|
||||||
context 'on rails >5.1 (deep symbolized keys)' do
|
|
||||||
let(:secrets) { super().deep_symbolize_keys }
|
|
||||||
it { should include default: secrets_config[:bot] }
|
|
||||||
it { should include secrets_config[:bots] }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'and credentials (>= 5.2)' do
|
|
||||||
let(:app_stub) { super().merge(credentials: credentials) }
|
|
||||||
let(:credentials) { {telegram: credentials_config} }
|
|
||||||
let(:credentials_config) { {bot: double(:credentials_bot_config)} }
|
|
||||||
it { should include default: credentials_config[:bot] }
|
|
||||||
it { should_not include secrets[:bots] }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,5 +1,3 @@
|
|||||||
require 'rack/mock'
|
|
||||||
|
|
||||||
RSpec.describe Telegram::Bot::Middleware do
|
RSpec.describe Telegram::Bot::Middleware do
|
||||||
let(:instance) { described_class.new bot, controller }
|
let(:instance) { described_class.new bot, controller }
|
||||||
let(:bot) { double(:bot) }
|
let(:bot) { double(:bot) }
|
||||||
@@ -7,24 +5,11 @@ RSpec.describe Telegram::Bot::Middleware do
|
|||||||
|
|
||||||
describe '#call' do
|
describe '#call' do
|
||||||
subject { instance.call(env) }
|
subject { instance.call(env) }
|
||||||
let(:update) { {'message' => {'id' => 1}} }
|
let(:env) { {'action_dispatch.request.request_parameters' => json_body} }
|
||||||
let(:env) do
|
let(:json_body) { double(:json_body) }
|
||||||
Rack::MockRequest.env_for('/',
|
|
||||||
method: :post,
|
|
||||||
input: JSON.dump(update),
|
|
||||||
'CONTENT_TYPE' => 'application/json',
|
|
||||||
)
|
|
||||||
end
|
|
||||||
|
|
||||||
require 'action_pack/version'
|
|
||||||
if ActionPack::VERSION::MAJOR < 5
|
|
||||||
# Before Rails 5, params are parsed in middleware.
|
|
||||||
# In Rails 5, they are parsed in Request#request_parameters.
|
|
||||||
let(:instance) { ActionDispatch::ParamsParser.new(super()) }
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'calls dispatch on controller' do
|
it 'calls dispatch on controller' do
|
||||||
expect(controller).to receive(:dispatch).with(bot, update)
|
expect(controller).to receive(:dispatch).with(bot, json_body)
|
||||||
subject
|
subject
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -40,24 +40,25 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '#telegram_webhook' do
|
describe '#telegram_webhooks' do
|
||||||
subject { mapper.telegram_webhook(*input) }
|
subject { mapper.telegram_webhooks(*input) }
|
||||||
let(:mapper) { double(:mapper).tap { |x| x.extend described_class } }
|
let(:mapper) { double(:mapper).tap { |x| x.extend described_class } }
|
||||||
let(:bots) { {default: bot, other: other_bot} }
|
let(:bots) { {default: bot, other: other_bot} }
|
||||||
let(:controller) { double(:controller, name: :controller) }
|
let(:controller) { double(:controller, name: :controller) }
|
||||||
let(:other_controller) { double(:other_controller, name: :other_controller) }
|
let(:other_controller) { double(:other_controller, name: :other_controller) }
|
||||||
before { allow(Telegram).to receive(:bots) { bots } }
|
before { allow(Telegram).to receive(:bots) { bots } }
|
||||||
|
|
||||||
def assert_routes(bot, controller, route_name, options) # rubocop:disable AbcSize
|
def assert_routes(*expected) # rubocop:disable AbcSize
|
||||||
expected_path = options.delete(:path) || "telegram/#{bot.token}"
|
expected.each do |(bot, controller, route_name, options)|
|
||||||
expect(mapper).to receive(:post) do |path, params|
|
expect(mapper).to receive(:post) do |path, params|
|
||||||
expect(path).to eq expected_path
|
expect(path).to eq "telegram/#{bot.token}"
|
||||||
middleware = params[:to]
|
middleware = params[:to]
|
||||||
expect(middleware.controller).to eq(controller)
|
expect(middleware.controller).to eq(controller)
|
||||||
expect(middleware.bot.token).to eq(bot.token)
|
expect(middleware.bot.token).to eq(bot.token)
|
||||||
expect(middleware.bot.username).to eq(bot.username)
|
expect(middleware.bot.username).to eq(bot.username)
|
||||||
expect(params[:as]).to eq route_name
|
expect(params[:as]).to eq route_name
|
||||||
expect(params).to include(options) if options
|
expect(params).to include(options) if options
|
||||||
|
end
|
||||||
end
|
end
|
||||||
subject
|
subject
|
||||||
end
|
end
|
||||||
@@ -65,33 +66,57 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
|||||||
context 'when called with controller' do
|
context 'when called with controller' do
|
||||||
let(:input) { [controller, option: :val] }
|
let(:input) { [controller, option: :val] }
|
||||||
|
|
||||||
it 'creates routes for default bot and this controller' do
|
it 'creates routes for every bot and this controller' do
|
||||||
assert_routes bot, controller, 'default_telegram_webhook', option: :val
|
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
||||||
|
[other_bot, controller, 'other_telegram_webhook', option: :val]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when called with hash' do
|
||||||
|
let(:input) do
|
||||||
|
[
|
||||||
|
{
|
||||||
|
bot => controller,
|
||||||
|
'custom_token' => [other_controller, as: :custom_route, option: :other_val],
|
||||||
|
other: controller,
|
||||||
|
},
|
||||||
|
option: :val,
|
||||||
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'and bot does not have configured token' do
|
it 'creates routes for every bot and its controller' do
|
||||||
let(:bot) { create_bot(nil) }
|
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
||||||
it 'creates routes for default bot and this controller' do
|
[
|
||||||
assert_routes bot, controller, 'default_telegram_webhook', option: :val
|
create_bot('custom_token'),
|
||||||
end
|
other_controller,
|
||||||
end
|
:custom_route,
|
||||||
|
option: :other_val,
|
||||||
context 'and bot has colon in token' do
|
],
|
||||||
let(:bot) { create_bot('some:token') }
|
[Telegram.bots[:other], controller, 'other_telegram_webhook', option: :val]
|
||||||
it 'replaces colon with underscore' do
|
|
||||||
assert_routes bot, controller, 'default_telegram_webhook',
|
|
||||||
option: :val,
|
|
||||||
path: 'telegram/some_token'
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when called with controller and smth castable to bot' do
|
context 'when called with controller and smth castable to bot' do
|
||||||
let(:input) { [controller, 'custom_token', option: :val] }
|
let(:input) do
|
||||||
|
[
|
||||||
|
controller,
|
||||||
|
['custom_token', token: bot.token, username: 'new_name'],
|
||||||
|
option: :val,
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
it 'creates routes for every created bot and controller' do
|
it 'creates routes for every created bot and controller' do
|
||||||
assert_routes create_bot('custom_token'), controller, 'telegram_webhook',
|
assert_routes [
|
||||||
option: :val
|
create_bot('custom_token'),
|
||||||
|
controller,
|
||||||
|
'telegram_webhook',
|
||||||
|
option: :val,
|
||||||
|
], [
|
||||||
|
create_bot(bot.token, 'new_name'),
|
||||||
|
controller,
|
||||||
|
'telegram_webhook',
|
||||||
|
option: :val,
|
||||||
|
]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,42 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/poller'
|
|
||||||
|
|
||||||
RSpec.describe 'Integration spec helpers', telegram_bot: :poller do
|
|
||||||
let(:bot) { Telegram::Bot::ClientStub.new('token') }
|
|
||||||
let(:controller_class) do
|
|
||||||
Class.new(Telegram::Bot::UpdatesController) do
|
|
||||||
include Telegram::Bot::UpdatesController::CallbackQueryContext
|
|
||||||
|
|
||||||
def callback_query(data = nil, *)
|
|
||||||
answer_callback_query "data: #{data}"
|
|
||||||
end
|
|
||||||
|
|
||||||
def context_callback_query(data = nil, *)
|
|
||||||
answer_callback_query "data: #{data}", extra: :param
|
|
||||||
end
|
|
||||||
|
|
||||||
def answer_and_edit_callback_query(data = nil, *)
|
|
||||||
answer_callback_query "data: #{data}"
|
|
||||||
edit_message :text, text: 'edited-text', extra: :param
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#callback_query', :callback_query do
|
|
||||||
let(:data) { 'unknown:command' }
|
|
||||||
it { should answer_callback_query("data: #{data}") }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#context_callback_query', :callback_query do
|
|
||||||
let(:data) { 'context:test:payload' }
|
|
||||||
it { should answer_callback_query('data: test:payload', extra: :param) }
|
|
||||||
it { should_not edit_current_message(:text) }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#answer_and_edit_callback_query', :callback_query do
|
|
||||||
let(:data) { 'answer_and_edit:test:payload' }
|
|
||||||
it do
|
|
||||||
should answer_callback_query(/test:payload/).
|
|
||||||
and edit_current_message(:text, text: /edited/, extra: :param)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
RSpec.describe Telegram::Bot::RSpec::ClientMatchers do
|
|
||||||
let(:bot) { Telegram::Bot::ClientStub.new('TestBot') }
|
|
||||||
let(:other_bot) { Telegram::Bot::ClientStub.new('OtherTestBot') }
|
|
||||||
|
|
||||||
include described_class
|
|
||||||
|
|
||||||
describe '#make_telegram_request' do
|
|
||||||
context 'without args' do
|
|
||||||
it 'works for matching' do
|
|
||||||
block = ->(*) { bot.send_message(text: 'test') }
|
|
||||||
expect(&block).to make_telegram_request(bot, :sendMessage)
|
|
||||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).exactly(3).times
|
|
||||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).at_least(2).times
|
|
||||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).at_most(4).times
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for not-matching' do
|
|
||||||
block = ->(*) { bot.get_me }
|
|
||||||
expect {}.to_not make_telegram_request(bot, :getMe)
|
|
||||||
expect { other_bot.get_me }.to_not make_telegram_request(bot, :getMe)
|
|
||||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe)
|
|
||||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).exactly(2).times
|
|
||||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).exactly(4).times
|
|
||||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).at_least(4).times
|
|
||||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).at_most(2).times
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'with args' do
|
|
||||||
it 'works for exact matching' do
|
|
||||||
args = {text: 'test', parseMode: :Markdown}
|
|
||||||
block = ->(*) { bot.send_message(args) }
|
|
||||||
expect(&block).to make_telegram_request(bot, :sendMessage).with(args)
|
|
||||||
expect(&block).to_not make_telegram_request(bot, :sendMessage).with(args.except(:text))
|
|
||||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).
|
|
||||||
with(args).exactly(3).times
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for block matchers' do
|
|
||||||
args = {text: 'test', parseMode: :Markdown}
|
|
||||||
block = ->(*) { bot.send_message(args) }
|
|
||||||
expect(&block).to make_telegram_request(bot, :sendMessage).
|
|
||||||
with { |actual| expect(actual).to eq(args) }
|
|
||||||
# It ignores block's result! Custom expectations must be used inside block.
|
|
||||||
expect(&block).to make_telegram_request(bot, :sendMessage).
|
|
||||||
with { |actual| actual == {} }
|
|
||||||
expect do
|
|
||||||
expect(&block).to_not make_telegram_request(bot, :sendMessage).
|
|
||||||
with { |actual| expect(actual).to eq({}) }
|
|
||||||
end.to raise_error RSpec::Expectations::ExpectationNotMetError
|
|
||||||
n = -1
|
|
||||||
expect { 3.times { |i| bot.send_message text: i } }.
|
|
||||||
to make_telegram_request(bot, :sendMessage).exactly(3).times.
|
|
||||||
with { |actual| expect(actual).to eq(text: n += 1) }
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for RSpec::Mocks matchers' do
|
|
||||||
args = {text: 'test', parseMode: :Markdown}
|
|
||||||
block = ->(*) { bot.send_message(args) }
|
|
||||||
expect(&block).to make_telegram_request(bot, :sendMessage).with(hash_including(args))
|
|
||||||
expect(&block).to make_telegram_request(bot, :sendMessage).with(
|
|
||||||
text: a_string_matching(/est$/),
|
|
||||||
parseMode: :Markdown,
|
|
||||||
)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#send_telegram_message' do
|
|
||||||
let(:args) { {text: 'test', parseMode: :Markdown} }
|
|
||||||
let(:block) { ->(*) { bot.send_message(args) } }
|
|
||||||
|
|
||||||
it 'works for matching' do
|
|
||||||
expect(&block).to send_telegram_message(bot, 'test')
|
|
||||||
expect(&block).to send_telegram_message(bot, /^tes/)
|
|
||||||
expect(&block).to send_telegram_message(bot, 'test', parseMode: :Markdown)
|
|
||||||
expect(&block).to send_telegram_message(bot, a_string_including('es'))
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for not-matching' do
|
|
||||||
expect(&block).to_not send_telegram_message(bot, 'test!')
|
|
||||||
expect(&block).to_not send_telegram_message(bot, /tes$/)
|
|
||||||
expect(&block).to_not send_telegram_message(bot, 'test', parseMode: :HTML)
|
|
||||||
expect(&block).to_not send_telegram_message(bot, a_string_including('smth'))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/poller'
|
|
||||||
|
|
||||||
RSpec.describe 'Poller integration spec', telegram_bot: :poller do
|
|
||||||
include_examples 'shared integration examples'
|
|
||||||
end
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/rack'
|
|
||||||
|
|
||||||
RSpec.describe 'Rack integration spec', telegram_bot: :rack do
|
|
||||||
include_examples 'shared integration examples'
|
|
||||||
let(:request_path) { '/bot' }
|
|
||||||
let(:app) do
|
|
||||||
path = request_path
|
|
||||||
bot_app = Telegram::Bot::Middleware.new(bot, controller_class)
|
|
||||||
app = Rack::Builder.new do
|
|
||||||
map(path) { run bot_app }
|
|
||||||
run ->(env) { raise "Route is not mapped: #{env['PATH_INFO']}" }
|
|
||||||
end
|
|
||||||
if ActionPack::VERSION::MAJOR >= 5
|
|
||||||
app
|
|
||||||
else
|
|
||||||
require 'action_dispatch/middleware/params_parser'
|
|
||||||
ActionDispatch::ParamsParser.new(app)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
# Tested in spec/integration
|
|
||||||
@@ -1,115 +0,0 @@
|
|||||||
require 'telegram/bot/rspec/integration/poller'
|
|
||||||
|
|
||||||
RSpec.describe 'Integration: message helpers', telegram_bot: :poller do
|
|
||||||
describe '#default_message_options' do
|
|
||||||
subject { default_message_options }
|
|
||||||
it { should eq from: {id: from_id}, chat: {id: chat_id} }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#dispatch_message' do
|
|
||||||
subject { -> { dispatch_message text, options } }
|
|
||||||
let(:text) { '/start asd qwe' }
|
|
||||||
let(:options) { {} }
|
|
||||||
let(:result) { double(:result) }
|
|
||||||
|
|
||||||
it 'invokes dispatch' do
|
|
||||||
expect(self).to receive(:dispatch).with(
|
|
||||||
message: hash_including(default_message_options.merge(
|
|
||||||
text: text,
|
|
||||||
)),
|
|
||||||
) { result }
|
|
||||||
expect(subject.call).to eq result
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'with options' do
|
|
||||||
let(:options) { {option: 1} }
|
|
||||||
it 'invokes dispatch' do
|
|
||||||
expect(self).to receive(:dispatch).with(
|
|
||||||
message: hash_including(default_message_options.merge(
|
|
||||||
text: text,
|
|
||||||
).merge(options)),
|
|
||||||
) { result }
|
|
||||||
expect(subject.call).to eq result
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#dispatch_command' do
|
|
||||||
subject { -> { dispatch_command :start, *args } }
|
|
||||||
let(:args) { [] }
|
|
||||||
let(:result) { double(:result) }
|
|
||||||
|
|
||||||
it 'invokes dispatch' do
|
|
||||||
expect(self).to receive(:dispatch).with(
|
|
||||||
message: hash_including(default_message_options.merge(
|
|
||||||
text: '/start',
|
|
||||||
)),
|
|
||||||
) { result }
|
|
||||||
expect(subject.call).to eq result
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'with args & options' do
|
|
||||||
let(:args) { [*params, options] }
|
|
||||||
let(:params) { %w[qwe asd] }
|
|
||||||
let(:options) { {option: 1} }
|
|
||||||
it 'invokes dispatch' do
|
|
||||||
expect(self).to receive(:dispatch).with(
|
|
||||||
message: hash_including(default_message_options.merge(
|
|
||||||
text: "/start #{params.join(' ')}",
|
|
||||||
).merge(options)),
|
|
||||||
) { result }
|
|
||||||
expect(subject.call).to eq result
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Old specs
|
|
||||||
RSpec.describe 'Integration: message helpers', telegram_bot: :poller do
|
|
||||||
let(:bot) { Telegram::Bot::ClientStub.new('token') }
|
|
||||||
let(:controller_class) do
|
|
||||||
Class.new(Telegram::Bot::UpdatesController) do
|
|
||||||
def start!(*args)
|
|
||||||
respond_with :message, text: "Start: #{args.inspect}, option: #{payload['option']}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#default_message_options' do
|
|
||||||
subject { default_message_options }
|
|
||||||
it { should eq from: {id: from_id}, chat: {id: chat_id} }
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#dispatch_message' do
|
|
||||||
subject { -> { dispatch_message "/start #{args.join ' '}", options } }
|
|
||||||
let(:args) { %w[asd qwe] }
|
|
||||||
let(:options) { {} }
|
|
||||||
it { should respond_with_message "Start: #{args.inspect}, option: " }
|
|
||||||
|
|
||||||
context 'with options' do
|
|
||||||
let(:options) { {option: 1} }
|
|
||||||
it { should respond_with_message "Start: #{args.inspect}, option: 1" }
|
|
||||||
|
|
||||||
context 'and chat_id is not set' do
|
|
||||||
let(:options) { super().merge(chat: nil) }
|
|
||||||
it { should raise_error(/chat is not present/) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#dispatch_command' do
|
|
||||||
subject { -> { dispatch_command :start, *args } }
|
|
||||||
let(:args) { [] }
|
|
||||||
it { should respond_with_message "Start: #{args.inspect}, option: " }
|
|
||||||
|
|
||||||
context 'with args' do
|
|
||||||
let(:args) { %w[asd qwe] }
|
|
||||||
it { should respond_with_message "Start: #{args.inspect}, option: " }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'with options' do
|
|
||||||
let(:args) { ['asd', 'qwe', option: 1] }
|
|
||||||
it { should respond_with_message "Start: #{args[0...-1].inspect}, option: 1" }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
54
spec/telegram/bot/updates_controller/botan_spec.rb
Обычный файл
54
spec/telegram/bot/updates_controller/botan_spec.rb
Обычный файл
@@ -0,0 +1,54 @@
|
|||||||
|
RSpec.describe Telegram::Bot::UpdatesController::Botan do
|
||||||
|
include_context 'telegram/bot/updates_controller'
|
||||||
|
let(:controller_class) do
|
||||||
|
described_class = self.described_class
|
||||||
|
Class.new(Telegram::Bot::UpdatesController) do
|
||||||
|
include described_class
|
||||||
|
end
|
||||||
|
end
|
||||||
|
let(:botan) { double(:botan) }
|
||||||
|
let(:result) { double(:result) }
|
||||||
|
let(:payload) { {from: {id: user_id}} }
|
||||||
|
let(:payload_type) { :message }
|
||||||
|
let(:user_id) { double(:user_id) }
|
||||||
|
before { allow(bot).to receive(:botan) { botan } }
|
||||||
|
|
||||||
|
shared_examples 'basic tracking' do
|
||||||
|
context 'when botan is not configured' do
|
||||||
|
let(:botan) {}
|
||||||
|
it { should eq nil }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when `from` is empty' do
|
||||||
|
let(:payload) { {text: 'test'} }
|
||||||
|
it { expect { subject }.to raise_error described_class::MissingFrom }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#botan_track' do
|
||||||
|
subject { controller.send(:botan_track, event, data) }
|
||||||
|
let(:event) { double(:event) }
|
||||||
|
let(:data) { double(:data) }
|
||||||
|
|
||||||
|
it 'calls botan#track' do
|
||||||
|
expect(botan).to receive(:track).with(event, user_id, data) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
|
||||||
|
include_examples 'basic tracking'
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#botan_track_action' do
|
||||||
|
subject { controller.send(:botan_track_action) }
|
||||||
|
let(:action_name) { double(:action_name) }
|
||||||
|
|
||||||
|
it 'calls botan#track with current action and payload' do
|
||||||
|
expect(controller).to receive(:action_name) { action_name }
|
||||||
|
expect(botan).to receive(:track).
|
||||||
|
with(action_name, user_id, deep_stringify(payload)) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
|
||||||
|
include_examples 'basic tracking'
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController::CallbackQueryContext do
|
RSpec.describe Telegram::Bot::UpdatesController::CallbackQueyContext do
|
||||||
include_context 'telegram/bot/updates_controller'
|
include_context 'telegram/bot/updates_controller'
|
||||||
let(:controller_class) do
|
let(:controller_class) do
|
||||||
described_class = self.described_class
|
described_class = self.described_class
|
||||||
@@ -27,7 +27,7 @@ RSpec.describe Telegram::Bot::UpdatesController::CallbackQueryContext do
|
|||||||
describe '#dispatch' do
|
describe '#dispatch' do
|
||||||
subject { -> { dispatch } }
|
subject { -> { dispatch } }
|
||||||
let(:payload_type) { :callback_query }
|
let(:payload_type) { :callback_query }
|
||||||
let(:payload) { {data: data} }
|
let(:payload) { {'data' => data} }
|
||||||
let(:data) { text }
|
let(:data) { text }
|
||||||
let(:text) { 'asd qwe zxc' }
|
let(:text) { 'asd qwe zxc' }
|
||||||
|
|
||||||
|
|||||||
@@ -1,111 +0,0 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController::Commands do
|
|
||||||
describe '#action_for_command' do
|
|
||||||
subject { ->(*args) { object.action_for_command(*args) } }
|
|
||||||
let(:object) { Object.new.tap { |x| x.extend described_class } }
|
|
||||||
|
|
||||||
def assert_subject(input, expected)
|
|
||||||
expect(subject.call input).to eq expected
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'bypasses and downcases not conflictint commands' do
|
|
||||||
assert_subject 'test', 'test!'
|
|
||||||
assert_subject 'TeSt', 'test!'
|
|
||||||
assert_subject '_Te1St', '_te1st!'
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '.command_from_text' do
|
|
||||||
subject { ->(*args) { described_class.command_from_text(*args) } }
|
|
||||||
|
|
||||||
def assert_subject(input, cmd, *args)
|
|
||||||
expected = cmd ? [cmd, args] : cmd
|
|
||||||
expect(subject.call(*input)).to eq expected
|
|
||||||
end
|
|
||||||
|
|
||||||
let(:max_cmd_size) { 32 }
|
|
||||||
let(:long_cmd) { 'a' * (max_cmd_size - 1) }
|
|
||||||
let(:too_long_cmd) { 'a' * max_cmd_size }
|
|
||||||
|
|
||||||
it 'works for simple commands' do
|
|
||||||
assert_subject '/test', 'test'
|
|
||||||
assert_subject '/tE_2_St', 'tE_2_St'
|
|
||||||
assert_subject '/123', '123'
|
|
||||||
assert_subject "/#{long_cmd}", long_cmd
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for simple messages' do
|
|
||||||
assert_subject 'text', nil
|
|
||||||
assert_subject ' ', nil
|
|
||||||
assert_subject ' text', nil
|
|
||||||
assert_subject ' 1', nil
|
|
||||||
assert_subject ' /text', nil
|
|
||||||
assert_subject '/te-xt', nil
|
|
||||||
assert_subject 'text /cmd ', nil
|
|
||||||
assert_subject "/#{too_long_cmd}", nil
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for mentioned commands' do
|
|
||||||
assert_subject ['/test@bot', 'bot'], 'test'
|
|
||||||
assert_subject ['/test@otherbot', 'bot'], nil
|
|
||||||
assert_subject ['/test@Bot', 'bot'], nil
|
|
||||||
assert_subject '/test@bot', nil
|
|
||||||
assert_subject ['/test@bot', true], 'test'
|
|
||||||
assert_subject ['/test@otherbot', true], 'test'
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for commands with args' do
|
|
||||||
assert_subject '/test arg', 'test', 'arg'
|
|
||||||
assert_subject '/test arg 1 2', 'test', 'arg', '1', '2'
|
|
||||||
assert_subject ['/test@bot arg', 'bot'], 'test', 'arg'
|
|
||||||
assert_subject ['/test@otherbot arg', 'bot'], nil
|
|
||||||
assert_subject '/test@bot arg', nil
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'works for commands with multiline args' do
|
|
||||||
assert_subject "/test arg\nother", 'test', 'arg', 'other'
|
|
||||||
assert_subject "/test one\ntwo\n\nthree", 'test', 'one', 'two', 'three'
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#action_for_payload' do
|
|
||||||
include_context 'telegram/bot/updates_controller'
|
|
||||||
let(:controller_class) { Telegram::Bot::UpdatesController }
|
|
||||||
subject { controller.action_for_payload }
|
|
||||||
|
|
||||||
%w[message channel_post].each do |type|
|
|
||||||
context "when payload is edited_#{type}" do
|
|
||||||
let(:payload_type) { "edited_#{type}" }
|
|
||||||
it { should eq [payload_type, [payload]] }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when payload is message' do
|
|
||||||
let(:payload_type) { type }
|
|
||||||
let(:payload) { {'text' => text} }
|
|
||||||
let(:text) { 'test' }
|
|
||||||
|
|
||||||
it { should eq [payload_type, [payload]] }
|
|
||||||
|
|
||||||
context 'with command' do
|
|
||||||
let(:text) { "/test#{"@#{mention}" if mention} arg 1 2" }
|
|
||||||
let(:mention) {}
|
|
||||||
it { should eq [['test!', type: :command, command: 'test'], %w[arg 1 2]] }
|
|
||||||
|
|
||||||
context 'with mention' do
|
|
||||||
let(:mention) { bot.username }
|
|
||||||
it { should eq [['test!', type: :command, command: 'test'], %w[arg 1 2]] }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'with mention for other bot' do
|
|
||||||
let(:mention) { 'other_bot_name' }
|
|
||||||
it { should eq [payload_type, [payload]] }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'without text' do
|
|
||||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
|
||||||
it { should eq [payload_type, [payload]] }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController::Instrumentation do
|
|
||||||
include_context 'telegram/bot/updates_controller'
|
|
||||||
|
|
||||||
subject { -> { dispatch } }
|
|
||||||
let(:update) { {message: default_message_options.merge(text: '/start')} }
|
|
||||||
|
|
||||||
let(:controller_class) do
|
|
||||||
Class.new(Telegram::Bot::UpdatesController) do
|
|
||||||
def start!(*)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
let(:action_scope) { 'updates_controller.bot.telegram' }
|
|
||||||
let(:events) { Hash.new { |h, k| h[k] = [] } }
|
|
||||||
let!(:subscriber) do
|
|
||||||
ActiveSupport::Notifications.subscribe(/#{action_scope}/) do |action, *args|
|
|
||||||
events[action] << args
|
|
||||||
end
|
|
||||||
end
|
|
||||||
after { ActiveSupport::Notifications.unsubscribe(subscriber) }
|
|
||||||
|
|
||||||
def actions_list(*prefixes)
|
|
||||||
prefixes.map { |x| action_name(x) }
|
|
||||||
end
|
|
||||||
|
|
||||||
def action_name(prefix)
|
|
||||||
"#{prefix}.#{action_scope}"
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#process_action' do
|
|
||||||
it 'fires start_processing and process_action events' do
|
|
||||||
should change(events, :keys).by(actions_list(:start_processing, :process_action))
|
|
||||||
|
|
||||||
action = action_name(:start_processing)
|
|
||||||
expect(events[action].size).to eq(1)
|
|
||||||
expect(events[action][0].last).to include(update: deep_stringify(update))
|
|
||||||
|
|
||||||
action = action_name(:process_action)
|
|
||||||
expect(events[action].size).to eq(1)
|
|
||||||
expect(events[action][0].last).to include(update: deep_stringify(update))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#halted_callback_hook' do
|
|
||||||
let(:controller_class) do
|
|
||||||
super().try(:class_eval) do |x|
|
|
||||||
x.before_action :halter_method
|
|
||||||
|
|
||||||
def halter_method
|
|
||||||
require 'active_support/version'
|
|
||||||
if ActiveSupport::VERSION::MAJOR >= 5
|
|
||||||
throw :abort
|
|
||||||
else
|
|
||||||
false
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
self
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'fires halted_callback event' do
|
|
||||||
should change(events, :keys).
|
|
||||||
by(actions_list(:start_processing, :halted_callback, :process_action))
|
|
||||||
|
|
||||||
action = action_name(:halted_callback)
|
|
||||||
expect(events[action].size).to eq(1)
|
|
||||||
expect(events[action][0].last).to include(filter: :halter_method)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#respond_with' do
|
|
||||||
before do
|
|
||||||
def controller.start!(*)
|
|
||||||
respond_with :message, text: 'sample response'
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'fires respond_with event' do
|
|
||||||
should change(events, :keys).
|
|
||||||
by(actions_list(:start_processing, :respond_with, :process_action))
|
|
||||||
|
|
||||||
action = action_name(:respond_with)
|
|
||||||
expect(events[action].size).to eq(1)
|
|
||||||
expect(events[action][0].last).to include(type: :message)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -6,7 +6,7 @@ RSpec.describe Telegram::Bot::UpdatesController::MessageContext do
|
|||||||
include described_class
|
include described_class
|
||||||
|
|
||||||
attr_accessor :filter_done
|
attr_accessor :filter_done
|
||||||
before_action only: :context_with_filter do
|
before_action only: :redirect do
|
||||||
self.filter_done = true
|
self.filter_done = true
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -17,16 +17,19 @@ RSpec.describe Telegram::Bot::UpdatesController::MessageContext do
|
|||||||
[:no_context, *args]
|
[:no_context, *args]
|
||||||
end
|
end
|
||||||
|
|
||||||
def handler_method(*args)
|
context_handler :block do |*args|
|
||||||
[:method_result_1, *args]
|
[:block_result, *args]
|
||||||
end
|
end
|
||||||
|
|
||||||
def context_with_filter(*args)
|
context_handler :redirect
|
||||||
[:method_result_2, *args]
|
context_handler :other_redirect, :redirect
|
||||||
|
|
||||||
|
def redirect(*args)
|
||||||
|
[:method_result, *args]
|
||||||
end
|
end
|
||||||
|
|
||||||
def action!(*args)
|
def action(*args)
|
||||||
[:command_result, *args]
|
[:action_result, *args]
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
@@ -49,59 +52,85 @@ RSpec.describe Telegram::Bot::UpdatesController::MessageContext do
|
|||||||
it { should_not change { session[:context] } }
|
it { should_not change { session[:context] } }
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when context is handled by handler_method' do
|
context 'when context is handled by block' do
|
||||||
before { session[:context] = :handler_method }
|
before { session[:context] = :block }
|
||||||
its(:call) { should eq [:method_result_1, *text.split] }
|
its(:call) { should eq [:block_result, *text.split] }
|
||||||
it { should_not change(controller, :filter_done) }
|
it { should_not change(controller, :filter_done) }
|
||||||
it { should change { session[:context] }.to nil }
|
it { should change { session[:context] }.to nil }
|
||||||
|
|
||||||
context 'when message has no text' do
|
context 'when message has no text' do
|
||||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||||
its(:call) { should eq [:method_result_1] }
|
its(:call) { should eq [:block_result] }
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when message has new command' do
|
context 'when message has new command' do
|
||||||
let(:text) { '/action a s d' }
|
let(:text) { '/action a s d' }
|
||||||
its(:call) { should eq [:command_result, 'a', 's', 'd'] }
|
its(:call) { should eq [:action_result, *%w(a s d)] }
|
||||||
it { should change { session[:context] }.to nil }
|
it { should change { session[:context] }.to nil }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when context is handled by short context_with_filter' do
|
context 'when context is handled by short redirect' do
|
||||||
before { session[:context] = :context_with_filter }
|
before { session[:context] = :redirect }
|
||||||
its(:call) { should eq [:method_result_2, *text.split] }
|
its(:call) { should eq [:method_result, *text.split] }
|
||||||
it { should change(controller, :filter_done).to true }
|
it { should change(controller, :filter_done).to true }
|
||||||
it { should change { session[:context] }.to nil }
|
it { should change { session[:context] }.to nil }
|
||||||
it { should change(controller, :callbacks_runs).to 1 }
|
it { should change(controller, :callbacks_runs).to 1 }
|
||||||
|
|
||||||
context 'when message has no text' do
|
context 'when message has no text' do
|
||||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||||
its(:call) { should eq [:method_result_2] }
|
its(:call) { should eq [:method_result] }
|
||||||
it { should change(controller, :filter_done).to true }
|
it { should change(controller, :filter_done).to true }
|
||||||
it { should change { session[:context] }.to nil }
|
it { should change { session[:context] }.to nil }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when context is command-action`s name' do
|
context 'when context is handled by custom redirect' do
|
||||||
before { session[:context] = :action! }
|
before { session[:context] = :other_redirect }
|
||||||
its(:call) { should eq [:command_result, *text.split] }
|
its(:call) { should eq [:method_result, *text.split] }
|
||||||
|
it { should change(controller, :filter_done).to true }
|
||||||
|
it { should change { session[:context] }.to nil }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when context is action`s name but not mapped' do
|
||||||
|
before { session[:context] = :action }
|
||||||
|
its(:call) { should eq [:no_context, payload] }
|
||||||
it { should_not change(controller, :filter_done) }
|
it { should_not change(controller, :filter_done) }
|
||||||
it { should change { session[:context] }.to nil }
|
it { should change { session[:context] }.to nil }
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when context is not an action`s name' do
|
context 'when context_to_action is true' do
|
||||||
before { session[:context] = :not_action }
|
before { controller_class.context_to_action! }
|
||||||
it do
|
|
||||||
should raise_error(AbstractController::ActionNotFound).
|
|
||||||
and change { session[:context] }.to nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when context is invalid name' do
|
context 'when context is not set' do
|
||||||
before { session[:context] = :invalid }
|
its(:call) { should eq [:no_context, payload] }
|
||||||
it do
|
it { should_not change(controller, :filter_done) }
|
||||||
should raise_error(AbstractController::ActionNotFound).
|
it { should_not change { session[:context] } }
|
||||||
and change { session[:context] }.to nil
|
end
|
||||||
|
|
||||||
|
context 'when context is action`s name but not mapped' do
|
||||||
|
before { session[:context] = :action }
|
||||||
|
its(:call) { should eq [:action_result, *text.split] }
|
||||||
|
it { should_not change(controller, :filter_done) }
|
||||||
|
it { should change { session[:context] }.to nil }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when context is invalid' do
|
||||||
|
before { session[:context] = :invalid }
|
||||||
|
it 'raises error and clears context' do
|
||||||
|
expect do
|
||||||
|
should raise_error AbstractController::ActionNotFound
|
||||||
|
end.to change { session[:context] }.to nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when context is private method`s name' do
|
||||||
|
before { session[:context] = :not_action }
|
||||||
|
it 'raises error and clears context' do
|
||||||
|
expect do
|
||||||
|
should raise_error AbstractController::ActionNotFound
|
||||||
|
end.to change { session[:context] }.to nil
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,74 +1,35 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController do
|
RSpec.describe Telegram::Bot::UpdatesController do
|
||||||
include_context 'telegram/bot/updates_controller'
|
include_context 'telegram/bot/updates_controller'
|
||||||
let(:params) { {arg: 1, 'other_arg' => 2} }
|
|
||||||
let(:respond_type) { :photo }
|
|
||||||
let(:result) { double(:result) }
|
|
||||||
let(:payload_type) { :message }
|
|
||||||
let(:payload) { {message_id: double(:message_id), chat: chat} }
|
|
||||||
let(:chat) { {id: double(:chat_id)} }
|
|
||||||
|
|
||||||
shared_examples 'missing chat' do
|
|
||||||
context 'when chat is missing' do
|
|
||||||
let(:payload_type) { :some_type }
|
|
||||||
it { expect { subject }.to raise_error(/chat/) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#respond_with' do
|
|
||||||
subject { controller.respond_with respond_type, params }
|
|
||||||
include_examples 'missing chat'
|
|
||||||
|
|
||||||
it 'sets chat_id & reply_to_message_id' do
|
|
||||||
expect(bot).to receive("send_#{respond_type}").
|
|
||||||
with(params.merge(chat_id: chat[:id])) { result }
|
|
||||||
should eq result
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#reply_with' do
|
describe '#reply_with' do
|
||||||
subject { controller.reply_with respond_type, params }
|
subject { controller.reply_with type, params }
|
||||||
include_examples 'missing chat'
|
let(:params) { {arg: 1, 'other_arg' => 2} }
|
||||||
|
let(:type) { :photo }
|
||||||
|
let(:result) { double(:result) }
|
||||||
|
let(:payload_type) { :message }
|
||||||
|
let(:payload) { {message_id: double(:message_id)} }
|
||||||
|
let(:chat) { {'id' => double(:chat_id)} }
|
||||||
|
|
||||||
it 'sets chat_id & reply_to_message_id' do
|
it 'sets chat_id & reply_to_message' do
|
||||||
expect(bot).to receive("send_#{respond_type}").with(params.merge(
|
expect(controller).to receive(:chat) { chat }
|
||||||
chat_id: chat[:id],
|
expect(bot).to receive("send_#{type}").with(params.merge(
|
||||||
reply_to_message_id: payload[:message_id],
|
chat_id: chat['id'],
|
||||||
|
reply_to_message: payload[:message_id],
|
||||||
)) { result }
|
)) { result }
|
||||||
should eq result
|
should eq result
|
||||||
end
|
end
|
||||||
|
|
||||||
|
context 'when chat is missing' do
|
||||||
|
let(:payload_type) { :some_type }
|
||||||
|
it { expect { subject }.to raise_error(/chat/) }
|
||||||
|
end
|
||||||
|
|
||||||
context 'when update is not set' do
|
context 'when update is not set' do
|
||||||
let(:controller_args) { [bot, chat: deep_stringify(chat)] }
|
let(:update) { {chat: chat} }
|
||||||
it 'sets chat_id' do
|
it 'sets chat_id & reply_to_message' do
|
||||||
expect(bot).to receive("send_#{respond_type}").
|
expect(bot).to receive("send_#{type}").with(params.merge(
|
||||||
with(params.merge(chat_id: chat[:id])) { result }
|
chat_id: chat['id'],
|
||||||
should eq result
|
reply_to_message: nil,
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#edit_message' do
|
|
||||||
subject { controller.edit_message(type, params) }
|
|
||||||
let(:type) { :reply_markup }
|
|
||||||
|
|
||||||
it { expect { subject }.to raise_error(/Can not edit message without/) }
|
|
||||||
|
|
||||||
context 'when inline_message_id is present' do
|
|
||||||
let(:payload) { {inline_message_id: double(:message_id)} }
|
|
||||||
it 'sets inline_message_id' do
|
|
||||||
expect(bot).to receive("edit_message_#{type}").with(params.merge(
|
|
||||||
inline_message_id: payload[:inline_message_id],
|
|
||||||
)) { result }
|
|
||||||
should eq result
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when message is present' do
|
|
||||||
let(:payload) { {message: super().merge(chat: chat)} }
|
|
||||||
it 'sets chat_id & message_id' do
|
|
||||||
expect(bot).to receive("edit_message_#{type}").with(params.merge(
|
|
||||||
message_id: payload[:message][:message_id],
|
|
||||||
chat_id: payload[:message][:chat][:id],
|
|
||||||
)) { result }
|
)) { result }
|
||||||
should eq result
|
should eq result
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,31 +0,0 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController::Rescue do
|
|
||||||
include_context 'telegram/bot/updates_controller'
|
|
||||||
|
|
||||||
describe '#process_action' do
|
|
||||||
subject { -> { dispatch_message("/#{command} x y z") } }
|
|
||||||
|
|
||||||
let(:controller_class) do
|
|
||||||
Class.new(Telegram::Bot::UpdatesController) do
|
|
||||||
rescue_from ArgumentError, with: -> { respond_with :message, text: 'Rescued' }
|
|
||||||
|
|
||||||
def rescuable!(*)
|
|
||||||
raise ArgumentError, 'rescuable'
|
|
||||||
end
|
|
||||||
|
|
||||||
def not_rescuable!(*)
|
|
||||||
raise 'not_rescuable'
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when exception is rescued' do
|
|
||||||
let(:command) { :rescuable }
|
|
||||||
it { should respond_with_message 'Rescued' }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when exception is not rescued' do
|
|
||||||
let(:command) { :not_rescuable }
|
|
||||||
it { should raise_error('not_rescuable') }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -19,11 +19,11 @@ RSpec.describe Telegram::Bot::UpdatesController::Session do
|
|||||||
controller_class.class_eval do
|
controller_class.class_eval do
|
||||||
self.session_store = :memory_store
|
self.session_store = :memory_store
|
||||||
|
|
||||||
def write!(text)
|
def write(text)
|
||||||
session[:text] = text
|
session[:text] = text
|
||||||
end
|
end
|
||||||
|
|
||||||
def read!
|
def read
|
||||||
session[:text]
|
session[:text]
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ RSpec.describe Telegram::Bot::UpdatesController::Session do
|
|||||||
end
|
end
|
||||||
|
|
||||||
def build_message(text, from)
|
def build_message(text, from)
|
||||||
deep_stringify(message: {text: text, from: from})
|
{'message' => {'text' => text, 'from' => from.stringify_keys}}
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'stores session between requests' do
|
it 'stores session between requests' do
|
||||||
@@ -54,45 +54,4 @@ RSpec.describe Telegram::Bot::UpdatesController::Session do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '.build_session' do
|
|
||||||
subject { controller_class.build_session(key, *args) }
|
|
||||||
let(:key) {}
|
|
||||||
let(:args) { [] }
|
|
||||||
it { expect { subject }.to raise_error(/session_store is not configured/) }
|
|
||||||
|
|
||||||
shared_examples 'NullSessionHash when key is not present' do |store_proc|
|
|
||||||
it { should be_instance_of(described_class::NullSessionHash) }
|
|
||||||
|
|
||||||
context 'and key is present' do
|
|
||||||
let(:key) { :test_key }
|
|
||||||
it 'is valid SessionHash' do
|
|
||||||
expect(subject).to be_instance_of(described_class::SessionHash)
|
|
||||||
expect(subject.id).to eq key
|
|
||||||
expect(subject.instance_variable_get(:@store)).to be(instance_exec(&store_proc))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when store configured' do
|
|
||||||
before { controller_class.session_store = nil }
|
|
||||||
include_examples 'NullSessionHash when key is not present',
|
|
||||||
-> { controller_class.session_store }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when store is given' do
|
|
||||||
let(:args) { [double(:store)] }
|
|
||||||
include_examples 'NullSessionHash when key is not present', -> { args[0] }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '.session_store=' do
|
|
||||||
subject { ->(val) { controller_class.session_store = val } }
|
|
||||||
it 'casts to AS::Cache' do
|
|
||||||
expect { subject[:null_store] }.to change(controller_class, :session_store).
|
|
||||||
to(instance_of(ActiveSupport::Cache::NullStore))
|
|
||||||
expect { subject[nil] }.to change(controller_class, :session_store).
|
|
||||||
to(instance_of(ActiveSupport::Cache::MemoryStore))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,31 +0,0 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController::Translation do
|
|
||||||
describe '#translate' do
|
|
||||||
let(:controller) do
|
|
||||||
double(
|
|
||||||
controller_path: 'telegram/webhooks',
|
|
||||||
action_name: 'start!',
|
|
||||||
).tap { |x| x.extend(described_class) }
|
|
||||||
end
|
|
||||||
|
|
||||||
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')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe described_class::ClassMethods do
|
|
||||||
describe '#translate' do
|
|
||||||
let(:controller_class) do
|
|
||||||
double(controller_path: 'telegram/webhooks').
|
|
||||||
tap { |x| x.extend(described_class) }
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'uses controller_path for lazy translations' do
|
|
||||||
expect(I18n).to receive(:translate).with('telegram.webhooks.hello', {})
|
|
||||||
controller_class.t('.hello')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -9,40 +9,17 @@ RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate do
|
|||||||
|
|
||||||
context 'when `update` is a virtus model' do
|
context 'when `update` is a virtus model' do
|
||||||
subject { controller }
|
subject { controller }
|
||||||
unique_types = Telegram::Bot::UpdatesController::PAYLOAD_TYPES - %w[
|
%w(
|
||||||
edited_message
|
message
|
||||||
channel_post
|
inline_query
|
||||||
edited_channel_post
|
chosen_inline_result
|
||||||
]
|
).each do |type|
|
||||||
unique_types.each do |type|
|
|
||||||
context "with #{type}" do
|
context "with #{type}" do
|
||||||
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
||||||
let(:payload_type) { type }
|
let(:payload_type) { type }
|
||||||
let(:payload) do
|
let(:payload) { {} }
|
||||||
{}.tap do |result|
|
|
||||||
result[:chat] = chat if type_class.instance_methods.include?(:chat)
|
|
||||||
result[:from] = from if type_class.instance_methods.include?(:from)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
let(:chat) { {id: 'chat_id'} }
|
|
||||||
let(:from) { {id: 'from_id'} }
|
|
||||||
its(:payload_type) { should eq payload_type }
|
its(:payload_type) { should eq payload_type }
|
||||||
its(:payload) { should be_instance_of type_class }
|
its(:payload) { should be_instance_of type_class }
|
||||||
|
|
||||||
if type_class.instance_methods.include?(:chat)
|
|
||||||
# Virtus does not support ==. :(
|
|
||||||
its(:chat) { should be_instance_of Telegram::Bot::Types::Chat }
|
|
||||||
its('chat.to_hash') { should include chat }
|
|
||||||
else
|
|
||||||
its(:chat) { should eq nil }
|
|
||||||
end
|
|
||||||
|
|
||||||
if type_class.instance_methods.include?(:from)
|
|
||||||
its(:from) { should be_instance_of Telegram::Bot::Types::User }
|
|
||||||
its('from.to_hash') { should include from }
|
|
||||||
else
|
|
||||||
its(:from) { should eq nil }
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,81 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController do
|
RSpec.describe Telegram::Bot::UpdatesController do
|
||||||
include_context 'telegram/bot/updates_controller'
|
include_context 'telegram/bot/updates_controller'
|
||||||
|
let(:other_bot_name) { 'other_bot' }
|
||||||
|
|
||||||
|
describe '.action_for_command' do
|
||||||
|
subject { ->(*args) { described_class.action_for_command(*args) } }
|
||||||
|
|
||||||
|
def assert_subject(input, expected)
|
||||||
|
expect(subject.call input).to eq expected
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'bypasses and downcases not conflictint commands' do
|
||||||
|
assert_subject 'test', 'test'
|
||||||
|
assert_subject 'TeSt', 'test'
|
||||||
|
assert_subject '_Te1St', '_te1st'
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'adds _on to conflicting commands' do
|
||||||
|
described_class::PAYLOAD_TYPES.each do |x|
|
||||||
|
assert_subject x, "on_#{x}"
|
||||||
|
assert_subject x.upcase, "on_#{x}"
|
||||||
|
end
|
||||||
|
assert_subject '1TeSt', 'on_1test'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '.command_from_text' do
|
||||||
|
subject { ->(*args) { described_class.command_from_text(*args) } }
|
||||||
|
|
||||||
|
def assert_subject(input, cmd, *args)
|
||||||
|
expected = cmd ? [cmd, args] : cmd
|
||||||
|
expect(subject.call(*input)).to eq expected
|
||||||
|
end
|
||||||
|
|
||||||
|
let(:max_cmd_size) { 32 }
|
||||||
|
let(:long_cmd) { 'a' * (max_cmd_size - 1) }
|
||||||
|
let(:too_long_cmd) { 'a' * max_cmd_size }
|
||||||
|
|
||||||
|
it 'works for simple commands' do
|
||||||
|
assert_subject '/test', 'test'
|
||||||
|
assert_subject '/tE_2_St', 'tE_2_St'
|
||||||
|
assert_subject '/123', '123'
|
||||||
|
assert_subject "/#{long_cmd}", long_cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'works for simple messages' do
|
||||||
|
assert_subject 'text', nil
|
||||||
|
assert_subject ' ', nil
|
||||||
|
assert_subject ' text', nil
|
||||||
|
assert_subject ' 1', nil
|
||||||
|
assert_subject ' /text', nil
|
||||||
|
assert_subject '/te-xt', nil
|
||||||
|
assert_subject 'text /cmd ', nil
|
||||||
|
assert_subject "/#{too_long_cmd}", nil
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'works for mentioned commands' do
|
||||||
|
assert_subject ['/test@bot', 'bot'], 'test'
|
||||||
|
assert_subject ['/test@otherbot', 'bot'], nil
|
||||||
|
assert_subject ['/test@Bot', 'bot'], nil
|
||||||
|
assert_subject '/test@bot', nil
|
||||||
|
assert_subject ['/test@bot', true], 'test'
|
||||||
|
assert_subject ['/test@otherbot', true], 'test'
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'works for commands with args' do
|
||||||
|
assert_subject '/test arg', 'test', 'arg'
|
||||||
|
assert_subject '/test arg 1 2', 'test', 'arg', '1', '2'
|
||||||
|
assert_subject ['/test@bot arg', 'bot'], 'test', 'arg'
|
||||||
|
assert_subject ['/test@otherbot arg', 'bot'], nil
|
||||||
|
assert_subject '/test@bot arg', nil
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'works for commands with multiline args' do
|
||||||
|
assert_subject "/test arg\nother", 'test', 'arg', 'other'
|
||||||
|
assert_subject "/test one\ntwo\n\nthree", 'test', 'one', 'two', 'three'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
describe '#action_for_payload' do
|
describe '#action_for_payload' do
|
||||||
subject { controller.action_for_payload }
|
subject { controller.action_for_payload }
|
||||||
@@ -11,39 +87,57 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
context 'when payload is inline_query' do
|
context 'when payload is inline_query' do
|
||||||
let(:payload_type) { 'inline_query' }
|
let(:payload_type) { 'inline_query' }
|
||||||
let(:payload) { stub_payload(:id, :from, :location, :query, :offset) }
|
let(:payload) { stub_payload(:id, :from, :location, :query, :offset) }
|
||||||
it { should eq [payload_type, payload.values_at(:query, :offset)] }
|
it { should eq [false, payload_type, payload.values_at(:query, :offset)] }
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when payload is chosen_inline_result' do
|
context 'when payload is chosen_inline_result' do
|
||||||
let(:payload_type) { 'chosen_inline_result' }
|
let(:payload_type) { 'chosen_inline_result' }
|
||||||
let(:payload) { stub_payload(:result_id, :from, :location, :inline_message_id, :query) }
|
let(:payload) { stub_payload(:result_id, :from, :location, :inline_message_id, :query) }
|
||||||
it { should eq [payload_type, payload.values_at(:result_id, :query)] }
|
it { should eq [false, payload_type, payload.values_at(:result_id, :query)] }
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when payload is callback_query' do
|
context 'when payload is callback_query' do
|
||||||
let(:payload_type) { 'callback_query' }
|
let(:payload_type) { 'callback_query' }
|
||||||
let(:payload) { stub_payload(:id, :from, :message, :inline_message_id, :data) }
|
let(:payload) { stub_payload(:id, :from, :message, :inline_message_id, :data) }
|
||||||
it { should eq [payload_type, payload.values_at(:data)] }
|
it { should eq [false, payload_type, payload.values_at(:data)] }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when payload is edited_message' do
|
||||||
|
let(:payload_type) { 'edited_message' }
|
||||||
|
it { should eq [false, payload_type, [payload]] }
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when payload is not supported' do
|
context 'when payload is not supported' do
|
||||||
let(:payload_type) { '_unsupported_' }
|
let(:payload_type) { '_unsupported_' }
|
||||||
it { should eq [:unsupported_payload_type, []] }
|
it { should eq [false, :unsupported_payload_type, []] }
|
||||||
end
|
end
|
||||||
|
|
||||||
custom_payload_types = %w[
|
context 'when payload is message' do
|
||||||
message
|
let(:payload_type) { 'message' }
|
||||||
edited_message
|
let(:payload) { {'text' => text} }
|
||||||
channel_post
|
let(:text) { 'test' }
|
||||||
edited_channel_post
|
|
||||||
inline_query
|
it { should eq [false, payload_type, [payload]] }
|
||||||
chosen_inline_result
|
|
||||||
callback_query
|
context 'with command' do
|
||||||
]
|
let(:text) { "/test#{"@#{mention}" if mention} arg 1 2" }
|
||||||
(described_class::PAYLOAD_TYPES - custom_payload_types).each do |type|
|
let(:mention) {}
|
||||||
context "when payload is #{type}" do
|
it { should eq [true, 'test', %w(arg 1 2)] }
|
||||||
let(:payload_type) { type }
|
|
||||||
it { should eq [payload_type, [payload]] }
|
context 'with mention' do
|
||||||
|
let(:mention) { bot.username }
|
||||||
|
it { should eq [true, 'test', %w(arg 1 2)] }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'with mention for other bot' do
|
||||||
|
let(:mention) { other_bot_name }
|
||||||
|
it { should eq [false, 'message', [payload]] }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'without text' do
|
||||||
|
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||||
|
it { should eq [false, payload_type, [payload]] }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -51,11 +145,11 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
context 'when `update` is a virtus model' do
|
context 'when `update` is a virtus model' do
|
||||||
subject { controller }
|
subject { controller }
|
||||||
let(:update) { Telegram::Bot::Types::Update.new(super()) }
|
let(:update) { Telegram::Bot::Types::Update.new(super()) }
|
||||||
%w[
|
%w(
|
||||||
message
|
message
|
||||||
inline_query
|
inline_query
|
||||||
chosen_inline_result
|
chosen_inline_result
|
||||||
].each do |type|
|
).each do |type|
|
||||||
context "with #{type}" do
|
context "with #{type}" do
|
||||||
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
||||||
let(:payload_type) { type }
|
let(:payload_type) { type }
|
||||||
@@ -82,7 +176,7 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
|
|
||||||
describe '#process' do
|
describe '#process' do
|
||||||
subject { -> { controller.process(:action, *args) } }
|
subject { -> { controller.process(:action, *args) } }
|
||||||
let(:args) { %i[arg1 arg2] }
|
let(:args) { [:arg1, :arg2] }
|
||||||
let(:controller_class) do
|
let(:controller_class) do
|
||||||
Class.new(described_class) do
|
Class.new(described_class) do
|
||||||
attr_reader :acted, :hooked
|
attr_reader :acted, :hooked
|
||||||
@@ -131,12 +225,12 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
it { should change(controller, :acted).to true }
|
it { should change(controller, :acted).to true }
|
||||||
its(:call) { should eq [nil, nil, args] }
|
its(:call) { should eq [nil, nil, args] }
|
||||||
|
|
||||||
context 'when callback halts chain' do
|
context 'when callback returns false' do
|
||||||
before do
|
before do
|
||||||
controller_class.prepend(Module.new do
|
controller_class.prepend(Module.new do
|
||||||
def hook
|
def hook
|
||||||
super
|
super
|
||||||
ActiveSupport::VERSION::MAJOR >= 5 ? throw(:abort) : false
|
false
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
@@ -166,13 +260,11 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
instance_eval(&block)
|
instance_eval(&block)
|
||||||
context 'when re-initialized' do
|
context 'when re-initialized' do
|
||||||
let(:controller) do
|
let(:controller) do
|
||||||
initial_update = deep_stringify message: {
|
described_class.new(double(:other_bot), build_update(:message,
|
||||||
text: 'original message',
|
text: 'original message',
|
||||||
from: double(:original_from),
|
from: double(:original_from),
|
||||||
chat: double(:original_chat),
|
chat: double(:original_chat),
|
||||||
}
|
)).tap { |x| x.send(:initialize, bot, update) }
|
||||||
described_class.new(double(:other_bot), initial_update).
|
|
||||||
tap { |x| x.send(:initialize, *controller_args) }
|
|
||||||
end
|
end
|
||||||
instance_eval(&block)
|
instance_eval(&block)
|
||||||
end
|
end
|
||||||
@@ -190,7 +282,7 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
end
|
end
|
||||||
|
|
||||||
context 'when options hash is given' do
|
context 'when options hash is given' do
|
||||||
let(:controller_args) { [bot, from: from, chat: chat] }
|
let(:update) { {from: from, chat: chat} }
|
||||||
with_reinitialize do
|
with_reinitialize do
|
||||||
its(:bot) { should eq bot }
|
its(:bot) { should eq bot }
|
||||||
its(:update) { should eq nil }
|
its(:update) { should eq nil }
|
||||||
@@ -201,49 +293,4 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '#chat' do
|
|
||||||
subject { controller.chat }
|
|
||||||
let(:payload_type) { :message }
|
|
||||||
let(:payload) { {chat: 'test_value'} }
|
|
||||||
it { should eq payload[:chat] }
|
|
||||||
|
|
||||||
context 'when payload is not set' do
|
|
||||||
let(:payload) {}
|
|
||||||
it { should eq nil }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when payload has no such field' do
|
|
||||||
let(:payload) { {smth: 'other'} }
|
|
||||||
it { should eq nil }
|
|
||||||
|
|
||||||
context 'but has `message`' do
|
|
||||||
let(:payload) { {message: message} }
|
|
||||||
let(:message) { {text: 'Hello bot!'} }
|
|
||||||
it { should eq nil }
|
|
||||||
|
|
||||||
context 'with `chat` set' do
|
|
||||||
let(:message) { super().merge(chat: 'test value') }
|
|
||||||
it { should eq message[:chat] }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#from' do
|
|
||||||
subject { controller.from }
|
|
||||||
let(:payload_type) { :message }
|
|
||||||
let(:payload) { {from: 'test_value'} }
|
|
||||||
it { should eq payload[:from] }
|
|
||||||
|
|
||||||
context 'when payload is not set' do
|
|
||||||
let(:payload) {}
|
|
||||||
it { should eq nil }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when payload has no such field' do
|
|
||||||
let(:payload) { {smth: 'other'} }
|
|
||||||
it { should eq nil }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,57 +1,9 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesPoller do
|
RSpec.describe Telegram::Bot::UpdatesPoller do
|
||||||
let(:instance) { described_class.new(bot, controller) }
|
|
||||||
let(:bot) { Telegram::Bot::Client.new('token') }
|
|
||||||
let(:controller) { double(:controller) }
|
|
||||||
|
|
||||||
describe '#initialize' do
|
describe '#initialize' do
|
||||||
subject { instance }
|
subject { described_class.new bot, controller }
|
||||||
|
let(:bot) { double }
|
||||||
|
let(:controller) { double }
|
||||||
|
|
||||||
it { should be }
|
it { should be }
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '#process_updates' do
|
|
||||||
subject { -> { instance.process_updates(updates) } }
|
|
||||||
let(:block) { ->(x) { expect(x).to eq expected_results.shift } }
|
|
||||||
let(:updates) { [{update_id: 12}, {update_id: 34}].as_json }
|
|
||||||
let(:processed_updates) { [] }
|
|
||||||
before do
|
|
||||||
allow(controller).to receive(:dispatch) do |bot, update|
|
|
||||||
expect(bot).to eq self.bot
|
|
||||||
processed_updates << update
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it { should change(instance, :offset).to(updates.last['update_id'] + 1) }
|
|
||||||
it { should change(self, :processed_updates).to(updates) }
|
|
||||||
|
|
||||||
context 'with typed response' do
|
|
||||||
let(:updates) { super().map { |x| Telegram::Bot::Types::Update.new(x) } }
|
|
||||||
it { should change(instance, :offset).to(updates.last['update_id'] + 1) }
|
|
||||||
it { should change(self, :processed_updates).to(updates) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '#fetch_updates' do
|
|
||||||
subject { instance.fetch_updates }
|
|
||||||
let(:updates) { [{update_id: 12}, {update_id: 34}] }
|
|
||||||
let(:request_result) { {ok: true, result: updates}.as_json }
|
|
||||||
before do
|
|
||||||
allow(bot).to receive(:get_updates) do
|
|
||||||
expect(bot.async).to be_falsy
|
|
||||||
request_result
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it { should eq updates.as_json }
|
|
||||||
|
|
||||||
context 'with typed response' do
|
|
||||||
let(:updates) { super().map { |x| Telegram::Bot::Types::Update.new(x.as_json) } }
|
|
||||||
let(:request_result) { updates }
|
|
||||||
it { should eq updates }
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when bot is in async mode' do
|
|
||||||
let(:bot) { Telegram::Bot::Client.new('token', async: Class.new) }
|
|
||||||
it { should eq updates.as_json }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,4 +2,22 @@ RSpec.describe Telegram::Bot do
|
|||||||
it 'has a version number' do
|
it 'has a version number' do
|
||||||
expect(described_class::VERSION).not_to be nil
|
expect(described_class::VERSION).not_to be nil
|
||||||
end
|
end
|
||||||
|
|
||||||
|
describe described_class::StaleChat do
|
||||||
|
describe '.match_response?' do
|
||||||
|
subject { ->(val) { described_class.match_response?(val) } }
|
||||||
|
|
||||||
|
it 'returns true for specific errors' do
|
||||||
|
expect(subject.call({})).to eq false
|
||||||
|
expect(subject.call('description' => 'test')).to eq false
|
||||||
|
expect(subject.call('description' => 'Error: bot was kicked from')).to eq true
|
||||||
|
expect(subject.call(
|
||||||
|
'description' => "Forbidden: can't write to private chat with deleted user"
|
||||||
|
)).to eq true
|
||||||
|
expect(subject.call(
|
||||||
|
'description' => 'Bad request: group chat is deactivated'
|
||||||
|
)).to eq true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
# coding: utf-8
|
||||||
lib = File.expand_path('../lib', __FILE__)
|
lib = File.expand_path('../lib', __FILE__)
|
||||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||||
require 'telegram/bot/version'
|
require 'telegram/bot/version'
|
||||||
@@ -17,15 +18,11 @@ Gem::Specification.new do |spec|
|
|||||||
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
||||||
spec.require_paths = ['lib']
|
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.0'
|
spec.required_ruby_version = '~> 2.0'
|
||||||
|
|
||||||
spec.add_dependency 'actionpack', '>= 4.0', '< 6.1'
|
spec.add_dependency 'activesupport', '~> 4.0'
|
||||||
spec.add_dependency 'activesupport', '>= 4.0', '< 6.1'
|
spec.add_dependency 'actionpack', '~> 4.0'
|
||||||
spec.add_dependency 'httpclient', '~> 2.7'
|
spec.add_dependency 'httpclient', '~> 2.7'
|
||||||
|
spec.add_development_dependency 'bundler', '~> 1.11'
|
||||||
spec.add_development_dependency 'bundler', '> 1.16'
|
|
||||||
spec.add_development_dependency 'rake', '~> 10.0'
|
spec.add_development_dependency 'rake', '~> 10.0'
|
||||||
end
|
end
|
||||||
|
|||||||
Ссылка в новой задаче
Block a user