ably 1.1.4.rc → 1.1.7

data/ably.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'eventmachine', '~> 1.2.6'
   spec.add_runtime_dependency 'em-http-request', '~> 1.1'
-  spec.add_runtime_dependency 'statesman', '~> 1.0.0'
+  spec.add_runtime_dependency 'statesman', '~> 8.0'
   spec.add_runtime_dependency 'faraday', '~> 1.0'
   spec.add_runtime_dependency 'typhoeus', '~> 1.4'
 
@@ -35,23 +35,28 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
-  spec.add_development_dependency 'rspec', '~> 3.10.0' # version lock, see config.around(:example, :event_machine) in event_machine_helper.rb
+  spec.add_development_dependency 'rspec', '~> 3.3.0' # version lock, see config.around(:example, :event_machine) in event_machine_helper.rb
   spec.add_development_dependency 'rspec-retry', '~> 0.6'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'rspec-instafail', '~> 1.0'
-  spec.add_development_dependency 'bundler', '~> 2.2.1'
+  spec.add_development_dependency 'bundler', '>= 1.3.0'
 
   if RUBY_VERSION.match(/^1\./)
     spec.add_development_dependency 'public_suffix', '~> 1.4.6' # Later versions do not support Ruby 1.9
     spec.add_development_dependency 'webmock', '2.2'
     spec.add_development_dependency 'parallel_tests', '~> 2.9.0'
   else
-    spec.add_development_dependency 'webmock', '~> 2.2'
-    spec.add_development_dependency 'coveralls'
-    spec.add_development_dependency 'parallel_tests', '~> 2.22'
+    spec.add_development_dependency 'webmock', '~> 3.11'
+    spec.add_development_dependency 'simplecov', '~> 0.21.2'
+    spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+    spec.add_development_dependency 'parallel_tests', '~> 3.7'
     if !RUBY_VERSION.match(/^2\.[0123]/)
-      spec.add_development_dependency 'pry'
-      spec.add_development_dependency 'pry-byebug'
+      spec.add_development_dependency 'pry', '~> 0.14.1'
+      spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
     end
   end
+
+  if RUBY_VERSION.match(/^3\./)
+    spec.add_development_dependency 'webrick', '~> 1.7.0'
+  end
 end

data/lib/ably.rb

@@ -1,6 +1,7 @@
 require 'addressable/uri'
 
 require 'ably/version'
+require 'ably/agent'
 
 %w(modules util).each do |namespace|
   Dir.glob(File.expand_path("ably/#{namespace}/*.rb", File.dirname(__FILE__))).sort.each do |file|

data/lib/ably/agent.rb

@@ -0,0 +1,3 @@
+module Ably
+  AGENT = "ably-ruby/#{Ably::VERSION} ruby/#{RUBY_VERSION}"
+end

data/lib/ably/auth.rb

@@ -103,7 +103,6 @@ module Ably
       end
 
       if has_client_id? && !token_creatable_externally? && !token_option
-        raise ArgumentError, 'client_id cannot be provided without a complete API key or means to authenticate. An API key is needed to automatically authenticate with Ably and obtain a token' unless api_key_present?
         @client_id = ensure_utf_8(:client_id, client_id) if client_id
       end
 
@@ -377,7 +376,7 @@ module Ably
     # True when Token Auth is being used to authenticate with Ably
     def using_token_auth?
       return options[:use_token_auth] if options.has_key?(:use_token_auth)
-      !!(token_option || current_token_details || has_client_id? || token_creatable_externally?)
+      !!(token_option || current_token_details || token_creatable_externally?)
     end
 
     def client_id
@@ -408,6 +407,17 @@ module Ably
       end
     end
 
+    # Extra headers that may be used during authentication
+    #
+    # @return [Hash] headers
+    def extra_auth_headers
+      if client_id && using_basic_auth?
+        { 'X-Ably-ClientId' => Base64.urlsafe_encode64(client_id) }
+      else
+        {}
+      end
+    end
+
     # Auth params used in URI endpoint for Realtime connections
     # Will reauthorize implicitly if required and capable
     #

data/lib/ably/exceptions.rb

@@ -52,6 +52,12 @@ module Ably
       end
     end
 
+    # Maximum frame size exceeded TO3l9
+    class MaxFrameSizeExceeded < BaseAblyException; end
+
+    # Maximum message size exceeded TO3l8
+    class MaxMessageSizeExceeded < BaseAblyException; end
+
     # An invalid request was received by Ably
     class InvalidRequest < BaseAblyException; end
 

data/lib/ably/models/connection_details.rb

@@ -38,6 +38,8 @@ module Ably::Models
           self.attributes[duration_field] = (self.attributes[duration_field].to_f / 1000).round
         end
       end
+      self.attributes[:max_message_size] ||= 65536
+      self.attributes[:max_frame_size] ||= 524288
       self.attributes.freeze
     end
 

data/lib/ably/models/message.rb

@@ -105,6 +105,20 @@ module Ably::Models
       end.to_json
     end
 
+    # The size is the sum over name, data, clientId, and extras in bytes (TO3l8a)
+    #
+    def size
+      %w(name data client_id extras).map do |attr|
+        if (value = attributes[attr.to_sym]).is_a?(String)
+          value.bytesize
+        elsif value.nil?
+          0
+        else
+          value.to_json.bytesize
+        end
+      end.sum
+    end
+
     # Assign this message to a ProtocolMessage before delivery to the Ably system
     # @api private
     def assign_to_protocol_message(protocol_message)

data/lib/ably/models/presence_message.rb

@@ -125,6 +125,20 @@ module Ably::Models
       end.to_json
     end
 
+    # The size is the sum over data and clientId in bytes (TO3l8a)
+    #
+    def size
+      %w(data client_id).map do |attr|
+        if (value = attributes[attr.to_sym]).is_a?(String)
+          value.bytesize
+        elsif value.nil?
+          0
+        else
+          value.to_json.bytesize
+        end
+      end.sum
+    end
+
     # Assign this presence message to a ProtocolMessage before delivery to the Ably system
     # @api private
     def assign_to_protocol_message(protocol_message)

data/lib/ably/models/protocol_message.rb

@@ -185,6 +185,14 @@ module Ably::Models
         end
     end
 
+    def message_size
+      presence.map(&:size).sum + messages.map(&:size).sum
+    end
+
+    def has_correct_message_size?
+      message_size <= connection_details.max_message_size
+    end
+
     def flags
       Integer(attributes[:flags])
     rescue TypeError

data/lib/ably/modules/ably.rb

@@ -6,8 +6,18 @@
 module Ably
   # Fallback hosts to use when a connection to rest/realtime.ably.io is not possible due to
   # network failures either at the client, between the client and Ably, within an Ably data center, or at the IO domain registrar
+  # see https://docs.ably.io/client-lib-development-guide/features/#RSC15a
   #
-  FALLBACK_HOSTS = %w(A.ably-realtime.com B.ably-realtime.com C.ably-realtime.com D.ably-realtime.com E.ably-realtime.com).freeze
+  FALLBACK_DOMAIN = 'ably-realtime.com'.freeze
+  FALLBACK_IDS = %w(a b c d e).freeze
+
+  # Default production fallbacks a.ably-realtime.com ... e.ably-realtime.com
+  FALLBACK_HOSTS = FALLBACK_IDS.map { |host| "#{host}.#{FALLBACK_DOMAIN}".freeze }.freeze
+
+  # Custom environment default fallbacks {ENV}-a-fallback.ably-realtime.com ... {ENV}-a-fallback.ably-realtime.com
+  CUSTOM_ENVIRONMENT_FALLBACKS_SUFFIXES = FALLBACK_IDS.map do |host|
+    "-#{host}-fallback.#{FALLBACK_DOMAIN}".freeze
+  end.freeze
 
   INTERNET_CHECK = {
     url:     '//internet-up.ably-realtime.com/is-the-internet-up.txt',

data/lib/ably/realtime/channel.rb

@@ -79,6 +79,10 @@ module Ably
       # @return [Hash]
       attr_reader :options
 
+      # Properties of a channel and its state
+      # @return [{Ably::Realtime::Channel::ChannelProperties}]
+      attr_reader :properties
+
       # When a channel failure occurs this attribute contains the Ably Exception
       # @return [Ably::Models::ErrorInfo,Ably::Exceptions::BaseAblyException]
       attr_reader :error_reason
@@ -88,11 +92,6 @@ module Ably
       # @api private
       attr_reader :manager
 
-      # Serial number assigned to this channel when it was attached
-      # @return [Integer]
-      # @api private
-      attr_reader :attached_serial
-
       # Initialize a new Channel object
       #
       # @param  client [Ably::Rest::Client]
@@ -112,6 +111,7 @@ module Ably
         @state         = STATE(state_machine.current_state)
         @manager       = ChannelManager.new(self, client.connection)
         @push          = PushChannel.new(self)
+        @properties    = ChannelProperties.new(self)
 
         setup_event_handlers
         setup_presence
@@ -292,7 +292,7 @@ module Ably
             error = Ably::Exceptions::InvalidRequest.new('option :until_attach is invalid as the channel is not attached' )
             return Ably::Util::SafeDeferrable.new_and_fail_immediately(logger, error)
           end
-          options[:from_serial] = attached_serial
+          options[:from_serial] = properties.attach_serial
         end
 
         async_wrap(callback) do
@@ -319,11 +319,6 @@ module Ably
         @error_reason = nil
       end
 
-      # @api private
-      def set_attached_serial(serial)
-        @attached_serial = serial
-      end
-
       # @api private
       def update_options(channel_options)
         @options = channel_options.clone.freeze
@@ -372,3 +367,4 @@ end
 require 'ably/realtime/channel/channel_manager'
 require 'ably/realtime/channel/channel_state_machine'
 require 'ably/realtime/channel/push_channel'
+require 'ably/realtime/channel/channel_properties'

data/lib/ably/realtime/channel/channel_manager.rb

@@ -37,7 +37,7 @@ module Ably::Realtime
         # library, such as returning to attached whne detach has failed
         if attached_protocol_message
           update_presence_sync_state_following_attached attached_protocol_message
-          channel.set_attached_serial attached_protocol_message.channel_serial
+          channel.properties.set_attach_serial(attached_protocol_message.channel_serial)
         end
       end
 
@@ -63,6 +63,8 @@ module Ably::Realtime
           log_channel_error protocol_message.error
         end
 
+        channel.properties.set_attach_serial(protocol_message.channel_serial)
+
         if protocol_message.has_channel_resumed_flag?
           logger.debug { "ChannelManager: Additional resumed ATTACHED message received for #{channel.state} channel '#{channel.name}'" }
         else
@@ -75,8 +77,6 @@ module Ably::Realtime
           )
           update_presence_sync_state_following_attached protocol_message
         end
-
-        channel.set_attached_serial protocol_message.channel_serial
       end
 
       # Handle DETACED messages, see #RTL13 for server-initated detaches

data/lib/ably/realtime/channel/channel_properties.rb

@@ -0,0 +1,24 @@
+module Ably::Realtime
+  class Channel
+    # Represents properties of a channel and its state
+    class ChannelProperties
+      # {Ably::Realtime::Channel} this object associated with
+      # @return [Ably::Realtime::Channel]
+      attr_reader :channel
+
+      # Contains the last channelSerial received in an ATTACHED ProtocolMesage for the channel, see RTL15a
+      #
+      # @return [String]
+      attr_reader :attach_serial
+
+      def initialize(channel)
+        @channel = channel
+      end
+
+      # @api private
+      def set_attach_serial(attach_serial)
+        @attach_serial = attach_serial
+      end
+    end
+  end
+end

data/lib/ably/realtime/channel/publisher.rb

@@ -22,6 +22,11 @@ module Ably::Realtime
           end
         end
 
