jchris-couchrest 0.9.3 → 0.9.4

data/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/{README.markdown → README.rdoc}

@@ -1,22 +1,22 @@
-## CouchRest - CouchDB, close to the metal
+== 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
+=== Easy Install
 
-`sudo gem install jchris-couchrest -s http://gems.github.com`
+  sudo gem install jchris-couchrest -s http://gems.github.com
 
-### Relax, it's RESTful
+=== 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
+=== 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
+=== Examples
 
 Quick Start:
 

data/Rakefile

@@ -1,6 +1,65 @@
 require 'rake'
+require "rake/rdoctask"
 require 'spec/rake/spectask'
 
+
+spec = Gem::Specification.new do |s|
+  s.name = "couchrest"
+  s.version = "0.9.4"
+  s.date = "2008-09-11"
+  s.summary = "Lean and RESTful interface to CouchDB."
+  s.email = "jchris@grabb.it"
+  s.homepage = "http://github.com/jchris/couchrest"
+  s.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."
+  s.has_rdoc = true
+  s.authors = ["J. Chris Anderson"]
+  s.files = %w( LICENSE README.rdoc Rakefile THANKS ) + Dir["{bin,examples,lib,spec,utils}/**/*"]
+  s.extra_rdoc_files = %w( README.rdoc LICENSE THANKS )
+  s.require_path = "lib"
+  s.bindir = 'bin'
+  s.executables << 'couchview'
+  s.executables << 'couchdir'
+  s.add_dependency("json", ">= 1.1.2")
+  s.add_dependency("rest-client", ">= 0.5")
+end
+
+namespace :github do # thanks merb!
+  desc "Update Github Gemspec"
+  task :update_gemspec do
+    skip_fields = %w(new_platform original_platform)
+    integer_fields = %w(specification_version)
+
+    result = "Gem::Specification.new do |s|\n"
+    spec.instance_variables.each do |ivar|
+      value = spec.instance_variable_get(ivar)
+      name  = ivar.split("@").last
+      next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
+      if name == "dependencies"
+        value.each do |d|
+          puts d.to_s
+          dep, *ver = d.to_s.split(" ")
+          result <<  "  s.add_dependency #{dep.inspect}, [#{ /\(([^\,]*)/ . match(ver.join(" "))[1].inspect}]\n"
+        end
+      else        
+        case value
+        when Array
+          value =  name != "files" ? value.inspect : value.inspect.split(",").join(",\n")
+        when Fixnum
+          # leave as-is
+        when String
+          value = value.to_i if integer_fields.include?(name)
+          value = value.inspect
+        else
+          value = value.to_s.inspect
+        end
+        result << "  s.#{name} = #{value}\n"
+      end
+    end
+    result << "end"
+    File.open(File.join(File.dirname(__FILE__), "#{spec.name}.gemspec"), "w"){|f| f << result}
+  end
+end
+
 desc "Run all specs"
 Spec::Rake::SpecTask.new('spec') do |t|
 	t.spec_files = FileList['spec/*_spec.rb']
@@ -12,4 +71,17 @@ Spec::Rake::SpecTask.new(:doc) do |t|
 	t.spec_files = FileList['spec/*_spec.rb']
 end
 
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc"
+  rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
+end
+
+desc "Generate the gemspec"
+
+
+
+
 task :default => :spec

data/THANKS

@@ -0,0 +1,15 @@
+CouchRest THANKS
+=====================
+
+CouchRest was originally developed by J. Chris Anderson <jchris@grabb.it>
+and a number of other contributors. Many people further contributed to 
+CouchRest by reporting problems, suggesting various improvements or submitting
+changes. A list of these people is included below.
+
+ * Greg Borenstein <http://ideasfordozens.com>
+ * Geoffrey Grosenbach <http://nubyonrails.com/>
+ * Simon Rozet <simon /at/ rozet /dot/ name>
+
+Patches are welcome. The primary source for this software project is:
+
+http://github.com/jchris/couchrest/tree/master

data/bin/couchview

@@ -1,7 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require File.dirname(__FILE__) + "/../lib/couch_rest/commands"
+require 'couchrest'
+
+%w(generate push).each do |file|
+  require File.dirname(__FILE__) + "/../lib/couchrest/commands/#{file}"
+end
 
 # Set defaults
 options = {
@@ -36,12 +40,6 @@ unless (["push", "generate"].include?(options[:command]) && options[:directory]
   exit
 end
 
-# The options hash now contains the resolved defaults 
-# and the overrides from the command line.
-
-# Call your class and send it the options here
-# cr = CouchRest::FileManager.new(options[:database_name])
-
 case options[:command]
 when "push"
   CouchRest::Commands::Push.run(options)

data/examples/word_count/markov

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__)) + '/../../couchrest'
+
+cr = CouchRest.new("http://localhost:5984")
+@db = cr.database('word-count-example')
+@word_memoizer = {}
+
+def probable_follower_for(word)
+  @word_memoizer[word] ||= @db.view('markov/chain-reduce', :startkey => [word,nil], :endkey => [word,{}],:group_level => 2)
+  
+  # puts
+  # puts "search #{word} #{wprobs[word]['rows'].length}"
+  # @word_memoizer[word]['rows'].sort_by{|r|r['value']}.each{|r|puts [r['value'],r['key']].inspect}
+  
+  rows = @word_memoizer[word]['rows'].select{|r|(r['key'][1]!='')}.sort_by{|r|r['value']}
+  row = rows[(-1*[rows.length,5].min)..-1].sort_by{rand}[0]
+  row ? row['key'][1] : nil
+end
+
+
+word = ARGV[0]
+words = [word]
+
+while word
+  $stdout.print ' ' if words.length > 1
+  $stdout.print word
+  $stdout.flush
+  word = probable_follower_for(word)
+  words << word
+end
+
+$stdout.print '.'
+$stdout.flush
+puts
+
+# `say #{words.join(' ')}`
+

data/examples/word_count/views/books/chunked-map.js

@@ -0,0 +1,3 @@
+function(doc) {
+  doc.title && doc.chunk && emit([doc.title, doc.chunk],null);
+}

data/examples/word_count/views/books/united-map.js

@@ -0,0 +1 @@
+function(doc){if(doc.text && doc.text.match(/united/))  emit([doc.title, doc.chunk],null)}

data/examples/word_count/views/markov/chain-map.js

@@ -0,0 +1,6 @@
+function(doc){
+  var words = doc.text.split(/\W/).filter(function(w) {return w.length > 0}).map(function(w){return w.toLowerCase()});
+  for (var i = 0, l = words.length; i < l; i++) {
+    emit(words.slice(i,4),doc.title);
+  }
+}

data/examples/word_count/views/markov/chain-reduce.js

@@ -0,0 +1,7 @@
+function(key,vs,c){
+  if (c) {
+    return sum(vs);
+  } else {
+    return vs.length;
+  }
+}

data/examples/word_count/views/word_count/count-map.js

@@ -0,0 +1,6 @@
+function(doc){
+  var words = doc.text.split(/\W/).map(function(w){return w.toLowerCase()});
+  words.forEach(function(word){
+    if (word.length > 0) emit([word,doc.title],1);
+  });
+}

data/examples/word_count/views/word_count/count-reduce.js

@@ -0,0 +1,3 @@
+function(key,combine){
+  return sum(combine);
+}

data/examples/word_count/word_count.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../../couchrest'
+
+couch = CouchRest.new("http://localhost:5984")
+db = couch.database('word-count-example')
+db.delete! rescue nil
+db = couch.create_db('word-count-example')
+
+books = {
+  'outline-of-science.txt' => 'http://www.gutenberg.org/files/20417/20417.txt',
+  'ulysses.txt' => 'http://www.gutenberg.org/dirs/etext03/ulyss12.txt',
+  'america.txt' => 'http://www.gutenberg.org/files/16960/16960.txt',
+  'da-vinci.txt' => 'http://www.gutenberg.org/dirs/etext04/7ldv110.txt'
+}
+
+books.each do |file, url|
+  pathfile = File.join(File.dirname(__FILE__),file)
+  `curl #{url} > #{pathfile}` unless File.exists?(pathfile)  
+end
+
+
+books.keys.each do |book|
+  title = book.split('.')[0]
+  puts title
+  File.open(File.join(File.dirname(__FILE__),book),'r') do |file|
+    lines = []
+    chunk = 0
+    while line = file.gets
+      lines << line
+      if lines.length > 10
+        db.save({
+          :title => title,
+          :chunk => chunk, 
+          :text => lines.join('')
+        })
+        chunk += 1
+        puts chunk
+        lines = []
+      end
+    end
+  end
+end
+ 
+# word_count = {
+#   :map => 'function(doc){
+#     var words = doc.text.split(/\W/);
+#     words.forEach(function(word){
+#       if (word.length > 0) emit([word,doc.title],1);
+#     });
+#   }',
+#   :reduce => 'function(key,combine){
+#     return sum(combine);
+#   }'
+# }
+# 
+# db.delete db.get("_design/word_count") rescue nil
+# 
+# db.save({
+#   "_id" => "_design/word_count",
+#   :views => {
+#     :count => word_count,
+#     :words => {:map => word_count[:map]}
+#   }
+# })
+
+# puts "The books have been stored in your CouchDB. To initiate the MapReduce process, visit http://localhost:5984/_utils/ in your browser and click 'word-count-example', then select view 'words' or 'count'. The process could take about 15 minutes on an average MacBook."
+# 
+

