ably 0.8.8 → 0.8.9

data/spec/unit/models/message_encoders/cipher_spec.rb

@@ -3,7 +3,7 @@ require 'ably/models/message_encoders/cipher'
 require 'msgpack'
 
 describe Ably::Models::MessageEncoders::Cipher do
-  let(:secret_key)          { random_str(64) }
+  let(:secret_key)          { Ably::Util::Crypto.generate_random_key(128) }
   let(:crypto_options)      { { key: secret_key, algorithm: 'AES', mode: 'CBC', key_length: 128 } }
   let(:crypto)              { Ably::Util::Crypto.new(cipher_params) }
 
@@ -23,7 +23,7 @@ describe Ably::Models::MessageEncoders::Cipher do
 
       context 'valid cipher data' do
         before do
-          subject.decode message, { encrypted: true, cipher_params: cipher_params }
+          subject.decode message, { cipher: cipher_params }
         end
 
         context 'message with cipher payload' do
@@ -79,29 +79,33 @@ describe Ably::Models::MessageEncoders::Cipher do
         end
       end
 
-      context 'with invalid channel_option cipher params' do
-        let(:message) { { data: decoded_data, encoding: 'cipher+aes-128-cbc' } }
-        let(:cipher_params) { crypto_options.merge(key_length: 256) }
-        let(:decode_method) { subject.decode message, { encrypted: true, cipher_params: cipher_params } }
+      context '256 bit key' do
+        let(:secret_key) { Ably::Util::Crypto.generate_random_key(256) }
 
-        it 'raise an exception' do
-          expect { decode_method }.to raise_error Ably::Exceptions::CipherError, /Cipher algorithm [\w-]+ does not match message cipher algorithm of AES-128-CBC/
+        context 'with invalid channel_option cipher params' do
+          let(:message) { { data: decoded_data, encoding: 'cipher+aes-128-cbc' } }
+          let(:cipher_params) { crypto_options.merge(key_length: 256) }
+          let(:decode_method) { subject.decode message, { cipher: cipher_params } }
+
+          it 'raise an exception' do
+            expect { decode_method }.to raise_error Ably::Exceptions::CipherError, /Cipher algorithm [\w-]+ does not match message cipher algorithm of AES-128-CBC/
+          end
         end
-      end
 
-      context 'without any configured encryption' do
-        let(:message) { { data: decoded_data, encoding: 'cipher+aes-128-cbc' } }
-        let(:cipher_params) { crypto_options.merge(key_length: 256) }
-        let(:decode_method) { subject.decode message, {} }
+        context 'without any configured encryption' do
+          let(:message) { { data: decoded_data, encoding: 'cipher+aes-128-cbc' } }
+          let(:cipher_params) { crypto_options.merge(key_length: 256) }
+          let(:decode_method) { subject.decode message, {} }
 
-        it 'raise an exception' do
-          expect { decode_method }.to raise_error Ably::Exceptions::CipherError, /Message cannot be decrypted as the channel is not set up for encryption & decryption/
+          it 'raise an exception' do
+            expect { decode_method }.to raise_error Ably::Exceptions::CipherError, /Message cannot be decrypted as the channel is not set up for encryption & decryption/
+          end
         end
       end
 
       context 'with invalid cipher data' do
         let(:message) { { data: decoded_data, encoding: 'cipher+aes-128-cbc' } }
-        let(:decode_method) { subject.decode(message, { encrypted: true, cipher_params: cipher_params }) }
+        let(:decode_method) { subject.decode(message, { cipher: cipher_params }) }
 
         it 'raise an exception' do
           expect { decode_method }.to raise_error Ably::Exceptions::CipherError, /CipherError decrypting data/
@@ -110,10 +114,11 @@ describe Ably::Models::MessageEncoders::Cipher do
     end
 
     context 'with AES-256-CBC' do
+      let(:secret_key) { Ably::Util::Crypto.generate_random_key(256) }
       let(:cipher_params) { crypto_options.merge(key_length: 256) }
 
       before do
-        subject.decode message, { encrypted: true, cipher_params: cipher_params }
+        subject.decode message, { cipher: cipher_params }
       end
 
       context 'message with cipher payload' do
@@ -133,7 +138,7 @@ describe Ably::Models::MessageEncoders::Cipher do
   context '#encode' do
     context 'with channel set up for AES-128-CBC' do
       let(:cipher_params) { crypto_options }
-      let(:channel_options) { { encrypted: true, cipher_params: cipher_params } }
+      let(:channel_options) { { cipher: cipher_params } }
 
       context 'with encrypted set to true' do
         before do
@@ -211,12 +216,12 @@ describe Ably::Models::MessageEncoders::Cipher do
 
       context 'channel_option cipher params' do
         let(:message) { { data: decoded_data, encoding: nil } }
-        let(:encode_method) { subject.encode message, { encrypted: true, cipher_params: cipher_params } }
+        let(:encode_method) { subject.encode message, { cipher: cipher_params } }
 
         context 'have invalid key length' do
           let(:cipher_params) { crypto_options.merge(key_length: 1) }
           it 'raise an exception' do
-            expect { encode_method }.to raise_error Ably::Exceptions::CipherError, /unsupported cipher algorithm/
+            expect { encode_method }.to raise_error Ably::Exceptions::CipherError, /Incompatible :key length/
           end
         end
 
@@ -230,17 +235,18 @@ describe Ably::Models::MessageEncoders::Cipher do
         context 'have missing key' do
           let(:cipher_params) { {} }
           it 'raise an exception' do
-            expect { encode_method }.to raise_error Ably::Exceptions::CipherError, /:key is required/
+            expect { encode_method }.to raise_error Ably::Exceptions::CipherError, /key.*required/
           end
         end
       end
     end
 
     context 'with AES-256-CBC' do
+      let(:secret_key) { Ably::Util::Crypto.generate_random_key(256) }
       let(:cipher_params) { crypto_options.merge(key_length: 256) }
 
       before do
-        subject.encode message, { encrypted: true, cipher_params: cipher_params }
+        subject.encode message, { cipher: cipher_params }
       end
 
       context 'message with cipher payload' do

data/spec/unit/models/message_encoders/json_spec.rb

@@ -30,6 +30,18 @@ describe Ably::Models::MessageEncoders::Json do
       end
     end
 
+    context 'message with json payload in camelCase' do
+      let(:message) { { data: '{"keyId":"test"}', encoding: 'json' } }
+
+      it 'decodes json' do
+        expect(message[:data]).to eq({ 'keyId' => 'test' })
+      end
+
+      it 'strips the encoding' do
+        expect(message[:encoding]).to be_nil
+      end
+    end
+
     context 'message with json payload before other payloads' do
       let(:message) { { data: hash_string_data, encoding: 'utf-8/json' } }
 
@@ -72,6 +84,18 @@ describe Ably::Models::MessageEncoders::Json do
       end
     end
 
+    context 'message with hash payload and underscore case keys' do
+      let(:message) { { data: { key_id: 'test' }, encoding: nil } }
+
+      it 'encodes hash payload data as json and leaves underscore case in tact' do
+        expect(message[:data]).to eql('{"key_id":"test"}')
+      end
+
+      it 'adds the encoding' do
+        expect(message[:encoding]).to eql('json')
+      end
+    end
+
     context 'already encoded message with hash payload' do
       let(:message) { { data: hash_data, encoding: 'utf-8' } }
 

data/spec/unit/models/protocol_message_spec.rb

@@ -20,17 +20,17 @@ describe Ably::Models::ProtocolMessage do
   context 'initializer action coercion', :api_private do
     it 'ignores actions that are Integers' do
       protocol_message = subject.new(action: 14)
