cassandra_record 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99918f8fbbb1d222dea67d9eea38e577f4eac03f
-  data.tar.gz: ebea7d93413a497267341b6aa2cf8a791295ff17
+  metadata.gz: 3f7f7196553b6334084a1b9cbdc32fcc741c7234
+  data.tar.gz: 0d387f3cbb15897d9f585c52d722a4fe31dd124b
 SHA512:
-  metadata.gz: 00ff11ffd3d543b8067417bf4db87a35983f37240113a903cd452c12c1d76360576e49df96632051ec6d2b8d4edef6d26416ee9abc2a2237617a9e478b9c08ec
-  data.tar.gz: 87bdf5aea30cac22b1f64dc96b632015877c57948b3527b6f4dbefb4f0c152723d5d6b62df59626fd06ff6738ddd5113482965a5b813b9b1b6e218993d7c8d8a
+  metadata.gz: c1b89fe70793c22999b40a738ef9ba09b868ffcd6fc91ea1099384a90de9214d5288068d83499a37aa5df73eb056626ab1c8cf1d4df43110eb8e40fe53b152e8
+  data.tar.gz: 0a28d9c85a751abbafb5642495bf751fca95e8beeb2a154bfb9399bc53067eec0e946bbefa0edd6113467160cadc6ef57c23d9f08ad35d57457dfc4d5ca1a410

data/Gemfile

@@ -12,7 +12,3 @@ group :development, :test do
   gem 'pry-byebug'
   gem 'pry-doc'
 end
-
-
-gem 'activesupport'
-gem 'cassandra-driver'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cassandra_record (0.0.5)
+    cassandra_record (0.1.0)
       activesupport
       cassandra-driver
 
@@ -17,8 +17,8 @@ GEM
     byebug (2.7.0)
       columnize (~> 0.3)
       debugger-linecache (~> 1.2)
-    cassandra-driver (1.0.0.rc.1)
-      ione (~> 1.2.0.pre9)
+    cassandra-driver (2.1.0)
+      ione (~> 1.2)
     coderay (1.1.0)
     columnize (0.8.9)
     debugger-linecache (1.2.0)
@@ -61,9 +61,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
   bundler (~> 1.7)
-  cassandra-driver
   cassandra_record!
   pry
   pry-byebug

data/README.md

@@ -4,20 +4,70 @@
 
 Add this line to your application's Gemfile:
 
-```ruby
+```bash
 gem 'cassandra_record'
 ```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install cassandra_record
+```bash
+$ gem install cassandra_record
+```
 
 ## Usage
 
+CassandraRecord models are based on the following Cassandra table:
+
+```sql
+CREATE TABLE thingies (
+  id int,
+  name text,
+  PRIMARY KEY (id)
+);
+```
+
+__A simple Cassandra-backed model__
+
+Define the model by inheriting from CassandraRecord::Base. ...and you're done. ...you're welcome
+
+```ruby
+class Thingy < CassandraRecord::Base
+end
+
+# record creation
+Thingy.create(id: 123, name: 'pizza')
+
+# record retrieval and attribute access
+my_thingy = Thingy.where(id: 123)
+my_thingy.name   # => pizza
+```
+
+__A model with creation options__
+
+Override the instance-level #create method.
+Overriding the instance-level #create method will apply the configured options to all created records. 
+
+```ruby
+class Thingy < CassandraRecord::Base
+  TTL = 3600 # one hour
+
+  def create
+    options = { ttl: TTL }
+    super(options)
+  end
+end
+
+# record creation
+# this record will auto-expire in 1 hour.
+Thingy.create(id: 123, name: 'spaghetti')    
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/zephyr-dev/cassandra_record/fork )
@@ -25,3 +75,5 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+

data/lib/cassandra_record.rb

@@ -5,4 +5,7 @@ require 'cassandra_record/statement'
 require 'cassandra_record/database/adapters/cassandra'
 
 module CassandraRecord
+  Base.configure do |configuration|
+    configuration.database_adapter = Database::Adapters::Cassandra.instance
+  end
 end

data/lib/cassandra_record/base.rb

@@ -9,9 +9,28 @@ module CassandraRecord
         new(attributes).create
       end
 
+      def batch_create(array_of_attributes, options={})
+        batch = configuration.database_adapter.session.batch do |batch|
+          array_of_attributes.map do |attr|
+            batch.add(new(attr).send(:insert_statement, attr, options), attr.values)
+          end
+        end
+
+        configuration.database_adapter.session.execute(batch)
+        array_of_attributes.map { |attr| new(attr) }
+      end
+
       def where(attributes={})
         new.where(attributes)
       end
+
+      def configure
+        yield configuration
+      end
+
+      def configuration
+        @@configuration ||= Configuration.new
+      end
     end
 
     attr_accessor :attributes
@@ -21,28 +40,36 @@ module CassandraRecord
     end
 
     def where(options={})
