fixed middleware's response

Gemfile

@@ -6,6 +6,8 @@ group :development do
   gem 'pry', '~> 0.10.1'
   gem 'pry-byebug', '~> 3.2.0'
 
+  gem 'telegram-bot-types', '~> 0.2.0'
+
   gem 'rspec', '~> 3.3.0'
   gem 'rspec-its', '~> 1.1.0'
 

README.md

@@ -1,17 +1,17 @@
 # Telegram::Bot
 
 [![Gem Version](https://badge.fury.io/rb/telegram-bot.svg)](http://badge.fury.io/rb/telegram-bot)
-[![Code Climate](https://codeclimate.com/github/printercu/telegram-bot/badges/gpa.svg)](https://codeclimate.com/github/printercu/telegram-bot)
-[![Build Status](https://travis-ci.org/printercu/telegram-bot.svg)](https://travis-ci.org/printercu/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)
 
 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. 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:
 
-- Ligthweight client to bot API (with fast and thread-safe
-  [httpclient](https://github.com/nahi/httpclient) is under the hood.)
+- Ligthweight client for bot API (with fast and thread-safe
+  [httpclient](https://github.com/nahi/httpclient) under the hood).
 - Controller with message parser. Allows to write separate methods for each command.
 - Middleware and routes helpers for production env.
 - Poller with automatic source-reloader for development env.
@@ -62,23 +62,39 @@ telegram:
 From now clients will be accessible with `Telegram.bots[:chat]` or `Telegram.bots[:auction]`.
 Single bot can be accessed with `Telegram.bot` or `Telegram.bots[:default]`.
 
-You can create clients manually with `Telegram::Bot.new(token, username)`.
+You can create clients manually with `Telegram::Bot::Client.new(token, username)`.
 Username is optional and used only to parse commands with mentions.
 
-Client has all available methods in underscored style
+There is `request(path_suffix, body)` method to perform any query.
+And there are also shortcuts for available queries in underscored style
 (`answer_inline_query` instead of `answerInlineQuery`).
 All this methods just post given params to specific URL.
 
 ```ruby
+bot.request(:getMe) or bot.get_me
+bot.request(:getupdates, offset: 1) or bot.get_updates(offset: 1)
 bot.send_message chat_id: chat_id, text: 'Test'
 ```
 
+By default client will return parsed json responses. You can enable
+response typecasting to virtus models using `telegram-bot-types` gem:
+```ruby
+# Add to your gemfile:
+gem 'telegram-bot-types', '~> x.x.x'
+# Enable typecasting:
+Telegram::Bot::Client.typed_response!
+# or for single instance:
+bot.extend Telegram::Bot::Client::TypedResponse
+
+bot.get_me.class # => Telegram::Bot::Types::User
+```
+
 ### Controller
 
 ```ruby
 class Telegram::WebhookController < Telegram::Bot::UpdatesController
   # use callbacks like in any other controllers
-  around_action :set_locale
+  around_action :with_locale
 
   # Every update can have one of: message, inline_query & chosen_inline_result.
   # Define method with same name to respond to this updates.
@@ -107,7 +123,7 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
 
   private
 
-  def set_locale(&block)
+  def with_locale(&block)
     I18n.with_locale(locale_for_update, &block)
   end
 
@@ -121,6 +137,49 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
 end
 ```
 
+You can enable typecasting of `update` with `telegram-bot-types` by including
+`Telegram::Bot::UpdatesPoller::TypedUpdate`:
+
+```ruby
+class Telegram::WebhookController < Telegram::Bot::UpdatesController
+  include Telegram::Bot::UpdatesPoller::TypedUpdate
+
+  def message(message)
+    message.class # => Telegram::Bot::Types::Message
+  end
+end
+```
+
+There is support for sessions using `ActiveSupport::Cache` stores.
+
+```ruby
+# configure store in env files:
+config.telegram_updates_controller.session_store = :redis_store, {expires_in: 1.month}
+
+class Telegram::WebhookController < Telegram::Bot::UpdatesController
+  include Telegram::Bot::UpdatesController::Session
+  # You can override global config
+  self.session_store = :file_store
+
+  def write(text = nil, *)
+    session[:text] = text
+  end
+
+  def read
+    session[:text]
+  end
+
+  private
+  # By default it uses bot's username and user's id as a session key.
+  # Chat's id is used only when `from` field is empty.
+  # Override `session_key` method to change this behavior.
+  def session_key
+    # In this case session will persist for user only in specific chat:
+    "#{bot.username}:#{chat['id']}:#{from['id']}"
+  end
+end
+```
+
 ### Routes
 
 Use `telegram_webhooks` helper to add routes. It will create routes for bots
@@ -181,4 +240,4 @@ push git commits and tags, and push the `.gem` file to [rubygems.org](https://ru
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/printercu/telegram-bot.
+Bug reports and pull requests are welcome on GitHub at https://github.com/telegram-bot-rb/telegram-bot.

lib/tasks/telegram-bot.rake

@@ -12,9 +12,10 @@ namespace :telegram do
       routes = Rails.application.routes.url_helpers
       cert_file = ENV['CERT']
       cert = File.open(cert_file) if cert_file
-      Telegram.bots.each_value do |bot|
-        route_name = Telegram::RoutesHelper.route_name_for_bot(bot)
+      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.set_webhook(url: url, certificate: cert)
       end
     end

lib/telegram/bot.rb

@@ -1,97 +1,17 @@
-require 'httpclient'
-require 'json'
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/hash/keys'
-require 'active_support/core_ext/array/wrap'
-require 'telegram/bottable'
+require 'telegram/bot/config_methods'
 
 module Telegram
-  extend Bottable
+  extend Bot::ConfigMethods
 
-  class Bot
+  module Bot
     class Error < StandardError; end
     class NotFound < Error; end
 
+    autoload :Client,             'telegram/bot/client'
+    autoload :ClientStub,         'telegram/bot/client_stub'
     autoload :Middleware,         'telegram/bot/middleware'
     autoload :UpdatesController,  'telegram/bot/updates_controller'
     autoload :UpdatesPoller,      'telegram/bot/updates_poller'
-
-    URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
-
-    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']
-        else
-          new(input)
-        end
-      end
-    end
-
-    attr_reader :client, :token, :username, :base_uri
-
-    def initialize(token, username = nil)
-      @client = HTTPClient.new
-      @token = token
-      @username = username
-      @base_uri = format URL_TEMPLATE, token
-    end
-
-    def debug!(dev = STDOUT)
-      client.debug_dev = dev
-    end
-
-    def debug_off!
-      client.debug_dev = nil
-    end
-
-    def request(action, data = {})
-      res = http_request("#{base_uri}#{action}", data)
-      status = res.status
-      return JSON.parse(res.body) if 300 > status
-      result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
-      err_msg = "#{res.reason}: #{result && result['description'] || '-'}"
-      # NotFound is raised only for valid responses from Telegram
-      raise NotFound, err_msg if 404 == status && result
-      raise Error, err_msg
-    end
-
-    %w(
-      answerInlineQuery
-      forwardMessage
-      getFile
-      getMe
-      getUpdates
-      getUserProfilePhotos
-      sendAudio
-      sendChatAction
-      sendDocument
-      sendLocation
-      sendMessage
-      sendPhoto
-      sendSticker
-      sendVideo
-      sendVoice
-      setWebhook
-    ).each do |method|
-      define_method(method.underscore) { |*args| request(method, *args) }
-    end
-
-    # Endpoint for low-level request. For easy host highjacking & instrumentation.
-    # Params are not used directly but kept for instrumentation purpose.
-    # You probably don't want to use this method directly.
-    def http_request(uri, body)
-      client.post(uri, body)
-    end
-
-    def inspect
-      "#<Telegram::Bot##{object_id}(#{@username})>"
-    end
   end
 end
 

lib/telegram/bot/client.rb

@@ -0,0 +1,111 @@
+require 'json'
+require 'httpclient'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/hash/keys'
+
+module Telegram
+  module Bot
+    class Client
+      autoload :TypedResponse, 'telegram/bot/client/typed_response'
+
+      URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
+
+      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']
+          else
+            new(input)
+          end
+        end
+
+        # Prepend TypedResponse module.
+        def typed_response!
+          prepend TypedResponse
+        end
+
+        # Encodes nested hashes as json.
+        def prepare_body(body)
+          body.each do |k, val|
+            body[k] = val.to_json if val.is_a?(Hash)
+          end
+        end
+      end
+
+      attr_reader :client, :token, :username, :base_uri
+
+      def initialize(token, username = nil)
+        @client = HTTPClient.new
+        @token = token
+        @username = username
+        @base_uri = format URL_TEMPLATE, token
+      end
+
+      def debug!(dev = STDOUT)
+        if block_given?
+          begin
+            old_dev = client.debug_dev
+            client.debug_dev = dev
+            yield
+          ensure
+            client.debug_dev = old_dev
+          end
+        else
+          client.debug_dev = dev
+        end
+      end
+
+      def debug_off!
+        client.debug_dev = nil
+      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 300 > status
+        result = JSON.parse(res.body) rescue nil # rubocop:disable RescueModifier
+        err_msg = "#{res.reason}: #{result && result['description'] || '-'}"
+        # NotFound is raised only for valid responses from Telegram
+        raise NotFound, err_msg if 404 == status && result
+        raise Error, err_msg
+      end
+
+      %w(
+        answerInlineQuery
+        forwardMessage
+        getFile
+        getMe
+        getUpdates
+        getUserProfilePhotos
+        sendAudio
+        sendChatAction
+        sendDocument
+        sendLocation
+        sendMessage
+        sendPhoto
+        sendSticker
+        sendVideo
+        sendVoice
+        setWebhook
+      ).each do |method|
+        define_method(method.underscore) { |*args| request(method, *args) }
+      end
+
+      # Endpoint for low-level request. For easy host highjacking & instrumentation.
+      # Params are not used directly but kept for instrumentation purpose.
+      # You probably don't want to use this method directly.
+      def http_request(uri, body)
+        client.post(uri, body)
+      end
+
+      def inspect
+        "#<Telegram::Bot::Client##{object_id}(#{@username})>"
+      end
+    end
+  end
+end

lib/telegram/bot/client/typed_response.rb

@@ -0,0 +1,38 @@
+module Telegram
+  module Bot
+    class Client
+      # Actions with type-casted results. Install `telegram-bot-types` gem first.
+      module TypedResponse
+        {
+          getFile:              :File,
+          getMe:                :User,
+          getUpdates:           [:Update],
+          getUserProfilePhotos: :UserProfilePhotos,
+
+          forwardMessage:       :Message,
+          sendAudio:            :Message,
+          sendDocument:         :Message,
+          sendLocation:         :Message,
+          sendMessage:          :Message,
+          sendPhoto:            :Message,
+          sendSticker:          :Message,
+          sendVideo:            :Message,
+          sendVoice:            :Message,
+        }.each do |method, type|
+          next unless type
+          if type.is_a?(Array)
+            type_class = Types.const_get(type.first)
+            define_method(method.to_s.underscore) do |*args|
+              request(method, *args)['result'].map { |x| type_class.new(x) }
+            end
+          else
+            type_class = Types.const_get(type)
+            define_method(method.to_s.underscore) do |*args|
+              type_class.new request(method, *args)['result']
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/telegram/bot/client_stub.rb

@@ -0,0 +1,21 @@
+module Telegram
+  module Bot
+    # Stubbed client for tests. Saves all requests into #requests hash.
+    class ClientStub < Client
+      attr_reader :requests
+
+      def initialize(username = nil)
+        @username = username
+        reset
+      end
+
+      def reset
+        @requests = Hash.new { |h, k| h[k] = [] }
+      end
+
+      def request(action, body)
+        requests[action.to_sym] << body
+      end
+    end
+  end
+end

lib/telegram/bot/config_methods.rb

@@ -0,0 +1,46 @@
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/transform_values'
+
+module Telegram
+  module Bot
+    module ConfigMethods
+      # Overwrite config.
+      attr_writer :bots_config
+
+      # Keep this setting here, so we can avoid loading Bot::UpdatesPoller
+      # when polling is disabled.
+      attr_writer :bot_poller_mode
+
+      # 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.
+      def bot_poller_mode?
+        return @bot_poller_mode if defined?(@bot_poller_mode)
+        Rails.env.development? if defined?(Rails)
+      end
+
+      # Hash of bots made with bots_config.
+      def bots
+        @bots ||= bots_config.transform_values(&Client.method(:wrap))
+      end
+
+      # Default bot.
+      def bot
+        @bot ||= bots[:default]
+      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
+      end
+    end
+  end
+end

lib/telegram/bot/middleware.rb

@@ -3,7 +3,7 @@ require 'action_dispatch/http/mime_type'
 require 'action_dispatch/middleware/params_parser'
 
 module Telegram
-  class Bot
+  module Bot
     class Middleware
       attr_reader :bot, :controller
 
@@ -15,7 +15,7 @@ module Telegram
       def call(env)
         update = env['action_dispatch.request.request_parameters']
         controller.dispatch(bot, update)
-        [200, {}, '']
+        [200, {}, ['']]
       end
 
       def inspect

lib/telegram/bot/railtie.rb

@@ -1,7 +1,7 @@
 require 'telegram/bot/routes_helper'
 
 module Telegram
-  class Bot
+  module Bot
     class Railtie < Rails::Railtie
       config.telegram_updates_controller = ActiveSupport::OrderedOptions.new
 
@@ -18,13 +18,15 @@ module Telegram
 
         ActiveSupport.on_load('telegram.bot.updates_controller') do
           self.logger = options.logger || Rails.logger
+          self.session_store = options.session_store || Rails.cache
         end
       end
 
       initializer 'telegram.bot.updates_controller.add_ar_runtime' do
         ActiveSupport.on_load('telegram.bot.updates_controller') do
           if defined?(ActiveRecord::Railties::ControllerRuntime)
-            include ActiveRecord::Railties::ControllerRuntime
+            prepend ActiveRecord::Railties::ControllerRuntime
+            extend ActiveRecord::Railties::ControllerRuntime::ClassMethods
           end
         end
       end

lib/telegram/bot/routes_helper.rb

@@ -1,7 +1,8 @@
 require 'telegram/bot'
+require 'active_support/core_ext/array/wrap'
 
 module Telegram
-  class Bot
+  module Bot
     module RoutesHelper
       class << self
         # Returns route name for given bot. Result depends on `Telegram.bots`.
@@ -15,6 +16,12 @@ module Telegram
             name && "#{name}_telegram_webhook"
           end || 'telegram_webhook'
         end
+
+        # Replaces colon with underscore so rails don't treat it as
+        # route parameter.
+        def escape_token(token)
+          token.tr(':', '_')
+        end
       end
 
       #   # Create routes for all Telegram.bots to use same controller:
@@ -42,14 +49,14 @@ module Telegram
           controllers = Hash[bots.map { |x| [x, controllers] }]
         end
         controllers.each do |bot, controller|
-          bot = Bot.wrap(bot)
+          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/#{bot.token}", params)
+          post("telegram/#{RoutesHelper.escape_token bot.token}", params)
           UpdatesPoller.add(bot, controller) if Telegram.bot_poller_mode?
         end
       end

lib/telegram/bot/updates_controller.rb

@@ -1,15 +1,32 @@
 require 'abstract_controller'
 require 'active_support/callbacks'
+require 'active_support/version'
 
 module Telegram
-  class Bot
+  module Bot
     class UpdatesController < AbstractController::Base
-      include AbstractController::Callbacks
-      include AbstractController::Translation
+      abstract!
 
+      require 'telegram/bot/updates_controller/session'
       require 'telegram/bot/updates_controller/log_subscriber'
       require 'telegram/bot/updates_controller/instrumentation'
+
+      include AbstractController::Callbacks
+      # Redefine callbacks with default terminator.
+      if ActiveSupport.gem_version >= Gem::Version.new('5')
+        define_callbacks  :process_action,
+                          skip_after_callbacks_if_terminated: true
+      else
+        define_callbacks  :process_action,
+                          terminator: ->(_, result) { result == false },
+                          skip_after_callbacks_if_terminated: true
+      end
+
+      include AbstractController::Translation
       prepend Instrumentation
+      extend Session::ConfigMethods
+
+      autoload :TypedUpdate, 'telegram/bot/updates_controller/typed_update'
 
       PAYLOAD_TYPES = %w(
         message
@@ -18,7 +35,6 @@ module Telegram
       ).freeze
       CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
       CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
-      abstract!
 
       class << self
         def dispatch(*args)

lib/telegram/bot/updates_controller/instrumentation.rb

@@ -1,5 +1,5 @@
 module Telegram
-  class Bot
+  module Bot
     class UpdatesController
       # Most methods are taken from ActionController::Instrumentation,
       # some are slightly modified.

lib/telegram/bot/updates_controller/log_subscriber.rb

@@ -1,7 +1,7 @@
 require 'active_support/log_subscriber'
 
 module Telegram
-  class Bot
+  module Bot
     class UpdatesController
       class LogSubscriber < ActiveSupport::LogSubscriber
         def start_processing(event)

lib/telegram/bot/updates_controller/rspec_helpers.rb

@@ -0,0 +1,31 @@
+RSpec.shared_context 'telegram/bot/updates_controller' do
+  let(:controller_class) { described_class }
+  let(:instance) { controller_class.new(bot, update) }
+  let(:update) { {payload_type => payload} }
+  let(:payload_type) { 'some_type' }
+  let(:payload) { double(:payload) }
+  let(:bot) { Telegram::Bot::ClientStub.new(bot_name) }
+  let(:bot_name) { 'bot' }
+  let(:session) do
+    session = Telegram::Bot::UpdatesController::Session::TestSessionHash.new
+    allow_any_instance_of(controller_class).to receive(:session) { session }
+    session
+  end
+
+  def dispatch_message(text, options = {})
+    payload = build_payload :message, options.merge(text: text)
+    controller_class.dispatch bot, payload
+  end
+
+  def build_payload(type, content)
+    deep_stringify type => content
+  end
+
+  def deep_stringify(input)
+    case input
+    when Array then input.map(&method(__callee__))
+    when Hash then input.transform_keys(&:to_s).transform_values(&method(__callee__))
+    else input
+    end
+  end
+end

lib/telegram/bot/updates_controller/session.rb

@@ -0,0 +1,84 @@
+require 'rack/session/abstract/id'
+require 'active_support/cache'
+
+module Telegram
+  module Bot
+    class UpdatesController
+      # Add functionality to store data between requests.
+      module Session
+        extend ActiveSupport::Concern
+
+        def process_action(*)
+          super
+        ensure
+          session.commit
+        end
+
+        protected
+
+        def session
+          @_session ||= SessionHash.new(self.class.session_store, session_key)
+        end
+
+        def session_key
+          "#{bot.username}:#{from ? "from:#{from['id']}" : "chat:#{chat['id']}"}"
+        end
+
+        # Rack::Session::Abstract::SessionHash is taken to provide lazy loading.
+        # All methods that access store are overriden to support
+        # ActiveSupport::Cache::Store stores.
+        class SessionHash < Rack::Session::Abstract::SessionHash
+          attr_reader :id
+
+          def initialize(store, id)
+            @store = store
+            @id = id
+          end
+
+          def destroy
+            clear
+            @store.delete(id)
+          end
+
+          def exists?
+            return @exists if defined?(@exists)
+            @data = {}
+            @exists = @store.exist? id
+          end
+
+          def load!
+            session = @store.read(id)
+            @data = session ? stringify_keys(session) : {}
+            @loaded = true
+          end
+
+          def commit
+            return unless loaded?
+            data = to_hash.delete_if { |_, v| v.nil? }
+            @store.write(id, data)
+          end
+        end
+
+        class TestSessionHash < SessionHash
+          def initialize
+            @data = {}
+            @loaded = true
+            @exists = true
+          end
+
+          alias_method :destroy, :clear
+          alias_method :load!, :id
+          alias_method :commit, :id
+        end
+
+        module ConfigMethods
+          delegate :session_store, to: :config
+
+          def session_store=(store)
+            config.session_store = ActiveSupport::Cache.lookup_store(store)
+          end
+        end
+      end
+    end
+  end
+end

lib/telegram/bot/updates_controller/typed_update.rb

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

lib/telegram/bot/updates_poller.rb

@@ -1,5 +1,5 @@
 module Telegram
-  class Bot
+  module Bot
     # Supposed to be used in development environments only.
     class UpdatesPoller
       class << self
@@ -15,7 +15,7 @@ module Telegram
         end
 
         def start(bot_id, controller = nil)
-          bot = bot_id.is_a?(Symbol) ? Telegram.bots[bot_id] : Bot.wrap(bot_id)
+          bot = bot_id.is_a?(Symbol) ? Telegram.bots[bot_id] : Client.wrap(bot_id)
           instance = controller ? new(bot, controller) : instances[bot]
           raise "Poller not found for #{bot_id.inspect}" unless instance
           instance.start

lib/telegram/bot/version.rb

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

lib/telegram/bottable.rb

@@ -1,41 +0,0 @@
-module Telegram
-  module Bottable
-    # Overwrite config.
-    attr_writer :bots_config
-
-    # Keep this setting here, so we can avoid loading Bot::UpdatesPoller
-    # when polling is disabled.
-    attr_writer :bot_poller_mode
-
-    # 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.
-    def bot_poller_mode?
-      return @bot_poller_mode if defined?(@bot_poller_mode)
-      Rails.env.development? if defined?(Rails)
-    end
-
-    # Hash of bots made with bots_config.
-    def bots
-      @bots ||= bots_config.transform_values(&Bot.method(:wrap))
-    end
-
-    # Default bot.
-    def bot
-      @bot ||= bots[:default]
-    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
-    end
-  end
-end

spec/spec_helper.rb

@@ -14,6 +14,8 @@ GEM_ROOT = Pathname.new File.expand_path('../..', __FILE__)
 
 $LOAD_PATH.unshift GEM_ROOT.join('lib')
 require 'telegram/bot'
+require 'telegram/bot/updates_controller/rspec_helpers'
+require 'telegram/bot/types'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

spec/telegram/bot/client/typed_response_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe Telegram::Bot::Client::TypedResponse do
+  let(:bot) { Telegram::Bot::Client.new('token').tap { |x| x.extend described_class } }
+
+  describe '#get_me' do
+    subject { bot.get_me }
+    before { expect(bot).to receive(:request).with(:getMe) { response } }
+    let(:response) { {'ok' => true, 'result' => {'id' => user_id}} }
+    let(:user_id) { 123 }
+    it { should be_instance_of Telegram::Bot::Types::User }
+    its(:id) { should eq user_id }
+
+    context 'on error' do
+      let(:response) { raise Telegram::Bot::Error }
+      it { expect { subject }.to raise_error Telegram::Bot::Error }
+    end
+  end
+
+  describe '#get_updates' do
+    subject { bot.get_updates }
+    before { expect(bot).to receive(:request).with(:getUpdates) { response } }
+    let(:response) { {'ok' => true, 'result' => [{'update_id' => update_id}]} }
+    let(:update_id) { 123 }
+    it { should be_instance_of Array }
+    its(:first) { should be_instance_of Telegram::Bot::Types::Update }
+    its('first.update_id') { should eq update_id }
+
+    context 'on error' do
+      let(:response) { raise Telegram::Bot::Error }
+      it { expect { subject }.to raise_error Telegram::Bot::Error }
+    end
+  end
+end

spec/telegram/bot/client_spec.rb

@@ -0,0 +1,66 @@
+RSpec.describe Telegram::Bot::Client do
+  describe '.wrap' do
+    subject { described_class.wrap(input) }
+    let(:result) { double(:result) }
+    let(:token) { 'token' }
+    let(:username) { 'username' }
+    let(:instance) { described_class.new 'token' }
+
+    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) { result }
+        should eq result
+      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 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) { result_2 }
+        should eq [result, instance, result_2]
+      end
+    end
+  end
+
+  describe '.prepare_body' do
+    subject { described_class.prepare_body(input) }
+
+    context 'when plain hash is given' do
+      let(:input) { {a: 1, b: '2', c: [1, 2]} }
+      it { should eq input }
+    end
+
+    context 'when nested hash is given' do
+      let(:input) { {a: 1, b: '2', c: [1, 2], d: {a: 1}, e: {b: []}} }
+
+      it 'encodes nested hashes to json' do
+        expected = input.dup
+        %i(d e).each { |x| expected[x] = expected[x].to_json }
+        should eq expected
+      end
+    end
+  end
+end

spec/telegram/bot/middleware_spec.rb

@@ -13,6 +13,6 @@ RSpec.describe Telegram::Bot::Middleware do
       subject
     end
 
-    it { should eq [200, {}, ''] }
+    it { should eq [200, {}, ['']] }
   end
 end

spec/telegram/bot/routes_helper_spec.rb

@@ -1,10 +1,14 @@
 require 'telegram/bot/routes_helper'
 
 RSpec.describe Telegram::Bot::RoutesHelper do
-  let(:bot) { Telegram::Bot.new('bot_token') }
-  let(:other_bot) { Telegram::Bot.new('other_token') }
+  let(:bot) { create_bot('bot_token') }
+  let(:other_bot) { create_bot('other_token') }
   let(:bots) { {default: bot, other: other_bot} }
 
+  def create_bot(*args)
+    Telegram::Bot::Client.new(*args)
+  end
+
   describe '.route_name_for_bot' do
     subject { described_class.route_name_for_bot(input) }
     before { expect(Telegram).to receive(:bots) { bots } }
@@ -82,7 +86,7 @@ RSpec.describe Telegram::Bot::RoutesHelper do
       it 'creates routes for every bot and its controller' do
         assert_routes [bot, controller, 'default_telegram_webhook', option: :val],
                       [
-                        Telegram::Bot.new('custom_token'),
+                        create_bot('custom_token'),
                         other_controller,
                         :custom_route,
                         option: :other_val,
@@ -101,12 +105,12 @@ RSpec.describe Telegram::Bot::RoutesHelper do
 
       it 'creates routes for every created bot and controller' do
         assert_routes [
-          Telegram::Bot.new('custom_token'),
+          create_bot('custom_token'),
           controller,
           'telegram_webhook',
           option: :val,
         ], [
-          Telegram::Bot.new(bot.token, 'new_name'),
+          create_bot(bot.token, 'new_name'),
           controller,
           'telegram_webhook',
           option: :val,

spec/telegram/bot/updates_controller/session_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe Telegram::Bot::UpdatesController::Session do
+  include_context 'telegram/bot/updates_controller'
+  let(:controller_class) do
+    described_class = self.described_class
+    Class.new(Telegram::Bot::UpdatesController) do
+      include described_class
+    end
+  end
+
+  describe '.action_methods' do
+    subject { controller_class.action_methods }
+    it { should be_empty }
+  end
+
+  describe '.dispatch' do
+    subject { ->(*args) { controller_class.dispatch(*args) } }
+    let(:other_bot) { double(username: 'otherBot') }
+    before do
+      controller_class.class_eval do
+        self.session_store = :memory_store
+
+        def write(text)
+          session[:text] = text
+        end
+
+        def read
+          session[:text]
+        end
+      end
+    end
+
+    def build_message(text, from)
+      {'message' => {'text' => text, 'from' => from.stringify_keys}}
+    end
+
+    it 'stores session between requests' do
+      subject.call(bot, build_message('/write test', id: 1))
+      expect(subject.call(bot, build_message('/read', id: 1))).to eq 'test'
+      expect(subject.call(bot, build_message('/read', id: 2))).to eq nil
+      expect(subject.call(other_bot, build_message('/read', id: 1))).to eq nil
+    end
+  end
+end

spec/telegram/bot/updates_controller/typed_update_spec.rb

@@ -0,0 +1,26 @@
+RSpec.describe Telegram::Bot::UpdatesController::TypedUpdate do
+  include_context 'telegram/bot/updates_controller'
+  let(:controller_class) do
+    described_class = self.described_class
+    Class.new(Telegram::Bot::UpdatesController) do
+      include described_class
+    end
+  end
+
+  context 'when `update` is a virtus model' do
+    subject { instance }
+    %w(
+      message
+      inline_query
+      chosen_inline_result
+    ).each do |type|
+      context "with #{type}" do
+        type_class = Telegram::Bot::Types.const_get(type.camelize)
+        let(:payload_type) { type }
+        let(:payload) { {} }
+        its(:payload_type) { should eq payload_type }
+        its(:payload) { should be_instance_of type_class }
+      end
+    end
+  end
+end

spec/telegram/bot/updates_controller_spec.rb

@@ -1,10 +1,5 @@
 RSpec.describe Telegram::Bot::UpdatesController do
-  let(:instance) { described_class.new(bot, update) }
-  let(:update) { {payload_type => payload} }
-  let(:payload_type) { 'some_type' }
-  let(:payload) { double(:payload) }
-  let(:bot) { double(username: bot_name) }
-  let(:bot_name) { 'bot' }
+  include_context 'telegram/bot/updates_controller'
   let(:other_bot_name) { 'other_bot' }
 
   describe '.action_for_command' do
@@ -117,6 +112,24 @@ RSpec.describe Telegram::Bot::UpdatesController do
     end
   end
 
+  context 'when `update` is a virtus model' do
+    subject { instance }
+    let(:update) { Telegram::Bot::Types::Update.new(super()) }
+    %w(
+      message
+      inline_query
+      chosen_inline_result
+    ).each do |type|
+      context "with #{type}" do
+        type_class = Telegram::Bot::Types.const_get(type.camelize)
+        let(:payload_type) { type }
+        let(:payload) { {} }
+        its(:payload_type) { should eq payload_type }
+        its(:payload) { should be_instance_of type_class }
+      end
+    end
+  end
+
   describe '#bot_username' do
     subject { instance.bot_username }
 
@@ -130,4 +143,44 @@ RSpec.describe Telegram::Bot::UpdatesController do
       it { should eq bot.username }
     end
   end
+
+  describe '#process_action' do
+    subject { -> { instance.process_action(:action) } }
+
+    context 'when callbacks are defined' do
+      let(:controller_class) do
+        Class.new(described_class) do
+          before_action :hook
+          attr_reader :acted, :hooked
+
+          def action
+            @acted = true
+          end
+
+          private
+
+          def hook
+            @hooked = true
+          end
+        end
+      end
+
+      it { should change(instance, :hooked).to true }
+      it { should change(instance, :acted).to true }
+
+      context 'when callback returns false' do
+        before do
+          controller_class.prepend(Module.new do
+            def hook
+              super
+              false
+            end
+          end)
+        end
+
+        it { should change(instance, :hooked).to true }
+        it { should_not change(instance, :acted).from nil }
+      end
+    end
+  end
 end

spec/telegram/bot_spec.rb

@@ -1,51 +1,5 @@
 RSpec.describe Telegram::Bot do
   it 'has a version number' do
-    expect(Telegram::Bot::VERSION).not_to be nil
-  end
-
-  describe '.wrap' do
-    subject { described_class.wrap(input) }
-    let(:result) { double(:result) }
-    let(:token) { 'token' }
-    let(:username) { 'username' }
-    let(:instance) { described_class.new 'token' }
-
-    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) { result }
-        should eq result
-      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 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) { result_2 }
-        should eq [result, instance, result_2]
-      end
-    end
+    expect(described_class::VERSION).not_to be nil
   end
 end

telegram-bot.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['melentievm@gmail.com']
 
   spec.summary       = 'Library for building Telegram Bots with Rails integration'
-  spec.homepage      = 'https://github.com/printercu/telegram-bot'
+  spec.homepage      = 'https://github.com/telegram-bot-rb/telegram-bot'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }