telegram-bot-ruby 0.3.11 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4556db3d1e5de794e842e522c6eb0a7e588022c6
-  data.tar.gz: 2fc8acce5c5d5ae4188c70b1394a175375bd72d9
+  metadata.gz: 2f97dd430cc9b267ecc9bb00d55bd50dfb34b091
+  data.tar.gz: cfff29e4848daad38fdd280e968f62f31b987ee8
 SHA512:
-  metadata.gz: dbbd6285c05adb6ae4e3c0e9b08846104b60b2337347261615d2e1a663fa228761d1fbf508c30e98095029affc9c70f7a379da30bc0ab3d02b096582904587dd
-  data.tar.gz: 0eefaab43ecfb56f2c1c50dcd470342527552bda97b381c07b836e122d22899694636a2c2c4a1420e8288373996e7dda058da3d30dd0d01ae25bf501ec73b770
+  metadata.gz: f9763fcfe74b8e3bb067cd923182ebaa3418a7b68e9f71719baa8cf2a437810f3f58c8cefd76a8caaabb3eb1b8188fc7f0453213cf57d634aa841e7d8fade106
+  data.tar.gz: 9530676f3ee98dbb7edbf0901bf3a97a4a010f00209afdb7316f189e1f8c2b6df255761e3ca8de3e8c1a6b97fb6cef30c71bdf4fabc4da750621bcb46d8972c0

data/README.md

