telegrammer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acbfc6f91eae3b311a5ba063b288d0d1589ee977
-  data.tar.gz: 9168eaa97c2bd3be0ac90b8842bb42ba44305088
+  metadata.gz: d5bd45c16547dca85e93537a1b095c9d8d7f3d6f
+  data.tar.gz: 897030c54eb66cf9cb0d319aa00a3e48ea074130
 SHA512:
-  metadata.gz: f4465ab9634eb5ac0056eb5fc18eb5c051457d4a6a54397dc2c7f1b70537721d3edc7f415f92086f9d1f59c321208164b57ffbbc149305858933c6ede0db578b
-  data.tar.gz: 746a7fc98352c9ca819a0208277e4c854484d474657bf95a1cf45c3a1e633bd0eb1502de1603fae6305b2be07945f6fab48c5ef26ef58da00323aa60b24a4be1
+  metadata.gz: 9748b37b0edd3420cfc0af683665d38768378136612a260c9569fb4fe4094211cc14b8cfdf0f66ee03b04fa359b88be1ba46cc18e65597a4ee6ecdfcc131336c
+  data.tar.gz: 0237500a40e25bd1d02dd93d18f5d2292f843cbdf2b7bbdec04b104dbe01163d8fc7ddc64e0a0298dafcee88ef318ddeeaa05aa8d36c000cdc08066fc7c72292

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v0.4.0
+======
+
+* Added some methods and data types to be up to date with API version 2015-09-07 (https://core.telegram.org/bots/api-changelog#september-7-2015).
+
 v0.3.1
 ======
 

data/README.md

@@ -1,6 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/telegrammer.svg)](http://badge.fury.io/rb/telegrammer)
 [![Code Climate](https://codeclimate.com/github/mayoral/telegrammer/badges/gpa.svg)](https://codeclimate.com/github/mayoral/telegrammer)
 [![Inline docs](http://inch-ci.org/github/mayoral/telegrammer.svg?branch=master)](http://inch-ci.org/github/mayoral/telegrammer)
+[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/mayoral/telegrammer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 # Telegrammer
 

data/lib/telegrammer.rb

@@ -2,29 +2,29 @@ require 'httpclient'
 require 'virtus'
 require 'multi_json'
 
-require "telegrammer/version"
-
-require "telegrammer/data_types/base"
-require "telegrammer/data_types/audio"
-require "telegrammer/data_types/channel"
-require "telegrammer/data_types/contact"
-require "telegrammer/data_types/photo_size"
-require "telegrammer/data_types/user"
-require "telegrammer/data_types/sticker"
-require "telegrammer/data_types/video"
-
-require "telegrammer/data_types/document"
-require "telegrammer/data_types/force_reply"
-require "telegrammer/data_types/group_chat"
-require "telegrammer/data_types/location"
-require "telegrammer/data_types/message"
-require "telegrammer/data_types/reply_keyboard_hide"
-require "telegrammer/data_types/reply_keyboard_markup"
-require "telegrammer/data_types/update"
-require "telegrammer/data_types/user_profile_photos"
-
-require "telegrammer/bot"
-require "telegrammer/api_response"
+require 'telegrammer/version'
+
+require 'telegrammer/data_types/base'
+require 'telegrammer/data_types/audio'
+require 'telegrammer/data_types/channel'
+require 'telegrammer/data_types/contact'
+require 'telegrammer/data_types/photo_size'
+require 'telegrammer/data_types/user'
+require 'telegrammer/data_types/sticker'
+require 'telegrammer/data_types/video'
+
+require 'telegrammer/data_types/document'
+require 'telegrammer/data_types/force_reply'
+require 'telegrammer/data_types/group_chat'
+require 'telegrammer/data_types/location'
+require 'telegrammer/data_types/message'
+require 'telegrammer/data_types/reply_keyboard_hide'
+require 'telegrammer/data_types/reply_keyboard_markup'
+require 'telegrammer/data_types/update'
+require 'telegrammer/data_types/user_profile_photos'
+
+require 'telegrammer/bot'
+require 'telegrammer/api_response'
 
 module Telegrammer
   module Errors
@@ -38,7 +38,7 @@ module Telegrammer
     # Error returned when a param type is invalid
     class InvalidParamTypeError < StandardError
       def initialize(parameter, current_type, allowed_types)
-        super("Invalid parameter type: #{parameter}: #{current_type}. Allowed types: #{allowed_types.each {|type| type.class.to_s }.join(",")}.")
+        super("Invalid parameter type: #{parameter}: #{current_type}. Allowed types: #{allowed_types.each { |type| type.class.to_s }.join(',')}.")
       end
     end
 

data/lib/telegrammer/api_response.rb

@@ -9,15 +9,15 @@ module Telegrammer
         @body = response.body
 
         data = MultiJson.load(@body)
-        @success = data["ok"]
+        @success = data['ok']
 
         if @success
-          @result = data["result"]
+          @result = data['result']
         else
-          raise Telegrammer::Errors::BadRequestError.new(data["error_code"], data["description"])
+          fail Telegrammer::Errors::BadRequestError, data['error_code'], data['description']
         end
       else
-        raise Telegrammer::Errors::ServiceUnavailableError.new(response.status)
+        fail Telegrammer::Errors::ServiceUnavailableError, response.status
       end
     end
 

data/lib/telegrammer/bot.rb

@@ -38,9 +38,9 @@ module Telegrammer
     #
     # @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation
     # @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down
-    def get_updates(&block)
+    def get_updates(&_block)
       loop do
-        response = api_request("getUpdates", {offset: @offset, timeout: @timeout}, nil)
+        response = api_request('getUpdates', { offset: @offset, timeout: @timeout }, nil)
 
         response.result.each do |raw_update|
           update = Telegrammer::DataTypes::Update.new(raw_update)
@@ -69,7 +69,7 @@ module Telegrammer
     # @see https://github.com/mayoral/telegrammer/wiki/Using-webhooks
     # @return [Telegrammer::ApiResponse] Response from the API.
     def set_webhook(url)
-      api_request("setWebhook", {url: url}, nil)
+      api_request('setWebhook', { url: url }, nil)
     end
 
     # Returns basic information about the bot in form of a User object. Used for testing your bot's auth token.
@@ -83,7 +83,7 @@ module Telegrammer
     #
     # @return [Telegrammer::DataTypes::User] User object with info about the bot
     def get_me
-      response = api_request("getMe", nil, nil)
+      response = api_request('getMe', nil, nil)
 
       Telegrammer::DataTypes::User.new(response.result)
     end
@@ -93,6 +93,7 @@ module Telegrammer
     # @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 [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
     # @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.
@@ -112,6 +113,7 @@ module Telegrammer
     def send_message(params)
       extra_params_validation = {
         text: { required: true, class: [String] },
+        parse_mode: { required: false, class: [String] },
         disable_web_page_preview: { required: false, class: [TrueClass, FalseClass] }
       }
 
@@ -145,7 +147,7 @@ module Telegrammer
         message_id: { required: true, class: [Fixnum] }
       }
 
-      response = api_request("forwardMessage", params, params_validation)
+      response = api_request('forwardMessage', params, params_validation)
 
       Telegrammer::DataTypes::Message.new(response.result)
     end
@@ -154,8 +156,8 @@ module Telegrammer
     #
     # @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 [File,String] :photo Required.
-    # @option params [String] :caption Optional.
+    # @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
     # @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.
     #
@@ -171,7 +173,7 @@ module Telegrammer
     # @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat
     def send_photo(params)
       extra_params_validation = {
-        photo: { required: false, class: [File, String] },
+        photo: { required: true, class: [File, String] },
         caption: { required: false, class: [String] }
       }
 
@@ -185,6 +187,9 @@ module Telegrammer
     # @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 [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.
+    # @option params [String] title Optional. Track name.
     # @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.
     #
@@ -200,12 +205,46 @@ module Telegrammer
     # @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat
     def send_audio(params)
       extra_params_validation = {
-        audio: { required: false, class: [File, String] }
+        audio: { required: true, class: [File, String] },
+        duration: { required: false, class: [Integer] },
+        performer: { required: false, class: [String] },
+        title: { required: false, class: [String] }
       }
 
       send_something(:audio, params, extra_params_validation)
     end
 
+    # Sends audio files file to a user or group chat that the users will see as a playable voice message.
+    #
+    # 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 [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
+    # @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.
+    #
+    # @example
+    #     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')
+    #     voice_file = File.open("foo.ogg")
+    #     bot.send_voice(chat_id: 123456789, voice: audio_file)
+    #
+    # @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation
+    # @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down
+    #
+    # @see #send_document
+    # @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat
+    def send_voice(params)
+      extra_params_validation = {
+        voice: { required: true, class: [File, String] },
+        duration: { required: false, class: [Integer] }
+      }
+
+      send_something(:audio, params, extra_params_validation)
+    end
+
+
     # Sends a document to a user or group chat.
     #
     # @param [Hash] params hash of paramers to send to the sendDocument API operation.
@@ -225,7 +264,7 @@ module Telegrammer
     # @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat
     def send_document(params)
       extra_params_validation = {
-        document: { required: false, class: [File, String] }
+        document: { required: true, class: [File, String] }
       }
 
       send_something(:document, params, extra_params_validation)
@@ -263,7 +302,9 @@ module Telegrammer
     #
     # @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 [File,String] :video 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 [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).
     # @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.
     #
@@ -279,7 +320,9 @@ module Telegrammer
     # @return [Telegrammer::DataTypes::Message] Message object sent to the user or group chat
     def send_video(params)
       extra_params_validation = {
-        video: { required: true, class: [File, String] }
+        video: { required: true, class: [File, String] },
+        duration: { required: false, class: [Integer] },
+        caption: { required: false, class: [String] }
       }
 
       send_something(:video, params, extra_params_validation)
@@ -333,7 +376,7 @@ module Telegrammer
         action: { required: true, class: [String] }
       }
 
-      api_request("sendChatAction", params, params_validation)
+      api_request('sendChatAction', params, params_validation)
     end
 
     # Get a list of profile pictures for a user.
@@ -358,7 +401,7 @@ module Telegrammer
         limit: { required: false, class: [Fixnum] }
       }
 
-      response = api_request("getUserProfilePhotos", params, params_validation)
+      response = api_request('getUserProfilePhotos', params, params_validation)
 
       Telegrammer::DataTypes::UserProfilePhotos.new(response.result)
     end
@@ -372,19 +415,19 @@ module Telegrammer
         validated_params = params
       else
         # Delete params not accepted by the API
-        validated_params = params.delete_if {|k, v| !params_validation.has_key?(k) }
+        validated_params = params.delete_if { |k, _v| !params_validation.key?(k) }
 
         # Check all required params by the action are present
-        params_validation.each do |key, value|
-          if params_validation[key][:required] && !params.has_key?(key)
-            raise Telegrammer::Errors::MissingParamsError.new(key, action)
+        params_validation.each do |key, _value|
+          if params_validation[key][:required] && !params.key?(key)
+            fail Telegrammer::Errors::MissingParamsError.new(key, action)
           end
         end
 
         params.each do |key, value|
           # Check param types
-          if !params_validation[key][:class].include?(value.class)
-            raise Telegrammer::Errors::InvalidParamTypeError.new(key, value.class, params_validation[key][:class])
+          unless params_validation[key][:class].include?(value.class)
+            fail Telegrammer::Errors::InvalidParamTypeError.new(key, value.class, params_validation[key][:class])
           end
 
           # Prepare params for sending in Typhoeus post body request
@@ -400,10 +443,8 @@ module Telegrammer
       response = @connection.post(
         "#{API_ENDPOINT}/#{api_uri}",
         validated_params,
-        {
-          "User-Agent" => "Telegrammer/#{Telegrammer::VERSION}",
-          "Accept" => "application/json"
-        }
+        'User-Agent' => "Telegrammer/#{Telegrammer::VERSION}",
+        'Accept' => 'application/json'
       )
 
       ApiResponse.new(response)
@@ -416,8 +457,8 @@ module Telegrammer
         reply_markup: { required: false, class: [
           Telegrammer::DataTypes::ReplyKeyboardMarkup,
           Telegrammer::DataTypes::ReplyKeyboardHide,
-          Telegrammer::DataTypes::ForceReply,
-        ]}
+          Telegrammer::DataTypes::ForceReply
+        ] }
       }
 
       response = api_request("send#{object_kind.to_s.capitalize}", params, extra_params_validation.merge(params_validation))

