dpla-couchrest 1.2.1.pre.dpla

data/examples/word_count/word_count_query.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'couchrest'
+
+couch = CouchRest.new("http://127.0.0.1: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 "this will take a few minutes the first time. if it times out, just rerun this script in a few few minutes."
+puts db.view('word_count/words').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,{}]
+  }
+
+puts db.view('word_count/words',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/words',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://127.0.0.1:5984/word-count-example/_view/word_count/count?key=["flight","da-vinci"]'
+puts "\nTry dropping that in your browser..."

data/examples/word_count/word_count_views.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'couchrest'
+
+couch = CouchRest.new("http://127.0.0.1:5984")
+db = couch.database('word-count-example')
+
+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_doc db.get("_design/word_count") rescue nil
+
+db.save_doc({
+  "_id" => "_design/word_count",
+  :views => {
+    :words => word_count
+  }
+})

data/history.txt

@@ -0,0 +1,214 @@
+== 1.2.0 - 2013-05-25
+
+* Changes
+  * Added clobal configuration option to decode JSON objects (@langalex)
+  * Changing specs to test parameters as apposed to CouchDB for replication and restart
+  * Spec updates (@tapajos)
+  * Spec typos (@frasertweedale, @m1foley)
+
+== 1.1.3 - 2012-07-31
+
+* Minor changes
+  * Add support for HTTP HEAD requests (Tim Anglade)
+  * Make CouchRest#database! check if a db exists before creating it (Tim Anglade)
+  * Use _doc suffix in examples for delete and save (Mickael Riga)
+  * Database#view should not modify the params (@krishan)
+  * Fix replication with couchdb >= 1.1.0 (@erickt)
+  * Streamer protection against bad responses improved (@erickt)
+  * Support atomic bulk save requests with all_or_nothing CouchDB parameter (@matthiasjakel)
+  * Update multi_json dependency so we can use any 1.x version (@dgraham)
+
+== 1.1.2 - 2011-07-18
+
+* Minor changes
+  * Added `as_couch_json` method. If available, will be called before sending document to JSON encoder.
+
+== 1.1.1 - 2011-07-04
+
+* Urgent change
+  * Ensuring attributes hash initalized on use to avoid issues when initializer is overwritten.
+
+== 1.1.0 - 2011-06-25
+
+* Minor changes
+  * Refactored basic CouchRest API (get, post, etc.) to pass-through RestClient and MultiJSON options, including headers.
+  * CouchRest::Attributes module created to make attribute related methods independent.
+
+== 1.1.0.pre3 - 2011-06-06
+
+* Major changes
+  * CouchRest::Response removed
+  * CouchRest::Document now forwards key Hash methods (instead of inheritance) (thanks @karmi for prompting the discussion: https://github.com/crx/tire/commit/abf491d0035843a0a7395c8c32b9b7c2120071f9)
+  * Support multiple JSON gems with multi_json (thanks chrisdurtschi)
+
+== 1.1.0.pre2 - 2011-04-08
+
+* Major changes
+  * Time#to_json monkey patch removed! Standard JSON methods now used instead.
+
+* Minor alterations
+  * Named doc replication (thanks @ahamid)
+  * Database#update_doc no longer requires document to be returned from block (thanks @ferrous26)
+  * Streamer now available for all queries that return multiple documents (thanks @pcapr for pointer)
+  * Streamer#view method removed, use Database.view with block
+  * Database#changes method added (with streamer option)
+  * Added :allow_nil option when creating views
+  * Bug fix: only symbols can be passed as view options (helps fix auto :reduce option)
+
+WARNING: If you depend on ordering by Time, this release may cause issues on old databases! 
+Either update your documents to use the new format (JSON standard), or use Javascript's Date.parse 
+method in your views. Also, use Time#utc to ensure universal ordering regardless of time
+zone. (CouchRest Model does this automatically.)
+
+== 1.0.2
+
+* Minor enhancements
+  * Bundler
+  * Dependency versions upgrade
+  * Removed reduce option from view's defaults. Now detected according to presence of reduce function.
+  * Design#has_view? and Design#can_reduce_view? now available publically
+
+== 1.0.1
+
+* Minor enhancements
+	* rest-client version mismatch between couchrest.rb & gemspec
+  * json 1.4.X series re-enabled as tests now pass with v.1.4.6
+
+== 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.38
+
+* Major enhancements
+	* Add create_target option to Database#replicate_to and #replicate_from. http://github.com/couchrest/couchrest/issues/#issue/26 (Alexander Uvarov) 
+  * Removing unused core extensions and moving extlib_inhertiable_* methods to use couchrest_inheritable_* 
+    to avoid conflicts with Rails. (Geoff Buesing)
+
+* Minor enhancements
+  * Support for CouchDB 1.0
+  * Added Document#id= support (issue detected by Rory Franklin with RSpec model stubs)
+  * Fixing issues with CouchDB 1.0 and RestClient
+
+== 0.37
+
+* Minor enhancements
+  * Added gemspec (needed for Bundler install) (Tapajós)
+
+== 0.36
+
+* Major enhancements
+  * Adds support for continuous replication (sauy7)
+  * Automatic Type Casting (Alexander Uvarov, Sam Lown, Tim Heighes, Will Leinweber)
+  * Added a search method to CouchRest:Database to search the documents in a given database. (Dave Farkas, Arnaud Berthomier, John Wood)
+  
+* Minor enhancements
+  * Provide a description of the timeout error (John Wood)
+
+== 0.35
+
+* Major enhancements
+  * CouchRest::ExtendedDocument allow chaining the inherit class callback (Kenneth Kalmer) - http://github.com/couchrest/couchrest/issues#issue/8
+
+* Minor enhancements
+  * Fix attachment bug (Johannes Jörg Schmidt)
+  * Fix create database exception bug (Damien Mathieu)
+  * Compatible with restclient >= 1.4.0 new responses (Julien Kirch)
+  * Bug fix: Attribute protection no longer strips attributes coming from the database (Will Leinweber)
+  * Bug fix: Remove double CGI escape when PUTting an attachment (nzoschke)
+  * Bug fix: Changing Class proxy to set database on result sets (Peter Gumeson)
+  * Bug fix: Updated time regexp (Nolan Darilek)
+  * Added an update_doc method to database to handle conflicts during atomic updates. (Pierre Larochelle)
+  * Bug fix: http://github.com/couchrest/couchrest/issues/#issue/2 (Luke Burton)
+
+== 0.34
+
+* Major enhancements
+
+  * Added support for https database URIs. (Mathias Meyer)
+  * Changing some validations to be compatible with activemodel. (Marcos Tapajós)
+  * Adds attribute protection to properties. (Will Leinweber)
+  * Improved CouchRest::Database#save_doc, added "batch" mode to significantly speed up saves at cost of lower durability gurantees. (Igal Koshevoy)
+  * Added CouchRest::Database#bulk_save_doc and #batch_save_doc as human-friendlier wrappers around #save_doc. (Igal Koshevoy)
+  
+* Minor enhancements 
+  
+  * Fix content_type handling for attachments
+  * Fixed a bug in the pagination code that caused it to paginate over records outside of the scope of the view parameters.(John Wood)
+  * Removed amount_pages calculation for the pagination collection, since it cannot be reliably calculated without a view.(John Wood)
+  * Bug fix: http://github.com/couchrest/couchrest/issues/#issue/2 (Luke Burton)
+  * Bug fix: http://github.com/couchrest/couchrest/issues/#issue/1 (Marcos Tapajós)
+  * Removed the Database class deprecation notices (Matt Aimonetti)
+  * Adding support to :cast_as => 'Date'.  (Marcos Tapajós)
+  * Improve documentation  (Marcos Tapajós)
+  * Streamer fixes (Julien Sanchez)
+  * Fix Save on Document & ExtendedDocument crashed if bulk (Julien Sanchez)
+  * Fix Initialization of ExtendentDocument model shouldn't failed on a nil value in argument (deepj)
+  * Change to use Jeweler and Gemcutter (Marcos Tapajós)
+
+== 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
+ 
+  * Added support for pagination (John Wood)
+  * Improved performance when initializing documents with timestamps (Matt Aimonetti)
+ 
+* Minor enhancements
+ 
+  * Extended the API to retrieve an attachment URI (Matt Aimonetti)
+  * Bug fix: default value should be able to be set as false (Alexander Uvarov)
+  * Bug fix: validates_is_numeric should be able to properly validate a Float instance (Rob Kaufman)
+  * Bug fix: fixed the Timeout implementation (Seth Falcon)
+  
+  
+---
+
+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/couchrest/couchrest/commits/master/

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__),'lib', 'couchrest.rb')

data/lib/couchrest.rb

@@ -0,0 +1,146 @@
+# 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 'rest_client'
+require 'multi_json'
+
+# Not sure why this is required, so removed until a reason is found!
+$:.unshift File.dirname(__FILE__) unless
+ $:.include?(File.dirname(__FILE__)) ||
+ $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'couchrest/monkeypatches'
+require 'couchrest/rest_api'
+require 'couchrest/support/inheritable_attributes'
+
+require 'forwardable'
+
+# = CouchDB, close to the metal
+module CouchRest
+  autoload :Attributes,   'couchrest/attributes'
+  autoload :Server,       'couchrest/server'
+  autoload :Database,     'couchrest/database'
+  autoload :Document,     'couchrest/document'
+  autoload :Design,       'couchrest/design'
+  autoload :Model,        'couchrest/model'
+  autoload :Pager,        'couchrest/helper/pager'
+  autoload :Streamer,     'couchrest/helper/streamer'
+  autoload :Attachments,  'couchrest/helper/attachments'
+  autoload :Upgrade,      'couchrest/helper/upgrade'
+
+  # we extend CouchRest with the RestAPI module which gives us acess to
+  # the get, post, put, delete and copy
+  CouchRest.extend(::CouchRest::RestAPI)
+
+  # 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
+
+    def parse url
+      case url
+      when /^(https?:\/\/)(.*)\/(.*)\/(.*)/
+        scheme = $1
+        host = $2
+        db = $3
+        docid = $4
+      when /^(https?:\/\/)(.*)\/(.*)/
+        scheme = $1
+        host = $2
+        db = $3
+      when /^(https?:\/\/)(.*)/
+        scheme = $1
+        host = $2
+      when /(.*)\/(.*)\/(.*)/
+        host = $1
+        db = $2
+        docid = $3
+      when /(.*)\/(.*)/
+        host = $1
+        db = $2
+      else
+        db = url
+      end
+
+      db = nil if db && db.empty?
+
+      {
+        :host => (scheme || "http://") + (host || "127.0.0.1:5984"),
+        :database => db,
+        :doc => docid
+      }
+    end
+
+    # set proxy to use
+    def 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
+    def database! url
+      parsed = parse url
+      cr = CouchRest.new(parsed[:host])
+      cr.database!(parsed[:database])
+    end
+
+    def database url
+      parsed = parse url
+      cr = CouchRest.new(parsed[:host])
+      cr.database(parsed[:database])
+    end
+
+    def paramify_url url, params = {}
+      if params && !params.empty?
+        query = params.collect do |k,v|
+          v = MultiJson.encode(v) if %w{key startkey endkey}.include?(k.to_s)
+          "#{k}=#{CGI.escape(v.to_s)}"
+        end.join("&")
+        url = "#{url}?#{query}"
+      end
+      url
+    end
+
+    @@decode_json_objects = false
+
+    def decode_json_objects=(value)
+      @@decode_json_objects = value
+    end
+
+    # When set to true, CouchRest.get tries to decode the JSON returned
+    # from CouchDB into a Ruby object. Default: false.
+    def decode_json_objects
+      @@decode_json_objects
+    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/attributes.rb

@@ -0,0 +1,89 @@
+#
+# CouchRest::Attributes
+#
+# When included, provide the owner with an attributes hash and
+# accessors that forward calls to it.
+#
+# Provides the basic functionality of Hash without actually being
+# a Hash using Ruby's standard Forwardable module.
+#
+module CouchRest
+
+  module Attributes
+    extend Forwardable
+
+    # Initialize a new CouchRest Document and prepare 
+    # a hidden attributes hash.
+    #
+    # When inherting a Document, it is essential that the 
+    # super method is called before you own changes to ensure
+    # that the attributes hash has been initialized before
+    # you attempt to use it.
+    def initialize(attrs = nil)
+      attrs.each{|k,v| self[k] = v} unless attrs.nil?
+    end
+
+    # Hash equivilent methods to access the attributes
+    def_delegators :_attributes, :to_a, :==, :eql?, :keys, :values, :each,
+      :reject, :reject!, :empty?, :clear, :merge, :merge!,
+      :encode_json, :as_json, :to_json, :frozen?
+
+    def []=(key, value)
+      _attributes[key.to_s] = value
+    end
+    def [](key)
+      _attributes[key.to_s]
+    end
+    def has_key?(key)
+      _attributes.has_key?(key.to_s)
+    end
+    def delete(key)
+      _attributes.delete(key.to_s)
+    end
+    def dup
+      new = super
+      @_attributes = @_attributes.dup
+      new
+    end
+    def clone
+      new = super
+      @_attributes = @_attributes.dup
+      new
+    end
+    def to_hash
+      _attributes
+    end
+
+    # Provide JSON data hash that can be stored in the database.
+    # Will go through each attribute value and request the `as_couch_json` method
+    # on each if available, or return the value as-is.
+    def as_couch_json
+      _attributes.inject({}) {|h, (k,v)| h[k] = v.respond_to?(:as_couch_json) ? v.as_couch_json : v; h}
+    end
+
+    # Freeze the object's attributes instead of the actual document.
+    # This prevents further modifications to stored data, but does allow access
+    # to local variables useful for callbacks or cached data.
+    def freeze
+      _attributes.freeze; self
+    end
+
+    # Provide details of the current keys in the reponse. Based on ActiveRecord::Base.
+    def inspect
+      attributes_as_nice_string = self.keys.collect { |key|
+        "#{key}: #{self[key].inspect}"
+      }.compact.join(", ")
+      "#<#{self.class} #{attributes_as_nice_string}>"
+    end
+
+    protected
+
+    # Define accessor for _attributes hash that will instantiate the
+    # model if this has not already been done.
+    def _attributes
+      @_attributes ||= {}
+    end
+
+  end
+
+end