зеркало из
https://github.com/glebtv/telegram-bot.git
synced 2026-09-03 17:55:52 +03:00
Сравнить коммиты
47 Коммитов
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
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 | ||
|
|
933bb337ef | ||
|
|
f549ed53a5 | ||
|
|
bff412360e | ||
|
|
298947f970 | ||
|
|
ccb84c744a | ||
|
|
1b12435d8b | ||
|
|
d127a52364 | ||
|
|
a1adf17df3 |
@@ -8,9 +8,11 @@ Style/AlignParameters:
|
|||||||
# EnforcedStyle:
|
# EnforcedStyle:
|
||||||
# - with_first_parameter
|
# - with_first_parameter
|
||||||
# - with_fixed_indentation
|
# - with_fixed_indentation
|
||||||
|
Style/AndOr: {EnforcedStyle: conditionals}
|
||||||
Style/ClosingParenthesisIndentation: {Enabled: false}
|
Style/ClosingParenthesisIndentation: {Enabled: false}
|
||||||
Style/Documentation: {Enabled: false}
|
Style/Documentation: {Enabled: false}
|
||||||
Style/DotPosition: {EnforcedStyle: trailing}
|
Style/DotPosition: {EnforcedStyle: trailing}
|
||||||
|
Style/FirstParameterIndentation: {EnforcedStyle: consistent}
|
||||||
Style/IfUnlessModifier: {Enabled: false}
|
Style/IfUnlessModifier: {Enabled: false}
|
||||||
Style/ModuleFunction: {Enabled: false}
|
Style/ModuleFunction: {Enabled: false}
|
||||||
Style/MultilineOperationIndentation: {EnforcedStyle: indented}
|
Style/MultilineOperationIndentation: {EnforcedStyle: indented}
|
||||||
|
|||||||
@@ -2,5 +2,8 @@ language: ruby
|
|||||||
cache: bundler
|
cache: bundler
|
||||||
rvm:
|
rvm:
|
||||||
- 2.2.3
|
- 2.2.3
|
||||||
|
env:
|
||||||
|
- RAILS=4
|
||||||
|
- RAILS=5
|
||||||
notifications:
|
notifications:
|
||||||
email: false
|
email: false
|
||||||
|
|||||||
47
CHANGELOG.md
Обычный файл
47
CHANGELOG.md
Обычный файл
@@ -0,0 +1,47 @@
|
|||||||
|
# 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.
|
||||||
9
Gemfile
9
Gemfile
@@ -1,11 +1,20 @@
|
|||||||
source 'https://rubygems.org'
|
source 'https://rubygems.org'
|
||||||
gemspec
|
gemspec
|
||||||
|
|
||||||
|
case ENV['RAILS']
|
||||||
|
when '5'
|
||||||
|
gem 'actionpack', '5.0.0.rc1'
|
||||||
|
when '4'
|
||||||
|
gem 'actionpack', '~> 4.2'
|
||||||
|
end
|
||||||
|
|
||||||
group :development do
|
group :development do
|
||||||
gem 'sdoc', '~> 0.4.1'
|
gem 'sdoc', '~> 0.4.1'
|
||||||
gem 'pry', '~> 0.10.1'
|
gem 'pry', '~> 0.10.1'
|
||||||
gem 'pry-byebug', '~> 3.2.0'
|
gem 'pry-byebug', '~> 3.2.0'
|
||||||
|
|
||||||
|
gem 'telegram-bot-types', '~> 0.2.0'
|
||||||
|
|
||||||
gem 'rspec', '~> 3.3.0'
|
gem 'rspec', '~> 3.3.0'
|
||||||
gem 'rspec-its', '~> 1.1.0'
|
gem 'rspec-its', '~> 1.1.0'
|
||||||
|
|
||||||
|
|||||||
251
README.md
251
README.md
@@ -1,22 +1,26 @@
|
|||||||
# Telegram::Bot
|
# Telegram::Bot
|
||||||
|
|
||||||
[](http://badge.fury.io/rb/telegram-bot)
|
[](http://badge.fury.io/rb/telegram-bot)
|
||||||
[](https://codeclimate.com/github/printercu/telegram-bot)
|
[](https://codeclimate.com/github/telegram-bot-rb/telegram-bot)
|
||||||
[](https://travis-ci.org/printercu/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
|
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
|
standalone app. Supposed to be used in webhook-mode in production, and poller-mode
|
||||||
in development, but you can use poller in production if you want.
|
in development, but you can use poller in production if you want.
|
||||||
|
|
||||||
Package contains:
|
Package contains:
|
||||||
|
|
||||||
- Ligthweight client to bot API (with fast and thread-safe
|
- Ligthweight client for bot API (with fast and thread-safe
|
||||||
[httpclient](https://github.com/nahi/httpclient) is under the hood.)
|
[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. Allows to write separate methods for each command.
|
||||||
- Middleware and routes helpers for production env.
|
- Middleware and routes helpers for production env.
|
||||||
- Poller with automatic source-reloader for development env.
|
- Poller with automatic source-reloader for development env.
|
||||||
- Rake tasks to update webhook urls.
|
- Rake tasks to update webhook urls.
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Add this line to your application's Gemfile:
|
Add this line to your application's Gemfile:
|
||||||
@@ -62,25 +66,45 @@ telegram:
|
|||||||
From now clients will be accessible with `Telegram.bots[:chat]` or `Telegram.bots[:auction]`.
|
From now clients will be accessible with `Telegram.bots[:chat]` or `Telegram.bots[:auction]`.
|
||||||
Single bot can be accessed with `Telegram.bot` or `Telegram.bots[:default]`.
|
Single bot can be accessed with `Telegram.bot` or `Telegram.bots[:default]`.
|
||||||
|
|
||||||
You can create clients manually with `Telegram::Bot.new(token, username)`.
|
You can create clients manually with `Telegram::Bot::Client.new(token, username)`.
|
||||||
Username is optional and used only to parse commands with mentions.
|
Username is optional and used only to parse commands with mentions.
|
||||||
|
|
||||||
Client has all available methods in underscored style
|
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`).
|
(`answer_inline_query` instead of `answerInlineQuery`).
|
||||||
All this methods just post given params to specific URL.
|
All this methods just post given params to specific URL.
|
||||||
|
|
||||||
```ruby
|
```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'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
By default client will return parsed json responses. You can enable
|
||||||
|
response typecasting to virtus models using `telegram-bot-types` gem:
|
||||||
|
```ruby
|
||||||
|
# Add to your gemfile:
|
||||||
|
gem 'telegram-bot-types', '~> x.x.x'
|
||||||
|
# Enable typecasting:
|
||||||
|
Telegram::Bot::Client.typed_response!
|
||||||
|
# or for single instance:
|
||||||
|
bot.extend Telegram::Bot::Client::TypedResponse
|
||||||
|
|
||||||
|
bot.get_me.class # => Telegram::Bot::Types::User
|
||||||
|
```
|
||||||
|
|
||||||
|
Any API request error will raise `Telegram::Bot::Error` with description in its message.
|
||||||
|
Special `Telegram::Bot::StaleChat` is raised when bot can't post messages to the chat anymore.
|
||||||
|
|
||||||
### Controller
|
### Controller
|
||||||
|
|
||||||
```ruby
|
```ruby
|
||||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
# use callbacks like in any other controllers
|
# use callbacks like in any other controllers
|
||||||
around_action :set_locale
|
around_action :with_locale
|
||||||
|
|
||||||
# Every update can have one of: message, inline_query & chosen_inline_result.
|
# Every update can have one of: message, inline_query, chosen_inline_result,
|
||||||
|
# callback_query.
|
||||||
# Define method with same name to respond to this updates.
|
# Define method with same name to respond to this updates.
|
||||||
def message(message)
|
def message(message)
|
||||||
# message can be also accessed via instance method
|
# message can be also accessed via instance method
|
||||||
@@ -88,6 +112,13 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
|||||||
# store_message(message['text'])
|
# store_message(message['text'])
|
||||||
end
|
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.
|
# Define public methods to respond to commands.
|
||||||
# Command arguments will be parsed and passed to the method.
|
# Command arguments will be parsed and passed to the method.
|
||||||
# Be sure to use splat args and default values to not get errors when
|
# Be sure to use splat args and default values to not get errors when
|
||||||
@@ -100,14 +131,15 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
|||||||
|
|
||||||
# There are `chat` & `from` shortcut methods.
|
# There are `chat` & `from` shortcut methods.
|
||||||
response = from ? "Hello #{from['username']}!" : 'Hi there!'
|
response = from ? "Hello #{from['username']}!" : 'Hi there!'
|
||||||
# There is `reply_with` helper to set basic fields
|
# There is `respond_with` helper to set `chat_id` from received message:
|
||||||
# like `reply_to_message` & `chat_id`.
|
respond_with :message, text: response
|
||||||
reply_with :message, text: response
|
# `reply_with` also sets `reply_to_message_id`:
|
||||||
|
reply_with :photo, photo: File.open('party.jpg')
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
def set_locale(&block)
|
def with_locale(&block)
|
||||||
I18n.with_locale(locale_for_update, &block)
|
I18n.with_locale(locale_for_update, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -121,6 +153,119 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
|||||||
end
|
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::UpdatesController::TypedUpdate
|
||||||
|
|
||||||
|
def message(message)
|
||||||
|
message.class # => Telegram::Bot::Types::Message
|
||||||
|
end
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Session
|
||||||
|
|
||||||
|
There is support for sessions using `ActiveSupport::Cache` stores.
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
# configure store in env files:
|
||||||
|
config.telegram_updates_controller.session_store = :redis_store, {expires_in: 1.month}
|
||||||
|
|
||||||
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
|
include Telegram::Bot::UpdatesController::Session
|
||||||
|
# or just shortcut:
|
||||||
|
use_session!
|
||||||
|
|
||||||
|
# You can override global config
|
||||||
|
self.session_store = :file_store
|
||||||
|
|
||||||
|
def write(text = nil, *)
|
||||||
|
session[:text] = text
|
||||||
|
end
|
||||||
|
|
||||||
|
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.
|
||||||
|
def session_key
|
||||||
|
# In this case session will persist for user only in specific chat:
|
||||||
|
"#{bot.username}:#{chat['id']}:#{from['id']}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Message context
|
||||||
|
|
||||||
|
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
|
||||||
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
|
include Telegram::Bot::UpdatesController::MessageContext
|
||||||
|
|
||||||
|
def rename(*)
|
||||||
|
# set context for the next message
|
||||||
|
save_context :rename
|
||||||
|
respond_with :message, text: 'What name do you like?'
|
||||||
|
end
|
||||||
|
|
||||||
|
# register context handlers to handle this context
|
||||||
|
context_handler :rename do |*words|
|
||||||
|
update_name words[0]
|
||||||
|
respond_with :message, text: 'Renamed!'
|
||||||
|
end
|
||||||
|
|
||||||
|
# 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 use
|
||||||
|
context_to_action!
|
||||||
|
# It'll use context value as action name for all contexts which miss handlers.
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
You can use `CallbackQueyContext` in the similar way to split `#callback_query` into
|
||||||
|
several specific methods. It doesn't require session support, and takes context from
|
||||||
|
data. If data has a prefix with colon like this `my_ctx:smth...` it'll call
|
||||||
|
`my_ctx_callback_query('smth...')` when there is such action method. Otherwise
|
||||||
|
it'll call `callback_query('my_ctx:smth...')` as usual.
|
||||||
|
|
||||||
|
#### Processesing updates
|
||||||
|
|
||||||
|
To process update run:
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
ControllerClass.dispatch(bot, update)
|
||||||
|
```
|
||||||
|
|
||||||
|
There is also ability to run action without update:
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
# Most likely you'll want to pass :from and :chat
|
||||||
|
controller = ControllerClass.new(bot, from: telegram_user, chat: telegram_chat)
|
||||||
|
controller.process(:help, *args)
|
||||||
|
```
|
||||||
|
|
||||||
### Routes
|
### Routes
|
||||||
|
|
||||||
Use `telegram_webhooks` helper to add routes. It will create routes for bots
|
Use `telegram_webhooks` helper to add routes. It will create routes for bots
|
||||||
@@ -148,7 +293,8 @@ telegram_webhooks bot => TelegramChatController,
|
|||||||
# You can override this options or specify others:
|
# You can override this options or specify others:
|
||||||
telegram_webhooks TelegramController, as: :my_webhook
|
telegram_webhooks TelegramController, as: :my_webhook
|
||||||
telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
||||||
other_bot => [TelegramAuctionController,
|
other_bot => TelegramAuctionController,
|
||||||
|
admin_chat: TelegramAdminChatController
|
||||||
```
|
```
|
||||||
|
|
||||||
For Rack applications you can also use `Telegram::Bot::Middleware` or just
|
For Rack applications you can also use `Telegram::Bot::Middleware` or just
|
||||||
@@ -156,18 +302,77 @@ call `.dispatch(bot, update)` on controller.
|
|||||||
|
|
||||||
### Development & Debugging
|
### Development & Debugging
|
||||||
|
|
||||||
Use `rake telegram:bot:poller BOT=chat` to run poller. It'll automatically load
|
Use `rake telegram:bot:poller` to run poller. It'll automatically load
|
||||||
changes without restart in development env. This task will not if you don't use
|
changes without restart in development env. Optionally specify bot to run poller for
|
||||||
`telegram_webhooks`.
|
with `BOT` envvar (`BOT=chat`).
|
||||||
|
|
||||||
|
This task will not work if you don't use `telegram_webhooks`.
|
||||||
You can run poller manually with
|
You can run poller manually with
|
||||||
`Telegram::Bot::UpdatesPoller.start(bot, controller_class)`.
|
`Telegram::Bot::UpdatesPoller.start(bot, controller_class)`.
|
||||||
|
|
||||||
|
### 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. Most likely you'll want something like this:
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
RSpec.configure do |config|
|
||||||
|
# ...
|
||||||
|
Telegram.reset_bots
|
||||||
|
Telegram::Bot::ClientStub.stub_all!
|
||||||
|
config.after { Telegram.bot.reset }
|
||||||
|
# ...
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
There are also some helpers for controller tests.
|
||||||
|
Check out `telegram/bot/updates_controller/rspec_helpers` and
|
||||||
|
`telegram/bot/updates_controller/testing`.
|
||||||
|
|
||||||
### Deploying
|
### Deploying
|
||||||
|
|
||||||
Use `rake telegram:bot:set_webhook` to update webhook url for all configured bots.
|
Use `rake telegram:bot:set_webhook` to update webhook url for all configured bots.
|
||||||
Certificate can be specified with `CERT=path/to/cert`.
|
Certificate can be specified with `CERT=path/to/cert`.
|
||||||
|
|
||||||
|
### 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::UpdatesController::Botan`:
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||||
|
include Telegram::Bot::UpdatesController::Botan
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
After checking out the repo, run `bin/setup` to install dependencies.
|
After checking out the repo, run `bin/setup` to install dependencies.
|
||||||
@@ -179,6 +384,16 @@ To release a new version, update the version number in `version.rb`,
|
|||||||
and then run `bundle exec rake release`, which will create a git tag for the version,
|
and then run `bundle exec rake release`, which will create a git tag for the version,
|
||||||
push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
||||||
|
|
||||||
|
### Different Rails versions
|
||||||
|
|
||||||
|
To setup development for specific major Rails version use:
|
||||||
|
|
||||||
|
```
|
||||||
|
RAILS=5 bundle install
|
||||||
|
# or
|
||||||
|
RAILS=5 bundle update
|
||||||
|
```
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Bug reports and pull requests are welcome on GitHub at https://github.com/printercu/telegram-bot.
|
Bug reports and pull requests are welcome on GitHub at https://github.com/telegram-bot-rb/telegram-bot.
|
||||||
|
|||||||
@@ -1,9 +1,14 @@
|
|||||||
namespace :telegram do
|
namespace :telegram do
|
||||||
namespace :bot do
|
namespace :bot do
|
||||||
desc 'Run poller'
|
desc 'Run poller. It broadcasts Rails.logger to STDOUT in dev like `rails s` do. ' \
|
||||||
task poller: :environment do
|
'Use LOG_TO_STDOUT to enable/disable broadcasting.'
|
||||||
console = ActiveSupport::Logger.new(STDERR)
|
task :poller do
|
||||||
Rails.logger.extend ActiveSupport::Logger.broadcast console
|
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)
|
Telegram::Bot::UpdatesPoller.start(ENV['BOT'].try!(:to_sym) || :default)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -12,9 +17,10 @@ namespace :telegram do
|
|||||||
routes = Rails.application.routes.url_helpers
|
routes = Rails.application.routes.url_helpers
|
||||||
cert_file = ENV['CERT']
|
cert_file = ENV['CERT']
|
||||||
cert = File.open(cert_file) if cert_file
|
cert = File.open(cert_file) if cert_file
|
||||||
Telegram.bots.each_value do |bot|
|
Telegram.bots.each do |key, bot|
|
||||||
route_name = Telegram::RoutesHelper.route_name_for_bot(bot)
|
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
||||||
url = routes.send("#{route_name}_url")
|
url = routes.send("#{route_name}_url")
|
||||||
|
puts "Setting webhook for #{key}..."
|
||||||
bot.set_webhook(url: url, certificate: cert)
|
bot.set_webhook(url: url, certificate: cert)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,97 +1,37 @@
|
|||||||
require 'httpclient'
|
require 'telegram/bot/config_methods'
|
||||||
require 'json'
|
|
||||||
require 'active_support/core_ext/string/inflections'
|
|
||||||
require 'active_support/core_ext/hash/keys'
|
|
||||||
require 'active_support/core_ext/array/wrap'
|
|
||||||
require 'telegram/bottable'
|
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
extend Bottable
|
extend Bot::ConfigMethods
|
||||||
|
|
||||||
class Bot
|
module Bot
|
||||||
class Error < StandardError; end
|
class Error < StandardError; end
|
||||||
class NotFound < Error; end
|
class NotFound < Error; end
|
||||||
|
|
||||||
autoload :Middleware, 'telegram/bot/middleware'
|
# Error class for events when chat is not available anymore for bot.
|
||||||
autoload :UpdatesController, 'telegram/bot/updates_controller'
|
# While Telegram has same error codes for different messages and there is no
|
||||||
autoload :UpdatesPoller, 'telegram/bot/updates_poller'
|
# official docs for this error codes it uses `description` to
|
||||||
|
# check response.
|
||||||
|
class StaleChat < Error
|
||||||
|
DESCRIPTIONS = [
|
||||||
|
'bot was kicked',
|
||||||
|
"can't write to",
|
||||||
|
'group chat is deactivated',
|
||||||
|
].freeze
|
||||||
|
|
||||||
URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
|
class << self
|
||||||
|
def match_response?(response)
|
||||||
class << self
|
description = response['description'].to_s
|
||||||
# Accepts different options to initialize bot.
|
DESCRIPTIONS.any? { |x| description[x] }
|
||||||
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
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
attr_reader :client, :token, :username, :base_uri
|
autoload :Botan, 'telegram/bot/botan'
|
||||||
|
autoload :Client, 'telegram/bot/client'
|
||||||
def initialize(token, username = nil)
|
autoload :ClientStub, 'telegram/bot/client_stub'
|
||||||
@client = HTTPClient.new
|
autoload :Middleware, 'telegram/bot/middleware'
|
||||||
@token = token
|
autoload :UpdatesController, 'telegram/bot/updates_controller'
|
||||||
@username = username
|
autoload :UpdatesPoller, 'telegram/bot/updates_poller'
|
||||||
@base_uri = format URL_TEMPLATE, token
|
|
||||||
end
|
|
||||||
|
|
||||||
def debug!(dev = STDOUT)
|
|
||||||
client.debug_dev = dev
|
|
||||||
end
|
|
||||||
|
|
||||||
def debug_off!
|
|
||||||
client.debug_dev = nil
|
|
||||||
end
|
|
||||||
|
|
||||||
def request(action, data = {})
|
|
||||||
res = http_request("#{base_uri}#{action}", data)
|
|
||||||
status = res.status
|
|
||||||
return JSON.parse(res.body) if 300 > status
|
|
||||||
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
|
||||||
err_msg = "#{res.reason}: #{result && result['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) }
|
|
||||||
end
|
|
||||||
|
|
||||||
# Endpoint for low-level request. For easy host highjacking & instrumentation.
|
|
||||||
# Params are not used directly but kept for instrumentation purpose.
|
|
||||||
# You probably don't want to use this method directly.
|
|
||||||
def http_request(uri, body)
|
|
||||||
client.post(uri, body)
|
|
||||||
end
|
|
||||||
|
|
||||||
def inspect
|
|
||||||
"#<Telegram::Bot##{object_id}(#{@username})>"
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
36
lib/telegram/bot/botan.rb
Обычный файл
36
lib/telegram/bot/botan.rb
Обычный файл
@@ -0,0 +1,36 @@
|
|||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class Botan
|
||||||
|
TRACK_URI = 'https://api.botan.io/track'.freeze
|
||||||
|
|
||||||
|
class Error < Bot::Error; end
|
||||||
|
|
||||||
|
include DebugClient
|
||||||
|
|
||||||
|
attr_reader :client, :token
|
||||||
|
|
||||||
|
def initialize(token)
|
||||||
|
@client = HTTPClient.new
|
||||||
|
@token = token
|
||||||
|
end
|
||||||
|
|
||||||
|
def track(event, uid, payload = {})
|
||||||
|
res = http_request(
|
||||||
|
:post,
|
||||||
|
TRACK_URI,
|
||||||
|
{token: token, name: event, uid: uid},
|
||||||
|
payload.to_json,
|
||||||
|
)
|
||||||
|
status = res.status
|
||||||
|
return JSON.parse(res.body) if 300 > status
|
||||||
|
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
||||||
|
err_msg = "#{res.reason}: #{result && result['info'] || '-'}"
|
||||||
|
raise Error, err_msg
|
||||||
|
end
|
||||||
|
|
||||||
|
def http_request(method, uri, query, body)
|
||||||
|
client.request(method, uri, query, body)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
113
lib/telegram/bot/client.rb
Обычный файл
113
lib/telegram/bot/client.rb
Обычный файл
@@ -0,0 +1,113 @@
|
|||||||
|
require 'json'
|
||||||
|
require 'httpclient'
|
||||||
|
require 'active_support/core_ext/string/inflections'
|
||||||
|
require 'active_support/core_ext/hash/keys'
|
||||||
|
require 'telegram/bot/debug_client'
|
||||||
|
|
||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class Client
|
||||||
|
URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
|
||||||
|
|
||||||
|
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
||||||
|
include DebugClient
|
||||||
|
|
||||||
|
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'], botan: input['botan']
|
||||||
|
when Symbol
|
||||||
|
Telegram.bots[input] or
|
||||||
|
raise "Bot #{input} not configured, check Telegram.bots_config."
|
||||||
|
else
|
||||||
|
new(input)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Prepend TypedResponse module.
|
||||||
|
def typed_response!
|
||||||
|
prepend TypedResponse
|
||||||
|
end
|
||||||
|
|
||||||
|
# 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) || val.is_a?(Array)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
attr_reader :client, :token, :username, :base_uri, :botan
|
||||||
|
|
||||||
|
def initialize(token, username = nil, botan: nil)
|
||||||
|
@client = HTTPClient.new
|
||||||
|
@token = token
|
||||||
|
@username = username
|
||||||
|
@base_uri = format URL_TEMPLATE, token
|
||||||
|
@botan = Botan.new(botan) if botan
|
||||||
|
end
|
||||||
|
|
||||||
|
def request(action, body = {}) # rubocop:disable PerceivedComplexity
|
||||||
|
res = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
|
||||||
|
status = res.status
|
||||||
|
return JSON.parse(res.body) if 300 > status
|
||||||
|
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
||||||
|
err_msg = "#{res.reason}: #{result && result['description'] || '-'}"
|
||||||
|
if result
|
||||||
|
# NotFound is raised only for valid responses from Telegram
|
||||||
|
raise NotFound, err_msg if 404 == status
|
||||||
|
raise StaleChat, err_msg if StaleChat.match_response?(result)
|
||||||
|
end
|
||||||
|
raise Error, err_msg
|
||||||
|
end
|
||||||
|
|
||||||
|
%w(
|
||||||
|
answerCallbackQuery
|
||||||
|
answerInlineQuery
|
||||||
|
forwardMessage
|
||||||
|
getChat
|
||||||
|
getChatAdministrators
|
||||||
|
getChatMember
|
||||||
|
getChatMembersCount
|
||||||
|
getFile
|
||||||
|
getMe
|
||||||
|
getUpdates
|
||||||
|
getUserProfilePhotos
|
||||||
|
kickChatMember
|
||||||
|
leaveChat
|
||||||
|
sendAudio
|
||||||
|
sendChatAction
|
||||||
|
sendContact
|
||||||
|
sendDocument
|
||||||
|
sendLocation
|
||||||
|
sendMessage
|
||||||
|
sendPhoto
|
||||||
|
sendSticker
|
||||||
|
sendVenue
|
||||||
|
sendVideo
|
||||||
|
sendVoice
|
||||||
|
setWebhook
|
||||||
|
unbanChatMember
|
||||||
|
).each do |method|
|
||||||
|
define_method(method.underscore) { |*args| request(method, *args) }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Endpoint for low-level request. For easy host highjacking & instrumentation.
|
||||||
|
# Params are not used directly but kept for instrumentation purpose.
|
||||||
|
# You probably don't want to use this method directly.
|
||||||
|
def http_request(uri, body)
|
||||||
|
client.post(uri, body)
|
||||||
|
end
|
||||||
|
|
||||||
|
def inspect
|
||||||
|
"#<#{self.class.name}##{object_id}(#{@username})>"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
38
lib/telegram/bot/client/typed_response.rb
Обычный файл
38
lib/telegram/bot/client/typed_response.rb
Обычный файл
@@ -0,0 +1,38 @@
|
|||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class Client
|
||||||
|
# Actions with type-casted results. Install `telegram-bot-types` gem first.
|
||||||
|
module TypedResponse
|
||||||
|
{
|
||||||
|
getFile: :File,
|
||||||
|
getMe: :User,
|
||||||
|
getUpdates: [:Update],
|
||||||
|
getUserProfilePhotos: :UserProfilePhotos,
|
||||||
|
|
||||||
|
forwardMessage: :Message,
|
||||||
|
sendAudio: :Message,
|
||||||
|
sendDocument: :Message,
|
||||||
|
sendLocation: :Message,
|
||||||
|
sendMessage: :Message,
|
||||||
|
sendPhoto: :Message,
|
||||||
|
sendSticker: :Message,
|
||||||
|
sendVideo: :Message,
|
||||||
|
sendVoice: :Message,
|
||||||
|
}.each do |method, type|
|
||||||
|
next unless type
|
||||||
|
if type.is_a?(Array)
|
||||||
|
type_class = Types.const_get(type.first)
|
||||||
|
define_method(method.to_s.underscore) do |*args|
|
||||||
|
request(method, *args)['result'].map { |x| type_class.new(x) }
|
||||||
|
end
|
||||||
|
else
|
||||||
|
type_class = Types.const_get(type)
|
||||||
|
define_method(method.to_s.underscore) do |*args|
|
||||||
|
type_class.new request(method, *args)['result']
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
51
lib/telegram/bot/client_stub.rb
Обычный файл
51
lib/telegram/bot/client_stub.rb
Обычный файл
@@ -0,0 +1,51 @@
|
|||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
# Stubbed client for tests. Saves all requests into #requests hash.
|
||||||
|
class ClientStub < Client
|
||||||
|
attr_reader :requests
|
||||||
|
|
||||||
|
module StubbedConstructor
|
||||||
|
def new(*args)
|
||||||
|
if self == ClientStub || !ClientStub.stub_all?
|
||||||
|
super
|
||||||
|
else
|
||||||
|
ClientStub.new(args[1])
|
||||||
|
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(username = nil)
|
||||||
|
@username = username
|
||||||
|
reset
|
||||||
|
end
|
||||||
|
|
||||||
|
def reset
|
||||||
|
@requests = Hash.new { |h, k| h[k] = [] }
|
||||||
|
end
|
||||||
|
|
||||||
|
def request(action, body)
|
||||||
|
requests[action.to_sym] << body
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
58
lib/telegram/bot/config_methods.rb
Обычный файл
58
lib/telegram/bot/config_methods.rb
Обычный файл
@@ -0,0 +1,58 @@
|
|||||||
|
require 'active_support/core_ext/hash/keys'
|
||||||
|
require 'active_support/core_ext/hash/transform_values'
|
||||||
|
|
||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
module ConfigMethods
|
||||||
|
# Overwrite config.
|
||||||
|
attr_writer :bots_config
|
||||||
|
|
||||||
|
# Keep this setting here, so we can avoid loading Bot::UpdatesPoller
|
||||||
|
# when polling is disabled.
|
||||||
|
attr_writer :bot_poller_mode
|
||||||
|
|
||||||
|
# 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)
|
||||||
|
@bot_poller_mode = ENV.fetch('BOT_POLLER_MODE') do
|
||||||
|
Rails.env.development? if defined?(Rails)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Hash of bots made with bots_config.
|
||||||
|
def bots
|
||||||
|
@bots ||= bots_config.transform_values(&Client.method(:wrap))
|
||||||
|
end
|
||||||
|
|
||||||
|
# Default bot.
|
||||||
|
def bot
|
||||||
|
@bot ||= bots[:default]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Returns config for .bots method. By default uses `telegram['bots']` section
|
||||||
|
# from `secrets.yml` merging `telegram['bot']` at `:default` key.
|
||||||
|
#
|
||||||
|
# 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
|
||||||
|
end
|
||||||
|
|
||||||
|
# Resets all cached bots and their configs.
|
||||||
|
def reset_bots
|
||||||
|
@bots = nil
|
||||||
|
@bot = nil
|
||||||
|
@bots_config = nil
|
||||||
|
end
|
||||||
|
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
|
||||||
@@ -1,9 +1,11 @@
|
|||||||
require 'active_support/concern'
|
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/http/mime_type'
|
||||||
require 'action_dispatch/middleware/params_parser'
|
require 'action_dispatch/http/request'
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
class Middleware
|
class Middleware
|
||||||
attr_reader :bot, :controller
|
attr_reader :bot, :controller
|
||||||
|
|
||||||
@@ -13,9 +15,10 @@ module Telegram
|
|||||||
end
|
end
|
||||||
|
|
||||||
def call(env)
|
def call(env)
|
||||||
update = env['action_dispatch.request.request_parameters']
|
request = ActionDispatch::Request.new(env)
|
||||||
|
update = request.request_parameters
|
||||||
controller.dispatch(bot, update)
|
controller.dispatch(bot, update)
|
||||||
[200, {}, '']
|
[200, {}, ['']]
|
||||||
end
|
end
|
||||||
|
|
||||||
def inspect
|
def inspect
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
require 'telegram/bot/routes_helper'
|
require 'telegram/bot/routes_helper'
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
class Railtie < Rails::Railtie
|
class Railtie < Rails::Railtie
|
||||||
config.telegram_updates_controller = ActiveSupport::OrderedOptions.new
|
config.telegram_updates_controller = ActiveSupport::OrderedOptions.new
|
||||||
|
|
||||||
@@ -18,13 +18,15 @@ module Telegram
|
|||||||
|
|
||||||
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
||||||
self.logger = options.logger || Rails.logger
|
self.logger = options.logger || Rails.logger
|
||||||
|
self.session_store = options.session_store || Rails.cache
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
initializer 'telegram.bot.updates_controller.add_ar_runtime' do
|
initializer 'telegram.bot.updates_controller.add_ar_runtime' do
|
||||||
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
||||||
if defined?(ActiveRecord::Railties::ControllerRuntime)
|
if defined?(ActiveRecord::Railties::ControllerRuntime)
|
||||||
include ActiveRecord::Railties::ControllerRuntime
|
prepend ActiveRecord::Railties::ControllerRuntime
|
||||||
|
extend ActiveRecord::Railties::ControllerRuntime::ClassMethods
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
require 'telegram/bot'
|
require 'telegram/bot'
|
||||||
|
require 'active_support/core_ext/array/wrap'
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
module RoutesHelper
|
module RoutesHelper
|
||||||
class << self
|
class << self
|
||||||
# Returns route name for given bot. Result depends on `Telegram.bots`.
|
# Returns route name for given bot. Result depends on `Telegram.bots`.
|
||||||
@@ -15,6 +16,12 @@ module Telegram
|
|||||||
name && "#{name}_telegram_webhook"
|
name && "#{name}_telegram_webhook"
|
||||||
end || 'telegram_webhook'
|
end || 'telegram_webhook'
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Replaces colon with underscore so rails don't treat it as
|
||||||
|
# route parameter.
|
||||||
|
def escape_token(token)
|
||||||
|
token.tr(':', '_')
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# # Create routes for all Telegram.bots to use same controller:
|
# # Create routes for all Telegram.bots to use same controller:
|
||||||
@@ -35,21 +42,23 @@ module Telegram
|
|||||||
# # You can override this options or specify others:
|
# # You can override this options or specify others:
|
||||||
# telegram_webhooks TelegramController, as: :my_webhook
|
# telegram_webhooks TelegramController, as: :my_webhook
|
||||||
# telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
# telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
||||||
# other_bot => [TelegramAuctionController,
|
# other_bot => TelegramAuctionController,
|
||||||
|
# admin_chat: TelegramAdminChatController
|
||||||
|
#
|
||||||
def telegram_webhooks(controllers, bots = nil, **options)
|
def telegram_webhooks(controllers, bots = nil, **options)
|
||||||
unless controllers.is_a?(Hash)
|
unless controllers.is_a?(Hash)
|
||||||
bots = bots ? Array.wrap(bots) : Telegram.bots.values
|
bots = bots ? Array.wrap(bots) : Telegram.bots.values
|
||||||
controllers = Hash[bots.map { |x| [x, controllers] }]
|
controllers = Hash[bots.map { |x| [x, controllers] }]
|
||||||
end
|
end
|
||||||
controllers.each do |bot, controller|
|
controllers.each do |bot, controller|
|
||||||
bot = Bot.wrap(bot)
|
bot = Client.wrap(bot)
|
||||||
controller, bot_options = controller if controller.is_a?(Array)
|
controller, bot_options = controller if controller.is_a?(Array)
|
||||||
params = {
|
params = {
|
||||||
to: Middleware.new(bot, controller),
|
to: Middleware.new(bot, controller),
|
||||||
as: RoutesHelper.route_name_for_bot(bot),
|
as: RoutesHelper.route_name_for_bot(bot),
|
||||||
format: false,
|
format: false,
|
||||||
}.merge!(options).merge!(bot_options || {})
|
}.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?
|
UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,26 +1,96 @@
|
|||||||
require 'abstract_controller'
|
require 'abstract_controller'
|
||||||
require 'active_support/callbacks'
|
require 'active_support/callbacks'
|
||||||
|
require 'active_support/version'
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
class UpdatesController < AbstractController::Base
|
# Base class to create update processors. With callbacks, session and helpers.
|
||||||
include AbstractController::Callbacks
|
#
|
||||||
include AbstractController::Translation
|
# 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/log_subscriber'
|
||||||
require 'telegram/bot/updates_controller/instrumentation'
|
require 'telegram/bot/updates_controller/instrumentation'
|
||||||
|
require 'telegram/bot/updates_controller/reply_helpers'
|
||||||
|
autoload :CallbackQueyContext, 'telegram/bot/updates_controller/callback_query_context'
|
||||||
|
autoload :MessageContext, 'telegram/bot/updates_controller/message_context'
|
||||||
|
autoload :Botan, 'telegram/bot/updates_controller/botan'
|
||||||
|
|
||||||
|
include AbstractController::Callbacks
|
||||||
|
# Redefine callbacks with default terminator.
|
||||||
|
if ActiveSupport::VERSION::MAJOR >= 5
|
||||||
|
define_callbacks :process_action,
|
||||||
|
skip_after_callbacks_if_terminated: true
|
||||||
|
else
|
||||||
|
define_callbacks :process_action,
|
||||||
|
terminator: ->(_, result) { result == false },
|
||||||
|
skip_after_callbacks_if_terminated: true
|
||||||
|
end
|
||||||
|
|
||||||
|
include AbstractController::Translation
|
||||||
|
include ReplyHelpers
|
||||||
prepend Instrumentation
|
prepend Instrumentation
|
||||||
|
extend Session::ConfigMethods
|
||||||
|
|
||||||
|
autoload :TypedUpdate, 'telegram/bot/updates_controller/typed_update'
|
||||||
|
|
||||||
PAYLOAD_TYPES = %w(
|
PAYLOAD_TYPES = %w(
|
||||||
message
|
message
|
||||||
inline_query
|
inline_query
|
||||||
chosen_inline_result
|
chosen_inline_result
|
||||||
|
callback_query
|
||||||
|
edited_message
|
||||||
).freeze
|
).freeze
|
||||||
CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
|
CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
|
||||||
CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
|
CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
|
||||||
abstract!
|
|
||||||
|
|
||||||
class << self
|
class << self
|
||||||
|
# Initialize controller and process update.
|
||||||
def dispatch(*args)
|
def dispatch(*args)
|
||||||
new(*args).dispatch
|
new(*args).dispatch
|
||||||
end
|
end
|
||||||
@@ -43,7 +113,7 @@ module Telegram
|
|||||||
match = text.match CMD_REGEX
|
match = text.match CMD_REGEX
|
||||||
return unless match
|
return unless match
|
||||||
return if match[3] && username != true && match[3] != username
|
return if match[3] && username != true && match[3] != username
|
||||||
[match[1], text.split(' ').drop(1)]
|
[match[1], text.split.drop(1)]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -51,34 +121,81 @@ module Telegram
|
|||||||
alias_method :command?, :is_command
|
alias_method :command?, :is_command
|
||||||
delegate :username, to: :bot, prefix: true, allow_nil: true
|
delegate :username, to: :bot, prefix: true, allow_nil: true
|
||||||
|
|
||||||
|
# Second argument can be either update object with hash access & string
|
||||||
|
# keys or Hash with `:from` or `:chat` to override this values and assume
|
||||||
|
# that update is nil.
|
||||||
def initialize(bot = nil, update = 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
|
@_update = update
|
||||||
@_bot = bot
|
@_bot = bot
|
||||||
|
@_chat, @_from = options && options.values_at(:chat, :from)
|
||||||
|
|
||||||
|
payload_data = nil
|
||||||
update && PAYLOAD_TYPES.find do |type|
|
update && PAYLOAD_TYPES.find do |type|
|
||||||
item = update[type]
|
item = update[type]
|
||||||
next unless item
|
payload_data = [item, type] if item
|
||||||
@_payload = item
|
|
||||||
@_payload_type = type
|
|
||||||
end
|
end
|
||||||
|
@_payload, @_payload_type = payload_data
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Accessor to `'chat'` field of payload. Can be overriden with `chat` option
|
||||||
|
# for #initialize.
|
||||||
|
def chat
|
||||||
|
@_chat ||= payload && payload['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
|
def dispatch
|
||||||
@_is_command, action, args = action_for_payload
|
@_is_command, action, args = action_for_payload
|
||||||
process(action, *args)
|
process(action, *args)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Calculates action name and args for payload.
|
# Calculates action name and args for payload.
|
||||||
# If payload is a message with command, then returned action is an
|
# Uses `action_for_#{payload_type}` methods.
|
||||||
# action for this command. Otherwise it's the same as payload type.
|
# If this method doesn't return anything
|
||||||
|
# it uses fallback with action same as payload type.
|
||||||
# Returns array `[is_command?, action, args]`.
|
# Returns array `[is_command?, action, args]`.
|
||||||
def action_for_payload
|
def action_for_payload
|
||||||
case payload_type
|
if payload_type
|
||||||
when 'message'
|
send("action_for_#{payload_type}") || [false, payload_type, [payload]]
|
||||||
cmd, args = self.class.command_from_text(payload['text'], bot_username)
|
else
|
||||||
cmd &&= self.class.action_for_command(cmd)
|
[false, :unsupported_payload_type, []]
|
||||||
[true, cmd, args] if cmd
|
end
|
||||||
end || [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).
|
||||||
|
def action_for_message
|
||||||
|
cmd, args = self.class.command_from_text(payload['text'], bot_username)
|
||||||
|
cmd &&= self.class.action_for_command(cmd)
|
||||||
|
[true, cmd, args] if cmd
|
||||||
|
end
|
||||||
|
|
||||||
|
# It doesn't extract commands from edited messages. Just process
|
||||||
|
# them as usual ones.
|
||||||
|
def action_for_edited_message
|
||||||
|
end
|
||||||
|
|
||||||
|
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
|
end
|
||||||
|
|
||||||
# Silently ignore unsupported messages.
|
# Silently ignore unsupported messages.
|
||||||
@@ -86,19 +203,6 @@ module Telegram
|
|||||||
def action_missing(*)
|
def action_missing(*)
|
||||||
end
|
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)
|
|
||||||
end
|
|
||||||
|
|
||||||
ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
|
ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
33
lib/telegram/bot/updates_controller/botan.rb
Обычный файл
33
lib/telegram/bot/updates_controller/botan.rb
Обычный файл
@@ -0,0 +1,33 @@
|
|||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class UpdatesController
|
||||||
|
# Helpers for botan.io metrics.
|
||||||
|
module Botan
|
||||||
|
class MissingFrom < Error; end
|
||||||
|
|
||||||
|
protected
|
||||||
|
|
||||||
|
def botan
|
||||||
|
@botan ||= bot.try!(:botan)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Track custom event for user taken from `from` field:
|
||||||
|
#
|
||||||
|
# botan_track :my_event, {data: :val}
|
||||||
|
#
|
||||||
|
def botan_track(event, data = {})
|
||||||
|
raise MissingFrom, 'Can not track without user' unless from
|
||||||
|
botan.try! { |x| x.track(event, from['id'], data) }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Track current action and payload for current user. Best used with `before_action`:
|
||||||
|
#
|
||||||
|
# before_action :botan_track_action
|
||||||
|
#
|
||||||
|
def botan_track_action
|
||||||
|
botan_track(action_name, payload)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
34
lib/telegram/bot/updates_controller/callback_query_context.rb
Обычный файл
34
lib/telegram/bot/updates_controller/callback_query_context.rb
Обычный файл
@@ -0,0 +1,34 @@
|
|||||||
|
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 CallbackQueyContext
|
||||||
|
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
|
||||||
|
# binding.pry
|
||||||
|
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
|
||||||
@@ -1,12 +1,12 @@
|
|||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
class UpdatesController
|
class UpdatesController
|
||||||
# Most methods are taken from ActionController::Instrumentation,
|
# Most methods are taken from ActionController::Instrumentation,
|
||||||
# some are slightly modified.
|
# some are slightly modified.
|
||||||
module Instrumentation
|
module Instrumentation
|
||||||
class << self
|
class << self
|
||||||
def prepended(base)
|
def prepended(base)
|
||||||
base.config_accessor :logger
|
base.send :config_accessor, :logger
|
||||||
base.extend ClassMethods
|
base.extend ClassMethods
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -35,8 +35,14 @@ module Telegram
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def reply_with(type, *)
|
def respond_with(type, *)
|
||||||
Instrumentation.instrument(:reply_with, type: type) { super }
|
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
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
require 'active_support/log_subscriber'
|
require 'active_support/log_subscriber'
|
||||||
|
|
||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
class UpdatesController
|
class UpdatesController
|
||||||
class LogSubscriber < ActiveSupport::LogSubscriber
|
class LogSubscriber < ActiveSupport::LogSubscriber
|
||||||
def start_processing(event)
|
def start_processing(event)
|
||||||
@@ -22,8 +22,8 @@ module Telegram
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def reply_with(event)
|
def respond_with(event)
|
||||||
info { "Replied with #{event.payload[:type]}" }
|
info { "Responded with #{event.payload[:type]}" }
|
||||||
end
|
end
|
||||||
|
|
||||||
def halted_callback(event)
|
def halted_callback(event)
|
||||||
|
|||||||
94
lib/telegram/bot/updates_controller/message_context.rb
Обычный файл
94
lib/telegram/bot/updates_controller/message_context.rb
Обычный файл
@@ -0,0 +1,94 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
included do
|
||||||
|
# As we use before_action context is cleared anyway,
|
||||||
|
# no matter we used it or not.
|
||||||
|
singleton_class.send :attr_reader, :context_handlers, :context_to_action
|
||||||
|
@context_handlers = {}
|
||||||
|
end
|
||||||
|
|
||||||
|
module ClassMethods
|
||||||
|
# Registers handler for context.
|
||||||
|
#
|
||||||
|
# context_handler :rename do |*|
|
||||||
|
# resource.update!(name: payload['text'])
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# # To run other action with all the callbacks:
|
||||||
|
# context_handler :rename do |*words|
|
||||||
|
# process(:rename, *words)
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# # Or just
|
||||||
|
# context_handler :rename, :your_action_to_call
|
||||||
|
# context_handler :rename # to call :rename
|
||||||
|
#
|
||||||
|
def context_handler(context = nil, action = nil, &block)
|
||||||
|
context &&= context.to_sym
|
||||||
|
if block
|
||||||
|
action = "_context_handler_#{context}"
|
||||||
|
define_method(action, &block)
|
||||||
|
end
|
||||||
|
context_handlers[context] = action || context
|
||||||
|
end
|
||||||
|
|
||||||
|
# Use it to use context value as action name for all contexts
|
||||||
|
# which miss handlers.
|
||||||
|
# For security reasons it supports only action methods and will
|
||||||
|
# raise AbstractController::ActionNotFound if context is invalid.
|
||||||
|
def context_to_action!
|
||||||
|
@context_to_action = true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Action to clear context.
|
||||||
|
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
|
||||||
|
|
||||||
|
# Fetches context and finds handler for it. If message has new command,
|
||||||
|
# it has higher priority than contextual action.
|
||||||
|
def action_for_message
|
||||||
|
val = 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)
|
||||||
|
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
|
||||||
44
lib/telegram/bot/updates_controller/reply_helpers.rb
Обычный файл
44
lib/telegram/bot/updates_controller/reply_helpers.rb
Обычный файл
@@ -0,0 +1,44 @@
|
|||||||
|
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
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
37
lib/telegram/bot/updates_controller/rspec_helpers.rb
Обычный файл
37
lib/telegram/bot/updates_controller/rspec_helpers.rb
Обычный файл
@@ -0,0 +1,37 @@
|
|||||||
|
require 'telegram/bot/updates_controller/testing'
|
||||||
|
|
||||||
|
RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||||
|
let(:controller_class) { described_class }
|
||||||
|
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) { controller.send(:session) }
|
||||||
|
|
||||||
|
def dispatch(bot = self.bot, update = self.update)
|
||||||
|
controller.dispatch_again(bot, update)
|
||||||
|
end
|
||||||
|
|
||||||
|
def dispatch_message(text, options = {})
|
||||||
|
update = build_update :message, options.merge(text: text)
|
||||||
|
dispatch bot, update
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_update(type, content)
|
||||||
|
deep_stringify type => content
|
||||||
|
end
|
||||||
|
|
||||||
|
def deep_stringify(input)
|
||||||
|
case input
|
||||||
|
when Array then input.map(&method(__callee__))
|
||||||
|
when Hash then input.transform_keys(&:to_s).transform_values(&method(__callee__))
|
||||||
|
else input
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
92
lib/telegram/bot/updates_controller/session.rb
Обычный файл
92
lib/telegram/bot/updates_controller/session.rb
Обычный файл
@@ -0,0 +1,92 @@
|
|||||||
|
require 'rack/session/abstract/id'
|
||||||
|
require 'active_support/cache'
|
||||||
|
|
||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class UpdatesController
|
||||||
|
# Add functionality to store data between requests.
|
||||||
|
module Session
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
|
def process_action(*)
|
||||||
|
super
|
||||||
|
ensure
|
||||||
|
session.commit
|
||||||
|
end
|
||||||
|
|
||||||
|
protected
|
||||||
|
|
||||||
|
def session
|
||||||
|
@_session ||= begin
|
||||||
|
key = session_key
|
||||||
|
key ? SessionHash.new(self.class.session_store, key) : NullSessionHash.new
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def session_key
|
||||||
|
subject = from || chat
|
||||||
|
"#{bot.username}:#{subject['id']}" if subject
|
||||||
|
end
|
||||||
|
|
||||||
|
# Rack::Session::Abstract::SessionHash is taken to provide lazy loading.
|
||||||
|
# All methods that access store are overriden to support
|
||||||
|
# ActiveSupport::Cache::Store stores.
|
||||||
|
class SessionHash < Rack::Session::Abstract::SessionHash
|
||||||
|
attr_reader :id
|
||||||
|
|
||||||
|
def initialize(store, id)
|
||||||
|
@store = store
|
||||||
|
@id = id
|
||||||
|
end
|
||||||
|
|
||||||
|
def destroy
|
||||||
|
clear
|
||||||
|
@store.delete(id)
|
||||||
|
end
|
||||||
|
|
||||||
|
def exists?
|
||||||
|
return @exists if defined?(@exists)
|
||||||
|
@data = {}
|
||||||
|
@exists = @store.exist? id
|
||||||
|
end
|
||||||
|
|
||||||
|
def load!
|
||||||
|
session = @store.read(id)
|
||||||
|
@data = session ? stringify_keys(session) : {}
|
||||||
|
@loaded = true
|
||||||
|
end
|
||||||
|
|
||||||
|
def commit
|
||||||
|
return unless loaded?
|
||||||
|
data = to_hash.delete_if { |_, v| v.nil? }
|
||||||
|
@store.write(id, data)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class NullSessionHash < Session::SessionHash
|
||||||
|
def initialize
|
||||||
|
@data = {}
|
||||||
|
@loaded = true
|
||||||
|
@exists = true
|
||||||
|
end
|
||||||
|
|
||||||
|
alias_method :destroy, :clear
|
||||||
|
alias_method :load!, :id
|
||||||
|
alias_method :commit, :id
|
||||||
|
end
|
||||||
|
|
||||||
|
module ConfigMethods
|
||||||
|
delegate :session_store, to: :config
|
||||||
|
|
||||||
|
def session_store=(store)
|
||||||
|
config.session_store = ActiveSupport::Cache.lookup_store(store)
|
||||||
|
end
|
||||||
|
|
||||||
|
def use_session!
|
||||||
|
include Session
|
||||||
|
end
|
||||||
|
end
|
||||||
|
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
|
||||||
14
lib/telegram/bot/updates_controller/typed_update.rb
Обычный файл
14
lib/telegram/bot/updates_controller/typed_update.rb
Обычный файл
@@ -0,0 +1,14 @@
|
|||||||
|
module Telegram
|
||||||
|
module Bot
|
||||||
|
class UpdatesController
|
||||||
|
# Include this module to type cast update to Virtus model
|
||||||
|
# using `telegram-bot-types` gem (install this gem first).
|
||||||
|
module TypedUpdate
|
||||||
|
def initialize(bot = nil, update = nil)
|
||||||
|
update = Types::Update.new(update) if update && !update.is_a?(Types::Update)
|
||||||
|
super
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
# Supposed to be used in development environments only.
|
# Supposed to be used in development environments only.
|
||||||
class UpdatesPoller
|
class UpdatesPoller
|
||||||
class << self
|
class << self
|
||||||
@@ -15,7 +15,7 @@ module Telegram
|
|||||||
end
|
end
|
||||||
|
|
||||||
def start(bot_id, controller = nil)
|
def start(bot_id, controller = nil)
|
||||||
bot = bot_id.is_a?(Symbol) ? Telegram.bots[bot_id] : Bot.wrap(bot_id)
|
bot = bot_id.is_a?(Symbol) ? Telegram.bots[bot_id] : Client.wrap(bot_id)
|
||||||
instance = controller ? new(bot, controller) : instances[bot]
|
instance = controller ? new(bot, controller) : instances[bot]
|
||||||
raise "Poller not found for #{bot_id.inspect}" unless instance
|
raise "Poller not found for #{bot_id.inspect}" unless instance
|
||||||
instance.start
|
instance.start
|
||||||
@@ -77,11 +77,25 @@ module Telegram
|
|||||||
|
|
||||||
def reload!
|
def reload!
|
||||||
return yield unless reload
|
return yield unless reload
|
||||||
ActionDispatch::Reloader.prepare!
|
reloading_code do
|
||||||
if controller.is_a?(Class) && controller.name
|
if controller.is_a?(Class) && controller.name
|
||||||
@controller = Object.const_get(controller.name)
|
@controller = Object.const_get(controller.name)
|
||||||
|
end
|
||||||
|
yield
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
if defined?(Rails) && Rails.application.respond_to?(:reloader)
|
||||||
|
def reloading_code
|
||||||
|
Rails.application.reloader.wrap do
|
||||||
|
yield
|
||||||
|
end
|
||||||
|
end
|
||||||
|
else
|
||||||
|
def reloading_code
|
||||||
|
ActionDispatch::Reloader.prepare!
|
||||||
|
yield.tap { ActionDispatch::Reloader.cleanup! }
|
||||||
end
|
end
|
||||||
yield.tap { ActionDispatch::Reloader.cleanup! }
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
module Telegram
|
module Telegram
|
||||||
class Bot
|
module Bot
|
||||||
VERSION = '0.3.0'.freeze
|
VERSION = '0.8.0'.freeze
|
||||||
|
|
||||||
def self.gem_version
|
def self.gem_version
|
||||||
Gem::Version.new VERSION
|
Gem::Version.new VERSION
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
module Telegram
|
|
||||||
module Bottable
|
|
||||||
# Overwrite config.
|
|
||||||
attr_writer :bots_config
|
|
||||||
|
|
||||||
# Keep this setting here, so we can avoid loading Bot::UpdatesPoller
|
|
||||||
# when polling is disabled.
|
|
||||||
attr_writer :bot_poller_mode
|
|
||||||
|
|
||||||
# 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.
|
|
||||||
def bot_poller_mode?
|
|
||||||
return @bot_poller_mode if defined?(@bot_poller_mode)
|
|
||||||
Rails.env.development? if defined?(Rails)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Hash of bots made with bots_config.
|
|
||||||
def bots
|
|
||||||
@bots ||= bots_config.transform_values(&Bot.method(:wrap))
|
|
||||||
end
|
|
||||||
|
|
||||||
# Default bot.
|
|
||||||
def bot
|
|
||||||
@bot ||= bots[:default]
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns config for .bots method. By default uses `telegram['bots']` section
|
|
||||||
# from `secrets.yml` merging `telegram['bot']` at `:default` key.
|
|
||||||
#
|
|
||||||
# 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
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -14,6 +14,8 @@ GEM_ROOT = Pathname.new File.expand_path('../..', __FILE__)
|
|||||||
|
|
||||||
$LOAD_PATH.unshift GEM_ROOT.join('lib')
|
$LOAD_PATH.unshift GEM_ROOT.join('lib')
|
||||||
require 'telegram/bot'
|
require 'telegram/bot'
|
||||||
|
require 'telegram/bot/updates_controller/rspec_helpers'
|
||||||
|
require 'telegram/bot/types'
|
||||||
|
|
||||||
RSpec.configure do |config|
|
RSpec.configure do |config|
|
||||||
config.expect_with :rspec do |expectations|
|
config.expect_with :rspec do |expectations|
|
||||||
|
|||||||
32
spec/telegram/bot/client/typed_response_spec.rb
Обычный файл
32
spec/telegram/bot/client/typed_response_spec.rb
Обычный файл
@@ -0,0 +1,32 @@
|
|||||||
|
RSpec.describe Telegram::Bot::Client::TypedResponse do
|
||||||
|
let(:bot) { Telegram::Bot::Client.new('token').tap { |x| x.extend described_class } }
|
||||||
|
|
||||||
|
describe '#get_me' do
|
||||||
|
subject { bot.get_me }
|
||||||
|
before { expect(bot).to receive(:request).with(:getMe) { response } }
|
||||||
|
let(:response) { {'ok' => true, 'result' => {'id' => user_id}} }
|
||||||
|
let(:user_id) { 123 }
|
||||||
|
it { should be_instance_of Telegram::Bot::Types::User }
|
||||||
|
its(:id) { should eq user_id }
|
||||||
|
|
||||||
|
context 'on error' do
|
||||||
|
let(:response) { raise Telegram::Bot::Error }
|
||||||
|
it { expect { subject }.to raise_error Telegram::Bot::Error }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#get_updates' do
|
||||||
|
subject { bot.get_updates }
|
||||||
|
before { expect(bot).to receive(:request).with(:getUpdates) { response } }
|
||||||
|
let(:response) { {'ok' => true, 'result' => [{'update_id' => update_id}]} }
|
||||||
|
let(:update_id) { 123 }
|
||||||
|
it { should be_instance_of Array }
|
||||||
|
its(:first) { should be_instance_of Telegram::Bot::Types::Update }
|
||||||
|
its('first.update_id') { should eq update_id }
|
||||||
|
|
||||||
|
context 'on error' do
|
||||||
|
let(:response) { raise Telegram::Bot::Error }
|
||||||
|
it { expect { subject }.to raise_error Telegram::Bot::Error }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
101
spec/telegram/bot/client_spec.rb
Обычный файл
101
spec/telegram/bot/client_spec.rb
Обычный файл
@@ -0,0 +1,101 @@
|
|||||||
|
RSpec.describe Telegram::Bot::Client do
|
||||||
|
let(:instance) { described_class.new 'token' }
|
||||||
|
let(:token) { 'token' }
|
||||||
|
let(:botan_token) { double(:botan_token) }
|
||||||
|
|
||||||
|
describe '.wrap' do
|
||||||
|
subject { described_class.wrap(input) }
|
||||||
|
let(:result) { double(:result) }
|
||||||
|
let(:username) { 'username' }
|
||||||
|
|
||||||
|
context 'when input is a string' do
|
||||||
|
let(:input) { token }
|
||||||
|
|
||||||
|
it 'treats string as token' do
|
||||||
|
expect(described_class).to receive(:new).with(token) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when input is a hash' do
|
||||||
|
let(:input) { {token: token, username: username, ignore: :ignore} }
|
||||||
|
|
||||||
|
it 'extracts token & username' do
|
||||||
|
expect(described_class).to receive(:new).
|
||||||
|
with(token, username, botan: nil) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when `botan` is given' do
|
||||||
|
let(:input) { super().merge(botan: botan_token) }
|
||||||
|
|
||||||
|
it 'passes it to initializer' do
|
||||||
|
expect(described_class).to receive(:new).
|
||||||
|
with(token, username, botan: botan_token) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when input is an instance of described_class' do
|
||||||
|
let!(:input) { instance }
|
||||||
|
|
||||||
|
it 'returns input' do
|
||||||
|
expect(described_class).to_not receive(:new)
|
||||||
|
should eq input
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when input is a Symbol' do
|
||||||
|
let(:input) { :bot_1 }
|
||||||
|
before { allow(Telegram).to receive(:bots) { {bot_1: instance} } }
|
||||||
|
it { should eq Telegram.bots[:bot_1] }
|
||||||
|
|
||||||
|
context 'and there is no such bot' do
|
||||||
|
let(:input) { :invalid }
|
||||||
|
it { expect { subject }.to raise_error(/not configured/) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when input is an array' do
|
||||||
|
let!(:input) { ['other_token', instance, token: token, username: username] }
|
||||||
|
let(:result_2) { double(:result_2) }
|
||||||
|
|
||||||
|
it 'calls wrap for every element' do
|
||||||
|
expect(described_class).to receive(:new).with('other_token') { result }
|
||||||
|
expect(described_class).to receive(:new).with(token, username, botan: nil) { result_2 }
|
||||||
|
should eq [result, instance, result_2]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '.prepare_body' do
|
||||||
|
subject { described_class.prepare_body(input) }
|
||||||
|
|
||||||
|
context 'when plain hash is given' do
|
||||||
|
let(:input) { {a: 1, b: '2', c: nil} }
|
||||||
|
it { should eq input }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when nested hash is given' do
|
||||||
|
let(:input) { {a: 1, b: '2', c: [1, 2], d: {a: 1}, e: {b: []}} }
|
||||||
|
|
||||||
|
it 'encodes nested hashes to json' do
|
||||||
|
expected = input.dup
|
||||||
|
%i(c d e).each { |x| expected[x] = expected[x].to_json }
|
||||||
|
should eq expected
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#botan' do
|
||||||
|
subject { instance.botan }
|
||||||
|
it { should eq nil }
|
||||||
|
|
||||||
|
context 'when botan token is set' do
|
||||||
|
let(:instance) { described_class.new token, botan: botan_token }
|
||||||
|
it { should be_instance_of Telegram::Bot::Botan }
|
||||||
|
its(:token) { should eq botan_token }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
38
spec/telegram/bot/client_stub_spec.rb
Обычный файл
38
spec/telegram/bot/client_stub_spec.rb
Обычный файл
@@ -0,0 +1,38 @@
|
|||||||
|
RSpec.describe Telegram::Bot::ClientStub do
|
||||||
|
describe '#stub_all!' do
|
||||||
|
let(:client) { Telegram::Bot::Client.new('token', 'bot_name') }
|
||||||
|
let(:clients) { Telegram::Bot::Client.wrap(['token', token: 'token2']) }
|
||||||
|
|
||||||
|
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 raturn 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
|
||||||
|
end
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
|
require 'rack/mock'
|
||||||
|
|
||||||
RSpec.describe Telegram::Bot::Middleware do
|
RSpec.describe Telegram::Bot::Middleware do
|
||||||
let(:instance) { described_class.new bot, controller }
|
let(:instance) { described_class.new bot, controller }
|
||||||
let(:bot) { double(:bot) }
|
let(:bot) { double(:bot) }
|
||||||
@@ -6,13 +8,28 @@ RSpec.describe Telegram::Bot::Middleware do
|
|||||||
describe '#call' do
|
describe '#call' do
|
||||||
subject { instance.call(env) }
|
subject { instance.call(env) }
|
||||||
let(:env) { {'action_dispatch.request.request_parameters' => json_body} }
|
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
|
it 'calls dispatch on controller' do
|
||||||
expect(controller).to receive(:dispatch).with(bot, json_body)
|
expect(controller).to receive(:dispatch).with(bot, update)
|
||||||
subject
|
subject
|
||||||
end
|
end
|
||||||
|
|
||||||
it { should eq [200, {}, ''] }
|
it { should eq [200, {}, ['']] }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,10 +1,14 @@
|
|||||||
require 'telegram/bot/routes_helper'
|
require 'telegram/bot/routes_helper'
|
||||||
|
|
||||||
RSpec.describe Telegram::Bot::RoutesHelper do
|
RSpec.describe Telegram::Bot::RoutesHelper do
|
||||||
let(:bot) { Telegram::Bot.new('bot_token') }
|
let(:bot) { create_bot('bot_token') }
|
||||||
let(:other_bot) { Telegram::Bot.new('other_token') }
|
let(:other_bot) { create_bot('other_token') }
|
||||||
let(:bots) { {default: bot, other: other_bot} }
|
let(:bots) { {default: bot, other: other_bot} }
|
||||||
|
|
||||||
|
def create_bot(*args)
|
||||||
|
Telegram::Bot::Client.new(*args)
|
||||||
|
end
|
||||||
|
|
||||||
describe '.route_name_for_bot' do
|
describe '.route_name_for_bot' do
|
||||||
subject { described_class.route_name_for_bot(input) }
|
subject { described_class.route_name_for_bot(input) }
|
||||||
before { expect(Telegram).to receive(:bots) { bots } }
|
before { expect(Telegram).to receive(:bots) { bots } }
|
||||||
@@ -74,6 +78,7 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
|||||||
{
|
{
|
||||||
bot => controller,
|
bot => controller,
|
||||||
'custom_token' => [other_controller, as: :custom_route, option: :other_val],
|
'custom_token' => [other_controller, as: :custom_route, option: :other_val],
|
||||||
|
other: controller,
|
||||||
},
|
},
|
||||||
option: :val,
|
option: :val,
|
||||||
]
|
]
|
||||||
@@ -82,11 +87,12 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
|||||||
it 'creates routes for every bot and its controller' do
|
it 'creates routes for every bot and its controller' do
|
||||||
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
||||||
[
|
[
|
||||||
Telegram::Bot.new('custom_token'),
|
create_bot('custom_token'),
|
||||||
other_controller,
|
other_controller,
|
||||||
:custom_route,
|
:custom_route,
|
||||||
option: :other_val,
|
option: :other_val,
|
||||||
]
|
],
|
||||||
|
[Telegram.bots[:other], controller, 'other_telegram_webhook', option: :val]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -101,12 +107,12 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
|||||||
|
|
||||||
it 'creates routes for every created bot and controller' do
|
it 'creates routes for every created bot and controller' do
|
||||||
assert_routes [
|
assert_routes [
|
||||||
Telegram::Bot.new('custom_token'),
|
create_bot('custom_token'),
|
||||||
controller,
|
controller,
|
||||||
'telegram_webhook',
|
'telegram_webhook',
|
||||||
option: :val,
|
option: :val,
|
||||||
], [
|
], [
|
||||||
Telegram::Bot.new(bot.token, 'new_name'),
|
create_bot(bot.token, 'new_name'),
|
||||||
controller,
|
controller,
|
||||||
'telegram_webhook',
|
'telegram_webhook',
|
||||||
option: :val,
|
option: :val,
|
||||||
|
|||||||
54
spec/telegram/bot/updates_controller/botan_spec.rb
Обычный файл
54
spec/telegram/bot/updates_controller/botan_spec.rb
Обычный файл
@@ -0,0 +1,54 @@
|
|||||||
|
RSpec.describe Telegram::Bot::UpdatesController::Botan do
|
||||||
|
include_context 'telegram/bot/updates_controller'
|
||||||
|
let(:controller_class) do
|
||||||
|
described_class = self.described_class
|
||||||
|
Class.new(Telegram::Bot::UpdatesController) do
|
||||||
|
include described_class
|
||||||
|
end
|
||||||
|
end
|
||||||
|
let(:botan) { double(:botan) }
|
||||||
|
let(:result) { double(:result) }
|
||||||
|
let(:payload) { {from: {id: user_id}} }
|
||||||
|
let(:payload_type) { :message }
|
||||||
|
let(:user_id) { double(:user_id) }
|
||||||
|
before { allow(bot).to receive(:botan) { botan } }
|
||||||
|
|
||||||
|
shared_examples 'basic tracking' do
|
||||||
|
context 'when botan is not configured' do
|
||||||
|
let(:botan) {}
|
||||||
|
it { should eq nil }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when `from` is empty' do
|
||||||
|
let(:payload) { {text: 'test'} }
|
||||||
|
it { expect { subject }.to raise_error described_class::MissingFrom }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#botan_track' do
|
||||||
|
subject { controller.send(:botan_track, event, data) }
|
||||||
|
let(:event) { double(:event) }
|
||||||
|
let(:data) { double(:data) }
|
||||||
|
|
||||||
|
it 'calls botan#track' do
|
||||||
|
expect(botan).to receive(:track).with(event, user_id, data) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
|
||||||
|
include_examples 'basic tracking'
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '#botan_track_action' do
|
||||||
|
subject { controller.send(:botan_track_action) }
|
||||||
|
let(:action_name) { double(:action_name) }
|
||||||
|
|
||||||
|
it 'calls botan#track with current action and payload' do
|
||||||
|
expect(controller).to receive(:action_name) { action_name }
|
||||||
|
expect(botan).to receive(:track).
|
||||||
|
with(action_name, user_id, deep_stringify(payload)) { result }
|
||||||
|
should eq result
|
||||||
|
end
|
||||||
|
|
||||||
|
include_examples 'basic tracking'
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
RSpec.describe Telegram::Bot::UpdatesController::CallbackQueyContext 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, *%w(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
|
||||||
51
spec/telegram/bot/updates_controller/reply_helpers_spec.rb
Обычный файл
51
spec/telegram/bot/updates_controller/reply_helpers_spec.rb
Обычный файл
@@ -0,0 +1,51 @@
|
|||||||
|
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
|
||||||
|
end
|
||||||
57
spec/telegram/bot/updates_controller/session_spec.rb
Обычный файл
57
spec/telegram/bot/updates_controller/session_spec.rb
Обычный файл
@@ -0,0 +1,57 @@
|
|||||||
|
RSpec.describe Telegram::Bot::UpdatesController::Session 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
|
||||||
|
|
||||||
|
describe '.action_methods' do
|
||||||
|
subject { controller_class.action_methods }
|
||||||
|
it { should be_empty }
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '.dispatch' do
|
||||||
|
subject { ->(*args) { controller_class.dispatch(*args) } }
|
||||||
|
let(:other_bot) { double(username: 'otherBot') }
|
||||||
|
before do
|
||||||
|
controller_class.class_eval do
|
||||||
|
self.session_store = :memory_store
|
||||||
|
|
||||||
|
def write(text)
|
||||||
|
session[:text] = text
|
||||||
|
end
|
||||||
|
|
||||||
|
def read
|
||||||
|
session[:text]
|
||||||
|
end
|
||||||
|
|
||||||
|
def action_missing(*)
|
||||||
|
[:action_missing, session[:text]].tap do
|
||||||
|
session[:text] = 'test'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_message(text, from)
|
||||||
|
{'message' => {'text' => text, 'from' => from.stringify_keys}}
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'stores session between requests' do
|
||||||
|
subject.call(bot, build_message('/write test', id: 1))
|
||||||
|
expect(subject.call(bot, build_message('/read', id: 1))).to eq 'test'
|
||||||
|
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
|
||||||
|
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
|
||||||
26
spec/telegram/bot/updates_controller/typed_update_spec.rb
Обычный файл
26
spec/telegram/bot/updates_controller/typed_update_spec.rb
Обычный файл
@@ -0,0 +1,26 @@
|
|||||||
|
RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate 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
|
||||||
|
|
||||||
|
context 'when `update` is a virtus model' do
|
||||||
|
subject { controller }
|
||||||
|
%w(
|
||||||
|
message
|
||||||
|
inline_query
|
||||||
|
chosen_inline_result
|
||||||
|
).each do |type|
|
||||||
|
context "with #{type}" do
|
||||||
|
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
||||||
|
let(:payload_type) { type }
|
||||||
|
let(:payload) { {} }
|
||||||
|
its(:payload_type) { should eq payload_type }
|
||||||
|
its(:payload) { should be_instance_of type_class }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,10 +1,5 @@
|
|||||||
RSpec.describe Telegram::Bot::UpdatesController do
|
RSpec.describe Telegram::Bot::UpdatesController do
|
||||||
let(:instance) { described_class.new(bot, update) }
|
include_context 'telegram/bot/updates_controller'
|
||||||
let(:update) { {payload_type => payload} }
|
|
||||||
let(:payload_type) { 'some_type' }
|
|
||||||
let(:payload) { double(:payload) }
|
|
||||||
let(:bot) { double(username: bot_name) }
|
|
||||||
let(:bot_name) { 'bot' }
|
|
||||||
let(:other_bot_name) { 'other_bot' }
|
let(:other_bot_name) { 'other_bot' }
|
||||||
|
|
||||||
describe '.action_for_command' do
|
describe '.action_for_command' do
|
||||||
@@ -83,13 +78,38 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
end
|
end
|
||||||
|
|
||||||
describe '#action_for_payload' do
|
describe '#action_for_payload' do
|
||||||
subject { instance.action_for_payload }
|
subject { controller.action_for_payload }
|
||||||
|
|
||||||
(described_class::PAYLOAD_TYPES - %w(message)).each do |type|
|
def stub_payload(*fields)
|
||||||
context "when payload is #{type}" do
|
Hash[fields.map { |x| [x, double(x)] }]
|
||||||
let(:payload_type) { type }
|
end
|
||||||
it { should eq [false, type, [payload]] }
|
|
||||||
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 edited_message' do
|
||||||
|
let(:payload_type) { 'edited_message' }
|
||||||
|
it { should eq [false, payload_type, [payload]] }
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when payload is not supported' do
|
||||||
|
let(:payload_type) { '_unsupported_' }
|
||||||
|
it { should eq [false, :unsupported_payload_type, []] }
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when payload is message' do
|
context 'when payload is message' do
|
||||||
@@ -114,11 +134,34 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
it { should eq [false, 'message', [payload]] }
|
it { should eq [false, 'message', [payload]] }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
context 'without text' do
|
||||||
|
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||||
|
it { should eq [false, payload_type, [payload]] }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when `update` is a virtus model' do
|
||||||
|
subject { controller }
|
||||||
|
let(:update) { Telegram::Bot::Types::Update.new(super()) }
|
||||||
|
%w(
|
||||||
|
message
|
||||||
|
inline_query
|
||||||
|
chosen_inline_result
|
||||||
|
).each do |type|
|
||||||
|
context "with #{type}" do
|
||||||
|
type_class = Telegram::Bot::Types.const_get(type.camelize)
|
||||||
|
let(:payload_type) { type }
|
||||||
|
let(:payload) { {} }
|
||||||
|
its(:payload_type) { should eq payload_type }
|
||||||
|
its(:payload) { should be_instance_of type_class }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '#bot_username' do
|
describe '#bot_username' do
|
||||||
subject { instance.bot_username }
|
subject { controller.bot_username }
|
||||||
|
|
||||||
context 'when bot is not set' do
|
context 'when bot is not set' do
|
||||||
let(:bot) {}
|
let(:bot) {}
|
||||||
@@ -130,4 +173,124 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
|||||||
it { should eq bot.username }
|
it { should eq bot.username }
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
describe '#process' do
|
||||||
|
subject { -> { controller.process(:action, *args) } }
|
||||||
|
let(:args) { [: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
|
||||||
|
before do
|
||||||
|
controller_class.class_eval do
|
||||||
|
before_action :hook, only: :action
|
||||||
|
attr_reader :hooked
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def hook
|
||||||
|
@hooked = true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
it { should change(controller, :hooked).to true }
|
||||||
|
it { should change(controller, :acted).to true }
|
||||||
|
its(:call) { should eq [nil, nil, args] }
|
||||||
|
|
||||||
|
context 'when callback halts chain' do
|
||||||
|
before do
|
||||||
|
controller_class.prepend(Module.new do
|
||||||
|
def hook
|
||||||
|
super
|
||||||
|
ActiveSupport::VERSION::MAJOR >= 5 ? throw(:abort) : false
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,50 +1,22 @@
|
|||||||
RSpec.describe Telegram::Bot do
|
RSpec.describe Telegram::Bot do
|
||||||
it 'has a version number' do
|
it 'has a version number' do
|
||||||
expect(Telegram::Bot::VERSION).not_to be nil
|
expect(described_class::VERSION).not_to be nil
|
||||||
end
|
end
|
||||||
|
|
||||||
describe '.wrap' do
|
describe described_class::StaleChat do
|
||||||
subject { described_class.wrap(input) }
|
describe '.match_response?' do
|
||||||
let(:result) { double(:result) }
|
subject { ->(val) { described_class.match_response?(val) } }
|
||||||
let(:token) { 'token' }
|
|
||||||
let(:username) { 'username' }
|
|
||||||
let(:instance) { described_class.new 'token' }
|
|
||||||
|
|
||||||
context 'when input is a string' do
|
it 'returns true for specific errors' do
|
||||||
let(:input) { token }
|
expect(subject.call({})).to eq false
|
||||||
|
expect(subject.call('description' => 'test')).to eq false
|
||||||
it 'treats string as token' do
|
expect(subject.call('description' => 'Error: bot was kicked from')).to eq true
|
||||||
expect(described_class).to receive(:new).with(token) { result }
|
expect(subject.call(
|
||||||
should eq result
|
'description' => "Forbidden: can't write to private chat with deleted user"
|
||||||
end
|
)).to eq true
|
||||||
end
|
expect(subject.call(
|
||||||
|
'description' => 'Bad request: group chat is deactivated'
|
||||||
context 'when input is a hash' do
|
)).to eq true
|
||||||
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
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
|
|||||||
spec.email = ['melentievm@gmail.com']
|
spec.email = ['melentievm@gmail.com']
|
||||||
|
|
||||||
spec.summary = 'Library for building Telegram Bots with Rails integration'
|
spec.summary = 'Library for building Telegram Bots with Rails integration'
|
||||||
spec.homepage = 'https://github.com/printercu/telegram-bot'
|
spec.homepage = 'https://github.com/telegram-bot-rb/telegram-bot'
|
||||||
spec.license = 'MIT'
|
spec.license = 'MIT'
|
||||||
|
|
||||||
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
|
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
|
||||||
@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
|
|||||||
|
|
||||||
spec.required_ruby_version = '~> 2.0'
|
spec.required_ruby_version = '~> 2.0'
|
||||||
|
|
||||||
spec.add_dependency 'activesupport', '~> 4.0'
|
spec.add_dependency 'activesupport', '>= 4.0', '< 5.1'
|
||||||
spec.add_dependency 'actionpack', '~> 4.0'
|
spec.add_dependency 'actionpack', '>= 4.0', '< 5.1'
|
||||||
spec.add_dependency 'httpclient', '~> 2.7'
|
spec.add_dependency 'httpclient', '~> 2.7'
|
||||||
spec.add_development_dependency 'bundler', '~> 1.11'
|
spec.add_development_dependency 'bundler', '~> 1.11'
|
||||||
spec.add_development_dependency 'rake', '~> 10.0'
|
spec.add_development_dependency 'rake', '~> 10.0'
|
||||||
|
|||||||
Ссылка в новой задаче
Block a user