ably 0.8.14 → 0.8.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7ff0fc1dc14fc84ea707c200752a84943571d53
-  data.tar.gz: 7ba75aa7a6bfdacd097ffa694409bb172711eddb
+  metadata.gz: 9214384ab04b11d18a4cbcd0cfa430854bf04e52
+  data.tar.gz: 945b41698a5cf1cccfd98b3dfa9e7f9894fcd1a5
 SHA512:
-  metadata.gz: 8eaf2f813c5003c87c64c0f9dbd33e6231ac1d9c1fbd2a1e07117f566c648b6eed4fd50eb4ec15e622bf510dc225e70cd3d6a42dfe25ca4da8ca69529d5001f4
-  data.tar.gz: f07522639b0068f1a1aea116d04bcfbc745d7d9862ad12ea64111921854c1da4eb785480f2c5881083c0aa30c052ce1741552ad8b8195c7fd75f4868df58a556
+  metadata.gz: 371d2f0d7a4200d6bb7946e2fba94b9bed19176d76140fd05335206c7ee3af20fd54ac2c7c3d0477bd004131fb835ee54b74779060de1fff2c1b3e0251b82ee4
+  data.tar.gz: 6c6722c07d086c2ecfc6825c4d406a3b66f22df079b50690dc2912875669e0d5beba5e2ec566ec9e9bfdb2e7ab32bfd1abec552c3c3b65568fd170d7b0cc02d6

data/CHANGELOG.md

@@ -1,7 +1,52 @@
 # Change Log
 
-## [Unreleased](https://github.com/ably/ably-ruby/tree/v0.8.14)
+## [v0.8.15](https://github.com/ably/ably-ruby/tree/v0.8.15)
 
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.14...v0.8.15)
+
+**Implemented enhancements:**
+
+- Fix HttpRequest & HttpRetry timeouts [\#110](https://github.com/ably/ably-ruby/issues/110)
+- Logger should take blocks [\#107](https://github.com/ably/ably-ruby/issues/107)
+- 0.9: Use separate internal/external listeners [\#106](https://github.com/ably/ably-ruby/issues/106)
+- Add reuse library test [\#83](https://github.com/ably/ably-ruby/issues/83)
+- 0.8 final spec check [\#71](https://github.com/ably/ably-ruby/issues/71)
+- Use connection\#id not connection\#key to determine if connection has been resumed [\#62](https://github.com/ably/ably-ruby/issues/62)
+- Channel Presence suspended state [\#41](https://github.com/ably/ably-ruby/issues/41)
+- Attach / detach timeouts + protocol error handling for Channel [\#38](https://github.com/ably/ably-ruby/issues/38)
+- Connection retry and timeout needs to be configurable [\#6](https://github.com/ably/ably-ruby/issues/6)
+
+**Fixed bugs:**
+
+- Subscribing to all connection state changes doesn't work [\#103](https://github.com/ably/ably-ruby/issues/103)
+- Ensure DETACHED or DISCONNECTED with error is non-fatal [\#93](https://github.com/ably/ably-ruby/issues/93)
+- Incorrect assumption for channel errors [\#91](https://github.com/ably/ably-ruby/issues/91)
+- authCallback assumes a blocking callback, even in EM [\#89](https://github.com/ably/ably-ruby/issues/89)
+- Token Reauth error codes [\#86](https://github.com/ably/ably-ruby/issues/86)
+- Do not persist authorise attributes force & timestamp [\#72](https://github.com/ably/ably-ruby/issues/72)
+- 0.8 final spec check [\#71](https://github.com/ably/ably-ruby/issues/71)
+- Receiving CONNECTED when already connected [\#69](https://github.com/ably/ably-ruby/issues/69)
+- Connection\#connect callback may not be called as expected [\#68](https://github.com/ably/ably-ruby/issues/68)
+- nodename nor servname provided [\#65](https://github.com/ably/ably-ruby/issues/65)
+- Channel Presence suspended state [\#41](https://github.com/ably/ably-ruby/issues/41)
+- Intermittent test fixes [\#33](https://github.com/ably/ably-ruby/issues/33)
+
+**Closed issues:**
+
+- Remove deprecated ProtocolMessage\#connectionKey [\#108](https://github.com/ably/ably-ruby/issues/108)
+- 0.9 Extras field [\#105](https://github.com/ably/ably-ruby/issues/105)
+- 0.9 UPDATE spec [\#104](https://github.com/ably/ably-ruby/issues/104)
+- Token issue bug [\#75](https://github.com/ably/ably-ruby/issues/75)
+- Ensure client\_id provided is string or cast to string in Auth request\_token [\#74](https://github.com/ably/ably-ruby/issues/74)
+- Standardise timeouts [\#64](https://github.com/ably/ably-ruby/issues/64)
+- Ensure RSpec retry compatibility is used [\#54](https://github.com/ably/ably-ruby/issues/54)
+- Spec validation [\#43](https://github.com/ably/ably-ruby/issues/43)
+
+**Merged pull requests:**
+
+- From encoded [\#101](https://github.com/ably/ably-ruby/pull/101) ([mattheworiordan](https://github.com/mattheworiordan))
+
+## [v0.8.14](https://github.com/ably/ably-ruby/tree/v0.8.14) (2016-09-30)
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.13...v0.8.14)
 
 **Fixed bugs:**
@@ -17,7 +62,6 @@
 - Fallback host improvements [\#97](https://github.com/ably/ably-ruby/pull/97) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.13](https://github.com/ably/ably-ruby/tree/v0.8.13) (2016-09-29)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.12...v0.8.13)
 
 **Merged pull requests:**
@@ -25,7 +69,6 @@
 - Ensure interoperability with other libraries with JSON protocol [\#94](https://github.com/ably/ably-ruby/pull/94) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.12](https://github.com/ably/ably-ruby/tree/v0.8.12) (2016-05-23)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.11...v0.8.12)
 
 **Fixed bugs:**
@@ -37,7 +80,6 @@
 - Reauthorise [\#90](https://github.com/ably/ably-ruby/pull/90) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.11](https://github.com/ably/ably-ruby/tree/v0.8.11) (2016-04-05)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.10...v0.8.11)
 
 **Merged pull requests:**
@@ -45,17 +87,14 @@
 - Ensure message emitter callbacks are safe \(i.e. cannot break the EM\) [\#85](https://github.com/ably/ably-ruby/pull/85) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.10](https://github.com/ably/ably-ruby/tree/v0.8.10) (2016-04-01)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.9...v0.8.10)
 
 ## [v0.8.9](https://github.com/ably/ably-ruby/tree/v0.8.9) (2016-03-01)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.8...v0.8.9)
 
 **Fixed bugs:**
 
 - Support enter\(data\) [\#79](https://github.com/ably/ably-ruby/issues/79)
-
 - Update documentation to hide private API methods [\#77](https://github.com/ably/ably-ruby/issues/77)
 
 **Closed issues:**
@@ -65,11 +104,9 @@
 **Merged pull requests:**
 
 - Various fixes for open issues [\#82](https://github.com/ably/ably-ruby/pull/82) ([mattheworiordan](https://github.com/mattheworiordan))
-
 - Encryption spec update [\#81](https://github.com/ably/ably-ruby/pull/81) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.8](https://github.com/ably/ably-ruby/tree/v0.8.8) (2016-01-26)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.7...v0.8.8)
 
 **Closed issues:**
@@ -77,23 +114,18 @@
 - Support :key in ClientOptions and deprecate :api\_key [\#73](https://github.com/ably/ably-ruby/issues/73)
 
 ## [v0.8.7](https://github.com/ably/ably-ruby/tree/v0.8.7) (2015-12-31)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.6...v0.8.7)
 
 ## [v0.8.6](https://github.com/ably/ably-ruby/tree/v0.8.6) (2015-12-02)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.5...v0.8.6)
 
 **Merged pull requests:**
 
 - Some intermittent test fixes & enable tests that were blocked [\#70](https://github.com/ably/ably-ruby/pull/70) ([mattheworiordan](https://github.com/mattheworiordan))
-
 - Output detailed log for any text failures [\#67](https://github.com/ably/ably-ruby/pull/67) ([mattheworiordan](https://github.com/mattheworiordan))
-
 - 0.8 final spec \(98% compliance\) [\#66](https://github.com/ably/ably-ruby/pull/66) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.5](https://github.com/ably/ably-ruby/tree/v0.8.5) (2015-10-08)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.4...v0.8.5)
 
 **Implemented enhancements:**
@@ -103,9 +135,7 @@
 **Fixed bugs:**
 
 - Switch arity of auth methods [\#61](https://github.com/ably/ably-ruby/issues/61)
-
 - Add test: Message published, connection dropped, then restores to point before last message was published [\#56](https://github.com/ably/ably-ruby/issues/56)
-
 - Documentation for constructor is incorrect [\#49](https://github.com/ably/ably-ruby/issues/49)
 
 **Merged pull requests:**
@@ -113,41 +143,30 @@
 - Ensure connections are always closed in tests [\#63](https://github.com/ably/ably-ruby/pull/63) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.4](https://github.com/ably/ably-ruby/tree/v0.8.4) (2015-09-08)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.3...v0.8.4)
 
 **Implemented enhancements:**
 
 - Add compatibility support for default Crypto params [\#53](https://github.com/ably/ably-ruby/issues/53)
-
 - EventEmitter on connection [\#52](https://github.com/ably/ably-ruby/issues/52)
-
 - Add test for connectionId attribute for a message sent over REST [\#50](https://github.com/ably/ably-ruby/issues/50)
 
 **Merged pull requests:**
 
 - Spec update to fix a number of issues [\#60](https://github.com/ably/ably-ruby/pull/60) ([mattheworiordan](https://github.com/mattheworiordan))
-
 - Allow clientId to be provided on init if using externally created token [\#58](https://github.com/ably/ably-ruby/pull/58) ([SimonWoolf](https://github.com/SimonWoolf))
 
 ## [v0.8.3](https://github.com/ably/ably-ruby/tree/v0.8.3) (2015-08-19)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.2...v0.8.3)
 
 **Implemented enhancements:**
 
 - Implement :queue\_messages option [\#36](https://github.com/ably/ably-ruby/issues/36)
-
 - Check that a non 200-299 status code for REST requests uses fallback hosts [\#35](https://github.com/ably/ably-ruby/issues/35)
-
 - Move stats fixtures into ably-common [\#34](https://github.com/ably/ably-ruby/issues/34)
-
 - Add tests for messages with no data or name fields [\#21](https://github.com/ably/ably-ruby/issues/21)
-
 - Namespace MsgPack as MsgPack5 because compliance is not merged in [\#12](https://github.com/ably/ably-ruby/issues/12)
-
 - Add test coverage for receiving messages more than once i.e. historical messages resent somehow on reconnect [\#11](https://github.com/ably/ably-ruby/issues/11)
-
 - Add async methods for Authentication in the realtime library [\#8](https://github.com/ably/ably-ruby/issues/8)
 
 **Fixed bugs:**
@@ -157,37 +176,28 @@
 **Closed issues:**
 
 - Scope default token params in arguments [\#55](https://github.com/ably/ably-ruby/issues/55)
-
 - Channel options can be reset when accessing a channel with \#get [\#46](https://github.com/ably/ably-ruby/issues/46)
 
 **Merged pull requests:**
 
 - Separate token params for auth [\#57](https://github.com/ably/ably-ruby/pull/57) ([mattheworiordan](https://github.com/mattheworiordan))
-
 - Ensure files are required in a consistent order [\#51](https://github.com/ably/ably-ruby/pull/51) ([SimonWoolf](https://github.com/SimonWoolf))
 
 ## [v0.8.2](https://github.com/ably/ably-ruby/tree/v0.8.2) (2015-05-20)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.1...v0.8.2)
 
 **Implemented enhancements:**
 
 - Ensure Array object can be used in place of Hash for payload [\#44](https://github.com/ably/ably-ruby/issues/44)
-
 - Change connect\_automatically option to auto\_connect for consistency [\#42](https://github.com/ably/ably-ruby/issues/42)
-
 - Rename PaginatedResource to PaginatedResult for consistency [\#40](https://github.com/ably/ably-ruby/issues/40)
-
 - EventEmitter should use `emit` not `trigger` to be consistent with other libs [\#31](https://github.com/ably/ably-ruby/issues/31)
-
 - Add exceptions when data attribute for messages/presence is not String, Binary or JSON data [\#4](https://github.com/ably/ably-ruby/issues/4)
-
 - Auth Callback and Auth URL should support tokens as well as token requests [\#2](https://github.com/ably/ably-ruby/issues/2)
 
 **Closed issues:**
 
 - Realtime Presence\#get does not wait by default [\#47](https://github.com/ably/ably-ruby/issues/47)
-
 - No implicit attach when accessing channel.presence [\#45](https://github.com/ably/ably-ruby/issues/45)
 
 **Merged pull requests:**
@@ -195,11 +205,9 @@
 - Reject invalid payload type [\#48](https://github.com/ably/ably-ruby/pull/48) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.8.1](https://github.com/ably/ably-ruby/tree/v0.8.1) (2015-04-23)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.0...v0.8.1)
 
 ## [v0.8.0](https://github.com/ably/ably-ruby/tree/v0.8.0) (2015-04-23)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.6...v0.8.0)
 
 **Merged pull requests:**
@@ -207,18 +215,15 @@
 - Token naming refactor [\#29](https://github.com/ably/ably-ruby/pull/29) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.7.6](https://github.com/ably/ably-ruby/tree/v0.7.6) (2015-04-17)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.5...v0.7.6)
 
 **Implemented enhancements:**
 
 - Rename Stat to Stats for consistency [\#32](https://github.com/ably/ably-ruby/issues/32)
-
 - Stats objects [\#24](https://github.com/ably/ably-ruby/issues/24)
-
 - Need a test to handle errors in callbacks [\#13](https://github.com/ably/ably-ruby/issues/13)
-
 - Allow token ID or API key in the client constructor [\#5](https://github.com/ably/ably-ruby/issues/5)
+- Typed stats similar to Java library + zero default for empty stats [\#25](https://github.com/ably/ably-ruby/pull/25) ([mattheworiordan](https://github.com/mattheworiordan))
 
 **Fixed bugs:**
 
@@ -231,19 +236,14 @@
 **Merged pull requests:**
 
 - Test encoded presence fixture data for \#get & \#history [\#28](https://github.com/ably/ably-ruby/pull/28) ([mattheworiordan](https://github.com/mattheworiordan))
-
 - Add coveralls.io coverage reporting [\#27](https://github.com/ably/ably-ruby/pull/27) ([mattheworiordan](https://github.com/mattheworiordan))
-
 - New paginated resource [\#26](https://github.com/ably/ably-ruby/pull/26) ([mattheworiordan](https://github.com/mattheworiordan))
-
-- Typed stats similar to Java library + zero default for empty stats [\#25](https://github.com/ably/ably-ruby/pull/25) ([mattheworiordan](https://github.com/mattheworiordan))
+- History since attach [\#22](https://github.com/ably/ably-ruby/pull/22) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.7.5](https://github.com/ably/ably-ruby/tree/v0.7.5) (2015-03-21)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.4...v0.7.5)
 
 ## [v0.7.4](https://github.com/ably/ably-ruby/tree/v0.7.4) (2015-03-21)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.2...v0.7.4)
 
 **Merged pull requests:**
@@ -251,7 +251,6 @@
 - Presence Member Map [\#14](https://github.com/ably/ably-ruby/pull/14) ([mattheworiordan](https://github.com/mattheworiordan))
 
 ## [v0.7.2](https://github.com/ably/ably-ruby/tree/v0.7.2) (2015-02-10)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.1...v0.7.2)
 
 **Implemented enhancements:**
@@ -261,15 +260,12 @@
 **Merged pull requests:**
 
 - Update README to include various missing snippets for core features [\#9](https://github.com/ably/ably-ruby/pull/9) ([kouno](https://github.com/kouno))
-
 - Fix connection retry frequency [\#7](https://github.com/ably/ably-ruby/pull/7) ([kouno](https://github.com/kouno))
 
 ## [v0.7.1](https://github.com/ably/ably-ruby/tree/v0.7.1) (2015-01-18)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.7.0...v0.7.1)
 
 ## [v0.7.0](https://github.com/ably/ably-ruby/tree/v0.7.0) (2015-01-12)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.6.2...v0.7.0)
 
 **Closed issues:**
@@ -277,39 +273,30 @@
 - JSON encoder should only append utf-8 before a cipher encoder is applied [\#1](https://github.com/ably/ably-ruby/issues/1)
 
 ## [v0.6.2](https://github.com/ably/ably-ruby/tree/v0.6.2) (2014-12-10)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.2.0...v0.6.2)
 
 ## [v0.2.0](https://github.com/ably/ably-ruby/tree/v0.2.0) (2014-12-09)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.6...v0.2.0)
 
 ## [v0.1.6](https://github.com/ably/ably-ruby/tree/v0.1.6) (2014-10-31)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.5...v0.1.6)
 
 ## [v0.1.5](https://github.com/ably/ably-ruby/tree/v0.1.5) (2014-10-23)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.4...v0.1.5)
 
 ## [v0.1.4](https://github.com/ably/ably-ruby/tree/v0.1.4) (2014-09-27)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.3...v0.1.4)
 
 ## [v0.1.3](https://github.com/ably/ably-ruby/tree/v0.1.3) (2014-09-26)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.2...v0.1.3)
 
 ## [v0.1.2](https://github.com/ably/ably-ruby/tree/v0.1.2) (2014-09-25)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.1...v0.1.2)
 
 ## [v0.1.1](https://github.com/ably/ably-ruby/tree/v0.1.1) (2014-09-23)
-
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v0.1.0...v0.1.1)
 
 ## [v0.1.0](https://github.com/ably/ably-ruby/tree/v0.1.0) (2014-09-23)
 
 
-
 \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -24,6 +24,12 @@ And then install this Bundler dependency:
 Or install it yourself as:
 
     $ gem install ably
+    
+### Using with Rails or Sinatra
+
+This `ably` gem provides both a [Realtime](http://www.ably.io/documentation/realtime/usage) and [REST](http://www.ably.io/documentation/rest/usage) version of the Ably library. Realtime depends on EventMachine to provide an asynchronous evented framework to run the library in, whereas the REST library depends only on synchronous libraries such as Faraday.
+
+If you are using Ably within your Rails or Sinatra apps, more often than not, you probably want to use the REST only version of the library that has no dependency on EventMachine and provides a synchronous API that you will be used to using within Rails and Sinatra. [See the REST only Ruby version of the Ably library](https://github.com/ably/ably-ruby-rest).
 
 ## Using the Realtime API
 

data/ably.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.2.0' # version lock, see config.around(:example, :event_machine) in event_machine_helper.rb
   spec.add_development_dependency 'rspec-retry'
   spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'webmock', '~> 2.3.0'
 
   spec.add_development_dependency 'coveralls'
 

data/lib/ably/models/http_paginated_response.rb

@@ -0,0 +1,90 @@
+require 'ably/models/paginated_result'
+
+module Ably::Models
+  # HTTP respones object from Rest#request object
+  # Wraps any Ably HTTP response that supports paging and provides methods to iterate through
+  # the pages using {#first}, {#next}, {#has_next?} and {#last?}
+
+  class HttpPaginatedResponse < PaginatedResult
+    # Retrieve the first page of results.
+    # When used as part of the {Ably::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
+    #   and allows an optional success callback block to be provided.
+    #
+    # @return [HttpPaginatedResponse,Ably::Util::SafeDeferrable]
+    def first(&success_callback)
+      async_wrap_if_realtime(success_callback) do
+        return nil unless supports_pagination?
+        HttpPaginatedResponse.new(client.get(pagination_url('first')), base_url, client, pagination_options, &each_block)
+      end
+    end
+
+    # Retrieve the next page of results.
+    # When used as part of the {Ably::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
+    #   and allows an optional success callback block to be provided.
+    #
+    # @return [HttpPaginatedResponse,Ably::Util::SafeDeferrable]
+    def next(&success_callback)
+      async_wrap_if_realtime(success_callback) do
+        return nil unless has_next?
+        HttpPaginatedResponse.new(client.get(pagination_url('next')), base_url, client, pagination_options, &each_block)
+      end
+    end
+
+    # HTTP status code for response
+    # @return [Integer]
+    def status_code
+      http_response.status.to_i
+    end
+
+    # True if the response is considered successful due to the HTTP status code
+    # @return [Boolean]
+    def success?
+      (200..299).include?(http_response.status.to_i)
+    end
+
+    # Ably error code from +X-Ably-Errorcode+ header if available from response
+    # @return [Integer]
+    def error_code
+      if http_response.headers['X-Ably-Errorcode']
+        http_response.headers['X-Ably-Errorcode'].to_i
+      end
+    end
+
+    # Error message from +X-Ably-Errormessage+ header if available from response
+    # @return [String]
+    def error_message
+      http_response.headers['X-Ably-Errormessage']
+    end
+
+    # Headers for the HTTP response
+    # @return [Hash<String, String>]
+    def headers
+      http_response.headers || {}
+    end
+
+    # Farady compatible response object used when an exception is raised
+    # @api private
+    class ErrorResponse
+      def initialize(status, error_code, error_message)
+        @status = status
+        @error_code = error_code
+        @error_message = error_message
+      end
+
+      def status
+        @status
+      end
+
+      def headers
+        {
+          'X-Ably-Errorcode' => @error_code,
+          'X-Ably-Errormessage' => @error_message
+        }
+      end
+
+      def body
+        nil
+      end
+    end
+  end
+end