ably 0.1.5 → 0.1.6

data/spec/unit/realtime/channel_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require "support/protocol_msgbus_helper"
 
 describe Ably::Realtime::Channel do
-  let(:client) { double(:client) }
+  let(:client) { double('client').as_null_object }
   let(:channel_name) { 'test' }
 
   subject do
@@ -23,5 +23,79 @@ describe Ably::Realtime::Channel do
     end
   end
 
-  it_behaves_like 'an incoming protocol message bus'
+  context 'msgbus' do
+    let(:message) do
+      Ably::Models::Message.new({
+        'name' => 'test',
+        'data' => 'payload'
+      }, instance_double('Ably::Models::ProtocolMessage'))
+    end
+    let(:msgbus) { subject.__incoming_msgbus__ }
+
+    specify 'supports messages' do
+      received = 0
+      msgbus.subscribe(:message) { received += 1 }
+      expect { msgbus.publish(:message, message) }.to change { received }.to(1)
+    end
+
+    specify 'fail with unacceptable STATE event names' do
+      expect { msgbus.subscribe(:invalid) }.to raise_error KeyError
+      expect { msgbus.publish(:invalid) }.to raise_error KeyError
+      expect { msgbus.unsubscribe(:invalid) }.to raise_error KeyError
+    end
+  end
+
+  context 'subscriptions' do
+    let(:message_history) { Hash.new { |hash, key| hash[key] = 0 } }
+    let(:event_name) { 'click' }
+    let(:message) { instance_double('Ably::Models::Message', name: event_name) }
+
+    context '#subscribe' do
+      specify 'to all events' do
+        subject.subscribe { |message| message_history[:received] += 1}
+        subject.__incoming_msgbus__.publish(:message, message)
+        expect(message_history[:received]).to eql(1)
+      end
+
+      specify 'to specific events' do
+        subject.subscribe(event_name) { |message| message_history[:received] += 1 }
+        subject.subscribe('move')  { |message| message_history[:received] += 1 }
+        subject.__incoming_msgbus__.publish(:message, message)
+        expect(message_history[:received]).to eql(1)
+      end
+    end
+
+    context '#unsubscribe' do
+      let(:callback) do
+        Proc.new { |message| message_history[:received] += 1 }
+      end
+      before do
+        subject.subscribe(event_name, &callback)
+      end
+
+      specify 'to all events' do
+        subject.unsubscribe &callback
+        subject.__incoming_msgbus__.publish(:message, message)
+        expect(message_history[:received]).to eql(0)
+      end
+
+      specify 'to specific events' do
+        subject.unsubscribe event_name, &callback
+        subject.__incoming_msgbus__.publish(:message, message)
+        expect(message_history[:received]).to eql(0)
+      end
+
+      specify 'to specific non-matching events' do
+        subject.unsubscribe 'move', &callback
+        subject.__incoming_msgbus__.publish(:message, message)
+        expect(message_history[:received]).to eql(1)
+      end
+
+      specify 'all callbacks by not providing a callback' do
+        subject.unsubscribe event_name
+        subject.__incoming_msgbus__.publish(:message, message)
+        expect(message_history[:received]).to eql(0)
+      end
+    end
+  end
 end

data/spec/unit/realtime/channels_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Ably::Realtime::Channels do
+  let(:connection) { instance_double('Ably::Realtime::Connection', on: true) }
+  let(:client) { instance_double('Ably::Realtime::Client', connection: connection) }
+  let(:channel_name) { 'unique' }
+  let(:options) { { 'bizarre' => 'value' } }
+
+  subject { Ably::Realtime::Channels.new(client) }
+
+  context 'creating channels' do
+    it '#get creates a channel' do
+      expect(Ably::Realtime::Channel).to receive(:new).with(client, channel_name, options)
+      subject.get(channel_name, options)
+    end
+
+    it '#get will reuse the channel object' do
+      channel = subject.get(channel_name, options)
+      expect(channel).to be_a(Ably::Realtime::Channel)
+      expect(subject.get(channel_name, options).object_id).to eql(channel.object_id)
+    end
+
+    it '[] creates a channel' do
+      expect(Ably::Realtime::Channel).to receive(:new).with(client, channel_name, options)
+      subject.get(channel_name, options)
+    end
+  end
+
+  context '#fetch' do
+    it 'retrieves a channel if it exists' do
+      channel = subject.get(channel_name, options)
+      expect(subject.fetch(channel_name)).to eql(channel)
+    end
+
+    it 'calls the block if channel is missing' do
+      block_called = false
+      subject.fetch(channel_name) { block_called = true }
+      expect(block_called).to eql(true)
+    end
+  end
+
+  context 'destroying channels' do
+    it '#release detatches and then releases the channel resoures' do
+      released_channel = subject.get(channel_name, options)
+      expect(released_channel).to receive(:detach).and_yield
+      subject.release(channel_name)
+      expect(subject.get(channel_name, options).object_id).to_not eql(released_channel.object_id)
+    end
+  end
+end

