ya_telegram_bot 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33d0b778d491d225fe59fadff14f620515b9ef71
-  data.tar.gz: 1a840811af1f7f8c687c02e8a6d93ed0dc3a6232
+  metadata.gz: 61a5de13ed8de99426a7bfa61de2546284469107
+  data.tar.gz: e9fab4795d112701d2c5af7fca256b0b7a96ce4c
 SHA512:
-  metadata.gz: ce566672deef931074d949515b584e2cf6613266efd7bf7f4da0df9ed1cc8383a6a1e8f897b189a936afa787a44b34b4f3ce336d5b1dcfe2ed50d20e9313caa0
-  data.tar.gz: 7fea81894b8587ac5796a548173fee2ff2e1552f5f59b17977e765a277e1ad26c6e994da4a8683c18752ce82a0ff88022d2ba2f99f45abba3edfe80453257aff
+  metadata.gz: c80cb576d0254a8b2b76c56b907a9120585b32598ac41c4547673483b87da9914282454823bad44db4a51f123a344c8b4bb4ffc9681deefe80ba3dc9132e41d5
+  data.tar.gz: 869d9928d5b2e91236a3c542e33bda90705906887430290b321e14ac29573fd88e312365d9a3710c9498c82f88ef75bb775b82b1d28ea5990d7c83e5759ad553

data/README.md

@@ -2,6 +2,12 @@
 
 **IN DEV**
 
+## What's new **0.2.0**
+
+* Class `YATelegramBot::TelegramAPI::Message`.
+* `Base#Update` generates array of `Message`. See Usage.
+
+
 ## Usage
 
 ```ruby
@@ -19,15 +25,20 @@ updates.each do |message|
   user = message['from']['first_name']
   text = "Hello, *#{user}*"
 
-  Bot.send_message chat: chat_id,
-                   text: text,
-                   markdown: true
+  Bot.send_text chat: chat_id,
+                text: text,
+                markdown: true
 end
+
+Bot.updates.each { |message| message.reply text: 'Leave me alone!' }
+
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/telegram_bot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Nondv/telegram_bot.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/ya_telegram_bot/base.rb

@@ -2,12 +2,17 @@ require 'rest-client'
 require 'json'
 require 'time'
 
+require_relative 'exceptions'
+Dir[File.expand_path('../telegram_api/*.rb', __FILE__)].each { |file| require file }
+
 module YATelegramBot
   #
   # extend your class with this module to use API.
   # Or include it if you want to use in instances
   #
   module Base
+    include TelegramAPI
+
     def token(value)
       @token = value
       @api_request_prefix = "bot#{@token}"
@@ -28,7 +33,7 @@ module YATelegramBot
       fail ResponseIsNotOk unless updates['ok']
 
       @last_update_id = updates['result'].last['update_id'] unless updates['result'].empty?
-      updates['result'].map { |u| u['message'] }
+      updates['result'].map { |u| Message.new(u['message'], self) }
     end
 
     #
@@ -39,26 +44,30 @@ module YATelegramBot
     # * :text - your message
     #
     # additional params:
-    # * :markdown - use telegram markdown
+    # * :markdown [Boolean] use telegram markdown
+    # * :reply_to [Integer] id of message you reply
     #
-    def send_message(params = {})
+    def send_text(params = {})
+      response = send_api_request 'sendMessage',
+                                  params_for_sending_text(params)
+      response['ok']
+    end
+
+    private
+
+    def params_for_sending_text(params)
       fail NoChatSpecified unless params[:chat]
       fail NoMessageSpecified unless params[:text]
 
-      params[:chat_id] = params[:chat]
-      params.delete :chat
-
-      if params[:markdown]
-        params.delete :markdown
-        params[:parse_mode] = 'Markdown'
-      end
+      result = {}
+      result[:chat_id] = params[:chat]
+      result[:text] = params[:text]
+      result[:parse_mode] = 'Markdown' if params[:markdown]
+      result[:reply_to_message_id] = params[:reply_to].to_i if params[:reply_to]
 
-      response = send_api_request('sendMessage', params)
-      response['ok']
+      result
     end
 
-    private
-
     def send_api_request(method, params = {})
       fail NoTokenSpecified unless defined?(@token)
       @telegram_api_url = 'https://api.telegram.org' unless defined? @telegram_api_url

data/lib/ya_telegram_bot/exceptions.rb

@@ -3,4 +3,5 @@ module YATelegramBot
   class ResponseIsNotOk; end
   class NoChatSpecified; end
   class NoMessageSpecified; end
+  class InitWithoutBot; end
 end

data/lib/ya_telegram_bot/telegram_api/message.rb

@@ -0,0 +1,84 @@
+require 'time'
+
+module YATelegramBot
+  module TelegramAPI
+    #
+    # represents incoming messages
+    #
+    class Message < Hash
+      TYPES = [:text, :audio, :photo, :document, :video, :voice, :contact, :location].freeze
+
+      #
+      # @param hash_message [Hash] update['message']
+      # @param bot [Base] for using api like sending replies
+      #
+      def initialize(hash_message, bot = nil)
+        @bot = bot
+        merge! hash_for_merging(hash_message)
+      end
+
+      #
+      # @example message.text
+      #
+      def method_missing(m, *args)
+        return self[m] if self[m] && args.empty?
+        super
+      end
+
+      #
+      # checking on message type via `message.<type>?`
+      # @example message.text?
+      #
+      TYPES.each do |t|
+        define_method("#{t}?") { self[t] }
+      end
+
+      #
+      # @return [Symbol] type of a message (see Message::TYPES)
+      #
+      def type
+        TYPES.find { |t| self[t] }
+      end
+
+      #
+      # send reply to this message via bot from #initialize
+      #
+      # params values:
+      # * :text [String]
+      # * :as_plain_message [Boolean] default: true. If it's set, method won't set :reply_to parameter
+      #
+      # @example message.reply(text: 'Hi, *friend*!', markdown: true)
+      #
+      def reply(params = {})
+        fail InitWithoutBot unless @bot
+
+        params[:chat] = self[:chat]['id']
+
+        params[:as_plain_message] = true unless params.key? :as_plain_message
+        params[:reply_to] = self[:id] unless params[:as_plain_message]
+        param.delete :as_plain_message
+
+        @bot.send_text params
+      end
+
+      private
+
+      #
+      # converts some fields like 'user'
+      # @return [Hash]
+      #
+      def hash_for_merging(hash)
+        new_hash = {}
+        new_hash[:id] = hash['message_id'].to_i
+        new_hash[:date] = Time.at hash['date'].to_i
+        new_hash[:from] = hash['from'] # TODO: class User
+        new_hash[:chat] = hash['chat'] # TODO: class Chat
+
+        type = TYPES.find { |t| hash[t.to_s] }
+        new_hash[type] = hash[type.to_s] # TODO: fail if type not found
+
+        new_hash
+      end
+    end
+  end
+end

data/lib/ya_telegram_bot/version.rb

@@ -1,3 +1,3 @@
 module YATelegramBot
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/ya_telegram_bot.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Yet Another Telegram Bot'
   spec.description   = 'Module for using Telegram Bot API'
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/Nondv/telegram_bot'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ya_telegram_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitriy Non
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,9 +99,10 @@ files:
 - lib/ya_telegram_bot.rb
 - lib/ya_telegram_bot/base.rb
 - lib/ya_telegram_bot/exceptions.rb
+- lib/ya_telegram_bot/telegram_api/message.rb
 - lib/ya_telegram_bot/version.rb
 - ya_telegram_bot.gemspec
-homepage: ''
+homepage: https://github.com/Nondv/telegram_bot
 licenses:
 - MIT
 metadata: {}