whi-cassie 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3ebdf5f386202ccb62aa4e9f4c10599111f18f6
-  data.tar.gz: 15e6f8b61b24160a946f5fd521b0f20bfc258366
+  metadata.gz: ed90a287c5693223a52bedf3d65cf4cdccf8d9c5
+  data.tar.gz: 53f2742d6789dcbabaff098831214b1535367f8d
 SHA512:
-  metadata.gz: 8d8e4275b346070a0549d52a782d3a0c403cf13c3b3d7e332469d6fa93b2335ce368e3243b2dce4b9dc49ac339bff3c7d3172095ad39298752b3eaf8808fa462
-  data.tar.gz: f6a73b42ef8301d095b9fa2a6910169cbfb7b42fd9b0fc1d1584c5a959b5350a1829893843179b0b8ab09116591157493778e485d544d5d39ae41c4846c9228b
+  metadata.gz: 41a9270e5b4a88ba2ae253d0fc2e4662424ba0a7b899d0869922f8d7b4c8bbd54ba32df2a35bcaaf5e8ffa3fb36d6378df6794cd8a08d613f65508df3dff1df3
+  data.tar.gz: 6e83ad281fad4ea6a41925339e4c531e91d93314402ef6ff4aa87ea0c0df6929e304384a39b7f374642983012f7b8aee76e3e31f8ffbcfe9e44560f25ed3eb31

data/HISTORY.md

@@ -0,0 +1,41 @@
+## 1.1.0
+
+* Bump supported version of cassandra-driver to 3.x.
+
+* Add more control over consistency settings.
+
+* Add read and write consistency on model definitions.
+
+## 1.0.7
+
+* Add find_subscribers to Cassie::Model for instrumenting model find calls.
+
+## 1.0.6
+
+* Wrap raw CQL in a Simple statement for code consistency in subscribers.
+
+## 1.0.5
+
+* Add subscribers for instumenting code.
+
+* Remove hardcoded log warnings for long running statements since this can now be better handled with instrumentation.
+
+## 1.0.4
+
+* Set less cryptic error message for invalid records exceptions.
+
+## 1.0.3
+
+* Fix bugs preventing counter and set data types from working on models.
+
+## 1.0.2
+
+* Set cluster logger on the Cassandra cluster if not already set.
+
+## 1.0.1
+
+* Allow finding the offset to the row from a range.
+
+## 1.0.0
+
+* Initial Release

data/README.md

@@ -83,7 +83,17 @@ You can use all the standard ActiveModel validation methods on your models. You
 Note that one difference between Cassandra and other data stores is that data is only eventually consistent. Some subtle results of this:
 
 1. You won't get an error if you try to create a record with the same primary key twice. Cassandra will simple use the second insert as an update statement.
-2. If you perform any queries in your validation logic (e.g. to ensure a value is unique), you really need to use a high consistency level like quorum. If you use a low consistency level, there is a chance that your query can hit a node in the cluster that hasn't been replicated to and your validation could make decisions based on the wrong data. You can control the consistency level on most of the query methods or you can use `Cassie.consistency` to set a default consistency within a block.
+2. If you perform any queries in your validation logic (e.g. to ensure a value is unique), you really need to use a high consistency level like quorum. If you use a low consistency level, there is a chance that your query can hit a node in the cluster that hasn't been replicated to and your validation could make decisions based on the wrong data.
+
+### Consistency
+
+You can specify the consistency for the connection when it is created in the options. This will default to `:local_one`. You can override the global consistency at runtime by setting a new consistency on the instance `Cassie.instance.consistency = :local_quorum`. This will be the default consistency used if nothing else specifies a consistency.
+
+You can override the default consistency within a block by using the `Cassie.consistency` method. This method will set the default consistency within a block and can be used in instances where you want to force a specific consistency on all queries within a specific scope.
+
+Finally, you can force a specific consistency by specifying `:consistency` in the options to any of the statements that execute a query. This consistency will override any default consistency you've specified. However, if the statement is a write statement and is wrapped in a batch block, the consistency option will have no effect. You can, though, specify the `:consistency` option in the `batch` call to apply a consistency to all statements in the batch.
+
+In `Cassie::Model` classes, you can specify `read_consistency` and `write_consistency` that will be applied to all statements generated by the model. You could use this, for instance, to force all write operations to use `:quorum` while letting all read operations user `:one`. These consistency levels will override any default levels if they are set.
 
 ### Prepared statements
 

data/VERSION

@@ -1 +1 @@
-1.0.7
+1.1.0

