ably 0.7.1 → 0.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b651a5ed9326c5950e3aec0232ef8b96b548021b
+  data.tar.gz: 1b6db9eb56d925b901e8e26e6e15863820562234
+SHA512:
+  metadata.gz: 80518f8fb55cef422fe8da8c96c314bc63e95ece705b9851dcf4613862d6b5b804285535bb0303750636b7db55529301c1c00a32bf50f9e13332c9c4c828c709
+  data.tar.gz: 19619184eb6ebe32608e5f642b158b5e9a1bae3e9d713422174ec5082aadcbcc15845e5351ee395bd3c5f978f8d8c6ea88461eb944b509fab914d97c06ff3b27

data/.travis.yml

@@ -1,7 +1,10 @@
 env: RSPEC_RETRY=true
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.2.0
-
+- 1.9.3
+- 2.0.0
+- 2.2.0
+script: bundle exec rspec
+notifications:
+  slack:
+    secure: Xe8MwDcV2C8XLGk6O6Co31LpQiRSxsmS7Toy5vM7rHds5fnVRBNn5iX6Q5mXMdLOlnsMhjKLt7zl4fsBOZv+siQ+Us0omZSIYpXCYSCIj8nofReF0Lj8M4oa6lFSL5OuygO7PH+wLKTRxQURGZ6Pi1nHU+RE5izRmsewQHkhtY0=

data/SPEC.md

@@ -209,84 +209,90 @@ _(see [spec/acceptance/realtime/connection_spec.rb](./spec/acceptance/realtime/c
                 * [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)*
+                * PENDING: *[retains connection state](./spec/acceptance/realtime/connection_spec.rb#L167)*
+                * PENDING: *[changes state to failed if a new token cannot be issued](./spec/acceptance/realtime/connection_spec.rb#L168)*
                 * the server
-                  * [disconnects the client, and the client automatically renews the token and then reconnects](./spec/acceptance/realtime/connection_spec.rb#L141)
+                  * [disconnects the client, and the client automatically renews the token and then reconnects](./spec/acceptance/realtime/connection_spec.rb#L144)
         * for non-renewable tokens
           * that are expired
             * opening a new connection
-              * [transitions state to failed](./spec/acceptance/realtime/connection_spec.rb#L180)
+              * [transitions state to failed](./spec/acceptance/realtime/connection_spec.rb#L183)
             * when connected
-              * PENDING: *[transitions state to failed](./spec/acceptance/realtime/connection_spec.rb#L193)*
+              * PENDING: *[transitions state to failed](./spec/acceptance/realtime/connection_spec.rb#L196)*
     * initialization state changes
       * with implicit #connect
-        * [are triggered in order](./spec/acceptance/realtime/connection_spec.rb#L221)
+        * [are triggered in order](./spec/acceptance/realtime/connection_spec.rb#L223)
       * with explicit #connect
-        * [are triggered in order](./spec/acceptance/realtime/connection_spec.rb#L227)
+        * [are triggered in order](./spec/acceptance/realtime/connection_spec.rb#L229)
     * #connect
-      * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L235)
-      * [calls the Deferrable callback on success](./spec/acceptance/realtime/connection_spec.rb#L240)
+      * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L237)
+      * [calls the Deferrable callback on success](./spec/acceptance/realtime/connection_spec.rb#L242)
       * when already connected
-        * [does nothing and no further state changes are emitted](./spec/acceptance/realtime/connection_spec.rb#L249)
+        * [does nothing and no further state changes are emitted](./spec/acceptance/realtime/connection_spec.rb#L251)
       * 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)
+          * [is a string](./spec/acceptance/realtime/connection_spec.rb#L268)
+          * [is unique from the connection#key](./spec/acceptance/realtime/connection_spec.rb#L275)
+          * [is unique for every connection](./spec/acceptance/realtime/connection_spec.rb#L282)
         * 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)
+          * [is a string](./spec/acceptance/realtime/connection_spec.rb#L291)
+          * [is unique from the connection#id](./spec/acceptance/realtime/connection_spec.rb#L298)
+          * [is unique for every connection](./spec/acceptance/realtime/connection_spec.rb#L305)
       * 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)
+        * [reconnects and is provided with a new connection ID and connection key from the server](./spec/acceptance/realtime/connection_spec.rb#L315)
+    * #serial connection serial
+      * [is set to -1 when a new connection is opened](./spec/acceptance/realtime/connection_spec.rb#L335)
+      * [is set to 0 when a message sent ACK is received](./spec/acceptance/realtime/connection_spec.rb#L357)
+      * [is set to 1 when the second message sent ACK is received](./spec/acceptance/realtime/connection_spec.rb#L364)
+      * when a message is sent but the ACK has not yet been received
+        * [the sent message msgSerial is 0 but the connection serial remains at -1](./spec/acceptance/realtime/connection_spec.rb#L344)
     * #close
-      * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L331)
-      * [calls the Deferrable callback on success](./spec/acceptance/realtime/connection_spec.rb#L338)
+      * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L375)
+      * [calls the Deferrable callback on success](./spec/acceptance/realtime/connection_spec.rb#L382)
       * when already closed
-        * [does nothing and no further state changes are emitted](./spec/acceptance/realtime/connection_spec.rb#L349)
+        * [does nothing and no further state changes are emitted](./spec/acceptance/realtime/connection_spec.rb#L393)
       * 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)
+          * [changes the connection state to :closing and then immediately :closed without sending a ProtocolMessage CLOSE](./spec/acceptance/realtime/connection_spec.rb#L421)
         * :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)
+          * [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#L439)
           * with an unresponsive connection
-            * [force closes the connection when a :closed ProtocolMessage response is not received](./spec/acceptance/realtime/connection_spec.rb#L425)
+            * [force closes the connection when a :closed ProtocolMessage response is not received](./spec/acceptance/realtime/connection_spec.rb#L469)
     * #ping
-      * [echoes a heart beat](./spec/acceptance/realtime/connection_spec.rb#L448)
+      * [echoes a heart beat](./spec/acceptance/realtime/connection_spec.rb#L492)
       * when not connected
-        * [raises an exception](./spec/acceptance/realtime/connection_spec.rb#L458)
+        * [raises an exception](./spec/acceptance/realtime/connection_spec.rb#L502)
     * 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)
+        * [is composed of connection id and serial that is kept up to date with each message ACK received](./spec/acceptance/realtime/connection_spec.rb#L535)
+        * [is available when connection is in one of the states: connecting, connected, disconnected, suspended, failed](./spec/acceptance/realtime/connection_spec.rb#L556)
+        * [is nil when connection is explicitly CLOSED](./spec/acceptance/realtime/connection_spec.rb#L580)
       * 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)
+          * [remain the same](./spec/acceptance/realtime/connection_spec.rb#L594)
         * 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)
+            * [recovers server-side queued messages](./spec/acceptance/realtime/connection_spec.rb#L619)
       * with :recover option
         * with invalid syntax
-          * [raises an exception](./spec/acceptance/realtime/connection_spec.rb#L600)
+          * [raises an exception](./spec/acceptance/realtime/connection_spec.rb#L644)
         * 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)
+          * [triggers a fatal error on the connection object, sets the #error_reason and disconnects](./spec/acceptance/realtime/connection_spec.rb#L653)
         * 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)
+          * [triggers an error on the connection object, sets the #error_reason, yet will connect anyway](./spec/acceptance/realtime/connection_spec.rb#L667)
     * with many connections simultaneously
-      * [opens each with a unique connection#id and connection#key](./spec/acceptance/realtime/connection_spec.rb#L641)
+      * [opens each with a unique connection#id and connection#key](./spec/acceptance/realtime/connection_spec.rb#L685)
     * when a state transition is unsupported
-      * [emits a StateChangeError](./spec/acceptance/realtime/connection_spec.rb#L661)
+      * [emits a StateChangeError](./spec/acceptance/realtime/connection_spec.rb#L705)
     * undocumented method
       * #internet_up?
-        * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L676)
+        * [returns a Deferrable](./spec/acceptance/realtime/connection_spec.rb#L720)
         * 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)
+          * [calls the block with true](./spec/acceptance/realtime/connection_spec.rb#L726)
+          * [calls the success callback of the Deferrable](./spec/acceptance/realtime/connection_spec.rb#L733)
         * 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)
+          * [calls the block with false](./spec/acceptance/realtime/connection_spec.rb#L745)
+          * [calls the failure callback of the Deferrable](./spec/acceptance/realtime/connection_spec.rb#L752)
 
 ### Ably::Realtime::Channel Message
 _(see [spec/acceptance/realtime/message_spec.rb](./spec/acceptance/realtime/message_spec.rb))_
@@ -506,7 +512,7 @@ _(see [spec/acceptance/realtime/presence_spec.rb](./spec/acceptance/realtime/pre
 _(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 PaginatedResource](./spec/acceptance/realtime/stats_spec.rb#L10)
       * [should return a Deferrable object](./spec/acceptance/realtime/stats_spec.rb#L17)
 
 ### Ably::Realtime::Client#time
@@ -738,29 +744,29 @@ _(see [spec/acceptance/rest/encoders_spec.rb](./spec/acceptance/rest/encoders_sp
       * 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)
+        * [stringifies the JSON and sets the encoding attribute to "json"](./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)
+        * [applies utf-8 and cipher encoding and sets the encoding attribute to "utf-8/cipher+aes-128-cbc"](./spec/acceptance/rest/encoders_spec.rb#L78)
       * with binary data
-        * [applies cipher encoding](./spec/acceptance/rest/encoders_spec.rb#L89)
+        * [applies cipher encoding and sets the encoding attribute to "cipher+aes-128-cbc"](./spec/acceptance/rest/encoders_spec.rb#L89)
       * with JSON data
-        * [applies json, utf-8 and cipher encoding](./spec/acceptance/rest/encoders_spec.rb#L100)
+        * [applies json, utf-8 and cipher encoding and sets the encoding attribute to "json/utf-8/cipher+aes-128-cbc"](./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)
+        * [applies a base64 encoding and sets the encoding attribute to "base64"](./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)
+        * [stringifies the JSON and sets the encoding attribute to "json"](./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)
+        * [applies utf-8, cipher and base64 encodings and sets the encoding attribute to "utf-8/cipher+aes-128-cbc/base64"](./spec/acceptance/rest/encoders_spec.rb#L154)
       * with binary data
-        * [applies cipher and base64 encoding](./spec/acceptance/rest/encoders_spec.rb#L165)
+        * [applies cipher and base64 encoding and sets the encoding attribute to "utf-8/cipher+aes-128-cbc/base64"](./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)
+        * [applies json, utf-8, cipher and base64 encoding and sets the encoding attribute to "json/utf-8/cipher+aes-128-cbc/base64"](./spec/acceptance/rest/encoders_spec.rb#L176)
 
 ### Ably::Rest::Channel messages
 _(see [spec/acceptance/rest/message_spec.rb](./spec/acceptance/rest/message_spec.rb))_
@@ -867,13 +873,32 @@ _(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)
+        * with :from set to last interval and :limit set to 1
+          * [retrieves only one stat](./spec/acceptance/rest/stats_spec.rb#L51)
+          * [returns accurate all aggregated message data](./spec/acceptance/rest/stats_spec.rb#L55)
+          * [returns accurate inbound realtime all data](./spec/acceptance/rest/stats_spec.rb#L60)
+          * [returns accurate inbound realtime message data](./spec/acceptance/rest/stats_spec.rb#L65)
+          * [returns accurate outbound realtime all data](./spec/acceptance/rest/stats_spec.rb#L70)
+          * [returns accurate persisted presence all data](./spec/acceptance/rest/stats_spec.rb#L75)
+          * [returns accurate connections all data](./spec/acceptance/rest/stats_spec.rb#L80)
+          * [returns accurate channels all data](./spec/acceptance/rest/stats_spec.rb#L85)
+          * [returns accurate api_requests data](./spec/acceptance/rest/stats_spec.rb#L90)
+          * [returns accurate token_requests data](./spec/acceptance/rest/stats_spec.rb#L95)
+          * [returns stat objects with #interval_granularity equal to :minute](./spec/acceptance/rest/stats_spec.rb#L100)
+          * [returns stat objects with #interval_id matching :start](./spec/acceptance/rest/stats_spec.rb#L104)
+          * [returns stat objects with #interval_time matching :start Time](./spec/acceptance/rest/stats_spec.rb#L108)
+        * with :start set to first interval, :limit set to 1 and direction :forwards
+          * [returns the first interval stats as stats are provided forwards from :start](./spec/acceptance/rest/stats_spec.rb#L118)
+          * [returns 3 pages of stats](./spec/acceptance/rest/stats_spec.rb#L122)
+        * with :end set to last interval, :limit set to 1 and direction :backwards
+          * [returns the 3rd interval stats first as stats are provided backwards from :end](./spec/acceptance/rest/stats_spec.rb#L135)
+          * [returns 3 pages of stats](./spec/acceptance/rest/stats_spec.rb#L139)
       * by hour
-        * [should return all the stats for the application](./spec/acceptance/rest/stats_spec.rb#L49)
+        * [should aggregate the stats for that period](./spec/acceptance/rest/stats_spec.rb#L163)
       * by day
-        * [should return all the stats for the application](./spec/acceptance/rest/stats_spec.rb#L49)
+        * [should aggregate the stats for that period](./spec/acceptance/rest/stats_spec.rb#L163)
       * by month
-        * [should return all the stats for the application](./spec/acceptance/rest/stats_spec.rb#L49)
+        * [should aggregate the stats for that period](./spec/acceptance/rest/stats_spec.rb#L163)
 
 ### Ably::Rest::Client#time
 _(see [spec/acceptance/rest/time_spec.rb](./spec/acceptance/rest/time_spec.rb))_
@@ -1337,6 +1362,63 @@ _(see [spec/unit/models/protocol_message_spec.rb](./spec/unit/models/protocol_me
       * with error
         * [returns a valid ErrorInfo object](./spec/unit/models/protocol_message_spec.rb#L261)
 
+### Ably::Models::Stat
+_(see [spec/unit/models/stat_spec.rb](./spec/unit/models/stat_spec.rb))_
+  * behaves like a model
+    * attributes
+      * #interval_id
+        * [retrieves attribute :interval_id](./spec/shared/model_behaviour.rb#L15)
+      * #all
+        * [retrieves attribute :all](./spec/shared/model_behaviour.rb#L15)
+      * #inbound
+        * [retrieves attribute :inbound](./spec/shared/model_behaviour.rb#L15)
+      * #outbound
+        * [retrieves attribute :outbound](./spec/shared/model_behaviour.rb#L15)
+      * #persisted
+        * [retrieves attribute :persisted](./spec/shared/model_behaviour.rb#L15)
+      * #connections
+        * [retrieves attribute :connections](./spec/shared/model_behaviour.rb#L15)
+      * #channels
+        * [retrieves attribute :channels](./spec/shared/model_behaviour.rb#L15)
+      * #api_requests
+        * [retrieves attribute :api_requests](./spec/shared/model_behaviour.rb#L15)
+      * #token_requests
+        * [retrieves attribute :token_requests](./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)
+  * #interval_granularity
+    * [returns the granularity of the interval_id](./spec/unit/models/stat_spec.rb#L17)
+  * #interval_time
+    * [returns a Time object representing the start of the interval](./spec/unit/models/stat_spec.rb#L25)
+  * class methods
+    * #to_interval_id
+      * when time zone of time argument is UTC
+        * [converts time 2014-02-03:05:06 with granularity :month into 2014-02](./spec/unit/models/stat_spec.rb#L33)
+        * [converts time 2014-02-03:05:06 with granularity :day into 2014-02-03](./spec/unit/models/stat_spec.rb#L37)
+        * [converts time 2014-02-03:05:06 with granularity :hour into 2014-02-03:05](./spec/unit/models/stat_spec.rb#L41)
+        * [converts time 2014-02-03:05:06 with granularity :minute into 2014-02-03:05:06](./spec/unit/models/stat_spec.rb#L45)
+        * [fails with invalid granularity](./spec/unit/models/stat_spec.rb#L49)
+        * [fails with invalid time](./spec/unit/models/stat_spec.rb#L53)
+      * when time zone of time argument is +02:00
+        * [converts time 2014-02-03:06 with granularity :hour into 2014-02-03:04 at UTC +00:00](./spec/unit/models/stat_spec.rb#L59)
+    * #from_interval_id
+      * [converts a month interval_id 2014-02 into a Time object in UTC 0](./spec/unit/models/stat_spec.rb#L66)
+      * [converts a day interval_id 2014-02-03 into a Time object in UTC 0](./spec/unit/models/stat_spec.rb#L71)
+      * [converts an hour interval_id 2014-02-03:05 into a Time object in UTC 0](./spec/unit/models/stat_spec.rb#L76)
+      * [converts a minute interval_id 2014-02-03:05:06 into a Time object in UTC 0](./spec/unit/models/stat_spec.rb#L81)
+      * [fails with an invalid interval_id 14-20](./spec/unit/models/stat_spec.rb#L86)
+    * #granularity_from_interval_id
+      * [returns a :month interval_id for 2014-02](./spec/unit/models/stat_spec.rb#L92)
+      * [returns a :day interval_id for 2014-02-03](./spec/unit/models/stat_spec.rb#L96)
+      * [returns a :hour interval_id for 2014-02-03:05](./spec/unit/models/stat_spec.rb#L100)
+      * [returns a :minute interval_id for 2014-02-03:05:06](./spec/unit/models/stat_spec.rb#L104)
+      * [fails with an invalid interval_id 14-20](./spec/unit/models/stat_spec.rb#L108)
+
 ### Ably::Models::Token
 _(see [spec/unit/models/token_spec.rb](./spec/unit/models/token_spec.rb))_
   * behaves like a model
@@ -1703,10 +1785,10 @@ _(see [spec/unit/util/pub_sub_spec.rb](./spec/unit/util/pub_sub_spec.rb))_
     * [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
+  ## Test summary
 
-* Passing tests: 811
-* Pending tests: 11
-* Failing tests: 0
+  * Passing tests: 864
+  * Pending tests: 11
+  * Failing tests: 0

data/ably.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'redcarpet'
-  spec.add_development_dependency 'rspec', '~> 3.1.0' # version lock, see event_machine_helper.rb#patch_example_block_with_surrounding_eventmachine_reactor
+  spec.add_development_dependency 'rspec', '~> 3.1.0' # version lock, see config.around(:example, :event_machine) in event_machine_helper.rb
   spec.add_development_dependency 'rspec-retry'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'webmock'

data/lib/ably/models/stat.rb

@@ -0,0 +1,161 @@
+module Ably::Models
+  # Convert stat argument to a {Stat} object
+  #
+  # @param stat [Stat,Hash] A Stat object or Hash of stat properties
+  #
+  # @return [Stat]
+  def self.Stat(stat)
+    case stat
+    when Stat
+      stat
+    else
+      Stat.new(stat)
+    end
+  end
+
+  # A class representing an individual statistic for a specified {#interval_id}
+  #
+  # @!attribute [r] all
+  #   @return [Hash] Breakdown of summary stats for all message types
+  # @!attribute [r] inbound
+  #   @return [Hash] Breakdown of summary stats for traffic over various transport types for all inbound messages
+  # @!attribute [r] outbound
+  #   @return [Hash] Breakdown of summary stats for traffic over various transport types for all outbound messages
+  # @!attribute [r] persisted
+  #   @return [Hash] Breakdown of summary stats for all persisted messages
+  # @!attribute [r] connections
+  #   @return [Hash] A breakdown of summary stats data for different (TLS vs non-TLS) connection types.
+  # @!attribute [r] channels
+  #   @return [Hash] Aggregate data for usage of Channels
+  # @!attribute [r] api_requests
+  #   @return [Hash] Aggregate data for numbers of API requests
+  # @!attribute [r] token_requests
+  #   @return [Hash] Aggregate data for numbers of Token requests
+  #
+  class Stat
+    include Ably::Modules::ModelCommon
+    extend Ably::Modules::Enum
+
+    GRANULARITY = ruby_enum('GRANULARITY',
+      :minute,
+      :hour,
+      :day,
+      :month
+    )
+
+    INTERVAL_FORMAT_STRING = [
+      '%Y-%m-%d:%H:%M',
+      '%Y-%m-%d:%H',
+      '%Y-%m-%d',
+      '%Y-%m'
+    ]
+
+    class << self
+      # Convert a Time with the specified Granularity into an interval ID based on UTC 0 time
+      # @example
+      #   Stat.to_interval_id(Time.now, :hour) # => '2015-01-01:10'
+      #
+      # @param time [Time] Time used to determine the interval
+      # @param granularity [GRANULARITY] Granularity of the metrics such as :hour, :day
+      #
+      # @return [String] interval ID used for stats
+      #
+      def to_interval_id(time, granularity)
+        raise ArgumentError, 'Time object required as first argument' unless time.kind_of?(Time)
+
+        granularity = GRANULARITY(granularity)
+        format = INTERVAL_FORMAT_STRING[granularity.to_i]
+
+        time.utc.strftime(format)
+      end
+
+      # Returns the UTC 0 start Time of an interval_id
+      # @example
+      #   Stat.from_interval_id('2015-01-01:10') # => 2015-01-01 10:00:00 +0000
+      #
+      # @param interval_id [String]
+      #
+      # @return [Time] start time of the provided interval_id
+      #
+      def from_interval_id(interval_id)
+        raise ArgumentError, 'Interval ID must be a string' unless interval_id.kind_of?(String)
+
+        format = INTERVAL_FORMAT_STRING.find { |format| expected_length(format) == interval_id.length }
+        raise ArgumentError, 'Interval ID is an invalid length' unless format
+
+        Time.strptime("#{interval_id} +0000", "#{format} %z").utc
+      end
+
+      # Returns the {GRANULARITY} determined from the interval_id
+      # @example
+      #   Stat.granularity_from_interval_id('2015-01-01:10') # => :hour
+      #
+      # @param interval_id [String]
+      #
+      # @return [GRANULARITY] Granularity Enum for the interval_id
+      #
+      def granularity_from_interval_id(interval_id)
+        raise ArgumentError, 'Interval ID must be a string' unless interval_id.kind_of?(String)
+
+        format = INTERVAL_FORMAT_STRING.find { |format| expected_length(format) == interval_id.length }
+        raise ArgumentError, 'Interval ID is an invalid length' unless format
+
+        GRANULARITY[INTERVAL_FORMAT_STRING.index(format)]
+      end
+
+      private
+      def expected_length(format)
+        format.gsub('%Y', 'YYYY').length
+      end
+    end
+
+    # {Stat} initializer
+    #
+    # @param hash_object  [Hash]  object with the underlying stat details
+    #
+    def initialize(hash_object)
+      @raw_hash_object  = hash_object
+
+      set_hash_object hash_object
+    end
+
+    %w( all inbound outbound persisted connections channels api_requests token_requests ).each do |attribute|
+      define_method attribute do
+        hash[attribute.to_sym]
+      end
+    end
+
+    # @!attribute [r] interval_id
+    # @return [String] The interval that this statistic applies to, see {GRANULARITY} and {INTERVAL_FORMAT_STRING}
+    def interval_id
+      hash.fetch(:interval_id)
+    end
+
+    # @!attribute [r] interval_time
+    # @return [Time] A Time object representing the start of the interval
+    def interval_time
+      self.class.from_interval_id(interval_id)
+    end
+
+    # @!attribute [r] interval_granularity
+    # @return [GRANULARITY] The granularity of the interval for the stat such as :day, :hour, :minute, see {GRANULARITY}
+    def interval_granularity
+      self.class.granularity_from_interval_id(interval_id)
+    end
+
+    def hash
+      @hash_object
+    end
+
+    def as_json(*args)
+      hash.as_json(*args)
+    end
+
+    private
+    attr_reader :raw_hash_object
+
+    def set_hash_object(hash)
+      @hash_object = IdiomaticRubyWrapper(hash.clone.freeze)
+    end
+  end
+end