ably 0.1.6 → 0.2.0

data/spec/unit/realtime/websocket_transport_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'support/protocol_msgbus_helper'
+
+describe Ably::Realtime::Connection::WebsocketTransport do
+  let(:client_ignored) { double('Ably::Realtime::Client').as_null_object }
+  let(:connection) { instance_double('Ably::Realtime::Connection', client: client_ignored, id: nil) }
+
+  let(:websocket_transport_without_eventmachine) do
+    Ably::Realtime::Connection::WebsocketTransport.send(:allocate).tap do |websocket_transport|
+      websocket_transport.send(:initialize, connection)
+    end
+  end
+
+  before do
+    allow(Ably::Realtime::Connection::WebsocketTransport).to receive(:new).with(connection).and_return(websocket_transport_without_eventmachine)
+  end
+
+  subject do
+    Ably::Realtime::Connection::WebsocketTransport.new(connection)
+  end
+
+  it_behaves_like 'an incoming protocol message bus'
+  it_behaves_like 'an outgoing protocol message bus'
+end

data/spec/unit/rest/channels_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Ably::Rest::Channels do
   let(:client) { instance_double('Ably::Rest::Client') }

data/spec/unit/rest/client_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Ably::Rest do
   let(:options) { { api_key: 'app.key:secret' } }
@@ -8,31 +8,31 @@ describe Ably::Rest do
   end
 
   describe Ably::Rest::Client do
-    describe "initializing the client" do
-      it "should disallow an invalid key" do
+    describe 'initializing the client' do
+      it 'should disallow an invalid key' do
         expect { Ably::Rest::Client.new({}) }.to raise_error(ArgumentError, /api_key is missing/)
         expect { Ably::Rest::Client.new(api_key: 'invalid') }.to raise_error(ArgumentError, /api_key is invalid/)
         expect { Ably::Rest::Client.new(api_key: 'invalid:asdad') }.to raise_error(ArgumentError, /api_key is invalid/)
         expect { Ably::Rest::Client.new(api_key: 'appid.keyuid:keysecret') }.to_not raise_error
       end
 
-      it "should disallow api_key and key_id" do
+      it 'should disallow api_key and key_id' do
         expect { Ably::Rest::Client.new(api_key: 'valid', key_id: 'invalid') }.to raise_error(ArgumentError, /api_key and key_id or key_secret are mutually exclusive/)
       end
 
-      it "should disallow api_key and key_secret" do
+      it 'should disallow api_key and key_secret' do
         expect { Ably::Rest::Client.new(api_key: 'valid', key_secret: 'invalid') }.to raise_error(ArgumentError, /api_key and key_id or key_secret are mutually exclusive/)
       end
 
       context 'using key_id and key_secret' do
         let(:client) { Ably::Rest::Client.new(key_id: 'id', key_secret: 'secret') }
 
-        it "should allow key_id and key_secret in place of api_key" do
+        it 'should allow key_id and key_secret in place of api_key' do
           expect(client.auth.api_key).to eql('id:secret')
         end
       end
 
-      context "with a string key instead of options" do
+      context 'with a string key instead of options' do
         let(:options) { 'app.key:secret' }
         subject { Ably::Rest::Client.new(options) }
 
@@ -49,17 +49,17 @@ describe Ably::Rest do
         end
       end
 
-      context "with a client_id" do
+      context 'with a client_id' do
         it "should require a valid key" do
           expect { Ably::Rest::Client.new(client_id: 'valid') }.to raise_error(ArgumentError, /client_id cannot be provided without a complete API key/)
         end
       end
 
-      it "should default to the production REST end point" do
+      it 'should default to the production REST end point' do
         expect(Ably::Rest::Client.new(api_key: 'appid.keyuid:keysecret').endpoint.to_s).to eql('https://rest.ably.io')
       end
 
-      it "should allow an environment to be set" do
+      it 'should allow an environment to be set' do
         expect(Ably::Rest::Client.new(api_key: 'appid.keyuid:keysecret', environment: 'sandbox').endpoint.to_s).to eql('https://sandbox-rest.ably.io')
       end
 
@@ -108,6 +108,41 @@ describe Ably::Rest do
           expect(subject.auth_options).to eql({ option: 1 })
         end
       end
+
+      context 'logger' do
+        context 'defaults' do
+          subject { Ably::Rest::Client.new(options) }
+
+          it 'uses default Ruby Logger by default' do
+            expect(subject.logger.logger).to be_a(::Logger)
+          end
+
+          it 'defaults to Logger::ERROR log level' do
+            expect(subject.logger.log_level).to eql(::Logger::ERROR)
+          end
+        end
+
+        context 'with custom logger and log_level' do
+          let(:custom_logger) do
+            Class.new do
+              extend Forwardable
+              def initialize
+                @logger = Logger.new(STDOUT)
+              end
+              def_delegators :@logger, :fatal, :error, :warn, :info, :debug, :level, :level=
+            end
+          end
+          subject { Ably::Rest::Client.new(options.merge(logger: custom_logger.new, log_level: :debug)) }
+
+          it 'uses the custom logger' do
+            expect(subject.logger.logger.class).to eql(custom_logger)
+          end
+
+          it 'sets the custom log level' do
+            expect(subject.logger.log_level).to eql(Logger::DEBUG)
+          end
+        end
+      end
     end
   end
 end

data/spec/unit/util/crypto_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'msgpack'
+
+describe Ably::Util::Crypto do
+  let(:seret_key)  { SecureRandom.hex }
+  let(:cipher_options) { { key: seret_key } }
+  subject { Ably::Util::Crypto.new(cipher_options) }
+
+  context 'defaults' do
+    let(:expected_defaults) do
+      {
+        algorithm: 'AES',
+        mode: 'CBC',
+        key_length: 128
+      }
+    end
+
+    specify 'match other client libraries' do
+      expect(Ably::Util::Crypto::DEFAULTS).to eql(expected_defaults)
+      expect(Ably::Util::Crypto::BLOCK_LENGTH).to eql(16)
+    end
+  end
+
+  context 'encrypts & decrypt' do
+    let(:string) { SecureRandom.hex }
+    let(:byte_array) { SecureRandom.hex.to_msgpack.unpack('C*') }
+
+    specify 'a string' do
+      encrypted = subject.encrypt(string)
+      expect(subject.decrypt(encrypted)).to eql(string)
+    end
+  end
+
+  context 'encrypting an empty string' do
+    let(:empty_string) { '' }
+
+    it 'raises an ErgumentError' do
+      expect { subject.encrypt(empty_string) }.to raise_error ArgumentError, /data must not be empty/
+    end
+  end
+
+  context 'using shared client lib fixture data' do
+    let(:resources_root)      { File.expand_path('../../../resources', __FILE__) }
+    let(:encryption_data_128) { JSON.parse(File.read(File.join(resources_root, 'crypto-data-128.json'))) }
+    let(:encryption_data_256) { JSON.parse(File.read(File.join(resources_root, 'crypto-data-256.json'))) }
+
+    shared_examples 'an Ably encrypter and decrypter' do
+      let(:algorithm)      { data['algorithm'].upcase }
+      let(:mode)           { data['mode'].upcase }
+      let(:key_length)     { data['keylength'] }
+      let(:secret_key)     { Base64.decode64(data['key']) }
+      let(:iv)             { Base64.decode64(data['iv']) }
+
+      let(:cipher_options) { { key: secret_key, algorithm: algorithm, mode: mode, key_length: key_length } }
+
+      context 'text payload' do
+        let(:payload)        { data['items'].first['encoded']['data'] }
+        let(:encrypted)      { data['items'].first['encrypted']['data'] }
+
+        it 'encrypts exactly the same binary data as other client libraries' do
+          expect(subject.encrypt(payload, iv: iv)).to eql(Base64.decode64(encrypted))
+        end
+
+        it 'decrypts exactly the same binary data as other client libraries' do
+          expect(subject.decrypt(Base64.decode64(encrypted))).to eql(payload)
+        end
+      end
+    end
+
+    context 'with AES-128-CBC' do
+      let(:data) { encryption_data_128 }
+
+      it_behaves_like 'an Ably encrypter and decrypter'
+    end
+
+    context 'with AES-256-CBC' do
+      let(:data) { encryption_data_256 }
+
+      it_behaves_like 'an Ably encrypter and decrypter'
+    end
+  end
+end

data/spec/unit/{modules → util}/pub_sub_spec.rb

@@ -8,7 +8,7 @@ describe Ably::Util::PubSub do
   subject { Ably::Util::PubSub.new(options) }
 
   context 'event fan out' do
-    specify do
+    specify 'allows publishing to more than on subscriber' do
       expect(obj).to receive(:received_message).with(msg).twice
       2.times do
         subject.subscribe(:message) { |msg| obj.received_message msg }
@@ -34,6 +34,18 @@ describe Ably::Util::PubSub do
         subject.subscribe('valid') { |msg| obj.received_message msg }
         subject.publish :valid, msg
       end
+
+      context 'and two different configurations but sharing the same class' do
+        let!(:exception_pubsub) { Ably::Util::PubSub.new(coerce_into: Proc.new { raise KeyError }) }
+
+        it 'does not share state' do
+          expect(obj).to receive(:received_message).with(msg).once
+          subject.subscribe('valid') { |msg| obj.received_message msg }
+          subject.publish :valid, msg
+
+          expect { exception_pubsub.publish :fail }.to raise_error KeyError
+        end
+      end
     end
 
     context 'without coercion' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -82,19 +82,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: msgpack-ably
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.5.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.5.10
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +188,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -196,16 +197,22 @@ files:
 - lib/ably.rb
 - lib/ably/auth.rb
 - lib/ably/exceptions.rb
+- lib/ably/logger.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/message_encoders/base.rb
+- lib/ably/models/message_encoders/base64.rb
+- lib/ably/models/message_encoders/cipher.rb
+- lib/ably/models/message_encoders/json.rb
+- lib/ably/models/message_encoders/utf8.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/encodeable.rb
 - lib/ably/modules/enum.rb
 - lib/ably/modules/event_emitter.rb
 - lib/ably/modules/event_machine_helpers.rb
@@ -220,23 +227,26 @@ files:
 - lib/ably/realtime/client/incoming_message_dispatcher.rb
 - lib/ably/realtime/client/outgoing_message_dispatcher.rb
 - lib/ably/realtime/connection.rb
+- lib/ably/realtime/connection/connection_manager.rb
 - lib/ably/realtime/connection/connection_state_machine.rb
 - lib/ably/realtime/connection/websocket_transport.rb
+- lib/ably/realtime/models/nil_channel.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/encoder.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/logger.rb
 - lib/ably/rest/middleware/parse_json.rb
 - lib/ably/rest/middleware/parse_message_pack.rb
 - lib/ably/rest/presence.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
@@ -247,19 +257,28 @@ files:
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
 - spec/acceptance/rest/channels_spec.rb
+- spec/acceptance/rest/message_spec.rb
 - spec/acceptance/rest/presence_spec.rb
 - spec/acceptance/rest/stats_spec.rb
 - spec/acceptance/rest/time_spec.rb
 - spec/integration/modules/state_emitter_spec.rb
 - spec/integration/rest/auth.rb
+- spec/resources/crypto-data-128.json
+- spec/resources/crypto-data-256.json
+- spec/rspec_config.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/logger_spec.rb
 - spec/unit/models/error_info_spec.rb
 - spec/unit/models/idiomatic_ruby_wrapper_spec.rb
+- spec/unit/models/message_encoders/base64_spec.rb
+- spec/unit/models/message_encoders/cipher_spec.rb
+- spec/unit/models/message_encoders/json_spec.rb
+- spec/unit/models/message_encoders/utf8_spec.rb
 - spec/unit/models/message_spec.rb
 - spec/unit/models/paginated_resource_spec.rb
 - spec/unit/models/presence_message_spec.rb
@@ -268,7 +287,6 @@ files:
 - 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
@@ -276,8 +294,11 @@ files:
 - spec/unit/realtime/incoming_message_dispatcher_spec.rb
 - spec/unit/realtime/presence_spec.rb
 - spec/unit/realtime/realtime_spec.rb
+- spec/unit/realtime/websocket_transport_spec.rb
 - spec/unit/rest/channels_spec.rb
 - spec/unit/rest/client_spec.rb
+- spec/unit/util/crypto_spec.rb
+- spec/unit/util/pub_sub_spec.rb
 homepage: http://github.com/ably/ably-ruby
 licenses:
 - MIT
@@ -303,7 +324,6 @@ signing_key:
 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
@@ -314,19 +334,28 @@ test_files:
 - spec/acceptance/rest/base_spec.rb
 - spec/acceptance/rest/channel_spec.rb
 - spec/acceptance/rest/channels_spec.rb
+- spec/acceptance/rest/message_spec.rb
 - spec/acceptance/rest/presence_spec.rb
 - spec/acceptance/rest/stats_spec.rb
 - spec/acceptance/rest/time_spec.rb
 - spec/integration/modules/state_emitter_spec.rb
 - spec/integration/rest/auth.rb
+- spec/resources/crypto-data-128.json
+- spec/resources/crypto-data-256.json
+- spec/rspec_config.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/logger_spec.rb
 - spec/unit/models/error_info_spec.rb
 - spec/unit/models/idiomatic_ruby_wrapper_spec.rb
+- spec/unit/models/message_encoders/base64_spec.rb
+- spec/unit/models/message_encoders/cipher_spec.rb
+- spec/unit/models/message_encoders/json_spec.rb
+- spec/unit/models/message_encoders/utf8_spec.rb
 - spec/unit/models/message_spec.rb
 - spec/unit/models/paginated_resource_spec.rb
 - spec/unit/models/presence_message_spec.rb
@@ -335,7 +364,6 @@ test_files:
 - 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
@@ -343,6 +371,9 @@ test_files:
 - spec/unit/realtime/incoming_message_dispatcher_spec.rb
 - spec/unit/realtime/presence_spec.rb
 - spec/unit/realtime/realtime_spec.rb
+- spec/unit/realtime/websocket_transport_spec.rb
 - spec/unit/rest/channels_spec.rb
 - spec/unit/rest/client_spec.rb
+- spec/unit/util/crypto_spec.rb
+- spec/unit/util/pub_sub_spec.rb
 has_rdoc: