cassandra-driver 0.1.0.alpha1 → 1.0.0.beta.1

data/lib/cassandra/protocol/requests/query_request.rb

@@ -0,0 +1,153 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class QueryRequest < Request
+      attr_reader :cql, :values, :type_hints, :serial_consistency, :page_size, :paging_state
+      attr_accessor :consistency, :retries
+
+      def initialize(cql, values, type_hints, consistency, serial_consistency=nil, page_size=nil, paging_state=nil, trace=false)
+        raise ArgumentError, %(No CQL given!) unless cql
+        raise ArgumentError, %(No such consistency: #{consistency.inspect}) if consistency.nil? || !CONSISTENCIES.include?(consistency)
+        raise ArgumentError, %(No such consistency: #{serial_consistency.inspect}) unless serial_consistency.nil? || CONSISTENCIES.include?(serial_consistency)
+        raise ArgumentError, %(Bound values and type hints must have the same number of elements (got #{values.size} values and #{type_hints.size} hints)) if values && type_hints && values.size != type_hints.size
+        raise ArgumentError, %(Paging state given but no page size) if paging_state && !page_size
+        super(7, trace)
+        @cql = cql
+        @values = values || EMPTY_LIST
+        @type_hints = type_hints || EMPTY_LIST
+        @consistency = consistency
+        @serial_consistency = serial_consistency
+        @page_size = page_size
+        @paging_state = paging_state
+      end
+
+      def write(protocol_version, buffer)
+        if protocol_version > 1
+          buffer.append_long_string(@cql)
+        else
+          buffer.append_long_string(serialized_cql)
+        end
+        buffer.append_consistency(@consistency)
+        if protocol_version > 1
+          flags  = 0
+          flags |= 0x04 if @page_size
+          flags |= 0x08 if @paging_state
+          flags |= 0x10 if @serial_consistency
+          if @values && @values.size > 0
+            flags |= 0x01
+            buffer.append(flags.chr)
+            self.class.encode_values(buffer, @values, @type_hints)
+          else
+            buffer.append(flags.chr)
+          end
+          buffer.append_int(@page_size) if @page_size
+          buffer.append_bytes(@paging_state) if @paging_state
+          buffer.append_consistency(@serial_consistency) if @serial_consistency
+        end
+        buffer
+      end
+
+      def to_s
+        %(QUERY "#@cql" #{@consistency.to_s.upcase})
+      end
+
+      def eql?(rq)
+        self.class === rq &&
+          rq.cql == self.cql &&
+          rq.values == self.values &&
+          rq.type_hints == self.type_hints &&
+          rq.consistency == self.consistency &&
+          rq.serial_consistency == self.serial_consistency &&
+          rq.page_size == self.page_size &&
+          rq.paging_state == self.paging_state
+      end
+      alias_method :==, :eql?
+
+      def hash
+        h = 0xcbf29ce484222325
+        h = 0xffffffffffffffff & (0x100000001b3 * (h ^ @cql.hash))
+        h = 0xffffffffffffffff & (0x100000001b3 * (h ^ @values.hash))
+        h = 0xffffffffffffffff & (0x100000001b3 * (h ^ @type_hints.hash))
+        h = 0xffffffffffffffff & (0x100000001b3 * (h ^ @consistency.hash))
+        h = 0xffffffffffffffff & (0x100000001b3 * (h ^ @serial_consistency.hash))
+        h = 0xffffffffffffffff & (0x100000001b3 * (h ^ @page_size.hash))
+        h = 0xffffffffffffffff & (0x100000001b3 * (h ^ @paging_state.hash))
+        h
+      end
+
+      def self.encode_values(buffer, values, hints)
+        if values && values.size > 0
+          buffer.append_short(values.size)
+          values.each_with_index do |value, index|
+            type = (hints && hints[index]) || guess_type(value)
+            raise EncodingError, "Could not guess a suitable type for #{value.inspect}" unless type
+            TYPE_CONVERTER.to_bytes(buffer, type, value)
+          end
+          buffer
+        else
+          buffer.append_short(0)
+        end
+      end
+
+      private
+
+      def serialized_cql
+        return @cql if @values.nil? || @values.empty?
+        i = -1
+        @cql.gsub('?') { Util.encode(@values[i += 1]) }
+      end
+
+      def self.guess_type(value)
+        type = TYPE_GUESSES[value.class]
+        if type == :map
+          pair = value.first
+          [type, guess_type(pair[0]), guess_type(pair[1])]
+        elsif type == :list
+          [type, guess_type(value.first)]
+        elsif type == :set
+          [type, guess_type(value.first)]
+        else
+          type
+        end
+      end
+
+      TYPE_GUESSES = {
+        String => :varchar,
+        Fixnum => :bigint,
+        Float => :double,
+        Bignum => :varint,
+        BigDecimal => :decimal,
+        TrueClass => :boolean,
+        FalseClass => :boolean,
+        NilClass => :bigint,
+        Uuid => :uuid,
+        TimeUuid => :uuid,
+        IPAddr => :inet,
+        Time => :timestamp,
+        Hash => :map,
+        Array => :list,
+        Set => :set,
+      }.freeze
+      TYPE_CONVERTER = TypeConverter.new
+      EMPTY_LIST = [].freeze
+      NO_FLAGS = "\x00".freeze
+    end
+  end
+end

data/lib/cassandra/protocol/requests/register_request.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class RegisterRequest < Request
+      attr_reader :events
+
+      def initialize(*events)
+        super(11)
+        @events = events
+      end
+
+      def write(protocol_version, buffer)
+        buffer.append_string_list(@events)
+      end
+
+      def to_s
+        %(REGISTER #@events)
+      end
+    end
+  end
+end

data/lib/cassandra/protocol/requests/startup_request.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class StartupRequest < Request
+      attr_reader :options
+
+      def initialize(cql_version, compression=nil)
+        super(1)
+        raise ArgumentError, "Invalid CQL version: #{cql_version.inspect}" unless cql_version
+        @options = {CQL_VERSION => cql_version}
+        @options[COMPRESSION] = compression if compression
+      end
+
+      def compressable?
+        false
+      end
+
+      def write(protocol_version, buffer)
+        buffer.append_string_map(@options)
+      end
+
+      def to_s
+        %(STARTUP #@options)
+      end
+
+      private
+
+      CQL_VERSION = 'CQL_VERSION'.freeze
+      COMPRESSION = 'COMPRESSION'.freeze
+    end
+  end
+end

data/lib/cassandra/protocol/requests/void_query_request.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class VoidQueryRequest
+    end
+  end
+end

data/lib/cassandra/protocol/response.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class Response
+      def self.decode(opcode, protocol_version, buffer, length, trace_id)
+        response_class = RESPONSE_TYPES[opcode]
+        if response_class
+          response_class.decode(protocol_version, buffer, length, trace_id)
+        else
+          raise UnsupportedOperationError, "The operation #{opcode} is not supported"
+        end
+      end
+
+      private
+
+      RESPONSE_TYPES = [
+        # populated by subclasses
+      ]
+    end
+  end
+end

data/lib/cassandra/protocol/responses/auth_challenge_response.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class AuthChallengeResponse < Response
+      attr_reader :token
+
+      def self.decode(protocol_version, buffer, length, trace_id=nil)
+        new(buffer.read_bytes)
+      end
+
+      def initialize(token)
+        @token = token
+      end
+
+      def to_s
+        %(AUTH_CHALLENGE #{@token.bytesize})
+      end
+
+      private
+
+      RESPONSE_TYPES[0x0e] = self
+    end
+  end
+end

data/lib/cassandra/protocol/responses/auth_success_response.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class AuthSuccessResponse < Response
+      attr_reader :token
+
+      def self.decode(protocol_version, buffer, length, trace_id=nil)
+        new(buffer.read_bytes)
+      end
+
+      def initialize(token)
+        @token = token
+      end
+
+      def to_s
+        %(AUTH_SUCCESS #{@token.bytesize})
+      end
+
+      private
+
+      RESPONSE_TYPES[0x10] = self
+    end
+  end
+end

data/lib/cassandra/protocol/responses/authenticate_response.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class AuthenticateResponse < Response
+      attr_reader :authentication_class
+
+      def self.decode(protocol_version, buffer, length, trace_id=nil)
+        new(buffer.read_string)
+      end
+
+      def initialize(authentication_class)
+        @authentication_class = authentication_class
+      end
+
+      def to_s
+        %(AUTHENTICATE #{authentication_class})
+      end
+
+      private
+
+      RESPONSE_TYPES[0x03] = self
+    end
+  end
+end

data/lib/cassandra/protocol/responses/detailed_error_response.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class DetailedErrorResponse < ErrorResponse
+      attr_reader :details
+
+      def initialize(code, message, details)
+        super(code, message)
+        @details = details
+      end
+
+      def self.decode(code, message, protocol_version, buffer, length, trace_id=nil)
+        details = {}
+        case code
+        when 0x1000 # unavailable
+          details[:cl] = buffer.read_consistency
+          details[:required] = buffer.read_int
+          details[:alive] = buffer.read_int
+        when 0x1100 # write_timeout
+          details[:cl] = buffer.read_consistency
+          details[:received] = buffer.read_int
+          details[:blockfor] = buffer.read_int
+          details[:write_type] = buffer.read_string
+        when 0x1200 # read_timeout
+          details[:cl] = buffer.read_consistency
+          details[:received] = buffer.read_int
+          details[:blockfor] = buffer.read_int
+          details[:data_present] = buffer.read_byte != 0
+        when 0x2400 # already_exists
+          details[:ks] = buffer.read_string
+          details[:table] = buffer.read_string
+        when 0x2500
+          details[:id] = buffer.read_short_bytes
+        end
+        new(code, message, details)
+      end
+
+      def to_s
+        "#{super} #{@details}"
+      end
+    end
+  end
+end