telegram_bot_middleware 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53104e93078e22a26e106dd70fbec85e2e5eefc0
+  data.tar.gz: 92d7d5da377b3708f52fabc3de79d339d418cd6f
+SHA512:
+  metadata.gz: 11a3edb593bcc3bca092c9abc94f00454c97d269cc5a85bb9ee40d682697d80a093949bba721f414025df1863cf4662bd7df4d1d5c666c415115e9da260450bc
+  data.tar.gz: 0f08fdccfa4588fea7a9f6070b8461eb69df2f2d76d3a0b0fcfe9964a3b3be3e6aea572088434ddd295a2808caddab46cce8623f59193b2ef95d7d034c242590

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# RubyMine project files
+.idea/
+
+#Mac OS files
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in telegram_bot_middleware.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    telegram_bot_middleware (0.1.0)
+      httmultiparty
+      http
+      persistent_httparty
+      rake (~> 10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    diff-lcs (1.2.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    gene_pool (1.4.1)
+      thread_safe
+    httmultiparty (0.3.16)
+      httparty (>= 0.7.3)
+      mimemagic
+      multipart-post
+    http (0.9.8)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    mimemagic (0.3.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    persistent_http (1.0.6)
+      gene_pool (>= 1.3)
+    persistent_httparty (0.1.2)
+      httparty (~> 0.9)
+      persistent_http (< 2)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    thread_safe (0.3.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  rspec
+  telegram_bot_middleware!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mirko Mignini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# TelegramBotMiddleware
+
+Rack middleware to communicate with a telegram bot.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telegram_bot_middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telegram_bot_middleware
+    
+TODO: Write more installation instructions.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/MirkoMignini/telegram_bot_middleware. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "telegram_bot_middleware"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/rack/config.ru

@@ -0,0 +1,9 @@
+require_relative '../../lib/telegram_bot_middleware'
+
+use TelegramBotMiddleware do |config|
+  config.token = '138381425:AAEXjzZx5U5wZmiKvFmHjdNMkXJqnkHnum4'
+  config.host = 'http://127.0.0.1:9292'
+  config.get_updates = :polling
+end
+
+run Proc.new { |env| [200, {'Content-Type' => 'text/html'}, ['Hello world!']] }

data/examples/sinatra/calc.rb

@@ -0,0 +1,22 @@
+require_relative 'example_init'
+
+calc_string = ''
+
+get %r{calc/?$}i do
+  calc_string = ''
+  {
+    text: "Let's calc!",
+    reply_markup: {keyboard: [%w(7 8 9 *), %w(4 5 6 /), %w(1 2 3 -), %w(0 . = +)], resize_keyboard: true, one_time_keyboard: false, selective: false}
+  }
+end
+
+get %r{(0|1|2|3|4|5|6|7|8|9|\*|\/|-|\.|\+)$} do |cmd|
+  calc_string += cmd
+end
+
+get '/=' do
+  {
+    text: eval(calc_string).to_s,
+    reply_markup: {hide_keyboard: true}
+  }
+end

data/examples/sinatra/chuck_norris.rb

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

data/examples/sinatra/config.ru

@@ -0,0 +1,12 @@
+#require './example'
+#require './calc'
+require './chuck_norris'
+
+$stdout.sync = true
+
+warmup do |app|
+  client = Rack::MockRequest.new(app)
+  client.get('/')
+end
+
+run Sinatra::Application

data/examples/sinatra/example.rb

@@ -0,0 +1,42 @@
+require_relative 'example_init'
+
+get %r{/hello$}i do
+  {
+    text: "Hello #{params['from']['first_name']} #{params['from']['last_name']}!",
+    reply_markup: {keyboard: [%w(A B), ['C', 'D']], resize_keyboard: true, one_time_keyboard: true, selective: false}
+  }
+end
+
+get %r{/hello/(.*)}i do |name|
+  "Hello #{name}!"
+end
+
+get %r{/image/?$}i do
+  send_file 'tmp/test.png'
+end
+
+get %r{/audio/?$}i do
+  send_file 'tmp/test.mp3'
+end
+
+get %r{/video/?$}i do
+  send_file 'tmp/test.mp4'
+end
+
+get %r{/location/?$}i do
+  {
+    latitude: 38.115036, 
+    longitude: 13.366640
+  }
+end
+
+get %r{/caption/?$}i do
+  {
+    photo: File.new('tmp/test.png'),
+    caption: 'caption'
+  }
+end
+
+get '*' do
+  "Sono giapponese \u{0FE4E5}"
+end

data/examples/sinatra/example_init.rb

@@ -0,0 +1,9 @@
+require 'sinatra'
+require_relative '../../lib/telegram_bot_middleware'
+
+use TelegramBotMiddleware do |config|
+  config.token = '138381425:AAEXjzZx5U5wZmiKvFmHjdNMkXJqnkHnum4'
+  #config.host = 'https://telegram-bot-middleware.herokuapp.com'
+  config.host = 'http://127.0.0.1:9292'
+  config.get_updates = :polling
+end

data/lib/ostruct_nested.rb

@@ -0,0 +1,18 @@
+require 'ostruct'
+require 'json'
+
+class OpenStruct 
+  def to_h_nested
+    hash = self.to_h
+    hash.each do |key, value|
+      if value.is_a? OpenStruct
+        hash[key] = value.to_h_nested
+      end
+    end
+    hash
+  end
+  
+  def self.from_json(json_string)
+    JSON.parse(json_string, object_class: OpenStruct)
+  end
+end

data/lib/telegram_bot_middleware/version.rb

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

data/lib/telegram_bot_middleware.rb

@@ -0,0 +1,172 @@
+require 'rack'
+require 'uri'
+require 'http'
+require 'httmultiparty'
+require 'persistent_httparty'
+require_relative 'ostruct_nested'
+require_relative 'telegram_bot_middleware/version'
+
+class TelegramBotMiddleware
+  include HTTMultiParty
+  base_uri 'https://api.telegram.org'
+  persistent_connection_adapter pool_size: 1,
+                                keep_alive: 30,
+                                force_retry: true
+  
+  def initialize(app, &block)
+    # 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?
+
+    # setup webhook
+    if @config.webhook.nil?
+      @config.host = "#{@config.host}/" unless @config.host.end_with?('/')
+      @config.webhook = "#{@config.host}#{@config.token}"
+    end
+    
+    # setup telegram messages input
+    case @config.get_updates
+      
+      # setup polling
+      when :polling
+        # clear the webhook in case was set in the past
+        send_to_bot('setWebhook', {url: ''})
+        
+        # setup a thread with get_updates function
+        start_get_updates_thread
+      
+      # setup webhook
+      when :webhook
+        send_to_bot('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.')
+    end
+  end
+  
+  def start_get_updates_thread
+    # start a new thread
+    Thread.new do
+      # the initial offset is always 0
+      @offset = 0      
+      # wait 5 seconds to don't risk to post message too early when the app is not still up
+      sleep 5
+      # loop forever
+      loop do
+        # call the getUpdates telegram function
+        response = send_to_bot('getUpdates', {offset: @offset})
+        # enumerate the results
+        response.to_hash['result'].each do |data|
+          # create an update message from the post data
+          update = OpenStruct.new(data)
+          # store the last offset +1 but ensure that is not lower than the already stored
+          @offset = (update.update_id + 1) if update.update_id + 1 > @offset
+          # simulate a post to itself
+          HTTP.post @config.webhook, json: update.to_h_nested
+        end
+      end
+    end
+  end
+
+  # necessary for thread safe
+  def call(env)
+    dup._call(env)
+  end
+  
+  def _call(env)
+    # retrieve the request object
+    req = Rack::Request.new(env)
+    
+    # if the request is a post to bot webhhok
+    if req.post? and req.path == "/#{@config.token}"
+      
+      # in case someone already read it
+      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?('/')
+      
+      # build the querystring using message but nested
+      query_string = Rack::Utils.build_nested_query(params.message.to_h_nested)
+      
+      # 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}"
+      # TODO use update(hash) { |name, old_value, new_value| }
+      
+      # call the rack stack
+      status, headers, body = @app.call(env)
+      
+      if status == 200 or status == '200'
+        
+        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)
+              
+              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})
+              end
+            end
+        
+          when /(^image\/)/
+            send_to_bot('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)})
+          
+          when /(^video\/)/
+            send_to_bot('sendVideo', {chat_id: params.message.chat.id, video: File.new(body)})          
+        end
+      end
+      
+      # return result
+      [status, headers, body]
+    else
+      # normal rack flow - not a bot call
+      @app.call(env)
+    end
+  end
+  
+  def send_to_bot(path, query)
+    response = self.class.post("/bot#{@config.token}/#{path}", query: query)
+    # TODO check respobse error
+  end
+end

data/telegram_bot_middleware.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telegram_bot_middleware/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telegram_bot_middleware"
+  spec.version       = TelegramBotMiddleware::VERSION
+  spec.authors       = ["Mirko Mignini"]
+  spec.email         = ["mirko.mignini@gmail.com"]
+
+  spec.summary       = %q{Rack middleware to communicate with a telegram bot.}
+  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.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 'http'
+  spec.add_dependency 'httmultiparty'
+  spec.add_dependency 'persistent_httparty'
+  
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: telegram_bot_middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mirko Mignini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  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: httmultiparty
+  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: persistent_httparty
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/rack/config.ru
+- examples/sinatra/calc.rb
+- examples/sinatra/chuck_norris.rb
+- examples/sinatra/config.ru
+- examples/sinatra/example.rb
+- examples/sinatra/example_init.rb
+- lib/ostruct_nested.rb
+- lib/telegram_bot_middleware.rb
+- lib/telegram_bot_middleware/version.rb
+- telegram_bot_middleware.gemspec
+homepage: https://github.com/MirkoMignini/telegram_bot_middleware
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware to communicate with a telegram bot.
+test_files: []