зеркало из
https://github.com/glebtv/telegram-bot.git
synced 2026-08-28 15:26:18 +03:00
Сравнить коммиты
8 Коммитов
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
232eab1d5b | ||
|
|
9fe4c6bcae | ||
|
|
c04884040d | ||
|
|
225290b677 | ||
|
|
e03e39bd53 | ||
|
|
e767a65faa | ||
|
|
32b6794924 | ||
|
|
2a511abe16 |
@@ -8,9 +8,11 @@ Style/AlignParameters:
|
||||
# EnforcedStyle:
|
||||
# - with_first_parameter
|
||||
# - with_fixed_indentation
|
||||
Style/AndOr: {EnforcedStyle: conditionals}
|
||||
Style/ClosingParenthesisIndentation: {Enabled: false}
|
||||
Style/Documentation: {Enabled: false}
|
||||
Style/DotPosition: {EnforcedStyle: trailing}
|
||||
Style/FirstParameterIndentation: {EnforcedStyle: consistent}
|
||||
Style/IfUnlessModifier: {Enabled: false}
|
||||
Style/ModuleFunction: {Enabled: false}
|
||||
Style/MultilineOperationIndentation: {EnforcedStyle: indented}
|
||||
|
||||
7
CHANGELOG.md
Обычный файл
7
CHANGELOG.md
Обычный файл
@@ -0,0 +1,7 @@
|
||||
# 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.
|
||||
89
README.md
89
README.md
@@ -142,7 +142,7 @@ You can enable typecasting of `update` with `telegram-bot-types` by including
|
||||
|
||||
```ruby
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
include Telegram::Bot::UpdatesPoller::TypedUpdate
|
||||
include Telegram::Bot::UpdatesController::TypedUpdate
|
||||
|
||||
def message(message)
|
||||
message.class # => Telegram::Bot::Types::Message
|
||||
@@ -158,6 +158,9 @@ config.telegram_updates_controller.session_store = :redis_store, {expires_in: 1.
|
||||
|
||||
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
|
||||
|
||||
@@ -166,7 +169,7 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
end
|
||||
|
||||
def read
|
||||
session[:text]
|
||||
reply_with :message, text: session[:text]
|
||||
end
|
||||
|
||||
private
|
||||
@@ -180,6 +183,59 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
end
|
||||
```
|
||||
|
||||
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
|
||||
reply_with :message, text: 'What name do you like?'
|
||||
end
|
||||
|
||||
# register context handlers to handle this context
|
||||
context_handler :rename do |message|
|
||||
update_name message[:text]
|
||||
reply_with :message, text: 'Renamed!'
|
||||
end
|
||||
|
||||
# You can do it in other way:
|
||||
def rename(name = nil, *)
|
||||
if name
|
||||
update_name name
|
||||
reply_with :message, text: 'Renamed!'
|
||||
else
|
||||
save_context :rename
|
||||
reply_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
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
Use `telegram_webhooks` helper to add routes. It will create routes for bots
|
||||
@@ -215,13 +271,36 @@ call `.dispatch(bot, update)` on controller.
|
||||
|
||||
### Development & Debugging
|
||||
|
||||
Use `rake telegram:bot:poller BOT=chat` to run poller. It'll automatically load
|
||||
changes without restart in development env. This task will not if you don't use
|
||||
`telegram_webhooks`.
|
||||
Use `rake telegram:bot:poller` to run poller. It'll automatically load
|
||||
changes without restart in development env. Optionally specify bot to run poller for
|
||||
with `BOT` envvar (`BOT=chat`).
|
||||
|
||||
This task will not work if you don't use `telegram_webhooks`.
|
||||
You can run poller manually with
|
||||
`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
|
||||
|
||||
Use `rake telegram:bot:set_webhook` to update webhook url for all configured bots.
|
||||
|
||||
@@ -19,6 +19,9 @@ module Telegram
|
||||
when Hash then
|
||||
input = input.stringify_keys
|
||||
new input['token'], input['username']
|
||||
when Symbol
|
||||
Telegram.bots[input] or
|
||||
raise "Bot #{input} not configured, check Telegram.bots_config."
|
||||
else
|
||||
new(input)
|
||||
end
|
||||
@@ -104,7 +107,7 @@ module Telegram
|
||||
end
|
||||
|
||||
def inspect
|
||||
"#<Telegram::Bot::Client##{object_id}(#{@username})>"
|
||||
"#<#{self.class.name}##{object_id}(#{@username})>"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -4,6 +4,35 @@ module Telegram
|
||||
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
|
||||
# Makes all
|
||||
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
|
||||
|
||||
@@ -41,6 +41,13 @@ module Telegram
|
||||
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
|
||||
|
||||
@@ -15,7 +15,7 @@ module Telegram
|
||||
def call(env)
|
||||
update = env['action_dispatch.request.request_parameters']
|
||||
controller.dispatch(bot, update)
|
||||
[200, {}, '']
|
||||
[200, {}, ['']]
|
||||
end
|
||||
|
||||
def inspect
|
||||
|
||||
@@ -42,7 +42,9 @@ module Telegram
|
||||
# # You can override this options or specify others:
|
||||
# telegram_webhooks TelegramController, as: :my_webhook
|
||||
# telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
|
||||
# other_bot => [TelegramAuctionController,
|
||||
# other_bot => TelegramAuctionController,
|
||||
# admin_chat: TelegramAdminChatController
|
||||
#
|
||||
def telegram_webhooks(controllers, bots = nil, **options)
|
||||
unless controllers.is_a?(Hash)
|
||||
bots = bots ? Array.wrap(bots) : Telegram.bots.values
|
||||
|
||||
@@ -4,12 +4,59 @@ require 'active_support/version'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
# Base class to create update processors. With callbacks, session and helpers.
|
||||
#
|
||||
# Define public methods for each command and they will be called when
|
||||
# update has this command. Message is automatically parsed and
|
||||
# words are passed as method arguments. Be sure to use default values and
|
||||
# splat arguments in every action method to not get errors, when user
|
||||
# sends command without necessary args / with extra args.
|
||||
#
|
||||
# def start(token = nil, *)
|
||||
# if token
|
||||
# # ...
|
||||
# else
|
||||
# # ...
|
||||
# end
|
||||
# end
|
||||
#
|
||||
# def help(*)
|
||||
# reply_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)
|
||||
# reply_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
|
||||
abstract!
|
||||
|
||||
require 'telegram/bot/updates_controller/session'
|
||||
require 'telegram/bot/updates_controller/log_subscriber'
|
||||
require 'telegram/bot/updates_controller/instrumentation'
|
||||
autoload :MessageContext, 'telegram/bot/updates_controller/message_context'
|
||||
|
||||
include AbstractController::Callbacks
|
||||
# Redefine callbacks with default terminator.
|
||||
@@ -37,6 +84,7 @@ module Telegram
|
||||
CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
|
||||
|
||||
class << self
|
||||
# Initialize controller and process update.
|
||||
def dispatch(*args)
|
||||
new(*args).dispatch
|
||||
end
|
||||
@@ -59,7 +107,7 @@ module Telegram
|
||||
match = text.match CMD_REGEX
|
||||
return unless match
|
||||
return if match[3] && username != true && match[3] != username
|
||||
[match[1], text.split(' ').drop(1)]
|
||||
[match[1], text.split.drop(1)]
|
||||
end
|
||||
end
|
||||
|
||||
@@ -67,18 +115,39 @@ module Telegram
|
||||
alias_method :command?, :is_command
|
||||
delegate :username, to: :bot, prefix: true, allow_nil: true
|
||||
|
||||
# Second argument can be either update object with hash access & string
|
||||
# keys or Hash with `:from` or `:chat` to override this values and assume
|
||||
# that update is nil.
|
||||
def initialize(bot = nil, update = nil)
|
||||
if update.is_a?(Hash) && (update.key?(:from) || update.key?(:chat))
|
||||
options = update
|
||||
update = nil
|
||||
end
|
||||
@_update = update
|
||||
@_bot = bot
|
||||
@_chat, @_from = options && options.values_at(:chat, :from)
|
||||
|
||||
payload_data = nil
|
||||
update && PAYLOAD_TYPES.find do |type|
|
||||
item = update[type]
|
||||
next unless item
|
||||
@_payload = item
|
||||
@_payload_type = type
|
||||
payload_data = [item, type] if item
|
||||
end
|
||||
@_payload, @_payload_type = payload_data
|
||||
end
|
||||
|
||||
# Accessor to `'chat'` field of payload. 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
|
||||
@_is_command, action, args = action_for_payload
|
||||
process(action, *args)
|
||||
@@ -102,19 +171,32 @@ module Telegram
|
||||
def action_missing(*)
|
||||
end
|
||||
|
||||
%w(chat from).each do |field|
|
||||
define_method(field) { payload[field] }
|
||||
end
|
||||
|
||||
# Helper to call bot's `send_#{type}` method with already set `chat_id` and
|
||||
# `reply_to_message_id`:
|
||||
#
|
||||
# reply_with :message, text: 'Hello!'
|
||||
# reply_with :message, text: '__Hello!__', parse_mode: :Markdown
|
||||
# reply_with :photo, photo: File.open(photo_to_send), caption: "It's incredible!"
|
||||
def reply_with(type, params)
|
||||
method = "send_#{type}"
|
||||
chat = self.chat
|
||||
payload = self.payload
|
||||
params = params.merge(
|
||||
chat_id: chat['id'],
|
||||
reply_to_message: payload['message_id'],
|
||||
chat_id: (chat && chat['id'] or raise 'Can not reply_with when chat is not present'),
|
||||
reply_to_message: payload && payload['message_id'],
|
||||
)
|
||||
bot.public_send(method, 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
|
||||
|
||||
ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
|
||||
end
|
||||
end
|
||||
|
||||
102
lib/telegram/bot/updates_controller/message_context.rb
Обычный файл
102
lib/telegram/bot/updates_controller/message_context.rb
Обычный файл
@@ -0,0 +1,102 @@
|
||||
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.
|
||||
before_action :fetch_context
|
||||
singleton_class.send :attr_reader, :context_handlers, :context_to_action
|
||||
@context_handlers = {}
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
# Registers handler for context.
|
||||
#
|
||||
# context_handler :rename do |message|
|
||||
# resource.update!(name: message['text'])
|
||||
# end
|
||||
#
|
||||
# # To run other action with all the callbacks:
|
||||
# context_handler :rename do |message|
|
||||
# process(:rename, *m['text'].split)
|
||||
# end
|
||||
#
|
||||
# # Or just
|
||||
# context_handler :rename, :your_action_to_call
|
||||
# context_handler :rename # to call :rename
|
||||
#
|
||||
# # For messages without context use this instead of `message` method:
|
||||
# context_handle do |message|
|
||||
# end
|
||||
#
|
||||
def context_handler(context = nil, action = nil, &block)
|
||||
context &&= context.to_sym
|
||||
context_handlers[context] = block || 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
|
||||
|
||||
# Finds handler for current context and processes message with it.
|
||||
def message(message)
|
||||
handler = handler_for_context
|
||||
return unless handler
|
||||
if handler.respond_to?(:call)
|
||||
instance_exec(message, &handler)
|
||||
else
|
||||
process(handler, *message['text'].split)
|
||||
end
|
||||
end
|
||||
|
||||
# Action to clear context.
|
||||
def cancel
|
||||
# Context is already cleared in before_action
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Context is read from the session to treat messages
|
||||
# according to previous request.
|
||||
attr_reader :context
|
||||
|
||||
# Fetches and removes context from session.
|
||||
def fetch_context
|
||||
val = session.delete(:context)
|
||||
@context = val && val.to_sym
|
||||
true # TODO: remove in Rails 5.0
|
||||
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
|
||||
@@ -1,23 +1,29 @@
|
||||
require 'telegram/bot/updates_controller/testing'
|
||||
|
||||
RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||
let(:controller_class) { described_class }
|
||||
let(:instance) { controller_class.new(bot, update) }
|
||||
let(:update) { {payload_type => payload} }
|
||||
let(:payload_type) { 'some_type' }
|
||||
let(:controller) do
|
||||
controller_class.new(bot, update).tap do |x|
|
||||
x.extend Telegram::Bot::UpdatesController::Testing
|
||||
end
|
||||
end
|
||||
let(:update) { build_update(payload_type, payload) }
|
||||
let(:payload_type) { :some_type }
|
||||
let(:payload) { double(:payload) }
|
||||
let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
|
||||
let(:bot_name) { 'bot' }
|
||||
let(:session) do
|
||||
session = Telegram::Bot::UpdatesController::Session::TestSessionHash.new
|
||||
allow_any_instance_of(controller_class).to receive(:session) { session }
|
||||
session
|
||||
let(:session) { controller.send(:session) }
|
||||
|
||||
def dispatch(bot = self.bot, update = self.update)
|
||||
controller.dispatch_again(bot, update)
|
||||
end
|
||||
|
||||
def dispatch_message(text, options = {})
|
||||
payload = build_payload :message, options.merge(text: text)
|
||||
controller_class.dispatch bot, payload
|
||||
update = build_update :message, options.merge(text: text)
|
||||
dispatch bot, update
|
||||
end
|
||||
|
||||
def build_payload(type, content)
|
||||
def build_update(type, content)
|
||||
deep_stringify type => content
|
||||
end
|
||||
|
||||
|
||||
@@ -59,24 +59,16 @@ module Telegram
|
||||
end
|
||||
end
|
||||
|
||||
class TestSessionHash < 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
|
||||
|
||||
47
lib/telegram/bot/updates_controller/testing.rb
Обычный файл
47
lib/telegram/bot/updates_controller/testing.rb
Обычный файл
@@ -0,0 +1,47 @@
|
||||
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 ||= Testing::SessionHash.new
|
||||
end
|
||||
|
||||
class SessionHash < Session::SessionHash
|
||||
def initialize
|
||||
@data = {}
|
||||
@loaded = true
|
||||
@exists = true
|
||||
end
|
||||
|
||||
alias_method :destroy, :clear
|
||||
alias_method :load!, :id
|
||||
alias_method :commit, :id
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -4,7 +4,7 @@ module Telegram
|
||||
# Include this module to type cast update to Virtus model
|
||||
# using `telegram-bot-types` gem (install this gem first).
|
||||
module TypedUpdate
|
||||
def initialize(bot, update)
|
||||
def initialize(bot = nil, update = nil)
|
||||
update = Types::Update.new(update) if update && !update.is_a?(Types::Update)
|
||||
super
|
||||
end
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
VERSION = '0.4.1'.freeze
|
||||
VERSION = '0.5.0'.freeze
|
||||
|
||||
def self.gem_version
|
||||
Gem::Version.new VERSION
|
||||
|
||||
@@ -33,6 +33,17 @@ RSpec.describe Telegram::Bot::Client do
|
||||
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) }
|
||||
|
||||
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
|
||||
@@ -13,6 +13,6 @@ RSpec.describe Telegram::Bot::Middleware do
|
||||
subject
|
||||
end
|
||||
|
||||
it { should eq [200, {}, ''] }
|
||||
it { should eq [200, {}, ['']] }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -78,6 +78,7 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
{
|
||||
bot => controller,
|
||||
'custom_token' => [other_controller, as: :custom_route, option: :other_val],
|
||||
other: controller,
|
||||
},
|
||||
option: :val,
|
||||
]
|
||||
@@ -90,7 +91,8 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
other_controller,
|
||||
:custom_route,
|
||||
option: :other_val,
|
||||
]
|
||||
],
|
||||
[Telegram.bots[:other], controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
109
spec/telegram/bot/updates_controller/message_context_spec.rb
Обычный файл
109
spec/telegram/bot/updates_controller/message_context_spec.rb
Обычный файл
@@ -0,0 +1,109 @@
|
||||
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
|
||||
|
||||
context_handler do |*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, payload] }
|
||||
it { should_not change(controller, :filter_done) }
|
||||
it { should change { session[:context] }.to nil }
|
||||
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 }
|
||||
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 nil }
|
||||
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 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
|
||||
27
spec/telegram/bot/updates_controller/testing_spec.rb
Обычный файл
27
spec/telegram/bot/updates_controller/testing_spec.rb
Обычный файл
@@ -0,0 +1,27 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController::Testing do
|
||||
include_context 'telegram/bot/updates_controller'
|
||||
let(:controller_class) do
|
||||
Class.new(Telegram::Bot::UpdatesController) do
|
||||
attr_accessor :ivar
|
||||
end
|
||||
end
|
||||
|
||||
describe '#recycle!' do
|
||||
subject { -> { controller.recycle!(full) } }
|
||||
before do
|
||||
controller.ivar = :ival
|
||||
session[:key] = 'sval'
|
||||
end
|
||||
let(:full) {}
|
||||
|
||||
it { should_not change(controller, :ivar).from :ival }
|
||||
it { should_not change { controller.send(:session)[:key] }.from 'sval' }
|
||||
|
||||
context 'when full is true' do
|
||||
let(:full) { true }
|
||||
it { should change(controller, :ivar).from(:ival).to nil }
|
||||
it { should change { controller.instance_variable_defined?(:@ivar) }.to false }
|
||||
it { should_not change { controller.send(:session)[:key] }.from 'sval' }
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -8,7 +8,7 @@ RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate do
|
||||
end
|
||||
|
||||
context 'when `update` is a virtus model' do
|
||||
subject { instance }
|
||||
subject { controller }
|
||||
%w(
|
||||
message
|
||||
inline_query
|
||||
|
||||
@@ -78,7 +78,7 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
|
||||
describe '#action_for_payload' do
|
||||
subject { instance.action_for_payload }
|
||||
subject { controller.action_for_payload }
|
||||
|
||||
(described_class::PAYLOAD_TYPES - %w(message)).each do |type|
|
||||
context "when payload is #{type}" do
|
||||
@@ -113,7 +113,7 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
|
||||
context 'when `update` is a virtus model' do
|
||||
subject { instance }
|
||||
subject { controller }
|
||||
let(:update) { Telegram::Bot::Types::Update.new(super()) }
|
||||
%w(
|
||||
message
|
||||
@@ -131,7 +131,7 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
|
||||
describe '#bot_username' do
|
||||
subject { instance.bot_username }
|
||||
subject { controller.bot_username }
|
||||
|
||||
context 'when bot is not set' do
|
||||
let(:bot) {}
|
||||
@@ -144,18 +144,44 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
end
|
||||
|
||||
describe '#process_action' do
|
||||
subject { -> { instance.process_action(:action) } }
|
||||
describe '#process' do
|
||||
subject { -> { controller.process(:action, *args) } }
|
||||
let(:args) { [:arg1, :arg2] }
|
||||
let(:controller_class) do
|
||||
Class.new(described_class) do
|
||||
attr_reader :acted, :hooked
|
||||
|
||||
def action(*args)
|
||||
@acted = true
|
||||
[from, chat, args]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when action is protected' do
|
||||
before { controller_class.send :protected, :action }
|
||||
its(:call) { should eq nil }
|
||||
|
||||
context 'when action_missing defined' do
|
||||
before do
|
||||
controller.class_eval do
|
||||
protected
|
||||
|
||||
def action_missing(*args)
|
||||
args
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
its(:call) { should eq ['action', *args] }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when callbacks are defined' do
|
||||
let(:controller_class) do
|
||||
Class.new(described_class) do
|
||||
before_action :hook
|
||||
attr_reader :acted, :hooked
|
||||
|
||||
def action
|
||||
@acted = true
|
||||
end
|
||||
before do
|
||||
controller_class.class_eval do
|
||||
before_action :hook, only: :action
|
||||
attr_reader :hooked
|
||||
|
||||
private
|
||||
|
||||
@@ -165,8 +191,9 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
end
|
||||
|
||||
it { should change(instance, :hooked).to true }
|
||||
it { should change(instance, :acted).to true }
|
||||
it { should change(controller, :hooked).to true }
|
||||
it { should change(controller, :acted).to true }
|
||||
its(:call) { should eq [nil, nil, args] }
|
||||
|
||||
context 'when callback returns false' do
|
||||
before do
|
||||
@@ -178,8 +205,96 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end)
|
||||
end
|
||||
|
||||
it { should change(instance, :hooked).to true }
|
||||
it { should_not change(instance, :acted).from nil }
|
||||
it { should change(controller, :hooked).to true }
|
||||
it { should_not change(controller, :acted).from nil }
|
||||
its(:call) { should eq false }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when initialized without update' do
|
||||
let(:controller) { controller_class.new(bot, from: from, chat: chat) }
|
||||
let(:from) { {'id' => 'user_id'} }
|
||||
let(:chat) { {'id' => 'chat_id'} }
|
||||
its(:call) { should eq [from, chat, args] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#initialize' do
|
||||
subject { controller }
|
||||
let(:payload_type) { 'message' }
|
||||
let(:payload) { deep_stringify(chat: chat, from: from) }
|
||||
let(:chat) { double(:chat) }
|
||||
let(:from) { double(:from) }
|
||||
|
||||
def self.with_reinitialize(&block)
|
||||
instance_eval(&block)
|
||||
context 'when re-initialized' do
|
||||
let(:controller) do
|
||||
described_class.new(double(:other_bot), build_update(:message,
|
||||
text: 'original message',
|
||||
from: double(:original_from),
|
||||
chat: double(:original_chat),
|
||||
)).tap { |x| x.send(:initialize, bot, update) }
|
||||
end
|
||||
instance_eval(&block)
|
||||
end
|
||||
end
|
||||
|
||||
context 'when update is given' do
|
||||
with_reinitialize do
|
||||
its(:bot) { should eq bot }
|
||||
its(:update) { should eq update }
|
||||
its(:payload) { should eq payload }
|
||||
its(:payload_type) { should eq payload_type }
|
||||
its(:from) { should eq from }
|
||||
its(:chat) { should eq chat }
|
||||
end
|
||||
end
|
||||
|
||||
context 'when options hash is given' do
|
||||
let(:update) { {from: from, chat: chat} }
|
||||
with_reinitialize do
|
||||
its(:bot) { should eq bot }
|
||||
its(:update) { should eq nil }
|
||||
its(:payload) { should eq nil }
|
||||
its(:payload_type) { should eq nil }
|
||||
its(:from) { should eq from }
|
||||
its(:chat) { should eq chat }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#reply_with' do
|
||||
subject { controller.reply_with type, params }
|
||||
let(:params) { {arg: 1, 'other_arg' => 2} }
|
||||
let(:type) { :photo }
|
||||
let(:result) { double(:result) }
|
||||
let(:payload_type) { :message }
|
||||
let(:payload) { {message_id: double(:message_id)} }
|
||||
let(:chat) { {'id' => double(:chat_id)} }
|
||||
|
||||
it 'sets chat_id & reply_to_message' do
|
||||
expect(controller).to receive(:chat) { chat }
|
||||
expect(bot).to receive("send_#{type}").with(params.merge(
|
||||
chat_id: chat['id'],
|
||||
reply_to_message: payload[:message_id],
|
||||
)) { result }
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'when chat is missing' do
|
||||
let(:payload_type) { :some_type }
|
||||
it { expect { subject }.to raise_error(/chat/) }
|
||||
end
|
||||
|
||||
context 'when update is not set' do
|
||||
let(:update) { {chat: chat} }
|
||||
it 'sets chat_id & reply_to_message' do
|
||||
expect(bot).to receive("send_#{type}").with(params.merge(
|
||||
chat_id: chat['id'],
|
||||
reply_to_message: nil,
|
||||
)) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
Ссылка в новой задаче
Block a user