riak-client 2.2.0.pre1 → 2.2.0

data/lib/riak/errors/base.rb

@@ -1,5 +1,5 @@
 module Riak
-  
+
   # Superclass for all errors raised by riak-client. If you catch an error
   # that the client raises that isn't descended from this class, please
   # file a bug. Thanks!

data/lib/riak/errors/crdt_error.rb

@@ -14,5 +14,25 @@ module Riak
         super t('crdt.precondition', message: message)
       end
     end
+
+    class UnrecognizedDataType < CrdtError
+      def initialize(given_type)
+        super t('crdt.unrecognized_type', type: given_type)
+      end
+    end
+
+    class UnexpectedDataType < CrdtError
+      def initialize(given_type, expected_type)
+        super t('crdt.unexpected_type',
+                given: given_type,
+                expected: expected_type)
+      end
+    end
+
+    class NotACrdt < CrdtError
+      def initialize
+        super t('crdt.not_a_crdt')
+      end
+    end
   end
 end

data/lib/riak/errors/search_error.rb

@@ -25,5 +25,11 @@ module Riak
         super t('search.index_non_exist', index: index)
       end
     end
+
+    class UnexpectedResultError < SearchError
+      def initialize(expected, actual)
+        super t('search.unexpected_result', expected: expected, actual: actual)
+      end
+    end
   end
 end

data/lib/riak/index_collection.rb

@@ -18,7 +18,7 @@ module Riak
       parsed = JSON.parse json
       fresh = nil
       if parsed['keys']
-        fresh = new parsed['keys'] 
+        fresh = new parsed['keys']
       elsif parsed['results']
         fresh_terms = load_json_terms(parsed)
         fresh = new fresh_terms.values.flatten

data/lib/riak/link.rb

@@ -52,7 +52,7 @@ module Riak
     end
 
     # @return [String] the URL (relative or absolute) of the related resource
-    def url(new_scheme=false)
+    def url(new_scheme = false)
       return @url unless @bucket
 
       if new_scheme
@@ -68,9 +68,11 @@ module Riak
       @key = unescape($1) if value =~ %r{^/buckets/[^/]+/keys/([^/]+)/?} || value =~ %r{^/[^/]+/[^/]+/([^/]+)/?}
     end
 
-    def inspect; to_s; end
+    def inspect
+      to_s
+    end
 
-    def to_s(new_scheme=false)
+    def to_s(new_scheme = false)
       %Q[<#{url(new_scheme)}>; riaktag="#{tag}"]
     end
 

data/lib/riak/locale/en.yml

@@ -13,9 +13,12 @@ en:
       increment_by_integer: "Counters can only be incremented or decremented by integers."
     crdt:
       precondition_error: "Riak server returned precondition error: %{message}"
+      not_a_crdt: "Expected to find a CRDT, but failed."
       set_removal_without_context: "CRDT Sets do not support removal without context. Store and reload the set before removing members."
       unknown_field: "Unknown field type %{symbol}, expected one of :counter, :map, or :set."
       unknown_inner_field: "Unknown field type %{symbol}, expected one of :counter, :flag, :map, :register, or :set."
+      unexpected_type: "Tried to initialize %{expected}, found unexpected %{given}."
+      unrecognized_type: "Couldn't determine CRDT class for datatype %{type}"
       serialize_no_ops: "Can't serialize an empty list of CRDT operations."
       flag:
         not_boolean: "Flags can only be true or false."
@@ -49,7 +52,7 @@ en:
     invalid_ssl_verify_mode: "%{invalid} is not a valid :verify_mode option for SSL. Valid options are 'peer' and 'none'."
     invalid_index_query: "%{value} is not a valid index query term, only Strings, Integers, and Ranges of those are allowed."
     indexes_unsupported: "Riak server does not support secondary indexes."
-    loading_bucket: "while loading bucket '%{name}'"    
+    loading_bucket: "while loading bucket '%{name}'"
     list_buckets: "Riak::Client#buckets is an expensive operation that should not be used in production.\n    %{backtrace}"
     list_keys: "Riak::Bucket#keys is an expensive operation that should not be used in production.\n    %{backtrace}"
     missing_block: "A block must be given."
@@ -75,6 +78,7 @@ en:
       index_non_exist: "The index %{index} doesn't exist."
       index_argument_error: "invalid argument %{index} is not a Riak::Search::Index or a String"
       schema_exists: "The schema %{name} already exists."
+      unexpected_result: "Expected %{expected} but got %{actual} from search result."
     search_unsupported: "Riak server does not support search."
     search_docs_require_id: "Search index documents must include the 'id' field."
     search_remove_requires_id_or_query: "Search index documents to be removed must have 'id' or 'query' keys."

data/lib/riak/map_reduce.rb

@@ -85,7 +85,7 @@ module Riak
           else
             bucket = maybe_escape(bucket)
           end
-          
+
           warn(t('full_bucket_mapred', :backtrace => caller.join("\n    "))) unless Riak.disable_list_keys_warnings
           @inputs = {:bucket => bucket, :key_filters => params.first }
         else
@@ -246,13 +246,13 @@ module Riak
 
     # Processes a {RObject} into a single-object {MapReduce} input, whether it
     # has a bucket type or not.
-    def robject_input(obj, key_data='')
+    def robject_input(obj, key_data = '')
       bucket = obj.bucket
       if bucket.needs_type?
         return [
-                maybe_escape(bucket.name), 
-                maybe_escape(obj.key), 
-                key_data, 
+                maybe_escape(bucket.name),
+                maybe_escape(obj.key),
+                key_data,
                 maybe_escape(bucket.type.name)
                ]
       end
@@ -263,13 +263,13 @@ module Riak
     # Processes a key into a single-object {MapReduce} input, doing the correct
     # thing if the bucket argument is a {String}, {Bucket}, or a
     # {BucketTyped::Bucket}.
-    def key_input(key, bucket, key_data='')     
+    def key_input(key, bucket, key_data = '')
       kd = []
       kd << key_data unless key_data.blank?
 
       if bucket.is_a? String
         return [
-                maybe_escape(bucket), 
+                maybe_escape(bucket),
                 maybe_escape(key)
                ] + kd
       elsif bucket.needs_type?

data/lib/riak/map_reduce/filter_builder.rb

@@ -28,7 +28,7 @@ module Riak
         :less_than => 1,
         :greater_than_eq => 1,
         :less_than_eq => 1,
-        :between => [2,3],
+        :between => [2, 3],
         :matches => 1,
         :neq => 1,
         :eq => 1,
@@ -52,7 +52,7 @@ module Riak
       #    end
       LOGICAL_OPERATIONS = %w{and or not}
 
-      FILTERS.each do |f,arity|
+      FILTERS.each do |f, arity|
         arities = [arity].flatten
 
         define_method(f) { |*args|

data/lib/riak/map_reduce/phase.rb

@@ -31,7 +31,7 @@ module Riak
       # @option options [String, Array, Hash] :function In the case of Javascript, a literal function in a string, or a hash with :bucket and :key. In the case of Erlang, an Array of [module, function].  For a :link phase, a hash including any of :bucket, :tag or a WalkSpec.
       # @option options [Boolean] :keep (false) whether to return the results of this phase
       # @option options [Array] :arg (nil) any extra static arguments to pass to the phase
-      def initialize(options={})
+      def initialize(options = {})
         self.type = options[:type]
         self.language = options[:language] || "javascript"
         self.function = options[:function]
@@ -70,7 +70,7 @@ module Riak
 
       # Converts the phase to its JSON-compatible representation for job invocation.
       # @return [Hash] a Hash-equivalent of the phase
-      def as_json(options=nil)
+      def as_json(options = nil)
         obj = case type
               when :map, :reduce
                 defaults = {"language" => language, "keep" => keep}

data/lib/riak/preflist_item.rb

@@ -0,0 +1,7 @@
+require 'riak'
+
+module Riak
+  # @abstract Parent module for preflist items
+  module PreflistItem
+  end
+end

data/lib/riak/rcontent.rb

@@ -52,7 +52,7 @@ module Riak
     end
 
     def indexes=(hash)
-      @indexes = hash.inject(new_index_hash) do |h, (k,v)|
+      @indexes = hash.inject(new_index_hash) do |h, (k, v)|
         h[k].merge([*v])
         h
       end
@@ -68,9 +68,9 @@ module Riak
       @data
     end
 
-    # @param [Object] new_data unmarshaled form of the data to be stored in 
-    #   Riak. Object will be serialized using {#serialize} if a known 
-    #   content_type is used. Setting this overrides values stored with 
+    # @param [Object] new_data unmarshaled form of the data to be stored in
+    #   Riak. Object will be serialized using {#serialize} if a known
+    #   content_type is used. Setting this overrides values stored with
     #   {#raw_data=}
     # @return [Object] the object stored
     def data=(new_data)
@@ -142,14 +142,14 @@ module Riak
       extract_if_present(metadata, 'content-type', :content_type)
       extract_if_present(metadata, 'X-Riak-Last-Modified', :last_modified) { |v| Time.httpdate( v ) }
       extract_if_present(metadata, 'index', :indexes) do |entries|
-        Hash[ entries.map {|k,v| [k, Set.new(Array(v))] } ]
+        Hash[ entries.map {|k, v| [k, Set.new(Array(v))] } ]
       end
       extract_if_present(metadata, 'Links', :links) do |links|
         Set.new( links.map { |l| Link.new(*l) } )
       end
       extract_if_present(metadata, 'X-Riak-Meta', :meta) do |meta|
         Hash[
-             meta.map do |k,v|
+             meta.map do |k, v|
                [k.sub(%r{^x-riak-meta-}i, ''), [v]]
              end
             ]
@@ -158,7 +158,7 @@ module Riak
     end
 
     private
-    def extract_if_present(hash, key, attribute=nil)
+    def extract_if_present(hash, key, attribute = nil)
       if hash[key].present?
         attribute ||= key
         value = block_given? ? yield(hash[key]) : hash[key]
@@ -167,7 +167,7 @@ module Riak
     end
 
     def new_index_hash
-      Hash.new {|h,k| h[k] = Set.new }
+      Hash.new {|h, k| h[k] = Set.new }
     end
   end
 end

data/lib/riak/robject.rb

@@ -12,7 +12,7 @@ module Riak
   # the Riak database, the base unit of data manipulation.
   class RObject
     include Util::Translation
-    extend  Util::Translation
+    extend Util::Translation
     include Util::Escape
     extend Util::Escape
     extend Forwardable
@@ -23,13 +23,15 @@ module Riak
     # @return [String] the key of this object within its bucket
     attr_accessor :key
 
-    # @return [String] the Riak vector clock for the object
+    # @return [String] the Riak causal context/vector clock for the object
     attr_accessor :vclock
 
+    alias :causal_context :vclock
+    alias :causal_context= :vclock=
     alias :vector_clock :vclock
     alias :vector_clock= :vclock=
 
-    # @return [Boolean] whether to attempt to prevent stale writes using 
+    # @return [Boolean] whether to attempt to prevent stale writes using
     #   conditional PUT semantics, If-None-Match: * or If-Match: etag
     # @see http://wiki.basho.com/display/RIAK/REST+API#RESTAPI-Storeaneworexistingobjectwithakey Riak Rest API Docs
     attr_accessor :prevent_stale_writes
@@ -94,7 +96,7 @@ module Riak
     # @param [String] key the key at which the object resides. If nil, a key will be assigned when the object is saved.
     # @yield self the new RObject
     # @see Bucket#get
-    def initialize(bucket, key=nil)
+    def initialize(bucket, key = nil)
       @bucket, @key = bucket, key
 
       # fix a require-loop
@@ -108,8 +110,8 @@ module Riak
     end
 
     # Load object data from a map/reduce response item.
-    # This method is used by RObject::load_from_mapreduce to instantiate the necessary
-    # objects.
+    # This method is used by RObject::load_from_mapreduce to instantiate the
+    # necessary objects.
     # @param [Hash] response a response from {Riak::MapReduce}
     # @return [RObject] self
     def load_from_mapreduce(response)
@@ -124,17 +126,21 @@ module Riak
 
     # Store the object in Riak
     # @param [Hash] options query parameters
-    # @option options [Fixnum] :r the "r" parameter (Read quorum for the implicit read performed when validating the store operation)
+    # @option options [Fixnum] :r the "r" parameter (Read quorum for the
+    #   implicit read performed when validating the store operation)
     # @option options [Fixnum] :w the "w" parameter (Write quorum)
     # @option options [Fixnum] :dw the "dw" parameter (Durable-write quorum)
-    # @option options [Boolean] :returnbody (true) whether to return the result of a successful write in the body of the response. Set to false for fire-and-forget updates, set to true to immediately have access to the object's stored representation.
+    # @option options [Boolean] :returnbody (true) whether to return the result
+    #   of a successful write in the body of the response. Set to false for
+    #   fire-and-forget updates, set to true to immediately have access to the
+    #   object's stored representation.
     # @return [Riak::RObject] self
     # @raise [ArgumentError] if the content_type is not defined
     # @raise [Conflict] if the object has siblings
-    def store(options={})
-      raise Conflict, self if conflict?
-      raise ArgumentError, t("content_type_undefined") unless content_type.present?
-      raise ArgumentError, t("zero_length_key") if key == ''
+    def store(options = {})
+      fail Conflict, self if conflict?
+      fail ArgumentError, t('content_type_undefined') unless content_type.present?
+      fail ArgumentError, t('zero_length_key') if key == ''
       @bucket.client.store_object(self, default(options))
       self
     end
@@ -146,7 +152,7 @@ module Riak
     #     the vclock is not present, useful for reloading the object after
     #     a store (not passed in the query params)
     # @return [Riak::RObject] self
-    def reload(options={})
+    def reload(options = {})
       force = options.delete(:force)
       return self unless @key && (@vclock || force)
       self.etag = self.last_modified = nil if force
@@ -158,7 +164,7 @@ module Riak
     # Delete the object from Riak and freeze this instance.  Will work whether or not the object actually
     # exists in the Riak database.
     # @see Bucket#delete
-    def delete(options={})
+    def delete(options = {})
       return if key.blank?
       options[:vclock] = vclock if vclock
       @bucket.delete(key, default(options))
@@ -197,6 +203,13 @@ module Riak
       Link.new(@bucket.name, @key, tag)
     end
 
+    # Retrieves a preflist for this RObject; useful for
+    # figuring out where in the cluster it is stored.
+    # @return [Array<PreflistItem>] an array of preflist entries
+    def preflist(options = {})
+      bucket.get_preflist key, options
+    end
+
     private
 
     def default(options)

data/lib/riak/search.rb

@@ -8,3 +8,4 @@ require 'riak/search/query'
 require 'riak/search/result_collection'
 require 'riak/search/result_document'
 require 'riak/search/schema'
+require 'riak/errors/search_error'

data/lib/riak/search/index.rb

@@ -6,9 +6,14 @@ module Riak::Search
   # bucket or bucket type property must be configured to use the index in order
   # for new and updated documents to be indexed and searchable.
   class Index
+    # @!attribute [r] name
     # @return [String] the name of the index
     attr_reader :name
 
+    # @!attribute [r] client
+    # @return [Riak::Client] the client to operate on the index with
+    attr_reader :client
+
     # Initializes an index object, that may or may not exist.
     #
     # @param [Riak::Client] client the client connected to the Riak cluster
@@ -36,13 +41,13 @@ module Riak::Search
 
     # Attempt to create this index
     #
-    # @raise [Riak::SearchError::IndexExistsError] if an index with the given 
+    # @raise [Riak::SearchError::IndexExistsError] if an index with the given
     #   name already exists
-    def create!(schema = nil, n_val = nil)
+    def create!(schema = nil, n_val = nil, timeout = nil)
       raise Riak::SearchError::IndexExistsError.new name if exists?
 
       @client.backend do |b|
-        b.create_search_index name, schema, n_val
+        b.create_search_index name, schema, n_val, timeout
       end
 
       @index_data = nil
@@ -50,6 +55,15 @@ module Riak::Search
       true
     end
 
+    # Create a {Riak::Search::Query} using this index and client
+    #
+    # @param [String] term the query term
+    # @param [Hash] options a hash of options to set attributes on the query
+    # @return [Riak::Search::Query] a query using this index
+    def query(term, options = {  })
+      Riak::Search::Query.new(@client, self, term, options)
+    end
+
     private
     def index_data
       return @index_data if defined?(@index_data) && @index_data

data/lib/riak/search/query.rb

@@ -3,7 +3,7 @@ require 'riak/search'
 module Riak::Search
   # A {Riak::Search::Query} wraps a Solr query for Riak Search 2.
   class Query
-    
+
     # @!attribute rows
     # @return [Numeric] the number of rows to return from the query
     attr_accessor :rows
@@ -36,6 +36,14 @@ module Riak::Search
     # @return [String] the term to query
     attr_reader :term
 
+    # @!attribute [r] index
+    # @return [Riak::Search::Index] the index to query against
+    attr_reader :index
+
+    # @!attribute [r] client
+    # @return [Riak::Client] the client to query against
+    attr_reader :client
+
     # Initializes a query object.
     #
     # @param [Riak::Client] client the client connected to the Riak cluster
@@ -43,7 +51,7 @@ module Riak::Search
     #   {Riak::Search::Index} instance or a {String}
     # @param [String] term the query term
     # @param [Hash] options a hash of options to quickly set attributes
-    def initialize(client, index, term, options={  })
+    def initialize(client, index, term, options = {  })
       @client = client
       validate_index index
       @term = term
@@ -63,7 +71,7 @@ module Riak::Search
     end
 
     private
-    
+
     def index_name
       return @index if @index.is_a? String
       return @index.name
@@ -95,14 +103,14 @@ module Riak::Search
       @df = %w{text}
       @op = nil
       @fl = %w{_yz_rb _yz_rk _yz_rt score}
-      
+
       @presort = nil
     end
 
     def consume_options
       @rows = @options[:rows] if @options[:rows]
       @start = @options[:start] if @options[:start]
-      
+
       @sort = @options[:sort] if @options[:sort]
       @filter = @options[:filter] if @options[:filter]
 
@@ -112,7 +120,7 @@ module Riak::Search
     end
 
     def prepare_options
-      configured_options = { 
+      configured_options = {
         rows: @rows,
         start: @start,
         sort: @sort,