jchris-couchrest 0.2.2 → 0.7.99

data/script/couchview

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby
+
+commands = %w{pull push}
+
+command = ARGV[0]
+
+if !commands.include?(command)
+  puts <<-USAGE
+Usage: couchview (pull|push) my-database-name
+For help on pull and push run script/views (pull|push) without a database name.
+USAGE
+  exit
+end
+
+if ARGV.length == 1
+  case command
+  when "pull"
+    puts <<-PULL
+couchview pull my-database-name
+
+I will automagically create a "views" directory in your current working directory if none exists.
+Then I copy the design documents and views into a directory structure like:
+
+./views/my-design-doc/view-name-map.js
+./views/my-design-doc/view-name-reduce.js
+
+If your view names don't end in "map" or "reduce" I'll add those suffixes as a pull. On push I'll put them in new locations corresponding to these new names (overwriting the old design documents). I'm opinionated, but if these conventions don't work for you, the source code is right here.
+    
+    PULL
+  when "push"
+    puts <<-PUSH
+couchview push my-database-name
+
+I'll push all the files in your views directory to the specified database. Because CouchDB caches the results of view calculation by function content, there's no performance penalty for duplicating the map function twice, which I'll do if you have a reduce function. This makes it possible to browse the results of just the map, which can be useful for both queries and debugging.
+
+./views/my-design-doc/view-name-map.js
+./views/my-design-doc/view-name-reduce.js
+
+  Pushed to =>
+
+  http://localhost:5984/my-database-name/_design/my-design-doc
+    {
+      "views" : {
+        "view-name-map" : {
+          "map" : "### contents of view-name-map.js ###"
+        },
+        "view-name-reduce" : {
+          "map" : "### contents of view-name-map.js ###",
+          "reduce" : "### contents of view-name-reduce.js ###"
+        },
+      }
+    }
+PUSH
+  end
+  exit
+end
+
+dbname = ARGV[1]
+dirname = ARGV[2] || "views"
+
+puts "Running #{command} on #{dbname} from directory #{dirname}."
+
+require File.expand_path(File.dirname(__FILE__)) + '/../couchrest'
+require 'fileutils'
+
+module Enumerable
+  def group_by
+    inject({}) do |groups, element|
+      (groups[yield(element)] ||= []) << element
+      groups
+    end
+  end if RUBY_VERSION < '1.9'
+end
+
+# connect to couchdb
+cr = CouchRest.new("http://localhost:5984")
+db = cr.database(dbname)
+
+def readjs(file, libs=nil)
+  st = open(file).read
+  st.sub!(/\/\/include-lib/,libs) if libs
+  st
+end
+
+case command
+when "push" # files to views
+  views = {}
+  viewfiles = Dir.glob(File.join(dirname,"**","*.js")) # todo support non-js views
+  libfiles = viewfiles.select{|f|/lib\.js/.match(f)}
+  libs = open(libfiles[0]).read if libfiles[0]
+  all = (viewfiles-libfiles).collect do |file|
+    fileparts = file.split('/')
+    filename = /(\w.*)-(\w.*)\.js/.match file.split('/').pop
+    design = fileparts[1]
+    view = filename[1]
+    func = filename[2]
+    path = file
+    [design,view,func,path]
+  end
+  designs = all.group_by{|f|f[0]}
+  designs.each do |design,parts|
+    # puts "replace _design/#{design}? (enter to proceed, 'n' to skip)"
+    # rep = $stdin.gets.chomp
+    # next if rep == 'n'
+    dviews = {}
+    parts.group_by{|p|p[1]}.each do |view,fs|
+      fs.each do |f|
+        dviews["#{view}-reduce"] ||= {}
+        dviews["#{view}-reduce"][f[2]] = readjs(f.last,libs)        
+      end
+      dviews["#{view}-map"] = {'map' => dviews["#{view}-reduce"]['map']}
+      dviews.delete("#{view}-reduce") unless dviews["#{view}-reduce"]["reduce"]
+    end
+    # save them to the db
+    view = db.get("_design/#{design}") rescue nil
+    if (view && view['views'] == dviews)
+      puts "no change to _design/#{design}. skipping..."
+    else
+      puts "replacing _design/#{design}"
+      db.delete(view) rescue nil
+      db.save({
+        "_id" => "_design/#{design}",
+        :views => dviews
+      })   
+    end
+  end
+  
+when "pull" # views to files
+  ds = db.documents(:startkey => '_design/', :endkey => '_design/ZZZZZZZZZ')
+  ds['rows'].collect{|r|r['id']}.each do |id|
+    puts directory = id.split('/').last
+    FileUtils.mkdir_p(File.join("views",directory))
+    views = db.get(id)['views']
+    
+    vgroups = views.keys.group_by{|k|k.sub(/\-(map|reduce)$/,'')}
+    vgroups.each do|g,vs|
+      mapname = vs.find {|v|views[v]["map"]}
+      if mapname
+        # save map
+        mapfunc = views[mapname]["map"]
+        mapfile = File.join(dirname,directory,"#{g}-map.js") # todo support non-js views
+        File.open(mapfile,'w') do |f|
+          f.write mapfunc
+        end
+      end
+      
+      reducename = vs.find {|v|views[v]["reduce"]}
+      if reducename
+        # save reduce
+        reducefunc = views[reducename]["reduce"]
+        reducefile = File.join(dirname,directory,"#{g}-reduce.js") # todo support non-js views
+        File.open(reducefile,'w') do |f|
+          f.write reducefunc
+        end
+      end
+    end
+  end  
+end

