couchrest 1.1.3 → 1.2.0

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree-1.8.7
+  - jruby
+services: couchdb

data/Gemfile

@@ -1,4 +1,2 @@
-
-source :rubygems
-gemspec
-
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -1,4 +1,4 @@
-# CouchRest: CouchDB, close to the metal
+# CouchRest: CouchDB, close to the metal [![Build Status](https://travis-ci.org/couchrest/couchrest.png)](https://travis-ci.org/couchrest/couchrest)
 
 CouchRest is based on [CouchDB's couch.js test
 library](http://svn.apache.org/repos/asf/couchdb/trunk/share/www/script/couch.js),
@@ -41,12 +41,13 @@ CouchRest install, from the project root directory use bundler to install
 the dependencies and then run the tests:
 
     $ bundle install
-    $ bundle exec spec spec
+    $ bundle exec rake
 
 To date, the couchrest specs have been show to run on:
 
  * Ruby 1.8.7
  * Ruby 1.9.2
+ * Ruby 1.9.3
  * JRuby 1.5.6
 
 ## Docs

data/Rakefile

@@ -1,33 +1,18 @@
-require 'rubygems'
+# encoding: utf-8
 require 'bundler'
-require 'rspec/core/rake_task'
-require "rake/rdoctask"
-
 Bundler::GemHelper.install_tasks
 
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ["--color"]
-  spec.pattern = 'spec/**/*_spec.rb'
-end
+require 'rspec/core/rake_task'
 
-desc "Print specdocs"
-RSpec::Core::RakeTask.new(:doc) do |spec|
-  spec.rspec_opts = ["--format", "specdoc"]
-  spec.pattern = 'spec/*_spec.rb'
-end
+desc 'Default: run unit tests.'
+task :default => :spec
 
-desc "Generate the rdoc"
-Rake::RDocTask.new do |rdoc|
-  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
-  rdoc.rdoc_files.add(files)
-  rdoc.main = "README.rdoc"
-  rdoc.title = "CouchRest: Ruby CouchDB, close to the metal"
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["-c", "-f progress"]
 end
 
-desc "Run the rspec"
-task :default => :spec
-
 module Rake
   def self.remove_task(task_name)
     Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
@@ -35,4 +20,4 @@ module Rake
 end
 
 Rake.remove_task("github:release")
-Rake.remove_task("release")
+Rake.remove_task("release")

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.2.0

data/couchrest.gemspec

@@ -29,6 +29,8 @@ Gem::Specification.new do |s|
   s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
   s.add_dependency(%q<mime-types>, ["~> 1.15"])
   s.add_dependency(%q<multi_json>, ["~> 1.0"])
-  s.add_development_dependency(%q<json>, ["~> 1.5.1"])
+  s.add_development_dependency(%q<json>, [">= 1.7.0"])
   s.add_development_dependency(%q<rspec>, "~> 2.6.0")
+  s.add_development_dependency(%q<rake>)
+  s.add_development_dependency(%q<multi_json>, "~> 1.7") # needed for json decode json objects
 end

data/history.txt

@@ -1,3 +1,11 @@
+== 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

data/lib/couchrest.rb

@@ -43,7 +43,7 @@ module CouchRest
   # the get, post, put, delete and copy
   CouchRest.extend(::CouchRest::RestAPI)
 
-  # The CouchRest module methods handle the basic JSON serialization 
+  # 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
@@ -118,6 +118,18 @@ module CouchRest
       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

data/lib/couchrest/database.rb

@@ -129,7 +129,7 @@ module CouchRest
           uri << "?batch=ok" if batch
           CouchRest.put uri, doc
         rescue RestClient::ResourceNotFound
-          p "resource not found when saving even tho an id was passed"
+          puts "resource not found when saving even though an id was passed"
           slug = doc['_id'] = @server.next_uuid
           CouchRest.put "#{@root}/#{slug}", doc
         end
@@ -349,12 +349,12 @@ 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
       else
-        payload['target'] = other_db.root
+        payload[:target] = other_db.root
       end
-      payload['continuous'] = continuous
-      payload['doc_ids'] = doc_ids if doc_ids
+      payload[:continuous] = continuous
+      payload[:doc_ids] = doc_ids if doc_ids
       CouchRest.post "#{@host}/_replicate", payload
     end
 

data/lib/couchrest/helper/streamer.rb

@@ -8,7 +8,7 @@ module CouchRest
     end
 
     def view(*args)
-      raise "CouchRest::Streamer#view is depricated. Please use Database#view with block."
+      raise "CouchRest::Streamer#view is deprecated. Please use Database#view with block."
     end
 
     def get(url, &block)

data/lib/couchrest/rest_api.rb

@@ -30,7 +30,7 @@ module CouchRest
   #
   # Any other remaining options will be sent to the MultiJSON backend except for the :raw option.
   #
-  # When :raw is true in PUT and POST requests, no attempt will be made to convert the document payload to JSON. This is 
+  # When :raw is true in PUT and POST requests, no attempt will be made to convert the document payload to JSON. This is
   # not normally necessary as IO and Tempfile objects will not be parsed anyway. The result of the request will
   # *always* be parsed.
   #
@@ -84,7 +84,7 @@ module CouchRest
 
     private
 
-    # Perform the RestClient request by removing the parse specific options, ensuring the 
+    # Perform the RestClient request by removing the parse specific options, ensuring the
     # payload is prepared, and sending the request ready to parse the response.
     def execute(url, method, options = {}, payload = nil)
       request, parser = prepare_and_split_options(url, method, options)
@@ -131,7 +131,7 @@ module CouchRest
       [request, parser]
     end
 
-    # Check if the provided doc is nil or special IO device or temp file. If not, 
+    # Check if the provided doc is nil or special IO device or temp file. If not,
     # encode it into a string.
     #
     # The options supported are:
@@ -147,6 +147,7 @@ module CouchRest
 
     # Parse the response provided.
     def parse_response(result, opts = {})
+      opts = opts.update(:create_additions => true) if decode_json_objects
       (opts.delete(:raw) || opts.delete(:head)) ? result : MultiJson.decode(result, opts.update(:max_nesting => false))
     end
 

data/lib/couchrest/server.rb

@@ -1,11 +1,13 @@
 module CouchRest
   class Server
+
     attr_accessor :uri, :uuid_batch_count, :available_databases
+
     def initialize(server = 'http://127.0.0.1:5984', uuid_batch_count = 1000)
       @uri = server
       @uuid_batch_count = uuid_batch_count
     end
-  
+
     # Lists all "available" databases.
     # An available database, is a database that was specified
     # as avaiable by your code.
@@ -13,7 +15,7 @@ module CouchRest
     def available_databases
       @available_databases ||= {}
     end
-    
+
     # Adds a new available database and create it unless it already exists
     #
     # Example:
@@ -24,7 +26,7 @@ module CouchRest
     def define_available_database(reference, db_name, create_unless_exists = true)
       available_databases[reference.to_sym] = create_unless_exists ? database!(db_name) : database(db_name)
     end
-  
+
     # Checks that a database is set as available
     #
     # Example:
@@ -34,25 +36,25 @@ module CouchRest
     def available_database?(ref_or_name)
       ref_or_name.is_a?(Symbol) ? available_databases.keys.include?(ref_or_name) : available_databases.values.map{|db| db.name}.include?(ref_or_name)
     end
-  
+
     def default_database=(name, create_unless_exists = true)
       define_available_database(:default, name, create_unless_exists = true)
     end
-    
+
     def default_database
       available_databases[:default]
     end
-  
+
     # Lists all databases on the server
     def databases
       CouchRest.get "#{@uri}/_all_dbs"
     end
-  
+
     # Returns a CouchRest::Database for the given name
     def database(name)
       CouchRest::Database.new(self, name)
     end
-  
+
     # Creates the database if it doesn't exist
     def database!(name)
       CouchRest.head "#{@uri}/#{name}" # Check if the URL is valid
@@ -60,7 +62,7 @@ module CouchRest
     rescue RestClient::ResourceNotFound # Thrown if the HTTP HEAD fails
       create_db(name)
     end
-  
+
     # GET the welcome message
     def info
       CouchRest.get "#{@uri}/"
@@ -75,8 +77,6 @@ module CouchRest
     # Restart the CouchDB instance
     def restart!
       CouchRest.post "#{@uri}/_restart"
-    rescue RestClient::ServerBrokeConnection
-      # Shouldn't really happen, but does in CouchDB 1.0.0
     end
 
     # Retrive an unused UUID from CouchDB. Server instances manage caching a list of unused UUIDs.

data/spec/couchrest/couchrest_spec.rb

@@ -27,14 +27,9 @@ describe CouchRest do
   end
 
   it "should restart" do
+    # we really do not need to perform a proper restart!
+    CouchRest.should_receive(:post).with("#{@cr.uri}/_restart")
     @cr.restart!
-    begin
-      @cr.info
-    rescue
-      # Give the couchdb time to restart
-      sleep 0.2
-      retry
-    end
   end
 
   it "should provide one-time access to uuids" do

data/spec/couchrest/database_spec.rb

@@ -4,8 +4,8 @@ describe CouchRest::Database do
   before(:each) do
     @cr = CouchRest.new(COUCHHOST)
     @db = @cr.database(TESTDB)
-    @db.delete! rescue nil
-    @db = @cr.create_db(TESTDB) rescue nil
+    @db.delete! rescue RestClient::ResourceNotFound
+    @db = @cr.create_db(TESTDB) # rescue nil
   end
 
   describe "database name including slash" do
@@ -735,10 +735,11 @@ describe CouchRest::Database do
   
 
   describe "#compact" do
+    # Can cause failures in recent versions of CouchDB, just ensure
+    # we actually send the right command.
     it "should compact the database" do
-      db = @cr.database('couchrest-test')
-      r = db.compact!
-      r['ok'].should == true
+      CouchRest.should_receive(:post).with("#{@cr.uri}/couchrest-test/_compact")
+      @cr.database('couchrest-test').compact!
     end
   end
 
@@ -754,128 +755,107 @@ describe CouchRest::Database do
     end
   end
 
+  #
+  # Replicating databases is often a time consuming process, so instead of
+  # trying to send commands to CouchDB, we just validate that the post
+  # command contains the correct parameters.
+  #
+
   describe "simply replicating a database" do
     before(:each) do
-      @db.save_doc({'_id' => 'test_doc', 'some-value' => 'foo'})
       @other_db = @cr.database(REPLICATIONDB)
     end
 
-    shared_examples_for "simply replicated" do
-      it "contains the document from the original database" do
-        doc = @other_db.get('test_doc')
-        doc['some-value'].should == 'foo'
-      end
-    end
-
-    describe "via pulling" do
-      before(:each) do
-        @other_db.recreate!
-        @other_db.replicate_from @db
-      end
-
-      it_should_behave_like "simply replicated"
-    end
-
-    describe "via pushing" do
-      before(:each) do
-        @other_db.recreate!
-        @db.replicate_to @other_db
-      end
-
-      it_should_behave_like "simply replicated"
-    end
-    
-    describe "with a specific doc" do
-      before(:each) do
-        @other_db.recreate!
-        @db.save_doc({'_id' => 'unreplicated_doc', 'some-value' => 'foo'})
-        @db.replicate_to @other_db, false, false, ['test_doc']
-      end
-      
-      # should contain only replicated doc and not unreplicated doc
-      it_should_behave_like "simply replicated"
-      it "does not contain unreplicated doc" do 
-        lambda { @other_db.get('unreplicated_doc') }.should raise_error(RestClient::ResourceNotFound)
-      end
+    it "should replicate via pulling" do
+      CouchRest.should_receive(:post).with(
+        include("/_replicate"),
+        include(
+          :create_target => false,
+          :continuous    => false,
+          :source        => "#{@cr.uri}/#{@db.name}",
+          :target        => @other_db.name
+        )
+      )
+      @other_db.replicate_from @db
+    end
+
+    it "should replicate via pushing" do
+      CouchRest.should_receive(:post).with(
+        include("/_replicate"),
+        include(
+          :create_target => false,
+          :continuous    => false,
+          :source        => @db.name,
+          :target        => "#{@cr.uri}/#{@other_db.name}"
+        )
+      )
+      @db.replicate_to @other_db
+    end
+
+    it "should replacicate with a specific doc" do
+      CouchRest.should_receive(:post).with(
+        include("/_replicate"),
+        include(
+          :create_target => false,
+          :continuous    => false,
+          :doc_ids       => ['test_doc'],
+          :source        => @db.name,
+          :target        => "#{@cr.uri}/#{@other_db.name}"
+        )
+      )
+      @db.replicate_to @other_db, false, false, ['test_doc']
     end
 
     describe "implicitly creating target" do
-      describe "via pulling" do
-        before(:each) do
-          @other_db.replicate_from(@db, false, true)
-        end
-
-        it_should_behave_like "simply replicated"
-      end
-
-      describe "via pushing" do
-        before(:each) do
-          @db.replicate_to(@other_db, false, true)
-        end
-
-        it_should_behave_like "simply replicated"
-      end
-    end
-  end
-
-  describe "continuously replicating a database" do
-    before(:each) do
-      @db.save_doc({'_id' => 'test_doc', 'some-value' => 'foo'})
-      @other_db = @cr.database(REPLICATIONDB)
-    end
-
-    shared_examples_for "continuously replicated" do
-      it "contains the document from the original database" do
-        sleep(1.5) # Allow some time to replicate
-        doc = @other_db.get('test_doc')
-        doc['some-value'].should == 'foo'
-      end
-
-      it "contains documents saved after replication initiated" do
-        @db.save_doc({'_id' => 'test_doc_after', 'some-value' => 'bar'})
-        sleep(1.5) # Allow some time to replicate
-        doc = @other_db.get('test_doc_after')
-        doc['some-value'].should == 'bar'
-      end
-    end
-
-    describe "via pulling" do
-      before(:each) do
-        @other_db.recreate!
+      it "should replicate via pulling" do
+        CouchRest.should_receive(:post).with(
+          include("/_replicate"),
+          include(
+            :create_target => true,
+            :continuous    => false
+          )
+        )
+        @other_db.replicate_from(@db, false, true)
+      end
+
+      it "should replicate via pushing" do
+        CouchRest.should_receive(:post).with(
+          include("/_replicate"),
+          include(
+            :create_target => true,
+            :continuous    => false
+          )
+        )
+        @db.replicate_to(@other_db, false, true)
+      end
+    end
+
+    describe "continuous replication" do
+      it "should replicate via pulling" do
+        CouchRest.should_receive(:post).with(
+          include("/_replicate"),
+          include(
+            :create_target => false,
+            :continuous    => true
+          )
+        )
         @other_db.replicate_from(@db, true)
       end
 
-      it_should_behave_like "continuously replicated"
-    end
-
-    describe "via pushing" do
-      before(:each) do
-        @other_db.recreate!
+      it "should replicate via pushing" do
+        CouchRest.should_receive(:post).with(
+          include("/_replicate"),
+          include(
+            :create_target => false,
+            :continuous    => true
+          )
+        )
         @db.replicate_to(@other_db, true)
       end
-
-      it_should_behave_like "continuously replicated"
-    end
-
-    describe "implicitly creating target" do
-      before(:each) do
-        @other_db.replicate_from(@db, true, true)
-      end
-
-      after(:each) do
-        @other_db.delete!
-      end
-
-      describe "via pulling" do
-        it_should_behave_like "continuously replicated"
-      end
-
-      describe "via pushing" do
-        it_should_behave_like "continuously replicated"
-      end
     end
   end
 
+
   describe "#create!" do
     before(:each) do
       @db = @cr.database('couchrest-test-db_to_create')
@@ -903,7 +883,7 @@ describe CouchRest::Database do
        @cr.databases.should include(@db.name)
     end
 
-    it "should recreate a db even tho it doesn't exist" do
+    it "should recreate a db even though it doesn't exist" do
       @cr.databases.should_not include(@db2.name)
       @db2.recreate!
       @cr.databases.should include(@db2.name)

data/spec/couchrest/helpers/streamer_spec.rb

@@ -19,8 +19,8 @@ describe CouchRest::Streamer do
     })
   end
 
