0.9.0.alpha1

Fixes #11

.travis.yml

@@ -2,5 +2,8 @@ language: ruby
 cache: bundler
 rvm:
   - 2.2.3
+env:
+  - RAILS=4
+  - RAILS=5
 notifications:
   email: false

CHANGELOG.md

@@ -1,3 +1,26 @@
+# Unreleased
+
+- One more description for StaleChat error.
+
+# 0.8.0
+
+- Fixed `#reply_with`, now it sets `reply_to_message_id` as it's supposed to.
+  Added `#respond_with` which works the same way, but doesn't set `reply_to_message_id`.
+  Please, replace all occurrences of `reply_with` to `respond_with` to
+  keep it working the old way.
+- Fixes for Rails 5:
+  - Controller callbacks
+  - Middleware
+  - Setup travis builds
+
+# 0.7.4
+
+- Rails 5 support by @dreyks (#4).
+
+# 0.7.3
+
+-  Fixed issues with poller in production (#3)
+
 # 0.7.2
 
 - Bot API 2.1

Gemfile

@@ -1,6 +1,13 @@
 source 'https://rubygems.org'
 gemspec
 
+case ENV['RAILS']
+when '5'
+  gem 'actionpack', '5.0.0.rc1'
+when '4'
+  gem 'actionpack', '~> 4.2'
+end
+
 group :development do
   gem 'sdoc', '~> 0.4.1'
   gem 'pry', '~> 0.10.1'

README.md

@@ -5,7 +5,8 @@
 [![Build Status](https://travis-ci.org/telegram-bot-rb/telegram-bot.svg)](https://travis-ci.org/telegram-bot-rb/telegram-bot)
 
 Tools for developing bot for Telegram. Best used with Rails, but can be be used in
-standalone app. Supposed to be used in webhook-mode in production, and poller-mode
+[standalone app](https://github.com/telegram-bot-rb/telegram-bot/wiki/Non-rails-application).
+Supposed to be used in webhook-mode in production, and poller-mode
 in development, but you can use poller in production if you want.
 
 Package contains:
@@ -16,6 +17,7 @@ Package contains:
 - Middleware and routes helpers for production env.
 - Poller with automatic source-reloader for development env.
 - Rake tasks to update webhook urls.
+- Async requests for Telegram and/or Botan API. Let the queue adapter handle errors!
 
 Here is sample [telegram_bot_app](https://github.com/telegram-bot-rb/telegram_bot_app)
 with session, keyboards and inline queries.
@@ -131,9 +133,10 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
 
     # There are `chat` & `from` shortcut methods.
     response = from ? "Hello #{from['username']}!" : 'Hi there!'
-    # There is `reply_with` helper to set basic fields
-    # like `reply_to_message` & `chat_id`.
-    reply_with :message, text: response
+    # 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
 
   private
@@ -188,7 +191,7 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
   end
 
   def read
-    reply_with :message, text: session[:text]
+    respond_with :message, text: session[:text]
   end
 
   private
@@ -214,23 +217,23 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
   def rename(*)
     # set context for the next message
     save_context :rename
-    reply_with :message, text: 'What name do you like?'
+    respond_with :message, text: 'What name do you like?'
   end
 
   # register context handlers to handle this context
   context_handler :rename do |*words|
     update_name words[0]
-    reply_with :message, text: 'Renamed!'
+    respond_with :message, text: 'Renamed!'
   end
 
   # You can do it in other way:
   def rename(name = nil, *)
     if name
       update_name name
-      reply_with :message, text: 'Renamed!'
+      respond_with :message, text: 'Renamed!'
     else
       save_context :rename
-      reply_with :message, text: 'What name do you like?'
+      respond_with :message, text: 'What name do you like?'
     end
   end
 
@@ -351,11 +354,11 @@ or just add `botan` key in `secrets.yml`:
 Access to Botan client with `bot.botan`.
 Use `bot.botan.track(event, uid, payload)` to track events.
 
-There are some helpers for controllers in `Telegram::Bot::UpdatesController::Botan`:
+There are some helpers for controllers in `Telegram::Bot::Botan::ControllerHelpers`:
 
 ```ruby
 class Telegram::WebhookController < Telegram::Bot::UpdatesController
-  include Telegram::Bot::UpdatesController::Botan
+  include Telegram::Bot::Botan::ControllerHelpers
 
   # This will track with event: action_name & data: payload
   before_action :botan_track_action
@@ -372,6 +375,20 @@ end
 
 There is no stubbing for botan clients, so don't set botan token in tests.
 
+### Async mode
+
+There is built in support for async requests using ActiveJob. Without Rails
+you can implement your own worker class to handle such requests. This allows:
+
+- Process updates very fast, without waiting for telegram and botan responses.
+- Handle and retry network and other errors with queue adapter.
+- ???
+
+To enable this mode add `async: true` to bot's and botan's config.
+For more information and custom configuration check out
+[docs](http://www.rubydoc.info/github/telegram-bot-rb/telegram-bot/master/Telegram/Bot/Async) or
+[source](https://github.com/telegram-bot-rb/telegram-bot/blob/master/lib/telegram/bot/async.rb).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -383,6 +400,16 @@ To release a new version, update the version number in `version.rb`,
 and then run `bundle exec rake release`, which will create a git tag for the version,
 push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Different Rails versions
+
+To setup development for specific major Rails version use:
+
+```
+RAILS=5 bundle install
+# or
+RAILS=5 bundle update
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/telegram-bot-rb/telegram-bot.

lib/tasks/telegram-bot.rake

@@ -1,9 +1,14 @@
 namespace :telegram do
   namespace :bot do
-    desc 'Run poller'
-    task poller: :environment do
-      console = ActiveSupport::Logger.new(STDERR)
-      Rails.logger.extend ActiveSupport::Logger.broadcast console
+    desc 'Run poller. It broadcasts Rails.logger to STDOUT in dev like `rails s` do. ' \
+      'Use LOG_TO_STDOUT to enable/disable broadcasting.'
+    task :poller do
+      ENV['BOT_POLLER_MODE'] = 'true'
+      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
+      end
       Telegram::Bot::UpdatesPoller.start(ENV['BOT'].try!(:to_sym) || :default)
     end
 

lib/telegram/bot.rb

@@ -13,6 +13,7 @@ module Telegram
     # check response.
     class StaleChat < Error
       DESCRIPTIONS = [
+        'Bot was blocked',
         'bot was kicked',
         "can't write to",
         'group chat is deactivated',
@@ -26,9 +27,12 @@ module Telegram
       end
     end
 
+    autoload :Async,              'telegram/bot/async'
     autoload :Botan,              'telegram/bot/botan'
     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 :UpdatesController,  'telegram/bot/updates_controller'
     autoload :UpdatesPoller,      'telegram/bot/updates_poller'

lib/telegram/bot/async.rb

@@ -0,0 +1,138 @@
+module Telegram
+  module Bot
+    # Telegram & Botan clients can perform requests in async way with
+    # any job adapter (ActiveJob by default). Using Rails you don't need any
+    # additional configuration. However you may want to enable async requests
+    # by default with `async: true` in `secrets.yml`. Botan client doesn't inherit
+    # async setting from client and must be configured separately.
+    #
+    #   telegram:
+    #     bots:
+    #       chat_async:
+    #         token: secret
+    #         async: true # enable async mode for client
+    #         botan: botan_token # in this way botan will not be async
+    #         botan: # in this way - it's in async mode
+    #           token: botan_token
+    #           async: true
+    #
+    # Without Rails To start using async requests
+    # initialize client with `id` kwarg and make sure the client is
+    # accessible via `Teletgram.bots[id]` in job worker. Or just use
+    # `Telegram.bots_config=` for configuration.
+    #
+    # Being in async mode `#request` enqueues job instead to perform
+    # http request instead of performing it directly.
+    # Async behavior is controlled with `#async=` writer
+    # and can be enabled/disabled for the block with `#async`:
+    #
+    #   client = Telegram::Bot::Client.new(**config, async: true)
+    #   client.send_message(message)
+    #   client.async(false) { client.send_message(other_one) }
+    #
+    # It can be set with custom job class or classname. By default it defines
+    # job classes for every client class, inherited from ApplicationRecord, which
+    # can be accessed via `.default_async_job`. You can integrate it with any
+    # other job provider by defining a class with `.perform_later(bot_id, *args)`
+    # method. See Async::Job for implemetation.
+    module Async
+      module Job
+        class << self
+          def included(base)
+            base.singleton_class.send :attr_accessor, :client_class
+          end
+        end
+
+        def perform(client_id, *args)
+          client = self.class.client_class.wrap(client_id.to_sym)
+          client.async(false) { client.request(*args) }
+        end
+      end
+
+      module ClassMethods
+        def default_async_job
+          @default_async_job ||= begin
+            begin
+              ApplicationJob
+            rescue NameError
+              raise 'Define ApplicationJob class or setup #async= with custom job class'
+            end
+            klass = Class.new(ApplicationJob) { include Job }
+            klass.client_class = self
+            const_set(:AsyncJob, klass)
+          end
+        end
+
+        # This is used in specs.
+        def default_async_job=(val)
+          @default_async_job = val
+          remove_const(:AsyncJob) if const_defined?(:AsyncJob, false)
+        end
+
+        # Prepares argments for async job. ActiveJob doesn't support
+        # Symbol in argumens. Also we can encode json bodies only once here,
+        # so it would not be unnecessarily serialized-deserialized.
+        #
+        # This is stub method, which returns input. Every client class
+        # must prepare args itself.
+        def prepare_async_args(*args)
+          args
+        end
+      end
+
+      class << self
+        def prepended(base)
+          base.extend(ClassMethods)
+        end
+
+        # Transforms symbols to strings in hash values.
+        def prepare_hash(hash)
+          return hash unless hash.is_a?(Hash)
+          hash = hash.dup
+          hash.each { |key, val| hash[key] = val.to_s if val.is_a?(Symbol) }
+        end
+      end
+
+      attr_reader :id
+
+      def initialize(*, id: nil, async: nil, **options)
+        @id = id
+        self.async = async
+        super
+      end
+
+      # Sets `@async` to `self.class.default_async_job` if `true` is given
+      # or uses given value.
+      # Pass custom job class to perform async calls with.
+      def async=(val)
+        @async =
+          case val
+          when true then self.class.default_async_job
+          when String then const_get(val)
+          else val
+          end
+      end
+
+      # Returns value of `@async` if no block is given. Otherwise sets this value
+      # for a block.
+      def async(val = true)
+        return @async unless block_given?
+        begin
+          old_val = @async
+          self.async = val
+          yield
+        ensure
+          @async = old_val
+        end
+      end
+
+      # Uses job if #async is set.
+      def request(*args)
+        job_class = async
+        return super unless job_class
+        raise 'Can not enqueue job without client id' unless id
+        job_class.perform_later(id.to_s, *self.class.prepare_async_args(*args))
+      end
+    end
+  end
+end

lib/telegram/bot/botan.rb

@@ -3,24 +3,37 @@ module Telegram
     class Botan
       TRACK_URI = 'https://api.botan.io/track'.freeze
 
+      autoload :ClientHelpers, 'telegram/bot/botan/client_helpers'
+      autoload :ControllerHelpers, 'telegram/bot/botan/controller_helpers'
       class Error < Bot::Error; end
 
+      extend Initializers
+      prepend Async
       include DebugClient
 
+      class << self
+        def by_id(id)
+          Telegram.botans[id]
+        end
+
+        def prepare_async_args(method, uri, query = {}, body = nil)
+          [method.to_s, uri.to_s, Async.prepare_hash(query), body]
+        end
+      end
+
       attr_reader :client, :token
 
-      def initialize(token)
+      def initialize(token = nil, **options)
         @client = HTTPClient.new
-        @token = token
+        @token = token || options[:token]
       end
 
       def track(event, uid, payload = {})
-        res = http_request(
-          :post,
-          TRACK_URI,
-          {token: token, name: event, uid: uid},
-          payload.to_json,
-        )
+        request(:post, TRACK_URI, {name: event, uid: uid}, payload.to_json)
+      end
+
+      def request(method, uri, query = {}, body = nil)
+        res = http_request(method, uri, query.merge(token: token), body)
         status = res.status
         return JSON.parse(res.body) if 300 > status
         result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
@@ -31,6 +44,10 @@ module Telegram
       def http_request(method, uri, query, body)
         client.request(method, uri, query, body)
       end
+
+      def inspect
+        "#<#{self.class.name}##{object_id}(#{@id})>"
+      end
     end
   end
 end

lib/telegram/bot/botan/client_helpers.rb

@@ -0,0 +1,15 @@
+module Telegram
+  module Bot
+    class Botan
+      # Helpers for botan.io metrics.
+      module ClientHelpers
+        attr_reader :botan
+
+        def initialize(*, botan: nil, **)
+          super
+          @botan = Botan.wrap(botan, id: id) if botan
+        end
+      end
+    end
+  end
+end

lib/telegram/bot/botan/controller_helpers.rb

@@ -1,8 +1,8 @@
 module Telegram
   module Bot
-    class UpdatesController
+    class Botan
       # Helpers for botan.io metrics.
-      module Botan
+      module ControllerHelpers
         class MissingFrom < Error; end
 
         protected

lib/telegram/bot/client.rb

@@ -2,7 +2,6 @@ require 'json'
 require 'httpclient'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/keys'
-require 'telegram/bot/debug_client'
 
 module Telegram
   module Bot
@@ -10,23 +9,14 @@ module Telegram
       URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
 
       autoload :TypedResponse, 'telegram/bot/client/typed_response'
+      extend Initializers
+      prepend Async
+      prepend Botan::ClientHelpers
       include DebugClient
 
       class << self
-        # Accepts different options to initialize bot.
-        def wrap(input)
-          case input
-          when self then input
-          when Array then input.map(&method(__callee__))
-          when Hash then
-            input = input.stringify_keys
-            new input['token'], input['username'], botan: input['botan']
-          when Symbol
-            Telegram.bots[input] or
-              raise "Bot #{input} not configured, check Telegram.bots_config."
-          else
-            new(input)
-          end
+        def by_id(id)
+          Telegram.bots[id]
         end
 
         # Prepend TypedResponse module.
@@ -41,16 +31,19 @@ module Telegram
             body[k] = val.to_json if val.is_a?(Hash) || val.is_a?(Array)
           end
         end
+
+        def prepare_async_args(action, body = {})
+          [action.to_s, Async.prepare_hash(prepare_body(body))]
+        end
       end
 
-      attr_reader :client, :token, :username, :base_uri, :botan
+      attr_reader :client, :token, :username, :base_uri
 
-      def initialize(token, username = nil, botan: nil)
+      def initialize(token = nil, username = nil, **options)
         @client = HTTPClient.new
-        @token = token
-        @username = username
-        @base_uri = format URL_TEMPLATE, token
-        @botan = Botan.new(botan) if botan
+        @token = token || options[:token]
+        @username = username || options[:username]
+        @base_uri = format URL_TEMPLATE, self.token
       end
 
       def request(action, body = {}) # rubocop:disable PerceivedComplexity

lib/telegram/bot/client_stub.rb

@@ -9,7 +9,7 @@ module Telegram
           if self == ClientStub || !ClientStub.stub_all?
             super
           else
-            ClientStub.new(args[1])
+            ClientStub.new(*args)
           end
         end
       end
@@ -34,8 +34,8 @@ module Telegram
         end
       end
 
-      def initialize(username = nil)
-        @username = username
+      def initialize(token = nil, username = nil, **options)
+        @username = username || options[:username] || token
         reset
       end
 

lib/telegram/bot/config_methods.rb

@@ -14,14 +14,21 @@ module Telegram
       # It just tells routes helpers whether to add routed bots to
       # Bot::UpdatesPoller, so their config will be available by bot key in
       # Bot::UpdatesPoller.start.
+      #
+      # It's enabled by default in Rails dev environment and `rake telegram:bot:poller`
+      # task. Use `BOT_POLLER_MODE=true` envvar to set it manually.
       def bot_poller_mode?
         return @bot_poller_mode if defined?(@bot_poller_mode)
-        Rails.env.development? if defined?(Rails)
+        @bot_poller_mode = ENV.fetch('BOT_POLLER_MODE') do
+          Rails.env.development? if defined?(Rails)
+        end
       end
 
       # Hash of bots made with bots_config.
       def bots
-        @bots ||= bots_config.transform_values(&Client.method(:wrap))
+        @bots ||= bots_config.each_with_object({}) do |(id, config), h|
+          h[id] = Client.wrap(config, id: id)
+        end
       end
 
       # Default bot.
@@ -29,17 +36,26 @@ module Telegram
         @bot ||= bots[:default]
       end
 
+      # Hash of botan clients made from #bots.
+      def botans
+        @botans ||= bots.transform_values(&:botan)
+      end
+
       # Returns config for .bots method. By default uses `telegram['bots']` section
       # from `secrets.yml` merging `telegram['bot']` at `:default` key.
       #
       # Can be overwritten with .bots_config=
       def bots_config
-        return @bots_config if @bots_config
-        telegram_config = Rails.application.secrets[:telegram]
-        (telegram_config['bots'] || {}).symbolize_keys.tap do |config|
-          default = telegram_config['bot']
-          config[:default] = default if default
-        end
+        @bots_config ||=
+          if defined?(Rails)
+            telegram_config = Rails.application.secrets[:telegram] || {}
+            (telegram_config['bots'] || {}).symbolize_keys.tap do |config|
+              default = telegram_config['bot']
+              config[:default] = default if default
+            end
+          else
+            {}
+          end
       end
 
       # Resets all cached bots and their configs.
@@ -47,6 +63,7 @@ module Telegram
         @bots = nil
         @bot = nil
         @bots_config = nil
+        @botans = nil
       end
     end
   end

lib/telegram/bot/initializers.rb

@@ -0,0 +1,19 @@
+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

lib/telegram/bot/middleware.rb

@@ -1,6 +1,8 @@
 require 'active_support/concern'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/json'
 require 'action_dispatch/http/mime_type'
-require 'action_dispatch/middleware/params_parser'
+require 'action_dispatch/http/request'
 
 module Telegram
   module Bot
@@ -13,7 +15,8 @@ module Telegram
       end
 
       def call(env)
-        update = env['action_dispatch.request.request_parameters']
+        request = ActionDispatch::Request.new(env)
+        update = request.request_parameters
         controller.dispatch(bot, update)
         [200, {}, ['']]
       end

lib/telegram/bot/routes_helper.rb

@@ -20,7 +20,7 @@ module Telegram
         # Replaces colon with underscore so rails don't treat it as
         # route parameter.
         def escape_token(token)
-          token.tr(':', '_')
+          token && token.tr(':', '_')
         end
       end
 

lib/telegram/bot/updates_controller.rb

@@ -21,7 +21,7 @@ module Telegram
     #     end
     #
     #     def help(*)
-    #       reply_with :message, text:
+    #       respond_with :message, text:
     #     end
     #
     # To process plain text messages (without commands) or other updates just
@@ -29,7 +29,7 @@ module Telegram
     # as an argument.
     #
     #     def message(message)
-    #       reply_with :message, text: "Echo: #{message['text']}"
+    #       respond_with :message, text: "Echo: #{message['text']}"
     #     end
     #
     #     def inline_query(query)
@@ -59,11 +59,10 @@ module Telegram
       require 'telegram/bot/updates_controller/reply_helpers'
       autoload :CallbackQueyContext, 'telegram/bot/updates_controller/callback_query_context'
       autoload :MessageContext, 'telegram/bot/updates_controller/message_context'
-      autoload :Botan, 'telegram/bot/updates_controller/botan'
 
       include AbstractController::Callbacks
       # Redefine callbacks with default terminator.
-      if ActiveSupport.gem_version >= Gem::Version.new('5')
+      if ActiveSupport::VERSION::MAJOR >= 5
         define_callbacks  :process_action,
                           skip_after_callbacks_if_terminated: true
       else

lib/telegram/bot/updates_controller/instrumentation.rb

@@ -6,7 +6,7 @@ module Telegram
       module Instrumentation
         class << self
           def prepended(base)
-            base.config_accessor :logger
+            base.send :config_accessor, :logger
             base.extend ClassMethods
           end
 
@@ -35,13 +35,13 @@ module Telegram
           end
         end
 
-        def reply_with(type, *)
-          Instrumentation.instrument(:reply_with, type: type) { super }
+        def respond_with(type, *)
+          Instrumentation.instrument(:respond_with, type: type) { super }
         end
 
         %i(answer_callback_query answer_inline_query).each do |type|
           define_method(type) do |*args|
-            Instrumentation.instrument(:reply_with, type: type) { super(*args) }
+            Instrumentation.instrument(:respond_with, type: type) { super(*args) }
           end
         end
 

lib/telegram/bot/updates_controller/log_subscriber.rb

@@ -22,8 +22,8 @@ module Telegram
           end
         end
 
-        def reply_with(event)
-          info { "Replied with #{event.payload[:type]}" }
+        def respond_with(event)
+          info { "Responded with #{event.payload[:type]}" }
         end
 
         def halted_callback(event)

lib/telegram/bot/updates_controller/reply_helpers.rb

@@ -2,21 +2,23 @@ module Telegram
   module Bot
     class UpdatesController
       module ReplyHelpers
-        # Helper to call bot's `send_#{type}` method with already set `chat_id` and
-        # `reply_to_message_id`:
+        # Helper to call bot's `send_#{type}` method with already set `chat_id`:
         #
-        #     reply_with :message, text: 'Hello!'
-        #     reply_with :message, text: '__Hello!__', parse_mode: :Markdown
-        #     reply_with :photo, photo: File.open(photo_to_send), caption: "It's incredible!"
-        def reply_with(type, params)
-          method = "send_#{type}"
+        #     respond_with :message, text: 'Hello!'
+        #     respond_with :message, text: '__Hello!__', parse_mode: :Markdown
+        #     respond_with :photo, photo: File.open(photo_to_send), caption: "It's incredible!"
+        def respond_with(type, params)
           chat = self.chat
+          chat_id = chat && chat['id'] or raise 'Can not respond_with when chat is not present'
+          bot.public_send("send_#{type}", params.merge(chat_id: chat_id))
+        end
+
+        # Same as respond_with but also sets `reply_to_message_id`.
+        def reply_with(type, params)
           payload = self.payload
-          params = params.merge(
-            chat_id: (chat && chat['id'] or raise 'Can not reply_with when chat is not present'),
-            reply_to_message: payload && payload['message_id'],
-          )
-          bot.public_send(method, params)
+          message_id = payload && payload['message_id']
+          params = params.merge(reply_to_message_id: message_id) if message_id
+          respond_with(type, params)
         end
 
         # Same as reply_with, but for inline queries.

lib/telegram/bot/updates_poller.rb

@@ -64,7 +64,7 @@ module Telegram
       end
 
       def fetch_updates
-        response = bot.get_updates(offset: offset, timeout: timeout)
+        response = bot.async(false) { bot.get_updates(offset: offset, timeout: timeout) }
         return unless response['ok'] && response['result'].any?
         reload! do
           response['result'].each do |update|
@@ -77,11 +77,25 @@ module Telegram
 
       def reload!
         return yield unless reload
-        ActionDispatch::Reloader.prepare!
-        if controller.is_a?(Class) && controller.name
-          @controller = Object.const_get(controller.name)
+        reloading_code do
+          if controller.is_a?(Class) && controller.name
+            @controller = Object.const_get(controller.name)
+          end
+          yield
+        end
+      end
+
+      if defined?(Rails) && Rails.application.respond_to?(:reloader)
+        def reloading_code
+          Rails.application.reloader.wrap do
+            yield
+          end
+        end
+      else
+        def reloading_code
+          ActionDispatch::Reloader.prepare!
+          yield.tap { ActionDispatch::Reloader.cleanup! }
         end
-        yield.tap { ActionDispatch::Reloader.cleanup! }
       end
     end
   end

lib/telegram/bot/version.rb

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

spec/spec_helper.rb

@@ -17,6 +17,8 @@ require 'telegram/bot'
 require 'telegram/bot/updates_controller/rspec_helpers'
 require 'telegram/bot/types'
 
+Dir[GEM_ROOT.join('spec/support/**/*.rb')].each { |f| require f }
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     # This option will default to `true` in RSpec 4. It makes the `description`

spec/support/examples/async.rb

@@ -0,0 +1,89 @@
+RSpec.shared_examples 'async' do |request_args: -> {}|
+  let(:instance) { described_class.new(token: token, id: id, async: async) }
+  let(:id) { :default_bot }
+  let(:async) { true }
+  let!(:application_job_class) do
+    klass = Class.new do
+      def self.perform_later(*)
+      end
+    end
+    klass.tap { |x| stub_const('ApplicationJob', x) }
+  end
+  after { described_class.default_async_job = nil }
+
+  describe '#async' do
+    subject { ->(*args, &block) { instance.async(*args, &block) } }
+    its(:call) { should eq described_class.default_async_job }
+
+    context 'when async is disabled' do
+      let(:async) { false }
+      its(:call) { should eq false }
+    end
+
+    context 'when using with block' do
+      it 'sets value inside block' do
+        expect do
+          expect do
+            subject.call(false) do
+              expect do
+                subject.call(nil) { expect(subject[]).to eq nil }
+              end.to_not change(&subject).from false
+              raise 'TestError'
+            end
+          end.to raise_error(/TestError/)
+        end.to_not change(instance, :async).from(described_class.default_async_job)
+      end
+    end
+  end
+
+  describe '.default_async_job' do
+    subject { described_class.default_async_job }
+    its(:superclass) { should eq application_job_class }
+    it { should include Telegram::Bot::Async::Job }
+    its(:client_class) { should eq described_class }
+
+    context 'when ApplicationJob is not defined' do
+      let(:application_job_class) {}
+      it { expect { subject }.to raise_error(/Define ApplicationJob/) }
+    end
+  end
+
+  describe '#request' do
+    subject { ->(*args) { instance.request(*(args.empty? ? self.args : args)) } }
+    let(:args, &request_args)
+    let(:result) { double(:result) }
+
+    shared_examples 'enqueues job' do
+      it 'enqueues job' do
+        expect(instance).to_not receive(:http_request)
+        expect(described_class).to receive(:prepare_async_args).with(*args) { args }
+        expect(instance.async).to receive(:perform_later).with(id.to_s, *args) { result }
+        expect(subject.call).to eq result
+      end
+    end
+
+    include_examples 'enqueues job'
+
+    context 'with custom job class' do
+      let(:async) { double(:job_class) }
+      include_examples 'enqueues job'
+    end
+
+    context 'when id is not set' do
+      let(:id) {}
+      it { should raise_error(/Can not enqueue/) }
+    end
+
+    context 'when async is disabled' do
+      let(:async) { false }
+      let(:result) { double(status: 200, body: '{"test":"ok"}') }
+      let(:args, &request_args)
+
+      it 'performs request immediately' do
+        expect(instance).to receive(:request).with(*args).and_call_original
+        expect(instance).to receive(:http_request) { result }
+        expect(subject[]).to eq 'test' => 'ok'
+      end
+    end
+  end
+end

spec/support/examples/initializers.rb

@@ -0,0 +1,65 @@
+RSpec.shared_examples 'initializers' do |config_method = :bots|
+  describe '.wrap' do
+    subject { described_class.wrap(input, **options) }
+    let(:options) { {} }
+    let(:result) { double(:result) }
+    let(:username) { 'username' }
+
+    context 'when input is a string' do
+      let(:input) { token }
+
+      it 'treats string as token' do
+        expect(described_class).to receive(:new).with(token, {}) { result }
+        should eq result
+      end
+
+      context 'and additional options are given' do
+        let(:options) { {id: :test} }
+
+        it 'passes them to initializer' do
+          expect(described_class).to receive(:new).with(input, **options) { result }
+          should eq result
+        end
+      end
+    end
+
+    context 'when input is a hash' do
+      let(:input) { {token: token, 'username' => username, other: :options} }
+
+      it 'passes it with symbolized keys' do
+        expect(described_class).to receive(:new).with(**input.symbolize_keys) { result }
+        should eq result
+      end
+
+      context 'and additional options are given' do
+        let(:options) { {id: :test} }
+
+        it 'passes them to initializer' do
+          expect(described_class).to receive(:new).
+            with(**input.symbolize_keys, **options) { result }
+          should eq result
+        end
+      end
+    end
+
+    context 'when input is an instance of described_class' do
+      let!(:input) { instance }
+
+      it 'returns input' do
+        expect(described_class).to_not receive(:new)
+        should eq input
+      end
+    end
+
+    context 'when input is a Symbol' do
+      let(:input) { :client_1 }
+      before { allow(Telegram).to receive(config_method) { {client_1: instance} } }
+      it { should eq Telegram.send(config_method)[:client_1] }
+
+      context 'and there is no such bot' do
+        let(:input) { :invalid }
+        it { expect { subject }.to raise_error(/not configured/) }
+      end
+    end
+  end
+end

spec/telegram/bot/async_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe Telegram::Bot::Async::Job do
+  let(:job_class) do
+    described_class = self.described_class
+    client_class = self.client_class
+    Class.new do
+      include described_class
+      self.client_class = client_class
+    end
+  end
+  let(:client_class) { Telegram::Bot::Client }
+  let(:instance) { job_class.new }
+
+  describe '#perform' do
+    subject { instance.perform(id, *args) }
+    let(:id) { 'bot_id' }
+    let(:args) { [double(:action), {body: :content}] }
+    let(:client) { Telegram::Bot::Client.new(async: custom_job_class) }
+    let(:custom_job_class) { Class.new }
+    let(:result) { double(status: 200, body: '{"test":"ok"}') }
+
+    it 'finds client and performs request' do
+      expect(client_class).to receive(:wrap).with(id.to_sym) { client }
+      expect(client).to receive(:request).with(*args).and_call_original
+      expect(client).to receive(:http_request) { result }
+      should eq 'test' => 'ok'
+    end
+  end
+end

spec/telegram/bot/botan/client_helpers_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe Telegram::Bot::Client do
+  let(:instance) { described_class.new(*client_args) }
+  let(:token) { 'token' }
+  let(:botan_token) { double(:botan_token) }
+  let(:client_id) { 'client_id' }
+  let(:client_args) { [token] }
+
+  describe '#botan' do
+    subject { instance.botan }
+    it { should eq nil }
+
+    context 'when botan token is set' do
+      let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_token] }
+      it { should be_instance_of Telegram::Bot::Botan }
+      its(:token) { should eq botan_token }
+      its(:id) { should eq client_id }
+
+      it 'doesnt inherit async from client' do
+        expect(instance.async).to be
+        expect(subject.async).to_not be
+      end
+    end
+
+    context 'when botan is configured with hash' do
+      let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_config] }
+      let(:botan_config) { {token: botan_token, async: Class.new} }
+      it { should be_instance_of Telegram::Bot::Botan }
+      its(:token) { should eq botan_token }
+      its(:id) { should eq client_id }
+      its(:async) { should eq botan_config[:async] }
+    end
+  end
+end

spec/telegram/bot/botan/controller_helpers_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe Telegram::Bot::UpdatesController::Botan do
+RSpec.describe Telegram::Bot::Botan::ControllerHelpers do
   include_context 'telegram/bot/updates_controller'
   let(:controller_class) do
     described_class = self.described_class

spec/telegram/bot/botan_spec.rb

@@ -0,0 +1,27 @@
+RSpec.describe Telegram::Bot::Botan do
+  let(:instance) { described_class.new 'token' }
+  let(:token) { 'token' }
+
+  include_examples 'initializers', :botans
+  include_examples 'async', request_args: -> { [double(:method), double(:url)] }
+
+  describe '.new' do
+    subject { described_class.new(*args) }
+
+    context 'when usual args are given' do
+      let(:args) { ['secret'] }
+      its(:token) { should eq args[0] }
+    end
+
+    context 'when options are given' do
+      let(:args) { [token: 'secret'] }
+      its(:token) { should eq args[0][:token] }
+    end
+  end
+
+  describe '.prepare_async_args' do
+    subject { described_class.prepare_async_args(*input) }
+    let(:input) { [:post, :uri, {a: 1, b: :sym, 'd' => 'str'}, 'body'] }
+    it { should eq ['post', 'uri', {a: 1, b: 'sym', 'd' => 'str'}, 'body'] }
+  end
+end

spec/telegram/bot/client_spec.rb

@@ -3,71 +3,8 @@ RSpec.describe Telegram::Bot::Client do
   let(:token) { 'token' }
   let(:botan_token) { double(:botan_token) }
 
-  describe '.wrap' do
-    subject { described_class.wrap(input) }
-    let(:result) { double(:result) }
-    let(:username) { 'username' }
-
-    context 'when input is a string' do
-      let(:input) { token }
-
-      it 'treats string as token' do
-        expect(described_class).to receive(:new).with(token) { result }
-        should eq result
-      end
-    end
-
-    context 'when input is a hash' do
-      let(:input) { {token: token, username: username, ignore: :ignore} }
-
-      it 'extracts token & username' do
-        expect(described_class).to receive(:new).
-          with(token, username, botan: nil) { result }
-        should eq result
-      end
-
-      context 'when `botan` is given' do
-        let(:input) { super().merge(botan: botan_token) }
-
-        it 'passes it to initializer' do
-          expect(described_class).to receive(:new).
-            with(token, username, botan: botan_token) { result }
-          should eq result
-        end
-      end
-    end
-
-    context 'when input is an instance of described_class' do
-      let!(:input) { instance }
-
-      it 'returns input' do
-        expect(described_class).to_not receive(:new)
-        should eq input
-      end
-    end
-
-    context 'when input is a Symbol' do
-      let(:input) { :bot_1 }
-      before { allow(Telegram).to receive(:bots) { {bot_1: instance} } }
-      it { should eq Telegram.bots[:bot_1] }
-
-      context 'and there is no such bot' do
-        let(:input) { :invalid }
-        it { expect { subject }.to raise_error(/not configured/) }
-      end
-    end
-
-    context 'when input is an array' do
-      let!(:input) { ['other_token', instance, token: token, username: username] }
-      let(:result_2) { double(:result_2) }
-
-      it 'calls wrap for every element' do
-        expect(described_class).to receive(:new).with('other_token') { result }
-        expect(described_class).to receive(:new).with(token, username, botan: nil) { result_2 }
-        should eq [result, instance, result_2]
-      end
-    end
-  end
+  include_examples 'initializers'
+  include_examples 'async', request_args: -> { [double(:action), {body: :content}] }
 
   describe '.prepare_body' do
     subject { described_class.prepare_body(input) }
@@ -88,14 +25,27 @@ RSpec.describe Telegram::Bot::Client do
     end
   end
 
-  describe '#botan' do
-    subject { instance.botan }
-    it { should eq nil }
+  describe '.prepare_async_args' do
+    subject { described_class.prepare_async_args(*input) }
+    let(:input) { [:action, a: 1, b: :sym, c: [:other], 'd' => 'str'] }
+    it { should eq ['action', a: 1, b: 'sym', c: '["other"]', 'd' => 'str'] }
+  end
 
-    context 'when botan token is set' do
-      let(:instance) { described_class.new token, botan: botan_token }
-      it { should be_instance_of Telegram::Bot::Botan }
-      its(:token) { should eq botan_token }
+  describe '.new' do
+    subject { described_class.new(*args) }
+
+    context 'when multiple args are given' do
+      let(:args) { %w(secret superbot) }
+      its(:token) { should eq args[0] }
+      its(:username) { should eq args[1] }
+      its(:base_uri) { should include args[0] }
+    end
+
+    context 'when hash is given' do
+      let(:args) { [token: 'secret', username: 'superbot'] }
+      its(:token) { should eq args[0][:token] }
+      its(:username) { should eq args[0][:username] }
+      its(:base_uri) { should include args[0][:token] }
     end
   end
 end

spec/telegram/bot/client_stub_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Telegram::Bot::ClientStub do
   describe '#stub_all!' do
     let(:client) { Telegram::Bot::Client.new('token', 'bot_name') }
-    let(:clients) { Telegram::Bot::Client.wrap(['token', token: 'token2']) }
+    let(:clients) { ['token', token: 'token2'].map(&Telegram::Bot::Client.method(:wrap)) }
 
     shared_examples 'constructors' do |expected_class|
       it 'makes Client.new return ClientStub' do
@@ -9,7 +9,7 @@ RSpec.describe Telegram::Bot::ClientStub do
         expect(client.username).to eq 'bot_name'
       end
 
-      it 'makes Client.wrap raturn ClientStub' do
+      it 'makes Client.wrap return ClientStub' do
         expect(clients).to contain_exactly instance_of(expected_class),
           instance_of(expected_class)
       end
@@ -35,4 +35,19 @@ RSpec.describe Telegram::Bot::ClientStub do
       include_examples 'constructors', Telegram::Bot::Client
     end
   end
+
+  describe '#new' do
+    subject { described_class.new(*args) }
+
+    context 'when only username is given' do
+      let(:args) { 'superbot' }
+      its(:username) { should eq args }
+    end
+
+    context 'when username and token are given' do
+      let(:args) { %w(token superbot) }
+      its(:token) { should eq nil }
+      its(:username) { should eq args[1] }
+    end
+  end
 end

spec/telegram/bot/config_methods_spec.rb

@@ -0,0 +1,94 @@
+RSpec.describe Telegram::Bot::ConfigMethods do
+  let(:registry) do
+    Object.new.tap do |x|
+      x.extend described_class
+      x.bots_config = config
+    end
+  end
+  let(:config) do
+    {
+      default: 'default_token',
+      chat: {
+        token: 'chat_token',
+        username: 'Chat',
+        botan: 'chat_botan_token',
+      },
+      other_chat: {
+        'token' => 'other_chat_token',
+        'username' => 'OtherChat',
+        'botan' => 'other_chat_botan_token',
+      },
+    }
+  end
+
+  describe '#bot' do
+    subject { registry.bot }
+    it { should eq registry.bots[:default] }
+  end
+
+  describe '#bots' do
+    context 'configured by token' do
+      subject { registry.bots[:default] }
+      its(:id) { should eq :default }
+      its(:token) { should eq config[:default] }
+    end
+
+    context 'configured by hash' do
+      subject { registry.bots[:chat] }
+      its(:id) { should eq :chat }
+      its(:token) { should eq config[:chat][:token] }
+      its(:username) { should eq config[:chat][:username] }
+      its('botan.token') { should eq config[:chat][:botan] }
+    end
+
+    context 'configured by hash with stringified keys' do
+      subject { registry.bots[:other_chat] }
+      its(:id) { should eq :other_chat }
+      its(:token) { should eq config[:other_chat]['token'] }
+      its(:username) { should eq config[:other_chat]['username'] }
+      its('botan.token') { should eq config[:other_chat]['botan'] }
+    end
+  end
+
+  describe '#botans' do
+    subject { registry.botans }
+    it do
+      should eq(
+        default: nil,
+        chat: registry.bots[:chat].botan,
+        other_chat: registry.bots[:other_chat].botan,
+      )
+    end
+  end
+
+  describe '#bots_config' do
+    subject { registry.bots_config }
+    it { should eq config }
+
+    context 'when not configured' do
+      let(:registry) { Object.new.tap { |x| x.extend described_class } }
+      it { should eq({}) }
+
+      context 'in rails environment' do
+        before { stub_const('Rails', double(application: double(secrets: secrets))) }
+        let(:secrets) { {} }
+        it { should eq({}) }
+
+        context 'when there is telegram section in secrets' do
+          let(:secrets) { {telegram: config.stringify_keys} }
+          let(:config) do
+            {
+              bot: double(:bot_config),
+              bots: {
+                chat: double(:chat_config),
+                other_chat: double(:other_chat_config),
+              },
+            }
+          end
+          it { should include default: config[:bot] }
+          it { should include config[:bots] }
+        end
+      end
+    end
+  end
+end

spec/telegram/bot/middleware_spec.rb

@@ -1,3 +1,5 @@
+require 'rack/mock'
+
 RSpec.describe Telegram::Bot::Middleware do
   let(:instance) { described_class.new bot, controller }
   let(:bot) { double(:bot) }
@@ -6,10 +8,25 @@ RSpec.describe Telegram::Bot::Middleware do
   describe '#call' do
     subject { instance.call(env) }
     let(:env) { {'action_dispatch.request.request_parameters' => json_body} }
-    let(:json_body) { double(:json_body) }
+    let(:update) { {'message' => {'id' => 1}} }
+    let(:env) do
+      Rack::MockRequest.env_for('/',
+        method: :post,
+        input:  JSON.dump(update),
+        'CONTENT_TYPE' => 'application/json',
+      )
+    end
+
+    require 'action_pack/version'
+    if ActionPack::VERSION::MAJOR < 5
+      # Before Rails 5, params are parsed in middleware.
+      # In Rails 5, they are parsed in Request#request_parameters.
+      require 'action_dispatch/middleware/params_parser'
+      let(:instance) { ActionDispatch::ParamsParser.new(super()) }
+    end
 
     it 'calls dispatch on controller' do
-      expect(controller).to receive(:dispatch).with(bot, json_body)
+      expect(controller).to receive(:dispatch).with(bot, update)
       subject
     end
 

spec/telegram/bot/routes_helper_spec.rb

@@ -50,8 +50,9 @@ RSpec.describe Telegram::Bot::RoutesHelper do
 
     def assert_routes(*expected) # rubocop:disable AbcSize
       expected.each do |(bot, controller, route_name, options)|
+        expected_path = options.delete(:path) || "telegram/#{bot.token}"
         expect(mapper).to receive(:post) do |path, params|
-          expect(path).to eq "telegram/#{bot.token}"
+          expect(path).to eq expected_path
           middleware = params[:to]
           expect(middleware.controller).to eq(controller)
           expect(middleware.bot.token).to eq(bot.token)
@@ -70,6 +71,27 @@ RSpec.describe Telegram::Bot::RoutesHelper do
         assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
                       [other_bot, controller, 'other_telegram_webhook', option: :val]
       end
+
+      context 'and bot does not have configured token' do
+        let(:bot) { create_bot(nil) }
+        it 'creates routes for every bot and this controller' do
+          assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
+                        [other_bot, controller, 'other_telegram_webhook', option: :val]
+        end
+      end
+
+      context 'and bot has colon in token' do
+        let(:bot) { create_bot('some:token') }
+        it 'replaces colon with underscore' do
+          assert_routes [
+            bot,
+            controller,
+            'default_telegram_webhook',
+            option: :val,
+            path: 'telegram/some_token',
+          ], [other_bot, controller, 'other_telegram_webhook', option: :val]
+        end
+      end
     end
 
     context 'when called with hash' do

spec/telegram/bot/updates_controller/reply_helpers_spec.rb

@@ -1,36 +1,49 @@
 RSpec.describe Telegram::Bot::UpdatesController do
   include_context 'telegram/bot/updates_controller'
+  let(:params) { {arg: 1, 'other_arg' => 2} }
+  let(:respond_type) { :photo }
+  let(:result) { double(:result) }
+  let(:payload_type) { :message }
+  let(:payload) { {message_id: double(:message_id)} }
+  let(:chat) { {'id' => double(:chat_id)} }
 
-  describe '#reply_with' do
-    subject { controller.reply_with type, params }
-    let(:params) { {arg: 1, 'other_arg' => 2} }
-    let(:type) { :photo }
-    let(:result) { double(:result) }
-    let(:payload_type) { :message }
-    let(:payload) { {message_id: double(:message_id)} }
-    let(:chat) { {'id' => double(:chat_id)} }
-
-    it 'sets chat_id & reply_to_message' do
-      expect(controller).to receive(:chat) { chat }
-      expect(bot).to receive("send_#{type}").with(params.merge(
-        chat_id: chat['id'],
-        reply_to_message: payload[:message_id],
-      )) { result }
-      should eq result
-    end
-
+  shared_examples 'missing chat' do
     context 'when chat is missing' do
       let(:payload_type) { :some_type }
       it { expect { subject }.to raise_error(/chat/) }
     end
+  end
+
+  describe '#respond_with' do
+    subject { controller.respond_with respond_type, params }
+    include_examples 'missing chat'
+
+    it 'sets chat_id & reply_to_message_id' do
+      expect(controller).to receive(:chat) { chat }
+      expect(bot).to receive("send_#{respond_type}").
+        with(params.merge(chat_id: chat['id'])) { result }
+      should eq result
+    end
+  end
+
+  describe '#reply_with' do
+    subject { controller.reply_with respond_type, params }
+    include_examples 'missing chat'
+
+    it 'sets chat_id & reply_to_message_id' do
+      expect(controller).to receive(:chat) { chat }
+      expect(bot).to receive("send_#{respond_type}").with(params.merge(
+        chat_id: chat['id'],
+        reply_to_message_id: payload[:message_id],
+      )) { result }
+      should eq result
+    end
 
     context 'when update is not set' do
       let(:update) { {chat: chat} }
-      it 'sets chat_id & reply_to_message' do
-        expect(bot).to receive("send_#{type}").with(params.merge(
-          chat_id: chat['id'],
-          reply_to_message: nil,
-        )) { result }
+      it 'sets chat_id' do
+        expect(bot).to receive("send_#{respond_type}").
+          with(params.merge(chat_id: chat['id'])) { result }
         should eq result
       end
     end

spec/telegram/bot/updates_controller_spec.rb

@@ -225,12 +225,12 @@ RSpec.describe Telegram::Bot::UpdatesController do
       it { should change(controller, :acted).to true }
       its(:call) { should eq [nil, nil, args] }
 
-      context 'when callback returns false' do
+      context 'when callback halts chain' do
         before do
           controller_class.prepend(Module.new do
             def hook
               super
-              false
+              ActiveSupport::VERSION::MAJOR >= 5 ? throw(:abort) : false
             end
           end)
         end

spec/telegram/bot_spec.rb

@@ -17,6 +17,9 @@ RSpec.describe Telegram::Bot do
         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

telegram-bot.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.0'
 
-  spec.add_dependency 'activesupport', '~> 4.0'
-  spec.add_dependency 'actionpack', '~> 4.0'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 5.1'
+  spec.add_dependency 'actionpack', '>= 4.0', '< 5.1'
   spec.add_dependency 'httpclient', '~> 2.7'
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'