data/spec/unit/realtime/client_spec.rb

@@ -2,7 +2,37 @@ require 'spec_helper'
 require "support/protocol_msgbus_helper"
 
 describe Ably::Realtime::Client do
+  let(:client_options) { 'appid.keyuid:keysecret' }
   subject do
-    Ably::Realtime::Client.new('appid.keyuid:keysecret')
+    Ably::Realtime::Client.new(client_options)
+  end
+
+  context 'delegation to the Rest Client' do
+    let(:options) { { arbitrary: 'value' } }
+
+    it 'passes on the options to the initializer' do
+      rest_client = instance_double('Ably::Rest::Client', auth: instance_double('Ably::Auth'), options: {})
+      expect(Ably::Rest::Client).to receive(:new).with(client_options).and_return(rest_client)
+      subject
+    end
+
+    specify '#time' do
+      expect(subject.rest_client).to receive(:time)
+      subject.time
+    end
+
+    specify '#stats' do
+      expect(subject.rest_client).to receive(:stats).with(options)
+      subject.stats options
+    end
+
+    context 'for attribute' do
+      [:environment, :use_tls?, :logger, :log_level].each do |attribute|
+        specify "##{attribute}" do
+          expect(subject.rest_client).to receive(attribute)
+          subject.public_send attribute
+        end
+      end
+    end
   end
 end

data/spec/unit/realtime/connection_spec.rb

@@ -1,24 +1,17 @@
 require 'spec_helper'
-require "support/protocol_msgbus_helper"
+require 'support/protocol_msgbus_helper'
+require 'support/event_machine_helper'
 
 describe Ably::Realtime::Connection do
-  let(:client) { double(:client) }
-  let(:klass) { Class.new(Ably::Realtime::Connection) do; end }
+  let(:client) { instance_double('Ably::Realtime::Client', logger: double('logger').as_null_object) }
 
-  before do
-    # Override self.new with a generic implementation of new as EventMachine::Connection
-    # overrides self.new by default, and using EventMachine in unit tests is unnecessary
-    klass.instance_eval do
-      def self.new(*args)
-        obj = self.allocate
-        obj.orig_send :initialize, *args
-        obj
-      end
-    end
+  subject do
+    Ably::Realtime::Connection.new(client)
   end
 
-  subject do
-    klass.new(client)
+  before do
+    expect(EventMachine::Timer).to receive(:new)
+    expect(EventMachine).to receive(:next_tick)
   end
 
   describe 'callbacks' do

data/spec/unit/realtime/incoming_message_dispatcher_spec.rb

@@ -4,14 +4,14 @@ describe Ably::Realtime::Client::IncomingMessageDispatcher do
   let(:msgbus) do
     Ably::Util::PubSub.new
   end
+  let(:connection) do
+    instance_double('Ably::Realtime::Connection', __incoming_protocol_msgbus__: msgbus, update_connection_id: true)
+  end
   let(:client) do
-    double(:client,
-      connection: double('connection', __incoming_protocol_msgbus__: msgbus),
-      channels: {}
-    )
+    instance_double('Ably::Realtime::Client', channels: {})
   end
 
-  subject { Ably::Realtime::Client::IncomingMessageDispatcher.new(client) }
+  subject { Ably::Realtime::Client::IncomingMessageDispatcher.new(client, connection) }
 
   context '#initialize' do
     it 'should subscribe to protocol messages from the connection' do
@@ -30,7 +30,7 @@ describe Ably::Realtime::Client::IncomingMessageDispatcher do
     it 'should warn if a message is received for a non-existent channel' do
       allow(subject).to receive_message_chain(:logger, :debug)
       expect(subject).to receive_message_chain(:logger, :warn)
