telegram-bot 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90fe9ba02f559d7627de3c66909da6815bac5e96
-  data.tar.gz: 9eece5573e375b2443752987b6788c443a369833
+  metadata.gz: 21e86ff6949e2e4f60350c86344291f603bafc8c
+  data.tar.gz: 61478f30a26e0ae4e50c18fd34e2df250dba9fe3
 SHA512:
-  metadata.gz: 76fbe6456c485ed85b052177ec3d759487cb0e96c0db8891286a49a198be4832891b82751de3817e6b913640cd042ee00d69e4067d8146402695cea28aa8b691
-  data.tar.gz: 8ae9a9fcaa9a771b60149e0350f6f18377e67788d26cb40fe9ce38e1d837282865608b4034506e294cab8617492954653ffdb368cf3a71f92e5d2e41bf4a7151
+  metadata.gz: f1eb9064cd9b8220b8d47f436422d2088cb03e44c35bec3590c59f8e26f79a36e049f36b5761bcbf73854bb168f38c0201ce6bd5253c590049f201be5aa4dcae
+  data.tar.gz: e405a0acf8966a581f6efc65b893a5746ff614382ccfa32d051ec3c60d78f9a83be4756f25b62178118251659d1c58d4704a2c48c05c3a6ddb5d2a0fca2b77ac

data/.gitignore

@@ -6,4 +6,5 @@
 /doc/
 /pkg/
 /spec/reports/
+/log/
 /tmp/

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# Unreleased
+
+# 0.12.0
+
+- New API methods and payload types (up to Bot API 3.2).
+- Fix rails 5.1.x support.
+- RSpec context for callback_query updates.
+- `edit_message` helper.
+- ClientStub saves and returns token. Fixes testing multiple bots.
+- Raise descriptive error when accessing not-configured bot.
+
 # 0.11.3
 
 - Release dependencies for Rails 5.1.

data/Gemfile

@@ -1,16 +1,22 @@
 source 'https://rubygems.org'
 gemspec
 
-case ENV['RAILS']
-when '5_1'
-  gem 'actionpack', '5.1.0'
-when '5'
-  gem 'actionpack', '5.0.2'
-when '4'
-  gem 'actionpack', '~> 4.2'
-end
-
 group :development do
+  case ENV['RAILS']
+  when '5_1'
+    gem 'railties', '5.1.0'
+    gem 'actionpack', '5.1.0'
+  when '5'
+    gem 'railties', '5.0.2'
+    gem 'actionpack', '5.0.2'
+  when '4'
+    gem 'railties', '~> 4.2'
+    gem 'actionpack', '~> 4.2'
+  else
+    gem 'railties'
+    gem 'actionpack'
+  end
+
   gem 'sdoc', '~> 0.4.1'
   gem 'pry', '~> 0.10.1'
   gem 'pry-byebug', '~> 3.2.0'
@@ -19,6 +25,7 @@ group :development do
 
   gem 'rspec', '~> 3.5.0'
   gem 'rspec-its', '~> 1.1.0'
+  gem 'rspec-rails', '~> 3.5.0'
 
   gem 'rubocop', '~> 0.37.0'
 

data/README.md

