telegrammer 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56ae9079cd5b8570b1ece286941bb23580f96f70
-  data.tar.gz: f3372fc3617f6187186643616c9a4b6d4b821a5f
+  metadata.gz: 9ccbe938586bdb894b8bb7da76c5f4f1223e25fb
+  data.tar.gz: d1081a1b521c670e287ac228e962103f574dd386
 SHA512:
-  metadata.gz: 086f116639424d0cfcabc09b93df2858763a66a70345f52135517f6eedcc9ad5cd081d1d74e68e1682bceeee3209893240d18cc323048d521f832050fb5d88f8
-  data.tar.gz: 07ab9deec6870f74782642a49e76b83d626156e52df4b6a8e63afee0cb22d6f1f1258cdf3d8afe11718f92c0348497d8a9536b4aa352664985cfe714d758e63e
+  metadata.gz: 31ca5931228d51197094729224556299b4bcbbf81d9d9da4ef8cdcea90296e15de16fa67305f1d7eef54c8394fe62458654f3892cf3bd861214cbfa07c22d63d
+  data.tar.gz: a7029706230bfe110efac6df6fb32f793278f8b8d7c8ad5d5fe0166abc69825a0e5fcbfdd2afb82d86893b689aaf88df54e2ec7178e874e3e0a8b97a9d5699b2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v0.6.0
+======
+
+* New File & Chat datatypes.
+* Implemented get_file operation.
+
 v0.5.1
 ======
 

data/README.md

@@ -5,7 +5,7 @@
 
 # Telegrammer
 
-Ruby client for the [Telegram's Bot API](https://core.telegram.org/bots/api).
+Ruby client for the [Telegram's Bot API](https://core.telegram.org/bots/api). Compliant with the [version 2015-10-08 of the API](https://core.telegram.org/bots/api#recent-changes).
 
 ## Installation
 

data/lib/telegrammer.rb

@@ -6,7 +6,7 @@ require 'telegrammer/version'
 
 require 'telegrammer/data_types/base'
 require 'telegrammer/data_types/audio'
-require 'telegrammer/data_types/channel'
+require 'telegrammer/data_types/chat'
 require 'telegrammer/data_types/contact'
 require 'telegrammer/data_types/photo_size'
 require 'telegrammer/data_types/user'
@@ -15,6 +15,7 @@ require 'telegrammer/data_types/video'
 require 'telegrammer/data_types/voice'
 
 require 'telegrammer/data_types/document'
+require 'telegrammer/data_types/file'
 require 'telegrammer/data_types/force_reply'
 require 'telegrammer/data_types/group_chat'
 require 'telegrammer/data_types/location'

data/lib/telegrammer/bot.rb

@@ -400,7 +400,7 @@ module Telegrammer
 
     # Get a list of profile pictures for a user.
     #
-    # @param [Hash] params hash of paramers to send to the sendChatAction API operation.
+    # @param [Hash] params hash of paramers to send to the getUserProfilePhotos 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.
@@ -425,6 +425,32 @@ module Telegrammer
       Telegrammer::DataTypes::UserProfilePhotos.new(response.result)
     end
 
+    # Get a list of profile pictures for a user.
+    #
+    # @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.
+    #
+    # @example
+    #     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')
+    #     bot.get_file(file_id: 123456789)
+    #
+    # @raise [Telegrammer::Errors::BadRequestError]
+    # @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down
+    #
+    # @return [String] URL of the file (valid for one hour) or BadRequestError if the file_id is wrong
+    def get_file(params)
+      params_validation = {
+        file_id: { required: true, class: [String] }
+      }
+
+      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}"
+    end
+
     private
 
     def api_request(action, params, params_validation)

data/lib/telegrammer/data_types/chat.rb

@@ -0,0 +1,22 @@
+module Telegrammer
+  module DataTypes
+    # 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] 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
+    # @attr [String] last_name Optional. Last name of the other party in a private chat
+    #
+    # See more at https://core.telegram.org/bots/api#chat
+    class Chat < Telegrammer::DataTypes::Base
+      attribute :id, Integer
+      attribute :type, String
+      attribute :title, String
+      attribute :username, String
+      attribute :first_name, String
+      attribute :last_name, String
+    end
+  end
+end

data/lib/telegrammer/data_types/file.rb

@@ -0,0 +1,16 @@
+module Telegrammer
+  module DataTypes
+    # Telegram File data type.
+    #
+    # @attr [String] file_id Unique identifier for this file
+    # @attr [Integer] file_size Optional. File size, if known
+    # @attr [String] file_path Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
+    #
+    # See more at https://core.telegram.org/bots/api#file
+    class File < Telegrammer::DataTypes::Base
+      attribute :file_id, String
+      attribute :file_size, Integer
+      attribute :file_path, String
+    end
+  end
+end

data/lib/telegrammer/data_types/message.rb

@@ -5,7 +5,7 @@ module Telegrammer
     # @attr [Integer] message_id Unique message identifier
     # @attr [Telegrammer::DataTypes::User] from Sender
     # @attr [DateTime] date Date the message was sent
-    # @attr [Telegrammer::DataTypes::Channel] chat Conversation the message belongs to — user in case of a private message, GroupChat in case of a group
+    # @attr [Telegrammer::DataTypes::Chat] chat Conversation the message belongs to
     # @attr [Telegrammer::DataTypes::User] forward_from Optional. For forwarded messages, sender of the original message
     # @attr [DateTime] forward_date Optional. For forwarded messages, date the original message was sent
     # @attr [Telegrammer::DataTypes::Message] reply_to_message Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
@@ -31,7 +31,7 @@ module Telegrammer
       attribute :message_id, Integer
       attribute :from, User
       attribute :date, DateTime
-      attribute :chat, Channel
+      attribute :chat, Chat
       attribute :forward_from, User
       attribute :forward_date, DateTime
       attribute :reply_to_message, Message

data/lib/telegrammer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegrammer
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Luis Mayoral
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -97,9 +97,10 @@ files:
 - lib/telegrammer/bot.rb
 - lib/telegrammer/data_types/audio.rb
 - lib/telegrammer/data_types/base.rb
-- lib/telegrammer/data_types/channel.rb
+- lib/telegrammer/data_types/chat.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/location.rb
@@ -135,9 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the Telegram's Bots API
 test_files: []
-has_rdoc: 

data/lib/telegrammer/data_types/channel.rb

@@ -1,11 +0,0 @@
-module Telegrammer
-  module DataTypes
-    # Custom attribute class to handle chat attribute in Telegrammer::DataTypes::Message
-    class Channel < Virtus::Attribute
-      # Transforms a channel into a User object or GroupChat object
-      def coerce(value)
-        value.respond_to?(:first_name) ? User.new(value) : GroupChat.new(value)
-      end
-    end
-  end
-end