telegram_bot_middleware 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 870191d85926103616be33ea31cb39dc8bb1d272
-  data.tar.gz: bc550f86c1c106ae526d18d4e5afaa31b91fdcf0
+  metadata.gz: e64e5b8be07193b800fce0ed89221089356e346e
+  data.tar.gz: 64ce2fa555fcd5126a447b8aba38cabed1f796fd
 SHA512:
-  metadata.gz: 42cf0b10bfb844b86c821140e64f35271e0f7ee37fe4f4a818cf14e5040db05fb4f418f70a371d2cae5f9e4f1c529ce4524f85e085a8be701b8a81bd748ce4f3
-  data.tar.gz: 2de4247868fb47150d373d91254ad41fa964e519303e5287243b278744f03cf07fcd77794eba22a8f2d41665ca2189e957ec4590cb0f7afc431275dc61bd1c86
+  metadata.gz: ebe6680804b864eec96966a784c75107d99537dfae53cb0b11b55f67795d80a7dcb8b059d7d5fc64559325cca4f80811f53b311399dcff8c82e186be918be7d9
+  data.tar.gz: d71a1d3d656e25befab1663a17e0a23527dd6ae5bd62c5e5ca41eb2f60cc57031378eca4e9a472cb11b475393619df36cc5d2c8a7b85b31e2f14698247fc299a

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.1.2
-before_install: gem install bundler -v 1.10.6
+before_install: gem install bundler

data/Gemfile.lock

@@ -1,17 +1,26 @@
 PATH
   remote: .
   specs:
-    telegram_bot_middleware (0.2.0)
+    telegram_bot_middleware (0.3.1)
       httmultiparty
       http
       persistent_httparty
+      rack
       rake (~> 10.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.8)
+    coveralls (0.8.9)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     domain_name (0.5.25)
       unf (>= 0.0.5, < 1.0.0)
     gene_pool (1.4.1)
@@ -33,20 +42,27 @@ GEM
       json (~> 1.8)
       multi_xml (>= 0.5.2)
     json (1.8.3)
+    mime-types (2.99)
     mimemagic (0.3.0)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
+    netrc (0.11.0)
     persistent_http (1.0.6)
       gene_pool (>= 1.3)
     persistent_httparty (0.1.2)
       httparty (~> 0.9)
       persistent_http (< 2)
+    rack (1.6.4)
     rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.0)
+    rspec-core (3.4.1)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -54,8 +70,17 @@ GEM
     rspec-mocks (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
-    rspec-support (3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
     thread_safe (0.3.5)
+    tins (1.6.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
@@ -65,6 +90,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.10)
+  coveralls
   rspec
   telegram_bot_middleware!
 

data/README.md

@@ -1,3 +1,9 @@
+[![Build Status](https://travis-ci.org/MirkoMignini/telegram_bot_middleware.svg)](https://travis-ci.org/MirkoMignini/telegram_bot_middleware)
+[![Coverage Status](https://coveralls.io/repos/MirkoMignini/telegram_bot_middleware/badge.svg?branch=master&service=github)](https://coveralls.io/github/MirkoMignini/telegram_bot_middleware?branch=master)
+[![Code Climate](https://codeclimate.com/github/MirkoMignini/telegram_bot_middleware/badges/gpa.svg)](https://codeclimate.com/github/MirkoMignini/telegram_bot_middleware)
+[![Dependency Status](https://gemnasium.com/MirkoMignini/telegram_bot_middleware.svg)](https://gemnasium.com/MirkoMignini/telegram_bot_middleware)
+[![Gem Version](https://badge.fury.io/rb/telegram_bot_middleware.svg)](https://badge.fury.io/rb/telegram_bot_middleware)
+
 # Telegram Bot Middleware
 
 Rack middleware to communicate with a telegram bot.

data/lib/telegram_bot_middleware.rb

@@ -10,23 +10,27 @@ class TelegramBotMiddleware
   include HTTMultiParty
   base_uri 'https://api.telegram.org'
   
-  def initialize(app, &block)    
+  def initialize(app, &_block)
     # save the app var
     @app = app
     
     # local cookies hash
     @cookies = Hash.new
     
-    @env = nil
-    
     # create the config and populate passing do the block function
     @config = OpenStruct.new
     yield(@config) if block_given?
     
+    # validate required input params
+    raise ArgumentError.new("Config error: host can't be null || empty.") if @config.host.nil? || @config.host.empty?
+    raise ArgumentError.new("Config error: token can't be null || empty.") if @config.token.nil? || @config.token.empty?
+    
+    # initialize persistent connection to telegram
     self.class.persistent_connection_adapter  pool_size: (@config.connection_pool_size || 2),
                                               keep_alive: (@config.connection_keep_alive || 30),
                                               force_retry: (@config.connection_force_retry || true)
     
+    # if get_updates is empty set to :polling by default
     @config.get_updates ||= :polling
 
     # setup webhook
@@ -41,18 +45,18 @@ class TelegramBotMiddleware
       # setup polling
       when :polling
         # clear the webhook in case was set in the past
-        send_to_bot('setWebhook', {url: ''})
+        send_to_telegram('setWebhook', {url: ''})
         
         # setup a thread with get_updates function
         start_get_updates_thread
       
       # setup webhook
       when :webhook
-        send_to_bot('setWebhook', {url: @config.webhook})
+        send_to_telegram('setWebhook', {url: @config.webhook})
       
       # in this case get_updates is a non valid value
       else
-        raise ArgumentError.new('Config error: get_updates must be :webhook or :polling.')
+        raise ArgumentError.new('Config error: get_updates must be :webhook || :polling.')
     end
   end
   
@@ -66,7 +70,7 @@ class TelegramBotMiddleware
       # loop forever
       loop do
         # call the getUpdates telegram function
-        response = send_to_bot('getUpdates', {offset: @offset})
+        response = send_to_telegram('getUpdates', {offset: @offset})
         # enumerate the results
         response.to_hash['result'].each do |data|
           # create an update message from the post data
@@ -85,58 +89,37 @@ class TelegramBotMiddleware
     dup._call(env)
   end
   
-  def _call(env)
-    @env = env
-    
+  def _call(env)    
     # retrieve the request object
-    req = Rack::Request.new(@env)
+    request = Rack::Request.new(env)
     
     # if the request is a post to bot webhhok
-    if req.post? and req.path == "/#{@config.token}"
+    if request.post? and request.path == "/#{@config.token}"
       
       # in case someone already read it
-      req.body.rewind
+      request.body.rewind
       # build an openstruct based on post params
-      params = OpenStruct.from_json(req.body.read)
+      params = OpenStruct.from_json(request.body.read)
       
       log_debug("Message from chat: #{params}")
-
-      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)
+      # build command based on message
+      command = get_command(params)
       
       # transform the POST in GET
-      @env['PATH_INFO'] = path
-      @env['QUERY_STRING'] = query_string
-      @env['REQUEST_METHOD'] = 'GET'
-      @env['REQUEST_URI'] = "https://#{req.host}#{path}"
+      env['PATH_INFO'] = command
+      env['QUERY_STRING'] = Rack::Utils.build_nested_query(params.message.to_h_nested)
+      env['REQUEST_METHOD'] = 'GET'
+      env['REQUEST_URI'] = "https://#{request.host}#{command}"
       
       # if in cache a cookie for this chat was present add to the header
-      @env['HTTP_COOKIE'] = @cookies[params.message.chat.id] if @cookies.include?(params.message.chat.id)
+      env['HTTP_COOKIE'] = @cookies[params.message.chat.id] if @cookies.include?(params.message.chat.id)
       
       # call the rack stack
-      status, headers, body = @app.call(@env)
+      status, headers, body = @app.call(env)
       
       # try to send to telegram only if no errors
-      if status == 200 or status == '200'
+      if status == 200 || status == '200'
         
         # if the call setted a cookie save to local cache
         @cookies[params.message.chat.id] = headers['Set-Cookie'] if headers.include?('Set-Cookie')
@@ -152,19 +135,19 @@ class TelegramBotMiddleware
                   #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})
+                  send_to_telegram('sendMessage', {chat_id: params.message.chat.id, text: data})
                 end
               end
             end
         
           when /(^image\/)/
-            send_to_bot('sendPhoto', {chat_id: params.message.chat.id, photo: File.new(body)})
+            send_to_telegram('sendPhoto', {chat_id: params.message.chat.id, photo: File.new(body)})
         
           when /(^audio\/)/
-            send_to_bot('sendAudio', {chat_id: params.message.chat.id, audio: File.new(body)})
+            send_to_telegram('sendAudio', {chat_id: params.message.chat.id, audio: File.new(body)})
           
           when /(^video\/)/
-            send_to_bot('sendVideo', {chat_id: params.message.chat.id, video: File.new(body)})          
+            send_to_telegram('sendVideo', {chat_id: params.message.chat.id, video: File.new(body)})          
         end
       end
       
@@ -176,7 +159,28 @@ class TelegramBotMiddleware
     end
   end
   
-  def process_hash_message(message, params)
+  # build command based on message
+  def get_command(params)
+    unless params.message['text'].nil?
+      # build path based on message
+      # - get only message part of post params
+      # - remove empty chars from beginning || end (strip)
+      # - replace first sequence of spaces with /
+      # - encode as uri
+      command = URI.escape(params.message.text.strip.sub(/\s+/, '/'))
+      # - add first / if not present
+      command = "/#{command}" unless command.start_with?('/')
+      return command
+    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?
+          return "/#{type}"
+        end
+      end
+    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))
@@ -187,28 +191,35 @@ class TelegramBotMiddleware
   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[:chat_id] = params.message.chat.id unless message.include?(:chat_id) || 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')
+    ['reply_markup', :reply_markup].each do |item|
+      message[item] = message[item].to_json if message.include?(item)
+    end
     
     ['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)
+    if message.include?(:text) || message.include?('text')
+      send_to_telegram('sendMessage', message)
+    elsif (message.include?(:latitude) and message.include?(:longitude)) || (message.include?('latitude') and message.include?('longitude'))
+      send_to_telegram('sendLocation', message)
+    elsif message.include?(:photo) || message.include?('photo')
+      send_to_telegram('sendPhoto', message)
+    elsif message.include?(:audio) || message.include?('audio')
+      send_to_telegram('sendAudio', message)      
+    elsif message.include?(:video) || message.include?('video')
+      send_to_telegram('sendVideo', message)
     else
       # TODO: invalid query
-    end  
+    end
+  end
+  
+  def send_to_telegram(path, query)
+    log_debug("Sending to chat: #{path} - #{query}")
+    self.class.post("/bot#{@config.token}/#{path}", query: query)
+    # TODO check response error and return response
   end
   
   def log_error(exception)
@@ -224,18 +235,13 @@ class TelegramBotMiddleware
     log(:debug, message)
   end
   
+  # TODO: to fix env
   def log(level, message)
-    return if @env.nil?
-    if @env['rack.logger']
-      @env['rack.logger'].send(level, message)
-    else
-      @env['rack.errors'].write(message)
-    end
-  end
-  
-  def send_to_bot(path, query)
-    log_debug("Sending to chat: #{path} - #{query}")
-    response = self.class.post("/bot#{@config.token}/#{path}", query: query)
-    # TODO check response error and return response
+    #return if @env.nil?
+    #if @env['rack.logger']
+    #  @env['rack.logger'].send(level, message)
+    #else
+    #  @env['rack.errors'].write(message)
+    #end
   end
 end

data/lib/telegram_bot_middleware/version.rb

@@ -1,3 +1,3 @@
 class TelegramBotMiddleware
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'telegram_bot_middleware'

data/spec/telegram_bot_middleware_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe TelegramBotMiddleware do
+  
+  let(:app) { ->(env) { [200, env, 'app'] } }
+  let(:token) { '138381425:AAEXjzZx5U5wZmiKvFmHjdNMkXJqnkHnum4' }
+  let(:host) { 'http://127.0.0.1:9292' }
+  let(:middleware) {
+    TelegramBotMiddleware.new(app) { |config|
+      config.token = token
+      config.host = host
+    }
+  }
+  
+  def init_middleware(&block)
+    TelegramBotMiddleware.new(app, &block)
+  end
+  
+  context 'Preliminary checks' do
+    it 'has a version number' do
+      expect(TelegramBotMiddleware::VERSION).not_to be nil
+    end
+  end
+  
+  context 'Configuration not valid' do
+    it 'raise ArgumentError if token is null' do expect { init_middleware { |config| config.token = nil } }.to raise_error(ArgumentError) end
+    it 'raise ArgumentError if token is empty' do expect { init_middleware { |config| config.token = '' } }.to raise_error(ArgumentError) end
+    it 'raise ArgumentError if host is null' do expect { init_middleware { |config| config.token = token; config.host = nil } }.to raise_error(ArgumentError) end
+    it 'raise ArgumentError if host is empty' do expect { init_middleware { |config| config.token = token; config.host = '' } }.to raise_error(ArgumentError) end
+    it 'raise ArgumentError if get_updates is not valid' do expect { init_middleware { |config| config.token = token; config.host = host; config.get_updates = :not_valid } }.to raise_error(ArgumentError) end
+  end
+  
+  context 'Configuration valid' do
+    it 'initialize with correct parameters' do
+      expect(middleware).to_not be nil
+    end
+  end
+  
+end

data/telegram_bot_middleware.gemspec

@@ -13,15 +13,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/MirkoMignini/telegram_bot_middleware'
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   
   spec.add_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'rack'
   spec.add_dependency 'http'
   spec.add_dependency 'httmultiparty'
   spec.add_dependency 'persistent_httparty'
   
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rspec'
-end
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_bot_middleware
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Mirko Mignini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - mirko.mignini@gmail.com
@@ -123,6 +151,8 @@ files:
 - lib/ostruct_nested.rb
 - lib/telegram_bot_middleware.rb
 - lib/telegram_bot_middleware/version.rb
+- spec/spec_helper.rb
+- spec/telegram_bot_middleware_spec.rb
 - telegram_bot_middleware.gemspec
 homepage: https://github.com/MirkoMignini/telegram_bot_middleware
 licenses:
@@ -148,4 +178,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rack middleware to communicate with a telegram bot.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/telegram_bot_middleware_spec.rb