-      msgbus.publish :message, Ably::Realtime::Models::ProtocolMessage.new(:action => :attached, channel: 'unknown')
+      msgbus.publish :message, Ably::Models::ProtocolMessage.new(:action => :attached, channel: 'unknown')
     end
   end
 end

data/spec/unit/realtime/presence_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require "support/protocol_msgbus_helper"
+
+describe Ably::Realtime::Presence do
+  let(:channel) { double('Ably::Realtime::Channel').as_null_object }
+
+  subject do
+    Ably::Realtime::Presence.new(channel)
+  end
+
+  describe 'callbacks' do
+    specify 'are supported for valid STATE events' do
+      state = nil
+      subject.on(:initialized) { state = :entered }
+      expect { subject.trigger(:initialized) }.to change { state }.to(:entered)
+    end
+
+    specify 'fail with unacceptable STATE event names' do
+      expect { subject.on(:invalid) }.to raise_error KeyError
+      expect { subject.trigger(:invalid) }.to raise_error KeyError
+      expect { subject.off(:invalid) }.to raise_error KeyError
+    end
+  end
+
+  context 'msgbus' do
+    let(:message) do
+      Ably::Models::PresenceMessage.new({
+        'action' => 0,
+        'member_id' => SecureRandom.hex,
+      }, instance_double('Ably::Models::ProtocolMessage'))
+    end
+    let(:msgbus) { subject.__incoming_msgbus__ }
+
+    specify 'supports messages' do
+      received = 0
+      msgbus.subscribe(:presence) { received += 1 }
+      expect { msgbus.publish(:presence, message) }.to change { received }.to(1)
+    end
+
+    specify 'fail with unacceptable STATE event names' do
+      expect { msgbus.subscribe(:invalid) }.to raise_error KeyError
+      expect { msgbus.publish(:invalid) }.to raise_error KeyError
+      expect { msgbus.unsubscribe(:invalid) }.to raise_error KeyError
+    end
+  end
+
+  context 'subscriptions' do
+    let(:message_history) { Hash.new { |hash, key| hash[key] = 0 } }
+    let(:presence_action) { Ably::Models::PresenceMessage::ACTION.Enter }
+    let(:message) { instance_double('Ably::Models::PresenceMessage', action: presence_action, member_id: SecureRandom.hex) }
+
+    context '#subscribe' do
+      specify 'to all presence state actions' do
+        subject.subscribe { |message| message_history[:received] += 1}
+        subject.__incoming_msgbus__.publish(:presence, message)
+        expect(message_history[:received]).to eql(1)
+      end
+
+      specify 'to specific presence state actions' do
+        subject.subscribe(presence_action) { |message| message_history[:received] += 1 }
+        subject.subscribe(:leave)  { |message| message_history[:received] += 1 }
+        subject.__incoming_msgbus__.publish(:presence, message)
+        expect(message_history[:received]).to eql(1)
+      end
+    end
+
+    context '#unsubscribe' do
+      let(:callback) do
+        Proc.new { |message| message_history[:received] += 1 }
+      end
+      before do
+        subject.subscribe(presence_action, &callback)
+      end
+
+      specify 'to all presence state actions' do
+        subject.unsubscribe &callback
+        subject.__incoming_msgbus__.publish(:presence, message)
+        expect(message_history[:received]).to eql(0)
+      end
+
+      specify 'to specific presence state actions' do
+        subject.unsubscribe presence_action, &callback
+        subject.__incoming_msgbus__.publish(:presence, message)
+        expect(message_history[:received]).to eql(0)
+      end
+
+      specify 'to specific non-matching presence state actions' do
+        subject.unsubscribe :leave, &callback
+        subject.__incoming_msgbus__.publish(:presence, message)
+        expect(message_history[:received]).to eql(1)
+      end
+
+      specify 'all callbacks by not providing a callback' do
+        subject.unsubscribe presence_action
+        subject.__incoming_msgbus__.publish(:presence, message)
+        expect(message_history[:received]).to eql(0)
+      end
+    end
+  end
+end

