ably-rest 0.8.1 → 0.8.2

data/lib/submodules/ably-ruby/lib/ably/realtime/presence/members_map.rb

@@ -26,10 +26,6 @@ module Ably::Realtime
       )
       include Ably::Modules::StateEmitter
 
-      # Number of absent members to cache internally whilst channel is in sync.
-      # Cache is unlimited until initial sync is complete ensuring users who have left are never reported as present.
-      MAX_ABSENT_MEMBER_CACHE = 100
-
       def initialize(presence)
         @presence = presence
 
@@ -66,14 +62,14 @@ module Ably::Realtime
       # @param [Hash,String] options an options Hash to filter members
       # @option options [String] :client_id      optional client_id for the member
       # @option options [String] :connection_id  optional connection_id for the member
-      # @option options [String] :wait_for_sync  defaults to true, if false the get method returns the current list of members and does not wait for the presence sync to complete
+      # @option options [String] :wait_for_sync  defaults to false, if true the get method waits for the initial presence sync following channel attachment to complete before returning the members present
       #
       # @yield [Array<Ably::Models::PresenceMessage>] array of present members
       #
       # @return [Ably::Util::SafeDeferrable] Deferrable that supports both success (callback) and failure (errback) callbacks
       #
       def get(options = {}, &block)
-        wait_for_sync = options.fetch(:wait_for_sync, true)
+        wait_for_sync = options.fetch(:wait_for_sync, false)
         deferrable    = Ably::Util::SafeDeferrable.new(logger)
 
         result_block = proc do
@@ -164,6 +160,10 @@ module Ably::Realtime
         once(:in_sync, :failed) do
           connection.off_resume &resume_sync_proc
         end
+
+        once(:in_sync) do
+          clean_up_absent_members
+        end
       end
 
       # Trigger a manual SYNC operation to resume member synchronisation from last known cursor position
@@ -198,8 +198,6 @@ module Ably::Realtime
         else
           Ably::Exceptions::ProtocolError.new("Protocol error, unknown presence action #{presence_message.action}", 400, 80013)
         end
-
-        clean_up_absent_members
       end
 
       def ensure_presence_message_is_valid(presence_message)
@@ -207,7 +205,7 @@ module Ably::Realtime
 
         error = Ably::Exceptions::ProtocolError.new("Protocol error, presence message is missing connectionId", 400, 80013)
         logger.error "PresenceMap: On channel '#{channel.name}' error: #{error}"
-        channel.trigger :error, error
+        channel.emit :error, error
       end
 
       # If the message received is older than the last known event for presence
@@ -234,8 +232,14 @@ module Ably::Realtime
 
       def remove_presence_member(presence_message)
         logger.debug "#{self.class.name}: Member '#{presence_message.member_key}' removed.\n#{presence_message.to_json}"
-        members[presence_message.member_key] = { present: false, message: presence_message }
-        absent_member_cleanup_queue << presence_message.member_key
+
+        if in_sync?
+          members.delete presence_message.member_key
+        else
+          members[presence_message.member_key] = { present: false, message: presence_message }
+          absent_member_cleanup_queue << presence_message.member_key
+        end
+
         presence.emit_message presence_message.action, presence_message
       end
 
@@ -256,8 +260,7 @@ module Ably::Realtime
       end
 
       def clean_up_absent_members
-        return unless sync_complete?
-        members.delete absent_member_cleanup_queue.shift until absent_member_cleanup_queue.count <= MAX_ABSENT_MEMBER_CACHE
+        members.delete absent_member_cleanup_queue.shift
       end
     end
   end

data/lib/submodules/ably-ruby/lib/ably/rest/channel.rb

@@ -37,6 +37,7 @@ module Ably
       # @return [Boolean] true if the message was published, otherwise false
       def publish(name, data)
         ensure_utf_8 :name, name
