chimera 0.0.3 → 0.0.4

data/History.txt

@@ -1,4 +1,8 @@
+=== 0.0.4 2010-03-07
+
+* Added support for siblings in riak so that conflicts can be managed.
+  See tests for example and http://blog.basho.com/2010/01/29/why-vector-clocks-are-easy/.
+
 === 0.0.1 2010-03-01
 
-* 1 major enhancement:
-  * Initial release
+* Initial release

data/README.rdoc

@@ -14,6 +14,9 @@ that are automatically created. There's no built in sharding for Redis, but sinc
 only being used for key storage and basic data elements you should be able to go a long
 way with one Redis server (especially if you use the new Redis VM).
 
+!! Chimera is alpha. It's not production tested and needs a better test suite. !!
+!! It's also only tested in Ruby 1.9. !!
+
 == FEATURES:
 
 * Uses Riak (http://riak.basho.com/) for your primary storage.
@@ -21,10 +24,13 @@ way with one Redis server (especially if you use the new Redis VM).
 * Supports unique and non-unique indexes, as well as basic search indexes (words are stemmed,
   uses set intersection so you can get an AND/OR search).
 * Supports a geospatial index type for simple storage and lookup of coordinates.
+* Uses Typhoeus for communicating with Riak.
+* Surfaces siblings from Riak so that conflicts can be managed and resolved.
 
 == ISSUES/NOTES:
 
 * Experimental. Not yet tested in production environment, use at your own risk.
+* Only tested with Ruby 1.9. Why not upgrade?
 * Test coverage needs to be improved.
 * Documentation is lacking. At the moment reading the tests and sample test/models.rb
   file are your best bet.
@@ -62,10 +68,10 @@ way with one Redis server (especially if you use the new Redis VM).
   Car.find_with_index(:year, 2010)
   => [c]
 
-  Car.find_with_index(:description, "rigid boat", :type => :union)
+  Car.find_with_index(:description, :q => "rigid boat", :type => :union)
   => [c]
 
-  Car.find_with_index(:description, "rigid boat", :type => :intersect)
+  Car.find_with_index(:description, :q => "rigid boat", :type => :intersect)
   => []
 
 * See tests for more usage examples
@@ -75,6 +81,8 @@ way with one Redis server (especially if you use the new Redis VM).
 * Riak Server
 * Redis Server
 
+* Ruby 1.9
+
 * ActiveSupport+ActiveModel 3.0.0.beta
 
 * uuidtools 2.1.1
@@ -89,13 +97,15 @@ way with one Redis server (especially if you use the new Redis VM).
   
 == USEFUL LINKS:
 
-* http://groups.google.com/group/chimera-lib
+* Discussion: http://groups.google.com/group/chimera-lib
+* Email: ben dot myles at gmail dot com
+* Twitter: benmyles
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2010 FIXME full name
+Copyright (c) 2010 Ben Myles
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/chimera.rb

@@ -29,5 +29,5 @@ require "chimera/persistence"
 require "chimera/base"
 
 module Chimera
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/chimera/base.rb

@@ -22,7 +22,8 @@ module Chimera
     extend ActiveModel::Callbacks
     define_model_callbacks :create, :save, :destroy
     
-    attr_accessor :id, :attributes, :orig_attributes, :riak_response, :associations
+    attr_accessor :id, :attributes, :orig_attributes, :riak_response, :associations,
+                  :sibling_attributes
     
     def self.use_config(key)
       @config = (Chimera.config[key.to_sym] || raise(Chimera::Error::MissingConfig,":#{key}"))
@@ -33,15 +34,17 @@ module Chimera
     end
     
     def self.connection(server)
-      Thread.current["Chimera::#{self.to_s}::#{server}::connection"] ||= begin
-        case server.to_sym
-        when :redis
-          Redis.new(self.config[:redis])
-        when :riak_raw
-          RiakRaw::Client.new(self.config[:riak_raw][:host], self.config[:riak_raw][:port])
-        else
-          nil
-        end
+      Thread.current["Chimera::#{self.to_s}::#{server}::connection"] ||= new_connection(server)
+    end
+    
+    def self.new_connection(server)
+      case server.to_sym
+      when :redis
+        Redis.new(self.config[:redis])
+      when :riak_raw
+        RiakRaw::Client.new(self.config[:riak_raw][:host], self.config[:riak_raw][:port])
+      else
+        nil
       end
     end
 
@@ -76,6 +79,7 @@ module Chimera
       @orig_attributes = @attributes.clone
       @id = id
       @new = is_new
+      @sibling_attributes = nil
     end
     
     def id=(val)

data/lib/chimera/error.rb

@@ -7,6 +7,8 @@ module Chimera
     class ValidationErrors < Chimera::Error; end
     class AttemptToModifyId < Chimera::Error; end
     class AssociationClassMismatch < Chimera::Error; end
+    class UnhandledRiakResponseCode < Chimera::Error; end
+    class CannotSaveWithConflicts < Chimera::Error; end
   end
 end
 

data/lib/chimera/finders.rb

@@ -10,19 +10,27 @@ module Chimera
         self.find_with_index(:all) { |obj| yield(obj) }
       end
       
-      def find(key)
-        find_many(key)[0]
+      def find(key,opts={})
+        find_many([[key,opts]])[0]
       end
       
-      def find_many(keys)
-        keys    = Array(keys)
+      def find_many(key_opts_arr)
         found   = []
         threads = []
-        keys.each do |key|
+        key_opts_arr = Array(key_opts_arr).collect { |e| Array(e) }
+        key_opts_arr.each do |key,opts|
+          opts ||= {}
           threads << Thread.new do
             if key
-              resp = self.connection(:riak_raw).fetch(self.to_s, key)
-              if resp.code == 200
+              resp = self.connection(:riak_raw).fetch(self.to_s, key, opts)
+              case resp.code
+              when 300 then
+                # siblings
+                obj = self.new({},key,false)
+                obj.riak_response = resp
+                obj.load_sibling_attributes
+                found << obj
+              when 200 then
                 if resp.body and yaml_hash = YAML.load(resp.body)
                   hash = {}
                   yaml_hash.each { |k,v| hash[k.to_sym] = v }
@@ -34,7 +42,11 @@ module Chimera
                   obj.riak_response = resp
                   found << obj
                 end
-              end
+              when 404 then
+                nil
+              else
+                raise(Chimera::Error::UnhandledRiakResponseCode.new(resp.code.to_s))
+              end # case
             end
           end # Thread.new
         end # keys.each

data/lib/chimera/persistence.rb

@@ -6,16 +6,49 @@ module Chimera
     end
     
     module ClassMethods
+      # allows for multiple conflicting values from riak
+      def allow_multi=(val)
+        props = self.bucket
+        props["props"]["allow_mult"] = val
+        self.connection(:riak_raw).set_bucket_properties(self.to_s,props)
+      end
     end # ClassMethods
     
     module InstanceMethods
       def new?
         @new == true
       end
+      
+      def in_conflict?
+        !self.sibling_attributes.nil?
+      end
+      
+      def load_sibling_attributes
+        return nil unless self.riak_response.body =~ /^Sibling/
+        vtags = self.riak_response.body.split("\n")[1..-1]
+        if vtags.empty?
+          self.sibling_attributes = nil
+        else
+          self.sibling_attributes = {}
+          vtags.each do |vtag|
+            if resp = self.class.connection(:riak_raw).fetch(self.class.to_s, self.id, {"vtag" => vtag})
+              self.sibling_attributes[vtag] = YAML.load(resp.body)
+            else
+              self.sibling_attributes[vtag] = {}
+            end
+          end
+        end
+      end # load_sibling_attributes
+      
+      def resolve_and_save
+        if valid?
+          self.sibling_attributes = nil
+          save
+        end
+      end
 
       def save
-        raise(Chimera::Error::SaveWithoutId) unless self.id
-        raise(Chimera::Error::ValidationErrors) unless self.valid?
+        verify_can_save!
         check_index_constraints
         
         if new?
@@ -45,12 +78,23 @@ module Chimera
       end
       
       def save_without_callbacks
+        verify_can_save!
+        
         @riak_response = self.class.connection(:riak_raw).store(
           self.class.bucket_key,
           self.id, 
           YAML.dump(@attributes),
           self.vector_clock)
-
+        
+        case @riak_response.code
+        when 300 then
+          self.load_sibling_attributes
+        when 200 then
+          # all good
+        else
+          raise(Chimera::Error::UnhandledRiakResponseCode.new(@riak_response.code))
+        end
+        
         @orig_attributes = @attributes.clone
         @new = false
       end
@@ -65,6 +109,14 @@ module Chimera
           freeze
         end
       end
+      
+      protected
+      
+      def verify_can_save!
+        raise(Chimera::Error::SaveWithoutId) unless self.id
+        raise(Chimera::Error::CannotSaveWithConflicts) if self.in_conflict?
+        raise(Chimera::Error::ValidationErrors) unless self.valid?
+      end
     end # InstanceMethods
   end
 end

data/lib/riak_raw.rb

@@ -40,6 +40,12 @@ module RiakRaw
       end; nil
     end
     
+    def set_bucket_properties(name,props)
+      response = request(:put,
+        build_path(name),
+        Yajl::Encoder.encode(props), { 'Content-Type' => 'application/json' })
+    end
+    
     def store(bucket_name, key, content, vclock=nil, links=[], content_type='application/json', w=2, dw=2, r=2)
       headers = { 'Content-Type' => content_type,
                   'X-Riak-ClientId' => self.client_id }
@@ -55,16 +61,19 @@ module RiakRaw
       # returnbody=true could cause issues. instead we'll do a
       # separate fetch. see: https://issues.basho.com/show_bug.cgi?id=52
       if response.code == 204
-        response = fetch(bucket_name, key, r)
+        response = fetch(bucket_name, key, {:r => r})
       end
       
       response
     end
     
-    def fetch(bucket_name, key, r=2)
+    def fetch(bucket_name, key, _params={})
+      params = {}
+      _params.each { |k,v| params[k.to_s] = v }
+      params["r"] ||= 2
       response = request(:get,
         build_path(bucket_name, key),
-        nil, {}, {"r" => r})
+        nil, {}, params)
     end
     
     # there could be concurrency issues if we don't force a short sleep

data/test/test_chimera.rb

@@ -4,6 +4,7 @@ class TestChimera < Test::Unit::TestCase
   def setup
     Car.each { |c| c.destroy }
     Car.connection(:redis).flush_all
+    Car.allow_multi = true
   end
   
   def test_geo_indexes
@@ -56,7 +57,7 @@ class TestChimera < Test::Unit::TestCase
     c2.comments = "cat dog chicken"
     c2.id = Car.new_uuid
     assert c2.save
-
+  
     c3 = Car.new
     c3.make = "Porsche"
     c3.model = "911"
@@ -69,7 +70,7 @@ class TestChimera < Test::Unit::TestCase
     assert_equal [c,c2,c3].sort, Car.find_with_index(:comments, "dog").sort
     assert_equal [c,c2].sort, Car.find_with_index(:comments, "cat").sort
     assert_equal [c,c2].sort, Car.find_with_index(:comments, "cat").sort
-
+  
     assert_equal [c,c2,c3].sort, Car.find_with_index(:comments, {:q => "dog dolphin", :type => :union}).sort
     assert_equal [c,c3].sort, Car.find_with_index(:comments, {:q => "dog dolphin", :type => :intersect}).sort
   end
@@ -235,4 +236,42 @@ class TestChimera < Test::Unit::TestCase
     u = User.find(u.id)
     assert u.updated_at.is_a?(Time)
   end
+  
+  # see http://blog.basho.com/2010/01/29/why-vector-clocks-are-easy/
+  def test_conflicts
+    Car.connection(:riak_raw).client_id = "Client1"
+    c = Car.new
+    c.id = Car.new_uuid
+    c.make = "Nissan"
+    c.model = "Versa"
+    c.year = 2009
+    assert c.save
+    
+    c2 = c.clone
+    Car.connection(:riak_raw).client_id = "Client2"
+    c2.year = 2008
+    assert c2.save
+    
+    assert !c2.in_conflict?
+    
+    Car.connection(:riak_raw).client_id = "Client3"
+    c.year = 2007
+    assert c.save
+    
+    assert c.in_conflict?
+    assert_raise(Chimera::Error::CannotSaveWithConflicts) { c.save }
+    
+    c2 = Car.find(c.id)
+    assert_raise(Chimera::Error::CannotSaveWithConflicts) { c2.save }
+    
+    c.attributes = c.sibling_attributes.first[1].dup
+    c.year = 2006
+    assert c.resolve_and_save
+    
+    assert !c.in_conflict?
+    
+    c = Car.find(c.id)
+    assert !c.in_conflict?
+    assert_equal 2006, c.year
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Ben Myles
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-05 00:00:00 -08:00
+date: 2010-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -141,6 +141,9 @@ description: |-
   that are automatically created. There's no built in sharding for Redis, but since it's
   only being used for key storage and basic data elements you should be able to go a long
   way with one Redis server (especially if you use the new Redis VM).
+  
+  !! Chimera is alpha. It's not production tested and needs a better test suite. !!
+  !! It's also only tested in Ruby 1.9. !!
 email: 
 - ben.myles@gmail.com
 executables: []