Merge pull request #163 from telegram-bot-rb/update_api

Update to Bot API 5.3

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Unreleased
 
+# 0.15.4
+
+- Update to Bot API 5.3
+
+# 0.15.3
+
+- Ruby 3.0 support: fix translation helpers.
+
 # 0.15.2
 
 - Ruby 3.0 support. Drop support for Ruby < 2.4.

Gemfile

@@ -8,7 +8,7 @@ group :development do
   gem 'pry-byebug', '~> 3.9.0'
   gem 'sdoc', '~> 2.0.3'
 
-  gem 'telegram-bot-types', '~> 0.6.2'
+  gem 'telegram-bot-types', '~> 0.6.3'
 
   gem 'rspec', '~> 3.10.0'
   gem 'rspec-its', '~> 1.3.0'

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://travis-ci.org/telegram-bot-rb/telegram-bot.svg)](https://travis-ci.org/telegram-bot-rb/telegram-bot)
+[![Build Status](https://travis-ci.com/telegram-bot-rb/telegram-bot.svg)](https://travis-ci.com/telegram-bot-rb/telegram-bot)
 
 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).
@@ -25,9 +25,33 @@ with session, keyboards and inline queries.
 Run it on your local machine in 1 minute!
 
 And here is [app template](https://github.com/telegram-bot-rb/rails_template)
-to generate clean app in seconds.
+to generate new rails app in seconds.
 
-Examples and cookbook in [wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
+See examples and cookbook in [the wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Configuration](#configuration)
+  * [Configuration in Rails app](#configuration-in-rails-app)
+  * [Client](#client)
+    * [Typed responses](#typed-responses)
+  * [Controller](#controller)
+    * [Reply helpers](#reply-helpers)
+    * [Optional typecasting](#optional-typecasting)
+    * [Session](#session)
+    * [Message context](#message-context)
+    * [Callback queries](#callback-queries)
+  * [Routes in Rails app](#routes-in-rails-app)
+    * [Processing updates](#processing-updates)
+  * [Development & Debugging](#development--debugging)
+  * [Testing](#testing)
+  * [Deployment](#deployment)
+  * [Async mode](#async-mode)
+    * [Limitations](#limitations)
+* [Development](#development)
+* [Contributing](#contributing)
 
 ## Installation
 
@@ -39,11 +63,15 @@ gem 'telegram-bot'
 
 And then execute:
 
-    $ bundle
+```
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install telegram-bot
+```
+gem install telegram-bot
+```
 
 Require if necessary:
 
@@ -170,19 +198,18 @@ Bot controllers like usual rails controllers provides features like callbacks,
 
 ```ruby
 class Telegram::WebhookController < Telegram::Bot::UpdatesController
-  # use callbacks like in any other controllers
+  # use callbacks like in any other controller
   around_action :with_locale
 
-  # Every update can have one of: message, inline_query, chosen_inline_result,
+  # Every update has one of: message, inline_query, chosen_inline_result,
   # callback_query, etc.
-  # Define method with same name to respond to this updates.
+  # Define method with the same name to handle this type of update.
   def message(message)
-    # message can be also accessed via instance method
-    message == self.payload # true
     # store_message(message['text'])
   end
 
-  # This basic methods receives commonly used params:
+  # For the following types of updates commonly used params are passed as arguments,
+  # full payload object is available with `payload` instance method.
   #
   #   message(payload)
   #   inline_query(query, offset)
@@ -193,14 +220,19 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
   # Command arguments will be parsed and passed to the method.
   # Be sure to use splat args and default values to not get errors when
   # someone passed more or less arguments in the message.
-  def start!(data = nil, *)
-    # do_smth_with(data)
+  def start!(word = nil, *other_words)
+    # do_smth_with(word)
+
+    # full message object is also available via `payload` instance method:
+    # process_raw_message(payload['text'])
 
     # There are `chat` & `from` shortcut methods.
-    # For callback queries `chat` if taken from `message` when it's available.
+    # For callback queries `chat` is 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
+
     # `reply_with` also sets `reply_to_message_id`:
     reply_with :photo, photo: File.open('party.jpg')
   end
@@ -223,10 +255,10 @@ end
 
 #### Reply helpers
 
-There are helpers to respond for basic actions. They just set chat/message/query
-identifiers from update. See
+There are helpers for basic responses. They just set chat/message/query
+identifiers from the update. See
 [`ReplyHelpers`](https://github.com/telegram-bot-rb/telegram-bot/blob/master/lib/telegram/bot/updates_controller/reply_helpers.rb)
-module for more information. Here are this methods signatures:
+module for more information. Here are these methods signatures:
 
 ```ruby
 def respond_with(type, params); end
@@ -389,7 +421,7 @@ telegram_webhook TelegramAuctionController, :auction
 telegram_webhook TelegramController, as: :custom_telegram_webhook
 ```
 
-#### Processesing updates
+#### Processing updates
 
 To process update with controller call `.dispatch(bot, update)` on it.
 There are several options to run it automatically:

lib/telegram/bot/client/api_methods.txt

@@ -1,5 +1,5 @@
 # Generated with bin/fetch-telegram-methods
-# Bot API 5.0
+# Bot API 5.3
 
 getUpdates
 setWebhook
@@ -30,13 +30,16 @@ sendDice
 sendChatAction
 getUserProfilePhotos
 getFile
-kickChatMember
+banChatMember
 unbanChatMember
 restrictChatMember
 promoteChatMember
 setChatAdministratorCustomTitle
 setChatPermissions
 exportChatInviteLink
+createChatInviteLink
+editChatInviteLink
+revokeChatInviteLink
 setChatPhoto
 deleteChatPhoto
 setChatTitle
@@ -47,12 +50,13 @@ unpinAllChatMessages
 leaveChat
 getChat
 getChatAdministrators
-getChatMembersCount
+getChatMemberCount
 getChatMember
 setChatStickerSet
 deleteChatStickerSet
 answerCallbackQuery
 setMyCommands
+deleteMyCommands
 getMyCommands
 
 editMessageText

lib/telegram/bot/updates_controller.rb

@@ -99,6 +99,8 @@ module Telegram
         pre_checkout_query
         poll
         poll_answer
+        my_chat_member
+        chat_member
       ].freeze
 
       class << self

lib/telegram/bot/updates_controller/translation.rb

@@ -12,15 +12,15 @@ module Telegram
 
         module ClassMethods
           # Class-level helper for lazy translations.
-          def translate(key, options = {})
+          def translate(key, **options)
             key = "#{controller_path.tr('/', '.')}#{key}" if key.to_s.start_with?('.')
-            I18n.translate(key, options)
+            I18n.translate(key, **options)
           end
           alias :t :translate
         end
 
         # See toplevel description.
-        def translate(key, options = {})
+        def translate(key, **options)
           if key.to_s.start_with?('.')
             path = controller_path.tr('/', '.')
             defaults = [:"#{path}#{key}"]
@@ -28,7 +28,7 @@ module Telegram
             options[:default] = defaults.flatten
             key = "#{path}.#{action_name_i18n_key}#{key}"
           end
-          I18n.translate(key, options)
+          I18n.translate(key, **options)
         end
         alias :t :translate
 

lib/telegram/bot/version.rb

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

spec/telegram/bot/updates_controller/translation_spec.rb

@@ -1,5 +1,26 @@
 RSpec.describe Telegram::Bot::UpdatesController::Translation do
+  def self.stub_translations(translations)
+    around do |ex|
+      backend = I18n.backend
+      I18n.backend = I18n::Backend::Simple.new
+      begin
+        I18n.backend.store_translations 'en', telegram: {webhooks: translations}
+        ex.run
+      ensure
+        I18n.backend = backend
+      end
+    end
+  end
+  let(:result) { double(:result) }
+
   describe '#translate' do
+    stub_translations(
+      start: {
+        hello: 'Hello from start!',
+        hi: 'Hi %{name} from start', # rubocop:disable Style/FormatStringToken
+      },
+    )
+
     let(:controller) do
       double(
         controller_path: 'telegram/webhooks',
@@ -10,12 +31,28 @@ RSpec.describe Telegram::Bot::UpdatesController::Translation do
     it 'uses action_name without ! for lazy translations' do
       expect(I18n).to receive(:translate).with('telegram.webhooks.start.hello',
         default: [:'telegram.webhooks.hello'],
-      )
-      controller.t('.hello')
+      ) { result }
+      expect(controller.t('.hello')).to eq(result)
+
+      expect(I18n).to receive(:translate).with('telegram.webhooks.start.hi',
+        default: [:'telegram.webhooks.hi'],
+        name: 'Dude',
+      ) { result }
+      expect(controller.t('.hi', name: 'Dude')).to eq(result)
+    end
+
+    it 'translates' do
+      expect(controller.t('.hello')).to eq('Hello from start!')
+      expect(controller.t('.hi', name: 'Dude')).to eq('Hi Dude from start')
     end
   end
 
   describe described_class::ClassMethods do
+    stub_translations(
+      hello: 'Hello!',
+      hi: 'Hi %{name}', # rubocop:disable Style/FormatStringToken
+    )
+
     describe '#translate' do
       let(:controller_class) do
         double(controller_path: 'telegram/webhooks').
@@ -23,8 +60,20 @@ RSpec.describe Telegram::Bot::UpdatesController::Translation do
       end
 
       it 'uses controller_path for lazy translations' do
-        expect(I18n).to receive(:translate).with('telegram.webhooks.hello', {})
-        controller_class.t('.hello')
+        expect(I18n).to receive(:translate) do |*args, **kwargs|
+          # not using .with to support ruby 2.x and 3.x
+          expect([*args, kwargs]).to eq(['telegram.webhooks.hello', {}])
+          result
+        end
+        expect(controller_class.t('.hello')).to eq(result)
+
+        expect(I18n).to receive(:translate).with('telegram.webhooks.hi', name: 'Dude') { result }
+        expect(controller_class.t('.hi', name: 'Dude')).to eq(result)
+      end
+
+      it 'translates' do
+        expect(controller_class.t('.hello')).to eq('Hello!')
+        expect(controller_class.t('.hi', name: 'Dude')).to eq('Hi Dude')
       end
     end
   end

spec/telegram/bot/updates_controller/typed_update_spec.rb

@@ -9,14 +9,19 @@ RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate do
 
   context 'when `update` is a virtus model' do
     subject { controller }
-    unique_types = Telegram::Bot::UpdatesController::PAYLOAD_TYPES - %w[
+    unique_types = (Telegram::Bot::UpdatesController::PAYLOAD_TYPES - %w[
       edited_message
       channel_post
       edited_channel_post
-    ]
-    unique_types.each do |type|
+      my_chat_member
+      chat_member
+    ]).
+      map { |x| [x, Telegram::Bot::Types.const_get(type.camelize)] }.to_h.
+      merge(
+        'chat_member' => Telegram::Bot::Types::ChatMemberUpdated
+      )
+    unique_types.each do |type, type_class|
       context "with #{type}" do
-        type_class = Telegram::Bot::Types.const_get(type.camelize)
         let(:payload_type) { type }
         let(:payload) do
           {}.tap do |result|