jchris-couchrest 0.9.1 → 0.9.2

data/README.markdown

@@ -0,0 +1,51 @@
+## CouchRest - CouchDB, close to the metal
+
+CouchRest is based on [CouchDB's couch.js test library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js), which I find to be concise, clear, and well designed. CouchRest lightly wraps CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths to CouchDB's API endpoints so you don't have to.
+
+CouchRest's lighweight is designed to make a simple base for application and framework-specific object oriented APIs.
+
+### Easy Install
+
+`sudo gem install jchris-couchrest -s http://gems.github.com`
+
+### Relax, it's RESTful
+
+The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime you’re interfacing with a well-defined web service. 
+
+### Running the Specs
+
+The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run `rake`, or `autotest` (requires RSpec and optionally ZenTest for autotest support). 
+
+### Examples
+
+Quick Start:
+
+    # with !, it creates the database if it doesn't already exist
+    @db = CouchRest.database!("http://localhost:5984/couchrest-test")
+    response = @db.save({:key => 'value', 'another key' => 'another value'})
+    doc = @db.get(response['id'])
+    puts doc.inspect
+
+Bulk Save:
+
+    @db.bulk_save([
+        {"wild" => "and random"},
+        {"mild" => "yet local"},
+        {"another" => ["set","of","keys"]}
+      ])
+    # returns ids and revs of the current docs
+    puts @db.documents.inspect 
+
+Creating and Querying Views:
+
+    @db.save({
+      "_id" => "_design/first", 
+      :views => {
+        :test => {
+          :map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
+          }
+        }
+      })
+    puts @db.view('first/test')['rows'].inspect 
+
+

data/lib/couch_rest.rb

@@ -1,7 +1,27 @@
 class CouchRest
-  attr_accessor :uri
-  def initialize server = 'http://localhost:5984'
+  attr_accessor :uri, :uuid_batch_count
+  def initialize server = 'http://localhost:5984', uuid_batch_count = 1000
     @uri = server
+    @uuid_batch_count = uuid_batch_count
+  end
+  
+  # ensure that a database exists
+  # creates it if it isn't already there
+  # returns it after it's been created
+  def self.database! url
+    uri = URI.parse url
+    path = uri.path
+    uri.path = ''
+    cr = CouchRest.new(uri.to_s)
+    cr.database!(path)
+  end
+  
+  def self.database url
+    uri = URI.parse url
+    path = uri.path
+    uri.path = ''
+    cr = CouchRest.new(uri.to_s)
+    cr.database(path)
   end
   
   # list all databases on the server
@@ -10,7 +30,13 @@ class CouchRest
   end
   
   def database name
-    CouchRest::Database.new(@uri, name)
+    CouchRest::Database.new(self, name)
+  end
+  
+  # creates the database if it doesn't exist
+  def database! name
+    create_db(path) rescue nil
+    database name
   end
   
   # get the welcome message
@@ -18,17 +44,25 @@ class CouchRest
     CouchRest.get "#{@uri}/"
   end
 
-  # restart the couchdb instance
-  def restart!
-    CouchRest.post "#{@uri}/_restart"
-  end
-  
   # create a database
   def create_db name
     CouchRest.put "#{@uri}/#{name}"
     database name
   end
 
+  # restart the couchdb instance
+  def restart!
+    CouchRest.post "#{@uri}/_restart"
+  end
+
+  def next_uuid count = @uuid_batch_count
+    @uuids ||= []
+    if @uuids.empty?
+      @uuids = CouchRest.post("#{@uri}/_uuids?count=#{count}")["uuids"]
+    end
+    @uuids.pop
+  end
+
   class << self
     def put uri, doc = nil
       payload = doc.to_json if doc

data/lib/couchrest.rb

@@ -6,5 +6,6 @@ require File.dirname(__FILE__) + '/couch_rest'
 require File.dirname(__FILE__) + '/database'
 require File.dirname(__FILE__) + '/pager'
 require File.dirname(__FILE__) + '/file_manager'
+require File.dirname(__FILE__) + '/streamer'
 
 

data/lib/database.rb

@@ -3,10 +3,12 @@ require "base64"
 
 class CouchRest
   class Database
-    attr_accessor :host, :name
-    def initialize host, name
+    attr_reader :server, :host, :name, :root
+     
+    def initialize server, name
       @name = name
-      @host = host
+      @server = server
+      @host = server.uri
       @root = "#{host}/#{name}"
     end
     
@@ -14,6 +16,10 @@ class CouchRest
       @root
     end
     
+    def info
+      CouchRest.get @root
+    end
+    
     def documents params = nil
       url = CouchRest.paramify_url "#{@root}/_all_docs", params
       CouchRest.get url  
@@ -58,13 +64,18 @@ class CouchRest
       end
       if doc['_id']
         slug = CGI.escape(doc['_id'])
-        CouchRest.put "#{@root}/#{slug}", doc
       else
-        CouchRest.post "#{@root}", doc
+        slug = doc['_id'] = @server.next_uuid
       end
+      CouchRest.put "#{@root}/#{slug}", doc
     end
     
     def bulk_save docs
+      ids, noids = docs.partition{|d|d['_id']}
+      uuid_count = [noids.length, @server.uuid_batch_count].max
+      noids.each do |doc|
+        doc['_id'] = @server.next_uuid(uuid_count)
+      end
       CouchRest.post "#{@root}/_bulk_docs", {:docs => docs}
     end
     
@@ -76,7 +87,9 @@ class CouchRest
     def delete!
       CouchRest.delete @root
     end
+
     private
+
     def encode_attachments attachments
       attachments.each do |k,v|
         next if v['stub']
@@ -84,6 +97,7 @@ class CouchRest
       end
       attachments
     end
+
     def base64 data
       Base64.encode64(data).gsub(/\s/,'')
     end

data/lib/pager.rb

@@ -1,19 +1,3 @@
-module Enumerable
-  def group_by
-    inject({}) do |grouped, element|
-      (grouped[yield(element)] ||= []) << element
-      grouped
-    end
-  end unless [].respond_to?(:group_by)
-  
-  def group_by_fast
-    inject({}) do |grouped, element|
-      (grouped[yield(element)] ||= []) << element
-      grouped
-    end
-  end
-end
-
 class CouchRest
   class Pager
     attr_accessor :db
@@ -74,12 +58,6 @@ class CouchRest
           end   
           startkey = endkey
         end
-
-        # grouped = rows.group_by{|r|r['key']}
-        # grouped.each do |k, rs|
-        #   vs = rs.collect{|r|r['value']}
-        #   yield(k,vs)
-        # end
         
         key = :begin
         values = []

data/lib/streamer.rb

@@ -0,0 +1,29 @@
+class CouchRest
+  class Streamer
+    attr_accessor :db
+    def initialize db
+      @db = db
+    end
+    
+    def view name, params = nil
+      urlst = /^_/.match(name) ? "#{@db.root}/#{name}" : "#{@db.root}/_view/#{name}"
+      url = CouchRest.paramify_url urlst, params
+      IO.popen("curl --silent #{url}") do |view|
+        view.gets # discard header
+        while row = parse_line(view.gets)
+          yield row
+        end
+      end
+    end
+    
+    private
+    
+    def parse_line line
+      return nil unless line
+      if /(\{.*\}),?/.match(line.chomp)
+        JSON.parse($1)
+      end
+    end
+    
+  end
+end

data/spec/couchrest_spec.rb

@@ -26,10 +26,12 @@ describe CouchRest do
     end
   end
   
-  describe "description" do
-    it "should restart" do
-      @cr.restart!
-    end
+  it "should restart" do
+    @cr.restart!
+  end
+
+  it "should provide one-time access to uuids" do
+    @cr.next_uuid.should_not be_nil
   end
 
   describe "initializing a database" do
@@ -40,6 +42,25 @@ describe CouchRest do
     end
   end
 
+  describe "easy initializing a database adapter" do
+    it "should be possible without an explicit CouchRest instantiation" do
+      db = CouchRest.database "http://localhost:5984/couchrest-test"
+      db.should be_an_instance_of(CouchRest::Database)
+      db.host.should == "http://localhost:5984"
+    end
+    it "should not create the database automatically" do
+      db = CouchRest.database "http://localhost:5984/couchrest-test"
+      lambda{db.info}.should raise_error(RestClient::ResourceNotFound)      
+    end
+  end
+
+  describe "ensuring the db exists" do
+    it "should be super easy" do
+      db = CouchRest.database! "http://localhost:5984/couchrest-test-2"
+      db.info["db_name"].should == 'couchrest-test-2'
+    end
+  end
+
   describe "successfully creating a database" do
     it "should start without a database" do
       @cr.databases.should_not include(TESTDB)

data/spec/database_spec.rb

@@ -137,6 +137,17 @@ describe CouchRest::Database do
         @db.get(r['id'])
       end
     end
+    
+    it "should use uuids when ids aren't provided" do
+      @db.server.stub!(:next_uuid).and_return('asdf6sgadkfhgsdfusdf')
+      
+      docs = [{'key' => 'value'}, {'_id' => 'totally-uniq'}]
+      id_docs = [{'key' => 'value', '_id' => 'asdf6sgadkfhgsdfusdf'}, {'_id' => 'totally-uniq'}]
+      CouchRest.should_receive(:post).with("http://localhost:5984/couchrest-test/_bulk_docs", {:docs => id_docs})
+      
+      @db.bulk_save(docs)
+    end
+    
     it "should add them with uniq ids" do
       rs = @db.bulk_save([
           {"_id" => "oneB", "wild" => "and random"},
@@ -147,6 +158,7 @@ describe CouchRest::Database do
         @db.get(r['id'])
       end
     end
+    
     it "in the case of an id conflict should not insert anything" do
       @r = @db.save({'lemons' => 'from texas', 'and' => 'how', "_id" => "oneB"})
       
@@ -159,12 +171,25 @@ describe CouchRest::Database do
       end.should raise_error(RestClient::RequestFailed)
     
       lambda do
-        @db.get('twoB')        
+        @db.get('twoB')
       end.should raise_error(RestClient::ResourceNotFound)
     end
+    it "should raise an error that is useful for recovery" do
+      @r = @db.save({"_id" => "taken", "field" => "stuff"})
+      begin
+        rs = @db.bulk_save([
+            {"_id" => "taken", "wild" => "and random"},
+            {"_id" => "free", "mild" => "yet local"},
+            {"another" => ["set","of","keys"]}
+          ])
+      rescue RestClient::RequestFailed => e
+        # soon CouchDB will provide _which_ docs conflicted
+        JSON.parse(e.response.body)['error'].should == 'conflict'
+      end
+    end
   end
   
-  describe "POST (new document without an id)" do
+  describe "new document without an id" do
     it "should start empty" do
       @db.documents["total_rows"].should == 0
     end
@@ -173,6 +198,11 @@ describe CouchRest::Database do
       r2 = @db.get(r['id'])
       r2["lemons"].should == "from texas"
     end
+    it "should use PUT with UUIDs" do
+      CouchRest.should_receive(:put)
+      r = @db.save({'just' => ['another document']})      
+    end
+    
   end
 
   describe "PUT document with attachment" do

data/spec/streamer_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe CouchRest::Streamer do
+  before(:all) do
+    @cr = CouchRest.new(COUCHHOST)
+    @db = @cr.database(TESTDB)
+    @db.delete! rescue nil
+    @db = @cr.create_db(TESTDB) rescue nil
+    @streamer = CouchRest::Streamer.new(@db)
+    @docs = (1..1000).collect{|i| {:integer => i, :string => i.to_s}}
+    @db.bulk_save(@docs)
+  end
+  
+  it "should yield each row in a view" do
+    count = 0
+    sum = 0
+    @streamer.view("_all_docs") do |row|
+      count += 1
+    end
+    count.should == 1000
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jchris-couchrest
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - J. Chris Anderson
@@ -46,14 +46,16 @@ files:
 - lib/database.rb
 - lib/pager.rb
 - lib/file_manager.rb
+- lib/streamer.rb
 - Rakefile
-- README
+- README.markdown
 - bin/couchdir
 - bin/couchview
 - spec/couchrest_spec.rb
 - spec/database_spec.rb
 - spec/pager_spec.rb
 - spec/file_manager_spec.rb
+- spec/streamer_spec.rb
 - spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/jchris/couchrest

data/README

@@ -1,39 +0,0 @@
-Couchrest is a loose port of the couch.js library from CouchDB’s Futon admin interface, which I find to be concise, clear, and well designed.
-
-I prefer to stay close to the metal, especially when the metal is as clean and simple as CouchDB’s HTTP API. The main thing Couchrest does for you is manage the Ruby <=> JSON serialization, and point your actions (database creation, document CRUD, view creation and queries, etc) at the appropriate API endpoints.
-
-The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime you’re interfacing with a well-defined API. (We use it for Grabb.it’s Tumblr integration, and it works like a charm.)
-
-The most complete source of documentation are the spec files. To ensure that your environment is setup for successful CouchRest operation, from the project root directory run `autotest` or `spec spec` (requires RSpec and optionally ZenTest for autotest support). 
-
-Quick Start:
-
-@cr = CouchRest.new("http://localhost:5984")
-@db = @cr.create_db('couchrest-test')
-response = @db.save({:key => 'value', 'another key' => 'another value'})
-doc = @db.get(response['id'])
-puts doc.inspect
-
-
-Bulk Save:
-
-@db.bulk_save([
-    {"wild" => "and random"},
-    {"mild" => "yet local"},
-    {"another" => ["set","of","keys"]}
-  ])
-puts @db.documents.inspect # returns ids and revs of the current docs
-
-Creating and Querying Views:
-
-@db.save({
-  "_id" => "_design/first", 
-  :views => {
-    :test => {
-      :map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
-      }
-    }
-  })
-puts @db.view('first/test')['rows'].inspect 
-
-