seomoz-riak-client 1.0.0.pre

data/spec/riak/http_backend/transport_methods_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Riak::Client::HTTPBackend::TransportMethods do
+  before :each do
+    @client = Riak::Client.new
+    @backend = Riak::Client::HTTPBackend.new(@client)
+    @backend.instance_variable_set(:@server_config, {})
+  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 or IO-like (responds to :read)" 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)
+      lambda { @backend.verify_path_and_body!(["/riak/", "foo", Tempfile.new('riak-spec')]) }.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
+
+  it "should allow using the https protocol" do
+    @client  = Riak::Client.new(:protocol => 'https')
+    @backend = Riak::Client::HTTPBackend.new(@client)
+    @backend.root_uri.to_s.should eq("https://127.0.0.1:8098")
+  end
+end

data/spec/riak/http_backend_spec.rb

@@ -0,0 +1,269 @@
+require 'spec_helper'
+
+describe Riak::Client::HTTPBackend do
+  before :each do
+    @client = Riak::Client.new
+    @backend = Riak::Client::HTTPBackend.new(@client)
+    @backend.instance_variable_set(:@server_config, {})
+  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
+
+  context "pinging the server" do
+    it "should succeed on 200" do
+      @backend.should_receive(:get).with(200, "/ping", {}, {}).and_return({:code => 200, :body => "OK"})
+      @backend.ping.should be_true
+    end
+
+    it "should fail on any other code or error" do
+      @backend.should_receive(:get).and_raise("socket closed")
+      @backend.ping.should be_false
+    end
+  end
+
+  context "fetching an object" do
+    it "should perform a GET request and return an RObject" do
+      @backend.should_receive(:get).with([200,300], "/riak/","foo", "db", {}, {}).and_return({:headers => {"content-type" => ["application/json"]}, :body => '{"name":"Riak","company":"Basho"}'})
+      @backend.fetch_object("foo", "db").should be_kind_of(Riak::RObject)
+    end
+
+    it "should pass the R quorum as a query parameter" do
+      @backend.should_receive(:get).with([200,300], "/riak/","foo", "db", {:r => 2}, {}).and_return({:headers => {"content-type" => ["application/json"]}, :body => '{"name":"Riak","company":"Basho"}'})
+      @backend.fetch_object("foo", "db", 2)
+    end
+
+    it "should escape the bucket and key names" do
+      @backend.should_receive(:get).with([200,300], "/riak/","foo%20", "%20bar", {}, {}).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
+    before do
+      @object = Riak::RObject.new(@client.bucket("foo"), "bar")
+    end
+
+    it "should use conditional request headers" do
+      @object.etag = "etag"
+      @backend.should_receive(:get).with([200,300,304], "/riak/", "foo", "bar", {}, {'If-None-Match' => "etag"}).and_return({:code => 304})
+      @backend.reload_object(@object)
+    end
+
+    it "should return without modifying the object if the response is 304 Not Modified" do
+      @backend.should_receive(:get).and_return({:code => 304})
+      @backend.should_not_receive(:load_object)
+      @backend.reload_object(@object)
+    end
+
+    it "should raise an exception when the response code is not 200 or 304" do
+      @backend.should_receive(:get).and_raise(Riak::HTTPFailedRequest.new(:get, 200, 500, {}, ''))
+      lambda { @backend.reload_object(@object) }.should raise_error(Riak::FailedRequest)
+    end
+
+    it "should escape the bucket and key names" do
+      # @bucket.should_receive(:name).and_return("some/deep/path")
+      @object.bucket = @client.bucket("some/deep/path")
+      @object.key = "another/deep/path"
+      @backend.should_receive(:get).with([200,300,304], "/riak/", "some%2Fdeep%2Fpath", "another%2Fdeep%2Fpath", {}, {}).and_return({:code => 304})
+      @backend.reload_object(@object)
+    end
+  end
+
+  context "storing an object" do
+    before do
+      @bucket = Riak::Bucket.new(@client, "foo")
+      @object = Riak::RObject.new(@bucket)
+      @object.content_type = "text/plain"
+      @object.data = "This is some text."
+      @headers = @backend.store_headers(@object)
+    end
+
+    it "should use the raw_data as the request body" do
+      @object.content_type = "application/json"
+      body = @object.raw_data = "{this is probably invalid json!}}"
+      @backend.stub(:post).and_return({})
+      @object.should_not_receive(:serialize)
+      @backend.store_object(@object, false)
+    end
+    
+    context "when the object has no key" do
+      it "should issue a POST request to the bucket, and update the object properties (returning the body by default)" do
+        @backend.should_receive(:post).with(201, "/riak/", "foo", {:returnbody => true}, "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/somereallylongstring"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 201})
+        @backend.store_object(@object, true, nil, nil)
+        @object.key.should == "somereallylongstring"
+        @object.vclock.should == "areallylonghashvalue"
+      end
+
+      it "should include persistence-tuning parameters in the query string" do
+        @backend.should_receive(:post).with(201, "/riak/", "foo", {:dw => 2, :returnbody => true}, "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/somereallylongstring"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 201})
+        @backend.store_object(@object, true, nil, 2)
+      end
+
+      it "should escape the bucket name" do
+        @object.bucket = @client.bucket("foo ")
+        @backend.should_receive(:post).with(201, "/riak/", "foo%20", {:returnbody => true}, "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/somereallylongstring"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 201})
+        @backend.store_object(@object, true)
+      end
+    end
+
+    context "when the object has a key" do
+      before :each do
+        @object.key = "bar"
+      end
+
+      it "should issue a PUT request to the bucket, and update the object properties (returning the body by default)" do
+        @backend.should_receive(:put).with([200,204,300], "/riak/", "foo/bar", {:returnbody => true}, "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/somereallylongstring"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 204})
+        @backend.store_object(@object, true, nil, nil)
+        @object.key.should == "somereallylongstring"
+        @object.vclock.should == "areallylonghashvalue"
+      end
+      
+      it "should include persistence-tuning parameters in the query string" do
+        @backend.should_receive(:put).with([200,204,300], "/riak/", "foo/bar", {:w => 2, :returnbody => true}, "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/somereallylongstring"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 204})
+        @backend.store_object(@object, true, 2, nil)
+      end
+
+      it "should escape the bucket and key names" do
+        @backend.should_receive(:put).with([200,204,300], "/riak/", "foo%20/bar%2Fbaz", {:returnbody => true}, "This is some text.", @headers).and_return({:headers => {'location' => ["/riak/foo/somereallylongstring"], "x-riak-vclock" => ["areallylonghashvalue"]}, :code => 204})
+        @bucket.instance_variable_set(:@name, "foo ")
+        @object.key = "bar/baz"
+        @backend.store_object(@object, true, nil, nil)
+      end
+    end
+  end
+
+  context "deleting an object" do
+    it "should perform a DELETE request" do
+      @backend.should_receive(:delete).with([204,404], "/riak/", "foo", 'bar',{},{}).and_return(:code => 204)
+      @backend.delete_object("foo", "bar")
+    end
+
+    it "should escape the bucket and key names" do
+      @backend.should_receive(:delete).with([204,404], "/riak/", "bucket%20spaces", "deep%2Fpath",{},{}).and_return({:code => 204, :headers => {}})
+      @backend.delete_object("bucket spaces", "deep/path")
+    end
+  end
+
+  context "fetching bucket properties" do
+    it "should GET the bucket URL and parse the response as JSON" do
+      @backend.should_receive(:get).with(200, "/riak/", "foo", {:keys => false, :props => true}, {}).and_return({:body => '{"props":{"n_val":3}}'})
+      @backend.get_bucket_props("foo").should == {"n_val" => 3}
+    end
+
+    it "should escape the bucket name" do
+      @backend.should_receive(:get).with(200, "/riak/", "foo%20bar", {:keys => false, :props => true}, {}).and_return({:body => '{"props":{"n_val":3}}'})
+      @backend.get_bucket_props("foo bar")
+    end
+  end
+  
+  context "setting bucket properties" do
+    it "should PUT the properties to the bucket URL as JSON" do
+      @backend.should_receive(:put).with(204, "/riak/","foo", '{"props":{"n_val":2}}', {"Content-Type" => "application/json"}).and_return({:body => "", :headers => {}})
+      @backend.set_bucket_props("foo", {:n_val => 2})      
+    end
+    
+    it "should escape the bucket name" do
+      @backend.should_receive(:put).with(204, "/riak/","foo%20bar", '{"props":{"n_val":2}}', {"Content-Type" => "application/json"}).and_return({:body => "", :headers => {}})
+      @backend.set_bucket_props("foo bar", {:n_val => 2})
+    end
+  end
+  
+  context "listing keys" do
+    it "should unescape key names" do
+      @backend.should_receive(:get).with(200, "/riak/","foo", {:props => false, :keys => true}, {}).and_return({:headers => {"content-type" => ["application/json"]}, :body => '{"keys":["bar%20baz"]}'})
+      @backend.list_keys("foo").should == ["bar baz"]
+    end
+
+    it "should escape the bucket name" do
+      @backend.should_receive(:get).with(200, "/riak/","unescaped%20", {:props => false, :keys => true}, {}).and_return({:headers => {"content-type" => ["application/json"]}, :body => '{"keys":["bar"]}'})
+      @backend.list_keys("unescaped ").should == ["bar"]
+    end
+  end
+
+  context "listing buckets" do
+    it "should GET the raw URL with ?buckets=true and parse the response as JSON" do
+      @backend.should_receive(:get).with(200, "/riak/", {:buckets => true}, {}).and_return({:body => '{"buckets":["foo", "bar", "baz"]}'})
+      @backend.list_buckets.should == ["foo", "bar", "baz"]
+    end
+  end
+  
+  context "performing a MapReduce query" do
+    before do
+      @mr = Riak::MapReduce.new(@client).map("Riak.mapValues", :keep => true)
+    end
+
+    it "should issue POST request to the mapred endpoint" do
+      @backend.should_receive(:post).with(200, "/mapred", @mr.to_json, hash_including("Content-Type" => "application/json")).and_return({:headers => {'content-type' => ["application/json"]}, :body => "[]"})
+      @backend.mapred(@mr)
+    end
+
+    it "should vivify JSON responses" do
+      @backend.stub!(:post).and_return(:headers => {'content-type' => ["application/json"]}, :body => '[{"key":"value"}]')
+      @backend.mapred(@mr).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.'}
+      @backend.stub!(:post).and_return(response)
+      @backend.mapred(@mr).should == response
+    end
+
+    it "should stream results through the block" do
+      data = File.read("spec/fixtures/multipart-mapreduce.txt")
+      @backend.should_receive(:post).with(200, "/mapred", {:chunked => true}, @mr.to_json, hash_including("Content-Type" => "application/json")).and_yield(data)
+      block = mock
+      block.should_receive(:ping).twice.and_return(true)
+      @backend.mapred(@mr) do |phase, data|
+        block.ping
+        phase.should == 0
+        data.should have(1).item
+      end
+    end
+  end
+
+  context "getting statistics" do
+    it "should get the status URL and parse the response as JSON" do
+      @backend.should_receive(:get).with(200, "/stats", {}, {}).and_return({:body => '{"vnode_gets":20348}'})
+      @backend.stats.should == {"vnode_gets" => 20348}
+    end
+  end
+  
+  context "performing a link-walking query" do
+    before do
+      @bucket = Riak::Bucket.new(@client, "foo")
+      @object = Riak::RObject.new(@bucket, "bar")
+      @body = File.read(File.expand_path("#{File.dirname(__FILE__)}/../fixtures/multipart-with-body.txt"))
+      @specs = [Riak::WalkSpec.new(:tag => "next", :keep => true)]
+    end
+
+    it "should perform a GET request for the given object and walk specs" do
+      @backend.should_receive(:get).with(200, "/riak/", "foo", "bar", "_,next,1").and_return(:headers => {"content-type" => ["multipart/mixed; boundary=12345"]}, :body => "\n--12345\nContent-Type: multipart/mixed; boundary=09876\n\n--09876--\n\n--12345--\n")
+      @backend.link_walk(@object, @specs)
+    end
+
+    it "should parse the results into arrays of objects" do
+      @backend.should_receive(:get).and_return(:headers => {"content-type" => ["multipart/mixed; boundary=5EiMOjuGavQ2IbXAqsJPLLfJNlA"]}, :body => @body)
+      results = @backend.link_walk(@object, @specs)
+      results.should be_kind_of(Array)
+      results.first.should be_kind_of(Array)
+      obj = results.first.first
+      obj.should be_kind_of(Riak::RObject)
+      obj.content_type.should == "text/plain"
+      obj.key.should == "baz"
+      obj.bucket.should == @bucket
+    end
+
+    it "should assign the bucket for newly parsed objects" do
+      @backend.stub!(:get).and_return(:headers => {"content-type" => ["multipart/mixed; boundary=5EiMOjuGavQ2IbXAqsJPLLfJNlA"]}, :body => @body)
+      @client.should_receive(:bucket).with("foo").and_return(@bucket)
+      @backend.link_walk(@object, @specs)
+    end
+  end
+end

data/spec/riak/link_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+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 keep the url intact if it does not point to a bucket or bucket/key" do
+      result = Riak::Link.parse('</mapred>; rel="riak_kv_wm_mapred"')
+      result[0].url.should == "/mapred"
+      result[0].bucket.should be_nil
+      result[0].key.should be_nil
+    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"'
+    Riak::Link.new("/riak", "riak_kv_wm_raw").to_s.should == '</riak>; riaktag="riak_kv_wm_raw"'
+  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
+
+  it "should construct from bucket, key and tag" do
+    link = Riak::Link.new("bucket", "key", "tag")
+    link.bucket.should == "bucket"
+    link.key.should == "key"
+    link.tag.should == "tag"
+    link.url.should == "/riak/bucket/key"
+  end
+end