data/examples/word_count/word_count_query.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../../couchrest'
+
+couch = CouchRest.new("http://localhost:5984")
+db = couch.database('word-count-example')
+
+puts "Now that we've parsed all those books into CouchDB, the queries we can run are incredibly flexible."
+puts "\nThe simplest query we can run is the total word count for all words in all documents:"
+
+puts db.view('word_count/count').inspect
+
+puts "\nWe can also narrow the query down to just one word, across all documents. Here is the count for 'flight' in all three books:"
+
+word = 'flight'
+params = {
+  :startkey => [word], 
+  :endkey => [word,'Z']
+  }
+
+puts db.view('word_count/count',params).inspect
+
+puts "\nWe scope the query using startkey and endkey params to take advantage of CouchDB's collation ordering. Here are the params for the last query:"
+puts params.inspect
+
+puts "\nWe can also count words on a per-title basis."
+
+title = 'da-vinci'
+params = {
+  :key => [word, title]
+  }
+  
+puts db.view('word_count/count',params).inspect
+
+
+puts "\nHere are the params for 'flight' in the da-vinci book:"
+puts params.inspect
+puts
+puts 'The url looks like this:'
+puts 'http://localhost:5984/word-count-example/_view/word_count/count?key=["flight","da-vinci"]'
+puts "\nTry dropping that in your browser..."

data/lib/{couch_rest → couchrest}/commands/generate.rb

@@ -1,6 +1,6 @@
 require 'fileutils'
 
-class CouchRest
+module CouchRest
   module Commands
     module Generate
 

data/lib/{couch_rest → couchrest}/commands/push.rb

@@ -1,4 +1,4 @@
-class CouchRest
+module CouchRest
 
   module Commands
 

data/lib/{database.rb → couchrest/core/database.rb}

@@ -1,7 +1,7 @@
 require 'cgi'
 require "base64"
 
-class CouchRest
+module CouchRest
   class Database
     attr_reader :server, :host, :name, :root
      

data/lib/couchrest/core/server.rb

@@ -0,0 +1,49 @@
+module CouchRest
+  class Server
+    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
+  
+    # list all databases on the server
+    def databases
+      CouchRest.get "#{@uri}/_all_dbs"
+    end
+  
+    def database name
+      CouchRest::Database.new(self, name)
+    end
+  
+    # creates the database if it doesn't exist
+    def database! name
+      create_db(name) rescue nil
+      database name
+    end
+  
+    # get the welcome message
+    def info
+      CouchRest.get "#{@uri}/"
+    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
+
+  end
+end

data/lib/{file_manager.rb → couchrest/helper/file_manager.rb}

@@ -1,6 +1,6 @@
 require 'digest/md5'
 
-class CouchRest
+module CouchRest
   class FileManager
     attr_reader :db
     attr_accessor :loud

data/lib/{pager.rb → couchrest/helper/pager.rb}

@@ -1,4 +1,4 @@
-class CouchRest
+module CouchRest
   class Pager
     attr_accessor :db
     def initialize db

data/lib/{streamer.rb → couchrest/helper/streamer.rb}

@@ -1,4 +1,4 @@
-class CouchRest
+module CouchRest
   class Streamer
     attr_accessor :db
     def initialize db

data/lib/couchrest/monkeypatches.rb

@@ -0,0 +1,22 @@
+
+# this file must be loaded after the JSON gem
+
+class Time
+  # this date format sorts lexicographically
+  # and is compatible with Javascript's new Date(time_string) constructor
+  # note that sorting will break if you store times from multiple timezones
+  # I like to add a ENV['TZ'] = 'UTC' to my apps
+
+  def to_json(options = nil)
+    %("#{strftime("%Y/%m/%d %H:%M:%S %z")}")
+  end
+
+  # this works to decode the outputted time format
+  # copied from ActiveSupport
+  # def self.parse string, fallback=nil
+  #   d = DateTime.parse(string).new_offset
+  #   self.utc(d.year, d.month, d.day, d.hour, d.min, d.sec)
+  # rescue
+  #   fallback
+  # end
+end

data/lib/couchrest.rb