@@ -27,6 +27,8 @@ Run it on your local machine in 1 minute!
 And here is [app teamplate](https://github.com/telegram-bot-rb/rails_template)
 to generate clean app in seconds.
 
+Examples and cookbook in [wiki](https://github.com/telegram-bot-rb/telegram-bot/wiki).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -166,6 +168,20 @@ class Telegram::WebhookController < Telegram::Bot::UpdatesController
 end
 ```
 
+#### Reply helpers
+
+There are helpers to respond for basic actions. They just set chat/message/query
+identifiers from update. See `ReplyHelpers` method for more information.
+Here are this methods signatures:
+
+```ruby
+def respond_with(type, params); end
+def reply_with(type, params); end
+def answer_inline_query(results, params = {}); end
+def answer_callback_query(text, params = {}); end
+def edit_message(type, params = {}); end
+```
+
 #### Optional typecasting
 
 You can enable typecasting of `update` with `telegram-bot-types` by including
@@ -341,6 +357,8 @@ Telegram::Bot::ClientStub.stub_all!
 RSpec.configure do |config|
   # ...
   config.after { Telegram.bot.reset }
+  # or for multiple bots:
+  config.after { Telegram.bots.each_value(&:reset) }
   # ...
 end
 ```
@@ -359,6 +377,13 @@ RSpec.describe TelegramWebhooksController, :telegram_bot do
     subject { -> { dispatch_command :start } }
     it { should respond_with_message 'Hi there!' }
   end
+
+  # There is context for callback queries with related matchers.
+  describe '#hey_callback_query', :callback_query do
+    let(:data) { "hey:#{name}" }
+    let(:name) { 'Joe' }
+    it { should answer_callback_query('Hey Joe') }
+    it { should edit_current_message :text, text: 'Done' }
 end
 
 # For controller specs use
@@ -376,6 +401,10 @@ expect(&process_update).
   to make_telegram_request(bot, :sendMessage, hash_including(text: 'msg text'))
 ```
 
+Place integration tests inside `spec/requests`
+when using RSpec's `infer_spec_type_from_file_location!`,
+or just add `type: :request` to `describe`.
+
 See sample app for more examples.
 
 ### Deploying

data/lib/telegram/bot/client.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/hash/keys'
 
 module Telegram
   module Bot
-    class Client
+    class Client # rubocop:disable ClassLength
       URL_TEMPLATE = 'https://api.telegram.org/bot%s/'.freeze
 
       autoload :TypedResponse, 'telegram/bot/client/typed_response'
@@ -70,6 +70,8 @@ module Telegram
         setWebhook
 
         answerCallbackQuery
+        deleteChatPhoto
+        exportChatInviteLink
         forwardMessage
         getChat
         getChatAdministrators
@@ -80,6 +82,9 @@ module Telegram
         getUserProfilePhotos
         kickChatMember
         leaveChat
+        pinChatMessage
+        promoteChatMember
+        restrictChatMember
         sendAudio
         sendChatAction
         sendContact
@@ -87,18 +92,35 @@ module Telegram
         sendLocation
         sendMessage
         sendPhoto
-        sendSticker
         sendVenue
         sendVideo
+        sendVideoNote
         sendVoice
+        setChatDescription
+        setChatPhoto
+        setChatTitle
         unbanChatMember
+        unpinChatMessage
 
+        deleteMessage
         editMessageCaption
         editMessageReplyMarkup
         editMessageText
 
+        sendSticker
+        getStickerSet
+        uploadStickerFile
+        createNewStickerSet
+        addStickerToSet
+        setStickerPositionInSet
+        deleteStickerFromSet
+
         answerInlineQuery
 
+        sendInvoice
+        answerShippingQuery
+        answerPreCheckoutQuery
+
         getGameHighScores
         sendGame
         setGameScore

data/lib/telegram/bot/client_stub.rb

@@ -35,6 +35,7 @@ module Telegram
       end
 
       def initialize(token = nil, username = nil, **options)
+        @token = token || options[:token]
         @username = username || options[:username] || token
         reset
       end

data/lib/telegram/bot/config_methods.rb

@@ -34,7 +34,11 @@ module Telegram
 
       # Default bot.
       def bot
-        @bot ||= bots[:default]
+        @bot ||= bots.fetch(:default) do
+          raise 'Default bot is not configured.' \
+            ' Add :default to bots_config' \
+            ' or use telegram.bot/telegram.bots.default section in secrets.yml.'
+        end
       end
 
       # Hash of botan clients made from #bots.

data/lib/telegram/bot/rspec/integration.rb

@@ -14,7 +14,7 @@ RSpec.shared_context 'telegram/bot/integration' do
     }
   end
   let(:clear_session?) { described_class.respond_to?(:session_store) }
-  before { described_class.session_store.clear if clear_session? }
+  before { described_class.session_store.try!(:clear) if clear_session? }
 
   include Telegram::Bot::RSpec::ClientMatchers
 
@@ -36,14 +36,48 @@ RSpec.shared_context 'telegram/bot/integration' do
   end
 
   # Matcher to check response. Make sure to define `let(:chat_id)`.
-  def respond_with_message(expected)
+  def respond_with_message(expected = Regexp.new(''))
     raise 'Define chat_id to use respond_with_message' unless defined?(chat_id)
     send_telegram_message(bot, expected, chat_id: chat_id)
   end
 end
 
+RSpec.shared_context 'telegram/bot/callback_query', callback_query: true do
+  include_context 'telegram/bot/integration'
+
+  subject { -> { dispatch callback_query: payload } }
+  let(:payload) { {id: 11, from: from, message: message, data: data} }
+  let(:message) { {message_id: 22, chat: chat, text: 'message text'} }
+
+  # Matcher to check that origin message got edited.
+  def edit_current_message(type, options = {})
+    description = 'edit current message'
+    options = options.merge(
+      message_id: message[:message_id],
+      chat_id: chat_id,
+    )
+    Telegram::Bot::RSpec::ClientMatchers::MakeTelegramRequest.new(
+      bot, :"editMessage#{type.to_s.camelize}", description: description
+    ).with(hash_including(options))
+  end
+
+  # Matcher to check that callback query is answered.
+  def answer_callback_query(text = Regexp.new(''), options = {})
+    description = "answer callback query with #{text.inspect}"
+    text = a_string_matching(text) if text.is_a?(Regexp)
+    options = options.merge(
+      callback_query_id: payload[:id],
+      text: text,
+    )
+    Telegram::Bot::RSpec::ClientMatchers::MakeTelegramRequest.new(
+      bot, :answerCallbackQuery, description: description
+    ).with(hash_including(options))
+  end
+end
+
 RSpec.configure do |config|
   if config.respond_to?(:include_context)
     config.include_context 'telegram/bot/integration', :telegram_bot
+    config.include_context 'telegram/bot/callback_query', :telegram_bot, :callback_query
   end
 end

data/lib/telegram/bot/updates_controller.rb

@@ -86,6 +86,8 @@ module Telegram
         inline_query
         chosen_inline_result
         callback_query
+        shipping_query
+        pre_checkout_query
       ).freeze
       CMD_REGEX = %r{\A/([a-z\d_]{,31})(@(\S+))?(\s|$)}i
       CONFLICT_CMD_REGEX = Regexp.new("^(#{PAYLOAD_TYPES.join('|')}|\\d)")
@@ -169,15 +171,21 @@ module Telegram
       # Returns array `[is_command?, action, args]`.
       def action_for_payload
         if payload_type
-          send("action_for_#{payload_type}") || [false, payload_type, [payload]]
+          send("action_for_#{payload_type}") || action_for_default_payload
         else
           [false, :unsupported_payload_type, []]
         end
       end
 
+      def action_for_default_payload
+        [false, payload_type, [payload]]
+      end
+
       # If payload is a message with command, then returned action is an
       # action for this command.
       # Separate method, so it can be easily overriden (ex. MessageContext).
+      #
+      # This is not used for edited messages/posts. It process them as basic updates.
       def action_for_message
         cmd, args = self.class.command_from_text(payload['text'], bot_username)
         cmd &&= self.class.action_for_command(cmd)
@@ -185,12 +193,6 @@ module Telegram
       end
       alias_method :action_for_channel_post, :action_for_message
 
-      # It doesn't extract commands from edited messages. Just process
-      # them as usual ones.
-      def action_for_edited_message
-      end
-      alias_method :action_for_edited_channel_post, :action_for_edited_message
-
       def action_for_inline_query
         [false, payload_type, [payload['query'], payload['offset']]]
       end
@@ -208,6 +210,11 @@ module Telegram
       def action_missing(*)
       end
 
+      PAYLOAD_TYPES.each do |type|
+        method = :"action_for_#{type}"
+        alias_method method, :action_for_default_payload unless instance_methods.include?(method)
+      end
+
       ActiveSupport.run_load_hooks('telegram.bot.updates_controller', self)
     end
   end

data/lib/telegram/bot/updates_controller/callback_query_context.rb

@@ -15,7 +15,6 @@ module Telegram
         # because `data` param is controlled by client.
         def action_for_callback_query
           context, new_data = context_from_callback_query
-          # binding.pry
           if context
             action_name = "#{context}_callback_query"
             [false, action_name, [new_data]] if action_method?(action_name)

data/lib/telegram/bot/updates_controller/reply_helpers.rb

@@ -38,6 +38,19 @@ module Telegram
           )
           bot.answer_callback_query(params)
         end
+
+        # Edit message from callback query.
+        def edit_message(type, params = {})
+          params =
+            if message_id = payload['inline_message_id'] # rubocop:disable AssignmentInCondition
+              params.merge(inline_message_id: message_id)
+            elsif message = payload['message'] # rubocop:disable AssignmentInCondition
+              params.merge(chat_id: message['chat']['id'], message_id: message['message_id'])
+            else
+              raise 'Can not edit message without `inline_message_id` or `message`'
+            end
+          bot.public_send("edit_message_#{type}", params)
+        end
       end
     end
   end

data/lib/telegram/bot/version.rb

@@ -1,6 +1,6 @@
 module Telegram
   module Bot
-    VERSION = '0.11.3'.freeze
+    VERSION = '0.12.0'.freeze
 
     def self.gem_version
       Gem::Version.new VERSION

data/telegram-bot.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.0'
 
-  spec.add_dependency 'activesupport', '>= 4.0', '<= 5.1'
-  spec.add_dependency 'actionpack', '>= 4.0', '<= 5.1'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 5.2'
+  spec.add_dependency 'actionpack', '>= 4.0', '< 5.2'
   spec.add_dependency 'httpclient', '~> 2.7'
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-bot
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement