ciql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9638c378c3dd96de3e453431fb768d2446fcafe
+  data.tar.gz: 77a6bcc2b812511957284dbc0ab319a9abe50cc4
+SHA512:
+  metadata.gz: 83d476cf4eb7a62b9646a5b810ab0cd9c076eed1d00dec3b76468f9f8328bbf96ca7eccf64650254ff9541bf77e350b7a3ebec316369dc1b4715eab623bac4c2
+  data.tar.gz: 29afea8c01852fb176295b34357fd3b8c3c4ee714baddb738cc9b9d3ef19259c31f123efb3f317b42475403f6adf617542eaea9356518c039236e6ba5bc81714

data/README.md

@@ -0,0 +1,5 @@
+# Ciql
+
+[![Build Status](https://travis-ci.org/Nulu/ciql.png?branch=master)](https://travis-ci.org/Nulu/ciql) [![Dependency Status](https://gemnasium.com/Nulu/ciql.png)](https://gemnasium.com/Nulu/ciql)
+
+This project is currently small support utilities and extensions for the [cql-rb](https://github.com/iconara/cql-rb) driver.

data/lib/ciql/client.rb

@@ -0,0 +1,21 @@
+module Ciql
+  module Client
+    class AsynchronousClient < Cql::Client::AsynchronousClient
+      def execute(statement, *arguments)
+        bind_variables = arguments.shift statement.count('?')
+        bound_statement = Ciql::Sanitize.sanitize statement, *bind_variables
+        super(bound_statement, *arguments)
+      end
+    end
+
+    class SynchronousClient < Cql::Client::SynchronousClient
+      def execute(statement, *arguments)
+        @async_client.execute(statement, *arguments).get
+      end
+    end
+
+    def self.connect(options={})
+      SynchronousClient.new(AsynchronousClient.new(options)).connect
+    end
+  end
+end

data/lib/ciql/configuration.rb

@@ -0,0 +1,31 @@
+require 'ostruct'
+
+module Ciql
+  @@client = nil
+  def self.client
+    @@client ||= Client.connect(configuration.to_options)
+  end
+
+  @@configuration = nil
+  def self.configuration
+    @@configuration ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    yield configuration
+  end
+
+  class Configuration < OpenStruct
+    def initialize
+      super
+      self.hosts = []
+    end
+
+    def to_options
+      all = [host].concat(hosts).compact.reject(&:empty?)
+      self.hosts = []
+      self.host = all.join(',') unless all.empty?
+      self.marshal_dump.dup.tap { |hash| hash.delete(:hosts) }
+    end
+  end
+end

data/lib/ciql/sanitize.rb

@@ -0,0 +1,59 @@
+require 'simple_uuid'
+
+module Ciql
+  module Sanitize
+
+    class UnescapableObjectError < Ciql::Error; end
+    class InvalidBindVariableError < Ciql::Error; end
+
+    def self.sanitize(statement, *variables)
+      variables = variables.dup
+      expected = statement.count('?')
+
+      if expected != variables.size
+        raise InvalidBindVariableError,
+          "Wrong number of bound variables "\
+          "(statement expected #{expected}, "\
+          "was #{variables.size})"
+      end
+
+      statement.gsub(/\?/) { cast(variables.shift) }
+    end
+
+    private
+
+    def self.quote(string)
+      "'" + string.gsub("'", "''") + "'"
+    end
+
+    def self.cast(obj)
+      case obj
+      when Hash
+        obj.map do |key, value|
+          [cast(key), cast(value)].join(':')
+        end.join(',')
+
+      when Enumerable
+        obj.map { |member| cast(member) }.join(',')
+
+      when Numeric;  obj
+      when DateTime; (obj.to_time.to_f * 1000).to_i
+      when Time;     (obj.to_f * 1000).to_i
+      when Date;     quote(obj.strftime('%Y-%m-%d'))
+
+      when ::Cql::Uuid;        obj.to_s
+      when ::SimpleUUID::UUID; obj.to_guid
+
+      when String
+        if obj.encoding == ::Encoding::BINARY
+          '0x' + obj.unpack('H*').first
+        else
+          quote obj.encode(::Encoding::UTF_8)
+        end
+
+      else
+        quote obj.to_s.dup.force_encoding(::Encoding::BINARY)
+      end
+    end
+  end
+end

data/lib/ciql/version.rb

@@ -0,0 +1,3 @@
+module Ciql
+  VERSION = '0.1.0'.freeze
+end

data/lib/ciql.rb

@@ -0,0 +1,9 @@
+require 'cql'
+
+module Ciql
+  Error = Class.new(StandardError)
+end
+
+require 'ciql/configuration'
+require 'ciql/sanitize'
+require 'ciql/client'

data/spec/ciql/client_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module Ciql::Client
+  describe AsynchronousClient do
+    let(:client) { described_class.new }
+
+    describe '#execute' do
+      before do
+        client.instance_variable_set(:@connected, true)
+        client.stub(:execute_request) do |request|
+          Cql::Future.completed(request)
+        end
+      end
+
+      it 'returns a Cql::Future' do
+        client.execute('x').should be_kind_of Cql::Future
+      end
+
+      it 'binds query parameters' do
+        client.execute('a = ? and b = ?', "a'b", [1,2].pack('C*'))
+          .get.cql.should == "a = 'a''b' and b = 0x0102"
+      end
+
+      it 'uses an extra trailing argument as the consistency level' do
+        client.execute('update', :any).get.consistency.should == :any
+        client.execute('update ?', :any).get.consistency.should == :quorum
+        client.execute('update ?', :any, :one).get.consistency.should == :one
+      end
+    end
+  end
+
+  describe SynchronousClient do
+    let(:async_client) { mock('async client') }
+    let(:client) { described_class.new(async_client) }
+
+    describe '#execute' do
+      before do
+        async_client.should_receive(:execute) do |*arguments|
+          Cql::Future.completed(arguments)
+        end
+      end
+
+      it "returns the value of the async client's #execute result" do
+        client.execute('??', 'a', 'b', :two).should == ['??', 'a', 'b', :two]
+      end
+    end
+  end
+
+  describe '.connect' do
+    let(:reactor) { FakeReactor.new }
+
+    before(:each) do
+      Cql::Io::IoReactor.stub(:new).and_return(reactor)
+    end
+
+    subject { Ciql::Client.connect(port: 4000) }
+
+    it 'returns a SynchronousClient' do
+      subject.should be_instance_of Ciql::Client::SynchronousClient
+    end
+
+    it 'passes the options to the internal async client' do
+      subject.async.instance_variable_get(:@port).should == 4000
+    end
+  end
+end

data/spec/ciql/configuration_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+module Ciql
+  describe '.client' do
+    let(:reactor) { FakeReactor.new }
+
+    before(:each) do
+      Cql::Io::IoReactor.stub(:new).and_return(reactor)
+    end
+
+    after(:each) do
+      Ciql.class_variable_set(:@@client, nil)
+      Ciql.class_variable_set(:@@configuration, nil)
+    end
+
+    it 'returns a Client instance' do
+      Ciql.client.should be_instance_of Ciql::Client::SynchronousClient
+    end
+
+    it 'always returns the same Client instance' do
+      Ciql.client.should be Ciql.client
+    end
+
+    it 'creates the client with the configured options' do
+      Ciql.configure { |c| c.port = 1234 }
+      Ciql::Client::AsynchronousClient.should_receive(:new).with(port: 1234).and_call_original
+      Ciql.client
+    end
+
+    it 'connects the client' do
+      Ciql.client.should be_connected
+    end
+  end
+
+  describe '.configuration' do
+    after(:each) do
+      Ciql.class_variable_set(:@@configuration, nil)
+    end
+
+    it 'returns a Configuration instance' do
+      Ciql.configuration.should be_instance_of Ciql::Configuration
+    end
+
+    it 'always returns the same Configuration instance' do
+      Ciql.configuration.should be Ciql.configuration
+    end
+  end
+
+  describe '.configure' do
+    it 'yields the Configuration instance returned by .configuration' do
+      Ciql.configure do |c|
+        c.should be Ciql.configuration
+      end
+    end
+  end
+
+  describe Configuration do
+    it 'supports property access via #name' do
+      subject.port = 5
+      subject.port.should == 5
+    end
+
+    it '#hosts is an array' do
+      subject.hosts << 'remote'
+      subject.hosts.should == ['remote']
+    end
+
+    describe '#to_options' do
+      it 'returns a Hash with the configured options as keys' do
+        subject.foo = 1
+        subject.bar = 'a'
+        subject.to_options.should == {foo: 1, bar: 'a'}
+      end
+
+      it 'sets #host with comma-separated string of #hosts entries' do
+        subject.hosts << 'local'
+        subject.hosts << 'remote'
+        subject.to_options[:host].should == 'local,remote'
+      end
+
+      it 'combines #host and #hosts into #host' do
+        subject.host = 'primary'
+        subject.hosts << 'secondary'
+        subject.to_options[:host].should == 'primary,secondary'
+      end
+
+      it 'does not include an entry for :hosts' do
+        subject.to_options[:hosts].should be_nil
+      end
+
+      it 'clears #hosts' do
+        subject.hosts << 'one'
+        subject.to_options
+        subject.hosts.should be_empty
+      end
+
+      it 'ignores nil values and empty strings' do
+        subject.hosts << nil
+        subject.hosts << ''
+        subject.hosts << 'server'
+        subject.to_options[:host].should == 'server'
+      end
+
+      it 'does not change #host if #hosts is empty' do
+        subject.to_options[:host].should == nil
+        subject.host = 'local'
+        subject.to_options[:host].should == 'local'
+      end
+    end
+  end
+end

data/spec/ciql/sanitize_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+module Ciql
+  describe Sanitize do
+    describe 'when there are no placeholders in the statement' do
+      before do
+        @statement = 'select * from table'
+      end
+
+      describe 'and no variables are given' do
+        it 'returns the statement as-is' do
+          subject.sanitize(@statement).should == @statement
+        end
+      end
+
+      describe 'and one or more variables are given' do
+        it 'throws InvalidBindVariableError' do
+          expect {
+            subject.sanitize(@statement, 1, 2)
+          }.to raise_error(subject::InvalidBindVariableError)
+        end
+      end
+    end
+
+    describe 'when there are placeholders in the query' do
+      describe 'and too few variables are given' do
+        it 'throws InvalidBindVariableError' do
+          expect {
+            subject.sanitize('?')
+          }.to raise_error(subject::InvalidBindVariableError)
+
+          expect {
+            subject.sanitize('? ?', 1)
+          }.to raise_error(subject::InvalidBindVariableError)
+        end
+      end
+
+      describe 'and too many variables are given' do
+        it 'throws InvalidBindVariableError' do
+          expect {
+            subject.sanitize('? ?', 1, 2, 3)
+          }.to raise_error(subject::InvalidBindVariableError)
+        end
+      end
+
+      it 'replaces placeholders with the correct variable' do
+        subject.sanitize('? ?', 1, 2.1).should == '1 2.1'
+      end
+
+      it 'quotes strings' do
+        subject.sanitize('?', 'string').should == "'string'"
+      end
+
+      it 'escapes single quotes' do
+        subject.sanitize('?', "a'b").should == "'a''b'"
+      end
+
+      it 'converts dates' do
+        subject.sanitize('?', Date.new(2013, 3, 26))
+          .should == "'2013-03-26'"
+      end
+
+      it 'converts times' do
+        subject.sanitize('?', Time.new(2013, 3, 26, 23, 1, 2.544, 0))
+          .should == 1364338862544.to_s
+      end
+
+      it 'converts DateTime instances as a time' do
+        subject.sanitize('?', DateTime.new(2013, 3, 26, 23, 1, 2.544, 0))
+          .should == 1364338862544.to_s
+      end
+
+      it 'converts Cql::Uuid to a bare string representation' do
+        subject.sanitize('?', Cql::Uuid.new(2**127 - 1))
+          .should == "7fffffff-ffff-ffff-ffff-ffffffffffff"
+      end
+
+      it 'converts SimpleUUID::UUID to a bare string representation' do
+        subject.sanitize('?', SimpleUUID::UUID.new(2**127 - 1))
+          .should == "7fffffff-ffff-ffff-ffff-ffffffffffff"
+      end
+
+      it 'converts binary strings into a hex blob' do
+        subject.sanitize('?', [1,2,3,4].pack('C*'))
+          .should == "0x01020304"
+      end
+
+      it 'joins elements of an array with a comma separator' do
+        subject.sanitize('?', [1,2,3]).should == '1,2,3'
+      end
+
+      it 'joins key/value pairs of a hash with colon and comma separators' do
+        subject.sanitize('?', {a: 1, b: 'z'}).should == "'a':1,'b':'z'"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'simplecov'; SimpleCov.start
+require 'ciql'
+
+class FakeReactor
+  def start
+    Cql::Future.completed([])
+  end
+
+  def add_connection(host, port)
+    Cql::Future.completed(1)
+  end
+
+  def queue_request(request, connection_id = nil)
+    Cql::Future.completed(nil)
+  end
+
+  def stop
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ciql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Bradford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cql-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre8
+- !ruby/object:Gem::Dependency
+  name: simple_uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: A CQL-based Cassandra client for Ruby
+email:
+- justin@nulu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ciql/client.rb
+- lib/ciql/configuration.rb
+- lib/ciql/sanitize.rb
+- lib/ciql/version.rb
+- lib/ciql.rb
+- README.md
+- spec/ciql/client_spec.rb
+- spec/ciql/configuration_spec.rb
+- spec/ciql/sanitize_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nulu/ciql
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: CQL Cassandra client for Ruby
+test_files:
+- spec/ciql/client_spec.rb
+- spec/ciql/configuration_spec.rb
+- spec/ciql/sanitize_spec.rb
+- spec/spec_helper.rb