data/lib/telegrammer/data_types/audio.rb

@@ -4,14 +4,18 @@ module Telegrammer
     #
     # @attr [String] file_id Unique identifier for this file
     # @attr [Integer] duration Duration of the audio in seconds as defined by sender
-    # @attr [String] mime_type MIME type of the file as defined by sender
-    # @attr [Integer] file_size File size
+    # @attr [String] performer Optional. Performer of the audio as defined by sender or by audio tags
+    # @attr [String] title Optional. Title of the audio as defined by sender or by audio tags
+    # @attr [String] mime_type Optional. MIME type of the file as defined by sender
+    # @attr [Integer] file_size Optional. File size
     #
     # See more at https://core.telegram.org/bots/api#audio
     class Audio < Telegrammer::DataTypes::Base
       # Unique identifier
       attribute :file_id, String
       attribute :duration, Integer
+      attribute :performer, String
+      attribute :title, String
       attribute :mime_type, String
       attribute :file_size, Integer
     end

data/lib/telegrammer/data_types/contact.rb

@@ -5,14 +5,14 @@ module Telegrammer
     # @attr [String] phone_number Contact's phone number
     # @attr [String] first_name Contact's first name
     # @attr [String] last_name Optional. Contact's last name
-    # @attr [String] user_id Optional. Contact's user identifier in Telegram
+    # @attr [Integer] user_id Optional. Contact's user identifier in Telegram
     #
     # See more at https://core.telegram.org/bots/api#contact
     class Contact < Telegrammer::DataTypes::Base
       attribute :phone_number, String
       attribute :first_name, String
       attribute :last_name, String
