telegrammer 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ccbe938586bdb894b8bb7da76c5f4f1223e25fb
-  data.tar.gz: d1081a1b521c670e287ac228e962103f574dd386
+  metadata.gz: 725b61fa8cb25386f77232d48030a47982aaefd4
+  data.tar.gz: 8e50940cb2f539cbcf616b164921e610d7e353cb
 SHA512:
-  metadata.gz: 31ca5931228d51197094729224556299b4bcbbf81d9d9da4ef8cdcea90296e15de16fa67305f1d7eef54c8394fe62458654f3892cf3bd861214cbfa07c22d63d
-  data.tar.gz: a7029706230bfe110efac6df6fb32f793278f8b8d7c8ad5d5fe0166abc69825a0e5fcbfdd2afb82d86893b689aaf88df54e2ec7178e874e3e0a8b97a9d5699b2
+  metadata.gz: 470585dd3ee07e23b45857582b4e2393fbbbd9c385bd1166b9a75c0a83b9478a8122442148c7b5052a3b57615ef922e0554ce7a209f0f70bcca15e16e6e9c4f6
+  data.tar.gz: 6d8ba416eefc3c4ca4717903f3dcb2834d440ac9d04115750c9ae42faf0b0fec43b8ecee0ec6b0b316ec8238f70779b77a2b2f9c89ee744c432c7d34964e37ca

data/CHANGELOG.md

@@ -1,8 +1,14 @@
+v0.6.1
+======
+
+* Updated operations that are using chat_id to also support "@channel" format (reported by @rkpasia in #15).
+
 v0.6.0
 ======
 
 * New File & Chat datatypes.
 * Implemented get_file operation.
+* Gem is now up to date with API version 2015-10-08 (https://core.telegram.org/bots/api-changelog#october-8-2015).
 
 v0.5.1
 ======

data/lib/telegrammer/bot.rb

@@ -110,7 +110,7 @@ module Telegrammer
     # Send text messages to a user or group chat.
     #
     # @param [Hash] params hash of paramers to send to the sendMessage API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [String] :text Required. Text of the message to be sent
     # @option params [String] :parse_mode Optional. Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.
     # @option params [Boolean] :disable_web_page_preview Optional. Disables link previews for links in this message
@@ -142,8 +142,8 @@ module Telegrammer
     # Forward message to a user or group chat.
     #
     # @param [Hash] params hash of paramers to send to the forwardMessage API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
-    # @option params [Integer] :from_chat_id Required. Unique identifier for the chat where the original message was sent.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
+    # @option params [Integer,String] :from_chat_id Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername).
     # @option params [Integer] :message_id Required. Message id to be forwarded.
     #
     # @example
@@ -174,7 +174,7 @@ module Telegrammer
     # Sends a photo to a user or group chat.
     #
     # @param [Hash] params hash of paramers to send to the sendPhoto API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [File,String] :photo Required. Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data.
     # @option params [String] :caption Optional. Photo caption (may also be used when resending photos by file_id).
     # @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message
@@ -204,7 +204,7 @@ module Telegrammer
     # At this moment, Telegram only allows Ogg files encoded with the OPUS codec. If you need to send another file format, you must use #send_document.
     #
     # @param [Hash] params hash of paramers to send to the sendAudio API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [File,String] audio Required. Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data
     # @option params [Integer] duration Optional. Duration of the audio in seconds.
     # @option params [String] performer Optional. Performer.
@@ -238,7 +238,7 @@ module Telegrammer
     # At this moment, Telegram only allows Ogg files encoded with the OPUS codec. If you need to send another file format, you must use #send_document.
     #
     # @param [Hash] params hash of paramers to send to the sendAudio API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [File,String] voice Required. Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data
     # @option params [Integer] duration Optional. Duration of sent audio in seconds.
     # @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message
@@ -267,7 +267,7 @@ module Telegrammer
     # Sends a document to a user or group chat.
     #
     # @param [Hash] params hash of paramers to send to the sendDocument API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [File,String] :document Required. File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.
     # @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message
     # @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
@@ -292,7 +292,7 @@ module Telegrammer
     # Send WebP images as stickers.
     #
     # @param [Hash] params hash of paramers to send to the sendSticker API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [File,String] :sticker Required. Sticker to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.
     # @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message
     # @option params [Telegrammer::DataTypes::ReplyKeyboardMarkup,Telegrammer::DataTypes::ReplyKeyboardHide,Telegrammer::DataTypes::ForceReply] :reply_markup Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
@@ -320,7 +320,7 @@ module Telegrammer
     # At this moment, Telegram only support mp4 videos. If you need to send other formats you must use #send_document.
     #
     # @param [Hash] params hash of paramers to send to the sendVideo API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [File,String] :video Required. Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file.
     # @option params [Integer] :duration Optional. Duration of sent video in seconds.
     # @option params [String] :caption Optional. Video caption (may also be used when resending videos by file_id).
@@ -350,7 +350,7 @@ module Telegrammer
     # Sends point on the map to a user or group chat.
     #
     # @param [Hash] params hash of paramers to send to the sendAudio API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [Float] :latitude Required. Latitude of location.
     # @option params [Float] :longitude Required. Longitude of location.
     # @option params [Integer] :reply_to_message_id Optional. If the message is a reply, ID of the original message.
@@ -378,7 +378,7 @@ module Telegrammer
     # Used when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).
     #
     # @param [Hash] params hash of paramers to send to the sendChatAction API operation.
-    # @option params [Integer] :chat_id Required. Unique identifier for the message recipient — User or GroupChat id.
+    # @option params [Integer,String] :chat_id Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername).
     # @option params [String] :action Required. Type of action to broadcast. Choose one, depending on what the user is about to receive: "typing" for text messages, "upload_photo" for photos, "record_video" or "upload_video" for videos, "record_audio" or "upload_audio" for audio files, "upload_document" for general files, "find_location" for location data.
     #
     # @example
@@ -391,7 +391,7 @@ module Telegrammer
     # @return [Telegrammer::ApiResponse] Response from the API.
     def send_chat_action(params)
       params_validation = {
-        chat_id: { required: true, class: [Fixnum] },
+        chat_id: { required: true, class: [Fixnum, String] },
         action: { required: true, class: [String] }
       }
 
@@ -425,12 +425,10 @@ module Telegrammer
       Telegrammer::DataTypes::UserProfilePhotos.new(response.result)
     end
 
-    # Get a list of profile pictures for a user.
+    # Get basic info about a file and prepare it for downloading.
     #
-    # @param [Hash] params hash of paramers to send to the sendChatAction API operation.
-    # @option params [Integer] :user_id Required. Unique identifier of the target user.
-    # @option params [Integer] :offset Optional. Sequential number of the first photo to be returned. By default, all photos are returned.
-    # @option params [Integer] :limit Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.
+    # @param [Hash] params hash of paramers to send to the getFile API operation.
+    # @option params [String] :file_id Required. File identifier to get info about.
     #
     # @example
     #     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')
@@ -448,7 +446,7 @@ module Telegrammer
       response = response = api_request("getFile", params, params_validation)
       file_object = Telegrammer::DataTypes::File.new(response.result)
 
-      "https://api.telegram.org/file/bot#{@api_token}/#{file_object.file_path}"
+      "#{API_ENDPOINT}/file/bot#{@api_token}/#{file_object.file_path}"
     end
 
     private
@@ -503,7 +501,7 @@ module Telegrammer
 
     def send_something(object_kind, params, extra_params_validation = {})
       params_validation = {
-        chat_id: { required: true, class: [Fixnum] },
+        chat_id: { required: true, class: [Fixnum, String] },
         reply_to_message_id: { required: false, class: [String] },
         reply_markup: { required: false, class: [
           Telegrammer::DataTypes::ReplyKeyboardMarkup,

data/lib/telegrammer/version.rb

@@ -1,3 +1,3 @@
 module Telegrammer
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegrammer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Luis Mayoral
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Telegram's Bots API