ably 0.1.4 → 0.1.5

data/spec/unit/modules/pub_sub_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Ably::Util::PubSub do
+  let(:options) { {} }
+  let(:obj) { double('example') }
+  let(:msg) { double('message') }
+
+  subject { Ably::Util::PubSub.new(options) }
+
+  context 'event fan out' do
+    specify do
+      expect(obj).to receive(:received_message).with(msg).twice
+      2.times do
+        subject.subscribe(:message) { |msg| obj.received_message msg }
+      end
+      subject.publish :message, msg
+    end
+
+    it 'sends only messages to matching event names' do
+      expect(obj).to receive(:received_message).with(msg).once
+      subject.subscribe(:valid) { |msg| obj.received_message msg }
+      subject.publish :valid, msg
+      subject.publish :ignored, msg
+      subject.publish 'valid', msg
+    end
+
+    context 'with coercion' do
+      let(:options) do
+        { coerce_into: Proc.new { |event| String(event) } }
+      end
+
+      it 'calls the provided proc to coerce the event name' do
+        expect(obj).to receive(:received_message).with(msg).once
+        subject.subscribe('valid') { |msg| obj.received_message msg }
+        subject.publish :valid, msg
+      end
+    end
+
+    context 'without coercion' do
+      it 'only matches event names on type matches' do
+        expect(obj).to_not receive(:received_message).with(msg)
+        subject.subscribe('valid') { |msg| obj.received_message msg }
+        subject.publish :valid, msg
+      end
+    end
+  end
+
+  context '#off' do
+    let(:callback) { Proc.new { |msg| obj.received_message msg } }
+
+    before do
+      subject.subscribe(:message, &callback)
+    end
+
+    after do
+      subject.publish :message, msg
+    end
+
+    it 'deletes matching callbacks' do
+      expect(obj).to_not receive(:received_message).with(msg)
+      subject.unsubscribe(:message, &callback)
+    end
+
+    it 'deletes all callbacks if not block given' do
+      expect(obj).to_not receive(:received_message).with(msg)
+      subject.unsubscribe(:message)
+    end
+
+    it 'continues if the block does not exist' do
+      expect(obj).to receive(:received_message).with(msg)
+      subject.unsubscribe(:message) { true }
+    end
+  end
+end

data/spec/unit/realtime/channel_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require "support/protocol_msgbus_helper"
+
+describe Ably::Realtime::Channel do
+  let(:client) { double(:client) }
+  let(:channel_name) { 'test' }
+
+  subject do
+    Ably::Realtime::Channel.new(client, channel_name)
+  end
+
+  describe 'callbacks' do
+    specify 'are supported for valid STATE events' do
+      state = nil
+      subject.on(:initialized) { state = :ready }
+      expect { subject.trigger(:initialized) }.to change { state }.to(:ready)
+    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
+
+  it_behaves_like 'an incoming protocol message bus'
+end

data/spec/unit/realtime/client_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require "support/protocol_msgbus_helper"
+
+describe Ably::Realtime::Client do
+  subject do
+    Ably::Realtime::Client.new('appid.keyuid:keysecret')
+  end
+end

data/spec/unit/realtime/connection_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require "support/protocol_msgbus_helper"
+
+describe Ably::Realtime::Connection do
+  let(:client) { double(:client) }
+  let(:klass) { Class.new(Ably::Realtime::Connection) do; end }
+
+  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
+  end
+
+  subject do
+    klass.new(client)
+  end
+
+  describe 'callbacks' do
+    specify 'are supported for valid STATE events' do
+      state = nil
+      subject.on(:initialized) { state = :ready }
+      expect { subject.trigger(:initialized) }.to change { state }.to(:ready)
+    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
+
+  it_behaves_like 'an incoming protocol message bus'
+  it_behaves_like 'an outgoing protocol message bus'
+end

data/spec/unit/realtime/error_info_spec.rb

@@ -4,7 +4,15 @@ require 'support/model_helper'
 describe Ably::Realtime::Models::ErrorInfo do
   subject { Ably::Realtime::Models::ErrorInfo }
 
-  it_behaves_like 'a realtime model', with_simple_attributes: %w(code status message) do
+  it_behaves_like 'a realtime model', with_simple_attributes: %w(code status_code message) do
     let(:model_args) { [] }
   end
+
+  context '#status' do
+    subject { Ably::Realtime::Models::ErrorInfo.new('statusCode' => 401) }
+    it 'is an alias for #status_code' do
+      expect(subject.status).to eql(subject.status_code)
+      expect(subject.status).to eql(401)
+    end
+  end
 end

data/spec/unit/realtime/incoming_message_dispatcher_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Ably::Realtime::Client::IncomingMessageDispatcher do
+  let(:msgbus) do
+    Ably::Util::PubSub.new
+  end
+  let(:client) do
+    double(:client,
+      connection: double('connection', __incoming_protocol_msgbus__: msgbus),
+      channels: {}
+    )
+  end
+
+  subject { Ably::Realtime::Client::IncomingMessageDispatcher.new(client) }
+
+  context '#initialize' do
+    it 'should subscribe to protocol messages from the connection' do
+      expect(msgbus).to receive(:subscribe).with(:message).and_call_original
+      subject
+    end
+  end
+
+  context '#dispatch_protocol_message' do
+    before { subject }
+
+    it 'should raise an exception if a message is sent that is not a ProtocolMessage' do
+      expect { msgbus.publish :message, nil }.to raise_error ArgumentError
+    end
+
+    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')
+    end
+  end
+end

data/spec/unit/realtime/message_spec.rb

@@ -38,7 +38,7 @@ describe Ably::Realtime::Models::Message do
       end
 
       it 'autofills a missing timestamp for all messages' do
-        expect(json_object["timestamp"].to_i).to be_within(1).of(as_since_epoch(Time.now))
+        expect(json_object["timestamp"].to_i).to be_within(50).of(as_since_epoch(Time.now))
       end
     end
 
@@ -55,7 +55,7 @@ describe Ably::Realtime::Models::Message do
     let(:ably_time) { Time.now + 5 }
     let(:sender_time_0) { Time.now - 5 }
     let(:sender_time_1) { Time.now - 3 }
-    let(:message_serial) { SecureRandom.hex }
+    let(:message_serial) { SecureRandom.random_number(1_000_000) }
     let(:connection_id) { SecureRandom.hex }
 
     let(:message_0_payload) do

data/spec/unit/realtime/protocol_message_spec.rb

@@ -6,7 +6,7 @@ describe Ably::Realtime::Models::ProtocolMessage do
   subject { Ably::Realtime::Models::ProtocolMessage }
 
   it_behaves_like 'a realtime model',
-    with_simple_attributes: %w(action count channel channel_serial connection_id connection_serial) do
+    with_simple_attributes: %w(channel channel_serial connection_id connection_serial) do
 
     let(:model_args) { [] }
   end
@@ -22,11 +22,23 @@ describe Ably::Realtime::Models::ProtocolMessage do
       end
     end
 
-    context '#action_sym' do
+    context '#action' do
       let(:protocol_message) { subject.new(action: 14) }
 
-      it 'returns the symbol equivalent' do
-        expect(protocol_message.action_sym).to eql(:presence)
+      it 'returns an Enum that behaves like a symbol' do
+        expect(protocol_message.action).to eq(:presence)
+      end
+
+      it 'returns an Enum that behaves like a Numeric' do
+        expect(protocol_message.action).to eq(14)
+      end
+
+      it 'returns an Enum that behaves like a String' do
+        expect(protocol_message.action).to eq('Presence')
+      end
+
+      it 'returns an Enum that matchdes the ACTION constant' do
+        expect(protocol_message.action).to eql(Ably::Realtime::Models::ProtocolMessage::ACTION.Presence)
       end
     end
 
@@ -38,6 +50,55 @@ describe Ably::Realtime::Models::ProtocolMessage do
       end
     end
 
+    context '#message_serial' do
+      let(:protocol_message) { subject.new(msg_serial: "55") }
+      it 'converts :msg_serial to an Integer' do
+        expect(protocol_message.message_serial).to be_a(Integer)
+        expect(protocol_message.message_serial).to eql(55)
+      end
+    end
+
+    context '#count' do
+      context 'when missing' do
+        let(:protocol_message) { subject.new({}) }
+        it 'is 1' do
+          expect(protocol_message.count).to eql(1)
+        end
+      end
+
+      context 'when non numeric' do
+        let(:protocol_message) { subject.new(count: 'A') }
+        it 'is 1' do
+          expect(protocol_message.count).to eql(1)
+        end
+      end
+
+      context 'when greater than 1' do
+        let(:protocol_message) { subject.new(count: '666') }
+        it 'is the value of count' do
+          expect(protocol_message.count).to eql(666)
+        end
+      end
+    end
+
+    context '#has_message_serial?' do
+      context 'without msg_serial' do
+        let(:protocol_message) { subject.new({}) }
+
+        it 'returns false' do
+          expect(protocol_message.has_message_serial?).to eql(false)
+        end
+      end
+
+      context 'with msg_serial' do
+        let(:protocol_message) { subject.new(msg_serial: "55") }
+
+        it 'returns true' do
+          expect(protocol_message.has_message_serial?).to eql(true)
+        end
+      end
+    end
+
     context '#error' do
       context 'with no error attribute' do
         let(:protocol_message) { subject.new(action: 1) }
@@ -68,9 +129,9 @@ describe Ably::Realtime::Models::ProtocolMessage do
 
   context '#to_json' do
     let(:json_object) { JSON.parse(model.to_json) }
-    let(:message) { { 'name' => 'event', 'clientId' => 'joe' } }
-    let(:attached_action) { Ably::Realtime::Models::ProtocolMessage.action!(:attached) }
-    let(:message_action) { Ably::Realtime::Models::ProtocolMessage.action!(:message) }
+    let(:message) { { 'name' => 'event', 'clientId' => 'joe', 'timestamp' => as_since_epoch(Time.now) } }
+    let(:attached_action) { Ably::Realtime::Models::ProtocolMessage::ACTION.Attached }
+    let(:message_action) { Ably::Realtime::Models::ProtocolMessage::ACTION.Message }
 
     context 'with valid data' do
       let(:model) { subject.new({ :action => attached_action, :channelSerial => 'unique', messages: [message] }) }
@@ -88,7 +149,7 @@ describe Ably::Realtime::Models::ProtocolMessage do
       let(:model) { subject.new({ clientId: 'joe' }) }
 
       it 'it raises an exception' do
-        expect { model.to_json }.to raise_error RuntimeError, /cannot generate valid JSON/
+        expect { model.to_json }.to raise_error KeyError, /Action '' is not supported by ProtocolMessage/
       end
     end
 
@@ -96,7 +157,15 @@ describe Ably::Realtime::Models::ProtocolMessage do
       let(:model) { subject.new({ :action => message_action }) }
 
       it 'it raises an exception' do
-        expect { model.to_json }.to raise_error RuntimeError, /cannot generate valid JSON/
+        expect { model.to_json }.to raise_error TypeError, /msg_serial is missing/
+      end
+    end
+
+    context 'is aliased by #to_s' do
+      let(:model) { subject.new({ :action => attached_action, :channelSerial => 'unique', messages: [message], :timestamp => as_since_epoch(Time.now) }) }
+
+      specify do
+        expect(json_object).to eql(JSON.parse("#{model}"))
       end
     end
   end

data/spec/unit/rest/message_spec.rb

@@ -28,7 +28,7 @@ describe Ably::Rest::Models::Message do
       subject { Ably::Rest::Models::Message.new(attributes) }
 
       it 'provides access to #json' do
-        expect(subject.json).to eql(attributes)
+        expect(subject.json).to eq(attributes)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +184,20 @@ files:
 - lib/ably/exceptions.rb
 - lib/ably/models/idiomatic_ruby_wrapper.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/realtime.rb
-- lib/ably/realtime/callbacks.rb
 - lib/ably/realtime/channel.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/rest.rb
@@ -187,15 +207,18 @@ files:
 - lib/ably/rest/middleware/exceptions.rb
 - lib/ably/rest/middleware/external_exceptions.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_spec.rb
+- spec/acceptance/realtime/message_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
@@ -203,21 +226,30 @@ 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/rest/auth.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb
 - spec/support/event_machine_helper.rb
 - spec/support/model_helper.rb
+- spec/support/protocol_msgbus_helper.rb
 - spec/support/test_app.rb
-- spec/unit/auth.rb
-- spec/unit/conversions.rb
 - spec/unit/models/idiomatic_ruby_wrapper_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/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/realtime_spec.rb
+- spec/unit/rest/client_spec.rb
 - spec/unit/rest/message_spec.rb
 - spec/unit/rest/paged_resource_spec.rb
-- spec/unit/rest/rest_spec.rb
 - spec/unit/token_spec.rb
 homepage: http://github.com/ably/ably-ruby
 licenses:
@@ -246,6 +278,7 @@ summary: A Ruby client library for ably.io, the real-time messaging service
 test_files:
 - spec/acceptance/crypto.rb
 - spec/acceptance/realtime/channel_spec.rb
+- spec/acceptance/realtime/message_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
@@ -253,20 +286,29 @@ 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/rest/auth.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb
 - spec/support/event_machine_helper.rb
 - spec/support/model_helper.rb
+- spec/support/protocol_msgbus_helper.rb
 - spec/support/test_app.rb
-- spec/unit/auth.rb
-- spec/unit/conversions.rb
 - spec/unit/models/idiomatic_ruby_wrapper_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/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/realtime_spec.rb
+- spec/unit/rest/client_spec.rb
 - spec/unit/rest/message_spec.rb
 - spec/unit/rest/paged_resource_spec.rb
-- spec/unit/rest/rest_spec.rb
 - spec/unit/token_spec.rb
 has_rdoc: