client.rb in ably-rest-0.8.2

- old
+ new

@@ -42,11 +42,11 @@
       # @return [String,Nil]
       attr_reader :custom_realtime_host
 
       # When true, as soon as the client library is instantiated it will connect to Ably.  If this attribute is false, a connection must be opened explicitly
       # @return [Boolean]
-      attr_reader :connect_automatically
+      attr_reader :auto_connect
 
       # When a recover option is specified a connection inherits the state of a previous connection that may have existed under a different instance of the Realtime library, please refer to the API documentation for further information on connection state recovery
       # @return [String,Nil]
       attr_reader :recover
 
@@ -60,11 +60,11 @@
       # @param (see Ably::Rest::Client#initialize)
       # @option options (see Ably::Rest::Client#initialize)
       # @option options [Boolean] :queue_messages If false, this disables the default behaviour whereby the library queues messages on a connection in the disconnected or connecting states
       # @option options [Boolean] :echo_messages  If false, prevents messages originating from this connection being echoed back on the same connection
       # @option options [String]  :recover        When a recover option is specified a connection inherits the state of a previous connection that may have existed under a different instance of the Realtime library, please refer to the API documentation for further information on connection state recovery
-      # @option options [Boolean] :connect_automatically  By default as soon as the client library is instantiated it will connect to Ably. You can optionally set this to false and explicitly connect.
+      # @option options [Boolean] :auto_connect   By default as soon as the client library is instantiated it will connect to Ably. You can optionally set this to false and explicitly connect.
       #
       # @return [Ably::Realtime::Client]
       #
       # @example
       #    # create a new client authenticating with basic auth
@@ -77,11 +77,11 @@
         @rest_client           = Ably::Rest::Client.new(options)
         @auth                  = @rest_client.auth
         @channels              = Ably::Realtime::Channels.new(self)
         @echo_messages         = @rest_client.options.fetch(:echo_messages, true) == false ? false : true
         @custom_realtime_host  = @rest_client.options[:realtime_host] || @rest_client.options[:ws_host]
-        @connect_automatically = @rest_client.options.fetch(:connect_automatically, true) == false ? false : true
+        @auto_connect          = @rest_client.options.fetch(:auto_connect, true) == false ? false : true
         @recover               = @rest_client.options[:recover]
 
         raise ArgumentError, "Recovery key is invalid" if @recover && !@recover.match(Connection::RECOVER_REGEX)
       end
 
@@ -108,10 +108,10 @@
       # Retrieve the stats for the application
       #
       # @param (see Ably::Rest::Client#stats)
       # @option options (see Ably::Rest::Client#stats)
       #
-      # @yield [Ably::Models::PaginatedResource<Ably::Models::Stats>] An Array of Stats
+      # @yield [Ably::Models::PaginatedResult<Ably::Models::Stats>] An Array of Stats
       #
       # @return [Ably::Util::SafeDeferrable]
       #
       def stats(options = {}, &success_callback)
         async_wrap(success_callback) do