riak-client 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ead2288b6e4cf47a182c33bb8f7d9305b3f8bf81
-  data.tar.gz: 84f40a4b0c078fa3d8660d942c47987b9a79e1b6
+  metadata.gz: 6dbee3629c0d7cc2798d8daf842413b38dd480f8
+  data.tar.gz: 1bcedfd574e6912f7da1372b7889a94a88767e06
 SHA512:
-  metadata.gz: d60099de09cdd2b8dd511eaed9482cd4ab8e35088b5946343afab8871e7414c571090cde02075e62176a312421270539ba7df646c5d44f66803fac1d85daf756
-  data.tar.gz: 4e1513258ca94ac6032f0eda704df463104eb892a03c3d7fe0bd7288a157190a6a8ce4b867a863d28b194278ef3d84e81ad8f8a7f2385e74063a024dc6ebaae1
+  metadata.gz: 0b34ddb04c2868d5373f2bac8087453664d502b3cca06660908f87f81f10102264496e9119b7d522cbc72f14c5a125fb42fefb2d08dc26b08dd0cb0039464be6
+  data.tar.gz: 6a62183303ee95d343c028ef76d2570ffafdb168089c3456803eb58e45d6811540058ba884b45156a0c9290603da54affb53aa8739b222199720a3ef1fa22bf2

data/Gemfile

@@ -2,7 +2,6 @@ source "https://rubygems.org"
 
 gemspec
 gem 'bundler'
-gem 'rake'
 
 group :guard do
   gem 'guard-rspec'

data/README.markdown

@@ -86,7 +86,6 @@ p results # => ["Please Please Me", "With The Beatles", "A Hard Day's Night",
           #     "The Beatles", "Yellow Submarine", "Abbey Road", "Let It Be"]
 ```
 
-
 ## Riak Search Examples
 
 For more information about Riak Search, see [the Basho wiki](http://wiki.basho.com/Riak-Search.html).
@@ -155,11 +154,11 @@ object = bucket.get_or_new 'cobb.salad'
 
 # 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}
+object.indexes['ingredients_bin'] = %w{lettuce tomato bacon egg chives}
 
 # Indexes ending with the "_int" suffix are indexed as integers. They can
 # have multiple values too.
-object.indexes[:calories_int] = [220]
+object.indexes['calories_int'] = [220]
 
 # You must re-save the object to store indexes.
 object.store
@@ -202,6 +201,59 @@ q.has_next_page? # => true
 q2 = q.next_page
 ```
 
+## Counter examples
+
+For more information about counters in Riak, see [the Basho wiki](http://docs.basho.com/riak/latest/dev/references/http/counters/).
+
+Counter records are automatically persisted on increment or decrement. The initial default value is 0.
+
+``` ruby
+# Firstly, ensure that your bucket is allow_mult set to true
+bucket = client.bucket "counters"
+bucket.allow_mult = true
+
+# You can create a counter by using the bucket's counter method
+counter = bucket.counter("counter-key-here")
+counter.increment
+=> nil
+
+p counter.value
+1
+=> 1
+
+# Let's increment one more time and then retrieve it from the database
+counter.increment
+
+# Retrieval is similar to creation
+persisted_counter = Riak::Counter.new(bucket, "counter-key-here")
+
+p persisted_counter.value
+2
+=> 2
+
+# We can also increment by a specified number
+persisted_counter.increment(20)
+p persisted_counter.value
+22
+=> 22
+
+# Decrement works much the same
+persisted_counter.decrement
+persisted_counter.value
+=> 21
+
+persisted_counter.decrement(6)
+persisted_counter.value
+=> 15
+
+# Incrementing by anything other than integer will throw an ArgumentError
+persisted_counter.increment "nonsense"
+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.
+
+
 ## How to Contribute
 
 * Fork the project on [Github](http://github.com/basho/riak-ruby-client).  If you have already forked, use `git pull --rebase` to reapply your changes on top of the mainline. Example:

data/RELEASE_NOTES.md

@@ -1,6 +1,23 @@
 # Riak Ruby Client Release Notes
 
-## 1.4.2 Bugfix Release - TBD
+## 1.4.3 Bugfix Release - 2013-12-31
+
+Release 1.4.3 fixes some bugs and improves documentation.
+
+Documentation:
+* Secondary Index examples in README now use string names.
+* 1.4 Counter usage explained better, fixed by Srdjan "batasrki" Pejic in
+  https://github.com/basho/riak-ruby-client/pull/130
+
+Bugfixes:
+
+* Redundant `gem "rake"` in `Gemfile`.
+* Escape square brackets in key names, reported and fixed by Garret Alfert in
+  https://github.com/basho/riak-ruby-client/issues/128 and
+  https://github.com/basho/riak-ruby-client/pull/129 , respectively.
+
+
+## 1.4.2 Bugfix Release - 2013-09-20
 
 Release 1.4.2 fixes a couple bugs.
 

data/lib/riak/util/escape.rb

@@ -52,7 +52,9 @@ module Riak
       # @return [String] the escaped path segment
       def escape(bucket_or_key)
         if Riak.escaper == URI
-          Riak.escaper.escape(bucket_or_key.to_s).gsub(" ", "%20").gsub("+", "%2B").gsub('/', "%2F")
+          Riak.escaper.escape(bucket_or_key.to_s).
+            gsub(" ", "%20").gsub("+", "%2B").gsub("/", "%2F").
+            gsub("[", "%5B").gsub("]", "%5D")
         else #CGI
           Riak.escaper.escape(bucket_or_key.to_s).gsub("+", "%20").gsub('/', "%2F")
         end

data/lib/riak/version.rb

@@ -1,3 +1,3 @@
 module Riak
-  VERSION = "1.4.2"
+  VERSION = "1.4.3"
 end

data/spec/riak/escape_spec.rb

@@ -48,7 +48,6 @@ describe Riak::Util::Escape do
     end
 
     it "should allow URI-safe characters" do
-      @object.escape("bracket[one").should == "bracket[one"
       @object.escape("sean@basho").should == "sean@basho"
     end
 
@@ -56,6 +55,11 @@ describe Riak::Util::Escape do
       @object.escape("some/inner/path").should == "some%2Finner%2Fpath"
     end
 
+    it "should escape 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
       @object.escape(125).should == '125'
     end

data/spec/riak/http_backend_spec.rb

@@ -49,6 +49,11 @@ describe Riak::Client::HTTPBackend do
       @backend.should_receive(:get).with([200,300], @backend.object_path('foo ', ' bar')).and_return({:headers => {"content-type" => ["application/json"]}, :body => '{"name":"Riak","company":"Basho"}'})
       @backend.fetch_object('foo ',' bar').should be_kind_of(Riak::RObject)
     end
+
+    it "should escape brackets in the bucket and key names" do
+      @backend.should_receive(:get).with([200,300], @backend.object_path('[foo]', '[bar]')).and_return({:headers => {"content-type" => ["application/json"]}, :body => '{"name":"Riak","company":"Basho"}'})
+      @backend.fetch_object('[foo]','[bar]').should be_kind_of(Riak::RObject)
+    end
   end
 
   context "reloading an object" do
@@ -130,6 +135,18 @@ describe Riak::Client::HTTPBackend do
         @backend.store_object(@object, :returnbody => true, :w => 2)
       end
     end
+
+    context "when the object's key contains square brackets" do
+      before :each do
+        @object.key = "[bar]"
+      end
+
+      it "should escape the key name" do
+        @backend.should_receive(:put).with([200,204,300], @backend.object_path("foo", "[bar]", {:returnbody => true}), "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/%5Bbar%5D"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 204})
+        @backend.store_object(@object, :returnbody => true)
+        @object.key.should == "[bar]"
+      end
+    end
   end
 
   context "deleting an object" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riak-client
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Sean Cribbs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -332,7 +332,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: riak-client is a rich client for Riak, the distributed database by Basho.