-      expect(protocol_message.hash[:action]).to eql(14)
+      expect(protocol_message.attributes[:action]).to eql(14)
     end
 
     it 'converts actions to Integers if a symbol' do
       protocol_message = subject.new(action: :message)
-      expect(protocol_message.hash[:action]).to eql(15)
+      expect(protocol_message.attributes[:action]).to eql(15)
     end
 
     it 'converts actions to Integers if a ACTION' do
       protocol_message = subject.new(action: Ably::Models::ProtocolMessage::ACTION.Message)
-      expect(protocol_message.hash[:action]).to eql(15)
+      expect(protocol_message.attributes[:action]).to eql(15)
     end
 
     it 'raises an argument error if nil' do

data/spec/unit/util/crypto_spec.rb

@@ -2,16 +2,17 @@ require 'spec_helper'
 require 'msgpack'
 
 describe Ably::Util::Crypto do
-  let(:seret_key)  { random_str }
-  let(:cipher_options) { { key: seret_key } }
+  let(:cipher)         { OpenSSL::Cipher.new('AES-256-CBC') }
+  let(:secret_key)     { cipher.random_key }
+  let(:cipher_options) { { key: secret_key } }
   subject { Ably::Util::Crypto.new(cipher_options) }
 
   context 'defaults' do
     let(:expected_defaults) do
       {
-        algorithm: 'AES',
-        mode: 'CBC',
-        key_length: 128
+        algorithm: 'aes',
+        mode: 'cbc',
+        key_length: 256
       }
     end
 
@@ -22,20 +23,52 @@ describe Ably::Util::Crypto do
   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)
+    context 'with just a :key param' do
+      let(:defaults) { Ably::Util::Crypto.get_default_params(key: secret_key) }
+
+      it 'uses the defaults' do
+        expect(defaults.algorithm).to eql('aes')
+        expect(defaults.mode).to eql('cbc')
+        expect(defaults.key_length).to eql(256)
+      end
+
+      it 'contains the provided key' do
+        expect(defaults.key).to eql(secret_key)
+      end
+
+      it 'returns a CipherParams object' do
+        expect(defaults).to be_a(Ably::Models::CipherParams)
+      end
     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)
+    context 'without a :key param' do
+      let(:cipher_params) { Ably::Util::Crypto.get_default_params }
+
+      it 'raises an exception' do
+        expect { cipher_params }.to raise_error(/key.*required/)
+      end
+    end
+
+    context 'with a base64-encoded :key param' do
+      let(:cipher_params) { Ably::Util::Crypto.get_default_params(key: Base64.encode64(secret_key)) }
+
+      it 'converts the key to binary' do
+        expect(cipher_params.key).to eql(secret_key)
+      end
+    end
+
+    context 'with provided params' do
+      let(:algorithm) { 'FOO' }
+      let(:mode) { 'BAR' }
+      let(:key_length) { 192 }
+      let(:key) { secret_key[0...24] }
+      let(:cipher_params) { Ably::Util::Crypto.get_default_params(key: key, algorithm: algorithm, mode: mode, key_length: key_length) }
+
+      it 'overrides the defaults' do
+        expect(cipher_params.algorithm).to eql('foo')
+        expect(cipher_params.mode).to eql('bar')
+        expect(cipher_params.key_length).to eql(192)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.8.9
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -287,6 +287,7 @@ files:
 - lib/ably/exceptions.rb
 - lib/ably/logger.rb
 - lib/ably/models/channel_state_change.rb
+- lib/ably/models/cipher_params.rb
 - lib/ably/models/connection_details.rb
 - lib/ably/models/connection_state_change.rb
 - lib/ably/models/error_info.rb
@@ -397,6 +398,7 @@ files:
 - spec/unit/auth_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/channel_state_change_spec.rb
+- spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb
 - spec/unit/models/error_info_spec.rb
@@ -497,6 +499,7 @@ test_files:
 - spec/unit/auth_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/channel_state_change_spec.rb
+- spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb
 - spec/unit/models/error_info_spec.rb