riak-client 2.2.0.pre1 → 2.2.0

data/lib/riak/client.rb

@@ -12,11 +12,14 @@ require 'riak/client/node'
 require 'riak/client/search'
 require 'riak/client/yokozuna'
 require 'riak/client/protobuffs_backend'
+require 'riak/preflist_item'
 require 'riak/client/beefcake_protobuffs_backend'
 require 'riak/bucket'
+require 'riak/bucket_properties'
 require 'riak/bucket_type'
 require 'riak/multiget'
 require 'riak/secondary_index'
+require 'riak/search'
 require 'riak/stamp'
 require 'riak/list_buckets'
 
@@ -81,7 +84,7 @@ module Riak
     # @option options [Fixnum, String] :client_id (rand(MAX_CLIENT_ID)) The internal client ID used by Riak to route responses
     # @option options [String, Symbol] :protobuffs_backend (:Beefcake) which Protocol Buffers backend to use
     # @raise [ArgumentError] raised if any invalid options are given
-    def initialize(options={})
+    def initialize(options = {})
       if options.include? :port
         warn(t('deprecated.port', :backtrace => caller[0..2].join("\n    ")))
       end
@@ -120,7 +123,7 @@ module Riak
     # @param [Hash] options options for retrieving the bucket
     # @option options [Boolean] :props (false) whether to retreive the bucket properties
     # @return [Bucket] the requested bucket
-    def bucket(name, options={})
+    def bucket(name, options = {})
       raise ArgumentError, t('zero_length_bucket') if name == ''
       unless (options.keys - [:props]).empty?
         raise ArgumentError, "invalid options"
@@ -140,7 +143,7 @@ module Riak
     # @note This is an expensive operation and should be used only
     #       in development.
     # @return [Array<Bucket>] a list of buckets
-    def buckets(options={}, &block)
+    def buckets(options = {}, &block)
       warn(t('list_buckets', :backtrace => caller.join("\n    "))) unless Riak.disable_list_keys_warnings
 
       return ListBuckets.new self, options, block if block_given?
@@ -224,19 +227,32 @@ module Riak
     end
 
     # Bucket properties. See Bucket#props
-    def get_bucket_props(bucket, options={  })
+    def get_bucket_props(bucket, options = {  })
       backend do |b|
         b.get_bucket_props bucket, options
       end
     end
 
     # Queries a secondary index on a bucket. See Bucket#get_index
-    def get_index(bucket, index, query, options={})
+    def get_index(bucket, index, query, options = {})
       backend do |b|
         b.get_index bucket, index, query, options
       end
     end
 
+    # Retrieves a preflist for the given bucket, key, and type; useful for
+    # figuring out where in the cluster an object is stored.
+    # @param [Bucket, String] bucket the Bucket or name of the bucket
+    # @param [String] key the key
+    # @param [BucketType, String] type the bucket type or name of the bucket
+    #   type
+    # @return [Array<PreflistItem>] an array of preflist entries
+    def get_preflist(bucket, key, type = nil, options = {  })
+      backend do |b|
+        b.get_preflist bucket, key, type, options
+      end
+    end
+
     # Get multiple objects in parallel.
     def get_many(pairs)
       Multiget.get_all self, pairs
@@ -256,7 +272,7 @@ module Riak
     end
 
     # Retrieves a list of keys in the given bucket. See Bucket#keys
-    def list_keys(bucket, options={}, &block)
+    def list_keys(bucket, options = {}, &block)
       if block_given?
         backend do |b|
           b.list_keys bucket, options, &block
@@ -367,14 +383,14 @@ module Riak
     end
 
     # Sets the properties on a bucket. See Bucket#props=
-    def set_bucket_props(bucket, properties, type=nil)
+    def set_bucket_props(bucket, properties, type = nil)
       backend do |b|
         b.set_bucket_props(bucket, properties, type)
       end
     end
 
     # Clears the properties on a bucket. See Bucket#clear_props
-    def clear_bucket_props(bucket, options={  })
+    def clear_bucket_props(bucket, options = {  })
       backend do |b|
         b.reset_bucket_props(bucket, options)
       end

data/lib/riak/client/beefcake/bucket_properties_operator.rb

@@ -13,7 +13,7 @@ class Riak::Client::BeefcakeProtobuffsBackend
       @backend = backend
     end
 
-    def get(bucket, options={})
+    def get(bucket, options = {})
       response = backend.protocol do |p|
         p.write :GetBucketReq, get_request(bucket, options)
         p.expect :GetBucketResp, RpbGetBucketResp
@@ -24,11 +24,11 @@ class Riak::Client::BeefcakeProtobuffsBackend
       return rubyfy(properties)
     end
 
-    def put(bucket, props={}, options={})
+    def put(bucket, props = {}, options = {})
       properties = riakify props
 
       request = put_request bucket, properties, options
-      
+
       backend.protocol do |p|
         p.write :SetBucketReq, request
         p.expect :SetBucketResp
@@ -42,7 +42,7 @@ class Riak::Client::BeefcakeProtobuffsBackend
       rubyfy_quorums(props)
       rubyfy_hooks(props)
       rubyfy_modfuns(props)
-      
+
       return props
     end
 
@@ -126,7 +126,7 @@ class Riak::Client::BeefcakeProtobuffsBackend
     end
 
     def rubyfy_modfun(modfun)
-      { 
+      {
         'mod' => modfun[:module],
         'fun' => modfun[:function]
       }
@@ -151,16 +151,16 @@ class Riak::Client::BeefcakeProtobuffsBackend
                         3
                       end
     end
-    
+
     def name_options(bucket)
       o = {}
       if bucket.is_a? Riak::Bucket
-        o[:bucket] = bucket.name 
+        o[:bucket] = bucket.name
         o[:type] = bucket.type.name if bucket.needs_type?
       else
         o[:bucket] = bucket
       end
-      
+
       return o
     end
 

data/lib/riak/client/beefcake/crdt/set_loader.rb

@@ -15,4 +15,4 @@ class Riak::Client::BeefcakeProtobuffsBackend
       end
     end
   end
-end 
+end

data/lib/riak/client/beefcake/crdt_loader.rb

@@ -26,7 +26,7 @@ module Riak
         end
 
         # Perform the protobuffs request and return a deserialized CRDT.
-        def load(bucket, key, bucket_type, options={})
+        def load(bucket, key, bucket_type, options = {})
           bucket = bucket.name if bucket.is_a? ::Riak::Bucket
           fetch_args = options.merge(
                                      bucket: bucket,

data/lib/riak/client/beefcake/crdt_operator.rb

@@ -4,13 +4,13 @@ module Riak
   class Client
     class BeefcakeProtobuffsBackend
 
-      # Returns a new {CrdtOperator} for serializing CRDT operations into 
+      # Returns a new {CrdtOperator} for serializing CRDT operations into
       # protobuffs and sending them to a Riak cluster.
       # @api private
       def crdt_operator
         return CrdtOperator.new self
       end
-      
+
       # Serializes and writes CRDT operations from {Riak::Crdt::Operation} members
       # into protobuffs, and writes them to a Riak cluster.
       # @api private
@@ -18,13 +18,13 @@ module Riak
         include Util::Translation
 
         attr_reader :backend
-        
+
         def initialize(backend)
           @backend = backend
         end
 
         # Serializes and writes CRDT operations.
-        def operate(bucket, key, bucket_type, operation, options={})
+        def operate(bucket, key, bucket_type, operation, options = {})
           serialized = serialize(operation)
           args = {
             bucket: bucket,
@@ -63,7 +63,7 @@ module Riak
         def wrap_field_for(ops)
           "#{ops.first.type.to_s}_op".to_sym
         end
-        
+
         def serialize_group(operations)
           case operations.first.type
           when :counter
@@ -76,9 +76,9 @@ module Riak
             raise ArgumentError, t('crdt.unknown_field', symbol: operation.type.inspect)
           end
         end
-        
+
         def inner_serialize_group(operations)
-          updates, deletes = operations.partition do |op| 
+          updates, deletes = operations.partition do |op|
             op.value.is_a? Riak::Crdt::Operation::Update
           end
           serialized_updates = updates.map do |operation|
@@ -117,7 +117,7 @@ module Riak
                        type: type_symbol_to_type_enum(operation.type)
                        )
         end
-        
+
         def serialize_counter(counter_ops)
           amount = counter_ops.inject(0){|m, o| m += o.value }
           CounterOp.new(increment: amount)
@@ -163,7 +163,7 @@ module Riak
             adds.add [o.value[:add]] if o.value[:add]
             removes.merge [o.value[:remove]] if o.value[:remove]
           end
-          
+
           SetOp.new(
                     adds: adds.to_a.flatten,
                     removes: removes.to_a.flatten

data/lib/riak/client/beefcake/message_codes.rb

@@ -39,6 +39,10 @@ module Riak
         :SetBucketTypeReq => 32,
         :ResetBucketTypeReq => 33,
 
+        # preflist
+        :GetBucketKeyPreflistReq => 33,
+        :GetBucketKeyPreflistResp => 34,
+
         # riak cs
         :CSBucketReq => 40,
         :CSBucketResp => 41,

data/lib/riak/client/beefcake/message_overlay.rb

@@ -9,6 +9,10 @@ module Riak
         end
       end
 
+      class RpbBucketKeyPreflistItem
+        include Riak::PreflistItem
+      end
+
       class RpbBucketProps
 
         # "repeated" elements with zero items are indistinguishable

data/lib/riak/client/beefcake/messages.rb

@@ -4,7 +4,7 @@ module Riak
   class Client
     # @private
     class BeefcakeProtobuffsBackend
-## Generated from riak.proto for 
+## Generated from riak.proto for
 require "beefcake"
 
 
@@ -149,13 +149,14 @@ class RpbBucketProps
   optional :search_index, :bytes, 25
   optional :datatype, :bytes, 26
   optional :consistent, :bool, 27
+  optional :write_once, :bool, 28
 end
 
 class RpbAuthReq
   required :user, :bytes, 1
   required :password, :bytes, 2
 end
-## Generated from riak_kv.proto for 
+## Generated from riak_kv.proto for
 require "beefcake"
 
 
@@ -260,6 +261,18 @@ class RpbCounterGetResp
   include Beefcake::Message
 end
 
+class RpbGetBucketKeyPreflistReq
+  include Beefcake::Message
+end
+
+class RpbGetBucketKeyPreflistResp
+  include Beefcake::Message
+end
+
+class RpbBucketKeyPreflistItem
+  include Beefcake::Message
+end
+
 class RpbGetClientIdResp
   required :client_id, :bytes, 1
 end
@@ -457,7 +470,23 @@ end
 class RpbCounterGetResp
   optional :value, :sint64, 1
 end
-## Generated from riak_search.proto for 
+
+class RpbGetBucketKeyPreflistReq
+  required :bucket, :bytes, 1
+  required :key, :bytes, 2
+  optional :type, :bytes, 3
+end
+
+class RpbGetBucketKeyPreflistResp
+  repeated :preflist, RpbBucketKeyPreflistItem, 1
+end
+
+class RpbBucketKeyPreflistItem
+  required :partition, :int64, 1
+  required :node, :bytes, 2
+  required :primary, :bool, 3
+end
+## Generated from riak_search.proto for
 require "beefcake"
 
 
@@ -495,7 +524,7 @@ class RpbSearchQueryResp
   optional :max_score, :float, 2
   optional :num_found, :uint32, 3
 end
-## Generated from riak_yokozuna.proto for 
+## Generated from riak_yokozuna.proto for
 require "beefcake"
 
 
@@ -551,6 +580,7 @@ end
 
 class RpbYokozunaIndexPutReq
   required :index, RpbYokozunaIndex, 1
+  optional :timeout, :uint32, 2
 end
 
 class RpbYokozunaIndexDeleteReq
@@ -573,7 +603,7 @@ end
 class RpbYokozunaSchemaGetResp
   required :schema, RpbYokozunaSchema, 1
 end
-## Generated from riak_dt.proto for 
+## Generated from riak_dt.proto for
 require "beefcake"
 
 

data/lib/riak/client/beefcake/object_methods.rb

@@ -9,20 +9,15 @@ module Riak
         ENCODING = "Riak".respond_to?(:encoding)
 
         # Returns RpbPutReq
-        def dump_object(robject, options={})
-          pbuf = RpbPutReq.new(options.merge(:bucket => maybe_encode(robject.bucket.name)))
+        def dump_object(robject, options = {})
+          req_opts = options.merge(:bucket => maybe_encode(robject.bucket.name))
+          if robject.bucket.respond_to?(:type) && t = robject.bucket.type
+            req_opts[:type] = maybe_encode(t.name)
+          end
+          pbuf = RpbPutReq.new(req_opts)
           pbuf.key = maybe_encode(robject.key) if robject.key # Put w/o key supported!
           pbuf.vclock = maybe_encode(Base64.decode64(robject.vclock)) if robject.vclock
-          pbuf.content = RpbContent.new(:value => maybe_encode(robject.raw_data),
-                                        :content_type => maybe_encode(robject.content_type),
-                                        :links => robject.links.map {|l| encode_link(l) }.compact,
-                                        :indexes => robject.indexes.map {|k,s| encode_index(k,s) }.flatten)
-
-          pbuf.content.usermeta = robject.meta.map {|k,v| encode_meta(k,v)} if robject.meta.any?
-          pbuf.content.vtag = maybe_encode(robject.etag) if robject.etag.present?
-          if ENCODING # 1.9 support
-            pbuf.content.charset = maybe_encode(robject.raw_data.encoding.name)
-          end
+          dump_content pbuf, robject
           pbuf
         end
 
@@ -60,6 +55,19 @@ module Riak
           rcontent
         end
 
+        def dump_content(pbuf, robject)
+          pbuf.content = RpbContent.new(:value => maybe_encode(robject.raw_data),
+                                        :content_type => maybe_encode(robject.content_type),
+                                        :links => robject.links.map {|l| encode_link(l) }.compact,
+                                        :indexes => robject.indexes.map {|k, s| encode_index(k, s) }.flatten)
+
+          pbuf.content.usermeta = robject.meta.map {|k, v| encode_meta(k, v)} if robject.meta.any?
+          pbuf.content.vtag = maybe_encode(robject.etag) if robject.etag.present?
+          if ENCODING # 1.9 support
+            pbuf.content.charset = maybe_encode(robject.raw_data.encoding.name)
+          end
+        end
+
         def decode_link(pbuf)
           Riak::Link.new(pbuf.bucket, pbuf.key, pbuf.tag)
         end
@@ -75,7 +83,7 @@ module Riak
           hash[pbuf.key] = pbuf.value
         end
 
-        def encode_meta(key,value)
+        def encode_meta(key, value)
           return nil unless value.present?
           RpbPair.new(:key => maybe_encode(key.to_s),
                       :value => maybe_encode(value.to_s))

data/lib/riak/client/beefcake/protocol.rb

@@ -16,12 +16,12 @@ module Riak
 
         # Encodes and writes a Riak-formatted message, including protocol buffer
         # payload if given.
-        # 
-        # @param [Symbol, Integer] code the symbolic or numeric code for the 
+        #
+        # @param [Symbol, Integer] code the symbolic or numeric code for the
         #   message
         # @param [Beefcake::Message, nil] message the protocol buffer message
         #   payload, or nil if the message carries no payload
-        def write(code, message=nil)
+        def write(code, message = nil)
           if code.is_a? Symbol
             code = BeefcakeMessageCodes.index code
           end
@@ -42,7 +42,7 @@ module Riak
         # @return [Array<Symbol, String>]
         def receive
           header = socket.read 5
-          
+
           raise ProtobuffsFailedHeader.new if header.nil?
           message_length, code = header.unpack 'NC'
           body_length = message_length - 1
@@ -59,7 +59,7 @@ module Riak
         # success if the payload is empty.
         #
         # @param [Symbol] code the code for the message
-        # @param [Class, nil] decoder_class the class to attempt to decode 
+        # @param [Class, nil] decoder_class the class to attempt to decode
         #   the payload with
         # @param [Hash] options
         # @option options [Boolean] :empty_body_acceptable Whether to accept
@@ -71,10 +71,10 @@ module Riak
         #   255-ErrorResp
         # @raise {ProtobuffsUnexpectedResponse} if the message from riak did
         #   not match `code`
-        def expect(code, decoder_class=nil, options={ })
+        def expect(code, decoder_class = nil, options = { })
           code = BeefcakeMessageCodes[code] unless code.is_a? Symbol
           name, body = receive
-          
+
           if name == :ErrorResp
             raise ProtobuffsErrorResponse.new RpbErrorResp.decode(body)
           end