couch-client 0.0.2 → 0.1.0

data/CHANGELOG

@@ -1,3 +1,5 @@
-v0.0.2. fixing gemspec
+v0.1.0. Adding rake tasks to sync and manage database functions and design documents.  Also added support for list and show functions; as well as fulltext administration.
 
-v0.0.1. first release
+v0.0.2. Fixing gemspec
+
+v0.0.1. First release

data/README.markdown

@@ -1,7 +1,7 @@
 Introduction
 ============
 
-CouchClient is Ruby library that can be used to interact with CouchDB.  The goal of CouchClient is to make documents feel as much as possible as what they already represent, a Hash of primitives, Arrays and other Hashes.  As such, the interface for documents closely represents that of Hash and Array, but also includes additional methods and state in order to manage documents and interface with the CouchDB Server.
+CouchClient is a Ruby interface for CouchDB that provides easy configuration, state management and utility methods.
 
 Installation
 ------------
@@ -50,7 +50,7 @@ Fetching a Document
     person = Couch["a3b556796203eab59c31fa21b00043e3"]
     
     # You can also pass options if desired
-    person = Couch["a3b556796203eab59c31fa21b00043e3", :include_docs => true]
+    person = Couch["a3b556796203eab59c31fa21b00043e3", :attachments => true]
 
 Getting a Document's id, rev and attachments
 --------------------------------------------
@@ -61,7 +61,7 @@ Getting a Document's id, rev and attachments
     person.rev # => "1-6665e6330ba75e757ce1f6d793305d67"
 
     # A document's attachments
-    # NOTE: This will be an CouchClient::AttachmentList, and attachments will be CouchClient::Attachment objects
+    # NOTE: This will be a CouchClient::AttachmentList, and attachments will be CouchClient::Attachment objects
     person.attachments # => {"plain.txt"=>{"content_type"=>"text/plain", "revpos"=>2, "length"=>406, "stub"=>true}}
     
 
@@ -122,10 +122,10 @@ Working with Collections
     # Getting all documents with document fields
     Couch.all_docs(:include_docs => true)
 
-    # Specifying a `key`, `start_key` or `end_key`
+    # Specifying a `key`, `startkey` or `endkey`
     couch.all_docs(:key => "7f22af967b04d1b88212d3d26b018e89")
-    couch.all_docs(:start_key => 200)
-    couch.all_docs(:end_key => [2010, 01, 01])
+    couch.all_docs(:startkey => 200)
+    couch.all_docs(:endkey => [2010, 01, 01])
 
     # Getting additional collection information
     Couch.all_docs.info # => {"total_rows" => 2, "offset" => 0}
@@ -140,28 +140,102 @@ Using Design Documents
     # MapReduce Views
     Couch.design(:people).view(:sum) # => [{"key" => "male", "value" => 1}, {"key" => "female", "value" => 1}]
 
-Using FullText Searching (Must Have CouchDB-Lucene Installed)
--------------------------------------------------------------
+Using Show and List Functions
+-----------------------------
+
+    # Show Functions
+    Couch.design(:people).show(:html) # => "<h1>alice</h1>"
+    Couch.design(:people).show(:json) # => {"name" => "alice"}
+    
+    # List Functions
+    Couch.design(:people).list(:json, :people, :all) # => ["alice", "bob", "charlie"]
+
+Using FullText Search (Must Have CouchDB-Lucene Installed)
+----------------------------------------------------------
 
     # Getting search results
-    Couch.design(:people).fulltext(:by_name, :q => "alice") # => [{"id"=>"a6c92090bbee241e892be1ac4464b9d9", "score"=>4.505526065826416, "fields"=>{"default"=>"alice"}}]
+    Couch.design(:people).fulltext(:by_name, :q => "ali*") # => [{"id"=>"a6c92090bbee241e892be1ac4464b9d9", "score"=>4.505526065826416, "fields"=>{"default"=>"alice"}}]
 
     # Getting additional search results information
-    Couch.design(:people).fulltext(:by_name, :q => "alice").info # => {"q"=>"default:alice", "etag"=>"11e1541e20d9b860", "skip"=>0, "limit"=>25, 
+    Couch.design(:people).fulltext(:by_name, :q => "ali*").info  # => {"q"=>"default:alice", "etag"=>"11e1541e20d9b860", "skip"=>0, "limit"=>25, 
                                                                  #     "total_rows"=>7, "search_duration"=>0, "fetch_duration"=>1}
 
     # Getting search index information
     Couch.design(:people).fulltext(:by_name) # => {"current"=>true, "disk_size"=>3759, "doc_count"=>25, "doc_del_count"=>3, "fields"=>["default"], 
                                              #     "last_modified"=>"1288403429000", "optimized"=>false, "ref_count"=>2}
+    
+    # Optimizing an index
+    Couch.design(:people).fulltext(:by_name, :optimize) # => true
+    
+    # Expunging an index
+    Couch.design(:people).fulltext(:by_name, :expunge) # => true
 
-Database Administration
------------------------
+Convenience Rake Tasks
+----------------------
+
+CouchClient rake tasks can be enabled by adding the following to your `Rakefile`.
+
+    CouchClient::RakeTask.new do |c|
+      c.connection  = Couch
+      c.design_path = "./designs"
+    end
+
+Two parameters are available, `connection` should be the actual variable used for your CouchDB interface and `design_path` should be the application's location where design documents will be stored.
+
+Within the design path, you should format each design document with folders and files corresponding to the fields in your design document.
+
+    designs
+    ├── people
+    │   ├── fulltext
+    │   │   └── by_name
+    │   │       └── index.js
+    │   ├── lists
+    │   │   ├── html.js
+    │   │   └── json.js
+    │   ├── shows
+    │   │   ├── html.js
+    │   │   ├── json.js
+    │   │   └── xml.js
+    │   ├── validate_on_update.js
+    │   └── views
+    │       ├── all
+    │       │   └── map.js
+    │       └── sum
+    │           ├── map.js
+    │           └── reduce.js
+    └── robots
+        ├── fulltext
+        │   └── by_name
+        │       └── index.js
+        ├── validate_on_update.js
+        └── views
+            ├── all
+            │   └── map.js
+            └── sum
+                ├── map.js
+                └── reduce.js
+    
+Once you have your design documents created, you can rum `rake couch:sync`, and CouchClient will create new documents, update existing documents (only if there are changes) and delete documents that no longer exist.
+
+CouchClient also offers tasks that help in maintaining CouchDB.
+    
+    # Create a database
+    rake couch:create
+    
+    # Delete a database
+    rake couch:delete
+    
+    # Compact a database
+    rake couch:compact
+
+Performing Database Administration
+----------------------------------
 
     # Create a database
     Couch.database.create
 
     # See if a database exists
-    Couch.database.exists
+    Couch.database.exists?
 
     # Get database stats
     Couch.database.stats

data/Rakefile

@@ -2,7 +2,10 @@ require 'rake'
 require 'rspec/core/rake_task'
 require 'echoe'
 
-desc  "Run all specs"
+# Prevent Echoe from running spec tasks, especially as
+# Spec should be removed in later versions of Rspec 2.
+Object.send(:remove_const, :Spec)
+
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = %w[--colour --format progress]
 end
@@ -11,7 +14,8 @@ Echoe.new("couch-client") do |p|
   p.author = "Robert Sosinski"
   p.email = "email@robertsosinski.com"
   p.url = "http://github.com/robertsosinski/couch-client"
-  p.description = "CouchClient is Ruby library that can be used to interact with CouchDB"
-  p.summary = "The goal of CouchClient is to make documents feel as much as possible as what they already represent, a Hash of primitives, Arrays and other Hashes."
+  p.description = "A Ruby interface for CouchDB"
+  p.summary = "A Ruby interface for CouchDB that provides easy configuration, state management and utility methods."
   p.runtime_dependencies = ["json >=1.4.6", "curb >=0.7.8"]
+  p.development_dependencies = ["echoe >=4.3.1", "rspec >=2.0.0"]
 end

data/TODO

@@ -1,11 +1,5 @@
-Need
-* design save rake task
-
-Next
+* replication
 * batch insert
 * batch update
 * batch delete
-* batch upload
-* show design
-* list design
-* replication
+* batch upload

data/couch-client.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couch-client}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert Sosinski"]
-  s.date = %q{2010-10-30}
-  s.description = %q{CouchClient is Ruby library that can be used to interact with CouchDB}
+  s.date = %q{2010-11-05}
+  s.description = %q{A Ruby interface for CouchDB}
   s.email = %q{email@robertsosinski.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.markdown", "TODO", "lib/couch-client.rb", "lib/couch-client/attachment.rb", "lib/couch-client/attachment_list.rb", "lib/couch-client/collection.rb", "lib/couch-client/connection.rb", "lib/couch-client/connection_handler.rb", "lib/couch-client/consistent_hash.rb", "lib/couch-client/database.rb", "lib/couch-client/design.rb", "lib/couch-client/document.rb", "lib/couch-client/hookup.rb", "lib/couch-client/row.rb"]
   s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.markdown", "Rakefile", "TODO", "lib/couch-client.rb", "lib/couch-client/attachment.rb", "lib/couch-client/attachment_list.rb", "lib/couch-client/collection.rb", "lib/couch-client/connection.rb", "lib/couch-client/connection_handler.rb", "lib/couch-client/consistent_hash.rb", "lib/couch-client/database.rb", "lib/couch-client/design.rb", "lib/couch-client/document.rb", "lib/couch-client/hookup.rb", "lib/couch-client/row.rb", "spec/attachment_list_spec.rb", "spec/attachment_spec.rb", "spec/collection_spec.rb", "spec/conection_handler_spec.rb", "spec/connection_spec.rb", "spec/consistent_hash_spec.rb", "spec/couch-client_spec.rb", "spec/database_spec.rb", "spec/design_spec.rb", "spec/document_spec.rb", "spec/files/image.png", "spec/files/plain.txt", "spec/hookup_spec.rb", "spec/row_spec.rb", "spec/spec_helper.rb", "couch-client.gemspec"]
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{couch-client}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{The goal of CouchClient is to make documents feel as much as possible as what they already represent, a Hash of primitives, Arrays and other Hashes.}
+  s.summary = %q{A Ruby interface for CouchDB that provides easy configuration, state management and utility methods.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -25,12 +25,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
       s.add_runtime_dependency(%q<curb>, [">= 0.7.8"])
+      s.add_development_dependency(%q<echoe>, [">= 4.3.1"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
     else
       s.add_dependency(%q<json>, [">= 1.4.6"])
       s.add_dependency(%q<curb>, [">= 0.7.8"])
+      s.add_dependency(%q<echoe>, [">= 4.3.1"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
     end
   else
     s.add_dependency(%q<json>, [">= 1.4.6"])
     s.add_dependency(%q<curb>, [">= 0.7.8"])
+    s.add_dependency(%q<echoe>, [">= 4.3.1"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
   end
 end

data/lib/couch-client.rb

@@ -1,7 +1,5 @@
 $:.unshift(File.dirname(File.expand_path(__FILE__)))
 
-# require '../core_ext/hash'
-
 require 'couch-client/consistent_hash'
 require 'couch-client/connection'
 require 'couch-client/connection_handler'
@@ -13,11 +11,11 @@ require 'couch-client/attachment'
 require 'couch-client/design'
 require 'couch-client/collection'
 require 'couch-client/row'
-require 'tasks/couch'
+require "couch-client/rake_task" if defined?(Rake)
 
 # The CouchClient module is the overall container of all CouchClient logic.
 module CouchClient
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
   
   class Error < Exception; end
   

data/lib/couch-client/attachment.rb

@@ -1,10 +1,10 @@
 module CouchClient
-  # The Attachment is an extended Hash that provides additional methods to
-  # interact with attached files saved within a document.
+  # Attachment is an extended Hash that provides additional methods
+  # to interact with attached files saved within a document.
   class Attachment < ConsistentHash
     attr_reader :name
 
-    # Attachment is constructed the id of the document it is attached to,
+    # Attachment is constructed with the id of the document it is attached to,
     # the filename, file stub and connection object.
     def initialize(id, name, stub, connection)
       self.merge!(stub)
@@ -26,7 +26,7 @@ module CouchClient
 
     # Returns a string that contains attachment data
     def data
-      @connection.hookup.get([@id, @name], nil, self["content_type"]).last
+      @data ||= @connection.hookup.get([@id, @name], nil, self["content_type"]).last
     end
   end
 end

data/lib/couch-client/attachment_list.rb

@@ -1,5 +1,5 @@
 module CouchClient
-  # The AttachmentList prevents ConsistentHash from absorbing
+  # AttachmentList prevents ConsistentHash from absorbing
   # instances of Attachment and making them a ConsistentHash.
   class AttachmentList < ConsistentHash
     # AttachmentList is constructed with a hash of attachments.

data/lib/couch-client/collection.rb

@@ -1,6 +1,6 @@
 module CouchClient
-  # The Document is an extended Array that provides additional methods
-  # and state to get status codes, info and connect documents to the server.
+  # Collection is an extended Array that provides additional methods and
+  # state to get status codes, info and connect documents to the server.
   class Collection < Array
     attr_reader :code, :info
     

data/lib/couch-client/connection.rb

@@ -3,7 +3,7 @@ module CouchClient
   class DocumentNotValid < Exception; end
   class DocumentNotFound < Exception; end
 
-  # The Connection is the high-level interface used to interact with the CouchDB Server.
+  # Connection is the high-level interface used to interact with the CouchDB Server.
   class Connection
     attr_reader :hookup, :database
 
@@ -75,16 +75,16 @@ module CouchClient
     
     # Acts as the interface to CouchDB's `_all_docs` map view.
     def all_docs(options = {})
-      # key, startkey and endkey must be JSON encoded
-      ["key", "startkey", "endkey"].each do |key|
-        options[key] &&= options[key].to_json
-      end
-      
       # Create a new Collection with the response code, body and connection.
       Collection.new(*@hookup.get(["_all_docs"], options), self)
     end
     
-    # The interface used to construct new CouchDB documents.  Once constructed
+    # Returns a list of all _design documents.
+    def all_design_docs(options = {})
+      all_docs({"startkey" => "_design/", "endkey" => "_design0"}.merge(options))
+    end
+    
+    # The interface used to construct new CouchDB documents.  Once constructed,
     # these documents can be saved, updated, validated and deleted.
     def build(body = {})
       Document.new(nil, body, self)

data/lib/couch-client/connection_handler.rb

@@ -5,7 +5,7 @@ module CouchClient
   class InvalidQueryObject < Exception; end
   class InvalidDatabaseName < Exception; end
   
-  # The ConnectionHandler creates properly formed URIs and paths, while also
+  # ConnectionHandler creates properly formed URIs and paths, while also
   # specifying sensible defaults for CouchDB.  Once initialized, parameters
   # can be wrote and read using getter and setter syntax.
   class ConnectionHandler
@@ -50,6 +50,11 @@ module CouchClient
         raise InvalidPathObject.new("path must be of type 'Array' not of type '#{path_obj.class}'")
       end
       
+      # key, startkey and endkey must be JSON encoded to be valid.
+      ["key", :key, "startkey", :startkey, "endkey", :endkey].each do |key|
+        query_obj[key] &&= query_obj[key].to_json
+      end
+      
       query_str = if query_obj.is_a?(Hash)
         # If a Hash, stringify and escape each object, join each key/value with a "=" and each pair with a "&"
         query_obj.to_a.map{|q| q.map{|r| CGI.escape(r.to_s)}.join("=")}.join("&")

data/lib/couch-client/database.rb

@@ -1,5 +1,5 @@
 module CouchClient
-  # The Database is just a organized collection of functions that interact with the
+  # Database is just an organized collection of functions that interact with the
   # CouchDB database such as stats, creation, compaction, replication and deletion.
   class Database
     # Database is constructed with a connection that is used to make HTTP requests to the server.

data/lib/couch-client/design.rb

@@ -3,8 +3,9 @@ module CouchClient
   class ShowNotFound < Exception; end
   class ListNotFound < Exception; end
   class FullTextNotFound < Exception; end
+  class FullTextRequestBad < Exception; end
   
-  # The Design is the interface used to interact with design documents
+  # Design is the interface used to interact with design documents
   # in order make view, show, list and fulltext requests.
   class Design
     attr_accessor :id
@@ -18,11 +19,6 @@ module CouchClient
 
     # Makes requests to the server that return mappped/reduced view collections.
     def view(name, options = {})
-      # key, startkey and endkey must be JSON encoded
-      ["key", "startkey", "endkey"].each do |key|
-        options[key] &&= options[key].to_json
-      end
-
       code, body = @connection.hookup.get(["_design", id, "_view", name], options)
 
       case code
@@ -37,34 +33,73 @@ module CouchClient
         raise Error.new("code: #{code}, error: #{body["error"]}, reason: #{body["reason"]}")
       end
     end
+    
+    # Makes requests to the server that return show objects.
+    def show(name, document_id, options = {})
+      code, body = @connection.hookup.get(["_design", id, "_show", name, document_id], options, nil)
 
-    # TODO: add show method
-    def show(name, options = {})
-      raise "pending"
+      case code
+      when 200
+        body.is_a?(Hash) ? ConsistentHash.new(body) : body
+      when 404
+        # Raise an error if nothing was found
+        raise ViewNotFound.new("could not find show field '#{name}' for design '#{id}'")
+      else
+        # Also raise an error if something else happens
+        raise Error.new("code: #{code}, error: #{body["error"]}, reason: #{body["reason"]}")
+      end
     end
+    
+    # Makes requests to the server that list objects.
+    def list(name, document_id, view_name, options = {})
+      code, body = @connection.hookup.get(["_design", id, "_list", name, document_id, view_name], options)
 
-    # TODO: add list method
-    def list(name, options = {})
-      raise "pending"
+      case code
+      when 200
+        body.is_a?(Hash) ? ConsistentHash.new(body) : body
+      when 404
+        # Raise an error if nothing was found
+        raise ViewNotFound.new("could not find list field '#{name}' for design '#{id}'")
+      else
+        # Also raise an error if something else happens
+        raise Error.new("code: #{code}, error: #{body["error"]}, reason: #{body["reason"]}")
+      end
     end
     
     # Makes requests to the server that return lucene search results.
     def fulltext(name, options = {})
-      code, body = @connection.hookup.get(["_fti", "_design", id, name], options)
+      path = ["_fti", "_design", id, name]
+      verb = :get
+      
+      # Options may be a Hash or a String.  Hashes are used for fulltext queries,
+      # while String are used for administration operations (such as optimizing).
+      if [String, Symbol].include?(options.class)
+        path << "_#{options}"
+        verb =  :post
+        options = {}
+      end
+      
+      code, body = @connection.hookup.send(verb, path, options)
 
       case code
       when 200
         if body["rows"]
-          # Return a serch result if a query was provided
+          # Return a serch result if a query was provided.
           Collection.new(code, body, self)
         else
-          # Return a status hash if a query was not provided
+          # Return a status hash if a query was not provided.
           body
         end
+      when 202
+        true # Return true when administration operations are successfully performed.
       else
-        if body["reason"] == "no_such_view"
-          # Raise an error if a fulltext function was not found
+        case body["reason"]
+        when "no_such_view"
+          # Raise an error if a fulltext function was not found.
           raise FullTextNotFound.new("could not find fulltext field '#{name}' for design '#{id}'")
+        when "bad_request"
+          # Raise an error if a request was not formated properly (i.e. is bad).
+          raise FullTextRequestBad.new("bad request made for fulltext field '#{name}' for design '#{id}'")
         else
           # Also raise an error if something else happens 
           raise Error.new("code: #{code}, error: #{body["error"]}, reason: #{body["reason"]}")

data/lib/couch-client/document.rb

@@ -3,7 +3,7 @@ module CouchClient
   class AttachmentError < Exception; end
   class DocumentNotAvailable < Exception; end
   
-  # The Document is an extended Hash that provides additional methods to
+  # Document is an extended Hash that provides additional methods to
   # save, update (with attachments), and delete documents on the CouchDB.
   class Document < ConsistentHash
     attr_reader :code, :error
@@ -42,14 +42,14 @@ module CouchClient
     # Returns a copy of the same document that is currently saved on the server.
     def saved_doc(query = {})
       if new?
-        raise DocumentNotAvailable.new('this document is new and therefore has not been saved yet')
+        raise DocumentNotAvailable.new("this document is new and therefore has not been saved yet")
       else
         @connection[self.id, query]
       end
     end
 
     # Tries to save the document to the server.  If it us unable to,
-    # it will save the error and make it available with via #error.
+    # it will save the error and make it available via #error.
     def save
       # Ensure that "_id" is a String if it is defined.
       if self.key?("_id") && !self["_id"].is_a?(String)
@@ -71,14 +71,14 @@ module CouchClient
         @deleted  = false
         true
       else
-        # Save error message and return `false`.
+        # Else save error message and return `false`.
         @error = {body["error"] => body["reason"]}
         false
       end
     end
 
     # Tries to attach a file to the document.  If it us unable to,
-    # it will save the error and make it available with via #error.
+    # it will save the error and make it available via #error.
     def attach(name, content, content_type)
       # The document must already be saved to the server before a file can be attached.
       if self.rev
@@ -90,7 +90,7 @@ module CouchClient
           self.rev = body["rev"]
           true
         else
-          # Save error message and return `false`.
+          # Else save error message and return `false`.
           @error = {body["error"] => body["reason"]}
           false
         end
@@ -101,7 +101,7 @@ module CouchClient
     end
     
     # Tries to delete a file from the server.  If it us unable to,
-    # it will save the error and make it available with via #error.
+    # it will save the error and make it available via #error.
     def delete!
       @code, body = @connection.hookup.delete([id], {"rev" => rev})
       
@@ -112,7 +112,7 @@ module CouchClient
         @deleted = true
         true
       else
-        # Save error message and return `false`.
+        # Else save error message and return `false`.
         @error = {body["error"] => body["reason"]}
         false
       end

data/lib/couch-client/hookup.rb

@@ -6,7 +6,7 @@ module CouchClient
   class InvalidJSONData < Exception; end
   class SymbolUsedInField < Exception; end
 
-  # The Hookup is the basic HTTP interface that connects CouchClient to CouchDB.
+  # Hookup is the basic HTTP interface that connects CouchClient to CouchDB.
   # Hookup can use any HTTP library if the conventions listed below are followed.
   #
   # If modified, Hookup must have head, get, post, put and delete instance methods.
@@ -66,8 +66,7 @@ module CouchClient
       # Setup curb options block
       options = lambda do |easy|
         easy.headers["User-Agent"] = "couch-client v#{VERSION}"
-        easy.headers["Content-Type"] = content_type if content_type
-        easy.headers["Accepts"] = content_type if content_type
+        easy.headers["Content-Type"] = content_type if content_type && [:post, :put].include?(verb)
         easy.username = handler.username
         easy.userpwd  = handler.password
       end
@@ -91,7 +90,7 @@ module CouchClient
       # body is either a nil, a hash or a string containing attachment data
       body = if easy.body_str == "" || easy.body_str.nil?
         nil
-      elsif content_type == "application/json" || [:post, :put, :delete].include?(verb)
+      elsif [content_type, easy.content_type].include?("application/json") || [:post, :put, :delete].include?(verb)
         begin
           JSON.parse(easy.body_str)
         rescue

data/lib/couch-client/row.rb

@@ -1,5 +1,5 @@
 module CouchClient
-  # The Row is an extended Hash that provides additional state to 
+  # Row is an extended Hash that provides additional state to
   # get status codes and connect documents to the server.
   class Row < ConsistentHash
     def initialize(code, row, connection)

data/spec/conection_handler_spec.rb

@@ -60,6 +60,10 @@ describe CouchClient::ConnectionHandler do
     @ch.uri(["path"]).should eql("https://couchone.com:8080/abc123%2F_%24%28%29%2B-/path")
   end
   
+  it 'should properly json encode key, startkey and endkey query paramenters' do
+    @ch.uri(["path"], {:key => "7f22af967b04d1b88212d3d26b018e89", "startkey" => 2010, :endkey => [2010, 01, 01]}).should eql("https://couchone.com:8080/abc123%2F_%24%28%29%2B-/path?key=%227f22af967b04d1b88212d3d26b018e89%22&startkey=2010&endkey=%5B2010%2C1%2C1%5D")
+  end
+  
   it 'should raise an error if an invalid name is given' do
     lambda{@ch.database = "ABC!@#"}.should raise_error(CouchClient::InvalidDatabaseName)
   end

data/spec/connection_spec.rb

@@ -71,6 +71,17 @@ describe CouchClient::Connection do
     end
   end
   
+  describe '#all_design_docs' do
+    it 'should return a list of all documents stored' do
+      all_docs = @couch.all_design_docs("include_docs" => true)
+      all_docs.should be_a(CouchClient::Collection)
+      docs = all_docs.map{|doc| doc["doc"].id}
+      docs.should_not include(@alice.id)
+      docs.should_not include(@bob.id)
+      docs.should include(@design.id)
+    end
+  end
+  
   describe '#build' do
     before(:all) do
       @charlie = @couch.build({"name" => "charlie", "city" => "san fran"})

data/spec/design_spec.rb

@@ -19,6 +19,13 @@ describe CouchClient::Connection do
         "all" => {"map" => "function(doc){emit(doc._id, doc)}"},
         "sum" => {"map" => "function(doc){emit(null, 1)}", "reduce" => "function(id, values, rereduce){return sum(values)}"},
       },
+      "shows" => {
+        "html" => "function(doc, req){return{body: '<h1>' + doc.name + '</h1>', headers: {'Content-Type': 'text/html'}}}",
+        "json" => "function(doc, req){return{body: JSON.stringify({'name': doc.name}), headers: {'Content-Type': 'application/json'}}}"
+      },
+      "lists" => {
+        "json" => "function(head, req){var row;var rows = [];while(row = getRow()){rows.push(row.value.name);}send(JSON.stringify(rows));}"
+      },
       "fulltext" => {
         "by_name" => {
           "index" => "function(doc){var ret = new Document();ret.add(doc.name);return ret;}"
@@ -78,11 +85,19 @@ describe CouchClient::Connection do
   end
   
   describe '#show' do
-    pending 'will be built in another release'
+    it 'should return valid html for a html show function' do
+      @people.show("html", "123").should eql("<h1>alice</h1>")
+    end
+    
+    it 'should return valid json for a json show function' do
+      @people.show("json", "123").should eql({"name"=>"alice"})
+    end
   end
   
   describe '#list' do
-    pending 'will be built in another release'
+    it 'should return valid json for a json list function' do
+      @people.list("json", "people", "all").should eql(["alice", "bob", "charlie"])
+    end
   end
   
   describe '#fulltext' do
@@ -96,5 +111,17 @@ describe CouchClient::Connection do
       fulltext.info.should be_a(Hash)
       fulltext.first["id"].should eql(@alice.id)
     end
+    
+    it 'should return true when administration operations are successfully performed' do
+      @people.fulltext("by_name", "optimize").should be_true
+    end
+    
+    it 'should raise a "not found" error if the fulltext field was not found' do
+      lambda{@people.fulltext("not_found")}.should raise_error(CouchClient::FullTextNotFound)
+    end
+    
+    it 'should raise a "bad request" error if the requested administration operation was not valid' do
+      lambda{@people.fulltext("by_name", "bad_request")}.should raise_error(CouchClient::FullTextRequestBad)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
+require 'tempfile'
 require 'rspec'
+require 'rake'
 
 Rspec.configure do |c|
   c.mock_with :rspec
@@ -8,4 +10,22 @@ end
 COUCHDB_TEST_SETTINGS = {:database => "couch-client_test"}
 COUCHDB_TEST_DATABASE = COUCHDB_TEST_SETTINGS[:database]
 
+def suppress
+  temp_f = Tempfile.new("suppress")
+  save_stdout = $stdout.dup
+  save_stderr = $stderr.dup
+  begin
+    $stdout.reopen(temp_f)
+    $stderr.reopen(temp_f)
+    yield
+  rescue
+    temp_f.flush
+    save_stdout.puts File.open(temp_f.path).read
+    raise
+  ensure
+    $stdout.reopen(save_stdout)
+    $stderr.reopen(save_stderr)
+  end
+end
+
 require File.join(File.dirname(File.expand_path(__FILE__)), "..", "lib", "couch-client")

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Robert Sosinski
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 -04:00
+date: 2010-11-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,37 @@ dependencies:
         version: 0.7.8
   type: :runtime
   version_requirements: *id002
-description: CouchClient is Ruby library that can be used to interact with CouchDB
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 4
+        - 3
+        - 1
+        version: 4.3.1
+  type: :development
+  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: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id004
+description: A Ruby interface for CouchDB
 email: email@robertsosinski.com
 executables: []
 
@@ -142,6 +172,6 @@ rubyforge_project: couch-client
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: The goal of CouchClient is to make documents feel as much as possible as what they already represent, a Hash of primitives, Arrays and other Hashes.
+summary: A Ruby interface for CouchDB that provides easy configuration, state management and utility methods.
 test_files: []