akdubya-cushion 0.5.1 → 0.5.2

data/lib/cushion.rb

@@ -2,7 +2,7 @@ require 'json'
 require 'restclient'
 require 'uri'
 
-dir = File.dirname(__FILE__) + '/cushion/'
+dir = File.expand_path(File.dirname(__FILE__)) + '/cushion/'
 
 require dir + 'core_ext'
 require dir + 'server'
@@ -13,7 +13,7 @@ require dir + 'design'
 DEFAULT_COUCH_HOST = "http://127.0.0.1:5984"
 
 module Cushion
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 
   class << self
 

data/lib/cushion/database.rb

@@ -19,7 +19,7 @@ module Cushion
 
     # Compacts this database.
     def compact(headers = {})
-      server.post("#{@name}/_compact", nil, headers)
+      post("_compact", nil, headers)
     end
 
     # Creates this database on the server.
@@ -28,7 +28,7 @@ module Cushion
     end
 
     # Deletes this database from the server.
-    def delete(headers = {})
+    def drop(headers = {})
       server.delete(@name, headers)
     end
 
@@ -39,11 +39,11 @@ module Cushion
     def all_docs(params = {})
       keys = params.delete(:keys)
       opts = params.delete(:headers) || {}
-      path = Cushion.paramify_url("#{@name}/_all_docs", params)
+      path = Cushion.paramify_url("_all_docs", params)
       if keys
-        server.post(path, {:keys => keys}, opts)
+        post(path, {:keys => keys}, opts)
       else
-        server.get(path, opts)
+        get(path, opts)
       end
     end
 
@@ -52,8 +52,8 @@ module Cushion
     def open_doc(id, params = {})
       opts = params.delete(:headers) || {}
       slug = Cushion.escape_docid(id)
-      path = Cushion.paramify_url("#{@name}/#{slug}", params)
-      server.get(path, opts)
+      path = Cushion.paramify_url("#{slug}", params)
+      get(path, opts)
     end
 
     # Retrieves a single document by +id+ and returns a <tt>Cushion::Document</tt>
@@ -79,17 +79,17 @@ module Cushion
       end
       if params['_id']
         slug = Cushion.escape_docid(params['_id'])
-        server.put("#{@name}/#{slug}", params, opts)
+        put("#{slug}", params, opts)
       else
         slug = params['_id'] = server.next_uuid
-        server.put("#{@name}/#{slug}", params, opts)
+        put("#{slug}", params, opts)
       end
     end
 
     # Deletes a single document by +id+ and +rev+.
     def delete_doc(id, rev, headers = {})
       slug = Cushion.escape_docid(id)
-      server.delete("#{@name}/#{slug}?rev=#{rev}", headers)
+      delete("#{slug}?rev=#{rev}", headers)
     end
 
     # Creates, updates and deletes multiple documents in this database according
@@ -130,7 +130,7 @@ module Cushion
           doc['_id'] = nextid if nextid
         end
       end
-      server.post("#{@name}/_bulk_docs", {:docs => docs}, headers)
+      post("_bulk_docs", {:docs => docs}, headers)
     end
 
     # A convenience method for deleting multiple documents at once. Just pass in
@@ -155,7 +155,7 @@ module Cushion
     #  db.purge(doc_revs)
     #
     def purge(doc_revs, headers = {})
-      server.post("#{@name}/_purge", doc_revs, headers)
+      post("_purge", doc_revs, headers)
     end
 
     # Copies the document identified by +source_id+ to a new or existing document
@@ -171,7 +171,7 @@ module Cushion
       else
         dest_id
       end
-      server.copy("#{@name}/#{slug}", destination, headers)
+      copy("#{slug}", destination, headers)
     end
 
     # Moves the document identified by +source_id+ and +src_rev+ to a new or
@@ -188,7 +188,7 @@ module Cushion
       else
         dest_id
       end
-      server.move("#{@name}/#{slug}?rev=#{src_rev}", destination, headers)
+      move("#{slug}?rev=#{src_rev}", destination, headers)
     end
 
     # Supply +funcs+ to create a temporary view and run a query against it. Set
@@ -207,8 +207,8 @@ module Cushion
       keys = params.delete(:keys)
       headers = params.delete(:headers) || {}
       funcs = funcs.merge({:keys => keys}) if keys
-      path = Cushion.paramify_url("#{@name}/_temp_view", params)
-      server.post(path, funcs, headers)
+      path = Cushion.paramify_url("_temp_view", params)
+      post(path, funcs, headers)
     end
 
     # Query a saved view identified by +view+. Set the +keys+ param to perform a
@@ -221,11 +221,11 @@ module Cushion
     def view(view, params = {})
       keys = params.delete(:keys)
       headers = params.delete(:headers) || {}
-      path = Cushion.paramify_url("#{@name}/_view/#{view}", params)
+      path = Cushion.paramify_url("_view/#{view}", params)
       if keys
-        server.post(path, {:keys => keys}, headers)
+        post(path, {:keys => keys}, headers)
       else
-        server.get(path, headers)
+        get(path, headers)
       end
     end
 
@@ -237,8 +237,8 @@ module Cushion
       defaults = { :accept => "text/html;text/plain;*/*" }
       headers = params.delete(:headers) || {}
       slug = Cushion.escape_docid(id)
-      path = Cushion.paramify_url("#{@name}/_show/#{design}/#{show_template}/#{slug}", params)
-      server.get(path, defaults.merge(headers))
+      path = Cushion.paramify_url("_show/#{design}/#{show_template}/#{slug}", params)
+      get(path, defaults.merge(headers))
     end
 
     # Query the list template identified by +design+, +list_template+ and +view+.
@@ -248,8 +248,8 @@ module Cushion
     def list(design, list_template, view, params = {})
       defaults = { :accept => "text/html;text/plain;*/*" }
       headers = params.delete(:headers) || {}
-      path = Cushion.paramify_url("#{@name}/_list/#{design}/#{list_template}/#{view}", params)
-      server.get(path, defaults.merge(headers))
+      path = Cushion.paramify_url("_list/#{design}/#{list_template}/#{view}", params)
+      get(path, defaults.merge(headers))
     end
 
     # Issues a request to the CouchDB external server identified by +process+.
@@ -258,7 +258,7 @@ module Cushion
     #
     def external(verb, process_path, params = {})
       path = Cushion.paramify_url("_#{process_path}", params[:query])
-      server.request(verb, path, :body => params[:body], :headers => params[:headers])
+      request(verb, path, :body => params[:body], :headers => params[:headers])
     end
 
     # Uses open-uri to open the attachment identified by +id+ and +filename+.
@@ -280,7 +280,7 @@ module Cushion
       defaults = { :content_type => "application/octet-stream" }
       slug = Cushion.escape_docid(id)
       fname = CGI.escape(filename)
-      server.put("#{@name}/#{slug}/#{fname}?rev=#{rev}", data, defaults.merge(headers))
+      put("#{slug}/#{fname}?rev=#{rev}", data, defaults.merge(headers))
     end
 
     # Deletes an attachment under the document identified by +id+ and +rev+ with
@@ -289,7 +289,7 @@ module Cushion
     def delete_attachment(id, rev, filename, headers = {})
       slug = Cushion.escape_docid(id)
       fname = CGI.escape(filename)
-      server.delete("#{@name}/#{slug}/#{fname}?rev=#{rev}", headers)
+      delete("#{slug}/#{fname}?rev=#{rev}", headers)
     end
 
     # Renames an attachment under the document identified by +id+ and +rev+.
@@ -306,5 +306,47 @@ module Cushion
       end
     end
 
+    # Issues a HEAD request to this database. See Cushion::Server#head.
+    def head(path, headers = {})
+      server.head("#{@name}/#{path}", headers)
+    end
+
+    # Issues a GET request to this database. See Cushion::Server#get.
+    def get(path, headers = {})
+      server.get("#{@name}/#{path}", headers)
+    end
+
+    # Issues a POST request to this database. See Cushion::Server#post.
+    def post(path, body, headers = {})
+      server.post("#{@name}/#{path}", body, headers)
+    end
+
+    # Issues a PUT request to this database. See Cushion::Server#put.
+    def put(path, body, headers = {})
+      server.put("#{@name}/#{path}", body, headers)
+    end
+
+    # Issues a DELETE request to this database. See Cushion::Server#delete.
+    def delete(path, headers = {})
+      server.delete("#{@name}/#{path}", headers)
+    end
+
+    # Issues a COPY request to this database. See Cushion::Server#copy.
+    def copy(source, destination, headers = {})
+      server.copy("#{@name}/#{source}", destination, headers)
+    end
+
+    # Issues a MOVE request to this database. See Cushion::Server#move.
+    def move(source, destination, headers = {})
+      server.move("#{@name}/#{source}", destination, headers)
+    end
+
+    # Issues a generic request to this database. See Cushion::Server#request.
+    def request(verb, path, params)
+      server.request(verb, "#{@name}/#{path}", params)
+    end
+
+    ## EXPERIMENTAL ##
+
   end
 end

data/lib/cushion/server.rb

@@ -58,8 +58,8 @@ module Cushion
     end
 
     # Deletes the database identified by +name+ from this server.
-    def delete(name, headers = {})
-      db(name).delete(headers)
+    def drop(name, headers = {})
+      db(name).drop(headers)
     end
 
     # Deletes and re-creates the database identified by +name+.
@@ -67,7 +67,7 @@ module Cushion
     def recreate(name)
       rdb = db(name)
       begin
-        rdb.delete
+        rdb.drop
       rescue RestClient::ResourceNotFound
         nil
       end
@@ -105,7 +105,7 @@ module Cushion
     end
 
     # Issues a GET request to the CouchDB server. Returns a parsed response body
-    # if the +accept+ options is set to 'application/json' (the default), otherwise
+    # if the +accept+ option is set to 'application/json' (the default), otherwise
     # returns the raw RestClient response body.
     def get(path, headers = {})
       defaults = { :accept => "application/json" }
@@ -114,7 +114,7 @@ module Cushion
 
     # Issues a POST request to the CouchDB server. Parses the request body if
     # the +content_type+ option is set to 'application/json' (the default).
-    # Returns a parsed response body if the +accept+ options is set to
+    # Returns a parsed response body if the +accept+ option is set to
     # 'application/json' (the default), otherwise returns the raw
     # RestClient response body.
     def post(path, body, headers = {})
@@ -135,7 +135,7 @@ module Cushion
     end
 
     # Issues a DELETE request to the CouchDB server. Returns a parsed response body
-    # if the +accept+ options is set to 'application/json' (the default), otherwise
+    # if the +accept+ option is set to 'application/json' (the default), otherwise
     # returns the raw RestClient response body.
     def delete(path, headers = {})
       defaults = { :accept => "application/json" }
@@ -143,7 +143,7 @@ module Cushion
     end
 
     # Issues a COPY request to the CouchDB server, copying a document from +source+
-    # to +destination+. Returns a parsed response body if the +accept+ options
+    # to +destination+. Returns a parsed response body if the +accept+ option
     # is set to 'application/json' (the default), otherwise returns the raw
     # RestClient response body.
     def copy(source, destination, headers = {})
@@ -152,7 +152,7 @@ module Cushion
     end
 
     # Issues a MOVE request to the CouchDB server, moving a document from +source+
-    # to +destination+. Returns a parsed response body if the +accept+ options
+    # to +destination+. Returns a parsed response body if the +accept+ option
     # is set to 'application/json' (the default), otherwise returns the raw
     # RestClient response body.
     def move(source, destination, headers = {})
@@ -160,7 +160,9 @@ module Cushion
       parse_response(RestClient.move("#{@uri}/#{source}", defaults.merge(headers)))
     end
 
-    def request(verb, path, params)
+    # Issues a generic request to the server +path+ with the method set to +verb+.
+    # Accepts +body+ and +headers+ options.
+    def request(verb, path, params = {})
       RestClient::Request.execute(
         :method => verb,
         :url => "#{@uri}/#{path}",

data/spec/database_spec.rb

@@ -7,7 +7,7 @@ describe "Cushion::Database" do
   end
   
   after do
-    @db.delete rescue nil
+    @db.drop rescue nil
   end
 
   describe "Operations" do
@@ -18,10 +18,10 @@ describe "Cushion::Database" do
       lambda { Cushion::Database.new( :foo, "mydb" ) }.should.raise ArgumentError
     end
 
-    it "should create and delete a database" do
+    it "should create and drop a database" do
       newdb = Cushion.db('http://127.0.0.1:5984/foo_test')
       newdb.create["ok"].should.be.true
-      newdb.delete["ok"].should.be.true
+      newdb.drop["ok"].should.be.true
     end
 
     it "should retrieve database info" do
@@ -31,14 +31,12 @@ describe "Cushion::Database" do
     it "should compact a database" do
       @db.save_doc("foo" => "bar")
       @db.compact["ok"].should.be.true
-      # Finish compaction before moving on
-      while @db.server.active_tasks != [] do
-        sleep(0.5)
-      end
     end
 
     it "should pass requests to external handlers" do
-      lambda { @db.external(:get, "stats") }.should.not.raise
+      # This is kind of lame, but installing an external handler to run a "real"
+      # external test seems like overkill.
+      lambda { @db.external(:get, "all_docs") }.should.not.raise
     end
 
   end

data/spec/server_spec.rb

@@ -41,21 +41,21 @@ describe "Cushion::Server" do
 
   describe "Databases" do
 
-    it "should create and delete databases" do
+    it "should create and drop databases" do
       @server.create(:server_test)["ok"].should.be.true
-      @server.delete(:server_test)["ok"].should.be.true
+      @server.drop(:server_test)["ok"].should.be.true
     end
   
     it "should retrieve a list of all databases on the server" do
       @server.create(:server_list_test)
       @server.all_dbs.should.include "server_list_test"
-      @server.delete(:server_list_test)
+      @server.drop(:server_list_test)
     end
 
     it "should recreate a database" do
       @server.recreate(:server_recreate_test).should.be.kind_of Cushion::Database
       @server.all_dbs.should.include "server_recreate_test"
-      @server.delete(:server_recreate_test)
+      @server.drop(:server_recreate_test)
     end
 
     it "should instantiate a Cushion::Database with server[:dbname]" do
@@ -69,7 +69,7 @@ describe "Cushion::Server" do
     it "should create a database if it does not already exist with db!('dbname')" do
       @server.db!(:server_autocreate_test).should.be.kind_of Cushion::Database
       @server.all_dbs.should.include "server_autocreate_test"
-      @server.delete(:server_autocreate_test)
+      @server.drop(:server_autocreate_test)
     end
 
   end
@@ -82,8 +82,8 @@ describe "Cushion::Server" do
     end
 
     after do
-      @server.delete(:server_replication_test1)
-      @server.delete(:server_replication_test2)
+      @server.drop(:server_replication_test1)
+      @server.drop(:server_replication_test2)
     end
     
     it "should replicate databases" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: akdubya-cushion
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Aleksander Williams