ably 1.1.7 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99da4e4f2a2934965e19a4541968e651405886d6a0814786e701fc182d6e10ef
-  data.tar.gz: f026b079b0b8969df7efe18e99413bc7d79035c2a055c46d2166d12da1d8a8ef
+  metadata.gz: 6d535fd596cbed132fc9c540fb46997c5fcaafeae4b4531ab6fbe02dba33178f
+  data.tar.gz: 1792b4e4f47d7044d0a937d3b75f9e3b9d9f1d6a436a36bfde2f9e65ae3f2552
 SHA512:
-  metadata.gz: 98ac241fc8720f4da77cabe14b8cd2c6b705c8ccac33cd2f81f9c937cb75ddba173e1f129670c0392f9f2a63e0809dba995d71700832d16efbc6aa24f5ae6ad3
-  data.tar.gz: 74b4bc0c6aef5ed2ffccf41a432d8d4588a694ef0cad301e8163f8a4607536a382306d22fe0a349c95dbaad7080690220f788de8bb96033588b275e099663eaa
+  metadata.gz: fad634a453ebbb3d1b05ad13fa7c3683e794635862267376920aa7d43e93afeab7c5ba06398609e048d7f421f8d10f80f9866828f07468e153be843f6b38a136
+  data.tar.gz: 1d76ae8ffe50a043b82fbb553af787a2a49665909d802f6471644e9614d81677d04c38926cb34890a2daeef2d498cabe7c39817c40fbb8d1be88070d2d103669

data/.github/workflows/check.yml

@@ -10,7 +10,7 @@ jobs:
     continue-on-error: true
     strategy:
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+        ruby: [ '2.7', '3.0', '3.1' ]
         protocol: [ 'json', 'msgpack' ]
     steps:
       - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,104 @@
 # Change Log
 
+## [v1.2.1](https://github.com/ably/ably-ruby/tree/v1.2.1)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.2.0...v1.2.1)
+
+**Fixed bugs:**
+
+- Update Ruby version \(and Gemfile.lock dependencies\) [\#253](https://github.com/ably/ably-ruby/issues/253)
+- Error not emitted when failing to connect to an endpoint indefinitely [\#233](https://github.com/ably/ably-ruby/issues/233)
+- Connection errors when there should be warnings [\#198](https://github.com/ably/ably-ruby/issues/198)
+- Implement presence re-entry requirement change for 1.1 [\#185](https://github.com/ably/ably-ruby/issues/185)
+
+**Closed issues:**
+
+- Update urls in readme [\#353](https://github.com/ably/ably-ruby/issues/353)
+- Reconsider required Ruby version [\#344](https://github.com/ably/ably-ruby/issues/344)
+
+## [v1.2.0](https://github.com/ably/ably-ruby/tree/v1.2.0)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.8...v1.2.0)
+
+This release updates ably-ruby to be compliant with the 1.2 version of the Ably client library feature specification. There are some minor breaking changes, please see [the migration guide](./UPDATING.md) for more information.
+
+**Closed issues:**
+
+- Add Channel.setOptions method [\#291](https://github.com/ably/ably-ruby/issues/291)
+- Add support for channel params [\#288](https://github.com/ably/ably-ruby/issues/288)
+- Use ATTACH_RESUME flag for unclean attaches [\#287](https://github.com/ably/ably-ruby/issues/287)
+- Add ChannelOptions param to Channels.get [\#285](https://github.com/ably/ably-ruby/issues/285)
+- Update library to adhere to new spec for token renewal (see [the spec definition](https://docs.ably.io/client-lib-development-guide/features/#RSA4b) for more info) [\#268](https://github.com/ably/ably-ruby/issues/268)
+
+**Merged pull requests:**
+
+- Add migration guide from 1.1.8 to 1.2.0 [\#348](https://github.com/ably/ably-ruby/pull/348) ([TheSmartnik](https://github.com/TheSmartnik))
+- RTL21 [\#345](https://github.com/ably/ably-ruby/pull/345) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- RTL4j [\#341](https://github.com/ably/ably-ruby/pull/341) ([TheSmartnik](https://github.com/TheSmartnik))
+- RSL1a, RSL1b [\#340](https://github.com/ably/ably-ruby/pull/340) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Add support for RSA4b, b1, c, RSA16 \(Authentication\) [\#338](https://github.com/ably/ably-ruby/pull/338) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- ChannelOptions related tasks [\#336](https://github.com/ably/ably-ruby/pull/336) ([TheSmartnik](https://github.com/TheSmartnik))
+- Update RSC7 [\#334](https://github.com/ably/ably-ruby/pull/334) ([TheSmartnik](https://github.com/TheSmartnik))
+
+## [v1.1.8](https://github.com/ably/ably-ruby/tree/v1.1.8)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.1.7...v1.1.8)
+
+**Fixed bugs:**
+
+- Lib apparently closing the socket after each request [\#211](https://github.com/ably/ably-ruby/issues/211)
+
+**Closed issues:**
+
+- Resolve config.around\(\) issue and upgrade rspec [\#313](https://github.com/ably/ably-ruby/issues/313)
+- Write spec tests for RTL21 [\#308](https://github.com/ably/ably-ruby/issues/308)
+- Write spec tests for RTL20 [\#307](https://github.com/ably/ably-ruby/issues/307)
+- Write spec tests for RTL19, RTL19a, b, c [\#306](https://github.com/ably/ably-ruby/issues/306)
+- Write spec tests for RTL18, RTL18a, b, c [\#305](https://github.com/ably/ably-ruby/issues/305)
+- Add support for RTL20 [\#295](https://github.com/ably/ably-ruby/issues/295)
+- Add support for RTL19, RTL19a, b, c [\#294](https://github.com/ably/ably-ruby/issues/294)
+- Add support for RTL18, RTL18a, b, c [\#293](https://github.com/ably/ably-ruby/issues/293)
+- Write spec tests for RSL6b, RLS7 \(Channels\) [\#284](https://github.com/ably/ably-ruby/issues/284)
+- Write spec tests for RSC15e, d, f \(Host Fallback \)
+ [\#280](https://github.com/ably/ably-ruby/issues/280)
+- Write spec tests for RSC7a, RSC7c \(RestClient\)
+ [\#279](https://github.com/ably/ably-ruby/issues/279)
+- Add support for DataTypes ChannelOptions TB2c, d [\#278](https://github.com/ably/ably-ruby/issues/278)
+- Add support for DataTypes TokenParams AO2g [\#277](https://github.com/ably/ably-ruby/issues/277)
+- Add support for DataTypes ClientOptions TO3j10 [\#276](https://github.com/ably/ably-ruby/issues/276)
+- Add support for DataTypes ErrorInfo TI1 [\#275](https://github.com/ably/ably-ruby/issues/275)
+- Add support for DataTypes ProtocolMessage TR3f, TR4i, q [\#274](https://github.com/ably/ably-ruby/issues/274)
+- Add support for TM2i \(DataTypes Message\) [\#273](https://github.com/ably/ably-ruby/issues/273)
+- Add support for PC1, PC2, PC3, PC3a \(Plugins\) [\#272](https://github.com/ably/ably-ruby/issues/272)
+- Add support  for RSL6b, RLS7 \(Channels\) [\#271](https://github.com/ably/ably-ruby/issues/271)
+- Add support for RSL1a, b, h, k1, k2, l, l1 \(Channels\) [\#270](https://github.com/ably/ably-ruby/issues/270)
+- Add support for RSC15e, d, f \(Host Fallback \)
+ [\#267](https://github.com/ably/ably-ruby/issues/267)
+- Update client options support to 1.1 spec level \(logExceptionReportingUrl\) [\#246](https://github.com/ably/ably-ruby/issues/246)
+- Confirm status of remaining realtime spec items for 1.0 [\#244](https://github.com/ably/ably-ruby/issues/244)
+
+**Merged pull requests:**
+
+- Allowing ConnectionDetails\#max\_message\_size [\#342](https://github.com/ably/ably-ruby/pull/342) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Add specs for RTL17 [\#335](https://github.com/ably/ably-ruby/pull/335) ([TheSmartnik](https://github.com/TheSmartnik))
+- Add spec for RTP5b [\#332](https://github.com/ably/ably-ruby/pull/332) ([TheSmartnik](https://github.com/TheSmartnik))
+- Update specs with comments to docs seciton for RSN3a/RSN3c [\#331](https://github.com/ably/ably-ruby/pull/331) ([TheSmartnik](https://github.com/TheSmartnik))
+- Fix after suite hook in specs [\#329](https://github.com/ably/ably-ruby/pull/329) ([TheSmartnik](https://github.com/TheSmartnik))
+- Add specs for RTN15h2 [\#328](https://github.com/ably/ably-ruby/pull/328) ([TheSmartnik](https://github.com/TheSmartnik))
+- Add specs for RTN12f [\#327](https://github.com/ably/ably-ruby/pull/327) ([TheSmartnik](https://github.com/TheSmartnik))
+- Added Channel\#set\_options and Channel\#options= aliases [\#326](https://github.com/ably/ably-ruby/pull/326) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Added DeltaExtras class and Message\#delta\_extras method. \(TM2i\) [\#325](https://github.com/ably/ably-ruby/pull/325) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- When connection disconnectes and can't renew token it fails \(RTN15h1\) [\#324](https://github.com/ably/ably-ruby/pull/324) ([TheSmartnik](https://github.com/TheSmartnik))
+- RTN-13c Add spec that channels do not reattach when connection isn't connected [\#323](https://github.com/ably/ably-ruby/pull/323) ([TheSmartnik](https://github.com/TheSmartnik))
+- Add support for DataTypes ProtocolMessage: has\_attach\_resume\_flag? [\#322](https://github.com/ably/ably-ruby/pull/322) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Added request\_id and cause attributes to the ErrorInfo class TI1, RSC7c [\#321](https://github.com/ably/ably-ruby/pull/321) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Add spec for RTN12d [\#318](https://github.com/ably/ably-ruby/pull/318) ([TheSmartnik](https://github.com/TheSmartnik))
+- Change behavior when reconnecting from failed state \(RTN11d\) [\#316](https://github.com/ably/ably-ruby/pull/316) ([TheSmartnik](https://github.com/TheSmartnik))
+- Remove deprecated ProtocolMessage\#connection\_key TR4e [\#315](https://github.com/ably/ably-ruby/pull/315) ([TheSmartnik](https://github.com/TheSmartnik))
+- Upgrade rspec to 3.10 [\#314](https://github.com/ably/ably-ruby/pull/314) ([lukaszsliwa](https://github.com/lukaszsliwa))
+- Add a spec for \#RTN11c [\#257](https://github.com/ably/ably-ruby/pull/257) ([TheSmartnik](https://github.com/TheSmartnik))
+
+
 ## [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)

data/COPYRIGHT

@@ -1 +1 @@
-Copyright 2015-2021 Ably Real-time Ltd (ably.com)
+Copyright 2015-2022 Ably Real-time Ltd (ably.com)

data/README.md

@@ -5,11 +5,11 @@
 
 _[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).
+This is a Ruby client library for Ably. The library currently targets the [Ably 1.2 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+. For eventmachine and Ruby 3.0 note please visit [Ruby 3.0 support](#ruby-30-support) section.
+This SDK supports Ruby 2.7 and 3.x. For eventmachine and Ruby 3.x 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`.
 

data/SPEC.md

@@ -3299,8 +3299,6 @@ _(see [spec/unit/models/protocol_message_spec.rb](./spec/unit/models/protocol_me
         * [retrieves attribute :channel_serial](./spec/shared/model_behaviour.rb#L15)
       * #connection_id
         * [retrieves attribute :connection_id](./spec/shared/model_behaviour.rb#L15)
-      * #connection_key
-        * [retrieves attribute :connection_key](./spec/shared/model_behaviour.rb#L15)
     * #==
       * [is true when attributes are the same](./spec/shared/model_behaviour.rb#L41)
       * [is false when attributes are not the same](./spec/shared/model_behaviour.rb#L46)
@@ -3386,11 +3384,6 @@ _(see [spec/unit/models/protocol_message_spec.rb](./spec/unit/models/protocol_me
         * [contains the attributes from the JSON auth details](./spec/unit/models/protocol_message_spec.rb#L358)
       * without a JSON value
         * [contains an empty AuthDetails object](./spec/unit/models/protocol_message_spec.rb#L366)
-    * #connection_key (#TR4e)
-      * existing only in #connection_details.connection_key
-        * [is returned](./spec/unit/models/protocol_message_spec.rb#L377)
-      * existing in both #connection_key and #connection_details.connection_key
-        * [returns #connection_details.connection_key as #connection_key will be deprecated > 0.8](./spec/unit/models/protocol_message_spec.rb#L385)
 
 ### Ably::Models::PushChannelSubscription
 _(see [spec/unit/models/push_channel_subscription_spec.rb](./spec/unit/models/push_channel_subscription_spec.rb))_

data/UPDATING.md

@@ -0,0 +1,30 @@
+# Upgrade / Migration Guide
+
+## Version 1.1.8 to 1.2.0
+
+### Notable Changes
+This release is all about channel options. Here is the full [changelog](https://github.com/ably/ably-ruby/blob/main/CHANGELOG.md)
+
+* Channel options were extracted into a seperate model [ChannelOptions](https://github.com/ably/ably-ruby/blob/main/lib/ably/models/channel_options.rb). However it's still backward campatible with `Hash` and you don't need to do make any adjustments to your code
+
+* The `ChannelOptions` class now supports `:params`, `:modes` and `:cipher` as options. Previously only `:cipher` was available
+
+* The client `:idempotent_rest_publishing` option is `true` by default. Previously `:idempotent_rest_publishing` was `false` by default.
+
+### Breaking Changes
+
+* Changing channel options with `Channels#get` is now deprecated in favor of explicit options change
+
+  1. If channel state is attached or attaching an exception will be raised
+  2. Otherwise the library will emit a warning
+
+For example, the following code
+```
+  client.channels.get(channel_name, new_channel_options)
+```
+
+Should be changed to:
+```
+  channel = client.channels.get(channel_name)
+  channel.options = new_channel_options
+```

data/ably.gemspec

@@ -20,41 +20,28 @@ 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', '~> 8.0'
-  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'statesman', '~> 9.0'
+  spec.add_runtime_dependency 'faraday', '~> 2.2'
+  spec.add_runtime_dependency 'faraday-typhoeus', '~> 0.2.0'
   spec.add_runtime_dependency 'typhoeus', '~> 1.4'
-
-  if RUBY_VERSION.match(/^1\./)
-    spec.add_runtime_dependency 'json', '< 2.0'
-  else
-    spec.add_runtime_dependency 'json'
-  end
+  spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency 'websocket-driver', '~> 0.7'
   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 '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', '~> 3.11.0'
   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', '>= 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', '~> 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', '~> 0.14.1'
-      spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
-    end
-  end
+  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.8'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
 
   if RUBY_VERSION.match(/^3\./)
     spec.add_development_dependency 'webrick', '~> 1.7.0'

data/lib/ably/auth.rb

@@ -5,9 +5,9 @@ require 'securerandom'
 require 'ably/rest/middleware/external_exceptions'
 
 module Ably
-  # Auth is responsible for authentication with {https://www.ably.io Ably} using basic or token authentication
+  # Auth is responsible for authentication with {https://www.ably.com Ably} using basic or token authentication
   #
-  # Find out more about Ably authentication at: https://www.ably.io/documentation/general/authentication/
+  # Find out more about Ably authentication at: https://www.ably.com/docs/general/authentication/
   #
   # @!attribute [r] client_id
   #   @return [String] The provided client ID, used for identifying this client for presence purposes
@@ -35,7 +35,7 @@ module Ably
 
     API_KEY_REGEX = /^[\w-]{2,}\.[\w-]{2,}:[\w-]{2,}$/
 
-    # Supported AuthOption keys, see https://www.ably.io/documentation/realtime/types#auth-options
+    # Supported AuthOption keys, see https://www.ably.com/docs/realtime/types#auth-options
     # TODO: Review client_id usage embedded incorrectly within AuthOptions.
     #       This is legacy code to configure a client with a client_id from the ClientOptions
     # TODO: Review inclusion of use_token_auth, ttl, token_params in auth options
@@ -277,7 +277,7 @@ module Ably
     #
     # @param [Hash] token_params the token params used in the token request
     # @option token_params [String]  :client_id     A client ID to associate with this token. The generated token may be used to authenticate as this +client_id+
-    # @option token_params [Integer] :ttl           validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.io/documentation/other/authentication}
+    # @option token_params [Integer] :ttl           validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.com/docs/general/authentication}
     # @option token_params [Hash]    :capability    canonicalised representation of the resource paths and associated operations
     # @option token_params [Time]    :timestamp     the time of the request
     # @option token_params [String]  :nonce         an unquoted, unescaped random string of at least 16 characters
@@ -285,7 +285,7 @@ module Ably
     # @param [Hash] auth_options the authentication options for the token request
     # @option auth_options [String]  :key           API key comprising the key name and key secret in a single string
     # @option auth_options [String]  :client_id     client ID identifying this connection to other clients (will use +client_id+ specified when library was instanced if provided)
-    # @option auth_options [Boolean] :query_time    when true will query the {https://www.ably.io Ably} system for the current time instead of using the local time
+    # @option auth_options [Boolean] :query_time    when true will query the {https://www.ably.com Ably} system for the current time instead of using the local time
     # @option auth_options [Hash]    :token_params  convenience to pass in +token_params+ within the +auth_options+ argument, especially useful when setting default token_params in the client constructor
     #
     # @return [Models::TokenRequest]
@@ -510,11 +510,11 @@ module Ably
     end
 
     def authorize_when_necessary
-      if current_token_details && !current_token_details.expired?
+      if current_token_details && !current_token_details.expired?(from: current_time)
         return current_token_details
-      else
-        authorize
       end
+
+      authorize
     end
 
     # Returns the current device clock time unless the

data/lib/ably/logger.rb

@@ -7,9 +7,9 @@ module Ably
     extend Forwardable
 
     # @param client        [Ably::Rest::Client,Ably::Realtime::Client] Rest or Realtime Ably client
-    # @param log_level     [Integer] {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} log level
+    # @param log_level     [Integer] {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger} log level
     # @param custom_logger [nil,Object] A custom logger can optionally be used instead of the,
-    #                      however it must provide a {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
+    #                      however it must provide a {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
     #
     def initialize(client, log_level, custom_logger = nil)
       @client        = client
@@ -24,7 +24,7 @@ module Ably
       @log_mutex = Mutex.new
     end
 
-    # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger}
+    # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger}
     # @return {Object,Logger}
     attr_reader :logger
 
@@ -32,7 +32,7 @@ module Ably
     # @return {nil,Object}
     attr_reader :custom_logger
 
-    # The log level ranging from DEBUG to FATAL, refer to http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html
+    # The log level ranging from DEBUG to FATAL, refer to http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html
     # @return {Integer}
     attr_reader :log_level
 

data/lib/ably/models/channel_options.rb

@@ -0,0 +1,97 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelOptions} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelOptions]
+  def self.ChannelOptions(attributes)
+    case attributes
+    when ChannelOptions
+      return attributes
+    else
+      ChannelOptions.new(attributes)
+    end
+  end
+
+  # Represents options of a channel
+  class ChannelOptions
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    MODES = ruby_enum('MODES',
+      presence: 0,
+      publish: 1,
+      subscribe: 2,
+      presence_subscribe: 3
+    )
+
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    def_delegators :attributes, :fetch, :size, :empty?
+    # Initialize a new ChannelOptions
+    #
+    # @option params [Hash] (TB2c) params (for realtime client libraries only) a  of key/value pairs
+    # @option modes [Hash] modes (for realtime client libraries only) an array of ChannelMode
+    # @option cipher [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.
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+
+      attributes[:modes] = modes.to_a.map { |mode| Ably::Models::ChannelOptions::MODES[mode] } if modes
+      attributes[:cipher] = Ably::Models::CipherParams(cipher) if cipher
+      attributes.clone
+    end
+
+    # @!attribute cipher
+    #
+    # @return [CipherParams]
+    def cipher
+      attributes[:cipher]
+    end
+
+    # @!attribute params
+    #
+    # @return [Hash]
+    def params
+      attributes[:params].to_h
+    end
+
+    # @!attribute modes
+    #
+    # @return [Array<ChannelOptions::MODES>]
+    def modes
+      attributes[:modes]
+    end
+
+    # Converts modes to a bitfield that coresponds to ProtocolMessage#flags
+    #
+    # @return [Integer]
+    def modes_to_flags
+      modes.map { |mode| Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[mode.to_sym] }.reduce(:|)
+    end
+
+    # @return [Hash]
+    # @api private
+    def set_params(hash)
+      attributes[:params] = hash
+    end
+
+    # Sets modes from ProtocolMessage#flags
+    #
+    # @return [Array<ChannelOptions::MODES>]
+    # @api private
+    def set_modes_from_flags(flags)
+      return unless flags
+
+      message_modes = MODES.select do |mode|
+        flag = Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[mode.to_sym]
+        flags & flag == flag
+      end
+
+      attributes[:modes] = message_modes.map { |mode| Ably::Models::ChannelOptions::MODES[mode] }
+    end
+  end
+end

data/lib/ably/models/connection_details.rb

@@ -21,6 +21,12 @@ module Ably::Models
   class ConnectionDetails
     include Ably::Modules::ModelCommon
 
+    # Max message size
+    MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
+
+    # Max frame size
+    MAX_FRAME_SIZE = 524288 # See spec TO3l9
+
     # @param attributes [Hash]
     # @option attributes [String]    :client_id             contains the client ID assigned to the connection
     # @option attributes [String]    :connection_key        the connection secret key string that is used to resume a connection and its state
@@ -38,8 +44,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[:max_message_size] ||= MAX_MESSAGE_SIZE
+      self.attributes[:max_frame_size] ||= MAX_FRAME_SIZE
       self.attributes.freeze
     end
 

data/lib/ably/models/delta_extras.rb

@@ -0,0 +1,29 @@
+module Ably::Models
+  #
+  # @!attribute [r] from
+  #   @return [String] The id of the message the delta was generated from
+  # @!attribute [r] format
+  #   @return [String] The delta format. Only vcdiff is supported as at API version 1.2
+  #
+  class DeltaExtras
+    include Ably::Modules::ModelCommon
+
+    # The id of the message the delta was generated from.
+    # @return [String, nil]
+    #
+    attr_reader :from
+
+    # The delta format.
+    # @return [String, nil]
+    #
+    attr_reader :format
+
+    def initialize(attributes = {})
+      @from, @format = IdiomaticRubyWrapper((attributes || {}), stop_at: [:from, :format]).attributes.values_at(:from, :format)
+    end
+
+    def to_json(*args)
+      as_json(args).to_json
+    end
+  end
+end

data/lib/ably/models/device_details.rb

@@ -27,7 +27,7 @@ module Ably::Models
   # @!attribute [r] form_factor
   #   @return [String] Device form factor such as phone, tablet, watch
   # @!attribute [r] client_id
-  #   @return [String] The authenticated client identifier for this device. See {https://www.ably.io/documentation/general/authentication#identified-clients auth documentation}.
+  #   @return [String] The authenticated client identifier for this device. See {https://www.ably.com/docs/general/authentication#identified-clients auth documentation}.
   # @!attribute [r] metadata
   #   @return [Hash] Arbitrary metadata that can be associated with a device
   # @!attribute [r] device_secret

data/lib/ably/models/error_info.rb

@@ -27,6 +27,10 @@ module Ably::Models
   #   @return [Integer] Ably error code (see ably-common/protocol/errors.json)
   # @!attribute [r] status
   #   @return [Integer] HTTP Status Code corresponding to this error, where applicable
+  # @!attribute [r] request_id
+  #   @return [Integer] HTTP RequestId corresponding to this error, where applicable (#RSC7c)
+  # @!attribute [r] cause
+  #   @return [Integer] HTTP Status Code corresponding to this error, where applicable (#TI1)
   # @!attribute [r] attributes
   #   @return [Hash] Access the protocol message Hash object ruby'fied to use symbolized keys
   #
@@ -38,7 +42,7 @@ module Ably::Models
       @hash_object     = IdiomaticRubyWrapper(hash_object.clone.freeze)
     end
 
-    %w(message code href status_code).each do |attribute|
+    %w(message code href status_code request_id cause).each do |attribute|
       define_method attribute do
         attributes[attribute.to_sym]
       end
@@ -52,7 +56,7 @@ module Ably::Models
     def to_s
       error_href = href || (code ? "https://help.ably.io/error/#{code}" : '')
       see_msg = " -> see #{error_href} for help" unless message.to_s.include?(error_href.to_s)
-      "<Error: #{message} (code: #{code}, http status: #{status})>#{see_msg}"
+      "<Error: #{message} (code: #{code}, http status: #{status} request_id: #{request_id} cause: #{cause})>#{see_msg}"
     end
   end
 end

data/lib/ably/models/idiomatic_ruby_wrapper.rb

@@ -94,6 +94,10 @@ module Ably::Models
       attributes.size
     end
 
+    def empty?
+      attributes.empty?
+    end
+
     def keys
       map { |key, value| key }
     end

data/lib/ably/models/message.rb

@@ -142,6 +142,9 @@ module Ably::Models
 
     # Contains any arbitrary key value pairs which may also contain other primitive JSON types, JSON-encodable objects or JSON-encodable arrays.
     # The extras field is provided to contain message metadata and/or ancillary payloads in support of specific functionality, e.g. push
+    # 1.2 adds the delta extension which is of type DeltaExtras, and the headers extension, which contains arbitrary string->string key-value pairs,
+    # settable at publish time. Unless otherwise specified, the client library should not attempt to do any filtering or validation of the extras
+    # field itself, but should treat it opaquely, encoding it and passing it to realtime unaltered.
     # @api private
     def extras
       attributes[:extras].tap do |val|
@@ -151,15 +154,23 @@ module Ably::Models
       end
     end
 
-    private
-    def raw_hash_object
-      @raw_hash_object
+    # Delta extras extension (TM2i)
+    # @return [DeltaExtras, nil]
+    # @api private
+    def delta_extras
+      return nil if attributes[:extras][:delta].nil?
+      @delta_extras ||= DeltaExtras.new(attributes[:extras][:delta]).freeze
     end
 
     def protocol_message_index
       protocol_message.messages.map(&:object_id).index(self.object_id)
     end
 
+    private
+    def raw_hash_object
+      @raw_hash_object
+    end
+
     def set_attributes_object(new_attributes)
       @attributes = IdiomaticRubyWrapper(new_attributes.clone, stop_at: [:data, :extras])
     end