couchrest 1.2.1 → 2.0.0.beta1

data/lib/couchrest/database.rb

@@ -3,7 +3,17 @@ require "base64"
 
 module CouchRest
   class Database
-    attr_reader :server, :host, :name, :root, :uri
+
+    # Server object we'll use to communicate with.
+    attr_reader :server
+    
+    # Name of the database of we're using.
+    attr_reader :name
+
+    # Name of the database we can use in requests.
+    attr_reader :path
+
+    # How many documents should be cached before peforming the bulk save operation
     attr_accessor :bulk_save_cache_limit
 
     # Create a CouchRest::Database adapter for the supplied CouchRest::Server
@@ -14,36 +24,41 @@ module CouchRest
     # name<String>:: database name
     #
     def initialize(server, name)
-      @name = name
-      @server = server
-      @host = server.uri
-      @uri  = "/#{name.gsub('/','%2F')}"
-      @root = host + uri
-      @streamer = Streamer.new
+      @name     = name
+      @server   = server
+      @path     = "/#{name.gsub('/','%2F')}"
       @bulk_save_cache = []
       @bulk_save_cache_limit = 500  # must be smaller than the uuid count
     end
 
-    # == Database information and manipulation methods
+    def connection
+      server.connection
+    end
+
+    # A URI object for the exact location of this database
+    def uri
+      server.uri + path 
+    end
+    alias root uri
 
-    # returns the database's uri
+    # String of #root
     def to_s
-      @root
+      uri.to_s
     end
 
     # GET the database info from CouchDB
     def info
-      CouchRest.get @root
+      connection.get path
     end
 
     # Compact the database, removing old document revisions and optimizing space use.
     def compact!
-      CouchRest.post "#{@root}/_compact"
+      connection.post "#{path}/_compact"
     end
 
     # Create the database
     def create!
-      bool = server.create_db(@name) rescue false
+      bool = server.create_db(path) rescue false
       bool && true
     end
 
@@ -51,7 +66,7 @@ module CouchRest
     def recreate!
       delete!
       create!
-    rescue RestClient::ResourceNotFound
+    rescue CouchRest::NotFound
     ensure
       create!
     end
@@ -69,7 +84,7 @@ module CouchRest
     # DELETE the database itself. This is not undoable and could be rather
     # catastrophic. Use with care!
     def delete!
-      CouchRest.delete @root
+      connection.delete path
     end
 
 
@@ -78,8 +93,8 @@ module CouchRest
     # GET a document from CouchDB, by id. Returns a Document or Design.
     def get(id, params = {})
       slug = escape_docid(id)
-      url = CouchRest.paramify_url("#{@root}/#{slug}", params)
-      result = CouchRest.get(url)
+      url = CouchRest.paramify_url("#{path}/#{slug}", params)
+      result = connection.get(url)
       return result unless result.is_a?(Hash)
       doc = if /^_design/ =~ result["_id"]
         Design.new(result)
@@ -115,6 +130,7 @@ module CouchRest
       if doc['_attachments']
         doc['_attachments'] = encode_attachments(doc['_attachments'])
       end
+
       if bulk
         @bulk_save_cache << doc
         bulk_save if @bulk_save_cache.length >= @bulk_save_cache_limit
@@ -125,21 +141,17 @@ module CouchRest
       result = if doc['_id']
         slug = escape_docid(doc['_id'])
         begin
-          uri = "#{@root}/#{slug}"
-          uri << "?batch=ok" if batch
-          CouchRest.put uri, doc
-        rescue RestClient::ResourceNotFound
+          doc_path = "#{path}/#{slug}"
+          doc_path << "?batch=ok" if batch
+          connection.put doc_path, doc
+        rescue CouchRest::NotFound
           puts "resource not found when saving even though an id was passed"
-          slug = doc['_id'] = @server.next_uuid
-          CouchRest.put "#{@root}/#{slug}", doc
+          slug = doc['_id'] = server.next_uuid
+          connection.put "#{path}/#{slug}", doc
         end
       else
