telegram_bot_middleware 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53104e93078e22a26e106dd70fbec85e2e5eefc0
-  data.tar.gz: 92d7d5da377b3708f52fabc3de79d339d418cd6f
+  metadata.gz: d39fe2bef0e2ca483f3a3c6d31aac1a4c4d8e14b
+  data.tar.gz: 2a3d02a2962ea2910f93ede19af24b18f5ee2201
 SHA512:
-  metadata.gz: 11a3edb593bcc3bca092c9abc94f00454c97d269cc5a85bb9ee40d682697d80a093949bba721f414025df1863cf4662bd7df4d1d5c666c415115e9da260450bc
-  data.tar.gz: 0f08fdccfa4588fea7a9f6070b8461eb69df2f2d76d3a0b0fcfe9964a3b3be3e6aea572088434ddd295a2808caddab46cce8623f59193b2ef95d7d034c242590
+  metadata.gz: 733cbb9bd5f14245bfd6bee885bc7aa86a195db64d7c9657dbcb272267005a6440581ebe33a69063f5d62c923c4f4d40ab8b05aa9217e7d3dd77d94fc86c1b74
+  data.tar.gz: c26f854c127f75e85020acb6c46150632e6664cc2e19ea48ff5093bbe6ead1064ed33743c1ed5227d5eed62d5707ea7f54c5204274d425b41d6307682b33b9fc

data/README.md

@@ -18,7 +18,21 @@ Or install it yourself as:
 
     $ gem install telegram_bot_middleware
     
