cassandra-cql 1.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+pkg/*
+*.gem
+.bundle
+coverage
+.DS_Store
+.rspec-tm
+doc
+Gemfile.lock
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in cassandra-cql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+

data/README.rdoc

@@ -0,0 +1,78 @@
+=Cassandra
+The Apache Cassandra Project (http://cassandra.apache.org) develops a highly scalable second-generation distributed database, bringing together Dynamo's fully distributed design and Bigtable's ColumnFamily-based data model.
+
+=CQL
+Cassandra originally went with a Thrift RPC-based API as a way to provide a common denominator that more idiomatic clients could build upon independently.
+However, this worked poorly in practice: raw Thrift is too low-level to use productively, and keeping pace with new API methods to support (for example) indexes in 0.7 or distributed counters in 0.8 is too much for many maintainers.
+
+CQL, the Cassandra Query Language, addresses this by pushing all implementation details to the server; all the client has to know for any operation is how to interpret "resultset" objects.
+So adding a feature like counters just requires teaching the CQL parser to understand "column + N" notation; no client-side changes are necessary.
+
+(CQL Specification: https://github.com/apache/cassandra/blob/trunk/doc/cql/CQL.textile)
+
+=Quick Start
+
+==Establishing a connection
+
+  # Defaults to the system keyspace
+  db = CassandraCQL::Database.new('127.0.0.1:9160')
+  
+  # Specifying a keyspace
+  db = CassandraCQL::Database.new('127.0.0.1:9160', {:keyspace => 'keyspace1'})
+  
+  # Specifying more than one seed node
+  db = CassandraCQL::Database.new(['127.0.0.1:9160','127.0.0.2:9160'])
+  
+==Creating a Keyspace
+
+  # Creating a simple keyspace with replication factor 1
+  db.execute("CREATE KEYSPACE keyspace1 WITH strategy_class='org.apache.cassandra.locator.SimpleStrategy' AND strategy_options:replication_factor=1")
+  db.execute("USE keyspace1")
+
+==Creating a Column Family
+
+  # Creating a column family with a single validated column
+  db.execute("CREATE COLUMNFAMILY users (id varchar PRIMARY KEY, email varchar)")
+
+  # Create an index on the name
+  db.execute("CREATE INDEX users_email_idx ON users (email)")
+
+==Inserting into a Column Family
+
+  # Insert without bound variables
+  db.execute("INSERT INTO users (id, email) VALUES ('kreynolds', 'kelley@insidesystems.net')")
+  
+  # Insert with bound variables
+  db.execute("INSERT INTO users (id, email) VALUES (?, ?)", 'kway', 'kevin@insidesystems.net')
+  
+==Updating a Column Family
+
+  # Update
+  db.execute("UPDATE users SET email=? WHERE id=?", 'kreynolds@insidesystems.net', 'kreynolds')
+  
+==Selecting from a Column Family
+
+  # Select all
+  db.execute("SELECT * FROM users").fetch { |row| puts row.to_hash.inspect }
+    {"id"=>"kway", "email"=>"kevin@insidesystems.net"}
+    {"id"=>"kreynolds", "email"=>"kreynolds@insidesystems.net"}
+  
+  # Select just one user by id
+  db.execute("SELECT * FROM users WHERE id=?", 'kreynolds').fetch { |row| puts row.to_hash.inspect }
+    {"id"=>"kreynolds", "email"=>"kreynolds@insidesystems.net"}
+
+  # Select just one user by indexed column
+  db.execute("SELECT * FROM users WHERE email=?", 'kreynolds@insidesystems.net').fetch { |row| puts row.to_hash.inspect }
+    {"id"=>"kreynolds", "email"=>"kreynolds@insidesystems.net"}
+  
+==Deleting from a Column Family
+
+  # Delete the swarthy bastard Kevin
+  db.execute("DELETE FROM users WHERE id=?", 'kway')
+  
+=TODO
+
+  1. Make bind_var usage friendlier
+  2. Determine if returning Time objects for TimeUUID is appropriate in all cases and if not, add an option
+  3. Add yardoc
+  4. Add spec for database

data/Rakefile

@@ -0,0 +1,150 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+CassandraBinaries = {
+  '0.8' => 'http://archive.apache.org/dist/cassandra/0.8.4/apache-cassandra-0.8.4-bin.tar.gz',
+  '1.0' => 'http://archive.apache.org/dist/cassandra/1.0.1/apache-cassandra-1.0.1-bin.tar.gz',
+}
+
+CASSANDRA_VERSION = ENV['CASSANDRA_VERSION'] || '1.0'
+CASSANDRA_HOME = File.dirname(__FILE__) + '/tmp'
+CASSANDRA_PIDFILE = ENV['CASSANDRA_PIDFILE'] || "#{CASSANDRA_HOME}/cassandra.pid"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rcov = true
+  spec.rcov_opts = "--exclude 'spec/*'"
+end
+
+desc "Download Cassandra and run specs against it"
+task :spec_with_server do
+  Rake::Task["cassandra:clean"].invoke
+  Rake::Task["cassandra:start"].invoke
+  error = nil
+  begin
+    Rake::Task["spec"].invoke
+  rescue
+    error = $!
+  end
+  Rake::Task["cassandra:stop"].invoke
+  raise $! if $!
+end
+
+task :default => :spec
+
+def setup_cassandra_version(version = CASSANDRA_VERSION)
+  FileUtils.mkdir_p CASSANDRA_HOME
+
+  destination_directory = File.join(CASSANDRA_HOME, 'cassandra-' + CASSANDRA_VERSION)
+
+  unless File.exists?(File.join(destination_directory, 'bin','cassandra'))
+    download_source       = CassandraBinaries[CASSANDRA_VERSION]
+    download_destination  = File.join(CASSANDRA_HOME, File.basename(download_source))
+    untar_directory       = File.join(CASSANDRA_HOME,  File.basename(download_source,'-bin.tar.gz'))
+
+    puts "downloading cassandra"
+    sh "curl -L -o #{download_destination} #{download_source}"
+
+    sh "tar xzf #{download_destination} -C #{CASSANDRA_HOME}"
+    sh "mv #{untar_directory} #{destination_directory}"
+  end
+end
+
+def setup_environment
+  env = ""
+  if !ENV["CASSANDRA_INCLUDE"]
+    env << "CASSANDRA_INCLUDE=#{File.expand_path(Dir.pwd)}/spec/conf/#{CASSANDRA_VERSION}/cassandra.in.sh "
+    env << "CASSANDRA_HOME=#{CASSANDRA_HOME}/cassandra-#{CASSANDRA_VERSION} "
+    env << "CASSANDRA_CONF=#{File.expand_path(Dir.pwd)}/spec/conf/#{CASSANDRA_VERSION}"
+  else
+    env << "CASSANDRA_INCLUDE=#{ENV['CASSANDRA_INCLUDE']} "
+    env << "CASSANDRA_HOME=#{ENV['CASSANDRA_HOME']} "
+    env << "CASSANDRA_CONF=#{ENV['CASSANDRA_CONF']}"
+  end
+
+  env
+end
+
+def running?(pid_file = nil)
+  pid_file ||= CASSANDRA_PIDFILE
+
+  if File.exists?(pid_file)
+    pid = File.new(pid_file).read.to_i
+    begin
+      Process.kill(0, pid)
+      return true
+    rescue
+      File.delete(pid_file)
+    end
+  end
+
+  false
+end
+
+namespace :cassandra do
+  desc "Start Cassandra"
+  task :start, [:daemonize] => :java do |t, args|
+    args.with_defaults(:daemonize => true)
+
+    setup_cassandra_version
+
+    env = setup_environment
+
+    Dir.chdir(File.join(CASSANDRA_HOME, "cassandra-#{CASSANDRA_VERSION}")) do
+      sh("env #{env} bin/cassandra #{'-f' unless args.daemonize} -p #{CASSANDRA_PIDFILE}")
+    end
+    $stdout.puts "Sleeping for 8 seconds to wait for Cassandra to start ..."
+    sleep(8)
+  end
+
+  desc "Stop Cassandra"
+  task :stop => :java do
+    setup_cassandra_version
+    env = setup_environment
+    sh("kill $(cat #{CASSANDRA_PIDFILE})")
+  end
+  
+  desc "Delete all data files in #{CASSANDRA_HOME}"
+  task :clean do
+    sh("rm -rf #{File.join(CASSANDRA_HOME, "cassandra-#{CASSANDRA_VERSION}", 'data')}")
+  end
+  
+end
+
+desc "Start Cassandra"
+task :cassandra => :java do
+  begin
+    Rake::Task["cassandra:start"].invoke(false)
+  rescue RuntimeError => e
+    raise e unless e.message =~ /Command failed with status \(130\)/ # handle keyboard interupt errors
+  end
+end
+
+desc "Run the Cassandra CLI"
+task :cli do
+  Dir.chdir(File.join(CASSANDRA_HOME, "cassandra-#{CASSANDRA_VERSION}")) do
+    sh("bin/cassandra-cli -host localhost -port 9160")
+  end
+end
+
+desc "Check Java version"
+task :java do
+  unless `java -version 2>&1`.split("\n").first =~ /java version "1.6/ #"
+    puts "You need to configure your environment for Java 1.6."
+    puts "If you're on OS X, just export the following environment variables:"
+    puts '  JAVA_HOME="/System/Library/Frameworks/JavaVM.framework/Versions/1.6/Home"'
+    puts '  PATH="/System/Library/Frameworks/JavaVM.framework/Versions/1.6/Home/bin:$PATH"'
+    exit(1)
+  end
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/cassandra-cql.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/cassandra-cql/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "cassandra-cql"
+  s.version     = CassandraCQL::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kelley Reynolds"]
+  s.email       = ["kelley@insidesystems.net"]
+  s.homepage    = "http://code.google.com/a/apache-extras.org/p/cassandra-ruby/"
+  s.summary     = "CQL Interface to Cassandra"
+  s.description = "CQL Interface to Cassandra"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "cassandra-cql"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rcov", ">= 0.9.9"
+  s.add_development_dependency "rspec", ">= 2.6.0"
+  s.add_development_dependency "rake", ">= 0.9.2"
+  s.add_development_dependency "yard", ">= 0.7.2"
+  s.add_dependency "simple_uuid", ">= 0.2.0"
+  s.add_dependency "thrift_client", ">= 0.7.1"
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {spec}/*`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end