cql-rb 1.1.3 → 1.2.0.pre0

data/spec/cql/protocol/requests/prepare_request_spec.rb

@@ -12,10 +12,10 @@ module Cql
         end
       end
 
-      describe '#encode_frame' do
+      describe '#write' do
         it 'encodes a PREPARE request frame' do
-          bytes = PrepareRequest.new('UPDATE users SET email = ? WHERE user_name = ?').encode_frame(3)
-          bytes.should == "\x01\x00\x03\x09\x00\x00\x00\x32\x00\x00\x00\x2eUPDATE users SET email = ? WHERE user_name = ?"
+          bytes = PrepareRequest.new('UPDATE users SET email = ? WHERE user_name = ?').write('')
+          bytes.should == "\x00\x00\x00\x2eUPDATE users SET email = ? WHERE user_name = ?"
         end
       end
 

data/spec/cql/protocol/requests/query_request_spec.rb

@@ -20,15 +20,20 @@ module Cql
         end
       end
 
-      describe '#encode_frame' do
+      describe '#write' do
         it 'encodes a QUERY request frame' do
-          bytes = QueryRequest.new('USE system', :all).encode_frame(3)
-          bytes.should == "\x01\x00\x03\x07\x00\x00\x00\x10\x00\x00\x00\x0aUSE system\x00\x05"
+          bytes = QueryRequest.new('USE system', :all).write('')
+          bytes.should == "\x00\x00\x00\x0aUSE system\x00\x05"
+        end
+
+        it 'encodes a QUERY request frame with tracing' do
+          bytes = QueryRequest.new('USE system', :all, true).write('')
+          bytes.should == "\x00\x00\x00\x0aUSE system\x00\x05"
         end
 
         it 'correctly encodes queries with multibyte characters' do
-          bytes = QueryRequest.new("INSERT INTO users (user_id, first, last, age) VALUES ('test', 'ümlaut', 'test', 1)", :all).encode_frame(3)
-          bytes.should eql_bytes("\x01\x00\x03\a\x00\x00\x00Y\x00\x00\x00SINSERT INTO users (user_id, first, last, age) VALUES ('test', '\xC3\xBCmlaut', 'test', 1)\x00\x05")
+          bytes = QueryRequest.new("INSERT INTO users (user_id, first, last, age) VALUES ('test', 'ümlaut', 'test', 1)", :all).write('')
+          bytes.should eql_bytes("\x00\x00\x00SINSERT INTO users (user_id, first, last, age) VALUES ('test', '\xC3\xBCmlaut', 'test', 1)\x00\x05")
         end
       end
 

data/spec/cql/protocol/requests/register_request_spec.rb

@@ -6,10 +6,10 @@ require 'spec_helper'
 module Cql
   module Protocol
     describe RegisterRequest do
-      describe '#encode_frame' do
+      describe '#write' do
         it 'encodes a REGISTER request frame' do
-          bytes = RegisterRequest.new('TOPOLOGY_CHANGE', 'STATUS_CHANGE').encode_frame(3)
-          bytes.should == "\x01\x00\x03\x0b\x00\x00\x00\x22\x00\x02\x00\x0fTOPOLOGY_CHANGE\x00\x0dSTATUS_CHANGE"
+          bytes = RegisterRequest.new('TOPOLOGY_CHANGE', 'STATUS_CHANGE').write('')
+          bytes.should == "\x00\x02\x00\x0fTOPOLOGY_CHANGE\x00\x0dSTATUS_CHANGE"
         end
       end
 

data/spec/cql/protocol/requests/startup_request_spec.rb

@@ -6,15 +6,21 @@ require 'spec_helper'
 module Cql
   module Protocol
     describe StartupRequest do
-      describe '#encode_frame' do
+      describe '#compressable?' do
+        it 'is not compressable' do
+          described_class.new.should_not be_compressable
+        end
+      end
+
+      describe '#write' do
         it 'encodes a STARTUP request frame' do
-          bytes = StartupRequest.new('3.0.0', 'snappy').encode_frame(3)
-          bytes.should == "\x01\x00\x03\x01\x00\x00\x00\x2b\x00\x02\x00\x0bCQL_VERSION\x00\x053.0.0\x00\x0bCOMPRESSION\x00\x06snappy"
+          bytes = StartupRequest.new('3.0.0', 'snappy').write('')
+          bytes.should == "\x00\x02\x00\x0bCQL_VERSION\x00\x053.0.0\x00\x0bCOMPRESSION\x00\x06snappy"
         end
 
         it 'defaults to CQL 3.0.0 and no compression' do
-          bytes = StartupRequest.new.encode_frame(3)
-          bytes.should == "\x01\x00\x03\x01\x00\x00\x00\x16\x00\x01\x00\x0bCQL_VERSION\x00\x053.0.0"
+          bytes = StartupRequest.new.write('')
+          bytes.should == "\x00\x01\x00\x0bCQL_VERSION\x00\x053.0.0"
         end
       end
 

data/spec/cql/protocol/responses/authenticate_response_spec.rb

@@ -0,0 +1,27 @@
+# encoding: ascii-8bit
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe AuthenticateResponse do
+      describe '.decode!' do
+        let :response do
+          described_class.decode!(ByteBuffer.new("\x00\x2forg.apache.cassandra.auth.PasswordAuthenticator"))
+        end
+
+        it 'decodes the authentication class' do
+          response.authentication_class.should == 'org.apache.cassandra.auth.PasswordAuthenticator'
+        end
+      end
+
+      describe '#to_s' do
+        it 'returns a string with the authentication class' do
+          response = described_class.new('org.apache.cassandra.auth.PasswordAuthenticator')
+          response.to_s.should == 'AUTHENTICATE org.apache.cassandra.auth.PasswordAuthenticator'
+        end
+      end
+    end
+  end
+end

data/spec/cql/protocol/responses/detailed_error_response_spec.rb

@@ -0,0 +1,78 @@
+# encoding: ascii-8bit
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe DetailedErrorResponse do
+      describe '.decode!' do
+        it 'decodes an unavailable error' do
+          response = described_class.decode!(0x1000, '', ByteBuffer.new("\x00\x05\x00\x00\x00\x03\x00\x00\x00\x02"))
+          response.details.should == {
+            :cl => :all,
+            :required => 3,
+            :alive => 2
+          }
+        end
+
+        it 'decodes a write_timeout error' do
+          response = described_class.decode!(0x1100, '', ByteBuffer.new("\x00\x01\x00\x00\x00\x00\x00\x00\x00\x01\x00\tBATCH_LOG"))
+          response.details.should == {
+            :cl => :one,
+            :received => 0,
+            :blockfor => 1,
+            :write_type => 'BATCH_LOG'
+          }
+        end
+
+        it 'decodes a read_timeout error' do
+          response = described_class.decode!(0x1200, '', ByteBuffer.new("\x00\x01\x00\x00\x00\x00\x00\x00\x00\x01\x01"))
+          response.details.should == {
+            :cl => :one,
+            :received => 0,
+            :blockfor => 1,
+            :data_present => true
+          }
+          response = described_class.decode!(0x1200, '', ByteBuffer.new("\x00\x01\x00\x00\x00\x00\x00\x00\x00\x01\x00"))
+          response.details.should == {
+            :cl => :one,
+            :received => 0,
+            :blockfor => 1,
+            :data_present => false
+          }
+        end
+
+        it 'decodes an already_exists error with a keyspace' do
+          response = described_class.decode!(0x2400, '', ByteBuffer.new("\x00\x05stuff\x00\x00"))
+          response.details.should == {
+            :ks => 'stuff',
+            :table => '',
+          }
+        end
+
+        it 'decodes an already_exists error with a keyspace and table' do
+          response = described_class.decode!(0x2400, '', ByteBuffer.new("\x00\x05stuff\x00\x06things"))
+          response.details.should == {
+            :ks => 'stuff',
+            :table => 'things',
+          }
+        end
+
+        it 'decodes unprepared error' do
+          response = described_class.decode!(0x2500, '', ByteBuffer.new("\x00\x10\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/"))
+          response.details.should == {
+            :id => "\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/"
+          }
+        end
+      end
+
+      describe '#to_s' do
+        it 'returns a string with the error code, message and details' do
+          response = described_class.new(0xffff, 'This is an error', {:foo => 'bar'})
+          response.to_s.should == 'ERROR 0xFFFF "This is an error" {:foo=>"bar"}'
+        end
+      end
+    end
+  end
+end

data/spec/cql/protocol/responses/error_response_spec.rb

