dialog_bot_ruby 0.8.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75602caf402bd9c38556bf173265dc884083b55aa42fd91e447e97638949d586
+  data.tar.gz: a666b4f4813e77fa30049dd73a82db2297842e11a66d07be5d3ca910610d7a1d
+SHA512:
+  metadata.gz: 5f9af8849974b68ccad6ca9ed08dc445cf921788039bf560ba7caf66744f449aa50e3f93ddb2af360b45bf66a64d59fae7961b88cf4f91776c1e4e43a665998a
+  data.tar.gz: e79720f970f726be57d6797885df46e32ea9a8bb1ba54f5183a603806256504bd9e5cb830bfcddec8c87c85b9d7b9c9f1d0cf6ee2577832bf3239b090c0d3dad

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+*.gem
+
+.bundle/
+pkg/
+vendor/bundle/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from: .rubocop_todo.yml
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/LineLength:
+  Exclude:
+    - telegram-bot-ruby.gemspec
+    - examples/*.rb
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '()'

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-06-27 20:51:46 +0300 using RuboCop version 0.32.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 15
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.0
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+## 0.8.6.1
+
+- Fix #163
+
+## 0.8.6
+
+- Implement [Bot API 3.5](https://core.telegram.org/bots/api#november-17-2017)
+
+## 0.8.5
+
+- Implement [Bot API 3.4](https://core.telegram.org/bots/api#october-11-2017) (thx [@ivanovaleksey][])
+
+## 0.8.4
+
+- Implement [Bot API 3.3](https://core.telegram.org/bots/api#august-23-2017) (thx [@ivanovaleksey][])
+
+## 0.8.3
+
+- Implement [Bot API 3.2](https://core.telegram.org/bots/api#july-21-2017) (thx [@ivanovaleksey][])
+
+## 0.8.2
+
+- Implement [Bot API 3.1](https://core.telegram.org/bots/api#june-30-2017) (thx [@ivanovaleksey][])
+
+## 0.8.1
+
+- Add [missing methods](https://github.com/atipugin/telegram-bot-ruby/pull/127) from earlier versions earlier
+
+## 0.8.0
+
+- Implement [Bot API 3.0](https://core.telegram.org/bots/api#may-18-2017) (thx [@ivanovaleksey][])
+
+## 0.7.2
+
+- Bug fixes
+
+## 0.7.1
+
+- Implement [Bot API 2.3.1](https://core.telegram.org/bots/api-changelog#december-4-2016)
+
+## 0.7.0
+
+- Implement [Bot API 2.3](https://core.telegram.org/bots/api-changelog#november-21-2016) (thx [@ivanovaleksey][])
+
+## 0.6.0
+
+- Implement Bot API changes (October 3, 2016 API update)
+
+## 0.5.2
+
+- Implement Bot API 2.1 changes
+
+## 0.5.1
+
+- Update `Sticker` and `Message` objects (May 6, 2016 API update)
+
+## 0.5.0
+
+- Replace [httparty](https://github.com/jnunemaker/httparty) with [faraday](https://github.com/lostisland/faraday)
+- Implement [Bot API 2.0](https://core.telegram.org/bots/2-0-intro)
+
+## 0.4.2
+
+- Let `Client#logger` be overwritten later (use `attr_accessor` instead of `attr_reader`)
+
+[@ivanovaleksey]: https://github.com/ivanovaleksey

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.
+

data/README.md

@@ -0,0 +1,197 @@
+# telegram-bot-ruby
+
+Ruby wrapper for [Telegram's Bot API](https://core.telegram.org/bots/api).
+
+[![Gem Version](https://badge.fury.io/rb/telegram-bot-ruby.svg)](http://badge.fury.io/rb/telegram-bot-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7e61fbf5bec86e118fb1/maintainability)](https://codeclimate.com/github/atipugin/telegram-bot-ruby/maintainability)
+[![Build Status](https://travis-ci.org/atipugin/telegram-bot-ruby.svg?branch=master)](https://travis-ci.org/atipugin/telegram-bot-ruby)
+[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks!-🦉-1EAEDB.svg)](https://saythanks.io/to/atipugin)
+
+## Installation
+
+Add following line to your Gemfile:
+
+```ruby
+gem 'telegram-bot-ruby'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it system-wide:
+
+```shell
+$ gem install telegram-bot-ruby
+```
+
+## Usage
+
+First things first, you need to [obtain a token](https://core.telegram.org/bots#botfather) for your bot. Then create your Telegram bot like this:
+
+```ruby
+require 'telegram/bot'
+
+token = 'YOUR_TELEGRAM_BOT_API_TOKEN'
+
+Telegram::Bot::Client.run(token) do |bot|
+  bot.listen do |message|
+    case message.text
+    when '/start'
+      bot.api.send_message(chat_id: message.chat.id, text: "Hello, #{message.from.first_name}")
+    when '/stop'
+      bot.api.send_message(chat_id: message.chat.id, text: "Bye, #{message.from.first_name}")
+    end
+  end
+end
+```
+
+Note that `bot.api` object implements [Telegram Bot API methods](https://core.telegram.org/bots/api#available-methods) as is. So you can invoke any method inside the block without any problems. All methods are available in both *snake_case* and *camelCase* notations.
+
+Same thing about `message` object - it implements [Message](https://core.telegram.org/bots/api#message) spec, so you always know what to expect from it.
+
+## Webhooks
+
+If you are going to use [webhooks](https://core.telegram.org/bots/api#setwebhook) instead of [long polling](https://core.telegram.org/bots/api#getupdates), you need to implement your own webhook callbacks server. Take a look at [this repo](https://github.com/solyaris/BOTServer) as an example.
+
+## Custom keyboards
+
+You can use your own [custom keyboards](https://core.telegram.org/bots#keyboards). Here is an example:
+
+```ruby
+bot.listen do |message|
+  case message.text
+  when '/start'
+    question = 'London is a capital of which country?'
+    # See more: https://core.telegram.org/bots/api#replykeyboardmarkup
+    answers =
+      Telegram::Bot::Types::ReplyKeyboardMarkup
+      .new(keyboard: [%w(A B), %w(C D)], one_time_keyboard: true)
+    bot.api.send_message(chat_id: message.chat.id, text: question, reply_markup: answers)
+  when '/stop'
+    # See more: https://core.telegram.org/bots/api#replykeyboardremove
+    kb = Telegram::Bot::Types::ReplyKeyboardRemove.new(remove_keyboard: true)
+    bot.api.send_message(chat_id: message.chat.id, text: 'Sorry to see you go :(', reply_markup: kb)
+  end
+end
+```
+
+Furthermore, you can ask user to share location or phone number using `KeyboardButton`:
+
+```ruby
+bot.listen do |message|
+  kb = [
+    Telegram::Bot::Types::KeyboardButton.new(text: 'Give me your phone number', request_contact: true),
+    Telegram::Bot::Types::KeyboardButton.new(text: 'Show me your location', request_location: true)
+  ]
+  markup = Telegram::Bot::Types::ReplyKeyboardMarkup.new(keyboard: kb)
+  bot.api.send_message(chat_id: message.chat.id, text: 'Hey!', reply_markup: markup)
+end
+```
+
+## Inline keyboards
+
+[Bot API 2.0](https://core.telegram.org/bots/2-0-intro) brought us new inline keyboards. Example:
+
+```ruby
+bot.listen do |message|
+  case message
+  when Telegram::Bot::Types::CallbackQuery
+    # Here you can handle your callbacks from inline buttons
+    if message.data == 'touch'
+      bot.api.send_message(chat_id: message.from.id, text: "Don't touch me!")
+    end
+  when Telegram::Bot::Types::Message
+    kb = [
+      Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Go to Google', url: 'https://google.com'),
+      Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Touch me', callback_data: 'touch'),
+      Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Switch to inline', switch_inline_query: 'some text')
+    ]
+    markup = Telegram::Bot::Types::InlineKeyboardMarkup.new(inline_keyboard: kb)
+    bot.api.send_message(chat_id: message.chat.id, text: 'Make a choice', reply_markup: markup)
+  end
+end
+```
+
+## Inline bots
+
+If you are going to create [inline bot](https://core.telegram.org/bots/inline), check the example below:
+
+```ruby
+bot.listen do |message|
+  case message
+  when Telegram::Bot::Types::InlineQuery
+    results = [
+      [1, 'First article', 'Very interesting text goes here.'],
+      [2, 'Second article', 'Another interesting text here.']
+    ].map do |arr|
+      Telegram::Bot::Types::InlineQueryResultArticle.new(
+        id: arr[0],
+        title: arr[1],
+        input_message_content: Telegram::Bot::Types::InputTextMessageContent.new(message_text: arr[2])
+      )
+    end
+
+    bot.api.answer_inline_query(inline_query_id: message.id, results: results)
+  when Telegram::Bot::Types::Message
+    bot.api.send_message(chat_id: message.chat.id, text: "Hello, #{message.from.first_name}!")
+  end
+end
+```
+
+Now, with `inline` mode enabled, your `message` object can be an instance of [Message](https://core.telegram.org/bots/api#message), [InlineQuery](https://core.telegram.org/bots/api#inlinequery) or [ChosenInlineResult](https://core.telegram.org/bots/api#choseninlineresult). That's why you need to check type of each message and decide how to handle it.
+
+Using `answer_inline_query` you can send query results to user. `results` field must be an array of [query result objects](https://core.telegram.org/bots/api#inlinequeryresult).
+
+## File upload
+
+Your bot can even upload files ([photos](https://core.telegram.org/bots/api#sendphoto), [audio](https://core.telegram.org/bots/api#sendaudio), [documents](https://core.telegram.org/bots/api#senddocument), [stickers](https://core.telegram.org/bots/api#sendsticker), [video](https://core.telegram.org/bots/api#sendvideo)) to Telegram servers. Just like this:
+
+```ruby
+bot.listen do |message|
+  case message.text
+  when '/photo'
+    bot.api.send_photo(chat_id: message.chat.id, photo: Faraday::UploadIO.new('~/Desktop/jennifer.jpg', 'image/jpeg'))
+  end
+end
+```
+
+## Logging
+
+By default, bot doesn't log anything (uses `NullLoger`). You can change this behavior and provide your own logger class. See example below:
+
+```ruby
+Telegram::Bot::Client.run(token, logger: Logger.new($stderr)) do |bot|
+  bot.logger.info('Bot has been started')
+  bot.listen do |message|
+    # ...
+  end
+end
+```
+
+## Connection adapters
+
+Since version `0.5.0` we rely on [faraday](https://github.com/lostisland/faraday) under the hood. You can use any of supported adapters (for example, `net/http/persistent`):
+
+```ruby
+require 'net/http/persistent'
+
+Telegram::Bot.configure do |config|
+  config.adapter = :net_http_persistent
+end
+```
+
+## Boilerplates
+
+If you don't know how to setup database for your bot or how to use it with different languages here are some boilerplates which can help you to start faster:
+- [Ruby Telegram Bot boilerplate](https://github.com/telegram-bots/ruby-telegram-bot-boilerplate)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = false
+  task.options = %w(--force-exclusion)
+  task.patterns = %w(lib/**/*.rb)
+  task.requires << 'rubocop-rspec'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'telegram/bot'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/dialog_bot_ruby.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'telegram/bot/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'dialog_bot_ruby'
+  s.version       = Telegram::Bot::VERSION
+  s.authors       = ['Alexander Tipugin', 'Eugene Istomin']
+  s.email         = ['atipugin@gmail.com', 'info@innosense.org']
+  s.license       = 'CC-BY-SA-4.0'
+
+  s.summary       = "Ruby wrapper for Telegram's Bot API"
+  s.homepage      = 'https://gitlab.com/Innosense/libs/dialog_bot_ruby'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'faraday',   '~> 0'
+  s.add_runtime_dependency 'virtus',    '~> 0'
+  s.add_runtime_dependency 'inflecto',  '~> 0'
+  s.add_runtime_dependency 'socksify',  '~> 0'
+
+  s.add_development_dependency 'bundler',   '~> 1.9'
+  s.add_development_dependency 'rake',      '~> 10.0'
+  s.add_development_dependency 'pry',       '~> 0'
+  s.add_development_dependency 'rubocop',   '~> 0.48.1'
+  s.add_development_dependency 'rspec',     '~> 3.4'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.8'
+end

