topfunky-couchrest 0.9.4

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/couchrest.rb

@@ -0,0 +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'
+
+$:.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
+
+    # 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
+
+    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/lib/couchrest/commands/generate.rb

@@ -0,0 +1,71 @@
+require 'fileutils'
+
+module CouchRest
+  module Commands
+    module Generate
+
+      def self.run(options)
+        directory    = options[:directory]
+        design_names = options[:trailing_args]
+
+        FileUtils.mkdir_p(directory)
+        filename = File.join(directory, "lib.js")
+        self.write(filename, <<-FUNC)
+        // Put global functions here.
+        // Include in your views with
+        //
+        //   //include-lib
+        FUNC
+
+        design_names.each do |design_name|
+          subdirectory = File.join(directory, design_name)
+          FileUtils.mkdir_p(subdirectory)
+          filename = File.join(subdirectory, "sample-map.js")
+          self.write(filename, <<-FUNC)
+          function(doc) {
+            // Keys is first letter of _id
+            emit(doc._id[0], doc);
+          }
+          FUNC
+
+          filename = File.join(subdirectory, "sample-reduce.js")
+          self.write(filename, <<-FUNC)
+          function(keys, values) {
+            // Count the number of keys starting with this letter
+            return values.length;
+          }
+          FUNC
+
+          filename = File.join(subdirectory, "lib.js")
+          self.write(filename, <<-FUNC)
+          // Put functions specific to '#{design_name}' here.
+          // Include in your views with
+          //
+          //   //include-lib
+          FUNC
+        end
+      end
+
+      def self.help
+        helpstring = <<-GEN
+
+        Usage: couchview generate directory design1 design2 design3 ...
+
+        Couchview will create directories and example views for the design documents you specify.
+
+        GEN
+        helpstring.gsub(/^        /, '')
+      end
+
+      def self.write(filename, contents)
+        puts "Writing #{filename}"
+        File.open(filename, "w") do |f|
+          # Remove leading spaces
+          contents.gsub!(/^        (  )?/, '')
+          f.write contents
+        end
+      end
+
+    end
+  end
+end

data/lib/couchrest/commands/push.rb

@@ -0,0 +1,99 @@
+module CouchRest
+
+  module Commands
+
+    module Push
+
+      def self.run(options)
+        directory = options[:directory]
+        database  = options[:trailing_args].first
+        
+        fm      = CouchRest::FileManager.new(database)
+        fm.loud = options[:loud]
+        puts "Pushing views from directory #{directory} to database #{fm.db}"
+        fm.push_views(directory)
+      end
+
+      def self.help
+        helpstring = <<-GEN
+
+        == Pushing views with Couchview ==
+
+        Usage: couchview push directory dbname
+
+        Couchview expects a specific filesystem layout for your CouchDB views (see
+        example below). It also supports advanced features like inlining of library
+        code (so you can keep DRY) as well as avoiding unnecessary document
+        modification.
+
+        Couchview also solves a problem with CouchDB's view API, which only provides
+        access to the final reduce side of any views which have both a map and a
+        reduce function defined. The intermediate map results are often useful for
+        development and production. CouchDB is smart enough to reuse map indexes for
+        functions duplicated across views within the same design document.
+
+        For views with a reduce function defined, Couchview creates both a reduce view
+        and a map-only view, so that you can browse and query the map side as well as
+        the reduction, with no performance penalty.
+
+        == Example ==
+
+        couchview push foo-project/bar-views baz-database
+
+        This will push the views defined in foo-project/bar-views into a database
+        called baz-database. Couchview expects the views to be defined in files with
+        names like:
+
+        foo-project/bar-views/my-design/viewname-map.js
+        foo-project/bar-views/my-design/viewname-reduce.js
+        foo-project/bar-views/my-design/noreduce-map.js
+
+        Pushed to => http://localhost:5984/baz-database/_design/my-design
+
+        And the design document:
+        {
+          "views" : {
+            "viewname-map" : {
+              "map" : "### contents of view-name-map.js ###"
+            },
+            "viewname-reduce" : {
+              "map" : "### contents of view-name-map.js ###",
+              "reduce" : "### contents of view-name-reduce.js ###"
+            },
+            "noreduce-map" : {
+              "map" : "### contents of noreduce-map.js ###"
+            }
+          }
+        }
+
+        Couchview will create a design document for each subdirectory of the views
+        directory specified on the command line.
+
+        == Library Inlining ==
+
+        Couchview can optionally inline library code into your views so you only have
+        to maintain it in one place. It looks for any files named lib.* in your
+        design-doc directory (for doc specific libs) and in the parent views directory
+        (for project global libs). These libraries are only inserted into views which
+        include the text
+
+        //include-lib
+
+        or
+
+        #include-lib
+
+        Couchview is a result of scratching my own itch. I'd be happy to make it more
+        general, so please contact me at jchris@grabb.it if you'd like to see anything
+        added or changed.
+
+        GEN
+        helpstring.gsub(/^        /, '')
+      end
+
+    end
+
+
+  end
+
+end

data/lib/couchrest/core/database.rb

@@ -0,0 +1,105 @@
+require 'cgi'
+require "base64"
+
+module CouchRest
+  class Database
+    attr_reader :server, :host, :name, :root
+     
+    def initialize server, name
+      @name = name
+      @server = server
+      @host = server.uri
+      @root = "#{host}/#{name}"
+    end
+    
+    def to_s
+      @root
+    end
+    
+    def info
+      CouchRest.get @root
+    end
+    
+    def documents params = nil
+      url = CouchRest.paramify_url "#{@root}/_all_docs", params
+      CouchRest.get url  
+    end
+  
+    def temp_view funcs, params = nil
+      url = CouchRest.paramify_url "#{@root}/_temp_view", params
+      JSON.parse(RestClient.post(url, funcs.to_json, {"Content-Type" => 'application/json'}))
+    end
+  
+    def view name, params = nil
+      url = CouchRest.paramify_url "#{@root}/_view/#{name}", params
+      CouchRest.get url
+    end
+
+    # experimental
+    def search params = nil
+      url = CouchRest.paramify_url "#{@root}/_search", params
+      CouchRest.get url
+    end
+    # experimental
+    def action action, params = nil
+      url = CouchRest.paramify_url "#{@root}/_action/#{action}", params
+      CouchRest.get url
+    end
+    
+    def get id
+      slug = CGI.escape(id) 
+      CouchRest.get "#{@root}/#{slug}"
+    end
+    
+    def fetch_attachment doc, name
+      doc = CGI.escape(doc)
+      name = CGI.escape(name)
+      RestClient.get "#{@root}/#{doc}/#{name}"
+    end
+    
+    # PUT or POST depending on presence of _id attribute
+    def save doc
+      if doc['_attachments']
+        doc['_attachments'] = encode_attachments(doc['_attachments'])
+      end
+      if doc['_id']
+        slug = CGI.escape(doc['_id'])
+      else
+        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
+    
+    def delete doc
+      slug = CGI.escape(doc['_id'])
+      CouchRest.delete "#{@root}/#{slug}?rev=#{doc['_rev']}"
+    end
+    
+    def delete!
+      CouchRest.delete @root
+    end
+
+    private
+
+    def encode_attachments attachments
+      attachments.each do |k,v|
+        next if v['stub']
+        v['data'] = base64(v['data'])
+      end
+      attachments
+    end
+
+    def base64 data
+      Base64.encode64(data).gsub(/\s/,'')
+    end
+  end
+end