-        begin
-          slug = doc['_id'] = @server.next_uuid
-          CouchRest.put "#{@root}/#{slug}", doc
-        rescue #old version of couchdb
-          CouchRest.post @root, doc
-        end
+        slug = doc['_id'] = @server.next_uuid
+        connection.put "#{path}/#{slug}", doc
       end
       if result['ok']
         doc['_id'] = result['id']
@@ -172,7 +184,7 @@ module CouchRest
         ids, noids = docs.partition{|d|d['_id']}
         uuid_count = [noids.length, @server.uuid_batch_count].max
         noids.each do |doc|
-          nextid = @server.next_uuid(uuid_count) rescue nil
+          nextid = server.next_uuid(uuid_count) rescue nil
           doc['_id'] = nextid if nextid
         end
       end
@@ -180,7 +192,7 @@ module CouchRest
       if all_or_nothing
         request_body[:all_or_nothing] = true
       end
-      CouchRest.post "#{@root}/_bulk_docs", request_body
+      connection.post "#{path}/_bulk_docs", request_body
     end
     alias :bulk_delete :bulk_save
 
@@ -197,7 +209,7 @@ module CouchRest
         return {'ok' => true} # Mimic the non-deferred version
       end
       slug = escape_docid(doc['_id'])        
-      CouchRest.delete "#{@root}/#{slug}?rev=#{doc['_rev']}"
+      connection.delete "#{path}/#{slug}?rev=#{doc['_rev']}"
     end
 
     # COPY an existing document to a new id. If the destination id currently exists, a rev must be provided.
@@ -211,7 +223,7 @@ module CouchRest
       else
         dest
       end
-      CouchRest.copy "#{@root}/#{slug}", destination
+      connection.copy "#{path}/#{slug}", destination
     end
 
     # Updates the given doc by yielding the current state of the doc
@@ -227,7 +239,7 @@ module CouchRest
         yield doc
         begin
           resp = self.save_doc doc
-        rescue RestClient::RequestFailed => e
+        rescue CouchRest::RequestFailed => e
           if e.http_code == 409 # Update collision
             update_limit -= 1
             last_fail = e
@@ -247,23 +259,21 @@ module CouchRest
     # Query a CouchDB view as defined by a <tt>_design</tt> document. Accepts
     # paramaters as described in http://wiki.apache.org/couchdb/HttpViewApi
     def view(name, params = {}, payload = {}, &block)
+      opts = {}
       params = params.dup
       payload['keys'] = params.delete(:keys) if params[:keys]
+
+      # Continuous feeds need to be parsed differently
+      opts[:continuous] = true if params['feed'] == 'continuous'
+
       # Try recognising the name, otherwise assume already prepared
       view_path = name_to_view_path(name)
-      url = CouchRest.paramify_url "#{@root}/#{view_path}", params
-      if block_given?
-        if !payload.empty?
-          @streamer.post url, payload, &block
-        else
-          @streamer.get url, &block
-        end
+      req_path = CouchRest.paramify_url("#{path}/#{view_path}", params)
+
+      if payload.empty?
+        connection.get req_path, opts, &block
       else
-        if !payload.empty?
-          CouchRest.post url, payload
-        else
-          CouchRest.get url
-        end
+        connection.post req_path, payload, opts, &block
       end
     end
 
@@ -310,37 +320,33 @@ module CouchRest
 
     # GET an attachment directly from CouchDB
     def fetch_attachment(doc, name)
-      uri = url_for_attachment(doc, name)
-      CouchRest.get uri, :raw => true
+      connection.get path_for_attachment(doc, name), :raw => true
     end
 
-    # PUT an attachment directly to CouchDB
+    # PUT an attachment directly to CouchDB, expects an IO object, or a string
+    # that will be converted to a StringIO in the 'file' parameter.
     def put_attachment(doc, name, file, options = {})
-      docid = escape_docid(doc['_id'])
-      uri = url_for_attachment(doc, name)
-      CouchRest.put(uri, file, options.merge(:raw => true))
+      file = StringIO.new(file) if file.is_a?(String)
+      connection.put path_for_attachment(doc, name), file, options
     end
 
     # DELETE an attachment directly from CouchDB
     def delete_attachment(doc, name, force=false)
