ably 1.0.7 → 1.1.0

data/lib/ably/rest/push/device_registrations.rb

@@ -0,0 +1,103 @@
+module Ably::Rest
+  class Push
+    # Manage device registrations for push notifications
+    class DeviceRegistrations
+      include Ably::Modules::Conversions
+
+      # @api private
+      attr_reader :client
+
+      # @api private
+      attr_reader :admin
+
+      def initialize(admin)
+        @admin = admin
+        @client = admin.client
+      end
+
+      # Get registered device by device ID
+      #
+      # @param [String, Ably::Models::DeviceDetails] device_id   the device to retrieve
+      #
+      # @return [Ably::Models::DeviceDetails]  Returns {Ably::Models::DeviceDetails} if a match is found else a {Ably::Exceptions::ResourceMissing} is raised
+      #
+      def get(device_id)
+        device_id = device_id.id if device_id.kind_of?(Ably::Models::DeviceDetails)
+        raise ArgumentError, "device_id must be a string or DeviceDetails object" unless device_id.kind_of?(String)
+
+        DeviceDetails(client.get("/push/deviceRegistrations/#{device_id}").body)
+      end
+
+      # List registered devices filtered by optional params
+      #
+      # @param [Hash] params   the filter options for the list registered device request
+      # @option params [String]   :client_id  filter by devices registered to a client identifier. Cannot be used with +device_id+ param
+      # @option params [String]   :device_id  filter by unique device ID. Cannot be used with +client_id+ param
+      # @option params [Integer]  :limit      maximum number of devices to retrieve up to 1,000, defaults to 100
+      #
+      # @return [Ably::Models::PaginatedResult<Ably::Models::DeviceDetails>]  Paginated list of matching {Ably::Models::DeviceDetails}
+      #
+      def list(params = {})
+        params = {} if params.nil?
+        raise ArgumentError, "params must be a Hash" unless params.kind_of?(Hash)
+        raise ArgumentError, "device_id filter cannot be specified alongside a client_id filter. Use one or the other" if params[:client_id] && params[:device_id]
+
+        params = params.clone
+
+        paginated_options = {
+          coerce_into: 'Ably::Models::DeviceDetails',
+          async_blocking_operations: params.delete(:async_blocking_operations),
+        }
+
+        response = client.get('/push/deviceRegistrations', IdiomaticRubyWrapper(params).as_json)
+
+        Ably::Models::PaginatedResult.new(response, '', client, paginated_options)
+      end
+
+      # Save and register device
+      #
+      # @param [Ably::Models::DeviceDetails, Hash]  device   the device details to save
+      #
+      # @return [void]
+      #
+      def save(device)
+        device_details = DeviceDetails(device)
+        raise ArgumentError, "Device ID is required yet is empty" if device_details.id.nil? || device_details == ''
+
+        client.put("/push/deviceRegistrations/#{device_details.id}", device_details.as_json)
+      end
+
+      # Remove device
+      #
+      # @param [String, Ably::Models::DeviceDetails]  device_id  the device to remove
+      #
+      # @return [void]
+      #
+      def remove(device_id)
+        device_id = device_id.id if device_id.kind_of?(Ably::Models::DeviceDetails)
+        raise ArgumentError, "device_id must be a string or DeviceDetails object" unless device_id.kind_of?(String)
+
+        client.delete("/push/deviceRegistrations/#{device_id}", {})
+      end
+
+      # Remove device matching where params
+      #
+      # @param [Hash] params   the filter params for the remove request
+      # @option params [String]   :client_id  remove devices registered to a client identifier. Cannot be used with +device_id+ param
+      # @option params [String]   :device_id  remove device with this unique device ID. Cannot be used with +client_id+ param
+      #
+      # @return [void]
+      #
+      def remove_where(params = {})
+        filter = if params.kind_of?(Ably::Models::DeviceDetails)
+          { 'deviceId' => params.id }
+        else
+          raise ArgumentError, "params must be a Hash" unless params.kind_of?(Hash)
+          raise ArgumentError, "device_id filter cannot be specified alongside a client_id filter. Use one or the other" if params[:client_id] && params[:device_id]
+          IdiomaticRubyWrapper(params).as_json
+        end
+        client.delete("/push/deviceRegistrations", filter)
+      end
+    end
+  end
+end

data/lib/ably/version.rb

@@ -1,6 +1,6 @@
 module Ably
-  VERSION = '1.0.7'
-  PROTOCOL_VERSION = '1.0'
+  VERSION = '1.1.0'
+  PROTOCOL_VERSION = '1.1'
 
   # Allow a variant to be configured for all instances of this client library
   # such as ruby-rest-[VERSION]