@@ -0,0 +1,36 @@
+# encoding: ascii-8bit
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe ErrorResponse do
+      describe '.decode!' do
+        let :response do
+          described_class.decode!(ByteBuffer.new("\x00\x00\x00\n\x00PProvided version 4.0.0 is not supported by this server (supported: 2.0.0, 3.0.0)"))
+        end
+
+        it 'decodes the error code' do
+          response.code.should == 10
+        end
+
+        it 'decodes the error message' do
+          response.message.should == 'Provided version 4.0.0 is not supported by this server (supported: 2.0.0, 3.0.0)'
+        end
+
+        it 'decodes error frames with details' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x00\x11\x00\x000Operation timed out - received only 0 responses.\x00\x01\x00\x00\x00\x00\x00\x00\x00\x01\x00\tBATCH_LOG"))
+          response.details.should_not be_nil
+        end
+      end
+
+      describe '#to_s' do
+        it 'returns a string with the error code and the message' do
+          response = described_class.new(0xffff, 'This is an error')
+          response.to_s.should == 'ERROR 0xFFFF "This is an error"'
+        end
+      end
+    end
+  end
+end

data/spec/cql/protocol/responses/event_response_spec.rb

@@ -0,0 +1,40 @@
+# encoding: ascii-8bit
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe EventResponse do
+      describe '.decode!' do
+        it 'decodes a SCHEMA_CHANGE event' do
+          response = described_class.decode!(ByteBuffer.new("\x00\rSCHEMA_CHANGE\x00\aDROPPED\x00\ncql_rb_609\x00\x05users"))
+          response.type.should == 'SCHEMA_CHANGE'
+          response.change.should == 'DROPPED'
+          response.keyspace.should == 'cql_rb_609'
+          response.table.should == 'users'
+        end
+
+        it 'decodes a STATUS_CHANGE event' do
+          response = described_class.decode!(ByteBuffer.new("\x00\rSTATUS_CHANGE\x00\x04DOWN\x04\x00\x00\x00\x00\x00\x00#R"))
+          response.type.should == 'STATUS_CHANGE'
+          response.change.should == 'DOWN'
+          response.address.should == IPAddr.new('0.0.0.0')
+          response.port.should == 9042
+        end
+
+        it 'decodes a TOPOLOGY_CHANGE event' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x0FTOPOLOGY_CHANGE\x00\fREMOVED_NODE\x04\x00\x00\x00\x00\x00\x00#R"))
+          response.type.should == 'TOPOLOGY_CHANGE'
+          response.change.should == 'REMOVED_NODE'
+          response.address.should == IPAddr.new('0.0.0.0')
+          response.port.should == 9042
+        end
+
+        it 'complains when asked to decode an unknown event type' do
+          expect { described_class.decode!(ByteBuffer.new("\x00\x04PING")) }.to raise_error(UnsupportedEventTypeError, /PING/)
+        end
+      end
+    end
+  end
+end

data/spec/cql/protocol/responses/prepared_result_response_spec.rb

@@ -0,0 +1,108 @@
+# encoding: ascii-8bit
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe PreparedResultResponse do
+      describe '.decode!' do
+        let :response do
+          described_class.decode!(ByteBuffer.new("\x00\x10\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/\x00\x00\x00\x01\x00\x00\x00\x01\x00\ncql_rb_911\x00\x05users\x00\tuser_name\x00\r"))
+        end
+
+        it 'decodes the ID' do
+          response.id.should == "\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/"
+        end
+
+        it 'decodes the column metadata' do
+          response.metadata.should == [['cql_rb_911', 'users', 'user_name', :varchar]]
+        end
+      end
+
+      describe '#void?' do
+        it 'is not void' do
+          response = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          response.should_not be_void
+        end
+      end
+
+      describe '#to_s' do
+        it 'returns a string with the ID and metadata' do
+          response = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          response.to_s.should match(/^RESULT PREPARED [0-9a-f]{32} \[\["ks", "tbl", "col", :varchar\]\]$/)
+        end
+      end
+
+      describe '#eql?' do
+        it 'is equal to an identical response' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r1.should eql(r2)
+        end
+
+        it 'is not equal when the IDs differ' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r2 = described_class.new("\x00" * 16, [['ks', 'tbl', 'col', :varchar]], nil)
+          r1.should_not eql(r2)
+        end
+
+        it 'is not equal when the metadata differ' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar], ['ks', 'tbl', 'col2', :uuid]], nil)
+          r1.should_not eql(r2)
+        end
+
+        it 'is not equal when one has a trace ID' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], Uuid.new('00b69180-d0e1-11e2-8b8b-0800200c9a66'))
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r1.should_not eql(r2)
+        end
+
+        it 'is not equal when the trace IDs differ' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], Uuid.new('00b69180-d0e1-11e2-8b8b-0800200c9a66'))
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], Uuid.new('11111111-d0e1-11e2-8b8b-0800200c9a66'))
+          r1.should_not eql(r2)
+        end
+
+        it 'is aliased as ==' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r1.should == r2
+        end
+      end
+
+      describe '#hash' do
+        it 'is the same for an identical response' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r1.hash.should == r2.hash
+        end
+
+        it 'is not the same when the IDs differ' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r2 = described_class.new("\x00" * 16, [['ks', 'tbl', 'col', :varchar]], nil)
+          r1.hash.should_not == r2.hash
+        end
+
+        it 'is not the same when the metadata differ' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar], ['ks', 'tbl', 'col2', :uuid]], nil)
+          r1.hash.should_not == r2.hash
+        end
+
+        it 'is not the same when one has a trace ID' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], Uuid.new('00b69180-d0e1-11e2-8b8b-0800200c9a66'))
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], nil)
+          r1.hash.should_not == r2.hash
+        end
+
+        it 'is not equal when the trace IDs differ' do
+          r1 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], Uuid.new('00b69180-d0e1-11e2-8b8b-0800200c9a66'))
+          r2 = described_class.new("\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/", [['ks', 'tbl', 'col', :varchar]], Uuid.new('11111111-d0e1-11e2-8b8b-0800200c9a66'))
+          r1.hash.should_not == r2.hash
+        end
+      end
+    end
+  end
+end

data/spec/cql/protocol/responses/ready_response_spec.rb

@@ -0,0 +1,39 @@
+# encoding: ascii-8bit
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe ReadyResponse do
+      describe '.decode!' do
+        it 'returns a new instance' do
+          unused_byte_buffer = nil
+          described_class.decode!(unused_byte_buffer).should be_a(described_class)
+        end
+      end
+
+      describe '#to_s' do
+        it 'returns a string' do
+          described_class.new.to_s.should == 'READY'
+        end
+      end
+
+      describe '#eql?' do
+        it 'is equal to all other ready responses' do
+          described_class.new.should eql(described_class.new)
+        end
+
+        it 'aliased as ==' do
+          described_class.new.should == described_class.new
+        end
+      end
+
+      describe '#hash' do
+        it 'has the same hash code as all other ready responses' do
+          described_class.new.hash.should == described_class.new.hash
+        end
+      end
+    end
+  end
+end

data/spec/cql/protocol/responses/result_response_spec.rb

@@ -0,0 +1,57 @@
+# encoding: ascii-8bit
+
+require 'spec_helper'
+
+
+module Cql
+  module Protocol
+    describe ResultResponse do
+      describe '.decode!' do
+        it 'decodes a set_keyspace result' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x00\x00\x03\x00\x06system"))
+          response.should_not be_void
+          response.keyspace.should == 'system'
+        end
+
+        it 'decodes a schema_change CREATED result' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x00\x00\x05\x00\aCREATED\x00\ncql_rb_477\x00\x00"))
+          response.should_not be_void
+          response.change.should == 'CREATED'
+          response.keyspace.should == 'cql_rb_477'
+          response.table.should be_empty
+        end
+
+        it 'decodes a schema_change UPDATED result' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x00\x00\x05\x00\aUPDATED\x00\ncql_rb_973\x00\x05users"))
+          response.should_not be_void
+          response.change.should == 'UPDATED'
+          response.keyspace.should == 'cql_rb_973'
+          response.table.should == 'users'
+        end
+
+        it 'decodes a void result' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x00\x00\x01"))
+          response.should be_void
+        end
+
+        it 'decodes a rows result' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x00\x00\x02\x00\x00\x00\x01\x00\x00\x00\x03\x00\ncql_rb_126\x00\x05users\x00\tuser_name\x00\r\x00\x05email\x00\r\x00\bpassword\x00\r\x00\x00\x00\x02\x00\x00\x00\x04phil\x00\x00\x00\rphil@heck.com\xFF\xFF\xFF\xFF\x00\x00\x00\x03sue\x00\x00\x00\rsue@inter.net\xFF\xFF\xFF\xFF"))
+          response.should_not be_void
+          response.rows.size.should == 2
+          response.metadata.size.should == 3
+        end
+
+        it 'decodes a prepared result' do
+          response = described_class.decode!(ByteBuffer.new("\x00\x00\x00\x04\x00\x10\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/\x00\x00\x00\x01\x00\x00\x00\x01\x00\ncql_rb_911\x00\x05users\x00\tuser_name\x00\r"))
+          response.should_not be_void
+          response.id.should == "\xCAH\x7F\x1Ez\x82\xD2<N\x8A\xF35Qq\xA5/"
+          response.metadata.size.should == 1
+        end
+
+        it 'complains when asked to decode an unknown result type' do
+          expect { described_class.decode!(ByteBuffer.new("\x00\x00\x00\xffhello")) }.to raise_error(UnsupportedResultKindError)
+        end
+      end
+    end
+  end
+end