data/examples/bot.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'telegram/bot'
+
+token = 'replace-me-with-your-real-token'
+
+Telegram::Bot::Client.run(token) do |bot|
+  bot.listen do |message|
+    case message.text
+    when '/start'
+      bot.api.send_message(chat_id: message.chat.id, text: "Hello, #{message.from.first_name}!")
+    when '/end'
+      bot.api.send_message(chat_id: message.chat.id, text: "Bye, #{message.from.first_name}!")
+    else
+      bot.api.send_message(chat_id: message.chat.id, text: "I don't understand you :(")
+    end
+  end
+end

data/lib/telegram/bot/adapters/socks5.rb

@@ -0,0 +1,24 @@
+require 'socksify'
+require 'socksify/http'
+
+module Telegram
+  module Bot
+    module Adapters
+      class Socks5 < Faraday::Adapter::NetHttp
+        def net_http_connection(env)
+          if proxy = env[:request][:proxy]
+            if proxy[:socks]
+              TCPSocket.socks_username = proxy[:user] if proxy[:user]
+              TCPSocket.socks_password = proxy[:password] if proxy[:password]
+              Net::HTTP::SOCKSProxy(proxy[:uri].host, proxy[:uri].port)
+            else
+              Net::HTTP::Proxy(proxy[:uri].host, proxy[:uri].port, proxy[:uri].user, proxy[:uri].password)
+            end
+          else
+            Net::HTTP
+          end.new(env[:url].host, env[:url].port)
+        end
+      end
+    end
+  end
+end 

data/lib/telegram/bot/api.rb

@@ -0,0 +1,172 @@
+module Telegram
+  module Bot
+    class Api
+      ENDPOINTS = %w(
+        getUpdates setWebhook deleteWebhook getWebhookInfo getMe sendMessage
+        forwardMessage sendPhoto sendAudio sendDocument sendVideo sendVoice
+        sendVideoNote sendMediaGroup sendLocation editMessageLiveLocation
+        stopMessageLiveLocation sendVenue sendContact sendChatAction
+        getUserProfilePhotos getFile kickChatMember unbanChatMember
+        restrictChatMember promoteChatMember leaveChat getChat
+        getChatAdministrators exportChatInviteLink setChatPhoto deleteChatPhoto
+        setChatTitle setChatDescription pinChatMessage unpinChatMessage
+        getChatMembersCount getChatMember setChatStickerSet deleteChatStickerSet
+        answerCallbackQuery editMessageText editMessageCaption
+        editMessageReplyMarkup deleteMessage sendSticker getStickerSet
+        uploadStickerFile createNewStickerSet addStickerToSet
+        setStickerPositionInSet deleteStickerFromSet answerInlineQuery
+        sendInvoice answerShippingQuery answerPreCheckoutQuery
+        sendGame setGameScore getGameHighScores sendInvoice
+      ).freeze
+      REPLY_MARKUP_TYPES = [
+        Telegram::Bot::Types::ReplyKeyboardMarkup,
+        Telegram::Bot::Types::ReplyKeyboardRemove,
+        Telegram::Bot::Types::ForceReply,
+        Telegram::Bot::Types::InlineKeyboardMarkup
+      ].freeze
+      INLINE_QUERY_RESULT_TYPES = [
+        Telegram::Bot::Types::InlineQueryResultArticle,
+        Telegram::Bot::Types::InlineQueryResultPhoto,
+        Telegram::Bot::Types::InlineQueryResultGif,
+        Telegram::Bot::Types::InlineQueryResultMpeg4Gif,
+        Telegram::Bot::Types::InlineQueryResultVideo,
+        Telegram::Bot::Types::InlineQueryResultAudio,
+        Telegram::Bot::Types::InlineQueryResultVoice,
+        Telegram::Bot::Types::InlineQueryResultDocument,
+        Telegram::Bot::Types::InlineQueryResultLocation,
+        Telegram::Bot::Types::InlineQueryResultVenue,
+        Telegram::Bot::Types::InlineQueryResultContact,
+        Telegram::Bot::Types::InlineQueryResultGame,
+        Telegram::Bot::Types::InlineQueryResultCachedPhoto,
+        Telegram::Bot::Types::InlineQueryResultCachedGif,
+        Telegram::Bot::Types::InlineQueryResultCachedMpeg4Gif,
+        Telegram::Bot::Types::InlineQueryResultCachedSticker,
+        Telegram::Bot::Types::InlineQueryResultCachedDocument,
+        Telegram::Bot::Types::InlineQueryResultCachedVideo,
+        Telegram::Bot::Types::InlineQueryResultCachedVoice,
+        Telegram::Bot::Types::InlineQueryResultCachedAudio
+      ].freeze
+
+      attr_reader :token
+
+      def initialize(token)
+        @token = token
+      end
+
+      def method_missing(method_name, *args, &block)
+        endpoint = method_name.to_s
+        endpoint = camelize(endpoint) if endpoint.include?('_')
+
+        ENDPOINTS.include?(endpoint) ? call(endpoint, *args) : super
+      end
+
+      def respond_to_missing?(*args)
+        method_name = args[0].to_s
+        method_name = camelize(method_name) if method_name.include?('_')
+
+        ENDPOINTS.include?(method_name) || super
+      end
+
+      def call(endpoint, raw_params = {}, force = false)
+        params = force ? raw_params : build_params(raw_params)
+        response = conn.post("/bot#{token}/#{endpoint}", params.to_json)
+        if response.status == 200
+          JSON.parse(response.body)
+        elsif response.finished?
+          raise Exceptions::ResponseError.new(response),
+                'Telegram API has returned the error.'
+        else
+          response          
+        end
+      end
+
+      def in_parallel(&block)
+        conn.in_parallel(&block)
+      end      
+      
+      private
+
+      def build_params(h)
+        h.each_with_object({}) do |(key, value), params|
+          params[key] = sanitize_value(value)
+        end
+      end
+
+      def sanitize_value(value)
+        jsonify_inline_query_results(jsonify_reply_markup(value))
+      end
+
+      def jsonify_reply_markup(value)
+        return value unless REPLY_MARKUP_TYPES.include?(value.class)
+        value.to_compact_hash.to_json
+      end
+
+      def jsonify_inline_query_results(value)
+        return value unless
+          value.is_a?(Array) &&
+          value.all? { |i| INLINE_QUERY_RESULT_TYPES.include?(i.class) }
+        value.map { |i| i.to_compact_hash.select { |_, v| v } }.to_json
+      end
+
+      def camelize(method_name)
+        words = method_name.split('_')
+        words.drop(1).map(&:capitalize!)
+        words.join
+      end
+
+      def conn
+        @conn ||=
+          case ENV['BotProxyType']
+          when 'https'
+            set_http_proxy_connection('https')
+          when 'http'
+            set_http_proxy_connection('http') 
+          when 'socks5'
+            set_socks5_connection
+          else
+            set_default_connection
+          end
+      end
+
+      def set_http_proxy_connection(proto)
+        host = "#{proto}://#{ENV['BotProxyHost']}:#{ENV['BotProxyPort']}"
+        Faraday.new(url: 'https://api.telegram.org', ssl: {verify:false}) do |faraday|
+          faraday.request :multipart
+          faraday.request :url_encoded
+          faraday.adapter Telegram::Bot.configuration.adapter
+          faraday.proxy URI.parse(host)
+        end
+      end
+
+      def set_default_connection
+        Faraday.new(url: 'https://api.telegram.org', ssl: {verify:false}) do |faraday|
+          faraday.request :multipart
+          faraday.request :url_encoded
+          faraday.adapter Telegram::Bot.configuration.adapter
+        end
+      end
+
+      def set_socks5_connection
+        require 'telegram/bot/adapters/socks5'
+
+        host = "https://#{ENV['BotProxyHost']}:#{ENV['BotProxyPort']}"                                            
+        proxy_opts = {
+            uri: URI.parse(host),
+            user: ENV['BotProxyLogin'],
+            password: ENV['BotProxyPass'],
+            socks: true
+        }
+
+        Faraday.new(url: 'https://api.telegram.org',
+                                 ssl: {verify:false},
+                                 request: { proxy: proxy_opts }) do |c|
+          c.request :multipart
+          c.request :url_encoded
+          c.headers['Content-Type'] = 'application/json'
+          Faraday::Adapter.register_middleware socks5: Telegram::Bot::Adapters::Socks5
+          c.adapter :socks5
+        end
+      end
+    end
+  end
+end