@@ -13,4 +13,9 @@ module Ably
   def self.lib_variant
     @lib_variant
   end
+
+  # @api private
+  def self.major_minor_version_numeric
+    VERSION.gsub(/\.\d+$/, '').to_f
+  end
 end

data/spec/acceptance/realtime/auth_spec.rb

@@ -607,16 +607,17 @@ describe Ably::Realtime::Auth, :event_machine do
 
           context 'when auth fails' do
             let(:client_options) { default_options.merge(auth_callback: basic_token_cb, log_level: :none) }
+            let!(:token_string) { client.rest_client.auth.request_token.token }
 
             it 'transitions the connection state to the FAILED state (#RSA15c, #RTC8a2, #RTC8a3)' do
               connection_failed = false
 
               client.connection.once(:connected) do
-                client.auth.authorize(nil, auth_callback: lambda { |token_params| 'invalid.token:will.cause.failure' }).tap do |deferrable|
+                client.auth.authorize(nil, auth_callback: lambda { |token_params| "#{app_id}.invalid.token.will.cause.failure" }).tap do |deferrable|
                   deferrable.errback do |error|
                     EventMachine.add_timer(0.2) do
                       expect(connection_failed).to eql(true)
-                      expect(error.message).to match(/Invalid accessToken/i)
+                      expect(error.message).to match(/invalid.*accessToken/i)
                       expect(error.code).to eql(40005)
                       stop_reactor
                     end
@@ -626,7 +627,7 @@ describe Ably::Realtime::Auth, :event_machine do
               end
 
               client.connection.once(:failed) do
-                expect(client.connection.error_reason.message).to match(/Invalid accessToken/i)
+                expect(client.connection.error_reason.message).to match(/invalid.*accessToken/i)
                 expect(client.connection.error_reason.code).to eql(40005)
                 connection_failed = true
               end
@@ -749,11 +750,8 @@ describe Ably::Realtime::Auth, :event_machine do
       end
 
       context 'when received' do
-        # Ably in all environments other than locla will send AUTH 30 seconds before expiry
-        # We set the TTL to 33s and wait (3s window)
-        # In local env, that window is 5 seconds instead of 30 seconds
-        let(:local_offset) { ENV['ABLY_ENV'] == 'local' ? 25 : 0 }
-        let(:client_options) { default_options.merge(use_token_auth: :true, default_token_params: { ttl: 33 - local_offset }) }
+        # Ably will send AUTH 30 seconds before expiry
+        let(:client_options) { default_options.merge(use_token_auth: :true, default_token_params: { ttl: 33 }) }
 
         it 'should immediately start a new authentication process (#RTN22)' do
           client.connection.once(:connected) do

data/spec/acceptance/realtime/channel_spec.rb

@@ -13,6 +13,9 @@ describe Ably::Realtime::Channel, :event_machine do
     let(:channel)      { client.channel(channel_name) }
     let(:messages)     { [] }
 
+    let(:sub_client)   { auto_close Ably::Realtime::Client.new(client_options) }
+    let(:sub_channel)  { sub_client.channel(channel_name) }
+
     def disconnect_transport
       connection.transport.unbind
     end
@@ -726,7 +729,7 @@ describe Ably::Realtime::Channel, :event_machine do
       let(:name)    { random_str }
       let(:data)    { random_str }
 
-      context 'when attached' do
+      context 'when channel is attached (#RTL6c1)' do
         it 'publishes messages' do
           channel.attach do
             3.times { channel.publish('event', payload) }
@@ -738,81 +741,173 @@ describe Ably::Realtime::Channel, :event_machine do
         end
       end
 
-      context 'when not yet attached' do
-        it 'publishes queued messages once attached' do
-          3.times { channel.publish('event', random_str) }
-          channel.subscribe do |message|
-            messages << message if message.name == 'event'
-            stop_reactor if messages.count == 3
+      context 'when channel is not attached in state Initializing (#RTL6c1)' do
+        it 'publishes messages immediately and does not implicitly attach (#RTL6c1)' do
+          sub_channel.attach do
+            sub_channel.subscribe do |message|
+              messages << message if message.name == 'event'
+              if messages.count == 3
+                EventMachine.add_timer(1) do
+                  expect(channel.state).to eq(:initialized)
+                  stop_reactor
+                end
+              end
+            end
+            3.times { channel.publish('event', random_str) }
           end
         end
+      end
 
-        it 'publishes queued messages within a single protocol message' do
-          3.times { channel.publish('event', random_str) }
-          channel.subscribe do |message|
-            messages << message if message.name == 'event'
-            next unless messages.length == 3
-
-            # All 3 messages should be batched into a single Protocol Message by the client library
-            # message.id = "{protocol_message.id}:{protocol_message_index}"
-            # Check that all messages share the same protocol_message.id
-            message_id = messages.map { |msg| msg.id.split(':')[0...-1].join(':') }
-            expect(message_id.uniq.count).to eql(1)
-
-            # Check that messages use index 0,1,2 in the ID
-            message_indexes = messages.map { |msg| msg.id.split(':').last }
-            expect(message_indexes).to include("0", "1", "2")
-            stop_reactor
+      context 'when channel is Attaching (#RTL6c1)' do
+        it 'publishes messages immediately (#RTL6c1)' do
+          sub_channel.attach do
+            channel.once(:attaching) do
+              outgoing_message_count = 0
+              client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                if protocol_message.action == :message
+                  raise "Expected channel state to be attaching when publishing messages, not #{channel.state}" unless channel.attaching?
+                  outgoing_message_count += protocol_message.messages.count
+                end
+              end
+              sub_channel.subscribe do |message|
+                messages << message if message.name == 'event'
+                if messages.count == 3
+                  expect(outgoing_message_count).to eql(3)
+                  stop_reactor
+                end
+              end
+              3.times { channel.publish('event', random_str) }
+            end
+            channel.attach
           end
         end
+      end
 
-        context 'with :queue_messages client option set to false' do
-          let(:client_options)  { default_options.merge(queue_messages: false) }
-
-          context 'and connection state initialized' do
-            it 'fails the deferrable' do
-              expect(client.connection).to be_initialized
-              channel.publish('event').errback do |error|
-                expect(error).to be_a(Ably::Exceptions::MessageQueueingDisabled)
-                stop_reactor
+      context 'when channel is Detaching (#RTL6c1)' do
+        it 'publishes messages immediately (#RTL6c1)' do
+          sub_channel.attach do
+            channel.attach do
+              channel.once(:detaching) do
+                outgoing_message_count = 0
+                client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                  if protocol_message.action == :message
+                    raise "Expected channel state to be attaching when publishing messages, not #{channel.state}" unless channel.detaching?
+                    outgoing_message_count += protocol_message.messages.count
+                  end
+                end
+                sub_channel.subscribe do |message|
+                  messages << message if message.name == 'event'
+                  if messages.count == 3
+                    expect(outgoing_message_count).to eql(3)
+                    stop_reactor
+                  end
+                end
+                3.times { channel.publish('event', random_str) }
               end
+              channel.detach
             end
           end
+        end
+      end
 
-          context 'and connection state connecting' do
-            it 'fails the deferrable' do
-              client.connect
-              EventMachine.next_tick do
-                expect(client.connection).to be_connecting
-                channel.publish('event').errback do |error|
-                  expect(error).to be_a(Ably::Exceptions::MessageQueueingDisabled)
-                  stop_reactor
+      context 'when channel is Detached (#RTL6c1)' do
+        it 'publishes messages immediately (#RTL6c1)' do
+          sub_channel.attach do
+            channel.attach
+            channel.once(:attached) do
+              channel.once(:detached) do
+                outgoing_message_count = 0
+                client.connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+                  if protocol_message.action == :message
+                    raise "Expected channel state to be attaching when publishing messages, not #{channel.state}" unless channel.detached?
+                    outgoing_message_count += protocol_message.messages.count
+                  end
+                end
+                sub_channel.subscribe do |message|
+                  messages << message if message.name == 'event'
+                  if messages.count == 3
+                    expect(outgoing_message_count).to eql(3)
+                    stop_reactor
+                  end
                 end
+                3.times { channel.publish('event', random_str) }
+              end
+              channel.detach
+            end
+          end
+        end
+      end
+
+      context 'with :queue_messages client option set to false (#RTL6c4)' do
+        let(:client_options)  { default_options.merge(queue_messages: false) }
+
+        context 'and connection state connected (#RTL6c4)' do
+          it 'publishes the message' do
+            client.connection.once(:connected) do
+              channel.publish('event')
+              stop_reactor
+            end
+          end
+        end
+
+        context 'and connection state initialized (#RTL6c4)' do
+          it 'fails the deferrable' do
+            expect(client.connection).to be_initialized
+            channel.publish('event').errback do |error|
+              expect(error).to be_a(Ably::Exceptions::MessageQueueingDisabled)
+              stop_reactor
+            end
+          end
+        end
+
+        context 'and connection state connecting (#RTL6c4)' do
+          it 'fails the deferrable' do
+            client.connect
+            EventMachine.next_tick do
+              expect(client.connection).to be_connecting
+              channel.publish('event').errback do |error|
+                expect(error).to be_a(Ably::Exceptions::MessageQueueingDisabled)
+                stop_reactor
               end
             end
           end
+        end
 
-          context 'and connection state disconnected' do
+        [:disconnected, :suspended, :closing, :closed].each do |invalid_connection_state|
+          context "and connection state #{invalid_connection_state} (#RTL6c4)" do
             let(:client_options)  { default_options.merge(queue_messages: false) }
             it 'fails the deferrable' do
               client.connection.once(:connected) do
-                client.connection.once(:disconnected) do
-                  expect(client.connection).to be_disconnected
+                client.connection.once(invalid_connection_state) do
+                  expect(client.connection.state).to eq(invalid_connection_state)
                   channel.publish('event').errback do |error|
                     expect(error).to be_a(Ably::Exceptions::MessageQueueingDisabled)
                     stop_reactor
                   end
                 end
-                client.connection.transition_state_machine :disconnected
+                if invalid_connection_state == :closed
+                  connection.close
+                else
+                  client.connection.transition_state_machine invalid_connection_state
+                end
               end
             end
           end
+        end
 
-          context 'and connection state connected' do
-            it 'publishes the message' do
-              client.connection.once(:connected) do
-                channel.publish('event')
-                stop_reactor
+        context 'and the channel state is failed (#RTL6c4)' do
+          let(:client_options)  { default_options.merge(queue_messages: false) }
+          it 'fails the deferrable' do
+            client.connection.once(:connected) do
+              channel.attach
+              channel.once(:attached) do
+                channel.once(:failed) do
+                  channel.publish('event').errback do |error|
+                    expect(error).to be_a(Ably::Exceptions::ChannelInactive)
+                    stop_reactor
+                  end
+                end
+                channel.transition_state_machine(:failed)
               end
             end
           end
@@ -1074,6 +1169,21 @@ describe Ably::Realtime::Channel, :event_machine do
         end
       end
 
+      context 'with more than allowed messages in a single publish' do
+        let(:channel_name) { random_str }
+
+        it 'rejects the publish' do
+          messages = (Ably::Realtime::Connection::MAX_PROTOCOL_MESSAGE_BATCH_SIZE + 1).times.map do
+            { name: 'foo' }
+          end
+
+          channel.publish(messages).errback do |error|
+            expect(error).to be_kind_of(Ably::Exceptions::InvalidRequest)
+            stop_reactor
+          end
+        end
+      end
+
       context 'identified clients' do
         context 'when authenticated with a wildcard client_id' do
           let(:token)            { Ably::Rest::Client.new(default_options).auth.request_token(client_id: '*') }
@@ -1953,8 +2063,12 @@ describe Ably::Realtime::Channel, :event_machine do
       end
 
       context 'moves to' do
-        %w(suspended detached failed).each do |channel_state|
+        %w(suspended failed).each do |channel_state|
           context(channel_state) do
+            let(:client) do
+              auto_close Ably::Realtime::Client.new(default_options.merge(log_level: :error))
+            end
+
             specify 'all queued messages fail with NACK (#RTL11)' do
               channel.attach do
                 # Move to disconnected
@@ -1981,7 +2095,8 @@ describe Ably::Realtime::Channel, :event_machine do
             specify 'all published messages awaiting an ACK do nothing (#RTL11a)' do
               connection_been_disconnected = false
 
-              channel.attach do
+              channel.attach
+              channel.once(:attached) do
                 deferrable = channel.publish("foo")
                 deferrable.errback do |error|
                   fail "Message publish should not fail"

data/spec/acceptance/realtime/client_spec.rb

@@ -12,6 +12,7 @@ describe Ably::Realtime::Client, :event_machine do
     let(:auth_params)    { subject.auth.auth_params_sync }
 
     subject              { auto_close Ably::Realtime::Client.new(client_options) }
+    let(:sub_client)     { auto_close Ably::Realtime::Client.new(client_options) }
 
     context 'initialization' do
       context 'basic auth' do
@@ -24,6 +25,22 @@ describe Ably::Realtime::Client, :event_machine do
           end
         end
 
+        context 'with an invalid API key' do
+          let(:custom_logger_object) { TestLogger.new }
+          let(:client) { Ably::Realtime::Client.new(client_options.merge(key: 'app.key:secret', logger: custom_logger_object)) }
+
+          it 'logs an entry with a help href url matching the code #TI5' do
+            client.connect
+            client.connection.once(:failed) do
+              expect(custom_logger_object.logs.find do |severity, message|
+                next unless %w(fatal error).include?(severity.to_s)
+                message.match(%r{https://help.ably.io/error/40400})
+              end).to_not be_nil
+              stop_reactor
+            end
+          end
+        end
+
         context ':tls option' do
           context 'set to false to force a plain-text connection' do
             let(:client_options) { default_options.merge(tls: false, log_level: :none) }
@@ -281,5 +298,137 @@ describe Ably::Realtime::Client, :event_machine do
         end
       end
     end
+
+    context '#publish (#TBC)' do
+      let(:channel_name) { random_str }
+      let(:channel)      { subject.channel(channel_name) }
+      let(:sub_channel)  { sub_client.channel(channel_name) }
+      let(:event_name)   { random_str }
+      let(:data)         { random_str }
+      let(:extras)       { { 'push' => { 'notification' => { 'title' => 'Testing' } } } }
+      let(:message)      { Ably::Models::Message.new(name: event_name, data: data) }
+
+      specify 'publishing a message implicity connects and publishes the message successfully on the provided channel' do
+        sub_channel.attach do
+          sub_channel.subscribe do |msg|
+            expect(msg.name).to eql(event_name)
+            expect(msg.data).to eql(data)
+            stop_reactor
+          end
+        end
+        subject.publish channel_name, event_name, data
+      end
+
+      specify 'publishing does not result in a channel being created' do
+        subject.publish channel_name, event_name, data
+        subject.channels.fetch(channel_name) do
+          # Block called if channel does not exist
+          EventMachine.add_timer(1) do
+            subject.channels.fetch(channel_name) do
+              # Block called if channel does not exist
+              stop_reactor
+            end
+          end
+        end
+      end
+
+      context 'with extras' do
+        let(:channel_name) { "pushenabled:#{random_str}" }
+
+        specify 'publishing supports extras' do
+          sub_channel.attach do
+            sub_channel.subscribe do |msg|
+              expect(msg.extras).to eql(extras)
+              stop_reactor
+            end
+          end
+          subject.publish channel_name, event_name, {}, extras: extras
+        end
+      end
+
+      specify 'publishing supports an array of Message objects' do
+        sub_channel.attach do
+          sub_channel.subscribe do |msg|
+            expect(msg.name).to eql(event_name)
+            expect(msg.data).to eql(data)
+            stop_reactor
+          end
+        end
+        subject.publish channel_name, [message]
+      end
+
+      specify 'publishing supports an array of Hash objects' do
+        sub_channel.attach do
+          sub_channel.subscribe do |msg|
+            expect(msg.name).to eql(event_name)
+            expect(msg.data).to eql(data)
+            stop_reactor
+          end
+        end
+        subject.publish channel_name, [name: event_name, data: data]
+      end
+
+      specify 'publishing on a closed connection fails' do
+        subject.connection.once(:connected) do
+          subject.connection.once(:closed) do
+            subject.publish(channel_name, name: event_name).errback do |error|
+              expect(error).to be_kind_of(Ably::Exceptions::MessageQueueingDisabled)
+              stop_reactor
+            end
+          end
+          connection.close
+        end
+      end
+
+      context 'queue_messages ClientOption' do
+        context 'when true' do
+          subject { auto_close Ably::Realtime::Client.new(client_options.merge(auto_connect: false)) }
+
+          it 'will queue messages whilst connecting and publish once connected' do
+            sub_channel.attach do
+              sub_channel.subscribe do |msg|
+                expect(msg.name).to eql(event_name)
+                stop_reactor
+              end
+              subject.connection.once(:connecting) do
+                subject.publish channel_name, event_name
+              end
+              subject.connection.connect
+            end
+          end
+        end
+
+        context 'when false' do
+          subject { auto_close Ably::Realtime::Client.new(client_options.merge(auto_connect: false, queue_messages: false)) }
+
+          it 'will reject messages on an initializing connection' do
+            sub_channel.attach do
+              subject.connection.once(:connecting) do
+                subject.publish(channel_name, event_name).errback do |error|
+                  expect(error).to be_kind_of(Ably::Exceptions::MessageQueueingDisabled)
+                  stop_reactor
+                end
+              end
+              subject.connection.connect
+            end
+          end
+        end
+      end
+
+      context 'with more than allowed messages in a single publish' do
+        let(:channel_name) { random_str }
+
+        it 'rejects the publish' do
+          messages = (Ably::Realtime::Connection::MAX_PROTOCOL_MESSAGE_BATCH_SIZE + 1).times.map do
+            { name: 'foo' }
+          end
+
+          subject.publish(channel_name, messages).errback do |error|
+            expect(error).to be_kind_of(Ably::Exceptions::InvalidRequest)
+            stop_reactor
+          end
+        end
+      end
+    end
   end
 end