ably 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a05adf2fb91ff543ae2797812dce8bc9c3119cc5ebf9c4a4468a177f07e2587c
-  data.tar.gz: 97c229e631a871cdba553220677629bff959be160db9a864b8c5b712e26480d1
+  metadata.gz: adc7327c5853f3fe2fc8175a94877b4ffcbd22c24ce67cca48dfdce9464d3df1
+  data.tar.gz: e1740c98a0a6b24a67c8e3fcb6066a93902f9e12b17562a40c31d83184e86c75
 SHA512:
-  metadata.gz: e3a2dc86d92459e6fe03721df934e819e504a39a6be899a42d3ea00b251e8dd8f465552e481451a024903ee199370a932addfdbda1962f441379fc5cb718ea73
-  data.tar.gz: db1ca5e7ae13cb490f469d72a58ee7ca8f1377a834e200ade85045f0b341f411aaed966a4c7d2d85de9dd7cd55084a8369ff39505e76508ce744549723b305a8
+  metadata.gz: 4bee4e577b3c8598219d8143d193b3af8772ff95c25cb55694817ff08792b30ef365921d1cb99964673b58166cd2b08fc7a7931303342874b5412d0c19c46c20
+  data.tar.gz: 6aaea4c6281c4bc0d74b3262ed167698145dff798f1dcb735b7684792003117a7431944e4c2512cfcc6306b0fc98aea9f5d26d6132ad755afa1fca0a282a109c

data/CHANGELOG.md

@@ -1,11 +1,36 @@
 # Change Log
 
-## [v1.0.5](https://github.com/ably/ably-ruby/tree/v1.0.5)
+## [v1.0.6](https://github.com/ably/ably-ruby/tree/v1.0.6)
 
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.5...v1.0.6)
+
+**Fixed bugs:**
+
+- WebSocket driver does not emit events for heartbeats [\#116](https://github.com/ably/ably-ruby/issues/116)
+
+**Closed issues:**
+
+- Passing a frozen channel name or name gives an error on the REST client \[Reopen\] [\#145](https://github.com/ably/ably-ruby/issues/145)
+- Passing a frozen channel name or name gives an error on the REST client [\#132](https://github.com/ably/ably-ruby/issues/132)
+
+**Merged pull requests:**
+
+- Add request id fix for bulk publishes [\#154](https://github.com/ably/ably-ruby/pull/154) ([mattheworiordan](https://github.com/mattheworiordan))
+- Fix race condition in EventMachine [\#153](https://github.com/ably/ably-ruby/pull/153) ([mattheworiordan](https://github.com/mattheworiordan))
+- Add support for WebSocket native heartbeats [\#151](https://github.com/ably/ably-ruby/pull/151) ([mattheworiordan](https://github.com/mattheworiordan))
+- RSC15d test fixes; add \(failing\) tests for GET as well as POST [\#148](https://github.com/ably/ably-ruby/pull/148) ([SimonWoolf](https://github.com/SimonWoolf))
+- Do not encode strings in-place [\#147](https://github.com/ably/ably-ruby/pull/147) ([mattheworiordan](https://github.com/mattheworiordan))
+- Only resume if connection is fresh \(RTN15g\*\) [\#146](https://github.com/ably/ably-ruby/pull/146) ([mattheworiordan](https://github.com/mattheworiordan))
+- Fix channel history pagination test [\#143](https://github.com/ably/ably-ruby/pull/143) ([funkyboy](https://github.com/funkyboy))
+- Fix presence history test [\#141](https://github.com/ably/ably-ruby/pull/141) ([funkyboy](https://github.com/funkyboy))
+- Do not encode strings in-place [\#140](https://github.com/ably/ably-ruby/pull/140) ([aschuster3](https://github.com/aschuster3))
+
+## [v1.0.5](https://github.com/ably/ably-ruby/tree/v1.0.5) (2018-04-23)
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v1.0.4...v1.0.5)
 
 **Implemented enhancements:**
 
+- Add Ruby 2.1 and 2.3 to Travis tests [\#129](https://github.com/ably/ably-ruby/issues/129)
 - Add supported platforms to README file [\#128](https://github.com/ably/ably-ruby/issues/128)
 - Add Ruby 2.1 and 2.3 to Travis tests [\#130](https://github.com/ably/ably-ruby/pull/130) ([funkyboy](https://github.com/funkyboy))
 

data/ably.gemspec

@@ -18,17 +18,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'eventmachine', '~> 1.0'
+  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', '~> 0.9'
+  spec.add_runtime_dependency 'faraday', '~> 0.12'
+  spec.add_runtime_dependency 'excon', '~> 0.55'
 
   if RUBY_VERSION.match(/^1/)
     spec.add_runtime_dependency 'json', '< 2.0'
   else
     spec.add_runtime_dependency 'json'
   end
-  spec.add_runtime_dependency 'websocket-driver', '~> 0.6'
+  spec.add_runtime_dependency 'websocket-driver', '~> 0.7'
   spec.add_runtime_dependency 'msgpack', '>= 0.6.2'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 

data/lib/ably/auth.rb

@@ -82,7 +82,7 @@ module Ably
 
       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?
-        ensure_utf_8 :client_id, client_id
+        @client_id = ensure_utf_8(:client_id, client_id) if client_id
       end
 
       # If a token details object or token string is provided in the initializer
@@ -119,7 +119,7 @@ module Ably
     #    token_details = client.auth.authorize
     #
     #    # will use token request from block to authorize if not already authorized
-    #    token_details = client.auth.authorize {}, auth_callback: Proc.new do
+    #    token_details = client.auth.authorize {}, auth_callback: lambda do |token_parmas|
     #      # create token_request object
     #      token_request
     #    end
@@ -207,7 +207,7 @@ module Ably
     #    client.auth.request_token ttl: 1.hour
     #
     #    # token request using auth block
-    #    token_details = client.auth.request_token {}, auth_callback: Proc.new do
+    #    token_details = client.auth.request_token {}, auth_callback: lambda do |token_params|
     #      # create token_request object
     #      token_request
     #    end
@@ -633,7 +633,7 @@ module Ably
       method = auth_options[:auth_method] || options[:auth_method] || :get
       params = (auth_options[:auth_params] || options[:auth_method] || {}).merge(token_params)
 
-      response = connection.send(method) do |request|
+      response = connection.public_send(method) do |request|
         request.url uri.path
         request.headers = auth_options[:auth_headers] || {}
         if method.to_s.downcase == 'post'

data/lib/ably/logger.rb

@@ -82,7 +82,7 @@ module Ably
 
     def default_logger
       ::Logger.new(STDOUT).tap do |logger|
-        logger.formatter = proc do |severity, datetime, progname, msg|
+        logger.formatter = lambda do |severity, datetime, progname, msg|
           severity = ::Logger::SEV_LABEL.index(severity) if severity.kind_of?(String)
 
           formatted_date = if severity == ::Logger::DEBUG

data/lib/ably/models/idiomatic_ruby_wrapper.rb

@@ -210,14 +210,14 @@ module Ably::Models
     # key is not found in mixedCase.
     def source_key_for(symbolized_key)
       format_preferences = [
-        proc { |key_sym| convert_to_mixed_case(key_sym) },
-        proc { |key_sym| key_sym.to_sym },
-        proc { |key_sym| key_sym.to_s },
-        proc { |key_sym| convert_to_mixed_case(key_sym).to_sym },
-        proc { |key_sym| convert_to_lower_case(key_sym) },
-        proc { |key_sym| convert_to_lower_case(key_sym).to_sym },
-        proc { |key_sym| convert_to_mixed_case(key_sym, force_camel: true) },
-        proc { |key_sym| convert_to_mixed_case(key_sym, force_camel: true).to_sym }
+        lambda { |key_sym| convert_to_mixed_case(key_sym) },
+        lambda { |key_sym| key_sym.to_sym },
+        lambda { |key_sym| key_sym.to_s },
+        lambda { |key_sym| convert_to_mixed_case(key_sym).to_sym },
+        lambda { |key_sym| convert_to_lower_case(key_sym) },
+        lambda { |key_sym| convert_to_lower_case(key_sym).to_sym },
+        lambda { |key_sym| convert_to_mixed_case(key_sym, force_camel: true) },
+        lambda { |key_sym| convert_to_mixed_case(key_sym, force_camel: true).to_sym }
       ]
 
       preferred_format = format_preferences.detect do |format|

data/lib/ably/models/message.rb

@@ -62,9 +62,11 @@ module Ably::Models
 
       set_attributes_object attributes
 
-      ensure_utf_8 :name,      name,      allow_nil: true
-      ensure_utf_8 :client_id, client_id, allow_nil: true
-      ensure_utf_8 :encoding,  encoding,  allow_nil: true
+      self.attributes[:name] = ensure_utf_8(:name, name, allow_nil: true) if name
+      self.attributes[:client_id] = ensure_utf_8(:client_id, client_id, allow_nil: true) if client_id
+      self.attributes[:encoding] = ensure_utf_8(:encoding,  encoding,  allow_nil: true) if encoding
+
+      self.attributes.freeze
     end
 
     %w( name client_id encoding ).each do |attribute|
@@ -145,7 +147,7 @@ module Ably::Models
     end
 
     def set_attributes_object(new_attributes)
-      @attributes = IdiomaticRubyWrapper(new_attributes.clone.freeze, stop_at: [:data, :extras])
+      @attributes = IdiomaticRubyWrapper(new_attributes.clone, stop_at: [:data, :extras])
     end
 
     def logger

data/lib/ably/models/presence_message.rb

@@ -69,9 +69,11 @@ module Ably::Models
 
       set_attributes_object attributes
 
-      ensure_utf_8 :client_id,     client_id,     allow_nil: true
-      ensure_utf_8 :connection_id, connection_id, allow_nil: true
-      ensure_utf_8 :encoding,      encoding,      allow_nil: true
+      self.attributes[:client_id] = ensure_utf_8(:client_id, client_id, allow_nil: true) if client_id
+      self.attributes[:connection_id] = ensure_utf_8(:connection_id, connection_id, allow_nil: true) if connection_id
+      self.attributes[:encoding] = ensure_utf_8(:encoding, encoding, allow_nil: true) if encoding
+
+      self.attributes.freeze
     end
 
     %w( client_id data encoding ).each do |attribute|
@@ -167,7 +169,7 @@ module Ably::Models
     end
 
     def set_attributes_object(new_attributes)
-      @attributes = IdiomaticRubyWrapper(new_attributes.clone.freeze, stop_at: [:data])
+      @attributes = IdiomaticRubyWrapper(new_attributes.clone, stop_at: [:data])
     end
 
     def logger

data/lib/ably/modules/async_wrapper.rb

@@ -44,7 +44,7 @@ module Ably::Modules
       Ably::Util::SafeDeferrable.new(logger).tap do |deferrable|
         deferrable.callback(&success_callback) if success_callback
 
-        operation_with_exception_handling = proc do
+        operation_with_exception_handling = lambda do
           begin
             yield
           rescue StandardError => err
@@ -57,7 +57,7 @@ module Ably::Modules
           end
         end
 
-        complete_callback = proc do |result|
+        complete_callback = lambda do |result|
           deferrable.succeed result
         end
 

data/lib/ably/modules/conversions.rb

@@ -96,7 +96,7 @@ module Ably::Modules
       unless options[:allow_nil] && string_value.nil?
         raise ArgumentError, "#{field_name} must be a String" unless string_value.kind_of?(String)
       end
-      string_value.encode!(Encoding::UTF_8) if string_value
+      string_value.encode(Encoding::UTF_8) if string_value
     rescue Encoding::UndefinedConversionError, Encoding::InvalidByteSequenceError => e
       raise ArgumentError, "#{field_name} could not be converted to UTF-8: #{e.message}"
     end

data/lib/ably/modules/encodeable.rb

@@ -95,7 +95,7 @@ module Ably::Modules
 
         previous_encoding = message_attributes[:encoding]
         encoders.each do |encoder|
-          encoder.send method, message_attributes, channel_options
+          encoder.public_send method, message_attributes, channel_options
         end
       end until previous_encoding == message_attributes[:encoding]
 

data/lib/ably/modules/event_emitter.rb

@@ -31,7 +31,7 @@ module Ably
         # @option options [Proc] :coerce_into A lambda/Proc that is used to coerce the event names for all events. This is useful to ensure the event names conform to a naming or type convention.
         #
         # @example
-        #   configure_event_emitter coerce_into: Proc.new { |event| event.to_sym }
+        #   configure_event_emitter coerce_into: lambda { |event| event.to_sym }
         #
         def configure_event_emitter(options = {})
           @event_emitter_coerce_proc = options[:coerce_into]
@@ -158,7 +158,7 @@ module Ably
       # #emit automatically deletes any blocks that return true thus allowing a block to be run once
       def proc_for_block(block, options = {})
         {
-          emit_proc: Proc.new do |*args|
+          emit_proc: lambda do |*args|
             block.call(*args)
             true if options[:delete_once_run]
           end,

data/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/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/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/ably/realtime/auth.rb

@@ -233,7 +233,7 @@ 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

data/lib/ably/realtime/channel.rb

@@ -93,7 +93,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
@@ -159,7 +159,7 @@ module Ably
         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
@@ -291,7 +291,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
 

data/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
@@ -224,7 +224,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/ably/realtime/client/incoming_message_dispatcher.rb

@@ -56,6 +56,7 @@ module Ably::Realtime
         end
 
         update_connection_recovery_info protocol_message
+        connection.set_connection_confirmed_alive
 
         case protocol_message.action
           when ACTION.Heartbeat
@@ -75,8 +76,10 @@ module Ably::Realtime
             elsif connection.connected?
               logger.debug { "Updated CONNECTED ProtocolMessage received (whilst connected)" }
               process_connected_update_message protocol_message
+              connection.set_connection_confirmed_alive # Connection protocol messages can change liveness settings such as max_idle_interval
             else
               process_connected_message protocol_message
+              connection.set_connection_confirmed_alive # Connection protocol messages can change liveness settings such as max_idle_interval
             end
 
           when ACTION.Disconnect, ACTION.Disconnected
@@ -132,8 +135,6 @@ module Ably::Realtime
             error = Ably::Exceptions::ProtocolError.new("Protocol Message Action #{protocol_message.action} is unsupported by this MessageDispatcher", 400, 80013)
             logger.fatal error.message
         end
-
-        connection.set_connection_confirmed_alive
       end
 
       def dispatch_channel_error(protocol_message)

data/lib/ably/realtime/connection.rb

@@ -235,7 +235,7 @@ module Ably
           ping_id = SecureRandom.hex(16)
           heartbeat_action = Ably::Models::ProtocolMessage::ACTION.Heartbeat
 
-          wait_for_ping = Proc.new do |protocol_message|
+          wait_for_ping = lambda do |protocol_message|
             next if finished
             if protocol_message.action == heartbeat_action && protocol_message.id == ping_id
               finished = true
@@ -423,9 +423,12 @@ module Ably
                 lib:        client.rest_client.lib_version_id,
               )
 
-              # Use native websocket heartbeats if possible
-              # TODO: Fix once https://github.com/ably/ably-ruby/issues/116 is resolved
-              url_params['heartbeats'] = 'true' # unless defaults.fetch(:websocket_heartbeats_disabled)
+              # Use native websocket heartbeats if possible, but allow Ably protocol heartbeats
+              url_params['heartbeats'] = if defaults.fetch(:websocket_heartbeats_disabled)
+                'true'
+              else
+                'false'
+              end
 
               url_params['clientId'] = client.auth.client_id if client.auth.has_client_id?
 
@@ -579,7 +582,7 @@ module Ably
 
       def create_pub_sub_message_bus
         Ably::Util::PubSub.new(
-          coerce_into: Proc.new do |event|
+          coerce_into: lambda do |event|
             raise KeyError, "Expected :protocol_message, :#{event} is disallowed" unless event == :protocol_message
             :protocol_message
           end
@@ -615,8 +618,10 @@ module Ably
       def connection_state_available?
         return true if connected?
 
+        return false if time_since_connection_confirmed_alive? > connection_state_ttl + details.max_idle_interval
+
         connected_last = state_history.reverse.find { |connected| connected.fetch(:state) == :connected }
-        if connected_last.nil? || (connected_last.fetch(:transitioned_at) < Time.now - connection_state_ttl)
+        if connected_last.nil?
           false
         else
           true

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

@@ -208,7 +208,7 @@ module Ably::Realtime
 
       def create_pub_sub_message_bus
         Ably::Util::PubSub.new(
-          coerce_into: Proc.new do |event|
+          coerce_into: lambda do |event|
             raise KeyError, "Expected :protocol_message, :#{event} is disallowed" unless event == :protocol_message
             :protocol_message
           end