ably 1.1.4.rc → 1.1.4

data/ably.gemspec

@@ -20,9 +20,9 @@ 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 'faraday', '~> 1.0'
-  spec.add_runtime_dependency 'typhoeus', '~> 1.4'
+  spec.add_runtime_dependency 'statesman', '~> 7.4'
+  spec.add_runtime_dependency 'faraday', '>= 0.12', '< 2.0.0'
+  spec.add_runtime_dependency 'excon', '~> 0.55'
 
   if RUBY_VERSION.match(/^1\./)
     spec.add_runtime_dependency 'json', '< 2.0'
@@ -33,20 +33,20 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'msgpack', '>= 1.3.0'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 
-  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rake', '~> 11.3'
   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 'webmock', '~> 3.11'
     spec.add_development_dependency 'coveralls'
     spec.add_development_dependency 'parallel_tests', '~> 2.22'
     if !RUBY_VERSION.match(/^2\.[0123]/)

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/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
 
@@ -76,7 +76,7 @@ module Ably::Realtime
           update_presence_sync_state_following_attached protocol_message
         end
 
-        channel.set_attached_serial protocol_message.channel_serial
+        channel.properties.set_attach_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/client.rb

@@ -65,6 +65,10 @@ 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?
@@ -82,6 +86,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 +114,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/connection.rb

@@ -431,10 +431,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,
+                'lib' =>        client.rest_client.lib_version_id,
               )
 
               # Use native websocket heartbeats if possible, but allow Ably protocol heartbeats
@@ -445,6 +445,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

data/lib/ably/realtime/presence.rb

@@ -278,28 +278,14 @@ module Ably::Realtime
 
     # Return the presence messages history for the channel
     #
-    # Once attached to a channel, you can retrieve presence message history on the channel before the
-    # channel was attached with the option <tt>until_attach: true</tt>.  This is very useful for
-    # developers who wish to capture new presence events as well as retrieve historical presence state with
-    # the guarantee that no presence history has been missed.
-    #
     # @param (see Ably::Rest::Presence#history)
     # @option options (see Ably::Rest::Presence#history)
-    # @option options [Boolean]  :until_attach  When true, request for history will be limited only to messages published before the associated channel was attached. The associated channel must be attached.
     #
     # @yield [Ably::Models::PaginatedResult<Ably::Models::PresenceMessage>] First {Ably::Models::PaginatedResult page} of {Ably::Models::PresenceMessage} objects accessible with {Ably::Models::PaginatedResult#items #items}.
     #
     # @return [Ably::Util::SafeDeferrable]
     #
     def history(options = {}, &callback)
-      if options.delete(:until_attach)
-        unless channel.attached?
-          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] = channel.attached_serial
-      end
-
       async_wrap(callback) do
         rest_presence.history(options.merge(async_blocking_operations: true))
       end

data/lib/ably/rest/client.rb

@@ -3,9 +3,6 @@ require 'json'
 require 'logger'
 require 'uri'
 
-require 'typhoeus'
-require 'typhoeus/adapters/faraday'
-
 require 'ably/rest/middleware/exceptions'
 
 module Ably
@@ -205,8 +202,6 @@ module Ably
         @http_defaults = HTTP_DEFAULTS.dup
         options.each do |key, val|
           if http_key = key[/^http_(.+)/, 1]
-            # Typhoeus converts decimal durations to milliseconds, so 0.0001 timeout is treated as 0 (no timeout)
-            val = 0.001 if val.kind_of?(Numeric) && (val > 0) && (val < 0.001)
             @http_defaults[http_key.to_sym] = val if val && @http_defaults.has_key?(http_key.to_sym)
           end
         end
@@ -348,14 +343,14 @@ module Ably
       #
       # @return [Ably::Models::HttpPaginatedResponse<>]
       def request(method, path, params = {}, body = nil, headers = {}, options = {})
-        raise "Method #{method.to_s.upcase} not supported" unless [:get, :put, :post].include?(method.to_sym)
+        raise "Method #{method.to_s.upcase} not supported" unless %i(get put patch post delete).include?(method.to_sym)
 
         response = case method.to_sym
-        when :get
+        when :get, :delete
           reauthorize_on_authorization_failure do
             send_request(method, path, params, headers: headers)
           end
-        when :post
+        when :post, :patch, :put
           path_with_params = Addressable::URI.new
           path_with_params.query_values = params || {}
           query = path_with_params.query
@@ -576,10 +571,9 @@ module Ably
             end
             unless options[:send_auth_header] == false
               request.headers[:authorization] = auth.auth_header
-              if options[:headers]
-                options[:headers].map do |key, val|
-                  request.headers[key] = val
-                end
+
+              options[:headers].to_h.merge(auth.extra_auth_headers).map do |key, val|
+                request.headers[key] = val
               end
             end
           end.tap do
@@ -671,7 +665,7 @@ module Ably
         }
       end
 
-      # Return a Faraday middleware stack to initiate the Faraday::RackBuilder with
+      # Return a Faraday middleware stack to initiate the Faraday::Connection with
       #
       # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
       def middleware
@@ -683,8 +677,8 @@ module Ably
 
           setup_incoming_middleware builder, logger, fail_if_unsupported_mime_type: true
 
-          # Set Faraday's HTTP adapter with support for HTTP/2
-          builder.adapter :typhoeus, http_version: :httpv2_0
+          # Set Faraday's HTTP adapter
+          builder.adapter :excon
         end
       end
 

data/lib/ably/rest/middleware/fail_if_unsupported_mime_type.rb

@@ -7,10 +7,7 @@ module Ably
       class FailIfUnsupportedMimeType < Faraday::Response::Middleware
         def on_complete(env)
           unless env.response_headers['Ably-Middleware-Parsed'] == true
-            # Ignore empty body with success status code for no body response
-            return if env.body.to_s.empty? && env.status == 204
-
-            unless (500..599).include?(env.status)
+            unless  (500..599).include?(env.status)
               raise Ably::Exceptions::InvalidResponseBody,
                     "Content Type #{env.response_headers['Content-Type']} is not supported by this client library"
             end

data/lib/ably/version.rb

@@ -1,5 +1,5 @@
 module Ably
-  VERSION = '1.1.4.rc'
+  VERSION = '1.1.4'
   PROTOCOL_VERSION = '1.1'
 
   # Allow a variant to be configured for all instances of this client library