-TODO: Write more installation instructions.
+Add the middleware in config.ru or in other files base on the framework you are using:
+
+```ruby
+require 'telegram_bot_middleware'
+
+use TelegramBotMiddleware do |config|
+  config.token = '<TELEGRAM_TOKEN>'
+  config.host = '<HOST>'
+  config.get_updates = :polling or :webhook
+end
+```
+
+* To obtain a token follow the instructions in [telegram bot api](https://core.telegram.org/bots#botfather).
+* The host is the address where the script is running, for example during development could be http://127.0.0.1:9292.
+* The get_updates params specify how to get incoming messages from telegram, can be :polling or :webhook, look at the [telegram bot api](https://core.telegram.org/bots/api#getupdates) for details.
 
 ## Usage
 

data/examples/cuba/config.ru

@@ -0,0 +1,46 @@
+require 'cuba'
+require_relative '../../lib/telegram_bot_middleware'
+
+Cuba.use TelegramBotMiddleware do |config|
+  config.token = '138381425:AAEXjzZx5U5wZmiKvFmHjdNMkXJqnkHnum4'
+  config.host = 'http://127.0.0.1:9292'
+  config.get_updates = :polling
+end
+
+Cuba.define do
+  on get do
+    on 'hello' do
+      res.headers["Content-Type"] = "application/json; charset=utf-8"
+      res.write({
+        'text' => 'Ciao',
+        'reply_markup' => {'keyboard' => [%w(A B), ['C', 'D']], 'resize_keyboard' => true, 'one_time_keyboard' => true, 'selective' => false}
+      })
+    end
+    
+    on 'test' do
+      res.write({
+        'multiple' => [
+          {
+            'photo' => '../../tmp/test.png',
+            'caption' => 'caption'
+          },
+          {
+            'text' => 'Ciao',
+            'reply_markup' => {'keyboard' => [%w(A B), ['C', 'D']], 'resize_keyboard' => true, 'one_time_keyboard' => true, 'selective' => false}
+          }
+        ]
+      })
+    end
+    
+    on /.*/ do
+      res.write 'Hello world!'
+    end
+  end
+end
+
+warmup do |app|
+  client = Rack::MockRequest.new(app)
+  client.get('/')
+end
+
+run Cuba

data/examples/roda/config.ru

@@ -0,0 +1,40 @@
+require 'roda'
+require_relative '../../lib/telegram_bot_middleware'
+
+class App < Roda
+  use TelegramBotMiddleware do |config|
+    config.token = '138381425:AAEXjzZx5U5wZmiKvFmHjdNMkXJqnkHnum4'
+    config.host = 'http://127.0.0.1:9292'
+    config.get_updates = :polling
+  end
+  
+  #plugin :json
+
+  route do |r|
+    
+    r.on 'hello' do
+      {
+        text: 'Ciao',
+        reply_markup: {keyboard: [%w(A B), ['C', 'D']], resize_keyboard: true, one_time_keyboard: true, selective: false}
+      }
+    end
+    
+    r.on 'image' do
+      {
+        photo: File.new('../../tmp/test.png'),
+        caption: 'caption'
+      }
+    end
+    
+    r.on /.*/ do
+      'Hello world!'
+    end
+  end
+end
+
+warmup do |app|
+  client = Rack::MockRequest.new(app)
+  client.get('/')
+end
+
+run App.freeze.app

data/examples/sinatra/chuck_norris.rb

@@ -3,6 +3,6 @@ require 'net/http'
 require 'json'
 require_relative 'example_init'
 
-get '/start' do
+get '*' do
   JSON.parse(Net::HTTP.get(URI('http://api.icndb.com/jokes/random')))['value']['joke']
 end

data/examples/sinatra/config.ru

@@ -1,6 +1,6 @@
-#require './example'
+require './example'
 #require './calc'
-require './chuck_norris'
+#require './chuck_norris'
 
 $stdout.sync = true
 

data/examples/sinatra/example.rb

@@ -12,7 +12,11 @@ get %r{/hello/(.*)}i do |name|
 end
 
 get %r{/image/?$}i do
-  send_file 'tmp/test.png'
+  #send_file 'tmp/test.png'
+  {
+    photo: '../../tmp/test.png',
+    caption: 'caption'
+  }  
 end
 
 get %r{/audio/?$}i do
@@ -23,6 +27,13 @@ get %r{/video/?$}i do
   send_file 'tmp/test.mp4'
 end
 
+get '/location' do
+  {
+    latitude: params['location']['latitude'],
+    longitude: params['location']['longitude'],
+  }
+end
+
 get %r{/location/?$}i do
   {
     latitude: 38.115036, 
@@ -30,10 +41,22 @@ get %r{/location/?$}i do
   }
 end
 
-get %r{/caption/?$}i do
+get %r{/test/?$}i do
   {
-    photo: File.new('tmp/test.png'),
-    caption: 'caption'
+    multiple: 
+    [
+      {
+        photo: '../../tmp/test.png',
+        caption: 'caption'
+      },
+      {
+        text: 'ciao'
+      },
+      {
+        latitude: 38.115036, 
+        longitude: 13.366640
+      }
+    ]
   }
 end
 

data/lib/telegram_bot_middleware/version.rb

@@ -1,3 +1,3 @@
 class TelegramBotMiddleware
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/telegram_bot_middleware.rb

@@ -17,8 +17,6 @@ class TelegramBotMiddleware
     # save the app var
     @app = app
     
-    puts 'Initializing...'
-    
     # create the config and populate passing do the block function
     @config = OpenStruct.new
     yield(@config) if block_given?
@@ -90,15 +88,25 @@ class TelegramBotMiddleware
       req.body.rewind
       # build an openstruct based on post params
       params = OpenStruct.from_json(req.body.read)
-      
-      # build path based on message
-      # - get only message part of post params
-      # - remove empty chars from beginning or end (strip)
-      # - replace first sequence of spaces with /
-      # - encode as uri
-      path = URI.escape(params.message.text.strip.sub(/\s+/, '/'))
-      # - add first / if not present
-      path = "/#{path}" unless path.start_with?('/')
+
+      path = nil
+      unless params.message['text'].nil?
+        # build path based on message
+        # - get only message part of post params
+        # - remove empty chars from beginning or end (strip)
+        # - replace first sequence of spaces with /
+        # - encode as uri
+        path = URI.escape(params.message.text.strip.sub(/\s+/, '/'))
+        # - add first / if not present
+        path = "/#{path}" unless path.start_with?('/')
+      else
+        %w(audio document photo sticker video voice contact location new_chat_participant left_chat_participant new_chat_title new_chat_photo delete_chat_photo group_chat_created).each do |type|
+          unless params.message[type].nil?
+            path = "/#{type}"
+            break
+          end
+        end
+      end
       
       # build the querystring using message but nested
       query_string = Rack::Utils.build_nested_query(params.message.to_h_nested)
@@ -117,32 +125,17 @@ class TelegramBotMiddleware
         
         case headers['Content-Type'].split(';').first
           when 'text/html', 'application/json'          
-            
             if body.is_a? Hash
-            
-              query = body.clone
-              query[:chat_id] = params.message.chat.id unless query.include?(:chat_id)
-              query[:reply_markup] = query[:reply_markup].to_json if query.include?(:reply_markup)
-              
+              process_hash_message(body.clone, params)
               body = Array.new(1) { '' }
-              
-              if query.include?(:text)
-                send_to_bot('sendMessage', query)
-              elsif query.include?(:latitude) and query.include?(:longitude)
-                send_to_bot('sendLocation', query)
-              elsif query.include?(:photo)
-                send_to_bot('sendPhoto', query)
-              elsif query.include?(:audio)
-                send_to_bot('sendAudio', query)              
-              elsif query.include?(:video)
-                send_to_bot('sendVideo', query)              
-              else
-                # TODO: invalid query
-              end
-              
             else
               body.each do |data|
-                send_to_bot('sendMessage', {chat_id: params.message.chat.id, text: data})
+                begin
+                  #TODO: add better json parsing to support symbols too
+                  process_hash_message(JSON.parse(data.gsub('=>', ':')), params)
+                rescue
+                  send_to_bot('sendMessage', {chat_id: params.message.chat.id, text: data})
+                end
               end
             end
         
@@ -165,6 +158,41 @@ class TelegramBotMiddleware
     end
   end
   
+  def process_hash_message(message, params)
+    if (message.include?(:multiple) && message[:multiple].is_a?(Array))
+      message[:multiple].each { |item| process_json_message(item, params) }
+    elsif (message.include?('multiple') && message['multiple'].is_a?(Array))
+      message['multiple'].each { |item| process_json_message(item, params) }
+    else
+      process_json_message(message, params)            
+    end
+  end
+  
+  def process_json_message(message, params)
+    message[:chat_id] = params.message.chat.id unless message.include?(:chat_id) or message.include?('chat_id')
+    
+    message[:reply_markup] = message[:reply_markup].to_json if message.include?(:reply_markup)
+    message['reply_markup'] = message['reply_markup'].to_json if message.include?('reply_markup')
+    
+    ['photo', :photo, 'audio', :audio, 'video', :video].each do |item|
+      message[item] = File.new(message[item]) if message.include?(item)
+    end
+    
+    if message.include?(:text) or message.include?('text')
+      send_to_bot('sendMessage', message)
+    elsif (message.include?(:latitude) and message.include?(:longitude)) or (message.include?('latitude') and message.include?('longitude'))
+      send_to_bot('sendLocation', message)
+    elsif message.include?(:photo) or message.include?('photo')
+      send_to_bot('sendPhoto', message)
+    elsif message.include?(:audio) or message.include?('audio')
+      send_to_bot('sendAudio', message)      
+    elsif message.include?(:video) or message.include?('video')
+      send_to_bot('sendVideo', message)
+    else
+      # TODO: invalid query
+    end  
+  end
+  
   def send_to_bot(path, query)
     response = self.class.post("/bot#{@config.token}/#{path}", query: query)
     # TODO check respobse error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_bot_middleware
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mirko Mignini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -112,7 +112,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/cuba/config.ru
 - examples/rack/config.ru
+- examples/roda/config.ru
 - examples/sinatra/calc.rb
 - examples/sinatra/chuck_norris.rb
 - examples/sinatra/config.ru