ably 0.1.1 → 0.1.2

data/spec/unit/realtime/error_info_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+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
+    let(:model_args) { [] }
+  end
+end

data/spec/unit/realtime/message_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'support/model_helper'
+
+describe Ably::Realtime::Models::Message do
+  subject { Ably::Realtime::Models::Message }
+  let(:protocol_message) { Ably::Realtime::Models::ProtocolMessage.new(action: 1) }
+
+  it_behaves_like 'a realtime model', with_simple_attributes: %w(name client_id data) do
+    let(:model_args) { [protocol_message] }
+  end
+
+  context '#sender_timestamp' do
+    let(:model) { subject.new({ timestamp: Time.now.to_i * 1000 }, protocol_message) }
+    it 'retrieves attribute :sender_timestamp' do
+      expect(model.sender_timestamp).to be_a(Time)
+      expect(model.sender_timestamp.to_i).to be_within(1).of(Time.now.to_i)
+    end
+  end
+
+  context 'Java naming' do
+    let(:model) { subject.new({ clientId: 'joe' }, protocol_message) }
+
+    it 'converts the attribute to ruby symbol naming convention' do
+      expect(model.client_id).to eql('joe')
+    end
+  end
+
+  context '#to_json' do
+    let(:json_object) { JSON.parse(model.to_json) }
+
+    context 'with valid data' do
+      let(:model) { subject.new({ name: 'test', clientId: 'joe' }, protocol_message) }
+
+      it 'converts the attribute back to Java mixedCase notation using string keys' do
+        expect(json_object["clientId"]).to eql('joe')
+      end
+
+      it 'autofills a missing timestamp for all messages' do
+        expect(json_object["timestamp"].to_i / 1000).to be_within(1).of(Time.now.to_i)
+      end
+    end
+
+    context 'with invalid data' do
+      let(:model) { subject.new({ clientId: 'joe' }, protocol_message) }
+
+      it 'raises an exception' do
+        expect { model.to_json }.to raise_error RuntimeError, /cannot generate valid JSON/
+      end
+    end
+  end
+
+  context 'part of ProtocolMessage' 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(:connection_id) { SecureRandom.hex }
+
+    let(:message_0_payload) do
+      {
+        'string_key' => 'string_value',
+        1 => 2,
+        true => false
+      }
+    end
+
+    let(:message_0_json) do
+      {
+        timestamp: sender_time_0,
+        name: 'zero',
+        data: message_0_payload
+      }
+    end
+
+    let(:message_1_json) do
+      {
+        timestamp: sender_time_1,
+        name: 'one',
+        data: 'simple string'
+      }
+    end
+
+    let(:protocol_message) do
+      Ably::Realtime::Models::ProtocolMessage.new({
+        timestamp: ably_time.to_i,
+        msg_serial: message_serial,
+        connection_id: connection_id,
+        messages: [
+          message_0_json, message_1_json
+        ]
+      })
+    end
+
+    let(:message_0) { protocol_message.messages.first }
+    let(:message_1) { protocol_message.messages.last }
+
+    it 'should generate a message ID from the index, serial and connection id' do
+      expect(message_0.message_id).to eql("#{connection_id}:#{message_serial}:0")
+      expect(message_1.message_id).to eql("#{connection_id}:#{message_serial}:1")
+    end
+
+    it 'should not modify the data payload' do
+      expect(message_0.data['string_key']).to eql('string_value')
+      expect(message_0.data[1]).to eql(2)
+      expect(message_0.data[true]).to eql(false)
+      expect(message_0.data).to eql(message_0_payload)
+
+      expect(message_1.data).to eql('simple string')
+    end
+
+    it 'should not allow changes to the payload' do
+      expect { message_0.data["test"] = true }.to raise_error RuntimeError, /can't modify frozen Hash/
+    end
+  end
+end

data/spec/unit/realtime/protocol_message_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'support/model_helper'
+
+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
+
+    let(:model_args) { [] }
+  end
+
+  context 'attributes' do
+    let(:unique_value) { SecureRandom.hex }
+
+    context 'Java naming' do
+      let(:protocol_message) { subject.new(channelSerial: unique_value) }
+
+      it 'converts the attribute to ruby symbol naming convention' do
+        expect(protocol_message.channel_serial).to eql(unique_value)
+      end
+    end
+
+    context '#action_sym' do
+      let(:protocol_message) { subject.new(action: 14) }
+
+      it 'returns the symbol equivalent' do
+        expect(protocol_message.action_sym).to eql(:presence)
+      end
+    end
+
+    context '#timestamp' do
+      let(:protocol_message) { subject.new(timestamp: Time.now.to_i * 1000) }
+      it 'retrieves attribute :timestamp' do
+        expect(protocol_message.timestamp).to be_a(Time)
+        expect(protocol_message.timestamp.to_i).to be_within(1).of(Time.now.to_i)
+      end
+    end
+
+    context '#error' do
+      context 'with no error attribute' do
+        let(:protocol_message) { subject.new(action: 1) }
+
+        it 'returns nil' do
+          expect(protocol_message.error).to be_nil
+        end
+      end
+
+      context 'with nil error' do
+        let(:protocol_message) { subject.new(error: nil) }
+
+        it 'returns nil' do
+          expect(protocol_message.error).to be_nil
+        end
+      end
+
+      context 'with error' do
+        let(:protocol_message) { subject.new(error: { message: 'test_error' }) }
+
+        it 'returns a valid ErrorInfo object' do
+          expect(protocol_message.error).to be_a(Ably::Realtime::Models::ErrorInfo)
+          expect(protocol_message.error.message).to eql('test_error')
+        end
+      end
+    end
+  end
+
+  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) }
+
+    context 'with valid data' do
+      let(:model) { subject.new({ :action => attached_action, :channelSerial => 'unique', messages: [message] }) }
+
+      it 'converts the attribute back to Java mixedCase notation using string keys' do
+        expect(json_object["channelSerial"]).to eql('unique')
+      end
+
+      it 'populates the messages' do
+        expect(json_object["messages"].first).to include(message)
+      end
+    end
+
+    context 'with invalid name data' 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/
+      end
+    end
+
+    context 'with missing msg_serial for ack message' 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/
+      end
+    end
+  end
+end

data/spec/unit/realtime/realtime_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Ably::Realtime do
+  let(:options) { { api_key: 'app.key:secret' } }
+
+  specify 'constructor returns an Ably::Realtime::Client' do
+    expect(Ably::Realtime.new(options)).to be_instance_of(Ably::Realtime::Client)
+  end
+
+  describe Ably::Realtime::Client do
+    describe "initializing the client" do
+      it "should disallow an invalid key" do
+        expect { Ably::Realtime::Client.new({}) }.to raise_error(ArgumentError, /api_key is missing/)
+        expect { Ably::Realtime::Client.new(api_key: 'invalid') }.to raise_error(ArgumentError, /api_key is invalid/)
+        expect { Ably::Realtime::Client.new(api_key: 'invalid:asdad') }.to raise_error(ArgumentError, /api_key is invalid/)
+        expect { Ably::Realtime::Client.new(api_key: 'appid.keyuid:keysecret') }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/unit/rest/message_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+describe Ably::Rest::Models::Message do
+  context 'attributes' do
+    let(:unique_value) { 'unique_value' }
+
+    %w(name data client_id message_id).each do |attribute|
+      context "##{attribute}" do
+        subject { Ably::Rest::Models::Message.new({ attribute.to_sym => unique_value }) }
+
+        it "retrieves attribute :#{attribute}" do
+          expect(subject.public_send(attribute)).to eql(unique_value)
+        end
+      end
+    end
+
+    context '#sender_timestamp' do
+      subject { Ably::Rest::Models::Message.new(timestamp: Time.now.to_i * 1000) }
+      it 'retrieves attribute :timestamp' do
+        expect(subject.sender_timestamp).to be_a(Time)
+        expect(subject.sender_timestamp.to_i).to be_within(1).of(Time.now.to_i)
+      end
+    end
+
+    context '#json' do
+      let(:attributes) { { timestamp: Time.now.to_i * 1000 } }
+      subject { Ably::Rest::Models::Message.new(attributes) }
+
+      it 'provides access to #json' do
+        expect(subject.json).to eql(attributes)
+      end
+    end
+
+    context '#[]' do
+      subject { Ably::Rest::Models::Message.new(unusual: 'attribute') }
+
+      it 'provides accessor method to #json' do
+        expect(subject[:unusual]).to eql('attribute')
+      end
+    end
+  end
+
+  context '==' do
+    let(:attributes) { { client_id: 'unique' } }
+
+    it 'is true when attributes are the same' do
+      new_message = -> { Ably::Rest::Models::Message.new(attributes) }
+      expect(new_message[]).to eq(new_message[])
+    end
+
+    it 'is false when attributes are not the same' do
+      expect(Ably::Rest::Models::Message.new(client_id: 1)).to_not eq(Ably::Rest::Models::Message.new(client_id: 2))
+    end
+
+    it 'is false when class type differs' do
+      expect(Ably::Rest::Models::Message.new(client_id: 1)).to_not eq(nil)
+    end
+  end
+
+  context 'is immutable' do
+    let(:options) { { client_id: 'John' } }
+    subject { Ably::Rest::Models::Message.new(options) }
+
+    it 'prevents changes' do
+      expect { subject.json[:client_id] = 'Joe' }.to raise_error RuntimeError, /can't modify frozen Hash/
+    end
+
+    it 'dups options' do
+      expect(subject.json[:client_id]).to eql('John')
+      options[:client_id] = 'Joe'
+      expect(subject.json[:client_id]).to eql('John')
+    end
+  end
+end

data/spec/unit/{rest_spec.rb → rest/rest_spec.rb}

@@ -94,6 +94,20 @@ describe Ably::Rest do
           expect(client.endpoint.to_s).to eql('https://sandbox-rest.ably.io')
         end
       end
+
+      context 'delegators' do
+        subject { Ably::Rest::Client.new(options) }
+
+        it 'should delegate :client_id to .auth' do
+          expect(subject.auth).to receive(:client_id).and_return('john')
+          expect(subject.client_id).to eql('john')
+        end
+
+        it 'should delegate :auth_options to .auth' do
+          expect(subject.auth).to receive(:auth_options).and_return({ option: 1 })
+          expect(subject.auth_options).to eql({ option: 1 })
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -168,12 +168,17 @@ files:
 - lib/ably.rb
 - lib/ably/auth.rb
 - lib/ably/exceptions.rb
-- lib/ably/message.rb
+- lib/ably/modules/conversions.rb
+- lib/ably/modules/http_helpers.rb
 - lib/ably/realtime.rb
 - lib/ably/realtime/callbacks.rb
 - lib/ably/realtime/channel.rb
 - lib/ably/realtime/client.rb
 - lib/ably/realtime/connection.rb
+- lib/ably/realtime/models/error_info.rb
+- lib/ably/realtime/models/message.rb
+- lib/ably/realtime/models/protocol_message.rb
+- lib/ably/realtime/models/shared.rb
 - lib/ably/rest.rb
 - lib/ably/rest/channel.rb
 - lib/ably/rest/channels.rb
@@ -181,12 +186,12 @@ files:
 - lib/ably/rest/middleware/exceptions.rb
 - lib/ably/rest/middleware/external_exceptions.rb
 - lib/ably/rest/middleware/parse_json.rb
-- lib/ably/rest/paged_resource.rb
+- lib/ably/rest/models/message.rb
+- lib/ably/rest/models/paged_resource.rb
 - lib/ably/rest/presence.rb
-- lib/ably/support.rb
 - lib/ably/token.rb
 - lib/ably/version.rb
-- spec/acceptance/realtime_client_spec.rb
+- spec/acceptance/realtime/channel_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
@@ -196,11 +201,16 @@ files:
 - spec/acceptance/rest/time_spec.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb
+- spec/support/event_machine_helper.rb
+- spec/support/model_helper.rb
 - spec/support/test_app.rb
 - spec/unit/auth.rb
-- spec/unit/message_spec.rb
-- spec/unit/realtime_spec.rb
-- spec/unit/rest_spec.rb
+- spec/unit/realtime/error_info_spec.rb
+- spec/unit/realtime/message_spec.rb
+- spec/unit/realtime/protocol_message_spec.rb
+- spec/unit/realtime/realtime_spec.rb
+- spec/unit/rest/message_spec.rb
+- spec/unit/rest/rest_spec.rb
 - spec/unit/token_spec.rb
 homepage: http://github.com/ably/ably-ruby
 licenses:
@@ -227,7 +237,7 @@ signing_key:
 specification_version: 4
 summary: A Ruby client library for ably.io, the real-time messaging service
 test_files:
-- spec/acceptance/realtime_client_spec.rb
+- spec/acceptance/realtime/channel_spec.rb
 - spec/acceptance/rest/auth_spec.rb
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
@@ -237,10 +247,15 @@ test_files:
 - spec/acceptance/rest/time_spec.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb
+- spec/support/event_machine_helper.rb
+- spec/support/model_helper.rb
 - spec/support/test_app.rb
 - spec/unit/auth.rb
-- spec/unit/message_spec.rb
-- spec/unit/realtime_spec.rb
-- spec/unit/rest_spec.rb
+- spec/unit/realtime/error_info_spec.rb
+- spec/unit/realtime/message_spec.rb
+- spec/unit/realtime/protocol_message_spec.rb
+- spec/unit/realtime/realtime_spec.rb
+- spec/unit/rest/message_spec.rb
+- spec/unit/rest/rest_spec.rb
 - spec/unit/token_spec.rb
 has_rdoc: 

data/lib/ably/message.rb

@@ -1,70 +0,0 @@
-module Ably
-  # A Message encapsulates an individual message sent or received in Ably
-  class Message
-    def initialize(message)
-      @message = message.dup.freeze
-    end
-
-    # Event name
-    #
-    # @return [String]
-    def name
-      @message[:name]
-    end
-
-    # Payload
-    #
-    # @return [Object]
-    def data
-      @message[:data]
-    end
-
-    # Client ID of the publisher of the message
-    #
-    # @return [String]
-    def client_id
-      @message[:client_id]
-    end
-
-    # Timestamp in milliseconds since epoch.  This property is populated by the Ably system.
-    #
-    # @return [Integer]
-    def timestamp
-      @message[:timestamp]
-    end
-
-    # Timestamp as {Time}.  This property is populated by the Ably system.
-    #
-    # @return [Time]
-    def timestamp_at
-      raise RuntimeError, "Timestamp is missing" unless timestamp
-      Time.at(timestamp / 1000.0)
-    end
-
-    # Unique serial number of this message within the channel
-    #
-    # @return [Integer]
-    def channel_serial
-      @message[:channel_serial]
-    end
-
-    # Provide a normal Hash accessor to the underlying raw message object
-    #
-    # @return [Object]
-    def [](key)
-      @message[key]
-    end
-
-    # Raw message object
-    #
-    # @return [Hash]
-    def raw_message
-      @message
-    end
-
-    def ==(other)
-      self.kind_of?(other.class) &&
-        raw_message == other.raw_message
-    end
-  end
-end