riak-client 2.2.0.pre1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 516d08bb526f4cffe8b94314f766a3424e58b884
-  data.tar.gz: 317c345920e67e8035662a5ecf7ab6aaf5533774
+  metadata.gz: 2dd52a7e386245c3d3dc1d7c1be2ba94b3dd2c91
+  data.tar.gz: 48ed739d11831361ca42d2c8291753c9d87c7124
 SHA512:
-  metadata.gz: 9b251487856bf8dfba41427a8f1370a97541662d47c5047ee5d6a5f7f2b7567630a32b741cd821ce2320adae76ca4e334672f6fef267e7b7117941b1b77c1d0a
-  data.tar.gz: f4da60a9d5a7254e9541fa87e97fd32acd67da05a5024d972cb23e23ff1e30d93601c132266d29200eb907bdbcc9141495b6b7d490ea5f8f7f3ab3559dbc3ce6
+  metadata.gz: dc420b627bd2854197b03468a4aaf09895eb267f601fb285280788ff73754266b098d9fac1251354f662853eb8e4c73973a75874d040e9fa3019a64adac6d86a
+  data.tar.gz: f07cc587b55e1b54662b86f3ca572df999f89511ed8ae340ed935848a410d5b9bcb7947f7cc96a569121ddc270e595eedf9e19518f1266fa0cbe7b7d04e5229a

data/.gitignore

@@ -39,3 +39,4 @@ vendor/erlang
 vendor/riak
 .ruby-version
 tmp
+tags

data/Gemfile

@@ -15,5 +15,3 @@ end
 platforms :jruby, :rbx do
   gem 'json'
 end
-
-gem 'beefcake', '1.1.0.pre1'

data/README.markdown

@@ -5,9 +5,13 @@ distributed database that contains a basic wrapper around typical
 operations, including bucket manipulation, object CRUD, link-walking,
 and map-reduce.
 
+Exhaustive documentation is available at
+http://basho.github.io/riak-ruby-client/ , and API documentation can be
+read at http://www.rubydoc.info/gems/riak-client/frames .
+
 ## Dependencies
 
-Ruby 1.9.3, 2.0, and 2.1 are supported. JRuby in 1.9 and 2.0 modes are
+Ruby 1.9.3, 2.0, 2.1, and 2.2 are supported. JRuby in 1.9 and 2.0 modes are
 also supported. `riak-client` is not compatible with Ruby 1.8.
 
 In JRuby 1.7.13, OCSP validation is absent, and CRL validation always
@@ -19,25 +23,25 @@ when it works.
 [1]: https://github.com/jruby/jruby-openssl/issues/5
 [2]: https://github.com/basho/riak_api/issues/65
 
-`riak-client` requires i18n, builder, beefcake, and multi_json. The
-cache store implementation requires ActiveSupport 3 or later.
+`riak-client` requires beefcake, cert_validator, i18n, innertube, and
+multi_json.
 
 Development dependencies are handled with bundler. Install bundler
 (`gem install bundler`) and run this command to get started:
 
-``` bash
+```bash
 $ bundle install
 ```
 
 Run the RSpec suite using `bundle exec`:
 
-``` bash
+```bash
 $ bundle exec rake
 ```
 
 ## Basic Example
 
-``` ruby
+```ruby
 require 'riak'
 
 # Create a client interface
@@ -622,7 +626,7 @@ search.admin,search.query,riak_kv.mapreduce on any to user
 
 ## License & Copyright
 
-Copyright ©2010-2014 Sean Cribbs and Basho Technologies, Inc.
+Copyright ©2010-2015 Sean Cribbs and Basho Technologies, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 

data/RELEASE_NOTES.md

@@ -1,5 +1,32 @@
 # Riak Ruby Client Release Notes
 
+## 2.2.0 Release - 2015-05-27
+
+Version 2.2.0 is a feature release.
+
+New features:
+
+* Object-oriented Riak Search (Yokozuna) API.
+* Object-oriented Bucket Properties API.
+* Bucket type properties are readable.
+* Bucket-typed buckets without properties expose properties of bucket type.
+* An interface to get a preflist for Riak KV objects has been added.
+
+Small improvements and changes:
+
+* In line with recent Riak documentation and implementation changes, `vclock`
+  can also be referred to as `causal_context`.
+* Support for synchronous Riak Search index creation with timeouts has been
+  added.
+
+Bug fixes:
+
+* Accessing a flag in a non-existent CRDT map returns false now.
+* Escaping text in situations that require it is faster, thanks to Jordan
+  Goldstein.
+* Loading and storing objects from bucket-typed buckets is more reliable and
+  correct thanks to Takeshi Akima.
+
 ## 2.1.0 Release - 2014-10-03
 
 Version 2.1.0 is a feature release.
@@ -88,7 +115,7 @@ Features for all Riak versions:
 
 * Multi-get parallelizes fetching multiple objects from one or more
   buckets.
-  
+
 Features for Riak 1.4 and newer:
 
 * Bucket properties are settable and resettable over Protocol Buffers.
@@ -209,7 +236,7 @@ Changes in 1.0.4:
 * A function in the `app_helper` module that does not exist on Riak
   1.1 and earlier was copied into the KV test backend.
 * Excon's configuration logic was made more idempotent.
-* Added timeout support to the Excon HTTP backend. [Mat Brown] 
+* Added timeout support to the Excon HTTP backend. [Mat Brown]
 * Corrected an misnamed constant in Excon which would cause timeouts
   not to be recognized as network errors.
 * The `Riak::TestServer` is now compatible with Riak 1.2.

data/Rakefile

@@ -92,13 +92,13 @@ namespace :beefcake do
 
   PROTO_FILES = %w{riak_kv riak_search riak_yokozuna riak_dt}
   PROTO_TMP = PROTO_FILES.map{|f| "tmp/#{f}.pb.rb"}
-  
+
   task :clean do
     sh "rm -rf tmp/riak_pb"
     sh "rm -rf #{PROTO_TMP.join ' '}"
   end
 
-  
+
   file 'lib/riak/client/beefcake/messages.rb' => PROTO_TMP do |t|
     sh "cat lib/riak/client/beefcake/header tmp/riak.pb.rb #{t.prerequisites.join ' '} lib/riak/client/beefcake/footer > #{t.name}"
   end
@@ -109,7 +109,9 @@ namespace :beefcake do
     end
   end
 
-  directory 'tmp/riak_pb' do
+  directory 'tmp'
+
+  directory 'tmp/riak_pb' => 'tmp' do
     cd 'tmp' do
       sh "git clone -b develop https://github.com/basho/riak_pb.git"
     end

data/lib/riak/bucket.rb

@@ -37,7 +37,7 @@ module Riak
     # @return [Array<String>] Keys in this bucket
     # @note This operation has serious performance implications and
     #    should not be used in production applications.
-    def keys(options={}, &block)
+    def keys(options = {}, &block)
       warn(t('list_keys', :backtrace => caller.join("\n    "))) unless Riak.disable_list_keys_warnings
       if block_given?
         @client.list_keys(self, options, &block)
@@ -51,7 +51,8 @@ module Riak
     # @param [Hash] properties new properties for the bucket
     # @option properties [Fixnum] :n_val (3) The N value (replication factor)
     # @option properties [true,false] :allow_mult (false) Whether to permit object siblings
-    # @option properties [true,false] :last_write_wins (false) Whether to ignore vclocks
+    # @option properties [true,false] :last_write_wins (false) Whether to ignore
+    #   causal context in regular key-value buckets
     # @option properties [Array<Hash>] :precommit ([]) precommit hooks
     # @option properties [Array<Hash>] :postcommit ([])postcommit hooks
     # @option properties [Fixnum,String] :r ("quorum") read quorum (numeric or
@@ -92,10 +93,12 @@ module Riak
     # Retrieve an object from within the bucket.
     # @param [String] key the key of the object to retrieve
     # @param [Hash] options query parameters for the request
-    # @option options [Fixnum] :r - the read quorum for the request - how many nodes should concur on the read
+    # @option options [Fixnum] :r - the read quorum for the request - how many
+    #   nodes should concur on the read
     # @return [Riak::RObject] the object
-    # @raise [FailedRequest] if the object is not found or some other error occurs
-    def get(key, options={})
+    # @raise [FailedRequest] if the object is not found or some other error
+    #   occurs
+    def get(key, options = {})
       @client.get_object(self, key, options)
     end
     alias :[] :get
@@ -106,22 +109,26 @@ module Riak
     def get_many(keys)
       pairs = keys.map{|k| [self, k]}
       results = Multiget.get_all @client, pairs
-      results.keys.inject(Hash.new) { |mem, var| mem[var[1]] = results[var]; mem }
+      results.keys.inject(Hash.new) do |mem, var|
+        mem[var[1]] = results[var]
+        mem
+      end
     end
 
     # Create a new blank object
     # @param [String] key the key of the new object
     # @return [RObject] the new, unsaved object
-    def new(key=nil)
+    def new(key = nil)
       RObject.new(self, key).tap do |obj|
         obj.content_type = "application/json"
       end
     end
 
-    # Fetches an object if it exists, otherwise creates a new one with the given key
+    # Fetches an object if it exists, otherwise creates a new one with the
+    # given key
     # @param [String] key the key to fetch or create
     # @return [RObject] the new or existing object
-    def get_or_new(key, options={})
+    def get_or_new(key, options = {})
       begin
         get(key, options)
       rescue Riak::FailedRequest => fr
@@ -146,7 +153,7 @@ module Riak
     # @param [Hash] options quorum options
     # @option options [Fixnum] :r - the read quorum value for the request (R)
     # @return [true, false] whether the key exists in this bucket
-    def exists?(key, options={})
+    def exists?(key, options = {})
       begin
         get(key, options.merge({ :head => true }))
         true
@@ -162,9 +169,9 @@ module Riak
     # @param [Hash] options quorum options
     # @option options [Fixnum] :rw - the read/write quorum for the
     #   delete
-    # @option options [String] :vclock - the vector clock of the
+    # @option options [String] :vclock - the causal context/vector clock of the
     #   object being deleted
-    def delete(key, options={})
+    def delete(key, options = {})
       client.delete_object(self, key, options)
     end
 
@@ -175,16 +182,27 @@ module Riak
     #   Range of values to query
     # @return [Array<String>] a list of keys that match the index
     #   query
-    def get_index(index, query, options={})
+    def get_index(index, query, options = {})
       client.get_index(self, index, query, options)
     end
 
+
+    # Retrieves a preflist for the given key; useful for
+    # figuring out where in the cluster an object is stored.
+    # @param [String] key the key
+    # @return [Array<PreflistItem>] an array of preflist entries
+    def get_preflist(key, options = {  })
+      type = self.type.name if needs_type?
+      client.get_preflist self, key, type, options
+    end
+
     # @return [true, false] whether the bucket allows divergent siblings
     def allow_mult
       props['allow_mult']
     end
 
-    # Set the allow_mult property.  *NOTE* This will result in a PUT request to Riak.
+    # Set the allow_mult property.  *NOTE* This will result in a PUT request to
+    # Riak.
     # @param [true, false] value whether the bucket should allow siblings
     def allow_mult=(value)
       self.props = {'allow_mult' => value}
@@ -197,9 +215,11 @@ module Riak
     end
     alias :n_val :n_value
 
-    # Set the N value (number of replicas). *NOTE* This will result in a PUT request to Riak.
-    # Setting this value after the bucket has objects stored in it may have unpredictable results.
-    # @param [Fixnum] value the number of replicas the bucket should keep of each object
+    # Set the N value (number of replicas). *NOTE* This will result in a PUT
+    # request to Riak. Setting this value after the bucket has objects stored in
+    # it may have unpredictable results.
+    # @param [Fixnum] value the number of replicas the bucket should keep of
+    #   each object
     def n_value=(value)
       self.props = {'n_val' => value}
       value
@@ -218,15 +238,21 @@ module Riak
     # into riak_search.
     def enable_index!
       unless is_indexed?
-        self.props = {"precommit" => (props['precommit'] + [SEARCH_PRECOMMIT_HOOK]), "search" => true}
+        self.props = {
+          "precommit" => (props['precommit'] + [SEARCH_PRECOMMIT_HOOK]),
+          "search" => true
+        }
       end
     end
 
-    # (Riak Search) Removes the precommit hook that automatically indexes objects
-    # into riak_search.
+    # (Riak Search) Removes the precommit hook that automatically indexes
+    # objects into riak_search.
     def disable_index!
       if is_indexed?
-        self.props = {"precommit" => (props['precommit'] - [SEARCH_PRECOMMIT_HOOK]), "search" => false}
+        self.props = {
+          "precommit" => (props['precommit'] - [SEARCH_PRECOMMIT_HOOK]),
+          "search" => false
+        }
       end
     end
 
@@ -234,7 +260,10 @@ module Riak
     # riak_search.
     # @return [true,false] whether the bucket includes the search indexing hook
     def is_indexed?
-      props['search'] == true || (props.has_key?('precommit') && props['precommit'].include?(SEARCH_PRECOMMIT_HOOK))
+      return true if props['search'] == true
+      return true if props.has_key?('precommit') &&
+                     props['precommit'].include?(SEARCH_PRECOMMIT_HOOK)
+      false
     end
 
     # @return [String] a representation suitable for IRB and debugging output
@@ -259,7 +288,10 @@ module Riak
 
     # @return [true,false] whether the other is equivalent
     def ==(other)
-      Bucket === other && other.client == client && other.name == name
+      return false unless self.class == other.class
+      return false unless self.client == other.client
+      return false unless self.name == other.name
+      true
     end
   end
 end

data/lib/riak/bucket_properties.rb

@@ -30,7 +30,7 @@ module Riak
       return true
     end
 
-    # Take bucket properties from a given {Hash} or {Riak::BucketProperties} 
+    # Take bucket properties from a given {Hash} or {Riak::BucketProperties}
     # object.
     # @param [Hash<String, Object>, Riak::BucketProperties] other
     def merge!(other)
@@ -54,6 +54,7 @@ module Riak
     # @param [String] property_name
     # @param [Object] value
     def []=(property_name, value)
+      value = unwrap_index(value) if property_name == 'search_index'
       cached_props[property_name.to_s] = value
     end
 
@@ -63,5 +64,11 @@ module Riak
         be.bucket_properties_operator.get bucket
       end
     end
+
+    def unwrap_index(value)
+      return value.name if value.is_a? Riak::Search::Index
+
+      value
+    end
   end
 end

data/lib/riak/bucket_type.rb

@@ -1,4 +1,5 @@
 require 'riak/bucket_typed/bucket'
+require 'riak/errors/crdt_error'
 
 module Riak
   # A representation of a bucket type
@@ -44,5 +45,33 @@ module Riak
     end
     alias :props :properties
 
+    # Return the data type used for handling the CRDT stored in this bucket
+    # type.
+    # Returns `nil` for a non-CRDT bucket type.
+    # @raise [Riak::CrdtError::UnrecognizedDataType] if the bucket type has an
+    #   unknown datatype
+    # @return [Class<Riak::Crdt::Base>] CRDT subclass to use with this bucket
+    #   type
+    def data_type_class
+      return nil unless dt = properties[:datatype]
+      parent = Riak::Crdt
+      case dt
+      when 'counter'
+        parent::Counter
+      when 'map'
+        parent::Map
+      when 'set'
+        parent::Set
+      else
+        raise CrdtError::UnrecognizedDataType.new dt
+      end
+    end
+
+    def ==(other)
+      return false unless self.class == other.class
+      return false unless self.client == other.client
+      return false unless self.name == other.name
+      true
+    end
   end
 end

data/lib/riak/bucket_typed/bucket.rb

@@ -2,16 +2,16 @@ require 'riak/bucket'
 require 'riak/bucket_type'
 
 module Riak
-  
+
   # Container module for subclasses of objects with bucket type data attached.
   # Currently only used for {BucketTyped::Bucket}.
   module BucketTyped
-  
+
     # A bucket that has a {BucketType} attached to it. Normally created using
     # the {BucketType#bucket} method. Inherits most of its behavior from the
     # {Riak::Bucket} class.
     class Bucket < Riak::Bucket
-      
+
       # @return [BucketType] the bucket type used with this bucket
       attr_reader :type
 
@@ -37,8 +37,10 @@ module Riak
       # @option options [Fixnum] :r - the read quorum for the request - how many nodes should concur on the read
       # @return [Riak::RObject] the object
       # @raise [FailedRequest] if the object is not found or some other error occurs
-      def get(key, options={  })
-        super key, o(options)
+      def get(key, options = {  })
+        object = super key, o(options)
+        object.bucket = self
+        return object
       end
       alias :[] :get
 
@@ -49,7 +51,7 @@ module Riak
       #   delete
       # @option options [String] :vclock - the vector clock of the
       #   object being deleted
-      def delete(key, options={  })
+      def delete(key, options = {  })
         super key, o(options)
       end
 
@@ -61,7 +63,7 @@ module Riak
       # @return [Array<String>] Keys in this bucket
       # @note This operation has serious performance implications and
       #    should not be used in production applications.
-      def keys(options={  }, &block)
+      def keys(options = {  }, &block)
         super o(options), &block
       end
 
@@ -103,6 +105,12 @@ module Riak
         return false
       end
 
+      def ==(other)
+        return false unless self.class == other.class
+        return false unless self.type == other.type
+        super
+      end
+
       private
       # merge in the type name with options
       def o(options)