couchrest 1.0.2 → 1.1.0.pre

data/.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
 html/*
 pkg
-*.swp
+*.swp
+Gemfile.lock

data/README.md

@@ -10,6 +10,12 @@ CouchRest is designed to make a simple base for application and framework-specif
 
 **Note: CouchRest only support CouchDB 0.9.0 or newer. Some features requires CouchDB 0.10.0 or newer.**
 
+## Important Upgrade Notice
+
+### 2011-04-04: Time#to_json no longer overwritten!
+
+Now sticking to JSON standard format. Ensure you views using Time will be ordered correctly after upgrade!
+
 ## Easy Install
 
     $ sudo gem install couchrest

data/Rakefile

@@ -20,14 +20,14 @@ end
 
 desc "Run all specs"
 Spec::Rake::SpecTask.new('spec') do |t|
-	t.spec_opts = ["--color"]
-	t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["--color"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
 end
 
 desc "Print specdocs"
 Spec::Rake::SpecTask.new(:doc) do |t|
-	t.spec_opts = ["--format", "specdoc"]
-	t.spec_files = FileList['spec/*_spec.rb']
+  t.spec_opts = ["--format", "specdoc"]
+  t.spec_files = FileList['spec/*_spec.rb']
 end
 
 desc "Generate the rdoc"
@@ -40,12 +40,3 @@ end
 
 desc "Run the rspec"
 task :default => :spec
-
-module Rake
-  def self.remove_task(task_name)
-    Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
-  end
-end
-
-Rake.remove_task("github:release")
-Rake.remove_task("release")

data/couchrest.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couchrest}
-  s.version = "1.0.2"
+  s.version = "1.1.0.pre"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["J. Chris Anderson", "Matt Aimonetti", "Marcos Tapajos", "Will Leinweber", "Sam Lown"]
-  s.date = %q{2011-03-13}
+  s.date = %q{2011-04-06}
   s.description = %q{CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments.}
   s.email = %q{jchris@apache.org}
 

data/history.txt

@@ -1,3 +1,21 @@
+== 1.1.0.rc
+
+* Major changes
+  * Time#to_json monkey patch removed! Standard JSON methods now used instead.
+
+* Minor alterations
+  * Named doc replication (thanks @ahamid)
+  * Database#update_doc no longer requires document to be returned from block (thanks @ferrous26)
+  * Streamer now available for all queries that return multiple documents (thanks @pcapr for pointer)
+  * Streamer#view method removed, use Database.view with block
+  * Database#changes method added (with streamer option)
+  * Added :allow_nil option when creating views
+
+WARNING: If you depend on ordering by Time, this release may cause issues on old databases! 
+Either update your documents to use the new format (JSON standard), or use Javascript's Date.parse 
+method in your views. Also, use Time#utc to ensure universal ordering regardless of time
+zone. (CouchRest Model does this automatically.)
+
 == 1.0.2
 
 * Minor enhancements

data/lib/couchrest/database.rb

@@ -5,10 +5,10 @@ module CouchRest
   class Database
     attr_reader :server, :host, :name, :root, :uri
     attr_accessor :bulk_save_cache_limit
-     
+
     # Create a CouchRest::Database adapter for the supplied CouchRest::Server
     # and database name.
-    #  
+    #
     # ==== Parameters
     # server<CouchRest::Server>:: database host
     # name<String>:: database name
@@ -19,77 +19,62 @@ module CouchRest
       @host = server.uri
       @uri  = "/#{name.gsub('/','%2F')}"
       @root = host + uri
-      @streamer = Streamer.new(self)
+      @streamer = Streamer.new
       @bulk_save_cache = []
       @bulk_save_cache_limit = 500  # must be smaller than the uuid count
     end
-    
+
+    # == Database information and manipulation methods
+
     # returns the database's uri
     def to_s
       @root
     end
-    
+
     # GET the database info from CouchDB
     def info
       CouchRest.get @root
     end
-    
-    # Query the <tt>_all_docs</tt> view. Accepts all the same arguments as view.
-    def documents(params = {})
-      keys = params.delete(:keys)
-      url = CouchRest.paramify_url "#{@root}/_all_docs", params
-      if keys
-        CouchRest.post(url, {:keys => keys})
-      else
-        CouchRest.get url
-      end
+
+    # Compact the database, removing old document revisions and optimizing space use.
+    def compact!
+      CouchRest.post "#{@root}/_compact"
     end
 
-    # Query a CouchDB-Lucene search view
-    def search(name, params={})
-      # -> http://localhost:5984/yourdb/_fti/YourDesign/by_name?include_docs=true&q=plop*'
-      url = CouchRest.paramify_url "#{root}/_fti/#{name}", params
-      CouchRest.get url
+    # Create the database
+    def create!
+      bool = server.create_db(@name) rescue false
+      bool && true
     end
 
-    # load a set of documents by passing an array of ids
-    def get_bulk(ids)
-      documents(:keys => ids, :include_docs => true)
+    # Delete and re create the database
+    def recreate!
+      delete!
+      create!
+    rescue RestClient::ResourceNotFound
+    ensure
+      create!
     end
-    alias :bulk_load :get_bulk
-  
-    # POST a temporary view function to CouchDB for querying. This is not
-    # recommended, as you don't get any performance benefit from CouchDB's
-    # materialized views. Can be quite slow on large databases.
-    def slow_view(funcs, params = {})
-      keys = params.delete(:keys)
-      funcs = funcs.merge({:keys => keys}) if keys
-      url = CouchRest.paramify_url "#{@root}/_temp_view", params
-      JSON.parse(RestClient.post(url, funcs.to_json, CouchRest.default_headers))
-    end
-    
-    # backwards compatibility is a plus
-    alias :temp_view :slow_view
-  
-    # Query a CouchDB view as defined by a <tt>_design</tt> document. Accepts
-    # paramaters as described in http://wiki.apache.org/couchdb/HttpViewApi
-    def view(name, params = {}, &block)
-      keys = params.delete(:keys)
-      name = name.split('/') # I think this will always be length == 2, but maybe not...
-      dname = name.shift
-      vname = name.join('/')
-      url = CouchRest.paramify_url "#{@root}/_design/#{dname}/_view/#{vname}", params
-      if keys
-        CouchRest.post(url, {:keys => keys})
-      else
-        if block_given?
-          @streamer.view("_design/#{dname}/_view/#{vname}", params, &block)
-        else
-          CouchRest.get url
-        end
-      end
+
+    # Replicates via "pulling" from another database to this database. Makes no attempt to deal with conflicts.
+    def replicate_from(other_db, continuous = false, create_target = false, doc_ids = nil)
+      replicate(other_db, continuous, :target => name, :create_target => create_target, :doc_ids => doc_ids)
+    end
+
+    # Replicates via "pushing" to another database. Makes no attempt to deal with conflicts.
+    def replicate_to(other_db, continuous = false, create_target = false, doc_ids = nil)
+      replicate(other_db, continuous, :source => name, :create_target => create_target, :doc_ids => doc_ids)
     end
-    
+
+    # DELETE the database itself. This is not undoable and could be rather
+    # catastrophic. Use with care!
+    def delete!
+      CouchRest.delete @root
+    end
+
+
+    # == Retrieving and saving single documents
+
     # GET a document from CouchDB, by id. Returns a Ruby Hash.
     def get(id, params = {})
       slug = escape_docid(id)
@@ -104,37 +89,6 @@ module CouchRest
       doc.database = self
       doc
     end
-    
-    # GET an attachment directly from CouchDB
-    def fetch_attachment(doc, name)
-      uri = url_for_attachment(doc, name)
-      RestClient.get uri, CouchRest.default_headers
-    end
-    
-    # PUT an attachment directly to CouchDB
-    def put_attachment(doc, name, file, options = {})
-      docid = escape_docid(doc['_id'])
-      uri = url_for_attachment(doc, name)
-      JSON.parse(RestClient.put(uri, file, CouchRest.default_headers.merge(options)))
-    end
-    
-    # DELETE an attachment directly from CouchDB
-    def delete_attachment(doc, name, force=false)
-      uri = url_for_attachment(doc, name)
-      # this needs a rev
-      begin
-        CouchRest.delete(uri)
-      rescue Exception => error
-        if force
-          # get over a 409
-          doc = get(doc['_id'])
-          uri = url_for_attachment(doc, name)
-          CouchRest.delete(uri)
-        else
-          error
-        end
-      end
-    end
 
     # Save a document to CouchDB. This will use the <tt>_id</tt> field from
     # the document as the id for PUT, or request a new UUID from CouchDB, if
@@ -194,7 +148,7 @@ module CouchRest
       end
       result
     end
-    
+
     # Save a document to CouchDB in bulk mode. See #save_doc's +bulk+ argument.
     def bulk_save_doc(doc)
       save_doc(doc, true)
@@ -204,7 +158,7 @@ module CouchRest
     def batch_save_doc(doc)
       save_doc(doc, false, true)
     end
-    
+
     # POST an array of documents to CouchDB. If any of the documents are
     # missing ids, supply one from the uuid cache.
     #
@@ -225,7 +179,7 @@ module CouchRest
       CouchRest.post "#{@root}/_bulk_docs", {:docs => docs}
     end
     alias :bulk_delete :bulk_save
-    
+
     # DELETE the document from CouchDB that has the given <tt>_id</tt> and
     # <tt>_rev</tt>.
     #
@@ -241,7 +195,7 @@ module CouchRest
       slug = escape_docid(doc['_id'])        
       CouchRest.delete "#{@root}/#{slug}?rev=#{doc['_rev']}"
     end
-    
+
     # COPY an existing document to a new id. If the destination id currently exists, a rev must be provided.
     # <tt>dest</tt> can take one of two forms if overwriting: "id_to_overwrite?rev=revision" or the actual doc
     # hash with a '_rev' key
@@ -255,72 +209,135 @@ module CouchRest
       end
       CouchRest.copy "#{@root}/#{slug}", destination
     end
-    
+
     # Updates the given doc by yielding the current state of the doc
-    # and trying to update update_limit times. Returns the new doc
-    # if the doc was successfully updated without hitting the limit
-    def update_doc(doc_id, params = {}, update_limit=10)
+    # and trying to update update_limit times. Returns the doc
+    # if successfully updated without hitting the limit.
+    # If the limit is reached, the last execption will be raised.
+    def update_doc(doc_id, params = {}, update_limit = 10)
       resp = {'ok' => false}
-      new_doc = nil
       last_fail = nil
 
       until resp['ok'] or update_limit <= 0
-        doc = self.get(doc_id, params)  # grab the doc
-        new_doc = yield doc # give it to the caller to be updated
+        doc = self.get(doc_id, params)
+        yield doc
         begin
-          resp = self.save_doc new_doc # try to PUT the updated doc into the db
+          resp = self.save_doc doc
         rescue RestClient::RequestFailed => e
           if e.http_code == 409 # Update collision
             update_limit -= 1
             last_fail = e
-          else # some other error
+          else
             raise e
           end
         end
       end
 
       raise last_fail unless resp['ok']
-      new_doc
+      doc
     end
-    
-    # Compact the database, removing old document revisions and optimizing space use.
-    def compact!
-      CouchRest.post "#{@root}/_compact"
+
+
+    # == View and multi-document based queries
+
+    # Query a CouchDB view as defined by a <tt>_design</tt> document. Accepts
+    # paramaters as described in http://wiki.apache.org/couchdb/HttpViewApi
+    def view(name, params = {}, payload = {}, &block)
+      payload[:keys] = params.delete(:keys) if params[:keys]
+      # Try recognising the name, otherwise assume already prepared
+      view_path = name =~ /^([^_].+?)\/(.*)$/ ? "_design/#{$1}/_view/#{$2}" : name
+      url = CouchRest.paramify_url "#{@root}/#{view_path}", params
+      if block_given?
+        if !payload.empty?
+          @streamer.post url, payload, &block
+        else
+          @streamer.get url, &block
+        end
+      else
+        if !payload.empty?
+          CouchRest.post url, payload
+        else
+          CouchRest.get url
+        end
+      end
     end
-    
-    # Create the database
-    def create!
-      bool = server.create_db(@name) rescue false
-      bool && true
+
+    # POST a temporary view function to CouchDB for querying. This is not
+    # recommended, as you don't get any performance benefit from CouchDB's
+    # materialized views. Can be quite slow on large databases.
+    def temp_view(payload, params = {}, &block)
+      view('_temp_view', params, payload, &block)
     end
-    
-    # Delete and re create the database
-    def recreate!
-      delete!
-      create!
-    rescue RestClient::ResourceNotFound
-    ensure
-      create!
+    alias :slow_view :temp_view
+
+
+    # Query the <tt>_all_docs</tt> view. Accepts all the same arguments as view.
+    def all_docs(params = {}, payload = {}, &block)
+      view("_all_docs", params, payload, &block)
     end
+    alias :documents :all_docs
 
-    # Replicates via "pulling" from another database to this database. Makes no attempt to deal with conflicts.
-    def replicate_from(other_db, continuous = false, create_target = false)
-      replicate(other_db, continuous, :target => name, :create_target => create_target)
+    # Query CouchDB's special <tt>_changes</tt> feed for the latest.
+    # All standard CouchDB options can be provided.
+    #
+    # Warning: sending :feed => 'continuous' will cause your code to block
+    # indefinetly while waiting for changes. You might want to look-up an
+    # alternative to this.
+    def changes(params = {}, payload = {}, &block)
+      view("_changes", params, payload, &block)
     end
 
-    # Replicates via "pushing" to another database. Makes no attempt to deal with conflicts.
-    def replicate_to(other_db, continuous = false, create_target = false)
-      replicate(other_db, continuous, :source => name, :create_target => create_target)
+    # Query a CouchDB-Lucene search view
+    def fti(name, params={})
+      # -> http://localhost:5984/yourdb/_fti/YourDesign/by_name?include_docs=true&q=plop*'
+      view("_fti/#{name}", params)
     end
+    alias :search :fti
 
-    # DELETE the database itself. This is not undoable and could be rather
-    # catastrophic. Use with care!
-    def delete!
-      CouchRest.delete @root
+    # load a set of documents by passing an array of ids
+    def get_bulk(ids)
+      all_docs(:keys => ids, :include_docs => true)
+    end
+    alias :bulk_load :get_bulk
+
+
+    # == Handling attachments
+
+    # GET an attachment directly from CouchDB
+    def fetch_attachment(doc, name)
+      uri = url_for_attachment(doc, name)
+      RestClient.get uri, CouchRest.default_headers
+    end
+
+    # PUT an attachment directly to CouchDB
+    def put_attachment(doc, name, file, options = {})
+      docid = escape_docid(doc['_id'])
+      uri = url_for_attachment(doc, name)
+      JSON.parse(RestClient.put(uri, file, CouchRest.default_headers.merge(options)))
+    end
+
+    # DELETE an attachment directly from CouchDB
+    def delete_attachment(doc, name, force=false)
+      uri = url_for_attachment(doc, name)
+      # this needs a rev
+      begin
+        CouchRest.delete(uri)
+      rescue Exception => error
+        if force
+          # get over a 409
+          doc = get(doc['_id'])
+          uri = url_for_attachment(doc, name)
+          CouchRest.delete(uri)
+        else
+          error
+        end
+      end
     end
 
+
+
     private
-    
+
     def replicate(other_db, continuous, options)
       raise ArgumentError, "must provide a CouchReset::Database" unless other_db.kind_of?(CouchRest::Database)
       raise ArgumentError, "must provide a target or source option" unless (options.key?(:target) || options.key?(:source))
@@ -331,6 +348,7 @@ module CouchRest
         payload[:target] = other_db.root
       end
       payload[:continuous] = continuous
+      payload[:doc_ids] = options[:doc_ids] if options[:doc_ids]
       CouchRest.post "#{@host}/_replicate", payload
     end
 
@@ -352,8 +370,8 @@ module CouchRest
     def url_for_attachment(doc, name)
       @root + uri_for_attachment(doc, name)
     end
-    
-    def escape_docid id      
+
+    def escape_docid id
       /^_design\/(.*)/ =~ id ? "_design/#{CGI.escape($1)}" : CGI.escape(id) 
     end
 

data/lib/couchrest/design.rb

@@ -15,7 +15,8 @@ module CouchRest
         doc_keys = keys.collect{|k| "doc['#{k}']"}
         key_emit = doc_keys.length == 1 ? "#{doc_keys.first}" : "[#{doc_keys.join(', ')}]"
         guards = opts.delete(:guards) || []
-        guards += doc_keys.map{|k| "(#{k} != null)"}
+        guards += doc_keys.map{|k| "(#{k} != null)"} unless opts.delete(:allow_nil)
+        guards << 'true' if guards.empty?
         map_function = <<-JAVASCRIPT
 function(doc) {
   if (#{guards.join(' && ')}) {

data/lib/couchrest/helper/streamer.rb

@@ -1,35 +1,42 @@
 module CouchRest
   class Streamer
-    attr_accessor :db
-    def initialize db
-      @db = db
-    end
-    
-    # Stream a view, yielding one row at a time. Shells out to <tt>curl</tt> to keep RAM usage low when you have millions of rows.
-    def view name, params = nil, &block
-      urlst = if /^_/.match(name) then
-        "#{@db.root}/#{name}"
-      else
-        name = name.split('/')
-        dname = name.shift
-        vname = name.join('/')
-        "#{@db.root}/_design/#{dname}/_view/#{vname}"
-      end
-      url = CouchRest.paramify_url urlst, params
-      # puts "stream #{url}"
+
+    attr_accessor :default_curl_opts
+
+    def initialize
+      self.default_curl_opts = "--silent --no-buffer --tcp-nodelay -H \"Content-Type: application/json\""
+    end
+
+    def view(*args)
+      raise "CouchRest::Streamer#view is depricated. Please use Database#view with block."
+    end
+
+    def get(url, &block)
+      open_pipe("curl #{default_curl_opts} \"#{url}\"", &block)
+    end
+
+    def post(url, params = {}, &block)
+      open_pipe("curl #{default_curl_opts} -d \"#{escape_quotes(params.to_json)}\" \"#{url}\"", &block)
+    end
+
+    protected
+
+    def escape_quotes(data)
+      data.gsub(/"/, '\"')
+    end
+
+    def open_pipe(cmd, &block)
       first = nil
-      IO.popen("curl --silent \"#{url}\"") do |view|
-        first = view.gets # discard header
-        while line = view.gets 
+      IO.popen(cmd) do |f|
+        first = f.gets # discard header
+        while line = f.gets 
           row = parse_line(line)
           block.call row unless row.nil? # last line "}]" discarded
         end
       end
       parse_first(first)
     end
-    
-    private
-    
+
     def parse_line line
       return nil unless line
       if /(\{.*\}),?/.match(line.chomp)
@@ -46,6 +53,6 @@ module CouchRest
     rescue
       nil
     end
-    
+
   end
 end

data/lib/couchrest/monkeypatches.rb

@@ -1,22 +1,7 @@
-require 'timeout'
-
-# This file must be loaded after the JSON gem and any other library that beats up the Time class.
-class Time
-  # This date format sorts lexicographically
-  # and is compatible with Javascript's <tt>new Date(time_string)</tt> constructor.
-  # Note this this format stores all dates in UTC so that collation 
-  # order is preserved. (There's no longer a need to set <tt>ENV['TZ'] = 'UTC'</tt>
-  # in your application.)
-
-  def to_json(options = nil)
-    u = self.getutc
-    %("#{u.strftime("%Y/%m/%d %H:%M:%S +0000")}")
-  end
-
-end
-
 # Monkey patch for faster net/http io
 if RUBY_VERSION.to_f < 1.9
+  require 'timeout'
+
   class Net::BufferedIO #:nodoc:
     alias :old_rbuf_fill :rbuf_fill
     def rbuf_fill
@@ -38,5 +23,3 @@ if RUBY_VERSION.to_f < 1.9
     end
   end
 end
-
-

data/lib/couchrest.rb

@@ -12,13 +12,8 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-require 'rubygems'
-gem 'rest-client', ">= 1.5.1"
-unless Kernel.const_defined?("JSON")
-  gem 'json', '>= 1.4.6'
-  require 'json'
-end
 require 'rest_client'
+require 'json'
 
 # Not sure why this is required, so removed until a reason is found!
 $:.unshift File.dirname(__FILE__) unless

data/spec/couchrest/database_spec.rb

@@ -17,6 +17,12 @@ describe CouchRest::Database do
     end
   end
 
+  describe "#info" do
+    it "should request basic database data" do
+      @db.info['db_name'].should eql(TESTDB)
+    end
+  end
+
   describe "map query with _temp_view in Javascript" do
     before(:each) do
       @db.bulk_save([
@@ -146,6 +152,42 @@ describe CouchRest::Database do
       end
       rows.length.should == 2
     end
+    it "should accept a payload" do
+      rs = @db.view('first/test', {}, :keys => ["another", "wild"])
+      rs['rows'].length.should == 2
+    end
+    it "should accept a payload with block" do
+      rows = []
+      rs = @db.view('first/test', {:include_docs => true}, :keys => ["another", "wild"]) do |row|
+        rows << row
+      end
+      rows.length.should == 2
+      rows.first['doc']['another'].should_not be_empty
+    end
+  end
+
+  describe "#changes" do
+    # uses standard view method, so not much testing required
+    before(:each) do
+      [ 
+        {"wild" => "and random"},
+        {"mild" => "yet local"},
+        {"another" => ["set","of","keys"]}
+      ].each do |d|
+        @db.save_doc(d)
+      end
+    end
+
+    it "should produce a basic list of changes" do
+      c = @db.changes
+      c['results'].length.should eql(3)
+    end
+
+    it "should provide id of last document" do
+      c = @db.changes
+      doc = @db.get(c['results'].last['id'])
+      doc['another'].should_not be_empty
+    end
   end
 
   describe "GET (document by id) when the doc exists" do
@@ -561,7 +603,6 @@ describe CouchRest::Database do
     it "should work under normal conditions" do
       @db.update_doc @id do |doc|
         doc['upvotes'] += 1
-        doc
       end
       @db.get(@id)['upvotes'].should == 11
     end
@@ -572,10 +613,9 @@ describe CouchRest::Database do
           conflicting_doc = @db.get @id
           conflicting_doc['upvotes'] += 1
           @db.save_doc conflicting_doc
-        
+
           # then try saving it through the update
           doc['upvotes'] += 1
-          doc
         end
       end.should raise_error(RestClient::RequestFailed)
     end
@@ -647,6 +687,7 @@ describe CouchRest::Database do
     ds['total_rows'].should == 5
   end
   
+  # This is redundant with the latest view code, but left in place for prosterity.
   describe "documents / _all_docs" do
     before(:each) do
       9.times do |i|
@@ -681,12 +722,11 @@ describe CouchRest::Database do
   end
   
 
-  describe "compacting a database" do
+  describe "#compact" do
     it "should compact the database" do
       db = @cr.database('couchrest-test')
-      # r = 
-      db.compact!
-      # r['ok'].should == true
+      r = db.compact!
+      r['ok'].should == true
     end
   end
 
@@ -696,9 +736,8 @@ describe CouchRest::Database do
     end
     it "should delete the database" do
       db = @cr.database('couchrest-test')
-      # r = 
-      db.delete!
-      # r['ok'].should == true
+      r = db.delete!
+      r['ok'].should == true
       @cr.databases.should_not include('couchrest-test')
     end
   end
@@ -733,6 +772,20 @@ describe CouchRest::Database do
 
       it_should_behave_like "simply replicated"
     end
+    
+    describe "with a specific doc" do
+      before(:each) do
+        @other_db.recreate!
+        @db.save_doc({'_id' => 'unreplicated_doc', 'some-value' => 'foo'})
+        @db.replicate_to @other_db, false, false, ['test_doc']
+      end
+      
+      # should contain only replicated doc and not unreplicated doc
+      it_should_behave_like "simply replicated"
+      it "does not contain unreplicated doc" do 
+        lambda { @other_db.get('unreplicated_doc') }.should raise_error(RestClient::ResourceNotFound)
+      end
+    end
 
     describe "implicitly creating target" do
       describe "via pulling" do
@@ -811,39 +864,38 @@ describe CouchRest::Database do
     end
   end
 
-  describe "creating a database" do
+  describe "#create!" do
     before(:each) do
       @db = @cr.database('couchrest-test-db_to_create')
       @db.delete! if @cr.databases.include?('couchrest-test-db_to_create')
     end
-    
+
     it "should just work fine" do
       @cr.databases.should_not include('couchrest-test-db_to_create')
       @db.create!
       @cr.databases.should include('couchrest-test-db_to_create')
     end
   end
-  
-  describe "recreating a database" do
+
+  describe "#recreate!" do
     before(:each) do
       @db = @cr.database('couchrest-test-db_to_create')
       @db2 = @cr.database('couchrest-test-db_to_recreate')
       @cr.databases.include?(@db.name) ? nil : @db.create!
       @cr.databases.include?(@db2.name) ? @db2.delete! : nil
     end
-    
+
     it "should drop and recreate a database" do
        @cr.databases.should include(@db.name)
        @db.recreate!
        @cr.databases.should include(@db.name)
     end
-    
+
     it "should recreate a db even tho it doesn't exist" do
       @cr.databases.should_not include(@db2.name)
       @db2.recreate!
       @cr.databases.should include(@db2.name)
     end
-    
   end
 
   describe "searching a database" do

data/spec/couchrest/design_spec.rb

@@ -154,6 +154,26 @@ describe CouchRest::Design do
     end
   end
 
+  describe "a view with nil and 0 values and :allow_nil" do
+    before(:all) do
+      @db = reset_test_db!
+      @des = CouchRest::Design.new
+      @des.name = "test"
+      @des.view_by :code, :allow_nil => true
+      @des.database = @db
+      @des.save
+      @db.bulk_save([{"code" => "a", "age" => 2},
+        {"code" => nil, "age" => 4},{"code" => 0, "age" => 9}])
+    end
+    it "should work" do
+      res = @des.view :by_code
+      res["rows"][0]["key"].should == nil
+      res["rows"][1]["key"].should == 0
+      res["rows"][2]["key"].should == "a"
+    end
+  end
+
+
   describe "a view with a reduce function" do
     before(:all) do
       @db = reset_test_db!

data/spec/couchrest/helpers/streamer_spec.rb

@@ -6,7 +6,7 @@ describe CouchRest::Streamer do
     @db = @cr.database(TESTDB)
     @db.delete! rescue nil
     @db = @cr.create_db(TESTDB) rescue nil
-    @streamer = CouchRest::Streamer.new(@db)
+    @streamer = CouchRest::Streamer.new()
     @docs = (1..1000).collect{|i| {:integer => i, :string => i.to_s}}
     @db.bulk_save(@docs)
     @db.save_doc({
@@ -18,35 +18,42 @@ describe CouchRest::Streamer do
       }
     })
   end
-  
-  it "should yield each row in a view" do
+
+  it "should raise error on #view as depricated" do
+    lambda { @streamer.view }.should raise_error(/depricated/)
+  end
+
+  it "should GET each row in a view" do
     count = 0
-    sum = 0
-    @streamer.view("_all_docs") do |row|
+    @streamer.get("#{@db.root}/_all_docs") do |row|
       count += 1
     end
     count.should == 1001
   end
 
-  it "should accept several params" do
+  it "should GET each row in a view with params" do
     count = 0
-    @streamer.view("_design/first/_view/test", :include_docs => true, :limit => 5) do |row|
+    @streamer.get("#{@db.root}/_all_docs?include_docs=true&limit=5") do |row|
       count += 1
     end
     count.should == 5
   end
 
-  it "should accept both view formats" do
-    count = 0
-    @streamer.view("_design/first/_view/test") do |row|
-      count += 1
+  it "should POST for each row in a view" do
+    # First grab a pair of IDs
+    ids = []
+    @streamer.get("#{@db.root}/_design/first/_view/test?limit=2") do |row|
+      ids << row['id']
     end
-    count.should == 2000
     count = 0
-    @streamer.view("first/test") do |row|
+    @streamer.post("#{@db.root}/_all_docs?include_docs=true", :keys => ids) do |row|
       count += 1
     end
-    count.should == 2000
+    count.should == 2
+  end
+
+  it "should escape quotes" do
+    @streamer.send(:escape_quotes, "keys: [\"sams's test\"]").should eql("keys: [\\\"sams's test\\\"]")
   end
 
 end

metadata

@@ -1,85 +1,82 @@
 --- !ruby/object:Gem::Specification 
 name: couchrest
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+    - 1
+    - 1
+    - 0
+    - pre
+  version: 1.1.0.pre
 platform: ruby
 authors: 
-- J. Chris Anderson
-- Matt Aimonetti
-- Marcos Tapajos
-- Will Leinweber
-- Sam Lown
+  - J. Chris Anderson
+  - Matt Aimonetti
+  - Marcos Tapajos
+  - Will Leinweber
+  - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-03-13 00:00:00 +01:00
+date: 2011-04-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 1
-        version: 1.6.1
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mime-types
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 15
-        version: "1.15"
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
-  type: :development
-  version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: rest-client
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 6
+              - 1
+            version: 1.6.1
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: mime-types
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 15
+            version: "1.15"
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: json
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 5
+              - 1
+            version: 1.5.1
+    type: :runtime
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 3
+              - 0
+            version: 1.3.0
+    type: :development
+    version_requirements: *id004
 description: CouchRest provides a simple interface on top of CouchDB's RESTful HTTP API, as well as including some utility scripts for managing views and attachments.
 email: jchris@apache.org
 executables: []
@@ -87,99 +84,112 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
-- README.md
-- THANKS.md
+  - LICENSE
+  - README.md
+  - THANKS.md
 files: 
-- .gitignore
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.md
-- Rakefile
-- THANKS.md
-- couchrest.gemspec
-- examples/word_count/markov
-- examples/word_count/views/books/chunked-map.js
-- examples/word_count/views/books/united-map.js
-- examples/word_count/views/markov/chain-map.js
-- examples/word_count/views/markov/chain-reduce.js
-- examples/word_count/views/word_count/count-map.js
-- examples/word_count/views/word_count/count-reduce.js
-- examples/word_count/word_count.rb
-- examples/word_count/word_count_query.rb
-- examples/word_count/word_count_views.rb
-- history.txt
-- init.rb
-- lib/couchrest.rb
-- lib/couchrest/commands/generate.rb
-- lib/couchrest/commands/push.rb
-- lib/couchrest/database.rb
-- lib/couchrest/design.rb
-- lib/couchrest/document.rb
-- lib/couchrest/helper/attachments.rb
-- lib/couchrest/helper/pager.rb
-- lib/couchrest/helper/streamer.rb
-- lib/couchrest/helper/upgrade.rb
-- lib/couchrest/middlewares/logger.rb
-- lib/couchrest/monkeypatches.rb
-- lib/couchrest/response.rb
-- lib/couchrest/rest_api.rb
-- lib/couchrest/server.rb
-- lib/couchrest/support/inheritable_attributes.rb
-- spec/.gitignore
-- spec/couchrest/couchrest_spec.rb
-- spec/couchrest/database_spec.rb
-- spec/couchrest/design_spec.rb
-- spec/couchrest/document_spec.rb
-- spec/couchrest/helpers/pager_spec.rb
-- spec/couchrest/helpers/streamer_spec.rb
-- spec/couchrest/server_spec.rb
-- spec/fixtures/attachments/README
-- spec/fixtures/attachments/couchdb.png
-- spec/fixtures/attachments/test.html
-- spec/fixtures/views/lib.js
-- spec/fixtures/views/test_view/lib.js
-- spec/fixtures/views/test_view/only-map.js
-- spec/fixtures/views/test_view/test-map.js
-- spec/fixtures/views/test_view/test-reduce.js
-- spec/spec.opts
-- spec/spec_helper.rb
-- utils/remap.rb
-- utils/subset.rb
+  - .gitignore
+  - Gemfile
+  - LICENSE
+  - README.md
+  - Rakefile
+  - THANKS.md
+  - couchrest.gemspec
+  - examples/word_count/markov
+  - examples/word_count/views/books/chunked-map.js
+  - examples/word_count/views/books/united-map.js
+  - examples/word_count/views/markov/chain-map.js
+  - examples/word_count/views/markov/chain-reduce.js
+  - examples/word_count/views/word_count/count-map.js
+  - examples/word_count/views/word_count/count-reduce.js
+  - examples/word_count/word_count.rb
+  - examples/word_count/word_count_query.rb
+  - examples/word_count/word_count_views.rb
+  - history.txt
+  - init.rb
+  - lib/couchrest.rb
+  - lib/couchrest/commands/generate.rb
+  - lib/couchrest/commands/push.rb
+  - lib/couchrest/database.rb
+  - lib/couchrest/design.rb
+  - lib/couchrest/document.rb
+  - lib/couchrest/helper/attachments.rb
+  - lib/couchrest/helper/pager.rb
+  - lib/couchrest/helper/streamer.rb
+  - lib/couchrest/helper/upgrade.rb
+  - lib/couchrest/middlewares/logger.rb
+  - lib/couchrest/monkeypatches.rb
+  - lib/couchrest/response.rb
+  - lib/couchrest/rest_api.rb
+  - lib/couchrest/server.rb
+  - lib/couchrest/support/inheritable_attributes.rb
+  - spec/.gitignore
+  - spec/couchrest/couchrest_spec.rb
+  - spec/couchrest/database_spec.rb
+  - spec/couchrest/design_spec.rb
+  - spec/couchrest/document_spec.rb
+  - spec/couchrest/helpers/pager_spec.rb
+  - spec/couchrest/helpers/streamer_spec.rb
+  - spec/couchrest/server_spec.rb
+  - spec/fixtures/attachments/README
+  - spec/fixtures/attachments/couchdb.png
+  - spec/fixtures/attachments/test.html
+  - spec/fixtures/views/lib.js
+  - spec/fixtures/views/test_view/lib.js
+  - spec/fixtures/views/test_view/only-map.js
+  - spec/fixtures/views/test_view/test-map.js
+  - spec/fixtures/views/test_view/test-reduce.js
+  - spec/spec.opts
+  - spec/spec_helper.rb
+  - utils/remap.rb
+  - utils/subset.rb
 has_rdoc: true
 homepage: http://github.com/couchrest/couchrest
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
+  - --charset=UTF-8
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 1
+          - 3
+          - 1
+        version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Lean and RESTful interface to CouchDB.
-test_files: []
-
+test_files: 
+  - spec/couchrest/couchrest_spec.rb
+  - spec/couchrest/database_spec.rb
+  - spec/couchrest/design_spec.rb
+  - spec/couchrest/document_spec.rb
+  - spec/couchrest/helpers/pager_spec.rb
+  - spec/couchrest/helpers/streamer_spec.rb
+  - spec/couchrest/server_spec.rb
+  - spec/fixtures/attachments/README
+  - spec/fixtures/attachments/couchdb.png
+  - spec/fixtures/attachments/test.html
+  - spec/fixtures/views/lib.js
+  - spec/fixtures/views/test_view/lib.js
+  - spec/fixtures/views/test_view/only-map.js
+  - spec/fixtures/views/test_view/test-map.js
+  - spec/fixtures/views/test_view/test-reduce.js
+  - spec/spec.opts
+  - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,24 +0,0 @@
-PATH
-  remote: .
-  specs:
-    couchrest (1.0.2)
-      json (~> 1.5.1)
-      mime-types (~> 1.15)
-      rest-client (~> 1.6.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    json (1.5.1-java)
-    mime-types (1.16)
-    rest-client (1.6.1)
-      mime-types (>= 1.16)
-    rspec (1.3.1)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  couchrest!
-  rspec (~> 1.3.0)