akdubya-cushion 0.6.2 → 0.9.0

data/README.rdoc

@@ -40,20 +40,23 @@ Fetching documents is just as simple.
 Store attachments inline or via CouchDB's standalone attachment API. The standalone
 method accepts both IO objects and strings:
 
-  # Inline
+Inline:
+
   db.store("_id" => "hasfiles", ..., "_attachments" => {
     "foo.txt" => {
       "content_type" => "text/plain",
       "data" => "Hello World!"
     }})
 
-  # Standalone
+Standalone:
+
   res = @db.store("_id" => "savemefirst", ...)
   db.attach("savemefirst", "foo.txt", "Hello World!", :rev => res['rev'],
     :content_type => "text/plain")
   # => Foo now contains an attachment hash similar to the above example
 
-  # Fetch attachment data
+Fetch attachment data:
+
   db.fetch("savemefirst", "foo.txt")  # => "Hello World!"
 
 Cushion returns parsed JSON by default. In those cases where you need the raw
@@ -78,39 +81,48 @@ documents at once:
   db.bulk(docs)                  # => returns a hash of updated documents
   db.bulk(docs, :delete => true) # => deletes the selected docs
 
-Documents and attachments may also be copied or moved within the same database.
-Some useful examples:
+Documents may be copied within the same database.
 
-  # Documents
   db.copy("mydoc", "new_doc")
   # => {"ok"=>true, "id"=>"new_doc", "rev"=> ...}
-  db.move("mydoc", "existing_doc", :rev => ..., :dest_rev => ...)
+  db.copy("mydoc", "existing_doc", :dest_rev => ...)
   # => overwrites the existing doc
 
-  # Attachments
+Attachments may also be copied.
+
   db.copy_attachment("mydoc", "foo.txt", "bar.txt")
   # => copies an attachment within the same doc
-  db.move_attachment("mydoc", "foo.txt", "bar.txt")
-  # => renames an attachment; aliased at #rename_attachment
+  db.copy_attachment("mydoc", "foo.txt", "bar.txt", :dest_id => 'existing_doc', :dest_rev => ...)
+  # => copies an attachment to an existing doc
+
+== Creating Views
 
-See the database specs for more copy and move examples.
+== Querying Views
 
-== Views
+Query regular views by passing in the design doc name and view name along with
+an optional hash of parameters.
 
-- creating (design docs)
-- querying
-- temp views
+  db.view("people/by_first_name", :key => "gomer")
+  db.view("foo/bar", :keys => ["a", "b", "c"])
+  db.view(:all)
+
+You may also query the database using temporary views.
+
+  temp_view = { :map => "function(doc){emit(doc.status,null)}" }
+  db.view(:temp, :funcs => temp_view, :key => "verified")
+
+Temp view queries are slow, so they should only be used as a convenience during
+development. Whenever possible you should query against saved views.
 
 == Servers and Databases
 
 The server location defaults to http://127.0.0.1:5984, so you may omit the host
 when initializing a server if you are satisfied with the default.
 
-NOTE: Some cruft needs cleaning up. Use <tt>Cushion!(dbname, opts)</tt> for
-now.
-
 Display various bits of server metadata as follows:
 
+  server = Cushion.server :uri => 'http://myhost:5984'
+
   server.info          #=> welcome message
   server.all_dbs       #=> all dbs available
   server.active_tasks  #=> running tasks (e.g., replication or compaction)

data/lib/cushion.rb

@@ -21,7 +21,7 @@ def Cushion!(dbname, opts = {})
 end
 
 module Cushion
-  VERSION = '0.6.2'
+  VERSION = '0.9.0'
 
   class << self
 
@@ -130,7 +130,6 @@ module Cushion
     attr_accessor :headers
 
     def add_header_field(name, value)
-      #value.gsub!('"', '') if name == :etag  ==> CouchDB seems to require the xtra "'s
       @headers[name] = value
     end
 

data/lib/cushion/database.rb

@@ -234,7 +234,7 @@ module Cushion
       dest_id = options[:dest_id] || id
       opts = options[:dest_rev] ? { :rev => options[:dest_rev] } : {}
       if opts.empty? && (id == dest_id)
-        opts = { :rev => src.headers[:etag] }
+        opts = { :rev => src.headers[:etag].gsub('"', '') }
       end
       res = attach(dest_id, new_filename, src, headers.merge(opts))
       if id == dest_id
@@ -244,42 +244,9 @@ module Cushion
       end
     end
 
-    # Moves the document at +source+ to a new or existing location at +destination+.
-    # Set the +dest_rev+ option to overwrite an existing document. Set the
-    # +headers+ option to pass custom request headers. Example:
-    #
-    #   db.move("doc1", "doc2", :rev => "1234")
-    #     #=> Moves to a new location
-    #   db.copy("doc1", "doc3", :rev => "1234", :dest_rev => "4567")
-    #     #=> Overwrites an existing doc
-    #
-    def move(source, destination, options = {})
-      headers = options.delete(:headers) || {}
-      dest_rev = options.delete(:dest_rev)
-      slug = Cushion.escape_key(source)
-      path = Cushion.paramify_url("#{slug}", options)
-      dest = if dest_rev
-        "#{destination}?rev=#{dest_rev}"
-      else
-        destination
-      end
-      server.move("#{@name}/#{path}", dest, headers)
-    end
-
-    # Moves an attachment to a new location. This is presently experimental.
-    def move_attachment(id, old_filename, new_filename, options = {})
-      res = copy_attachment(id, old_filename, new_filename, options)
-      if res["ok"]
-        destroy(id, old_filename, :rev => res["src_rev"])
-      else
-        res
-      end
-    end
-    alias_method :rename_attachment, :move_attachment
-
     # Query a named view. Set +name+ to :all to query CouchDB's all_docs view.
     # Set +name+ to :temp to query a temp_view. Set the +keys+ option to perform
-    # a key-based multi-document fetch against any view. Examples
+    # a key-based multi-document fetch against any view. Examples:
     #
     #   temp_view = { :map => "function(doc){emit(doc.status,null)}" }
     #   db.view(:temp, :funcs => temp_view, :key => "verified")
@@ -287,6 +254,11 @@ module Cushion
     #   db.view("foo/bar", :keys => ["a", "b", "c"])
     #   db.view(:all)
     #
+    # You should pass the design doc name and view name as two separate
+    # parameters if the design doc name contains slashes:
+    #
+    #   db.view("foo/bar", "baz", :limit => 1)
+    #
     # Set the +headers+ option to pass custom request headers. Set
     # <code>:etag => some_value</code> to perform a simple if-none-match
     # conditional GET.
@@ -295,21 +267,32 @@ module Cushion
     # during development. Whenever possible you should query against saved
     # views.
     #
-    def view(name, options = {})
+    def view(name, *args)
+      options = args.last.respond_to?(:merge) ? args.pop : {}
+
       keys = options.delete(:keys)
       headers = options.delete(:headers) || {}
       if etag = options.delete(:etag)
         headers.merge!(:if_none_match => "\"#{etag}\"".squeeze("\""))
       end
       body = keys ? {:keys => keys} : {}
-      if name == :all
+
+      case name
+      when :all
         slug = "_all_docs"
-      elsif name == :temp
+      when :temp
         slug = "_temp_view"
         body.merge!(options.delete(:funcs))
       else
-        slug = "_view/#{name}"
+        if args.any?
+          dname = Cushion.escape_key(name)
+          vname = args.first
+        else
+          dname, vname = name.split('/', 2)
+        end
+        slug = "_design/#{dname}/_view/#{Cushion.escape_key(vname)}"
       end
+
       path = Cushion.paramify_url(slug, options)
 
       if body.any?
@@ -335,11 +318,13 @@ module Cushion
     # The results are not parsed by default. Set the +headers+ option to pass
     # custom request headers.
     #
+    # TODO: Need to escape names
+    #
     def show(design, show_template, id, options = {})
       defaults = { :accept => "text/html;text/plain;*/*" }
       headers = options.delete(:headers) || {}
       slug = Cushion.escape_key(id)
-      path = Cushion.paramify_url("_show/#{design}/#{show_template}/#{slug}", options)
+      path = Cushion.paramify_url("_design/#{design}/_show/#{show_template}/#{slug}", options)
       get(path, defaults.merge(headers))
     end
 
@@ -347,12 +332,13 @@ module Cushion
     # The results are not parsed by default. Set the +headers+ option to pass
     # custom request headers.
     #
+    # TODO: Need to escape names
     # TODO: Update for multi-key fetch (CouchDB r750565)
     #
     def list(design, list_template, view, options = {})
       defaults = { :accept => "text/html;text/plain;*/*" }
       headers = options.delete(:headers) || {}
-      path = Cushion.paramify_url("_list/#{design}/#{list_template}/#{view}", options)
+      path = Cushion.paramify_url("_design/#{design}/_list/#{list_template}/#{view}", options)
       get(path, defaults.merge(headers))
     end
 

data/lib/cushion/document.rb

@@ -125,17 +125,29 @@ module Cushion
       database.fetch(id, filename)
     end
 
-    # Renames an attachment. +oldname+ is the name of the existing attachment
+    # Copies an attachment. +oldname+ is the name of the existing attachment
     # and +newname+ is the desired name.
-    def rename(oldname, newname)
-      result = database.move_attachment(id, oldname, newname)
+    def copy(oldname, newname)
+      result = database.copy_attachment(id, oldname, newname)
       if result['ok']
         self[:_rev] = result['rev']
-        attachments[newname] = attachments.delete(oldname)
+        attachments[newname] = {
+          "stub" => true,
+          "content_type" => attachments[oldname]['content_type'],
+          "length" => attachments[oldname]['length']
+        }
       end
       result['ok']
     end
 
+    # Renames an attachment. +oldname+ is the name of the existing attachment
+    # and +newname+ is the desired name.
+    def rename(oldname, newname)
+      if copy(oldname, newname)
+        detach(oldname)
+      end
+    end
+
     # Reloads this document.
     def reload
       initialize(database.fetch(id))
@@ -146,18 +158,7 @@ module Cushion
     # the +dest_rev+ option must be provided.
     def copy_to(dest_id, opts = {})
       result = database.copy(id, dest_id, :dest_rev => opts[:rev])
-      result['ok']
-    end
-
-    # Moves this document to a new id. If +dest_id+ currently exists then
-    # the +dest_rev+ option must be provided.
-    def move_to(dest_id, opts = {})
-      result = database.move(id, dest_id, :rev => rev, :dest_rev => opts[:rev])
-      if result['ok']
-        self[:_rev] = nil
-        self[:_id] = nil
-      end
-      result['ok']
+      result['rev']
     end
 
     def to_json

data/lib/cushion/server.rb

@@ -146,15 +146,6 @@ module Cushion
       parse_response(RestClient.copy("#{@uri}/#{source}", defaults.merge(headers)))
     end
 
-    # Issues a MOVE request to the CouchDB server, moving a document from +source+
-    # 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 = {})
-      defaults = { :accept => "application/json", 'Destination' => destination }
-      parse_response(RestClient.move("#{@uri}/#{source}", defaults.merge(headers)))
-    end
-
     # Issues a generic request to the server +path+ with the method set to +verb+.
     # Accepts +body+ and +headers+ options.
     def request(verb, path, params = {})

data/spec/database_spec.rb

@@ -82,7 +82,7 @@ describe "A Cushion database" do
 
     it "should pass extra parameters to CouchDB" do
       @db.store("_id" => "123")
-      @db.fetch("123", :revs => true)["_revs"].should.not.be.nil
+      @db.fetch("123", :revs => true)["_revisions"].should.not.be.nil
     end
 
     it "should pass headers to CouchDB" do
@@ -176,7 +176,7 @@ describe "A Cushion database" do
 
   it "should bulk save documents with #bulk" do
     count = @db.info["doc_count"]
-    @db.bulk([{"_id" => "456"},{"_id" => "789"}])["ok"].should.be.true
+    @db.bulk([{"_id" => "456"},{"_id" => "789"}]).length.should == 2
     @db.info["doc_count"].should == count + 2
   end
 
@@ -185,7 +185,7 @@ describe "A Cushion database" do
     @db.store("_id" => "456")
     count = @db.info["doc_count"]
     docs = @db.all(:keys => ["123", "456"], :include_docs => true)
-    @db.bulk(docs["rows"].map{ |row| row["doc"] }, :delete => true)["ok"].should.be.true
+    @db.bulk(docs["rows"].map{ |row| row["doc"] }, :delete => true).length.should == 2
     @db.info["doc_count"].should == count - 2
   end
 
@@ -223,6 +223,10 @@ describe "A Cushion database" do
       @db.view("foo/bar", :keys => ["vince carter"])["rows"].length.should == 1
     end
 
+    it "should retrieve docs from regular views with #view and split params" do
+      @db.view('foo', 'bar', :key => "gomer pyle")["rows"].length.should == 1
+    end
+
     it "should perform a conditional GET" do
       etag = @db.view("foo/bar").etag
       lambda {
@@ -245,7 +249,7 @@ describe "A Cushion database" do
     end
   end
 
-  describe "when copying and moving documents" do
+  describe "when copying documents" do
     before do
       @source = @db.store("_id" => "source", "_attachments" => {
           "foo.txt" => {
@@ -257,23 +261,12 @@ describe "A Cushion database" do
     end
 
     it "should copy a doc to a new id with #copy" do
-      @db.copy("source", "source_1")["ok"].should.be.true
+      @db.copy("source", "source_1")['rev'].should.not.be.nil
       lambda { @db.fetch("source_1") }.should.not.raise
     end
 
     it "should copy a doc to an existing doc" do
-      @db.copy("source", "dest", :dest_rev => @dest["rev"])["ok"].should.be.true
-      @db.fetch("dest")["_attachments"].should.not.be.nil
-    end
-
-    it "should move a doc to a new id with #move" do
-      @db.move("source", "source_1", :rev => @source["rev"])["ok"].should.be.true
-      lambda { @db.fetch("source_1") }.should.not.raise
-      lambda { @db.fetch("source") }.should.raise RestClient::ResourceNotFound
-    end
-
-    it "should move a doc to an existing doc" do
-      @db.move("source", "dest", :rev => @source["rev"], :dest_rev => @dest["rev"])["ok"].should.be.true
+      @db.copy("source", "dest", :dest_rev => @dest["rev"])['rev'].should.not.be.nil
       @db.fetch("dest")["_attachments"].should.not.be.nil
     end
 
@@ -287,18 +280,5 @@ describe "A Cushion database" do
         :dest_rev => @dest["rev"])["ok"].should.be.true
       @db.fetch("dest", "bar.txt").should == "Hello World!"
     end
-
-    it "should move a file to a new key under the same doc with #move_attachment" do
-      @db.move_attachment("source", "foo.txt", "bar.txt")["ok"].should.be.true
-      @db.fetch("source", "bar.txt").should == "Hello World!"
-      lambda { @db.fetch("source", "foo.txt") }.should.raise RestClient::ResourceNotFound
-    end
-
-    it "should move a file to a new key in another doc with #move_attachment" do
-      @db.move_attachment("source", "foo.txt", "bar.txt", :dest_id => "dest",
-        :dest_rev => @dest["rev"])["ok"].should.be.true
-      @db.fetch("dest", "bar.txt").should == "Hello World!"
-      lambda { @db.fetch("source", "foo.txt") }.should.raise RestClient::ResourceNotFound
-    end
   end
 end

data/spec/document_spec.rb

@@ -119,6 +119,12 @@ describe "A Cushion Document" do
       @doc.fetch("foo.txt").should == "hello"
     end
 
+    it "should copy an attachment with #copy" do
+      @doc.copy('foo.txt', 'bar.txt').should.be.true
+      @doc.attachments['bar.txt'].should.not.be.nil
+      @doc.attachments['bar.txt']['content_type'].should == 'text/plain'
+    end
+
     it "should rename an attachment with #rename" do
       @doc.rename("foo.txt", "bar.txt").should.be.true
       @doc.attachments["foo.txt"].should.be.nil
@@ -136,7 +142,7 @@ describe "A Cushion Document" do
   it "should copy itself to a new document with #copy_to" do
     @doc["foo"] = "bar"
     @doc.save
-    @doc.copy_to("newdoc").should.be.true
+    @doc.copy_to("newdoc").should.not.be.nil
     @db.fetch("newdoc")["foo"].should == "bar"
   end
 
@@ -144,25 +150,8 @@ describe "A Cushion Document" do
     res = @db.store("_id" => "otherdoc")
     @doc["foo"] = "bar"
     @doc.save
-    @doc.copy_to("otherdoc", :rev => res['rev']).should.be.true
-    @db.fetch("otherdoc")["foo"].should == "bar"
-  end
-
-  it "should move itself to a new document with #move_to" do
-    @doc.merge!("_id" => "123", "foo" => "bar")
-    @doc.save
-    @doc.move_to("newdoc").should.be.true
-    @db.fetch("newdoc")["foo"].should == "bar"
-    @db.key?("123").should.be.false
-  end
-
-  it "should move itself to an existing doc with #move_to" do
-    @doc.merge!("_id" => "123", "foo" => "bar")
-    res = @db.store("_id" => "otherdoc")
-    @doc.save
-    @doc.move_to("otherdoc", :rev => res['rev']).should.be.true
+    @doc.copy_to("otherdoc", :rev => res['rev']).should.not.be.nil
     @db.fetch("otherdoc")["foo"].should == "bar"
-    @db.key?("123").should.be.false
   end
 
   it "should serialize its attributes with #to_json" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: akdubya-cushion
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: 0.9.0
 platform: ruby
 authors: 
 - Aleksander Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-14 00:00:00 -07:00
+date: 2009-03-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency