Merge pull request #2 from telegram-bot-rb/async

Async requests

spec/spec_helper.rb

@@ -17,6 +17,8 @@ require 'telegram/bot'
 require 'telegram/bot/updates_controller/rspec_helpers'
 require 'telegram/bot/types'
 
+Dir[GEM_ROOT.join('spec/support/**/*.rb')].each { |f| require f }
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     # This option will default to `true` in RSpec 4. It makes the `description`

spec/support/examples/async.rb

@@ -0,0 +1,143 @@
+RSpec.shared_examples 'async' do |request_args: -> {}|
+  let(:instance) { described_class.new(token: token, id: id, async: async) }
+  let(:id) { :default_bot }
+  let(:async) { true }
+  let!(:application_job_class) do
+    klass = Class.new do
+      def self.perform_later(*)
+      end
+    end
+    klass.tap { |x| stub_const('ApplicationJob', x) }
+  end
+  after { described_class.default_async_job = nil }
+
+  describe '#async' do
+    subject { ->(*args, &block) { instance.async(*args, &block) } }
+    its(:call) { should eq described_class.default_async_job }
+
+    context 'when async is disabled' do
+      let(:async) { false }
+      its(:call) { should eq false }
+    end
+
+    context 'when using with block' do
+      it 'sets value inside block' do
+        expect do
+          expect do
+            subject.call(false) do
+              expect do
+                subject.call(nil) { expect(subject[]).to eq nil }
+              end.to_not change(&subject).from false
+              raise 'TestError'
+            end
+          end.to raise_error(/TestError/)
+        end.to_not change(instance, :async).from(described_class.default_async_job)
+      end
+    end
+
+    context 'in multi-threaded environment' do
+      it 'changes only in current thread' do
+        thread = nil
+        expect do
+          thread = Thread.new do
+            expect do
+              subject.call(false) do
+                expect(subject[]).to eq false
+              end
+            end.to_not change(instance, :async).from(described_class.default_async_job)
+            sleep 0.2
+          end
+        end.to_not change(instance, :async).from(described_class.default_async_job)
+        thread.join
+      end
+
+      it 'uses default value after block' do
+        thread = Thread.new do
+          subject.call(false) {}
+          expect { sleep 0.2 }.to change(instance, :async).
+            from(described_class.default_async_job).to(nil)
+        end
+        sleep 0.1
+        instance.async = nil
+        thread.join
+      end
+    end
+  end
+
+  describe '#async=' do
+    subject { ->(val = new_val) { instance.async = val } }
+    let(:async) {}
+
+    context 'when true is given' do
+      let(:new_val) { true }
+      it { should change(instance, :async).to described_class.default_async_job }
+    end
+
+    context 'when false is given' do
+      let(:new_val) { false }
+      it { should change(instance, :async).to false }
+    end
+
+    context 'when string is given' do
+      let(:new_val) { 'Telegram::Bot::Client' }
+      it { should change(instance, :async).to Object.const_get(new_val) }
+    end
+
+    context 'in multi-threaded environment' do
+      subject { ->(val = new_val) { Thread.new { instance.async = val }.join } }
+      let(:new_val) { true }
+      it { should change(instance, :async).to described_class.default_async_job }
+    end
+  end
+
+  describe '.default_async_job' do
+    subject { described_class.default_async_job }
+    its(:superclass) { should eq application_job_class }
+    it { should include Telegram::Bot::Async::Job }
+    its(:client_class) { should eq described_class }
+
+    context 'when ApplicationJob is not defined' do
+      let(:application_job_class) {}
+      it { expect { subject }.to raise_error(/Define ApplicationJob/) }
+    end
+  end
+
+  describe '#request' do
+    subject { ->(*args) { instance.request(*(args.empty? ? self.args : args)) } }
+    let(:args, &request_args)
+    let(:result) { double(:result) }
+
+    shared_examples 'enqueues job' do
+      it 'enqueues job' do
+        expect(instance).to_not receive(:http_request)
+        expect(described_class).to receive(:prepare_async_args).with(*args) { args }
+        expect(instance.async).to receive(:perform_later).with(id.to_s, *args) { result }
+        expect(subject.call).to eq result
+      end
+    end
+
+    include_examples 'enqueues job'
+
+    context 'with custom job class' do
+      let(:async) { double(:job_class) }
+      include_examples 'enqueues job'
+    end
+
+    context 'when id is not set' do
+      let(:id) {}
+      it { should raise_error(/Can not enqueue/) }
+    end
+
+    context 'when async is disabled' do
+      let(:async) { false }
+      let(:result) { double(status: 200, body: '{"test":"ok"}') }
+      let(:args, &request_args)
+
+      it 'performs request immediately' do
+        expect(instance).to receive(:request).with(*args).and_call_original
+        expect(instance).to receive(:http_request) { result }
+        expect(subject[]).to eq 'test' => 'ok'
+      end
+    end
+  end
+end

spec/support/examples/initializers.rb

@@ -0,0 +1,65 @@
+RSpec.shared_examples 'initializers' do |config_method = :bots|
+  describe '.wrap' do
+    subject { described_class.wrap(input, **options) }
+    let(:options) { {} }
+    let(:result) { double(:result) }
+    let(:username) { 'username' }
+
+    context 'when input is a string' do
+      let(:input) { token }
+
+      it 'treats string as token' do
+        expect(described_class).to receive(:new).with(token, {}) { result }
+        should eq result
+      end
+
+      context 'and additional options are given' do
+        let(:options) { {id: :test} }
+
+        it 'passes them to initializer' do
+          expect(described_class).to receive(:new).with(input, **options) { result }
+          should eq result
+        end
+      end
+    end
+
+    context 'when input is a hash' do
+      let(:input) { {token: token, 'username' => username, other: :options} }
+
+      it 'passes it with symbolized keys' do
+        expect(described_class).to receive(:new).with(**input.symbolize_keys) { result }
+        should eq result
+      end
+
+      context 'and additional options are given' do
+        let(:options) { {id: :test} }
+
+        it 'passes them to initializer' do
+          expect(described_class).to receive(:new).
+            with(**input.symbolize_keys, **options) { result }
+          should eq result
+        end
+      end
+    end
+
+    context 'when input is an instance of described_class' do
+      let!(:input) { instance }
+
+      it 'returns input' do
+        expect(described_class).to_not receive(:new)
+        should eq input
+      end
+    end
+
+    context 'when input is a Symbol' do
+      let(:input) { :client_1 }
+      before { allow(Telegram).to receive(config_method) { {client_1: instance} } }
+      it { should eq Telegram.send(config_method)[:client_1] }
+
+      context 'and there is no such bot' do
+        let(:input) { :invalid }
+        it { expect { subject }.to raise_error(/not configured/) }
+      end
+    end
+  end
+end

spec/telegram/bot/async_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe Telegram::Bot::Async::Job do
+  let(:job_class) do
+    described_class = self.described_class
+    client_class = self.client_class
+    Class.new do
+      include described_class
+      self.client_class = client_class
+    end
+  end
+  let(:client_class) { Telegram::Bot::Client }
+  let(:instance) { job_class.new }
+
+  describe '#perform' do
+    subject { instance.perform(id, *args) }
+    let(:id) { 'bot_id' }
+    let(:args) { [double(:action), {body: :content}] }
+    let(:client) { Telegram::Bot::Client.new(async: custom_job_class) }
+    let(:custom_job_class) { Class.new }
+    let(:result) { double(status: 200, body: '{"test":"ok"}') }
+
+    it 'finds client and performs request' do
+      expect(client_class).to receive(:wrap).with(id.to_sym) { client }
+      expect(client).to receive(:request).with(*args).and_call_original
+      expect(client).to receive(:http_request) { result }
+      should eq 'test' => 'ok'
+    end
+  end
+end

spec/telegram/bot/botan/client_helpers_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe Telegram::Bot::Client do
+  let(:instance) { described_class.new(*client_args) }
+  let(:token) { 'token' }
+  let(:botan_token) { double(:botan_token) }
+  let(:client_id) { 'client_id' }
+  let(:client_args) { [token] }
+
+  describe '#botan' do
+    subject { instance.botan }
+    it { should eq nil }
+
+    context 'when botan token is set' do
+      let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_token] }
+      it { should be_instance_of Telegram::Bot::Botan }
+      its(:token) { should eq botan_token }
+      its(:id) { should eq client_id }
+
+      it 'doesnt inherit async from client' do
+        expect(instance.async).to be
+        expect(subject.async).to_not be
+      end
+    end
+
+    context 'when botan is configured with hash' do
+      let(:client_args) { [token, id: client_id, async: Class.new, botan: botan_config] }
+      let(:botan_config) { {token: botan_token, async: Class.new} }
+      it { should be_instance_of Telegram::Bot::Botan }
+      its(:token) { should eq botan_token }
+      its(:id) { should eq client_id }
+      its(:async) { should eq botan_config[:async] }
+    end
+  end
+end

spec/telegram/bot/botan/controller_helpers_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe Telegram::Bot::UpdatesController::Botan do
+RSpec.describe Telegram::Bot::Botan::ControllerHelpers do
   include_context 'telegram/bot/updates_controller'
   let(:controller_class) do
     described_class = self.described_class

spec/telegram/bot/botan_spec.rb

@@ -0,0 +1,27 @@
+RSpec.describe Telegram::Bot::Botan do
+  let(:instance) { described_class.new 'token' }
+  let(:token) { 'token' }
+
+  include_examples 'initializers', :botans
+  include_examples 'async', request_args: -> { [double(:method), double(:url)] }
+
+  describe '.new' do
+    subject { described_class.new(*args) }
+
+    context 'when usual args are given' do
+      let(:args) { ['secret'] }
+      its(:token) { should eq args[0] }
+    end
+
+    context 'when options are given' do
+      let(:args) { [token: 'secret'] }
+      its(:token) { should eq args[0][:token] }
+    end
+  end
+
+  describe '.prepare_async_args' do
+    subject { described_class.prepare_async_args(*input) }
+    let(:input) { [:post, :uri, {a: 1, b: :sym, 'd' => 'str'}, 'body'] }
+    it { should eq ['post', 'uri', {a: 1, b: 'sym', 'd' => 'str'}, 'body'] }
+  end
+end

spec/telegram/bot/client_spec.rb

@@ -3,71 +3,8 @@ RSpec.describe Telegram::Bot::Client do
   let(:token) { 'token' }
   let(:botan_token) { double(:botan_token) }
 
-  describe '.wrap' do
-    subject { described_class.wrap(input) }
-    let(:result) { double(:result) }
-    let(:username) { 'username' }
-
-    context 'when input is a string' do
-      let(:input) { token }
-
-      it 'treats string as token' do
-        expect(described_class).to receive(:new).with(token) { result }
-        should eq result
-      end
-    end
-
-    context 'when input is a hash' do
-      let(:input) { {token: token, username: username, ignore: :ignore} }
-
-      it 'extracts token & username' do
-        expect(described_class).to receive(:new).
-          with(token, username, botan: nil) { result }
-        should eq result
-      end
-
-      context 'when `botan` is given' do
-        let(:input) { super().merge(botan: botan_token) }
-
-        it 'passes it to initializer' do
-          expect(described_class).to receive(:new).
-            with(token, username, botan: botan_token) { result }
-          should eq result
-        end
-      end
-    end
-
-    context 'when input is an instance of described_class' do
-      let!(:input) { instance }
-
-      it 'returns input' do
-        expect(described_class).to_not receive(:new)
-        should eq input
-      end
-    end
-
-    context 'when input is a Symbol' do
-      let(:input) { :bot_1 }
-      before { allow(Telegram).to receive(:bots) { {bot_1: instance} } }
-      it { should eq Telegram.bots[:bot_1] }
-
-      context 'and there is no such bot' do
-        let(:input) { :invalid }
-        it { expect { subject }.to raise_error(/not configured/) }
-      end
-    end
-
-    context 'when input is an array' do
-      let!(:input) { ['other_token', instance, token: token, username: username] }
-      let(:result_2) { double(:result_2) }
-
-      it 'calls wrap for every element' do
-        expect(described_class).to receive(:new).with('other_token') { result }
-        expect(described_class).to receive(:new).with(token, username, botan: nil) { result_2 }
-        should eq [result, instance, result_2]
-      end
-    end
-  end
+  include_examples 'initializers'
+  include_examples 'async', request_args: -> { [double(:action), {body: :content}] }
 
   describe '.prepare_body' do
     subject { described_class.prepare_body(input) }
@@ -88,14 +25,27 @@ RSpec.describe Telegram::Bot::Client do
     end
   end
 
-  describe '#botan' do
-    subject { instance.botan }
-    it { should eq nil }
+  describe '.prepare_async_args' do
+    subject { described_class.prepare_async_args(*input) }
+    let(:input) { [:action, a: 1, b: :sym, c: [:other], 'd' => 'str'] }
+    it { should eq ['action', a: 1, b: 'sym', c: '["other"]', 'd' => 'str'] }
+  end
 
-    context 'when botan token is set' do
-      let(:instance) { described_class.new token, botan: botan_token }
-      it { should be_instance_of Telegram::Bot::Botan }
-      its(:token) { should eq botan_token }
+  describe '.new' do
+    subject { described_class.new(*args) }
+
+    context 'when multiple args are given' do
+      let(:args) { %w(secret superbot) }
+      its(:token) { should eq args[0] }
+      its(:username) { should eq args[1] }
+      its(:base_uri) { should include args[0] }
+    end
+
+    context 'when hash is given' do
+      let(:args) { [token: 'secret', username: 'superbot'] }
+      its(:token) { should eq args[0][:token] }
+      its(:username) { should eq args[0][:username] }
+      its(:base_uri) { should include args[0][:token] }
     end
   end
 end

spec/telegram/bot/client_stub_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Telegram::Bot::ClientStub do
   describe '#stub_all!' do
     let(:client) { Telegram::Bot::Client.new('token', 'bot_name') }
-    let(:clients) { Telegram::Bot::Client.wrap(['token', token: 'token2']) }
+    let(:clients) { ['token', token: 'token2'].map(&Telegram::Bot::Client.method(:wrap)) }
 
     shared_examples 'constructors' do |expected_class|
       it 'makes Client.new return ClientStub' do
@@ -9,7 +9,7 @@ RSpec.describe Telegram::Bot::ClientStub do
         expect(client.username).to eq 'bot_name'
       end
 
-      it 'makes Client.wrap raturn ClientStub' do
+      it 'makes Client.wrap return ClientStub' do
         expect(clients).to contain_exactly instance_of(expected_class),
           instance_of(expected_class)
       end
@@ -35,4 +35,19 @@ RSpec.describe Telegram::Bot::ClientStub do
       include_examples 'constructors', Telegram::Bot::Client
     end
   end
+
+  describe '#new' do
+    subject { described_class.new(*args) }
+
+    context 'when only username is given' do
+      let(:args) { 'superbot' }
+      its(:username) { should eq args }
+    end
+
+    context 'when username and token are given' do
+      let(:args) { %w(token superbot) }
+      its(:token) { should eq nil }
+      its(:username) { should eq args[1] }
+    end
+  end
 end

spec/telegram/bot/config_methods_spec.rb

@@ -0,0 +1,94 @@
+RSpec.describe Telegram::Bot::ConfigMethods do
+  let(:registry) do
+    Object.new.tap do |x|
+      x.extend described_class
+      x.bots_config = config
+    end
+  end
+  let(:config) do
+    {
+      default: 'default_token',
+      chat: {
+        token: 'chat_token',
+        username: 'Chat',
+        botan: 'chat_botan_token',
+      },
+      other_chat: {
+        'token' => 'other_chat_token',
+        'username' => 'OtherChat',
+        'botan' => 'other_chat_botan_token',
+      },
+    }
+  end
+
+  describe '#bot' do
+    subject { registry.bot }
+    it { should eq registry.bots[:default] }
+  end
+
+  describe '#bots' do
+    context 'configured by token' do
+      subject { registry.bots[:default] }
+      its(:id) { should eq :default }
+      its(:token) { should eq config[:default] }
+    end
+
+    context 'configured by hash' do
+      subject { registry.bots[:chat] }
+      its(:id) { should eq :chat }
+      its(:token) { should eq config[:chat][:token] }
+      its(:username) { should eq config[:chat][:username] }
+      its('botan.token') { should eq config[:chat][:botan] }
+    end
+
+    context 'configured by hash with stringified keys' do
+      subject { registry.bots[:other_chat] }
+      its(:id) { should eq :other_chat }
+      its(:token) { should eq config[:other_chat]['token'] }
+      its(:username) { should eq config[:other_chat]['username'] }
+      its('botan.token') { should eq config[:other_chat]['botan'] }
+    end
+  end
+
+  describe '#botans' do
+    subject { registry.botans }
+    it do
+      should eq(
+        default: nil,
+        chat: registry.bots[:chat].botan,
+        other_chat: registry.bots[:other_chat].botan,
+      )
+    end
+  end
+
+  describe '#bots_config' do
+    subject { registry.bots_config }
+    it { should eq config }
+
+    context 'when not configured' do
+      let(:registry) { Object.new.tap { |x| x.extend described_class } }
+      it { should eq({}) }
+
+      context 'in rails environment' do
+        before { stub_const('Rails', double(application: double(secrets: secrets))) }
+        let(:secrets) { {} }
+        it { should eq({}) }
+
+        context 'when there is telegram section in secrets' do
+          let(:secrets) { {telegram: config.stringify_keys} }
+          let(:config) do
+            {
+              bot: double(:bot_config),
+              bots: {
+                chat: double(:chat_config),
+                other_chat: double(:other_chat_config),
+              },
+            }
+          end
+          it { should include default: config[:bot] }
+          it { should include config[:bots] }
+        end
+      end
+    end
+  end
+end