-  it "should raise error on #view as depricated" do
-    lambda { @streamer.view }.should raise_error(/depricated/)
+  it "should raise error on #view as deprecated" do
+    lambda { @streamer.view }.should raise_error(/deprecated/)
   end
 
   it "should GET each row in a view" do
@@ -50,7 +50,7 @@ describe CouchRest::Streamer do
     header.should == {"total_rows" => 1001, "offset" => 0}
   end
 
-  it "should raise an exception receives malformed data" do
+  it "should raise an exception if it receives malformed data" do
     IO.stub(:popen) do |cmd, block|
       class F
         def initialize

data/spec/couchrest/rest_api_spec.rb

@@ -98,6 +98,27 @@ describe CouchRest::RestAPI do
         expect { CouchRest.get('foo') }.to raise_error(RestClient::Exception)
       end
 
+      context 'when decode_json_objects is true' do
+        class TestObject
+          def self.json_create(args)
+            new
+          end
+        end
+
+        before(:each) do
+          CouchRest.decode_json_objects = true
+        end
+
+        after(:each) do
+          CouchRest.decode_json_objects = false
+        end
+
+        it 'should return the response as a Ruby object' do
+          CouchRest.put "#{COUCHHOST}/#{TESTDB}/test", JSON.create_id => TestObject.to_s
+
+          CouchRest.get("#{COUCHHOST}/#{TESTDB}/test").class.should eql(TestObject)
+        end
+      end
     end
 
     describe :post do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchrest
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000 Z
+date: 2013-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -68,17 +68,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
 description: CouchRest provides a simple interface on top of CouchDB's RESTful HTTP
   API, as well as including some utility scripts for managing views and attachments.
 email: jchris@apache.org
@@ -106,6 +138,7 @@ extra_rdoc_files:
 - THANKS.md
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -175,6 +208,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1010445868410705054
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -183,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Lean and RESTful interface to CouchDB.