riak-client 1.4.4.1 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0470172bce5c87b1894c0b14f10f3305944361b
-  data.tar.gz: a27f23fe2344aa79477f037d741621aca64acef9
+  metadata.gz: 9016aab8aba93bb63aca3046534eda1a37d06df2
+  data.tar.gz: 7fe5882b0b6435b59f335c6dd55b2282f261cdee
 SHA512:
-  metadata.gz: 83dd6430cf599ab6d682dff05bc15247ad8912c5d771dc70cd41170fb78e1b9535ccb51c89aa1d03d26f707bd34b1d3a3114e1dc0c6177504135f1f9f90bddac
-  data.tar.gz: 656b3e793a6e54820d0ab851064121d702c126619296a0ac4b911801c106e49d116fc08162390edf6f70b92c3a8aedba3d2b950ed8a085e32707803393b2add0
+  metadata.gz: b94915ad5556abb0383e804a63b1e1dd4eb95c948552a32c38f8c480a905f5a6d738bc5e1782e0d9f39aab5ae7979bdf09b0549214fa3f2fe4567d53e3165ad3
+  data.tar.gz: 07ab78ccb8117017897415215af4b08e605889a9f5b23f764ed52d7422eefabd329e66a7f4cf3ae5e3a8f59739bfbda1d0be933efc6be52cc5fa9f2d4999b16f

data/README.markdown

@@ -80,9 +80,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"]
 ```
 
@@ -137,7 +137,7 @@ client['users'].disable_index!
 
 ## 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.
 
@@ -152,7 +152,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}
 
@@ -166,7 +166,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
@@ -253,6 +253,55 @@ 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.store_file
+* riak.get_file
+* riak.delete_file
+* riak.file_exists
+* riak.link_walk
+* 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:
+
+* `:protocol`: The `client.protocol` value of the Riak client
+* `: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
 
@@ -295,5 +344,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,5 +1,21 @@
 # Riak Ruby Client Release Notes
 
+## 1.4.5 Feature and Bugfix Release - 2014-10-03
+
+Release 1.4.5 includes:
+
+Feature:
+
+* 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.
+
+Bugfix:
+
+* URI escaping now uses the CGI escaper. Thanks to Sean McKibben for 
+  reporting this bug.
+
 ## 1.4.4.1 Bugfix Release - 2014-04-17
 
 Release 1.4.4.1 includes the intended 1.4.4 bugfix:

data/lib/riak.rb

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

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

@@ -246,11 +246,6 @@ module Riak
         required :props,  RpbBucketProps, 2
       end
 
-      class RpbResetBucketReq
-        include Beefcake::Message
-        required :bucket, :bytes, 1
-      end
-
       class RpbMapRedReq
         include Beefcake::Message
         required :request,      :bytes, 1

data/lib/riak/client/instrumentation.rb

@@ -0,0 +1,25 @@
+class Riak::Client
+  include Instrumentable
+
+  client_payload = {protocol: :protocol, 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 :store_file, 'riak.store_file', client_payload
+  instrument_method :get_file, 'riak.get_file', client_payload
+  instrument_method :delete_file, 'riak.delete_file', client_payload
+  instrument_method :file_exists?, 'riak.file_exists', client_payload
+  instrument_method :file_exist?, 'riak.file_exists', client_payload
+  instrument_method :link_walk, 'riak.link_walk', client_payload
+  instrument_method :mapred, 'riak.map_reduce', client_payload
+  instrument_method :ping, 'riak.ping', client_payload
+end

data/lib/riak/instrumentation.rb

@@ -0,0 +1,6 @@
+begin
+  require 'instrumentable'
+  require 'riak/client/instrumentation'
+rescue LoadError => e
+  # Go quietly into the night...(?)
+end

data/lib/riak/util/escape.rb

@@ -30,7 +30,7 @@ module Riak
     attr_accessor :url_decoding
   end
 
-  self.escaper = URI
+  self.escaper = CGI
   self.url_decoding = false
 
   module Util

data/lib/riak/version.rb

@@ -1,3 +1,3 @@
 module Riak
-  VERSION = "1.4.4.1"
+  VERSION = "1.4.5"
 end

data/riak-client.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rack", ">=1.0"
   gem.add_development_dependency "excon", ">=0.6.1"
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency "instrumentable", "~> 1.1.0"
   gem.add_runtime_dependency "i18n", ">=0.4.0"
   gem.add_runtime_dependency "builder", ">= 2.1.2"
-  gem.add_runtime_dependency "beefcake", "~>0.3.7"
+  gem.add_runtime_dependency "beefcake", "~>1.0.0"
   gem.add_runtime_dependency "multi_json", "~>1.0"
   gem.add_runtime_dependency "innertube", "~>1.0.2"
 

data/spec/integration/riak/http_backends_spec.rb

@@ -102,6 +102,42 @@ describe "HTTP" do
             stored_file.size.should == string.bytesize
           end
         end
+
+        describe 'key and bucket escaping' do
+          let(:default_bucket){ @client[rand(36**10).to_s(36)] }
+
+          { 'question mark' => 'question?marks',
+            'hash' => 'hashtag#riak',
+            'slash' => 'slash/fiction',
+            'space' => 'space opera',
+            'plus' => 'plus+one',
+            'caret' => 'caret^top',
+            'square bracket' => 'square[]meal',
+          }.each do |k, v|
+            it "doesn't mangle keys with a #{k} in them" do
+              obj = default_bucket.new v
+              obj.content_type = 'text/plain'
+              obj.data = rand(36**10).to_s(36)
+              obj.store
+              
+              o2 = nil
+              expect{ o2 = default_bucket.get v }.to_not raise_error
+              expect(o2.data).to eq obj.data
+            end
+            
+            it "doesn't mangle buckets with a #{k} in them" do
+              bucket = @client[v]
+              obj = bucket.new rand(36**10).to_s(36)
+              obj.content_type = 'text/plain'
+              obj.data = rand(36**10).to_s(36)
+              obj.store
+
+              o2 = nil
+              expect{ o2 = bucket.get obj.key }.to_not raise_error
+              expect(o2.data).to eq obj.data
+            end
+          end
+        end
       end
     end
   end

data/spec/riak/escape_spec.rb

@@ -7,29 +7,29 @@ describe Riak::Util::Escape do
     @object.extend(Riak::Util::Escape)
   end
 
-  it "should use URI by default for escaping" do
-    Riak.escaper.should == URI
+  it "uses URI by default for escaping" do
+    Riak.escaper.should == CGI
   end
 
   context "when using CGI for escaping" do
     before { @oldesc, Riak.escaper = Riak.escaper, CGI }
     after { Riak.escaper = @oldesc }
 
-    it "should escape standard non-safe characters" do
+    it "escapes standard non-safe characters" do
       @object.escape("some string").should == "some%20string"
       @object.escape("another^one").should == "another%5Eone"
       @object.escape("bracket[one").should == "bracket%5Bone"
     end
 
-    it "should escape slashes" do
+    it "escapes slashes" do
       @object.escape("some/inner/path").should == "some%2Finner%2Fpath"
     end
 
-    it "should convert the bucket or key to a string before escaping" do
+    it "converts the bucket or key to a string before escaping" do
       @object.escape(125).should == '125'
     end
 
-    it "should unescape escaped strings" do
+    it "unescapes escaped strings" do
       @object.unescape("some%20string").should == "some string"
       @object.unescape("another%5Eone").should == "another^one"
       @object.unescape("bracket%5Bone").should == "bracket[one"
@@ -41,30 +41,30 @@ describe Riak::Util::Escape do
     before { @oldesc, Riak.escaper = Riak.escaper, URI }
     after { Riak.escaper = @oldesc }
 
-    it "should escape standard non-safe characters" do
+    it "escapes standard non-safe characters" do
       @object.escape("some string").should == "some%20string"
       @object.escape("another^one").should == "another%5Eone"
       @object.escape("--one+two--").should == "--one%2Btwo--"
     end
 
-    it "should allow URI-safe characters" do
+    it "allows URI-safe characters" do
       @object.escape("sean@basho").should == "sean@basho"
     end
 
-    it "should escape slashes" do
+    it "escapes slashes" do
       @object.escape("some/inner/path").should == "some%2Finner%2Fpath"
     end
 
-    it "should escape square brackets" do
+    it "escapes square brackets" do
       @object.escape("bracket[one").should == "bracket%5Bone"
       @object.escape("bracket]two").should == "bracket%5Dtwo"
     end
 
-    it "should convert the bucket or key to a string before escaping" do
+    it "converts the bucket or key to a string before escaping" do
       @object.escape(125).should == '125'
     end
 
-    it "should unescape escaped strings" do
+    it "unescapes escaped strings" do
       @object.unescape("some%20string").should == "some string"
       @object.unescape("another%5Eone").should == "another^one"
       @object.unescape("bracket%5Bone").should == "bracket[one"

data/spec/riak/instrumentation_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe Riak::Client do
+
+  before do
+    @client = Riak::Client.new
+    @backend = mock("Backend")
+    @client.stub!(:backend).and_yield(@backend)
+    @client.stub!(:http).and_yield(@backend)
+    @bucket = Riak::Bucket.new(@client, "foo")
+
+    @events = []
+    @notifier = ActiveSupport::Notifications.notifier
+    @notifier.subscribe { |*args| (@events ||= []) << event(*args) }
+  end
+
+  describe "instrumentation", instrumentation: true do
+
+    it "should notify on the 'buckets' operation" do
+      @backend.should_receive(:list_buckets).and_return(%w{test test2})
+      test_client_event(@client, 'riak.list_buckets') do
+        @client.buckets
+      end
+    end
+
+    it "should notify on the 'list_buckets' operation" do
+      @backend.should_receive(:list_buckets).and_return(%w{test test2})
+      test_client_event(@client, 'riak.list_buckets') do
+        @client.list_buckets
+      end
+    end
+
+    it "should notify on the 'list_keys' operation" do
+      @backend.should_receive(:list_keys).and_return(%w{test test2})
+      test_client_event(@client, 'riak.list_keys') do
+        @client.list_keys(@bucket)
+      end
+    end
+
+    it "should notify on the 'get_bucket_props' operation" do
+      @backend.should_receive(:get_bucket_props).and_return({})
+      test_client_event(@client, 'riak.get_bucket_props') do
+        @client.get_bucket_props(@bucket)
+      end
+    end
+
+    it "should notify on the 'set_bucket_props' operation" do
+      @backend.should_receive(:set_bucket_props).and_return({})
+      test_client_event(@client, 'riak.set_bucket_props') do
+        @client.set_bucket_props(@bucket, {})
+      end
+    end
+
+    it "should notify on the 'clear_bucket_props' operation" do
+      @backend.should_receive(:clear_bucket_props).and_return({})
+      test_client_event(@client, 'riak.clear_bucket_props') do
+        @client.clear_bucket_props(@bucket)
+      end
+    end
+
+    it "should notify on the 'get_index' operation" do
+      @backend.should_receive(:get_index).and_return({})
+      test_client_event(@client, 'riak.get_index') do
+        @client.get_index(@bucket, 'index', 'query', {})
+      end
+    end
+
+    it "should notify on the 'get_object' operation" do
+      @backend.should_receive(:fetch_object).and_return(nil)
+      test_client_event(@client, 'riak.get_object') do
+        @client.get_object(@bucket, 'bar')
+      end
+    end
+
+    it "should notify on the 'store_object' operation" do
+      @backend.should_receive(:store_object).and_return(nil)
+      test_client_event(@client, 'riak.store_object') do
+        @client.store_object(Object.new)
+      end
+    end
+
+    it "should notify on the 'reload_object' operation" do
+      @backend.should_receive(:reload_object).and_return(nil)
+      test_client_event(@client, 'riak.reload_object') do
+        @client.reload_object(Object.new)
+      end
+    end
+
+    it "should notify on the 'delete_object' operation" do
+      @backend.should_receive(:delete_object).and_return(nil)
+      test_client_event(@client, 'riak.delete_object') do
+        @client.delete_object(@bucket, 'bar')
+      end
+    end
+
+    it "should notify on the 'store_file' operation" do
+      @backend.should_receive(:store_file).and_return(nil)
+      test_client_event(@client, 'riak.store_file') do
+        @client.store_file('filename')
+      end
+    end
+
+    it "should notify on the 'get_file' operation" do
+      @backend.should_receive(:get_file).and_return(nil)
+      test_client_event(@client, 'riak.get_file') do
+        @client.get_file('filename')
+      end
+    end
+
+    it "should notify on the 'delete_file' operation" do
+      @backend.should_receive(:delete_file).and_return(nil)
+      test_client_event(@client, 'riak.delete_file') do
+        @client.delete_file('filename')
+      end
+    end
+
+    it "should notify on the 'file_exists' operation" do
+      @backend.should_receive(:file_exists?).and_return(nil)
+      test_client_event(@client, 'riak.file_exists') do
+        @client.file_exists?('filename')
+      end
+    end
+
+    it "should notify on the 'file_exist' operation" do
+      @backend.should_receive(:file_exists?).and_return(nil)
+      test_client_event(@client, 'riak.file_exists') do
+        @client.file_exist?('filename')
+      end
+    end
+
+    it "should notify on the 'link_walk' operation" do
+      @backend.should_receive(:link_walk).and_return(nil)
+      test_client_event(@client, 'riak.link_walk') do
+        @client.link_walk(Object.new, [Riak::WalkSpec.new(:bucket => 'foo')])
+      end
+    end
+
+    it "should notify on the 'mapred' operation" do
+      @mapred = Riak::MapReduce.new(@client).add('test').map("function(){}").map("function(){}")
+      @backend.should_receive(:mapred).and_return(nil)
+      test_client_event(@client, 'riak.map_reduce') do
+        @client.mapred(@mapred)
+      end
+    end
+
+    it "should notify on the 'ping' operation" do
+      @backend.should_receive(:ping).and_return(nil)
+      test_client_event(@client, 'riak.ping') do
+        @client.ping
+      end
+    end
+  end
+end
+
+def test_client_event(client, event_name, &block)
+  block.call
+  @events.size.should == 1
+  event = @events.first
+  event.name.should == event_name
+  event.payload[:protocol].should == client.protocol
+  event.payload[:client_id].should == client.client_id
+end
+
+# name, start, finish, id, payload
+def event(*args)
+  ActiveSupport::Notifications::Event.new(*args)
+end

data/spec/spec_helper.rb

@@ -49,4 +49,10 @@ RSpec.configure do |config|
   else
     config.order = :random
   end
+
+  begin
+    require 'instrumentable'
+  rescue LoadError => e
+    config.filter_run_excluding instrumentation: true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riak-client
 version: !ruby/object:Gem::Version
-  version: 1.4.4.1
+  version: 1.4.5
 platform: ruby
 authors:
 - Sean Cribbs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: instrumentable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +208,7 @@ files:
 - lib/riak/client/http_backend/object_methods.rb
 - lib/riak/client/http_backend/request_headers.rb
 - lib/riak/client/http_backend/transport_methods.rb
+- lib/riak/client/instrumentation.rb
 - lib/riak/client/net_http_backend.rb
 - lib/riak/client/node.rb
 - lib/riak/client/protobuffs_backend.rb
@@ -214,6 +229,7 @@ files:
 - lib/riak/failed_request.rb
 - lib/riak/i18n.rb
 - lib/riak/index_collection.rb
+- lib/riak/instrumentation.rb
 - lib/riak/json.rb
 - lib/riak/link.rb
 - lib/riak/list_buckets.rb
@@ -283,6 +299,7 @@ files:
 - spec/riak/http_backend/transport_methods_spec.rb
 - spec/riak/http_backend_spec.rb
 - spec/riak/index_collection_spec.rb
+- spec/riak/instrumentation_spec.rb
 - spec/riak/link_spec.rb
 - spec/riak/list_buckets_spec.rb
 - spec/riak/map_reduce/filter_builder_spec.rb
@@ -371,6 +388,7 @@ test_files:
 - spec/riak/http_backend/transport_methods_spec.rb
 - spec/riak/http_backend_spec.rb
 - spec/riak/index_collection_spec.rb
+- spec/riak/instrumentation_spec.rb
 - spec/riak/link_spec.rb
 - spec/riak/list_buckets_spec.rb
 - spec/riak/map_reduce/filter_builder_spec.rb