ably 0.7.1 → 0.7.2

data/lib/ably/modules/ably.rb

@@ -9,7 +9,7 @@ module Ably
   #
   FALLBACK_HOSTS = %w(A.ably-realtime.com B.ably-realtime.com C.ably-realtime.com D.ably-realtime.com E.ably-realtime.com)
   INTERNET_CHECK = {
-    url:     'http://internet-up.ably.io/is-the-internet-up.txt', #ably-realtime.com
+    url:     '//internet-up.ably-realtime.com/is-the-internet-up.txt',
     ok_text: 'yes'
   }
 end

data/lib/ably/realtime/client.rb

@@ -111,12 +111,16 @@ module Ably
 
       # Retrieve the stats for the application
       #
-      # @yield [Array] An Array of hashes representing the stats
+      # @param (see Ably::Rest::Client#stats)
+      # @option options (see Ably::Rest::Client#stats)
+      #
+      # @yield [Ably::Models::PaginatedResource<Ably::Models::Stat>] An Array of Stats
+      #
       # @return [EventMachine::Deferrable]
       #
-      def stats(params = {}, &success_callback)
+      def stats(options = {}, &success_callback)
         async_wrap(success_callback) do
-          rest_client.stats(params)
+          rest_client.stats(options)
         end
       end
 

data/lib/ably/realtime/client/incoming_message_dispatcher.rb

@@ -119,7 +119,7 @@ module Ably::Realtime
         if protocol_message.connection_key && (protocol_message.connection_key != connection.key)
           logger.debug "New connection ID set to #{protocol_message.connection_id} with connection key #{protocol_message.connection_key}"
           detach_attached_channels protocol_message.error if protocol_message.error
-          connection.update_connection_id_and_key protocol_message.connection_id, protocol_message.connection_key
+          connection.configure_new protocol_message.connection_id, protocol_message.connection_key, protocol_message.connection_serial
         end
 
         if protocol_message.has_connection_serial?

data/lib/ably/realtime/connection.rb

@@ -99,7 +99,7 @@ module Ably
       # @api public
       def initialize(client)
         @client                     = client
-        @serial                     = -1
+        @client_serial              = -1
         @__outgoing_message_queue__ = []
         @__pending_message_queue__  = []
 
@@ -182,7 +182,7 @@ module Ably
       # @api private
       def internet_up?
         EventMachine::DefaultDeferrable.new.tap do |deferrable|
-          EventMachine::HttpRequest.new(Ably::INTERNET_CHECK.fetch(:url)).get.tap do |http|
+          EventMachine::HttpRequest.new("http#{'s' if client.use_tls?}:#{Ably::INTERNET_CHECK.fetch(:url)}").get.tap do |http|
             http.errback do
               yield false if block_given?
               deferrable.fail
@@ -202,12 +202,17 @@ module Ably
         "#{key}:#{serial}" if connection_resumable?
       end
 
-      # Configure the current connection ID and connection key
+      # Following a new connection being made, resumed or recovered, the connection ID, connection key
+      # and message serial need to match the details provided by the server.
+      #
       # @return [void]
       # @api private
-      def update_connection_id_and_key(connection_id, connection_key)
-        @id  = connection_id
-        @key = connection_key
+      def configure_new(connection_id, connection_key, connection_serial)
+        @id            = connection_id
+        @key           = connection_key
+        @client_serial = connection_serial
+
+        update_connection_serial connection_serial
       end
 
       # Store last received connection serial so that the connection can be resumed from the last known point-in-time
@@ -362,6 +367,17 @@ module Ably
       private :change_state
 
       private
+
+      # The client serial is incremented for every message that is published that requires an ACK.
+      # Note that this is different to the connection serial that contains the last known serial number
+      # received from the server.
+      #
+      # A client serial number therefore does not guarantee a message has been received, only sent.
+      # A connection serial guarantees the server has received the message and is thus used for connection
+      # recovery and resumes.
+      # @return [Integer] starting at -1 indicating no messages sent, 0 when the first message is sent
+      attr_reader :client_serial
+
       def create_pub_sub_message_bus
         Ably::Util::PubSub.new(
           coerce_into: Proc.new do |event|
@@ -380,11 +396,11 @@ module Ably
       end
 
       def add_message_serial_to(protocol_message)
-        @serial += 1
-        protocol_message[:msgSerial] = serial
+        @client_serial += 1
+        protocol_message[:msgSerial] = client_serial
         yield
       rescue StandardError => e
-        @serial -= 1
+        @client_serial -= 1
         raise e
       end
 

data/lib/ably/realtime/connection/connection_manager.rb

@@ -10,8 +10,8 @@ module Ably::Realtime
     class ConnectionManager
       # Configuration for automatic recovery of failed connection attempts
       CONNECT_RETRY_CONFIG = {
-        disconnected: { retry_every: 0.5, max_time_in_state: 10 },
-        suspended:    { retry_every: 5,   max_time_in_state: 60 }
+        disconnected: { retry_every: 15,  max_time_in_state: 120 },
+        suspended:    { retry_every: 120, max_time_in_state: Float::INFINITY }
       }.freeze
 
       # Time to wait following a connection state request before it's considered a failure

data/lib/ably/rest/client.rb

@@ -139,20 +139,33 @@ module Ably
         channels.get(name, channel_options)
       end
 
-      # Retrieve the stats for the application
+      # Retrieve the Stats for the application
       #
-      # @return [Array] An Array of hashes representing the stats
-      def stats(params = {})
-        default_params = {
+      # @param [Hash] options the options for the stats request
+      # @option options [Integer,Time] :start      Time or millisecond since epoch
+      # @option options [Integer,Time] :end        Time or millisecond since epoch
+      # @option options [Symbol]       :direction  `:forwards` or `:backwards`
+      # @option options [Integer]      :limit      Maximum number of stats to retrieve up to 10,000
+      # @option options [Symbol]       :by         `:minute`, `:hour`, `:day` or `:month`. Defaults to `:minute`
+      #
+      # @return [Ably::Models::PaginatedResource<Ably::Models::Stat>] An Array of Stats
+      #
+      def stats(options = {})
+        options = {
           :direction => :forwards,
           :by        => :minute
+        }.merge(options)
+
+        [:start, :end].each { |option| options[option] = as_since_epoch(options[option]) if options.has_key?(option) }
+
+        paginated_options = {
+          coerce_into: 'Ably::Models::Stat'
         }
 
-        response = get("/stats", default_params.merge(params))
+        url = '/stats'
+        response = get(url, options)
 
-        response.body.map do |stat|
-          IdiomaticRubyWrapper(stat)
-        end
+        Ably::Models::PaginatedResource.new(response, url, self, paginated_options)
       end
 
       # Retrieve the Ably service time

data/lib/ably/rest/middleware/logger.rb

@@ -42,7 +42,7 @@ module Ably
           end
 
         rescue StandardError
-          "Error displaying body: (as hex) '#{readable_body(env.body)}'"
+          readable_body(env.body)
         end
 
         def readable_body(body)

data/lib/ably/version.rb

@@ -1,3 +1,3 @@
 module Ably
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/spec/acceptance/realtime/channel_history_spec.rb

@@ -61,7 +61,7 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
 
     context 'with lots of messages published with a single client and channel' do
       let(:messages_sent)   { 30 }
-      let(:rate_per_second) { 4 }
+      let(:rate_per_second) { 10 }
       let(:limit)           { 15 }
 
       def ensure_message_history_direction_and_paging_is_correct(direction)
@@ -103,7 +103,7 @@ describe Ably::Realtime::Channel, '#history', :event_machine do
         end
       end
 
-      context 'in multiple ProtocolMessages', em_timeout: (30 / 4) + 20 do
+      context 'in multiple ProtocolMessages', em_timeout: (30 / 10) + 5 do
         it 'retrieves limited history forwards with pagination' do
           messages_sent.times do |index|
             EventMachine.add_timer(index.to_f / rate_per_second) do

data/spec/acceptance/realtime/connection_failures_spec.rb

@@ -127,7 +127,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
         end
 
         context 'when connection state is :suspended' do
-          it 'enters the failed state after multiple attempts' do
+          it 'enters the failed state after multiple attempts if the max_time_in_state is set' do
             connection.on(:connected) { raise 'Connection should not have reached :connected state' }
 
             connection.once(:suspended) do
@@ -397,7 +397,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
       context 'when failing to resume because the connection_key is not or no longer valid' do
         def kill_connection_transport_and_prevent_valid_resume
           connection.transport.close_connection_after_writing
-          connection.update_connection_id_and_key '0123456789abcdef', '0123456789abcdef' # force the resume connection key to be invalid
+          connection.configure_new '0123456789abcdef', '0123456789abcdef', -1 # force the resume connection key to be invalid
         end
 
         it 'updates the connection_id and connection_key' do

data/spec/acceptance/realtime/connection_spec.rb

@@ -198,7 +198,6 @@ describe Ably::Realtime::Connection, :event_machine do
           end
         end
       end
-
     end
 
     context 'initialization state changes' do
@@ -330,6 +329,48 @@ describe Ably::Realtime::Connection, :event_machine do
       end
     end
 
+    describe '#serial connection serial' do
+      let(:channel) { client.channel(random_str) }
+
+      it 'is set to -1 when a new connection is opened' do
+        connection.connect do
+          expect(connection.serial).to eql(-1)
+          stop_reactor
+        end
+      end
+
+      context 'when a message is sent but the ACK has not yet been received' do
+
+        it 'the sent message msgSerial is 0 but the connection serial remains at -1' do
+          channel.attach do
+            connection.__outgoing_protocol_msgbus__.subscribe(:protocol_message) do |protocol_message|
+              connection.__outgoing_protocol_msgbus__.unsubscribe
+              expect(protocol_message['msgSerial']).to eql(0)
+              expect(connection.serial).to eql(-1)
+              stop_reactor
+            end
+            channel.publish('event', 'data')
+          end
+        end
+      end
+
+      it 'is set to 0 when a message sent ACK is received' do
+        channel.publish('event', 'data') do
+          expect(connection.serial).to eql(0)
+          stop_reactor
+        end
+      end
+
+      it 'is set to 1 when the second message sent ACK is received' do
+        channel.publish('event', 'data') do
+          channel.publish('event', 'data') do
+            expect(connection.serial).to eql(1)
+            stop_reactor
+          end
+        end
+      end
+    end
+
     context '#close' do
       it 'returns a Deferrable' do
         connection.connect do
@@ -491,7 +532,7 @@ describe Ably::Realtime::Connection, :event_machine do
         let(:states)           { Hash.new }
         let(:client_options)   { default_options.merge(log_level: :none) }
 
-        it 'is composed of connection id and serial that is kept up to date with each message sent' do
+        it 'is composed of connection id and serial that is kept up to date with each message ACK received' do
           connection.on(:connected) do
             expected_serial = -1
             expect(connection.id).to_not be_nil
@@ -681,6 +722,30 @@ describe Ably::Realtime::Connection, :event_machine do
           stop_reactor
         end
 
+        context 'internet up URL protocol' do
+          let(:http_request) { double('EventMachine::HttpRequest', get: EventMachine::DefaultDeferrable.new) }
+
+          context 'when using TLS for the connection' do
+            let(:client_options) { default_options.merge(tls: true) }
+
+            it 'uses TLS for the Internet check to https://internet-up.ably-realtime.com/is-the-internet-up.txt' do
+              expect(EventMachine::HttpRequest).to receive(:new).with('https://internet-up.ably-realtime.com/is-the-internet-up.txt').and_return(http_request)
+              connection.internet_up?
+              stop_reactor
+            end
+          end
+
+          context 'when using a non-secured connection' do
+            let(:client_options) { default_options.merge(tls: false, use_token_auth: true) }
+
+            it 'uses TLS for the Internet check to http://internet-up.ably-realtime.com/is-the-internet-up.txt' do
+              expect(EventMachine::HttpRequest).to receive(:new).with('http://internet-up.ably-realtime.com/is-the-internet-up.txt').and_return(http_request)
+              connection.internet_up?
+              stop_reactor
+            end
+          end
+        end
+
         context 'when the Internet is up' do
           it 'calls the block with true' do
             connection.internet_up? do |result|
@@ -698,7 +763,7 @@ describe Ably::Realtime::Connection, :event_machine do
 
         context 'when the Internet is down' do
           before do
-            stub_const 'Ably::INTERNET_CHECK', { url: 'http://does.not.exist.com', ok_text: 'no.way.this.will.match' }
+            stub_const 'Ably::INTERNET_CHECK', { url: '//does.not.exist.com', ok_text: 'no.way.this.will.match' }
           end
 
           it 'calls the block with false' do

data/spec/acceptance/realtime/stats_spec.rb

@@ -7,9 +7,9 @@ describe Ably::Realtime::Client, '#stats', :event_machine do
     end
 
     describe 'fetching stats' do
-      it 'should return a Hash' do
+      it 'should return a PaginatedResource' do
         client.stats do |stats|
-          expect(stats).to be_a(Array)
+          expect(stats).to be_a(Ably::Models::PaginatedResource)
           stop_reactor
         end
       end

data/spec/acceptance/rest/auth_spec.rb

@@ -59,16 +59,18 @@ describe Ably::Auth do
       let(:ttl)        { 30 * 60 }
       let(:capability) { { :foo => ['publish'] } }
 
-      it 'returns the requested token' do
-        actual_token = auth.request_token(
+      let(:token) do
+        auth.request_token(
           ttl:        ttl,
           capability: capability
         )
+      end
 
-        expect(actual_token.id).to match(/^#{app_id}\.[\w-]+$/)
-        expect(actual_token.key_id).to match(/^#{key_id}$/)
-        expect(actual_token.issued_at).to be_within(2).of(Time.now)
-        expect(actual_token.expires_at).to be_within(2).of(Time.now + ttl)
+      it 'returns a valid requested token in the expected format with valid issued_at and expires_at attributes' do
+        expect(token.id).to match(/^#{app_id}\.[\w-]+$/)
+        expect(token.key_id).to match(/^#{key_id}$/)
+        expect(token.issued_at).to be_within(2).of(Time.now)
+        expect(token.expires_at).to be_within(2).of(Time.now + ttl)
       end
 
       %w(client_id capability nonce timestamp ttl).each do |option|

data/spec/acceptance/rest/encoders_spec.rb

@@ -60,7 +60,7 @@ describe Ably::Models::MessageEncoders do
       context 'with JSON data' do
         let(:published_data) { json_data }
 
-        it 'stringifies the JSON and sets the json encoding type' do
+        it 'stringifies the JSON and sets the encoding attribute to "json"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('json')
             expect(encoded_data).to eql(JSON.dump(published_data))
@@ -75,7 +75,7 @@ describe Ably::Models::MessageEncoders do
       context 'with UTF-8 data' do
         let(:published_data) { utf_8_data }
 
-        it 'applies utf-8 and cipher encoding' do
+        it 'applies utf-8 and cipher encoding and sets the encoding attribute to "utf-8/cipher+aes-128-cbc"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('utf-8/cipher+aes-128-cbc')
             expect(decrypted(encoded_data)).to eql(published_data)
@@ -86,7 +86,7 @@ describe Ably::Models::MessageEncoders do
       context 'with binary data' do
         let(:published_data) { binary_data }
 
-        it 'applies cipher encoding' do
+        it 'applies cipher encoding and sets the encoding attribute to "cipher+aes-128-cbc"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('cipher+aes-128-cbc')
             expect(decrypted(encoded_data)).to eql(published_data)
@@ -97,7 +97,7 @@ describe Ably::Models::MessageEncoders do
       context 'with JSON data' do
         let(:published_data) { json_data }
 
-        it 'applies json, utf-8 and cipher encoding' do
+        it 'applies json, utf-8 and cipher encoding and sets the encoding attribute to "json/utf-8/cipher+aes-128-cbc"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('json/utf-8/cipher+aes-128-cbc')
             expect(decrypted(encoded_data)).to eql(JSON.dump(published_data))
@@ -125,7 +125,7 @@ describe Ably::Models::MessageEncoders do
       context 'with binary data' do
         let(:published_data) { binary_data }
 
-        it 'applies a base64 encoding' do
+        it 'applies a base64 encoding and sets the encoding attribute to "base64"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('base64')
             expect(Base64.decode64(encoded_data)).to eql(published_data)
@@ -136,7 +136,7 @@ describe Ably::Models::MessageEncoders do
       context 'with JSON data' do
         let(:published_data) { json_data }
 
-        it 'stringifies the JSON and sets the json encoding type' do
+        it 'stringifies the JSON and sets the encoding attribute to "json"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('json')
             expect(encoded_data).to eql(JSON.dump(published_data))
@@ -151,7 +151,7 @@ describe Ably::Models::MessageEncoders do
       context 'with UTF-8 data' do
         let(:published_data) { utf_8_data }
 
-        it 'applies utf-8, cipher and base64 encodings' do
+        it 'applies utf-8, cipher and base64 encodings and sets the encoding attribute to "utf-8/cipher+aes-128-cbc/base64"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('utf-8/cipher+aes-128-cbc/base64')
             expect(decrypted(encoded_data, base64: true)).to eql(published_data)
@@ -162,7 +162,7 @@ describe Ably::Models::MessageEncoders do
       context 'with binary data' do
         let(:published_data) { binary_data }
 
-        it 'applies cipher and base64 encoding' do
+        it 'applies cipher and base64 encoding and sets the encoding attribute to "utf-8/cipher+aes-128-cbc/base64"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('cipher+aes-128-cbc/base64')
             expect(decrypted(encoded_data, base64: true)).to eql(published_data)
@@ -173,7 +173,7 @@ describe Ably::Models::MessageEncoders do
       context 'with JSON data' do
         let(:published_data) { json_data }
 
-        it 'applies json, utf-8, cipher and base64 encoding' do
+        it 'applies json, utf-8, cipher and base64 encoding and sets the encoding attribute to "json/utf-8/cipher+aes-128-cbc/base64"' do
           on_publish do |encoding, encoded_data|
             expect(encoding).to eql('json/utf-8/cipher+aes-128-cbc/base64')
             expect(decrypted(encoded_data, base64: true)).to eql(JSON.dump(published_data))

data/spec/acceptance/rest/presence_spec.rb

@@ -21,8 +21,7 @@ describe Ably::Rest::Presence do
       describe '#get' do
         before(:context) do
           # When this test is run as a part of a test suite, the presence data injected in the test app may have expired
-          WebMock.disable!
-          TestApp.reload
+          reload_test_app
         end
 
         let(:channel) { client.channel('persisted:presence_fixtures') }
@@ -54,8 +53,7 @@ describe Ably::Rest::Presence do
       describe '#history' do
         before(:context) do
           # When this test is run as a part of a test suite, the presence data injected in the test app may have expired
-          WebMock.disable!
-          TestApp.reload
+          reload_test_app
         end
 
         let(:channel) { client.channel('persisted:presence_fixtures') }