couchrest 2.0.0.rc2 → 2.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e11ffbb5106aa947148918e8df2dca90b71e7760
-  data.tar.gz: 5cb76649c5af7b0b7be771a1238b9d4d2a9c4748
+  metadata.gz: 47b17f1a8431dbf297df05649b3e3ef50da87ec5
+  data.tar.gz: d6c33fc6dfd9651d3cafb18d75a91a363542026f
 SHA512:
-  metadata.gz: 82bd9c1a4249d4ada2e838462b8bd1a56b02b709262aa3906da17bba1e2e0f142a4daebfe7ae9dff11f85782bbd8dac4cfac0953a72204c40b931993e3fcd312
-  data.tar.gz: cc004a48286023ccf7c68ba48f4c5380729391c62ef160860b94a262295b43b8d400ccc92b983d6f734bb5dfc71c86fbff142a947748c734945cf6a0b21f046c
+  metadata.gz: c690201c7ca0cde422405fc26e1399e18d0b98c435cfb6ca37e38fb2dd194351f06188930ebe805fd7201fb5f089dbde9df1fea1f12913c8ecf0be8f602ef4c9
+  data.tar.gz: 0d012252eb5d4a89302d2f069d76b855763aba3e65d6a17dbfe6f78b2d129ff381211ed96d08250ae6bef6edea8224983a03245db5bf06b0851af8a777bb5d35

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+  - 2.3.0
   - 2.2.0
   - 2.1.0
   - 2.0.0
@@ -6,3 +7,5 @@ rvm:
   - jruby
   - rbx
 services: couchdb
+before_install:
+  - gem install bundler

data/VERSION

@@ -1 +1 @@
-2.0.0.rc2
+2.0.0.rc3

data/couchrest.gemspec

@@ -27,11 +27,12 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Lean and RESTful interface to CouchDB.}
 
-  s.add_dependency("httpclient", ["~> 2.6.0"])
+  s.add_dependency("httpclient", ["~> 2.7"])
   s.add_dependency("mime-types", [">= 1.15"])
   s.add_dependency("multi_json", ["~> 1.7"])
   s.add_development_dependency("json", [">= 1.7.0"])
   s.add_development_dependency("rspec", "~> 2.14.1")
   s.add_development_dependency("rake")
   s.add_development_dependency("webmock")
+  s.add_development_dependency("mime-types", "2.6.2") # Avoid Errors with 3.0 series
 end

data/examples/word_count/word_count_query.rb

@@ -6,7 +6,7 @@ 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 "this will take a few minutes the first time. if it times out, just rerun this script in a 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:"
@@ -37,4 +37,4 @@ 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..."
+puts "\nTry dropping that in your browser..."

data/history.txt

@@ -1,4 +1,15 @@
-== 2.0.0.rc2
+== 2.0.0.rc3
+
+* Major Changes
+  * At the risk of causing chaos, `Database#get` now returns nil for 404 (@samlown)
+
+* Minor changes
+  * Updating HTTPClient dependency to > 2.7 for Ruby 2.3 support. (@samlown)
+  * Added `:ssl_ca_file` configuration option (@joelnb)
+  * Return headers content for HEAD requests (@solenko)
+  * Changing to options hash for bulk_save (@samlown via @matthiasjakel)
+
+== 2.0.0.rc2 - 2015-08-18
 
 * Minor changes
   * Forcing HTTP basic connections when user+pass provided to avoid 401 (@samlown via @cloudant)

data/lib/couchrest/connection.rb

@@ -25,7 +25,9 @@ module CouchRest
   #  * `:payload` override the document or data sent in the message body (only PUT or POST).
   #  * `:headers` any additional headers (overrides :content_type and :accept)
   #  * `:timeout` (or `:read_timeout`) and `:open_timeout` the time in miliseconds to wait for the request, see the [Net HTTP Persistent documentation](http://docs.seattlerb.org/net-http-persistent/Net/HTTP/Persistent.html#attribute-i-read_timeout) for more details.
-  # * `:verify_ssl`, `:ssl_client_cert`, `:ssl_client_key`, and `:ssl_ca_file`, SSL handling methods.
+  #  * `:verify_ssl` verify ssl certificates (or not)
+  #  * `:ssl_client_cert`, `:ssl_client_key` parameters controlling ssl client certificate authentication
+  #  * `:ssl_ca_file` load additional CA certificates from a file (or directory)
   #
   # 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
@@ -38,7 +40,7 @@ module CouchRest
 
     HEADER_CONTENT_SYMBOL_MAP = {
       :content_type => 'Content-Type',
-      :accept       => 'Accept' 
+      :accept       => 'Accept'
     }
 
     DEFAULT_HEADERS = {
@@ -90,7 +92,7 @@ module CouchRest
 
     # Send a HEAD request.
     def head(path, options = {})
-      options = options.merge(:raw => true) # No parsing!
+      options = options.merge(:head => true) # No parsing!
       execute('HEAD', path, options)
     end
 
@@ -122,6 +124,7 @@ module CouchRest
       end
       http.ssl_config.client_cert = opts[:ssl_client_cert] if opts.include?(:ssl_client_cert)
       http.ssl_config.client_key  = opts[:ssl_client_key]  if opts.include?(:ssl_client_key)
+      http.ssl_config.set_trust_ca(opts[:ssl_ca_file]) if opts.include?(:ssl_ca_file)
 
       # Timeout options
       http.receive_timeout = opts[:timeout] if opts.include?(:timeout)
@@ -164,7 +167,7 @@ module CouchRest
       else
         response = send_request(req)
         handle_response_code(response)
-        parse_body(response.body, options)
+        parse_response(response, options)
       end
     end
 
@@ -177,6 +180,14 @@ module CouchRest
       raise_response_error(response) unless SUCCESS_RESPONSE_CODES.include?(response.status)
     end
 
+    def parse_response(response, opts)
+      if opts[:head]
+        opts[:raw] ? response.http_header.dump : response.headers
+      else
+        parse_body(response.body, opts)
+      end
+    end
+
     def parse_body(body, opts)
       if opts[:raw]
         # passthru

data/lib/couchrest/database.rb

@@ -90,8 +90,9 @@ module CouchRest
 
     # == Retrieving and saving single documents
 
-    # GET a document from CouchDB, by id. Returns a Document or Design.
-    def get(id, params = {})
+    # GET a document from CouchDB, by id. Returns a Document, Design, or raises an exception
+    # if the document does not exist.
+    def get!(id, params = {})
       slug = escape_docid(id)
       url = CouchRest.paramify_url("#{path}/#{slug}", params)
       result = connection.get(url)
@@ -105,6 +106,14 @@ module CouchRest
       doc
     end
 
+    # GET the requested document by ID like `get!`, but returns nil if the document
+    # does not exist.
+    def get(*args)
+      get!(*args)
+    rescue CouchRest::NotFound
+      nil
+    end
+
     # Save a document to CouchDB. This will use the <tt>_id</tt> field from
     # the document as the id for PUT, or request a new UUID from CouchDB, if
     # no <tt>_id</tt> is present on the document. IDs are attached to
@@ -175,12 +184,13 @@ module CouchRest
     # missing ids, supply one from the uuid cache.
     #
     # If called with no arguments, bulk saves the cache of documents to be bulk saved.
-    def bulk_save(docs = nil, use_uuids = true, all_or_nothing = false)
+    def bulk_save(docs = nil, opts = {})
+      opts = { :use_uuids => true, :all_or_nothing => false }.update(opts)
       if docs.nil?
         docs = @bulk_save_cache
         @bulk_save_cache = []
       end
-      if (use_uuids) 
+      if opts[:use_uuids]
         ids, noids = docs.partition{|d|d['_id']}
         uuid_count = [noids.length, @server.uuid_batch_count].max
         noids.each do |doc|
@@ -189,7 +199,7 @@ module CouchRest
         end
       end
       request_body = {:docs => docs}
-      if all_or_nothing
+      if opts[:all_or_nothing]
         request_body[:all_or_nothing] = true
       end
       connection.post "#{path}/_bulk_docs", request_body

data/spec/couchrest/connection_spec.rb

@@ -64,22 +64,26 @@ describe CouchRest::Connection do
       conn = CouchRest::Connection.new(URI "http://user:pass@mock")
       expect(conn.http.www_auth.basic_auth.set?).to be_true
     end
-    
+
     describe "with SSL options" do
+
       it "should leave the default if nothing set" do
         default = HTTPClient.new.ssl_config.verify_mode
         conn = CouchRest::Connection.new(URI "https://localhost:5984")
         expect(conn.http.ssl_config.verify_mode).to eql(default)
       end
+
       it "should support disabling SSL verify mode" do
         conn = CouchRest::Connection.new(URI("https://localhost:5984"), :verify_ssl => false)
         expect(conn.http.ssl_config.verify_mode).to eql(OpenSSL::SSL::VERIFY_NONE)
       end
+
       it "should support enabling SSL verify mode" do
         conn = CouchRest::Connection.new(URI("https://localhost:5984"), :verify_ssl => true)
         expect(conn.http.ssl_config.verify_mode).to eql(OpenSSL::SSL::VERIFY_PEER)
       end
-      it "should support setting specific cert, key, and ca" do
+
+      it "should support setting specific client cert & key" do
         conn = CouchRest::Connection.new(URI("https://localhost:5984"),
           :ssl_client_cert => 'cert',
           :ssl_client_key  => 'key',
@@ -88,6 +92,42 @@ describe CouchRest::Connection do
         expect(conn.http.ssl_config.client_key).to eql('key')
       end
 
+      it "should support adding the ca to trust from a file" do
+        file = Tempfile.new(['server', '.pem'])
+        File.write(file.path, "-----BEGIN CERTIFICATE-----
+          MIIDrTCCAxagAwIBAgIBADANBgkqhkiG9w0BAQQFADCBnDEbMBkGA1UEChMSVGhl
+          IFNhbXBsZSBDb21wYW55MRQwEgYDVQQLEwtDQSBEaXZpc2lvbjEcMBoGCSqGSIb3
+          DQEJARYNY2FAc2FtcGxlLmNvbTETMBEGA1UEBxMKTWV0cm9wb2xpczERMA8GA1UE
+          CBMITmV3IFlvcmsxCzAJBgNVBAYTAlVTMRQwEgYDVQQDEwtUU0MgUm9vdCBDQTAe
+          Fw0wMTEyMDgwNDI3MDVaFw0wMjEyMDgwNDI3MDVaMIGcMRswGQYDVQQKExJUaGUg
+          U2FtcGxlIENvbXBhbnkxFDASBgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcN
+          AQkBFg1jYUBzYW1wbGUuY29tMRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQI
+          EwhOZXcgWW9yazELMAkGA1UEBhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBMIGf
+          MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDaiAwfKB6ZBtnTRTIo6ddomt0S9ec0
+          NcuvtJogt0s9dXpHowh98FCDjnLtCi8du6LDTZluhlOtTFARPlV/LVnpsbyMCXMs
+          G2qpdjJop+XIBdvoCz2HpGXjUmym8WLqt+coWwJqUSwiEba74JG93v7TU+Xcvc00
+          5MWnxmKZzD/R3QIDAQABo4H8MIH5MAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFG/v
+          yytrBtEquMX2dreysix/MlPMMIHJBgNVHSMEgcEwgb6AFG/vyytrBtEquMX2drey
+          six/MlPMoYGipIGfMIGcMRswGQYDVQQKExJUaGUgU2FtcGxlIENvbXBhbnkxFDAS
+          BgNVBAsTC0NBIERpdmlzaW9uMRwwGgYJKoZIhvcNAQkBFg1jYUBzYW1wbGUuY29t
+          MRMwEQYDVQQHEwpNZXRyb3BvbGlzMREwDwYDVQQIEwhOZXcgWW9yazELMAkGA1UE
+          BhMCVVMxFDASBgNVBAMTC1RTQyBSb290IENBggEAMA0GCSqGSIb3DQEBBAUAA4GB
+          ABclymJfsPOUazNQO8aIaxwVbXWS+8AFEkMMRx6O68ICAMubQBvs8Buz3ALXhqYe
+          FS5G13pW2ZnAlSdTkSTKkE5wGZ1RYSfyiEKXb+uOKhDN9LnajDzaMPkNDU2NDXDz
+          SqHk9ZiE1boQaMzjNLu+KabTLpmL9uXvFA/i+gdenFHv
+          -----END CERTIFICATE-----".gsub(/^\s+/, ''))
+        conn = CouchRest::Connection.new(URI("https://localhost:5984"),
+          :ssl_ca_file => file.path
+        )
+        conn.http.ssl_config.cert_store_items.should include(file.path)
+      end
+
+      it "should support adding multiple ca certificates from a directory" do
+        conn = CouchRest::Connection.new(URI("https://localhost:5984"),
+          :ssl_ca_file => '.'
+        )
+        conn.http.ssl_config.cert_store_items.should include('.')
+      end
     end
 
     describe "with timeout options" do
@@ -417,6 +457,26 @@ describe CouchRest::Connection do
           .to_return(:body => "")
         expect { mock_conn.head('db/test-head') }.to_not raise_error
       end
+      it "should returns headers hash" do
+        response_headers = { "Etag" => "document-version-number" }
+        stub_request(:head, "http://mock/db/test-head")
+        .to_return(
+            :body => "",
+            :headers => response_headers
+        )
+        expect(mock_conn.head('db/test-head')).to eq(response_headers)
+      end
+
+      it "should returns raw headers if opts[:raw] true" do
+        response_headers = { "Etag" => "document-version-number" }
+        stub_request(:head, "http://mock/db/test-head")
+        .to_return(
+            :body => "",
+            :headers => response_headers
+        )
+        expect(mock_conn.head('db/test-head', {raw: true})).to include("Etag: document-version-number" )
+      end
+
       it "should handle head request when document missing" do
         stub_request(:head, "http://mock/db/test-missing-head")
           .to_return(:status => 404)

data/spec/couchrest/database_spec.rb

@@ -233,6 +233,17 @@ describe CouchRest::Database do
       expect(@db.get(@docid)['will-exist']).to eq 'here'
     end
   end
+
+  describe "GET (document by id) when the doc does not exist)" do
+   it "should provide nil" do
+      expect(@db.get('fooooobar')).to be_nil
+    end
+    it "should raise an exception" do
+      expect do
+        @db.get!('fooooobar')
+      end.to raise_error(CouchRest::NotFound)
+    end
+  end
   
   describe "POST (adding bulk documents)" do
     it "should add them without ids" do
@@ -256,6 +267,13 @@ describe CouchRest::Database do
       
       @db.bulk_save(docs)
     end
+
+    it "should allow UUID assignment to be disabled" do
+      expect(@db.connection).to_not receive(:next_uuid)
+      docs = [{'key' => 'value'}, {'_id' => 'totally-uniq'}]
+      expect(@db.connection).to receive(:post).with("/couchrest-test/_bulk_docs", {:docs => docs})
+      @db.bulk_save(docs, :use_uuids => false)
+    end
     
     it "should add them with uniq ids" do
       rs = @db.bulk_save([
@@ -270,9 +288,7 @@ describe CouchRest::Database do
 
     it "should empty the bulk save cache if no documents are given" do
       @db.save_doc({"_id" => "bulk_cache_1", "val" => "test"}, true)
-      expect do
-        @db.get('bulk_cache_1')
-      end.to raise_error(CouchRest::NotFound)
+      expect(@db.get('bulk_cache_1')).to be_nil
       @db.bulk_save
       expect(@db.get("bulk_cache_1")["val"]).to eq "test"
     end
@@ -281,7 +297,7 @@ describe CouchRest::Database do
       docs = [{"_id" => "oneB", "wild" => "and random"}, {"_id" => "twoB", "mild" => "yet local"}]
       expect(@db.connection).to receive(:post).with("/couchrest-test/_bulk_docs", {:all_or_nothing => true, :docs => docs})
       
-      @db.bulk_save(docs, false, true)
+      @db.bulk_save(docs, :all_or_nothing => true)
     end
 
     it "should raise an error that is useful for recovery" do
@@ -577,12 +593,8 @@ describe CouchRest::Database do
       td2 = {"_id" => "td2", "val" => 4}
       @db.save_doc(td1, true)
       @db.save_doc(td2, true)
-      expect do
-        @db.get(td1["_id"])
-      end.to raise_error(CouchRest::NotFound)
-      expect do
-        @db.get(td2["_id"])
-      end.to raise_error(CouchRest::NotFound)
+      expect(@db.get(td1["_id"])).to be_nil
+      expect(@db.get(td2["_id"])).to be_nil
       td3 = {"_id" => "td3", "val" => "foo"}
       @db.save_doc(td3, true)
       expect(@db.get(td1["_id"])["val"]).to eq td1["val"]
@@ -595,9 +607,7 @@ describe CouchRest::Database do
       td2 = {"_id" => "steve", "val" => 3}
       @db.bulk_save_cache_limit = 50
       @db.save_doc(td1, true)
-      expect do
-        @db.get(td1["_id"])
-      end.to raise_error(CouchRest::NotFound)
+      expect(@db.get(td1["_id"])).to be_nil
       @db.save_doc(td2)
       expect(@db.get(td1["_id"])["val"]).to eq td1["val"]
       expect(@db.get(td2["_id"])["val"]).to eq td2["val"]
@@ -614,12 +624,12 @@ describe CouchRest::Database do
       doc = @db.get(@r['id'])
       expect(doc['and']).to eq 'spain'
       @db.delete_doc doc
-      expect(lambda{@db.get @r['id']}).to raise_error
+      expect(@db.get(@r['id'])).to be_nil 
     end
     it "should work with uri id" do
       doc = @db.get(@docid)
       @db.delete_doc doc
-      expect(lambda{@db.get @docid}).to raise_error
+      expect(@db.get @docid).to be_nil
     end
     it "should fail without an _id" do
       expect(lambda{@db.delete_doc({"not"=>"a real doc"})}).to raise_error(ArgumentError)
@@ -627,9 +637,9 @@ describe CouchRest::Database do
     it "should defer actual deletion when using bulk save" do
       doc = @db.get(@docid)
       @db.delete_doc doc, true
-      expect(lambda{@db.get @docid}).not_to raise_error
+      expect(@db.get @docid).to_not be_nil
       @db.bulk_save
-      expect(lambda{@db.get @docid}).to raise_error
+      expect(@db.get @docid).to be_nil
     end
     
   end

data/spec/couchrest/document_spec.rb

@@ -227,7 +227,7 @@ describe CouchRest::Document do
       doc = CouchRest::Document.new({"_id" => "bulkdoc", "val" => 3})
       doc.database = @db
       doc.save(true)
-      expect(lambda { doc.database.get(doc["_id"]) }).to raise_error(CouchRest::NotFound)
+      expect(doc.database.get(doc["_id"])).to be_nil
       doc.database.bulk_save
       expect(doc.database.get(doc["_id"])["val"]).to eql doc["val"]
     end
@@ -267,7 +267,7 @@ describe CouchRest::Document do
     end
     it "should make it disappear" do
       @doc.destroy
-      expect(lambda{@db.get @resp['id']}).to raise_error
+      expect(@db.get @resp['id']).to be_nil
     end
     it "should error when there's no db" do
       @doc = CouchRest::Document.new("key" => [1,2,3], :more => "values")    
@@ -288,9 +288,9 @@ describe CouchRest::Document do
       @doc.destroy(true)
       expect(@doc['_id']).to be_nil
       expect(@doc['_rev']).to be_nil
-      expect(lambda{@db.get @resp['id']}).not_to raise_error
+      expect(@db.get @resp['id']).to_not be_nil
       @db.bulk_save
-      expect(lambda{@db.get @resp['id']}).to raise_error
+      expect(@db.get @resp['id']).to be_nil
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchrest
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0.rc3
 platform: ruby
 authors:
 - J. Chris Anderson
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -20,14 +20,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +112,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
 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
@@ -206,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Lean and RESTful interface to CouchDB.