riak-client 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad40ac9eb63589a4a5ec590cec005f72da1d5865
-  data.tar.gz: 728c720266417b1f07e0d2078b83deb49341e004
+  metadata.gz: ca7b5752fe722de4af5c0adceec72adf47c80241
+  data.tar.gz: 0a2b4e34fefb8b5c7a9ecef6fd06d8372616ba2c
 SHA512:
-  metadata.gz: d74e7d77692280c40f0777b0c80dad5455592584e116f1ea12a9eeca2d53e14bd38b32cca201fafd15550767d305a13ae2127376c3fef4339204ed1d860f554f
-  data.tar.gz: 8073b45333abf60fb4965afea5eaca555b44761abe08089295f742d1bcd937c0ee8027319f0c65f3d86e0caf57cc63ae5b538430fc161d500939c885650045b2
+  metadata.gz: 43600350e10122607eaca375a69225285a28403041e231d3bf527c04c90fedde75fc7136f7bd626d3ea448e0ecfd4deed10e8707e6a12605077662edb72a60f0
+  data.tar.gz: 1b3e910ec530a8d9e41a333b376918608aac4398be8b15af478978323e22f94cd407e008a43135c2f4bb12914e4e1ea998d88ac6acf19201242c3bd9eac6e0e9

data/README.markdown

@@ -50,7 +50,7 @@ client = Riak::Client.new(authentication: {
 
       # username, required
       user: 'zedo',
-      
+
       # password for password-based authentication
       password: 'catnip',
 
@@ -97,7 +97,7 @@ new_one.store
 ## Bucket Types
 
 Riak 2 uses [bucket types](http://docs.basho.com/riak/latest/dev/advanced/bucket-types/) to
-enable groups of similar buckets to share properties, configuration, and to namespace values 
+enable groups of similar buckets to share properties, configuration, and to namespace values
 within those buckets. Bucket type support is integral to how CRDTs work.
 
 Many operations take `type` options to perform them with a specific bucket type.
@@ -133,9 +133,9 @@ results = Riak::MapReduce.new(client).
                 link(:bucket => "albums").
                 map("function(v){ return [JSON.parse(v.values[0].data).title]; }", :keep => true).run
 
-p results # => ["Please Please Me", "With The Beatles", "A Hard Day's Night", 
+p results # => ["Please Please Me", "With The Beatles", "A Hard Day's Night",
           #     "Beatles For Sale", "Help!", "Rubber Soul",
-          #     "Revolver", "Sgt. Pepper's Lonely Hearts Club Band", "Magical Mystery Tour", 
+          #     "Revolver", "Sgt. Pepper's Lonely Hearts Club Band", "Magical Mystery Tour",
           #     "The Beatles", "Yellow Submarine", "Abbey Road", "Let It Be"]
 ```
 
@@ -151,7 +151,7 @@ client = Riak::Client.new
 bucket = client.bucket 'pizzas'
 
 # Create an index and add it to a typed bucket. Setting the index on the bucket
-# may fail until the index creation has propagated. 
+# may fail until the index creation has propagated.
 client.create_search_index 'pizzas'
 client.set_bucket_props bucket, {search_index: 'pizzas'}, 'yokozuna'
 
@@ -172,7 +172,7 @@ result['docs']      # the list of indexed documents
 
 ## Secondary Index Examples
 
-Riak supports secondary indexes. Secondary indexing, or "2i," gives you the 
+Riak supports secondary indexes. Secondary indexing, or "2i," gives you the
 ability to tag objects with multiple queryable values at write time, and then
 query them later.
 
@@ -187,7 +187,7 @@ storage logic is in `lib/riak/rcontent.rb`.
 ```ruby
 object = bucket.get_or_new 'cobb.salad'
 
-# Indexes end with the "_bin" suffix to indicate they're binary or string 
+# Indexes end with the "_bin" suffix to indicate they're binary or string
 # indexes. They can have multiple values.
 object.indexes['ingredients_bin'] = %w{lettuce tomato bacon egg chives}
 
@@ -201,7 +201,7 @@ object.store
 
 ### Finding Objects
 
-Secondary index queries return a list of keys exactly matching a scalar or 
+Secondary index queries return a list of keys exactly matching a scalar or
 within a range.
 
 ```ruby
@@ -238,12 +238,12 @@ q2 = q.next_page
 
 ## Riak 2 Data Types
 
-Riak 2 features new distributed data structures: counters, sets, and maps 
-(containing counters, flags, maps, registers, and sets).  These are implemented 
+Riak 2 features new distributed data structures: counters, sets, and maps
+(containing counters, flags, maps, registers, and sets).  These are implemented
 by the Riak database as Convergent Replicated Data Types.
 
 Riak data type support requires bucket types to be configured to support each
-top-level data type. If you're just playing around, use the 
+top-level data type. If you're just playing around, use the
 [Riak Ruby Vagrant](https://github.com/basho-labs/riak-ruby-vagrant) setup to
 get started with the appropriate configuration and bucket types quickly.
 
@@ -438,6 +438,49 @@ ArgumentError: Counters can only be incremented or decremented by integers.
 
 That's about it. PN Counters in Riak are distributed, so each node will receive the proper increment/decrement operation. Enjoy using them.
 
+## Instrumentation
+
+The Riak client has built-in event hooks for all major over-the-wire operations including:
+
+* riak.list_buckets
+* riak.list_keys
+* riak.set_bucket_props
+* riak.get_bucket_props
+* riak.clear_bucket_props
+* riak.get_index
+* riak.store_object
+* riak.get_object
+* riak.reload_object
+* riak.delete_object
+* riak.map_reduce
+* riak.ping
+
+Events are propogated using [ActiveSupport::Notifications](http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html), provided by the [Instrumentable](https://github.com/siyegen/instrumentable) gem.
+
+### Enabling
+
+Instrumentation is opt-in. If `instrumentable` is not available, instrumentation will not be available. To turn on instrumentation, simply require the `instrumentable` gem in your app's Gemfile:
+
+```ruby
+gem 'instrumentable', '~> 1.1.0'
+```
+
+Then, to subscribe to events:
+
+```ruby
+ActiveSupport::Notifications.subscribe(/^riak\.*/) do |name, start, finish, id, payload|
+  name    # => String, name of the event (such as 'riak.get_object' from above)
+  start   # => Time, when the instrumented block started execution
+  finish  # => Time, when the instrumented block ended execution
+  id      # => String, unique ID for this notification
+  payload # => Hash, the payload
+end
+```
+
+The payload for each event contains the following keys:
+
+* `:client_id`: The client_id of the Riak client
+* `:_method_args`: The array of method arguments for the instrumented method. For instance, for `riak.get_object`, this value would resemble `[<Riak::Bucket ...>, 'key', {}]`
 
 ## How to Contribute
 
@@ -480,5 +523,5 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 ## Auxillary Licenses
 
-The included photo (spec/fixtures/cat.jpg) is Copyright &copy;2009 [Sean Cribbs](http://seancribbs.com/), and is licensed under the [Creative Commons Attribution Non-Commercial 3.0](http://creativecommons.org/licenses/by-nc/3.0) license. 
+The included photo (spec/fixtures/cat.jpg) is Copyright &copy;2009 [Sean Cribbs](http://seancribbs.com/), and is licensed under the [Creative Commons Attribution Non-Commercial 3.0](http://creativecommons.org/licenses/by-nc/3.0) license.
 !["Creative Commons"](http://i.creativecommons.org/l/by-nc/3.0/88x31.png)

data/RELEASE_NOTES.md

@@ -1,6 +1,25 @@
 # Riak Ruby Client Release Notes
 
-## 2.0.0 Release - TBD
+## 2.1.0 Release - 2014-10-03
+
+Version 2.1.0 is a feature release.
+
+New features:
+
+* Instrumentation: if the `instrumentable` gem is loaded, the client exposes
+  several event hooks to `ActiveSupport::Notifications`. Read the README for
+  more information, and if you'd like other events to be instrumented, please
+  file GitHub issues. Instrumentation was developed by Ryan Daigle.
+* CRDTs support the `returnbody` option, and use it by default. This means that
+  unless specified otherwise, CRDTs will update themselves on a write.
+
+Small changes:
+
+* UTF-8 support is now tested against.
+* RSpec 3.1 is now supported, although RSpec 3.0 still works.
+* Specs no longer use gratuitous "should"s.
+
+## 2.0.0 Release - 2014-09-05
 
 Version 2.0.0 is a major new version with many new features, API changes,
 and feature removals.

data/lib/riak.rb

@@ -4,6 +4,7 @@ require 'riak/client'
 require 'riak/map_reduce'
 require 'riak/util/translation'
 require 'riak/crdt'
+require 'riak/instrumentation'
 
 # The Riak module contains all aspects of the client interface to
 # Riak.

data/lib/riak/client.rb

@@ -6,6 +6,7 @@ require 'riak/util/translation'
 require 'riak/util/escape'
 require 'riak/errors/failed_request'
 require 'riak/errors/protobuffs_error'
+require 'riak/errors/backend_creation'
 require 'riak/client/decaying'
 require 'riak/client/node'
 require 'riak/client/search'
@@ -283,7 +284,7 @@ module Riak
 
         klass.new(self, node)
       else
-        raise t('protobuffs_configuration', :backend => @protobuffs_backend)
+        raise BackendCreationError.new @protobuffs_backend
       end
     end
 

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

@@ -0,0 +1,18 @@
+class Riak::Client::BeefcakeProtobuffsBackend
+  class CrdtLoader
+    class CounterLoader
+      def self.for_value(resp)
+        return nil unless resp.counter_value
+        new resp.counter_value
+      end
+
+      def initialize(counter_value)
+        @value = counter_value
+      end
+
+      def rubyfy
+        @value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+class Riak::Client::BeefcakeProtobuffsBackend
+  class CrdtLoader
+    class MapLoader
+      def self.for_value(resp)
+        return nil unless resp.map_value
+        new resp.map_value
+      end
+
+      def initialize(map_value)
+        @value = map_value
+      end
+
+      def rubyfy
+        accum = {
+          counters: {},
+          flags: {},
+          maps: {},
+          registers: {},
+          sets: {}
+        }
+
+        contents_loop @value, accum
+      end
+
+      private
+
+      def rubyfy_inner(accum, map_value)
+        destination = accum[:maps][map_value.field.name]
+        if destination.nil?
+          destination = accum[:maps][map_value.field.name] = {
+            counters: {},
+            flags: {},
+            maps: {},
+            registers: {},
+            sets: {}
+          }
+        end
+
+        contents_loop map_value.map_value, destination
+      end
+
+      def contents_loop(rolling_value, destination)
+        return destination if rolling_value.nil?
+
+        rolling_value.each do |inner|
+          case inner.field.type
+          when MapField::MapFieldType::COUNTER
+            destination[:counters][inner.field.name] = inner.counter_value
+          when MapField::MapFieldType::FLAG
+            destination[:flags][inner.field.name] = inner.flag_value
+          when MapField::MapFieldType::MAP
+            rubyfy_inner destination, inner
+          when MapField::MapFieldType::REGISTER
+            destination[:registers][inner.field.name] = inner.register_value
+          when MapField::MapFieldType::SET
+            destination[:sets][inner.field.name] = ::Set.new inner.set_value
+          end
+        end
+
+        return destination
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+class Riak::Client::BeefcakeProtobuffsBackend
+  class CrdtLoader
+    class SetLoader
+      def self.for_value(resp)
+        return nil unless resp.set_value
+        new resp.set_value
+      end
+
+      def initialize(set_value)
+        @value = set_value
+      end
+
+      def rubyfy
+        ::Set.new @value
+      end
+    end
+  end
+end 

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

@@ -1,3 +1,7 @@
+require 'riak/client/beefcake/crdt/counter_loader'
+require 'riak/client/beefcake/crdt/map_loader'
+require 'riak/client/beefcake/crdt/set_loader'
+
 module Riak
   class Client
     class BeefcakeProtobuffsBackend
@@ -8,7 +12,7 @@ module Riak
       def crdt_loader
         return CrdtLoader.new self
       end
-      
+
       # Loads, and deserializes CRDTs from protobuffs into Ruby hashes,
       # sets, strings, and integers.
       # @api private
@@ -40,68 +44,21 @@ module Riak
           rubyfy response
         end
 
-        private
-        # Convert the protobuffs response into low-level Ruby objects.
-        def rubyfy(response)
-          return nil_rubyfy(response.type) if response.value.nil?
-          case response.type
-          when DtFetchResp::DataType::COUNTER
-            response.value.counter_value
-          when DtFetchResp::DataType::SET
-            ::Set.new response.value.set_value
-          when DtFetchResp::DataType::MAP
-            rubyfy_map response.value.map_value
-          end
-        end
-
-        # Convert a top-level map into a Ruby {Hash} of hashes.
-        def rubyfy_map(map_value)
-          accum = {
-            counters: {},
-            flags: {},
-            maps: {},
-            registers: {},
-            sets: {}
-          }
+        def get_loader_for_value(value)
+          return nil if value.nil?
 
-          rubyfy_map_contents map_value, accum
+          [CounterLoader, MapLoader, SetLoader].map do |loader|
+            loader.for_value value
+          end.compact.first
         end
 
-        # Convert a map inside another map into a Ruby {Hash}.
-        def rubyfy_inner_map(accum, map_value)
-          destination = accum[:maps][map_value.field.name]
-          if destination.nil?
-            destination = accum[:maps][map_value.field.name] = {
-              counters: {},
-              flags: {},
-              maps: {},
-              registers: {},
-              sets: {}
-            }
-          end
-          
-          rubyfy_map_contents map_value.map_value, destination
-        end
-
-        # Load the contents of a map into Ruby hashes.
-        def rubyfy_map_contents(map_value, destination)
-          return destination if map_value.nil?
-          map_value.each do |inner_mv|
-            case inner_mv.field.type
-            when MapField::MapFieldType::COUNTER
-              destination[:counters][inner_mv.field.name] = inner_mv.counter_value
-            when MapField::MapFieldType::FLAG
-              destination[:flags][inner_mv.field.name] = inner_mv.flag_value
-            when MapField::MapFieldType::MAP
-              rubyfy_inner_map destination, inner_mv
-            when MapField::MapFieldType::REGISTER
-              destination[:registers][inner_mv.field.name] = inner_mv.register_value
-            when MapField::MapFieldType::SET
-              destination[:sets][inner_mv.field.name] = ::Set.new inner_mv.set_value
-            end
-          end
+        private
+        # Convert the protobuffs response into low-level Ruby objects.
+        def rubyfy(response)
+          loader = get_loader_for_value response.value
+          return nil_rubyfy(response.type) if loader.nil?
 
-          return destination
+          return loader.rubyfy
         end
 
         # Sometimes a CRDT is empty, provide a sane default.

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

@@ -30,7 +30,8 @@ module Riak
             bucket: bucket,
             key: key,
             type: bucket_type,
-            op: serialized
+            op: serialized,
+            return_body: true,
           }.merge options
           request = DtUpdateReq.new args
           begin

data/lib/riak/client/instrumentation.rb

@@ -0,0 +1,19 @@
+class Riak::Client
+  include Instrumentable
+
+  client_payload = {client_id: :client_id}
+
+  instrument_method :buckets, 'riak.list_buckets', client_payload
+  instrument_method :list_buckets, 'riak.list_buckets', client_payload
+  instrument_method :list_keys, 'riak.list_keys', client_payload
+  instrument_method :set_bucket_props, 'riak.set_bucket_props', client_payload
+  instrument_method :get_bucket_props, 'riak.get_bucket_props', client_payload
+  instrument_method :clear_bucket_props, 'riak.clear_bucket_props', client_payload
+  instrument_method :get_index, 'riak.get_index', client_payload
+  instrument_method :store_object, 'riak.store_object', client_payload
+  instrument_method :get_object, 'riak.get_object', client_payload
+  instrument_method :reload_object, 'riak.reload_object', client_payload
+  instrument_method :delete_object, 'riak.delete_object', client_payload
+  instrument_method :mapred, 'riak.map_reduce', client_payload
+  instrument_method :ping, 'riak.ping', client_payload
+end

data/lib/riak/crdt/base.rb

@@ -112,9 +112,25 @@ module Riak
 
           break if :empty == response
           @key = response.key if response.key
+          response
         end
 
         @dirty = true
+        vivify_returnbody(result)
+
+        return true
+      end
+
+      def vivify_returnbody(result)
+        loader do |l|
+          specific_loader = l.get_loader_for_value result
+
+          return false if specific_loader.nil?
+
+          vivify specific_loader.rubyfy
+          @context = result.context unless result.context.nil?
+          @dirty = false
+        end
       end
     end
   end