ably-rest 0.7.1 → 0.7.3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 85a727f923a067f8d9391c50c1dde992fc866162
-  data.tar.gz: 9886c7bba136da444d531e11bc23b33e99d83e0d
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmFlZmVjODUzYjUxMzVjNmM3OWRlN2Y5YzAzY2ExNGZlZjFkNDYzYQ==
+  data.tar.gz: !binary |-
+    MDllZThmYmRkYjE3MmQ4NzNlYjE0YjZhNWQ4ZWVkZWRiMTkzNmQ3Nw==
 SHA512:
-  metadata.gz: 4cd6a4f599a2def5ec886cf679bb01d8cc0357ee0ae4bd28369456a3c77497f4ad1b6b988e9b558c130b0a8f5ee1a61f28826f276f1450d52b151753633d01ed
-  data.tar.gz: 0a51a727f2533c3f2c11ce8e0c60c47e0e31ad344e510e7f0caac03e92733d199337b207d400398c06d55ebda1ce875f4ad5024f6d7a5a38ab5d667b4a675290
+  metadata.gz: !binary |-
+    YmRkMTMxNjZlYThhYmY1YzAyNzc5ZjRlNDE3MDk3ZmEzMjI3MmQzMTJlMWM2
+    YzdmOWE0MzY2YWZjY2ZiZDMzNDQxMDQ3M2VlNTJjMWJjOGZhNWEyNGYwNTdj
+    YjEyNWEwNWFmZWUyMDU3ZTcwZDE0MGYzYTNkNGY4MTg1Y2ViMzA=
+  data.tar.gz: !binary |-
+    ZDk1ZWFhMTFiNTE4MzE5ZjAyYzllOGE3MDUwOGRhNGEyNDBmYzA2OTgyODY2
+    YmU4ZjM0Y2MzOWMyZmVmMjlkNWJkNGVjNGQ1OGQ0Y2ViNDRkZDEzYzhlY2I3
+    MWJkN2M5NGM2YjQ4N2I1NDg3YmZhOGFkYzUxYzQ1YjcwYWFiMjc=

data/.gitmodules

@@ -1,3 +1,3 @@
 [submodule "lib/submodules/ably-ruby"]
 	path = lib/submodules/ably-ruby
-	url = git@github.com:ably/ably-ruby.git
+	url = https://github.com/ably/ably-ruby.git

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.2.0
+- 1.9.3
+- 2.0.0
+- 2.2.0
+script: bundle exec rspec
+notifications:
+  slack:
+    secure: wIcB0kscOcVO41zOkOBLHDphzq/Lowrn40MI2mqQtcWcFkvHzcn3fIPoEH0YR8eul7bZ6ZHOLlJw3Qs8gE6VfrqLFVzZuAAv2vtzh26xkZCuQwmCn0o576mTWMSB6H8q71+t7GHZUL/ctMKtJNzwRBilppSaLjktEynS7UdiVO8=

data/SPEC.md

@@ -1,858 +1,934 @@
 # Ably REST Client Library 0.7.1 Specification
 
 ### Ably::Auth
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb))_
   * using JSON and MsgPack protocol
-    * [has immutable options](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L54)
+    * [has immutable options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L54)
     * #request_token
-      * [returns the requested token](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L62)
+      * [returns the requested token](https://github.com/ably/ably-ruby/tree/fa00e7d8516d7da32ca44f46a0bde21057ea422a/spec/acceptance/rest/auth_spec.rb#L62)
       * with option :client_id
-        * [overrides default and uses camelCase notation for all attributes](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L93)
+        * [overrides default and uses camelCase notation for all attributes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L95)
       * with option :capability
-        * [overrides default and uses camelCase notation for all attributes](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L93)
+        * [overrides default and uses camelCase notation for all attributes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L95)
       * with option :nonce
-        * [overrides default and uses camelCase notation for all attributes](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L93)
+        * [overrides default and uses camelCase notation for all attributes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L95)
       * with option :timestamp
-        * [overrides default and uses camelCase notation for all attributes](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L93)
+        * [overrides default and uses camelCase notation for all attributes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L95)
       * with option :ttl
-        * [overrides default and uses camelCase notation for all attributes](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L93)
+        * [overrides default and uses camelCase notation for all attributes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L95)
       * with :key_id & :key_secret options
-        * [key_id is used in request and signing uses key_secret](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L122)
+        * [key_id is used in request and signing uses key_secret](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L124)
       * with :query_time option
-        * [queries the server for the time](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L130)
+        * [queries the server for the time](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L132)
       * without :query_time option
-        * [does not query the server for the time](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L139)
+        * [does not query the server for the time](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L141)
       * with :auth_url option
         * when response is valid
-          * [requests a token from :auth_url using an HTTP GET request](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L186)
+          * [requests a token from :auth_url using an HTTP GET request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L188)
           * with :query_params
-            * [requests a token from :auth_url with the :query_params](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L194)
+            * [requests a token from :auth_url with the :query_params](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L196)
           * with :headers
-            * [requests a token from :auth_url with the HTTP headers set](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L202)
+            * [requests a token from :auth_url with the HTTP headers set](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L204)
           * with POST
-            * [requests a token from :auth_url using an HTTP POST instead of the default GET](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L210)
+            * [requests a token from :auth_url using an HTTP POST instead of the default GET](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L212)
         * when response is invalid
           * 500
-            * [raises ServerError](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L223)
+            * [raises ServerError](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L225)
           * XML
-            * [raises InvalidResponseBody](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L234)
+            * [raises InvalidResponseBody](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L236)
       * with token_request_block
-        * [calls the block when authenticating to obtain the request token](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L252)
-        * [uses the token request from the block when requesting a new token](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L257)
+        * [calls the block when authenticating to obtain the request token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L254)
+        * [uses the token request from the block when requesting a new token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L259)
     * before #authorise has been called
-      * [has no current_token](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L264)
+      * [has no current_token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L266)
     * #authorise
-      * [updates the persisted auth options thare are then used for subsequent authorise requests](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L311)
+      * [updates the persisted auth options thare are then used for subsequent authorise requests](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L313)
       * when called for the first time since the client has been instantiated
-        * [passes all options to #request_token](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L275)
-        * [returns a valid token](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L280)
-        * [issues a new token if option :force => true](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L284)
+        * [passes all options to #request_token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L277)
+        * [returns a valid token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L282)
+        * [issues a new token if option :force => true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L286)
       * with previous authorisation
-        * [does not request a token if current_token has not expired](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L295)
-        * [requests a new token if token is expired](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L300)
-        * [issues a new token if option :force => true](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L306)
+        * [does not request a token if current_token has not expired](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L297)
+        * [requests a new token if token is expired](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L302)
+        * [issues a new token if option :force => true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L308)
       * with token_request_block
-        * [calls the block](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L327)
-        * [uses the token request returned from the block when requesting a new token](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L331)
+        * [calls the block](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L329)
+        * [uses the token request returned from the block when requesting a new token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L333)
         * for every subsequent #request_token
           * without a provided block
-            * [calls the originally provided block](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L337)
+            * [calls the originally provided block](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L339)
           * with a provided block
-            * [does not call the originally provided block and calls the new #request_token block](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L344)
+            * [does not call the originally provided block and calls the new #request_token block](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L346)
     * #create_token_request
-      * [uses the key ID from the client](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L360)
-      * [uses the default TTL](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L364)
-      * [uses the default capability](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L368)
+      * [uses the key ID from the client](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L362)
+      * [uses the default TTL](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L366)
+      * [uses the default capability](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L370)
       * the nonce
-        * [is unique for every request](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L373)
-        * [is at least 16 characters](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L378)
+        * [is unique for every request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L375)
+        * [is at least 16 characters](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L380)
       * with option :ttl
-        * [overrides default](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L389)
+        * [overrides default](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L391)
       * with option :capability
-        * [overrides default](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L389)
+        * [overrides default](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L391)
       * with option :nonce
-        * [overrides default](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L389)
+        * [overrides default](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L391)
       * with option :timestamp
-        * [overrides default](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L389)
+        * [overrides default](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L391)
       * with option :client_id
-        * [overrides default](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L389)
+        * [overrides default](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L391)
       * with additional invalid attributes
-        * [are ignored](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L397)
+        * [are ignored](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L399)
       * when required fields are missing
-        * [should raise an exception if key secret is missing](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L408)
-        * [should raise an exception if key id is missing](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L412)
+        * [should raise an exception if key secret is missing](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L410)
+        * [should raise an exception if key id is missing](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L414)
       * with :query_time option
-        * [queries the server for the timestamp](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L421)
+        * [queries the server for the timestamp](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L423)
       * with :timestamp option
-        * [uses the provided timestamp in the token request](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L431)
+        * [uses the provided timestamp in the token request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L433)
       * signing
-        * [generates a valid HMAC](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L448)
+        * [generates a valid HMAC](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L450)
     * using token authentication
       * with :token_id option
-        * [authenticates successfully using the provided :token_id](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L471)
-        * [disallows publishing on unspecified capability channels](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L475)
-        * [fails if timestamp is invalid](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L483)
-        * [cannot be renewed automatically](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L491)
+        * [authenticates successfully using the provided :token_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L473)
+        * [disallows publishing on unspecified capability channels](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L477)
+        * [fails if timestamp is invalid](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L485)
+        * [cannot be renewed automatically](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L493)
       * when implicit as a result of using :client id
         * and requests to the Ably server are mocked
-          * [will send a token request to the server](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L521)
+          * [will send a token request to the server](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L523)
         * a token is created
-          * [before a request is made](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L530)
-          * [when a message is published](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L534)
-          * [with capability and TTL defaults](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L538)
+          * [before a request is made](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L532)
+          * [when a message is published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L536)
+          * [with capability and TTL defaults](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L540)
     * when using an :api_key and basic auth
-      * [#using_token_auth? is false](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L553)
-      * [#using_basic_auth? is true](./lib/submodules/ably-ruby/spec/acceptance/rest/auth_spec.rb#L557)
+      * [#using_token_auth? is false](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L555)
+      * [#using_basic_auth? is true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/auth_spec.rb#L559)
 
 ### Ably::Rest
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb))_
   * transport protocol
     * when protocol is not defined it defaults to :msgpack
-      * [uses MsgPack](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L27)
+      * [uses MsgPack](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L27)
     * when option {:protocol=>:json} is used
-      * [uses JSON](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L43)
+      * [uses JSON](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L43)
     * when option {:use_binary_protocol=>false} is used
-      * [uses JSON](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L43)
+      * [uses JSON](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L43)
     * when option {:protocol=>:msgpack} is used
-      * [uses MsgPack](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L60)
+      * [uses MsgPack](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L60)
     * when option {:use_binary_protocol=>true} is used
-      * [uses MsgPack](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L60)
+      * [uses MsgPack](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L60)
   * using JSON and MsgPack protocol
     * failed requests
       * due to invalid Auth
-        * [should raise an InvalidRequest exception with a valid error message and code](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L75)
+        * [should raise an InvalidRequest exception with a valid error message and code](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L75)
       * server error with JSON error response body
-        * [should raise a ServerError exception](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L94)
+        * [should raise a ServerError exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L94)
       * 500 server error without a valid JSON response body
-        * [should raise a ServerError exception](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L105)
+        * [should raise a ServerError exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L105)
     * token authentication failures
       * when auth#token_renewable?
-        * [should automatically reissue a token](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L143)
+        * [should automatically reissue a token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L143)
       * when NOT auth#token_renewable?
-        * [should raise an InvalidToken exception](./lib/submodules/ably-ruby/spec/acceptance/rest/base_spec.rb#L156)
+        * [should raise an InvalidToken exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/base_spec.rb#L156)
 
 ### Ably::Rest::Channel
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb))_
   * using JSON and MsgPack protocol
     * #publish
-      * [should publish the message adn return true indicating success](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L17)
+      * [should publish the message adn return true indicating success](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L17)
     * #history
-      * [should return the current message history for the channel](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L39)
-      * [should return paged history using the PaginatedResource model](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L67)
+      * [should return the current message history for the channel](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L39)
+      * [should return paged history using the PaginatedResource model](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L67)
       * message timestamps
-        * [should all be after the messages were published](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L52)
+        * [should all be after the messages were published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L52)
       * message IDs
-        * [should be unique](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L60)
+        * [should be unique](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L60)
     * #history option
       * :start
         * with milliseconds since epoch value
-          * [uses this value in the history request](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L116)
+          * [uses this value in the history request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L116)
         * with a Time object value
-          * [converts the value to milliseconds since epoch in the hisotry request](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L126)
+          * [converts the value to milliseconds since epoch in the hisotry request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L126)
       * :end
         * with milliseconds since epoch value
-          * [uses this value in the history request](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L116)
+          * [uses this value in the history request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L116)
         * with a Time object value
-          * [converts the value to milliseconds since epoch in the hisotry request](./lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb#L126)
+          * [converts the value to milliseconds since epoch in the hisotry request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channel_spec.rb#L126)
 
 ### Ably::Rest::Channels
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channels_spec.rb))_
   * using JSON and MsgPack protocol
     * using shortcut method #channel on the client object
       * behaves like a channel
-        * [returns a channel object](./lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb#L6)
-        * [returns channel object and passes the provided options](./lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb#L11)
+        * [returns a channel object](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channels_spec.rb#L6)
+        * [returns channel object and passes the provided options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channels_spec.rb#L11)
     * using #get method on client#channels
       * behaves like a channel
-        * [returns a channel object](./lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb#L6)
-        * [returns channel object and passes the provided options](./lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb#L11)
+        * [returns a channel object](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channels_spec.rb#L6)
+        * [returns channel object and passes the provided options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channels_spec.rb#L11)
     * using undocumented array accessor [] method on client#channels
       * behaves like a channel
-        * [returns a channel object](./lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb#L6)
-        * [returns channel object and passes the provided options](./lib/submodules/ably-ruby/spec/acceptance/rest/channels_spec.rb#L11)
+        * [returns a channel object](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channels_spec.rb#L6)
+        * [returns channel object and passes the provided options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/channels_spec.rb#L11)
 
 ### Ably::Rest::Client
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb))_
   * using JSON and MsgPack protocol
     * #initialize
       * with an auth block
-        * [calls the block to get a new token](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L20)
+        * [calls the block to get a new token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L20)
       * with an auth URL
-        * [sends an HTTP request to the provided URL to get a new token](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L34)
+        * [sends an HTTP request to the provided URL to get a new token](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L34)
     * using tokens
       * when expired
-        * [creates a new token automatically when the old token expires](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L55)
+        * [creates a new token automatically when the old token expires](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L55)
       * when token has not expired
-        * [reuses the existing token for every request](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L69)
+        * [reuses the existing token for every request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L69)
     * connection transport
       * for default host
-        * [is configured to timeout connection opening in 4 seconds](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L85)
-        * [is configured to timeout connection requests in 15 seconds](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L89)
+        * [is configured to timeout connection opening in 4 seconds](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L85)
+        * [is configured to timeout connection requests in 15 seconds](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L89)
       * for the fallback hosts
-        * [is configured to timeout connection opening in 4 seconds](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L95)
-        * [is configured to timeout connection requests in 15 seconds](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L99)
+        * [is configured to timeout connection opening in 4 seconds](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L95)
+        * [is configured to timeout connection requests in 15 seconds](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L99)
     * fallback hosts
       * configured
-        * [should make connection attempts to A.ably-realtime.com, B.ably-realtime.com, C.ably-realtime.com, D.ably-realtime.com, E.ably-realtime.com](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L112)
+        * [should make connection attempts to A.ably-realtime.com, B.ably-realtime.com, C.ably-realtime.com, D.ably-realtime.com, E.ably-realtime.com](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L112)
       * when environment is NOT production
-        * [does not retry failed requests with fallback hosts when there is a connection error](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L129)
+        * [does not retry failed requests with fallback hosts when there is a connection error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L129)
       * when environment is production
         * and connection times out
-          * [tries fallback hosts 3 times](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L169)
+          * [tries fallback hosts 3 times](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L169)
           * and the total request time exeeds 10 seconds
-            * [makes no further attempts to any fallback hosts](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L184)
+            * [makes no further attempts to any fallback hosts](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L184)
         * and connection fails
-          * [tries fallback hosts 3 times](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L200)
+          * [tries fallback hosts 3 times](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L200)
     * with a custom host
       * that does not exist
-        * [fails immediately and raises a Faraday Error](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L216)
+        * [fails immediately and raises a Faraday Error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L216)
         * fallback hosts
-          * [are never used](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L237)
+          * [are never used](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L237)
       * that times out
-        * [fails immediately and raises a Faraday Error](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L252)
+        * [fails immediately and raises a Faraday Error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L252)
         * fallback hosts
-          * [are never used](./lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb#L265)
+          * [are never used](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/client_spec.rb#L265)
 
 ### Ably::Models::MessageEncoders
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb))_
   * with binary transport protocol
     * without encryption
       * with UTF-8 data
-        * [does not apply any encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L41)
+        * [does not apply any encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L41)
       * with binary data
-        * [does not apply any encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L52)
+        * [does not apply any encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L52)
       * with JSON data
-        * [stringifies the JSON and sets the json encoding type](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L63)
+        * [stringifies the JSON and sets the encoding attribute to "json"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L63)
     * with encryption
       * with UTF-8 data
-        * [applies utf-8 and cipher encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L78)
+        * [applies utf-8 and cipher encoding and sets the encoding attribute to "utf-8/cipher+aes-128-cbc"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L78)
       * with binary data
-        * [applies cipher encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L89)
+        * [applies cipher encoding and sets the encoding attribute to "cipher+aes-128-cbc"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L89)
       * with JSON data
-        * [applies json, utf-8 and cipher encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L100)
+        * [applies json, utf-8 and cipher encoding and sets the encoding attribute to "json/utf-8/cipher+aes-128-cbc"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L100)
   * with text transport protocol
     * without encryption
       * with UTF-8 data
-        * [does not apply any encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L117)
+        * [does not apply any encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L117)
       * with binary data
-        * [applies a base64 encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L128)
+        * [applies a base64 encoding and sets the encoding attribute to "base64"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L128)
       * with JSON data
-        * [stringifies the JSON and sets the json encoding type](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L139)
+        * [stringifies the JSON and sets the encoding attribute to "json"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L139)
     * with encryption
       * with UTF-8 data
-        * [applies utf-8, cipher and base64 encodings](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L154)
+        * [applies utf-8, cipher and base64 encodings and sets the encoding attribute to "utf-8/cipher+aes-128-cbc/base64"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L154)
       * with binary data
-        * [applies cipher and base64 encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L165)
+        * [applies cipher and base64 encoding and sets the encoding attribute to "utf-8/cipher+aes-128-cbc/base64"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L165)
       * with JSON data
-        * [applies json, utf-8, cipher and base64 encoding](./lib/submodules/ably-ruby/spec/acceptance/rest/encoders_spec.rb#L176)
+        * [applies json, utf-8, cipher and base64 encoding and sets the encoding attribute to "json/utf-8/cipher+aes-128-cbc/base64"](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/encoders_spec.rb#L176)
 
 ### Ably::Rest::Channel messages
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb))_
   * using JSON and MsgPack protocol
     * publishing with an ASCII_8BIT message name
-      * [is converted into UTF_8](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L18)
+      * [is converted into UTF_8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L18)
     * encryption and encoding
       * with #publish and #history
         * with AES-128-CBC using crypto-data-128.json fixtures
           * item 0 with encrypted encoding utf-8/cipher+aes-128-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
           * item 1 with encrypted encoding cipher+aes-128-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
           * item 2 with encrypted encoding json/utf-8/cipher+aes-128-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
           * item 3 with encrypted encoding json/utf-8/cipher+aes-128-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
         * with AES-256-CBC using crypto-data-256.json fixtures
           * item 0 with encrypted encoding utf-8/cipher+aes-256-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
           * item 1 with encrypted encoding cipher+aes-256-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
           * item 2 with encrypted encoding json/utf-8/cipher+aes-256-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
           * item 3 with encrypted encoding json/utf-8/cipher+aes-256-cbc/base64
             * behaves like an Ably encrypter and decrypter
-              * [encrypts message automatically when published](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L65)
-              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L80)
+              * [encrypts message automatically when published](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L65)
+              * [sends and retrieves messages that are encrypted & decrypted by the Ably library](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L80)
         * when publishing lots of messages
-          * [encrypts on #publish and decrypts on #history](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L113)
+          * [encrypts on #publish and decrypts on #history](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L113)
         * when retrieving #history with a different protocol
-          * [delivers a String ASCII-8BIT payload to the receiver](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L140)
-          * [delivers a String UTF-8 payload to the receiver](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L140)
-          * [delivers a Hash payload to the receiver](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L140)
+          * [delivers a String ASCII-8BIT payload to the receiver](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L140)
+          * [delivers a String UTF-8 payload to the receiver](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L140)
+          * [delivers a Hash payload to the receiver](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L140)
         * when publishing on an unencrypted channel and retrieving with #history on an encrypted channel
-          * [does not attempt to decrypt the message](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L156)
+          * [does not attempt to decrypt the message](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L156)
         * when publishing on an encrypted channel and retrieving with #history on an unencrypted channel
-          * [retrieves the message that remains encrypted with an encrypted encoding attribute](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L177)
-          * [logs a Cipher exception](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L183)
+          * [retrieves the message that remains encrypted with an encrypted encoding attribute](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L177)
+          * [logs a Cipher exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L183)
         * publishing on an encrypted channel and retrieving #history with a different algorithm on another client
-          * [retrieves the message that remains encrypted with an encrypted encoding attribute](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L204)
-          * [logs a Cipher exception](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L210)
+          * [retrieves the message that remains encrypted with an encrypted encoding attribute](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L204)
+          * [logs a Cipher exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L210)
         * publishing on an encrypted channel and subscribing with a different key on another client
-          * [retrieves the message that remains encrypted with an encrypted encoding attribute](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L231)
-          * [logs a Cipher exception](./lib/submodules/ably-ruby/spec/acceptance/rest/message_spec.rb#L237)
+          * [retrieves the message that remains encrypted with an encrypted encoding attribute](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L231)
+          * [logs a Cipher exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/message_spec.rb#L237)
 
 ### Ably::Rest::Presence
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb))_
   * using JSON and MsgPack protocol
     * tested against presence fixture data set up in test app
       * #get
-        * [returns current members on the channel with their action set to :present](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L31)
+        * [returns current members on the channel with their action set to :present](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L30)
         * with :limit option
-          * [returns a paged response limiting number of members per page](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L45)
+          * [returns a paged response limiting number of members per page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L44)
       * #history
-        * [returns recent presence activity](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L58)
+        * [returns recent presence activity](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L62)
         * with options
           * direction: :forwards
-            * [returns recent presence activity forwards with most recent history last](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L74)
+            * [returns recent presence activity forwards with most recent history last](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L78)
           * direction: :backwards
-            * [returns recent presence activity backwards with most recent history first](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L89)
+            * [returns recent presence activity backwards with most recent history first](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L93)
     * #history
       * with time range options
         * :start
           * with milliseconds since epoch value
-            * [uses this value in the history request](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L134)
+            * [uses this value in the history request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L138)
           * with Time object value
-            * [converts the value to milliseconds since epoch in the hisotry request](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L144)
+            * [converts the value to milliseconds since epoch in the hisotry request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L148)
         * :end
           * with milliseconds since epoch value
-            * [uses this value in the history request](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L134)
+            * [uses this value in the history request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L138)
           * with Time object value
-            * [converts the value to milliseconds since epoch in the hisotry request](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L144)
+            * [converts the value to milliseconds since epoch in the hisotry request](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L148)
     * decoding
       * valid decodeable content
         * #get
-          * [automaticaly decodes presence messages](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L202)
+          * [automaticaly decodes presence messages](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L206)
         * #history
-          * [automaticaly decodes presence messages](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L219)
+          * [automaticaly decodes presence messages](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L223)
       * invalid data
         * #get
-          * [returns the messages still encoded](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L250)
-          * [logs a cipher error](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L254)
+          * [returns the messages still encoded](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L254)
+          * [logs a cipher error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L258)
         * #history
-          * [returns the messages still encoded](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L274)
-          * [logs a cipher error](./lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb#L278)
+          * [returns the messages still encoded](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L278)
+          * [logs a cipher error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/presence_spec.rb#L282)
 
 ### Ably::Rest::Client#stats
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb))_
   * using JSON and MsgPack protocol
     * fetching application stats
       * by minute
-        * [should return all the stats for the application](./lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb#L49)
+        * with :from set to last interval and :limit set to 1
+          * [retrieves only one stat](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L50)
+          * [returns all aggregated message data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L54)
+          * [returns inbound realtime all data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L59)
+          * [returns inbound realtime message data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L64)
+          * [returns outbound realtime all data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L69)
+          * [returns persisted presence all data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L74)
+          * [returns connections all data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L79)
+          * [returns channels all data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L84)
+          * [returns api_requests data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L89)
+          * [returns token_requests data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L94)
+          * [returns stat objects with #interval_granularity equal to :minute](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L99)
+          * [returns stat objects with #interval_id matching :start](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L103)
+          * [returns stat objects with #interval_time matching :start Time](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L107)
+        * with :start set to first interval, :limit set to 1 and direction :forwards
+          * [returns the first interval stats as stats are provided forwards from :start](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L117)
+          * [returns 3 pages of stats](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L121)
+        * with :end set to last interval, :limit set to 1 and direction :backwards
+          * [returns the 3rd interval stats first as stats are provided backwards from :end](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L134)
+          * [returns 3 pages of stats](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L138)
       * by hour
-        * [should return all the stats for the application](./lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb#L49)
+        * [should aggregate the stats for that period](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L162)
       * by day
-        * [should return all the stats for the application](./lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb#L49)
+        * [should aggregate the stats for that period](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L162)
       * by month
-        * [should return all the stats for the application](./lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb#L49)
+        * [should aggregate the stats for that period](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/stats_spec.rb#L162)
 
 ### Ably::Rest::Client#time
-_(see [lib/submodules/ably-ruby/spec/acceptance/rest/time_spec.rb](./lib/submodules/ably-ruby/spec/acceptance/rest/time_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/acceptance/rest/time_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/time_spec.rb))_
   * using JSON and MsgPack protocol
     * fetching the service time
-      * [should return the service time as a Time object](./lib/submodules/ably-ruby/spec/acceptance/rest/time_spec.rb#L10)
+      * [should return the service time as a Time object](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/acceptance/rest/time_spec.rb#L10)
 
 ### Ably::Auth
-_(see [lib/submodules/ably-ruby/spec/unit/auth_spec.rb](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/auth_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb))_
   * client_id option
     * with nil value
-      * [is permitted](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L19)
+      * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L19)
     * as UTF_8 string
-      * [is permitted](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L27)
-      * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L31)
+      * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L27)
+      * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L31)
     * as SHIFT_JIS string
-      * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L39)
-      * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L43)
+      * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L39)
+      * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L43)
     * as ASCII_8BIT string
-      * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L51)
-      * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L55)
+      * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L51)
+      * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L55)
     * as Integer
-      * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/auth_spec.rb#L63)
+      * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/auth_spec.rb#L63)
 
 ### Ably::Logger
-_(see [lib/submodules/ably-ruby/spec/unit/logger_spec.rb](./lib/submodules/ably-ruby/spec/unit/logger_spec.rb))_
-  * [uses the language provided Logger by default](./lib/submodules/ably-ruby/spec/unit/logger_spec.rb#L15)
+_(see [lib/submodules/ably-ruby/spec/unit/logger_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/logger_spec.rb))_
+  * [uses the language provided Logger by default](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/logger_spec.rb#L15)
   * with a custom Logger
     * with an invalid interface
-      * [raises an exception](./lib/submodules/ably-ruby/spec/unit/logger_spec.rb#L116)
+      * [raises an exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/logger_spec.rb#L116)
     * with a valid interface
-      * [is used](./lib/submodules/ably-ruby/spec/unit/logger_spec.rb#L135)
+      * [is used](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/logger_spec.rb#L135)
 
 ### Ably::Models::ErrorInfo
-_(see [lib/submodules/ably-ruby/spec/unit/models/error_info_spec.rb](./lib/submodules/ably-ruby/spec/unit/models/error_info_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/models/error_info_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/error_info_spec.rb))_
   * behaves like a model
     * attributes
       * #code
-        * [retrieves attribute :code](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :code](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #status_code
-        * [retrieves attribute :status_code](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :status_code](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #message
-        * [retrieves attribute :message](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :message](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
     * #==
-      * [is true when attributes are the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L41)
-      * [is false when attributes are not the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L46)
-      * [is false when class type differs](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L50)
+      * [is true when attributes are the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L41)
+      * [is false when attributes are not the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L46)
+      * [is false when class type differs](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L50)
     * is immutable
-      * [prevents changes](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L76)
-      * [dups options](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L80)
+      * [prevents changes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L76)
+      * [dups options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L80)
   * #status
-    * [is an alias for #status_code](./lib/submodules/ably-ruby/spec/unit/models/error_info_spec.rb#L13)
+    * [is an alias for #status_code](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/error_info_spec.rb#L13)
 
 ### Ably::Models::Message
-_(see [lib/submodules/ably-ruby/spec/unit/models/message_spec.rb](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/models/message_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb))_
   * behaves like a model
     * attributes
       * #name
-        * [retrieves attribute :name](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :name](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #client_id
-        * [retrieves attribute :client_id](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :client_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #data
-        * [retrieves attribute :data](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #encoding
-        * [retrieves attribute :encoding](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
     * #==
-      * [is true when attributes are the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L41)
-      * [is false when attributes are not the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L46)
-      * [is false when class type differs](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L50)
+      * [is true when attributes are the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L41)
+      * [is false when attributes are not the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L46)
+      * [is false when class type differs](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L50)
     * is immutable
-      * [prevents changes](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L76)
-      * [dups options](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L80)
+      * [prevents changes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L76)
+      * [dups options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L80)
   * #timestamp
-    * [retrieves attribute :timestamp as Time object from ProtocolMessage](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L21)
+    * [retrieves attribute :timestamp as Time object from ProtocolMessage](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L21)
   * #connection_id attribute
     * when this model has a connectionId attribute
       * but no protocol message
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L36)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L36)
       * with a protocol message with a different connectionId
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L44)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L44)
     * when this model has no connectionId attribute
       * and no protocol message
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L54)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L54)
       * with a protocol message with a connectionId
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L62)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L62)
   * initialized with
     * :name
       * as UTF_8 string
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L89)
-        * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L93)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L89)
+        * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L93)
       * as SHIFT_JIS string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L101)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L105)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L101)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L105)
       * as ASCII_8BIT string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L113)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L117)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L113)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L117)
       * as Integer
-        * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L125)
+        * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L125)
       * as Nil
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L133)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L133)
     * :client_id
       * as UTF_8 string
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L89)
-        * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L93)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L89)
+        * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L93)
       * as SHIFT_JIS string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L101)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L105)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L101)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L105)
       * as ASCII_8BIT string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L113)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L117)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L113)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L117)
       * as Integer
-        * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L125)
+        * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L125)
       * as Nil
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L133)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L133)
     * :encoding
       * as UTF_8 string
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L89)
-        * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L93)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L89)
+        * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L93)
       * as SHIFT_JIS string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L101)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L105)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L101)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L105)
       * as ASCII_8BIT string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L113)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L117)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L113)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L117)
       * as Integer
-        * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L125)
+        * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L125)
       * as Nil
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/message_spec.rb#L133)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/message_spec.rb#L133)
 
 ### Ably::Models::PaginatedResource
-_(see [lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb))_
-  * [returns correct length from body](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L30)
-  * [supports alias methods for length](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L34)
-  * [is Enumerable](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L39)
-  * [is iterable](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L43)
-  * [provides [] accessor method](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L61)
-  * [#first gets the first item in page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L67)
-  * [#last gets the last item in page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L71)
+_(see [lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb))_
+  * [returns correct length from body](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L30)
+  * [supports alias methods for length](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L34)
+  * [is Enumerable](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L39)
+  * [is iterable](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L43)
+  * [provides [] accessor method](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L61)
+  * [#first gets the first item in page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L67)
+  * [#last gets the last item in page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L71)
   * #each
-    * [returns an enumerator](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L48)
-    * [yields each item](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L52)
+    * [returns an enumerator](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L48)
+    * [yields each item](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L52)
   * with non paged http response
-    * [is the first page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L175)
-    * [is the last page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L179)
-    * [does not support pagination](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L183)
-    * [raises an exception when accessing next page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L187)
-    * [raises an exception when accessing first page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L191)
+    * [is the first page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L175)
+    * [is the last page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L179)
+    * [does not support pagination](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L183)
+    * [raises an exception when accessing next page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L187)
+    * [raises an exception when accessing first page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L191)
   * with paged http response
-    * [is the first page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L209)
-    * [is not the last page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L213)
-    * [supports pagination](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L217)
+    * [is the first page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L209)
+    * [is not the last page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L213)
+    * [supports pagination](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L217)
     * accessing next page
-      * [returns another PaginatedResource](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L245)
-      * [retrieves the next page of results](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L249)
-      * [is not the first page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L254)
-      * [is the last page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L258)
-      * [raises an exception if trying to access the last page when it is the last page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L262)
+      * [returns another PaginatedResource](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L245)
+      * [retrieves the next page of results](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L249)
+      * [is not the first page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L254)
+      * [is the last page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L258)
+      * [raises an exception if trying to access the last page when it is the last page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L262)
       * and then first page
-        * [returns a PaginatedResource](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L273)
-        * [retrieves the first page of results](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L277)
-        * [is the first page](./lib/submodules/ably-ruby/spec/unit/models/paginated_resource_spec.rb#L281)
+        * [returns a PaginatedResource](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L273)
+        * [retrieves the first page of results](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L277)
+        * [is the first page](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/paginated_resource_spec.rb#L281)
 
 ### Ably::Models::PresenceMessage
-_(see [lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb))_
   * behaves like a model
     * attributes
       * #client_id
-        * [retrieves attribute :client_id](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :client_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #data
-        * [retrieves attribute :data](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :data](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #encoding
-        * [retrieves attribute :encoding](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
     * #==
-      * [is true when attributes are the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L41)
-      * [is false when attributes are not the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L46)
-      * [is false when class type differs](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L50)
+      * [is true when attributes are the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L41)
+      * [is false when attributes are not the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L46)
+      * [is false when class type differs](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L50)
     * is immutable
-      * [prevents changes](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L76)
-      * [dups options](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L80)
+      * [prevents changes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L76)
+      * [dups options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L80)
   * #connection_id attribute
     * when this model has a connectionId attribute
       * but no protocol message
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L25)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L25)
       * with a protocol message with a different connectionId
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L33)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L33)
     * when this model has no connectionId attribute
       * and no protocol message
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L43)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L43)
       * with a protocol message with a connectionId
-        * [uses the model value](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L51)
+        * [uses the model value](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L51)
   * #member_key attribute
-    * [is string in format connection_id:client_id](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L61)
+    * [is string in format connection_id:client_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L61)
     * with the same client id across multiple connections
-      * [is unique](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L69)
+      * [is unique](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L69)
     * with a single connection and different client_ids
-      * [is unique](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L78)
+      * [is unique](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L78)
   * #timestamp
-    * [retrieves attribute :timestamp as a Time object from ProtocolMessage](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L86)
+    * [retrieves attribute :timestamp as a Time object from ProtocolMessage](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L86)
   * initialized with
     * :client_id
       * as UTF_8 string
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L138)
-        * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L142)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L138)
+        * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L142)
       * as SHIFT_JIS string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L150)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L154)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L150)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L154)
       * as ASCII_8BIT string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L162)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L166)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L162)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L166)
       * as Integer
-        * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L174)
+        * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L174)
       * as Nil
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L182)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L182)
     * :connection_id
       * as UTF_8 string
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L138)
-        * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L142)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L138)
+        * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L142)
       * as SHIFT_JIS string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L150)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L154)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L150)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L154)
       * as ASCII_8BIT string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L162)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L166)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L162)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L166)
       * as Integer
-        * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L174)
+        * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L174)
       * as Nil
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L182)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L182)
     * :encoding
       * as UTF_8 string
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L138)
-        * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L142)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L138)
+        * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L142)
       * as SHIFT_JIS string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L150)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L154)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L150)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L154)
       * as ASCII_8BIT string
-        * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L162)
-        * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L166)
+        * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L162)
+        * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L166)
       * as Integer
-        * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L174)
+        * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L174)
       * as Nil
-        * [is permitted](./lib/submodules/ably-ruby/spec/unit/models/presence_message_spec.rb#L182)
+        * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/presence_message_spec.rb#L182)
 
 ### Ably::Models::ProtocolMessage
-_(see [lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb))_
   * behaves like a model
     * attributes
       * #id
-        * [retrieves attribute :id](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #channel
-        * [retrieves attribute :channel](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :channel](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #channel_serial
-        * [retrieves attribute :channel_serial](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :channel_serial](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #connection_id
-        * [retrieves attribute :connection_id](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :connection_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
     * #==
-      * [is true when attributes are the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L41)
-      * [is false when attributes are not the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L46)
-      * [is false when class type differs](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L50)
+      * [is true when attributes are the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L41)
+      * [is false when attributes are not the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L46)
+      * [is false when class type differs](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L50)
     * is immutable
-      * [prevents changes](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L76)
-      * [dups options](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L80)
+      * [prevents changes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L76)
+      * [dups options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L80)
   * attributes
     * #timestamp
-      * [retrieves attribute :timestamp as Time object](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L74)
+      * [retrieves attribute :timestamp as Time object](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L74)
     * #count
       * when missing
-        * [is 1](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L83)
+        * [is 1](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L83)
       * when non numeric
-        * [is 1](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L90)
+        * [is 1](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L90)
       * when greater than 1
-        * [is the value of count](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L97)
+        * [is the value of count](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L97)
     * #message_serial
-      * [converts :msg_serial to an Integer](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L105)
+      * [converts :msg_serial to an Integer](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L105)
     * #has_message_serial?
       * without msg_serial
-        * [returns false](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L115)
+        * [returns false](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L115)
       * with msg_serial
-        * [returns true](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L123)
+        * [returns true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L123)
     * #connection_serial
-      * [converts :connection_serial to an Integer](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L131)
+      * [converts :connection_serial to an Integer](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L131)
     * #flags
       * when nil
-        * [is zero](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L141)
+        * [is zero](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L141)
       * when numeric
-        * [is an Integer](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L149)
+        * [is an Integer](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L149)
       * when has_presence
-        * [#has_presence_flag? is true](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L157)
+        * [#has_presence_flag? is true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L157)
       * when has another future flag
-        * [#has_presence_flag? is false](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L165)
+        * [#has_presence_flag? is false](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L165)
     * #has_connection_serial?
       * without connection_serial
-        * [returns false](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L175)
+        * [returns false](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L175)
       * with connection_serial
-        * [returns true](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L183)
+        * [returns true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L183)
     * #serial
       * with underlying msg_serial
-        * [converts :msg_serial to an Integer](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L192)
+        * [converts :msg_serial to an Integer](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L192)
       * with underlying connection_serial
-        * [converts :connection_serial to an Integer](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L200)
+        * [converts :connection_serial to an Integer](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L200)
       * with underlying connection_serial and msg_serial
-        * [prefers connection_serial and converts :connection_serial to an Integer](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L208)
+        * [prefers connection_serial and converts :connection_serial to an Integer](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L208)
     * #has_serial?
       * without msg_serial or connection_serial
-        * [returns false](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L219)
+        * [returns false](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L219)
       * with msg_serial
-        * [returns true](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L227)
+        * [returns true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L227)
       * with connection_serial
-        * [returns true](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L235)
+        * [returns true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L235)
     * #error
       * with no error attribute
-        * [returns nil](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L245)
+        * [returns nil](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L245)
       * with nil error
-        * [returns nil](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L253)
+        * [returns nil](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L253)
       * with error
-        * [returns a valid ErrorInfo object](./lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb#L261)
+        * [returns a valid ErrorInfo object](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/protocol_message_spec.rb#L261)
+
+### Ably::Models::Stat
+_(see [lib/submodules/ably-ruby/spec/unit/models/stat_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb))_
+  * behaves like a model
+    * attributes
+      * #interval_id
+        * [retrieves attribute :interval_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #all
+        * [retrieves attribute :all](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #inbound
+        * [retrieves attribute :inbound](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #outbound
+        * [retrieves attribute :outbound](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #persisted
+        * [retrieves attribute :persisted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #connections
+        * [retrieves attribute :connections](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #channels
+        * [retrieves attribute :channels](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #api_requests
+        * [retrieves attribute :api_requests](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+      * #token_requests
+        * [retrieves attribute :token_requests](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
+    * #==
+      * [is true when attributes are the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L41)
+      * [is false when attributes are not the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L46)
+      * [is false when class type differs](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L50)
+    * is immutable
+      * [prevents changes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L76)
+      * [dups options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L80)
+  * #interval_granularity
+    * [returns the granularity of the interval_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L17)
+  * #interval_time
+    * [returns a Time object representing the start of the interval](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L25)
+  * class methods
+    * #to_interval_id
+      * when time zone of time argument is UTC
+        * [converts time 2014-02-03:05:06 with granularity :month into 2014-02](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L33)
+        * [converts time 2014-02-03:05:06 with granularity :day into 2014-02-03](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L37)
+        * [converts time 2014-02-03:05:06 with granularity :hour into 2014-02-03:05](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L41)
+        * [converts time 2014-02-03:05:06 with granularity :minute into 2014-02-03:05:06](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L45)
+        * [fails with invalid granularity](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L49)
+        * [fails with invalid time](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L53)
+      * when time zone of time argument is +02:00
+        * [converts time 2014-02-03:06 with granularity :hour into 2014-02-03:04 at UTC +00:00](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L59)
+    * #from_interval_id
+      * [converts a month interval_id 2014-02 into a Time object in UTC 0](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L66)
+      * [converts a day interval_id 2014-02-03 into a Time object in UTC 0](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L71)
+      * [converts an hour interval_id 2014-02-03:05 into a Time object in UTC 0](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L76)
+      * [converts a minute interval_id 2014-02-03:05:06 into a Time object in UTC 0](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L81)
+      * [fails with an invalid interval_id 14-20](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L86)
+    * #granularity_from_interval_id
+      * [returns a :month interval_id for 2014-02](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L92)
+      * [returns a :day interval_id for 2014-02-03](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L96)
+      * [returns a :hour interval_id for 2014-02-03:05](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L100)
+      * [returns a :minute interval_id for 2014-02-03:05:06](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L104)
+      * [fails with an invalid interval_id 14-20](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/stat_spec.rb#L108)
 
 ### Ably::Models::Token
-_(see [lib/submodules/ably-ruby/spec/unit/models/token_spec.rb](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/models/token_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb))_
   * behaves like a model
     * attributes
       * #id
-        * [retrieves attribute :id](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #capability
-        * [retrieves attribute :capability](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :capability](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #client_id
-        * [retrieves attribute :client_id](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :client_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
       * #nonce
-        * [retrieves attribute :nonce](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L15)
+        * [retrieves attribute :nonce](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L15)
     * #==
-      * [is true when attributes are the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L41)
-      * [is false when attributes are not the same](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L46)
-      * [is false when class type differs](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L50)
+      * [is true when attributes are the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L41)
+      * [is false when attributes are not the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L46)
+      * [is false when class type differs](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L50)
     * is immutable
-      * [prevents changes](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L76)
-      * [dups options](./lib/submodules/ably-ruby/spec/shared/model_behaviour.rb#L80)
+      * [prevents changes](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L76)
+      * [dups options](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/model_behaviour.rb#L80)
   * defaults
-    * [should default TTL to 1 hour](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L14)
-    * [should default capability to all](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L18)
-    * [should only have defaults for :ttl and :capability](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L22)
+    * [should default TTL to 1 hour](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L14)
+    * [should default capability to all](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L18)
+    * [should only have defaults for :ttl and :capability](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L22)
   * attributes
     * #key_id
-      * [retrieves attribute :key](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L32)
+      * [retrieves attribute :key](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L32)
     * #issued_at
-      * [retrieves attribute :issued_at as Time](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L42)
+      * [retrieves attribute :issued_at as Time](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L42)
     * #expires_at
-      * [retrieves attribute :expires as Time](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L42)
+      * [retrieves attribute :expires as Time](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L42)
     * #expired?
       * once grace period buffer has passed
-        * [is true](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L55)
+        * [is true](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L55)
       * within grace period buffer
-        * [is false](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L63)
+        * [is false](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L63)
   * ==
-    * [is true when attributes are the same](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L73)
-    * [is false when attributes are not the same](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L78)
-    * [is false when class type differs](./lib/submodules/ably-ruby/spec/unit/models/token_spec.rb#L82)
+    * [is true when attributes are the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L73)
+    * [is false when attributes are not the same](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L78)
+    * [is false when class type differs](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/models/token_spec.rb#L82)
 
 ### Ably::Rest::Channels
-_(see [lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb))_
   * #initializer
     * as UTF_8 string
-      * [is permitted](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L16)
-      * [remains as UTF-8](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L20)
+      * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L16)
+      * [remains as UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L20)
     * as SHIFT_JIS string
-      * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L28)
-      * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L32)
+      * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L28)
+      * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L32)
     * as ASCII_8BIT string
-      * [gets converted to UTF-8](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L40)
-      * [is compatible with original encoding](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L44)
+      * [gets converted to UTF-8](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L40)
+      * [is compatible with original encoding](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L44)
     * as Integer
-      * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L52)
+      * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L52)
     * as Nil
-      * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L60)
+      * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L60)
   * #publish name argument
     * as UTF_8 string
-      * [is permitted](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L72)
+      * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L72)
     * as SHIFT_JIS string
-      * [is permitted](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L80)
+      * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L80)
     * as ASCII_8BIT string
-      * [is permitted](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L88)
+      * [is permitted](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L88)
     * as Integer
-      * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L96)
+      * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L96)
     * as Nil
-      * [raises an argument error](./lib/submodules/ably-ruby/spec/unit/rest/channel_spec.rb#L104)
+      * [raises an argument error](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channel_spec.rb#L104)
 
 ### Ably::Rest::Channels
-_(see [lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb))_
   * creating channels
-    * [#get creates a channel](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L12)
-    * [#get will reuse the channel object](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L17)
-    * [[] creates a channel](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L23)
+    * [#get creates a channel](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L12)
+    * [#get will reuse the channel object](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L17)
+    * [[] creates a channel](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L23)
   * #fetch
-    * [retrieves a channel if it exists](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L30)
-    * [calls the block if channel is missing](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L35)
+    * [retrieves a channel if it exists](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L30)
+    * [calls the block if channel is missing](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L35)
   * destroying channels
-    * [#release releases the channel resoures](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L43)
+    * [#release releases the channel resoures](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L43)
   * is Enumerable
-    * [allows enumeration](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L59)
-    * [provides #length](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L75)
+    * [allows enumeration](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L59)
+    * [provides #length](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L75)
     * #each
-      * [returns an enumerator](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L64)
-      * [yields each channel](./lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb#L68)
+      * [returns an enumerator](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L64)
+      * [yields each channel](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/channels_spec.rb#L68)
 
 ### Ably::Rest::Client
-_(see [lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb](./lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/client_spec.rb))_
   * behaves like a client initializer
     * with invalid arguments
       * empty hash
-        * [raises an exception](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L28)
+        * [raises an exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L28)
       * nil
-        * [raises an exception](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L36)
+        * [raises an exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L36)
       * api_key: "invalid"
-        * [raises an exception](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L44)
+        * [raises an exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L44)
       * api_key: "invalid:asdad"
-        * [raises an exception](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L52)
+        * [raises an exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L52)
       * api_key and key_id
-        * [raises an exception](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L60)
+        * [raises an exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L60)
       * api_key and key_secret
-        * [raises an exception](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L68)
+        * [raises an exception](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L68)
       * client_id as only option
-        * [requires a valid key](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L76)
+        * [requires a valid key](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L76)
     * with valid arguments
       * api_key only
-        * [connects to the Ably service](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L87)
+        * [connects to the Ably service](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L87)
       * key_id and key_secret
-        * [constructs an api_key](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L95)
+        * [constructs an api_key](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L95)
       * with a string key instead of options hash
-        * [sets the api_key](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L103)
-        * [sets the key_id](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L107)
-        * [sets the key_secret](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L111)
+        * [sets the api_key](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L103)
+        * [sets the key_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L107)
+        * [sets the key_secret](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L111)
       * with token
-        * [sets the token_id](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L119)
+        * [sets the token_id](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L119)
       * endpoint
-        * [defaults to production](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L125)
+        * [defaults to production](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L125)
         * with environment option
-          * [uses an alternate endpoint](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L132)
+          * [uses an alternate endpoint](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L132)
       * tls
-        * [defaults to TLS](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L151)
+        * [defaults to TLS](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L151)
         * set to false
-          * [uses plain text](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L142)
-          * [uses HTTP](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L146)
+          * [uses plain text](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L142)
+          * [uses HTTP](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L146)
       * logger
         * default
-          * [uses Ruby Logger](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L158)
-          * [specifies Logger::ERROR log level](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L162)
+          * [uses Ruby Logger](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L158)
+          * [specifies Logger::ERROR log level](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L162)
         * with log_level :none
-          * [silences all logging with a NilLogger](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L170)
+          * [silences all logging with a NilLogger](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L170)
         * with custom logger and log_level
-          * [uses the custom logger](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L188)
-          * [sets the custom log level](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L192)
+          * [uses the custom logger](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L188)
+          * [sets the custom log level](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L192)
     * delegators
-      * [delegates :client_id to .auth](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L202)
-      * [delegates :auth_options to .auth](./lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb#L207)
+      * [delegates :client_id to .auth](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L202)
+      * [delegates :auth_options to .auth](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/shared/client_initializer_behaviour.rb#L207)
   * initializer options
     * TLS
       * disabled
-        * [fails for any operation with basic auth and attempting to send an API key over a non-secure connection](./lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb#L17)
+        * [fails for any operation with basic auth and attempting to send an API key over a non-secure connection](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/client_spec.rb#L17)
     * :use_token_auth
       * set to false
         * with an api_key with :tls => false
-          * [fails for any operation with basic auth and attempting to send an API key over a non-secure connection](./lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb#L28)
+          * [fails for any operation with basic auth and attempting to send an API key over a non-secure connection](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/client_spec.rb#L28)
         * without an api_key
-          * [fails as an api_key is required if not using token auth](./lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb#L36)
+          * [fails as an api_key is required if not using token auth](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/client_spec.rb#L36)
       * set to true
         * without an api_key or token_id
-          * [fails as an api_key is required to issue tokens](./lib/submodules/ably-ruby/spec/unit/rest/client_spec.rb#L46)
+          * [fails as an api_key is required to issue tokens](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/client_spec.rb#L46)
 
 ### Ably::Rest
-_(see [lib/submodules/ably-ruby/spec/unit/rest/rest_spec.rb](./lib/submodules/ably-ruby/spec/unit/rest/rest_spec.rb))_
-  * [constructor returns an Ably::Rest::Client](./lib/submodules/ably-ruby/spec/unit/rest/rest_spec.rb#L7)
+_(see [lib/submodules/ably-ruby/spec/unit/rest/rest_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/rest_spec.rb))_
+  * [constructor returns an Ably::Rest::Client](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/rest/rest_spec.rb#L7)
 
 ### Ably::Util::Crypto
-_(see [lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb))_
+_(see [lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb))_
   * defaults
-    * [match other client libraries](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L18)
+    * [match other client libraries](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L18)
   * encrypts & decrypt
-    * [#encrypt encrypts a string](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L28)
-    * [#decrypt decrypts a string](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L33)
+    * [#encrypt encrypts a string](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L28)
+    * [#decrypt decrypts a string](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L33)
   * encrypting an empty string
-    * [raises an ArgumentError](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L42)
+    * [raises an ArgumentError](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L42)
   * using shared client lib fixture data
     * with AES-128-CBC
       * behaves like an Ably encrypter and decrypter
         * text payload
-          * [encrypts exactly the same binary data as other client libraries](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L65)
-          * [decrypts exactly the same binary data as other client libraries](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L69)
+          * [encrypts exactly the same binary data as other client libraries](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L65)
+          * [decrypts exactly the same binary data as other client libraries](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L69)
     * with AES-256-CBC
       * behaves like an Ably encrypter and decrypter
         * text payload
-          * [encrypts exactly the same binary data as other client libraries](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L65)
-          * [decrypts exactly the same binary data as other client libraries](./lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb#L69)
+          * [encrypts exactly the same binary data as other client libraries](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L65)
+          * [decrypts exactly the same binary data as other client libraries](https://github.com/ably/ably-ruby/tree/ffa3b80642e515c63d5f2ced07c2ae3df2c4fd05/spec/unit/util/crypto_spec.rb#L69)
 
   -------
 
   ## Test summary
 
-  * Passing tests: 394
+  * Passing tests: 442
   * Pending tests: 0
-  * Failing tests: 0
+  * Failing tests: 1