+        if messages.sum(&:size) > Ably::Realtime::Connection::MAX_MESSAGE_SIZE
+          error = Ably::Exceptions::MaxMessageSizeExceeded.new("Message size exceeded #{Ably::Realtime::Connection::MAX_MESSAGE_SIZE} bytes.")
+          return Ably::Util::SafeDeferrable.new_and_fail_immediately(logger, error)
+        end
+
         connection.send_protocol_message(
           action:   Ably::Models::ProtocolMessage::ACTION.Message.to_i,
           channel:  channel_name,

data/lib/ably/realtime/client.rb

@@ -65,11 +65,16 @@ module Ably
       # @return [String,Nil]
       attr_reader :recover
 
+      # Additional parameters to be sent in the querystring when initiating a realtime connection
+      # @return [Hash]
+      attr_reader :transport_params
+
       def_delegators :auth, :client_id, :auth_options
       def_delegators :@rest_client, :encoders
       def_delegators :@rest_client, :use_tls?, :protocol, :protocol_binary?
       def_delegators :@rest_client, :environment, :custom_host, :custom_port, :custom_tls_port
       def_delegators :@rest_client, :log_level
+      def_delegators :@rest_client, :options
 
       # Creates a {Ably::Realtime::Client Realtime Client} and configures the {Ably::Auth} object for the connection.
       #
@@ -82,6 +87,7 @@ module Ably
       # @option options [Boolean] :echo_messages  If false, prevents messages originating from this connection being echoed back on the same connection
       # @option options [String]  :recover        When a recover option is specified a connection inherits the state of a previous connection that may have existed under a different instance of the Realtime library, please refer to the API documentation for further information on connection state recovery
       # @option options [Boolean] :auto_connect   By default as soon as the client library is instantiated it will connect to Ably. You can optionally set this to false and explicitly connect.
+      # @option options [Hash]    :transport_params   Additional parameters to be sent in the querystring when initiating a realtime connection. Keys are Strings, values are Stringifiable(a value must respond to #to_s)
       #
       # @option options [Integer] :channel_retry_timeout       (15 seconds). When a channel becomes SUSPENDED, after this delay in seconds, the channel will automatically attempt to reattach if the connection is CONNECTED
       # @option options [Integer] :disconnected_retry_timeout  (15 seconds). When the connection enters the DISCONNECTED state, after this delay in seconds, if the state is still DISCONNECTED, the client library will attempt to reconnect automatically
@@ -109,6 +115,9 @@ module Ably
           end
         end
 
+        @transport_params      = options.delete(:transport_params).to_h.each_with_object({}) do |(key, value), acc|
+          acc[key.to_s] = value.to_s
+        end
         @rest_client           = Ably::Rest::Client.new(options.merge(realtime_client: self))
         @echo_messages         = rest_client.options.fetch(:echo_messages, true) == false ? false : true
         @queue_messages        = rest_client.options.fetch(:queue_messages, true) == false ? false : true

data/lib/ably/realtime/client/incoming_message_dispatcher.rb

@@ -121,15 +121,23 @@ module Ably::Realtime
             presence.manager.sync_process_messages protocol_message.channel_serial, protocol_message.presence
 
           when ACTION.Presence
-            presence = get_channel(protocol_message.channel).presence
-            protocol_message.presence.each do |presence_message|
-              presence.__incoming_msgbus__.publish :presence, presence_message
+            if protocol_message.has_correct_message_size?
+              presence = get_channel(protocol_message.channel).presence
+              protocol_message.presence.each do |presence_message|
+                presence.__incoming_msgbus__.publish :presence, presence_message
+              end
+            else
+              logger.fatal Ably::Exceptions::ProtocolError.new("Not published. Channel message limit exceeded #{protocol_message.message_size} bytes", 400, Ably::Exceptions::Codes::UNABLE_TO_RECOVER_CHANNEL_MESSAGE_LIMIT_EXCEEDED).message
             end
 
           when ACTION.Message
-            channel = get_channel(protocol_message.channel)
-            protocol_message.messages.each do |message|
-              channel.__incoming_msgbus__.publish :message, message
+            if protocol_message.has_correct_message_size?
+              channel = get_channel(protocol_message.channel)
+              protocol_message.messages.each do |message|
+                channel.__incoming_msgbus__.publish :message, message
+              end
+            else
+              logger.fatal Ably::Exceptions::ProtocolError.new("Not published. Channel message limit exceeded #{protocol_message.message_size} bytes", 400, Ably::Exceptions::Codes::UNABLE_TO_RECOVER_CHANNEL_MESSAGE_LIMIT_EXCEEDED).message
             end
 
           when ACTION.Auth

data/lib/ably/realtime/connection.rb

@@ -82,6 +82,9 @@ module Ably
       # Max number of messages to bundle in a single ProtocolMessage
       MAX_PROTOCOL_MESSAGE_BATCH_SIZE = 50
 
+      # Max message size
+      MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
+
       # A unique public identifier for this connection, used to identify this member in presence events and messages
       # @return [String]
       attr_reader :id
@@ -292,7 +295,7 @@ module Ably
       def internet_up?
         url = "http#{'s' if client.use_tls?}:#{Ably::INTERNET_CHECK.fetch(:url)}"
         EventMachine::DefaultDeferrable.new.tap do |deferrable|
-          EventMachine::HttpRequest.new(url).get.tap do |http|
+          EventMachine::HttpRequest.new(url, tls: { verify_peer: true }).get.tap do |http|
             http.errback do
               yield false if block_given?
               deferrable.fail Ably::Exceptions::ConnectionFailed.new("Unable to connect to #{url}", nil, Ably::Exceptions::Codes::CONNECTION_FAILED)
@@ -431,10 +434,10 @@ module Ably
           client.auth.auth_params.tap do |auth_deferrable|
             auth_deferrable.callback do |auth_params|
               url_params = auth_params.merge(
-                format:     client.protocol,
-                echo:       client.echo_messages,
-                v:          Ably::PROTOCOL_VERSION,
-                lib:        client.rest_client.lib_version_id,
+                'format' =>     client.protocol,
+                'echo' =>       client.echo_messages,
+                'v' =>          Ably::PROTOCOL_VERSION,
+                'agent' =>      client.rest_client.agent
               )
 
               # Use native websocket heartbeats if possible, but allow Ably protocol heartbeats
@@ -445,6 +448,7 @@ module Ably
               end
 
               url_params['clientId'] = client.auth.client_id if client.auth.has_client_id?
+              url_params.merge!(client.transport_params)
 
               if connection_resumable?
                 url_params.merge! resume: key, connection_serial: serial

data/lib/ably/realtime/connection/websocket_transport.rb

@@ -1,3 +1,5 @@
+require 'openssl'
+
 module Ably::Realtime
   class Connection
     # EventMachine WebSocket transport
@@ -16,10 +18,13 @@ module Ably::Realtime
       )
       include Ably::Modules::StateEmitter
 
+      attr_reader :host
+
       def initialize(connection, url)
         @connection = connection
         @state      = STATE.Initialized
         @url        = url
+        @host       = URI.parse(url).hostname
 
         setup_event_handlers
       end
@@ -49,7 +54,7 @@ module Ably::Realtime
       # Required {http://www.rubydoc.info/github/eventmachine/eventmachine/EventMachine/Connection EventMachine::Connection} interface
       def connection_completed
         change_state STATE.Connected
-        start_tls if client.use_tls?
+        start_tls(tls_opts) if client.use_tls?
         driver.start
       end
 
@@ -77,6 +82,51 @@ module Ably::Realtime
         send_data(data)
       end
 
+      # TLS verification support, original implementation by Mislav Marohnić:
+      #
+      # https://github.com/lostisland/faraday/commit/63cf47c95b573539f047c729bd9ad67560bc83ff
+      def ssl_verify_peer(cert_string)
+        cert = nil
+        begin
+          cert = OpenSSL::X509::Certificate.new(cert_string)
+        rescue OpenSSL::X509::CertificateError => e
+          disconnect_with_reason "Websocket host '#{host}' returned an invalid TLS certificate: #{e.message}"
+          return false
+        end
+
+        @last_seen_cert = cert
+
+        if certificate_store.verify(@last_seen_cert)
+          begin
+            certificate_store.add_cert(@last_seen_cert)
+          rescue OpenSSL::X509::StoreError => e
+            unless e.message == 'cert already in hash table'
+              disconnect_with_reason "Websocket host '#{host}' returned an invalid TLS certificate: #{e.message}"
+              return false
+            end
+          end
+          true
+        else
+          disconnect_with_reason "Websocket host '#{host}' returned an invalid TLS certificate"
+          false
+        end
+      end
+
+      def ssl_handshake_completed
+        unless OpenSSL::SSL.verify_certificate_identity(@last_seen_cert, host)
+          disconnect_with_reason "Websocket host '#{host}' returned an invalid TLS certificate"
+          false
+        else
+          true
+        end
+      end
+
+      def certificate_store
+        @certificate_store ||= OpenSSL::X509::Store.new.tap do |store|
+          store.set_default_paths
+        end
+      end
+
       # True if socket connection is ready to be released
       # i.e. it is not currently connecting or connected
       def ready_for_release?
@@ -106,6 +156,12 @@ module Ably::Realtime
         @connection
       end
 
+      def disconnect_with_reason(reason)
+        client.logger.error { "WebsocketTransport: Disconnecting due to error: #{reason}" }
+        @reason_closed = reason
+        disconnect
+      end
+
       def reason_closed
         @reason_closed
       end
@@ -214,6 +270,16 @@ module Ably::Realtime
           end
         )
       end
+
+      # TLS options to pass to EventMachine::Connection#start_tls
+      #
+      # See https://www.rubydoc.info/github/eventmachine/eventmachine/EventMachine/Connection#start_tls-instance_method
+      def tls_opts
+        {
+          sni_hostname: host,
+          verify_peer:  true,
+        }
+      end
     end
   end
 end