зеркало из
https://github.com/glebtv/telegram-bot.git
synced 2026-08-28 15:26:18 +03:00
Сравнить коммиты
37 Коммитов
| Автор | SHA1 | Дата | |
|---|---|---|---|
|
|
cd3d3739a4 | ||
|
|
a054ac704c | ||
|
|
23aa92e614 | ||
|
|
a49dca66fa | ||
|
|
2d5ca981ce | ||
|
|
cf9bd87cf2 | ||
|
|
48ff7a4f43 | ||
|
|
17260cb5a9 | ||
|
|
817af95369 | ||
|
|
99fbe41b16 | ||
|
|
88178113d7 | ||
|
|
1a2ac0dd83 | ||
|
|
fa6e385ca1 | ||
|
|
1098118826 | ||
|
|
0c9a4a5fa0 | ||
|
|
5c299887bb | ||
|
|
9f2234c132 | ||
|
|
ec1d5bad7d | ||
|
|
194fc78202 | ||
|
|
ececfa660e | ||
|
|
9e67122465 | ||
|
|
caee9809d0 | ||
|
|
4b511f51a7 | ||
|
|
d2d6202fa7 | ||
|
|
dd38cfea93 | ||
|
|
3cb6e930b8 | ||
|
|
e42a293804 | ||
|
|
2e405acfb1 | ||
|
|
b2eca2d37f | ||
|
|
6d687e459a | ||
|
|
71f736e0a2 | ||
|
|
85ff07de9b | ||
|
|
27602b20bd | ||
|
|
91e0aa2096 | ||
|
|
4e539e1867 | ||
|
|
33f0049f6e | ||
|
|
207754499e |
@@ -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
|
||||
|
||||
38
CHANGELOG.md
38
CHANGELOG.md
@@ -1,3 +1,41 @@
|
||||
# 0.11.3
|
||||
|
||||
- Release dependencies for Rails 5.1.
|
||||
|
||||
# 0.11.2
|
||||
|
||||
- Rails 5.1 deep symbolized secrets support.
|
||||
|
||||
# 0.11.1
|
||||
|
||||
- Fixed poller for typed response.
|
||||
|
||||
# 0.11.0
|
||||
|
||||
- Remove Bot::StaleChat in favor of Bot::Forbidden, as Telegram adds more
|
||||
and more new descriptions.
|
||||
Please open an issue if you face a problem.
|
||||
|
||||
# 0.10.2
|
||||
|
||||
- Support `(edited_)channel_post` updates.
|
||||
- New methods from 2.3, 2.3.1 API updates.
|
||||
|
||||
# 0.10.0
|
||||
|
||||
- Integration helpers for RSpec.
|
||||
- Fix for ruby 2.2.0 bug by @bob-frost.
|
||||
|
||||
# 0.9.0
|
||||
|
||||
- Async API requests.
|
||||
- One more description for StaleChat error.
|
||||
- edit_message_* methods.
|
||||
- API methods from 2016-10-03 update
|
||||
- Fix typo in module name: CallbackQueyContext -> CallbackQueryContext.
|
||||
- Take `chat` from `message` for callback queries
|
||||
- RSpec matchers.
|
||||
|
||||
# 0.8.0
|
||||
|
||||
- Fixed `#reply_with`, now it sets `reply_to_message_id` as it's supposed to.
|
||||
|
||||
8
Gemfile
8
Gemfile
@@ -2,8 +2,10 @@ source 'https://rubygems.org'
|
||||
gemspec
|
||||
|
||||
case ENV['RAILS']
|
||||
when '5_1'
|
||||
gem 'actionpack', '5.1.0'
|
||||
when '5'
|
||||
gem 'actionpack', '5.0.0.rc1'
|
||||
gem 'actionpack', '5.0.2'
|
||||
when '4'
|
||||
gem 'actionpack', '~> 4.2'
|
||||
end
|
||||
@@ -13,9 +15,9 @@ group :development do
|
||||
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 'rubocop', '~> 0.37.0'
|
||||
|
||||
97
README.md
97
README.md
@@ -5,7 +5,8 @@
|
||||
[](https://travis-ci.org/telegram-bot-rb/telegram-bot)
|
||||
|
||||
Tools for developing bot for Telegram. Best used with Rails, but can be be used in
|
||||
standalone app. Supposed to be used in webhook-mode in production, and poller-mode
|
||||
[standalone app](https://github.com/telegram-bot-rb/telegram-bot/wiki/Non-rails-application).
|
||||
Supposed to be used in webhook-mode in production, and poller-mode
|
||||
in development, but you can use poller in production if you want.
|
||||
|
||||
Package contains:
|
||||
@@ -16,11 +17,16 @@ Package contains:
|
||||
- Middleware and routes helpers for production env.
|
||||
- Poller with automatic source-reloader for development env.
|
||||
- Rake tasks to update webhook urls.
|
||||
- __[Async mode](#async-mode)__ for Telegram and/or Botan API.
|
||||
Let the queue adapter handle network errors!
|
||||
|
||||
Here is sample [telegram_bot_app](https://github.com/telegram-bot-rb/telegram_bot_app)
|
||||
with session, keyboards and inline queries.
|
||||
Run it on your local machine in 1 minute!
|
||||
|
||||
And here is [app teamplate](https://github.com/telegram-bot-rb/rails_template)
|
||||
to generate clean app in seconds.
|
||||
|
||||
## Installation
|
||||
|
||||
Add this line to your application's Gemfile:
|
||||
@@ -37,6 +43,12 @@ Or install it yourself as:
|
||||
|
||||
$ gem install telegram-bot
|
||||
|
||||
Require if necessary:
|
||||
|
||||
```ruby
|
||||
require 'telegram/bot'
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Configuration
|
||||
@@ -94,7 +106,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
|
||||
|
||||
@@ -130,6 +142,7 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
# do_smth_with(data)
|
||||
|
||||
# There are `chat` & `from` shortcut methods.
|
||||
# For callback queries `chat` if taken from `message` when it's available.
|
||||
response = from ? "Hello #{from['username']}!" : 'Hi there!'
|
||||
# There is `respond_with` helper to set `chat_id` from received message:
|
||||
respond_with :message, text: response
|
||||
@@ -244,7 +257,7 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
end
|
||||
```
|
||||
|
||||
You can use `CallbackQueyContext` in the similar way to split `#callback_query` into
|
||||
You can use `CallbackQueryContext` 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
|
||||
@@ -319,18 +332,51 @@ 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 }
|
||||
# ...
|
||||
end
|
||||
```
|
||||
|
||||
There are also some helpers for controller tests.
|
||||
Check out `telegram/bot/updates_controller/rspec_helpers` and
|
||||
`telegram/bot/updates_controller/testing`.
|
||||
There are integration and controller contexts for RSpec and some built-in matchers:
|
||||
|
||||
```ruby
|
||||
# spec/requests/telegram_webhooks_spec.rb
|
||||
require 'telegram/bot/rspec/integration'
|
||||
|
||||
RSpec.describe TelegramWebhooksController, :telegram_bot do
|
||||
# for old rspec add:
|
||||
# include_context 'telegram/bot/integration'
|
||||
|
||||
describe '#start' do
|
||||
subject { -> { dispatch_command :start } }
|
||||
it { should respond_with_message 'Hi there!' }
|
||||
end
|
||||
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'))
|
||||
```
|
||||
|
||||
See sample app for more examples.
|
||||
|
||||
### Deploying
|
||||
|
||||
@@ -352,11 +398,11 @@ or just add `botan` key in `secrets.yml`:
|
||||
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`:
|
||||
There are some helpers for controllers in `Telegram::Bot::Botan::ControllerHelpers`:
|
||||
|
||||
```ruby
|
||||
class Telegram::WebhookController < Telegram::Bot::UpdatesController
|
||||
include Telegram::Bot::UpdatesController::Botan
|
||||
include Telegram::Bot::Botan::ControllerHelpers
|
||||
|
||||
# This will track with event: action_name & data: payload
|
||||
before_action :botan_track_action
|
||||
@@ -373,6 +419,37 @@ end
|
||||
|
||||
There is no stubbing for botan clients, so don't set botan token in tests.
|
||||
|
||||
### Async mode
|
||||
|
||||
There is built in support for async requests using ActiveJob. Without Rails
|
||||
you can implement your own worker class to handle such requests. This allows:
|
||||
|
||||
- Process updates very fast, without waiting for telegram and botan responses.
|
||||
- Handle and retry network and other errors with queue adapter.
|
||||
- ???
|
||||
|
||||
Instead of performing request instantly client serializes it, pushes to queue,
|
||||
and immediately return control back. The job is then fetched with a worker
|
||||
and real API request is performed. And this all is absolutely transparent for the app.
|
||||
|
||||
To enable this mode add `async: true` to bot's and botan's config.
|
||||
For more information and custom configuration check out
|
||||
[docs](http://www.rubydoc.info/github/telegram-bot-rb/telegram-bot/master/Telegram/Bot/Async) or
|
||||
[source](https://github.com/telegram-bot-rb/telegram-bot/blob/master/lib/telegram/bot/async.rb).
|
||||
|
||||
If you want async mode, but don't want to setup queue, know that Rails 5 are shipped
|
||||
with Async adapter by default, and there is
|
||||
[Sucker Punch](https://github.com/brandonhilkert/sucker_punch) for Rails 4.
|
||||
|
||||
Be aware of some limitations:
|
||||
|
||||
- Client will not return API response.
|
||||
- Sending files is not available in async mode [now],
|
||||
because them can not be serialized.
|
||||
|
||||
To disable async mode for the block of code use `bot.async(false) { bot.send_photo }`.
|
||||
Yes, it's threadsafe too.
|
||||
|
||||
## Development
|
||||
|
||||
After checking out the repo, run `bin/setup` to install dependencies.
|
||||
|
||||
@@ -6,30 +6,16 @@ module Telegram
|
||||
module Bot
|
||||
class Error < StandardError; end
|
||||
class NotFound < Error; end
|
||||
class Forbidden < 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 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
|
||||
|
||||
autoload :Async, 'telegram/bot/async'
|
||||
autoload :Botan, 'telegram/bot/botan'
|
||||
autoload :Client, 'telegram/bot/client'
|
||||
autoload :ClientStub, 'telegram/bot/client_stub'
|
||||
autoload :DebugClient, 'telegram/bot/debug_client'
|
||||
autoload :Initializers, 'telegram/bot/initializers'
|
||||
autoload :Middleware, 'telegram/bot/middleware'
|
||||
autoload :RSpec, 'telegram/bot/rspec'
|
||||
autoload :UpdatesController, 'telegram/bot/updates_controller'
|
||||
autoload :UpdatesPoller, 'telegram/bot/updates_poller'
|
||||
end
|
||||
|
||||
162
lib/telegram/bot/async.rb
Обычный файл
162
lib/telegram/bot/async.rb
Обычный файл
@@ -0,0 +1,162 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
# Telegram & Botan clients can perform requests in async way with
|
||||
# any job adapter (ActiveJob by default). Using Rails you don't need any
|
||||
# additional configuration. However you may want to enable async requests
|
||||
# by default with `async: true` in `secrets.yml`. Botan client doesn't inherit
|
||||
# async setting from client and must be configured separately.
|
||||
#
|
||||
# telegram:
|
||||
# bots:
|
||||
# chat_async:
|
||||
# token: secret
|
||||
# async: true # enable async mode for client
|
||||
# botan: botan_token # in this way botan will not be async
|
||||
# botan: # in this way - it's in async mode
|
||||
# token: botan_token
|
||||
# async: true
|
||||
#
|
||||
# Without Rails To start using async requests
|
||||
# initialize client with `id` kwarg and make sure the client is
|
||||
# accessible via `Teletgram.bots[id]` in job worker. Or just use
|
||||
# `Telegram.bots_config=` for configuration.
|
||||
#
|
||||
# Being in async mode `#request` enqueues job instead to perform
|
||||
# http request instead of performing it directly.
|
||||
# Async behavior is controlled with `#async=` writer
|
||||
# and can be enabled/disabled for the block with `#async`:
|
||||
#
|
||||
# client = Telegram::Bot::Client.new(**config, async: true)
|
||||
# client.send_message(message)
|
||||
# client.async(false) { client.send_message(other_one) }
|
||||
#
|
||||
# `#async=` sets global value for all threads,
|
||||
# while `#async(val, &block)` is thread-safe.
|
||||
#
|
||||
# It can be set with custom job class or classname. By default it defines
|
||||
# job classes for every client class, inherited from ApplicationRecord, which
|
||||
# can be accessed via `.default_async_job`. You can integrate it with any
|
||||
# other job provider by defining a class with `.perform_later(bot_id, *args)`
|
||||
# method. See Async::Job for implemetation.
|
||||
module Async
|
||||
# Used to track missing key in a hash in local variable.
|
||||
MISSING_VALUE = Object.new.freeze
|
||||
|
||||
module Job
|
||||
class << self
|
||||
def included(base)
|
||||
base.singleton_class.send :attr_accessor, :client_class
|
||||
end
|
||||
end
|
||||
|
||||
def perform(client_id, *args)
|
||||
client = self.class.client_class.wrap(client_id.to_sym)
|
||||
client.async(false) { client.request(*args) }
|
||||
end
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
def default_async_job
|
||||
@default_async_job ||= begin
|
||||
begin
|
||||
ApplicationJob
|
||||
rescue NameError
|
||||
raise 'Define ApplicationJob class or setup #async= with custom job class'
|
||||
end
|
||||
klass = Class.new(ApplicationJob) { include Job }
|
||||
klass.client_class = self
|
||||
const_set(:AsyncJob, klass)
|
||||
end
|
||||
end
|
||||
|
||||
# This is used in specs.
|
||||
def default_async_job=(val)
|
||||
@default_async_job = val
|
||||
remove_const(:AsyncJob) if const_defined?(:AsyncJob, false)
|
||||
end
|
||||
|
||||
# Prepares argments for async job. ActiveJob doesn't support
|
||||
# Symbol in argumens. Also we can encode json bodies only once here,
|
||||
# so it would not be unnecessarily serialized-deserialized.
|
||||
#
|
||||
# This is stub method, which returns input. Every client class
|
||||
# must prepare args itself.
|
||||
def prepare_async_args(*args)
|
||||
args
|
||||
end
|
||||
|
||||
# Returns default_async_job if `true` is given,
|
||||
# treats String as a constant name, or bypasses any other values.
|
||||
def prepare_async_val(val)
|
||||
case val
|
||||
when true then default_async_job
|
||||
when String then Object.const_get(val)
|
||||
else val
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
class << self
|
||||
def prepended(base)
|
||||
base.extend(ClassMethods)
|
||||
end
|
||||
|
||||
# Transforms symbols to strings in hash values.
|
||||
def prepare_hash(hash)
|
||||
return hash unless hash.is_a?(Hash)
|
||||
hash = hash.dup
|
||||
hash.each { |key, val| hash[key] = val.to_s if val.is_a?(Symbol) }
|
||||
end
|
||||
|
||||
# Thread-local hash to store async config for every client.
|
||||
def thread_store
|
||||
Thread.current[:telegram_bot_async] ||= {}
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :id
|
||||
|
||||
def initialize(*, id: nil, async: nil, **options)
|
||||
@id = id
|
||||
self.async = async
|
||||
super
|
||||
end
|
||||
|
||||
# Sets default async value for all threads.
|
||||
# Uses `self.class.prepare_async_val` to prepare value.
|
||||
def async=(val)
|
||||
@async = self.class.prepare_async_val(val)
|
||||
end
|
||||
|
||||
# Sets async value in a thread-safe way for the block.
|
||||
# Uses `self.class.prepare_async_val` to prepare value.
|
||||
#
|
||||
# If no block is given returns previously set value or the global one,
|
||||
# set by #async=.
|
||||
def async(val = true)
|
||||
thread_key = object_id
|
||||
thread_store = Async.thread_store
|
||||
return thread_store.fetch(thread_key) { @async } unless block_given?
|
||||
begin
|
||||
old_val = thread_store.fetch(thread_key) { MISSING_VALUE }
|
||||
thread_store[thread_key] = self.class.prepare_async_val(val)
|
||||
yield
|
||||
ensure
|
||||
if MISSING_VALUE == old_val
|
||||
thread_store.delete(thread_key)
|
||||
else
|
||||
thread_store[thread_key] = old_val
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Uses job if #async is set.
|
||||
def request(*args)
|
||||
job_class = async
|
||||
return super unless job_class
|
||||
raise 'Can not enqueue job without client id' unless id
|
||||
job_class.perform_later(id.to_s, *self.class.prepare_async_args(*args))
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -3,24 +3,37 @@ module Telegram
|
||||
class Botan
|
||||
TRACK_URI = 'https://api.botan.io/track'.freeze
|
||||
|
||||
autoload :ClientHelpers, 'telegram/bot/botan/client_helpers'
|
||||
autoload :ControllerHelpers, 'telegram/bot/botan/controller_helpers'
|
||||
class Error < Bot::Error; end
|
||||
|
||||
extend Initializers
|
||||
prepend Async
|
||||
include DebugClient
|
||||
|
||||
class << self
|
||||
def by_id(id)
|
||||
Telegram.botans[id]
|
||||
end
|
||||
|
||||
def prepare_async_args(method, uri, query = {}, body = nil)
|
||||
[method.to_s, uri.to_s, Async.prepare_hash(query), body]
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :client, :token
|
||||
|
||||
def initialize(token)
|
||||
def initialize(token = nil, **options)
|
||||
@client = HTTPClient.new
|
||||
@token = token
|
||||
@token = token || options[:token]
|
||||
end
|
||||
|
||||
def track(event, uid, payload = {})
|
||||
res = http_request(
|
||||
:post,
|
||||
TRACK_URI,
|
||||
{token: token, name: event, uid: uid},
|
||||
payload.to_json,
|
||||
)
|
||||
request(:post, TRACK_URI, {name: event, uid: uid}, payload.to_json)
|
||||
end
|
||||
|
||||
def request(method, uri, query = {}, body = nil)
|
||||
res = http_request(method, uri, query.merge(token: token), body)
|
||||
status = res.status
|
||||
return JSON.parse(res.body) if 300 > status
|
||||
result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
|
||||
@@ -31,6 +44,10 @@ module Telegram
|
||||
def http_request(method, uri, query, body)
|
||||
client.request(method, uri, query, body)
|
||||
end
|
||||
|
||||
def inspect
|
||||
"#<#{self.class.name}##{object_id}(#{@id})>"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
15
lib/telegram/bot/botan/client_helpers.rb
Обычный файл
15
lib/telegram/bot/botan/client_helpers.rb
Обычный файл
@@ -0,0 +1,15 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class Botan
|
||||
# Helpers for botan.io metrics.
|
||||
module ClientHelpers
|
||||
attr_reader :botan
|
||||
|
||||
def initialize(*, botan: nil, **options)
|
||||
super
|
||||
@botan = Botan.wrap(botan, id: id) if botan
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,8 +1,8 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
class UpdatesController
|
||||
class Botan
|
||||
# Helpers for botan.io metrics.
|
||||
module Botan
|
||||
module ControllerHelpers
|
||||
class MissingFrom < Error; end
|
||||
|
||||
protected
|
||||
@@ -2,7 +2,6 @@ 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
|
||||
@@ -10,23 +9,14 @@ module Telegram
|
||||
URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
|
||||
|
||||
autoload :TypedResponse, 'telegram/bot/client/typed_response'
|
||||
extend Initializers
|
||||
prepend Async
|
||||
prepend Botan::ClientHelpers
|
||||
include DebugClient
|
||||
|
||||
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
|
||||
def by_id(id)
|
||||
Telegram.bots[id]
|
||||
end
|
||||
|
||||
# Prepend TypedResponse module.
|
||||
@@ -41,35 +31,45 @@ module Telegram
|
||||
body[k] = val.to_json if val.is_a?(Hash) || val.is_a?(Array)
|
||||
end
|
||||
end
|
||||
|
||||
def prepare_async_args(action, body = {})
|
||||
[action.to_s, Async.prepare_hash(prepare_body(body))]
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :client, :token, :username, :base_uri, :botan
|
||||
attr_reader :client, :token, :username, :base_uri
|
||||
|
||||
def initialize(token, username = nil, botan: nil)
|
||||
def initialize(token = nil, username = nil, **options)
|
||||
@client = HTTPClient.new
|
||||
@token = token
|
||||
@username = username
|
||||
@base_uri = format URL_TEMPLATE, token
|
||||
@botan = Botan.new(botan) if botan
|
||||
@token = token || options[:token]
|
||||
@username = username || options[:username]
|
||||
@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
|
||||
forwardMessage
|
||||
getChat
|
||||
getChatAdministrators
|
||||
@@ -77,7 +77,6 @@ module Telegram
|
||||
getChatMembersCount
|
||||
getFile
|
||||
getMe
|
||||
getUpdates
|
||||
getUserProfilePhotos
|
||||
kickChatMember
|
||||
leaveChat
|
||||
@@ -92,8 +91,17 @@ module Telegram
|
||||
sendVenue
|
||||
sendVideo
|
||||
sendVoice
|
||||
setWebhook
|
||||
unbanChatMember
|
||||
|
||||
editMessageCaption
|
||||
editMessageReplyMarkup
|
||||
editMessageText
|
||||
|
||||
answerInlineQuery
|
||||
|
||||
getGameHighScores
|
||||
sendGame
|
||||
setGameScore
|
||||
).each do |method|
|
||||
define_method(method.underscore) { |*args| request(method, *args) }
|
||||
end
|
||||
|
||||
@@ -9,7 +9,7 @@ module Telegram
|
||||
if self == ClientStub || !ClientStub.stub_all?
|
||||
super
|
||||
else
|
||||
ClientStub.new(args[1])
|
||||
ClientStub.new(*args)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -34,8 +34,8 @@ module Telegram
|
||||
end
|
||||
end
|
||||
|
||||
def initialize(username = nil)
|
||||
@username = username
|
||||
def initialize(token = nil, username = nil, **options)
|
||||
@username = username || options[:username] || token
|
||||
reset
|
||||
end
|
||||
|
||||
@@ -43,7 +43,7 @@ module Telegram
|
||||
@requests = Hash.new { |h, k| h[k] = [] }
|
||||
end
|
||||
|
||||
def request(action, body)
|
||||
def request(action, body = {})
|
||||
requests[action.to_sym] << body
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
require 'active_support/core_ext/hash/keys'
|
||||
require 'active_support/core_ext/hash/transform_values'
|
||||
require 'active_support/core_ext/hash/indifferent_access'
|
||||
|
||||
module Telegram
|
||||
module Bot
|
||||
@@ -20,13 +21,15 @@ 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
|
||||
|
||||
# Hash of bots made with bots_config.
|
||||
def bots
|
||||
@bots ||= bots_config.transform_values(&Client.method(:wrap))
|
||||
@bots ||= bots_config.each_with_object({}) do |(id, config), h|
|
||||
h[id] = Client.wrap(config, id: id)
|
||||
end
|
||||
end
|
||||
|
||||
# Default bot.
|
||||
@@ -34,17 +37,27 @@ module Telegram
|
||||
@bot ||= bots[:default]
|
||||
end
|
||||
|
||||
# Hash of botan clients made from #bots.
|
||||
def botans
|
||||
@botans ||= bots.transform_values(&:botan)
|
||||
end
|
||||
|
||||
# Returns config for .bots method. By default uses `telegram['bots']` section
|
||||
# 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
|
||||
@bots_config ||=
|
||||
if defined?(Rails.application)
|
||||
secrets = Rails.application.secrets.
|
||||
fetch(:telegram, {}).with_indifferent_access
|
||||
secrets.fetch(:bots, {}).symbolize_keys.tap do |config|
|
||||
default = secrets[:bot]
|
||||
config[:default] = default if default
|
||||
end
|
||||
else
|
||||
{}
|
||||
end
|
||||
end
|
||||
|
||||
# Resets all cached bots and their configs.
|
||||
@@ -52,6 +65,7 @@ module Telegram
|
||||
@bots = nil
|
||||
@bot = nil
|
||||
@bots_config = nil
|
||||
@botans = nil
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
19
lib/telegram/bot/initializers.rb
Обычный файл
19
lib/telegram/bot/initializers.rb
Обычный файл
@@ -0,0 +1,19 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
module Initializers
|
||||
# Accepts different options to initialize bot.
|
||||
def wrap(input, **options)
|
||||
case input
|
||||
when Symbol then by_id(input) or raise "#{name} #{input.inspect} not configured"
|
||||
when self then input
|
||||
when Hash then new(**input.symbolize_keys, **options)
|
||||
else new(input, **options)
|
||||
end
|
||||
end
|
||||
|
||||
def by_id(_id)
|
||||
raise 'Not implemented'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -20,7 +20,7 @@ module Telegram
|
||||
# Replaces colon with underscore so rails don't treat it as
|
||||
# route parameter.
|
||||
def escape_token(token)
|
||||
token.tr(':', '_')
|
||||
token && token.tr(':', '_')
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
7
lib/telegram/bot/rspec.rb
Обычный файл
7
lib/telegram/bot/rspec.rb
Обычный файл
@@ -0,0 +1,7 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
module RSpec
|
||||
autoload :ClientMatchers, 'telegram/bot/rspec/client_matchers'
|
||||
end
|
||||
end
|
||||
end
|
||||
151
lib/telegram/bot/rspec/client_matchers.rb
Обычный файл
151
lib/telegram/bot/rspec/client_matchers.rb
Обычный файл
@@ -0,0 +1,151 @@
|
||||
module Telegram
|
||||
module Bot
|
||||
module RSpec
|
||||
# Proxy that uses RSpec::Mocks::ArgListMatcher when it's available.
|
||||
# Otherwise just performs `#==` match.
|
||||
#
|
||||
# Also allows to check argumets with custom block.
|
||||
class ArgListMatcher
|
||||
attr_reader :expected, :expected_proc
|
||||
|
||||
def initialize(*args, &block)
|
||||
@expected_proc = block if block_given?
|
||||
@expected =
|
||||
if mocks_matcher?
|
||||
::RSpec::Mocks::ArgumentListMatcher.new(*args)
|
||||
else
|
||||
args
|
||||
end
|
||||
end
|
||||
|
||||
def args_match?(*actual)
|
||||
if expected_proc
|
||||
expected_proc[*actual]
|
||||
true
|
||||
elsif mocks_matcher?
|
||||
expected.args_match?(*actual)
|
||||
else
|
||||
expected == actual
|
||||
end
|
||||
end
|
||||
|
||||
def args
|
||||
mocks_matcher? ? expected.args : expected
|
||||
end
|
||||
|
||||
def mocks_matcher?
|
||||
defined?(::RSpec::Mocks::ArgumentListMatcher)
|
||||
end
|
||||
|
||||
def to_s
|
||||
if mocks_matcher?
|
||||
expected.expected_args.inspect
|
||||
elsif expected_proc
|
||||
'(proc matcher)'
|
||||
else
|
||||
expected.inspect
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Matchers to test requests to Telegram API.
|
||||
#
|
||||
# Complex matchers requires `rspec-mocks` to be installed.
|
||||
module ClientMatchers
|
||||
class MakeTelegramRequest < ::RSpec::Matchers::BuiltIn::BaseMatcher
|
||||
EXPECTATION_TYPES = {
|
||||
exactly: :==,
|
||||
at_most: :>=,
|
||||
at_least: :<=,
|
||||
}.freeze
|
||||
|
||||
attr_reader :performed_requests, :description
|
||||
|
||||
def initialize(bot, action, description: nil)
|
||||
@bot = bot
|
||||
@action = action
|
||||
@description = description || "make #{action} telegram request"
|
||||
exactly(1)
|
||||
end
|
||||
|
||||
def matches?(proc) # rubocop:disable AbcSize
|
||||
raise ArgumentError, 'matcher only supports block expectations' unless proc.is_a?(Proc)
|
||||
original_requests_count = bot.requests[action].count
|
||||
proc.call
|
||||
@performed_requests = bot.requests[action].drop(original_requests_count)
|
||||
@matching_requests_count = performed_requests.count do |request|
|
||||
!arg_list_matcher || arg_list_matcher.args_match?(request)
|
||||
end
|
||||
expectation_method = EXPECTATION_TYPES[expectation_type]
|
||||
expected_number.public_send(expectation_method, matching_requests_count)
|
||||
end
|
||||
|
||||
def with(*args, &block)
|
||||
@arg_list_matcher = ArgListMatcher.new(*args, &block)
|
||||
self
|
||||
end
|
||||
|
||||
EXPECTATION_TYPES.each_key do |type|
|
||||
define_method type do |count|
|
||||
@expectation_type = type
|
||||
@expected_number = Integer(count)
|
||||
self
|
||||
end
|
||||
end
|
||||
|
||||
def times
|
||||
self
|
||||
end
|
||||
|
||||
def failure_message
|
||||
"expected to #{base_message}"
|
||||
end
|
||||
|
||||
def failure_message_when_negated
|
||||
"expected not to #{base_message}"
|
||||
end
|
||||
|
||||
def supports_block_expectations?
|
||||
true
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
attr_reader :bot, :action, :expectation_type, :expected_number,
|
||||
:arg_list_matcher, :matching_requests_count
|
||||
|
||||
def base_message
|
||||
"make #{expectation_type.to_s.tr('_', ' ')} #{expected_number} " \
|
||||
"#{bot.inspect}.#{action} requests,".tap do |msg|
|
||||
msg << " with #{arg_list_matcher}," if arg_list_matcher
|
||||
msg << " but made #{matching_requests_count}"
|
||||
if performed_requests
|
||||
actual_args = performed_requests.map(&:inspect).join(', ')
|
||||
msg << ", and #{performed_requests.count} with #{actual_args}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Check that bot performed request to telegram API:
|
||||
#
|
||||
# expect { dispatch_message('Hi!') }.
|
||||
# to make_telegram_request(bot, :sendMessage).
|
||||
# with(text: 'Hello!', chat_id: chat_id)
|
||||
def make_telegram_request(bot, action)
|
||||
MakeTelegramRequest.new(bot, action)
|
||||
end
|
||||
|
||||
# Helper for asserting message is sent. Note that options are checked
|
||||
# with `hash_including`. For strict checks use #make_telegram_request.
|
||||
def send_telegram_message(bot, text = nil, options = {})
|
||||
description = "send telegram message #{text.inspect}"
|
||||
text = a_string_matching(text) if text.is_a?(Regexp)
|
||||
options = options.merge(text: text) if text
|
||||
MakeTelegramRequest.new(bot, :sendMessage, description: description).
|
||||
with(hash_including(options))
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
49
lib/telegram/bot/rspec/integration.rb
Обычный файл
49
lib/telegram/bot/rspec/integration.rb
Обычный файл
@@ -0,0 +1,49 @@
|
||||
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.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)
|
||||
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.configure do |config|
|
||||
if config.respond_to?(:include_context)
|
||||
config.include_context 'telegram/bot/integration', :telegram_bot
|
||||
end
|
||||
end
|
||||
@@ -57,9 +57,8 @@ module Telegram
|
||||
require 'telegram/bot/updates_controller/log_subscriber'
|
||||
require 'telegram/bot/updates_controller/instrumentation'
|
||||
require 'telegram/bot/updates_controller/reply_helpers'
|
||||
autoload :CallbackQueyContext, 'telegram/bot/updates_controller/callback_query_context'
|
||||
autoload :CallbackQueryContext, '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.
|
||||
@@ -81,10 +80,12 @@ module Telegram
|
||||
|
||||
PAYLOAD_TYPES = %w(
|
||||
message
|
||||
edited_message
|
||||
channel_post
|
||||
edited_channel_post
|
||||
inline_query
|
||||
chosen_inline_result
|
||||
callback_query
|
||||
edited_message
|
||||
).freeze
|
||||
CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
|
||||
CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
|
||||
@@ -141,10 +142,12 @@ module Telegram
|
||||
@_payload, @_payload_type = payload_data
|
||||
end
|
||||
|
||||
# Accessor to `'chat'` field of payload. Can be overriden with `chat` option
|
||||
# for #initialize.
|
||||
# Accessor to `'chat'` field of payload. Also tries `'chat'` in `'message'`
|
||||
# when there is no such field in payload.
|
||||
#
|
||||
# Can be overriden with `chat` option for #initialize.
|
||||
def chat
|
||||
@_chat ||= payload && payload['chat']
|
||||
@_chat ||= payload.try! { |x| x['chat'] || x['message'] && x['message']['chat'] }
|
||||
end
|
||||
|
||||
# Accessor to `'from'` field of payload. Can be overriden with `from` option
|
||||
@@ -180,11 +183,13 @@ module Telegram
|
||||
cmd &&= self.class.action_for_command(cmd)
|
||||
[true, cmd, args] if cmd
|
||||
end
|
||||
alias_method :action_for_channel_post, :action_for_message
|
||||
|
||||
# It doesn't extract commands from edited messages. Just process
|
||||
# them as usual ones.
|
||||
def action_for_edited_message
|
||||
end
|
||||
alias_method :action_for_edited_channel_post, :action_for_edited_message
|
||||
|
||||
def action_for_inline_query
|
||||
[false, payload_type, [payload['query'], payload['offset']]]
|
||||
|
||||
@@ -3,7 +3,7 @@ module Telegram
|
||||
class UpdatesController
|
||||
# Use separate actions for different callback queries.
|
||||
# It doesn't require session support. Simply add `%{context}:` prefix to data.
|
||||
module CallbackQueyContext
|
||||
module CallbackQueryContext
|
||||
protected
|
||||
|
||||
# Uses #context_from_callback_query as context name.
|
||||
|
||||
@@ -13,13 +13,18 @@ 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
|
||||
|
||||
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)
|
||||
update = build_update :message, default_message_options.merge(options).merge(text: text)
|
||||
dispatch bot, update
|
||||
end
|
||||
|
||||
@@ -34,4 +39,15 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
|
||||
else input
|
||||
end
|
||||
end
|
||||
|
||||
# Matcher to check response. Make sure to define `let(:chat_id)`.
|
||||
def respond_with_message(expected)
|
||||
send_telegram_message(bot, expected, chat_id: chat_id)
|
||||
end
|
||||
end
|
||||
|
||||
RSpec.configure do |config|
|
||||
if config.respond_to?(:include_context)
|
||||
config.include_context 'telegram/bot/updates_controller', type: :telegram_bot_controller
|
||||
end
|
||||
end
|
||||
|
||||
@@ -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)
|
||||
@@ -64,15 +64,17 @@ module Telegram
|
||||
end
|
||||
|
||||
def fetch_updates
|
||||
response = bot.get_updates(offset: offset, timeout: timeout)
|
||||
return unless response['ok'] && response['result'].any?
|
||||
response = bot.async(false) { bot.get_updates(offset: offset, timeout: timeout) }
|
||||
updates = response.is_a?(Array) ? response : response['result']
|
||||
return unless updates && updates.any?
|
||||
reload! do
|
||||
response['result'].each do |update|
|
||||
updates.each do |update|
|
||||
@offset = update['update_id'] + 1
|
||||
yield update
|
||||
end
|
||||
end
|
||||
rescue Timeout::Error # rubocop:disable HandleExceptions
|
||||
rescue Timeout::Error
|
||||
log { 'Fetch timeout' }
|
||||
end
|
||||
|
||||
def reload!
|
||||
@@ -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.8.0'.freeze
|
||||
VERSION = '0.11.3'.freeze
|
||||
|
||||
def self.gem_version
|
||||
Gem::Version.new VERSION
|
||||
|
||||
@@ -16,6 +16,9 @@ $LOAD_PATH.unshift GEM_ROOT.join('lib')
|
||||
require 'telegram/bot'
|
||||
require 'telegram/bot/updates_controller/rspec_helpers'
|
||||
require 'telegram/bot/types'
|
||||
require 'active_support/core_ext/object/json'
|
||||
|
||||
Dir[GEM_ROOT.join('spec/support/**/*.rb')].each { |f| require f }
|
||||
|
||||
RSpec.configure do |config|
|
||||
config.expect_with :rspec do |expectations|
|
||||
|
||||
143
spec/support/examples/async.rb
Обычный файл
143
spec/support/examples/async.rb
Обычный файл
@@ -0,0 +1,143 @@
|
||||
RSpec.shared_examples 'async' do |request_args: -> {}|
|
||||
let(:instance) { described_class.new(token: token, id: id, async: async) }
|
||||
let(:id) { :default_bot }
|
||||
let(:async) { true }
|
||||
let!(:application_job_class) do
|
||||
klass = Class.new do
|
||||
def self.perform_later(*)
|
||||
end
|
||||
end
|
||||
klass.tap { |x| stub_const('ApplicationJob', x) }
|
||||
end
|
||||
after { described_class.default_async_job = nil }
|
||||
|
||||
describe '#async' do
|
||||
subject { ->(*args, &block) { instance.async(*args, &block) } }
|
||||
its(:call) { should eq described_class.default_async_job }
|
||||
|
||||
context 'when async is disabled' do
|
||||
let(:async) { false }
|
||||
its(:call) { should eq false }
|
||||
end
|
||||
|
||||
context 'when using with block' do
|
||||
it 'sets value inside block' do
|
||||
expect do
|
||||
expect do
|
||||
subject.call(false) do
|
||||
expect do
|
||||
subject.call(nil) { expect(subject[]).to eq nil }
|
||||
end.to_not change(&subject).from false
|
||||
raise 'TestError'
|
||||
end
|
||||
end.to raise_error(/TestError/)
|
||||
end.to_not change(instance, :async).from(described_class.default_async_job)
|
||||
end
|
||||
end
|
||||
|
||||
context 'in multi-threaded environment' do
|
||||
it 'changes only in current thread' do
|
||||
thread = nil
|
||||
expect do
|
||||
thread = Thread.new do
|
||||
expect do
|
||||
subject.call(false) do
|
||||
expect(subject[]).to eq false
|
||||
end
|
||||
end.to_not change(instance, :async).from(described_class.default_async_job)
|
||||
sleep 0.2
|
||||
end
|
||||
end.to_not change(instance, :async).from(described_class.default_async_job)
|
||||
thread.join
|
||||
end
|
||||
|
||||
it 'uses default value after block' do
|
||||
thread = Thread.new do
|
||||
subject.call(false) {}
|
||||
expect { sleep 0.2 }.to change(instance, :async).
|
||||
from(described_class.default_async_job).to(nil)
|
||||
end
|
||||
sleep 0.1
|
||||
instance.async = nil
|
||||
thread.join
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#async=' do
|
||||
subject { ->(val = new_val) { instance.async = val } }
|
||||
let(:async) {}
|
||||
|
||||
context 'when true is given' do
|
||||
let(:new_val) { true }
|
||||
it { should change(instance, :async).to described_class.default_async_job }
|
||||
end
|
||||
|
||||
context 'when false is given' do
|
||||
let(:new_val) { false }
|
||||
it { should change(instance, :async).to false }
|
||||
end
|
||||
|
||||
context 'when string is given' do
|
||||
let(:new_val) { 'Telegram::Bot::Client' }
|
||||
it { should change(instance, :async).to Object.const_get(new_val) }
|
||||
end
|
||||
|
||||
context 'in multi-threaded environment' do
|
||||
subject { ->(val = new_val) { Thread.new { instance.async = val }.join } }
|
||||
let(:new_val) { true }
|
||||
it { should change(instance, :async).to described_class.default_async_job }
|
||||
end
|
||||
end
|
||||
|
||||
describe '.default_async_job' do
|
||||
subject { described_class.default_async_job }
|
||||
its(:superclass) { should eq application_job_class }
|
||||
it { should include Telegram::Bot::Async::Job }
|
||||
its(:client_class) { should eq described_class }
|
||||
|
||||
context 'when ApplicationJob is not defined' do
|
||||
let(:application_job_class) {}
|
||||
it { expect { subject }.to raise_error(/Define ApplicationJob/) }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#request' do
|
||||
subject { ->(*args) { instance.request(*(args.empty? ? self.args : args)) } }
|
||||
let(:args, &request_args)
|
||||
let(:result) { double(:result) }
|
||||
|
||||
shared_examples 'enqueues job' do
|
||||
it 'enqueues job' do
|
||||
expect(instance).to_not receive(:http_request)
|
||||
expect(described_class).to receive(:prepare_async_args).with(*args) { args }
|
||||
expect(instance.async).to receive(:perform_later).with(id.to_s, *args) { result }
|
||||
expect(subject.call).to eq result
|
||||
end
|
||||
end
|
||||
|
||||
include_examples 'enqueues job'
|
||||
|
||||
context 'with custom job class' do
|
||||
let(:async) { double(:job_class) }
|
||||
include_examples 'enqueues job'
|
||||
end
|
||||
|
||||
context 'when id is not set' do
|
||||
let(:id) {}
|
||||
it { should raise_error(/Can not enqueue/) }
|
||||
end
|
||||
|
||||
context 'when async is disabled' do
|
||||
let(:async) { false }
|
||||
let(:result) { double(status: 200, body: '{"test":"ok"}') }
|
||||
let(:args, &request_args)
|
||||
|
||||
it 'performs request immediately' do
|
||||
expect(instance).to receive(:request).with(*args).and_call_original
|
||||
expect(instance).to receive(:http_request) { result }
|
||||
expect(subject[]).to eq 'test' => 'ok'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
65
spec/support/examples/initializers.rb
Обычный файл
65
spec/support/examples/initializers.rb
Обычный файл
@@ -0,0 +1,65 @@
|
||||
RSpec.shared_examples 'initializers' do |config_method = :bots|
|
||||
describe '.wrap' do
|
||||
subject { described_class.wrap(input, **options) }
|
||||
let(:options) { {} }
|
||||
let(:result) { double(:result) }
|
||||
let(:username) { 'username' }
|
||||
|
||||
context 'when input is a string' do
|
||||
let(:input) { token }
|
||||
|
||||
it 'treats string as token' do
|
||||
expect(described_class).to receive(:new).with(token, {}) { result }
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'and additional options are given' do
|
||||
let(:options) { {id: :test} }
|
||||
|
||||
it 'passes them to initializer' do
|
||||
expect(described_class).to receive(:new).with(input, **options) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is a hash' do
|
||||
let(:input) { {token: token, 'username' => username, other: :options} }
|
||||
|
||||
it 'passes it with symbolized keys' do
|
||||
expect(described_class).to receive(:new).with(**input.symbolize_keys) { result }
|
||||
should eq result
|
||||
end
|
||||
|
||||
context 'and additional options are given' do
|
||||
let(:options) { {id: :test} }
|
||||
|
||||
it 'passes them to initializer' do
|
||||
expect(described_class).to receive(:new).
|
||||
with(**input.symbolize_keys, **options) { result }
|
||||
should eq result
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is an instance of described_class' do
|
||||
let!(:input) { instance }
|
||||
|
||||
it 'returns input' do
|
||||
expect(described_class).to_not receive(:new)
|
||||
should eq input
|
||||
end
|
||||
end
|
||||
|
||||
context 'when input is a Symbol' do
|
||||
let(:input) { :client_1 }
|
||||
before { allow(Telegram).to receive(config_method) { {client_1: instance} } }
|
||||
it { should eq Telegram.send(config_method)[:client_1] }
|
||||
|
||||
context 'and there is no such bot' do
|
||||
let(:input) { :invalid }
|
||||
it { expect { subject }.to raise_error(/not configured/) }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
28
spec/telegram/bot/async_spec.rb
Обычный файл
28
spec/telegram/bot/async_spec.rb
Обычный файл
@@ -0,0 +1,28 @@
|
||||
RSpec.describe Telegram::Bot::Async::Job do
|
||||
let(:job_class) do
|
||||
described_class = self.described_class
|
||||
client_class = self.client_class
|
||||
Class.new do
|
||||
include described_class
|
||||
self.client_class = client_class
|
||||
end
|
||||
end
|
||||
let(:client_class) { Telegram::Bot::Client }
|
||||
let(:instance) { job_class.new }
|
||||
|
||||
describe '#perform' do
|
||||
subject { instance.perform(id, *args) }
|
||||
let(:id) { 'bot_id' }
|
||||
let(:args) { [double(:action), {body: :content}] }
|
||||
let(:client) { Telegram::Bot::Client.new(async: custom_job_class) }
|
||||
let(:custom_job_class) { Class.new }
|
||||
let(:result) { double(status: 200, body: '{"test":"ok"}') }
|
||||
|
||||
it 'finds client and performs request' do
|
||||
expect(client_class).to receive(:wrap).with(id.to_sym) { client }
|
||||
expect(client).to receive(:request).with(*args).and_call_original
|
||||
expect(client).to receive(:http_request) { result }
|
||||
should eq 'test' => 'ok'
|
||||
end
|
||||
end
|
||||
end
|
||||
33
spec/telegram/bot/botan/client_helpers_spec.rb
Обычный файл
33
spec/telegram/bot/botan/client_helpers_spec.rb
Обычный файл
@@ -0,0 +1,33 @@
|
||||
RSpec.describe Telegram::Bot::Client do
|
||||
let(:instance) { described_class.new(*client_args) }
|
||||
let(:token) { 'token' }
|
||||
let(:botan_token) { double(:botan_token) }
|
||||
let(:client_id) { 'client_id' }
|
||||
let(:client_args) { [token] }
|
||||
|
||||
describe '#botan' do
|
||||
subject { instance.botan }
|
||||
it { should eq nil }
|
||||
|
||||
context 'when botan token is set' do
|
||||
let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_token] }
|
||||
it { should be_instance_of Telegram::Bot::Botan }
|
||||
its(:token) { should eq botan_token }
|
||||
its(:id) { should eq client_id }
|
||||
|
||||
it 'doesnt inherit async from client' do
|
||||
expect(instance.async).to be
|
||||
expect(subject.async).to_not be
|
||||
end
|
||||
end
|
||||
|
||||
context 'when botan is configured with hash' do
|
||||
let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_config] }
|
||||
let(:botan_config) { {token: botan_token, async: Class.new} }
|
||||
it { should be_instance_of Telegram::Bot::Botan }
|
||||
its(:token) { should eq botan_token }
|
||||
its(:id) { should eq client_id }
|
||||
its(:async) { should eq botan_config[:async] }
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,4 +1,4 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController::Botan do
|
||||
RSpec.describe Telegram::Bot::Botan::ControllerHelpers do
|
||||
include_context 'telegram/bot/updates_controller'
|
||||
let(:controller_class) do
|
||||
described_class = self.described_class
|
||||
27
spec/telegram/bot/botan_spec.rb
Обычный файл
27
spec/telegram/bot/botan_spec.rb
Обычный файл
@@ -0,0 +1,27 @@
|
||||
RSpec.describe Telegram::Bot::Botan do
|
||||
let(:instance) { described_class.new 'token' }
|
||||
let(:token) { 'token' }
|
||||
|
||||
include_examples 'initializers', :botans
|
||||
it_behaves_like 'async', request_args: -> { [double(:method), double(:url)] }
|
||||
|
||||
describe '.new' do
|
||||
subject { described_class.new(*args) }
|
||||
|
||||
context 'when usual args are given' do
|
||||
let(:args) { ['secret'] }
|
||||
its(:token) { should eq args[0] }
|
||||
end
|
||||
|
||||
context 'when options are given' do
|
||||
let(:args) { [token: 'secret'] }
|
||||
its(:token) { should eq args[0][:token] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '.prepare_async_args' do
|
||||
subject { described_class.prepare_async_args(*input) }
|
||||
let(:input) { [:post, :uri, {a: 1, b: :sym, 'd' => 'str'}, 'body'] }
|
||||
it { should eq ['post', 'uri', {a: 1, b: 'sym', 'd' => 'str'}, 'body'] }
|
||||
end
|
||||
end
|
||||
@@ -3,71 +3,8 @@ RSpec.describe Telegram::Bot::Client do
|
||||
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
|
||||
include_examples 'initializers'
|
||||
it_behaves_like 'async', request_args: -> { [double(:action), {body: :content}] }
|
||||
|
||||
describe '.prepare_body' do
|
||||
subject { described_class.prepare_body(input) }
|
||||
@@ -88,14 +25,72 @@ RSpec.describe Telegram::Bot::Client do
|
||||
end
|
||||
end
|
||||
|
||||
describe '#botan' do
|
||||
subject { instance.botan }
|
||||
it { should eq nil }
|
||||
describe '.prepare_async_args' do
|
||||
subject { described_class.prepare_async_args(*input) }
|
||||
let(:input) { [:action, a: 1, b: :sym, c: [:other], 'd' => 'str'] }
|
||||
it { should eq ['action', a: 1, b: 'sym', c: '["other"]', 'd' => 'str'] }
|
||||
end
|
||||
|
||||
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 }
|
||||
describe '.new' do
|
||||
subject { described_class.new(*args) }
|
||||
|
||||
context 'when multiple args are given' do
|
||||
let(:args) { %w(secret superbot) }
|
||||
its(:token) { should eq args[0] }
|
||||
its(:username) { should eq args[1] }
|
||||
its(:base_uri) { should include args[0] }
|
||||
end
|
||||
|
||||
context 'when hash is given' do
|
||||
let(:args) { [token: 'secret', username: 'superbot'] }
|
||||
its(:token) { should eq args[0][:token] }
|
||||
its(:username) { should eq args[0][:username] }
|
||||
its(:base_uri) { should include args[0][:token] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#request' do
|
||||
subject { -> { instance.request(action, request_body) } }
|
||||
let(:action) { :some_action }
|
||||
let(:url) { "#{format described_class::URL_TEMPLATE, token}#{action}" }
|
||||
let(:request_body) { double(:body) }
|
||||
let(:prepared_body) { double(:prepared_body) }
|
||||
let(:response) { HTTP::Message.new_response(body).tap { |x| x.status = status } }
|
||||
|
||||
let(:status) { 200 }
|
||||
let(:body) { body_json.to_json }
|
||||
let(:body_json) { {'param' => 'val', 'description' => 'some description'} }
|
||||
before do
|
||||
expect(described_class).to receive(:prepare_body).with(request_body) { prepared_body }
|
||||
expect(instance).to receive(:http_request).with(url, prepared_body) { response }
|
||||
end
|
||||
around { |ex| Telegram::Bot::ClientStub.stub_all!(false) { ex.run } }
|
||||
|
||||
shared_examples 'invalid body' do |error = Telegram::Bot::Error|
|
||||
context 'when body is not json' do
|
||||
let(:body) { '{' }
|
||||
it { should raise_error error }
|
||||
end
|
||||
end
|
||||
|
||||
its(:call) { should eq body_json }
|
||||
include_examples 'invalid body', JSON::ParserError
|
||||
|
||||
context 'when status is 403' do
|
||||
let(:status) { 403 }
|
||||
it { should raise_error Telegram::Bot::Forbidden, body_json['description'] }
|
||||
include_examples 'invalid body'
|
||||
end
|
||||
|
||||
context 'when status is 404' do
|
||||
let(:status) { 404 }
|
||||
it { should raise_error Telegram::Bot::NotFound, body_json['description'] }
|
||||
include_examples 'invalid body'
|
||||
end
|
||||
|
||||
context 'when status is other' do
|
||||
let(:status) { 500 }
|
||||
it { should raise_error Telegram::Bot::Error, /#{body_json['description']}/ }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
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']) }
|
||||
let(:clients) { ['token', token: 'token2'].map(&Telegram::Bot::Client.method(:wrap)) }
|
||||
|
||||
shared_examples 'constructors' do |expected_class|
|
||||
it 'makes Client.new return ClientStub' do
|
||||
@@ -9,7 +9,7 @@ RSpec.describe Telegram::Bot::ClientStub do
|
||||
expect(client.username).to eq 'bot_name'
|
||||
end
|
||||
|
||||
it 'makes Client.wrap raturn ClientStub' do
|
||||
it 'makes Client.wrap return ClientStub' do
|
||||
expect(clients).to contain_exactly instance_of(expected_class),
|
||||
instance_of(expected_class)
|
||||
end
|
||||
@@ -35,4 +35,19 @@ RSpec.describe Telegram::Bot::ClientStub do
|
||||
include_examples 'constructors', Telegram::Bot::Client
|
||||
end
|
||||
end
|
||||
|
||||
describe '#new' do
|
||||
subject { described_class.new(*args) }
|
||||
|
||||
context 'when only username is given' do
|
||||
let(:args) { 'superbot' }
|
||||
its(:username) { should eq args }
|
||||
end
|
||||
|
||||
context 'when username and token are given' do
|
||||
let(:args) { %w(token superbot) }
|
||||
its(:token) { should eq nil }
|
||||
its(:username) { should eq args[1] }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
100
spec/telegram/bot/config_methods_spec.rb
Обычный файл
100
spec/telegram/bot/config_methods_spec.rb
Обычный файл
@@ -0,0 +1,100 @@
|
||||
RSpec.describe Telegram::Bot::ConfigMethods do
|
||||
let(:registry) do
|
||||
Object.new.tap do |x|
|
||||
x.extend described_class
|
||||
x.bots_config = config
|
||||
end
|
||||
end
|
||||
let(:config) do
|
||||
{
|
||||
default: 'default_token',
|
||||
chat: {
|
||||
token: 'chat_token',
|
||||
username: 'Chat',
|
||||
botan: 'chat_botan_token',
|
||||
},
|
||||
other_chat: {
|
||||
'token' => 'other_chat_token',
|
||||
'username' => 'OtherChat',
|
||||
'botan' => 'other_chat_botan_token',
|
||||
},
|
||||
}
|
||||
end
|
||||
|
||||
describe '#bot' do
|
||||
subject { registry.bot }
|
||||
it { should eq registry.bots[:default] }
|
||||
end
|
||||
|
||||
describe '#bots' do
|
||||
context 'configured by token' do
|
||||
subject { registry.bots[:default] }
|
||||
its(:id) { should eq :default }
|
||||
its(:token) { should eq config[:default] }
|
||||
end
|
||||
|
||||
context 'configured by hash' do
|
||||
subject { registry.bots[:chat] }
|
||||
its(:id) { should eq :chat }
|
||||
its(:token) { should eq config[:chat][:token] }
|
||||
its(:username) { should eq config[:chat][:username] }
|
||||
its('botan.token') { should eq config[:chat][:botan] }
|
||||
end
|
||||
|
||||
context 'configured by hash with stringified keys' do
|
||||
subject { registry.bots[:other_chat] }
|
||||
its(:id) { should eq :other_chat }
|
||||
its(:token) { should eq config[:other_chat]['token'] }
|
||||
its(:username) { should eq config[:other_chat]['username'] }
|
||||
its('botan.token') { should eq config[:other_chat]['botan'] }
|
||||
end
|
||||
end
|
||||
|
||||
describe '#botans' do
|
||||
subject { registry.botans }
|
||||
it do
|
||||
should eq(
|
||||
default: nil,
|
||||
chat: registry.bots[:chat].botan,
|
||||
other_chat: registry.bots[:other_chat].botan,
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
describe '#bots_config' do
|
||||
subject { registry.bots_config }
|
||||
it { should eq config }
|
||||
|
||||
context 'when not configured' do
|
||||
let(:registry) { Object.new.tap { |x| x.extend described_class } }
|
||||
it { should eq({}) }
|
||||
|
||||
context 'in rails environment' do
|
||||
before { stub_const('Rails', double(application: double(secrets: secrets))) }
|
||||
let(:secrets) { {} }
|
||||
it { should eq({}) }
|
||||
|
||||
context 'when there is telegram section in secrets' do
|
||||
let(:secrets) { {telegram: config.stringify_keys} }
|
||||
let(:config) do
|
||||
{
|
||||
bot: double(:bot_config),
|
||||
bots: {
|
||||
chat: double(:chat_config),
|
||||
other_chat: double(:other_chat_config),
|
||||
},
|
||||
}
|
||||
end
|
||||
it { should include default: config[:bot] }
|
||||
it { should include config[:bots] }
|
||||
|
||||
context 'on rails >5.1 (deep symbolized keys)' do
|
||||
let(:secrets) { {telegram: config.deep_symbolize_keys} }
|
||||
it { should include default: config[:bot] }
|
||||
it { should include config[:bots] }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -50,8 +50,9 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
|
||||
def assert_routes(*expected) # rubocop:disable AbcSize
|
||||
expected.each do |(bot, controller, route_name, options)|
|
||||
expected_path = options.delete(:path) || "telegram/#{bot.token}"
|
||||
expect(mapper).to receive(:post) do |path, params|
|
||||
expect(path).to eq "telegram/#{bot.token}"
|
||||
expect(path).to eq expected_path
|
||||
middleware = params[:to]
|
||||
expect(middleware.controller).to eq(controller)
|
||||
expect(middleware.bot.token).to eq(bot.token)
|
||||
@@ -70,6 +71,27 @@ RSpec.describe Telegram::Bot::RoutesHelper do
|
||||
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
||||
[other_bot, controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
|
||||
context 'and bot does not have configured token' do
|
||||
let(:bot) { create_bot(nil) }
|
||||
it 'creates routes for every bot and this controller' do
|
||||
assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
|
||||
[other_bot, controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
end
|
||||
|
||||
context 'and bot has colon in token' do
|
||||
let(:bot) { create_bot('some:token') }
|
||||
it 'replaces colon with underscore' do
|
||||
assert_routes [
|
||||
bot,
|
||||
controller,
|
||||
'default_telegram_webhook',
|
||||
option: :val,
|
||||
path: 'telegram/some_token',
|
||||
], [other_bot, controller, 'other_telegram_webhook', option: :val]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when called with hash' do
|
||||
|
||||
87
spec/telegram/bot/rspec/client_matchers_spec.rb
Обычный файл
87
spec/telegram/bot/rspec/client_matchers_spec.rb
Обычный файл
@@ -0,0 +1,87 @@
|
||||
RSpec.describe Telegram::Bot::RSpec::ClientMatchers do
|
||||
let(:bot) { Telegram::Bot::ClientStub.new('TestBot') }
|
||||
let(:other_bot) { Telegram::Bot::ClientStub.new('OtherTestBot') }
|
||||
|
||||
include described_class
|
||||
|
||||
describe '#make_telegram_request' do
|
||||
context 'without args' do
|
||||
it 'works for matching' do
|
||||
block = ->(*) { bot.send_message(text: 'test') }
|
||||
expect(&block).to make_telegram_request(bot, :sendMessage)
|
||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).exactly(3).times
|
||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).at_least(2).times
|
||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).at_most(4).times
|
||||
end
|
||||
|
||||
it 'works for not-matching' do
|
||||
block = ->(*) { bot.get_me }
|
||||
expect {}.to_not make_telegram_request(bot, :getMe)
|
||||
expect { other_bot.get_me }.to_not make_telegram_request(bot, :getMe)
|
||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe)
|
||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).exactly(2).times
|
||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).exactly(4).times
|
||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).at_least(4).times
|
||||
expect { 3.times(&block) }.to_not make_telegram_request(bot, :getMe).at_most(2).times
|
||||
end
|
||||
end
|
||||
|
||||
context 'with args' do
|
||||
it 'works for exact matching' do
|
||||
args = {text: 'test', parseMode: :Markdown}
|
||||
block = ->(*) { bot.send_message(args) }
|
||||
expect(&block).to make_telegram_request(bot, :sendMessage).with(args)
|
||||
expect(&block).to_not make_telegram_request(bot, :sendMessage).with(args.except(:text))
|
||||
expect { 3.times(&block) }.to make_telegram_request(bot, :sendMessage).
|
||||
with(args).exactly(3).times
|
||||
end
|
||||
|
||||
it 'works for block matchers' do
|
||||
args = {text: 'test', parseMode: :Markdown}
|
||||
block = ->(*) { bot.send_message(args) }
|
||||
expect(&block).to make_telegram_request(bot, :sendMessage).
|
||||
with { |actual| expect(actual).to eq(args) }
|
||||
# It ignores block's result! Custom expectations must be used inside block.
|
||||
expect(&block).to make_telegram_request(bot, :sendMessage).
|
||||
with { |actual| actual == {} }
|
||||
expect do
|
||||
expect(&block).to_not make_telegram_request(bot, :sendMessage).
|
||||
with { |actual| expect(actual).to eq({}) }
|
||||
end.to raise_error RSpec::Expectations::ExpectationNotMetError
|
||||
n = -1
|
||||
expect { 3.times { |i| bot.send_message text: i } }.
|
||||
to make_telegram_request(bot, :sendMessage).exactly(3).times.
|
||||
with { |actual| expect(actual).to eq(text: n += 1) }
|
||||
end
|
||||
|
||||
it 'works for RSpec::Mocks matchers' do
|
||||
args = {text: 'test', parseMode: :Markdown}
|
||||
block = ->(*) { bot.send_message(args) }
|
||||
expect(&block).to make_telegram_request(bot, :sendMessage).with(hash_including(args))
|
||||
expect(&block).to make_telegram_request(bot, :sendMessage).with(
|
||||
text: a_string_matching(/est$/),
|
||||
parseMode: :Markdown,
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#send_telegram_message' do
|
||||
let(:args) { {text: 'test', parseMode: :Markdown} }
|
||||
let(:block) { ->(*) { bot.send_message(args) } }
|
||||
|
||||
it 'works for matching' do
|
||||
expect(&block).to send_telegram_message(bot, 'test')
|
||||
expect(&block).to send_telegram_message(bot, /^tes/)
|
||||
expect(&block).to send_telegram_message(bot, 'test', parseMode: :Markdown)
|
||||
expect(&block).to send_telegram_message(bot, a_string_including('es'))
|
||||
end
|
||||
|
||||
it 'works for not-matching' do
|
||||
expect(&block).to_not send_telegram_message(bot, 'test!')
|
||||
expect(&block).to_not send_telegram_message(bot, /tes$/)
|
||||
expect(&block).to_not send_telegram_message(bot, 'test', parseMode: :HTML)
|
||||
expect(&block).to_not send_telegram_message(bot, a_string_including('smth'))
|
||||
end
|
||||
end
|
||||
end
|
||||
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
|
||||
@@ -1,4 +1,4 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesController::CallbackQueyContext do
|
||||
RSpec.describe Telegram::Bot::UpdatesController::CallbackQueryContext do
|
||||
include_context 'telegram/bot/updates_controller'
|
||||
let(:controller_class) do
|
||||
described_class = self.described_class
|
||||
|
||||
@@ -102,42 +102,44 @@ 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_message' 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
|
||||
end
|
||||
@@ -293,4 +295,49 @@ RSpec.describe Telegram::Bot::UpdatesController do
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#chat' do
|
||||
subject { controller.chat }
|
||||
let(:payload_type) { :message }
|
||||
let(:payload) { {chat: 'test_value'} }
|
||||
it { should eq payload[:chat] }
|
||||
|
||||
context 'when payload is not set' do
|
||||
let(:payload) {}
|
||||
it { should eq nil }
|
||||
end
|
||||
|
||||
context 'when payload has no such field' do
|
||||
let(:payload) { {smth: 'other'} }
|
||||
it { should eq nil }
|
||||
|
||||
context 'but has `message`' do
|
||||
let(:payload) { {message: message} }
|
||||
let(:message) { {text: 'Hello bot!'} }
|
||||
it { should eq nil }
|
||||
|
||||
context 'with `chat` set' do
|
||||
let(:message) { super().merge(chat: 'test value') }
|
||||
it { should eq message[:chat] }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe '#from' do
|
||||
subject { controller.from }
|
||||
let(:payload_type) { :message }
|
||||
let(:payload) { {from: 'test_value'} }
|
||||
it { should eq payload[:from] }
|
||||
|
||||
context 'when payload is not set' do
|
||||
let(:payload) {}
|
||||
it { should eq nil }
|
||||
end
|
||||
|
||||
context 'when payload has no such field' do
|
||||
let(:payload) { {smth: 'other'} }
|
||||
it { should eq nil }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,9 +1,39 @@
|
||||
RSpec.describe Telegram::Bot::UpdatesPoller do
|
||||
describe '#initialize' do
|
||||
subject { described_class.new bot, controller }
|
||||
let(:bot) { double }
|
||||
let(:controller) { double }
|
||||
let(:instance) { described_class.new(bot, controller) }
|
||||
let(:bot) { Telegram::Bot::Client.new('token') }
|
||||
let(:controller) { double(:controller) }
|
||||
|
||||
describe '#initialize' do
|
||||
subject { instance }
|
||||
it { should be }
|
||||
end
|
||||
|
||||
describe '#fetch_updates' do
|
||||
subject { -> { instance.fetch_updates(&block) } }
|
||||
let(:block) { ->(x) { expect(x).to eq expected_results.shift } }
|
||||
let(:results) { [{update_id: 12}, {update_id: 34}] }
|
||||
let(:expected_results) { results.as_json }
|
||||
let(:request_result) { {ok: true, result: results}.as_json }
|
||||
before do
|
||||
allow(bot).to receive(:get_updates) do
|
||||
expect(bot.async).to be_falsy
|
||||
request_result
|
||||
end
|
||||
end
|
||||
|
||||
it { should change(instance, :offset).to(results.last[:update_id] + 1) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
|
||||
context 'with typed response' do
|
||||
let(:request_result) { results.as_json.map { |x| Telegram::Bot::Types::Update.new(x) } }
|
||||
let(:expected_results) { request_result.dup }
|
||||
it { should change(instance, :offset).to(results.last[:update_id] + 1) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
end
|
||||
|
||||
context 'when bot is in async mode' do
|
||||
let(:bot) { Telegram::Bot::Client.new('token', async: Class.new) }
|
||||
it { should change { expected_results }.to([]) }
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -2,22 +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
|
||||
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.1'
|
||||
spec.add_dependency 'actionpack', '>= 4.0', '<= 5.1'
|
||||
spec.add_dependency 'httpclient', '~> 2.7'
|
||||
spec.add_development_dependency 'bundler', '~> 1.11'
|
||||
spec.add_development_dependency 'rake', '~> 10.0'
|
||||
|
||||
Ссылка в новой задаче
Block a user