ably-rest 0.8.3 → 0.8.5

data/lib/submodules/ably-ruby/spec/acceptance/rest/channel_spec.rb

@@ -12,9 +12,10 @@ describe Ably::Rest::Channel do
     end
 
     describe '#publish' do
-      let(:channel) { client.channel(random_str) }
-      let(:name)   { 'foo' }
-      let(:data)    { 'woop!' }
+      let(:channel_name) { random_str }
+      let(:channel)      { client.channel(channel_name) }
+      let(:name)         { 'foo' }
+      let(:data)         { 'woop!' }
 
       context 'with name and data arguments' do
         it 'publishes the message and return true indicating success' do
@@ -22,6 +23,33 @@ describe Ably::Rest::Channel do
           expect(channel.history.items.first.name).to eql(name)
           expect(channel.history.items.first.data).to eql(data)
         end
+
+        context 'and additional attributes' do
+          let(:client_id) { random_str }
+
+          it 'publishes the message with the attributes and return true indicating success' do
+            expect(channel.publish(name, data, client_id: client_id)).to eql(true)
+            expect(channel.history.items.first.client_id).to eql(client_id)
+          end
+        end
+      end
+
+      context 'with a client_id configured in the ClientOptions' do
+        let(:client_id)      { random_str }
+        let(:client_options) { default_options.merge(client_id: client_id) }
+
+        it 'publishes the message without a client_id' do
+          expect(client).to receive(:post).
+            with("/channels/#{channel_name}/publish", hash_excluding(client_id: client_id)).
+            and_return(double('response', status: 201))
+
+          expect(channel.publish(name, data)).to eql(true)
+        end
+
+        it 'expects a client_id to be added by the realtime service' do
+          channel.publish name, data
+          expect(channel.history.items.first.client_id).to eql(client_id)
+        end
       end
 
       context 'with an array of Hash objects with :name and :data attributes' do

data/lib/submodules/ably-ruby/spec/acceptance/rest/client_spec.rb

@@ -16,7 +16,7 @@ describe Ably::Rest::Client do
 
     context '#initialize' do
       let(:client_id)     { random_str }
-      let(:token_request) { client.auth.create_token_request(key_name: key_name, key_secret: key_secret, client_id: client_id) }
+      let(:token_request) { client.auth.create_token_request({}, key_name: key_name, key_secret: key_secret, client_id: client_id) }
 
       context 'with only an API key' do
         let(:client) { Ably::Rest::Client.new(client_options.merge(key: api_key)) }
@@ -63,6 +63,16 @@ describe Ably::Rest::Client do
         end
       end
 
+      context 'with an :auth_callback Proc (clientId provided in library options instead of as a token_request param)' do
+        let(:client) { Ably::Rest::Client.new(client_options.merge(client_id: client_id, auth_callback: Proc.new { token_request })) }
+        let(:token_request) { client.auth.create_token_request({}, key_name: key_name, key_secret: key_secret) }
+
+        it 'correctly sets the clientId on the token' do
+          expect { client.channel('channel_name').publish('event', 'message') }.to change { client.auth.current_token_details }
+          expect(client.auth.current_token_details.client_id).to eql(client_id)
+        end
+      end
+
       context 'with an auth URL' do
         let(:client_options)    { default_options.merge(key: api_key, auth_url: token_request_url, auth_method: :get) }
         let(:token_request_url) { 'http://get.token.request.com/' }
@@ -74,7 +84,7 @@ describe Ably::Rest::Client do
         context 'before any REST request' do
           before do
             expect(client.auth).to receive(:token_request_from_auth_url).with(token_request_url, hash_including(:auth_method => :get)).once do
-              client.auth.create_token_request(token_params: { client_id: client_id })
+              client.auth.create_token_request(client_id: client_id)
             end
           end
 
@@ -144,11 +154,11 @@ describe Ably::Rest::Client do
           send("token_request_#{@request_index > 2 ? 'next' : @request_index}")
         end))
       end
-      let(:token_request_1) { client.auth.create_token_request(token_request_options.merge(client_id: random_str)) }
-      let(:token_request_2) { client.auth.create_token_request(token_request_options.merge(client_id: random_str)) }
+      let(:token_request_1) { client.auth.create_token_request({}, token_request_options.merge(client_id: random_str)) }
+      let(:token_request_2) { client.auth.create_token_request({}, token_request_options.merge(client_id: random_str)) }
 
       # If token expires against whilst runnig tests in a slower CI environment then use this token
-      let(:token_request_next) { client.auth.create_token_request(token_request_options.merge(client_id: random_str)) }
+      let(:token_request_next) { client.auth.create_token_request({}, token_request_options.merge(client_id: random_str)) }
 
       context 'when expired' do
         before do

data/lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb

@@ -93,23 +93,25 @@ describe Ably::Rest::Presence do
 
         context 'with :client_id option' do
           let(:client_id) { non_encoded_fixtures.first[:client_id] }
-          let(:presence_page)  { fixtures_channel.presence.get(client_id: client_id) }
+          let(:presence_page) { fixtures_channel.presence.get(client_id: client_id) }
 
           it 'returns a list members filtered by the provided client ID' do
-            pending 'not implemented in the REST API yet' # TODO realtime/issues/243
             expect(presence_page.items.count).to eql(1)
             expect(presence_page.items.first.client_id).to eql(client_id)
           end
         end
 
         context 'with :connection_id option' do
-          let(:connection_id) { fixtures_channel.presence.get.first.connection_id }
-          let(:presence_page)  { fixtures_channel.presence.get(connection_id: connection_id) }
+          let(:all_members)   { fixtures_channel.presence.get.items }
+          let(:connection_id) { all_members.first.connection_id }
+          let(:presence_page) { fixtures_channel.presence.get(connection_id: connection_id) }
 
           it 'returns a list members filtered by the provided connection ID' do
-            pending 'not implemented in the REST API yet' # TODO realtime/issues/243
-            expect(presence_page.items.count).to eql(1)
-            expect(presence_page.items.first.connetion_id).to eql(connetion_id)
+            expect(presence_page.items.all? { |member| member.connection_id == connection_id }).to eql(true)
+          end
+
+          it 'returns a list members filtered by the provided connection ID' do
+            expect(fixtures_channel.presence.get(connection_id: 'does.not.exist').items).to be_empty
           end
         end
       end

data/lib/submodules/ably-ruby/spec/support/event_machine_helper.rb

@@ -17,11 +17,34 @@ module RSpec
     end
 
     def stop_reactor
+      unless realtime_clients.empty?
+        realtime_clients.shift.tap do |client|
+          # Ensure close appens outside of the caller as this can cause errbacks on Deferrables
+          # e.g. connection.connect { connection.close } => # Error as calling close within the connected callback
+          ::EventMachine.add_timer(0.05) do
+            client.close if client.connection.can_transition_to?(:closing)
+            ::EventMachine.add_timer(0.1) { stop_reactor }
+          end
+        end
+        return
+      end
+
       ::EventMachine.next_tick do
         ::EventMachine.stop
       end
     end
 
+    # Ensures that any clients used in tests will have their connections
+    # explicitly closed when stop_reactor is called
+    def auto_close(realtime_client)
+      realtime_clients << realtime_client
+      realtime_client
+    end
+
+    def realtime_clients
+      @realtime_clients ||= []
+    end
+
     # Allows multiple Deferrables to be passed in and calls the provided block when
     # all success callbacks have completed
     def when_all(*deferrables)
@@ -48,7 +71,7 @@ module RSpec
         end
 
         deferrable.errback do |error|
-          raise RuntimeError, "Deferrable failed: #{error.message}"
+          raise RuntimeError, "Error: Deferrable failed: #{error}"
         end
       end
     end
@@ -56,9 +79,12 @@ module RSpec
     def wait_until(condition_block, &block)
       raise ArgumentError, 'Block required' unless block_given?
 
-      yield if condition_block.call
-      ::EventMachine.add_timer(0.1) do
-        wait_until condition_block, &block
+      if condition_block.call
+        yield
+      else
+        ::EventMachine.add_timer(0.1) do
+          wait_until condition_block, &block
+        end
       end
     end
   end

data/lib/submodules/ably-ruby/spec/support/protocol_helper.rb

@@ -1,12 +1,15 @@
 module RSpec
   module ProtocolHelper
-    PROTOCOLS = if ENV['TEST_LIMIT_PROTOCOLS']
-      JSON.parse(ENV['TEST_LIMIT_PROTOCOLS'])
+    SUPPORTED_PROTOCOLS = {
+      json:    'JSON',
+      msgpack: 'MsgPack'
+    }
+
+    PROTOCOLS = if ENV['PROTOCOL']
+      protocol = ENV['PROTOCOL'].downcase.to_sym
+      { protocol => SUPPORTED_PROTOCOLS[protocol] }
     else
-      {
-        json:    'JSON',
-        msgpack: 'MsgPack'
-      }
+      SUPPORTED_PROTOCOLS
     end
 
     def vary_by_protocol(&block)

data/lib/submodules/ably-ruby/spec/unit/auth_spec.rb

@@ -8,7 +8,7 @@ describe Ably::Auth do
   let(:token_params)  { { } }
 
   subject do
-    Ably::Auth.new(client, auth_options, token_params)
+    Ably::Auth.new(client, token_params, auth_options)
   end
 
   describe 'client_id option' do

data/lib/submodules/ably-ruby/spec/unit/models/channel_state_change_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::ChannelStateChange do
+  let(:unique) { random_str }
+
+  subject { Ably::Models::ChannelStateChange }
+
+  context '#current' do
+    it 'is required' do
+      expect { subject.new(previous: true) }.to raise_error ArgumentError
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(current: unique, previous: true).current).to eql(unique)
+    end
+  end
+
+  context '#previous' do
+    it 'is required' do
+      expect { subject.new(current: true) }.to raise_error ArgumentError
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(previous: unique, current: true).previous).to eql(unique)
+    end
+  end
+
+  context '#reason' do
+    it 'is not required' do
+      expect { subject.new(previous: true, current: true) }.to_not raise_error
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(reason: unique, previous: unique, current: true).reason).to eql(unique)
+    end
+  end
+
+  context 'invalid attributes' do
+    it 'raises an argument error' do
+      expect { subject.new(invalid: true, current: true, previous: true) }.to raise_error ArgumentError
+    end
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/models/connection_state_change_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::ConnectionStateChange do
+  let(:unique) { random_str }
+
+  subject { Ably::Models::ConnectionStateChange }
+
+  context '#current' do
+    it 'is required' do
+      expect { subject.new(previous: true) }.to raise_error ArgumentError
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(current: unique, previous: true).current).to eql(unique)
+    end
+  end
+
+  context '#previous' do
+    it 'is required' do
+      expect { subject.new(current: true) }.to raise_error ArgumentError
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(previous: unique, current: true).previous).to eql(unique)
+    end
+  end
+
+  context '#retry_in' do
+    it 'is not required' do
+      expect { subject.new(previous: true, current: true) }.to_not raise_error
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(retry_in: unique, previous: unique, current: true).retry_in).to eql(unique)
+    end
+  end
+
+  context '#reason' do
+    it 'is not required' do
+      expect { subject.new(previous: true, current: true) }.to_not raise_error
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(reason: unique, previous: unique, current: true).reason).to eql(unique)
+    end
+  end
+
+  context 'invalid attributes' do
+    it 'raises an argument error' do
+      expect { subject.new(invalid: true, current: true, previous: true) }.to raise_error ArgumentError
+    end
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/models/token_details_spec.rb

@@ -70,6 +70,14 @@ describe Ably::Models::TokenDetails do
           expect(subject.expired?).to eql(false)
         end
       end
+
+      context 'when expires is not available (i.e. string tokens)' do
+        subject { Ably::Models::TokenDetails.new() }
+
+        it 'is always false' do
+          expect(subject.expired?).to eql(false)
+        end
+      end
     end
   end
 

data/lib/submodules/ably-ruby/spec/unit/modules/async_wrapper_spec.rb

@@ -82,7 +82,7 @@ describe Ably::Modules::AsyncWrapper, :api_private do
             expect(result).to eql(result)
             EventMachine.add_timer(sleep_time * 2) { stop_reactor }
           end
-          deferrable.errback do |result|
+          deferrable.errback do |error|
             raise 'Errback should not have been called'
           end
         end

data/lib/submodules/ably-ruby/spec/unit/util/crypto_spec.rb

@@ -21,6 +21,24 @@ describe Ably::Util::Crypto do
     end
   end
 
+  context 'get_default_params' do
+    it 'uses the defaults and generates a key if not provided' do
+      expect(Ably::Util::Crypto.get_default_params[:algorithm]).to eql('AES')
+      expect(Ably::Util::Crypto.get_default_params[:mode]).to eql('CBC')
+      expect(Ably::Util::Crypto.get_default_params[:key_length]).to eql(128)
+      expect(Ably::Util::Crypto.get_default_params[:key].unpack('b*').first.length).to eql(128)
+    end
+
+    it 'uses the defaults and sets the key size when key is provided' do
+      key_192 = '123456781234567812345678'
+      params = Ably::Util::Crypto.get_default_params(key_192)
+      expect(params[:algorithm]).to eql('AES')
+      expect(params[:mode]).to eql('CBC')
+      expect(params[:key_length]).to eql(192)
+      expect(params[:key]).to eql(key_192)
+    end
+  end
+
   context 'encrypts & decrypt' do
     let(:string) { random_str }
     let(:byte_array) { random_str.to_msgpack.unpack('C*') }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ably-rest
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.5
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -187,6 +187,8 @@ files:
 - lib/submodules/ably-ruby/lib/ably/auth.rb
 - lib/submodules/ably-ruby/lib/ably/exceptions.rb
 - lib/submodules/ably-ruby/lib/ably/logger.rb
+- lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb
+- lib/submodules/ably-ruby/lib/ably/models/connection_state_change.rb
 - lib/submodules/ably-ruby/lib/ably/models/error_info.rb
 - lib/submodules/ably-ruby/lib/ably/models/idiomatic_ruby_wrapper.rb
 - lib/submodules/ably-ruby/lib/ably/models/message.rb
@@ -293,6 +295,8 @@ files:
 - lib/submodules/ably-ruby/spec/support/test_app.rb
 - lib/submodules/ably-ruby/spec/unit/auth_spec.rb
 - lib/submodules/ably-ruby/spec/unit/logger_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/channel_state_change_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/connection_state_change_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/error_info_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/idiomatic_ruby_wrapper_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/message_encoders/base64_spec.rb