norr-couchrest 0.30.4 → 0.33.01

data/README.md

@@ -12,14 +12,17 @@ Note: CouchRest only support CouchDB 0.9.0 or newer.
 
 ## Easy Install
 
-Easy Install is moving to RubyForge, heads up for the gem.
+    $ sudo gem install couchrest
+   
+Alternatively, you can install from Github:
+    
+    $ gem sources -a http://gems.github.com (you only have to do this once)
+    $ sudo gem install couchrest-couchrest
 
 ### 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.
+CouchRest rests on top of a HTTP abstraction layer using by default Heroku’s excellent REST Client Ruby HTTP wrapper.
+Other adapters can be added to support more http libraries.
 
 ### Running the Specs
 
@@ -27,7 +30,7 @@ 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 (CouchRest Core)
 
 Quick Start:
 
@@ -59,12 +62,50 @@ Creating and Querying Views:
       })
     puts @db.view('first/test')['rows'].inspect 
 
-## CouchRest::Model
 
-CouchRest::Model has been deprecated and replaced by CouchRest::ExtendedDocument
+## CouchRest::ExtendedDocument  
+
+CouchRest::ExtendedDocument is a DSL/ORM for CouchDB. Basically, ExtendedDocument seats on top of CouchRest Core to add the concept of Model.
+ExtendedDocument offers a lot of the usual ORM tools such as optional yet defined schema, validation, callbacks, pagination, casting and much more.
+
+### Model example
+
+Check spec/couchrest/more and spec/fixtures/more for more examples
+
+    class Article < CouchRest::ExtendedDocument
+      use_database DB
+      unique_id :slug
+
+      view_by :date, :descending => true
+      view_by :user_id, :date
+
+      view_by :tags,
+        :map => 
+          "function(doc) {
+            if (doc['couchrest-type'] == 'Article' && doc.tags) {
+              doc.tags.forEach(function(tag){
+                emit(tag, 1);
+              });
+            }
+          }",
+        :reduce => 
+          "function(keys, values, rereduce) {
+            return sum(values);
+          }"  
+
+      property :date
+      property :slug, :read_only => true
+      property :title
+      property :tags, :cast_as => ['String']
+
+      timestamps!
 
+      save_callback :before, :generate_slug_from_title
 
-## CouchRest::ExtendedDocument
+      def generate_slug_from_title
+        self['slug'] = title.downcase.gsub(/[^a-z0-9]/,'-').squeeze('-').gsub(/^\-|\-$/,'') if new_document?
+      end
+    end
 
 ### Callbacks
 
@@ -114,4 +155,11 @@ Basically, you can paginate through the articles starting by the letter a, 5 art
 Low level usage:        
 
     Article.paginate(:design_doc => 'Article', :view_name => 'by_date',
-      :per_page => 3, :page => 2, :descending => true, :key => Date.today, :include_docs => true)
+      :per_page => 3, :page => 2, :descending => true, :key => Date.today, :include_docs => true)
+      
+      
+## Ruby on Rails
+
+CouchRest is compatible with rails and can even be used a Rails plugin.
+However, you might be interested in the CouchRest companion rails project:
+[http://github.com/hpoydar/couchrest-rails](http://github.com/hpoydar/couchrest-rails)      

data/history.txt

@@ -1,3 +1,47 @@
+== 0.33
+
+* Major enhancements
+
+  * Added a new Rack logger middleware letting you log/save requests/queries (Matt Aimonetti)
+  
+* Minor enhancements 
+  
+  * Added #amount_pages to a paginated result array (Matt Aimonetti)
+  * Ruby 1.9.2 compatible (Matt Aimonetti)
+  * Added a property? method for property cast as :boolean (John Wood)
+  * Added an option to force the deletion of a attachments (bypass 409s) (Matt Aimonetti)
+  * Created a new abstraction layer for the REST API (Matt Aimonetti)
+  * Bug fix: made ExtendedDocument#all compatible with Couch 0.10 (tc)
+
+== 0.32
+  
+* Major enhancements
+
+  * ExtendedDocument.get doesn't raise an exception anymore. If no documents are found nil is returned.
+  * ExtendedDocument.get! works the say #get used to work and will raise an exception if a document isn't found.
+  
+* Minor enhancements  
+   
+  * Bug fix: Model.all(:keys => [1,2]) was not working (Matt Aimonetti)
+  * Added ValidationErrors#count in order to play nicely with Rails (Peter Wagenet)
+  * Bug fix: class proxy design doc refresh (Daniel Kirsh)
+  * Bug fix: the count method on the proxy collection was missing (Daniel Kirsch)
+  * Added #amount_pages to a paginated collection. (Matt Aimonetti)
+
+== 0.31
+
+* Major enhancements
+
+  * Created an abstraction HTTP layer to support different http adapters (Matt Aimonetti)
+  * Added ExtendedDocument.create({}) and #create!({}) so you don't have to do Model.new.create (Matt Aimonetti)
+  
+* Minor enhancements
+  
+  * Added an init.rb file for easy usage as a Rails plugin (Aaron Quint)
+  * Bug fix: pagination shouldn't die on empty results (Arnaud Berthomier)
+  * Optimized ExtendedDocument.count to run about 3x faster (Matt Aimonetti)
+  * Added Float casting (Ryan Felton & Matt Aimonetti)
+
 == 0.30
  
 * Major enhancements
@@ -16,4 +60,4 @@
 ---
 
 Unfortunately, before 0.30 we did not keep a track of the modifications made to CouchRest.
-You can see the full commit history on GitHub: http://github.com/mattetti/couchrest/commits/master/
+You can see the full commit history on GitHub: http://github.com/couchrest/couchrest/commits/master/

data/lib/couchrest.rb

@@ -29,7 +29,7 @@ require 'couchrest/monkeypatches'
 
 # = CouchDB, close to the metal
 module CouchRest
-  VERSION    = '0.30' unless self.const_defined?("VERSION")
+  VERSION    = '0.33' unless self.const_defined?("VERSION")
   
   autoload :Server,       'couchrest/core/server'
   autoload :Database,     'couchrest/core/database'
@@ -46,7 +46,13 @@ module CouchRest
   autoload :ExtendedDocument,     'couchrest/more/extended_document'
   autoload :CastedModel,          'couchrest/more/casted_model'
   
+  require File.join(File.dirname(__FILE__), 'couchrest', 'core', 'rest_api')
+  require File.join(File.dirname(__FILE__), 'couchrest', 'core', 'http_abstraction')
   require File.join(File.dirname(__FILE__), 'couchrest', 'mixins')
+
+  # we extend CouchRest with the RestAPI module which gives us acess to
+  # the get, post, put, delete and copy
+  CouchRest.extend(::RestAPI)
   
   # The CouchRest module methods handle the basic JSON serialization 
   # and deserialization, as well as query parameters. The module also includes
@@ -119,9 +125,9 @@ module CouchRest
       }
     end
 
-    # set proxy for RestClient to use
+    # set proxy to use
     def proxy url
-      RestClient.proxy = url
+      HttpAbstraction.proxy = url
     end
 
     # ensure that a database exists
@@ -139,52 +145,6 @@ module CouchRest
       cr.database(parsed[:database])
     end
     
-    def put(uri, doc = nil)
-      payload = doc.to_json if doc
-      begin
-        JSON.parse(RestClient.put(uri, payload))
-      rescue Exception => e
-        if $DEBUG
-          raise "Error while sending a PUT request #{uri}\npayload: #{payload.inspect}\n#{e}"
-        else
-          raise e
-        end
-      end
-    end
-
-    def get(uri)
-      begin
-        JSON.parse(RestClient.get(uri), :max_nesting => false)
-      rescue => e
-        if $DEBUG
-          raise "Error while sending a GET request #{uri}\n: #{e}"
-        else
-          raise e
-        end
-      end
-    end
-  
-    def post uri, doc = nil
-      payload = doc.to_json if doc
-      begin
-        JSON.parse(RestClient.post(uri, payload))
-      rescue Exception => e
-        if $DEBUG
-          raise "Error while sending a POST request #{uri}\npayload: #{payload.inspect}\n#{e}"
-        else
-          raise e
-        end
-      end
-    end
-  
-    def delete uri
-      JSON.parse(RestClient.delete(uri))
-    end
-    
-    def copy uri, destination
-      JSON.parse(RestClient.copy(uri, {'Destination' => destination}))
-    end
-  
     def paramify_url url, params = {}
       if params && !params.empty?
         query = params.collect do |k,v|

data/lib/couchrest/core/adapters/restclient.rb

@@ -0,0 +1,35 @@
+module RestClientAdapter
+   
+  module API
+    def proxy=(url)
+      RestClient.proxy = url
+    end 
+    
+    def proxy
+      RestClient.proxy
+    end
+  
+    def get(uri, headers={})
+      RestClient.get(uri, headers)
+    end
+  
+    def post(uri, payload, headers={})
+      RestClient.post(uri, payload, headers)
+    end
+  
+    def put(uri, payload, headers={})
+      RestClient.put(uri, payload, headers)
+    end
+  
+    def delete(uri, headers={})
+      RestClient.delete(uri, headers)
+    end
+  
+    def copy(uri, headers)
+      RestClient::Request.execute(  :method   => :copy,
+                                    :url      => uri,
+                                    :headers  => headers) 
+    end
+  end 
+  
+end

data/lib/couchrest/core/database.rb

@@ -58,7 +58,7 @@ module CouchRest
       keys = params.delete(:keys)
       funcs = funcs.merge({:keys => keys}) if keys
       url = CouchRest.paramify_url "#{@root}/_temp_view", params
-      JSON.parse(RestClient.post(url, funcs.to_json, {"Content-Type" => 'application/json'}))
+      JSON.parse(HttpAbstraction.post(url, funcs.to_json, {"Content-Type" => 'application/json'}))
     end
     
     # backwards compatibility is a plus
@@ -100,11 +100,8 @@ module CouchRest
     
     # GET an attachment directly from CouchDB
     def fetch_attachment(doc, name)
-      # slug = escape_docid(docid)        
-      # name = CGI.escape(name)
       uri = url_for_attachment(doc, name)
-      RestClient.get uri
-      # "#{@uri}/#{slug}/#{name}"
+      HttpAbstraction.get uri
     end
     
     # PUT an attachment directly to CouchDB
@@ -112,14 +109,25 @@ module CouchRest
       docid = escape_docid(doc['_id'])
       name = CGI.escape(name)
       uri = url_for_attachment(doc, name)
-      JSON.parse(RestClient.put(uri, file, options))
+      JSON.parse(HttpAbstraction.put(uri, file, options))
     end
     
     # DELETE an attachment directly from CouchDB
-    def delete_attachment doc, name
+    def delete_attachment(doc, name, force=false)
       uri = url_for_attachment(doc, name)
       # this needs a rev
-      JSON.parse(RestClient.delete(uri))
+      begin
+        JSON.parse(HttpAbstraction.delete(uri))
+      rescue Exception => error
+        if force
+          # get over a 409
+          doc = get(doc['_id'])
+          uri = url_for_attachment(doc, name)
+          JSON.parse(HttpAbstraction.delete(uri))
+        else
+          error
+        end
+      end
     end
     
     # Save a document to CouchDB. This will use the <tt>_id</tt> field from
@@ -146,7 +154,7 @@ module CouchRest
         slug = escape_docid(doc['_id'])
         begin     
           CouchRest.put "#{@root}/#{slug}", doc
-        rescue RestClient::ResourceNotFound
+        rescue HttpAbstraction::ResourceNotFound
           p "resource not found when saving even tho an id was passed"
           slug = doc['_id'] = @server.next_uuid
           CouchRest.put "#{@root}/#{slug}", doc
@@ -252,7 +260,7 @@ module CouchRest
     def recreate!
       delete!
       create!
-    rescue RestClient::ResourceNotFound
+    rescue HttpAbstraction::ResourceNotFound
     ensure
       create!
     end

data/lib/couchrest/core/document.rb

@@ -3,10 +3,6 @@ require 'delegate'
 module CouchRest  
   class Document < Response
     include CouchRest::Mixins::Attachments
-
-    # def self.inherited(subklass)
-    #   subklass.send(:extlib_inheritable_accessor, :database)
-    # end
     
     extlib_inheritable_accessor :database
     attr_accessor :database

data/lib/couchrest/core/http_abstraction.rb

@@ -0,0 +1,48 @@
+require 'couchrest/core/adapters/restclient'
+
+# Abstraction layet for HTTP communications.
+#                                           
+# By defining a basic API that CouchRest is relying on,
+# it allows for easy experimentations and implementations of various libraries.
+# 
+# Most of the API is based on the RestClient API that was used in the early version of CouchRest.
+#
+module HttpAbstraction
+  
+  # here is the list of exception expected by CouchRest
+  # please convert the underlying errors in this set of known
+  # exceptions.
+  class ResourceNotFound < StandardError; end
+  class RequestFailed < StandardError; end
+  class RequestTimeout < StandardError; end
+  class ServerBrokeConnection < StandardError; end
+  class Conflict < StandardError; end
+  
+  
+  # # Here is the API you need to implement if you want to write a new adapter
+  # # See adapters/restclient.rb for more information.
+  #
+  # def self.proxy=(url)
+  # end
+  #      
+  # def self.proxy
+  # end
+  #
+  # def self.get(uri, headers=nil)
+  # end
+  # 
+  # def self.post(uri, payload, headers=nil)
+  # end
+  # 
+  # def self.put(uri, payload, headers=nil)
+  # end
+  # 
+  # def self.delete(uri, headers=nil)
+  # end
+  # 
+  # def self.copy(uri, headers)
+  # end    
+ 
+end
+
+HttpAbstraction.extend(RestClientAdapter::API)

data/lib/couchrest/core/rest_api.rb

@@ -0,0 +1,49 @@
+module RestAPI
+
+  def put(uri, doc = nil)
+    payload = doc.to_json if doc
+    begin
+      JSON.parse(HttpAbstraction.put(uri, payload))
+    rescue Exception => e
+      if $DEBUG
+        raise "Error while sending a PUT request #{uri}\npayload: #{payload.inspect}\n#{e}"
+      else
+        raise e
+      end
+    end
+  end
+
+  def get(uri)
+    begin
+      JSON.parse(HttpAbstraction.get(uri), :max_nesting => false)
+    rescue => e
+      if $DEBUG
+        raise "Error while sending a GET request #{uri}\n: #{e}"
+      else
+        raise e
+      end
+    end
+  end
+
+  def post(uri, doc = nil)
+    payload = doc.to_json if doc
+    begin
+      JSON.parse(HttpAbstraction.post(uri, payload))
+    rescue Exception => e
+      if $DEBUG
+        raise "Error while sending a POST request #{uri}\npayload: #{payload.inspect}\n#{e}"
+      else
+        raise e
+      end
+    end
+  end
+
+  def delete(uri)
+    JSON.parse(HttpAbstraction.delete(uri))
+  end
+
+  def copy(uri, destination) 
+    JSON.parse(HttpAbstraction.copy(uri, {'Destination' => destination}))
+  end 
+
+end