зеркало из
https://github.com/glebtv/telegram-bot.git
synced 2026-08-28 15:26:18 +03:00
Сравнить коммиты
36 Коммитов
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
da93abaaf7 | ||
|
|
0ae17fb34e | ||
|
|
7e41bd4f9b | ||
|
|
e529a79339 | ||
|
|
ef4f3caa5f | ||
|
|
df7039326d | ||
|
|
4f47506e22 | ||
|
|
6abbe5489d | ||
|
|
ff7de976d0 | ||
|
|
aaba27eb70 | ||
|
|
88a4a9aab3 | ||
|
|
9387043ec1 | ||
|
|
3dca35ba9a | ||
|
|
6879618c00 | ||
|
|
6e4a69b6b1 | ||
|
|
b8db576452 | ||
|
|
2fffdeb475 | ||
|
|
9defa42f40 | ||
|
|
0320507abe | ||
|
|
cd3d3739a4 | ||
|
|
a054ac704c | ||
|
|
23aa92e614 | ||
|
|
a49dca66fa | ||
|
|
2d5ca981ce | ||
|
|
cf9bd87cf2 | ||
|
|
48ff7a4f43 | ||
|
|
17260cb5a9 | ||
|
|
817af95369 | ||
|
|
99fbe41b16 | ||
|
|
88178113d7 | ||
|
|
1a2ac0dd83 | ||
|
|
fa6e385ca1 | ||
|
|
1098118826 | ||
|
|
0c9a4a5fa0 | ||
|
|
5c299887bb | ||
|
|
9f2234c132 |
1
.gitignore
поставляемый
1
.gitignore
поставляемый
@@ -6,4 +6,5 @@
|
||||
/doc/
|
||||
/pkg/
|
||||
/spec/reports/
|
||||
/log/
|
||||
/tmp/
|
||||
|
||||
@@ -15,6 +15,7 @@ Style/DotPosition: {EnforcedStyle: trailing}
|
||||
Style/FirstParameterIndentation: {EnforcedStyle: consistent}
|
||||
Style/IfUnlessModifier: {Enabled: false}
|
||||
Style/ModuleFunction: {Enabled: false}
|
||||
Style/MultilineMethodCallIndentation: {EnforcedStyle: indented}
|
||||
Style/MultilineOperationIndentation: {EnforcedStyle: indented}
|
||||
Style/NestedParenthesizedCalls: {Enabled: false}
|
||||
Style/PredicateName: {Enabled: false}
|
||||
|
||||
@@ -5,5 +5,6 @@ rvm:
|
||||
env:
|
||||
- RAILS=4
|
||||
- RAILS=5
|
||||
- RAILS=5_1
|
||||
notifications:
|
||||
email: false
|
||||
|
||||
46
CHANGELOG.md
46
CHANGELOG.md
@@ -1,3 +1,49 @@
|
||||
# Unreleased
|
||||
|
||||
# 0.12.1
|
||||
|
||||
- Fix `set_webhook` rake task for async bots with self-issued certificates.
|
||||
- Make `#session` raise error when store is not configured,
|
||||
don't use Rails.cache as fallback for session_store.
|
||||
- Allow use different sessions for MessageContext.
|
||||
|
||||
# 0.12.0
|
||||
|
||||
- New API methods and payload types (up to Bot API 3.2).
|
||||
- Fix rails 5.1.x support.
|
||||
- RSpec context for callback_query updates.
|
||||
- `edit_message` helper.
|
||||
- ClientStub saves and returns token. Fixes testing multiple bots.
|
||||
- Raise descriptive error when accessing not-configured bot.
|
||||
|
||||
# 0.11.3
|
||||
|
||||
- Release dependencies for Rails 5.1.
|
||||
|
||||
# 0.11.2
|
||||
|
||||
- Rails 5.1 deep symbolized secrets support.
|
||||
|
||||
# 0.11.1
|
||||
|
||||
- Fixed poller for typed response.
|
||||
|
||||
# 0.11.0
|
||||
|
||||
- Remove Bot::StaleChat in favor of Bot::Forbidden, as Telegram adds more
|
||||
and more new descriptions.
|
||||
Please open an issue if you face a problem.
|
||||
|
||||
# 0.10.2
|
||||
|
||||
- Support `(edited_)channel_post` updates.
|
||||
- New methods from 2.3, 2.3.1 API updates.
|
||||
|
||||
# 0.10.0
|
||||
|
||||
- Integration helpers for RSpec.
|
||||
- Fix for ruby 2.2.0 bug by @bob-frost.
|
||||
|
||||
# 0.9.0
|
||||
|
||||
- Async API requests.
|
||||
|
||||
27
Gemfile
27
Gemfile
@@ -1,22 +1,31 @@
|
||||
source 'https://rubygems.org'
|
||||
gemspec
|
||||
|
||||
case ENV['RAILS']
|
||||
when '5'
|
||||
gem 'actionpack', '5.0.0.rc1'
|
||||
when '4'
|
||||
gem 'actionpack', '~> 4.2'
|
||||
end
|
||||
|
||||
group :development do
|
||||
case ENV['RAILS']
|
||||
when '5_1'
|
||||
gem 'railties', '5.1.0'
|
||||
gem 'actionpack', '5.1.0'
|
||||
when '5'
|
||||
gem 'railties', '5.0.2'
|
||||
gem 'actionpack', '5.0.2'
|
||||
when '4'
|
||||
gem 'railties', '~> 4.2'
|
||||
gem 'actionpack', '~> 4.2'
|
||||
else
|
||||
gem 'railties'
|
||||
gem 'actionpack'
|
||||
end
|
||||
|
||||
gem 'sdoc', '~> 0.4.1'
|
||||
gem 'pry', '~> 0.10.1'
|
||||
gem 'pry-byebug', '~> 3.2.0'
|
||||
|
||||
gem 'telegram-bot-types', '~> 0.2.0'
|
||||
gem 'telegram-bot-types', '~> 0.3.0'
|
||||
|
||||
gem 'rspec', '~> 3.3.0'
|
||||
gem 'rspec', '~> 3.5.0'
|
||||
gem 'rspec-its', '~> 1.1.0'
|
||||
gem 'rspec-rails', '~> 3.5.0'
|
||||
|
||||
gem 'rubocop', '~> 0.37.0'
|
||||
|
||||
|
||||
125
README.md
125
README.md
@@ -24,6 +24,11 @@ Here is sample [telegram_bot_app](https://github.com/telegram-bot-rb/telegram_bo
|
||||
with session, keyboards and inline queries.
|
||||
Run it on your local machine in 1 minute!
|
||||
|
||||
And here is [app template](https://github.com/telegram-bot-rb/rails_template)
|
||||
to generate clean app in seconds.
|
||||
|
||||
Examples and cookbook in [wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
|
||||
|
||||
## Installation
|
||||
|
||||
Add this line to your application's Gemfile:
|
||||
@@ -40,6 +45,12 @@ Or install it yourself as:
|
||||
|
||||
$ gem install telegram-bot
|
||||
|
||||
Require if necessary:
|
||||
|
||||
```ruby
|
||||
require 'telegram/bot'
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Configuration
|
||||
@@ -97,7 +108,7 @@ 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.
|
||||
Special `Telegram::Bot::Forbidden` is raised when bot can't post messages to the chat anymore.
|
||||
|
||||
### Controller
|
||||
|
||||
@@ -157,6 +168,20 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
end
|
||||
```
|
||||
|
||||
#### Reply helpers
|
||||
|
||||
There are helpers to respond for basic actions. They just set chat/message/query
|
||||
identifiers from update. See `ReplyHelpers` method for more information.
|
||||
Here are this methods signatures:
|
||||
|
||||
```ruby
|
||||
def respond_with(type, params); end
|
||||
def reply_with(type, params); end
|
||||
def answer_inline_query(results, params = {}); end
|
||||
def answer_callback_query(text, params = {}); end
|
||||
def edit_message(type, params = {}); end
|
||||
```
|
||||
|
||||
#### Optional typecasting
|
||||
|
||||
You can enable typecasting of `update` with `telegram-bot-types` by including
|
||||
@@ -174,12 +199,33 @@ end
|
||||
|
||||
#### Session
|
||||
|
||||
There is support for sessions using `ActiveSupport::Cache` stores.
|
||||
This API is very close to ActiveController's session API, but works different
|
||||
under the hood. Cookies can not be used to store session id or
|
||||
whole session (like CookieStore does). So it uses key-value store and `session_key`
|
||||
method to build identifier from update.
|
||||
|
||||
Store can be one of numerous `ActiveSupport::Cache` stores.
|
||||
While `:file_store` is suitable for development and single-server deployments
|
||||
without heavy load, it doesn't scale well. Key-value databases with persistance
|
||||
like Redis are more appropriate for production use.
|
||||
|
||||
```ruby
|
||||
# configure store in env files:
|
||||
# In rails app store can be configured in env files:
|
||||
config.telegram_updates_controller.session_store = :redis_store, {expires_in: 1.month}
|
||||
|
||||
# In other app it can be done for all controllers with:
|
||||
Telegram::Bot::UpdatesController.session_store = :redis_store, {expires_in: 1.month}
|
||||
# or for specific one:
|
||||
OneOfUpdatesController.session_store = :redis_store, {expires_in: 1.month}
|
||||
```
|
||||
|
||||
Default session id is made from bot's username and `(from || chat)['id']`.
|
||||
It means that session will be the same for updates from user in every chat,
|
||||
and different for every user in the same group chat.
|
||||
To change this behavior you can override `session_key` method, or even
|
||||
define multiple sessions in single controller. For details see `Session` module.
|
||||
|
||||
```ruby
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
include Telegram::Bot::UpdatesController::Session
|
||||
# or just shortcut:
|
||||
@@ -197,12 +243,16 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
end
|
||||
|
||||
private
|
||||
# By default it uses bot's username and user's id as a session key.
|
||||
# Chat's id is used only when `from` field is empty.
|
||||
# Override `session_key` method to change this behavior.
|
||||
|
||||
# In this case session will persist for user only in specific chat.
|
||||
# Same user in other chat will have different session.
|
||||
def session_key
|
||||
# In this case session will persist for user only in specific chat:
|
||||
"#{bot.username}:#{chat['id']}:#{from['id']}"
|
||||
"#{bot.username}:#{chat['id']}:#{from['id']}" if chat && from
|
||||
end
|
||||
|
||||
# This session will be the same for all updates in chat.
|
||||
def chat_session
|
||||
@_chat_session ||= self.class.build_session(chat && "#{bot.username}:#{chat['id']}")
|
||||
end
|
||||
end
|
||||
```
|
||||
@@ -323,36 +373,65 @@ To stub all possible clients use `Telegram::Bot::ClientStub.stub_all!` before
|
||||
initializing clients. Most likely you'll want something like this:
|
||||
|
||||
```ruby
|
||||
# environments/test.rb
|
||||
# Make sure to run it before defining routes or storing bot to some place in app!
|
||||
Telegram.reset_bots
|
||||
Telegram::Bot::ClientStub.stub_all!
|
||||
|
||||
# rails_helper.rb
|
||||
RSpec.configure do |config|
|
||||
# ...
|
||||
Telegram.reset_bots
|
||||
Telegram::Bot::ClientStub.stub_all!
|
||||
config.after { Telegram.bot.reset }
|
||||
# or for multiple bots:
|
||||
config.after { Telegram.bots.each_value(&:reset) }
|
||||
# ...
|
||||
end
|
||||
```
|
||||
|
||||
There are also some helpers for controller tests.
|
||||
Check out `telegram/bot/updates_controller/rspec_helpers` and
|
||||
`telegram/bot/updates_controller/testing`.
|
||||
|
||||
Built-in RSpec matchers will help you to write tests fast:
|
||||
There are integration and controller contexts for RSpec and some built-in matchers:
|
||||
|
||||
```ruby
|
||||
include Telegram::Bot::RSpec::ClientMatchers # no need if you already use controller herlpers
|
||||
# spec/requests/telegram_webhooks_spec.rb
|
||||
require 'telegram/bot/rspec/integration'
|
||||
|
||||
RSpec.describe TelegramWebhooksController, :telegram_bot do
|
||||
# for old rspec add:
|
||||
# include_context 'telegram/bot/integration'
|
||||
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_command :start } }
|
||||
it { should respond_with_message 'Hi there!' }
|
||||
end
|
||||
|
||||
# There is context for callback queries with related matchers.
|
||||
describe '#hey_callback_query', :callback_query do
|
||||
let(:data) { "hey:#{name}" }
|
||||
let(:name) { 'Joe' }
|
||||
it { should answer_callback_query('Hey Joe') }
|
||||
it { should edit_current_message :text, text: 'Done' }
|
||||
end
|
||||
|
||||
# For controller specs use
|
||||
require 'telegram/bot/updates_controller/rspec_helpers'
|
||||
RSpec.describe TelegramWebhooksController, type: :telegram_bot_controller do
|
||||
# for old rspec add:
|
||||
# include_context 'telegram/bot/updates_controller'
|
||||
end
|
||||
|
||||
# Matchers are available for custom specs:
|
||||
include Telegram::Bot::RSpec::ClientMatchers
|
||||
|
||||
expect(&process_update).to send_telegram_message(bot, /msg regexp/, some: :option)
|
||||
expect(&process_update).
|
||||
to make_telegram_request(bot, :sendMessage, hash_including(text: 'msg text'))
|
||||
|
||||
# controller specs are even simplier:
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_message '/start' } }
|
||||
it { should respond_with_message(/Hello/) }
|
||||
end
|
||||
# See sample app for more examples.
|
||||
```
|
||||
|
||||
Place integration tests inside `spec/requests`
|
||||
when using RSpec's `infer_spec_type_from_file_location!`,
|
||||
or just add `type: :request` to `describe`.
|
||||
|
||||
See sample app for more examples.
|
||||
|
||||
### Deploying
|
||||
|
||||
Use `rake telegram:bot:set_webhook` to update webhook url for all configured bots.
|
||||
|
||||
@@ -21,7 +21,7 @@ namespace :telegram do
|
||||
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
||||
url = routes.send("#{route_name}_url")
|
||||
puts "Setting webhook for #{key}..."
|
||||
bot.set_webhook(url: url, certificate: cert)
|
||||
bot.async(false) { bot.set_webhook(url: url, certificate: cert) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -6,26 +6,7 @@ module Telegram
|
||||
module Bot
|
||||
class Error < StandardError; end
|
||||
class NotFound < Error; end
|
||||
|
||||
# Error class for events when chat is not available anymore for bot.
|
||||
# While Telegram has same error codes for different messages and there is no
|
||||
# official docs for this error codes it uses `description` to
|
||||
# check response.
|
||||
class StaleChat < Error
|
||||
DESCRIPTIONS = [
|
||||
'Bot was blocked',
|
||||
'bot was kicked',
|
||||
"can't write to",
|
||||
'group chat is deactivated',
|
||||
].freeze
|
||||
|
||||
class << self
|
||||
def match_response?(response)
|
||||
description = response['description'].to_s
|
||||
DESCRIPTIONS.any? { |x| description[x] }
|
||||
end
|
||||
end
|
||||
end
|
||||
class Forbidden < Error; end
|
||||
|
||||
autoload :Async, 'telegram/bot/async'
|
||||
autoload :Botan, 'telegram/bot/botan'
|
||||
|
||||
@@ -116,7 +116,7 @@ module Telegram
|
||||
|
||||
attr_reader :id
|
||||
|
||||
def initialize(*, id: nil, async: nil, **)
|
||||
def initialize(*, id: nil, async: nil, **options)
|
||||
@id = id
|
||||
self.async = async
|
||||
super
|
||||
|
||||
@@ -5,7 +5,7 @@ module Telegram
|
||||
module ClientHelpers
|
||||
attr_reader :botan
|
||||
|
||||
def initialize(*, botan: nil, **)
|
||||
def initialize(*, botan: nil, **options)
|
||||
super
|
||||
@botan = Botan.wrap(botan, id: id) if botan
|
||||
end
|
||||
|
||||
@@ -5,7 +5,7 @@ require 'active_support/core_ext/hash/keys'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
class Client
|
||||
class Client # rubocop:disable ClassLength
|
||||
URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
|
||||
|
||||
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
||||
@@ -46,54 +46,84 @@ module Telegram
|
||||
@base_uri = format URL_TEMPLATE, self.token
|
||||
end
|
||||
|
||||
def request(action, body = {}) # rubocop:disable PerceivedComplexity
|
||||
def request(action, body = {})
|
||||
res = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
|
||||
status = res.status
|
||||
return JSON.parse(res.body) if 300 > status
|
||||
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
||||
err_msg = "#{res.reason}: #{result && result['description'] || '-'}"
|
||||
err_msg = 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)
|
||||
# This errors are raised only for valid responses from Telegram
|
||||
case status
|
||||
when 403 then raise Forbidden, err_msg
|
||||
when 404 then raise NotFound, err_msg
|
||||
end
|
||||
end
|
||||
raise Error, err_msg
|
||||
raise Error, "#{res.reason}: #{err_msg}"
|
||||
end
|
||||
|
||||
# Splited to the sections similar to API docs.
|
||||
%w(
|
||||
deleteWebhook
|
||||
getUpdates
|
||||
getWebhookInfo
|
||||
setWebhook
|
||||
|
||||
answerCallbackQuery
|
||||
answerInlineQuery
|
||||
editMessageCaption
|
||||
editMessageReplyMarkup
|
||||
editMessageText
|
||||
deleteChatPhoto
|
||||
exportChatInviteLink
|
||||
forwardMessage
|
||||
getChat
|
||||
getChatAdministrators
|
||||
getChatMember
|
||||
getChatMembersCount
|
||||
getFile
|
||||
getGameHighScores
|
||||
getMe
|
||||
getUpdates
|
||||
getUserProfilePhotos
|
||||
getWebhookInfo
|
||||
kickChatMember
|
||||
leaveChat
|
||||
pinChatMessage
|
||||
promoteChatMember
|
||||
restrictChatMember
|
||||
sendAudio
|
||||
sendChatAction
|
||||
sendContact
|
||||
sendDocument
|
||||
sendGame
|
||||
sendLocation
|
||||
sendMessage
|
||||
sendPhoto
|
||||
sendSticker
|
||||
sendVenue
|
||||
sendVideo
|
||||
sendVideoNote
|
||||
sendVoice
|
||||
setGameScore
|
||||
setWebhook
|
||||
setChatDescription
|
||||
setChatPhoto
|
||||
setChatTitle
|
||||
unbanChatMember
|
||||
unpinChatMessage
|
||||
|
||||
deleteMessage
|
||||
editMessageCaption
|
||||
editMessageReplyMarkup
|
||||
editMessageText
|
||||
|
||||
sendSticker
|
||||
getStickerSet
|
||||
uploadStickerFile
|
||||
createNewStickerSet
|
||||
addStickerToSet
|
||||
setStickerPositionInSet
|
||||
deleteStickerFromSet
|
||||
|
||||
answerInlineQuery
|
||||
|
||||
sendInvoice
|
||||
answerShippingQuery
|
||||
answerPreCheckoutQuery
|
||||
|
||||
getGameHighScores
|
||||
sendGame
|
||||
setGameScore
|
||||
).each do |method|
|
||||
define_method(method.underscore) { |*args| request(method, *args) }
|
||||
end
|
||||
|
||||
@@ -35,6 +35,7 @@ module Telegram
|
||||
end
|
||||
|
||||
def initialize(token = nil, username = nil, **options)
|
||||
@token = token || options[:token]
|
||||
@username = username || options[:username] || token
|
||||
reset
|
||||
end
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
require 'active_support/core_ext/hash/keys'
|
||||
require 'active_support/core_ext/hash/transform_values'
|
||||
require 'active_support/core_ext/hash/indifferent_access'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
@@ -20,7 +21,7 @@ module Telegram
|
||||
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)
|
||||
Rails.env.development? if defined?(Rails.env)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -33,7 +34,11 @@ module Telegram
|
||||
|
||||
# Default bot.
|
||||
def bot
|
||||
@bot ||= bots[:default]
|
||||
@bot ||= bots.fetch(:default) do
|
||||
raise 'Default bot is not configured.' \
|
||||
' Add :default to bots_config' \
|
||||
' or use telegram.bot/telegram.bots.default section in secrets.yml.'
|
||||
end
|
||||
end
|
||||
|
||||
# Hash of botan clients made from #bots.
|
||||
@@ -47,10 +52,11 @@ module Telegram
|
||||
# Can be overwritten with .bots_config=
|
||||
def bots_config
|
||||
@bots_config ||=
|
||||
if defined?(Rails)
|
||||
telegram_config = Rails.application.secrets[:telegram] || {}
|
||||
(telegram_config['bots'] || {}).symbolize_keys.tap do |config|
|
||||
default = telegram_config['bot']
|
||||
if defined?(Rails.application)
|
||||
secrets = Rails.application.secrets.
|
||||
fetch(:telegram, {}).with_indifferent_access
|
||||
secrets.fetch(:bots, {}).symbolize_keys.tap do |config|
|
||||
default = secrets[:bot]
|
||||
config[:default] = default if default
|
||||
end
|
||||
else
|
||||
|
||||
@@ -18,7 +18,7 @@ module Telegram
|
||||
|
||||
ActiveSupport.on_load('telegram.bot.updates_controller') do
|
||||
self.logger = options.logger || Rails.logger
|
||||
self.session_store = options.session_store || Rails.cache
|
||||
self.session_store = options.session_store if options.session_store
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -139,9 +139,9 @@ module Telegram
|
||||
# Helper for asserting message is sent. Note that options are checked
|
||||
# with `hash_including`. For strict checks use #make_telegram_request.
|
||||
def send_telegram_message(bot, text = nil, options = {})
|
||||
description = "send telegram message #{text.inspect}"
|
||||
text = a_string_matching(text) if text.is_a?(Regexp)
|
||||
options = options.merge(text: text) if text
|
||||
description = "send telegram message #{text.inspect}"
|
||||
MakeTelegramRequest.new(bot, :sendMessage, description: description).
|
||||
with(hash_including(options))
|
||||
end
|
||||
|
||||
83
lib/telegram/bot/rspec/integration.rb
Обычный файл
83
lib/telegram/bot/rspec/integration.rb
Обычный файл
@@ -0,0 +1,83 @@
|
||||
RSpec.shared_context 'telegram/bot/integration' do
|
||||
let(:bot) { Telegram.bot }
|
||||
let(:from_id) { 123 }
|
||||
let(:chat_id) { 456 }
|
||||
let(:default_message_options) { {from: {id: from_id}, chat: {id: chat_id}} }
|
||||
let(:controller_path) do
|
||||
route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
|
||||
Rails.application.routes.url_helpers.public_send("#{route_name}_path")
|
||||
end
|
||||
let(:request_headers) do
|
||||
{
|
||||
'ACCEPT' => 'application/json',
|
||||
'Content-Type' => 'application/json',
|
||||
}
|
||||
end
|
||||
let(:clear_session?) { described_class.respond_to?(:session_store) }
|
||||
before { described_class.session_store.try!(:clear) if clear_session? }
|
||||
|
||||
include Telegram::Bot::RSpec::ClientMatchers
|
||||
|
||||
def dispatch(update)
|
||||
if ActionPack::VERSION::MAJOR >= 5
|
||||
post(controller_path, params: update.to_json, headers: request_headers)
|
||||
else
|
||||
post(controller_path, update.to_json, request_headers)
|
||||
end
|
||||
end
|
||||
|
||||
def dispatch_message(text, options = {})
|
||||
dispatch message: default_message_options.merge(options).merge(text: text)
|
||||
end
|
||||
|
||||
def dispatch_command(*args)
|
||||
options = args.last.is_a?(Hash) ? args.pop : {}
|
||||
dispatch_message("/#{args.join ' '}", options)
|
||||
end
|
||||
|
||||
# Matcher to check response. Make sure to define `let(:chat_id)`.
|
||||
def respond_with_message(expected = Regexp.new(''))
|
||||
raise 'Define chat_id to use respond_with_message' unless defined?(chat_id)
|
||||
send_telegram_message(bot, expected, chat_id: chat_id)
|
||||
end
|
||||
end
|
||||
|
||||
RSpec.shared_context 'telegram/bot/callback_query', callback_query: true do
|
||||
include_context 'telegram/bot/integration'
|
||||
|
||||
subject { -> { dispatch callback_query: payload } }
|
||||
let(:payload) { {id: 11, from: from, message: message, data: data} }
|
||||
let(:message) { {message_id: 22, chat: chat, text: 'message text'} }
|
||||
|
||||
# Matcher to check that origin message got edited.
|
||||
def edit_current_message(type, options = {})
|
||||
description = 'edit current message'
|
||||
options = options.merge(
|
||||
message_id: message[:message_id],
|
||||
chat_id: chat_id,
|
||||
)
|
||||
Telegram::Bot::RSpec::ClientMatchers::MakeTelegramRequest.new(
|
||||
bot, :"editMessage#{type.to_s.camelize}", description: description
|
||||
).with(hash_including(options))
|
||||
end
|
||||
|
||||
# Matcher to check that callback query is answered.
|
||||
def answer_callback_query(text = Regexp.new(''), options = {})
|
||||
description = "answer callback query with #{text.inspect}"
|
||||
text = a_string_matching(text) if text.is_a?(Regexp)
|
||||
options = options.merge(
|
||||
callback_query_id: payload[:id],
|
||||
text: text,
|
||||
)
|
||||
Telegram::Bot::RSpec::ClientMatchers::MakeTelegramRequest.new(
|
||||
bot, :answerCallbackQuery, description: description
|
||||
).with(hash_including(options))
|
||||
end
|
||||
end
|
||||
|
||||
RSpec.configure do |config|
|
||||
if config.respond_to?(:include_context)
|
||||
config.include_context 'telegram/bot/integration', :telegram_bot
|
||||
config.include_context 'telegram/bot/callback_query', :telegram_bot, :callback_query
|
||||
end
|
||||
end
|
||||
@@ -50,7 +50,7 @@ module Telegram
|
||||
# ControllerClass.new(bot, from: telegram_user, chat: telegram_chat).
|
||||
# process(:help, *args)
|
||||
#
|
||||
class UpdatesController < AbstractController::Base
|
||||
class UpdatesController < AbstractController::Base # rubocop:disable ClassLength
|
||||
abstract!
|
||||
|
||||
require 'telegram/bot/updates_controller/session'
|
||||
@@ -80,10 +80,14 @@ module Telegram
|
||||
|
||||
PAYLOAD_TYPES = %w(
|
||||
message
|
||||
edited_message
|
||||
channel_post
|
||||
edited_channel_post
|
||||
inline_query
|
||||
chosen_inline_result
|
||||
callback_query
|
||||
edited_message
|
||||
shipping_query
|
||||
pre_checkout_query
|
||||
).freeze
|
||||
CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
|
||||
CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
|
||||
@@ -167,25 +171,27 @@ module Telegram
|
||||
# Returns array `[is_command?, action, args]`.
|
||||
def action_for_payload
|
||||
if payload_type
|
||||
send("action_for_#{payload_type}") || [false, payload_type, [payload]]
|
||||
send("action_for_#{payload_type}") || action_for_default_payload
|
||||
else
|
||||
[false, :unsupported_payload_type, []]
|
||||
end
|
||||
end
|
||||
|
||||
def action_for_default_payload
|
||||
[false, payload_type, [payload]]
|
||||
end
|
||||
|
||||
# If payload is a message with command, then returned action is an
|
||||
# action for this command.
|
||||
# Separate method, so it can be easily overriden (ex. MessageContext).
|
||||
#
|
||||
# This is not used for edited messages/posts. It process them as basic updates.
|
||||
def action_for_message
|
||||
cmd, args = self.class.command_from_text(payload['text'], bot_username)
|
||||
cmd &&= self.class.action_for_command(cmd)
|
||||
[true, cmd, args] if cmd
|
||||
end
|
||||
|
||||
# It doesn't extract commands from edited messages. Just process
|
||||
# them as usual ones.
|
||||
def action_for_edited_message
|
||||
end
|
||||
alias_method :action_for_channel_post, :action_for_message
|
||||
|
||||
def action_for_inline_query
|
||||
[false, payload_type, [payload['query'], payload['offset']]]
|
||||
@@ -204,6 +210,11 @@ module Telegram
|
||||
def action_missing(*)
|
||||
end
|
||||
|
||||
PAYLOAD_TYPES.each do |type|
|
||||
method = :"action_for_#{type}"
|
||||
alias_method method, :action_for_default_payload unless instance_methods.include?(method)
|
||||
end
|
||||
|
||||
ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -15,7 +15,6 @@ module Telegram
|
||||
# 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)
|
||||
|
||||
@@ -7,14 +7,11 @@ module Telegram
|
||||
|
||||
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
|
||||
def context_handlers
|
||||
@_context_handlers ||= {}
|
||||
end
|
||||
|
||||
# Registers handler for context.
|
||||
#
|
||||
# context_handler :rename do |*|
|
||||
@@ -39,6 +36,8 @@ module Telegram
|
||||
context_handlers[context] = action || context
|
||||
end
|
||||
|
||||
attr_reader :context_to_action
|
||||
|
||||
# Use it to use context value as action name for all contexts
|
||||
# which miss handlers.
|
||||
# For security reasons it supports only action methods and will
|
||||
@@ -59,10 +58,16 @@ module Telegram
|
||||
# according to previous request.
|
||||
attr_reader :context
|
||||
|
||||
# Controller may have multiple sessions, let it be possible
|
||||
# to select session for message context.
|
||||
def message_context_session
|
||||
session
|
||||
end
|
||||
|
||||
# Fetches context and finds handler for it. If message has new command,
|
||||
# it has higher priority than contextual action.
|
||||
def action_for_message
|
||||
val = session.delete(:context)
|
||||
val = message_context_session.delete(:context)
|
||||
@context = val && val.to_sym
|
||||
super || context && begin
|
||||
handler = handler_for_context
|
||||
@@ -72,7 +77,7 @@ module Telegram
|
||||
|
||||
# Save context for the next request.
|
||||
def save_context(context)
|
||||
session[:context] = context
|
||||
message_context_session[:context] = context
|
||||
end
|
||||
|
||||
def handler_for_context
|
||||
|
||||
@@ -38,6 +38,19 @@ module Telegram
|
||||
)
|
||||
bot.answer_callback_query(params)
|
||||
end
|
||||
|
||||
# Edit message from callback query.
|
||||
def edit_message(type, params = {})
|
||||
params =
|
||||
if message_id = payload['inline_message_id'] # rubocop:disable AssignmentInCondition
|
||||
params.merge(inline_message_id: message_id)
|
||||
elsif message = payload['message'] # rubocop:disable AssignmentInCondition
|
||||
params.merge(chat_id: message['chat']['id'], message_id: message['message_id'])
|
||||
else
|
||||
raise 'Can not edit message without `inline_message_id` or `message`'
|
||||
end
|
||||
bot.public_send("edit_message_#{type}", params)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -13,6 +13,9 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||
let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
|
||||
let(:bot_name) { 'bot' }
|
||||
let(:session) { controller.send(:session) }
|
||||
let(:from_id) { 123 }
|
||||
let(:chat_id) { 456 }
|
||||
let(:default_message_options) { {from: {id: from_id}, chat: {id: chat_id}} }
|
||||
|
||||
include Telegram::Bot::RSpec::ClientMatchers
|
||||
|
||||
@@ -20,9 +23,8 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||
controller.dispatch_again(bot, update)
|
||||
end
|
||||
|
||||
def dispatch_message(text, options = nil)
|
||||
options ||= respond_to?(:default_message_options) ? default_message_options : {}
|
||||
update = build_update :message, options.merge(text: text)
|
||||
def dispatch_message(text, options = {})
|
||||
update = build_update :message, default_message_options.merge(options).merge(text: text)
|
||||
dispatch bot, update
|
||||
end
|
||||
|
||||
@@ -43,3 +45,9 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||
send_telegram_message(bot, expected, chat_id: chat_id)
|
||||
end
|
||||
end
|
||||
|
||||
RSpec.configure do |config|
|
||||
if config.respond_to?(:include_context)
|
||||
config.include_context 'telegram/bot/updates_controller', type: :telegram_bot_controller
|
||||
end
|
||||
end
|
||||
|
||||
@@ -8,19 +8,26 @@ module Telegram
|
||||
module Session
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
module ClassMethods
|
||||
# Builds session with given key and optional store (default to session_store).
|
||||
# This way it's easier to define multiple custom sessions,
|
||||
# ex. one for group chat and one for user.
|
||||
def build_session(key, store = session_store)
|
||||
raise 'session_store is not configured' unless store
|
||||
key ? SessionHash.new(store, key) : NullSessionHash.new
|
||||
end
|
||||
end
|
||||
|
||||
def process_action(*)
|
||||
super
|
||||
ensure
|
||||
session.commit
|
||||
session.commit if @_session
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def session
|
||||
@_session ||= begin
|
||||
key = session_key
|
||||
key ? SessionHash.new(self.class.session_store, key) : NullSessionHash.new
|
||||
end
|
||||
@_session ||= self.class.build_session(session_key)
|
||||
end
|
||||
|
||||
def session_key
|
||||
|
||||
@@ -27,12 +27,12 @@ module Telegram
|
||||
attr_reader :bot, :controller, :timeout, :offset, :logger, :running, :reload
|
||||
|
||||
def initialize(bot, controller, **options)
|
||||
@logger = options.fetch(:logger) { defined?(Rails) && Rails.logger }
|
||||
@logger = options.fetch(:logger) { defined?(Rails.logger) && Rails.logger }
|
||||
@bot = bot
|
||||
@controller = controller
|
||||
@timeout = options.fetch(:timeout) { DEFAULT_TIMEOUT }
|
||||
@offset = options[:offset]
|
||||
@reload = options.fetch(:reload) { defined?(Rails) && Rails.env.development? }
|
||||
@reload = options.fetch(:reload) { defined?(Rails.env) && Rails.env.development? }
|
||||
end
|
||||
|
||||
def log(&block)
|
||||
@@ -65,14 +65,16 @@ module Telegram
|
||||
|
||||
def fetch_updates
|
||||
response = bot.async(false) { bot.get_updates(offset: offset, timeout: timeout) }
|
||||
return unless response['ok'] && response['result'].any?
|
||||
updates = response.is_a?(Array) ? response : response['result']
|
||||
return unless updates && updates.any?
|
||||
reload! do
|
||||
response['result'].each do |update|
|
||||
updates.each do |update|
|
||||
@offset = update['update_id'] + 1
|
||||
yield update
|
||||
end
|
||||
end
|
||||
rescue Timeout::Error # rubocop:disable HandleExceptions
|
||||
rescue Timeout::Error
|
||||
log { 'Fetch timeout' }
|
||||
end
|
||||
|
||||
def reload!
|
||||
@@ -85,7 +87,7 @@ module Telegram
|
||||
end
|
||||
end
|
||||
|
||||
if defined?(Rails) && Rails.application.respond_to?(:reloader)
|
||||
if defined?(Rails.application) && Rails.application.respond_to?(:reloader)
|
||||
def reloading_code
|
||||
Rails.application.reloader.wrap do
|
||||
yield
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
VERSION = '0.9.0'.freeze
|
||||
VERSION = '0.12.1'.freeze
|
||||
|
||||
def self.gem_version
|
||||
Gem::Version.new VERSION
|
||||
|
||||
13
spec/integration/requests/default_bot_spec.rb
Обычный файл
13
spec/integration/requests/default_bot_spec.rb
Обычный файл
@@ -0,0 +1,13 @@
|
||||
require 'integration_helper'
|
||||
|
||||
RSpec.describe DefaultBotController, :telegram_bot, type: :request do
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_command :start } }
|
||||
it { should respond_with_message 'from default' }
|
||||
end
|
||||
|
||||
describe '#load_session' do
|
||||
subject { -> { dispatch_command :load_session } }
|
||||
it { should_not raise_error }
|
||||
end
|
||||
end
|
||||
9
spec/integration/requests/named_bot_spec.rb
Обычный файл
9
spec/integration/requests/named_bot_spec.rb
Обычный файл
@@ -0,0 +1,9 @@
|
||||
require 'integration_helper'
|
||||
|
||||
RSpec.describe NamedBotController, :telegram_bot, type: :request do
|
||||
let(:bot) { Telegram.bots[:named] }
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_command :start } }
|
||||
it { should respond_with_message 'from named' }
|
||||
end
|
||||
end
|
||||
14
spec/integration/requests/other_bot_spec.rb
Обычный файл
14
spec/integration/requests/other_bot_spec.rb
Обычный файл
@@ -0,0 +1,14 @@
|
||||
require 'integration_helper'
|
||||
|
||||
RSpec.describe OtherBotController, :telegram_bot, type: :request do
|
||||
let(:bot) { Telegram.bots[:other] }
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_command :start } }
|
||||
it { should respond_with_message 'from other' }
|
||||
end
|
||||
|
||||
describe '#load_session' do
|
||||
subject { -> { dispatch_command :load_session } }
|
||||
it { should raise_error(/session_store is not configured/) }
|
||||
end
|
||||
end
|
||||
76
spec/integration_helper.rb
Обычный файл
76
spec/integration_helper.rb
Обычный файл
@@ -0,0 +1,76 @@
|
||||
require 'telegram/bot/rspec/integration'
|
||||
require 'action_controller'
|
||||
require 'action_dispatch'
|
||||
require 'action_dispatch/testing/integration'
|
||||
|
||||
require 'rails'
|
||||
require 'telegram/bot/railtie'
|
||||
require 'rspec/rails/adapters'
|
||||
require 'rspec/rails/fixture_support'
|
||||
require 'rspec/rails/example/rails_example_group'
|
||||
require 'rspec/rails/example/request_example_group'
|
||||
|
||||
ENV['RAILS_ENV'] = 'test'
|
||||
class TestApplication < Rails::Application
|
||||
config.eager_load = false
|
||||
config.log_level = :debug
|
||||
config.action_dispatch.show_exceptions = false
|
||||
secrets[:secret_key_base] = 'test'
|
||||
secrets[:telegram] = {
|
||||
bot: 'default_token',
|
||||
bots: {
|
||||
other: {token: 'other_token'},
|
||||
named: {token: 'named_token', username: 'TestBot'},
|
||||
},
|
||||
}
|
||||
end
|
||||
Rails.application.initialize!
|
||||
|
||||
# # Controllers
|
||||
%w(default other named).each do |bot_name|
|
||||
controller = Class.new(Telegram::Bot::UpdatesController) do
|
||||
define_method :start do |*|
|
||||
respond_with :message, text: "from #{bot_name}"
|
||||
end
|
||||
end
|
||||
Object.const_set("#{bot_name}_bot_controller".camelize, controller)
|
||||
end
|
||||
|
||||
[DefaultBotController, OtherBotController].each do |klass|
|
||||
klass.class_eval do
|
||||
use_session!
|
||||
|
||||
define_method :load_session do |*|
|
||||
session[:test]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
DefaultBotController.session_store = :memory_store
|
||||
|
||||
RSpec.configure do |config|
|
||||
config.include RSpec::Rails::RequestExampleGroup, type: :request
|
||||
|
||||
config.around type: :request do |ex|
|
||||
begin
|
||||
Telegram.reset_bots
|
||||
Telegram::Bot::ClientStub.stub_all!
|
||||
ex.run
|
||||
ensure
|
||||
Telegram.reset_bots
|
||||
Telegram::Bot::ClientStub.stub_all!(false)
|
||||
end
|
||||
end
|
||||
|
||||
config.before type: :request do
|
||||
# Redefine routes before every example, so it does not depent on order.
|
||||
Rails.application.routes.draw do
|
||||
require 'telegram/bot/routes_helper'
|
||||
extend Telegram::Bot::RoutesHelper
|
||||
|
||||
telegram_webhooks default: DefaultBotController,
|
||||
other: OtherBotController,
|
||||
named: NamedBotController
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -16,6 +16,7 @@ $LOAD_PATH.unshift GEM_ROOT.join('lib')
|
||||
require 'telegram/bot'
|
||||
require 'telegram/bot/updates_controller/rspec_helpers'
|
||||
require 'telegram/bot/types'
|
||||
require 'active_support/core_ext/object/json'
|
||||
|
||||
Dir[GEM_ROOT.join('spec/support/**/*.rb')].each { |f| require f }
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ RSpec.describe Telegram::Bot::Botan do
|
||||
let(:token) { 'token' }
|
||||
|
||||
include_examples 'initializers', :botans
|
||||
include_examples 'async', request_args: -> { [double(:method), double(:url)] }
|
||||
it_behaves_like 'async', request_args: -> { [double(:method), double(:url)] }
|
||||
|
||||
describe '.new' do
|
||||
subject { described_class.new(*args) }
|
||||
|
||||
@@ -4,7 +4,7 @@ RSpec.describe Telegram::Bot::Client do
|
||||
let(:botan_token) { double(:botan_token) }
|
||||
|
||||
include_examples 'initializers'
|
||||
include_examples 'async', request_args: -> { [double(:action), {body: :content}] }
|
||||
it_behaves_like 'async', request_args: -> { [double(:action), {body: :content}] }
|
||||
|
||||
describe '.prepare_body' do
|
||||
subject { described_class.prepare_body(input) }
|
||||
@@ -48,4 +48,49 @@ RSpec.describe Telegram::Bot::Client do
|
||||
its(:base_uri) { should include args[0][:token] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#request' do
|
||||
subject { -> { instance.request(action, request_body) } }
|
||||
let(:action) { :some_action }
|
||||
let(:url) { "#{format described_class::URL_TEMPLATE, token}#{action}" }
|
||||
let(:request_body) { double(:body) }
|
||||
let(:prepared_body) { double(:prepared_body) }
|
||||
let(:response) { HTTP::Message.new_response(body).tap { |x| x.status = status } }
|
||||
|
||||
let(:status) { 200 }
|
||||
let(:body) { body_json.to_json }
|
||||
let(:body_json) { {'param' => 'val', 'description' => 'some description'} }
|
||||
before do
|
||||
expect(described_class).to receive(:prepare_body).with(request_body) { prepared_body }
|
||||
expect(instance).to receive(:http_request).with(url, prepared_body) { response }
|
||||
end
|
||||
around { |ex| Telegram::Bot::ClientStub.stub_all!(false) { ex.run } }
|
||||
|
||||
shared_examples 'invalid body' do |error = Telegram::Bot::Error|
|
||||
context 'when body is not json' do
|
||||
let(:body) { '{' }
|
||||
it { should raise_error error }
|
||||
end
|
||||
end
|
||||
|
||||
its(:call) { should eq body_json }
|
||||
include_examples 'invalid body', JSON::ParserError
|
||||
|
||||
context 'when status is 403' do
|
||||
let(:status) { 403 }
|
||||
it { should raise_error Telegram::Bot::Forbidden, body_json['description'] }
|
||||
include_examples 'invalid body'
|
||||
end
|
||||
|
||||
context 'when status is 404' do
|
||||
let(:status) { 404 }
|
||||
it { should raise_error Telegram::Bot::NotFound, body_json['description'] }
|
||||
include_examples 'invalid body'
|
||||
end
|
||||
|
||||
context 'when status is other' do
|
||||
let(:status) { 500 }
|
||||
it { should raise_error Telegram::Bot::Error, /#{body_json['description']}/ }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -46,8 +46,14 @@ RSpec.describe Telegram::Bot::ClientStub do
|
||||
|
||||
context 'when username and token are given' do
|
||||
let(:args) { %w(token superbot) }
|
||||
its(:token) { should eq nil }
|
||||
its(:token) { should eq args[0] }
|
||||
its(:username) { should eq args[1] }
|
||||
end
|
||||
|
||||
context 'when hash config is given' do
|
||||
let(:args) { [token: 'token', username: 'superbot'] }
|
||||
its(:token) { should eq args[0][:token] }
|
||||
its(:username) { should eq args[0][:username] }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -22,8 +22,13 @@ RSpec.describe Telegram::Bot::ConfigMethods do
|
||||
end
|
||||
|
||||
describe '#bot' do
|
||||
subject { registry.bot }
|
||||
it { should eq registry.bots[:default] }
|
||||
subject { -> { registry.bot } }
|
||||
its(:call) { should eq registry.bots[:default] }
|
||||
|
||||
context 'when bot is not configured' do
|
||||
let(:config) { super().except(:default) }
|
||||
it { should raise_error(/bot is not configured/) }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#bots' do
|
||||
@@ -67,6 +72,7 @@ RSpec.describe Telegram::Bot::ConfigMethods do
|
||||
|
||||
context 'when not configured' do
|
||||
let(:registry) { Object.new.tap { |x| x.extend described_class } }
|
||||
before { hide_const('Rails') }
|
||||
it { should eq({}) }
|
||||
|
||||
context 'in rails environment' do
|
||||
@@ -87,6 +93,12 @@ RSpec.describe Telegram::Bot::ConfigMethods do
|
||||
end
|
||||
it { should include default: config[:bot] }
|
||||
it { should include config[:bots] }
|
||||
|
||||
context 'on rails >5.1 (deep symbolized keys)' do
|
||||
let(:secrets) { {telegram: config.deep_symbolize_keys} }
|
||||
it { should include default: config[:bot] }
|
||||
it { should include config[:bots] }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
71
spec/telegram/bot/rspec/integration_spec.rb
Обычный файл
71
spec/telegram/bot/rspec/integration_spec.rb
Обычный файл
@@ -0,0 +1,71 @@
|
||||
require 'telegram/bot/rspec/integration'
|
||||
require 'action_controller'
|
||||
require 'action_dispatch'
|
||||
require 'action_dispatch/testing/integration'
|
||||
|
||||
RSpec.describe 'Integrations helper', :telegram_bot do
|
||||
include ActionDispatch::Integration::Runner
|
||||
def reset_template_assertion; end
|
||||
|
||||
let(:app) do
|
||||
app = Telegram::Bot::Middleware.new(bot, controller)
|
||||
if ActionPack::VERSION::MAJOR >= 5
|
||||
app
|
||||
else
|
||||
require 'action_dispatch/middleware/params_parser'
|
||||
ActionDispatch::ParamsParser.new(app)
|
||||
end
|
||||
end
|
||||
let(:bot) { Telegram::Bot::ClientStub.new('token') }
|
||||
let(:controller_path) { '/' }
|
||||
let(:controller) do
|
||||
Class.new(Telegram::Bot::UpdatesController) do
|
||||
def start(*args)
|
||||
respond_with :message, text: "Start: #{args.inspect}, option: #{payload[:option]}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#default_message_options' do
|
||||
subject { default_message_options }
|
||||
it { should eq from: {id: from_id}, chat: {id: chat_id} }
|
||||
end
|
||||
|
||||
describe '#dispatch' do
|
||||
subject { -> { dispatch message: {text: '/start', **default_message_options} } }
|
||||
it { should respond_with_message 'Start: [], option: ' }
|
||||
end
|
||||
|
||||
describe '#dispatch_message' do
|
||||
subject { -> { dispatch_message "/start #{args.join ' '}", options } }
|
||||
let(:args) { %w(asd qwe) }
|
||||
let(:options) { {} }
|
||||
it { should respond_with_message "Start: #{args.inspect}, option: " }
|
||||
|
||||
context 'with options' do
|
||||
let(:options) { {option: 1} }
|
||||
it { should respond_with_message "Start: #{args.inspect}, option: 1" }
|
||||
|
||||
context 'and chat_id is not set' do
|
||||
let(:options) { super().merge(chat: nil) }
|
||||
it { should raise_error(/chat is not present/) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#dispatch_command' do
|
||||
subject { -> { dispatch_command :start, *args } }
|
||||
let(:args) { [] }
|
||||
it { should respond_with_message "Start: #{args.inspect}, option: " }
|
||||
|
||||
context 'with args' do
|
||||
let(:args) { %w(asd qwe) }
|
||||
it { should respond_with_message "Start: #{args.inspect}, option: " }
|
||||
end
|
||||
|
||||
context 'with options' do
|
||||
let(:args) { ['asd', 'qwe', option: 1] }
|
||||
it { should respond_with_message "Start: #{args[0...-1].inspect}, option: 1" }
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -48,4 +48,32 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#edit_message' do
|
||||
subject { controller.edit_message(type, params) }
|
||||
let(:type) { :reply_markup }
|
||||
|
||||
it { expect { subject }.to raise_error(/Can not edit message without/) }
|
||||
|
||||
context 'when inline_message_id is present' do
|
||||
let(:payload) { {inline_message_id: double(:message_id)} }
|
||||
it 'sets inline_message_id' do
|
||||
expect(bot).to receive("edit_message_#{type}").with(params.merge(
|
||||
inline_message_id: payload[:inline_message_id],
|
||||
)) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
|
||||
context 'when message is present' do
|
||||
let(:payload) { {message: super().merge(chat: chat)} }
|
||||
it 'sets chat_id & message_id' do
|
||||
expect(bot).to receive("edit_message_#{type}").with(params.merge(
|
||||
message_id: payload[:message][:message_id],
|
||||
chat_id: payload[:message][:chat]['id'],
|
||||
)) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -54,4 +54,45 @@ RSpec.describe Telegram::Bot::UpdatesController::Session do
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '.build_session' do
|
||||
subject { controller_class.build_session(key, *args) }
|
||||
let(:key) {}
|
||||
let(:args) { [] }
|
||||
it { expect { subject }.to raise_error(/session_store is not configured/) }
|
||||
|
||||
shared_examples 'NullSessionHash when key is not present' do |store_proc|
|
||||
it { should be_instance_of(described_class::NullSessionHash) }
|
||||
|
||||
context 'and key is present' do
|
||||
let(:key) { :test_key }
|
||||
it 'is valid SessionHash' do
|
||||
expect(subject).to be_instance_of(described_class::SessionHash)
|
||||
expect(subject.id).to eq key
|
||||
expect(subject.instance_variable_get(:@store)).to be(instance_exec(&store_proc))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when store configured' do
|
||||
before { controller_class.session_store = nil }
|
||||
include_examples 'NullSessionHash when key is not present',
|
||||
-> { controller_class.session_store }
|
||||
end
|
||||
|
||||
context 'when store is given' do
|
||||
let(:args) { [double(:store)] }
|
||||
include_examples 'NullSessionHash when key is not present', -> { args[0] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '.session_store=' do
|
||||
subject { ->(val) { controller_class.session_store = val } }
|
||||
it 'casts to AS::Cache' do
|
||||
expect { subject[:null_store] }.to change(controller_class, :session_store).
|
||||
to(instance_of(ActiveSupport::Cache::NullStore))
|
||||
expect { subject[nil] }.to change(controller_class, :session_store).
|
||||
to(instance_of(ActiveSupport::Cache::MemoryStore))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -102,41 +102,59 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
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
|
||||
|
||||
context 'when payload is message' do
|
||||
let(:payload_type) { 'message' }
|
||||
let(:payload) { {'text' => text} }
|
||||
let(:text) { 'test' }
|
||||
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
|
||||
context 'with command' do
|
||||
let(:text) { "/test#{"@#{mention}" if mention} arg 1 2" }
|
||||
let(:mention) {}
|
||||
it { should eq [true, 'test', %w(arg 1 2)] }
|
||||
|
||||
context 'with mention' do
|
||||
let(:mention) { bot.username }
|
||||
it { should eq [true, 'test', %w(arg 1 2)] }
|
||||
end
|
||||
|
||||
context 'with mention for other bot' do
|
||||
let(:mention) { other_bot_name }
|
||||
it { should eq [false, 'message', [payload]] }
|
||||
end
|
||||
%w(message channel_post).each do |type|
|
||||
context "when payload is edited_#{type}" do
|
||||
let(:payload_type) { "edited_#{type}" }
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
end
|
||||
|
||||
context 'without text' do
|
||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||
context 'when payload is message' do
|
||||
let(:payload_type) { type }
|
||||
let(:payload) { {'text' => text} }
|
||||
let(:text) { 'test' }
|
||||
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
|
||||
context 'with command' do
|
||||
let(:text) { "/test#{"@#{mention}" if mention} arg 1 2" }
|
||||
let(:mention) {}
|
||||
it { should eq [true, 'test', %w(arg 1 2)] }
|
||||
|
||||
context 'with mention' do
|
||||
let(:mention) { bot.username }
|
||||
it { should eq [true, 'test', %w(arg 1 2)] }
|
||||
end
|
||||
|
||||
context 'with mention for other bot' do
|
||||
let(:mention) { other_bot_name }
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
end
|
||||
end
|
||||
|
||||
context 'without text' do
|
||||
let(:payload) { {'audio' => {'file_id' => 123}} }
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
custom_payload_types = %w(
|
||||
message
|
||||
edited_message
|
||||
channel_post
|
||||
edited_channel_post
|
||||
inline_query
|
||||
chosen_inline_result
|
||||
callback_query
|
||||
)
|
||||
(described_class::PAYLOAD_TYPES - custom_payload_types).each do |type|
|
||||
context "when payload is #{type}" do
|
||||
let(:payload_type) { type }
|
||||
it { should eq [false, payload_type, [payload]] }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,9 +1,39 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesPoller do
|
||||
describe '#initialize' do
|
||||
subject { described_class.new bot, controller }
|
||||
let(:bot) { double }
|
||||
let(:controller) { double }
|
||||
let(:instance) { described_class.new(bot, controller) }
|
||||
let(:bot) { Telegram::Bot::Client.new('token') }
|
||||
let(:controller) { double(:controller) }
|
||||
|
||||
describe '#initialize' do
|
||||
subject { instance }
|
||||
it { should be }
|
||||
end
|
||||
|
||||
describe '#fetch_updates' do
|
||||
subject { -> { instance.fetch_updates(&block) } }
|
||||
let(:block) { ->(x) { expect(x).to eq expected_results.shift } }
|
||||
let(:results) { [{update_id: 12}, {update_id: 34}] }
|
||||
let(:expected_results) { results.as_json }
|
||||
let(:request_result) { {ok: true, result: results}.as_json }
|
||||
before do
|
||||
allow(bot).to receive(:get_updates) do
|
||||
expect(bot.async).to be_falsy
|
||||
request_result
|
||||
end
|
||||
end
|
||||
|
||||
it { should change(instance, :offset).to(results.last[:update_id] + 1) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
|
||||
context 'with typed response' do
|
||||
let(:request_result) { results.as_json.map { |x| Telegram::Bot::Types::Update.new(x) } }
|
||||
let(:expected_results) { request_result.dup }
|
||||
it { should change(instance, :offset).to(results.last[:update_id] + 1) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
end
|
||||
|
||||
context 'when bot is in async mode' do
|
||||
let(:bot) { Telegram::Bot::Client.new('token', async: Class.new) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -2,25 +2,4 @@ RSpec.describe Telegram::Bot do
|
||||
it 'has a version number' do
|
||||
expect(described_class::VERSION).not_to be nil
|
||||
end
|
||||
|
||||
describe described_class::StaleChat do
|
||||
describe '.match_response?' do
|
||||
subject { ->(val) { described_class.match_response?(val) } }
|
||||
|
||||
it 'returns true for specific errors' do
|
||||
expect(subject.call({})).to eq false
|
||||
expect(subject.call('description' => 'test')).to eq false
|
||||
expect(subject.call('description' => 'Error: bot was kicked from')).to eq true
|
||||
expect(subject.call(
|
||||
'description' => "Forbidden: can't write to private chat with deleted user"
|
||||
)).to eq true
|
||||
expect(subject.call(
|
||||
'description' => 'Bad request: group chat is deactivated'
|
||||
)).to eq true
|
||||
expect(subject.call(
|
||||
'description' => 'Forbidden: Bot was blocked by the user'
|
||||
)).to eq true
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
|
||||
|
||||
spec.required_ruby_version = '~> 2.0'
|
||||
|
||||
spec.add_dependency 'activesupport', '>= 4.0', '< 5.1'
|
||||
spec.add_dependency 'actionpack', '>= 4.0', '< 5.1'
|
||||
spec.add_dependency 'activesupport', '>= 4.0', '< 5.2'
|
||||
spec.add_dependency 'actionpack', '>= 4.0', '< 5.2'
|
||||
spec.add_dependency 'httpclient', '~> 2.7'
|
||||
spec.add_development_dependency 'bundler', '~> 1.11'
|
||||
spec.add_development_dependency 'rake', '~> 10.0'
|
||||
|
||||
Ссылка в новой задаче
Block a user