-      uri = url_for_attachment(doc, name)
-      # this needs a rev
+      attach_path = path_for_attachment(doc, name)
       begin
-        CouchRest.delete(uri)
+        connection.delete(attach_path)
       rescue Exception => error
         if force
           # get over a 409
           doc = get(doc['_id'])
-          uri = url_for_attachment(doc, name)
-          CouchRest.delete(uri)
+          attach_path = path_for_attachment(doc, name)
+          connection.delete(attach_path)
         else
           error
         end
       end
     end
 
-
-
     private
 
     def replicate(other_db, continuous, options)
@@ -349,32 +355,22 @@ module CouchRest
       doc_ids = options.delete(:doc_ids)
       payload = options
       if options.has_key?(:target)
-        payload[:source] = other_db.root
+        payload[:source] = other_db.root.to_s
       else
-        payload[:target] = other_db.root
+        payload[:target] = other_db.root.to_s
       end
       payload[:continuous] = continuous
       payload[:doc_ids] = doc_ids if doc_ids
-      CouchRest.post "#{@host}/_replicate", payload
-    end
-
-    def uri_for_attachment(doc, name)
-      if doc.is_a?(String)
-        puts "CouchRest::Database#fetch_attachment will eventually require a doc as the first argument, not a doc.id"
-        docid = doc
-        rev = nil
-      else
-        docid = doc['_id']
-        rev = doc['_rev']
-      end
-      docid = escape_docid(docid)
-      name = CGI.escape(name)
-      rev = "?rev=#{doc['_rev']}" if rev
-      "/#{docid}/#{name}#{rev}"
+      
+      # Use a short lived request here
+      connection.post "_replicate", payload
     end
 
-    def url_for_attachment(doc, name)
-      @root + uri_for_attachment(doc, name)
+    def path_for_attachment(doc, name)
+      docid = escape_docid(doc['_id'])
+      name  = CGI.escape(name)
+      rev   = doc['_rev'] ? "?rev=#{doc['_rev']}" : ''
+      "#{path}/#{docid}/#{name}#{rev}"
     end
 
     def escape_docid id

data/lib/couchrest/design.rb

@@ -62,7 +62,7 @@ JAVASCRIPT
 
     # Provide information about the status of the design document.
     def info
-      CouchRest.get "#{database.root}/#{id}/_info"
+      database.connection.get "#{database.uri}/#{id}/_info"
     end
 
     def save

data/lib/couchrest/exceptions.rb

@@ -0,0 +1,108 @@
+#
+# CouchRest Exception Handling
+#
+# Restricted set of HTTP error response we'd expect from a CouchDB server. If we don't have a specific error handler,
+# a generic Exception will be returned with the #http_code attribute set.
+#
+# Implementation based on [rest-client exception handling](https://github.com/rest-client/rest-client/blob/master/lib/restclient/exceptions.rb).
+#
+# In general, exceptions in the `CouchRest` scope are only generated by the couchrest library,
+# exceptions generated by other libraries will not be re-mapped.
+#
+module CouchRest
+
+ STATUSES = {
+              200 => 'OK',
+              201 => 'Created',
+              202 => 'Accepted',
+
+              304 => 'Not Modified',
+
+              400 => 'Bad Request',
+              401 => 'Unauthorized',
+              403 => 'Forbidden',
+              404 => 'Not Found',
+              405 => 'Method Not Allowed',
+              406 => 'Not Acceptable',
+              409 => 'Conflict',
+              412 => 'Precondition Failed',
+              415 => 'Unsupported Media Type',
+              416 => 'Requested Range Not Satisfiable',
+              417 => 'Expectation Failed',
+
+              500 => 'Internal Server Error',
+  } 
+
+  # This is the base CouchRest exception class. Rescue it if you want to
+  # catch any exception that your request might raise.
+  # You can get the status code by e.http_code, or see anything about the
+  # response via e.response.
+  # For example, the entire result body (which is
+  # probably an HTML error page) is e.response.
+  class Exception < RuntimeError
+    attr_accessor :response
+    attr_writer :message
+
+    def initialize response = nil
+      @response = response
+      @message = nil
+    end
+
+    def http_code
+      # return integer for compatibility
+      @response.status if @response
+    end
+
+    def http_headers
+      @response.headers if @response
+    end
+
+    def http_body
+      @response.body if @response
+    end
+
+    def inspect
+      "#{message}: #{http_body}"
+    end
+
+    def to_s
+      inspect
+    end
+
+    def message
+      @message || self.class.default_message
+    end
+
+    def self.default_message
+      self.name
+    end
+  end
+
+  # The request failed with an error code not managed by the code
+  class RequestFailed < Exception
+    def message
+      "HTTP status code #{http_code}"
+    end
+
+    def to_s
+      message
+    end
+  end
+
+  module Exceptions
+    EXCEPTIONS_MAP = {}
+  end
+
+  STATUSES.each_pair do |code, message|
+    klass = Class.new(RequestFailed) do
+      send(:define_method, :message) {"#{http_code ? "#{http_code} " : ''}#{message}"}
+    end
+    klass_constant = const_set message.delete(' \-\''), klass
+    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+  end
+
+  # Error handler for broken connections, mainly used by streamer
+  class ServerBrokeConnection < ::Exception
+  end
+
+end

data/lib/couchrest/helper/pager.rb

@@ -1,6 +1,8 @@
 module CouchRest
   class Pager
+
     attr_accessor :db
+
     def initialize db
       @db = db
     end
@@ -100,4 +102,4 @@ module CouchRest
     end
 
   end
-end
+end

data/lib/couchrest/helper/stream_row_parser.rb

@@ -0,0 +1,93 @@
+module CouchRest
+
+  # CouchRest Stream Row Parser
+  #
+  # Will parse a stream containing a standard CouchDB response including rows.
+  # Allows each row to be parsed individually, and provided in a block for 
+  # efficient memory usage.
+  #
+  # The StreamRowParser#parse method expects to be called multiple times with segments
+  # of data, typcially provided by the Net::HTTPResponse#read_body method.
+  # 
+  # Data will be cached until usable objects can be extracted in rows and provied in the block.
+  #
+  class StreamRowParser
+
+    # String containing the fields provided before and after the rows.
+    attr_accessor :header
+
+    # The row level at which we expect to receive "rows" of data.
+    # Typically this will be 0 for contious feeds, and 1 for most other users.
+    attr_reader :row_level
+
+    # Instantiate a new StreamRowParser with the mode set according to the type of data.
+    # The supported modes are:
+    #
+    #  * `:array` - objects are contianed in a data array, the default.
+    #  * `:feed` - each row of the stream is an object, like in continuous changes feeds.
+    #
+    def initialize(mode = :array)
+      @header  = ""
+      @data    = ""
+      @string  = false
+      @escape  = false
+
+      @row_level = mode == :array ? 1 : 0
+      @in_rows   = false
+      @obj_level = 0
+      @obj_close = false
+    end
+
+    def parse(segment, &block)
+      @in_rows = true if @row_level == 0
+      segment.each_char do |c|
+        if @string
+          # Inside a string, handling escaping and closure
+          if @escape
+            @escape = false
+          else
+            if c == '"'
+              @string = false
+            elsif c == '\\'
+              @escape = true
+            end
+          end
+        else
+          # Inside an object
+          @obj_close = false
+          if @obj_level == @row_level && c == "[" # start of rows
+            @in_rows = true
+          elsif @obj_level == @row_level && c == "]" # end of rows
+            @in_rows = false
+          elsif c == "{" # object
+            @obj_level += 1
+          elsif c == "}" # object end
+            @obj_level -= 1
+            @obj_close = true
+          elsif c == '"'
+            @string = true
+          end
+        end
+
+        # Append data
+        if @row_level > 0
+          if @obj_level == 0 || (@obj_level == @row_level && !@obj_close)
+            @header << c unless @in_rows && (c == ',' || c == ' ' || c == "\n") # skip row whitespace
+          else
+            @data << c
+          end
+        else
+          @data << c
+        end
+
+        # Determine if we need to trigger an event
+        if @obj_close && @obj_level == @row_level
+          block.call(@data)
+          @data = ""
+        end
+      end
+    end
+
+  end
+
+end