зеркало из
https://github.com/glebtv/telegram-bot.git
synced 2026-08-28 15:26:18 +03:00
Сравнить коммиты
101 Коммитов
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
9e396cabc4 | ||
|
|
81c18034a5 | ||
|
|
f332d27ec8 | ||
|
|
fa9b01d9d2 | ||
|
|
e06882f7af | ||
|
|
1a30b430df | ||
|
|
da93abaaf7 | ||
|
|
0ae17fb34e | ||
|
|
7e41bd4f9b | ||
|
|
e529a79339 | ||
|
|
ef4f3caa5f | ||
|
|
df7039326d | ||
|
|
4f47506e22 | ||
|
|
6abbe5489d | ||
|
|
ff7de976d0 | ||
|
|
aaba27eb70 | ||
|
|
88a4a9aab3 | ||
|
|
9387043ec1 | ||
|
|
3dca35ba9a | ||
|
|
6879618c00 | ||
|
|
6e4a69b6b1 | ||
|
|
b8db576452 | ||
|
|
2fffdeb475 | ||
|
|
9defa42f40 | ||
|
|
0320507abe | ||
|
|
cd3d3739a4 | ||
|
|
a054ac704c | ||
|
|
23aa92e614 | ||
|
|
a49dca66fa | ||
|
|
2d5ca981ce | ||
|
|
cf9bd87cf2 | ||
|
|
48ff7a4f43 | ||
|
|
17260cb5a9 | ||
|
|
817af95369 | ||
|
|
99fbe41b16 | ||
|
|
88178113d7 | ||
|
|
1a2ac0dd83 | ||
|
|
fa6e385ca1 | ||
|
|
1098118826 | ||
|
|
0c9a4a5fa0 | ||
|
|
5c299887bb | ||
|
|
9f2234c132 | ||
|
|
ec1d5bad7d | ||
|
|
194fc78202 | ||
|
|
ececfa660e | ||
|
|
9e67122465 | ||
|
|
caee9809d0 | ||
|
|
4b511f51a7 | ||
|
|
d2d6202fa7 | ||
|
|
dd38cfea93 | ||
|
|
3cb6e930b8 | ||
|
|
e42a293804 | ||
|
|
2e405acfb1 | ||
|
|
b2eca2d37f | ||
|
|
6d687e459a | ||
|
|
71f736e0a2 | ||
|
|
85ff07de9b | ||
|
|
27602b20bd | ||
|
|
91e0aa2096 | ||
|
|
4e539e1867 | ||
|
|
33f0049f6e | ||
|
|
207754499e | ||
|
|
995cde5607 | ||
|
|
9ba5a817cd | ||
|
|
0205891985 | ||
|
|
7393b1a1f3 | ||
|
|
43b519c5e8 | ||
|
|
93ff9851f6 | ||
|
|
7c1f1b5b63 | ||
|
|
028849a617 | ||
|
|
ba1b3c0974 | ||
|
|
f61cc1e536 | ||
|
|
2f7ff9d50e | ||
|
|
aca35a1934 | ||
|
|
5bf98b419b | ||
|
|
8077ef9bcf | ||
|
|
5fef6fb43a | ||
|
|
07be01c07d | ||
|
|
33a1220c5f | ||
|
|
a52e7ff31b | ||
|
|
23fb9a28d1 | ||
|
|
8994328654 | ||
|
|
4593a10dec | ||
|
|
148023bb0d | ||
|
|
9b9e55a449 | ||
|
|
1f139a2b36 | ||
|
|
9b3fb562a3 | ||
|
|
62475965e9 | ||
|
|
d7a20a745c | ||
|
|
1963533e33 | ||
|
|
232eab1d5b | ||
|
|
9fe4c6bcae | ||
|
|
c04884040d | ||
|
|
225290b677 | ||
|
|
e03e39bd53 | ||
|
|
e767a65faa | ||
|
|
32b6794924 | ||
|
|
2a511abe16 | ||
|
|
0f5f426d55 | ||
|
|
e6dea5096f | ||
|
|
c06ba2af5c |
3
.gitignore
поставляемый
3
.gitignore
поставляемый
@@ -1,9 +1,12 @@
|
||||
/.bundle/
|
||||
/.yardoc
|
||||
/Gemfile.lock
|
||||
/gemfiles/*.lock
|
||||
/gemfiles/.bundle
|
||||
/_yardoc/
|
||||
/coverage/
|
||||
/doc/
|
||||
/pkg/
|
||||
/spec/reports/
|
||||
/log/
|
||||
/tmp/
|
||||
|
||||
39
.rubocop.yml
39
.rubocop.yml
@@ -1,27 +1,52 @@
|
||||
Rails: {Enabled: true}
|
||||
|
||||
Style/Alias: {Enabled: false}
|
||||
Style/AlignParameters:
|
||||
Layout/AlignParameters:
|
||||
# Disable, till rubocop supports combination of styles.
|
||||
# Use one of this styles where appropriate, keep it clean, compact and readable.
|
||||
Enabled: false
|
||||
# EnforcedStyle:
|
||||
# - with_first_parameter
|
||||
# - with_fixed_indentation
|
||||
Style/ClosingParenthesisIndentation: {Enabled: false}
|
||||
|
||||
# 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/Documentation: {Enabled: false}
|
||||
Style/DotPosition: {EnforcedStyle: trailing}
|
||||
Style/IfUnlessModifier: {Enabled: false}
|
||||
|
||||
# Consistent to other definitions.
|
||||
Style/EmptyMethod: {EnforcedStyle: expanded}
|
||||
|
||||
Style/ModuleFunction: {Enabled: false}
|
||||
Style/MultilineOperationIndentation: {EnforcedStyle: indented}
|
||||
Style/NestedParenthesizedCalls: {Enabled: false}
|
||||
Style/PredicateName: {Enabled: false}
|
||||
Style/SignalException: {EnforcedStyle: only_raise}
|
||||
Style/SpaceInsideHashLiteralBraces: {EnforcedStyle: no_space}
|
||||
Style/TrailingCommaInArguments: {Enabled: false}
|
||||
Style/TrailingCommaInLiteral: {EnforcedStyleForMultiline: comma}
|
||||
|
||||
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/MethodLength: {Max: 30}
|
||||
Metrics/CyclomaticComplexity: {Max: 8}
|
||||
|
||||
@@ -2,5 +2,9 @@ language: ruby
|
||||
cache: bundler
|
||||
rvm:
|
||||
- 2.2.3
|
||||
gemfile:
|
||||
- gemfiles/rails_42.gemfile
|
||||
- gemfiles/rails_50.gemfile
|
||||
- gemfiles/rails_51.gemfile
|
||||
notifications:
|
||||
email: false
|
||||
|
||||
14
Appraisals
Обычный файл
14
Appraisals
Обычный файл
@@ -0,0 +1,14 @@
|
||||
appraise 'rails-51' do
|
||||
gem 'actionpack', '~> 5.1'
|
||||
gem 'railties', '~> 5.1'
|
||||
end
|
||||
|
||||
appraise 'rails-50' do
|
||||
gem 'actionpack', '~> 5.0'
|
||||
gem 'railties', '~> 5.0'
|
||||
end
|
||||
|
||||
appraise 'rails-42' do
|
||||
gem 'actionpack', '~> 4.2'
|
||||
gem 'railties', '~> 4.2'
|
||||
end
|
||||
109
CHANGELOG.md
Обычный файл
109
CHANGELOG.md
Обычный файл
@@ -0,0 +1,109 @@
|
||||
# Unreleased
|
||||
|
||||
# 0.12.2
|
||||
|
||||
- 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
|
||||
- Fixed possible crashes when payload type is not supported.
|
||||
Provides empty session when neither `from` nor `chat` is defined.
|
||||
|
||||
# 0.7.0
|
||||
|
||||
- New Bot API methods.
|
||||
- Helpers for inline keyboards, support for callback_query (with contextual actions).
|
||||
- Changed action methods signature
|
||||
- `#inline_query(payload) -> #inline_query(query, offset)`
|
||||
- `#chosen_inline_result(payload)` -> `#chosen_inline_result(result_id, query)`
|
||||
- MessageContext doesn't use second #process call to run contextual action.
|
||||
- Botan.io metrics.
|
||||
|
||||
# 0.6.0
|
||||
|
||||
- StaleChat error.
|
||||
- Encode arrays as json in request body.
|
||||
|
||||
# 0.5.0
|
||||
|
||||
- MessageContext.
|
||||
- Running controller action without update.
|
||||
- Client.wrap supports symbols.
|
||||
- Improved testing utils: ability to process multiple updates on same controller instance,
|
||||
stubbing all clients in application.
|
||||
11
Gemfile
11
Gemfile
@@ -2,16 +2,19 @@ source 'https://rubygems.org'
|
||||
gemspec
|
||||
|
||||
group :development do
|
||||
gem 'sdoc', '~> 0.4.1'
|
||||
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.2.0'
|
||||
gem 'telegram-bot-types', '~> 0.3.0'
|
||||
|
||||
gem 'rspec', '~> 3.3.0'
|
||||
gem 'rspec', '~> 3.5.0'
|
||||
gem 'rspec-its', '~> 1.1.0'
|
||||
gem 'rspec-rails', '~> 3.5.0'
|
||||
|
||||
gem 'rubocop', '~> 0.37.0'
|
||||
gem 'rubocop', '~> 0.51.0'
|
||||
|
||||
gem 'coveralls', '~> 0.8.2', require: false
|
||||
end
|
||||
|
||||
444
README.md
444
README.md
@@ -4,18 +4,30 @@
|
||||
[](https://codeclimate.com/github/telegram-bot-rb/telegram-bot)
|
||||
[](https://travis-ci.org/telegram-bot-rb/telegram-bot)
|
||||
|
||||
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.
|
||||
|
||||
Package contains:
|
||||
|
||||
- Ligthweight client for bot API (with fast and thread-safe
|
||||
[httpclient](https://github.com/nahi/httpclient) under the hood).
|
||||
- Controller with message parser. Allows to write separate methods for each command.
|
||||
- Controller with message parser: define methods for commands, not `case` branches.
|
||||
- Middleware and routes helpers for production env.
|
||||
- Poller with automatic source-reloader for development env.
|
||||
- Rake tasks to update webhook urls.
|
||||
- __[Async mode](#async-mode)__ for Telegram and/or Botan API.
|
||||
Let the queue adapter handle network errors!
|
||||
|
||||
Here is sample [telegram_bot_app](https://github.com/telegram-bot-rb/telegram_bot_app)
|
||||
with session, keyboards and inline queries.
|
||||
Run it on your local machine in 1 minute!
|
||||
|
||||
And here is [app template](https://github.com/telegram-bot-rb/rails_template)
|
||||
to generate clean app in seconds.
|
||||
|
||||
Examples and cookbook in [wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -33,51 +45,70 @@ Or install it yourself as:
|
||||
|
||||
$ gem install telegram-bot
|
||||
|
||||
Require if necessary:
|
||||
|
||||
```ruby
|
||||
require 'telegram/bot'
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Configuration
|
||||
### Configuration in Rails app
|
||||
|
||||
Add `telegram` section into `secrets.yml`:
|
||||
|
||||
```yml
|
||||
telegram:
|
||||
bots:
|
||||
# just set the token
|
||||
chat: TOKEN_1
|
||||
# or add username to support commands with mentions (/help@ChatBot)
|
||||
auction:
|
||||
token: TOKEN_2
|
||||
username: ChatBot
|
||||
development:
|
||||
telegram:
|
||||
# Single bot can be specified like this
|
||||
bot: TOKEN
|
||||
# or
|
||||
bot:
|
||||
token: TOKEN
|
||||
username: SomeBot
|
||||
|
||||
# Single bot can be specified like this
|
||||
bot: TOKEN
|
||||
# or
|
||||
bot:
|
||||
token: TOKEN
|
||||
username: SomeBot
|
||||
# For multiple bots in single app use hash of `internal_bot_id => settings`
|
||||
bots:
|
||||
# just set the bot token
|
||||
chat: TOKEN_1
|
||||
# or add username to support commands with mentions (/help@ChatBot)
|
||||
auction:
|
||||
token: TOKEN_2
|
||||
username: ChatBot
|
||||
```
|
||||
|
||||
### Client
|
||||
|
||||
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]`.
|
||||
|
||||
You can create clients manually with `Telegram::Bot::Client.new(token, username)`.
|
||||
### Client
|
||||
|
||||
Client is instantiated with `Telegram::Bot::Client.new(token, username)`.
|
||||
Username is optional and used only to parse commands with mentions.
|
||||
|
||||
There is `request(path_suffix, body)` method to perform any query.
|
||||
And there are also shortcuts for available queries in underscored style
|
||||
(`answer_inline_query` instead of `answerInlineQuery`).
|
||||
All this methods just post given params to specific URL.
|
||||
And there are shortcuts for all available requests in underscored style
|
||||
(`answer_inline_query(params)` instead of `answerInlineQuery`).
|
||||
|
||||
```ruby
|
||||
bot.request(:getMe) or bot.get_me
|
||||
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
|
||||
response typecasting to virtus models using `telegram-bot-types` gem:
|
||||
response typecasting to virtus models using
|
||||
[`telegram-bot-types`](https://github.com/telegram-bot-rb/telegram-bot-types) gem:
|
||||
|
||||
```ruby
|
||||
# Add to your gemfile:
|
||||
gem 'telegram-bot-types', '~> x.x.x'
|
||||
@@ -91,12 +122,21 @@ bot.get_me.class # => Telegram::Bot::Types::User
|
||||
|
||||
### 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.
|
||||
|
||||
```ruby
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
# use callbacks like in any other controllers
|
||||
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.
|
||||
# Define method with same name to respond to this updates.
|
||||
def message(message)
|
||||
# message can be also accessed via instance method
|
||||
@@ -104,6 +144,13 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
# store_message(message['text'])
|
||||
end
|
||||
|
||||
# This basic methods receives commonly used params:
|
||||
#
|
||||
# message(payload)
|
||||
# inline_query(query, offset)
|
||||
# chosen_inline_result(result_id, query)
|
||||
# callback_query(data)
|
||||
|
||||
# Define public methods to respond to commands.
|
||||
# Command arguments will be parsed and passed to the method.
|
||||
# Be sure to use splat args and default values to not get errors when
|
||||
@@ -115,10 +162,12 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
# do_smth_with(data)
|
||||
|
||||
# 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!'
|
||||
# There is `reply_with` helper to set basic fields
|
||||
# like `reply_to_message` & `chat_id`.
|
||||
reply_with :message, text: response
|
||||
# There is `respond_with` helper to set `chat_id` from received message:
|
||||
respond_with :message, text: response
|
||||
# `reply_with` also sets `reply_to_message_id`:
|
||||
reply_with :photo, photo: File.open('party.jpg')
|
||||
end
|
||||
|
||||
private
|
||||
@@ -137,12 +186,28 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
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
|
||||
```
|
||||
|
||||
#### Optional typecasting
|
||||
|
||||
You can enable typecasting of `update` with `telegram-bot-types` by including
|
||||
`Telegram::Bot::UpdatesPoller::TypedUpdate`:
|
||||
|
||||
```ruby
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
include Telegram::Bot::UpdatesPoller::TypedUpdate
|
||||
include Telegram::Bot::UpdatesController::TypedUpdate
|
||||
|
||||
def message(message)
|
||||
message.class # => Telegram::Bot::Types::Message
|
||||
@@ -150,87 +215,316 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
end
|
||||
```
|
||||
|
||||
There is support for sessions using `ActiveSupport::Cache` stores.
|
||||
#### Session
|
||||
|
||||
This API is very close to ActiveController's session API, but works different
|
||||
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
|
||||
# configure store in env files:
|
||||
# In rails app store can be configured in env files:
|
||||
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
|
||||
include Telegram::Bot::UpdatesController::Session
|
||||
# You can override global config
|
||||
# or just shortcut:
|
||||
use_session!
|
||||
|
||||
# You can override global config for this controller.
|
||||
self.session_store = :file_store
|
||||
|
||||
def write(text = nil, *)
|
||||
session[:text] = text
|
||||
end
|
||||
|
||||
def read
|
||||
session[:text]
|
||||
def read(*)
|
||||
respond_with :message, text: session[:text]
|
||||
end
|
||||
|
||||
private
|
||||
# By default it uses bot's username and user's id as a session key.
|
||||
# Chat's id is used only when `from` field is empty.
|
||||
# Override `session_key` method to change this behavior.
|
||||
|
||||
# In this case session will persist for user only in specific chat.
|
||||
# Same user in other chat will have different session.
|
||||
def session_key
|
||||
# In this case session will persist for user only in specific chat:
|
||||
"#{bot.username}:#{chat['id']}:#{from['id']}"
|
||||
"#{bot.username}:#{chat['id']}:#{from['id']}" if chat && from
|
||||
end
|
||||
end
|
||||
```
|
||||
|
||||
### Routes
|
||||
#### Message context
|
||||
|
||||
Use `telegram_webhooks` helper to add routes. It will create routes for bots
|
||||
at "telegram/#{bot.token}" path.
|
||||
It's usual to support chain of messages like BotFather: after receiving command
|
||||
it asks you for additional argument. There is `MessageContext` for this:
|
||||
|
||||
```ruby
|
||||
# Create routes for all Telegram.bots to use same controller:
|
||||
telegram_webhooks TelegramController
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
include Telegram::Bot::UpdatesController::MessageContext
|
||||
|
||||
# Or pass custom bots usin any of supported config options:
|
||||
telegram_webhooks TelegramController,
|
||||
bot,
|
||||
{token: token, username: username},
|
||||
other_bot_token
|
||||
def rename(*)
|
||||
# set context for the next message
|
||||
save_context :rename
|
||||
respond_with :message, text: 'What name do you like?'
|
||||
end
|
||||
|
||||
# Use different controllers for each bot:
|
||||
telegram_webhooks bot => TelegramChatController,
|
||||
other_bot => TelegramAuctionController
|
||||
# register context handlers to handle this context
|
||||
context_handler :rename do |*words|
|
||||
update_name words[0]
|
||||
respond_with :message, text: 'Renamed!'
|
||||
end
|
||||
|
||||
# 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,
|
||||
# You can do it in other way:
|
||||
def rename(name = nil, *)
|
||||
if name
|
||||
update_name name
|
||||
respond_with :message, text: 'Renamed!'
|
||||
else
|
||||
save_context :rename
|
||||
respond_with :message, text: 'What name do you like?'
|
||||
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 call this method
|
||||
# to use context value as action name for all contexts which miss handlers:
|
||||
context_to_action!
|
||||
end
|
||||
```
|
||||
|
||||
For Rack applications you can also use `Telegram::Bot::Middleware` or just
|
||||
call `.dispatch(bot, update)` on controller.
|
||||
#### Callback queries
|
||||
|
||||
You can include `CallbackQueryContext` module to split `#callback_query` into
|
||||
several methods. It doesn't require session support, and takes context from
|
||||
data: if data has a prefix with colon like this `my_ctx:smth...` it invokes
|
||||
`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_webhooks` helper for rails app to define routes for webhooks.
|
||||
It defines routes at `telegram/#{bot.token}` and connects bots with controller.
|
||||
For more options see [examples in wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki/Routes-helpers-in-details).
|
||||
|
||||
```ruby
|
||||
# Create routes for all Telegram.bots using single controller:
|
||||
telegram_webhooks TelegramController
|
||||
|
||||
# Use different controllers for each bot:
|
||||
telegram_webhooks chat: TelegramChatController,
|
||||
auction: TelegramAuctionController
|
||||
```
|
||||
|
||||
#### Processesing updates
|
||||
|
||||
To process update with controller call `.dispatch(bot, update)` on it.
|
||||
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
|
||||
controller = ControllerClass.new(bot, from: telegram_user, chat: telegram_chat)
|
||||
controller.process(:welcome, *args)
|
||||
```
|
||||
|
||||
### Development & Debugging
|
||||
|
||||
Use `rake telegram:bot:poller BOT=chat` to run poller. It'll automatically load
|
||||
changes without restart in development env. This task will not if you don't use
|
||||
`telegram_webhooks`.
|
||||
Use `rake telegram:bot:poller` to run poller in rails app. It automatically loads
|
||||
changes without restart in development env.
|
||||
Optionally pass bot id in `BOT` envvar (`BOT=chat`) to specify bot to run poller for.
|
||||
|
||||
You can run poller manually with
|
||||
`Telegram::Bot::UpdatesPoller.start(bot, controller_class)`.
|
||||
This task requires `telegram_webhooks` helper to be used as it connects bots with controller.
|
||||
To run poller in other cases use:
|
||||
|
||||
### Deploying
|
||||
```ruby
|
||||
Telegram::Bot::UpdatesPoller.start(bot, controller_class)
|
||||
```
|
||||
|
||||
Use `rake telegram:bot:set_webhook` to update webhook url for all configured bots.
|
||||
Certificate can be specified with `CERT=path/to/cert`.
|
||||
### Testing
|
||||
|
||||
There is `Telegram::Bot::ClientStub` class to stub client for tests.
|
||||
Instead of performing API requests it stores them in `requests` hash.
|
||||
|
||||
To stub all possible clients use `Telegram::Bot::ClientStub.stub_all!` before
|
||||
initializing clients. Here is template for RSpec:
|
||||
|
||||
```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|
|
||||
# ...
|
||||
config.after { Telegram.bot.reset }
|
||||
# or for multiple bots:
|
||||
config.after { Telegram.bots.each_value(&:reset) }
|
||||
# ...
|
||||
end
|
||||
```
|
||||
|
||||
There are integration and controller contexts for RSpec and some built-in matchers:
|
||||
|
||||
```ruby
|
||||
# spec/requests/telegram_webhooks_spec.rb
|
||||
require 'telegram/bot/rspec/integration'
|
||||
|
||||
RSpec.describe TelegramWebhooksController, :telegram_bot do
|
||||
# for old rspec add:
|
||||
# include_context 'telegram/bot/integration'
|
||||
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_command :start } }
|
||||
it { should respond_with_message 'Hi there!' }
|
||||
end
|
||||
|
||||
# There is context for callback queries with related matchers.
|
||||
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
|
||||
|
||||
# For controller specs use
|
||||
require 'telegram/bot/updates_controller/rspec_helpers'
|
||||
RSpec.describe TelegramWebhooksController, type: :telegram_bot_controller do
|
||||
# for old rspec add:
|
||||
# include_context 'telegram/bot/updates_controller'
|
||||
end
|
||||
|
||||
# Matchers are available for custom specs:
|
||||
include Telegram::Bot::RSpec::ClientMatchers
|
||||
|
||||
expect(&process_update).to send_telegram_message(bot, /msg regexp/, some: :option)
|
||||
expect(&process_update).
|
||||
to make_telegram_request(bot, :sendMessage, hash_including(text: 'msg text'))
|
||||
```
|
||||
|
||||
Place integration tests inside `spec/requests`
|
||||
when using RSpec's `infer_spec_type_from_file_location!`,
|
||||
or just add `type: :request` to `describe`.
|
||||
|
||||
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.
|
||||
|
||||
### Botan.io metrics
|
||||
|
||||
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::Botan::ControllerHelpers`:
|
||||
|
||||
```ruby
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
include Telegram::Bot::Botan::ControllerHelpers
|
||||
|
||||
# This will track with event: action_name & data: payload
|
||||
before_action :botan_track_action
|
||||
|
||||
def smth(*)
|
||||
# This will track event for current user only when botan is configured.
|
||||
botan_track :my_event, custom_data
|
||||
|
||||
# or get access directly to botan client:
|
||||
botan.track(...)
|
||||
end
|
||||
end
|
||||
```
|
||||
|
||||
There is no stubbing for botan clients, so don't set botan token in tests.
|
||||
|
||||
### 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 and botan 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 and botan'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
|
||||
|
||||
After checking out the repo, run `bin/setup` to install dependencies.
|
||||
Then, run `rake spec` to run the tests.
|
||||
Then, run `appraisal rake spec` to run the tests.
|
||||
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`.
|
||||
@@ -238,6 +532,8 @@ 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,
|
||||
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
|
||||
|
||||
Bug reports and pull requests are welcome on GitHub at https://github.com/telegram-bot-rb/telegram-bot.
|
||||
|
||||
41
bin/fetch-telegram-methods
Исполняемый файл
41
bin/fetch-telegram-methods
Исполняемый файл
@@ -0,0 +1,41 @@
|
||||
#!/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,6 +3,7 @@ set -euo pipefail
|
||||
IFS=$'\n\t'
|
||||
|
||||
bundle install
|
||||
appraisal install
|
||||
bin/install_git_hooks
|
||||
|
||||
# Do any other automated setup that you need to do here
|
||||
|
||||
21
gemfiles/rails_42.gemfile
Обычный файл
21
gemfiles/rails_42.gemfile
Обычный файл
@@ -0,0 +1,21 @@
|
||||
# This file was generated by Appraisal
|
||||
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "actionpack", "~> 4.2"
|
||||
gem "railties", "~> 4.2"
|
||||
|
||||
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.3.0"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rubocop", "~> 0.51.0"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
21
gemfiles/rails_50.gemfile
Обычный файл
21
gemfiles/rails_50.gemfile
Обычный файл
@@ -0,0 +1,21 @@
|
||||
# This file was generated by Appraisal
|
||||
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "actionpack", "~> 5.0"
|
||||
gem "railties", "~> 5.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.3.0"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rubocop", "~> 0.51.0"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
21
gemfiles/rails_51.gemfile
Обычный файл
21
gemfiles/rails_51.gemfile
Обычный файл
@@ -0,0 +1,21 @@
|
||||
# This file was generated by Appraisal
|
||||
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "actionpack", "~> 5.1"
|
||||
gem "railties", "~> 5.1"
|
||||
|
||||
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.3.0"
|
||||
gem "rspec", "~> 3.5.0"
|
||||
gem "rspec-its", "~> 1.1.0"
|
||||
gem "rspec-rails", "~> 3.5.0"
|
||||
gem "rubocop", "~> 0.51.0"
|
||||
gem "coveralls", "~> 0.8.2", require: false
|
||||
end
|
||||
|
||||
gemspec path: "../"
|
||||
@@ -1,9 +1,14 @@
|
||||
namespace :telegram do
|
||||
namespace :bot do
|
||||
desc 'Run poller'
|
||||
task poller: :environment do
|
||||
console = ActiveSupport::Logger.new(STDERR)
|
||||
Rails.logger.extend ActiveSupport::Logger.broadcast console
|
||||
desc 'Run poller. It broadcasts Rails.logger to STDOUT in dev like `rails s` do. ' \
|
||||
'Use LOG_TO_STDOUT to enable/disable broadcasting.'
|
||||
task :poller do
|
||||
ENV['BOT_POLLER_MODE'] = 'true'
|
||||
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)
|
||||
end
|
||||
|
||||
@@ -12,10 +17,11 @@ namespace :telegram do
|
||||
routes = Rails.application.routes.url_helpers
|
||||
cert_file = ENV['CERT']
|
||||
cert = File.open(cert_file) if cert_file
|
||||
Telegram.bots.each_value do |bot|
|
||||
route_name = Telegram::RoutesHelper.route_name_for_bot(bot)
|
||||
Telegram.bots.each do |key, bot|
|
||||
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
||||
url = routes.send("#{route_name}_url")
|
||||
bot.set_webhook(url: url, certificate: cert)
|
||||
puts "Setting webhook for #{key}..."
|
||||
bot.async(false) { bot.set_webhook(url: url, certificate: cert) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -6,10 +6,16 @@ module Telegram
|
||||
module Bot
|
||||
class Error < StandardError; end
|
||||
class NotFound < Error; end
|
||||
class Forbidden < Error; end
|
||||
|
||||
autoload :Async, 'telegram/bot/async'
|
||||
autoload :Botan, 'telegram/bot/botan'
|
||||
autoload :Client, 'telegram/bot/client'
|
||||
autoload :ClientStub, 'telegram/bot/client_stub'
|
||||
autoload :DebugClient, 'telegram/bot/debug_client'
|
||||
autoload :Initializers, 'telegram/bot/initializers'
|
||||
autoload :Middleware, 'telegram/bot/middleware'
|
||||
autoload :RSpec, 'telegram/bot/rspec'
|
||||
autoload :UpdatesController, 'telegram/bot/updates_controller'
|
||||
autoload :UpdatesPoller, 'telegram/bot/updates_poller'
|
||||
end
|
||||
|
||||
162
lib/telegram/bot/async.rb
Обычный файл
162
lib/telegram/bot/async.rb
Обычный файл
@@ -0,0 +1,162 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
# Telegram & Botan 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`. Botan client doesn't inherit
|
||||
# async setting from client and must be configured separately.
|
||||
#
|
||||
# telegram:
|
||||
# bots:
|
||||
# chat_async:
|
||||
# token: secret
|
||||
# async: true # enable async mode for client
|
||||
# botan: botan_token # in this way botan will not be async
|
||||
# botan: # in this way - it's in async mode
|
||||
# token: botan_token
|
||||
# async: true
|
||||
#
|
||||
# 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
|
||||
53
lib/telegram/bot/botan.rb
Обычный файл
53
lib/telegram/bot/botan.rb
Обычный файл
@@ -0,0 +1,53 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class Botan
|
||||
TRACK_URI = 'https://api.botan.io/track'.freeze
|
||||
|
||||
autoload :ClientHelpers, 'telegram/bot/botan/client_helpers'
|
||||
autoload :ControllerHelpers, 'telegram/bot/botan/controller_helpers'
|
||||
class Error < Bot::Error; end
|
||||
|
||||
extend Initializers
|
||||
prepend Async
|
||||
include DebugClient
|
||||
|
||||
class << self
|
||||
def by_id(id)
|
||||
Telegram.botans[id]
|
||||
end
|
||||
|
||||
def prepare_async_args(method, uri, query = {}, body = nil)
|
||||
[method.to_s, uri.to_s, Async.prepare_hash(query), body]
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :client, :token
|
||||
|
||||
def initialize(token = nil, **options)
|
||||
@client = HTTPClient.new
|
||||
@token = token || options[:token]
|
||||
end
|
||||
|
||||
def track(event, uid, payload = {})
|
||||
request(:post, TRACK_URI, {name: event, uid: uid}, payload.to_json)
|
||||
end
|
||||
|
||||
def request(method, uri, query = {}, body = nil)
|
||||
res = http_request(method, uri, query.merge(token: token), body)
|
||||
status = res.status
|
||||
return JSON.parse(res.body) if status < 300
|
||||
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
|
||||
|
||||
def inspect
|
||||
"#<#{self.class.name}##{object_id}(#{@id})>"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
15
lib/telegram/bot/botan/client_helpers.rb
Обычный файл
15
lib/telegram/bot/botan/client_helpers.rb
Обычный файл
@@ -0,0 +1,15 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class Botan
|
||||
# Helpers for botan.io metrics.
|
||||
module ClientHelpers
|
||||
attr_reader :botan
|
||||
|
||||
def initialize(*, botan: nil, **options)
|
||||
super
|
||||
@botan = Botan.wrap(botan, id: id) if botan
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
33
lib/telegram/bot/botan/controller_helpers.rb
Обычный файл
33
lib/telegram/bot/botan/controller_helpers.rb
Обычный файл
@@ -0,0 +1,33 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class Botan
|
||||
# Helpers for botan.io metrics.
|
||||
module ControllerHelpers
|
||||
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
|
||||
@@ -1,27 +1,23 @@
|
||||
require 'json'
|
||||
require 'httpclient'
|
||||
require 'active_support/core_ext/string/inflections'
|
||||
require 'active_support/core_ext/hash/keys'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
class Client
|
||||
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
||||
|
||||
URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
|
||||
|
||||
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
||||
extend Initializers
|
||||
prepend Async
|
||||
prepend Botan::ClientHelpers
|
||||
include DebugClient
|
||||
|
||||
require 'telegram/bot/client/api_helper'
|
||||
include ApiHelper
|
||||
|
||||
class << self
|
||||
# Accepts different options to initialize bot.
|
||||
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']
|
||||
else
|
||||
new(input)
|
||||
end
|
||||
def by_id(id)
|
||||
Telegram.bots[id]
|
||||
end
|
||||
|
||||
# Prepend TypedResponse module.
|
||||
@@ -31,69 +27,40 @@ module Telegram
|
||||
|
||||
# Encodes nested hashes as json.
|
||||
def prepare_body(body)
|
||||
body = body.dup
|
||||
body.each do |k, val|
|
||||
body[k] = val.to_json if val.is_a?(Hash)
|
||||
body[k] = val.to_json if val.is_a?(Hash) || val.is_a?(Array)
|
||||
end
|
||||
end
|
||||
|
||||
def prepare_async_args(action, body = {})
|
||||
[action.to_s, Async.prepare_hash(prepare_body(body))]
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :client, :token, :username, :base_uri
|
||||
|
||||
def initialize(token, username = nil)
|
||||
def initialize(token = nil, username = nil, **options)
|
||||
@client = HTTPClient.new
|
||||
@token = token
|
||||
@username = username
|
||||
@base_uri = format URL_TEMPLATE, token
|
||||
end
|
||||
|
||||
def debug!(dev = STDOUT)
|
||||
if block_given?
|
||||
begin
|
||||
old_dev = client.debug_dev
|
||||
client.debug_dev = dev
|
||||
yield
|
||||
ensure
|
||||
client.debug_dev = old_dev
|
||||
end
|
||||
else
|
||||
client.debug_dev = dev
|
||||
end
|
||||
end
|
||||
|
||||
def debug_off!
|
||||
client.debug_dev = nil
|
||||
@token = token || options[:token]
|
||||
@username = username || options[:username]
|
||||
@base_uri = format URL_TEMPLATE, self.token
|
||||
end
|
||||
|
||||
def request(action, body = {})
|
||||
res = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
|
||||
status = res.status
|
||||
return JSON.parse(res.body) if 300 > status
|
||||
return JSON.parse(res.body) if status < 300
|
||||
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
||||
err_msg = "#{res.reason}: #{result && result['description'] || '-'}"
|
||||
# NotFound is raised only for valid responses from Telegram
|
||||
raise NotFound, err_msg if 404 == status && result
|
||||
raise Error, err_msg
|
||||
end
|
||||
|
||||
%w(
|
||||
answerInlineQuery
|
||||
forwardMessage
|
||||
getFile
|
||||
getMe
|
||||
getUpdates
|
||||
getUserProfilePhotos
|
||||
sendAudio
|
||||
sendChatAction
|
||||
sendDocument
|
||||
sendLocation
|
||||
sendMessage
|
||||
sendPhoto
|
||||
sendSticker
|
||||
sendVideo
|
||||
sendVoice
|
||||
setWebhook
|
||||
).each do |method|
|
||||
define_method(method.underscore) { |*args| request(method, *args) }
|
||||
err_msg = result && result['description'] || '-'
|
||||
if result
|
||||
# This errors are raised only for valid responses from Telegram
|
||||
case status
|
||||
when 403 then raise Forbidden, err_msg
|
||||
when 404 then raise NotFound, err_msg
|
||||
end
|
||||
end
|
||||
raise Error, "#{res.reason}: #{err_msg}"
|
||||
end
|
||||
|
||||
# Endpoint for low-level request. For easy host highjacking & instrumentation.
|
||||
@@ -104,7 +71,7 @@ module Telegram
|
||||
end
|
||||
|
||||
def inspect
|
||||
"#<Telegram::Bot::Client##{object_id}(#{@username})>"
|
||||
"#<#{self.class.name}##{object_id}(#{@username})>"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
31
lib/telegram/bot/client/api_helper.rb
Обычный файл
31
lib/telegram/bot/client/api_helper.rb
Обычный файл
@@ -0,0 +1,31 @@
|
||||
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
|
||||
68
lib/telegram/bot/client/api_methods.txt
Обычный файл
68
lib/telegram/bot/client/api_methods.txt
Обычный файл
@@ -0,0 +1,68 @@
|
||||
# Generated with bin/fetch-telegram-methods
|
||||
# Bot API 3.5.
|
||||
|
||||
getUpdates
|
||||
setWebhook
|
||||
deleteWebhook
|
||||
getWebhookInfo
|
||||
|
||||
getMe
|
||||
sendMessage
|
||||
forwardMessage
|
||||
sendPhoto
|
||||
sendAudio
|
||||
sendDocument
|
||||
sendVideo
|
||||
sendVoice
|
||||
sendVideoNote
|
||||
sendMediaGroup
|
||||
sendLocation
|
||||
editMessageLiveLocation
|
||||
stopMessageLiveLocation
|
||||
sendVenue
|
||||
sendContact
|
||||
sendChatAction
|
||||
getUserProfilePhotos
|
||||
getFile
|
||||
kickChatMember
|
||||
unbanChatMember
|
||||
restrictChatMember
|
||||
promoteChatMember
|
||||
exportChatInviteLink
|
||||
setChatPhoto
|
||||
deleteChatPhoto
|
||||
setChatTitle
|
||||
setChatDescription
|
||||
pinChatMessage
|
||||
unpinChatMessage
|
||||
leaveChat
|
||||
getChat
|
||||
getChatAdministrators
|
||||
getChatMembersCount
|
||||
getChatMember
|
||||
setChatStickerSet
|
||||
deleteChatStickerSet
|
||||
answerCallbackQuery
|
||||
|
||||
editMessageText
|
||||
editMessageCaption
|
||||
editMessageReplyMarkup
|
||||
deleteMessage
|
||||
|
||||
sendSticker
|
||||
getStickerSet
|
||||
uploadStickerFile
|
||||
createNewStickerSet
|
||||
addStickerToSet
|
||||
setStickerPositionInSet
|
||||
deleteStickerFromSet
|
||||
|
||||
answerInlineQuery
|
||||
|
||||
sendInvoice
|
||||
answerShippingQuery
|
||||
answerPreCheckoutQuery
|
||||
|
||||
sendGame
|
||||
setGameScore
|
||||
getGameHighScores
|
||||
@@ -4,8 +4,39 @@ module Telegram
|
||||
class ClientStub < Client
|
||||
attr_reader :requests
|
||||
|
||||
def initialize(username = nil)
|
||||
@username = username
|
||||
module StubbedConstructor
|
||||
def new(*args)
|
||||
if self == ClientStub || !ClientStub.stub_all?
|
||||
super
|
||||
else
|
||||
ClientStub.new(*args)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
class << self
|
||||
# Any call to Client.new will return ClientStub instance when `enabled` is true.
|
||||
# Can be used with a block.
|
||||
def stub_all!(enabled = true)
|
||||
Client.extend(StubbedConstructor) unless Client < StubbedConstructor
|
||||
return @_stub_all = enabled unless block_given?
|
||||
begin
|
||||
old = @_stub_all
|
||||
stub_all!(enabled)
|
||||
yield
|
||||
ensure
|
||||
stub_all!(old)
|
||||
end
|
||||
end
|
||||
|
||||
def stub_all?
|
||||
@_stub_all
|
||||
end
|
||||
end
|
||||
|
||||
def initialize(token = nil, username = nil, **options)
|
||||
@token = token || options[:token]
|
||||
@username = username || options[:username] || token
|
||||
reset
|
||||
end
|
||||
|
||||
@@ -13,7 +44,7 @@ module Telegram
|
||||
@requests = Hash.new { |h, k| h[k] = [] }
|
||||
end
|
||||
|
||||
def request(action, body)
|
||||
def request(action, body = {})
|
||||
requests[action.to_sym] << body
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
require 'active_support/core_ext/hash/keys'
|
||||
require 'active_support/core_ext/hash/transform_values'
|
||||
require 'active_support/core_ext/hash/indifferent_access'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
@@ -14,19 +15,35 @@ module Telegram
|
||||
# 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.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?
|
||||
return @bot_poller_mode if defined?(@bot_poller_mode)
|
||||
Rails.env.development? if defined?(Rails)
|
||||
@bot_poller_mode = ENV.fetch('BOT_POLLER_MODE') do
|
||||
Rails.env.development? if defined?(Rails.env)
|
||||
end
|
||||
end
|
||||
|
||||
# Hash of bots made with bots_config.
|
||||
def bots
|
||||
@bots ||= bots_config.transform_values(&Client.method(:wrap))
|
||||
@bots ||= bots_config.each_with_object({}) do |(id, config), h|
|
||||
h[id] = Client.wrap(config, id: id)
|
||||
end
|
||||
end
|
||||
|
||||
# Default bot.
|
||||
def bot
|
||||
@bot ||= bots[:default]
|
||||
@bot ||= bots.fetch(:default) do
|
||||
raise 'Default bot is not configured.' \
|
||||
' Add :default to bots_config' \
|
||||
' or use telegram.bot/telegram.bots.default section in secrets.yml.'
|
||||
end
|
||||
end
|
||||
|
||||
# Hash of botan clients made from #bots.
|
||||
def botans
|
||||
@botans ||= bots.transform_values(&:botan)
|
||||
end
|
||||
|
||||
# Returns config for .bots method. By default uses `telegram['bots']` section
|
||||
@@ -34,12 +51,25 @@ module Telegram
|
||||
#
|
||||
# Can be overwritten with .bots_config=
|
||||
def bots_config
|
||||
return @bots_config if @bots_config
|
||||
telegram_config = Rails.application.secrets[:telegram]
|
||||
(telegram_config['bots'] || {}).symbolize_keys.tap do |config|
|
||||
default = telegram_config['bot']
|
||||
config[:default] = default if default
|
||||
end
|
||||
@bots_config ||=
|
||||
if defined?(Rails.application)
|
||||
secrets = Rails.application.secrets.
|
||||
fetch(:telegram, {}).with_indifferent_access
|
||||
secrets.fetch(:bots, {}).symbolize_keys.tap do |config|
|
||||
default = secrets[:bot]
|
||||
config[:default] = default if default
|
||||
end
|
||||
else
|
||||
{}
|
||||
end
|
||||
end
|
||||
|
||||
# Resets all cached bots and their configs.
|
||||
def reset_bots
|
||||
@bots = nil
|
||||
@bot = nil
|
||||
@bots_config = nil
|
||||
@botans = nil
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
23
lib/telegram/bot/debug_client.rb
Обычный файл
23
lib/telegram/bot/debug_client.rb
Обычный файл
@@ -0,0 +1,23 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
module DebugClient
|
||||
def debug!(dev = STDOUT)
|
||||
if block_given?
|
||||
begin
|
||||
old_dev = client.debug_dev
|
||||
client.debug_dev = dev
|
||||
yield
|
||||
ensure
|
||||
client.debug_dev = old_dev
|
||||
end
|
||||
else
|
||||
client.debug_dev = dev
|
||||
end
|
||||
end
|
||||
|
||||
def debug_off!
|
||||
client.debug_dev = nil
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
21
lib/telegram/bot/initializers.rb
Обычный файл
21
lib/telegram/bot/initializers.rb
Обычный файл
@@ -0,0 +1,21 @@
|
||||
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,6 +1,8 @@
|
||||
require 'active_support/concern'
|
||||
require 'active_support/core_ext/hash/indifferent_access'
|
||||
require 'active_support/json'
|
||||
require 'action_dispatch/http/mime_type'
|
||||
require 'action_dispatch/middleware/params_parser'
|
||||
require 'action_dispatch/http/request'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
@@ -13,9 +15,10 @@ module Telegram
|
||||
end
|
||||
|
||||
def call(env)
|
||||
update = env['action_dispatch.request.request_parameters']
|
||||
request = ActionDispatch::Request.new(env)
|
||||
update = request.request_parameters
|
||||
controller.dispatch(bot, update)
|
||||
[200, {}, '']
|
||||
[200, {}, ['']]
|
||||
end
|
||||
|
||||
def inspect
|
||||
|
||||
@@ -18,14 +18,15 @@ module Telegram
|
||||
|
||||
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
||||
self.logger = options.logger || Rails.logger
|
||||
self.session_store = options.session_store || Rails.cache
|
||||
self.session_store = options.session_store if options.session_store
|
||||
end
|
||||
end
|
||||
|
||||
initializer 'telegram.bot.updates_controller.add_ar_runtime' do
|
||||
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
||||
if defined?(ActiveRecord::Railties::ControllerRuntime)
|
||||
include ActiveRecord::Railties::ControllerRuntime
|
||||
prepend ActiveRecord::Railties::ControllerRuntime
|
||||
extend ActiveRecord::Railties::ControllerRuntime::ClassMethods
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -16,6 +16,12 @@ module Telegram
|
||||
name && "#{name}_telegram_webhook"
|
||||
end || 'telegram_webhook'
|
||||
end
|
||||
|
||||
# Replaces colon with underscore so rails don't treat it as
|
||||
# route parameter.
|
||||
def escape_token(token)
|
||||
token && token.tr(':', '_')
|
||||
end
|
||||
end
|
||||
|
||||
# # Create routes for all Telegram.bots to use same controller:
|
||||
@@ -36,7 +42,9 @@ module Telegram
|
||||
# # You can override this options or specify others:
|
||||
# telegram_webhooks TelegramController, as: :my_webhook
|
||||
# telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
||||
# other_bot => [TelegramAuctionController,
|
||||
# other_bot => TelegramAuctionController,
|
||||
# admin_chat: TelegramAdminChatController
|
||||
#
|
||||
def telegram_webhooks(controllers, bots = nil, **options)
|
||||
unless controllers.is_a?(Hash)
|
||||
bots = bots ? Array.wrap(bots) : Telegram.bots.values
|
||||
@@ -50,7 +58,7 @@ module Telegram
|
||||
as: RoutesHelper.route_name_for_bot(bot),
|
||||
format: false,
|
||||
}.merge!(options).merge!(bot_options || {})
|
||||
post("telegram/#{bot.token}", params)
|
||||
post("telegram/#{RoutesHelper.escape_token bot.token}", params)
|
||||
UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
|
||||
end
|
||||
end
|
||||
|
||||
7
lib/telegram/bot/rspec.rb
Обычный файл
7
lib/telegram/bot/rspec.rb
Обычный файл
@@ -0,0 +1,7 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
module RSpec
|
||||
autoload :ClientMatchers, 'telegram/bot/rspec/client_matchers'
|
||||
end
|
||||
end
|
||||
end
|
||||
151
lib/telegram/bot/rspec/client_matchers.rb
Обычный файл
151
lib/telegram/bot/rspec/client_matchers.rb
Обычный файл
@@ -0,0 +1,151 @@
|
||||
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
|
||||
83
lib/telegram/bot/rspec/integration.rb
Обычный файл
83
lib/telegram/bot/rspec/integration.rb
Обычный файл
@@ -0,0 +1,83 @@
|
||||
RSpec.shared_context 'telegram/bot/integration' do
|
||||
let(:bot) { Telegram.bot }
|
||||
let(:from_id) { 123 }
|
||||
let(:chat_id) { 456 }
|
||||
let(:default_message_options) { {from: {id: from_id}, chat: {id: chat_id}} }
|
||||
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
|
||||
let(:clear_session?) { described_class.respond_to?(:session_store) }
|
||||
before { described_class.session_store.try!(:clear) if clear_session? }
|
||||
|
||||
include Telegram::Bot::RSpec::ClientMatchers
|
||||
|
||||
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
|
||||
|
||||
def dispatch_message(text, options = {})
|
||||
dispatch message: default_message_options.merge(options).merge(text: text)
|
||||
end
|
||||
|
||||
def dispatch_command(*args)
|
||||
options = args.last.is_a?(Hash) ? args.pop : {}
|
||||
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
|
||||
|
||||
RSpec.shared_context 'telegram/bot/callback_query', callback_query: true do
|
||||
include_context 'telegram/bot/integration'
|
||||
|
||||
subject { -> { dispatch callback_query: payload } }
|
||||
let(:payload) { {id: 11, from: from, message: message, data: data} }
|
||||
let(:message) { {message_id: 22, chat: chat, text: 'message text'} }
|
||||
|
||||
# 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
|
||||
|
||||
RSpec.configure do |config|
|
||||
if config.respond_to?(:include_context)
|
||||
config.include_context 'telegram/bot/integration', :telegram_bot
|
||||
config.include_context 'telegram/bot/callback_query', :telegram_bot, :callback_query
|
||||
end
|
||||
end
|
||||
@@ -4,16 +4,65 @@ require 'active_support/version'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
class UpdatesController < AbstractController::Base
|
||||
# Base class to create update processors. With callbacks, session and helpers.
|
||||
#
|
||||
# Define public methods for each command and they will be called when
|
||||
# update has this command. Message is automatically parsed 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
|
||||
# sends command without necessary args / with extra args.
|
||||
#
|
||||
# def start(token = nil, *)
|
||||
# if token
|
||||
# # ...
|
||||
# else
|
||||
# # ...
|
||||
# end
|
||||
# end
|
||||
#
|
||||
# def help(*)
|
||||
# respond_with :message, text:
|
||||
# end
|
||||
#
|
||||
# To process plain text messages (without commands) or other updates just
|
||||
# define public method with name of payload type. They will receive payload
|
||||
# as an argument.
|
||||
#
|
||||
# def message(message)
|
||||
# respond_with :message, text: "Echo: #{message['text']}"
|
||||
# end
|
||||
#
|
||||
# def inline_query(query)
|
||||
# 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
|
||||
#
|
||||
# To process update run:
|
||||
#
|
||||
# ControllerClass.dispatch(bot, update)
|
||||
#
|
||||
# There is also ability to run action without update:
|
||||
#
|
||||
# ControllerClass.new(bot, from: telegram_user, chat: telegram_chat).
|
||||
# process(:help, *args)
|
||||
#
|
||||
class UpdatesController < AbstractController::Base # rubocop:disable ClassLength
|
||||
abstract!
|
||||
|
||||
require 'telegram/bot/updates_controller/session'
|
||||
require 'telegram/bot/updates_controller/log_subscriber'
|
||||
require 'telegram/bot/updates_controller/instrumentation'
|
||||
require 'telegram/bot/updates_controller/reply_helpers'
|
||||
autoload :CallbackQueryContext, 'telegram/bot/updates_controller/callback_query_context'
|
||||
autoload :MessageContext, 'telegram/bot/updates_controller/message_context'
|
||||
|
||||
include AbstractController::Callbacks
|
||||
# Redefine callbacks with default terminator.
|
||||
if ActiveSupport.gem_version >= Gem::Version.new('5')
|
||||
if ActiveSupport::VERSION::MAJOR >= 5
|
||||
define_callbacks :process_action,
|
||||
skip_after_callbacks_if_terminated: true
|
||||
else
|
||||
@@ -23,20 +72,28 @@ module Telegram
|
||||
end
|
||||
|
||||
include AbstractController::Translation
|
||||
include ReplyHelpers
|
||||
prepend Instrumentation
|
||||
extend Session::ConfigMethods
|
||||
|
||||
autoload :TypedUpdate, 'telegram/bot/updates_controller/typed_update'
|
||||
|
||||
PAYLOAD_TYPES = %w(
|
||||
PAYLOAD_TYPES = %w[
|
||||
message
|
||||
edited_message
|
||||
channel_post
|
||||
edited_channel_post
|
||||
inline_query
|
||||
chosen_inline_result
|
||||
).freeze
|
||||
callback_query
|
||||
shipping_query
|
||||
pre_checkout_query
|
||||
].freeze
|
||||
CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
|
||||
CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
|
||||
|
||||
class << self
|
||||
# Initialize controller and process update.
|
||||
def dispatch(*args)
|
||||
new(*args).dispatch
|
||||
end
|
||||
@@ -59,7 +116,7 @@ module Telegram
|
||||
match = text.match CMD_REGEX
|
||||
return unless match
|
||||
return if match[3] && username != true && match[3] != username
|
||||
[match[1], text.split(' ').drop(1)]
|
||||
[match[1], text.split.drop(1)]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -67,34 +124,85 @@ module Telegram
|
||||
alias_method :command?, :is_command
|
||||
delegate :username, to: :bot, prefix: true, allow_nil: true
|
||||
|
||||
# Second argument can be either update object with hash access & string
|
||||
# keys or Hash with `:from` or `:chat` to override this values and assume
|
||||
# that update is nil.
|
||||
def initialize(bot = nil, update = nil)
|
||||
if update.is_a?(Hash) && (update.key?(:from) || update.key?(:chat))
|
||||
options = update
|
||||
update = nil
|
||||
end
|
||||
@_update = update
|
||||
@_bot = bot
|
||||
@_chat, @_from = options && options.values_at(:chat, :from)
|
||||
|
||||
payload_data = nil
|
||||
update && PAYLOAD_TYPES.find do |type|
|
||||
item = update[type]
|
||||
next unless item
|
||||
@_payload = item
|
||||
@_payload_type = type
|
||||
payload_data = [item, type] if item
|
||||
end
|
||||
@_payload, @_payload_type = payload_data
|
||||
end
|
||||
|
||||
# Accessor to `'chat'` field of payload. Also tries `'chat'` in `'message'`
|
||||
# when there is no such field in payload.
|
||||
#
|
||||
# Can be overriden with `chat` option for #initialize.
|
||||
def chat
|
||||
@_chat ||= payload.try! { |x| x['chat'] || x['message'] && x['message']['chat'] }
|
||||
end
|
||||
|
||||
# Accessor to `'from'` field of payload. Can be overriden with `from` option
|
||||
# for #initialize.
|
||||
def from
|
||||
@_from ||= payload && payload['from']
|
||||
end
|
||||
|
||||
# Processes current update.
|
||||
def dispatch
|
||||
@_is_command, action, args = action_for_payload
|
||||
process(action, *args)
|
||||
end
|
||||
|
||||
# Calculates action name and args for payload.
|
||||
# If payload is a message with command, then returned action is an
|
||||
# action for this command. Otherwise it's the same as payload type.
|
||||
# Uses `action_for_#{payload_type}` methods.
|
||||
# If this method doesn't return anything
|
||||
# it uses fallback with action same as payload type.
|
||||
# Returns array `[is_command?, action, args]`.
|
||||
def action_for_payload
|
||||
case payload_type
|
||||
when '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 || [false, payload_type, [payload]]
|
||||
if payload_type
|
||||
send("action_for_#{payload_type}") || action_for_default_payload
|
||||
else
|
||||
[false, :unsupported_payload_type, []]
|
||||
end
|
||||
end
|
||||
|
||||
def action_for_default_payload
|
||||
[false, payload_type, [payload]]
|
||||
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 = self.class.command_from_text(payload['text'], bot_username)
|
||||
cmd &&= self.class.action_for_command(cmd)
|
||||
[true, cmd, args] if cmd
|
||||
end
|
||||
alias_method :action_for_channel_post, :action_for_message
|
||||
|
||||
def action_for_inline_query
|
||||
[false, payload_type, [payload['query'], payload['offset']]]
|
||||
end
|
||||
|
||||
def action_for_chosen_inline_result
|
||||
[false, payload_type, [payload['result_id'], payload['query']]]
|
||||
end
|
||||
|
||||
def action_for_callback_query
|
||||
[false, payload_type, [payload['data']]]
|
||||
end
|
||||
|
||||
# Silently ignore unsupported messages.
|
||||
@@ -102,17 +210,9 @@ module Telegram
|
||||
def action_missing(*)
|
||||
end
|
||||
|
||||
%w(chat from).each do |field|
|
||||
define_method(field) { payload[field] }
|
||||
end
|
||||
|
||||
def reply_with(type, params)
|
||||
method = "send_#{type}"
|
||||
params = params.merge(
|
||||
chat_id: chat['id'],
|
||||
reply_to_message: payload['message_id'],
|
||||
)
|
||||
bot.public_send(method, params)
|
||||
PAYLOAD_TYPES.each do |type|
|
||||
method = :"action_for_#{type}"
|
||||
alias_method method, :action_for_default_payload unless instance_methods.include?(method)
|
||||
end
|
||||
|
||||
ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
|
||||
|
||||
33
lib/telegram/bot/updates_controller/callback_query_context.rb
Обычный файл
33
lib/telegram/bot/updates_controller/callback_query_context.rb
Обычный файл
@@ -0,0 +1,33 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class UpdatesController
|
||||
# Use separate actions for different callback queries.
|
||||
# It doesn't require session support. Simply add `%{context}:` prefix to data.
|
||||
module CallbackQueryContext
|
||||
protected
|
||||
|
||||
# Uses #context_from_callback_query as context name.
|
||||
# If context is present checks if `%context%_callback_query` is valid
|
||||
# action method and returns it if so. Context is stripped from data
|
||||
# in this case. Otherwise returns `super`.
|
||||
#
|
||||
# It wont raise ActionNotFound as MessageContext does,
|
||||
# because `data` param is controlled by client.
|
||||
def action_for_callback_query
|
||||
context, new_data = context_from_callback_query
|
||||
if context
|
||||
action_name = "#{context}_callback_query"
|
||||
[false, action_name, [new_data]] if action_method?(action_name)
|
||||
end || super
|
||||
end
|
||||
|
||||
def context_from_callback_query
|
||||
data = payload['data']
|
||||
return unless data
|
||||
parts = data.split(':', 2)
|
||||
parts if parts.size > 1
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -6,7 +6,7 @@ module Telegram
|
||||
module Instrumentation
|
||||
class << self
|
||||
def prepended(base)
|
||||
base.config_accessor :logger
|
||||
base.send :config_accessor, :logger
|
||||
base.extend ClassMethods
|
||||
end
|
||||
|
||||
@@ -35,8 +35,14 @@ module Telegram
|
||||
end
|
||||
end
|
||||
|
||||
def reply_with(type, *)
|
||||
Instrumentation.instrument(:reply_with, type: type) { super }
|
||||
def respond_with(type, *)
|
||||
Instrumentation.instrument(:respond_with, type: type) { super }
|
||||
end
|
||||
|
||||
%i[answer_callback_query answer_inline_query].each do |type|
|
||||
define_method(type) do |*args|
|
||||
Instrumentation.instrument(:respond_with, type: type) { super(*args) }
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
@@ -17,13 +17,13 @@ module Telegram
|
||||
payload = event.payload
|
||||
additions = UpdatesController.log_process_action(payload)
|
||||
message = "Completed in #{event.duration.round}ms"
|
||||
message << " (#{additions.join(' | ')})" unless additions.blank?
|
||||
message << " (#{additions.join(' | ')})" if additions.present?
|
||||
message
|
||||
end
|
||||
end
|
||||
|
||||
def reply_with(event)
|
||||
info { "Replied with #{event.payload[:type]}" }
|
||||
def respond_with(event)
|
||||
info { "Responded with #{event.payload[:type]}" }
|
||||
end
|
||||
|
||||
def halted_callback(event)
|
||||
|
||||
99
lib/telegram/bot/updates_controller/message_context.rb
Обычный файл
99
lib/telegram/bot/updates_controller/message_context.rb
Обычный файл
@@ -0,0 +1,99 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class UpdatesController
|
||||
# Allows to store context in session and treat next message according to this context.
|
||||
module MessageContext
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
include Session
|
||||
|
||||
module ClassMethods
|
||||
def context_handlers
|
||||
@_context_handlers ||= {}
|
||||
end
|
||||
|
||||
# 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
|
||||
|
||||
attr_reader :context_to_action
|
||||
|
||||
# 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.
|
||||
def cancel
|
||||
# Context is already cleared in action_for_message
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Context is read from the session to treat messages
|
||||
# according to previous request.
|
||||
attr_reader :context
|
||||
|
||||
# Controller may have multiple sessions, let it be possible
|
||||
# to select session for message context.
|
||||
def message_context_session
|
||||
session
|
||||
end
|
||||
|
||||
# Fetches context and finds handler for it. If message has new command,
|
||||
# it has higher priority than contextual action.
|
||||
def action_for_message
|
||||
val = message_context_session.delete(:context)
|
||||
@context = val && val.to_sym
|
||||
super || context && begin
|
||||
handler = handler_for_context
|
||||
[true, handler, payload['text'].try!(:split) || []] if handler
|
||||
end
|
||||
end
|
||||
|
||||
# Save context for the next request.
|
||||
def save_context(context)
|
||||
message_context_session[:context] = context
|
||||
end
|
||||
|
||||
def handler_for_context
|
||||
self.class.context_handlers[context] || self.class.context_to_action && begin
|
||||
action_name = context.to_s
|
||||
unless action_method?(action_name)
|
||||
raise AbstractController::ActionNotFound,
|
||||
"The action '#{action_name}' could not be set from context " \
|
||||
"for #{self.class.name}. " \
|
||||
'context_to_action! supports only action methods for security reasons. ' \
|
||||
'If you need to call this action use context_handler for it.'
|
||||
end
|
||||
action_name
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
57
lib/telegram/bot/updates_controller/reply_helpers.rb
Обычный файл
57
lib/telegram/bot/updates_controller/reply_helpers.rb
Обычный файл
@@ -0,0 +1,57 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class UpdatesController
|
||||
module ReplyHelpers
|
||||
# Helper to call bot's `send_#{type}` method with already set `chat_id`:
|
||||
#
|
||||
# respond_with :message, text: 'Hello!'
|
||||
# respond_with :message, text: '__Hello!__', parse_mode: :Markdown
|
||||
# respond_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)
|
||||
payload = self.payload
|
||||
message_id = payload && payload['message_id']
|
||||
params = params.merge(reply_to_message_id: message_id) if message_id
|
||||
respond_with(type, params)
|
||||
end
|
||||
|
||||
# Same as reply_with, but for inline queries.
|
||||
def answer_inline_query(results, params = {})
|
||||
params = params.merge(
|
||||
inline_query_id: payload['id'],
|
||||
results: results,
|
||||
)
|
||||
bot.answer_inline_query(params)
|
||||
end
|
||||
|
||||
# Same as reply_with, but for callback queries.
|
||||
def answer_callback_query(text, params = {})
|
||||
params = params.merge(
|
||||
callback_query_id: payload['id'],
|
||||
text: text,
|
||||
)
|
||||
bot.answer_callback_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
|
||||
@@ -1,23 +1,34 @@
|
||||
require 'telegram/bot/updates_controller/testing'
|
||||
|
||||
RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||
let(:controller_class) { described_class }
|
||||
let(:instance) { controller_class.new(bot, update) }
|
||||
let(:update) { {payload_type => payload} }
|
||||
let(:payload_type) { 'some_type' }
|
||||
let(:controller) do
|
||||
controller_class.new(bot, update).tap do |x|
|
||||
x.extend Telegram::Bot::UpdatesController::Testing
|
||||
end
|
||||
end
|
||||
let(:update) { build_update(payload_type, payload) }
|
||||
let(:payload_type) { :some_type }
|
||||
let(:payload) { double(:payload) }
|
||||
let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
|
||||
let(:bot_name) { 'bot' }
|
||||
let(:session) do
|
||||
session = Telegram::Bot::UpdatesController::Session::TestSessionHash.new
|
||||
allow_any_instance_of(controller_class).to receive(:session) { session }
|
||||
session
|
||||
let(:session) { controller.send(:session) }
|
||||
let(:from_id) { 123 }
|
||||
let(:chat_id) { 456 }
|
||||
let(:default_message_options) { {from: {id: from_id}, chat: {id: chat_id}} }
|
||||
|
||||
include Telegram::Bot::RSpec::ClientMatchers
|
||||
|
||||
def dispatch(bot = self.bot, update = self.update)
|
||||
controller.dispatch_again(bot, update)
|
||||
end
|
||||
|
||||
def dispatch_message(text, options = {})
|
||||
payload = build_payload :message, options.merge(text: text)
|
||||
controller_class.dispatch bot, payload
|
||||
update = build_update :message, default_message_options.merge(options).merge(text: text)
|
||||
dispatch bot, update
|
||||
end
|
||||
|
||||
def build_payload(type, content)
|
||||
def build_update(type, content)
|
||||
deep_stringify type => content
|
||||
end
|
||||
|
||||
@@ -28,4 +39,15 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||
else input
|
||||
end
|
||||
end
|
||||
|
||||
# Matcher to check response. Make sure to define `let(:chat_id)`.
|
||||
def respond_with_message(expected)
|
||||
send_telegram_message(bot, expected, chat_id: chat_id)
|
||||
end
|
||||
end
|
||||
|
||||
RSpec.configure do |config|
|
||||
if config.respond_to?(:include_context)
|
||||
config.include_context 'telegram/bot/updates_controller', type: :telegram_bot_controller
|
||||
end
|
||||
end
|
||||
|
||||
@@ -8,20 +8,31 @@ module Telegram
|
||||
module Session
|
||||
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(*)
|
||||
super
|
||||
ensure
|
||||
session.commit
|
||||
session.commit if @_session
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def session
|
||||
@_session ||= SessionHash.new(self.class.session_store, session_key)
|
||||
@_session ||= self.class.build_session(session_key)
|
||||
end
|
||||
|
||||
def session_key
|
||||
"#{bot.username}:#{from ? "from:#{from['id']}" : "chat:#{chat['id']}"}"
|
||||
subject = from || chat
|
||||
"#{bot.username}:#{subject['id']}" if subject
|
||||
end
|
||||
|
||||
# Rack::Session::Abstract::SessionHash is taken to provide lazy loading.
|
||||
@@ -59,7 +70,7 @@ module Telegram
|
||||
end
|
||||
end
|
||||
|
||||
class TestSessionHash < SessionHash
|
||||
class NullSessionHash < Session::SessionHash
|
||||
def initialize
|
||||
@data = {}
|
||||
@loaded = true
|
||||
@@ -77,6 +88,10 @@ module Telegram
|
||||
def session_store=(store)
|
||||
config.session_store = ActiveSupport::Cache.lookup_store(store)
|
||||
end
|
||||
|
||||
def use_session!
|
||||
include Session
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
35
lib/telegram/bot/updates_controller/testing.rb
Обычный файл
35
lib/telegram/bot/updates_controller/testing.rb
Обычный файл
@@ -0,0 +1,35 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class UpdatesController
|
||||
module Testing
|
||||
IVARS_TO_KEEP = %i[@_session].freeze
|
||||
|
||||
# Perform multiple dispatches on same instance.
|
||||
def dispatch_again(bot = nil, update = nil)
|
||||
recycle!
|
||||
initialize(bot, update)
|
||||
dispatch
|
||||
end
|
||||
|
||||
# Cleans controller between dispatches.
|
||||
# Seems like there is nothing to clean between requests for now:
|
||||
# everything will be rewriten with #initialize.
|
||||
#
|
||||
# With `full` set to `true` it'll clear all cached instance variables.
|
||||
def recycle!(full = false)
|
||||
return unless full
|
||||
(instance_variables - IVARS_TO_KEEP).each do |ivar|
|
||||
remove_instance_variable(ivar)
|
||||
end
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
# Stubs session.
|
||||
def session
|
||||
@_session ||= Session::NullSessionHash.new
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -4,7 +4,7 @@ module Telegram
|
||||
# Include this module to type cast update to Virtus model
|
||||
# using `telegram-bot-types` gem (install this gem first).
|
||||
module TypedUpdate
|
||||
def initialize(bot, update)
|
||||
def initialize(bot = nil, update = nil)
|
||||
update = Types::Update.new(update) if update && !update.is_a?(Types::Update)
|
||||
super
|
||||
end
|
||||
|
||||
@@ -27,12 +27,12 @@ module Telegram
|
||||
attr_reader :bot, :controller, :timeout, :offset, :logger, :running, :reload
|
||||
|
||||
def initialize(bot, controller, **options)
|
||||
@logger = options.fetch(:logger) { defined?(Rails) && Rails.logger }
|
||||
@logger = options.fetch(:logger) { defined?(Rails.logger) && Rails.logger }
|
||||
@bot = bot
|
||||
@controller = controller
|
||||
@timeout = options.fetch(:timeout) { DEFAULT_TIMEOUT }
|
||||
@offset = options[:offset]
|
||||
@reload = options.fetch(:reload) { defined?(Rails) && Rails.env.development? }
|
||||
@reload = options.fetch(:reload) { defined?(Rails.env) && Rails.env.development? }
|
||||
end
|
||||
|
||||
def log(&block)
|
||||
@@ -50,7 +50,7 @@ module Telegram
|
||||
end
|
||||
rescue Interrupt
|
||||
@running = false
|
||||
rescue => e
|
||||
rescue StandardError => e
|
||||
logger.error { ([e.message] + e.backtrace).join("\n") } if logger
|
||||
end
|
||||
end
|
||||
@@ -64,24 +64,40 @@ module Telegram
|
||||
end
|
||||
|
||||
def fetch_updates
|
||||
response = bot.get_updates(offset: offset, timeout: timeout)
|
||||
return unless response['ok'] && response['result'].any?
|
||||
response = bot.async(false) { bot.get_updates(offset: offset, timeout: timeout) }
|
||||
updates = response.is_a?(Array) ? response : response['result']
|
||||
return unless updates && updates.any?
|
||||
reload! do
|
||||
response['result'].each do |update|
|
||||
updates.each do |update|
|
||||
@offset = update['update_id'] + 1
|
||||
yield update
|
||||
end
|
||||
end
|
||||
rescue Timeout::Error # rubocop:disable HandleExceptions
|
||||
rescue Timeout::Error
|
||||
log { 'Fetch timeout' }
|
||||
end
|
||||
|
||||
def reload!
|
||||
return yield unless reload
|
||||
ActionDispatch::Reloader.prepare!
|
||||
if controller.is_a?(Class) && controller.name
|
||||
@controller = Object.const_get(controller.name)
|
||||
reloading_code do
|
||||
if controller.is_a?(Class) && 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
|
||||
yield.tap { ActionDispatch::Reloader.cleanup! }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
VERSION = '0.4.0'.freeze
|
||||
VERSION = '0.12.3'.freeze
|
||||
|
||||
def self.gem_version
|
||||
Gem::Version.new VERSION
|
||||
|
||||
13
spec/integration/requests/default_bot_spec.rb
Обычный файл
13
spec/integration/requests/default_bot_spec.rb
Обычный файл
@@ -0,0 +1,13 @@
|
||||
require 'integration_helper'
|
||||
|
||||
RSpec.describe DefaultBotController, :telegram_bot, type: :request 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
|
||||
9
spec/integration/requests/named_bot_spec.rb
Обычный файл
9
spec/integration/requests/named_bot_spec.rb
Обычный файл
@@ -0,0 +1,9 @@
|
||||
require 'integration_helper'
|
||||
|
||||
RSpec.describe NamedBotController, :telegram_bot, type: :request do
|
||||
let(:bot) { Telegram.bots[:named] }
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_command :start } }
|
||||
it { should respond_with_message 'from named' }
|
||||
end
|
||||
end
|
||||
14
spec/integration/requests/other_bot_spec.rb
Обычный файл
14
spec/integration/requests/other_bot_spec.rb
Обычный файл
@@ -0,0 +1,14 @@
|
||||
require 'integration_helper'
|
||||
|
||||
RSpec.describe OtherBotController, :telegram_bot, type: :request 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
|
||||
76
spec/integration_helper.rb
Обычный файл
76
spec/integration_helper.rb
Обычный файл
@@ -0,0 +1,76 @@
|
||||
require 'telegram/bot/rspec/integration'
|
||||
require 'action_controller'
|
||||
require 'action_dispatch'
|
||||
require 'action_dispatch/testing/integration'
|
||||
|
||||
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
|
||||
secrets[:secret_key_base] = 'test'
|
||||
secrets[:telegram] = {
|
||||
bot: 'default_token',
|
||||
bots: {
|
||||
other: {token: 'other_token'},
|
||||
named: {token: 'named_token', username: 'TestBot'},
|
||||
},
|
||||
}
|
||||
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_webhooks default: DefaultBotController,
|
||||
other: OtherBotController,
|
||||
named: NamedBotController
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -16,6 +16,9 @@ $LOAD_PATH.unshift GEM_ROOT.join('lib')
|
||||
require 'telegram/bot'
|
||||
require 'telegram/bot/updates_controller/rspec_helpers'
|
||||
require 'telegram/bot/types'
|
||||
require 'active_support/core_ext/object/json'
|
||||
|
||||
Dir[GEM_ROOT.join('spec/support/**/*.rb')].each { |f| require f }
|
||||
|
||||
RSpec.configure do |config|
|
||||
config.expect_with :rspec do |expectations|
|
||||
|
||||
143
spec/support/examples/async.rb
Обычный файл
143
spec/support/examples/async.rb
Обычный файл
@@ -0,0 +1,143 @@
|
||||
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
|
||||
65
spec/support/examples/initializers.rb
Обычный файл
65
spec/support/examples/initializers.rb
Обычный файл
@@ -0,0 +1,65 @@
|
||||
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
|
||||
28
spec/telegram/bot/async_spec.rb
Обычный файл
28
spec/telegram/bot/async_spec.rb
Обычный файл
@@ -0,0 +1,28 @@
|
||||
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
|
||||
33
spec/telegram/bot/botan/client_helpers_spec.rb
Обычный файл
33
spec/telegram/bot/botan/client_helpers_spec.rb
Обычный файл
@@ -0,0 +1,33 @@
|
||||
RSpec.describe Telegram::Bot::Client do
|
||||
let(:instance) { described_class.new(*client_args) }
|
||||
let(:token) { 'token' }
|
||||
let(:botan_token) { double(:botan_token) }
|
||||
let(:client_id) { 'client_id' }
|
||||
let(:client_args) { [token] }
|
||||
|
||||
describe '#botan' do
|
||||
subject { instance.botan }
|
||||
it { should eq nil }
|
||||
|
||||
context 'when botan token is set' do
|
||||
let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_token] }
|
||||
it { should be_instance_of Telegram::Bot::Botan }
|
||||
its(:token) { should eq botan_token }
|
||||
its(:id) { should eq client_id }
|
||||
|
||||
it 'doesnt inherit async from client' do
|
||||
expect(instance.async).to be
|
||||
expect(subject.async).to_not be
|
||||
end
|
||||
end
|
||||
|
||||
context 'when botan is configured with hash' do
|
||||
let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_config] }
|
||||
let(:botan_config) { {token: botan_token, async: Class.new} }
|
||||
it { should be_instance_of Telegram::Bot::Botan }
|
||||
its(:token) { should eq botan_token }
|
||||
its(:id) { should eq client_id }
|
||||
its(:async) { should eq botan_config[:async] }
|
||||
end
|
||||
end
|
||||
end
|
||||
54
spec/telegram/bot/botan/controller_helpers_spec.rb
Обычный файл
54
spec/telegram/bot/botan/controller_helpers_spec.rb
Обычный файл
@@ -0,0 +1,54 @@
|
||||
RSpec.describe Telegram::Bot::Botan::ControllerHelpers 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
|
||||
27
spec/telegram/bot/botan_spec.rb
Обычный файл
27
spec/telegram/bot/botan_spec.rb
Обычный файл
@@ -0,0 +1,27 @@
|
||||
RSpec.describe Telegram::Bot::Botan do
|
||||
let(:instance) { described_class.new 'token' }
|
||||
let(:token) { 'token' }
|
||||
|
||||
include_examples 'initializers', :botans
|
||||
it_behaves_like 'async', request_args: -> { [double(:method), double(:url)] }
|
||||
|
||||
describe '.new' do
|
||||
subject { described_class.new(*args) }
|
||||
|
||||
context 'when usual args are given' do
|
||||
let(:args) { ['secret'] }
|
||||
its(:token) { should eq args[0] }
|
||||
end
|
||||
|
||||
context 'when options are given' do
|
||||
let(:args) { [token: 'secret'] }
|
||||
its(:token) { should eq args[0][:token] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '.prepare_async_args' do
|
||||
subject { described_class.prepare_async_args(*input) }
|
||||
let(:input) { [:post, :uri, {a: 1, b: :sym, 'd' => 'str'}, 'body'] }
|
||||
it { should eq ['post', 'uri', {a: 1, b: 'sym', 'd' => 'str'}, 'body'] }
|
||||
end
|
||||
end
|
||||
@@ -1,55 +1,16 @@
|
||||
RSpec.describe Telegram::Bot::Client do
|
||||
describe '.wrap' do
|
||||
subject { described_class.wrap(input) }
|
||||
let(:result) { double(:result) }
|
||||
let(:token) { 'token' }
|
||||
let(:username) { 'username' }
|
||||
let(:instance) { described_class.new 'token' }
|
||||
let(:instance) { described_class.new 'token' }
|
||||
let(:token) { 'token' }
|
||||
let(:botan_token) { double(:botan_token) }
|
||||
|
||||
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) { result }
|
||||
should eq result
|
||||
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 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) { result_2 }
|
||||
should eq [result, instance, result_2]
|
||||
end
|
||||
end
|
||||
end
|
||||
include_examples 'initializers'
|
||||
it_behaves_like 'async', request_args: -> { [double(:action), {body: :content}] }
|
||||
|
||||
describe '.prepare_body' do
|
||||
subject { described_class.prepare_body(input) }
|
||||
|
||||
context 'when plain hash is given' do
|
||||
let(:input) { {a: 1, b: '2', c: [1, 2]} }
|
||||
let(:input) { {a: 1, b: '2', c: nil} }
|
||||
it { should eq input }
|
||||
end
|
||||
|
||||
@@ -58,9 +19,78 @@ RSpec.describe Telegram::Bot::Client do
|
||||
|
||||
it 'encodes nested hashes to json' do
|
||||
expected = input.dup
|
||||
%i(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
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '.prepare_async_args' do
|
||||
subject { described_class.prepare_async_args(*input) }
|
||||
let(:input) { [:action, a: 1, b: :sym, c: [:other], 'd' => 'str'] }
|
||||
it { should eq ['action', a: 1, b: 'sym', c: '["other"]', 'd' => 'str'] }
|
||||
end
|
||||
|
||||
describe '.new' do
|
||||
subject { described_class.new(*args) }
|
||||
|
||||
context 'when multiple args are given' do
|
||||
let(:args) { %w[secret superbot] }
|
||||
its(:token) { should eq args[0] }
|
||||
its(:username) { should eq args[1] }
|
||||
its(:base_uri) { should include args[0] }
|
||||
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}#{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
|
||||
|
||||
59
spec/telegram/bot/client_stub_spec.rb
Обычный файл
59
spec/telegram/bot/client_stub_spec.rb
Обычный файл
@@ -0,0 +1,59 @@
|
||||
RSpec.describe Telegram::Bot::ClientStub do
|
||||
describe '#stub_all!' do
|
||||
let(:client) { Telegram::Bot::Client.new('token', 'bot_name') }
|
||||
let(:clients) { ['token', token: 'token2'].map(&Telegram::Bot::Client.method(:wrap)) }
|
||||
|
||||
shared_examples 'constructors' do |expected_class|
|
||||
it 'makes Client.new return ClientStub' do
|
||||
expect(client).to be_instance_of expected_class
|
||||
expect(client.username).to eq 'bot_name'
|
||||
end
|
||||
|
||||
it 'makes Client.wrap return ClientStub' do
|
||||
expect(clients).to contain_exactly instance_of(expected_class),
|
||||
instance_of(expected_class)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when not used' do
|
||||
include_examples 'constructors', Telegram::Bot::Client
|
||||
end
|
||||
|
||||
context 'when enabled' do
|
||||
around { |ex| described_class.stub_all! { ex.run } }
|
||||
include_examples 'constructors', Telegram::Bot::ClientStub
|
||||
end
|
||||
|
||||
context 'when redisabled' do
|
||||
around do |ex|
|
||||
described_class.stub_all! do
|
||||
described_class.stub_all!(false) do
|
||||
ex.run
|
||||
end
|
||||
end
|
||||
end
|
||||
include_examples 'constructors', Telegram::Bot::Client
|
||||
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
|
||||
106
spec/telegram/bot/config_methods_spec.rb
Обычный файл
106
spec/telegram/bot/config_methods_spec.rb
Обычный файл
@@ -0,0 +1,106 @@
|
||||
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',
|
||||
botan: 'chat_botan_token',
|
||||
},
|
||||
other_chat: {
|
||||
'token' => 'other_chat_token',
|
||||
'username' => 'OtherChat',
|
||||
'botan' => 'other_chat_botan_token',
|
||||
},
|
||||
}
|
||||
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] }
|
||||
its('botan.token') { should eq config[:chat][:botan] }
|
||||
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'] }
|
||||
its('botan.token') { should eq config[:other_chat]['botan'] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#botans' do
|
||||
subject { registry.botans }
|
||||
it do
|
||||
should eq(
|
||||
default: nil,
|
||||
chat: registry.bots[:chat].botan,
|
||||
other_chat: registry.bots[:other_chat].botan,
|
||||
)
|
||||
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(secrets: secrets))) }
|
||||
let(:secrets) { {} }
|
||||
it { should eq({}) }
|
||||
|
||||
context 'when there is telegram section in secrets' do
|
||||
let(:secrets) { {telegram: config.stringify_keys} }
|
||||
let(:config) do
|
||||
{
|
||||
bot: double(:bot_config),
|
||||
bots: {
|
||||
chat: double(:chat_config),
|
||||
other_chat: double(:other_chat_config),
|
||||
},
|
||||
}
|
||||
end
|
||||
it { should include default: config[:bot] }
|
||||
it { should include config[:bots] }
|
||||
|
||||
context 'on rails >5.1 (deep symbolized keys)' do
|
||||
let(:secrets) { {telegram: config.deep_symbolize_keys} }
|
||||
it { should include default: config[:bot] }
|
||||
it { should include config[:bots] }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,3 +1,5 @@
|
||||
require 'rack/mock'
|
||||
|
||||
RSpec.describe Telegram::Bot::Middleware do
|
||||
let(:instance) { described_class.new bot, controller }
|
||||
let(:bot) { double(:bot) }
|
||||
@@ -6,13 +8,28 @@ RSpec.describe Telegram::Bot::Middleware do
|
||||
describe '#call' do
|
||||
subject { instance.call(env) }
|
||||
let(:env) { {'action_dispatch.request.request_parameters' => json_body} }
|
||||
let(:json_body) { double(:json_body) }
|
||||
let(:update) { {'message' => {'id' => 1}} }
|
||||
let(:env) do
|
||||
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.
|
||||
require 'action_dispatch/middleware/params_parser'
|
||||
let(:instance) { ActionDispatch::ParamsParser.new(super()) }
|
||||
end
|
||||
|
||||
it 'calls dispatch on controller' do
|
||||
expect(controller).to receive(:dispatch).with(bot, json_body)
|
||||
expect(controller).to receive(:dispatch).with(bot, update)
|
||||
subject
|
||||
end
|
||||
|
||||
it { should eq [200, {}, ''] }
|
||||
it { should eq [200, {}, ['']] }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -50,8 +50,9 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
|
||||
def assert_routes(*expected) # rubocop:disable AbcSize
|
||||
expected.each do |(bot, controller, route_name, options)|
|
||||
expected_path = options.delete(:path) || "telegram/#{bot.token}"
|
||||
expect(mapper).to receive(:post) do |path, params|
|
||||
expect(path).to eq "telegram/#{bot.token}"
|
||||
expect(path).to eq expected_path
|
||||
middleware = params[:to]
|
||||
expect(middleware.controller).to eq(controller)
|
||||
expect(middleware.bot.token).to eq(bot.token)
|
||||
@@ -70,6 +71,27 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
||||
[other_bot, controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
|
||||
context 'and bot does not have configured token' do
|
||||
let(:bot) { create_bot(nil) }
|
||||
it 'creates routes for every bot and this controller' do
|
||||
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
||||
[other_bot, controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
end
|
||||
|
||||
context 'and bot has colon in token' do
|
||||
let(:bot) { create_bot('some:token') }
|
||||
it 'replaces colon with underscore' do
|
||||
assert_routes [
|
||||
bot,
|
||||
controller,
|
||||
'default_telegram_webhook',
|
||||
option: :val,
|
||||
path: 'telegram/some_token',
|
||||
], [other_bot, controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when called with hash' do
|
||||
@@ -78,6 +100,7 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
{
|
||||
bot => controller,
|
||||
'custom_token' => [other_controller, as: :custom_route, option: :other_val],
|
||||
other: controller,
|
||||
},
|
||||
option: :val,
|
||||
]
|
||||
@@ -90,7 +113,8 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
other_controller,
|
||||
:custom_route,
|
||||
option: :other_val,
|
||||
]
|
||||
],
|
||||
[Telegram.bots[:other], controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
87
spec/telegram/bot/rspec/client_matchers_spec.rb
Обычный файл
87
spec/telegram/bot/rspec/client_matchers_spec.rb
Обычный файл
@@ -0,0 +1,87 @@
|
||||
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
|
||||
72
spec/telegram/bot/rspec/integration_spec.rb
Обычный файл
72
spec/telegram/bot/rspec/integration_spec.rb
Обычный файл
@@ -0,0 +1,72 @@
|
||||
require 'telegram/bot/rspec/integration'
|
||||
require 'action_controller'
|
||||
require 'action_dispatch'
|
||||
require 'action_dispatch/testing/integration'
|
||||
|
||||
RSpec.describe 'Integrations helper', :telegram_bot do
|
||||
include ActionDispatch::Integration::Runner
|
||||
def reset_template_assertion
|
||||
end
|
||||
|
||||
let(:app) do
|
||||
app = Telegram::Bot::Middleware.new(bot, controller)
|
||||
if ActionPack::VERSION::MAJOR >= 5
|
||||
app
|
||||
else
|
||||
require 'action_dispatch/middleware/params_parser'
|
||||
ActionDispatch::ParamsParser.new(app)
|
||||
end
|
||||
end
|
||||
let(:bot) { Telegram::Bot::ClientStub.new('token') }
|
||||
let(:controller_path) { '/' }
|
||||
let(:controller) 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' do
|
||||
subject { -> { dispatch message: {text: '/start', **default_message_options} } }
|
||||
it { should respond_with_message 'Start: [], option: ' }
|
||||
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
|
||||
@@ -0,0 +1,65 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController::CallbackQueryContext 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
|
||||
|
||||
attr_accessor :filter_done
|
||||
before_action only: :ctx2_callback_query do
|
||||
self.filter_done = true
|
||||
end
|
||||
|
||||
def callback_query(data)
|
||||
[:no_context, data]
|
||||
end
|
||||
|
||||
def ctx1_callback_query(data)
|
||||
[:ctx1, data]
|
||||
end
|
||||
|
||||
def ctx2_callback_query(data)
|
||||
[:ctx2, data]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#dispatch' do
|
||||
subject { -> { dispatch } }
|
||||
let(:payload_type) { :callback_query }
|
||||
let(:payload) { {'data' => data} }
|
||||
let(:data) { text }
|
||||
let(:text) { 'asd qwe zxc' }
|
||||
|
||||
context 'when context is not set' do
|
||||
its(:call) { should eq [:no_context, text] }
|
||||
it { should_not change(controller, :filter_done) }
|
||||
end
|
||||
|
||||
context 'when context is set' do
|
||||
let(:data) { "#{ctx}:#{text}" }
|
||||
|
||||
context 'and valid' do
|
||||
let(:ctx) { 'ctx1' }
|
||||
its(:call) { should eq [:ctx1, text] }
|
||||
it { should_not change(controller, :filter_done) }
|
||||
|
||||
context 'and context has callback' do
|
||||
let(:ctx) { 'ctx2' }
|
||||
its(:call) { should eq [:ctx2, text] }
|
||||
it { should change(controller, :filter_done) }
|
||||
end
|
||||
|
||||
context 'and data has multiple colons' do
|
||||
let(:text) { super().tr(' ', ':') }
|
||||
its(:call) { should eq [:ctx1, text] }
|
||||
end
|
||||
end
|
||||
|
||||
context 'and invalid' do
|
||||
let(:ctx) { 'missing' }
|
||||
its(:call) { should eq [:no_context, data] }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
137
spec/telegram/bot/updates_controller/message_context_spec.rb
Обычный файл
137
spec/telegram/bot/updates_controller/message_context_spec.rb
Обычный файл
@@ -0,0 +1,137 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController::MessageContext 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
|
||||
|
||||
attr_accessor :filter_done
|
||||
before_action only: :redirect do
|
||||
self.filter_done = true
|
||||
end
|
||||
|
||||
attr_reader :callbacks_runs
|
||||
before_action { @callbacks_runs = (@callbacks_runs || 0) + 1 }
|
||||
|
||||
def message(*args)
|
||||
[:no_context, *args]
|
||||
end
|
||||
|
||||
context_handler :block do |*args|
|
||||
[:block_result, *args]
|
||||
end
|
||||
|
||||
context_handler :redirect
|
||||
context_handler :other_redirect, :redirect
|
||||
|
||||
def redirect(*args)
|
||||
[:method_result, *args]
|
||||
end
|
||||
|
||||
def action(*args)
|
||||
[:action_result, *args]
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def not_action
|
||||
raise 'Should not be called!'
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#message' do
|
||||
subject { -> { dispatch } }
|
||||
let(:payload_type) { :message }
|
||||
let(:payload) { {'text' => text} }
|
||||
let(:text) { 'asd qwe zxc' }
|
||||
|
||||
context 'when context is not set' do
|
||||
its(:call) { should eq [:no_context, payload] }
|
||||
it { should_not change(controller, :filter_done) }
|
||||
it { should_not change { session[:context] } }
|
||||
end
|
||||
|
||||
context 'when context is handled by block' do
|
||||
before { session[:context] = :block }
|
||||
its(:call) { should eq [:block_result, *text.split] }
|
||||
it { should_not change(controller, :filter_done) }
|
||||
it { should change { session[:context] }.to nil }
|
||||
|
||||
context 'when message has no text' do
|
||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||
its(:call) { should eq [:block_result] }
|
||||
end
|
||||
|
||||
context 'when message has new command' do
|
||||
let(:text) { '/action a s d' }
|
||||
its(:call) { should eq [:action_result, 'a', 's', 'd'] }
|
||||
it { should change { session[:context] }.to nil }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when context is handled by short redirect' do
|
||||
before { session[:context] = :redirect }
|
||||
its(:call) { should eq [:method_result, *text.split] }
|
||||
it { should change(controller, :filter_done).to true }
|
||||
it { should change { session[:context] }.to nil }
|
||||
it { should change(controller, :callbacks_runs).to 1 }
|
||||
|
||||
context 'when message has no text' do
|
||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||
its(:call) { should eq [:method_result] }
|
||||
it { should change(controller, :filter_done).to true }
|
||||
it { should change { session[:context] }.to nil }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when context is handled by custom redirect' do
|
||||
before { session[:context] = :other_redirect }
|
||||
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 change { session[:context] }.to nil }
|
||||
end
|
||||
|
||||
context 'when context_to_action is true' do
|
||||
before { controller_class.context_to_action! }
|
||||
|
||||
context 'when context is not set' do
|
||||
its(:call) { should eq [:no_context, payload] }
|
||||
it { should_not change(controller, :filter_done) }
|
||||
it { should_not change { session[:context] } }
|
||||
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
|
||||
79
spec/telegram/bot/updates_controller/reply_helpers_spec.rb
Обычный файл
79
spec/telegram/bot/updates_controller/reply_helpers_spec.rb
Обычный файл
@@ -0,0 +1,79 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController do
|
||||
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)} }
|
||||
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(controller).to receive(:chat) { chat }
|
||||
expect(bot).to receive("send_#{respond_type}").
|
||||
with(params.merge(chat_id: chat['id'])) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
|
||||
describe '#reply_with' do
|
||||
subject { controller.reply_with respond_type, params }
|
||||
include_examples 'missing chat'
|
||||
|
||||
it 'sets chat_id & reply_to_message_id' do
|
||||
expect(controller).to receive(:chat) { chat }
|
||||
expect(bot).to receive("send_#{respond_type}").with(params.merge(
|
||||
chat_id: chat['id'],
|
||||
reply_to_message_id: payload[:message_id],
|
||||
)) { result }
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'when update is not set' do
|
||||
let(:update) { {chat: chat} }
|
||||
it 'sets chat_id' do
|
||||
expect(bot).to receive("send_#{respond_type}").
|
||||
with(params.merge(chat_id: chat['id'])) { result }
|
||||
should eq result
|
||||
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 }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -26,6 +26,12 @@ RSpec.describe Telegram::Bot::UpdatesController::Session do
|
||||
def read
|
||||
session[:text]
|
||||
end
|
||||
|
||||
def action_missing(*)
|
||||
[:action_missing, session[:text]].tap do
|
||||
session[:text] = 'test'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -39,5 +45,54 @@ RSpec.describe Telegram::Bot::UpdatesController::Session do
|
||||
expect(subject.call(bot, build_message('/read', id: 2))).to eq nil
|
||||
expect(subject.call(other_bot, build_message('/read', id: 1))).to eq nil
|
||||
end
|
||||
|
||||
context 'payload is not supported' do
|
||||
let(:payload_type) { '_unsupported_' }
|
||||
it 'provides empty session' do
|
||||
2.times { expect(subject.call(bot)).to eq [:action_missing, nil] }
|
||||
expect(subject.call(other_bot)).to eq [:action_missing, nil]
|
||||
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
|
||||
|
||||
27
spec/telegram/bot/updates_controller/testing_spec.rb
Обычный файл
27
spec/telegram/bot/updates_controller/testing_spec.rb
Обычный файл
@@ -0,0 +1,27 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController::Testing do
|
||||
include_context 'telegram/bot/updates_controller'
|
||||
let(:controller_class) do
|
||||
Class.new(Telegram::Bot::UpdatesController) do
|
||||
attr_accessor :ivar
|
||||
end
|
||||
end
|
||||
|
||||
describe '#recycle!' do
|
||||
subject { -> { controller.recycle!(full) } }
|
||||
before do
|
||||
controller.ivar = :ival
|
||||
session[:key] = 'sval'
|
||||
end
|
||||
let(:full) {}
|
||||
|
||||
it { should_not change(controller, :ivar).from :ival }
|
||||
it { should_not change { controller.send(:session)[:key] }.from 'sval' }
|
||||
|
||||
context 'when full is true' do
|
||||
let(:full) { true }
|
||||
it { should change(controller, :ivar).from(:ival).to nil }
|
||||
it { should change { controller.instance_variable_defined?(:@ivar) }.to false }
|
||||
it { should_not change { controller.send(:session)[:key] }.from 'sval' }
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -8,12 +8,12 @@ RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate do
|
||||
end
|
||||
|
||||
context 'when `update` is a virtus model' do
|
||||
subject { instance }
|
||||
%w(
|
||||
subject { controller }
|
||||
%w[
|
||||
message
|
||||
inline_query
|
||||
chosen_inline_result
|
||||
).each do |type|
|
||||
].each do |type|
|
||||
context "with #{type}" do
|
||||
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
||||
let(:payload_type) { type }
|
||||
|
||||
@@ -78,48 +78,96 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
|
||||
describe '#action_for_payload' do
|
||||
subject { instance.action_for_payload }
|
||||
subject { controller.action_for_payload }
|
||||
|
||||
(described_class::PAYLOAD_TYPES - %w(message)).each do |type|
|
||||
context "when payload is #{type}" do
|
||||
def stub_payload(*fields)
|
||||
Hash[fields.map { |x| [x, double(x)] }]
|
||||
end
|
||||
|
||||
context 'when payload is inline_query' do
|
||||
let(:payload_type) { 'inline_query' }
|
||||
let(:payload) { stub_payload(:id, :from, :location, :query, :offset) }
|
||||
it { should eq [false, payload_type, payload.values_at(:query, :offset)] }
|
||||
end
|
||||
|
||||
context 'when payload is chosen_inline_result' do
|
||||
let(:payload_type) { 'chosen_inline_result' }
|
||||
let(:payload) { stub_payload(:result_id, :from, :location, :inline_message_id, :query) }
|
||||
it { should eq [false, payload_type, payload.values_at(:result_id, :query)] }
|
||||
end
|
||||
|
||||
context 'when payload is callback_query' do
|
||||
let(:payload_type) { 'callback_query' }
|
||||
let(:payload) { stub_payload(:id, :from, :message, :inline_message_id, :data) }
|
||||
it { should eq [false, payload_type, payload.values_at(:data)] }
|
||||
end
|
||||
|
||||
context 'when payload is not supported' do
|
||||
let(:payload_type) { '_unsupported_' }
|
||||
it { should eq [false, :unsupported_payload_type, []] }
|
||||
end
|
||||
|
||||
%w[message channel_post].each do |type|
|
||||
context "when payload is edited_#{type}" do
|
||||
let(:payload_type) { "edited_#{type}" }
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
end
|
||||
|
||||
context 'when payload is message' do
|
||||
let(:payload_type) { type }
|
||||
it { should eq [false, type, [payload]] }
|
||||
let(:payload) { {'text' => text} }
|
||||
let(:text) { 'test' }
|
||||
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
|
||||
context 'with command' do
|
||||
let(:text) { "/test#{"@#{mention}" if mention} arg 1 2" }
|
||||
let(:mention) {}
|
||||
it { should eq [true, 'test', %w[arg 1 2]] }
|
||||
|
||||
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, payload_type, [payload]] }
|
||||
end
|
||||
end
|
||||
|
||||
context 'without text' do
|
||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when payload is message' do
|
||||
let(:payload_type) { 'message' }
|
||||
let(:payload) { {'text' => text} }
|
||||
let(:text) { 'test' }
|
||||
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
|
||||
context 'with command' do
|
||||
let(:text) { "/test#{"@#{mention}" if mention} arg 1 2" }
|
||||
let(:mention) {}
|
||||
it { should eq [true, 'test', %w(arg 1 2)] }
|
||||
|
||||
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
|
||||
custom_payload_types = %w[
|
||||
message
|
||||
edited_message
|
||||
channel_post
|
||||
edited_channel_post
|
||||
inline_query
|
||||
chosen_inline_result
|
||||
callback_query
|
||||
]
|
||||
(described_class::PAYLOAD_TYPES - custom_payload_types).each do |type|
|
||||
context "when payload is #{type}" do
|
||||
let(:payload_type) { type }
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when `update` is a virtus model' do
|
||||
subject { instance }
|
||||
subject { controller }
|
||||
let(:update) { Telegram::Bot::Types::Update.new(super()) }
|
||||
%w(
|
||||
%w[
|
||||
message
|
||||
inline_query
|
||||
chosen_inline_result
|
||||
).each do |type|
|
||||
].each do |type|
|
||||
context "with #{type}" do
|
||||
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
||||
let(:payload_type) { type }
|
||||
@@ -131,7 +179,7 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
|
||||
describe '#bot_username' do
|
||||
subject { instance.bot_username }
|
||||
subject { controller.bot_username }
|
||||
|
||||
context 'when bot is not set' do
|
||||
let(:bot) {}
|
||||
@@ -144,18 +192,44 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
end
|
||||
|
||||
describe '#process_action' do
|
||||
subject { -> { instance.process_action(:action) } }
|
||||
describe '#process' do
|
||||
subject { -> { controller.process(:action, *args) } }
|
||||
let(:args) { %i[arg1 arg2] }
|
||||
let(:controller_class) do
|
||||
Class.new(described_class) do
|
||||
attr_reader :acted, :hooked
|
||||
|
||||
def action(*args)
|
||||
@acted = true
|
||||
[from, chat, args]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when action is protected' do
|
||||
before { controller_class.send :protected, :action }
|
||||
its(:call) { should eq nil }
|
||||
|
||||
context 'when action_missing defined' do
|
||||
before do
|
||||
controller.class_eval do
|
||||
protected
|
||||
|
||||
def action_missing(*args)
|
||||
args
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
its(:call) { should eq ['action', *args] }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when callbacks are defined' do
|
||||
let(:controller_class) do
|
||||
Class.new(described_class) do
|
||||
before_action :hook
|
||||
attr_reader :acted, :hooked
|
||||
|
||||
def action
|
||||
@acted = true
|
||||
end
|
||||
before do
|
||||
controller_class.class_eval do
|
||||
before_action :hook, only: :action
|
||||
attr_reader :hooked
|
||||
|
||||
private
|
||||
|
||||
@@ -165,22 +239,121 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
end
|
||||
|
||||
it { should change(instance, :hooked).to true }
|
||||
it { should change(instance, :acted).to true }
|
||||
it { should change(controller, :hooked).to true }
|
||||
it { should change(controller, :acted).to true }
|
||||
its(:call) { should eq [nil, nil, args] }
|
||||
|
||||
context 'when callback returns false' do
|
||||
context 'when callback halts chain' do
|
||||
before do
|
||||
controller_class.prepend(Module.new do
|
||||
def hook
|
||||
super
|
||||
false
|
||||
ActiveSupport::VERSION::MAJOR >= 5 ? throw(:abort) : false
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
it { should change(instance, :hooked).to true }
|
||||
it { should_not change(instance, :acted).from nil }
|
||||
it { should change(controller, :hooked).to true }
|
||||
it { should_not change(controller, :acted).from nil }
|
||||
its(:call) { should eq false }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when initialized without update' do
|
||||
let(:controller) { controller_class.new(bot, from: from, chat: chat) }
|
||||
let(:from) { {'id' => 'user_id'} }
|
||||
let(:chat) { {'id' => 'chat_id'} }
|
||||
its(:call) { should eq [from, chat, args] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#initialize' do
|
||||
subject { controller }
|
||||
let(:payload_type) { 'message' }
|
||||
let(:payload) { deep_stringify(chat: chat, from: from) }
|
||||
let(:chat) { double(:chat) }
|
||||
let(:from) { double(:from) }
|
||||
|
||||
def self.with_reinitialize(&block)
|
||||
instance_eval(&block)
|
||||
context 'when re-initialized' do
|
||||
let(:controller) do
|
||||
described_class.new(double(:other_bot), build_update(:message,
|
||||
text: 'original message',
|
||||
from: double(:original_from),
|
||||
chat: double(:original_chat),
|
||||
)).tap { |x| x.send(:initialize, bot, update) }
|
||||
end
|
||||
instance_eval(&block)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when update is given' do
|
||||
with_reinitialize do
|
||||
its(:bot) { should eq bot }
|
||||
its(:update) { should eq update }
|
||||
its(:payload) { should eq payload }
|
||||
its(:payload_type) { should eq payload_type }
|
||||
its(:from) { should eq from }
|
||||
its(:chat) { should eq chat }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when options hash is given' do
|
||||
let(:update) { {from: from, chat: chat} }
|
||||
with_reinitialize do
|
||||
its(:bot) { should eq bot }
|
||||
its(:update) { should eq nil }
|
||||
its(:payload) { should eq nil }
|
||||
its(:payload_type) { should eq nil }
|
||||
its(:from) { should eq from }
|
||||
its(:chat) { should eq chat }
|
||||
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
|
||||
|
||||
@@ -1,9 +1,39 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesPoller do
|
||||
describe '#initialize' do
|
||||
subject { described_class.new bot, controller }
|
||||
let(:bot) { double }
|
||||
let(:controller) { double }
|
||||
let(:instance) { described_class.new(bot, controller) }
|
||||
let(:bot) { Telegram::Bot::Client.new('token') }
|
||||
let(:controller) { double(:controller) }
|
||||
|
||||
describe '#initialize' do
|
||||
subject { instance }
|
||||
it { should be }
|
||||
end
|
||||
|
||||
describe '#fetch_updates' do
|
||||
subject { -> { instance.fetch_updates(&block) } }
|
||||
let(:block) { ->(x) { expect(x).to eq expected_results.shift } }
|
||||
let(:results) { [{update_id: 12}, {update_id: 34}] }
|
||||
let(:expected_results) { results.as_json }
|
||||
let(:request_result) { {ok: true, result: results}.as_json }
|
||||
before do
|
||||
allow(bot).to receive(:get_updates) do
|
||||
expect(bot.async).to be_falsy
|
||||
request_result
|
||||
end
|
||||
end
|
||||
|
||||
it { should change(instance, :offset).to(results.last[:update_id] + 1) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
|
||||
context 'with typed response' do
|
||||
let(:request_result) { results.as_json.map { |x| Telegram::Bot::Types::Update.new(x) } }
|
||||
let(:expected_results) { request_result.dup }
|
||||
it { should change(instance, :offset).to(results.last[:update_id] + 1) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
end
|
||||
|
||||
context 'when bot is in async mode' do
|
||||
let(:bot) { Telegram::Bot::Client.new('token', async: Class.new) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
# coding: utf-8
|
||||
lib = File.expand_path('../lib', __FILE__)
|
||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||
require 'telegram/bot/version'
|
||||
@@ -20,9 +19,10 @@ Gem::Specification.new do |spec|
|
||||
|
||||
spec.required_ruby_version = '~> 2.0'
|
||||
|
||||
spec.add_dependency 'activesupport', '~> 4.0'
|
||||
spec.add_dependency 'actionpack', '~> 4.0'
|
||||
spec.add_dependency 'actionpack', '>= 4.0', '< 6.0'
|
||||
spec.add_dependency 'activesupport', '>= 4.0', '< 6.0'
|
||||
spec.add_dependency 'httpclient', '~> 2.7'
|
||||
|
||||
spec.add_development_dependency 'bundler', '~> 1.11'
|
||||
spec.add_development_dependency 'rake', '~> 10.0'
|
||||
end
|
||||
|
||||
Ссылка в новой задаче
Block a user