telegrammer 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d0ee4efb76d8d569cc4082605df91692c262439
-  data.tar.gz: f8955b60e5c18a973835e27c307d0d5e3df744d0
+  metadata.gz: 1e7d63ced4d594d0750cff564f42d74cc737ee9c
+  data.tar.gz: 47b850bb589fb3c4ee0a9be1e5ed2a70ed77c0cd
 SHA512:
-  metadata.gz: 8f71a0902ead755f1ccf41d3c7f78754cbfa7b4492b7627c9fcff5fdd6fc9516da04bda3386635573e4166038501884e7dd1377b39932ce96443d6ba29010e2b
-  data.tar.gz: db5a654a0873cc194c81fbbef051bcd0551b5e9d39f75b87ff2fe7fd1c0c68ebf4c0d697d0ac987845008a314bcd5107dd9ffea7fa8db0e8fac32fa0113452a8
+  metadata.gz: 514d1f49af6ca9fb18264f6eaaaac6d4b541efc8d150f0fe8140b8b19ae125af08b67b2bbdba6e93958d47e88c0c145bbb2f6e9fa827aee9d2cd903472cdaab3
+  data.tar.gz: bf8d83bdbac9e10b21ffe557fce10f4b669edca9b586f11b0b7f70076c0d1c5b4afac66c024dc1164f946882478779d21a25f2fff74277accd8f0bf5767a228f

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+v0.7.0
+======
+
+* Added support for supergroups (https://telegram.org/blog/supergroups).
+* Added support for the new inline mode (https://core.telegram.org/bots/inline).
+* Gem is now up to date with API version 2016-01-04 (https://core.telegram.org/bots/api-changelog#january-4-2016).
+
 v0.6.2
 ======
 

data/lib/telegrammer.rb

@@ -26,6 +26,14 @@ require 'telegrammer/data_types/reply_keyboard_markup'
 require 'telegrammer/data_types/update'
 require 'telegrammer/data_types/user_profile_photos'
 
+require 'telegrammer/data_types/chosen_inline_result'
+require 'telegrammer/data_types/inline_query'
+require 'telegrammer/data_types/inline_query_result_article'
+require 'telegrammer/data_types/inline_query_result_gif'
+require 'telegrammer/data_types/inline_query_result_mpeg4_gif'
+require 'telegrammer/data_types/inline_query_result_photo'
+require 'telegrammer/data_types/inline_query_result_video'
+
 require 'telegrammer/bot'
 require 'telegrammer/api_response'
 

data/lib/telegrammer/bot.rb

@@ -443,12 +443,55 @@ module Telegrammer
         file_id: { required: true, class: [String] }
       }
 
-      response = response = api_request("getFile", params, params_validation)
+      response = api_request("getFile", params, params_validation)
       file_object = Telegrammer::DataTypes::File.new(response.result)
 
       "#{API_ENDPOINT}/file/bot#{@api_token}/#{file_object.file_path}"
     end
 
+    # Answer an inline query. On success, True is returned. No more than 50 results per query are allowed.
+    #
+    # @param [Hash] params hash of paramers to send to the answerInlineQuery API operation.
+    # @option params [String] :inline_query_id Required. Unique identifier for the answered query
+    # @option params [Array] :results Required. An array of InlineQueryResults objects for the inline query
+    # @option params [Fixnum] :cache_time Optional. The maximum amount of time the result of the inline query may be cached on the server
+    # @option params [TrueClass,FalseClass] :is_personal Optional. Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query
+    # @option params [String] :next_offset Optional. Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.
+
+    #
+    # @example
+    #     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')
+    #
+    #     bot.get_updates do |message|
+    #       inline_query = message.inline_query
+    #
+    #       if inline_query
+    #         results = the_search_in_my_app(inline_query.query)
+    #
+    #         bot.answer_inline_query(
+    #           inline_query_id: "my-internal-query-id",
+    #           results: results
+    #         )
+    #       end
+    #     end
+
+    #
+    # @raise [Telegrammer::Errors::BadRequestError]
+    # @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down
+    #
+    # @return [TrueClass] True if all was OK
+    def answer_inline_query(params)
+      params_validation = {
+        inline_query_id: { required: true, class: [String] },
+        results: { required: true, class: [Array] },
+        cache_time: { required: false, class: [Fixnum] },
+        is_personal: { required: false, class: [TrueClass, FalseClass] },
+        next_offset: { required: false, class: [String] }
+      }
+
+      response = api_request("answerInlineQuery", params, params_validation)
+    end
+
     private
 
     def api_request(action, params, params_validation)

data/lib/telegrammer/data_types/chat.rb

@@ -3,7 +3,7 @@ module Telegrammer
     # Telegram Chat data type
     #
     # @attr [Integer] id Unique identifier for this chat, not exceeding 1e13 by absolute value
-    # @attr [String] type Type of chat, can be either “private”, or “group”, or “channel”
+    # @attr [String] type Type of chat, can be either “private”, “group”, “supergroup” or “channel”
     # @attr [String] title Optional. Title, for channels and group chats
     # @attr [String] username Optional. Username, for private chats and channels if available
     # @attr [String] first_name Optional. First name of the other party in a private chat

data/lib/telegrammer/data_types/chosen_inline_result.rb

@@ -0,0 +1,16 @@
+module Telegrammer
+  module DataTypes
+    # Telegram ChosenInlineResult data type
+    #
+    # @attr [String] result_id The unique identifier for the result that was chosen.
+    # @attr [Telegrammer::DataTypes::User] from The user that chose the result.
+    # @attr [String] query The query that was used to obtain the result.
+    #
+    # See more at https://core.telegram.org/bots/api#choseninlineresult
+    class ChosenInlineResult < Telegrammer::DataTypes::Base
+      attribute :result_id, String
+      attribute :from, User
+      attribute :string, String
+    end
+  end
+end

data/lib/telegrammer/data_types/inline_query.rb

@@ -0,0 +1,19 @@
+module Telegrammer
+  module DataTypes
+    # Telegram InlineQuery data type
+    #
+    # @attr [String] id Unique identifier for this query
+    # @attr [Telegrammer::DataTypes::User] from Sender
+    # @attr [String] query Text of the query
+    # @attr [String] offset Offset of the results to be returned, can be controlled by the bot
+    #
+    # See more at https://core.telegram.org/bots/api#inlinequery
+    class InlineQuery < Telegrammer::DataTypes::Base
+      attribute :id, String
+      attribute :from, User
+      attribute :query, String
+      attribute :offset, String
+      attribute :title, String
+    end
+  end
+end

data/lib/telegrammer/data_types/inline_query_result_article.rb

@@ -0,0 +1,33 @@
+module Telegrammer
+  module DataTypes
+    # Telegram InlineQueryResultArticle data type
+    #
+    # @attr [String] type Type of the result, must be article
+    # @attr [String] id Unique identifier for this result, 1-64 Bytes
+    # @attr [String] title Title of the result
+    # @attr [String] message_text Text of the message to be sent
+    # @attr [String] parse_mode Optional. Send “Markdown”, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.
+    # @attr [Boolean] disable_web_page_preview Optional. Disables link previews for links in the sent message
+    # @attr [String] url Optional. URL of the result
+    # @attr [Boolean] hide_url Optional. Pass True, if you don't want the URL to be shown in the message
+    # @attr [String] description Optional. Short description of the result
+    # @attr [String] thumb_url Optional. Url of the thumbnail for the result
+    # @attr [Integer] thumb_width Optional. Thumbnail width
+    # @attr [Integer] thumb_height Optional. Thumbnail height
+    #
+    # See more at https://core.telegram.org/bots/api#inlinequeryresultarticle
+    class InlineQueryResultArticle < Telegrammer::DataTypes::Base
+      attribute :type, String
+      attribute :id, String
+      attribute :title, String
+      attribute :message_text, 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
+    end
+  end
+end

data/lib/telegrammer/data_types/inline_query_result_gif.rb

@@ -0,0 +1,32 @@
+module Telegrammer
+  module DataTypes
+    # Telegram InlineQueryResultGif data type
+    #
+    # @attr [String] type Type of the result, must be gif
+    # @attr [String] id Unique identifier for this result, 1-64 bytes
+    # @attr [String] gif_url A valid URL for the GIF file. File size must not exceed 1MB
+    # @attr [Integer] gif_width Optional. Width of the GIF
+    # @attr [Integer] gif_height Optional. Height of the GIF
+    # @attr [String] thumb_url URL of the static thumbnail for the result (jpeg or gif)
+    # @attr [String] title Optional. Title for the result
+    # @attr [String] caption Optional. Caption of the GIF file to be sent, 0-200 characters
+    # @attr [String] message_text Optional. Text of a message to be sent instead of the animation, 1-512 characters
+    # @attr [String] parse_mode Optional. Send “Markdown”, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.
+    # @attr [Boolean] disable_web_page_preview Optional. Disables link previews for links in the sent message
+    #
+    # See more at https://core.telegram.org/bots/api#inlinequeryresultgif
+    class InlineQueryResultGif < Telegrammer::DataTypes::Base
+      attribute :type, String
+      attribute :id, String
+      attribute :gif_url, String
+      attribute :gif_width, Integer
+      attribute :git_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

data/lib/telegrammer/data_types/inline_query_result_mpeg4_gif.rb

@@ -0,0 +1,32 @@
+module Telegrammer
+  module DataTypes
+    # Telegram InlineQueryResultMpeg4Gif data type
+    #
+    # @attr [String] type Type of the result, must be mpeg4_gif
+    # @attr [String] id Unique identifier for this result, 1-64 bytes
+    # @attr [String] mpeg4_url A valid URL for the MP4 file. File size must not exceed 1MB
+    # @attr [Integer] mpeg4_width Optional. Video width
+    # @attr [Integer] mpeg4_height Optional. Video height
+    # @attr [String] thumb_url URL of the static thumbnail (jpeg or gif) for the result
+    # @attr [String] title Optional. Title for the result
+    # @attr [String] caption Optional. Caption of the MPEG-4 file to be sent, 0-200 characters
+    # @attr [String] message_text Optional. Text of a message to be sent instead of the animation, 1-512 characters
+    # @attr [String] parse_mode Optional. Send “Markdown”, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.
+    # @attr [Boolean] disable_web_page_preview Optional. Disables link previews for links in the sent message
+    #
+    # See more at https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif
+    class InlineQueryResultMpeg4Gif < Telegrammer::DataTypes::Base
+      attribute :type, String
+      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

data/lib/telegrammer/data_types/inline_query_result_photo.rb

@@ -0,0 +1,34 @@
+module Telegrammer
+  module DataTypes
+    # Telegram InlineQueryResultPhoto data type
+    #
+    # @attr [String] type Type of the result, must be article
+    # @attr [String] id Unique identifier for this result, 1-64 Bytes
+    # @attr [String] photo_url A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB
+    # @attr [Integer] photo_width Optional. Width of the photo
+    # @attr [Integer] photo_height Optional. Height of the photo
+    # @attr [String] thumb_url URL of the thumbnail for the photo
+    # @attr [String] title Title of the result
+    # @attr [String] description Optional. Short description of the result
+    # @attr [String] caption Optional. Caption of the photo to be sent, 0-200 characters
+    # @attr [String] message_text Optional. Text of a message to be sent instead of the photo, 1-512 characters
+    # @attr [String] parse_mode Optional. Send “Markdown”, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.
+    # @attr [Boolean] disable_web_page_preview Optional. Disables link previews for links in the sent message
+    #
+    # See more at https://core.telegram.org/bots/api#inlinequeryresultphoto
+    class InlineQueryResultPhoto < Telegrammer::DataTypes::Base
+      attribute :type, String
+      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

data/lib/telegrammer/data_types/inline_query_result_video.rb

@@ -0,0 +1,36 @@
+module Telegrammer
+  module DataTypes
+    # Telegram InlineQueryResultVideo data type
+    #
+    # @attr [String] type Type of the result, must be video
+    # @attr [String] id Unique identifier for this result, 1-64 bytes
+    # @attr [String] video_url A valid URL for the embedded video player or video file
+    # @attr [String] mime_type Mime type of the content of video url, “text/html” or “video/mp4”
+    # @attr [String] message_text Text of the message to be sent with the video, 1-512 characters
+    # @attr [String] parse_mode Optional. Send “Markdown”, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.
+    # @attr [Boolean] disable_web_page_preview Optional. Disables link previews for links in the sent message
+    # @attr [Integer] video_width Optional. Video width
+    # @attr [Integer] video_height Optional. Video height
+    # @attr [Integer] video_duration Optional. Video duration in seconds
+    # @attr [String] thumb_url URL of the thumbnail (jpeg only) for the video
+    # @attr [String] title Title for the result
+    # @attr [String] description Optional. Short description of the result
+    #
+    # See more at https://core.telegram.org/bots/api#inlinequeryresultvideo
+    class InlineQueryResultVideo < Telegrammer::DataTypes::Base
+      attribute :type, String
+      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

data/lib/telegrammer/data_types/message.rb

@@ -25,6 +25,10 @@ module Telegrammer
     # @attr [Telegrammer::DataTypes::PhotoSize] new_chat_photo Optional. A group photo was change to this value
     # @attr [Boolean] delete_chat_photo Optional. Informs that the group photo was deleted
     # @attr [Boolean] group_chat_created Optional. Informs that the group has been created
+    # @attr [Boolean] supergroup_chat_created Optional. Service message: the supergroup has been created
+    # @attr [Boolean] channel_chat_created Optional. Service message: the channel has been created
+    # @attr [Integer] migrate_to_chat_id Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value
+    # @attr [Integer] migrate_from_chat_id Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value
     #
     # See more at https://core.telegram.org/bots/api#message
     class Message < Telegrammer::DataTypes::Base
@@ -50,6 +54,10 @@ module Telegrammer
       attribute :new_chat_photo, Array[PhotoSize]
       attribute :delete_chat_photo, Boolean
       attribute :group_chat_created, Boolean
+      attribute :supergroup_chat_created, Boolean
+      attribute :channel_chat_created, Boolean
+      attribute :migrate_from_chat_id, Integer
+      attribute :migrate_to_chat_id, Integer
     end
   end
 end

data/lib/telegrammer/data_types/update.rb

@@ -4,11 +4,13 @@ module Telegrammer
     #
     # @attr [Integer] update_id The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially.
     # @attr [Telegrammer::DataTypes::Message] message Optional. New incoming message of any kind - text, photo, sticker, etc.
+    # @attr [Telegrammer::DataTypes::InlineQuery] inline_query Optional. New incoming inline query.
     #
     # See more at https://core.telegram.org/bots/api#update
     class Update < Telegrammer::DataTypes::Base
       attribute :update_id, Integer
       attribute :message, Message
+      attribute :inline_query, InlineQuery
     end
   end
 end

data/lib/telegrammer/version.rb

@@ -1,3 +1,3 @@
 module Telegrammer
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegrammer
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Luis Mayoral
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-14 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -98,11 +98,18 @@ files:
 - lib/telegrammer/data_types/audio.rb
 - lib/telegrammer/data_types/base.rb
 - lib/telegrammer/data_types/chat.rb
+- lib/telegrammer/data_types/chosen_inline_result.rb
 - lib/telegrammer/data_types/contact.rb
 - lib/telegrammer/data_types/document.rb
 - lib/telegrammer/data_types/file.rb
 - lib/telegrammer/data_types/force_reply.rb
 - lib/telegrammer/data_types/group_chat.rb
+- lib/telegrammer/data_types/inline_query.rb
+- lib/telegrammer/data_types/inline_query_result_article.rb
+- lib/telegrammer/data_types/inline_query_result_gif.rb
+- lib/telegrammer/data_types/inline_query_result_mpeg4_gif.rb
+- lib/telegrammer/data_types/inline_query_result_photo.rb
+- lib/telegrammer/data_types/inline_query_result_video.rb
 - lib/telegrammer/data_types/location.rb
 - lib/telegrammer/data_types/message.rb
 - lib/telegrammer/data_types/photo_array.rb
@@ -137,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Telegram's Bots API