v0.16.1

Fix rails 7.1 broadcast error

.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: Lint & Test
+
+on: [push, pull_request]
+
+jobs:
+  # lint:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - uses: ruby/setup-ruby@v1
+  #       with:
+  #         ruby-version: '3.0'
+  #         bundler-cache: true
+  #     - run: bundle exec rubocop
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.7'
+        gemfile:
+          - gemfiles/rails_61.gemfile
+          - gemfiles/rails_60.gemfile
+          - gemfiles/rails_52.gemfile
+          - gemfiles/rails_51.gemfile
+        include:
+          # ruby 3.x
+          - ruby: '3.2'
+            gemfile: gemfiles/rails_71.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_61.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_60.gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake spec

.travis.yml

@@ -1,30 +0,0 @@
-os: linux
-dist: xenial
-language: ruby
-cache: bundler
-rvm:
-- 2.6
-- 2.5
-gemfile:
-- gemfiles/rails_61.gemfile
-- gemfiles/rails_60.gemfile
-- gemfiles/rails_52.gemfile
-jobs:
-  include:
-  # ruby 3.x
-  - rvm: 3.0
-    gemfile: gemfiles/rails_61.gemfile
-  - rvm: 3.0
-    gemfile: gemfiles/rails_60.gemfile
-  # old rails
-  - rvm: 2.5
-    gemfile: gemfiles/rails_51.gemfile
-  - rvm: 2.5
-    gemfile: gemfiles/rails_50.gemfile
-  - rvm: 2.5
-    gemfile: gemfiles/rails_42.gemfile
-  # old rubies
-  - rvm: 2.4
-    gemfile: gemfiles/rails_52.gemfile
-notifications:
-  email: false

Appraisals

@@ -1,3 +1,8 @@
+appraise 'rails-71' do
+  gem 'actionpack', '~> 7.1.0'
+  gem 'railties', '~> 7.1.0'
+end
+
 appraise 'rails-70' do
   gem 'actionpack', '~> 7.0.0'
   gem 'railties', '~> 7.0.0'
@@ -22,13 +27,3 @@ appraise 'rails-51' do
   gem 'actionpack', '~> 5.1.0'
   gem 'railties', '~> 5.1.0'
 end
-
-appraise 'rails-50' do
-  gem 'actionpack', '~> 5.0.0'
-  gem 'railties', '~> 5.0.0'
-end
-
-appraise 'rails-42' do
-  gem 'actionpack', '~> 4.2.0'
-  gem 'railties', '~> 4.2.0'
-end

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Unreleased
 
+# 0.16.1
+
+- Fix logger in poller mode in rails 7.1
+
+# 0.16.0
+
+- Add `UpdatesController#webhook_request` that is set to `ActionDispatch::Request`
+  in webhook mode.
+- Update to Bot API 6.8
+- Added `chat_join_request` to PAYLOAD_TYPES
+
 # 0.15.7
 
 - Add support for editMessageMedia similar to sendMediaGroup.

Gemfile

@@ -4,13 +4,13 @@ gemspec
 group :development do
   gem 'appraisal', '~> 2.2'
 
-  gem 'pry', '~> 0.13.1'
+  gem 'pry', '~> 0.14.1'
-  gem 'pry-byebug', '~> 3.9.0'
+  gem 'pry-byebug', '~> 3.10.1'
   gem 'sdoc', '~> 2.0.3'
 
   gem 'telegram-bot-types', '~> 0.6.3'
 
-  gem 'rspec', '~> 3.10.0'
+  gem 'rspec', '~> 3.12.0'
   gem 'rspec-its', '~> 1.3.0'
   gem 'rspec-rails', '~> 4.0.2'
 

README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/telegram-bot.svg)](http://badge.fury.io/rb/telegram-bot)
 [![Code Climate](https://codeclimate.com/github/telegram-bot-rb/telegram-bot/badges/gpa.svg)](https://codeclimate.com/github/telegram-bot-rb/telegram-bot)
-[![Build Status](https://app.travis-ci.com/telegram-bot-rb/telegram-bot.svg)](https://app.travis-ci.com/github/telegram-bot-rb/telegram-bot)
+[![Lint & Test](https://github.com/telegram-bot-rb/telegram-bot/actions/workflows/ci.yml/badge.svg)](https://github.com/telegram-bot-rb/telegram-bot/actions/workflows/ci.yml)
 
 Tools for developing Telegram bots. Best used with Rails, but can be used in
 [standalone app](https://github.com/telegram-bot-rb/telegram-bot/wiki/Not-rails-application).
@@ -430,6 +430,10 @@ There are several options to run it automatically:
 - Use `Telegram::Bot::Middleware` with rack ([example in wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki/Not-rails-application)).
 - Use poller (described in the next section).
 
+When controller runs in webhook mode `Telegram::Bot::Middleware` passes
+`ActionDispatch::Request` object to the `.dispatch` method.
+It's available via `#webhook_request` controller method.
+
 To run action without update (ex., send notifications from jobs),
 you can call `#process` directly. In this case controller can be initialized
 with `:from` and/or `:chat` options instead of `update` object:

gemfiles/rails_50.gemfile

@@ -1,21 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "actionpack", "~> 5.0.0"
-gem "railties", "~> 5.0.0"
-
-group :development do
-  gem "appraisal", "~> 2.2"
-  gem "pry", "~> 0.13.1"
-  gem "pry-byebug", "~> 3.9.0"
-  gem "sdoc", "~> 2.0.3"
-  gem "telegram-bot-types", "~> 0.6.3"
-  gem "rspec", "~> 3.10.0"
-  gem "rspec-its", "~> 1.3.0"
-  gem "rspec-rails", "~> 4.0.2"
-  gem "rubocop", "~> 0.52.1"
-  gem "coveralls", "~> 0.8.23", require: false
-end
-
-gemspec path: "../"

gemfiles/rails_51.gemfile

@@ -7,11 +7,11 @@ gem "railties", "~> 5.1.0"
 
 group :development do
   gem "appraisal", "~> 2.2"
-  gem "pry", "~> 0.13.1"
+  gem "pry", "~> 0.14.1"
-  gem "pry-byebug", "~> 3.9.0"
+  gem "pry-byebug", "~> 3.10.1"
   gem "sdoc", "~> 2.0.3"
   gem "telegram-bot-types", "~> 0.6.3"
-  gem "rspec", "~> 3.10.0"
+  gem "rspec", "~> 3.12.0"
   gem "rspec-its", "~> 1.3.0"
   gem "rspec-rails", "~> 4.0.2"
   gem "rubocop", "~> 0.52.1"

gemfiles/rails_52.gemfile

@@ -7,11 +7,11 @@ gem "railties", "~> 5.2.0"
 
 group :development do
   gem "appraisal", "~> 2.2"
-  gem "pry", "~> 0.13.1"
+  gem "pry", "~> 0.14.1"
-  gem "pry-byebug", "~> 3.9.0"
+  gem "pry-byebug", "~> 3.10.1"
   gem "sdoc", "~> 2.0.3"
   gem "telegram-bot-types", "~> 0.6.3"
-  gem "rspec", "~> 3.10.0"
+  gem "rspec", "~> 3.12.0"
   gem "rspec-its", "~> 1.3.0"
   gem "rspec-rails", "~> 4.0.2"
   gem "rubocop", "~> 0.52.1"

gemfiles/rails_60.gemfile

@@ -7,11 +7,11 @@ gem "railties", "~> 6.0.0"
 
 group :development do
   gem "appraisal", "~> 2.2"
-  gem "pry", "~> 0.13.1"
+  gem "pry", "~> 0.14.1"
-  gem "pry-byebug", "~> 3.9.0"
+  gem "pry-byebug", "~> 3.10.1"
   gem "sdoc", "~> 2.0.3"
   gem "telegram-bot-types", "~> 0.6.3"
-  gem "rspec", "~> 3.10.0"
+  gem "rspec", "~> 3.12.0"
   gem "rspec-its", "~> 1.3.0"
   gem "rspec-rails", "~> 4.0.2"
   gem "rubocop", "~> 0.52.1"

gemfiles/rails_61.gemfile

@@ -7,11 +7,11 @@ gem "railties", "~> 6.1.0"
 
 group :development do
   gem "appraisal", "~> 2.2"
-  gem "pry", "~> 0.13.1"
+  gem "pry", "~> 0.14.1"
-  gem "pry-byebug", "~> 3.9.0"
+  gem "pry-byebug", "~> 3.10.1"
   gem "sdoc", "~> 2.0.3"
   gem "telegram-bot-types", "~> 0.6.3"
-  gem "rspec", "~> 3.10.0"
+  gem "rspec", "~> 3.12.0"
   gem "rspec-its", "~> 1.3.0"
   gem "rspec-rails", "~> 4.0.2"
   gem "rubocop", "~> 0.52.1"

gemfiles/rails_70.gemfile

@@ -7,11 +7,11 @@ gem "railties", "~> 7.0.0"
 
 group :development do
   gem "appraisal", "~> 2.2"
-  gem "pry", "~> 0.13.1"
+  gem "pry", "~> 0.14.1"
-  gem "pry-byebug", "~> 3.9.0"
+  gem "pry-byebug", "~> 3.10.1"
   gem "sdoc", "~> 2.0.3"
   gem "telegram-bot-types", "~> 0.6.3"
-  gem "rspec", "~> 3.10.0"
+  gem "rspec", "~> 3.12.0"
   gem "rspec-its", "~> 1.3.0"
   gem "rspec-rails", "~> 4.0.2"
   gem "rubocop", "~> 0.52.1"

gemfiles/rails_71.gemfile

@@ -2,16 +2,16 @@
 
 source "https://rubygems.org"
 
-gem "actionpack", "~> 4.2.0"
+gem "actionpack", "~> 7.1.0"
-gem "railties", "~> 4.2.0"
+gem "railties", "~> 7.1.0"
 
 group :development do
   gem "appraisal", "~> 2.2"
-  gem "pry", "~> 0.13.1"
+  gem "pry", "~> 0.14.1"
-  gem "pry-byebug", "~> 3.9.0"
+  gem "pry-byebug", "~> 3.10.1"
   gem "sdoc", "~> 2.0.3"
   gem "telegram-bot-types", "~> 0.6.3"
-  gem "rspec", "~> 3.10.0"
+  gem "rspec", "~> 3.12.0"
   gem "rspec-its", "~> 1.3.0"
   gem "rspec-rails", "~> 4.0.2"
   gem "rubocop", "~> 0.52.1"

lib/tasks/telegram-bot.rake

@@ -7,7 +7,11 @@ namespace :telegram do
       Rake::Task['environment'].invoke
       if ENV.fetch('LOG_TO_STDOUT') { Rails.env.development? }.present?
         console = ActiveSupport::Logger.new(STDERR)
-        Rails.logger.extend ActiveSupport::Logger.broadcast console
+        if ::Rails.logger.respond_to?(:broadcast_to)
+          ::Rails.logger.broadcast_to(console)
+        else
+          Rails.logger.extend ActiveSupport::Logger.broadcast console
+        end
       end
       Telegram::Bot::UpdatesPoller.start(ENV['BOT'].try!(:to_sym) || :default)
     end

lib/telegram/bot/client/api_methods.txt

@@ -1,5 +1,5 @@
 # Generated with bin/fetch-telegram-methods
-# Bot API 5.7
+# Bot API 6.8
 
 getUpdates
 setWebhook
@@ -21,8 +21,6 @@ sendVoice
 sendVideoNote
 sendMediaGroup
 sendLocation
-editMessageLiveLocation
-stopMessageLiveLocation
 sendVenue
 sendContact
 sendPoll
@@ -58,30 +56,64 @@ getChatMemberCount
 getChatMember
 setChatStickerSet
 deleteChatStickerSet
+getForumTopicIconStickers
+createForumTopic
+editForumTopic
+closeForumTopic
+reopenForumTopic
+deleteForumTopic
+unpinAllForumTopicMessages
+editGeneralForumTopic
+closeGeneralForumTopic
+reopenGeneralForumTopic
+hideGeneralForumTopic
+unhideGeneralForumTopic
+unpinAllGeneralForumTopicMessages
 answerCallbackQuery
 setMyCommands
 deleteMyCommands
 getMyCommands
+setMyName
+getMyName
+setMyDescription
+getMyDescription
+setMyShortDescription
+getMyShortDescription
+setChatMenuButton
+getChatMenuButton
+setMyDefaultAdministratorRights
+getMyDefaultAdministratorRights
 
 editMessageText
 editMessageCaption
 editMessageMedia
+editMessageLiveLocation
+stopMessageLiveLocation
 editMessageReplyMarkup
 stopPoll
 deleteMessage
 
 sendSticker
 getStickerSet
+getCustomEmojiStickers
 uploadStickerFile
 createNewStickerSet
 addStickerToSet
 setStickerPositionInSet
 deleteStickerFromSet
-setStickerSetThumb
+setStickerEmojiList
+setStickerKeywords
+setStickerMaskPosition
+setStickerSetTitle
+setStickerSetThumbnail
+setCustomEmojiStickerSetThumbnail
+deleteStickerSet
 
 answerInlineQuery
+answerWebAppQuery
 
 sendInvoice
+createInvoiceLink
 answerShippingQuery
 answerPreCheckoutQuery
 

lib/telegram/bot/middleware.rb

@@ -16,7 +16,7 @@ module Telegram
       def call(env)
         request = ActionDispatch::Request.new(env)
         update = request.request_parameters
-        controller.dispatch(bot, update)
+        controller.dispatch(bot, update, request)
         [200, {}, ['']]
       end
 

lib/telegram/bot/updates_controller.rb

@@ -101,6 +101,7 @@ module Telegram
         poll_answer
         my_chat_member
         chat_member
+        chat_join_request
       ].freeze
 
       class << self
@@ -117,21 +118,24 @@ module Telegram
         end
       end
 
-      attr_internal_reader :update, :bot, :payload, :payload_type
+      attr_internal_reader :bot, :payload, :payload_type, :update, :webhook_request
       delegate :username, to: :bot, prefix: true, allow_nil: true
 
-      # Second argument can be either update object with hash access & string
+      # `update` can be either update object with hash access & string
       # keys or Hash with `:from` or `:chat` to override this values and assume
       # that update is nil.
-      def initialize(bot = nil, update = nil)
+      # ActionDispatch::Request object is passed in `webhook_request` when bot running
+      # in webhook mode.
+      def initialize(bot = nil, update = nil, webhook_request = nil)
         if update.is_a?(Hash) && (update.key?(:from) || update.key?(:chat))
           options = update
           update = nil
         end
-        @_update = update
         @_bot = bot
+        @_update = update
         @_chat, @_from = options && options.values_at(:chat, :from)
         @_payload, @_payload_type = self.class.payload_from_update(update)
+        @_webhook_request = webhook_request
       end
 
       # Accessor to `'chat'` field of payload. Also tries `'chat'` in `'message'`

lib/telegram/bot/updates_controller/message_context.rb

@@ -11,7 +11,7 @@ module Telegram
       #       respond_with :message, text: 'Where are you?'
       #     end
       #
-      #     def set_location_from_messge(city = nil, *)
+      #     def set_location_from_message(city = nil, *)
       #       # update
       #     end
       #

lib/telegram/bot/updates_controller/rspec_helpers.rb

@@ -13,8 +13,9 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
       x.extend Telegram::Bot::UpdatesController::Testing
     end
   end
-  let(:controller_args) { [bot, deep_stringify(update)] }
+  let(:controller_args) { [bot, deep_stringify(update), webhook_request] }
   let(:update) { {payload_type => payload} }
+  let(:webhook_request) { nil }
   let(:payload_type) { :some_type }
   let(:payload) { double(:payload) }
   let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
@@ -22,8 +23,8 @@ RSpec.shared_context 'telegram/bot/updates_controller' do
   let(:session) { controller.send(:session) }
 
   # Process update.
-  def dispatch(update = self.update, bot = self.bot)
+  def dispatch(update = self.update, bot = self.bot, webhook_request = self.webhook_request)
-    controller.dispatch_again(bot, deep_stringify(update))
+    controller.dispatch_again(bot, deep_stringify(update), webhook_request)
   end
 
   # Same as `.as_json` but mocks-friendly.

lib/telegram/bot/updates_controller/testing.rb

@@ -5,9 +5,9 @@ module Telegram
         IVARS_TO_KEEP = %i[@_session].freeze
 
         # Perform multiple dispatches on same instance.
-        def dispatch_again(bot = nil, update = nil)
+        def dispatch_again(bot = nil, update = nil, webhook_request = nil)
           recycle!
-          initialize(bot, update)
+          initialize(bot, update, webhook_request)
           dispatch
         end
 

lib/telegram/bot/updates_controller/typed_update.rb

@@ -4,7 +4,7 @@ module Telegram
       # Include this module to type cast update to Virtus model
       # using `telegram-bot-types` gem (install this gem first).
       module TypedUpdate
-        def initialize(bot = nil, update = nil)
+        def initialize(bot = nil, update = nil, webhook_request = nil)
           update = Types::Update.new(update) if update && !update.is_a?(Types::Update)
           super
         end

lib/telegram/bot/version.rb

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

spec/integration/requests/default_bot_spec.rb

@@ -10,4 +10,13 @@ RSpec.describe DefaultBotController, telegram_bot: :rails do
     subject { -> { dispatch_command :load_session } }
     it { should_not raise_error }
   end
+
+  describe '#dispatch' do
+    it 'provides webhook_request' do
+      expect(described_class).to receive(:dispatch).
+        with(bot, hash_including('message'), instance_of(ActionDispatch::Request)).
+        and_call_original
+      dispatch_message :test
+    end
+  end
 end

spec/telegram/bot/middleware_spec.rb

@@ -24,7 +24,8 @@ RSpec.describe Telegram::Bot::Middleware do
     end
 
     it 'calls dispatch on controller' do
-      expect(controller).to receive(:dispatch).with(bot, update)
+      expect(controller).to receive(:dispatch).
+        with(bot, update, instance_of(ActionDispatch::Request))
       subject
     end
 

spec/telegram/bot/rspec/integration/poller_spec.rb

@@ -2,4 +2,13 @@ require 'telegram/bot/rspec/integration/poller'
 
 RSpec.describe 'Poller integration spec', telegram_bot: :poller do
   include_examples 'shared integration examples'
+
+  describe '#dispatch' do
+    it 'doesn`t provide webhook_request' do
+      expect(controller_class).to receive(:dispatch).
+        with(bot, hash_including('message')).
+        and_call_original
+      dispatch_message :test
+    end
+  end
 end

spec/telegram/bot/rspec/integration/rack_spec.rb

@@ -17,4 +17,13 @@ RSpec.describe 'Rack integration spec', telegram_bot: :rack do
       ActionDispatch::ParamsParser.new(app)
     end
   end
+
+  describe '#dispatch' do
+    it 'provides webhook_request' do
+      expect(controller_class).to receive(:dispatch).
+        with(bot, hash_including('message'), instance_of(ActionDispatch::Request)).
+        and_call_original
+      dispatch_message :test
+    end
+  end
 end

spec/telegram/bot/updates_controller/testing_spec.rb

@@ -1,3 +1,5 @@
+require 'action_dispatch'
+
 RSpec.describe Telegram::Bot::UpdatesController::Testing do
   include_context 'telegram/bot/updates_controller'
   let(:controller_class) do
@@ -24,4 +26,27 @@ RSpec.describe Telegram::Bot::UpdatesController::Testing do
       it { should_not change { controller.send(:session)[:key] }.from 'sval' }
     end
   end
+
+  describe '#dispatch' do
+    it 'doesn`t provide webhook_request' do
+      dispatch
+      expect(controller.webhook_request).to eq nil
+    end
+
+    context 'when webhook_request is set' do
+      let(:webhook_request) { ActionDispatch::Request.new({}) }
+      it 'passes it to controller' do
+        dispatch
+        expect(controller.webhook_request).to eq webhook_request
+      end
+    end
+
+    context 'when webhook_request is given' do
+      it 'passes it to controller' do
+        webhook_request = ::ActionDispatch::Request.new({})
+        dispatch(update, bot, webhook_request)
+        expect(controller.webhook_request).to eq webhook_request
+      end
+    end
+  end
 end

spec/telegram/bot/updates_controller/typed_update_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate do
       edited_channel_post
       my_chat_member
       chat_member
+      chat_join_request
     ]).
       map { |x| [x, Telegram::Bot::Types.const_get(x.camelize)] }.to_h.
       merge(

spec/telegram/bot/updates_controller_spec.rb

@@ -46,6 +46,7 @@ RSpec.describe Telegram::Bot::UpdatesController do
       chosen_inline_result
       callback_query
       poll_answer
+      chat_join_request
     ]
     (described_class::PAYLOAD_TYPES - custom_payload_types).each do |type|
       context "when payload is #{type}" do

telegram-bot.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_dependency 'actionpack', '>= 4.0', '< 7.1'
+  spec.add_dependency 'actionpack', '>= 4.0', '< 7.2'
-  spec.add_dependency 'activesupport', '>= 4.0', '< 7.1'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 7.2'
   spec.add_dependency 'httpclient', '~> 2.7'
 
   spec.add_development_dependency 'bundler', '> 1.16'