telegram-bot 0.14.4 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 600d9d8e3bee50caefa1959a0334b35cd2fc36308296d66cd28be8eac6d46683
-  data.tar.gz: db65a62e6eda50dc825c56a6eca3ff08dbaf501eab80787814d526d6caad2f69
+  metadata.gz: 36fa85feb323b053ce1768ed84b40d1c69d0e8fc78b5dc7aee1f699462f3b4d2
+  data.tar.gz: 56b342a641205785fecf430bdde6601b7105f5ec3446e45f7388fe8312f77b24
 SHA512:
-  metadata.gz: 631e57ecb48e06319bd06084843a827f6130e65317fa87191649edaeb54615f7af9c9ceaa2a269b7fa126fd82daf18052b9640ca4b52a6b253e4a63a357efc32
-  data.tar.gz: 6e8c874e2c12b8030b3e6fb413f2073eab28aaa81cdf030b4e87809a61556c4f6326263fe3bf2c221ff3a1132ad02ecaa6e6a527163045bb640dfba7b2c335aa
+  metadata.gz: cfca483374037e8bc4fdd70dd0c321c3b5bf37ac877a905acae8d93befd9c9ecdf8f537357852bbb095efbb247db9408d4cad78893fb245c0c0c8278b02463f4
+  data.tar.gz: 39f34eda4df97c673f2f482290642a5ec186d2b0017f95f4edef28a8adef055db8f1e47504c849556b0f6ab0167326ea5fc29009279442705840afb490838bee

data/.rubocop.yml

@@ -40,6 +40,7 @@ Style/IfUnlessModifier: {Enabled: false}
 # Consistent to other definitions.
 Style/EmptyMethod: {EnforcedStyle: expanded}
 
+Style/Lambda: {EnforcedStyle: literal}
 Style/ModuleFunction: {Enabled: false}
 Style/NestedParenthesizedCalls: {Enabled: false}
 Style/SignalException: {EnforcedStyle: only_raise}

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Unreleased
 
+# 0.15.0
+
+- Add `:path` option to `telegram_webhook` route helper.
+- __Breaking change!__ Default route is generated using hashed bot token.
+  Please reconfigure webhook after update (`rake telegram:bot:set_webhook`).
+- Update to Bot API 5.0, add rake tasks for `deleteWebhook`, `close` & `logOut`.
+- Add `server` option for client to support local bot API servers.
+
 # 0.14.4
 
 - Update to Bot API 4.7

data/README.md

@@ -4,8 +4,6 @@
 [![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)
 
-__Breaking changes in v0.14!__ See [upgrade guide](https://github.com/telegram-bot-rb/telegram-bot/wiki/Upgrading-to-0.14).
-
 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).
 Supposed to be used in webhook-mode in production, and poller-mode
@@ -65,7 +63,11 @@ which is used for `Telegram.bot`.
 ```ruby
 Telegram.bots_config = {
   default: DEFAULT_BOT_TOKEN,
-  chat: {token: CHAT_BOT_TOKEN, username: 'chatbot'},
+  chat: {
+    token: CHAT_BOT_TOKEN,
+    username: 'ChatBot', # to support commands with mentions (/help@ChatBot)
+    server: 'http://local.bot.api.server', # for Local Bot API Server
+  },
 }
 
 Telegram.bot.get_updates
@@ -87,6 +89,7 @@ development:
     bot:
       token: TOKEN
       username: SomeBot
+      server: http://local.bot.api.server
 
     # For multiple bots in single app use hash of `internal_bot_id => settings`
     bots:
@@ -366,7 +369,7 @@ end
 ### Routes in Rails app
 
 There is `telegram_webhook` helper for rails app to define routes for webhooks.
-It defines routes at `telegram/#{bot.token}` and connects bots with controller.
+It defines routes at `telegram/#{hash_of(bot.token)}` and connects bots with controller.
 
 ```ruby
 # Most off apps would require

data/bin/fetch-telegram-methods

@@ -25,7 +25,7 @@ method_list = headers.
   map { |g| g.reject { |x| x.match?(NOT_METHOD_REGEXP) } }.
   reject(&:empty?)
 
-api_version = doc.text.match(/^(Bot API ([\d\.]+))\.?$/)
+api_version = doc.text.match(/^(?:Introducing )?(Bot API ([\d\.]+))\.?$/)
 
 result = ['# Generated with bin/fetch-telegram-methods']
 result << "# #{api_version[1]}" if api_version

data/lib/tasks/telegram-bot.rake

@@ -14,15 +14,22 @@ namespace :telegram do
 
     desc 'Set webhook urls for all bots'
     task set_webhook: :environment do
-      routes = Rails.application.routes.url_helpers
-      cert_file = ENV['CERT']
-      cert = File.open(cert_file) if cert_file
-      Telegram.bots.each do |key, bot|
-        route_name = Telegram::Bot::RoutesHelper.route_name_for_bot(bot)
-        url = routes.send("#{route_name}_url")
-        puts "Setting webhook for #{key}..."
-        bot.async(false) { bot.set_webhook(url: url, certificate: cert) }
-      end
+      Telegram::Bot::Tasks.set_webhook
+    end
+
+    desc 'Delete webhooks for all or specific BOT'
+    task :delete_webhook do
+      Telegram::Bot::Tasks.delete_webhook
+    end
+
+    desc 'Perform logOut command for all or specific BOT'
+    task :log_out do
+      Telegram::Bot::Tasks.log_out
+    end
+
+    desc 'Perform `close` command for all or specific BOT'
+    task :close do
+      Telegram::Bot::Tasks.close
     end
   end
 end

data/lib/telegram/bot.rb

@@ -14,10 +14,10 @@ module Telegram
 
     module_function
 
-    def deprecation_0_15
+    def deprecation_0_16
       @deprecation ||= begin
         require 'active_support/deprecation'
-        ActiveSupport::Deprecation.new('0.15', 'Telegram::Bot')
+        ActiveSupport::Deprecation.new('0.16', 'Telegram::Bot')
       end
     end
 
@@ -25,9 +25,9 @@ module Telegram
     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 :Tasks,              'telegram/bot/tasks'
     autoload :UpdatesController,  'telegram/bot/updates_controller'
     autoload :UpdatesPoller,      'telegram/bot/updates_poller'
   end

data/lib/telegram/bot/client.rb

@@ -1,13 +1,14 @@
+require 'active_support/core_ext/hash/keys'
 require 'json'
 require 'httpclient'
 
 module Telegram
   module Bot
     class Client
-      URL_TEMPLATE = 'https://api.telegram.org/bot%<token>s/'.freeze
+      SERVER = 'https://api.telegram.org'.freeze
+      URL_TEMPLATE = '%<server>s/bot%<token>s/'.freeze
 
       autoload :TypedResponse, 'telegram/bot/client/typed_response'
-      extend Initializers
       prepend Async
       include DebugClient
 
@@ -15,6 +16,16 @@ module Telegram
       include ApiHelper
 
       class << self
+        # 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)
           Telegram.bots[id]
         end
@@ -51,11 +62,11 @@ module Telegram
 
       attr_reader :client, :token, :username, :base_uri
 
-      def initialize(token = nil, username = nil, **options)
+      def initialize(token = nil, username = nil, server: SERVER, **options)
         @client = HTTPClient.new
         @token = token || options[:token]
         @username = username || options[:username]
-        @base_uri = format(URL_TEMPLATE, token: self.token)
+        @base_uri = format(URL_TEMPLATE, server: server, token: self.token)
       end
 
       def request(action, body = {})

data/lib/telegram/bot/client/api_methods.txt

@@ -1,5 +1,5 @@
 # Generated with bin/fetch-telegram-methods
-# Bot API 4.7
+# Bot API 5.0
 
 getUpdates
 setWebhook
@@ -7,8 +7,11 @@ deleteWebhook
 getWebhookInfo
 
 getMe
+logOut
+close
 sendMessage
 forwardMessage
+copyMessage
 sendPhoto
 sendAudio
 sendDocument
@@ -40,6 +43,7 @@ setChatTitle
 setChatDescription
 pinChatMessage
 unpinChatMessage
+unpinAllChatMessages
 leaveChat
 getChat
 getChatAdministrators

data/lib/telegram/bot/routes_helper.rb

@@ -1,3 +1,6 @@
+require 'base64'
+require 'openssl'
+
 require 'telegram/bot'
 require 'active_support/core_ext/array/wrap'
 
@@ -17,10 +20,8 @@ module Telegram
           end || 'telegram_webhook'
         end
 
-        # Replaces colon with underscore so rails don't treat it as
-        # route parameter.
-        def escape_token(token)
-          token && token.tr(':', '_')
+        def token_hash(token)
+          Base64.urlsafe_encode64(OpenSSL::Digest::SHA1.digest(token), padding: false)
         end
       end
 
@@ -34,14 +35,17 @@ module Telegram
       #
       #   # pass additional options
       #   telegram_webhook TelegramController, :default, as: :custom_route_name
-      def telegram_webhook(controller, bot = :default, **options)
+      #
+      #   # Default path is generated using hashed bot token. Override it using:
+      #   telegram_webhook TelegramController, :default, path: 'top/secret'
+      def telegram_webhook(controller, bot = :default, path: nil, **options)
         bot = Client.wrap(bot)
         params = {
           to: Middleware.new(bot, controller),
           as: RoutesHelper.route_name_for_bot(bot),
           format: false,
         }.merge!(options)
-        post("telegram/#{RoutesHelper.escape_token bot.token}", params)
+        post(path || "telegram/#{bot.token && RoutesHelper.token_hash(bot.token)}", params)
         UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
       end
     end

data/lib/telegram/bot/tasks.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Tasks
+      extend self
+
+      def set_webhook
+        routes = Rails.application.routes.url_helpers
+        cert_file = ENV['CERT']
+        cert = File.open(cert_file) if cert_file
+        each_bot do |key, bot|
+          route_name = RoutesHelper.route_name_for_bot(bot)
+          url = routes.send("#{route_name}_url")
+          say("Setting webhook for #{key}...")
+          bot.set_webhook(
+            url: url,
+            certificate: cert,
+            ip_address: ENV['IP_ADDRESS'],
+            drop_pending_updates: drop_pending_updates,
+          )
+        end
+      end
+
+      def delete_webhook
+        each_bot do |key, bot|
+          say("Deleting webhook for #{key}...")
+          bot.delete_webhook(drop_pending_updates: drop_pending_updates)
+        end
+      end
+
+      def log_out
+        each_bot do |key, bot|
+          say("Logging out #{key}...")
+          bot.log_out
+        end
+      end
+
+      def close
+        each_bot do |key, bot|
+          say("Closing #{key}...")
+          bot.close
+        end
+      end
+
+      private
+
+      def say(text)
+        puts(text) unless Rails.env.test? # rubocop:disable Rails/Output
+      end
+
+      def each_bot(&block)
+        id = ENV['BOT'].try!(:to_sym)
+        bots = id ? {id => Client.by_id(id)} : Telegram.bots
+        bots.each { |key, bot| bot.async(false) { block[key, bot] } }
+      end
+
+      def drop_pending_updates
+        ENV['DROP_PENDING_UPDATES'].try!(:downcase) == 'true'
+      end
+    end
+  end
+end

data/lib/telegram/bot/updates_poller.rb

@@ -50,7 +50,7 @@ module Telegram
         ensure
           @running = false
         end
-        log { 'Stoped polling bot updates.' }
+        log { 'Stopped polling bot updates.' }
       end
 
       def run

data/lib/telegram/bot/version.rb

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

data/telegram-bot.gemspec

@@ -17,9 +17,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.post_install_message = 'Breaking changes in v0.14! ' \
-    'See upgrade guide at https://github.com/telegram-bot-rb/telegram-bot/wiki/Upgrading-to-0.14'
-
   spec.required_ruby_version = '~> 2.0'
 
   spec.add_dependency 'actionpack', '>= 4.0', '< 6.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-bot
 version: !ruby/object:Gem::Version
-  version: 0.14.4
+  version: 0.15.0
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -131,19 +131,18 @@ files:
 - lib/telegram/bot/client_stub.rb
 - lib/telegram/bot/config_methods.rb
 - lib/telegram/bot/debug_client.rb
-- lib/telegram/bot/initializers.rb
 - lib/telegram/bot/middleware.rb
 - lib/telegram/bot/railtie.rb
 - lib/telegram/bot/routes_helper.rb
 - lib/telegram/bot/rspec.rb
 - lib/telegram/bot/rspec/callback_query_helpers.rb
 - lib/telegram/bot/rspec/client_matchers.rb
-- lib/telegram/bot/rspec/integration.rb
 - lib/telegram/bot/rspec/integration/poller.rb
 - lib/telegram/bot/rspec/integration/rack.rb
 - lib/telegram/bot/rspec/integration/rails.rb
 - lib/telegram/bot/rspec/integration/shared.rb
 - lib/telegram/bot/rspec/message_helpers.rb
+- lib/telegram/bot/tasks.rb
 - lib/telegram/bot/updates_controller.rb
 - lib/telegram/bot/updates_controller/callback_query_context.rb
 - lib/telegram/bot/updates_controller/commands.rb
@@ -164,7 +163,7 @@ homepage: https://github.com/telegram-bot-rb/telegram-bot
 licenses:
 - MIT
 metadata: {}
-post_install_message: Breaking changes in v0.14! See upgrade guide at https://github.com/telegram-bot-rb/telegram-bot/wiki/Upgrading-to-0.14
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -179,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Library for building Telegram Bots with Rails integration

data/lib/telegram/bot/initializers.rb

@@ -1,21 +0,0 @@
-require 'active_support/core_ext/hash/keys'
-
-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

data/lib/telegram/bot/rspec/integration.rb

@@ -1,10 +0,0 @@
-require 'telegram/bot'
-Telegram::Bot.deprecation_0_15.warn(
-  "`require 'telegram/bot/rspec/integration'` is deprecated in favor of " \
-  "`require 'telegram/bot/rspec/integration/rails'`"
-)
-require 'telegram/bot/rspec/integration/rails'
-
-Telegram::Bot::RSpec.with_include_context do |config|
-  config.include_context 'telegram/bot/integration/rails', telegram_bot: true
-end