riak-client 1.1.1 → 1.2.0

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec
 gem 'bundler'
@@ -9,7 +9,7 @@ group :guard do
   gem 'rb-fsevent'
   gem 'growl'
 end
-  
+
 platforms :mri do
   gem 'yajl-ruby'
 end

data/RELEASE_NOTES.md

@@ -1,5 +1,27 @@
 # Riak Ruby Client Release Notes
 
+## 1.2.0 Feature Release - 2013-05-15
+
+Release 1.2.0 adds support for Riak 1.3 and fixes a number of bugs.
+
+Features:
+
+* The "clear bucket properties" feature has been added. This resets
+  modified bucket properties to the defaults on Riak 1.3+ clusters.
+* Anonymous "strfun" MapReduce functions written in Erlang can now be
+  sent from the client, if they are enabled on the server-side.
+
+Bugfixes:
+
+* The WalkSpec class now properly includes the Translation module.
+* The Protocol Buffers transport now extracts the bucket name before
+  submitting secondary index queries.
+* Search query results returned over PBC are assumed to be UTF-8
+  encoded.
+* The newer Excon API is now supported (>= 0.19.0).
+* When enabling the search commit hook, the 'precommit' property will
+  now be checked more safely.
+
 ## 1.1.1 Patch/Bugfix Release - 2013-01-10
 
 Release 1.1.1 fixes a minor bug with Net::HTTP on Ruby 1.8.7 with

data/lib/riak/bucket.rb

@@ -78,6 +78,15 @@ module Riak
     end
     alias :properties :props
 
+    # Clears bucket properties, reverting them to the defaults.
+    # @return [true, false] whether the properties were cleared
+    # @since Riak 1.3
+    def clear_props
+      @props = nil
+      @client.clear_bucket_props(self)
+    end
+    alias :clear_properties :clear_props
+
     # 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
@@ -205,7 +214,7 @@ module Riak
     # riak_search.
     # @return [true,false] whether the bucket includes the search indexing hook
     def is_indexed?
-      props['search'] == true || props['precommit'].include?(SEARCH_PRECOMMIT_HOOK)
+      props['search'] == true || (props.has_key?('precommit') && props['precommit'].include?(SEARCH_PRECOMMIT_HOOK))
     end
 
     # @return [String] a representation suitable for IRB and debugging output

data/lib/riak/client.rb

@@ -469,6 +469,13 @@ module Riak
       end
     end
 
+    # Clears the properties on a bucket. See Bucket#clear_props
+    def clear_bucket_props(bucket)
+      http do |b|
+        b.clear_bucket_props(bucket)
+      end
+    end
+
     # Enables or disables SSL on all nodes, for HTTP backends.
     def ssl=(value)
       @nodes.each do |node|

data/lib/riak/client/beefcake_protobuffs_backend.rb

@@ -126,6 +126,7 @@ module Riak
 
       def get_index(bucket, index, query)
         return super unless pb_indexes?
+        bucket = bucket.name if Bucket === bucket
         if Range === query
           options = {
             :qtype => RpbIndexReq::IndexQueryType::RANGE,
@@ -218,7 +219,12 @@ module Riak
       end
 
       def decode_doc(doc)
-        Hash[doc.properties.map {|p| [ p.key, p.value ] }]
+        Hash[doc.properties.map {|p| [ force_utf8(p.key), force_utf8(p.value) ] }]
+      end
+
+      def force_utf8(str)
+        # Search returns strings that should always be valid UTF-8
+        ObjectMethods::ENCODING ? str.force_encoding('UTF-8') : str
       end
     end
   end

data/lib/riak/client/excon_backend.rb

@@ -150,12 +150,22 @@ module Riak
       end
 
       def connection
-        @connection ||= Excon::Connection.new(
-          root_uri.to_s,
-          :read_timeout => self.class.read_timeout,
+        @connection ||= new_connection
+      end
+
+      def new_connection
+        params = { :read_timeout => self.class.read_timeout,
           :write_timeout => self.class.write_timeout,
-          :connect_timeout => self.class.connect_timeout
-        )
+          :connect_timeout => self.class.connect_timeout }
+        args = [ params ]
+        if self.class.minimum_version?("0.19.0")
+          params.merge!(:scheme => root_uri.scheme,
+                        :host => root_uri.host,
+                        :port => root_uri.port)
+        else
+          args.unshift root_uri.to_s
+        end
+        Excon::Connection.new(*args)
       end
     end
   end

data/lib/riak/client/feature_detection.rb

@@ -13,7 +13,8 @@ module Riak
       VERSION = {
         1 => Gem::Version.new("1.0.0"),
         1.1 => Gem::Version.new("1.1.0"),
-        1.2 => Gem::Version.new("1.2.0")
+        1.2 => Gem::Version.new("1.2.0"),
+        1.3 => Gem::Version.new("1.3.0")
       }.freeze
 
       # @return [String] the version of the Riak node
@@ -71,6 +72,12 @@ module Riak
         at_least? VERSION[1]
       end
 
+      # @return [true,false] whether bucket properties can be cleared
+      #   (reset to defaults) over HTTP
+      def http_props_clearable?
+        at_least? VERSION[1.3]
+      end
+
       protected
       # @return [true,false] whether the server version is the same or
       #  newer than the requested version

data/lib/riak/client/http_backend.rb

@@ -133,6 +133,22 @@ module Riak
         put(204, bucket_properties_path(bucket), body, {"Content-Type" => "application/json"})
       end
 
+      # Clears bucket properties
+      # @param [Bucket, String] bucket the bucket to clear properties
+      #   on
+      # @return [true, false] whether the operation succeeded
+      # @note false will be returned if the operation is not supported
+      #   on the connected node
+      def clear_bucket_props(bucket)
+        if http_props_clearable?
+          bucket = bucket.name if Bucket === bucket
+          delete(204, bucket_properties_path(bucket))
+          true
+        else
+          false
+        end
+      end
+
       # List keys in a bucket
       # @param [Bucket, String] bucket the bucket to fetch the keys
       #        for

data/lib/riak/map_reduce/phase.rb

@@ -53,7 +53,7 @@ module Riak
           raise ArgumentError, t("stored_function_invalid") unless type == :link || value.has_key?(:bucket) && value.has_key?(:key)
           @language = "javascript"
         when String
-          @language = "javascript"
+          @language = (value =~ /\s*fun\s*\(.*\)\s*->/) ? "erlang" : "javascript"
         when WalkSpec
           raise ArgumentError, t("walk_spec_invalid_unless_link") unless type == :link
         else
@@ -78,7 +78,7 @@ module Riak
                 when Hash
                   defaults.merge(function)
                 when String
-                  if function =~ /\s*function/
+                  if function =~ /\s*function\s*\(/ || function =~ /\s*fun\s*\(.*\)\s*->/
                     defaults.merge("source" => function)
                   else
                     defaults.merge("name" => function)

data/lib/riak/version.rb

@@ -1,3 +1,3 @@
 module Riak
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/lib/riak/walk_spec.rb

@@ -12,6 +12,7 @@ module Riak
   #   Riak::WalkSpec.new({:bucket => 'tracks', :result => true})
   class WalkSpec
     include Util::Translation
+    extend Util::Translation
     include Util::Escape
 
     # @return [String] The bucket followed links should be restricted to. "_" represents all buckets.

data/riak-client.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.authors = ["Sean Cribbs"]
 
   # Deps
-  gem.add_development_dependency "rspec", "~>2.10.0"
+  gem.add_development_dependency "rspec", "~>2.13.0"
   gem.add_development_dependency "fakeweb", ">=1.2"
   gem.add_development_dependency "rack", ">=1.0"
   gem.add_development_dependency "excon", ">=0.6.1"

data/spec/integration/riak/http_backends_spec.rb

@@ -37,6 +37,21 @@ describe "HTTP" do
           end
         end
 
+        context "clearing bucket properties" do
+          it "should return false when unsupported", :version => "< 1.3.0" do
+            @backend.clear_bucket_props('foo').should be_false
+          end
+
+          it "should reset a previously set property to the default", :version => ">= 1.3.0" do
+            bucket = @client['bucketpropscleartest']
+            original_n = @backend.get_bucket_props(bucket)['n_val']
+            @backend.set_bucket_props(bucket, {'n_val' => 2})
+            @backend.get_bucket_props(bucket)['n_val'].should == 2
+            @backend.clear_bucket_props(bucket)
+            @backend.get_bucket_props(bucket)['n_val'].should == original_n
+          end
+        end
+
         context "using Luwak", :version => "< 1.1.0" do
           let(:file) { File.open(__FILE__) }
           let(:key) { "spec.rb" }

data/spec/integration/riak/protobuffs_backends_spec.rb

@@ -30,6 +30,20 @@ describe "Protocol Buffers" do
             results['docs'].should include({"id" => "munchausen-605"})
           end
         end
+
+        if "".respond_to?(:encoding) # Ruby 1.9 and later only
+          describe "searching fulltext indexes (1.2 and later)", :version => '>= 1.2.0' do
+            include_context "search corpus setup"
+
+            it 'should return documents with UTF-8 fields (GH #75)' do
+              utf8 = Encoding.find('UTF-8')
+              results = @backend.search 'search_test', 'fearless elephant rushed'
+              results['docs'].each do |d|
+                d.each {|(k,v)| k.encoding.should == utf8; v.encoding.should == utf8 }
+              end
+            end
+          end
+        end
       end
     end
   end

data/spec/riak/bucket_spec.rb

@@ -86,6 +86,14 @@ describe Riak::Bucket do
     end
   end
 
+  describe "clearing the bucket properties" do
+    it "should make the request and delete the internal properties cache" do
+      @client.should_receive(:clear_bucket_props).with(@bucket).and_return(true)
+      @bucket.clear_props.should be_true
+      @bucket.instance_variable_get(:@props).should be_nil
+    end
+  end
+
   describe "fetching an object" do
     it "should fetch the object via the backend" do
       @backend.should_receive(:fetch_object).with(@bucket, "db", {}).and_return(nil)

data/spec/riak/feature_detection_spec.rb

@@ -24,6 +24,7 @@ describe Riak::Client::FeatureDetection do
     it { should_not be_quorum_controls }
     it { should_not be_tombstone_vclocks }
     it { should_not be_pb_head }
+    it { should_not be_http_props_clearable }
   end
 
   context "when the Riak version is 1.0.x" do
@@ -35,6 +36,7 @@ describe Riak::Client::FeatureDetection do
     it { should be_quorum_controls }
     it { should be_tombstone_vclocks }
     it { should be_pb_head }
+    it { should_not be_http_props_clearable }
   end
 
   context "when the Riak version is 1.1.x" do
@@ -46,10 +48,11 @@ describe Riak::Client::FeatureDetection do
     it { should be_quorum_controls }
     it { should be_tombstone_vclocks }
     it { should be_pb_head }
+    it { should_not be_http_props_clearable }
   end
 
   context "when the Riak version is 1.2.x" do
-    before { subject.stub!(:get_server_version).and_return("1.2.0") }
+    before { subject.stub!(:get_server_version).and_return("1.2.1") }
     it { should be_mapred_phaseless }
     it { should be_pb_indexes }
     it { should be_pb_search }
@@ -57,5 +60,18 @@ describe Riak::Client::FeatureDetection do
     it { should be_quorum_controls }
     it { should be_tombstone_vclocks }
     it { should be_pb_head }
+    it { should_not be_http_props_clearable }
+  end
+
+  context "when the Riak version is 1.3.x" do
+    before { subject.stub!(:get_server_version).and_return("1.3.0") }
+    it { should be_mapred_phaseless }
+    it { should be_pb_indexes }
+    it { should be_pb_search }
+    it { should be_pb_conditionals }
+    it { should be_quorum_controls }
+    it { should be_tombstone_vclocks }
+    it { should be_pb_head }
+    it { should be_http_props_clearable }
   end
 end

data/spec/riak/map_reduce/phase_spec.rb

@@ -2,13 +2,14 @@ require 'spec_helper'
 
 describe Riak::MapReduce::Phase do
   before :each do
-    @fun = "function(v,_,_){ return v['values'][0]['data']; }"
+    @js_fun = "function(v,_,_){ return v['values'][0]['data']; }"
+    @erl_fun = "fun(Obj, _KeyData, _Arg) -> [{riak_object:key(Obj), riak_object:get_value(Obj)}] end."
   end
 
   it "should initialize with a type and a function" do
-    phase = Riak::MapReduce::Phase.new(:type => :map, :function => @fun, :language => "javascript")
+    phase = Riak::MapReduce::Phase.new(:type => :map, :function => @js_fun, :language => "javascript")
     phase.type.should == :map
-    phase.function.should == @fun
+    phase.function.should == @js_fun
     phase.language.should == "javascript"
   end
 
@@ -31,11 +32,16 @@ describe Riak::MapReduce::Phase do
     phase.language.should == "erlang"
   end
 
-  it "should assume the language is javascript when the function is a string" do
-    phase = Riak::MapReduce::Phase.new(:type => :map, :function => @fun)
+  it "should assume the language is javascript when the function is a string and starts with function" do
+    phase = Riak::MapReduce::Phase.new(:type => :map, :function => @js_fun)
     phase.language.should == "javascript"
   end
 
+  it "should assume the language is erlang when the function is a string and starts with anon fun" do
+    phase = Riak::MapReduce::Phase.new(:type => :map, :function => @erl_fun)
+    phase.language.should == "erlang"
+  end
+
   it "should assume the language is javascript when the function is a hash" do
     phase = Riak::MapReduce::Phase.new(:type => :map, :function => {:bucket => "jobs", :key => "awesome_map"})
     phase.language.should == "javascript"

data/spec/riak/walk_spec_spec.rb

@@ -101,6 +101,10 @@ describe Riak::WalkSpec do
       specs.should be_all {|s| s.kind_of?(Riak::WalkSpec) }
       specs.join("/").should == "_,next,_/foo,_,_/_,child,1"
     end
+
+    it "should raise an error when given invalid number of parameters" do
+      expect { Riak::WalkSpec.normalize("foo") }.to raise_error(ArgumentError)
+    end
   end
 
   describe "matching other objects with ===" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riak-client
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
@@ -329,12 +329,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 20034304450029998
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 20034304450029998
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23