@@ -1,29 +1,92 @@
+# Copyright 2008 J. Chris Anderson
+# 
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+# 
+#        http://www.apache.org/licenses/LICENSE-2.0
+# 
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
 require "rubygems"
 require 'json'
 require 'rest_client'
 
-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'
+$:.unshift File.dirname(__FILE__) unless
+  $:.include?(File.dirname(__FILE__)) ||
+  $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
+  
+require 'couchrest/monkeypatches'
+
+module CouchRest
+  autoload :Server,       'couchrest/core/server'
+  autoload :Database,     'couchrest/core/database'
+  autoload :Pager,        'couchrest/helper/pager'
+  autoload :FileManager,  'couchrest/helper/file_manager'
+  autoload :Streamer,     'couchrest/helper/streamer'
+  
+  # The CouchRest module methods handle the basic JSON serialization 
+  # and deserialization, as well as query parameters. The module also includes
+  # some helpers for tasks like instantiating a new Database or Server instance.
+  class << self
 
-# this has to come after the JSON gem
+    # todo, make this parse the url and instantiate a Server or Database instance
+    # depending on the specificity.
+    def new(*opts)
+      Server.new(*opts)
+    end
+    
+    # ensure that a database exists
+    # creates it if it isn't already there
+    # returns it after it's been created
+    def database! url
+      uri = URI.parse url
+      path = uri.path
+      uri.path = ''
+      cr = CouchRest.new(uri.to_s)
+      cr.database!(path)
+    end
+  
+    def database url
+      uri = URI.parse url
+      path = uri.path
+      uri.path = ''
+      cr = CouchRest.new(uri.to_s)
+      cr.database(path)
+    end
+    
+    def put uri, doc = nil
+      payload = doc.to_json if doc
+      JSON.parse(RestClient.put(uri, payload))
+    end
 
-# this date format sorts lexicographically
-# and is compatible with Javascript's new Date(time_string) constructor
-# note that sorting will break if you store times from multiple timezones
-# I like to add a ENV['TZ'] = 'UTC' to my apps
-class Time
-  def to_json(options = nil)
-    %("#{strftime("%Y/%m/%d %H:%M:%S %z")}")
-  end
-  # this works to decode the outputted time format
-  # from ActiveSupport
-  # def self.parse string, fallback=nil
-  #   d = DateTime.parse(string).new_offset
-  #   self.utc(d.year, d.month, d.day, d.hour, d.min, d.sec)
-  # rescue
-  #   fallback
-  # end
+    def get uri
+      JSON.parse(RestClient.get(uri), :max_nesting => false)
+    end
+  
+    def post uri, doc = nil
+      payload = doc.to_json if doc
+      JSON.parse(RestClient.post(uri, payload))
+    end
+  
+    def delete uri
+      JSON.parse(RestClient.delete(uri))
+    end
+  
+    def paramify_url url, params = nil
+      if params
+        query = params.collect do |k,v|
+          v = v.to_json if %w{key startkey endkey}.include?(k.to_s)
+          "#{k}=#{CGI.escape(v.to_s)}"
+        end.join("&")
+        url = "#{url}?#{query}"
+      end
+      url
+    end
+  end # class << self
 end

data/spec/fixtures/attachments/test.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test</title>
+  </head>
+  <body>
+    <p>
+      Test
+    </p>
+  </body>
+</html>

data/spec/fixtures/views/lib.js

@@ -0,0 +1,3 @@
+function globalLib() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/lib.js

@@ -0,0 +1,3 @@
+function justThisView() {
+  return "fixture";
+};

data/spec/fixtures/views/test_view/only-map.js

@@ -0,0 +1,4 @@
+function(doc) {
+  //include-lib
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-map.js

@@ -0,0 +1,3 @@
+function(doc) {
+  emit(null, null);
+};

data/spec/fixtures/views/test_view/test-reduce.js

@@ -0,0 +1,3 @@
+function(ks,vs,co) {
+  return vs.length;
+};

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/utils/remap.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'couchrest'
+
+# set the source db and map view
+source = CouchRest.new("http://localhost:5984").database('source-db')
+source_view = 'mydesign/view-map'
+
+# set the target db
+target = CouchRest.new("http://localhost:5984").database('target-db')
+
+
+pager = CouchRest::Pager.new(source)
+
+# pager will yield once per uniq key in the source view
+
+pager.key_reduce(source_view, 10000) do |key, values|
+  # create a doc from the key and the values
+  example_doc = {
+    :key => key,
+    :values => values.uniq
+  }
+
+  target.save(example_doc)
+  
+  # keep us up to date with progress
+  puts k if (rand > 0.9)
+end

data/utils/subset.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'couchrest'
+
+# subset.rb replicates a percentage of a database to a fresh database.
+# use it to create a smaller dataset on which to prototype views.
+
+# specify the source database
+source = CouchRest.new("http://localhost:5984").database('source-db')
+
+# specify the target database
+target = CouchRest.new("http://localhost:5984").database('target-db')
+
+# pager efficiently yields all view rows
+pager = CouchRest::Pager.new(source)
+
+pager.all_docs(1000) do |rows|  
+  docs = rows.collect do |r|
+    # the percentage of docs to clone
+    next if rand > 0.1 
+    doc = source.get(r['id'])
+    doc.delete('_rev')
+    doc      
+  end.compact
+  puts docs.length
+  next if docs.empty?
+
+  puts docs.first['_id']
+  target.bulk_save(docs)
+end
+

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: jchris-couchrest
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - J. Chris Anderson
-- Greg Borenstein
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-09-10 00:00:00 -07:00
+date: 2008-09-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,29 +37,64 @@ executables:
 - couchdir
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- THANKS
 files: 
-- lib/couchrest.rb
-- lib/couch_rest.rb
-- lib/database.rb
-- lib/pager.rb
-- lib/file_manager.rb
-- lib/streamer.rb
-- lib/couch_rest/commands.rb
-- lib/couch_rest/commands/generate.rb
-- lib/couch_rest/commands/push.rb
+- LICENSE
+- README.rdoc
 - Rakefile
-- README.markdown
+- THANKS
 - bin/couchdir
 - bin/couchview
+- examples/word_count
+- examples/word_count/markov
+- examples/word_count/views
+- examples/word_count/views/books
+- examples/word_count/views/books/chunked-map.js
+- examples/word_count/views/books/united-map.js
+- examples/word_count/views/markov
+- examples/word_count/views/markov/chain-map.js
+- examples/word_count/views/markov/chain-reduce.js
+- examples/word_count/views/word_count
+- 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
+- lib/couchrest
+- lib/couchrest/commands
+- lib/couchrest/commands/generate.rb
+- lib/couchrest/commands/push.rb
+- lib/couchrest/core
+- lib/couchrest/core/database.rb
+- lib/couchrest/core/server.rb
+- lib/couchrest/helper
+- lib/couchrest/helper/file_manager.rb
+- lib/couchrest/helper/pager.rb
+- lib/couchrest/helper/streamer.rb
+- lib/couchrest/monkeypatches.rb
+- lib/couchrest.rb
 - spec/couchrest_spec.rb
 - spec/database_spec.rb
-- spec/pager_spec.rb
 - spec/file_manager_spec.rb
-- spec/streamer_spec.rb
+- spec/fixtures
+- spec/fixtures/attachments
+- spec/fixtures/attachments/test.html
+- spec/fixtures/views
+- spec/fixtures/views/lib.js
+- spec/fixtures/views/test_view
+- 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/pager_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: false
+- spec/streamer_spec.rb
+- utils/remap.rb
+- utils/subset.rb
+has_rdoc: "true"
 homepage: http://github.com/jchris/couchrest
 post_install_message: 
 rdoc_options: []

data/lib/couch_rest/commands.rb

@@ -1,5 +0,0 @@
-require File.join(File.dirname(__FILE__), "..", "couchrest")
-  
-%w(push generate).each do |filename|
-  require File.join(File.dirname(__FILE__), "commands", filename)
-end

data/lib/couch_rest.rb

@@ -1,96 +0,0 @@
-class CouchRest
-  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
-  def databases
-    CouchRest.get "#{@uri}/_all_dbs"
-  end
-  
-  def database name
-    CouchRest::Database.new(self, name)
-  end
-  
-  # creates the database if it doesn't exist
-  def database! name
-    create_db(name) rescue nil
-    database name
-  end
-  
-  # get the welcome message
-  def info
-    CouchRest.get "#{@uri}/"
-  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
-      JSON.parse(RestClient.put(uri, payload))
-    end
-  
-    def get uri
-      JSON.parse(RestClient.get(uri), :max_nesting => false)
-    end
-    
-    def post uri, doc = nil
-      payload = doc.to_json if doc
-      JSON.parse(RestClient.post(uri, payload))
-    end
-    
-    def delete uri
-      JSON.parse(RestClient.delete(uri))
-    end
-    
-    def paramify_url url, params = nil
-      if params
-        query = params.collect do |k,v|
-          v = v.to_json if %w{key startkey endkey}.include?(k.to_s)
-          "#{k}=#{CGI.escape(v.to_s)}"
-        end.join("&")
-        url = "#{url}?#{query}"
-      end
-      url
-    end
-  end  
-end