# Ably Real-time & REST Client Library 0.7.1 Specification ### Ably::Realtime::Channel#history _(see [spec/acceptance/realtime/channel_history_spec.rb](./spec/acceptance/realtime/channel_history_spec.rb))_ * using JSON and MsgPack protocol * [returns a Deferrable](./spec/acceptance/realtime/channel_history_spec.rb#L20) * with a single client publishing and receiving * [retrieves real-time history](./spec/acceptance/realtime/channel_history_spec.rb#L33) * with two clients publishing messages on the same channel * [retrieves real-time history on both channels](./spec/acceptance/realtime/channel_history_spec.rb#L45) * with lots of messages published with a single client and channel * as one ProtocolMessage * [retrieves history forwards with pagination through :limit option](./spec/acceptance/realtime/channel_history_spec.rb#L87) * [retrieves history backwards with pagination through :limit option](./spec/acceptance/realtime/channel_history_spec.rb#L96) * in multiple ProtocolMessages * [retrieves limited history forwards with pagination](./spec/acceptance/realtime/channel_history_spec.rb#L107) * [retrieves limited history backwards with pagination](./spec/acceptance/realtime/channel_history_spec.rb#L118) * and REST history * [return the same results with unique matching message IDs](./spec/acceptance/realtime/channel_history_spec.rb#L134) ### Ably::Realtime::Channel _(see [spec/acceptance/realtime/channel_spec.rb](./spec/acceptance/realtime/channel_spec.rb))_ * using JSON and MsgPack protocol * initialization * with :connect_automatically option set to false on connection * [remains initialized when accessing a channel](./spec/acceptance/realtime/channel_spec.rb#L21) * [opens a connection implicitly on #attach](./spec/acceptance/realtime/channel_spec.rb#L29) * [opens a connection implicitly when accessing #presence](./spec/acceptance/realtime/channel_spec.rb#L36) * #attach * [emits attaching then attached events](./spec/acceptance/realtime/channel_spec.rb#L49) * [ignores subsequent #attach calls but calls the success callback if provided](./spec/acceptance/realtime/channel_spec.rb#L59) * [attaches to a channel](./spec/acceptance/realtime/channel_spec.rb#L72) * [attaches to a channel and calls the provided block](./spec/acceptance/realtime/channel_spec.rb#L80) * [returns a Deferrable](./spec/acceptance/realtime/channel_spec.rb#L87) * [calls the Deferrable callback on success](./spec/acceptance/realtime/channel_spec.rb#L92) * when state is :failed * [reattaches](./spec/acceptance/realtime/channel_spec.rb#L103) * when state is :detaching * [moves straight to attaching and skips detached](./spec/acceptance/realtime/channel_spec.rb#L116) * with many connections and many channels on each simultaneously * [attaches all channels](./spec/acceptance/realtime/channel_spec.rb#L142) * failure as a result of insufficient key permissions * [triggers failed event](./spec/acceptance/realtime/channel_spec.rb#L165) * [calls the errback of the returned Deferrable](./spec/acceptance/realtime/channel_spec.rb#L174) * [triggers an error event](./spec/acceptance/realtime/channel_spec.rb#L182) * [updates the error_reason](./spec/acceptance/realtime/channel_spec.rb#L191) * #detach * [detaches from a channel](./spec/acceptance/realtime/channel_spec.rb#L202) * [detaches from a channel and calls the provided block](./spec/acceptance/realtime/channel_spec.rb#L212) * [emits :detaching then :detached events](./spec/acceptance/realtime/channel_spec.rb#L221) * [returns a Deferrable](./spec/acceptance/realtime/channel_spec.rb#L233) * [calls the Deferrable callback on success](./spec/acceptance/realtime/channel_spec.rb#L238) * when state is :failed * [raises an exception](./spec/acceptance/realtime/channel_spec.rb#L251) * when state is :attaching * [moves straight to :detaching state and skips :attached](./spec/acceptance/realtime/channel_spec.rb#L262) * when state is :detaching * [ignores subsequent #detach calls but calls the callback if provided](./spec/acceptance/realtime/channel_spec.rb#L280) * channel recovery in :attaching state * the transport is disconnected before the ATTACHED protocol message is received * PENDING: *[attach times out and fails if not ATTACHED protocol message received](./spec/acceptance/realtime/channel_spec.rb#L299)* * PENDING: *[channel is ATTACHED if ATTACHED protocol message is later received](./spec/acceptance/realtime/channel_spec.rb#L300)* * PENDING: *[sends an ATTACH protocol message in response to a channel message being received on the attaching channel](./spec/acceptance/realtime/channel_spec.rb#L301)* * #publish * when attached * [publishes messages](./spec/acceptance/realtime/channel_spec.rb#L307) * when not yet attached * [publishes queued messages once attached](./spec/acceptance/realtime/channel_spec.rb#L319) * [publishes queued messages within a single protocol message](./spec/acceptance/realtime/channel_spec.rb#L327) * #subscribe * with an event argument * [subscribes for a single event](./spec/acceptance/realtime/channel_spec.rb#L350) * with no event argument * [subscribes for all events](./spec/acceptance/realtime/channel_spec.rb#L360) * many times with different event names * [filters events accordingly to each callback](./spec/acceptance/realtime/channel_spec.rb#L370) * #unsubscribe * with an event argument * [unsubscribes for a single event](./spec/acceptance/realtime/channel_spec.rb#L393) * with no event argument * [unsubscribes for a single event](./spec/acceptance/realtime/channel_spec.rb#L406) * when connection state changes to * :failed * an :attached channel * [transitions state to :failed](./spec/acceptance/realtime/channel_spec.rb#L429) * [triggers an error event on the channel](./spec/acceptance/realtime/channel_spec.rb#L439) * [updates the channel error_reason](./spec/acceptance/realtime/channel_spec.rb#L449) * a :detached channel * [remains in the :detached state](./spec/acceptance/realtime/channel_spec.rb#L461) * a :failed channel * [remains in the :failed state and ignores the failure error](./spec/acceptance/realtime/channel_spec.rb#L481) * :closed * an :attached channel * [transitions state to :detached](./spec/acceptance/realtime/channel_spec.rb#L504) * a :detached channel * [remains in the :detached state](./spec/acceptance/realtime/channel_spec.rb#L515) * a :failed channel * [remains in the :failed state and retains the error_reason](./spec/acceptance/realtime/channel_spec.rb#L536) ### Ably::Realtime::Client _(see [spec/acceptance/realtime/client_spec.rb](./spec/acceptance/realtime/client_spec.rb))_ * using JSON and MsgPack protocol * initialization * basic auth * [is enabled by default with a provided :api_key option](./spec/acceptance/realtime/client_spec.rb#L18) * :tls option * set to false to forec a plain-text connection * [fails to connect because a private key cannot be sent over a non-secure connection](./spec/acceptance/realtime/client_spec.rb#L31) * token auth * with TLS enabled * and a pre-generated Token provided with the :token_id option * [connects using token auth](./spec/acceptance/realtime/client_spec.rb#L51) * with valid :api_key and :use_token_auth option set to true * [automatically authorises on connect and generates a token](./spec/acceptance/realtime/client_spec.rb#L64) * with client_id * [connects using token auth](./spec/acceptance/realtime/client_spec.rb#L77) * with TLS disabled * and a pre-generated Token provided with the :token_id option * [connects using token auth](./spec/acceptance/realtime/client_spec.rb#L51) * with valid :api_key and :use_token_auth option set to true * [automatically authorises on connect and generates a token](./spec/acceptance/realtime/client_spec.rb#L64) * with client_id * [connects using token auth](./spec/acceptance/realtime/client_spec.rb#L77) * with token_request_block * [calls the block](./spec/acceptance/realtime/client_spec.rb#L102) * [uses the token request when requesting a new token](./spec/acceptance/realtime/client_spec.rb#L109) ### Ably::Realtime::Connection failures _(see [spec/acceptance/realtime/connection_failures_spec.rb](./spec/acceptance/realtime/connection_failures_spec.rb))_ * using JSON and MsgPack protocol * authentication failure * when API key is invalid * with invalid app part of the key * [enters the failed state and returns a not found error](./spec/acceptance/realtime/connection_failures_spec.rb#L26) * with invalid key ID part of the key * [enters the failed state and returns an authorization error](./spec/acceptance/realtime/connection_failures_spec.rb#L40) * automatic connection retry * with invalid WebSocket host * when disconnected * [enters the suspended state after multiple attempts to connect](./spec/acceptance/realtime/connection_failures_spec.rb#L94) * #close * [transitions connection state to :closed](./spec/acceptance/realtime/connection_failures_spec.rb#L111) * when connection state is :suspended * [enters the failed state after multiple attempts](./spec/acceptance/realtime/connection_failures_spec.rb#L130) * #close * [transitions connection state to :closed](./spec/acceptance/realtime/connection_failures_spec.rb#L150) * when connection state is :failed * #close * [will not transition state to :close and raises a StateChangeError exception](./spec/acceptance/realtime/connection_failures_spec.rb#L169) * #error_reason * [contains the error when state is disconnected](./spec/acceptance/realtime/connection_failures_spec.rb#L183) * [contains the error when state is suspended](./spec/acceptance/realtime/connection_failures_spec.rb#L183) * [contains the error when state is failed](./spec/acceptance/realtime/connection_failures_spec.rb#L183) * [is reset to nil when :connected](./spec/acceptance/realtime/connection_failures_spec.rb#L192) * [is reset to nil when :closed](./spec/acceptance/realtime/connection_failures_spec.rb#L203) * #connect * connection opening times out * [attempts to reconnect](./spec/acceptance/realtime/connection_failures_spec.rb#L230) * [calls the errback of the returned Deferrable object when first connection attempt fails](./spec/acceptance/realtime/connection_failures_spec.rb#L243) * when retry intervals are stubbed to attempt reconnection quickly * [never calls the provided success block](./spec/acceptance/realtime/connection_failures_spec.rb#L262) * connection resume * when DISCONNECTED ProtocolMessage received from the server * [reconnects automatically](./spec/acceptance/realtime/connection_failures_spec.rb#L291) * when websocket transport is closed * [reconnects automatically](./spec/acceptance/realtime/connection_failures_spec.rb#L309) * after successfully reconnecting and resuming * [retains connection_id and connection_key](./spec/acceptance/realtime/connection_failures_spec.rb#L326) * [retains channel subscription state](./spec/acceptance/realtime/connection_failures_spec.rb#L343) * when messages were published whilst the client was disconnected * [receives the messages published whilst offline](./spec/acceptance/realtime/connection_failures_spec.rb#L363) * when failing to resume because the connection_key is not or no longer valid * [updates the connection_id and connection_key](./spec/acceptance/realtime/connection_failures_spec.rb#L403) * [detaches all channels](./spec/acceptance/realtime/connection_failures_spec.rb#L418) * [emits an error on the channel and sets the error reason](./spec/acceptance/realtime/connection_failures_spec.rb#L436) * fallback host feature * with custom realtime websocket host option * [never uses a fallback host](./spec/acceptance/realtime/connection_failures_spec.rb#L472) * with non-production environment * [never uses a fallback host](./spec/acceptance/realtime/connection_failures_spec.rb#L489) * with production environment * when the Internet is down * [never uses a fallback host](./spec/acceptance/realtime/connection_failures_spec.rb#L517) * when the Internet is up * [uses a fallback host on every subsequent disconnected attempt until suspended](./spec/acceptance/realtime/connection_failures_spec.rb#L534) * [uses the primary host when suspended, and a fallback host on every subsequent suspended attempt](./spec/acceptance/realtime/connection_failures_spec.rb#L553) ### Ably::Realtime::Connection _(see [spec/acceptance/realtime/connection_spec.rb](./spec/acceptance/realtime/connection_spec.rb))_ * using JSON and MsgPack protocol * intialization * [connects automatically](./spec/acceptance/realtime/connection_spec.rb#L22) * with :connect_automatically option set to false * [does not connect automatically](./spec/acceptance/realtime/connection_spec.rb#L34) * [connects when method #connect is called](./spec/acceptance/realtime/connection_spec.rb#L42) * with token auth * for renewable tokens * that are valid for the duration of the test * with valid pre authorised token expiring in the future * [uses the existing token created by Auth](./spec/acceptance/realtime/connection_spec.rb#L60) * with implicit authorisation * [uses the token created by the implicit authorisation](./spec/acceptance/realtime/connection_spec.rb#L72) * that expire * opening a new connection * with recently expired token * [renews the token on connect](./spec/acceptance/realtime/connection_spec.rb#L93) * with immediately expiring token * [renews the token on connect, and only makes one subsequent attempt to obtain a new token](./spec/acceptance/realtime/connection_spec.rb#L107) * [uses the primary host for subsequent connection and auth requests](./spec/acceptance/realtime/connection_spec.rb#L117) * when connected with a valid non-expired token * that then expires following the connection being opened * PENDING: *[retains connection state](./spec/acceptance/realtime/connection_spec.rb#L164)* * PENDING: *[changes state to failed if a new token cannot be issued](./spec/acceptance/realtime/connection_spec.rb#L165)* * the server * [disconnects the client, and the client automatically renews the token and then reconnects](./spec/acceptance/realtime/connection_spec.rb#L141) * for non-renewable tokens * that are expired * opening a new connection * [transitions state to failed](./spec/acceptance/realtime/connection_spec.rb#L180) * when connected * PENDING: *[transitions state to failed](./spec/acceptance/realtime/connection_spec.rb#L193)* * initialization state changes * with implicit #connect * [are triggered in order](./spec/acceptance/realtime/connection_spec.rb#L221) * with explicit #connect * [are triggered in order](./spec/acceptance/realtime/connection_spec.rb#L227) * #connect * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L235) * [calls the Deferrable callback on success](./spec/acceptance/realtime/connection_spec.rb#L240) * when already connected * [does nothing and no further state changes are emitted](./spec/acceptance/realtime/connection_spec.rb#L249) * once connected * connection#id * [is a string](./spec/acceptance/realtime/connection_spec.rb#L266) * [is unique from the connection#key](./spec/acceptance/realtime/connection_spec.rb#L273) * [is unique for every connection](./spec/acceptance/realtime/connection_spec.rb#L280) * connection#key * [is a string](./spec/acceptance/realtime/connection_spec.rb#L289) * [is unique from the connection#id](./spec/acceptance/realtime/connection_spec.rb#L296) * [is unique for every connection](./spec/acceptance/realtime/connection_spec.rb#L303) * following a previous connection being opened and closed * [reconnects and is provided with a new connection ID and connection key from the server](./spec/acceptance/realtime/connection_spec.rb#L313) * #close * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L331) * [calls the Deferrable callback on success](./spec/acceptance/realtime/connection_spec.rb#L338) * when already closed * [does nothing and no further state changes are emitted](./spec/acceptance/realtime/connection_spec.rb#L349) * when connection state is * :initialized * [changes the connection state to :closing and then immediately :closed without sending a ProtocolMessage CLOSE](./spec/acceptance/realtime/connection_spec.rb#L377) * :connected * [changes the connection state to :closing and waits for the server to confirm connection is :closed with a ProtocolMessage](./spec/acceptance/realtime/connection_spec.rb#L395) * with an unresponsive connection * [force closes the connection when a :closed ProtocolMessage response is not received](./spec/acceptance/realtime/connection_spec.rb#L425) * #ping * [echoes a heart beat](./spec/acceptance/realtime/connection_spec.rb#L448) * when not connected * [raises an exception](./spec/acceptance/realtime/connection_spec.rb#L458) * recovery * #recovery_key * [is composed of connection id and serial that is kept up to date with each message sent](./spec/acceptance/realtime/connection_spec.rb#L491) * [is available when connection is in one of the states: connecting, connected, disconnected, suspended, failed](./spec/acceptance/realtime/connection_spec.rb#L512) * [is nil when connection is explicitly CLOSED](./spec/acceptance/realtime/connection_spec.rb#L536) * opening a new connection using a recently disconnected connection's #recovery_key * connection#id and connection#key after recovery * [remain the same](./spec/acceptance/realtime/connection_spec.rb#L550) * when messages have been sent whilst the old connection is disconnected * the new connection * [recovers server-side queued messages](./spec/acceptance/realtime/connection_spec.rb#L575) * with :recover option * with invalid syntax * [raises an exception](./spec/acceptance/realtime/connection_spec.rb#L600) * with invalid formatted value sent to server * [triggers a fatal error on the connection object, sets the #error_reason and disconnects](./spec/acceptance/realtime/connection_spec.rb#L609) * with expired (missing) value sent to server * [triggers an error on the connection object, sets the #error_reason, yet will connect anyway](./spec/acceptance/realtime/connection_spec.rb#L623) * with many connections simultaneously * [opens each with a unique connection#id and connection#key](./spec/acceptance/realtime/connection_spec.rb#L641) * when a state transition is unsupported * [emits a StateChangeError](./spec/acceptance/realtime/connection_spec.rb#L661) * undocumented method * #internet_up? * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L676) * when the Internet is up * [calls the block with true](./spec/acceptance/realtime/connection_spec.rb#L682) * [calls the success callback of the Deferrable](./spec/acceptance/realtime/connection_spec.rb#L689) * when the Internet is down * [calls the block with false](./spec/acceptance/realtime/connection_spec.rb#L701) * [calls the failure callback of the Deferrable](./spec/acceptance/realtime/connection_spec.rb#L708) ### Ably::Realtime::Channel Message _(see [spec/acceptance/realtime/message_spec.rb](./spec/acceptance/realtime/message_spec.rb))_ * using JSON and MsgPack protocol * [sends a String data payload](./spec/acceptance/realtime/message_spec.rb#L25) * with ASCII_8BIT message name * [is converted into UTF_8](./spec/acceptance/realtime/message_spec.rb#L37) * when the message publisher has a client_id * [contains a #client_id attribute](./spec/acceptance/realtime/message_spec.rb#L53) * #connection_id attribute * over realtime * [matches the sender connection#id](./spec/acceptance/realtime/message_spec.rb#L66) * when retrieved over REST * [matches the sender connection#id](./spec/acceptance/realtime/message_spec.rb#L78) * local echo when published * [is enabled by default](./spec/acceptance/realtime/message_spec.rb#L90) * with :echo_messages option set to false * [will not echo messages to the client but will still broadcast messages to other connected clients](./spec/acceptance/realtime/message_spec.rb#L106) * publishing lots of messages across two connections * [sends and receives the messages on both opened connections and calls the success callbacks for each message published](./spec/acceptance/realtime/message_spec.rb#L138) * without suitable publishing permissions * [calls the error callback](./spec/acceptance/realtime/message_spec.rb#L183) * encoding and decoding encrypted messages * 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 * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * item 1 with encrypted encoding cipher+aes-128-cbc/base64 * behaves like an Ably encrypter and decrypter * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * item 2 with encrypted encoding json/utf-8/cipher+aes-128-cbc/base64 * behaves like an Ably encrypter and decrypter * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * item 3 with encrypted encoding json/utf-8/cipher+aes-128-cbc/base64 * behaves like an Ably encrypter and decrypter * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * 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 * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * item 1 with encrypted encoding cipher+aes-256-cbc/base64 * behaves like an Ably encrypter and decrypter * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * item 2 with encrypted encoding json/utf-8/cipher+aes-256-cbc/base64 * behaves like an Ably encrypter and decrypter * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * item 3 with encrypted encoding json/utf-8/cipher+aes-256-cbc/base64 * behaves like an Ably encrypter and decrypter * with #publish and #subscribe * [encrypts message automatically before they are pushed to the server](./spec/acceptance/realtime/message_spec.rb#L235) * [sends and receives messages that are encrypted & decrypted by the Ably library](./spec/acceptance/realtime/message_spec.rb#L253) * with multiple sends from one client to another * [encrypts and decrypts all messages](./spec/acceptance/realtime/message_spec.rb#L292) * subscribing with a different transport protocol * [delivers a String ASCII-8BIT payload to the receiver](./spec/acceptance/realtime/message_spec.rb#L335) * [delivers a String UTF-8 payload to the receiver](./spec/acceptance/realtime/message_spec.rb#L335) * [delivers a Hash payload to the receiver](./spec/acceptance/realtime/message_spec.rb#L335) * publishing on an unencrypted channel and subscribing on an encrypted channel with another client * [does not attempt to decrypt the message](./spec/acceptance/realtime/message_spec.rb#L354) * publishing on an encrypted channel and subscribing on an unencrypted channel with another client * [delivers the message but still encrypted with a value in the #encoding attribute](./spec/acceptance/realtime/message_spec.rb#L372) * [triggers a Cipher error on the channel](./spec/acceptance/realtime/message_spec.rb#L381) * publishing on an encrypted channel and subscribing with a different algorithm on another client * [delivers the message but still encrypted with the cipher detials in the #encoding attribute](./spec/acceptance/realtime/message_spec.rb#L403) * [triggers a Cipher error on the channel](./spec/acceptance/realtime/message_spec.rb#L412) * publishing on an encrypted channel and subscribing with a different key on another client * [delivers the message but still encrypted with the cipher details in the #encoding attribute](./spec/acceptance/realtime/message_spec.rb#L434) * [triggers a Cipher error on the channel](./spec/acceptance/realtime/message_spec.rb#L443) ### Ably::Realtime::Presence history _(see [spec/acceptance/realtime/presence_history_spec.rb](./spec/acceptance/realtime/presence_history_spec.rb))_ * using JSON and MsgPack protocol * [provides up to the moment presence history](./spec/acceptance/realtime/presence_history_spec.rb#L21) * [ensures REST presence history message IDs match ProtocolMessage wrapped message and connection IDs via Realtime](./spec/acceptance/realtime/presence_history_spec.rb#L41) ### Ably::Realtime::Presence _(see [spec/acceptance/realtime/presence_spec.rb](./spec/acceptance/realtime/presence_spec.rb))_ * using JSON and MsgPack protocol * PENDING: *[ensure connection_id is unique and updated on ENTER](./spec/acceptance/realtime/presence_spec.rb#L995)* * PENDING: *[ensure connection_id for presence member matches the messages they publish on the channel](./spec/acceptance/realtime/presence_spec.rb#L996)* * PENDING: *[stop a call to get when the channel has not been entered](./spec/acceptance/realtime/presence_spec.rb#L997)* * PENDING: *[stop a call to get when the channel has been entered but the list is not up to date](./spec/acceptance/realtime/presence_spec.rb#L998)* * PENDING: *[presence will resume sync if connection is dropped mid-way](./spec/acceptance/realtime/presence_spec.rb#L999)* * when attached (but not present) on a presence channel with an anonymous client (no client ID) * [maintains state as other clients enter and leave the channel](./spec/acceptance/realtime/presence_spec.rb#L24) * #sync_complete? * when attaching to a channel without any members present * [is true and the presence channel is considered synced immediately](./spec/acceptance/realtime/presence_spec.rb#L53) * when attaching to a channel with members present * [is false and the presence channel will subsequently be synced](./spec/acceptance/realtime/presence_spec.rb#L62) * when the SYNC of a presence channel spans multiple ProtocolMessage messages * with 250 existing (present) members * when a new client attaches to the presence channel * [emits :present for each member](./spec/acceptance/realtime/presence_spec.rb#L83) * #get * [#waits until sync is complete](./spec/acceptance/realtime/presence_spec.rb#L102) * automatic attachment of channel on access to presence object * [is implicit if presence state is initalized](./spec/acceptance/realtime/presence_spec.rb#L122) * [is disabled if presence state is not initialized](./spec/acceptance/realtime/presence_spec.rb#L130) * state * once opened * [once opened, enters the :left state if the channel detaches](./spec/acceptance/realtime/presence_spec.rb#L147) * #enter * [allows client_id to be set on enter for anonymous clients](./spec/acceptance/realtime/presence_spec.rb#L170) * [raises an exception if client_id is not set](./spec/acceptance/realtime/presence_spec.rb#L204) * [returns a Deferrable](./spec/acceptance/realtime/presence_spec.rb#L209) * [calls the Deferrable callback on success](./spec/acceptance/realtime/presence_spec.rb#L214) * data attribute * when provided as argument option to #enter * [remains intact following #leave](./spec/acceptance/realtime/presence_spec.rb#L181) * #update * [without previous #enter automatically enters](./spec/acceptance/realtime/presence_spec.rb#L224) * [updates the data if :data argument provided](./spec/acceptance/realtime/presence_spec.rb#L249) * [updates the data to nil if :data argument is not provided (assumes nil value)](./spec/acceptance/realtime/presence_spec.rb#L259) * [returns a Deferrable](./spec/acceptance/realtime/presence_spec.rb#L269) * [calls the Deferrable callback on success](./spec/acceptance/realtime/presence_spec.rb#L276) * when ENTERED * [has no effect on the state](./spec/acceptance/realtime/presence_spec.rb#L234) * #leave * [raises an exception if not entered](./spec/acceptance/realtime/presence_spec.rb#L332) * [returns a Deferrable](./spec/acceptance/realtime/presence_spec.rb#L337) * [calls the Deferrable callback on success](./spec/acceptance/realtime/presence_spec.rb#L344) * :data option * when set to a string * [emits the new data for the leave event](./spec/acceptance/realtime/presence_spec.rb#L293) * when set to nil * [emits the previously defined value as a convenience](./spec/acceptance/realtime/presence_spec.rb#L306) * when not passed as an argument * [emits the previously defined value as a convenience](./spec/acceptance/realtime/presence_spec.rb#L319) * :left event * [emits the data defined in enter](./spec/acceptance/realtime/presence_spec.rb#L356) * [emits the data defined in update](./spec/acceptance/realtime/presence_spec.rb#L367) * entering/updating/leaving presence state on behalf of another client_id * #enter_client * [returns a Deferrable](./spec/acceptance/realtime/presence_spec.rb#L418) * [calls the Deferrable callback on success](./spec/acceptance/realtime/presence_spec.rb#L423) * multiple times on the same channel with different client_ids * [has no affect on the client's presence state and only enters on behalf of the provided client_id](./spec/acceptance/realtime/presence_spec.rb#L388) * [enters a channel and sets the data based on the provided :data option](./spec/acceptance/realtime/presence_spec.rb#L402) * #update_client * [returns a Deferrable](./spec/acceptance/realtime/presence_spec.rb#L492) * [calls the Deferrable callback on success](./spec/acceptance/realtime/presence_spec.rb#L497) * multiple times on the same channel with different client_ids * [updates the data attribute for the member when :data option provided](./spec/acceptance/realtime/presence_spec.rb#L433) * [updates the data attribute to null for the member when :data option is not provided (assumed null)](./spec/acceptance/realtime/presence_spec.rb#L457) * [enters if not already entered](./spec/acceptance/realtime/presence_spec.rb#L469) * #leave_client * [returns a Deferrable](./spec/acceptance/realtime/presence_spec.rb#L595) * [calls the Deferrable callback on success](./spec/acceptance/realtime/presence_spec.rb#L600) * leaves a channel * multiple times on the same channel with different client_ids * [emits the :leave event for each client_id](./spec/acceptance/realtime/presence_spec.rb#L508) * [succeeds if that client_id has not previously entered the channel](./spec/acceptance/realtime/presence_spec.rb#L532) * with a new value in :data option * [emits the leave event with the new data value](./spec/acceptance/realtime/presence_spec.rb#L556) * with a nil value in :data option * [emits the leave event with the previous value as a convenience](./spec/acceptance/realtime/presence_spec.rb#L569) * with no :data option * [emits the leave event with the previous value as a convenience](./spec/acceptance/realtime/presence_spec.rb#L582) * #get * [returns a Deferrable](./spec/acceptance/realtime/presence_spec.rb#L610) * [calls the Deferrable callback on success](./spec/acceptance/realtime/presence_spec.rb#L615) * [returns the current members on the channel](./spec/acceptance/realtime/presence_spec.rb#L622) * [filters by connection_id option if provided](./spec/acceptance/realtime/presence_spec.rb#L637) * [filters by client_id option if provided](./spec/acceptance/realtime/presence_spec.rb#L659) * [does not wait for SYNC to complete if :wait_for_sync option is false](./spec/acceptance/realtime/presence_spec.rb#L683) * when a member enters and then leaves * [has no members](./spec/acceptance/realtime/presence_spec.rb#L693) * with lots of members on different clients * [returns a complete list of members on all clients](./spec/acceptance/realtime/presence_spec.rb#L710) * #subscribe * with no arguments * [calls the callback for all presence events](./spec/acceptance/realtime/presence_spec.rb#L746) * #unsubscribe * with no arguments * [removes the callback for all presence events](./spec/acceptance/realtime/presence_spec.rb#L766) * REST #get * [returns current members](./spec/acceptance/realtime/presence_spec.rb#L785) * [returns no members once left](./spec/acceptance/realtime/presence_spec.rb#L798) * client_id with ASCII_8BIT * in connection set up * [is converted into UTF_8](./spec/acceptance/realtime/presence_spec.rb#L815) * in channel options * [is converted into UTF_8](./spec/acceptance/realtime/presence_spec.rb#L828) * encoding and decoding of presence message data * [encrypts presence message data](./spec/acceptance/realtime/presence_spec.rb#L852) * #subscribe * [emits decrypted enter events](./spec/acceptance/realtime/presence_spec.rb#L871) * [emits decrypted update events](./spec/acceptance/realtime/presence_spec.rb#L883) * [emits previously set data for leave events](./spec/acceptance/realtime/presence_spec.rb#L897) * #get * [returns a list of members with decrypted data](./spec/acceptance/realtime/presence_spec.rb#L913) * REST #get * [returns a list of members with decrypted data](./spec/acceptance/realtime/presence_spec.rb#L926) * when cipher settings do not match publisher * [delivers an unencoded presence message left with encoding value](./spec/acceptance/realtime/presence_spec.rb#L941) * [emits an error when cipher does not match and presence data cannot be decoded](./spec/acceptance/realtime/presence_spec.rb#L954) * leaving * [expect :left event once underlying connection is closed](./spec/acceptance/realtime/presence_spec.rb#L971) * [expect :left event with client data from enter event](./spec/acceptance/realtime/presence_spec.rb#L981) ### Ably::Realtime::Client#stats _(see [spec/acceptance/realtime/stats_spec.rb](./spec/acceptance/realtime/stats_spec.rb))_ * using JSON and MsgPack protocol * fetching stats * [should return a Hash](./spec/acceptance/realtime/stats_spec.rb#L10) * [should return a Deferrable object](./spec/acceptance/realtime/stats_spec.rb#L17) ### Ably::Realtime::Client#time _(see [spec/acceptance/realtime/time_spec.rb](./spec/acceptance/realtime/time_spec.rb))_ * using JSON and MsgPack protocol * fetching the service time * [should return the service time as a Time object](./spec/acceptance/realtime/time_spec.rb#L10) * [should return a deferrable object](./spec/acceptance/realtime/time_spec.rb#L19) ### Ably::Auth _(see [spec/acceptance/rest/auth_spec.rb](./spec/acceptance/rest/auth_spec.rb))_ * using JSON and MsgPack protocol * [has immutable options](./spec/acceptance/rest/auth_spec.rb#L54) * #request_token * [returns the requested token](./spec/acceptance/rest/auth_spec.rb#L62) * with option :client_id * [overrides default and uses camelCase notation for all attributes](./spec/acceptance/rest/auth_spec.rb#L93) * with option :capability * [overrides default and uses camelCase notation for all attributes](./spec/acceptance/rest/auth_spec.rb#L93) * with option :nonce * [overrides default and uses camelCase notation for all attributes](./spec/acceptance/rest/auth_spec.rb#L93) * with option :timestamp * [overrides default and uses camelCase notation for all attributes](./spec/acceptance/rest/auth_spec.rb#L93) * with option :ttl * [overrides default and uses camelCase notation for all attributes](./spec/acceptance/rest/auth_spec.rb#L93) * with :key_id & :key_secret options * [key_id is used in request and signing uses key_secret](./spec/acceptance/rest/auth_spec.rb#L122) * with :query_time option * [queries the server for the time](./spec/acceptance/rest/auth_spec.rb#L130) * without :query_time option * [does not query the server for the time](./spec/acceptance/rest/auth_spec.rb#L139) * with :auth_url option * when response is valid * [requests a token from :auth_url using an HTTP GET request](./spec/acceptance/rest/auth_spec.rb#L186) * with :query_params * [requests a token from :auth_url with the :query_params](./spec/acceptance/rest/auth_spec.rb#L194) * with :headers * [requests a token from :auth_url with the HTTP headers set](./spec/acceptance/rest/auth_spec.rb#L202) * with POST * [requests a token from :auth_url using an HTTP POST instead of the default GET](./spec/acceptance/rest/auth_spec.rb#L210) * when response is invalid * 500 * [raises ServerError](./spec/acceptance/rest/auth_spec.rb#L223) * XML * [raises InvalidResponseBody](./spec/acceptance/rest/auth_spec.rb#L234) * with token_request_block * [calls the block when authenticating to obtain the request token](./spec/acceptance/rest/auth_spec.rb#L252) * [uses the token request from the block when requesting a new token](./spec/acceptance/rest/auth_spec.rb#L257) * before #authorise has been called * [has no current_token](./spec/acceptance/rest/auth_spec.rb#L264) * #authorise * [updates the persisted auth options thare are then used for subsequent authorise requests](./spec/acceptance/rest/auth_spec.rb#L311) * when called for the first time since the client has been instantiated * [passes all options to #request_token](./spec/acceptance/rest/auth_spec.rb#L275) * [returns a valid token](./spec/acceptance/rest/auth_spec.rb#L280) * [issues a new token if option :force => true](./spec/acceptance/rest/auth_spec.rb#L284) * with previous authorisation * [does not request a token if current_token has not expired](./spec/acceptance/rest/auth_spec.rb#L295) * [requests a new token if token is expired](./spec/acceptance/rest/auth_spec.rb#L300) * [issues a new token if option :force => true](./spec/acceptance/rest/auth_spec.rb#L306) * with token_request_block * [calls the block](./spec/acceptance/rest/auth_spec.rb#L327) * [uses the token request returned from the block when requesting a new token](./spec/acceptance/rest/auth_spec.rb#L331) * for every subsequent #request_token * without a provided block * [calls the originally provided block](./spec/acceptance/rest/auth_spec.rb#L337) * with a provided block * [does not call the originally provided block and calls the new #request_token block](./spec/acceptance/rest/auth_spec.rb#L344) * #create_token_request * [uses the key ID from the client](./spec/acceptance/rest/auth_spec.rb#L360) * [uses the default TTL](./spec/acceptance/rest/auth_spec.rb#L364) * [uses the default capability](./spec/acceptance/rest/auth_spec.rb#L368) * the nonce * [is unique for every request](./spec/acceptance/rest/auth_spec.rb#L373) * [is at least 16 characters](./spec/acceptance/rest/auth_spec.rb#L378) * with option :ttl * [overrides default](./spec/acceptance/rest/auth_spec.rb#L389) * with option :capability * [overrides default](./spec/acceptance/rest/auth_spec.rb#L389) * with option :nonce * [overrides default](./spec/acceptance/rest/auth_spec.rb#L389) * with option :timestamp * [overrides default](./spec/acceptance/rest/auth_spec.rb#L389) * with option :client_id * [overrides default](./spec/acceptance/rest/auth_spec.rb#L389) * with additional invalid attributes * [are ignored](./spec/acceptance/rest/auth_spec.rb#L397) * when required fields are missing * [should raise an exception if key secret is missing](./spec/acceptance/rest/auth_spec.rb#L408) * [should raise an exception if key id is missing](./spec/acceptance/rest/auth_spec.rb#L412) * with :query_time option * [queries the server for the timestamp](./spec/acceptance/rest/auth_spec.rb#L421) * with :timestamp option * [uses the provided timestamp in the token request](./spec/acceptance/rest/auth_spec.rb#L431) * signing * [generates a valid HMAC](./spec/acceptance/rest/auth_spec.rb#L448) * using token authentication * with :token_id option * [authenticates successfully using the provided :token_id](./spec/acceptance/rest/auth_spec.rb#L471) * [disallows publishing on unspecified capability channels](./spec/acceptance/rest/auth_spec.rb#L475) * [fails if timestamp is invalid](./spec/acceptance/rest/auth_spec.rb#L483) * [cannot be renewed automatically](./spec/acceptance/rest/auth_spec.rb#L491) * 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](./spec/acceptance/rest/auth_spec.rb#L521) * a token is created * [before a request is made](./spec/acceptance/rest/auth_spec.rb#L530) * [when a message is published](./spec/acceptance/rest/auth_spec.rb#L534) * [with capability and TTL defaults](./spec/acceptance/rest/auth_spec.rb#L538) * when using an :api_key and basic auth * [#using_token_auth? is false](./spec/acceptance/rest/auth_spec.rb#L553) * [#using_basic_auth? is true](./spec/acceptance/rest/auth_spec.rb#L557) ### Ably::Rest _(see [spec/acceptance/rest/base_spec.rb](./spec/acceptance/rest/base_spec.rb))_ * transport protocol * when protocol is not defined it defaults to :msgpack * [uses MsgPack](./spec/acceptance/rest/base_spec.rb#L27) * when option {:protocol=>:json} is used * [uses JSON](./spec/acceptance/rest/base_spec.rb#L43) * when option {:use_binary_protocol=>false} is used * [uses JSON](./spec/acceptance/rest/base_spec.rb#L43) * when option {:protocol=>:msgpack} is used * [uses MsgPack](./spec/acceptance/rest/base_spec.rb#L60) * when option {:use_binary_protocol=>true} is used * [uses MsgPack](./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](./spec/acceptance/rest/base_spec.rb#L75) * server error with JSON error response body * [should raise a ServerError exception](./spec/acceptance/rest/base_spec.rb#L94) * 500 server error without a valid JSON response body * [should raise a ServerError exception](./spec/acceptance/rest/base_spec.rb#L105) * token authentication failures * when auth#token_renewable? * [should automatically reissue a token](./spec/acceptance/rest/base_spec.rb#L143) * when NOT auth#token_renewable? * [should raise an InvalidToken exception](./spec/acceptance/rest/base_spec.rb#L156) ### Ably::Rest::Channel _(see [spec/acceptance/rest/channel_spec.rb](./spec/acceptance/rest/channel_spec.rb))_ * using JSON and MsgPack protocol * #publish * [should publish the message adn return true indicating success](./spec/acceptance/rest/channel_spec.rb#L17) * #history * [should return the current message history for the channel](./spec/acceptance/rest/channel_spec.rb#L39) * [should return paged history using the PaginatedResource model](./spec/acceptance/rest/channel_spec.rb#L67) * message timestamps * [should all be after the messages were published](./spec/acceptance/rest/channel_spec.rb#L52) * message IDs * [should be unique](./spec/acceptance/rest/channel_spec.rb#L60) * #history option * :start * with milliseconds since epoch value * [uses this value in the history request](./spec/acceptance/rest/channel_spec.rb#L116) * with a Time object value * [converts the value to milliseconds since epoch in the hisotry request](./spec/acceptance/rest/channel_spec.rb#L126) * :end * with milliseconds since epoch value * [uses this value in the history request](./spec/acceptance/rest/channel_spec.rb#L116) * with a Time object value * [converts the value to milliseconds since epoch in the hisotry request](./spec/acceptance/rest/channel_spec.rb#L126) ### Ably::Rest::Channels _(see [spec/acceptance/rest/channels_spec.rb](./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](./spec/acceptance/rest/channels_spec.rb#L6) * [returns channel object and passes the provided options](./spec/acceptance/rest/channels_spec.rb#L11) * using #get method on client#channels * behaves like a channel * [returns a channel object](./spec/acceptance/rest/channels_spec.rb#L6) * [returns channel object and passes the provided options](./spec/acceptance/rest/channels_spec.rb#L11) * using undocumented array accessor [] method on client#channels * behaves like a channel * [returns a channel object](./spec/acceptance/rest/channels_spec.rb#L6) * [returns channel object and passes the provided options](./spec/acceptance/rest/channels_spec.rb#L11) ### Ably::Rest::Client _(see [spec/acceptance/rest/client_spec.rb](./spec/acceptance/rest/client_spec.rb))_ * using JSON and MsgPack protocol * #initialize * with an auth block * [calls the block to get a new token](./spec/acceptance/rest/client_spec.rb#L20) * with an auth URL * [sends an HTTP request to the provided URL to get a new token](./spec/acceptance/rest/client_spec.rb#L34) * using tokens * when expired * [creates a new token automatically when the old token expires](./spec/acceptance/rest/client_spec.rb#L55) * when token has not expired * [reuses the existing token for every request](./spec/acceptance/rest/client_spec.rb#L69) * connection transport * for default host * [is configured to timeout connection opening in 4 seconds](./spec/acceptance/rest/client_spec.rb#L85) * [is configured to timeout connection requests in 15 seconds](./spec/acceptance/rest/client_spec.rb#L89) * for the fallback hosts * [is configured to timeout connection opening in 4 seconds](./spec/acceptance/rest/client_spec.rb#L95) * [is configured to timeout connection requests in 15 seconds](./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](./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](./spec/acceptance/rest/client_spec.rb#L129) * when environment is production * and connection times out * [tries fallback hosts 3 times](./spec/acceptance/rest/client_spec.rb#L169) * and the total request time exeeds 10 seconds * [makes no further attempts to any fallback hosts](./spec/acceptance/rest/client_spec.rb#L184) * and connection fails * [tries fallback hosts 3 times](./spec/acceptance/rest/client_spec.rb#L200) * with a custom host * that does not exist * [fails immediately and raises a Faraday Error](./spec/acceptance/rest/client_spec.rb#L216) * fallback hosts * [are never used](./spec/acceptance/rest/client_spec.rb#L237) * that times out * [fails immediately and raises a Faraday Error](./spec/acceptance/rest/client_spec.rb#L252) * fallback hosts * [are never used](./spec/acceptance/rest/client_spec.rb#L265) ### Ably::Models::MessageEncoders _(see [spec/acceptance/rest/encoders_spec.rb](./spec/acceptance/rest/encoders_spec.rb))_ * with binary transport protocol * without encryption * with UTF-8 data * [does not apply any encoding](./spec/acceptance/rest/encoders_spec.rb#L41) * with binary data * [does not apply any encoding](./spec/acceptance/rest/encoders_spec.rb#L52) * with JSON data * [stringifies the JSON and sets the json encoding type](./spec/acceptance/rest/encoders_spec.rb#L63) * with encryption * with UTF-8 data * [applies utf-8 and cipher encoding](./spec/acceptance/rest/encoders_spec.rb#L78) * with binary data * [applies cipher encoding](./spec/acceptance/rest/encoders_spec.rb#L89) * with JSON data * [applies json, utf-8 and cipher encoding](./spec/acceptance/rest/encoders_spec.rb#L100) * with text transport protocol * without encryption * with UTF-8 data * [does not apply any encoding](./spec/acceptance/rest/encoders_spec.rb#L117) * with binary data * [applies a base64 encoding](./spec/acceptance/rest/encoders_spec.rb#L128) * with JSON data * [stringifies the JSON and sets the json encoding type](./spec/acceptance/rest/encoders_spec.rb#L139) * with encryption * with UTF-8 data * [applies utf-8, cipher and base64 encodings](./spec/acceptance/rest/encoders_spec.rb#L154) * with binary data * [applies cipher and base64 encoding](./spec/acceptance/rest/encoders_spec.rb#L165) * with JSON data * [applies json, utf-8, cipher and base64 encoding](./spec/acceptance/rest/encoders_spec.rb#L176) ### Ably::Rest::Channel messages _(see [spec/acceptance/rest/message_spec.rb](./spec/acceptance/rest/message_spec.rb))_ * using JSON and MsgPack protocol * publishing with an ASCII_8BIT message name * [is converted into UTF_8](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./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](./spec/acceptance/rest/message_spec.rb#L65) * [sends and retrieves messages that are encrypted & decrypted by the Ably library](./spec/acceptance/rest/message_spec.rb#L80) * when publishing lots of messages * [encrypts on #publish and decrypts on #history](./spec/acceptance/rest/message_spec.rb#L113) * when retrieving #history with a different protocol * [delivers a String ASCII-8BIT payload to the receiver](./spec/acceptance/rest/message_spec.rb#L140) * [delivers a String UTF-8 payload to the receiver](./spec/acceptance/rest/message_spec.rb#L140) * [delivers a Hash payload to the receiver](./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](./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](./spec/acceptance/rest/message_spec.rb#L177) * [logs a Cipher exception](./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](./spec/acceptance/rest/message_spec.rb#L204) * [logs a Cipher exception](./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](./spec/acceptance/rest/message_spec.rb#L231) * [logs a Cipher exception](./spec/acceptance/rest/message_spec.rb#L237) ### Ably::Rest::Presence _(see [spec/acceptance/rest/presence_spec.rb](./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](./spec/acceptance/rest/presence_spec.rb#L31) * with :limit option * [returns a paged response limiting number of members per page](./spec/acceptance/rest/presence_spec.rb#L45) * #history * [returns recent presence activity](./spec/acceptance/rest/presence_spec.rb#L64) * with options * direction: :forwards * [returns recent presence activity forwards with most recent history last](./spec/acceptance/rest/presence_spec.rb#L80) * direction: :backwards * [returns recent presence activity backwards with most recent history first](./spec/acceptance/rest/presence_spec.rb#L95) * #history * with time range options * :start * with milliseconds since epoch value * [uses this value in the history request](./spec/acceptance/rest/presence_spec.rb#L140) * with Time object value * [converts the value to milliseconds since epoch in the hisotry request](./spec/acceptance/rest/presence_spec.rb#L150) * :end * with milliseconds since epoch value * [uses this value in the history request](./spec/acceptance/rest/presence_spec.rb#L140) * with Time object value * [converts the value to milliseconds since epoch in the hisotry request](./spec/acceptance/rest/presence_spec.rb#L150) * decoding * valid decodeable content * #get * [automaticaly decodes presence messages](./spec/acceptance/rest/presence_spec.rb#L208) * #history * [automaticaly decodes presence messages](./spec/acceptance/rest/presence_spec.rb#L225) * invalid data * #get * [returns the messages still encoded](./spec/acceptance/rest/presence_spec.rb#L256) * [logs a cipher error](./spec/acceptance/rest/presence_spec.rb#L260) * #history * [returns the messages still encoded](./spec/acceptance/rest/presence_spec.rb#L280) * [logs a cipher error](./spec/acceptance/rest/presence_spec.rb#L284) ### Ably::Rest::Client#stats _(see [spec/acceptance/rest/stats_spec.rb](./spec/acceptance/rest/stats_spec.rb))_ * using JSON and MsgPack protocol * fetching application stats * by minute * [should return all the stats for the application](./spec/acceptance/rest/stats_spec.rb#L49) * by hour * [should return all the stats for the application](./spec/acceptance/rest/stats_spec.rb#L49) * by day * [should return all the stats for the application](./spec/acceptance/rest/stats_spec.rb#L49) * by month * [should return all the stats for the application](./spec/acceptance/rest/stats_spec.rb#L49) ### Ably::Rest::Client#time _(see [spec/acceptance/rest/time_spec.rb](./spec/acceptance/rest/time_spec.rb))_ * using JSON and MsgPack protocol * fetching the service time * [should return the service time as a Time object](./spec/acceptance/rest/time_spec.rb#L10) ### Ably::Auth _(see [spec/unit/auth_spec.rb](./spec/unit/auth_spec.rb))_ * client_id option * with nil value * [is permitted](./spec/unit/auth_spec.rb#L19) * as UTF_8 string * [is permitted](./spec/unit/auth_spec.rb#L27) * [remains as UTF-8](./spec/unit/auth_spec.rb#L31) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/auth_spec.rb#L39) * [is compatible with original encoding](./spec/unit/auth_spec.rb#L43) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/auth_spec.rb#L51) * [is compatible with original encoding](./spec/unit/auth_spec.rb#L55) * as Integer * [raises an argument error](./spec/unit/auth_spec.rb#L63) ### Ably::Logger _(see [spec/unit/logger_spec.rb](./spec/unit/logger_spec.rb))_ * [uses the language provided Logger by default](./spec/unit/logger_spec.rb#L15) * with a custom Logger * with an invalid interface * [raises an exception](./spec/unit/logger_spec.rb#L116) * with a valid interface * [is used](./spec/unit/logger_spec.rb#L135) ### Ably::Models::ErrorInfo _(see [spec/unit/models/error_info_spec.rb](./spec/unit/models/error_info_spec.rb))_ * behaves like a model * attributes * #code * [retrieves attribute :code](./spec/shared/model_behaviour.rb#L15) * #status_code * [retrieves attribute :status_code](./spec/shared/model_behaviour.rb#L15) * #message * [retrieves attribute :message](./spec/shared/model_behaviour.rb#L15) * #== * [is true when attributes are the same](./spec/shared/model_behaviour.rb#L41) * [is false when attributes are not the same](./spec/shared/model_behaviour.rb#L46) * [is false when class type differs](./spec/shared/model_behaviour.rb#L50) * is immutable * [prevents changes](./spec/shared/model_behaviour.rb#L76) * [dups options](./spec/shared/model_behaviour.rb#L80) * #status * [is an alias for #status_code](./spec/unit/models/error_info_spec.rb#L13) ### Ably::Models::MessageEncoders::Base64 _(see [spec/unit/models/message_encoders/base64_spec.rb](./spec/unit/models/message_encoders/base64_spec.rb))_ * #decode * message with base64 payload * [decodes base64](./spec/unit/models/message_encoders/base64_spec.rb#L24) * [strips the encoding](./spec/unit/models/message_encoders/base64_spec.rb#L28) * message with base64 payload before other payloads * [decodes base64](./spec/unit/models/message_encoders/base64_spec.rb#L36) * [strips the encoding](./spec/unit/models/message_encoders/base64_spec.rb#L40) * message with another payload * [leaves the message data intact](./spec/unit/models/message_encoders/base64_spec.rb#L48) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L52) * #encode * over binary transport * message with binary payload * [leaves the message data intact as Base64 encoding is not necessary](./spec/unit/models/message_encoders/base64_spec.rb#L68) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L72) * already encoded message with binary payload * [leaves the message data intact as Base64 encoding is not necessary](./spec/unit/models/message_encoders/base64_spec.rb#L80) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L84) * message with UTF-8 payload * [leaves the data intact](./spec/unit/models/message_encoders/base64_spec.rb#L92) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L96) * message with nil payload * [leaves the message data intact](./spec/unit/models/message_encoders/base64_spec.rb#L104) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L108) * message with empty binary string payload * [leaves the message data intact](./spec/unit/models/message_encoders/base64_spec.rb#L116) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L120) * over text transport * message with binary payload * [encodes binary data as base64](./spec/unit/models/message_encoders/base64_spec.rb#L135) * [adds the encoding](./spec/unit/models/message_encoders/base64_spec.rb#L139) * already encoded message with binary payload * [encodes binary data as base64](./spec/unit/models/message_encoders/base64_spec.rb#L147) * [adds the encoding](./spec/unit/models/message_encoders/base64_spec.rb#L151) * message with UTF-8 payload * [leaves the data intact](./spec/unit/models/message_encoders/base64_spec.rb#L159) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L163) * message with nil payload * [leaves the message data intact](./spec/unit/models/message_encoders/base64_spec.rb#L171) * [leaves the encoding intact](./spec/unit/models/message_encoders/base64_spec.rb#L175) ### Ably::Models::MessageEncoders::Cipher _(see [spec/unit/models/message_encoders/cipher_spec.rb](./spec/unit/models/message_encoders/cipher_spec.rb))_ * #decode * with channel set up for AES-128-CBC * valid cipher data * message with cipher payload * [decodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L32) * [strips the encoding](./spec/unit/models/message_encoders/cipher_spec.rb#L36) * message with cipher payload before other payloads * [decodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L44) * [strips the encoding](./spec/unit/models/message_encoders/cipher_spec.rb#L48) * message with binary payload * [decodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L56) * [strips the encoding](./spec/unit/models/message_encoders/cipher_spec.rb#L60) * [returns ASCII_8BIT encoded binary data](./spec/unit/models/message_encoders/cipher_spec.rb#L64) * message with another payload * [leaves the message data intact](./spec/unit/models/message_encoders/cipher_spec.rb#L72) * [leaves the encoding intact](./spec/unit/models/message_encoders/cipher_spec.rb#L76) * with invalid channel_option cipher params * [raise an exception](./spec/unit/models/message_encoders/cipher_spec.rb#L87) * without any configured encryption * [raise an exception](./spec/unit/models/message_encoders/cipher_spec.rb#L97) * with invalid cipher data * [raise an exception](./spec/unit/models/message_encoders/cipher_spec.rb#L106) * with AES-256-CBC * message with cipher payload * [decodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L122) * [strips the encoding](./spec/unit/models/message_encoders/cipher_spec.rb#L126) * #encode * with channel set up for AES-128-CBC * with encrypted set to true * message with string payload * [encodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L146) * [adds the encoding with utf-8](./spec/unit/models/message_encoders/cipher_spec.rb#L151) * message with binary payload * [encodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L159) * [adds the encoding without utf-8 prefixed](./spec/unit/models/message_encoders/cipher_spec.rb#L164) * [returns ASCII_8BIT encoded binary data](./spec/unit/models/message_encoders/cipher_spec.rb#L168) * message with json payload * [encodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L176) * [adds the encoding with utf-8](./spec/unit/models/message_encoders/cipher_spec.rb#L181) * message with existing cipher encoding before * [leaves message intact as it is already encrypted](./spec/unit/models/message_encoders/cipher_spec.rb#L189) * [leaves encoding intact](./spec/unit/models/message_encoders/cipher_spec.rb#L193) * with encryption set to to false * [leaves message intact as encryption is not enable](./spec/unit/models/message_encoders/cipher_spec.rb#L202) * [leaves encoding intact](./spec/unit/models/message_encoders/cipher_spec.rb#L206) * channel_option cipher params * have invalid key length * [raise an exception](./spec/unit/models/message_encoders/cipher_spec.rb#L218) * have invalid algorithm * [raise an exception](./spec/unit/models/message_encoders/cipher_spec.rb#L225) * have missing key * [raise an exception](./spec/unit/models/message_encoders/cipher_spec.rb#L232) * with AES-256-CBC * message with cipher payload * [decodes cipher](./spec/unit/models/message_encoders/cipher_spec.rb#L249) * [strips the encoding](./spec/unit/models/message_encoders/cipher_spec.rb#L254) ### Ably::Models::MessageEncoders::Json _(see [spec/unit/models/message_encoders/json_spec.rb](./spec/unit/models/message_encoders/json_spec.rb))_ * #decode * message with json payload * [decodes json](./spec/unit/models/message_encoders/json_spec.rb#L24) * [strips the encoding](./spec/unit/models/message_encoders/json_spec.rb#L28) * message with json payload before other payloads * [decodes json](./spec/unit/models/message_encoders/json_spec.rb#L36) * [strips the encoding](./spec/unit/models/message_encoders/json_spec.rb#L40) * message with another payload * [leaves the message data intact](./spec/unit/models/message_encoders/json_spec.rb#L48) * [leaves the encoding intact](./spec/unit/models/message_encoders/json_spec.rb#L52) * #encode * message with hash payload * [encodes hash payload data as json](./spec/unit/models/message_encoders/json_spec.rb#L66) * [adds the encoding](./spec/unit/models/message_encoders/json_spec.rb#L70) * already encoded message with hash payload * [encodes hash payload data as json](./spec/unit/models/message_encoders/json_spec.rb#L78) * [adds the encoding](./spec/unit/models/message_encoders/json_spec.rb#L82) * message with Array payload * [encodes Array payload data as json](./spec/unit/models/message_encoders/json_spec.rb#L90) * [adds the encoding](./spec/unit/models/message_encoders/json_spec.rb#L94) * message with UTF-8 payload * [leaves the message data intact](./spec/unit/models/message_encoders/json_spec.rb#L102) * [leaves the encoding intact](./spec/unit/models/message_encoders/json_spec.rb#L106) * message with nil payload * [leaves the message data intact](./spec/unit/models/message_encoders/json_spec.rb#L114) * [leaves the encoding intact](./spec/unit/models/message_encoders/json_spec.rb#L118) * message with no data payload * [leaves the message data intact](./spec/unit/models/message_encoders/json_spec.rb#L126) * [leaves the encoding intact](./spec/unit/models/message_encoders/json_spec.rb#L130) ### Ably::Models::MessageEncoders::Utf8 _(see [spec/unit/models/message_encoders/utf8_spec.rb](./spec/unit/models/message_encoders/utf8_spec.rb))_ * #decode * message with utf8 payload * [sets the encoding](./spec/unit/models/message_encoders/utf8_spec.rb#L21) * [strips the encoding](./spec/unit/models/message_encoders/utf8_spec.rb#L26) * message with utf8 payload before other payloads * [sets the encoding](./spec/unit/models/message_encoders/utf8_spec.rb#L34) * [strips the encoding](./spec/unit/models/message_encoders/utf8_spec.rb#L39) * message with another payload * [leaves the message data intact](./spec/unit/models/message_encoders/utf8_spec.rb#L47) * [leaves the encoding intact](./spec/unit/models/message_encoders/utf8_spec.rb#L51) ### Ably::Models::Message _(see [spec/unit/models/message_spec.rb](./spec/unit/models/message_spec.rb))_ * behaves like a model * attributes * #name * [retrieves attribute :name](./spec/shared/model_behaviour.rb#L15) * #client_id * [retrieves attribute :client_id](./spec/shared/model_behaviour.rb#L15) * #data * [retrieves attribute :data](./spec/shared/model_behaviour.rb#L15) * #encoding * [retrieves attribute :encoding](./spec/shared/model_behaviour.rb#L15) * #== * [is true when attributes are the same](./spec/shared/model_behaviour.rb#L41) * [is false when attributes are not the same](./spec/shared/model_behaviour.rb#L46) * [is false when class type differs](./spec/shared/model_behaviour.rb#L50) * is immutable * [prevents changes](./spec/shared/model_behaviour.rb#L76) * [dups options](./spec/shared/model_behaviour.rb#L80) * #timestamp * [retrieves attribute :timestamp as Time object from ProtocolMessage](./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](./spec/unit/models/message_spec.rb#L36) * with a protocol message with a different connectionId * [uses the model value](./spec/unit/models/message_spec.rb#L44) * when this model has no connectionId attribute * and no protocol message * [uses the model value](./spec/unit/models/message_spec.rb#L54) * with a protocol message with a connectionId * [uses the model value](./spec/unit/models/message_spec.rb#L62) * initialized with * :name * as UTF_8 string * [is permitted](./spec/unit/models/message_spec.rb#L89) * [remains as UTF-8](./spec/unit/models/message_spec.rb#L93) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/models/message_spec.rb#L101) * [is compatible with original encoding](./spec/unit/models/message_spec.rb#L105) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/models/message_spec.rb#L113) * [is compatible with original encoding](./spec/unit/models/message_spec.rb#L117) * as Integer * [raises an argument error](./spec/unit/models/message_spec.rb#L125) * as Nil * [is permitted](./spec/unit/models/message_spec.rb#L133) * :client_id * as UTF_8 string * [is permitted](./spec/unit/models/message_spec.rb#L89) * [remains as UTF-8](./spec/unit/models/message_spec.rb#L93) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/models/message_spec.rb#L101) * [is compatible with original encoding](./spec/unit/models/message_spec.rb#L105) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/models/message_spec.rb#L113) * [is compatible with original encoding](./spec/unit/models/message_spec.rb#L117) * as Integer * [raises an argument error](./spec/unit/models/message_spec.rb#L125) * as Nil * [is permitted](./spec/unit/models/message_spec.rb#L133) * :encoding * as UTF_8 string * [is permitted](./spec/unit/models/message_spec.rb#L89) * [remains as UTF-8](./spec/unit/models/message_spec.rb#L93) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/models/message_spec.rb#L101) * [is compatible with original encoding](./spec/unit/models/message_spec.rb#L105) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/models/message_spec.rb#L113) * [is compatible with original encoding](./spec/unit/models/message_spec.rb#L117) * as Integer * [raises an argument error](./spec/unit/models/message_spec.rb#L125) * as Nil * [is permitted](./spec/unit/models/message_spec.rb#L133) ### Ably::Models::PaginatedResource _(see [spec/unit/models/paginated_resource_spec.rb](./spec/unit/models/paginated_resource_spec.rb))_ * [returns correct length from body](./spec/unit/models/paginated_resource_spec.rb#L30) * [supports alias methods for length](./spec/unit/models/paginated_resource_spec.rb#L34) * [is Enumerable](./spec/unit/models/paginated_resource_spec.rb#L39) * [is iterable](./spec/unit/models/paginated_resource_spec.rb#L43) * [provides [] accessor method](./spec/unit/models/paginated_resource_spec.rb#L61) * [#first gets the first item in page](./spec/unit/models/paginated_resource_spec.rb#L67) * [#last gets the last item in page](./spec/unit/models/paginated_resource_spec.rb#L71) * #each * [returns an enumerator](./spec/unit/models/paginated_resource_spec.rb#L48) * [yields each item](./spec/unit/models/paginated_resource_spec.rb#L52) * with non paged http response * [is the first page](./spec/unit/models/paginated_resource_spec.rb#L175) * [is the last page](./spec/unit/models/paginated_resource_spec.rb#L179) * [does not support pagination](./spec/unit/models/paginated_resource_spec.rb#L183) * [raises an exception when accessing next page](./spec/unit/models/paginated_resource_spec.rb#L187) * [raises an exception when accessing first page](./spec/unit/models/paginated_resource_spec.rb#L191) * with paged http response * [is the first page](./spec/unit/models/paginated_resource_spec.rb#L209) * [is not the last page](./spec/unit/models/paginated_resource_spec.rb#L213) * [supports pagination](./spec/unit/models/paginated_resource_spec.rb#L217) * accessing next page * [returns another PaginatedResource](./spec/unit/models/paginated_resource_spec.rb#L245) * [retrieves the next page of results](./spec/unit/models/paginated_resource_spec.rb#L249) * [is not the first page](./spec/unit/models/paginated_resource_spec.rb#L254) * [is the last page](./spec/unit/models/paginated_resource_spec.rb#L258) * [raises an exception if trying to access the last page when it is the last page](./spec/unit/models/paginated_resource_spec.rb#L262) * and then first page * [returns a PaginatedResource](./spec/unit/models/paginated_resource_spec.rb#L273) * [retrieves the first page of results](./spec/unit/models/paginated_resource_spec.rb#L277) * [is the first page](./spec/unit/models/paginated_resource_spec.rb#L281) ### Ably::Models::PresenceMessage _(see [spec/unit/models/presence_message_spec.rb](./spec/unit/models/presence_message_spec.rb))_ * behaves like a model * attributes * #client_id * [retrieves attribute :client_id](./spec/shared/model_behaviour.rb#L15) * #data * [retrieves attribute :data](./spec/shared/model_behaviour.rb#L15) * #encoding * [retrieves attribute :encoding](./spec/shared/model_behaviour.rb#L15) * #== * [is true when attributes are the same](./spec/shared/model_behaviour.rb#L41) * [is false when attributes are not the same](./spec/shared/model_behaviour.rb#L46) * [is false when class type differs](./spec/shared/model_behaviour.rb#L50) * is immutable * [prevents changes](./spec/shared/model_behaviour.rb#L76) * [dups options](./spec/shared/model_behaviour.rb#L80) * #connection_id attribute * when this model has a connectionId attribute * but no protocol message * [uses the model value](./spec/unit/models/presence_message_spec.rb#L25) * with a protocol message with a different connectionId * [uses the model value](./spec/unit/models/presence_message_spec.rb#L33) * when this model has no connectionId attribute * and no protocol message * [uses the model value](./spec/unit/models/presence_message_spec.rb#L43) * with a protocol message with a connectionId * [uses the model value](./spec/unit/models/presence_message_spec.rb#L51) * #member_key attribute * [is string in format connection_id:client_id](./spec/unit/models/presence_message_spec.rb#L61) * with the same client id across multiple connections * [is unique](./spec/unit/models/presence_message_spec.rb#L69) * with a single connection and different client_ids * [is unique](./spec/unit/models/presence_message_spec.rb#L78) * #timestamp * [retrieves attribute :timestamp as a Time object from ProtocolMessage](./spec/unit/models/presence_message_spec.rb#L86) * initialized with * :client_id * as UTF_8 string * [is permitted](./spec/unit/models/presence_message_spec.rb#L138) * [remains as UTF-8](./spec/unit/models/presence_message_spec.rb#L142) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/models/presence_message_spec.rb#L150) * [is compatible with original encoding](./spec/unit/models/presence_message_spec.rb#L154) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/models/presence_message_spec.rb#L162) * [is compatible with original encoding](./spec/unit/models/presence_message_spec.rb#L166) * as Integer * [raises an argument error](./spec/unit/models/presence_message_spec.rb#L174) * as Nil * [is permitted](./spec/unit/models/presence_message_spec.rb#L182) * :connection_id * as UTF_8 string * [is permitted](./spec/unit/models/presence_message_spec.rb#L138) * [remains as UTF-8](./spec/unit/models/presence_message_spec.rb#L142) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/models/presence_message_spec.rb#L150) * [is compatible with original encoding](./spec/unit/models/presence_message_spec.rb#L154) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/models/presence_message_spec.rb#L162) * [is compatible with original encoding](./spec/unit/models/presence_message_spec.rb#L166) * as Integer * [raises an argument error](./spec/unit/models/presence_message_spec.rb#L174) * as Nil * [is permitted](./spec/unit/models/presence_message_spec.rb#L182) * :encoding * as UTF_8 string * [is permitted](./spec/unit/models/presence_message_spec.rb#L138) * [remains as UTF-8](./spec/unit/models/presence_message_spec.rb#L142) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/models/presence_message_spec.rb#L150) * [is compatible with original encoding](./spec/unit/models/presence_message_spec.rb#L154) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/models/presence_message_spec.rb#L162) * [is compatible with original encoding](./spec/unit/models/presence_message_spec.rb#L166) * as Integer * [raises an argument error](./spec/unit/models/presence_message_spec.rb#L174) * as Nil * [is permitted](./spec/unit/models/presence_message_spec.rb#L182) ### Ably::Models::ProtocolMessage _(see [spec/unit/models/protocol_message_spec.rb](./spec/unit/models/protocol_message_spec.rb))_ * behaves like a model * attributes * #id * [retrieves attribute :id](./spec/shared/model_behaviour.rb#L15) * #channel * [retrieves attribute :channel](./spec/shared/model_behaviour.rb#L15) * #channel_serial * [retrieves attribute :channel_serial](./spec/shared/model_behaviour.rb#L15) * #connection_id * [retrieves attribute :connection_id](./spec/shared/model_behaviour.rb#L15) * #== * [is true when attributes are the same](./spec/shared/model_behaviour.rb#L41) * [is false when attributes are not the same](./spec/shared/model_behaviour.rb#L46) * [is false when class type differs](./spec/shared/model_behaviour.rb#L50) * is immutable * [prevents changes](./spec/shared/model_behaviour.rb#L76) * [dups options](./spec/shared/model_behaviour.rb#L80) * attributes * #timestamp * [retrieves attribute :timestamp as Time object](./spec/unit/models/protocol_message_spec.rb#L74) * #count * when missing * [is 1](./spec/unit/models/protocol_message_spec.rb#L83) * when non numeric * [is 1](./spec/unit/models/protocol_message_spec.rb#L90) * when greater than 1 * [is the value of count](./spec/unit/models/protocol_message_spec.rb#L97) * #message_serial * [converts :msg_serial to an Integer](./spec/unit/models/protocol_message_spec.rb#L105) * #has_message_serial? * without msg_serial * [returns false](./spec/unit/models/protocol_message_spec.rb#L115) * with msg_serial * [returns true](./spec/unit/models/protocol_message_spec.rb#L123) * #connection_serial * [converts :connection_serial to an Integer](./spec/unit/models/protocol_message_spec.rb#L131) * #flags * when nil * [is zero](./spec/unit/models/protocol_message_spec.rb#L141) * when numeric * [is an Integer](./spec/unit/models/protocol_message_spec.rb#L149) * when has_presence * [#has_presence_flag? is true](./spec/unit/models/protocol_message_spec.rb#L157) * when has another future flag * [#has_presence_flag? is false](./spec/unit/models/protocol_message_spec.rb#L165) * #has_connection_serial? * without connection_serial * [returns false](./spec/unit/models/protocol_message_spec.rb#L175) * with connection_serial * [returns true](./spec/unit/models/protocol_message_spec.rb#L183) * #serial * with underlying msg_serial * [converts :msg_serial to an Integer](./spec/unit/models/protocol_message_spec.rb#L192) * with underlying connection_serial * [converts :connection_serial to an Integer](./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](./spec/unit/models/protocol_message_spec.rb#L208) * #has_serial? * without msg_serial or connection_serial * [returns false](./spec/unit/models/protocol_message_spec.rb#L219) * with msg_serial * [returns true](./spec/unit/models/protocol_message_spec.rb#L227) * with connection_serial * [returns true](./spec/unit/models/protocol_message_spec.rb#L235) * #error * with no error attribute * [returns nil](./spec/unit/models/protocol_message_spec.rb#L245) * with nil error * [returns nil](./spec/unit/models/protocol_message_spec.rb#L253) * with error * [returns a valid ErrorInfo object](./spec/unit/models/protocol_message_spec.rb#L261) ### Ably::Models::Token _(see [spec/unit/models/token_spec.rb](./spec/unit/models/token_spec.rb))_ * behaves like a model * attributes * #id * [retrieves attribute :id](./spec/shared/model_behaviour.rb#L15) * #capability * [retrieves attribute :capability](./spec/shared/model_behaviour.rb#L15) * #client_id * [retrieves attribute :client_id](./spec/shared/model_behaviour.rb#L15) * #nonce * [retrieves attribute :nonce](./spec/shared/model_behaviour.rb#L15) * #== * [is true when attributes are the same](./spec/shared/model_behaviour.rb#L41) * [is false when attributes are not the same](./spec/shared/model_behaviour.rb#L46) * [is false when class type differs](./spec/shared/model_behaviour.rb#L50) * is immutable * [prevents changes](./spec/shared/model_behaviour.rb#L76) * [dups options](./spec/shared/model_behaviour.rb#L80) * defaults * [should default TTL to 1 hour](./spec/unit/models/token_spec.rb#L14) * [should default capability to all](./spec/unit/models/token_spec.rb#L18) * [should only have defaults for :ttl and :capability](./spec/unit/models/token_spec.rb#L22) * attributes * #key_id * [retrieves attribute :key](./spec/unit/models/token_spec.rb#L32) * #issued_at * [retrieves attribute :issued_at as Time](./spec/unit/models/token_spec.rb#L42) * #expires_at * [retrieves attribute :expires as Time](./spec/unit/models/token_spec.rb#L42) * #expired? * once grace period buffer has passed * [is true](./spec/unit/models/token_spec.rb#L55) * within grace period buffer * [is false](./spec/unit/models/token_spec.rb#L63) * == * [is true when attributes are the same](./spec/unit/models/token_spec.rb#L73) * [is false when attributes are not the same](./spec/unit/models/token_spec.rb#L78) * [is false when class type differs](./spec/unit/models/token_spec.rb#L82) ### Ably::Modules::EventEmitter _(see [spec/unit/modules/event_emitter_spec.rb](./spec/unit/modules/event_emitter_spec.rb))_ * #trigger event fan out * [should emit an event for any number of subscribers](./spec/unit/modules/event_emitter_spec.rb#L18) * [sends only messages to matching event names](./spec/unit/modules/event_emitter_spec.rb#L27) * #on subscribe to multiple events * [with the same block](./spec/unit/modules/event_emitter_spec.rb#L59) * event callback changes within the callback block * when new event callbacks are added * [is unaffected and processes the prior event callbacks once](./spec/unit/modules/event_emitter_spec.rb#L83) * [adds them for the next emitted event](./spec/unit/modules/event_emitter_spec.rb#L89) * when callbacks are removed * [is unaffected and processes the prior event callbacks once](./spec/unit/modules/event_emitter_spec.rb#L110) * [removes them for the next emitted event](./spec/unit/modules/event_emitter_spec.rb#L115) * #once * [calls the block the first time an event is emitted only](./spec/unit/modules/event_emitter_spec.rb#L128) * [does not remove other blocks after it is called](./spec/unit/modules/event_emitter_spec.rb#L135) * #off * with event names as arguments * [deletes matching callbacks](./spec/unit/modules/event_emitter_spec.rb#L156) * [deletes all callbacks if not block given](./spec/unit/modules/event_emitter_spec.rb#L161) * [continues if the block does not exist](./spec/unit/modules/event_emitter_spec.rb#L166) * without any event names * [deletes all matching callbacks](./spec/unit/modules/event_emitter_spec.rb#L173) * [deletes all callbacks if not block given](./spec/unit/modules/event_emitter_spec.rb#L178) ### Ably::Modules::StateEmitter _(see [spec/unit/modules/state_emitter_spec.rb](./spec/unit/modules/state_emitter_spec.rb))_ * [#state returns current state](./spec/unit/modules/state_emitter_spec.rb#L25) * [#state= sets current state](./spec/unit/modules/state_emitter_spec.rb#L29) * [#change_state sets current state](./spec/unit/modules/state_emitter_spec.rb#L33) * #change_state with arguments * [passes the arguments through to the triggered callback](./spec/unit/modules/state_emitter_spec.rb#L41) * #state? * [returns true if state matches](./spec/unit/modules/state_emitter_spec.rb#L52) * [returns false if state does not match](./spec/unit/modules/state_emitter_spec.rb#L56) * and convenience predicates for states * [returns true for #initializing? if state matches](./spec/unit/modules/state_emitter_spec.rb#L61) * [returns false for #connecting? if state does not match](./spec/unit/modules/state_emitter_spec.rb#L65) ### Ably::Realtime::Channel _(see [spec/unit/realtime/channel_spec.rb](./spec/unit/realtime/channel_spec.rb))_ * #initializer * as UTF_8 string * [is permitted](./spec/unit/realtime/channel_spec.rb#L19) * [remains as UTF-8](./spec/unit/realtime/channel_spec.rb#L23) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/realtime/channel_spec.rb#L31) * [is compatible with original encoding](./spec/unit/realtime/channel_spec.rb#L35) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/realtime/channel_spec.rb#L43) * [is compatible with original encoding](./spec/unit/realtime/channel_spec.rb#L47) * as Integer * [raises an argument error](./spec/unit/realtime/channel_spec.rb#L55) * as Nil * [raises an argument error](./spec/unit/realtime/channel_spec.rb#L63) * #publish name argument * as UTF_8 string * [is permitted](./spec/unit/realtime/channel_spec.rb#L79) * as SHIFT_JIS string * [is permitted](./spec/unit/realtime/channel_spec.rb#L87) * as ASCII_8BIT string * [is permitted](./spec/unit/realtime/channel_spec.rb#L95) * as Integer * [raises an argument error](./spec/unit/realtime/channel_spec.rb#L103) * as Nil * [raises an argument error](./spec/unit/realtime/channel_spec.rb#L111) * callbacks * [are supported for valid STATE events](./spec/unit/realtime/channel_spec.rb#L118) * [fail with unacceptable STATE event names](./spec/unit/realtime/channel_spec.rb#L124) * subscriptions * #subscribe * [to all events](./spec/unit/realtime/channel_spec.rb#L159) * [to specific events](./spec/unit/realtime/channel_spec.rb#L165) * #unsubscribe * [to all events](./spec/unit/realtime/channel_spec.rb#L181) * [to specific events](./spec/unit/realtime/channel_spec.rb#L187) * [to specific non-matching events](./spec/unit/realtime/channel_spec.rb#L193) * [all callbacks by not providing a callback](./spec/unit/realtime/channel_spec.rb#L199) ### Ably::Realtime::Channels _(see [spec/unit/realtime/channels_spec.rb](./spec/unit/realtime/channels_spec.rb))_ * creating channels * [#get creates a channel](./spec/unit/realtime/channels_spec.rb#L13) * [#get will reuse the channel object](./spec/unit/realtime/channels_spec.rb#L18) * [[] creates a channel](./spec/unit/realtime/channels_spec.rb#L24) * #fetch * [retrieves a channel if it exists](./spec/unit/realtime/channels_spec.rb#L31) * [calls the block if channel is missing](./spec/unit/realtime/channels_spec.rb#L36) * destroying channels * [#release detatches and then releases the channel resoures](./spec/unit/realtime/channels_spec.rb#L44) * is Enumerable * [allows enumeration](./spec/unit/realtime/channels_spec.rb#L61) * [provides #length](./spec/unit/realtime/channels_spec.rb#L77) * #each * [returns an enumerator](./spec/unit/realtime/channels_spec.rb#L66) * [yields each channel](./spec/unit/realtime/channels_spec.rb#L70) ### Ably::Realtime::Client _(see [spec/unit/realtime/client_spec.rb](./spec/unit/realtime/client_spec.rb))_ * behaves like a client initializer * with invalid arguments * empty hash * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L28) * nil * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L36) * api_key: "invalid" * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L44) * api_key: "invalid:asdad" * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L52) * api_key and key_id * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L60) * api_key and key_secret * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L68) * client_id as only option * [requires a valid key](./spec/shared/client_initializer_behaviour.rb#L76) * with valid arguments * api_key only * [connects to the Ably service](./spec/shared/client_initializer_behaviour.rb#L87) * key_id and key_secret * [constructs an api_key](./spec/shared/client_initializer_behaviour.rb#L95) * with a string key instead of options hash * [sets the api_key](./spec/shared/client_initializer_behaviour.rb#L103) * [sets the key_id](./spec/shared/client_initializer_behaviour.rb#L107) * [sets the key_secret](./spec/shared/client_initializer_behaviour.rb#L111) * with token * [sets the token_id](./spec/shared/client_initializer_behaviour.rb#L119) * endpoint * [defaults to production](./spec/shared/client_initializer_behaviour.rb#L125) * with environment option * [uses an alternate endpoint](./spec/shared/client_initializer_behaviour.rb#L132) * tls * [defaults to TLS](./spec/shared/client_initializer_behaviour.rb#L151) * set to false * [uses plain text](./spec/shared/client_initializer_behaviour.rb#L142) * [uses HTTP](./spec/shared/client_initializer_behaviour.rb#L146) * logger * default * [uses Ruby Logger](./spec/shared/client_initializer_behaviour.rb#L158) * [specifies Logger::ERROR log level](./spec/shared/client_initializer_behaviour.rb#L162) * with log_level :none * [silences all logging with a NilLogger](./spec/shared/client_initializer_behaviour.rb#L170) * with custom logger and log_level * [uses the custom logger](./spec/shared/client_initializer_behaviour.rb#L188) * [sets the custom log level](./spec/shared/client_initializer_behaviour.rb#L192) * delegators * [delegates :client_id to .auth](./spec/shared/client_initializer_behaviour.rb#L202) * [delegates :auth_options to .auth](./spec/shared/client_initializer_behaviour.rb#L207) * delegation to the REST Client * [passes on the options to the initializer](./spec/unit/realtime/client_spec.rb#L15) * for attribute * [#environment](./spec/unit/realtime/client_spec.rb#L23) * [#use_tls?](./spec/unit/realtime/client_spec.rb#L23) * [#log_level](./spec/unit/realtime/client_spec.rb#L23) * [#custom_host](./spec/unit/realtime/client_spec.rb#L23) ### Ably::Realtime::Connection _(see [spec/unit/realtime/connection_spec.rb](./spec/unit/realtime/connection_spec.rb))_ * callbacks * [are supported for valid STATE events](./spec/unit/realtime/connection_spec.rb#L18) * [fail with unacceptable STATE event names](./spec/unit/realtime/connection_spec.rb#L24) ### Ably::Realtime::Presence _(see [spec/unit/realtime/presence_spec.rb](./spec/unit/realtime/presence_spec.rb))_ * callbacks * [are supported for valid STATE events](./spec/unit/realtime/presence_spec.rb#L13) * [fail with unacceptable STATE event names](./spec/unit/realtime/presence_spec.rb#L19) * subscriptions * #subscribe * [to all presence state actions](./spec/unit/realtime/presence_spec.rb#L60) * [to specific presence state actions](./spec/unit/realtime/presence_spec.rb#L66) * #unsubscribe * [to all presence state actions](./spec/unit/realtime/presence_spec.rb#L86) * [to specific presence state actions](./spec/unit/realtime/presence_spec.rb#L92) * [to specific non-matching presence state actions](./spec/unit/realtime/presence_spec.rb#L98) * [all callbacks by not providing a callback](./spec/unit/realtime/presence_spec.rb#L104) ### Ably::Realtime _(see [spec/unit/realtime/realtime_spec.rb](./spec/unit/realtime/realtime_spec.rb))_ * [constructor returns an Ably::Realtime::Client](./spec/unit/realtime/realtime_spec.rb#L6) ### Ably::Rest::Channels _(see [spec/unit/rest/channel_spec.rb](./spec/unit/rest/channel_spec.rb))_ * #initializer * as UTF_8 string * [is permitted](./spec/unit/rest/channel_spec.rb#L16) * [remains as UTF-8](./spec/unit/rest/channel_spec.rb#L20) * as SHIFT_JIS string * [gets converted to UTF-8](./spec/unit/rest/channel_spec.rb#L28) * [is compatible with original encoding](./spec/unit/rest/channel_spec.rb#L32) * as ASCII_8BIT string * [gets converted to UTF-8](./spec/unit/rest/channel_spec.rb#L40) * [is compatible with original encoding](./spec/unit/rest/channel_spec.rb#L44) * as Integer * [raises an argument error](./spec/unit/rest/channel_spec.rb#L52) * as Nil * [raises an argument error](./spec/unit/rest/channel_spec.rb#L60) * #publish name argument * as UTF_8 string * [is permitted](./spec/unit/rest/channel_spec.rb#L72) * as SHIFT_JIS string * [is permitted](./spec/unit/rest/channel_spec.rb#L80) * as ASCII_8BIT string * [is permitted](./spec/unit/rest/channel_spec.rb#L88) * as Integer * [raises an argument error](./spec/unit/rest/channel_spec.rb#L96) * as Nil * [raises an argument error](./spec/unit/rest/channel_spec.rb#L104) ### Ably::Rest::Channels _(see [spec/unit/rest/channels_spec.rb](./spec/unit/rest/channels_spec.rb))_ * creating channels * [#get creates a channel](./spec/unit/rest/channels_spec.rb#L12) * [#get will reuse the channel object](./spec/unit/rest/channels_spec.rb#L17) * [[] creates a channel](./spec/unit/rest/channels_spec.rb#L23) * #fetch * [retrieves a channel if it exists](./spec/unit/rest/channels_spec.rb#L30) * [calls the block if channel is missing](./spec/unit/rest/channels_spec.rb#L35) * destroying channels * [#release releases the channel resoures](./spec/unit/rest/channels_spec.rb#L43) * is Enumerable * [allows enumeration](./spec/unit/rest/channels_spec.rb#L59) * [provides #length](./spec/unit/rest/channels_spec.rb#L75) * #each * [returns an enumerator](./spec/unit/rest/channels_spec.rb#L64) * [yields each channel](./spec/unit/rest/channels_spec.rb#L68) ### Ably::Rest::Client _(see [spec/unit/rest/client_spec.rb](./spec/unit/rest/client_spec.rb))_ * behaves like a client initializer * with invalid arguments * empty hash * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L28) * nil * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L36) * api_key: "invalid" * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L44) * api_key: "invalid:asdad" * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L52) * api_key and key_id * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L60) * api_key and key_secret * [raises an exception](./spec/shared/client_initializer_behaviour.rb#L68) * client_id as only option * [requires a valid key](./spec/shared/client_initializer_behaviour.rb#L76) * with valid arguments * api_key only * [connects to the Ably service](./spec/shared/client_initializer_behaviour.rb#L87) * key_id and key_secret * [constructs an api_key](./spec/shared/client_initializer_behaviour.rb#L95) * with a string key instead of options hash * [sets the api_key](./spec/shared/client_initializer_behaviour.rb#L103) * [sets the key_id](./spec/shared/client_initializer_behaviour.rb#L107) * [sets the key_secret](./spec/shared/client_initializer_behaviour.rb#L111) * with token * [sets the token_id](./spec/shared/client_initializer_behaviour.rb#L119) * endpoint * [defaults to production](./spec/shared/client_initializer_behaviour.rb#L125) * with environment option * [uses an alternate endpoint](./spec/shared/client_initializer_behaviour.rb#L132) * tls * [defaults to TLS](./spec/shared/client_initializer_behaviour.rb#L151) * set to false * [uses plain text](./spec/shared/client_initializer_behaviour.rb#L142) * [uses HTTP](./spec/shared/client_initializer_behaviour.rb#L146) * logger * default * [uses Ruby Logger](./spec/shared/client_initializer_behaviour.rb#L158) * [specifies Logger::ERROR log level](./spec/shared/client_initializer_behaviour.rb#L162) * with log_level :none * [silences all logging with a NilLogger](./spec/shared/client_initializer_behaviour.rb#L170) * with custom logger and log_level * [uses the custom logger](./spec/shared/client_initializer_behaviour.rb#L188) * [sets the custom log level](./spec/shared/client_initializer_behaviour.rb#L192) * delegators * [delegates :client_id to .auth](./spec/shared/client_initializer_behaviour.rb#L202) * [delegates :auth_options to .auth](./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](./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](./spec/unit/rest/client_spec.rb#L28) * without an api_key * [fails as an api_key is required if not using token auth](./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](./spec/unit/rest/client_spec.rb#L46) ### Ably::Rest _(see [spec/unit/rest/rest_spec.rb](./spec/unit/rest/rest_spec.rb))_ * [constructor returns an Ably::Rest::Client](./spec/unit/rest/rest_spec.rb#L7) ### Ably::Util::Crypto _(see [spec/unit/util/crypto_spec.rb](./spec/unit/util/crypto_spec.rb))_ * defaults * [match other client libraries](./spec/unit/util/crypto_spec.rb#L18) * encrypts & decrypt * [#encrypt encrypts a string](./spec/unit/util/crypto_spec.rb#L28) * [#decrypt decrypts a string](./spec/unit/util/crypto_spec.rb#L33) * encrypting an empty string * [raises an ArgumentError](./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](./spec/unit/util/crypto_spec.rb#L65) * [decrypts exactly the same binary data as other client libraries](./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](./spec/unit/util/crypto_spec.rb#L65) * [decrypts exactly the same binary data as other client libraries](./spec/unit/util/crypto_spec.rb#L69) ### Ably::Util::PubSub _(see [spec/unit/util/pub_sub_spec.rb](./spec/unit/util/pub_sub_spec.rb))_ * event fan out * [#publish allows publishing to more than on subscriber](./spec/unit/util/pub_sub_spec.rb#L11) * [#publish sends only messages to #subscribe callbacks matching event names](./spec/unit/util/pub_sub_spec.rb#L19) * #unsubscribe * [deletes matching callbacks](./spec/unit/util/pub_sub_spec.rb#L71) * [deletes all callbacks if not block given](./spec/unit/util/pub_sub_spec.rb#L76) * [continues if the block does not exist](./spec/unit/util/pub_sub_spec.rb#L81) ------- ## Test summary * Passing tests: 811 * Pending tests: 11 * Failing tests: 0