ably 1.1.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa84b23cf7efa53651ed44ee5ba5fd19fa1e18b63025b5217cb88d069c095b5a
-  data.tar.gz: 357ce5eb6984d9a0cbc16a96fd267d45de4325d9b885538a9e09550bead51082
+  metadata.gz: f42d74184e0de100d535fa3c01595727b78a6d2cd6018d1743e2593c20fe7ed7
+  data.tar.gz: db674f894bc006187816c0e51df19b84a7473d178b8360271a27640e7b3e4f6e
 SHA512:
-  metadata.gz: f17679d2f885d6cf61d99996a3ebdc7bcf0b03e6edf8b0ca35c26806199f897e39ce033c1454f0082f643824e703a508d465be217a413e88650b7a04bd3faddb
-  data.tar.gz: 3fd85374765d146902fb6f64968fc2f6b9560e40bf168b2d3acf336b6dd94b0f9e98ccf0edcb1b04fb3e38eceb16f41601828c6a4da5a8efe64734e89b1243be
+  metadata.gz: 5950df21ad66e4c59eb6bd772ab71aa91b421679139166ddaa9076ea4fc7cc9a6eb9993a3f4e15e30a2d362a05c008587b153617c967da6a41aa6e0efdc3f091
+  data.tar.gz: a9d61d9b6c12397df274f55028a1fcbd6c285235cb489027188c799949466a6a74c4e6ea3829bd44851be48af14e05a2f7d49494ea61d1ea190176773079df23

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,136 @@
 # Change Log
 
+## [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:**
+
+- create migration guide for the upgrade to ruby 1.2  [\#347](https://github.com/ably/ably-ruby/issues/347)
+- Write spec tests for RTL17 [\#304](https://github.com/ably/ably-ruby/issues/304)
+- Write spec tests for RTL16, RTL16a [\#303](https://github.com/ably/ably-ruby/issues/303)
+- Write spec tests for RTL4m [\#302](https://github.com/ably/ably-ruby/issues/302)
+- Write spec tests for RTL4l [\#301](https://github.com/ably/ably-ruby/issues/301)
+- Write spec tests for RTL4k, RTL4k1 [\#300](https://github.com/ably/ably-ruby/issues/300)
+- Write spec tests for RTL4j, RTL4j1, RTL4j2 [\#299](https://github.com/ably/ably-ruby/issues/299)
+- Write spec tests for RTS3c, RTS3c1 [\#298](https://github.com/ably/ably-ruby/issues/298)
+- Write spec tests for RTS3a [\#297](https://github.com/ably/ably-ruby/issues/297)
+- Add support for RTL21 [\#296](https://github.com/ably/ably-ruby/issues/296)
+- Add support for RTL17 [\#292](https://github.com/ably/ably-ruby/issues/292)
+- Add support for RTL16, RTL16a [\#291](https://github.com/ably/ably-ruby/issues/291)
+- Add support for RTL4m [\#290](https://github.com/ably/ably-ruby/issues/290)
+- Add support for RTL4l [\#289](https://github.com/ably/ably-ruby/issues/289)
+- Add support for RTL4k, RTL4k1 [\#288](https://github.com/ably/ably-ruby/issues/288)
+- Add support for RTL4j, RTL4j1, RTL4j2 [\#287](https://github.com/ably/ably-ruby/issues/287)
+- Add support for RTS3c, RTS3c1 [\#286](https://github.com/ably/ably-ruby/issues/286)
+- Add support for RTS3a [\#285](https://github.com/ably/ably-ruby/issues/285)
+- Write spec tests for RSL1a, b, h, k1, k2, l, l1 \(Channels\) [\#283](https://github.com/ably/ably-ruby/issues/283)
+- Write spec tests for RSN3a, c \(Channels\) [\#282](https://github.com/ably/ably-ruby/issues/282)
+- Write spec tests for RSA4b, b1, c, RSA16 \(Authentication\) [\#281](https://github.com/ably/ably-ruby/issues/281)
+- Add support for RSN3a, c \(Channels\) [\#269](https://github.com/ably/ably-ruby/issues/269)
+- Add support for RSA4b, b1, c, RSA16 \(Authentication\) [\#268](https://github.com/ably/ably-ruby/issues/268)
+- Add support for RSC7a, RSC7c \(RestClient\)
+ [\#266](https://github.com/ably/ably-ruby/issues/266)
+- Add support for Test Guidance G4 [\#265](https://github.com/ably/ably-ruby/issues/265)
+- Add support for TO3o, TO3p [\#264](https://github.com/ably/ably-ruby/issues/264)
+
+**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)
+
+**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/COPYRIGHT

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

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.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+.
+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/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,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,9 +33,9 @@ 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', '~> 3.10.0'
   spec.add_development_dependency 'rspec-retry', '~> 0.6'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'rspec-instafail', '~> 1.0'
@@ -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/agent.rb

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

data/lib/ably/auth.rb

@@ -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/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/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,6 +44,8 @@ module Ably::Models
           self.attributes[duration_field] = (self.attributes[duration_field].to_f / 1000).round
         end
       end
+      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/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

@@ -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)
@@ -128,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|
@@ -137,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

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)