riak-client 0.7.0

data/spec/riak/escape_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe Riak::Util::Escape do
+  before :each do
+    @object = Object.new
+    @object.extend(Riak::Util::Escape)
+  end
+
+  it "should escape standard non-safe characters" do
+    @object.escape("some string").should == "some%20string"
+    @object.escape("another^one").should == "another%5Eone"
+  end
+
+  it "should escape 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
+    @object.escape(125).should == '125'
+  end
+end

data/spec/riak/headers_spec.rb

@@ -0,0 +1,34 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., 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
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+describe Riak::Util::Headers do
+  it "should include the Net::HTTPHeader module" do
+    Riak::Util::Headers.included_modules.should include(Net::HTTPHeader)
+  end
+
+  it "should be initially empty" do
+    Riak::Util::Headers.new.to_hash.should == {}
+  end
+
+  it "should parse a header line into the key and value" do
+    Riak::Util::Headers.parse("Content-Type: text/plain\n").should == ["Content-Type", "text/plain"]
+  end
+
+  it "should parse a header line and add it to the collection" do
+    h = Riak::Util::Headers.new
+    h.parse("Content-Type: text/plain\n")
+    h.to_hash.should == {"content-type" => ["text/plain"]}
+  end
+end

data/spec/riak/http_backend_spec.rb

@@ -0,0 +1,131 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., 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
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+describe Riak::Client::HTTPBackend do
+  before :each do
+    @client = Riak::Client.new
+    @backend = Riak::Client::HTTPBackend.new(@client)
+  end
+
+  it "should take the Riak::Client when creating" do
+    lambda { Riak::Client::HTTPBackend.new(nil) }.should raise_error(ArgumentError)
+    lambda { Riak::Client::HTTPBackend.new(@client) }.should_not raise_error
+  end
+
+  it "should make the client accessible" do
+    @backend.client.should == @client
+  end
+
+  it "should generate default headers for requests based on the client settings" do
+    @client.client_id = "testing"
+    @backend.default_headers.should == {"X-Riak-ClientId" => "testing", "Accept" => "multipart/mixed, application/json;q=0.7, */*;q=0.5"}
+  end
+
+  it "should generate a root URI based on the client settings" do
+    @backend.root_uri.should be_kind_of(URI)
+    @backend.root_uri.to_s.should == "http://127.0.0.1:8098"
+  end
+
+  it "should compute a URI from a relative resource path" do
+    @backend.path("baz").should be_kind_of(URI)
+    @backend.path("foo").to_s.should == "http://127.0.0.1:8098/foo"
+    @backend.path("foo", "bar").to_s.should == "http://127.0.0.1:8098/foo/bar"
+    @backend.path("/foo/bar").to_s.should == "http://127.0.0.1:8098/foo/bar"
+  end
+
+  it "should compute a URI from a relative resource path with a hash of query parameters" do
+    @backend.path("baz", :r => 2).to_s.should == "http://127.0.0.1:8098/baz?r=2"
+  end
+
+  it "should raise an error if a resource path is too short" do
+    lambda { @backend.verify_path!(["/riak/"]) }.should raise_error(ArgumentError)
+    lambda { @backend.verify_path!(["/riak/", "foo"]) }.should_not raise_error
+    lambda { @backend.verify_path!(["/mapred"]) }.should_not raise_error
+  end
+
+  describe "verify_path_and_body!" do
+    it "should separate the path and body from given arguments" do
+      uri, data = @backend.verify_path_and_body!(["/riak/", "foo", "This is the body."])
+      uri.should == ["/riak/", "foo"]
+      data.should == "This is the body."
+    end
+
+    it "should raise an error if the body is not a string or IO" do
+      lambda { @backend.verify_path_and_body!(["/riak/", "foo", nil]) }.should raise_error(ArgumentError)
+      lambda { @backend.verify_path_and_body!(["/riak/", "foo", File.open("spec/fixtures/cat.jpg")]) }.should_not raise_error(ArgumentError)
+    end
+
+    it "should raise an error if a body is not given" do
+      lambda { @backend.verify_path_and_body!(["/riak/", "foo"])}.should raise_error(ArgumentError)
+    end
+
+    it "should raise an error if a path is not given" do
+      lambda { @backend.verify_path_and_body!(["/riak/"])}.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe "detecting valid response codes" do
+    it "should accept strings or integers for either argument" do
+      @backend.should be_valid_response("300", "300")
+      @backend.should be_valid_response(300, "300")
+      @backend.should be_valid_response("300", 300)
+    end
+
+    it "should accept an array of strings or integers for the expected code" do
+      @backend.should be_valid_response([200,304], "200")
+      @backend.should be_valid_response(["200",304], "200")
+      @backend.should be_valid_response([200,"304"], "200")
+      @backend.should be_valid_response(["200","304"], "200")
+      @backend.should be_valid_response([200,304], 200)
+    end
+
+    it "should be false when none of the response codes match" do
+      @backend.should_not be_valid_response(200, 404)
+      @backend.should_not be_valid_response(["200","304"], 404)
+      @backend.should_not be_valid_response([200,304], 404)
+    end
+  end
+
+  describe "detecting whether a body should be returned" do
+    it "should be false when the method is :head" do
+      @backend.should_not be_return_body(:head, 200, false)
+    end
+
+    it "should be false when the response code is 204, 205, or 304" do
+      @backend.should_not be_return_body(:get, 204, false)
+      @backend.should_not be_return_body(:get, 205, false)
+      @backend.should_not be_return_body(:get, 304, false)
+    end
+
+    it "should be false when a streaming block was passed" do
+      @backend.should_not be_return_body(:get, 200, true)
+    end
+
+    it "should be true when the method is not head, a code other than 204, 205, or 304 was given, and there was no streaming block" do
+      [:get, :put, :post, :delete].each do |method|
+        [100,101,200,201,202,203,206,300,301,302,303,305,307,400,401,
+         402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,
+         500,501,502,503,504,505].each do |code|
+          @backend.should be_return_body(method, code, false)
+          @backend.should be_return_body(method, code.to_s, false)
+        end
+      end
+    end
+  end
+  
+  it "should force subclasses to implement the perform method" do
+    lambda { @backend.send(:perform, :get, "/foo", {}, 200) }.should raise_error(NotImplementedError)
+  end
+end

data/spec/riak/link_spec.rb

@@ -0,0 +1,82 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., 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
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+describe Riak::Link do
+  describe "parsing a link header" do
+    it "should create Link objects from the data" do
+      result = Riak::Link.parse('</riak/foo/bar>; rel="tag", </riak/foo>; rel="up"')
+      result.should be_kind_of(Array)
+      result.should be_all {|i| Riak::Link === i }
+    end
+
+    it "should set the bucket, key, url and rel parameters properly" do
+      result = Riak::Link.parse('</riak/foo/bar>; riaktag="tag", </riak/foo>; rel="up"')
+      result[0].url.should == "/riak/foo/bar"
+      result[0].bucket.should == "foo"
+      result[0].key.should == "bar"
+      result[0].rel.should == "tag"
+      result[1].url.should == "/riak/foo"
+      result[1].bucket.should == "foo"
+      result[1].key.should == nil
+      result[1].rel.should == "up"
+    end
+    
+    it "should set url properly, and set bucket and key to nil for non-Riak links" do
+      result = Riak::Link.parse('<http://www.example.com/123.html>; riaktag="tag", </riak/foo>; rel="up"')
+      result[0].url.should == "http://www.example.com/123.html"
+      result[0].bucket.should == nil
+      result[0].key.should == nil
+      result[0].rel.should == "tag"
+
+      result = Riak::Link.parse('<http://www.example.com/>; riaktag="tag", </riak/foo>; rel="up"')
+      result[0].url.should == "http://www.example.com/"
+      result[0].bucket.should == nil
+      result[0].key.should == nil
+      result[0].rel.should == "tag"
+    end
+  end
+
+  it "should convert to a string appropriate for use in the Link header" do
+    Riak::Link.new("/riak/foo", "up").to_s.should == '</riak/foo>; riaktag="up"'
+    Riak::Link.new("/riak/foo/bar", "next").to_s.should == '</riak/foo/bar>; riaktag="next"'
+  end
+
+  it "should convert to a walk spec when pointing to an object" do
+    Riak::Link.new("/riak/foo/bar", "next").to_walk_spec.to_s.should == "foo,next,_"
+    lambda { Riak::Link.new("/riak/foo", "up").to_walk_spec }.should raise_error
+  end
+
+  it "should be equivalent to a link with the same url and rel" do
+    one = Riak::Link.new("/riak/foo/bar", "next")
+    two = Riak::Link.new("/riak/foo/bar", "next")
+    one.should == two
+    [one].should include(two)
+    [two].should include(one)
+  end
+
+  it "should unescape the bucket name" do
+    Riak::Link.new("/riak/bucket%20spaces/key", "foo").bucket.should == "bucket spaces"
+  end
+
+  it "should unescape the key name" do
+    Riak::Link.new("/riak/bucket/key%2Fname", "foo").key.should == "key/name"
+  end
+
+  it "should not rely on the prefix to equal /riak/ when extracting the bucket and key" do
+    link = Riak::Link.new("/raw/bucket/key", "foo")
+    link.bucket.should == "bucket"
+    link.key.should == "key"
+  end
+end

data/spec/riak/map_reduce_spec.rb

@@ -0,0 +1,352 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., 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
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+describe Riak::MapReduce do
+  before :each do
+    @client = Riak::Client.new
+    @http = mock("HTTPBackend")
+    @client.stub!(:http).and_return(@http)
+    @mr = Riak::MapReduce.new(@client)
+  end
+
+  it "should require a client" do
+    lambda { Riak::MapReduce.new }.should raise_error
+    lambda { Riak::MapReduce.new(@client) }.should_not raise_error
+  end
+
+  it "should initialize the inputs and query to empty arrays" do
+    @mr.inputs.should == []
+    @mr.query.should == []
+  end
+
+  it "should yield itself when given a block on initializing" do
+    @mr2 = nil
+    @mr = Riak::MapReduce.new(@client) do |mr|
+      @mr2 = mr
+    end
+    @mr2.should == @mr
+  end
+
+  describe "adding inputs" do
+    it "should return self for chaining" do
+      @mr.add("foo", "bar").should == @mr
+    end
+
+    it "should add bucket/key pairs to the inputs" do
+      @mr.add("foo","bar")
+      @mr.inputs.should == [["foo","bar"]]
+    end
+
+    it "should add an array containing a bucket/key pair to the inputs" do
+      @mr.add(["foo","bar"])
+      @mr.inputs.should == [["foo","bar"]]
+    end
+
+    it "should add an object to the inputs by its bucket and key" do
+      bucket = Riak::Bucket.new(@client, "foo")
+      obj = Riak::RObject.new(bucket, "bar")
+      @mr.add(obj)
+      @mr.inputs.should == [["foo", "bar"]]
+    end
+
+    it "should add an array containing a bucket/key/key-data triple to the inputs" do
+      @mr.add(["foo","bar",1000])
+      @mr.inputs.should == [["foo","bar",1000]]
+    end
+
+    it "should use a bucket name as the single input" do
+      @mr.add(Riak::Bucket.new(@client, "foo"))
+      @mr.inputs.should == "foo"
+      @mr.add("docs")
+      @mr.inputs.should == "docs"
+    end
+  end
+
+  [:map, :reduce].each do |type|
+    describe "adding #{type} phases" do
+      it "should return self for chaining" do
+        @mr.send(type, "function(){}").should == @mr
+      end
+
+      it "should accept a function string" do
+        @mr.send(type, "function(){}")
+        @mr.query.should have(1).items
+        phase = @mr.query.first
+        phase.function.should == "function(){}"
+        phase.type.should == type
+      end
+
+      it "should accept a function and options" do
+        @mr.send(type, "function(){}", :keep => true)
+        @mr.query.should have(1).items
+        phase = @mr.query.first
+        phase.function.should == "function(){}"
+        phase.type.should == type
+        phase.keep.should be_true
+      end
+
+      it "should accept a module/function pair" do
+        @mr.send(type, ["riak","mapsomething"])
+        @mr.query.should have(1).items
+        phase = @mr.query.first
+        phase.function.should == ["riak", "mapsomething"]
+        phase.type.should == type
+        phase.language.should == "erlang"
+      end
+
+      it "should accept a module/function pair with extra options" do
+        @mr.send(type, ["riak", "mapsomething"], :arg => [1000])
+        @mr.query.should have(1).items
+        phase = @mr.query.first
+        phase.function.should == ["riak", "mapsomething"]
+        phase.type.should == type
+        phase.language.should == "erlang"
+        phase.arg.should == [1000]
+      end
+    end
+  end
+
+  describe "adding link phases" do
+    it "should return self for chaining" do
+      @mr.link({}).should == @mr
+    end
+
+    it "should accept a WalkSpec" do
+      @mr.link(Riak::WalkSpec.new(:tag => "next"))
+      @mr.query.should have(1).items
+      phase = @mr.query.first
+      phase.type.should == :link
+      phase.function.should be_kind_of(Riak::WalkSpec)
+      phase.function.tag.should == "next"
+    end
+
+    it "should accept a WalkSpec and a hash of options" do
+      @mr.link(Riak::WalkSpec.new(:bucket => "foo"), :keep => true)
+      @mr.query.should have(1).items
+      phase = @mr.query.first
+      phase.type.should == :link
+      phase.function.should be_kind_of(Riak::WalkSpec)
+      phase.function.bucket.should == "foo"
+      phase.keep.should be_true
+    end
+
+    it "should accept a hash of options intermingled with the walk spec options" do
+      @mr.link(:tag => "snakes", :arg => [1000])
+      @mr.query.should have(1).items
+      phase = @mr.query.first
+      phase.arg.should == [1000]
+      phase.function.should be_kind_of(Riak::WalkSpec)
+      phase.function.tag.should == "snakes"
+    end
+  end
+
+  describe "converting to JSON for the job" do
+    it "should include the inputs and query keys" do
+      @mr.to_json.should =~ /"inputs":/
+    end
+
+    it "should map phases to their JSON equivalents" do
+      phase = Riak::MapReduce::Phase.new(:type => :map, :function => "function(){}")
+      @mr.query << phase
+      @mr.to_json.should include('"source":"function(){}"')
+      @mr.to_json.should include('"query":[{"map":{')
+    end
+
+    it "should emit only the bucket name when the input is the whole bucket" do
+      @mr.add("foo")
+      @mr.to_json.should include('"inputs":"foo"')
+    end
+
+    it "should emit an array of inputs when there are multiple inputs" do
+      @mr.add("foo","bar",1000).add("foo","baz")
+      @mr.to_json.should include('"inputs":[["foo","bar",1000],["foo","baz"]]')
+    end
+
+    it "should add the timeout value when set" do
+      @mr.timeout(50000)
+      @mr.to_json.should include('"timeout":50000')
+    end
+  end
+
+  describe "executing the map reduce job" do
+    it "should issue POST request to the mapred endpoint" do
+      @http.should_receive(:post).with(200, "/mapred", @mr.to_json, hash_including("Content-Type" => "application/json")).and_return({:headers => {'content-type' => ["application/json"]}, :body => "{}"})
+      @mr.run
+    end
+
+    it "should vivify JSON responses" do
+      @http.stub!(:post).and_return(:headers => {'content-type' => ["application/json"]}, :body => '{"key":"value"}')
+      @mr.run.should == {"key" => "value"}
+    end
+
+    it "should return the full response hash for non-JSON responses" do
+      response = {:code => 200, :headers => {'content-type' => ["text/plain"]}, :body => 'This is some text.'}
+      @http.stub!(:post).and_return(response)
+      @mr.run.should == response
+    end
+
+    it "should interpret failed requests with JSON content-types as map reduce errors" do
+      @http.stub!(:post).and_raise(Riak::FailedRequest.new(:post, 200, 500, {"content-type" => ["application/json"]}, '{"error":"syntax error"}'))
+      lambda { @mr.run }.should raise_error(Riak::MapReduceError)
+      begin
+        @mr.run
+      rescue Riak::MapReduceError => mre
+        mre.message.should == '{"error":"syntax error"}'
+      else
+        fail "No exception raised!"
+      end
+    end
+
+    it "should re-raise non-JSON error responses" do
+      @http.stub!(:post).and_raise(Riak::FailedRequest.new(:post, 200, 500, {"content-type" => ["text/plain"]}, 'Oops, you bwoke it.'))
+      lambda { @mr.run }.should raise_error(Riak::FailedRequest)
+    end
+  end
+end
+
+describe Riak::MapReduce::Phase do
+  before :each do
+    @fun = "function(v,_,_){ return v['values'][0]['data']; }"
+  end
+
+  it "should initialize with a type and a function" do
+    phase = Riak::MapReduce::Phase.new(:type => :map, :function => @fun, :language => "javascript")
+    phase.type.should == :map
+    phase.function.should == @fun
+    phase.language.should == "javascript"
+  end
+
+  it "should initialize with a type and an MF" do
+    phase = Riak::MapReduce::Phase.new(:type => :map, :function => ["module", "function"], :language => "erlang")
+    phase.type.should == :map
+    phase.function.should == ["module", "function"]
+    phase.language.should == "erlang"
+  end
+
+  it "should initialize with a type and a bucket/key" do
+    phase = Riak::MapReduce::Phase.new(:type => :map, :function => {:bucket => "funs", :key => "awesome_map"}, :language => "javascript")
+    phase.type.should == :map
+    phase.function.should == {:bucket => "funs", :key => "awesome_map"}
+    phase.language.should == "javascript"
+  end
+
+  it "should assume the language is erlang when the function is an array" do
+    phase = Riak::MapReduce::Phase.new(:type => :map, :function => ["module", "function"])
+    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)
+    phase.language.should == "javascript"
+  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"
+  end
+
+  it "should accept a WalkSpec for the function when a link phase" do
+    phase = Riak::MapReduce::Phase.new(:type => :link, :function => Riak::WalkSpec.new({}))
+    phase.function.should be_kind_of(Riak::WalkSpec)
+  end
+
+  it "should raise an error if a WalkSpec is given for a phase type other than :link" do
+    lambda { Riak::MapReduce::Phase.new(:type => :map, :function => Riak::WalkSpec.new({})) }.should raise_error(ArgumentError)
+  end
+
+  describe "converting to JSON for the job" do
+    before :each do
+      @phase = Riak::MapReduce::Phase.new(:type => :map, :function => "")
+    end
+
+    [:map, :reduce].each do |type|
+      describe "when a #{type} phase" do
+        before :each do
+          @phase.type = type
+        end
+
+        it "should be an object with a single key of '#{type}'" do
+          @phase.to_json.should =~ /^\{"#{type}":/
+        end
+
+        it "should include the language" do
+          @phase.to_json.should =~ /"language":/
+        end
+
+        it "should include the keep value" do
+          @phase.to_json.should =~ /"keep":false/
+          @phase.keep = true
+          @phase.to_json.should =~ /"keep":true/
+        end
+
+        it "should include the function source when the function is a source string" do
+          @phase.function = "function(v,_,_){ return v; }"
+          @phase.to_json.should include(@phase.function)
+          @phase.to_json.should =~ /"source":/
+        end
+
+        it "should include the function name when the function is not a lambda" do
+          @phase.function = "Riak.mapValues"
+          @phase.to_json.should include('"name":"Riak.mapValues"')
+          @phase.to_json.should_not include('"source"')
+        end
+        
+        it "should include the bucket and key when referring to a stored function" do
+          @phase.function = {:bucket => "design", :key => "wordcount_map"}
+          @phase.to_json.should include('"bucket":"design"')
+          @phase.to_json.should include('"key":"wordcount_map"')
+        end
+
+        it "should include the module and function when invoking an Erlang function" do
+          @phase.function = ["riak_mapreduce", "mapreduce_fun"]
+          @phase.to_json.should include('"module":"riak_mapreduce"')
+          @phase.to_json.should include('"function":"mapreduce_fun"')
+        end
+      end
+    end
+
+    describe "when a link phase" do
+      before :each do
+        @phase.type = :link
+        @phase.function = {}
+      end
+
+      it "should be an object of a single key 'link'" do
+        @phase.to_json.should =~ /^\{"link":/
+      end
+
+      it "should include the bucket" do
+        @phase.to_json.should =~ /"bucket":"_"/
+        @phase.function[:bucket] = "foo"
+        @phase.to_json.should =~ /"bucket":"foo"/
+      end
+
+      it "should include the tag" do
+        @phase.to_json.should =~ /"tag":"_"/
+        @phase.function[:tag] = "parent"
+        @phase.to_json.should =~ /"tag":"parent"/
+      end
+
+      it "should include the keep value" do
+        @phase.to_json.should =~ /"keep":false/
+        @phase.keep = true
+        @phase.to_json.should =~ /"keep":true/
+        @phase.keep = false
+        @phase.function[:keep] = true
+        @phase.to_json.should =~ /"keep":true/
+      end
+    end
+  end
+end