ably 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa84b23cf7efa53651ed44ee5ba5fd19fa1e18b63025b5217cb88d069c095b5a
-  data.tar.gz: 357ce5eb6984d9a0cbc16a96fd267d45de4325d9b885538a9e09550bead51082
+  metadata.gz: 99da4e4f2a2934965e19a4541968e651405886d6a0814786e701fc182d6e10ef
+  data.tar.gz: f026b079b0b8969df7efe18e99413bc7d79035c2a055c46d2166d12da1d8a8ef
 SHA512:
-  metadata.gz: f17679d2f885d6cf61d99996a3ebdc7bcf0b03e6edf8b0ca35c26806199f897e39ce033c1454f0082f643824e703a508d465be217a413e88650b7a04bd3faddb
-  data.tar.gz: 3fd85374765d146902fb6f64968fc2f6b9560e40bf168b2d3acf336b6dd94b0f9e98ccf0edcb1b04fb3e38eceb16f41601828c6a4da5a8efe64734e89b1243be
+  metadata.gz: 98ac241fc8720f4da77cabe14b8cd2c6b705c8ccac33cd2f81f9c937cb75ddba173e1f129670c0392f9f2a63e0809dba995d71700832d16efbc6aa24f5ae6ad3
+  data.tar.gz: 74b4bc0c6aef5ed2ffccf41a432d8d4588a694ef0cad301e8163f8a4607536a382306d22fe0a349c95dbaad7080690220f788de8bb96033588b275e099663eaa

data/.github/workflows/check.yml

@@ -10,7 +10,7 @@ jobs:
     continue-on-error: true
     strategy:
       matrix:
-        ruby: [ '2.5', '2.6', '2.7' ]
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
         protocol: [ 'json', 'msgpack' ]
     steps:
       - uses: actions/checkout@v2
@@ -25,3 +25,17 @@ jobs:
           PARALLEL_TEST_PROCESSORS: 2
           PROTOCOL: ${{ matrix.protocol }}
         run: ./spec/run_parallel_tests
+      - uses: coverallsapp/github-action@1.1.3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-ruby_${{ matrix.ruby }}-${{ matrix.protocol }}_protocol
+          parallel: true
+  finish:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@1.1.3
+        with:
+          github-token: ${{ secrets.github_token }}
+          parallel-finished: true

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Change Log
 
+## [v1.1.7](https://github.com/ably/ably-ruby/tree/v1.1.7)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.6...v1.1.7)
+
+**Implemented enhancements:**
+
+- Implement RSC7d \(Ably-Agent header\) [\#230](https://github.com/ably/ably-ruby/issues/230)
+- Support Ruby 3.x [\#220](https://github.com/ably/ably-ruby/issues/220)
+
+**Closed issues:**
+
+- Create code snippets for homepage \(ruby\) [\#249](https://github.com/ably/ably-ruby/issues/249)
+- Update client options support to 1.1 spec level \(maxMessageSize\) [\#247](https://github.com/ably/ably-ruby/issues/247)
+- Update client options support to 1.1 spec level \(maxFrameSize\) [\#245](https://github.com/ably/ably-ruby/issues/245)
+
+**Merged pull requests:**
+
+- Enabled TLS hostname validation CVE-2020-13482 [\#263](https://github.com/ably/ably-ruby/pull/263) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Ruby 3.0 support [\#260](https://github.com/ably/ably-ruby/pull/260) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- TO3l9 Max frame size [\#259](https://github.com/ably/ably-ruby/pull/259) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Update client options support to 1.1 spec level \(maxMessageSize\) [\#252](https://github.com/ably/ably-ruby/pull/252) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Update ably-common to latest main [\#251](https://github.com/ably/ably-ruby/pull/251) ([owenpearson](https://github.com/owenpearson))
+- Implement RSC7d \(Ably-Agent header\) [\#248](https://github.com/ably/ably-ruby/pull/248) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Upgrade statesman to ~\> 8.0 [\#237](https://github.com/ably/ably-ruby/pull/237) ([darkhelmet](https://github.com/darkhelmet))
+- Update attach\_serial before emiting UPDATE event [\#228](https://github.com/ably/ably-ruby/pull/228) ([TheSmartnik](https://github.com/TheSmartnik))
+
 ## [v1.1.6](https://github.com/ably/ably-ruby/tree/v1.1.6)
 
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.5...v1.1.6)

data/README.md

@@ -3,11 +3,13 @@
 [![Gem Version](https://img.shields.io/gem/v/ably?style=flat)](https://img.shields.io/gem/v/ably?style=flat)
 [![Coverage Status](https://coveralls.io/repos/ably/ably-ruby/badge.svg)](https://coveralls.io/r/ably/ably-ruby)
 
-A Ruby client library for [ably.com](https://ably.com), the realtime messaging service. This library currently targets the [Ably 1.1 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix).
+_[Ably](https://ably.com) is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale. For more information, see the [Ably documentation](https://ably.com/documentation)._
+
+This is a Ruby client library for Ably. The library currently targets the [Ably 1.1 client library specification](https://ably.com/documentation/client-lib-development-guide/features/). You can see the complete list of features this client library supports in [our client library SDKs feature support matrix](https://ably.com/download/sdk-feature-support-matrix).
 
 ## Supported platforms
 
-This SDK supports Ruby 1.9.3+.
+This SDK supports Ruby 1.9.3+. For eventmachine and Ruby 3.0 note please visit [Ruby 3.0 support](#ruby-30-support) section.
 
 As of v1.1.5 this library requires `libcurl` as a system dependency. On most systems this is already installed but in rare cases where it isn't (for example debian-slim Docker images such as ruby-slim) you will need to install it yourself. On debian you can install it with the command `sudo apt-get install libcurl4`.
 
@@ -287,6 +289,16 @@ stats_page.next # retrieves the next page => #<Ably::Models::PaginatedResult ...
 client.time #=> 2013-12-12 14:23:34 +0000
 ```
 
+## Ruby 3.0 support
+
+If you cannot install ably realtime gem because of eventmachine openssl problems, please try to set your `openssl-dir`, i.e.:
+
+```ruby
+gem install eventmachine -- --with-openssl-dir=/usr/local/opt/openssl@1.1
+```
+
+More about eventmachine and ruby 3.0 support here https://github.com/eventmachine/eventmachine/issues/932
+
 ## Dependencies
 
 If you only need to use the REST features of this library and do not want EventMachine as a dependency, then you should consider using the [Ably Ruby REST gem](https://rubygems.org/gems/ably-rest).

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', '~> 7.4'
+  spec.add_runtime_dependency 'statesman', '~> 8.0'
   spec.add_runtime_dependency 'faraday', '~> 1.0'
   spec.add_runtime_dependency 'typhoeus', '~> 1.4'
 
@@ -33,7 +33,7 @@ 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', '~> 11.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
   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'
@@ -47,11 +47,16 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'parallel_tests', '~> 2.9.0'
   else
     spec.add_development_dependency 'webmock', '~> 3.11'
-    spec.add_development_dependency 'coveralls'
-    spec.add_development_dependency 'parallel_tests', '~> 2.22'
+    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/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/realtime/channel/channel_manager.rb

@@ -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.properties.set_attach_serial(protocol_message.channel_serial)
       end
 
       # Handle DETACED messages, see #RTL13 for server-initated detaches

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/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)
@@ -434,7 +437,7 @@ module Ably
                 'format' =>     client.protocol,
                 'echo' =>       client.echo_messages,
                 'v' =>          Ably::PROTOCOL_VERSION,
-                'lib' =>        client.rest_client.lib_version_id,
+                'agent' =>      client.rest_client.agent
               )
 
               # Use native websocket heartbeats if possible, but allow Ably protocol heartbeats

data/lib/ably/rest/channel.rb

@@ -23,6 +23,7 @@ module Ably
       attr_reader :push
 
       IDEMPOTENT_LIBRARY_GENERATED_ID_LENGTH = 9 # See spec RSL1k1
+      MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
 
       # Initialize a new Channel object
       #
@@ -85,7 +86,13 @@ module Ably
           [[{ name: first, data: second }.merge(third)], nil]
         end
 
-        payload = messages.each_with_index.map do |message, index|
+        messages.map! { |message| Ably::Models::Message(message.dup) }
+
+        if messages.sum(&:size) > Ably::Rest::Channel::MAX_MESSAGE_SIZE
+          raise Ably::Exceptions::MaxMessageSizeExceeded.new("Maximum message size exceeded #{Ably::Rest::Channel::MAX_MESSAGE_SIZE}.")
+        end
+
+        payload = messages.map do |message|
           Ably::Models::Message(message.dup).tap do |msg|
             msg.encode client.encoders, options
 

data/lib/ably/rest/client.rb

@@ -25,6 +25,8 @@ module Ably
       # Default Ably domain for REST
       DOMAIN = 'rest.ably.io'
 
+      MAX_FRAME_SIZE = 524288
+
       # Configuration for HTTP timeouts and HTTP request reattempts to fallback hosts
       HTTP_DEFAULTS = {
         open_timeout:       4,
@@ -52,6 +54,10 @@ module Ably
       # @return [Symbol]
       attr_reader :protocol
 
+      # Client agent i.e. `example-gem/1.2.0 ably-ruby/1.1.5 ruby/1.9.3`
+      # @return [String]
+      attr_reader :agent
+
       # {Ably::Auth} authentication object configured for this connection
       # @return [Ably::Auth]
       attr_reader :auth
@@ -168,6 +174,7 @@ module Ably
           end
         end
 
+        @agent               = options.delete(:agent) || Ably::AGENT
         @realtime_client     = options.delete(:realtime_client)
         @tls                 = options.delete(:tls) == false ? false : true
         @environment         = options.delete(:environment) # nil is production
@@ -358,6 +365,9 @@ module Ably
             send_request(method, path, params, headers: headers)
           end
         when :post, :patch, :put
+          if body.to_json.bytesize > MAX_FRAME_SIZE
+            raise Ably::Exceptions::MaxFrameSizeExceeded.new("Maximum frame size exceeded #{MAX_FRAME_SIZE} bytes.")
+          end
           path_with_params = Addressable::URI.new
           path_with_params.query_values = params || {}
           query = path_with_params.query
@@ -473,16 +483,6 @@ module Ably
         end
       end
 
-      # Library Ably version user agent
-      # @api private
-      def lib_version_id
-        @lib_version_id ||= [
-          'ruby',
-          Ably.lib_variant,
-          Ably::VERSION
-        ].compact.join('-')
-      end
-
       # Allowable duration for an external auth request
       # For REST client this defaults to request_timeout
       # For Realtime clients this defaults to 250ms less than the realtime_request_timeout
@@ -663,7 +663,7 @@ module Ably
             accept:             mime_type,
             user_agent:         user_agent,
             'X-Ably-Version' => Ably::PROTOCOL_VERSION,
-            'X-Ably-Lib'     => lib_version_id
+            'Ably-Agent'     => agent
           },
           request: {
             open_timeout: http_defaults.fetch(:open_timeout),

data/lib/ably/version.rb

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

data/spec/acceptance/realtime/auth_spec.rb

@@ -1237,7 +1237,7 @@ describe Ably::Realtime::Auth, :event_machine do
         let(:basic_capability) { JSON.dump(channel_name => ['subscribe'], channel_with_publish_permissions => ['publish']) }
         let(:auth_callback) do
           lambda do |token_params|
-            Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}&capability=#{URI.escape(basic_capability)}").body
+            Faraday.get("#{auth_url}?keyName=#{key_name}&keySecret=#{key_secret}&capability=#{URI::Parser.new.escape(basic_capability)}").body
           end
         end
         let(:client_options) { default_options.merge(auth_callback: auth_callback, log_level: :error) }