ably-rest 1.0.5 → 1.1.3

data/lib/submodules/ably-ruby/spec/unit/models/error_info_spec.rb

@@ -4,15 +4,63 @@ require 'shared/model_behaviour'
 describe Ably::Models::ErrorInfo do
   subject { Ably::Models::ErrorInfo }
 
-  it_behaves_like 'a model', with_simple_attributes: %w(code status_code message) do
-    let(:model_args) { [] }
+  context '#TI1, #TI4' do
+    it_behaves_like 'a model', with_simple_attributes: %w(code status_code href message) do
+      let(:model_args) { [] }
+    end
   end
 
-  context '#status' do
+  context '#status #TI1, #TI2' do
     subject { Ably::Models::ErrorInfo.new('statusCode' => 401) }
     it 'is an alias for #status_code' do
       expect(subject.status).to eql(subject.status_code)
       expect(subject.status).to eql(401)
     end
   end
+
+  context 'log entries container help link #TI5' do
+    context 'without an error code' do
+      subject { Ably::Models::ErrorInfo.new('statusCode' => 401) }
+
+      it 'does not include the help URL' do
+        expect(subject.to_s.scan(/help\.ably\.io/)).to be_empty
+      end
+    end
+
+    context 'with a specified error code' do
+      subject { Ably::Models::ErrorInfo.new('code' => 44444) }
+
+      it 'includes https://help.ably.io/error/[CODE] in the stringified object' do
+        expect(subject.to_s).to include('https://help.ably.io/error/44444')
+      end
+    end
+
+    context 'with an error code and an href attribute' do
+      subject { Ably::Models::ErrorInfo.new('code' => 44444, 'href' => 'http://foo.bar.com/') }
+
+      it 'includes the specified href in the stringified object' do
+        expect(subject.to_s).to include('http://foo.bar.com/')
+        expect(subject.to_s).to_not include('https://help.ably.io/error/44444')
+      end
+    end
+
+    context 'with an error code and a message with the same error URL' do
+      subject { Ably::Models::ErrorInfo.new('message' => 'error https://help.ably.io/error/44444', 'code' => 44444) }
+
+      it 'includes the specified error URL only once in the stringified object' do
+        expect(subject.to_s.scan(/help.ably.io/).length).to eql(1)
+      end
+    end
+
+    context 'with an error code and a message with a different error URL' do
+      subject { Ably::Models::ErrorInfo.new('message' => 'error https://help.ably.io/error/123123', 'code' => 44444) }
+
+      it 'includes the specified error URL from the message and the error code URL in the stringified object' do
+        puts subject.to_s
+        expect(subject.to_s.scan(/help.ably.io/).length).to eql(2)
+        expect(subject.to_s.scan(%r{error/123123}).length).to eql(1)
+        expect(subject.to_s.scan(%r{error/44444}).length).to eql(1)
+      end
+    end
+  end
 end

data/lib/submodules/ably-ruby/spec/unit/models/message_spec.rb

@@ -12,8 +12,23 @@ describe Ably::Models::Message do
   let(:protocol_message_timestamp) { as_since_epoch(Time.now) }
   let(:protocol_message) { Ably::Models::ProtocolMessage.new(action: 1, timestamp: protocol_message_timestamp) }
 
-  it_behaves_like 'a model', with_simple_attributes: %w(id name client_id data encoding) do
-    let(:model_args) { [protocol_message: protocol_message] }
+  context 'serialization of the Message object (#RSL1j)' do
+    it_behaves_like 'a model', with_simple_attributes: %w(id name client_id data encoding) do
+      let(:model_args) { [protocol_message: protocol_message] }
+    end
+  end
+
+  context '#id (#RSL1j)' do
+    let(:id) { random_str }
+    let(:model) { subject.new(id: id) }
+
+    it 'exposes the #id attribute' do
+      expect(model.id).to eql(id)
+    end
+
+    specify '#as_json exposes the #id attribute' do
+      expect(model.as_json['id']).to eql(id)
+    end
   end
 
   context '#timestamp' do

data/lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb

@@ -547,7 +547,7 @@ describe Ably::Models::PresenceMessage do
         clone = model.shallow_clone(id: 'newId', action: 1, timestamp: protocol_message_timestamp + 1000)
         expect(clone.id).to match(/newId/)
         expect(clone.connection_id).to eql(protocol_connection_id)
-        expect(as_since_epoch(clone.timestamp)).to eq(protocol_message_timestamp + 1000)
+        expect(as_since_epoch(clone.timestamp)).to be_within(5).of(protocol_message_timestamp + 1000)
         expect(clone.action).to eq(1)
       end
 

data/lib/submodules/ably-ruby/spec/unit/models/push_channel_subscription_spec.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::PushChannelSubscription do
+  include Ably::Modules::Conversions
+
+  subject { Ably::Models::PushChannelSubscription }
+
+  %w(channel client_id device_id).each do |string_attribute|
+    describe "##{string_attribute} and ##{string_attribute}=" do
+      let(:empty_device_details) do
+        if string_attribute == 'device_id'
+          subject.new(channel: 'default', device_id: 'default')
+        else
+          subject.new(channel: 'default', client_id: 'default')
+        end
+      end
+      let(:new_val) { random_str }
+
+      specify 'setter accepts a string value and getter returns the new value' do
+        expect(empty_device_details.public_send(string_attribute)).to eql('default')
+        empty_device_details.public_send("#{string_attribute}=", new_val)
+        expect(empty_device_details.public_send(string_attribute)).to eql(new_val)
+      end
+
+      specify 'setter accepts nil' do
+        empty_device_details.public_send("#{string_attribute}=", new_val)
+        expect(empty_device_details.public_send(string_attribute)).to eql(new_val)
+        empty_device_details.public_send("#{string_attribute}=", nil)
+        expect(empty_device_details.public_send(string_attribute)).to be_nil
+      end
+
+      specify 'rejects non string or nil values' do
+        expect { empty_device_details.public_send("#{string_attribute}=", {}) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  context 'camelCase constructor attributes' do
+    let(:client_id) { random_str }
+    let(:device_details) { subject.new(channel: 'foo', 'clientId' => client_id ) }
+
+    specify 'are rubyfied and exposed as underscore case' do
+      expect(device_details.client_id).to eql(client_id)
+    end
+
+    specify 'are generated when the object is serialised to JSON' do
+      expect(JSON.parse(device_details.to_json)["clientId"]).to eql(client_id)
+    end
+  end
+
+  describe 'conversion method PushChannelSubscription' do
+    let(:channel) { 'foo' }
+    let(:device_id) { 'bar' }
+
+    it 'accepts a PushChannelSubscription object' do
+      push_channel_sub = PushChannelSubscription(channel: channel, device_id: device_id)
+      expect(push_channel_sub.channel).to eql('foo')
+      expect(push_channel_sub.client_id).to be_nil
+      expect(push_channel_sub.device_id).to eql('bar')
+    end
+  end
+
+  describe '#for_client_id constructor' do
+    context 'with a valid object' do
+      let(:channel) { 'foo' }
+      let(:client_id) { 'bob' }
+
+      it 'accepts a Hash object' do
+        push_channel_sub = Ably::Models::PushChannelSubscription.for_client_id(channel, client_id)
+        expect(push_channel_sub.channel).to eql('foo')
+        expect(push_channel_sub.client_id).to eql('bob')
+        expect(push_channel_sub.device_id).to be_nil
+      end
+    end
+
+    context 'with an invalid valid object' do
+      let(:subscription) { { channel: 'foo' } }
+
+      it 'accepts a Hash object' do
+        expect { Ably::Models::PushChannelSubscription.for_device(subscription) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/modules/async_wrapper_spec.rb

@@ -31,7 +31,7 @@ describe Ably::Modules::AsyncWrapper, :api_private do
   context '#async_wrap blocking block' do
     context 'returns result' do
       let(:block) do
-        proc do
+        lambda do
           sleep sleep_time
           result
         end
@@ -104,7 +104,7 @@ describe Ably::Modules::AsyncWrapper, :api_private do
 
     context 'raises an Exception' do
       let(:block) do
-        proc do
+        lambda do
           sleep sleep_time
           raise RuntimeError, 'Intentional'
         end

data/lib/submodules/ably-ruby/spec/unit/modules/enum_spec.rb

@@ -53,7 +53,7 @@ describe Ably::Modules::Enum, :api_private do
     end
 
     it 'allows different type comparison 2' do
-      skip 'Unless we monkeypath Symbols, the == operator is never invoked'
+      skip 'Unless we monkeypatch Symbols, the == operator is never invoked'
       expect([:value_zero].include?(subject.ValueZero)).to eql(true)
     end
 

data/lib/submodules/ably-ruby/spec/unit/modules/event_emitter_spec.rb

@@ -38,7 +38,7 @@ describe Ably::Modules::EventEmitter do
 
     context 'with coercion', :api_private do
       let(:options) do
-        { coerce_into: Proc.new { |event| String(event) } }
+        { coerce_into: lambda { |event| String(event) } }
       end
 
       it 'calls the provided proc to coerce the event name' do
@@ -244,7 +244,7 @@ describe Ably::Modules::EventEmitter do
   end
 
   context '#off' do
-    let(:callback) { Proc.new { |msg| obj.received_message msg } }
+    let(:callback) { lambda { |msg| obj.received_message msg } }
 
     context 'with event specified in on handler' do
       before do
@@ -356,7 +356,7 @@ describe Ably::Modules::EventEmitter do
   end
 
   context '#unsafe_off' do
-    let(:callback) { Proc.new { |msg| obj.received_message msg } }
+    let(:callback) { lambda { |msg| obj.received_message msg } }
 
     context 'with unsafe_on subscribers' do
       before do

data/lib/submodules/ably-ruby/spec/unit/modules/state_emitter_spec.rb

@@ -85,7 +85,7 @@ describe Ably::Modules::StateEmitter do
     context 'without :else option block' do
       let(:block_calls) { [] }
       let(:block) do
-        proc do
+        lambda do
           block_calls << Time.now
         end
       end
@@ -116,7 +116,7 @@ describe Ably::Modules::StateEmitter do
     context 'with an array of targets' do
       let(:block_calls) { [] }
       let(:block) do
-        proc do
+        lambda do
           block_calls << Time.now
         end
       end
@@ -158,14 +158,14 @@ describe Ably::Modules::StateEmitter do
     context 'with :else option block', :api_private do
       let(:success_calls) { [] }
       let(:success_block) do
-        proc do
+        lambda do
           success_calls << Time.now
         end
       end
 
       let(:failure_calls) { [] }
       let(:failure_block) do
-        proc do |*args|
+        lambda do |*args|
           failure_calls << args
         end
       end
@@ -244,7 +244,7 @@ describe Ably::Modules::StateEmitter do
       end
 
       specify 'are passed to else blocks' do
-        else_block = proc { |arguments| expect(arguments).to eql(arguments) }
+        else_block = lambda { |arguments| expect(arguments).to eql(arguments) }
         subject.once_or_if(:connected, else: else_block) do
           raise 'Success should not be called'
         end
@@ -254,11 +254,11 @@ describe Ably::Modules::StateEmitter do
 
     context 'with blocks that raise exceptions' do
       let(:success_block) do
-        proc { raise 'Success exception' }
+        lambda { raise 'Success exception' }
       end
 
       let(:failure_block) do
-        proc { raise 'Failure exception' }
+        lambda { raise 'Failure exception' }
       end
 
       let(:target_state) { :connected }
@@ -291,11 +291,11 @@ describe Ably::Modules::StateEmitter do
     let(:target_state) { :connected }
 
     let(:success_block) do
-      proc { raise 'Success exception' }
+      lambda { raise 'Success exception' }
     end
 
     let(:failure_block) do
-      proc { raise 'Failure exception' }
+      lambda { raise 'Failure exception' }
     end
 
     before do
@@ -318,7 +318,7 @@ describe Ably::Modules::StateEmitter do
   context '#once_state_changed', :api_private do
     let(:block_calls) { [] }
     let(:block) do
-      proc do |*args|
+      lambda do |*args|
         block_calls << args
       end
     end

data/lib/submodules/ably-ruby/spec/unit/realtime/channel_spec.rb

@@ -203,7 +203,7 @@ describe Ably::Realtime::Channel do
 
     context '#unsubscribe' do
       let(:callback) do
-        Proc.new { |message| message_history[:received] += 1 }
+        lambda { |message| message_history[:received] += 1 }
       end
 
       before do

data/lib/submodules/ably-ruby/spec/unit/realtime/client_spec.rb

@@ -13,7 +13,7 @@ describe Ably::Realtime::Client do
     let(:client_options) { { key: 'appid.keyuid:keysecret', auto_connect: false } }
 
     it 'passes on the options to the initializer' do
-      rest_client = instance_double('Ably::Rest::Client', auth: instance_double('Ably::Auth'), options: client_options)
+      rest_client = instance_double('Ably::Rest::Client', auth: instance_double('Ably::Auth'), options: client_options, environment: 'production', use_tls?: true, custom_tls_port: nil)
       expect(Ably::Rest::Client).to receive(:new).with(hash_including(client_options)).and_return(rest_client)
       subject
     end
@@ -28,6 +28,18 @@ describe Ably::Realtime::Client do
     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::Realtime::Push)
+    end
+  end
+
   after(:all) do
     sleep 1 # let realtime library shut down any open clients
   end

data/lib/submodules/ably-ruby/spec/unit/realtime/connection_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'shared/protocol_msgbus_behaviour'
 
 describe Ably::Realtime::Connection do
-  let(:client) { instance_double('Ably::Realtime::Client', logger: double('logger').as_null_object) }
+  let(:client) { instance_double('Ably::Realtime::Client', logger: double('logger').as_null_object, recover: nil, endpoint: double('endpoint', host: 'realtime.ably.io')) }
 
   subject do
     Ably::Realtime::Connection.new(client, {}).tap do |connection|
@@ -56,7 +56,7 @@ describe Ably::Realtime::Connection do
     describe '#off_resume' do
       it 'registers a callback' do
         subject.on_resume { callbacks << true }
-        additional_proc = proc { raise 'This should not be called' }
+        additional_proc = lambda { raise 'This should not be called' }
         subject.off_resume(&additional_proc)
         subject.trigger_resumed
         expect(callbacks.count).to eql(1)

data/lib/submodules/ably-ruby/spec/unit/realtime/presence_spec.rb

@@ -98,7 +98,7 @@ describe Ably::Realtime::Presence do
 
     context '#unsubscribe' do
       let(:callback) do
-        Proc.new { |message| message_history[:received] += 1 }
+        lambda { |message| message_history[:received] += 1 }
       end
       before do
         subject.subscribe(enter_action, &callback)

data/lib/submodules/ably-ruby/spec/unit/realtime/push_channel_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Ably::Realtime::Channel::PushChannel do
+  subject { Ably::Realtime::Channel::PushChannel }
+
+  let(:channel_name) { 'unique' }
+  let(:client) { double('client').as_null_object }
+  let(:channel) { Ably::Realtime::Channel.new(client, channel_name) }
+
+  it 'is constructed with a channel' do
+    expect(subject.new(channel)).to be_a(Ably::Realtime::Channel::PushChannel)
+  end
+
+  it 'raises an exception if constructed with an invalid type' do
+    expect { subject.new(Hash.new) }.to raise_error(ArgumentError)
+  end
+
+  it 'exposes the channel as attribute #channel' do
+    expect(subject.new(channel).channel).to eql(channel)
+  end
+
+  it 'is available in the #push attribute of the channel' do
+    expect(channel.push).to be_a(Ably::Realtime::Channel::PushChannel)
+    expect(channel.push.channel).to eql(channel)
+  end
+
+  context 'methods not implemented as push notifications' do
+    subject { Ably::Realtime::Channel::PushChannel.new(channel) }
+
+    %w(subscribe_device subscribe_client_id unsubscribe_device unsubscribe_client_id get_subscriptions).each do |method_name|
+      specify "##{method_name} raises an unsupported exception" do
+        expect { subject.public_send(method_name, 'foo') }.to raise_error(Ably::Exceptions::PushNotificationsNotSupported)
+      end
+    end
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb

@@ -2,7 +2,14 @@
 require 'spec_helper'
 
 describe Ably::Rest::Channel do
-  let(:client)       { instance_double('Ably::Rest::Client', encoders: [], post: instance_double('Faraday::Response', status: 201)) }
+  let(:client) do
+    instance_double(
+      'Ably::Rest::Client',
+      encoders: [],
+      post: instance_double('Faraday::Response', status: 201),
+      idempotent_rest_publishing: false,
+    )
+  end
   let(:channel_name) { 'unique' }
 
   subject { Ably::Rest::Channel.new(client, channel_name) }
@@ -22,6 +29,19 @@ describe Ably::Rest::Channel do
       end
     end
 
+    context 'as frozen UTF_8 string' do
+      let(:channel_name) { 'unique'.freeze }
+      let(:encoding) { Encoding::UTF_8 }
+
+      it 'is permitted' do
+        expect(subject.name).to eql(channel_name)
+      end
+
+      it 'remains as UTF-8' do
+        expect(subject.name.encoding).to eql(encoding)
+      end
+    end
+
     context 'as SHIFT_JIS string' do
       let(:encoding) { Encoding::SHIFT_JIS }
 
@@ -74,6 +94,15 @@ describe Ably::Rest::Channel do
       end
     end
 
+    context 'as frozen UTF_8 string' do
+      let(:encoded_value) { 'unique'.freeze }
+      let(:encoding) { Encoding::UTF_8 }
+
+      it 'is permitted' do
+        expect(subject.publish(encoded_value, 'data')).to eql(true)
+      end
+    end
+
     context 'as SHIFT_JIS string' do
       let(:encoding) { Encoding::SHIFT_JIS }