Ability to use type-castion with telegram-bot-types

lib/telegram/bot.rb

@@ -1,97 +1,16 @@
-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 :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,94 @@
+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
+      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::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/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
 

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
 

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`.
@@ -42,7 +43,7 @@ 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),

lib/telegram/bot/updates_controller.rb

@@ -2,8 +2,10 @@ require 'abstract_controller'
 require 'active_support/callbacks'
 
 module Telegram
-  class Bot
+  module Bot
     class UpdatesController < AbstractController::Base
+      abstract!
+
       include AbstractController::Callbacks
       include AbstractController::Translation
 
@@ -11,6 +13,8 @@ module Telegram
       require 'telegram/bot/updates_controller/instrumentation'
       prepend Instrumentation
 
+      autoload :TypedUpdate, 'telegram/bot/updates_controller/typed_update'
+
       PAYLOAD_TYPES = %w(
         message
         inline_query
@@ -18,7 +22,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,8 @@
+RSpec.shared_context 'telegram/bot/updates_controller' 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' }
+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,5 +1,5 @@
 module Telegram
-  class Bot
+  module Bot
     VERSION = '0.3.0'.freeze
 
     def self.gem_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