ably-rest 1.0.5 → 1.1.3

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

@@ -71,7 +71,7 @@ module Ably::Modules
 
     def fallback_logger
       @fallback_logger ||= ::Logger.new(STDOUT).tap do |logger|
-        logger.formatter = proc do |severity, datetime, progname, msg|
+        logger.formatter = lambda do |severity, datetime, progname, msg|
           [
             "#{datetime.strftime("%Y-%m-%d %H:%M:%S.%L")} #{::Logger::SEV_LABEL[severity]} #{msg}",
             "Warning: SafeDeferrable expects the method #logger to be defined in the class it is included in, the method was not found in #{self.class}"

data/lib/submodules/ably-ruby/lib/ably/modules/safe_yield.rb

@@ -29,7 +29,7 @@ module Ably::Modules
 
     def fallback_logger
       @fallback_logger ||= ::Logger.new(STDOUT).tap do |logger|
-        logger.formatter = proc do |severity, datetime, progname, msg|
+        logger.formatter = lambda do |severity, datetime, progname, msg|
           [
             "#{datetime.strftime("%Y-%m-%d %H:%M:%S.%L")} #{::Logger::SEV_LABEL[severity]} #{msg}",
             "Warning: SafeYield expects the method #logger to be defined in the class it is included in, the method was not found in #{self.class}"

data/lib/submodules/ably-ruby/lib/ably/modules/state_emitter.rb

@@ -81,13 +81,13 @@ module Ably::Modules
         failure_block   = options.fetch(:else, nil)
         failure_wrapper = nil
 
-        success_wrapper = Proc.new do
+        success_wrapper = lambda do |*args|
           yield
           off(&success_wrapper)
           off(&failure_wrapper) if failure_wrapper
         end
 
-        failure_wrapper = proc do |*args|
+        failure_wrapper = lambda do |*args|
           failure_block.call(*args)
           off(&success_wrapper)
           off(&failure_wrapper)
@@ -119,7 +119,7 @@ module Ably::Modules
     def once_state_changed(options = {}, &block)
       raise ArgumentError, 'Block required' unless block_given?
 
-      once_block = proc do |*args|
+      once_block = lambda do |*args|
         off(*self.class::STATE.map, &once_block)
         yield(*args)
       end
@@ -142,7 +142,7 @@ module Ably::Modules
     #
     def deferrable_for_state_change_to(target_state)
       Ably::Util::SafeDeferrable.new(logger).tap do |deferrable|
-        fail_proc = Proc.new do |state_change|
+        fail_proc = lambda do |state_change|
           deferrable.fail state_change.reason
         end
         once_or_if(target_state, else: fail_proc) do
@@ -153,7 +153,7 @@ module Ably::Modules
     end
 
     def self.included(klass)
-      klass.configure_event_emitter coerce_into: Proc.new { |event|
+      klass.configure_event_emitter coerce_into: lambda { |event|
         # Special case allows EVENT instead of STATE to be emitted
         # Relies on the assumption that EVENT is a superset of STATE
         if klass.const_defined?(:EVENT)

data/lib/submodules/ably-ruby/lib/ably/modules/state_machine.rb

@@ -23,7 +23,7 @@ module Ably::Modules
     def transition_state(state, *args)
       unless result = transition_to(state.to_sym, *args)
         exception = exception_for_state_change_to(state)
-        logger.fatal { "#{self.class}: #{exception.message}" }
+        logger.fatal { "#{self.class}: #{exception.message}\n#{caller[0..20].join("\n")}" }
       end
       result
     end
@@ -41,7 +41,7 @@ module Ably::Modules
     # @return [Ably::Exceptions::InvalidStateChange]
     def exception_for_state_change_to(state)
       error_message = "#{self.class}: Unable to transition from #{current_state} => #{state}"
-      Ably::Exceptions::InvalidStateChange.new(error_message, nil, 80020)
+      Ably::Exceptions::InvalidStateChange.new(error_message, nil, Ably::Exceptions::Codes::CHANNEL_OPERATION_FAILED_INVALID_CHANNEL_STATE)
     end
 
     module ClassMethods

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

@@ -9,6 +9,7 @@ require 'ably/realtime/channel'
 require 'ably/realtime/channels'
 require 'ably/realtime/client'
 require 'ably/realtime/connection'
+require 'ably/realtime/push'
 require 'ably/realtime/presence'
 
 require 'ably/models/message_encoders/base'

data/lib/submodules/ably-ruby/lib/ably/realtime/auth.rb

@@ -233,13 +233,13 @@ module Ably
       # @yield [Hash] Auth params for a new Realtime connection
       #
       def auth_params(&success_callback)
-        fail_callback = Proc.new do |error, deferrable|
+        fail_callback = lambda do |error, deferrable|
           logger.error { "Failed to authenticate: #{error}" }
           if error.kind_of?(Ably::Exceptions::BaseAblyException)
             # Use base exception if it exists carrying forward the status codes
             deferrable.fail Ably::Exceptions::AuthenticationFailed.new(error.message, nil, nil, error)
           else
-            deferrable.fail Ably::Exceptions::AuthenticationFailed.new(error.message, 500, 80019)
+            deferrable.fail Ably::Exceptions::AuthenticationFailed.new(error.message, 500, Ably::Exceptions::Codes::CLIENT_CONFIGURED_AUTHENTICATION_PROVIDER_REQUEST_FAILED)
           end
         end
         async_wrap(success_callback, fail_callback) do

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

@@ -1,3 +1,5 @@
+require 'ably/realtime/channel/publisher'
+
 module Ably
   module Realtime
     # The Channel class represents a Channel belonging to this application.
@@ -32,6 +34,7 @@ module Ably
       include Ably::Modules::EventMachineHelpers
       include Ably::Modules::AsyncWrapper
       include Ably::Modules::MessageEmitter
+      include Ably::Realtime::Channel::Publisher
       extend Ably::Modules::Enum
 
       # ChannelState
@@ -61,12 +64,17 @@ module Ably
 
       # {Ably::Realtime::Client} associated with this channel
       # @return [Ably::Realtime::Client]
+      # @api private
       attr_reader :client
 
       # Channel name
       # @return [String]
       attr_reader :name
 
+      # Push channel used for push notification
+      # @return [Ably::Realtime::Channel::PushChannel]
+      attr_reader :push
+
       # Channel options configured for this channel, see {#initialize} for channel_options
       # @return [Hash]
       attr_reader :options
@@ -93,7 +101,7 @@ module Ably
       # @option channel_options [Hash,Ably::Models::CipherParams]   :cipher   A hash of options or a {Ably::Models::CipherParams} to configure the encryption. *:key* is required, all other options are optional.  See {Ably::Util::Crypto#initialize} for a list of +:cipher+ options
       #
       def initialize(client, name, channel_options = {})
-        ensure_utf_8 :name, name
+        name = ensure_utf_8(:name, name)
 
         update_options channel_options
         @client        = client
@@ -103,6 +111,7 @@ module Ably
         @state_machine = ChannelStateMachine.new(self)
         @state         = STATE(state_machine.current_state)
         @manager       = ChannelManager.new(self, client.connection)
+        @push          = PushChannel.new(self)
 
         setup_event_handlers
         setup_presence
@@ -116,7 +125,7 @@ module Ably
       # @param data [String, ByteArray, nil]   The message payload unless an Array of [Ably::Model::Message] objects passed in the first argument
       # @param attributes [Hash, nil]   Optional additional message attributes such as :client_id or :connection_id, applied when name attribute is nil or a string
       #
-      # @yield [Ably::Models::Message,Array<Ably::Models::Message>] On success, will call the block with the {Ably::Models::Message} if a single message is publishde, or an Array of {Ably::Models::Message} when multiple messages are published
+      # @yield [Ably::Models::Message,Array<Ably::Models::Message>] On success, will call the block with the {Ably::Models::Message} if a single message is published, or an Array of {Ably::Models::Message} when multiple messages are published
       # @return [Ably::Util::SafeDeferrable] Deferrable that supports both success (callback) and failure (errback) callbacks
       #
       # @example
@@ -146,25 +155,30 @@ module Ably
       #   end
       #
       def publish(name, data = nil, attributes = {}, &success_block)
-        if detached? || detaching? || failed?
+        if suspended? || failed?
           error = Ably::Exceptions::ChannelInactive.new("Cannot publish messages on a channel in state #{state}")
           return Ably::Util::SafeDeferrable.new_and_fail_immediately(logger, error)
         end
 
         if !connection.can_publish_messages?
-          error = Ably::Exceptions::MessageQueueingDisabled.new("Message cannot be published. Client is configured to disallow queueing of messages and connection is currently #{connection.state}")
+          error = Ably::Exceptions::MessageQueueingDisabled.new("Message cannot be published. Client is not allowed to queue messages when connection is in state #{connection.state}")
           return Ably::Util::SafeDeferrable.new_and_fail_immediately(logger, error)
         end
 
         messages = if name.kind_of?(Enumerable)
           name
         else
-          ensure_utf_8 :name, name, allow_nil: true
+          name = ensure_utf_8(:name, name, allow_nil: true)
           ensure_supported_payload data
           [{ name: name, data: data }.merge(attributes)]
         end
 
-        queue_messages(messages).tap do |deferrable|
+        if messages.length > Realtime::Connection::MAX_PROTOCOL_MESSAGE_BATCH_SIZE
+          error = Ably::Exceptions::InvalidRequest.new("It is not possible to publish more than #{Realtime::Connection::MAX_PROTOCOL_MESSAGE_BATCH_SIZE} messages with a single publish request.")
+          return Ably::Util::SafeDeferrable.new_and_fail_immediately(logger, error)
+        end
+
+        enqueue_messages_on_connection(client, messages, channel_name, options).tap do |deferrable|
           deferrable.callback(&success_block) if block_given?
         end
       end
@@ -291,7 +305,7 @@ module Ably
       # @api private
       def __incoming_msgbus__
         @__incoming_msgbus__ ||= Ably::Util::PubSub.new(
-          coerce_into: Proc.new { |event| Ably::Models::ProtocolMessage::ACTION(event) }
+          coerce_into: lambda { |event| Ably::Models::ProtocolMessage::ACTION(event) }
         )
       end
 
@@ -321,12 +335,6 @@ module Ably
         client.logger
       end
 
-      # Internal queue used for messages published that cannot yet be enqueued on the connection
-      # @api private
-      def __queue__
-        @queue
-      end
-
       # As we are using a state machine, do not allow change_state to be used
       # #transition_state_machine must be used instead
       private :change_state
@@ -339,98 +347,6 @@ module Ably
           end
           emit_message message.name, message
         end
-
-        unsafe_on(STATE.Attached) do
-          process_queue
-        end
-      end
-
-      # Queue messages and process queue if channel is attached.
-      # If channel is not yet attached, attempt to attach it before the message queue is processed.
-      # @return [Ably::Util::SafeDeferrable]
-      def queue_messages(raw_messages)
-        messages = Array(raw_messages).map do |raw_msg|
-          create_message(raw_msg).tap do |message|
-            next if message.client_id.nil?
-            if message.client_id == '*'
-              raise Ably::Exceptions::IncompatibleClientId.new('Wildcard client_id is reserved and cannot be used when publishing messages')
-            end
-            if message.client_id && !message.client_id.kind_of?(String)
-              raise Ably::Exceptions::IncompatibleClientId.new('client_id must be a String when publishing messages')
-            end
-            unless client.auth.can_assume_client_id?(message.client_id)
-              raise Ably::Exceptions::IncompatibleClientId.new("Cannot publish with client_id '#{message.client_id}' as it is incompatible with the current configured client_id '#{client.client_id}'")
-            end
-          end
-        end
-
-        __queue__.push(*messages)
-
-        if attached?
-          process_queue
-        else
-          attach
-        end
-
-        if messages.count == 1
-          # A message is a Deferrable so, if publishing only one message, simply return that Deferrable
-          messages.first
-        else
-          deferrable_for_multiple_messages(messages)
-        end
-      end
-
-      # A deferrable object that calls the success callback once all messages are delivered
-      # If any message fails, the errback is called immediately
-      # Only one callback or errback is ever called i.e. if a group of messages all fail, only once
-      # errback will be invoked
-      def deferrable_for_multiple_messages(messages)
-        expected_deliveries = messages.count
-        actual_deliveries = 0
-        failed = false
-
-        Ably::Util::SafeDeferrable.new(logger).tap do |deferrable|
-          messages.each do |message|
-            message.callback do
-              next if failed
-              actual_deliveries += 1
-              deferrable.succeed messages if actual_deliveries == expected_deliveries
-            end
-            message.errback do |error|
-              next if failed
-              failed = true
-              deferrable.fail error, message
-            end
-          end
-        end
-      end
-
-      def messages_in_queue?
-        !__queue__.empty?
-      end
-
-      # Move messages from Channel Queue into Outgoing Connection Queue
-      def process_queue
-        condition = -> { attached? && messages_in_queue? }
-        non_blocking_loop_while(condition) do
-          send_messages_within_protocol_message __queue__.shift(MAX_PROTOCOL_MESSAGE_BATCH_SIZE)
-        end
-      end
-
-      def send_messages_within_protocol_message(messages)
-        connection.send_protocol_message(
-          action:   Ably::Models::ProtocolMessage::ACTION.Message.to_i,
-          channel:  name,
-          messages: messages
-        )
-      end
-
-      def create_message(message)
-        Ably::Models::Message(message.dup).tap do |msg|
-          msg.encode(client.encoders, options) do |encode_error, error_message|
-            client.logger.error error_message
-          end
-        end
       end
 
       def rest_channel
@@ -444,9 +360,15 @@ module Ably
       def setup_presence
         @presence ||= Presence.new(self)
       end
+
+      # Alias useful for methods with a name argument
+      def channel_name
+        name
+      end
     end
   end
 end
 
 require 'ably/realtime/channel/channel_manager'
 require 'ably/realtime/channel/channel_state_machine'
+require 'ably/realtime/channel/push_channel'

data/lib/submodules/ably-ruby/lib/ably/realtime/channel/channel_manager.rb

@@ -98,7 +98,7 @@ module Ably::Realtime
       def fail_messages_awaiting_ack(error, options = {})
         immediately = options[:immediately] || false
 
-        fail_proc = Proc.new do
+        fail_proc = lambda do
           error = Ably::Exceptions::MessageDeliveryFailed.new("Continuity of connection was lost so published messages awaiting ACK have failed") unless error
           fail_messages_in_queue connection.__pending_message_ack_queue__, error
         end
@@ -111,16 +111,12 @@ module Ably::Realtime
         end
       end
 
-      # When a channel becomes detached, suspended or failed,
+      # When a channel becomes suspended or failed,
       # all queued messages should be failed immediately as we don't queue in
       # any of those states
       def fail_queued_messages(error)
         error = Ably::Exceptions::MessageDeliveryFailed.new("Queued messages on channel '#{channel.name}' in state '#{channel.state}' will never be delivered") unless error
         fail_messages_in_queue connection.__outgoing_message_queue__, error
-        channel.__queue__.each do |message|
-          nack_message message, error
-        end
-        channel.__queue__.clear
       end
 
       def fail_messages_in_queue(queue, error)
@@ -214,7 +210,7 @@ module Ably::Realtime
         state_at_time_of_request = channel.state
         @pending_state_change_timer = EventMachine::Timer.new(realtime_request_timeout) do
           if channel.state == state_at_time_of_request
-            error = Ably::Models::ErrorInfo.new(code: 90007, message: "Channel #{new_state} operation failed (timed out)")
+            error = Ably::Models::ErrorInfo.new(code: Ably::Exceptions::Codes::CHANNEL_OPERATION_FAILED_NO_RESPONSE_FROM_SERVER, message: "Channel #{new_state} operation failed (timed out)")
             channel.transition_state_machine state_if_failed, reason: error
           end
         end
@@ -224,7 +220,7 @@ module Ably::Realtime
           @pending_state_change_timer = nil
         end
 
-        resend_if_disconnected_and_connected = Proc.new do
+        resend_if_disconnected_and_connected = lambda do
           connection.unsafe_once(:disconnected) do
             next unless pending_state_change_timer
             connection.unsafe_once(:connected) do

data/lib/submodules/ably-ruby/lib/ably/realtime/channel/channel_state_machine.rb

@@ -25,7 +25,7 @@ module Ably::Realtime
       transition :from => :attached,     :to => [:attaching, :detaching, :detached, :failed, :suspended]
       transition :from => :detaching,    :to => [:detached, :attaching, :attached, :failed, :suspended]
       transition :from => :detached,     :to => [:attaching, :attached, :failed]
-      transition :from => :suspended,    :to => [:attaching, :detached, :failed]
+      transition :from => :suspended,    :to => [:attaching, :attached, :detached, :failed]
       transition :from => :failed,       :to => [:attaching]
 
       after_transition do |channel, transition|
@@ -47,7 +47,7 @@ module Ably::Realtime
 
       after_transition(to: [:detached, :failed, :suspended]) do |channel, current_transition|
         err = error_from_state_change(current_transition)
-        channel.manager.fail_queued_messages err
+        channel.manager.fail_queued_messages(err) if channel.failed? or channel.suspended? #RTL11
         channel.manager.log_channel_error err if err
       end
 

data/lib/submodules/ably-ruby/lib/ably/realtime/channel/publisher.rb

@@ -0,0 +1,74 @@
+module Ably::Realtime
+  class Channel
+    # Publisher module adds publishing capabilities to the current object
+    module Publisher
+      private
+
+      # Prepare and queue messages on the connection queue immediately
+      # @return [Ably::Util::SafeDeferrable]
+      def enqueue_messages_on_connection(client, raw_messages, channel_name, channel_options = {})
+        messages = Array(raw_messages).map do |raw_msg|
+          create_message(client, raw_msg, channel_options).tap do |message|
+            next if message.client_id.nil?
+            if message.client_id == '*'
+              raise Ably::Exceptions::IncompatibleClientId.new('Wildcard client_id is reserved and cannot be used when publishing messages')
+            end
+            if message.client_id && !message.client_id.kind_of?(String)
+              raise Ably::Exceptions::IncompatibleClientId.new('client_id must be a String when publishing messages')
+            end
+            unless client.auth.can_assume_client_id?(message.client_id)
+              raise Ably::Exceptions::IncompatibleClientId.new("Cannot publish with client_id '#{message.client_id}' as it is incompatible with the current configured client_id '#{client.client_id}'")
+            end
+          end
+        end
+
+        connection.send_protocol_message(
+          action:   Ably::Models::ProtocolMessage::ACTION.Message.to_i,
+          channel:  channel_name,
+          messages: messages
+        )
+
+        if messages.count == 1
+          # A message is a Deferrable so, if publishing only one message, simply return that Deferrable
+          messages.first
+        else
+          deferrable_for_multiple_messages(messages)
+        end
+      end
+
+      # A deferrable object that calls the success callback once all messages are delivered
+      # If any message fails, the errback is called immediately
+      # Only one callback or errback is ever called i.e. if a group of messages all fail, only once
+      # errback will be invoked
+      def deferrable_for_multiple_messages(messages)
+        expected_deliveries = messages.count
+        actual_deliveries = 0
+        failed = false
+
+        Ably::Util::SafeDeferrable.new(logger).tap do |deferrable|
+          messages.each do |message|
+            message.callback do
+              next if failed
+              actual_deliveries += 1
+              deferrable.succeed messages if actual_deliveries == expected_deliveries
+            end
+            message.errback do |error|
+              next if failed
+              failed = true
+              deferrable.fail error, message
+            end
+          end
+        end
+      end
+
+      def create_message(client, message, channel_options)
+        Ably::Models::Message(message.dup).tap do |msg|
+          msg.encode(client.encoders, channel_options) do |encode_error, error_message|
+            client.logger.error error_message
+          end
+        end
+      end
+    end
+  end
+end
+