v0.11.0

ActionDispatch::Testing::Integration requires smth else and
defines Rails, so had to change `defined?(Rails)` all over the code.

CHANGELOG.md

@@ -1,3 +1,19 @@
+# 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.

Gemfile

@@ -13,9 +13,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'

README.md

@@ -24,6 +24,9 @@ Here is sample [telegram_bot_app](https://github.com/telegram-bot-rb/telegram_bo
 with session, keyboards and inline queries.
 Run it on your local machine in 1 minute!
 
+And here is [app teamplate](https://github.com/telegram-bot-rb/rails_template)
+to generate clean app in seconds.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -97,7 +100,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
 
@@ -323,36 +326,52 @@ 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.
+There are integration and controller contexts for RSpec and some built-in matchers:
-Check out `telegram/bot/updates_controller/rspec_helpers` and
-`telegram/bot/updates_controller/testing`.
-
-Built-in RSpec matchers will help you to write tests fast:
 
 ```ruby
-include Telegram::Bot::RSpec::ClientMatchers # no need if you already use controller herlpers
+# spec/requests/telegram_webhooks_spec.rb
+require 'telegram/bot/rspec/integration'
+
+RSpec.describe TelegramWebhooksController, :telegram_bot do
+  # for old rspec add:
+  # include_context 'telegram/bot/integration'
+
+  describe '#start' do
+    subject { -> { dispatch_command :start } }
+    it { should respond_with_message 'Hi there!' }
+  end
+end
+
+# For controller specs use
+require 'telegram/bot/updates_controller/rspec_helpers'
+RSpec.describe TelegramWebhooksController, type: :telegram_bot_controller do
+  # for old rspec add:
+  # include_context 'telegram/bot/updates_controller'
+end
+
+# Matchers are available for custom specs:
+include Telegram::Bot::RSpec::ClientMatchers
 
 expect(&process_update).to send_telegram_message(bot, /msg regexp/, some: :option)
 expect(&process_update).
   to make_telegram_request(bot, :sendMessage, hash_including(text: 'msg text'))
-
-# controller specs are even simplier:
-describe '#start' do
-  subject { -> { dispatch_message '/start' } }
-  it { should respond_with_message(/Hello/) }
-end
-# See sample app for more examples.
 ```
 
+See sample app for more examples.
+
 ### Deploying
 
 Use `rake telegram:bot:set_webhook` to update webhook url for all configured bots.

lib/telegram/bot.rb

@@ -6,26 +6,7 @@ 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 blocked',
-        'bot was kicked',
-        "can't write to",
-        'group chat is deactivated',
-      ].freeze
-
-      class << self
-        def match_response?(response)
-          description = response['description'].to_s
-          DESCRIPTIONS.any? { |x| description[x] }
-        end
-      end
-    end
 
     autoload :Async,              'telegram/bot/async'
     autoload :Botan,              'telegram/bot/botan'

lib/telegram/bot/async.rb

@@ -116,7 +116,7 @@ module Telegram
 
       attr_reader :id
 
-      def initialize(*, id: nil, async: nil, **)
+      def initialize(*, id: nil, async: nil, **options)
         @id = id
         self.async = async
         super

lib/telegram/bot/botan/client_helpers.rb

@@ -5,7 +5,7 @@ module Telegram
       module ClientHelpers
         attr_reader :botan
 
-        def initialize(*, botan: nil, **)
+        def initialize(*, botan: nil, **options)
           super
           @botan = Botan.wrap(botan, id: id) if botan
         end

lib/telegram/bot/client.rb

@@ -46,44 +46,44 @@ module Telegram
         @base_uri = format URL_TEMPLATE, self.token
       end
 
-      def request(action, body = {}) # rubocop:disable PerceivedComplexity
+      def request(action, body = {})
         res = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
         status = res.status
         return JSON.parse(res.body) if 300 > status
         result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
-        err_msg = "#{res.reason}: #{result && result['description'] || '-'}"
+        err_msg = result && result['description'] || '-'
         if result
-          # NotFound is raised only for valid responses from Telegram
+          # This errors are raised only for valid responses from Telegram
-          raise NotFound, err_msg if 404 == status
+          case status
-          raise StaleChat, err_msg if StaleChat.match_response?(result)
+          when 403 then raise Forbidden, err_msg
+          when 404 then raise NotFound, err_msg
+          end
         end
-        raise Error, err_msg
+        raise Error, "#{res.reason}: #{err_msg}"
       end
 
+      # Splited to the sections similar to API docs.
       %w(
+        deleteWebhook
+        getUpdates
+        getWebhookInfo
+        setWebhook
+
         answerCallbackQuery
-        answerInlineQuery
-        editMessageCaption
-        editMessageReplyMarkup
-        editMessageText
         forwardMessage
         getChat
         getChatAdministrators
         getChatMember
         getChatMembersCount
         getFile
-        getGameHighScores
         getMe
-        getUpdates
         getUserProfilePhotos
-        getWebhookInfo
         kickChatMember
         leaveChat
         sendAudio
         sendChatAction
         sendContact
         sendDocument
-        sendGame
         sendLocation
         sendMessage
         sendPhoto
@@ -91,9 +91,17 @@ module Telegram
         sendVenue
         sendVideo
         sendVoice
-        setGameScore
-        setWebhook
         unbanChatMember
+
+        editMessageCaption
+        editMessageReplyMarkup
+        editMessageText
+
+        answerInlineQuery
+
+        getGameHighScores
+        sendGame
+        setGameScore
       ).each do |method|
         define_method(method.underscore) { |*args| request(method, *args) }
       end

lib/telegram/bot/config_methods.rb

@@ -20,7 +20,7 @@ module Telegram
       def bot_poller_mode?
         return @bot_poller_mode if defined?(@bot_poller_mode)
         @bot_poller_mode = ENV.fetch('BOT_POLLER_MODE') do
-          Rails.env.development? if defined?(Rails)
+          Rails.env.development? if defined?(Rails.env)
         end
       end
 
@@ -47,7 +47,7 @@ module Telegram
       # Can be overwritten with .bots_config=
       def bots_config
         @bots_config ||=
-          if defined?(Rails)
+          if defined?(Rails.application)
             telegram_config = Rails.application.secrets[:telegram] || {}
             (telegram_config['bots'] || {}).symbolize_keys.tap do |config|
               default = telegram_config['bot']

lib/telegram/bot/rspec/client_matchers.rb

@@ -139,9 +139,9 @@ module Telegram
         # Helper for asserting message is sent. Note that options are checked
         # with `hash_including`. For strict checks use #make_telegram_request.
         def send_telegram_message(bot, text = nil, options = {})
+          description = "send telegram message #{text.inspect}"
           text = a_string_matching(text) if text.is_a?(Regexp)
           options = options.merge(text: text) if text
-          description = "send telegram message #{text.inspect}"
           MakeTelegramRequest.new(bot, :sendMessage, description: description).
             with(hash_including(options))
         end

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

lib/telegram/bot/updates_controller.rb

@@ -50,7 +50,7 @@ module Telegram
     #     ControllerClass.new(bot, from: telegram_user, chat: telegram_chat).
     #       process(:help, *args)
     #
-    class UpdatesController < AbstractController::Base
+    class UpdatesController < AbstractController::Base # rubocop:disable ClassLength
       abstract!
 
       require 'telegram/bot/updates_controller/session'
@@ -80,10 +80,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)")
@@ -181,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']]]

