couch-client 0.0.1

data/spec/couch-client_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "spec_helper")
+
+describe CouchClient do
+  it 'should exist' do
+    CouchClient.should be_a(Module)
+  end
+  
+  it 'should have a .connect method that constructs a new CouchClient::Connection object' do
+    CouchClient.connect(:database => "sandbox").should be_a(CouchClient::Connection)
+  end
+end

data/spec/database_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "spec_helper")
+
+describe CouchClient::Database do
+  before(:all) do
+    @couch = CouchClient.connect(COUCHDB_TEST_SETTINGS)
+    @couch.database.create
+  end
+  
+  after(:all) do
+    @couch.database.delete!
+  end
+  
+  describe '#stats' do
+    it 'should exist' do
+      @couch.database.stats.should be_a(Hash)
+    end
+  end
+  
+  describe '#exists?' do
+    it 'should exist' do
+      @couch.database.exists?.should be_a(TrueClass)
+    end
+  end
+  
+  describe '#create' do
+    # Is already tested as it is used in the before(:all) setup 
+    # to make the database that is currently being tested.
+  end
+  
+  describe '#delete' do
+    # Is already tested as it is used in the after(:all) teardown 
+    # to delete the database that is currently being tested.
+  end
+  
+  describe '#compact!' do
+    it 'should exist' do
+      @couch.database.compact!.should be_a(Hash)
+    end
+  end
+  
+  describe '#replicate' do
+    pending 'will be built in another release'
+  end
+end

data/spec/design_spec.rb

@@ -0,0 +1,100 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "spec_helper")
+
+describe CouchClient::Connection do
+  before(:all) do
+    @couch = CouchClient.connect(COUCHDB_TEST_SETTINGS)
+    @couch.database.create
+    
+    factory = lambda do |hash|
+      doc = @couch.build(hash)
+      doc.save
+      doc
+    end
+    
+    @alice   = factory.call({"_id" => "123", "name" => "alice", "city" => "nyc"})
+    @bob     = factory.call({"_id" => "456", "name" => "bob", "city" => "chicago"})
+    @charlie = factory.call({"_id" => "789", "name" => "charlie", "city" => "san fran"})
+    @design  = factory.call({"_id" => "_design/people", 
+      "views" => {
+        "all" => {"map" => "function(doc){emit(doc._id, doc)}"},
+        "sum" => {"map" => "function(doc){emit(null, 1)}", "reduce" => "function(id, values, rereduce){return sum(values)}"},
+      },
+      "fulltext" => {
+        "by_name" => {
+          "index" => "function(doc){var ret = new Document();ret.add(doc.name);return ret;}"
+        }
+      }
+    })
+    
+    @people = @couch.design("people")
+  end
+  
+  after(:all) do
+    @couch.database.delete!
+  end
+  
+  it 'should have an id' do
+    @people.id.should eql("people")
+  end
+  
+  describe '#view' do
+    it 'should return a mapped collection if the view exists' do
+      view = @people.view("all", "include_docs" => true)
+      view.should be_a(CouchClient::Collection)
+      view.info.should be_a(Hash)
+      view.size.should eql(3)
+      view.first.keys.should eql(["id", "key", "value", "doc"])
+      view.first["id"].should eql(@alice.id)
+      view.last["id"].should eql(@charlie.id)
+    end
+    
+    it 'should return mapped results based on "key"' do
+      view = @people.view("all", "key" => @bob.id)
+      view.size.should eql(1)
+      view.first["id"].should eql(@bob.id)
+    end
+    
+    it 'should return mapped results based on "startkey"' do
+      view = @people.view("all", "startkey" => @bob.id)
+      view.size.should eql(2)
+      view.first["id"].should eql(@bob.id)
+      view.last["id"].should eql(@charlie.id)
+    end
+    
+    it 'should return mapped results based on "endkey"' do
+      view = @people.view("all", "endkey" => @bob.id)
+      view.size.should eql(2)
+      view.first["id"].should eql(@alice.id)
+    end
+    
+    it 'should return a mapped and reduced collection if the view exists' do
+      view = @people.view("sum", "group" => true)
+      view.should be_a(CouchClient::Collection)
+      view.info.should be_a(Hash)
+      view.size.should eql(1)
+      view.first.keys.should eql(["key", "value"])
+      view.first["value"].should eql(3)
+    end
+  end
+  
+  describe '#show' do
+    pending 'will be built in another release'
+  end
+  
+  describe '#list' do
+    pending 'will be built in another release'
+  end
+  
+  describe '#fulltext' do
+    it 'should return a lucine status hash if the fulltext exists' do
+      @people.fulltext("by_name").should be_a(Hash)
+    end
+    
+    it 'should return a search results collection if the fulltext exists and a query is given' do
+      fulltext = @people.fulltext("by_name", "q" => "al*")
+      fulltext.should be_a(CouchClient::Collection)
+      fulltext.info.should be_a(Hash)
+      fulltext.first["id"].should eql(@alice.id)
+    end
+  end
+end

data/spec/document_spec.rb

@@ -0,0 +1,196 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "spec_helper")
+require 'digest/sha1'
+
+describe CouchClient::Document do
+  before(:each) do
+    @couch = CouchClient.connect(COUCHDB_TEST_SETTINGS)
+    @couch.database.create
+    
+    factory = lambda do |hash|
+      doc = @couch.build(hash)
+      doc.save
+      doc
+    end
+    
+    @alice   = factory.call({"name" => "alice", "city" => "nyc"})
+    @bob     = factory.call({"name" => "bob", "city" => "chicago"})
+    @new     = @couch.build
+    @design  = factory.call({"_id" => "_design/people", "views" => {"all" => {"map" => "function(doc){emit(doc._id, doc)}"}}})
+  end
+  
+  after(:each) do
+    @couch.database.delete!
+  end
+  
+  it 'should have #id, #rev and #attachments methods' do
+    @alice.id.should eql(@alice["_id"])
+    @alice.rev.should eql(@alice["_rev"])
+    @alice.attachments.should eql(@alice["_attachments"])
+  end
+  
+  it 'should have #id=, #rev= and #attachments= methods' do
+    @alice.should respond_to(:id=)
+    @alice.should respond_to(:rev=)
+    @alice.should respond_to(:attachments=)
+  end
+  
+  describe '#saved_doc' do
+    it 'should get the doc from the database' do
+      @alice["key"] = "value"
+      @alice.saved_doc.should_not eql(@alice)
+      
+      @alice["key"].should eql("value")
+      @alice.saved_doc["key"].should be_nil
+    end
+    
+    it 'should return nothing if the doc is new' do
+      lambda{@new.saved_doc}.should raise_error(CouchClient::DocumentNotAvailable)
+    end
+  end
+  
+  describe '#save' do
+    it 'should save a new document' do
+      @new.new?.should be_true
+      @new.rev.should be_nil
+      
+      @new.save
+      
+      @new.new?.should be_false
+      @new.rev.should_not be_nil
+    end
+    
+    it 'should update an existing document' do
+      @alice["key"].should be_nil
+      @alice["key"] = "value"
+      
+      @alice.save
+      
+      @alice["key"].should eql("value")
+      @alice.saved_doc["key"].should eql("value")
+    end
+    
+    it 'should not save a document in conflict' do
+      @alice_old = @alice.saved_doc
+      @alice_old["old"] = true
+      @alice["key"] = "value"
+      
+      @alice.save
+      
+      @alice_old.save
+      @alice_old.error?.should be_true
+      @alice_old.conflict?.should be_true
+      @alice_old.error.should eql({"conflict"=>"Document update conflict."})
+    end
+  end
+  
+  describe '#attach' do
+    before(:all) do
+      @read = lambda do |file|
+        File.read(File.join(File.dirname(__FILE__), "files", file))
+      end
+      
+      @digest = lambda do |file|
+        Digest::SHA1.hexdigest(file)
+      end
+      
+      @plain = @read.call("plain.txt")
+      @image = @read.call("image.png")
+      
+      @plain_digest = @digest.call(@plain)
+      @image_digest = @digest.call(@image)
+    end
+    
+    it 'should attach a file' do
+      @alice.attach("plain.txt", @plain, "text/plain")
+      @alice.attach("image.png", @image, "image/png")
+      @alice = @alice.saved_doc
+      
+      @alice.attachments.should eql({"image.png"=>{"content_type"=>"image/png", "revpos"=>3, "length"=>104744, "stub"=>true}, "plain.txt"=>{"content_type"=>"text/plain", "revpos"=>2, "length"=>406, "stub"=>true}})
+      @digest.call(@alice.attachments["plain.txt"].data).should eql(@plain_digest)
+      @digest.call(@alice.attachments["image.png"].data).should eql(@image_digest)
+    end
+    
+    it 'should not attach a file to a new record' do
+      lambda{@new.attach("plain.txt", @plain, "text/plain")}.should raise_error(CouchClient::AttachmentError)
+    end
+  end
+  
+  describe '#delete!' do
+    it 'should delete a docment' do
+      @bob.deleted?.should be_false
+      @bob.delete!
+      @bob.deleted?.should be_true
+      lambda{@bob.saved_doc}.should raise_error(CouchClient::DocumentNotFound)
+    end
+    
+    it 'should not delete a document in conflict' do
+      @alice_old = @alice.saved_doc
+      @alice_old["old"] = true
+      @alice["key"] = "value"
+      
+      @alice.save
+      
+      @alice_old.delete!
+      @alice_old.error?.should be_true
+      @alice_old.conflict?.should be_true
+      @alice_old.error.should eql({"conflict"=>"Document update conflict."})
+    end
+  end
+  
+  describe '#design?' do
+    it 'should identify a design document' do
+      @design.design?.should be_true
+    end
+    
+    it 'should not identify a normal document' do
+      @alice.design?.should be_false
+    end
+  end
+  
+  describe '#new?' do
+    it 'should identify a new document' do
+      @alice.new?.should be_false
+    end
+    
+    it 'should not identify an existing document' do
+      @new.new?.should be_true
+    end
+  end
+
+  describe '#error #error? and conflict?' do
+    it 'should yield errors for a document that has errors' do
+      @alice_old = @alice.saved_doc
+      @alice["key"] = "value"
+      
+      @alice_old.error?.should be_false
+      @alice_old.error.should eql({})
+      @alice_old.conflict?.should be_false
+      
+      @alice.save
+      @alice_old.save
+      
+      @alice_old.error?.should be_true
+      @alice_old.error.should eql({"conflict"=>"Document update conflict."})
+      @alice_old.conflict?.should be_true
+    end
+  end
+  
+  describe '#invalid?' do
+    before(:each) do
+      @alice.instance_variable_set(:@code, 403)
+      @alice.instance_variable_set(:@error, {"forbidden" => "Document must have a name field."})
+    end
+    
+    it 'should identify an invalid document' do
+      @alice.invalid?.should be_true
+    end
+  end
+
+  describe '#deleted?' do
+    it 'should identify a deleted document' do
+      @bob.deleted?.should be_false
+      @bob.delete!
+      @bob.deleted?.should be_true
+    end
+  end
+end

data/spec/files/plain.txt

@@ -0,0 +1 @@
+When in the Course of human events, it becomes necessary for one people to dissolve the political bands which have connected them with another, and to assume among the powers of the earth, the separate and equal station to which the Laws of Nature and of Nature's God entitle them, a decent respect to the opinions of mankind requires that they should declare the causes which impel them to the separation.

data/spec/hookup_spec.rb

@@ -0,0 +1,122 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "spec_helper")
+require 'digest/sha1'
+
+describe CouchClient::Hookup do
+  before(:all) do
+    handler = CouchClient::ConnectionHandler.new
+    handler.database = COUCHDB_TEST_DATABASE
+    
+    @hookup = CouchClient::Hookup.new(handler)
+  end
+  
+  after(:all) do
+    @hookup.delete
+  end
+  
+  describe 'rest methods' do
+    describe 'put' do
+      it 'should create a database if one does not exist' do
+        @hookup.put.should eql([201, {"ok" => true}])
+      end
+
+      it 'should not create a database if one already exists' do
+        @hookup.put.should eql([412, {"error" => "file_exists", "reason" => "The database could not be created, the file already exists."}])
+      end
+
+      it 'should create a document if a path is provided' do
+        @hookup.put(["alice"]).should eql([201, {"ok" => true, "id" => "alice", "rev" => "1-967a00dff5e02add41819138abb3284d"}])
+      end
+
+      it 'should create a document with fields if a path with data is provided' do
+        @hookup.put(["bob"], nil, {"name" => "bob", "city" => "nyc"}).should eql([201, {"ok" => true, "id" => "bob", "rev" => "1-fb4ceea745e7c1cd487886f06eba6536"}])
+      end
+    end
+    
+    describe 'post' do
+      before(:all) do
+        @hookup.put
+      end
+      
+      it 'should create a document' do
+        code, body = @hookup.post(nil, nil, {"name" => "charlie"})
+        code.should eql(201)
+        body.should be_a(Hash)
+      end
+    end
+    
+    describe 'get and head' do
+      before(:all) do
+        @hookup.put
+        @hookup.put(["dave"], nil, {"name" => "dave", "city" => "chicago"})
+        @id = @hookup.post(nil, nil, {"name" => "edgar", "city" => "miami"}).last["id"]
+      end
+      
+      it 'should get database information when not given a path' do
+        code, body = @hookup.get
+        code.should eql(200)
+        body["db_name"].should eql("couch-client_test")
+      end
+      
+      it 'should get a document when given a path' do
+        @hookup.get(["dave"]).should eql([200, {"_id" => "dave", "_rev" => "1-17a22c4b658fd637577a4626344be252", "name" => "dave", "city" => "chicago"}])
+        code, body = @hookup.get([@id])
+        code.should eql(200)
+        body["name"].should eql("edgar")
+        body["city"].should eql("miami")
+      end
+      
+      it 'should head a document when given a path' do
+        @hookup.head(["dave"]).should eql([200, nil])
+        code, body = @hookup.head([@id])
+        code.should eql(200)
+        body.should be_nil
+      end
+    end
+    
+    describe 'delete' do
+      before(:all) do
+        @hookup.put
+        @rev = @hookup.put(["fred"], nil, {"name" => "fred", "city" => "san fran"}).last["rev"]
+      end
+      
+      it 'should delete a document when given a path' do
+        @hookup.delete(["fred"], {"rev" => @rev}).should eql([200, {"ok" => true, "id" => "fred", "rev" => "2-9bee1aef2fee82160ae8549079645933"}])
+      end
+      
+      it 'should delete the database when not given a path' do
+        @hookup.delete.should eql([200, {"ok" => true}])
+      end
+    end
+  end
+  
+  describe 'attachments' do
+    before(:all) do
+      @read = lambda do |file|
+        File.read(File.join(File.dirname(__FILE__), "files", file))
+      end
+      
+      @digest = lambda do |file|
+        Digest::SHA1.hexdigest(file)
+      end
+      
+      @plain = @read.call("plain.txt")
+      @image = @read.call("image.png")
+      
+      @plain_digest = @digest.call(@plain)
+      @image_digest = @digest.call(@image)
+      
+      @hookup.put
+      @rev = @hookup.put(["greg"], nil, {"name" => "greg", "city" => "austin"}).last["rev"]
+    end
+    
+    it 'can be uploaded' do
+      @rev = @hookup.put(["greg", "plain.txt"], {"rev" => @rev}, @plain, "text/plain").last["rev"]
+      @rev = @hookup.put(["greg", "image.png"], {"rev" => @rev}, @image, "image/png").last["rev"]
+    end
+    
+    it 'can be downloaded' do
+      @digest.call(@hookup.get(["greg", "plain.txt"], nil, "text/plain").last).should eql(@plain_digest)
+      @digest.call(@hookup.get(["greg", "image.png"], nil, "image/png").last).should eql(@image_digest)
+    end
+  end
+end