@@ -50,6 +50,10 @@ Note that `bot.api` object implements [Telegram Bot API methods](https://core.te
 
 Same thing about `message` object - it implements [Message](https://core.telegram.org/bots/api#message) spec, so you always know what to expect from it.
 
+## Webhooks
+
+If you are going to use [webhooks](https://core.telegram.org/bots/api#setwebhook) instead of [long polling](https://core.telegram.org/bots/api#getupdates), you need to implement your own webhook callbacks server. Take a look at [this repo](https://github.com/solyaris/BOTServer) as an example.
+
 ## Custom keyboards
 
 You can use your own [custom keyboards](https://core.telegram.org/bots#keyboards). Here is an example:
@@ -72,6 +76,31 @@ bot.listen do |message|
 end
 ```
 
+## Inline bots
+
+If you are going to create [inline bot](https://core.telegram.org/bots/inline), check the example below:
+
+```ruby
+bot.listen do |message|
+  case message
+  when Telegram::Bot::Types::InlineQuery
+    results = [
+      Telegram::Bot::Types::InlineQueryResultArticle
+        .new(id: 1, title: 'First article', message_text: 'Very interesting text goes here.'),
+      Telegram::Bot::Types::InlineQueryResultArticle
+        .new(id: 2, title: 'Second article', message_text: 'Another interesting text here.')
+    ]
+    bot.api.answer_inline_query(inline_query_id: message.id, results: results)
+  when Telegram::Bot::Types::Message
+    bot.api.send_message(chat_id: message.chat.id, text: "Hello, #{message.from.first_name}!")
+  end
+end
+```
+
+Now, with `inline` mode enabled, your `message` object can be an instance of [Message](https://core.telegram.org/bots/api#message), [InlineQuery](https://core.telegram.org/bots/api#inlinequery) or [ChosenInlineResult](https://core.telegram.org/bots/api#choseninlineresult). That's why you need to check type of each message and decide how to handle it.
+
+Using `answer_inline_query` you can send query results to user. `results` field must be an array of [query result objects](https://core.telegram.org/bots/api#inlinequeryresult).
+
 ## File upload
 
 Your bot can even upload files ([photos](https://core.telegram.org/bots/api#sendphoto), [audio](https://core.telegram.org/bots/api#sendaudio), [documents](https://core.telegram.org/bots/api#senddocument), [stickers](https://core.telegram.org/bots/api#sendsticker), [video](https://core.telegram.org/bots/api#sendvideo)) to Telegram servers. Just like this:
@@ -133,6 +162,11 @@ Sometimes you need to do some heavy work in another thread and send response fro
 $ TELEGRAM_BOT_POOL_SIZE=4 ruby bot.rb
 ```
 
+## Boilerplates
+
+If you don't know how to setup database for your bot or how to use it with different languages here are some boilerplates which can help you to start faster:
+- [Ruby Telegram Bot boilerplate](https://github.com/telegram-bots/ruby-telegram-bot-boilerplate)
+
 ## Contributing
 
 1. Fork it

data/lib/telegram/bot/api.rb

@@ -6,13 +6,20 @@ module Telegram
       ENDPOINTS = %w(
         getMe sendMessage forwardMessage sendPhoto sendAudio sendDocument
         sendSticker sendVideo sendVoice sendLocation sendChatAction
-        getUserProfilePhotos getUpdates setWebhook getFile
+        getUserProfilePhotos getUpdates setWebhook getFile answerInlineQuery
       ).freeze
       REPLY_MARKUP_TYPES = [
         Telegram::Bot::Types::ReplyKeyboardMarkup,
         Telegram::Bot::Types::ReplyKeyboardHide,
         Telegram::Bot::Types::ForceReply
       ].freeze
+      INLINE_QUERY_RESULT_TYPES = [
+        Telegram::Bot::Types::InlineQueryResultArticle,
+        Telegram::Bot::Types::InlineQueryResultGif,
+        Telegram::Bot::Types::InlineQueryResultMpeg4Gif,
+        Telegram::Bot::Types::InlineQueryResultPhoto,
+        Telegram::Bot::Types::InlineQueryResultVideo
+      ].freeze
       POOL_SIZE = ENV.fetch('TELEGRAM_BOT_POOL_SIZE', 1).to_i.freeze
 
       attr_reader :token
@@ -53,7 +60,7 @@ module Telegram
       end
 
       def sanitize_value(value)
-        jsonify_reply_markup(value)
+        jsonify_inline_query_results(jsonify_reply_markup(value))
       end
 
       def jsonify_reply_markup(value)
@@ -61,6 +68,11 @@ module Telegram
         value.to_h.to_json
       end
 
+      def jsonify_inline_query_results(value)
+        return value unless Array(value).all? { |i| INLINE_QUERY_RESULT_TYPES.include?(i.class) }
+        value.map { |i| i.to_h.select { |_, v| v } }.to_json
+      end
+
       def camelize(method_name)
         words = method_name.split('_')
         words.drop(1).map(&:capitalize!)

data/lib/telegram/bot/client.rb

@@ -37,8 +37,9 @@ module Telegram
         response['result'].each do |data|
           update = Types::Update.new(data)
           @offset = update.update_id.next
-          log_incoming_message(update.message)
-          yield update.message
+          message = extract_message(update)
+          log_incoming_message(message)
+          yield message
         end
       rescue *TIMEOUT_EXCEPTIONS
         retry
@@ -50,13 +51,13 @@ module Telegram
         { offset: 0, timeout: 20, logger: NullLogger.new }
       end
 
+      def extract_message(update)
+        update.inline_query || update.chosen_inline_result || update.message
+      end
+
       def log_incoming_message(message)
         logger.info(
-          format(
-            'Incoming message: text="%s" uid=%i',
-            message.text,
-            message.from.id
-          )
+          format('Incoming message: text="%s" uid=%i', message, message.from.id)
         )
       end
     end

data/lib/telegram/bot/exceptions/response_error.rb

@@ -14,7 +14,7 @@ module Telegram
         end
 
         def error_code
-          data[:error_code] || data["error_code"]
+          data[:error_code] || data['error_code']
         end
 
         private

data/lib/telegram/bot/types.rb

@@ -10,6 +10,13 @@ require 'telegram/bot/types/contact'
 require 'telegram/bot/types/location'
 require 'telegram/bot/types/chat'
 require 'telegram/bot/types/message'
+require 'telegram/bot/types/inline_query'
+require 'telegram/bot/types/inline_query_result_article'
+require 'telegram/bot/types/inline_query_result_photo'
+require 'telegram/bot/types/inline_query_result_gif'
+require 'telegram/bot/types/inline_query_result_mpeg4_gif'
+require 'telegram/bot/types/inline_query_result_video'
+require 'telegram/bot/types/chosen_inline_result'
 require 'telegram/bot/types/update'
 require 'telegram/bot/types/reply_keyboard_markup'
 require 'telegram/bot/types/reply_keyboard_hide'

data/lib/telegram/bot/types/chosen_inline_result.rb

@@ -0,0 +1,13 @@
+module Telegram
+  module Bot
+    module Types
+      class ChosenInlineResult < Base
+        attribute :result_id, String
+        attribute :from, User
+        attribute :query, String
+
+        alias_method :to_s, :query
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/inline_query.rb

@@ -0,0 +1,14 @@
+module Telegram
+  module Bot
+    module Types
+      class InlineQuery < Base
+        attribute :id, String
+        attribute :from, User
+        attribute :query, String
+        attribute :offset, String
+
+        alias_method :to_s, :query
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/inline_query_result_article.rb

@@ -0,0 +1,21 @@
+module Telegram
+  module Bot
+    module Types
+      class InlineQueryResultArticle < Base
+        attribute :type, String, default: 'article'
+        attribute :id, String
+        attribute :title, String
+        attribute :message_text, String
+        attribute :parse_mode, String
+        attribute :parse_mode, String
+        attribute :disable_web_page_preview, Boolean
+        attribute :url, String
+        attribute :hide_url, Boolean
+        attribute :description, String
+        attribute :thumb_url, String
+        attribute :thumb_width, Integer
+        attribute :thumb_height, Integer
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/inline_query_result_gif.rb

@@ -0,0 +1,19 @@
+module Telegram
+  module Bot
+    module Types
+      class InlineQueryResultGif < Base
+        attribute :type, String, default: 'gif'
+        attribute :id, String
+        attribute :gif_url, String
+        attribute :gif_width, Integer
+        attribute :gif_height, Integer
+        attribute :thumb_url, String
+        attribute :title, String
+        attribute :caption, String
+        attribute :message_text, String
+        attribute :parse_mode, String
+        attribute :disable_web_page_preview, Boolean
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/inline_query_result_mpeg4_gif.rb

@@ -0,0 +1,19 @@
+module Telegram
+  module Bot
+    module Types
+      class InlineQueryResultMpeg4Gif < Base
+        attribute :type, String, default: 'mpeg4_gif'
+        attribute :id, String
+        attribute :mpeg4_url, String
+        attribute :mpeg4_width, Integer
+        attribute :mpeg4_height, Integer
+        attribute :thumb_url, String
+        attribute :title, String
+        attribute :caption, String
+        attribute :message_text, String
+        attribute :parse_mode, String
+        attribute :disable_web_page_preview, Boolean
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/inline_query_result_photo.rb

@@ -0,0 +1,20 @@
+module Telegram
+  module Bot
+    module Types
+      class InlineQueryResultPhoto < Base
+        attribute :type, String, default: 'photo'
+        attribute :id, String
+        attribute :photo_url, String
+        attribute :photo_width, Integer
+        attribute :photo_height, Integer
+        attribute :thumb_url, String
+        attribute :title, String
+        attribute :description, String
+        attribute :caption, String
+        attribute :message_text, String
+        attribute :parse_mode, String
+        attribute :disable_web_page_preview, Boolean
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/inline_query_result_video.rb

@@ -0,0 +1,21 @@
+module Telegram
+  module Bot
+    module Types
+      class InlineQueryResultVideo < Base
+        attribute :type, String, default: 'video'
+        attribute :id, String
+        attribute :video_url, String
+        attribute :mime_type, String
+        attribute :message_text, String
+        attribute :parse_mode, String
+        attribute :disable_web_page_preview, Boolean
+        attribute :video_width, Integer
+        attribute :video_height, Integer
+        attribute :video_duration, Integer
+        attribute :thumb_url, String
+        attribute :title, String
+        attribute :description, String
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/message.rb

@@ -25,6 +25,8 @@ module Telegram
         attribute :delete_chat_photo, Boolean
         attribute :group_chat_created, Boolean
         attribute :chat, Chat
+
+        alias_method :to_s, :text
       end
     end
   end

data/lib/telegram/bot/types/update.rb

@@ -4,6 +4,8 @@ module Telegram
       class Update < Base
         attribute :update_id, Integer
         attribute :message, Message
+        attribute :inline_query, InlineQuery
+        attribute :chosen_inline_result, ChosenInlineResult
       end
     end
   end

data/lib/telegram/bot/version.rb

@@ -1,5 +1,5 @@
 module Telegram
   module Bot
-    VERSION = '0.3.11'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-bot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexander Tipugin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
@@ -137,10 +137,17 @@ files:
 - lib/telegram/bot/types/audio.rb
 - lib/telegram/bot/types/base.rb
 - lib/telegram/bot/types/chat.rb
+- lib/telegram/bot/types/chosen_inline_result.rb
 - lib/telegram/bot/types/contact.rb
 - lib/telegram/bot/types/document.rb
 - lib/telegram/bot/types/file.rb
 - lib/telegram/bot/types/force_reply.rb
+- lib/telegram/bot/types/inline_query.rb
+- lib/telegram/bot/types/inline_query_result_article.rb
+- lib/telegram/bot/types/inline_query_result_gif.rb
+- lib/telegram/bot/types/inline_query_result_mpeg4_gif.rb
+- lib/telegram/bot/types/inline_query_result_photo.rb
+- lib/telegram/bot/types/inline_query_result_video.rb
 - lib/telegram/bot/types/location.rb
 - lib/telegram/bot/types/message.rb
 - lib/telegram/bot/types/photo_size.rb