data/spec/unit/rest/channels_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Ably::Rest::Channels do
+  let(:client) { instance_double('Ably::Rest::Client') }
+  let(:channel_name) { 'unique' }
+  let(:options) { { 'bizarre' => 'value' } }
+
+  subject { Ably::Rest::Channels.new(client) }
+
+  context 'creating channels' do
+    it '#get creates a channel' do
+      expect(Ably::Rest::Channel).to receive(:new).with(client, channel_name, options)
+      subject.get(channel_name, options)
+    end
+
+    it '#get will reuse the channel object' do
+      channel = subject.get(channel_name, options)
+      expect(channel).to be_a(Ably::Rest::Channel)
+      expect(subject.get(channel_name, options).object_id).to eql(channel.object_id)
+    end
+
+    it '[] creates a channel' do
+      expect(Ably::Rest::Channel).to receive(:new).with(client, channel_name, options)
+      subject.get(channel_name, options)
+    end
+  end
+
+  context '#fetch' do
+    it 'retrieves a channel if it exists' do
+      channel = subject.get(channel_name, options)
+      expect(subject.fetch(channel_name)).to eql(channel)
+    end
+
+    it 'calls the block if channel is missing' do
+      block_called = false
+      subject.fetch(channel_name) { block_called = true }
+      expect(block_called).to eql(true)
+    end
+  end
+
+  context 'destroying channels' do
+    it '#release releases the channel resoures' do
+      released_channel = subject.get(channel_name, options)
+      subject.release(channel_name)
+      expect(subject.get(channel_name, options).object_id).to_not eql(released_channel.object_id)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,22 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: statesman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -57,30 +71,30 @@ dependencies:
   name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -182,43 +196,53 @@ files:
 - lib/ably.rb
 - lib/ably/auth.rb
 - lib/ably/exceptions.rb
+- lib/ably/models/error_info.rb
 - lib/ably/models/idiomatic_ruby_wrapper.rb
+- lib/ably/models/message.rb
+- lib/ably/models/nil_channel.rb
+- lib/ably/models/paginated_resource.rb
+- lib/ably/models/presence_message.rb
+- lib/ably/models/protocol_message.rb
+- lib/ably/models/token.rb
+- lib/ably/modules/channels_collection.rb
 - lib/ably/modules/conversions.rb
 - lib/ably/modules/enum.rb
 - lib/ably/modules/event_emitter.rb
 - lib/ably/modules/event_machine_helpers.rb
 - lib/ably/modules/http_helpers.rb
-- lib/ably/modules/state.rb
+- lib/ably/modules/message_pack.rb
+- lib/ably/modules/model_common.rb
+- lib/ably/modules/state_emitter.rb
 - lib/ably/realtime.rb
 - lib/ably/realtime/channel.rb
+- lib/ably/realtime/channels.rb
 - lib/ably/realtime/client.rb
 - lib/ably/realtime/client/incoming_message_dispatcher.rb
 - lib/ably/realtime/client/outgoing_message_dispatcher.rb
 - lib/ably/realtime/connection.rb
-- lib/ably/realtime/models/error_info.rb
-- lib/ably/realtime/models/message.rb
-- lib/ably/realtime/models/nil_channel.rb
-- lib/ably/realtime/models/protocol_message.rb
-- lib/ably/realtime/models/shared.rb
+- lib/ably/realtime/connection/connection_state_machine.rb
+- lib/ably/realtime/connection/websocket_transport.rb
+- lib/ably/realtime/presence.rb
 - lib/ably/rest.rb
 - lib/ably/rest/channel.rb
 - lib/ably/rest/channels.rb
 - lib/ably/rest/client.rb
 - lib/ably/rest/middleware/exceptions.rb
 - lib/ably/rest/middleware/external_exceptions.rb
+- lib/ably/rest/middleware/fail_if_unsupported_mime_type.rb
 - lib/ably/rest/middleware/parse_json.rb
 - lib/ably/rest/middleware/parse_message_pack.rb
-- lib/ably/rest/models/message.rb
-- lib/ably/rest/models/paged_resource.rb
-- lib/ably/rest/models/presence_message.rb
 - lib/ably/rest/presence.rb
-- lib/ably/token.rb
 - lib/ably/util/crypto.rb
 - lib/ably/util/pub_sub.rb
 - lib/ably/version.rb
 - spec/acceptance/crypto.rb
+- spec/acceptance/realtime/channel_history_spec.rb
 - spec/acceptance/realtime/channel_spec.rb
+- spec/acceptance/realtime/connection_spec.rb
 - spec/acceptance/realtime/message_spec.rb
+- spec/acceptance/realtime/presence_history_spec.rb
+- spec/acceptance/realtime/presence_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
@@ -226,7 +250,7 @@ files:
 - spec/acceptance/rest/presence_spec.rb
 - spec/acceptance/rest/stats_spec.rb
 - spec/acceptance/rest/time_spec.rb
-- spec/integration/modules/state_spec.rb
+- spec/integration/modules/state_emitter_spec.rb
 - spec/integration/rest/auth.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb
@@ -234,23 +258,26 @@ files:
 - spec/support/model_helper.rb
 - spec/support/protocol_msgbus_helper.rb
 - spec/support/test_app.rb
+- spec/unit/models/error_info_spec.rb
 - spec/unit/models/idiomatic_ruby_wrapper_spec.rb
+- spec/unit/models/message_spec.rb
+- spec/unit/models/paginated_resource_spec.rb
+- spec/unit/models/presence_message_spec.rb
+- spec/unit/models/protocol_message_spec.rb
+- spec/unit/models/token_spec.rb
 - spec/unit/modules/conversions_spec.rb
 - spec/unit/modules/enum_spec.rb
 - spec/unit/modules/event_emitter_spec.rb
 - spec/unit/modules/pub_sub_spec.rb
 - spec/unit/realtime/channel_spec.rb
+- spec/unit/realtime/channels_spec.rb
 - spec/unit/realtime/client_spec.rb
 - spec/unit/realtime/connection_spec.rb
-- spec/unit/realtime/error_info_spec.rb
 - spec/unit/realtime/incoming_message_dispatcher_spec.rb
-- spec/unit/realtime/message_spec.rb
-- spec/unit/realtime/protocol_message_spec.rb
+- spec/unit/realtime/presence_spec.rb
 - spec/unit/realtime/realtime_spec.rb
+- spec/unit/rest/channels_spec.rb
 - spec/unit/rest/client_spec.rb
-- spec/unit/rest/message_spec.rb
-- spec/unit/rest/paged_resource_spec.rb
-- spec/unit/token_spec.rb
 homepage: http://github.com/ably/ably-ruby
 licenses:
 - MIT
@@ -277,8 +304,12 @@ specification_version: 4
 summary: A Ruby client library for ably.io, the real-time messaging service
 test_files:
 - spec/acceptance/crypto.rb
+- spec/acceptance/realtime/channel_history_spec.rb
 - spec/acceptance/realtime/channel_spec.rb
+- spec/acceptance/realtime/connection_spec.rb
 - spec/acceptance/realtime/message_spec.rb
+- spec/acceptance/realtime/presence_history_spec.rb
+- spec/acceptance/realtime/presence_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
@@ -286,7 +317,7 @@ test_files:
 - spec/acceptance/rest/presence_spec.rb
 - spec/acceptance/rest/stats_spec.rb
 - spec/acceptance/rest/time_spec.rb
-- spec/integration/modules/state_spec.rb
+- spec/integration/modules/state_emitter_spec.rb
 - spec/integration/rest/auth.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb
@@ -294,21 +325,24 @@ test_files:
 - spec/support/model_helper.rb
 - spec/support/protocol_msgbus_helper.rb
 - spec/support/test_app.rb
+- spec/unit/models/error_info_spec.rb
 - spec/unit/models/idiomatic_ruby_wrapper_spec.rb
+- spec/unit/models/message_spec.rb
+- spec/unit/models/paginated_resource_spec.rb
+- spec/unit/models/presence_message_spec.rb
+- spec/unit/models/protocol_message_spec.rb
+- spec/unit/models/token_spec.rb
 - spec/unit/modules/conversions_spec.rb
 - spec/unit/modules/enum_spec.rb
 - spec/unit/modules/event_emitter_spec.rb
 - spec/unit/modules/pub_sub_spec.rb
 - spec/unit/realtime/channel_spec.rb
+- spec/unit/realtime/channels_spec.rb
 - spec/unit/realtime/client_spec.rb
 - spec/unit/realtime/connection_spec.rb
-- spec/unit/realtime/error_info_spec.rb
 - spec/unit/realtime/incoming_message_dispatcher_spec.rb
-- spec/unit/realtime/message_spec.rb
-- spec/unit/realtime/protocol_message_spec.rb
+- spec/unit/realtime/presence_spec.rb
 - spec/unit/realtime/realtime_spec.rb
+- spec/unit/rest/channels_spec.rb
 - spec/unit/rest/client_spec.rb
-- spec/unit/rest/message_spec.rb
-- spec/unit/rest/paged_resource_spec.rb
-- spec/unit/token_spec.rb
 has_rdoc: