telegram-bot 0.12.4 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1e4241ed0e42a58308758e38cd7aba2f377b518
-  data.tar.gz: 2433f93912e2ed5656ddcb2fec42e09652f73458
+  metadata.gz: fd54d434c70a78a128767db94de31a6fbf07ca11
+  data.tar.gz: 669957947937536ba2257af7362d97c75e82a236
 SHA512:
-  metadata.gz: ea6b59982b236a96a24d90778ee2055a9cd50088d17b7fbc764e89cf6794a53bdb5df4b99204123ff54b1a27e8f298d86e1d9d5d43950ee3544e01a3ac200c03
-  data.tar.gz: 3c451c937b2b79da1fb66745be8041b29c32f05b3ab97bb6c37a18d9ad2e2853e0c33d925c5b29040ab13b73f85ce1ff8176ebf26cae3c412579355d64331698
+  metadata.gz: abaa6ac4240292eb5200fca36b3fc30e9e30a9232a4694cf797ef3754eb8240c728203718b6a29bf8b29792b0e9312b93bfbccc5682cfaef250a12ec95e6e9e6
+  data.tar.gz: 77715ec8f7cc3f2f9752d1ab3faa821dbbbaf748f8c90dcc450c351e8786150301c84e1d78c87f2ae974b5413e12a49c5617fdec737d5864837ba0cc3fb1ad3a

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+checks:
+  method-complexity:
+    config:
+      threshold: 6 # should be just fine
+
+plugins:
+  rubocop:
+    enabled: true

data/.rubocop.yml

@@ -1,3 +1,6 @@
+# Rubocop does not support 2.0
+Gemspec/RequiredRubyVersion: {Enabled: false}
+
 Rails: {Enabled: true}
 
 Layout/AlignParameters:

data/.travis.yml

@@ -1,10 +1,17 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.2.3
+  - 2.5
+  - 2.4
+  - 2.3
 gemfile:
-  - gemfiles/rails_42.gemfile
-  - gemfiles/rails_50.gemfile
+  - gemfiles/rails_52.gemfile
   - gemfiles/rails_51.gemfile
+  - gemfiles/rails_50.gemfile
+  - gemfiles/rails_42.gemfile
 notifications:
   email: false
+
+# for 2.5.0 until 2.5.1 is released: https://github.com/travis-ci/travis-ci/issues/8978
+before_install:
+  - gem update --system

data/Appraisals

@@ -1,3 +1,8 @@
+appraise 'rails-52' do
+  gem 'actionpack', '~> 5.2.0.beta2'
+  gem 'railties', '~> 5.2.0.beta2'
+end
+
 appraise 'rails-51' do
   gem 'actionpack', '~> 5.1'
   gem 'railties', '~> 5.1'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Unreleased
 
+# 0.13.0
+
+- `rescue_from`.
+- Support for `credentials` store in Rails 5.2.
+- Deprecate `telegram_webhooks` in favor of `telegram_webhook`.
+  It was too complicated and such routes looked ugly.
+
 # 0.12.4
 
 - Fix spec helpers for callback queries.

data/Gemfile

@@ -14,7 +14,7 @@ group :development do
   gem 'rspec-its', '~> 1.1.0'
   gem 'rspec-rails', '~> 3.5.0'
 
-  gem 'rubocop', '~> 0.51.0'
+  gem 'rubocop', '~> 0.52.1'
 
   gem 'coveralls', '~> 0.8.2', require: false
 end

data/README.md

@@ -130,6 +130,9 @@ can represent actions as separate methods keeping source much more readable and
 New instance of controller is instantiated for each update.
 This way every update is processed in isolation from others.
 
+Bot controllers like usual rails controllers provides features like callbacks,
+`rescue_from` and instrumentation.
+
 ```ruby
 class Telegram::WebhookController < Telegram::Bot::UpdatesController
   # use callbacks like in any other controllers
@@ -325,29 +328,37 @@ Callback queries without prefix stay untouched.
 # This one handles `set_value:%{something}`.
 def set_value_callback_query(new_value = nil, *)
   save_this(value)
-  answer_callback_query('Saved!)
+  answer_callback_query('Saved!')
 end
 
 # And this one is for `make_cool:%{something}`
 def make_cool_callback_query(thing = nil, *)
   do_it(thing)
-  answer_callback_query("#{thing} is cool now! Like a callback query context.") 
+  answer_callback_query("#{thing} is cool now! Like a callback query context.")
 end
 ```
 
 ### Routes in Rails app
 
-There is `telegram_webhooks` helper for rails app to define routes for webhooks.
+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.
-For more options see [examples in wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki/Routes-helpers-in-details).
 
 ```ruby
-# Create routes for all Telegram.bots using single controller:
-telegram_webhooks TelegramController
+# Most off apps would require
+telegram_webhook TelegramController
+# which is same as
+telegram_webhook TelegramController, :default
 
 # Use different controllers for each bot:
-telegram_webhooks chat: TelegramChatController,
-                  auction: TelegramAuctionController
+telegram_webhook TelegramChatController, :chat
+telegram_webhook TelegramAuctionController, :auction
+
+# Defined route is named and its name depends on `Telegram.bots`.
+# For single bot it will use 'telegram_webhook',
+# for multiple bots it uses bot's key in the `Telegram.bots` as prefix
+# (eg. `chat_telegram_webhook`).
+# You can override this with `as` option:
+telegram_webhook TelegramController, as: :custom_telegram_webhook
 ```
 
 #### Processesing updates
@@ -360,7 +371,7 @@ There are several options to run it automatically:
 - Use poller (described in the next section).
 
 To run action without update (ex., send notifications from jobs),
-you can call `#process` directly. In this case controller can be initialized 
+you can call `#process` directly. In this case controller can be initialized
 with `:from` and/or `:chat` options instead of `update` object:
 
 ```ruby
@@ -374,7 +385,7 @@ Use `rake telegram:bot:poller` to run poller in rails app. It automatically load
 changes without restart in development env.
 Optionally pass bot id in `BOT` envvar (`BOT=chat`) to specify bot to run poller for.
 
-This task requires `telegram_webhooks` helper to be used as it connects bots with controller.
+This task requires `telegram_webhook` helper to be used as it connects bots with controller.
 To run poller in other cases use:
 
 ```ruby
@@ -523,7 +534,7 @@ Yes, it's threadsafe too.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies.
+After checking out the repo, run `bin/setup` to install dependencies and git hooks.
 Then, run `appraisal rake spec` to run the tests.
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/gemfiles/rails_42.gemfile

@@ -14,7 +14,7 @@ group :development do
   gem "rspec", "~> 3.5.0"
   gem "rspec-its", "~> 1.1.0"
   gem "rspec-rails", "~> 3.5.0"
-  gem "rubocop", "~> 0.51.0"
+  gem "rubocop", "~> 0.52.1"
   gem "coveralls", "~> 0.8.2", require: false
 end
 

data/gemfiles/rails_50.gemfile

@@ -14,7 +14,7 @@ group :development do
   gem "rspec", "~> 3.5.0"
   gem "rspec-its", "~> 1.1.0"
   gem "rspec-rails", "~> 3.5.0"
-  gem "rubocop", "~> 0.51.0"
+  gem "rubocop", "~> 0.52.1"
   gem "coveralls", "~> 0.8.2", require: false
 end
 

data/gemfiles/rails_51.gemfile

@@ -14,7 +14,7 @@ group :development do
   gem "rspec", "~> 3.5.0"
   gem "rspec-its", "~> 1.1.0"
   gem "rspec-rails", "~> 3.5.0"
-  gem "rubocop", "~> 0.51.0"
+  gem "rubocop", "~> 0.52.1"
   gem "coveralls", "~> 0.8.2", require: false
 end
 

data/gemfiles/rails_52.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 5.2.0.beta2"
+gem "railties", "~> 5.2.0.beta2"
+
+group :development do
+  gem "appraisal", "~> 2.2"
+  gem "pry", "~> 0.10.1"
+  gem "pry-byebug", "~> 3.2.0"
+  gem "sdoc", "~> 0.4.1"
+  gem "telegram-bot-types", "~> 0.3.0"
+  gem "rspec", "~> 3.5.0"
+  gem "rspec-its", "~> 1.1.0"
+  gem "rspec-rails", "~> 3.5.0"
+  gem "rubocop", "~> 0.52.1"
+  gem "coveralls", "~> 0.8.2", require: false
+end
+
+gemspec path: "../"

data/lib/telegram/bot.rb

@@ -5,9 +5,22 @@ module Telegram
 
   module Bot
     class Error < StandardError; end
-    class NotFound < Error; end
+
+    # Raised for valid telegram response with 403 status code.
     class Forbidden < Error; end
 
+    # Raised for valid telegram response with 404 status code.
+    class NotFound < Error; end
+
+    module_function
+
+    def deprecation_0_14
+      @deprecation ||= begin
+        require 'active_support/deprecation'
+        ActiveSupport::Deprecation.new('0.14', 'Telegram::Bot')
+      end
+    end
+
     autoload :Async,              'telegram/bot/async'
     autoload :Botan,              'telegram/bot/botan'
     autoload :Client,             'telegram/bot/client'

data/lib/telegram/bot/client.rb

@@ -4,7 +4,7 @@ require 'httpclient'
 module Telegram
   module Bot
     class Client
-      URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
+      URL_TEMPLATE = 'https://api.telegram.org/bot%<token>s/'.freeze
 
       autoload :TypedResponse, 'telegram/bot/client/typed_response'
       extend Initializers
@@ -36,6 +36,18 @@ module Telegram
         def prepare_async_args(action, body = {})
           [action.to_s, Async.prepare_hash(prepare_body(body))]
         end
+
+        def error_for_response(response)
+          result = JSON.parse(response.body) rescue nil # rubocop:disable RescueModifier
+          return Error.new(response.reason) unless result
+          message = result['description'] || '-'
+          # This errors are raised only for valid responses from Telegram
+          case response.status
+          when 403 then Forbidden.new(message)
+          when 404 then NotFound.new(message)
+          else Error.new("#{response.reason}: #{message}")
+          end
+        end
       end
 
       attr_reader :client, :token, :username, :base_uri
@@ -44,23 +56,13 @@ module Telegram
         @client = HTTPClient.new
         @token = token || options[:token]
         @username = username || options[:username]
-        @base_uri = format URL_TEMPLATE, self.token
+        @base_uri = format(URL_TEMPLATE, token: self.token)
       end
 
       def request(action, body = {})
-        res = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
-        status = res.status
-        return JSON.parse(res.body) if status < 300
-        result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
-        err_msg = result && result['description'] || '-'
-        if 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, "#{res.reason}: #{err_msg}"
+        response = http_request("#{base_uri}#{action}", self.class.prepare_body(body))
+        raise self.class.error_for_response(response) if response.status >= 300
+        JSON.parse(response.body)
       end
 
       # Endpoint for low-level request. For easy host highjacking & instrumentation.

data/lib/telegram/bot/config_methods.rb

@@ -53,8 +53,9 @@ module Telegram
       def bots_config
         @bots_config ||=
           if defined?(Rails.application)
-            secrets = Rails.application.secrets.
-              fetch(:telegram, {}).with_indifferent_access
+            app = Rails.application
+            store = app.respond_to?(:credentials) ? app.credentials : app.secrets
+            secrets = store.fetch(:telegram, {}).with_indifferent_access
             secrets.fetch(:bots, {}).symbolize_keys.tap do |config|
               default = secrets[:bot]
               config[:default] = default if default

data/lib/telegram/bot/routes_helper.rb

@@ -28,40 +28,49 @@ module Telegram
       #   telegram_webhooks TelegramController
       #
       #   # Or pass custom bots usin any of supported config options:
-      #   telegram_webhooks TelegramController,
-      #                     bot,
-      #                     {token: token, username: username},
-      #                     other_bot_token
-      #
-      #   # Use different controllers for each bot:
-      #   telegram_webhooks bot => TelegramChatController,
-      #                     other_bot => TelegramAuctionController
-      #
-      #   # telegram_webhooks creates named routes. See
-      #   # RoutesHelper.route_name_for_bot for more info.
-      #   # You can override this options or specify others:
-      #   telegram_webhooks TelegramController, as: :my_webhook
-      #   telegram_webhooks bot => [TelegramChatController, as: :chat_webhook],
-      #                     other_bot => TelegramAuctionController,
-      #                     admin_chat: TelegramAdminChatController
-      #
+      #   telegram_webhooks TelegramController, [
+      #     bot,
+      #     {token: token, username: username},
+      #     other_bot_token,
+      #   ]
       def telegram_webhooks(controllers, bots = nil, **options)
+        Bot.deprecation_0_14.deprecation_warning(:telegram_webhooks, <<-TXT.strip_heredoc)
+          It brings unnecessary complexity and encourages writeng less readable code.
+          Please use telegram_webhook method instead.
+          It's signature `telegram_webhook(controller, bot = :default, **options)`.
+          Multiple-bot environments now requires calling this method in a loop
+          or using statement for each bot.
+        TXT
         unless controllers.is_a?(Hash)
           bots = bots ? Array.wrap(bots) : Telegram.bots.values
           controllers = Hash[bots.map { |x| [x, controllers] }]
         end
         controllers.each do |bot, controller|
-          bot = Client.wrap(bot)
           controller, bot_options = controller if controller.is_a?(Array)
-          params = {
-            to: Middleware.new(bot, controller),
-            as: RoutesHelper.route_name_for_bot(bot),
-            format: false,
-          }.merge!(options).merge!(bot_options || {})
-          post("telegram/#{RoutesHelper.escape_token bot.token}", params)
-          UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
+          telegram_webhook(controller, bot, options.merge(bot_options || {}))
         end
       end
+
+      # Define route which processes requests using given controller and bot.
+      #
+      #   telegram_webhook TelegramController, bot
+      #
+      #   telegram_webhook TelegramController
+      #   # same as:
+      #   telegram_webhook TelegramController, :default
+      #
+      #   # pass additional options
+      #   telegram_webhook TelegramController, :default, as: :custom_route_name
+      def telegram_webhook(controller, bot = :default, **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)
+        UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
+      end
     end
   end
 end

data/lib/telegram/bot/updates_controller.rb

@@ -53,12 +53,19 @@ module Telegram
     class UpdatesController < AbstractController::Base # rubocop:disable ClassLength
       abstract!
 
-      require 'telegram/bot/updates_controller/session'
-      require 'telegram/bot/updates_controller/log_subscriber'
-      require 'telegram/bot/updates_controller/instrumentation'
-      require 'telegram/bot/updates_controller/reply_helpers'
-      autoload :CallbackQueryContext, 'telegram/bot/updates_controller/callback_query_context'
-      autoload :MessageContext, 'telegram/bot/updates_controller/message_context'
+      %w[
+        instrumentation
+        log_subscriber
+        reply_helpers
+        rescue
+        session
+      ].each { |file| require "telegram/bot/updates_controller/#{file}" }
+
+      %w[
+        CallbackQueryContext
+        MessageContext
+        TypedUpdate
+      ].each { |mod| autoload mod, "telegram/bot/updates_controller/#{mod.underscore}" }
 
       include AbstractController::Callbacks
       # Redefine callbacks with default terminator.
@@ -72,11 +79,11 @@ module Telegram
       end
 
       include AbstractController::Translation
+      include Rescue
       include ReplyHelpers
-      prepend Instrumentation
-      extend Session::ConfigMethods
+      include Instrumentation
 
-      autoload :TypedUpdate, 'telegram/bot/updates_controller/typed_update'
+      extend Session::ConfigMethods
 
       PAYLOAD_TYPES = %w[
         message
@@ -113,10 +120,17 @@ module Telegram
         # any commands.
         def command_from_text(text, username = nil)
           return unless text
-          match = text.match CMD_REGEX
+          match = text.match(CMD_REGEX)
           return unless match
-          return if match[3] && username != true && match[3] != username
-          [match[1], text.split.drop(1)]
+          mention = match[3]
+          [match[1], text.split.drop(1)] if username == true || !mention || mention == username
+        end
+
+        def payload_from_update(update)
+          update && PAYLOAD_TYPES.find do |type|
+            item = update[type]
+            return [item, type] if item
+          end
         end
       end
 
@@ -135,13 +149,7 @@ module Telegram
         @_update = update
         @_bot = bot
         @_chat, @_from = options && options.values_at(:chat, :from)
-
-        payload_data = nil
-        update && PAYLOAD_TYPES.find do |type|
-          item = update[type]
-          payload_data = [item, type] if item
-        end
-        @_payload, @_payload_type = payload_data
+        @_payload, @_payload_type = self.class.payload_from_update(update)
       end
 
       # Accessor to `'chat'` field of payload. Also tries `'chat'` in `'message'`

data/lib/telegram/bot/updates_controller/instrumentation.rb

@@ -4,12 +4,13 @@ module Telegram
       # Most methods are taken from ActionController::Instrumentation,
       # some are slightly modified.
       module Instrumentation
-        class << self
-          def prepended(base)
-            base.send :config_accessor, :logger
-            base.extend ClassMethods
-          end
+        extend ActiveSupport::Concern
 
+        included do
+          config_accessor :logger
+        end
+
+        class << self
           def instrument(action, *args, &block)
             ActiveSupport::Notifications.instrument(
               "#{action}.updates_controller.bot.telegram",

data/lib/telegram/bot/updates_controller/rescue.rb

@@ -0,0 +1,20 @@
+require 'active_support/rescuable'
+
+module Telegram
+  module Bot
+    class UpdatesController
+      module Rescue
+        extend ActiveSupport::Concern
+        include ActiveSupport::Rescuable
+
+        private
+
+        def process_action(*)
+          super
+        rescue Exception => exception # rubocop:disable RescueException
+          rescue_with_handler(exception) || raise
+        end
+      end
+    end
+  end
+end

data/lib/telegram/bot/updates_poller.rb

@@ -41,40 +41,54 @@ module Telegram
 
       def start
         return if running
-        @running = true
-        log { 'Started bot poller.' }
+        begin
+          @running = true
+          log { 'Started bot poller.' }
+          run
+        rescue Interrupt
+          nil # noop
+        ensure
+          @running = false
+        end
+        log { 'Stoped polling bot updates.' }
+      end
+
+      def run
         while running
-          begin
-            fetch_updates do |update|
-              controller.dispatch(bot, update)
-            end
-          rescue Interrupt
-            @running = false
-          rescue StandardError => e
-            logger.error { ([e.message] + e.backtrace).join("\n") } if logger
-          end
+          updates = fetch_updates
+          process_updates(updates) if updates && updates.any?
         end
-        log { 'Stop polling bot updates.' }
       end
 
+      # Method to stop poller from other thread.
       def stop
         return unless running
-        log { 'Killing polling thread.' }
+        log { 'Stopping polling bot updates.' }
         @running = false
       end
 
-      def fetch_updates
+      def fetch_updates(offset = self.offset)
         response = bot.async(false) { bot.get_updates(offset: offset, timeout: timeout) }
-        updates = response.is_a?(Array) ? response : response['result']
-        return unless updates && updates.any?
+        response.is_a?(Array) ? response : response['result']
+      rescue Timeout::Error
+        log { 'Fetch timeout' }
+        nil
+      end
+
+      def process_updates(updates)
         reload! do
           updates.each do |update|
             @offset = update['update_id'] + 1
-            yield update
+            process_update(update)
           end
         end
-      rescue Timeout::Error
-        log { 'Fetch timeout' }
+      rescue StandardError => e
+        logger.error { ([e.message] + e.backtrace).join("\n") } if logger
+      end
+
+      # Override this method to setup custom error collector.
+      def process_update(update)
+        controller.dispatch(bot, update)
       end
 
       def reload!

data/lib/telegram/bot/version.rb

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

data/telegram-bot.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 4.0', '< 6.0'
   spec.add_dependency 'httpclient', '~> 2.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-bot
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.13.0
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2018-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -117,6 +118,7 @@ files:
 - gemfiles/rails_42.gemfile
 - gemfiles/rails_50.gemfile
 - gemfiles/rails_51.gemfile
+- gemfiles/rails_52.gemfile
 - lib/tasks/telegram-bot.rake
 - lib/telegram/bot.rb
 - lib/telegram/bot/async.rb
@@ -143,6 +145,7 @@ files:
 - lib/telegram/bot/updates_controller/log_subscriber.rb
 - lib/telegram/bot/updates_controller/message_context.rb
 - lib/telegram/bot/updates_controller/reply_helpers.rb
+- lib/telegram/bot/updates_controller/rescue.rb
 - lib/telegram/bot/updates_controller/rspec_helpers.rb
 - lib/telegram/bot/updates_controller/session.rb
 - lib/telegram/bot/updates_controller/testing.rb