data/lib/cassie/model.rb

@@ -48,6 +48,8 @@ module Cassie::Model
     class_attribute :_ordering_keys, :instance_reader => false, :instance_writer => false
     class_attribute :_counter_table, :instance_reader => false, :instance_writer => false
     class_attribute :find_subscribers, :instance_reader => false, :instance_writer => false
+    class_attribute :read_consistency, :instance_reader => false, :instance_writer => false
+    class_attribute :write_consistency
     define_model_callbacks :create, :update, :save, :destroy
     self._columns = {}
     self._column_aliases = HashWithIndifferentAccess.new
@@ -98,8 +100,11 @@ module Cassie::Model
     def column(name, type, as: nil)
       name = name.to_sym
       type_class = nil
+      type_name = type.to_s.downcase.classify
+      # Backward compatibility with older driver versions.
+      type_name = "Text" if type_name == "Varchar"
       begin
-        type_class = "Cassandra::Types::#{type.to_s.downcase.classify}".constantize
+        type_class = "Cassandra::Types::#{type_name}".constantize
       rescue NameError
         raise ArgumentError.new("#{type.inspect} is not an allowed Cassandra type")
       end
@@ -231,7 +236,7 @@ module Cassie::Model
         values << Integer(limit)
       end
     
-      results = connection.find(cql, values, options)
+      results = connection.find(cql, values, consistency_options(read_consistency, options))
       records = [] unless block_given?
       row_count = 0
       loop do
@@ -294,7 +299,7 @@ module Cassie::Model
         where = connection.prepare(cql)
       end
       
-      results = connection.find(cql, values, options)
+      results = connection.find(cql, values, consistency_options(read_consistency, options))
       results.rows.first["count"]
     end
     
@@ -321,13 +326,15 @@ module Cassie::Model
       key_hash.each do |name, value|
         cleanup_up_hash[column_name(name)] = value
       end
-      connection.delete(full_table_name, cleanup_up_hash)
+      connection.delete(full_table_name, cleanup_up_hash, :consistency => write_consistency)
     end
     
     # All insert, update, and delete calls within the block will be sent as a single
-    # batch to Cassandra.
-    def batch
-      connection.batch do
+    # batch to Cassandra. The consistency level will default to the write consistency
+    # level if it's been set.
+    def batch(options = nil)
+      options = consistency_options(write_consistency, options)
+      connection.batch(options) do
         yield
       end
     end
@@ -448,6 +455,19 @@ module Cassie::Model
         type_class.new(value)
       end
     end
+    
+    def consistency_options(consistency, options)
+      if consistency
+        if options
+          options = options.merge(:consistency => consistency) if options[:consistency].nil?
+          options
+        else
+          {:consistency => consistency}
+        end
+      else
+        options
+      end
+    end
   end
   
   def initialize(attributes = {})
@@ -473,13 +493,14 @@ module Cassie::Model
     valid_record = (validate ? valid? : true)
     if valid_record
       run_callbacks(:save) do
+        options = {:consistency => write_consistency, :ttl => (ttl || persistence_ttl)}
         if persisted?
           run_callbacks(:update) do
-            self.class.connection.update(self.class.full_table_name, values_hash, key_hash, :ttl => (ttl || persistence_ttl))
+            self.class.connection.update(self.class.full_table_name, values_hash, key_hash, options)
           end
         else
           run_callbacks(:create) do
-            self.class.connection.insert(self.class.full_table_name, attributes, :ttl => (ttl || persistence_ttl))
+            self.class.connection.insert(self.class.full_table_name, attributes, options)
             @persisted = true
           end
         end
@@ -492,8 +513,8 @@ module Cassie::Model
   
   # Save a record. Returns true if the record was saved and raises an ActiveRecord::RecordInvalid
   # error if the record is invalid.
-  def save!
-    if save
+  def save!(ttl: nil)
+    if save(ttl: ttl)
       true
     else
       raise Cassie::RecordInvalid.new(self)
@@ -503,7 +524,7 @@ module Cassie::Model
   # Delete a record and call the destroy callbacks.
   def destroy
     run_callbacks(:destroy) do
-      self.class.connection.delete(self.class.full_table_name, key_hash)
+      self.class.connection.delete(self.class.full_table_name, key_hash, :consistency => write_consistency)
       @persisted = false
       true
     end
@@ -548,7 +569,8 @@ module Cassie::Model
     if amount != 0
       run_callbacks(:update) do
         adjustment = (amount < 0 ? "#{name} = #{name} - #{amount.abs}" : "#{name} = #{name} + #{amount}")
-        self.class.connection.update(self.class.full_table_name, adjustment, key_hash, :ttl => (ttl || persistence_ttl))
+        options = {:consistency => write_consistency, :ttl => (ttl || persistence_ttl)}
+        self.class.connection.update(self.class.full_table_name, adjustment, key_hash, options)
       end
     end
     record = self.class.find(key_hash)

data/lib/cassie.rb

@@ -36,6 +36,7 @@ class Cassie
   end
   
   attr_reader :config, :subscribers
+  attr_accessor :consistency
   
   class << self
     # A singleton instance that can be shared to communicate with a Cassandra cluster.
@@ -90,6 +91,7 @@ class Cassie
     @prepared_statements = {}
     @last_prepare_warning = Time.now
     @subscribers = Subscribers.new
+    @consistency = ((config.cluster || {})[:consistency] || :local_one)
   end
   
   # Open a connection to the Cassandra cluster.
@@ -180,7 +182,7 @@ class Cassie
               batch_statement.add(statement)
             end
           end
-          execute(batch_statement)
+          execute(batch_statement, nil, options)
         end
       ensure
         Thread.current[:cassie_batch] = nil
@@ -215,10 +217,13 @@ class Cassie
     end
     cql = "INSERT INTO #{table} (#{columns.join(', ')}) VALUES (#{question_marks(columns.size)})"
     
-    ttl = options[:ttl] if options
-    if ttl
-      cql << " USING TTL ?"
-      values << ttl
+    if options && options.include?(:ttl)
+      options = options.dup
+      ttl = options.delete(:ttl)
+      if ttl
+        cql << " USING TTL ?"
+        values << Integer(ttl)
+      end
     end
     
     batch_or_execute(cql, values, options)
@@ -245,11 +250,16 @@ class Cassie
     values = update_values + key_values
     
     cql = "UPDATE #{table}"
-    ttl = options[:ttl] if options
-    if ttl
-      cql << " USING TTL ?"
-      values.unshift(ttl)
+    
+    if options && options.include?(:ttl)
+      options = options.dup
+      ttl = options.delete(:ttl)
+      if ttl
+        cql << " USING TTL ?"
+        values.unshift(Integer(ttl))
+      end
     end
+
     cql << " SET #{update_cql.join(', ')} WHERE #{key_cql}"
     
     batch_or_execute(cql, values, options)
@@ -287,9 +297,13 @@ class Cassie
       end
     
       # Set a default consistency from a block context if it isn't explicitly set.
-      default_consistency = Thread.current[:cassie_consistency]
-      if default_consistency
-        options = (options ? options.reverse_merge(:consistency => default_consistency) : {:consistency => default_consistency})
+      statement_consistency = current_consistency
+      if statement_consistency
+        if options
+          options = options.merge(:consistency => statement_consistency) if options[:consistency].nil?
+        else
+          options = {:consistency => statement_consistency}
+        end
       end
       
       session.execute(statement, options || {})
@@ -303,6 +317,11 @@ class Cassie
       end
     end
   end
+  
+  # Return the current consistency level that has been set for statements.
+  def current_consistency
+    Thread.current[:cassie_consistency] || consistency
+  end
 
   private
   

data/spec/cassie/model_spec.rb

@@ -132,9 +132,9 @@ describe Cassie::Model do
   end
   
   describe "batch" do
-    it "should delegate to Cassie.batch" do
+    it "should delegate to Cassie.batch using the write consistency" do
       Cassie::Thing.connection.should be_a(Cassie)
-      expect(Cassie::Thing.connection).to receive(:batch).and_call_original
+      expect(Cassie::Thing.connection).to receive(:batch).with(:consistency => :quorum).and_call_original
       Cassie::Thing.batch{}
     end
   end
@@ -183,6 +183,16 @@ describe Cassie::Model do
       record.callbacks.should == [:save, :update]
       Cassie::Thing.find(:owner => 1, :id => 2).value.should == 'bar'
     end
+    
+    it "should save new records with a ttl" do
+      expect(Cassie::Thing.connection).to receive(:insert).with("cassie_specs.things", {:owner=>1, :id=>2, :val=>'foo'}, {:consistency=>:quorum, :ttl=>10}).and_call_original
+      record = Cassie::Thing.new(:owner => 1, :id => 2, :val => 'foo')
+      record.persisted?.should == false
+      record.save(ttl: 10).should == true
+      record.persisted?.should == true
+      record.callbacks.should == [:save, :create]
+      Cassie::Thing.find(:owner => 1, :id => 2).should == record
+    end
   end
   
   describe "destroy" do
@@ -195,6 +205,54 @@ describe Cassie::Model do
     end
   end
   
+  describe "consistency" do
+    let(:connection){ Cassie::Thing.connection }
+
+    it "should be able to set a model level read consistency" do
+      expect(connection).to receive(:find).with("SELECT owner, id, val FROM cassie_specs.things WHERE owner = ?", [0], {:consistency => :one}).and_call_original
+      Cassie::Thing.find_all(where: {:owner => 0})
+    end
+    
+    it "should be able to override the model level read consistency" do
+      save_val = Cassie::Thing.read_consistency
+      begin
+        Cassie::Thing.read_consistency = :quorum
+        expect(connection).to receive(:find).with("SELECT owner, id, val FROM cassie_specs.things WHERE owner = ?", [0], {:consistency => :quorum}).and_call_original
+        Cassie::Thing.find_all(where: {:owner => 0})
+      ensure
+        Cassie::Thing.read_consistency = save_val
+      end
+    end
+    
+    it "should be able to set a model level write consistency" do
+      thing = Cassie::Thing.new(:owner => 1, :id => 2)
+      expect(connection).to receive(:insert).with("cassie_specs.things", {:owner=>1, :id=>2, :val=>nil}, {:consistency=>:quorum, :ttl=>nil}).and_call_original
+      thing.save
+      
+      thing.val = "foo"
+      expect(connection).to receive(:update).with("cassie_specs.things", {:val=>"foo"}, {:owner=>1, :id=>2}, {:consistency=>:quorum, :ttl=>nil}).and_call_original
+      thing.save
+      
+      expect(connection).to receive(:delete).with("cassie_specs.things", {:owner=>1, :id=>2}, {:consistency=>:quorum}).and_call_original
+      thing.destroy
+    end
+    
+    it "should be able to override the model level write consistency" do
+      thing = Cassie::Thing.new(:owner => 1, :id => 2)
+      thing.write_consistency = :local_quorum
+      
+      expect(connection).to receive(:insert).with("cassie_specs.things", {:owner=>1, :id=>2, :val=>nil}, {:consistency=>:local_quorum, :ttl=>nil}).and_call_original
+      thing.save
+      
+      thing.val = "foo"
+      expect(connection).to receive(:update).with("cassie_specs.things", {:val=>"foo"}, {:owner=>1, :id=>2}, {:consistency=>:local_quorum, :ttl=>nil}).and_call_original
+      thing.save
+      
+      expect(connection).to receive(:delete).with("cassie_specs.things", {:owner=>1, :id=>2}, {:consistency=>:local_quorum}).and_call_original
+      thing.destroy
+    end
+  end
+  
   describe "type conversion" do
     let(:model){ Cassie::TypeTester.new }
     

data/spec/cassie_spec.rb

@@ -131,14 +131,14 @@ describe Cassie do
         messages.size.should == 1
         message = messages.shift
         message.statement.should be_a(Cassandra::Statement)
-        message.options.should == {:arguments => [1]}
+        message.options.should == {:arguments => [1], :consistency => :local_one}
         message.elapsed_time.should be_a(Float)
 
         instance.execute("SELECT owner, id, val FROM #{table} WHERE owner = 1")
         messages.size.should == 1
         message = messages.shift
         message.statement.should be_a(Cassandra::Statement)
-        message.options.should == nil
+        message.options.should == {:consistency => :local_one}
         message.elapsed_time.should be_a(Float)
 
         instance.batch do
@@ -148,7 +148,7 @@ describe Cassie do
         messages.size.should == 1
         message = messages.shift
         message.statement.should be_a(Cassandra::Statements::Batch)
-        message.options.should == nil
+        message.options.should == {:consistency => :local_one}
         message.elapsed_time.should be_a(Float)
       ensure
         instance.subscribers.clear
@@ -160,14 +160,24 @@ describe Cassie do
     let(:session){ instance.send(:session) }
     
     it "should not specify query consistency by default" do
-      expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT * FROM dual"), {})
+      expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT * FROM dual"), {:consistency => :local_one})
       instance.execute("SELECT * FROM dual")
+      expect(instance.current_consistency).to eq :local_one
     end
     
     it "should allow specifying the consistency in a block" do
       expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT * FROM dual"), {:consistency => :one})
       Cassie.consistency(:one) do
         instance.execute("SELECT * FROM dual")
