samlown-couchrest 0.37.2 → 1.0.0

data/README.md

@@ -14,12 +14,17 @@ Note: CouchRest only support CouchDB 0.9.0 or newer.
 
     $ sudo gem install couchrest
    
-### Relax, it's RESTful
+## Relax, it's RESTful
 
 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
+## Extended Document
+
+As of May 2010 support for the popular CouchRest::ExtendedDocument mixin has been moved to its own gem: couchrest_extended_document.
+
+Most people will probably want to use this library (or one of the alternatives) to make it slightly easier to access your documents.
+
+## 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`
@@ -38,7 +43,8 @@ Please post bugs, suggestions and patches to the bug tracker at [http://github.c
 Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
 
 Also, check [http://twitter.com/#search?q=%23couchrest](http://twitter.com/#search?q=%23couchrest)
-      
+
+
 ## Ruby on Rails
 
 CouchRest is compatible with rails and can even be used a Rails plugin.

data/Rakefile

@@ -25,7 +25,7 @@ begin
     gemspec.files = %w( LICENSE README.md Rakefile THANKS.md history.txt couchrest.gemspec) + Dir["{examples,lib,spec,utils}/**/*"] - Dir["spec/tmp"]
     gemspec.has_rdoc = true
     gemspec.add_dependency("rest-client", ">= 0.5")
-    gemspec.add_dependency("mime-types", ">= 1.15")
+#    gemspec.add_dependency("couchrest_extended_document", ">= 1.0.0")
     gemspec.version = CouchRest::VERSION
     gemspec.date = "2008-11-22"
     gemspec.require_path = "lib"

data/history.txt

@@ -4,6 +4,14 @@
 
 * Minor enhancements
 
+== 1.0.0 
+
+* Major enhancements
+  * Moved ExtendedDocument and friends into own library, couchrest_extended_document. (Sam Lown)
+  * Removed HttpAbstraction component for direct interface with RestClient. (Sam Lown)
+  * Changed version to more conventional format starting from 1.0.0 to avoid ambiguity issues with order. (Sam Lown)
+
+
 == 0.37
 
 * Minor enhancements

data/lib/couchrest.rb

@@ -25,31 +25,23 @@ $:.unshift File.dirname(__FILE__) unless
   $:.include?(File.expand_path(File.dirname(__FILE__)))
     
 require 'couchrest/monkeypatches'
+require 'couchrest/rest_api'
 
 # = CouchDB, close to the metal
 module CouchRest
-  VERSION    = '0.37.2' unless self.const_defined?("VERSION")
+  VERSION    = '1.0.0' unless self.const_defined?("VERSION")
   
-  autoload :Server,       'couchrest/core/server'
-  autoload :Database,     'couchrest/core/database'
-  autoload :Response,     'couchrest/core/response'
-  autoload :Document,     'couchrest/core/document'
-  autoload :Design,       'couchrest/core/design'
-  autoload :View,         'couchrest/core/view'
-  autoload :Model,        'couchrest/core/model'
+  autoload :Server,       'couchrest/server'
+  autoload :Database,     'couchrest/database'
+  autoload :Response,     'couchrest/response'
+  autoload :Document,     'couchrest/document'
+  autoload :Design,       'couchrest/design'
+  autoload :Model,        'couchrest/model'
   autoload :Pager,        'couchrest/helper/pager'
-  autoload :FileManager,  'couchrest/helper/file_manager'
   autoload :Streamer,     'couchrest/helper/streamer'
+  autoload :Attachments,  'couchrest/helper/attachments'
   autoload :Upgrade,      'couchrest/helper/upgrade'
-  
-  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')
-  require File.join(File.dirname(__FILE__), 'couchrest', 'support', 'rails') if defined?(Rails)
-
+ 
   # we extend CouchRest with the RestAPI module which gives us acess to
   # the get, post, put, delete and copy
   CouchRest.extend(::RestAPI)
@@ -59,35 +51,6 @@ module CouchRest
   # some helpers for tasks like instantiating a new Database or Server instance.
   class << self
 
-    # extracted from Extlib
-    #
-    # Constantize tries to find a declared constant with the name specified
-    # in the string. It raises a NameError when the name is not in CamelCase
-    # or is not initialized.
-    #
-    # @example
-    # "Module".constantize #=> Module
-    # "Class".constantize #=> Class
-    def constantize(camel_cased_word)
-      unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
-        raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
-      end
-
-      Object.module_eval("::#{$1}", __FILE__, __LINE__)
-    end
-    
-    # extracted from Extlib
-    #    
-    # Capitalizes the first word and turns underscores into spaces and strips _id.
-    # Like titleize, this is meant for creating pretty output.
-    #
-    # @example
-    #   "employee_salary" #=> "Employee salary"
-    #   "author_id" #=> "Author"
-    def humanize(lower_case_and_underscored_word)
-      lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
-    end
-    
     # todo, make this parse the url and instantiate a Server or Database instance
     # depending on the specificity.
     def new(*opts)
@@ -130,9 +93,9 @@ module CouchRest
 
     # set proxy to use
     def proxy url
-      HttpAbstraction.proxy = url
+      RestClient.proxy = url
     end
-
+    
     # ensure that a database exists
     # creates it if it isn't already there
     # returns it after it's been created
@@ -160,3 +123,18 @@ module CouchRest
     end
   end # class << self
 end
+
+# For the sake of backwards compatability, generate a dummy ExtendedDocument class
+# which should be replaced by real library: couchrest_extended_document.
+#
+# Added 2010-05-10 by Sam Lown. Please remove at some point in the future.
+#
+class CouchRest::ExtendedDocument < CouchRest::Document
+
+  def self.inherited(subclass)
+    raise "ExtendedDocument is no longer included in CouchRest base driver, see couchrest_extended_document gem"
+  end
+
+end
+
+

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

@@ -65,7 +65,7 @@ module CouchRest
       keys = params.delete(:keys)
       funcs = funcs.merge({:keys => keys}) if keys
       url = CouchRest.paramify_url "#{@root}/_temp_view", params
-      JSON.parse(HttpAbstraction.post(url, funcs.to_json, {"Content-Type" => 'application/json'}))
+      JSON.parse(RestClient.post(url, funcs.to_json, {"Content-Type" => 'application/json'}))
     end
     
     # backwards compatibility is a plus
@@ -108,14 +108,14 @@ module CouchRest
     # GET an attachment directly from CouchDB
     def fetch_attachment(doc, name)
       uri = url_for_attachment(doc, name)
-      HttpAbstraction.get uri
+      RestClient.get uri
     end
     
     # PUT an attachment directly to CouchDB
     def put_attachment(doc, name, file, options = {})
       docid = escape_docid(doc['_id'])
       uri = url_for_attachment(doc, name)
-      JSON.parse(HttpAbstraction.put(uri, file, options))
+      JSON.parse(RestClient.put(uri, file, options))
     end
     
     # DELETE an attachment directly from CouchDB
@@ -123,13 +123,13 @@ module CouchRest
       uri = url_for_attachment(doc, name)
       # this needs a rev
       begin
-        JSON.parse(HttpAbstraction.delete(uri))
+        JSON.parse(RestClient.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))
+          JSON.parse(RestClient.delete(uri))
         else
           error
         end
@@ -174,7 +174,7 @@ module CouchRest
           uri = "#{@root}/#{slug}"
           uri << "?batch=ok" if batch
           CouchRest.put uri, doc
-        rescue HttpAbstraction::ResourceNotFound
+        rescue RestClient::ResourceNotFound
           p "resource not found when saving even tho an id was passed"
           slug = doc['_id'] = @server.next_uuid
           CouchRest.put "#{@root}/#{slug}", doc
@@ -316,7 +316,6 @@ module CouchRest
     # DELETE the database itself. This is not undoable and could be rather
     # catastrophic. Use with care!
     def delete!
-      clear_extended_doc_fresh_cache
       CouchRest.delete @root
     end
 
@@ -334,10 +333,6 @@ module CouchRest
       payload[:continuous] = continuous
       CouchRest.post "#{@host}/_replicate", payload
     end
-    
-    def clear_extended_doc_fresh_cache
-      ::CouchRest::ExtendedDocument.subclasses.each{|klass| klass.design_doc_fresh = false if klass.respond_to?(:design_doc_fresh=) }
-    end
 
     def uri_for_attachment(doc, name)
       if doc.is_a?(String)

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

@@ -67,7 +67,7 @@ JAVASCRIPT
     def has_view?(view)
       view = view.to_s
       self['views'][view] &&
-        (self['views'][view]["couchrest-defaults"]||{})
+        (self['views'][view]["couchrest-defaults"] || {})
     end
 
     def fetch_view view_name, opts, &block
@@ -76,4 +76,4 @@ JAVASCRIPT
 
   end
   
-end
+end

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

@@ -2,7 +2,7 @@ require 'delegate'
 
 module CouchRest  
   class Document < Response
-    include CouchRest::Mixins::Attachments
+    include CouchRest::Attachments
     
     extlib_inheritable_accessor :database
     attr_accessor :database

data/lib/couchrest/helper/attachments.rb

@@ -0,0 +1,29 @@
+module CouchRest
+  module Attachments
+  
+    # saves an attachment directly to couchdb
+    def put_attachment(name, file, options={})
+      raise ArgumentError, "doc must be saved" unless self.rev
+      raise ArgumentError, "doc.database required to put_attachment" unless database
+      result = database.put_attachment(self, name, file, options)
+      self['_rev'] = result['rev']
+      result['ok']
+    end
+
+    # returns an attachment's data
+    def fetch_attachment(name)
+      raise ArgumentError, "doc must be saved" unless self.rev
+      raise ArgumentError, "doc.database required to put_attachment" unless database
+      database.fetch_attachment(self, name)
+    end
+
+    # deletes an attachment directly from couchdb
+    def delete_attachment(name, force=false)
+      raise ArgumentError, "doc.database required to delete_attachment" unless database
+      result = database.delete_attachment(self, name, force)
+      self['_rev'] = result['rev']
+      result['ok']
+    end
+  
+  end
+end

data/lib/couchrest/middlewares/logger.rb

@@ -53,8 +53,8 @@ module CouchRest
   end
 end
 
-# inject our logger into CouchRest HTTP abstraction layer
-module HttpAbstraction
+# inject our logger into key RestClient methods
+module RestClient 
  
   def self.get(uri, headers=nil)
     start_query = Time.now
@@ -260,4 +260,4 @@ end
 #     end
 #     
 #   end
-# end             
+# end             

data/lib/couchrest/monkeypatches.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), 'support', 'class')
-require File.join(File.dirname(__FILE__), 'support', 'blank')
 require 'timeout'
 
 # This file must be loaded after the JSON gem and any other library that beats up the Time class.
@@ -15,16 +14,6 @@ class Time
     %("#{u.strftime("%Y/%m/%d %H:%M:%S +0000")}")
   end
 
-  # Decodes the JSON time format to a UTC time.
-  # Based on Time.parse from ActiveSupport. ActiveSupport's version
-  # is more complete, returning a time in your current timezone, 
-  # rather than keeping the time in UTC. YMMV.
-  # 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
 
 # Monkey patch for faster net/http io
@@ -51,63 +40,4 @@ if RUBY_VERSION.to_f < 1.9
   end
 end
 
-# module RestClient
-#   # def self.copy(url, headers={})
-#   #   Request.execute(:method => :copy,
-#   #     :url => url,
-#   #     :headers => headers)
-#   # end  
-# 
-# #   class Request
-# #     
-# #     def establish_connection(uri)
-# #       Thread.current[:connection].finish if (Thread.current[:connection] && Thread.current[:connection].started?)
-# #       p net_http_class
-# #       net = net_http_class.new(uri.host, uri.port)
-# #       net.use_ssl = uri.is_a?(URI::HTTPS)
-# #       net.verify_mode = OpenSSL::SSL::VERIFY_NONE
-# #       Thread.current[:connection] = net
-# #       Thread.current[:connection].start
-# #       Thread.current[:connection]
-# #     end
-# #     
-# #     def transmit(uri, req, payload)
-# #       setup_credentials(req)
-# #       
-# #       Thread.current[:host] ||= uri.host
-# #       Thread.current[:port] ||= uri.port
-# #       
-# #       if (Thread.current[:connection].nil? || (Thread.current[:host] != uri.host))
-# #         p "establishing a connection"
-# #         establish_connection(uri)
-# #       end
-# # 
-# #       display_log request_log
-# #       http = Thread.current[:connection]
-# #       http.read_timeout = @timeout if @timeout
-# #       
-# #       begin
-# #         res = http.request(req, payload)
-# #       rescue
-# #         p "Net::HTTP connection failed, reconnecting"
-# #         establish_connection(uri)
-# #         http = Thread.current[:connection]
-# #         require 'ruby-debug'
-# #         req.body_stream = nil
-# #         
-# #         res = http.request(req, payload)
-# #         display_log response_log(res)
-# #         result res
-# #       else
-# #         display_log response_log(res)
-# #         process_result res
-# #       end
-# #       
-# #     rescue EOFError
-# #       raise RestClient::ServerBrokeConnection
-# #     rescue Timeout::Error
-# #       raise RestClient::RequestTimeout
-# #     end
-# #   end
-#   
-# end 
+

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

@@ -3,7 +3,7 @@ module RestAPI
   def put(uri, doc = nil)
     payload = doc.to_json if doc
     begin
-      JSON.parse(HttpAbstraction.put(uri, payload))
+      JSON.parse(RestClient.put(uri, payload))
     rescue Exception => e
       if $DEBUG
         raise "Error while sending a PUT request #{uri}\npayload: #{payload.inspect}\n#{e}"
@@ -15,7 +15,7 @@ module RestAPI
 
   def get(uri)
     begin
-      JSON.parse(HttpAbstraction.get(uri), :max_nesting => false)
+      JSON.parse(RestClient.get(uri), :max_nesting => false)
     rescue => e
       if $DEBUG
         raise "Error while sending a GET request #{uri}\n: #{e}"
@@ -28,7 +28,7 @@ module RestAPI
   def post(uri, doc = nil)
     payload = doc.to_json if doc
     begin
-      JSON.parse(HttpAbstraction.post(uri, payload))
+      JSON.parse(RestClient.post(uri, payload))
     rescue Exception => e
       if $DEBUG
         raise "Error while sending a POST request #{uri}\npayload: #{payload.inspect}\n#{e}"
@@ -39,11 +39,14 @@ module RestAPI
   end
 
   def delete(uri)
-    JSON.parse(HttpAbstraction.delete(uri))
+    JSON.parse(RestClient.delete(uri))
   end
 
   def copy(uri, destination) 
-    JSON.parse(HttpAbstraction.copy(uri, {'Destination' => destination}))
+    JSON.parse(RestClient::Request.execute( :method => :copy,
+                                            :url => uri,
+                                            :headers => {'Destination' => destination}
+                                          ).to_s)
   end 
 
-end
+end

data/spec/couchrest/{core/couchrest_spec.rb → couchrest_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path("../../../spec_helper", __FILE__)
+require File.expand_path("../../spec_helper", __FILE__)
 
 describe CouchRest do
 
@@ -174,11 +174,24 @@ describe CouchRest do
   describe "using a proxy for RestClient connections" do
     it "should set proxy url for RestClient" do
       CouchRest.proxy 'http://localhost:8888/'
-      proxy_uri = URI.parse(HttpAbstraction.proxy)
+      proxy_uri = URI.parse(RestClient.proxy)
       proxy_uri.host.should eql( 'localhost' )
       proxy_uri.port.should eql( 8888 )
       CouchRest.proxy nil
     end
   end
 
-end
+
+  describe "Including old ExtendedDocument library" do
+
+    it "should raise an exception" do
+      lambda do
+        class TestDoc < CouchRest::ExtendedDocument
+          attr_reader :fail
+        end
+      end.should raise_error(RuntimeError)
+    end
+
+  end
+
+end