data/spec/couchrest_spec.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/../lib/couchrest'
+
+describe CouchRest do
+
+  before(:each) do
+    @cr = CouchRest.new("http://localhost:5984")
+    @db = @cr.database('couchrest-test')
+    begin
+      @db.delete! 
+    rescue RestClient::Request::RequestFailed
+    end
+  end
+
+  after(:each) do
+    begin
+      @db.delete!
+    rescue RestClient::Request::RequestFailed
+    end
+  end
+
+  describe "tested against the current CouchDB svn revision" do
+    it "should be up to date" do
+      v = @cr.info["version"]
+      if /incubating/.match(v)
+        v.should include('0.8.0')
+      else
+        vi = v.split(/a/).pop.to_i
+        vi.should be >= 661484 # versions older than this will likely fail many specs
+        vi.should be <= 663797 # versions newer than this haven't been tried
+      end
+    end
+  end
+
+  describe "getting info" do
+    it "should list databases" do
+      @cr.databases.should be_an_instance_of(Array)
+    end
+    it "should get info" do
+      @cr.info["couchdb"].should == "Welcome"
+      @cr.info.class.should == Hash   
+    end
+  end
+  
+  describe "description" do
+    it "should restart" do
+      @cr.restart!
+    end
+  end
+
+  describe "initializing a database" do
+    it "should return a db" do
+      db = @cr.database('couchrest-test')
+      db.should be_an_instance_of(CouchRest::Database)
+      db.host.should == @cr.uri
+    end
+  end
+
+  describe "successfully creating a database" do
+    it "should start without a database" do
+      @cr.databases.should_not include('couchrest-test')
+    end
+    it "should return the created database" do
+      db = @cr.create_db('couchrest-test')
+      db.should be_an_instance_of(CouchRest::Database)
+    end
+    it "should create the database" do
+      db = @cr.create_db('couchrest-test')
+      @cr.databases.should include('couchrest-test')
+    end
+  end
+
+  describe "failing to create a database because the name is taken" do
+    before(:each) do
+      db = @cr.create_db('couchrest-test')
+    end
+    it "should start with the test database" do
+      @cr.databases.should include('couchrest-test')
+    end
+    it "should PUT the database and raise an error" do
+      lambda{
+        @cr.create_db('couchrest-test')
+      }.should raise_error(RestClient::Request::RequestFailed)
+    end
+  end
+
+end

data/spec/database_spec.rb