-      attribute :user_id, String
+      attribute :user_id, Integer
     end
   end
 end

data/lib/telegrammer/data_types/message.rb

@@ -15,6 +15,8 @@ module Telegrammer
     # @attr [Telegrammer::DataTypes::PhotoSize] photo Optional. Message is a photo, available sizes of the photo
     # @attr [Telegrammer::DataTypes::Sticker] sticker Optional. Message is a sticker, information about the sticker
     # @attr [Telegrammer::DataTypes::Video] video Optional. Message is a video, information about the video
+    # @attr [Telegrammer::DataTypes::Voice] voice Optional. Message is a voice message, information about the file
+    # @attr [String] caption Optional. Caption for the photo or video
     # @attr [Telegrammer::DataTypes::Contact] contact Optional. Message is a shared contact, information about the contact
     # @attr [Telegrammer::DataTypes::Location] location Optional. Message is a shared location, information about the location
     # @attr [Telegrammer::DataTypes::User] new_chat_participant Optional. A new member was added to the group, information about them (this member may be bot itself)
@@ -39,6 +41,7 @@ module Telegrammer
       attribute :photo, Array[PhotoSize]
       attribute :sticker, Sticker
       attribute :video, Video
+      attribute :voice, Voice
       attribute :contact, Contact
       attribute :location, Location
       attribute :new_chat_participant, User

data/lib/telegrammer/data_types/video.rb

@@ -9,7 +9,6 @@ module Telegrammer
     # @attr [Telegrammer::DataTypes::PhotoSize] thumb Video thumbnail
     # @attr [String] mime_type Optional. Mime type of a file as defined by sender
     # @attr [String] file_size Optional. File size
-    # @attr [String] caption Optional. Text description of the video (usually empty)
     #
     # See more at https://core.telegram.org/bots/api#video
     class Video < Telegrammer::DataTypes::Base
@@ -20,7 +19,6 @@ module Telegrammer
       attribute :thumb, PhotoSize
       attribute :mime_type, String
       attribute :file_size, Integer
-      attribute :caption, String
     end
   end
 end

data/lib/telegrammer/data_types/voice.rb

@@ -0,0 +1,18 @@
+module Telegrammer
+  module DataTypes
+    # Telegram Voice data type
+    #
+    # @attr [String] file_id Unique file identifier
+    # @attr [Integer] duration Duration of the audio in seconds as defined by sender
+    # @attr [String] mime_type Optional. Mime type of a file as defined by sender
+    # @attr [String] file_size Optional. File size
+    #
+    # See more at https://core.telegram.org/bots/api#video
+    class Voice < Telegrammer::DataTypes::Base
+      attribute :file_id, String
+      attribute :duration, Integer
+      attribute :mime_type, String
+      attribute :file_size, Integer
+    end
+  end
+end

data/lib/telegrammer/version.rb

@@ -1,3 +1,3 @@
 module Telegrammer
-  VERSION = "0.3.1"
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegrammer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Luis Mayoral
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -112,6 +112,7 @@ files:
 - lib/telegrammer/data_types/user.rb
 - lib/telegrammer/data_types/user_profile_photos.rb
 - lib/telegrammer/data_types/video.rb
+- lib/telegrammer/data_types/voice.rb
 - lib/telegrammer/version.rb
 - telegrammer.gemspec
 homepage: https://github.com/mayoral/telegrammer