lib/telegram/bot/updates_controller/rspec_helpers.rb

@@ -13,6 +13,9 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
   let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
   let(:bot_name) { 'bot' }
   let(:session) { controller.send(:session) }
+  let(:from_id) { 123 }
+  let(:chat_id) { 456 }
+  let(:default_message_options) { {from: {id: from_id}, chat: {id: chat_id}} }
 
   include Telegram::Bot::RSpec::ClientMatchers
 
@@ -20,9 +23,8 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
     controller.dispatch_again(bot, update)
   end
 
-  def dispatch_message(text, options = nil)
+  def dispatch_message(text, options = {})
-    options ||= respond_to?(:default_message_options) ? default_message_options : {}
+    update = build_update :message, default_message_options.merge(options).merge(text: text)
-    update = build_update :message, options.merge(text: text)
     dispatch bot, update
   end
 
@@ -43,3 +45,9 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
     send_telegram_message(bot, expected, chat_id: chat_id)
   end
 end
+
+RSpec.configure do |config|
+  if config.respond_to?(:include_context)
+    config.include_context 'telegram/bot/updates_controller', type: :telegram_bot_controller
+  end
+end

lib/telegram/bot/updates_poller.rb

@@ -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)
@@ -85,7 +85,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

lib/telegram/bot/version.rb

@@ -1,6 +1,6 @@
 module Telegram
   module Bot
-    VERSION = '0.9.0'.freeze
+    VERSION = '0.11.0'.freeze
 
     def self.gem_version
       Gem::Version.new VERSION

spec/telegram/bot/botan_spec.rb

@@ -3,7 +3,7 @@ RSpec.describe Telegram::Bot::Botan do
   let(:token) { 'token' }
 
   include_examples 'initializers', :botans
-  include_examples 'async', request_args: -> { [double(:method), double(:url)] }
+  it_behaves_like 'async', request_args: -> { [double(:method), double(:url)] }
 
   describe '.new' do
     subject { described_class.new(*args) }

spec/telegram/bot/client_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Telegram::Bot::Client do
   let(:botan_token) { double(:botan_token) }
 
   include_examples 'initializers'
-  include_examples 'async', request_args: -> { [double(:action), {body: :content}] }
+  it_behaves_like 'async', request_args: -> { [double(:action), {body: :content}] }
 
   describe '.prepare_body' do
     subject { described_class.prepare_body(input) }
@@ -48,4 +48,49 @@ RSpec.describe Telegram::Bot::Client do
       its(:base_uri) { should include args[0][:token] }
     end
   end
+
+  describe '#request' do
+    subject { -> { instance.request(action, request_body) } }
+    let(:action) { :some_action }
+    let(:url) { "#{format described_class::URL_TEMPLATE, token}#{action}" }
+    let(:request_body) { double(:body) }
+    let(:prepared_body) { double(:prepared_body) }
+    let(:response) { HTTP::Message.new_response(body).tap { |x| x.status = status } }
+
+    let(:status) { 200 }
+    let(:body) { body_json.to_json }
+    let(:body_json) { {'param' => 'val', 'description' => 'some description'} }
+    before do
+      expect(described_class).to receive(:prepare_body).with(request_body) { prepared_body }
+      expect(instance).to receive(:http_request).with(url, prepared_body) { response }
+    end
+    around { |ex| Telegram::Bot::ClientStub.stub_all!(false) { ex.run } }
+
+    shared_examples 'invalid body' do |error = Telegram::Bot::Error|
+      context 'when body is not json' do
+        let(:body) { '{' }
+        it { should raise_error error }
+      end
+    end
+
+    its(:call) { should eq body_json }
+    include_examples 'invalid body', JSON::ParserError
+
+    context 'when status is 403' do
+      let(:status) { 403 }
+      it { should raise_error Telegram::Bot::Forbidden, body_json['description'] }
+      include_examples 'invalid body'
+    end
+
+    context 'when status is 404' do
+      let(:status) { 404 }
+      it { should raise_error Telegram::Bot::NotFound, body_json['description'] }
+      include_examples 'invalid body'
+    end
+
+    context 'when status is other' do
+      let(:status) { 500 }
+      it { should raise_error Telegram::Bot::Error, /#{body_json['description']}/ }
+    end
+  end
 end

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

spec/telegram/bot/updates_controller_spec.rb

@@ -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
+    %w(message channel_post).each do |type|
-      let(:payload_type) { 'message' }
+      context 'when payload is edited_message' do
-      let(:payload) { {'text' => text} }
+        let(:payload_type) { "edited_#{type}" }
-      let(:text) { 'test' }
+        it { should eq [false, payload_type, [payload]] }
-
-      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
       end
 
-      context 'without text' do
+      context 'when payload is message' do
-        let(:payload) { {'audio' => {'file_id' => 123}} }
+        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

spec/telegram/bot_spec.rb

@@ -2,25 +2,4 @@ RSpec.describe Telegram::Bot do
   it 'has a version number' do
     expect(described_class::VERSION).not_to be nil
   end
-
-  describe described_class::StaleChat do
-    describe '.match_response?' do
-      subject { ->(val) { described_class.match_response?(val) } }
-
-      it 'returns true for specific errors' do
-        expect(subject.call({})).to eq false
-        expect(subject.call('description' => 'test')).to eq false
-        expect(subject.call('description' => 'Error: bot was kicked from')).to eq true
-        expect(subject.call(
-          'description' => "Forbidden: can't write to private chat with deleted user"
-        )).to eq true
-        expect(subject.call(
-          'description' => 'Bad request: group chat is deactivated'
-        )).to eq true
-        expect(subject.call(
-          'description' => 'Forbidden: Bot was blocked by the user'
-        )).to eq true
-      end
-    end
-  end
 end