-      results = Statement.where(table_name, options).map do |attributes|
+      db.execute(where_statement(options)).map do |attributes|
         self.class.new(attributes)
       end
     end
 
-    def create
-      Statement.create(table_name, columns, values)
+    def create(options={})
+      db.execute(insert_statement(attributes, options), *attributes.values)
       self
     end
 
     private
 
-    def table_name
-      ActiveSupport::Inflector.tableize(self.class.name).gsub(/\//, '_')
+    def db
+      self.class.configuration.database_adapter
     end
 
-    def columns
-      attributes.keys
+    def where_statement(options={})
+      Statement.where(table_name, options)
     end
 
-    def values
-      attributes.values
+    def insert_statement(attributes, options={})
+      @insert_statement ||= db.prepare(insert_cql(attributes, options))
+    end
+
+    def insert_cql(attributes, options={})
+      Statement.create(table_name, attributes.keys, attributes.values, options)
+    end
+
+    def table_name
+      ActiveSupport::Inflector.tableize(self.class.name).gsub(/\//, '_')
     end
 
     def method_missing(method, *args, &block)
@@ -53,5 +80,13 @@ module CassandraRecord
       end
     end
 
+    class Configuration
+      attr_accessor :database_adapter
+
+      def initialize(adapter=Database::Adapters::Cassandra.instance)
+        adapter
+      end
+    end
+
   end
 end

data/lib/cassandra_record/database/adapters/cassandra.rb

@@ -16,11 +16,15 @@ module CassandraRecord
         end
 
         def prepare(cql)
-          session.prepare(cql)
+          rescue_with_reset_and_retry do
+            session.prepare(cql)
+          end
         end
 
         def execute(cql, *args)
-          session.execute(cql, *args)
+          rescue_with_reset_and_retry do
+            session.execute(cql, arguments: args)
+          end
         end
 
         def cluster
@@ -38,6 +42,27 @@ module CassandraRecord
 
         private
 
+        MAX_RETRIES = 4
+
+        def rescue_with_reset_and_retry
+          retry_count = 0
+          begin
+            yield
+          rescue ::Cassandra::Error
+            if (retry_count += 1) < MAX_RETRIES
+              reset_session
+              sleep(0.5)
+              retry
+            else
+              raise
+            end
+          end
+        end
+
+        def reset_session
+          @session = nil
+        end
+
         def cluster_connection
           ::Cassandra.cluster(connection_configuration.symbolize_keys)
         end

data/lib/cassandra_record/statement.rb

@@ -5,28 +5,28 @@ module CassandraRecord
         cql = base_where_query(table_name)
 
         if options.present?
-          cql << 'WHERE'
+          cql << 'WHERE '
           cql << parse_where_clause_options(options)
         end
 
         cql << ';'
-        db.execute(cql)
       end
 
-      def create(table_name, columns, values)
+      def create(table_name, columns, values, options={})
         cql = <<-CQL
 INSERT INTO #{table_name} (#{columns.join(", ")})
 VALUES (#{value_placeholders(values).join(", ")})
         CQL
 
-        insert_statement = db.prepare(cql)
-        db.execute(insert_statement, *values)
+        cql.tap do |statement|
+          statement << ttl(options[:ttl]) if options.has_key?(:ttl)
+        end
       end
 
       private
 
-      def db
-        Database::Adapters::Cassandra.instance
+      def ttl(secs)
+        "USING TTL #{secs}"
       end
 
       def value_placeholders(values)

data/lib/cassandra_record/version.rb

@@ -1,3 +1,3 @@
 module CassandraRecord
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/integration/cassandra_record/base_spec.rb

@@ -4,6 +4,12 @@ describe CassandraRecord::Base do
   let(:db) { RSpec.configuration.db }
   let(:keyspace)  { RSpec.configuration.keyspace }
 
+  before do
+    CassandraRecord::Base.configure do |configuration|
+      configuration.database_adapter = ::CassandraRecord::Database::Adapters::Cassandra.instance
+    end
+  end
+
   class TestRecord < CassandraRecord::Base; end
 
   describe ".create" do
@@ -18,8 +24,8 @@ describe CassandraRecord::Base do
       record = TestRecord.create(id: 99, name: 'turkey')
 
       select = <<-CQL
-        SELECT * from #{keyspace}.test_records
-        WHERE id = 99;
+      SELECT * from #{keyspace}.test_records
+      WHERE id = 99;
       CQL
 
       results = db.execute(select)
@@ -29,6 +35,72 @@ describe CassandraRecord::Base do
       expect(result['id']).to eq(99)
       expect(result['name']).to eq('turkey')
     end
+
+    context "with TTL options" do
+      class TestRecord < CassandraRecord::Base
+        def create
+          options = { ttl: 1 }
+          super(options)
+        end
+      end
+
+      it "persists a record" do
+        TestRecord.create(id: 300, name: 'I\'m going away')
+
+        select = <<-CQL
+        SELECT * from #{keyspace}.test_records
+        WHERE id = 300;
+        CQL
+
+        results = db.execute(select)
+        expect(results.count).to eq(1)
+
+        # sucky, but we need to wait for Cassandra
+        # to remove the record to assert the TTL is working
+        sleep 1
+
+        results = db.execute(select)
+        expect(results.count).to eq(0)
+      end
+    end
+  end
+
+  describe ".batch_create" do
+    context "with TTL options" do
+      it "persists a record" do
+        TestRecord.batch_create([{ id: 99, name: 'turkey' }, { id: 100, name: 'buffalo' }], ttl: 1)
+
+        select = <<-CQL
+        SELECT * from #{keyspace}.test_records
+        CQL
+
+        results = db.execute(select)
+        expect(results.count).to eq 2
+
+        sleep 2
+
+        results = db.execute(select)
+        expect(results.count).to eq 0
+      end
+    end
+
+    it "returns an array of the records it created" do
+      records = TestRecord.batch_create([{ id: 99, name: 'turkey' }, { id: 100, name: 'buffalo' }])
+      expect(records.first.name).to eq "turkey"
+      expect(records.last.name).to eq "buffalo"
+    end
+
+    it "persists the records" do
+      TestRecord.batch_create([{ id: 99, name: 'turkey' }, { id: 100, name: 'buffalo' }])
+
+      select = <<-CQL
+      SELECT * from #{keyspace}.test_records
+      CQL
+
+      results = db.execute(select)
+      expect(results.count).to eq 2
+      expect(results.first['id']).to eq 99
+    end
   end
 
   describe ".where" do
@@ -72,4 +144,34 @@ describe CassandraRecord::Base do
     end
   end
 
+  describe "configuring the database adapter" do
+    let(:some_adapter) { double(:some_adapter) }
+
+    before do
+      allow(some_adapter).to receive(:execute) { [] }
+
+      CassandraRecord::Base.configure do |configuration|
+        configuration.database_adapter = some_adapter
+      end
+    end
+
+    context ".create" do
+      before do
+        allow(some_adapter).to receive(:prepare)
+      end
+
+      it "uses the configured database adapter" do
+        TestRecord.create(name: 'things')
+        expect(some_adapter).to have_received(:prepare)
+        expect(some_adapter).to have_received(:execute)
+      end
+    end
+
+    context ".where" do
+      it "uses the configured database adapter" do
+        TestRecord.where(name: 'things')
+        expect(some_adapter).to have_received(:execute)
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -16,8 +16,9 @@ RSpec.configure do |config|
   db = CassandraRecord::Database::Adapters::Cassandra.instance
 
   config.add_setting :db
-  config.db = db
   config.add_setting :keyspace
+
+  config.db = db
   config.keyspace = 'test_space'  # CassandraRecord::Database::Adapters::Cassandra.instance.keyspace
 
   create_keyspace = <<-CQL

data/spec/unit/cassandra_record/database/adapters/cassandra_spec.rb

@@ -3,6 +3,15 @@ require 'spec_helper'
 describe CassandraRecord::Database::Adapters::Cassandra do
   subject(:adapter) { CassandraRecord::Database::Adapters::Cassandra.instance }
 
+  before do
+    adapter.use(RSpec.configuration.keyspace)
+  end
+
+  after do
+    # reset the singleton's @session
+    adapter.use(RSpec.configuration.keyspace)
+  end
+
   describe "#configuration" do
     before do
       adapter.configuration do |config|
@@ -15,4 +24,41 @@ describe CassandraRecord::Database::Adapters::Cassandra do
     specify { expect(adapter.configuration[:other_thing]).to eq('other_stuff') }
   end
 
+  describe "connection retries" do
+    let(:cluster_connection) { double(:cluster_connection) }
+    let(:session) { double(:session) }
+    let(:retry_count) { CassandraRecord::Database::Adapters::Cassandra::MAX_RETRIES }
+
+    before do
+      allow(Cassandra).to receive(:cluster) { cluster_connection }
+      allow(cluster_connection).to receive(:connect) { session }
+    end
+
+    context "#prepare" do
+      before do
+        allow(session).to receive(:prepare).and_raise Cassandra::Errors::ClientError
+      end
+
+      it "retries the expected number of times" do
+        expect(session).to receive(:prepare).exactly(retry_count).times
+        expect {
+          adapter.prepare('some bogus commit statement')
+        }.to raise_error(Cassandra::Errors::ClientError)
+      end
+    end
+
+    context "#execute" do
+      before do
+        allow(session).to receive(:execute).and_raise Cassandra::Errors::ClientError
+      end
+
+      it "retries the expected number of times" do
+        expect(session).to receive(:execute).exactly(retry_count).times
+        expect {
+          adapter.execute('some bogus commit statement')
+        }.to raise_error(Cassandra::Errors::ClientError)
+      end
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cassandra_record
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Gust
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler