client_spec.rb

# encoding: utf-8
require 'spec_helper'
require 'shared/client_initializer_behaviour'

describe Ably::Rest::Client do
  subject do
    Ably::Rest::Client.new(client_options)
  end

  it_behaves_like 'a client initializer'

  context 'initializer options' do
    context 'TLS' do
      context 'disabled' do
        let(:client_options) { { key: 'appid.keyuid:keysecret', tls: false } }

        it 'fails for any operation with basic auth and attempting to send an API key over a non-secure connection (#RSA1)' do
          expect { subject.channel('a').publish('event', 'message') }.to raise_error(Ably::Exceptions::InsecureRequest)
        end
      end
    end

    context 'fallback_retry_timeout (#RSC15f)' do
      context 'default' do
        let(:client_options) { { key: 'appid.keyuid:keysecret' } }

        it 'is set to 10 minutes' do
          expect(subject.options.fetch(:fallback_retry_timeout)).to eql(10 * 60)
        end
      end

      context 'when provided' do
        let(:client_options) { { key: 'appid.keyuid:keysecret', fallback_retry_timeout: 30 } }

        it 'configures a new timeout' do
          expect(subject.options.fetch(:fallback_retry_timeout)).to eql(30)
        end
      end
    end

    context 'use agent' do
      context 'set agent to non-default value' do
        context 'default agent' do
          let(:client_options) { { key: 'appid.keyuid:keysecret' } }

          it 'should return default ably agent' do
            expect(subject.agent).to eq(Ably::AGENT)
          end
        end

        context 'custom agent' do
          let(:client_options) { { key: 'appid.keyuid:keysecret', agent: 'example-gem/1.1.4 ably-ruby/1.1.5 ruby/3.0.0' } }

          it 'should overwrite client.agent' do
            expect(subject.agent).to eq('example-gem/1.1.4 ably-ruby/1.1.5 ruby/3.0.0')
          end
        end
      end
    end

    context ':use_token_auth' do
      context 'set to false' do
        context 'with a key and :tls => false' do
          let(:client_options) { { use_token_auth: false, key: 'appid.keyuid:keysecret', tls: false } }

          it 'fails for any operation with basic auth and attempting to send an API key over a non-secure connection' do
            expect { subject.channel('a').publish('event', 'message') }.to raise_error(Ably::Exceptions::InsecureRequest)
          end
        end

        context 'without a key' do
          let(:client_options) { { use_token_auth: false } }

          it 'fails as a key is required if not using token auth' do
            expect { subject.channel('a').publish('event', 'message') }.to raise_error(ArgumentError)
          end
        end
      end

      context 'set to true' do
        context 'without a key or token' do
          let(:client_options) { { use_token_auth: true, key: true } }

          it 'fails as a key is required to issue tokens' do
            expect { subject.channel('a').publish('event', 'message') }.to raise_error(ArgumentError)
          end
        end
      end
    end

    context 'max_message_size' do
      context 'is not present' do
        let(:client_options) { { key: 'appid.keyuid:keysecret' } }

        it 'should return default 65536 (#TO3l8)' do
          expect(subject.max_message_size).to eq(Ably::Rest::Client::MAX_MESSAGE_SIZE)
        end
      end

      context 'is nil' do
        let(:client_options) { { key: 'appid.keyuid:keysecret', max_message_size: nil } }

        it 'should return default 65536 (#TO3l8)' do
          expect(Ably::Rest::Client::MAX_MESSAGE_SIZE).to eq(65536)
          expect(subject.max_message_size).to eq(Ably::Rest::Client::MAX_MESSAGE_SIZE)
        end
      end

      context 'is customized 131072 bytes' do
        let(:client_options) { { key: 'appid.keyuid:keysecret', max_message_size: 131072 } }

        it 'should return 131072' do
          expect(subject.max_message_size).to eq(131072)
        end
      end
    end
  end

  context 'request_id generation' do
    let(:client_options) { { key: 'appid.keyuid:keysecret', add_request_ids: true } }
    it 'includes request_id in URL' do
      expect(subject.add_request_ids).to eql(true)
    end
  end

  context 'push' do
    let(:client_options) { { key: 'appid.keyuid:keysecret' } }

    specify '#device is not supported and raises an exception' do
      expect { subject.device }.to raise_error Ably::Exceptions::PushNotificationsNotSupported
    end

    specify '#push returns a Push object' do
      expect(subject.push).to be_a(Ably::Rest::Push)
    end
  end
end