+        ensure_supported_payload data
 
         payload = {
           name: name,
@@ -60,7 +61,7 @@ module Ably
       # @option options [Symbol]       :direction  +:forwards+ or +:backwards+, defaults to +:backwards+
       # @option options [Integer]      :limit      Maximum number of messages to retrieve up to 1,000, defaults to 100
       #
-      # @return [Ably::Models::PaginatedResource<Ably::Models::Message>] First {Ably::Models::PaginatedResource page} of {Ably::Models::Message} objects accessible with {Ably::Models::PaginatedResource#items #items}.
+      # @return [Ably::Models::PaginatedResult<Ably::Models::Message>] First {Ably::Models::PaginatedResult page} of {Ably::Models::Message} objects accessible with {Ably::Models::PaginatedResult#items #items}.
       #
       def history(options = {})
         url = "#{base_path}/messages"
@@ -78,7 +79,7 @@ module Ably
 
         response = client.get(url, options)
 
-        Ably::Models::PaginatedResource.new(response, url, client, paginated_options) do |message|
+        Ably::Models::PaginatedResult.new(response, url, client, paginated_options) do |message|
           message.tap do |message|
             decode_message message
           end

data/lib/submodules/ably-ruby/lib/ably/rest/client.rb

@@ -150,7 +150,7 @@ module Ably
       # @option options [Integer]      :limit      Maximum number of messages to retrieve up to 1,000, defaults to 100
       # @option options [Symbol]       :unit       `:minute`, `:hour`, `:day` or `:month`. Defaults to `:minute`
       #
-      # @return [Ably::Models::PaginatedResource<Ably::Models::Stats>] An Array of Stats
+      # @return [Ably::Models::PaginatedResult<Ably::Models::Stats>] An Array of Stats
       #
       def stats(options = {})
         options = {
@@ -168,7 +168,7 @@ module Ably
         url = '/stats'
         response = get(url, options)
 
-        Ably::Models::PaginatedResource.new(response, url, self, paginated_options)
+        Ably::Models::PaginatedResult.new(response, url, self, paginated_options)
       end
 
       # Retrieve the Ably service time

data/lib/submodules/ably-ruby/lib/ably/rest/presence.rb

@@ -25,7 +25,7 @@ module Ably
       # @param [Hash] options the options for the set of members present
       # @option options [Integer]      :limit      Maximum number of members to retrieve up to 1,000, defaults to 100
       #
-      # @return [Ably::Models::PaginatedResource<Ably::Models::PresenceMessage>] First {Ably::Models::PaginatedResource page} of {Ably::Models::PresenceMessage} objects accessible with {Ably::Models::PaginatedResource#items #items}.
+      # @return [Ably::Models::PaginatedResult<Ably::Models::PresenceMessage>] First {Ably::Models::PaginatedResult page} of {Ably::Models::PresenceMessage} objects accessible with {Ably::Models::PaginatedResult#items #items}.
       #
       def get(options = {})
         options = options = {
@@ -39,7 +39,7 @@ module Ably
 
         response = client.get(base_path, options)
 
-        Ably::Models::PaginatedResource.new(response, base_path, client, paginated_options) do |presence_message|
+        Ably::Models::PaginatedResult.new(response, base_path, client, paginated_options) do |presence_message|
           presence_message.tap do |presence_message|
             decode_message presence_message
           end
@@ -54,7 +54,7 @@ module Ably
       # @option options [Symbol]       :direction  +:forwards+ or +:backwards+, defaults to +:backwards+
       # @option options [Integer]      :limit      Maximum number of messages to retrieve up to 1,000, defaults to 100
       #
-      # @return [Ably::Models::PaginatedResource<Ably::Models::PresenceMessage>] First {Ably::Models::PaginatedResource page} of {Ably::Models::PresenceMessage} objects accessible with {Ably::Models::PaginatedResource#items #items}.
+      # @return [Ably::Models::PaginatedResult<Ably::Models::PresenceMessage>] First {Ably::Models::PaginatedResult page} of {Ably::Models::PresenceMessage} objects accessible with {Ably::Models::PaginatedResult#items #items}.
       #
       def history(options = {})
         url = "#{base_path}/history"
@@ -72,7 +72,7 @@ module Ably
 
         response = client.get(url, options)
 
-        Ably::Models::PaginatedResource.new(response, url, client, paginated_options) do |presence_message|
+        Ably::Models::PaginatedResult.new(response, url, client, paginated_options) do |presence_message|
           presence_message.tap do |presence_message|
             decode_message presence_message
           end

data/lib/submodules/ably-ruby/lib/ably/util/pub_sub.rb

@@ -37,7 +37,7 @@ module Ably::Util
         configure_event_emitter options
 
         alias_method :subscribe, :unsafe_on
-        alias_method :publish, :trigger
+        alias_method :publish, :emit
         alias_method :unsubscribe, :off
       end
     end

data/lib/submodules/ably-ruby/lib/ably/util/safe_deferrable.rb

@@ -1,6 +1,6 @@
 module Ably::Util
   # SafeDeferrable class provides a Deferrable that is safe to use for for public interfaces
-  # of this client library.  Any exceptions raised in the success or failure callbacks is
+  # of this client library.  Any exceptions raised in the success or failure callbacks are
   # caught and logged to the provided logger.
   #
   # An exception in a callback provided by a developer should not break this client library

data/lib/submodules/ably-ruby/lib/ably/version.rb

@@ -1,3 +1,3 @@
 module Ably
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

data/lib/submodules/ably-ruby/spec/acceptance/realtime/channel_history_spec.rb

@@ -24,7 +24,7 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
         expect(history).to be_a(Ably::Util::SafeDeferrable)
         history.callback do |page|
           expect(page.items.count).to eql(1)
-          expect(page).to be_a(Ably::Models::PaginatedResource)
+          expect(page).to be_a(Ably::Models::PaginatedResult)
           stop_reactor
         end
       end

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

@@ -13,9 +13,9 @@ describe Ably::Realtime::Channel, :event_machine do
     let(:messages)     { [] }
 
     describe 'initialization' do
-      context 'with :connect_automatically option set to false on connection' do
+      context 'with :auto_connect option set to false on connection' do
         let(:client) do
-          Ably::Realtime::Client.new(default_options.merge(connect_automatically: false))
+          Ably::Realtime::Client.new(default_options.merge(auto_connect: false))
         end
 
         it 'remains initialized when accessing a channel' do
@@ -32,16 +32,6 @@ describe Ably::Realtime::Channel, :event_machine do
             stop_reactor
           end
         end
-
-        it 'opens a connection implicitly when accessing #presence' do
-          client.channel('test').tap do |channel|
-            channel.on(:attached) do
-              expect(client.connection).to be_connected
-              stop_reactor
-            end
-            channel.presence
-          end
-        end
       end
     end
 
@@ -162,7 +152,7 @@ describe Ably::Realtime::Channel, :event_machine do
         end
         let(:restricted_channel) { restricted_client.channel("cannot_subscribe") }
 
-        it 'triggers failed event' do
+        it 'emits failed event' do
           restricted_channel.attach
           restricted_channel.on(:failed) do |error|
             expect(restricted_channel.state).to eq(:failed)
@@ -179,7 +169,7 @@ describe Ably::Realtime::Channel, :event_machine do
           end
         end
 
-        it 'triggers an error event' do
+        it 'emits an error event' do
           restricted_channel.attach
           restricted_channel.on(:error) do |error|
             expect(restricted_channel.state).to eq(:failed)
@@ -458,7 +448,7 @@ describe Ably::Realtime::Channel, :event_machine do
             end
           end
 
-          it 'triggers an error event on the channel' do
+          it 'emits an error event on the channel' do
             channel.attach do
               channel.on(:error) do |error|
                 expect(error).to eql(connection_error)

data/lib/submodules/ably-ruby/spec/acceptance/realtime/connection_failures_spec.rb

@@ -319,7 +319,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
                         disconnected: { retry_every: retry_every, max_time_in_state: 60 })
           end
 
-          it "retries every CONNECT_RETRY_CONFIG[:disconnected][:retry_every] seconds" do
+          it "retries every #{Ably::Realtime::Connection::ConnectionManager::CONNECT_RETRY_CONFIG[:disconnected][:retry_every]} seconds" do
             fail_if_suspended_or_failed
 
             stubbed_first_attempt = false
@@ -415,7 +415,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
           end
         end
 
-        it 'triggers the resume callback', api_private: true do
+        it 'executes the resume callback', api_private: true do
           channel.attach do
             connection.transport.close_connection_after_writing
             connection.on_resume do

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

@@ -27,9 +27,9 @@ describe Ably::Realtime::Connection, :event_machine do
         end
       end
 
-      context 'with :connect_automatically option set to false' do
+      context 'with :auto_connect option set to false' do
         let(:client) do
-          Ably::Realtime::Client.new(default_options.merge(connect_automatically: false))
+          Ably::Realtime::Client.new(default_options.merge(auto_connect: false))
         end
 
         it 'does not connect automatically' do
@@ -201,10 +201,10 @@ describe Ably::Realtime::Connection, :event_machine do
 
     context 'initialization state changes' do
       let(:phases) { [:connecting, :connected] }
-      let(:events_triggered) { [] }
+      let(:events_emitted) { [] }
       let(:test_expectation) do
         Proc.new do
-          expect(events_triggered).to eq(phases)
+          expect(events_emitted).to eq(phases)
           stop_reactor
         end
       end
@@ -212,20 +212,20 @@ describe Ably::Realtime::Connection, :event_machine do
       def expect_ordered_phases
         phases.each do |phase|
           connection.on(phase) do
-            events_triggered << phase
-            test_expectation.call if events_triggered.length == phases.length
+            events_emitted << phase
+            test_expectation.call if events_emitted.length == phases.length
           end
         end
       end
 
       context 'with implicit #connect' do
-        it 'are triggered in order' do
+        it 'are emitted in order' do
           expect_ordered_phases
         end
       end
 
       context 'with explicit #connect' do
-        it 'are triggered in order' do
+        it 'are emitted in order' do
           expect_ordered_phases
           connection.connect
         end
@@ -542,10 +542,10 @@ describe Ably::Realtime::Connection, :event_machine do
         let(:states)           { Hash.new }
         let(:client_options)   { default_options.merge(log_level: :none) }
 
-        it 'is composed of connection id and serial that is kept up to date with each message ACK received' do
+        it 'is composed of connection key and serial that is kept up to date with each message ACK received' do
           connection.on(:connected) do
             expected_serial = -1
-            expect(connection.id).to_not be_nil
+            expect(connection.key).to_not be_nil
             expect(connection.serial).to eql(expected_serial)
 
             client.channel('test').attach do |channel|
@@ -556,6 +556,8 @@ describe Ably::Realtime::Connection, :event_machine do
                 channel.publish('event', 'data') do
                   expected_serial += 1 # attach message received
                   expect(connection.serial).to eql(expected_serial)
+
+                  expect(connection.recovery_key).to eql("#{connection.key}:#{connection.serial}")
                   stop_reactor
                 end
               end
@@ -621,7 +623,7 @@ describe Ably::Realtime::Connection, :event_machine do
             end
           end
 
-          it 'does not trigger a resume callback', api_private: true do
+          it 'does not call a resume callback', api_private: true do
             connection.once(:connected) do
               connection.transition_state_machine! :failed
             end
@@ -629,7 +631,7 @@ describe Ably::Realtime::Connection, :event_machine do
             connection.once(:failed) do
               recover_client = Ably::Realtime::Client.new(default_options.merge(recover: client.connection.recovery_key))
               recover_client.connection.on_resume do
-                raise 'Should not trigger resume callback'
+                raise 'Should not call the resume callback'
               end
               recover_client.connection.on(:connected) do
                 EventMachine.add_timer(0.5) { stop_reactor }
@@ -676,7 +678,7 @@ describe Ably::Realtime::Connection, :event_machine do
         context 'with invalid formatted value sent to server' do
           let(:client_options) { default_options.merge(recover: 'not-a-valid-connection-key:1', log_level: :none) }
 
-          it 'triggers a fatal error on the connection object, sets the #error_reason and disconnects' do
+          it 'emits a fatal error on the connection object, sets the #error_reason and disconnects' do
             connection.once(:error) do |error|
               expect(connection.state).to eq(:failed)
               expect(error.message).to match(/Invalid connection key/)
@@ -691,7 +693,7 @@ describe Ably::Realtime::Connection, :event_machine do
         context 'with expired (missing) value sent to server' do
           let(:client_options) { default_options.merge(recover: '0123456789abcdef:0', log_level: :fatal) }
 
-          it 'triggers an error on the connection object, sets the #error_reason, yet will connect anyway' do
+          it 'emits an error on the connection object, sets the #error_reason, yet will connect anyway' do
             connection.once(:error) do |error|
               expect(connection.state).to eq(:connected)
               expect(error.message).to match(/Invalid connection key/i)

data/lib/submodules/ably-ruby/spec/acceptance/realtime/message_spec.rb

@@ -32,6 +32,87 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
       end
     end
 
+    context 'with supported data payload content type' do
+      def publish_and_check_data(data)
+        channel.attach
+        channel.publish 'event', data
+        channel.subscribe do |message|
+          expect(message.data).to eql(data)
+          stop_reactor
+        end
+      end
+
+      context 'JSON Object (Hash)' do
+        let(:data) { { 'Hash' => 'true' } }
+
+        it 'is encoded and decoded to the same hash' do
+          publish_and_check_data data
+        end
+      end
+
+      context 'JSON Array' do
+        let(:data) { [ nil, true, false, 55, 'string', { 'Hash' => true }, ['array'] ] }
+
+        it 'is encoded and decoded to the same Array' do
+          publish_and_check_data data
+        end
+      end
+
+      context 'String' do
+        let(:data) { random_str }
+
+        it 'is encoded and decoded to the same Array' do
+          publish_and_check_data data
+        end
+      end
+
+      context 'Binary' do
+        let(:data) { Base64.encode64(random_str) }
+
+        it 'is encoded and decoded to the same Array' do
+          publish_and_check_data data
+        end
+      end
+    end
+
+    context 'with unsupported data payload content type' do
+      context 'Integer' do
+        let(:data) { 1 }
+
+        it 'is raises an UnsupportedDataTypeError 40011 exception' do
+          expect { channel.publish 'event', data }.to raise_error(Ably::Exceptions::UnsupportedDataTypeError)
+          stop_reactor
+        end
+      end
+
+      context 'Float' do
+        let(:data) { 1.1 }
+
+        it 'is raises an UnsupportedDataTypeError 40011 exception' do
+          expect { channel.publish 'event', data }.to raise_error(Ably::Exceptions::UnsupportedDataTypeError)
+          stop_reactor
+        end
+      end
+
+      context 'Boolean' do
+        let(:data) { true }
+
+        it 'is raises an UnsupportedDataTypeError 40011 exception' do
+          expect { channel.publish 'event', data }.to raise_error(Ably::Exceptions::UnsupportedDataTypeError)
+          stop_reactor
+        end
+      end
+
+      context 'False' do
+        let(:data) { false }
+
+        it 'is raises an UnsupportedDataTypeError 40011 exception' do
+          expect { channel.publish 'event', data }.to raise_error(Ably::Exceptions::UnsupportedDataTypeError)
+          stop_reactor
+        end
+      end
+    end
+
     context 'with ASCII_8BIT message name' do
       let(:message_name) { random_str.encode(Encoding::ASCII_8BIT) }
       it 'is converted into UTF_8' do
@@ -410,7 +491,7 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
           end
         end
 
-        it 'triggers a Cipher error on the channel' do
+        it 'emits a Cipher error on the channel' do
           unencrypted_channel_client2.attach do
             encrypted_channel_client1.publish 'example', payload
             unencrypted_channel_client2.on(:error) do |error|
@@ -441,7 +522,7 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
           end
         end
 
-        it 'triggers a Cipher error on the channel' do
+        it 'emits a Cipher error on the channel' do
           encrypted_channel_client2.attach do
             encrypted_channel_client1.publish 'example', payload
             encrypted_channel_client2.on(:error) do |error|
@@ -464,15 +545,17 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
         let(:payload) { MessagePack.pack({ 'key' => random_str }) }
 
         it 'delivers the message but still encrypted with the cipher details in the #encoding attribute' do
-          encrypted_channel_client1.publish 'example', payload
-          encrypted_channel_client2.subscribe do |message|
-            expect(message.data).to_not eql(payload)
-            expect(message.encoding).to match(/^cipher\+aes-256-cbc/)
-            stop_reactor
+          encrypted_channel_client2.attach do
+            encrypted_channel_client1.publish 'example', payload
+            encrypted_channel_client2.subscribe do |message|
+              expect(message.data).to_not eql(payload)
+              expect(message.encoding).to match(/^cipher\+aes-256-cbc/)
+              stop_reactor
+            end
           end
         end
 
-        it 'triggers a Cipher error on the channel' do
+        it 'emits a Cipher error on the channel' do
           encrypted_channel_client2.attach do
             encrypted_channel_client1.publish 'example', payload
             encrypted_channel_client2.on(:error) do |error|