adapter-cassanity 0.1.0 → 0.2.0

data/Changelog.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.2.0
+
+* Added adapter options: :read, :write, :delete. These can be used to tune consistency and all other operation arguments.
+* Added method options (ie: read('key', using: {consistency: :quorum})). Method operations override any similar adapter options.

data/README.md

@@ -29,6 +29,14 @@ client = apps
 adapter = Adapter[:cassanity].new(client)
 adapter.clear
 
+# you can also set options for the adapter
+using = {using: {consistency: :quorum}}
+adapter = Adapter[:cassanity].new(client, {
+  read: using,   # read using quorum consistency
+  write: using,  # write using quorum consistency
+  delete: using, # delete using quorum consistency
+})
+
 id = CassandraCQL::UUID.new
 
 adapter.read(id) # => nil
@@ -44,6 +52,10 @@ adapter.read(id) # => {'id' => ..., 'name' => 'GitHub'}
 
 adapter.clear
 adapter.read(id) # => nil
+
+# You can also override adapter options per method:
+# This will perform read with consistency set to ONE.
+adapter.read(id, using: {consistency: :one})
 ```
 
 ## Installation

data/adapter-cassanity.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'adapter', '~> 0.6.3'
-  gem.add_dependency 'cassanity', '~> 0.2.0'
+  gem.add_dependency 'cassanity', '~> 0.2.1'
 end

data/examples/adapter_options.rb

@@ -0,0 +1,16 @@
+require_relative 'shared_setup'
+
+client = AppsCF
+using = {using: {consistency: :quorum}}
+adapter = Adapter[:cassanity].new(client, {
+  read: using,
+  write: using,
+  delete: using,
+})
+adapter.clear
+
+id = CassandraCQL::UUID.new
+
+adapter.write(id, {name: 'GitHub'})
+pp adapter.read(id)
+adapter.delete(id)

data/examples/cassanity.rb

@@ -1,31 +1,6 @@
-require 'rubygems'
-require 'pathname'
+require_relative 'shared_setup'
 
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
-require 'adapter/cassanity'
-
-client     = CassandraCQL::Database.new('127.0.0.1:9160')
-executor   = Cassanity::Executors::CassandraCql.new(client: client)
-connection = Cassanity::Connection.new(executor: executor)
-keyspace   = connection.keyspace('adapter_cassanity')
-keyspace.recreate
-
-apps = keyspace.column_family(:apps, {
-  schema: Cassanity::Schema.new({
-    primary_key: :id,
-    columns: {
-      id: :timeuuid,
-      name: :text,
-    }
-  }),
-})
-
-apps.create
-
-client = apps
+client = AppsCF
 adapter = Adapter[:cassanity].new(client)
 adapter.clear
 

data/examples/method_options.rb

@@ -0,0 +1,11 @@
+require_relative 'shared_setup'
+
+client = AppsCF
+adapter = Adapter[:cassanity].new(client)
+adapter.clear
+
+id = CassandraCQL::UUID.new
+
+adapter.write(id, {name: 'GitHub'}, using: {consistency: :quorum})
+pp adapter.read(id, using: {consistency: :quorum})
+adapter.delete(id)

data/examples/shared_setup.rb

@@ -0,0 +1,27 @@
+require 'pp'
+require 'pathname'
+require 'rubygems'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'adapter/cassanity'
+
+client     = CassandraCQL::Database.new('127.0.0.1:9160')
+executor   = Cassanity::Executors::CassandraCql.new(client: client)
+connection = Cassanity::Connection.new(executor: executor)
+keyspace   = connection.keyspace('adapter_cassanity')
+keyspace.recreate
+
+AppsCF = keyspace.column_family(:apps, {
+  schema: Cassanity::Schema.new({
+    primary_key: :id,
+    columns: {
+      id: :timeuuid,
+      name: :text,
+    }
+  }),
+})
+
+AppsCF.create

data/lib/adapter/cassanity.rb

@@ -8,24 +8,37 @@ module Adapter
 
     def_delegator :@client, :schema
 
-    def read(key)
-      rows = client.select(where: where(key))
+    # Public
+    def read(key, options = nil)
+      operation_options = {where: where(key)}
+      adapter_options = @options[:read]
+      arguments = update_arguments(operation_options, adapter_options, options)
+
+      rows = @client.select(arguments)
       rows.empty? ? nil : decode(rows.first)
     end
 
-    def write(key, attributes)
-      client.update({
-        set: encode(attributes),
-        where: where(key),
-      })
+    # Public
+    def write(key, attributes, options = nil)
+      operation_options = {set: encode(attributes), where: where(key)}
+      adapter_options = @options[:write]
+      arguments = update_arguments(operation_options, adapter_options, options)
+
+      @client.update(arguments)
     end
 
-    def delete(key)
-      client.delete(where: where(key))
+    # Public
+    def delete(key, options = nil)
+      operation_options = {where: where(key)}
+      adapter_options = @options[:delete]
+      arguments = update_arguments(operation_options, adapter_options, options)
+
+      @client.delete(arguments)
     end
 
+    # Public
     def clear
-      client.truncate
+      @client.truncate
     end
 
     # Private
@@ -37,6 +50,23 @@ module Adapter
         {primary_key => criteria}
       end
     end
+
+    # Private
+    def update_arguments(operation_options, adapter_options, method_options)
+      keys = operation_options.keys
+
+      if !adapter_options.nil? && !adapter_options.empty?
+        filtered_options = adapter_options.reject { |key| keys.include?(key) }
+        operation_options.update(filtered_options)
+      end
+
+      if !method_options.nil? && !method_options.empty?
+        filtered_options = method_options.reject { |key| keys.include?(key) }
+        operation_options.update(filtered_options)
+      end
+
+      operation_options
+    end
   end
 end
 

data/lib/adapter/cassanity/version.rb

@@ -1,5 +1,5 @@
 module Adapter
   module Cassanity
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/cassanity_spec.rb

@@ -1,6 +1,7 @@
 require 'helper'
 
 describe "Cassanity adapter" do
+  let(:adapter_name) { :cassanity }
 
   context "single primary key" do
     before do
@@ -9,14 +10,160 @@ describe "Cassanity adapter" do
       @adapter.clear
     end
 
-    let(:adapter_name) { :cassanity }
-
     let(:adapter) { @adapter }
     let(:client)  { @client }
 
     it_behaves_like 'an adapter'
   end
 
+  context "with adapter read options" do
+    it "uses read options for read method" do
+      client = COLUMN_FAMILIES[:single]
+      options = {read: {
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:select).with({
+        where: {:some_key => 'foo'},
+        using: {consistency: :quorum},
+      }).and_return([])
+
+      adapter.read('foo')
+    end
+
+    it "does not override where" do
+      client = COLUMN_FAMILIES[:single]
+      options = {read: {
+        where: {:some_key => 'bar'},
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:select).with({
+        where: {:some_key => 'foo'},
+        using: {consistency: :quorum},
+      }).and_return([])
+
+      adapter.read('foo')
+    end
+
+    it "can be overriden by read method options" do
+      client = COLUMN_FAMILIES[:single]
+      options = {read: {
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:select).with({
+        where: {:some_key => 'foo'},
+        using: {consistency: :one},
+      }).and_return([])
+
+      adapter.read('foo', using: {consistency: :one})
+    end
+  end
+
+  context "with adapter write options" do
+    it "uses write options for write method" do
+      client = COLUMN_FAMILIES[:single]
+      options = {write: {
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:update).with({
+        set: {'name' => 'New Name'},
+        where: {:some_key => 'foo'},
+        using: {consistency: :quorum},
+      })
+
+      adapter.write('foo', {'name' => 'New Name'})
+    end
+
+    it "does not override where or set" do
+      client = COLUMN_FAMILIES[:single]
+      options = {write: {
+        where: {:some_key => 'should not use this'},
+        set: {'name' => 'should not use this'},
+        using: {consistency: :quorum,
+      }}}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:update).with({
+        set: {'name' => 'New Name'},
+        where: {:some_key => 'foo'},
+        using: {consistency: :quorum},
+      })
+
+      adapter.write('foo', {'name' => 'New Name'})
+    end
+
+    it "can be overriden by write method options" do
+      client = COLUMN_FAMILIES[:single]
+      options = {write: {
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:update).with({
+        set: {'name' => 'New Name'},
+        where: {:some_key => 'foo'},
+        using: {consistency: :one},
+      })
+
+      adapter.write('foo', {'name' => 'New Name'}, using: {consistency: :one})
+    end
+  end
+
+  context "with adapter delete options" do
+    it "uses delete options for delete method" do
+      client = COLUMN_FAMILIES[:single]
+      options = {delete: {
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:delete).with({
+        where: {:some_key => 'foo'},
+        using: {consistency: :quorum},
+      })
+
+      adapter.delete('foo')
+    end
+
+    it "does not override where" do
+      client = COLUMN_FAMILIES[:single]
+      options = {delete: {
+        where: {:some_key => 'bar'},
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:delete).with({
+        where: {:some_key => 'foo'},
+        using: {consistency: :quorum},
+      })
+
+      adapter.delete('foo')
+    end
+
+    it "can be overriden by delete method options" do
+      client = COLUMN_FAMILIES[:single]
+      options = {delete: {
+        using: {consistency: :quorum},
+      }}
+      adapter = Adapter[adapter_name].new(client, options)
+
+      client.should_receive(:delete).with({
+        where: {:some_key => 'foo'},
+        using: {consistency: :one},
+      })
+
+      adapter.delete('foo', using: {consistency: :one})
+    end
+  end
+
   context "composite primary key" do
     before do
       @client = COLUMN_FAMILIES[:composite]
@@ -24,12 +171,10 @@ describe "Cassanity adapter" do
       @adapter.clear
     end
 
-    let(:adapter_name) { :cassanity }
-
-    let(:adapter) { @adapter }
-    let(:client)  { @client }
-
     it_behaves_like 'an adapter' do
+      let(:adapter) { @adapter }
+      let(:client)  { @client }
+
       let(:key)  { {:bucket => '1', :id => CassandraCQL::UUID.new} }
       let(:key2) { {:bucket => '2', :id => CassandraCQL::UUID.new} }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adapter-cassanity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adapter
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 description: Adapter for Cassanity
 email:
 - nunemaker@gmail.com
@@ -53,13 +53,17 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- Changelog.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - adapter-cassanity.gemspec
+- examples/adapter_options.rb
 - examples/cassanity.rb
+- examples/method_options.rb
+- examples/shared_setup.rb
 - lib/adapter-cassanity.rb
 - lib/adapter/cassanity.rb
 - lib/adapter/cassanity/version.rb
@@ -79,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -267742197424905858
+      hash: 135504894243960004
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -88,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -267742197424905858
+      hash: 135504894243960004
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23