+        expect(instance.current_consistency).to eq :one
+      end
+    end
+    
+    it "should allow specifying the consistency in a block if statement consistency is explicitly nil" do
+      expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT * FROM dual"), {:consistency => :one})
+      Cassie.consistency(:one) do
+        instance.execute("SELECT * FROM dual", nil, :consistency => nil)
+        expect(instance.current_consistency).to eq :one
       end
     end
     
@@ -175,6 +185,35 @@ describe Cassie do
       expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT * FROM dual"), {:consistency => :two})
       Cassie.consistency(:one) do
         instance.execute("SELECT * FROM dual", nil, :consistency => :two)
+        expect(instance.current_consistency).to eq :one
+      end
+    end
+    
+    it "should use the consistency passed in the batch for all statements in the batch" do
+      expect(session).to receive(:execute).with(an_instance_of(Cassandra::Statements::Batch::Logged), {:consistency => :two})
+      Cassie.instance.batch(:consistency => :two) do
+        instance.insert(table, :owner => 1, :id => 2, :val => 'foo')
+      end
+    end
+    
+    it "should be able to specify a global consistancy" do
+      expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT * FROM dual"), {:consistency => :one})
+      expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT COUNT(*) FROM dual"), {:consistency => :local_quorum})
+      expect(session).to receive(:execute).with(Cassandra::Statements::Simple.new("SELECT COUNT(1) FROM dual"), {:consistency => :local_one})
+      instance.execute("SELECT COUNT(1) FROM dual", nil)
+      expect(instance.current_consistency).to eq :local_one
+      
+      begin
+        instance.consistency = :local_quorum
+        expect(instance.current_consistency).to eq :local_quorum
+        instance.execute("SELECT COUNT(*) FROM dual", nil)
+        Cassie.consistency(:one) do
+          instance.execute("SELECT * FROM dual", nil)
+          expect(instance.current_consistency).to eq :one
+        end
+        expect(instance.current_consistency).to eq :local_quorum
+      ensure
+        instance.consistency = :local_one
       end
     end
   end

data/spec/models/thing.rb

@@ -4,6 +4,8 @@ class Cassie::Thing
   self.table_name = "things"
   self.keyspace = "test"
   self.primary_key = [:owner, :id]
+  self.read_consistency = :one
+  self.write_consistency = :quorum
   
   column :owner, :int
   column :id, :int, :as => :identifier

data/spec/spec_helper.rb

@@ -16,7 +16,13 @@ RSpec.configure do |config|
   
   config.before(:suite) do
     schema_dir = File.expand_path("../schema", __FILE__)
-    Cassie.configure!(:cluster => {:host => 'localhost'}, :keyspaces => {"test" => "cassie_specs"}, :schema_directory => schema_dir, :max_prepared_statements => 3)
+    protocol_version = (ENV["protocol_version"] ? ENV["protocol_version"].to_i : 3)
+    Cassie.configure!(
+      :cluster => {:host => 'localhost', :protocol_version => protocol_version,},
+      :keyspaces => {"test" => "cassie_specs"},
+      :schema_directory => schema_dir,
+      :max_prepared_statements => 3
+    )
     Cassie::Schema.load_all!
     Cassie::Testing.prepare!
   end

data/whi-cassie.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency('cassandra-driver', '~>2.1.3')
+  spec.add_dependency('cassandra-driver', '~>3.0')
   spec.add_dependency('activemodel', '~>4.0')
 
   spec.add_development_dependency "bundler", "~>1.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whi-cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - We Heart It
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- HISTORY.txt
+- HISTORY.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Simple object mapper for Cassandra data tables specifically designed to work

data/HISTORY.txt

@@ -1,33 +0,0 @@
-1.0.7
-
-Add find_subscribers to Cassie::Model for instrumenting model find calls.
-
-1.0.6
-
-Wrap raw CQL in a Simple statement for code consistency in subscribers.
-
-1.0.5
-
-Add subscribers for instumenting code.
-
-Remove hardcoded log warnings for long running statements since this can now be better handled with instrumentation.
-
-1.0.4
-
-Set less cryptic error message for invalid records exceptions.
-
-1.0.3
-
-Fix bugs preventing counter and set data types from working on models.
-
-1.0.2
-
-Set cluster logger on the Cassandra cluster if not already set.
-
-1.0.1
-
-Allow finding the offset to the row from a range.
-
-1.0.0
-
-Initial Release