@@ -0,0 +1,407 @@
+require File.dirname(__FILE__) + '/../lib/couchrest'
+
+describe CouchRest::Database do
+  before(:each) do
+    @cr = CouchRest.new("http://localhost:5984")
+    begin
+      @db = @cr.create_db('couchrest-test')
+    rescue RestClient::Request::RequestFailed
+    end
+  end
+  
+  after(:each) do
+    begin
+      @db.delete!
+    rescue RestClient::Request::RequestFailed
+    end
+  end
+    
+  describe "map query with _temp_view in Javascript" do
+    before(:each) do
+      @db.bulk_save([
+          {"wild" => "and random"},
+          {"mild" => "yet local"},
+          {"another" => ["set","of","keys"]}
+        ])
+      @temp_view = {:map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"}
+    end
+    it "should return the result of the temporary function" do
+      rs = @db.temp_view(@temp_view)
+      rs['rows'].select{|r|r['key'] == 'wild' && r['value'] == 'and random'}.length.should == 1
+    end
+    it "should work with a range" do
+      rs = @db.temp_view(@temp_view,{:startkey => "b", :endkey => "z"})
+      rs['rows'].length.should == 2
+    end
+    it "should work with a key" do
+      rs = @db.temp_view(@temp_view,{:key => "wild"})
+      rs['rows'].length.should == 1
+    end
+    it "should work with a count" do
+      rs = @db.temp_view(@temp_view,{:count => 1})
+      rs['rows'].length.should == 1
+    end
+  end
+
+  describe "map/reduce query with _temp_view in Javascript" do
+    before(:each) do
+      @db.bulk_save([
+          {"beverage" => "beer", :count => 4},
+          {"beverage" => "beer", :count => 2},
+          {"beverage" => "tea", :count => 3}
+        ])
+    end
+    it "should return the result of the temporary function" do
+      rs = @db.temp_view(:map => "function(doc){emit(doc.beverage, doc.count)}", :reduce =>  "function(beverage,counts){return sum(counts)}")
+      # rs.should == 'x'
+      rs['rows'][0]['value'].should == 9
+    end
+  end
+  
+  describe "saving a view" do
+    before(:each) do
+      @view = {'test' => {'map' => 'function(doc) {
+        if (doc.word && !/\W/.test(doc.word)) {
+          emit(doc.word,null);
+        }
+      }'}}
+      @db.save({
+        "_id" => "_design/test",
+        :views => @view
+      })
+    end
+    it "should work properly" do
+      @db.bulk_save([
+        {"word" => "once"},
+        {"word" => "and again"}
+      ])
+      @db.view('test/test')['total_rows'].should == 1
+    end
+    it "should round trip" do
+      @db.get("_design/test")['views'].should == @view
+    end
+  end
+  
+  describe "select from an existing view" do
+    before(:each) do
+      r = @db.save({
+        "_id" => "_design/first", 
+        :views => {
+          :test => {
+            :map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
+            }
+          }
+        })
+      @db.bulk_save([
+          {"wild" => "and random"},
+          {"mild" => "yet local"},
+          {"another" => ["set","of","keys"]}
+        ])
+    end
+    it "should have the view" do
+      @db.get('_design/first')['views']['test']['map'].should include("for(var w in doc)")
+    end
+    it "should list from the view" do
+      rs = @db.view('first/test')
+      rs['rows'].select{|r|r['key'] == 'wild' && r['value'] == 'and random'}.length.should == 1
+    end
+    it "should work with a range" do
+      rs = @db.view('first/test',{:startkey => "b", :endkey => "z"})
+      rs['rows'].length.should == 2
+    end
+    it "should work with a key" do
+      rs = @db.view('first/test',{:key => "wild"})
+      rs['rows'].length.should == 1
+    end
+    it "should work with a count" do
+      rs = @db.view('first/test',{:count => 1})
+      rs['rows'].length.should == 1
+    end
+  end
+
+  describe "GET (document by id) when the doc exists" do
+    before(:each) do
+      @r = @db.save({'lemons' => 'from texas', 'and' => 'spain'})
+      @docid = "http://example.com/stuff.cgi?things=and%20stuff"
+      @db.save({'_id' => @docid, 'will-exist' => 'here'})
+    end
+    it "should get the document" do
+      doc = @db.get(@r['id'])
+      doc['lemons'].should == 'from texas'
+    end
+    it "should work with a funky id" do
+      @db.get(@docid)['will-exist'].should == 'here'
+    end
+  end
+  
+  describe "POST (adding bulk documents)" do
+    it "should add them without ids" do
+      rs = @db.bulk_save([
+          {"wild" => "and random"},
+          {"mild" => "yet local"},
+          {"another" => ["set","of","keys"]}
+        ])
+      rs['new_revs'].each do |r|
+        @db.get(r['id'])
+      end
+    end
+    it "should add them with uniq ids" do
+      rs = @db.bulk_save([
+          {"_id" => "oneB", "wild" => "and random"},
+          {"_id" => "twoB", "mild" => "yet local"},
+          {"another" => ["set","of","keys"]}
+        ])
+      rs['new_revs'].each do |r|
+        @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"})
+      
+      lambda do
+      rs = @db.bulk_save([
+          {"_id" => "oneB", "wild" => "and random"},
+          {"_id" => "twoB", "mild" => "yet local"},
+          {"another" => ["set","of","keys"]}
+        ])
+      end.should raise_error(RestClient::Request::RequestFailed)
+    
+      lambda do
+        @db.get('twoB')        
+      end.should raise_error(RestClient::Request::RequestFailed)
+    end
+  end
+  
+  describe "POST (new document without an id)" do
+    it "should start empty" do
+      @db.documents["total_rows"].should == 0
+    end
+    it "should create the document and return the id" do
+      r = @db.save({'lemons' => 'from texas', 'and' => 'spain'})
+      r2 = @db.get(r['id'])
+      r2["lemons"].should == "from texas"
+    end
+  end
+
+  describe "PUT document with attachment" do
+    before(:each) do
+      @attach = "<html><head><title>My Doc</title></head><body><p>Has words.</p></body></html>"
+      @doc = {
+        "_id" => "mydocwithattachment",
+        "field" => ["some value"],
+        "_attachments" => {
+          "test.html" => {
+            "type" => "text/html",
+            "data" => @attach
+          }
+        }
+      }
+      @db.save(@doc)
+    end
+    it "should save and be indicated" do
+      doc = @db.get("mydocwithattachment")
+      doc['_attachments']['test.html']['length'].should == @attach.length
+    end
+    it "should be there" do
+      attachment = @db.fetch_attachment("mydocwithattachment","test.html")
+      attachment.should == @attach
+    end
+  end
+  
+  describe "PUT document with attachment stub" do
+    before(:each) do
+      @attach = "<html><head><title>My Doc</title></head><body><p>Has words.</p></body></html>"
+      doc = {
+        '_id' => 'mydocwithattachment',
+        'field' => ['some_value'],
+        '_attachments' => {
+          'test.html' => {
+            'type' => 'text/html', 'data' => @attach
+          }
+        }
+      }
+      @db.save(doc)
+      doc = @db.get('mydocwithattachment')
+      doc['field'] << 'another value'
+      @db.save(doc)
+    end
+    
+    it 'should be there' do
+      attachment = @db.fetch_attachment('mydocwithattachment', 'test.html')
+      attachment.should == @attach
+    end
+  end
+
+  describe "PUT document with multiple attachments" do
+    before(:each) do
+      @attach = "<html><head><title>My Doc</title></head><body><p>Has words.</p></body></html>"
+      @attach2 = "<html><head><title>Other Doc</title></head><body><p>Has more words.</p></body></html>"
+      @doc = {
+        "_id" => "mydocwithattachment",
+        "field" => ["some value"],
+        "_attachments" => {
+          "test.html" => {
+            "type" => "text/html",
+            "data" => @attach
+          },
+          "other.html" => {
+            "type" => "text/html",
+            "data" => @attach2
+          }
+        }
+      }
+      @db.save(@doc)
+    end
+    it "should save and be indicated" do
+      doc = @db.get("mydocwithattachment")
+      doc['_attachments']['test.html']['length'].should == @attach.length
+      doc['_attachments']['other.html']['length'].should == @attach2.length
+    end
+    it "should be there" do
+      attachment = @db.fetch_attachment("mydocwithattachment","test.html")
+      attachment.should == @attach
+    end
+    it "should be there" do
+      attachment = @db.fetch_attachment("mydocwithattachment","other.html")
+      attachment.should == @attach2
+    end
+  end
+
+  describe "POST document with attachment (with funky name)" do
+    before(:each) do
+      @attach = "<html><head><title>My Funky Doc</title></head><body><p>Has words.</p></body></html>"
+      @doc = {
+        "field" => ["some other value"],
+        "_attachments" => {
+          "http://example.com/stuff.cgi?things=and%20stuff" => {
+            "type" => "text/html",
+            "data" => @attach
+          }
+        }
+      }
+      @docid = @db.save(@doc)['id']
+    end
+    it "should save and be indicated" do
+      doc = @db.get(@docid)
+      doc['_attachments']['http://example.com/stuff.cgi?things=and%20stuff']['length'].should == @attach.length
+    end
+    it "should be there" do
+      attachment = @db.fetch_attachment(@docid,"http://example.com/stuff.cgi?things=and%20stuff")
+      attachment.should == @attach
+    end
+  end
+
+  describe "PUT (new document with url id)" do
+    it "should create the document" do
+      @docid = "http://example.com/stuff.cgi?things=and%20stuff"
+      @db.save({'_id' => @docid, 'will-exist' => 'here'})
+      lambda{@db.save({'_id' => @docid})}.should raise_error(RestClient::Request::RequestFailed)
+      @db.get(@docid)['will-exist'].should == 'here'
+    end
+  end
+  
+  describe "PUT (new document with id)" do
+    it "should start without the document" do
+      # r = @db.save({'lemons' => 'from texas', 'and' => 'spain'})
+      @db.documents['rows'].each do |doc|
+        doc['id'].should_not == 'my-doc'
+      end
+      # should_not include({'_id' => 'my-doc'})
+      # this needs to be a loop over docs on content with the post
+      # or instead make it return something with a fancy <=> method
+    end
+    it "should create the document" do
+      @db.save({'_id' => 'my-doc', 'will-exist' => 'here'})
+      lambda{@db.save({'_id' => 'my-doc'})}.should raise_error(RestClient::Request::RequestFailed)
+    end
+  end
+  
+  describe "PUT (existing document with rev)" do
+    before(:each) do
+      @db.save({'_id' => 'my-doc', 'will-exist' => 'here'})
+      @doc = @db.get('my-doc')
+      @docid = "http://example.com/stuff.cgi?things=and%20stuff"
+      @db.save({'_id' => @docid, 'now' => 'save'})
+    end
+    it "should start with the document" do
+      @doc['will-exist'].should == 'here'
+      @db.get(@docid)['now'].should == 'save'
+    end
+    it "should save with url id" do
+      doc = @db.get(@docid)
+      doc['yaml'] = ['json', 'word.']
+      @db.save doc
+      @db.get(@docid)['yaml'].should == ['json', 'word.']
+    end
+    it "should fail to resave without the rev" do
+      @doc['them-keys'] = 'huge'
+      @doc['_rev'] = 'wrong'
+      # @db.save(@doc)
+      lambda {@db.save(@doc)}.should raise_error
+    end
+    it "should update the document" do
+      @doc['them-keys'] = 'huge'
+      @db.save(@doc)
+      now = @db.get('my-doc')
+      now['them-keys'].should == 'huge'
+    end
+  end
+  
+  describe "DELETE existing document" do
+    before(:each) do
+      @r = @db.save({'lemons' => 'from texas', 'and' => 'spain'})
+      @docid = "http://example.com/stuff.cgi?things=and%20stuff"
+      @db.save({'_id' => @docid, 'will-exist' => 'here'})
+    end
+    it "should work" do
+      doc = @db.get(@r['id'])
+      doc['and'].should == 'spain'
+      @db.delete doc
+      lambda{@db.get @r['id']}.should raise_error
+    end
+    it "should work with uri id" do
+      doc = @db.get(@docid)
+      @db.delete doc
+      lambda{@db.get @docid}.should raise_error
+    end
+  end
+  
+  it "should list documents" do
+    5.times do
+      @db.save({'another' => 'doc', 'will-exist' => 'anywhere'})
+    end
+    ds = @db.documents
+    ds['rows'].should be_an_instance_of(Array)
+    ds['rows'][0]['id'].should_not be_nil
+    ds['total_rows'].should == 5
+  end
+  
+  it "should list documents with keys and such" do
+    9.times do |i|
+      @db.save({'_id' => "doc#{i}",'another' => 'doc', 'will-exist' => 'here'})
+    end
+    ds = @db.documents
+    ds['rows'].should be_an_instance_of(Array)
+    ds['rows'][0]['id'].should == "doc0"
+    ds['total_rows'].should == 9
+    ds = @db.documents(:startkey => 'doc0', :endkey => 'doc3')
+    ds['rows'].length.should == 4
+    ds = @db.documents(:key => 'doc0')
+    ds['rows'].length.should == 1
+  end
+  
+  describe "deleting a database" do
+    it "should start with the test database" do
+      @cr.databases.should include('couchrest-test')
+    end
+    it "should delete the database" do
+      db = @cr.database('couchrest-test')
+      # r = 
+      db.delete!
+      # r['ok'].should == true
+      @cr.databases.should_not include('couchrest-test')
+    end
+  end
+
+
+end