analysand 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8530353cf2a187253a38f68e81c92c4db6269f1b
-  data.tar.gz: 2805780572de1e5df3581a7720e76591af57e9cd
+  metadata.gz: eca0af883835f83b39acdbea7d71f0d4104ceee7
+  data.tar.gz: 999a46fa6aea95401a270f499acfd809a19f1748
 SHA512:
-  metadata.gz: 7e983135f366396eb9767c9af43b656d81f5d3002512fc7069567af881ce18595f6209a228c3b1674ea36ee8562f6952f5a766c153d809373c7d56eb73a41d60
-  data.tar.gz: 81d3c799ce2eda121427df8678d0a81ad3474e333633cd20772e91aa2c23e9784826312b6b67903c02250016e2b164110616ab920613eaf8fea7f13b4b59ddc1
+  metadata.gz: e9b9fd4d5b3652bbc976d17b00b9980b265d4b51896495a60a76cfd89305e23781605a8000ff2e9922683c789e196aee3091e260526045d6561580ce132db50d
+  data.tar.gz: abac9b899a43da636747aae1edd7b2d1f0453d574786a7c2ee839d788d22825a3e693a667490f2391af783221be53f48950ef420cfc699139da77bebcc2f9059

data/.travis.yml

@@ -1,7 +1,14 @@
 language: ruby
 rvm:
-  - rbx-2.4.1
-  - 2.0.0
+  - rbx-2.5.1
+  - 2.2.0
+env:
+  - RBXOPT=-Xint
+  - RBXOPT=
+matrix:
+  exclude:
+    - rvm: 2.2.0
+      env: RBXOPT=-Xint
 before_script:
   - "./script/setup_database.rb"
 services:

data/CHANGELOG

@@ -1,6 +1,15 @@
 Issue numbers refer to issues on Analysand's Github tracker:
 https://github.com/yipdw/analysand/issues
 
+4.0.0 (2015-02-03)
+------------------
+
+Breaking changes:
+
+Analysand::Database methods no longer perform any escaping on document IDs.
+You will have to modify your code to use CGI.escape, Rack::Utils::escape_path,
+etc. when passing in document IDs.  (#7)
+
 3.1.0 (2015-02-03)
 ------------------
 

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 platform :rbx do
   gem 'rubysl'
+  gem 'psych'
 end

data/README

@@ -31,11 +31,10 @@ of specific admin and non-admin users for its test suite.
 See spec/support/test_parameters.rb for usernames, passwords, and connection
 information.
 
-Naturally, we hang with all the cool kids:
+Elsewhere on the Web:
 
 * Travis CI: https://travis-ci.org/#!/yipdw/analysand
 * Code Climate: https://codeclimate.com/github/yipdw/analysand
-* Gemnasium: https://gemnasium.com/yipdw/analysand
 
 4. License
 

data/lib/analysand/database.rb

@@ -229,6 +229,9 @@ module Analysand
   #
   #     vdb.copy('source', "destination?rev=#{rev}", credentials)
   #
+  # NOTE: CouchDB 1.5.0 and 1.6.1 expect an _unescaped_ destination document
+  # ID.
+  #
   #
   # Acceptable credentials
   # ======================

data/lib/analysand/http.rb

@@ -59,7 +59,7 @@ module Analysand
     # @private
     def _req(klass, doc_id, credentials, query, headers, body, block)
       uri = self.uri.dup
-      uri.path += URI.escape(doc_id)
+      uri.path += doc_id
       uri.query = build_query(query) unless query.empty?
 
       req = klass.new(uri.request_uri)

data/lib/analysand/version.rb

@@ -1,3 +1,3 @@
 module Analysand
-  VERSION = "3.1.0"
+  VERSION = "4.0.0"
 end

data/spec/analysand/database_spec.rb

@@ -69,6 +69,15 @@ module Analysand
       end
     end
 
+    describe '#get' do
+      it 'retrieves documents with URI-escaped IDs' do
+        doc_id = CGI.escape('10067--http://ark.cdlib.org/ark:/13030/kt067nc38g')
+        net_http_put!(db, doc_id, { 'foo' => 'bar' })
+
+        db.get(doc_id).body['foo'].should == 'bar'
+      end
+    end
+
     describe '#get!' do
       before do
         clean_databases!
@@ -76,6 +85,13 @@ module Analysand
         db.put!('foo', { 'foo' => 'bar' })
       end
 
+      it 'retrieves documents with URI-escaped IDs' do
+        doc_id = CGI.escape('10067--http://ark.cdlib.org/ark:/13030/kt067nc38g')
+        net_http_put!(db, doc_id, { 'foo' => 'bar' })
+
+        db.get!(doc_id).body['foo'].should == 'bar'
+      end
+
       describe 'if the response code is 200' do
         it 'returns the document' do
           db.get!('foo').body['foo'].should == 'bar'

data/spec/analysand/database_writing_spec.rb

@@ -75,10 +75,15 @@ module Analysand
         resp.should be_success
       end
 
-      it 'escapes document IDs' do
-        db.put('an ID', doc)
+      it 'does not double-escape document IDs' do
+        doc_id = CGI.escape('10067--http://ark.cdlib.org/ark:/13030/kt067nc38g')
+        put(doc_id, doc)
+
+        # Now we attempt to grab the escaped doc ID via good old HTTP.  If #put
+        # doesn't double-escape, this should not result in a 404.
+        resp = net_http_get(db, doc_id)
 
-        db.get('an ID').should be_success
+        expect(resp.code.to_i).to eq(200)
       end
 
       it 'handles URN-like IDs' do
@@ -397,10 +402,13 @@ module Analysand
         db.get('bar')['foo'].should == 'bar'
       end
 
-      it 'escapes document IDs in URIs' do
-        db.copy(doc_id, 'an ID')
+      it 'copies documents with IDs that need to be escaped' do
+        target_doc_id = '10067--http://ark.cdlib.org/ark:/13030/kt067nc38g'
+
+        db.copy(doc_id, target_doc_id)
 
-        db.get('an ID')['foo'].should == 'bar'
+        resp = net_http_get(db, CGI.escape(target_doc_id))
+        expect(resp.code.to_i).to eq(200)
       end
     end
 
@@ -435,11 +443,17 @@ module Analysand
         resp.should be_success
       end
 
-      it 'escapes document IDs in URIs' do
-        @put_resp = db.put!('an ID', doc)
+      it 'deletes documents with IDs that need to be escaped' do
+        doc_id = CGI.escape('10067--http://ark.cdlib.org/ark:/13030/kt067nc38g')
+        resp = net_http_put!(db, doc_id, {})
+        rev = JSON.parse(resp.body)['rev']
 
-        resp = db.delete('an ID', rev)
-        resp.should be_success
+        resp = db.delete(doc_id, rev)
+
+        # DELETE normally returns 200, but a CouchDB server can also return 202
+        # if it is configured to operate in delayed commit mode.  This test
+        # accepts either as success.
+        expect(resp.code).to match(/\A20[02]\Z/)
       end
     end
 

data/spec/analysand/view_streaming_spec.rb

@@ -69,7 +69,7 @@ module Analysand
         expect(resp.keys.take(10).each { |k| k }).to eq(['abc123'] * 10)
       end
 
-      it 'returns rows as soon as possible' do
+      xit 'returns rows as soon as possible' do
         # first, make sure the view's built
         db.head('_design/doc/_view/a_view', admin_credentials)
 

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require File.expand_path('../support/database_access', __FILE__)
 require File.expand_path('../support/example_isolation', __FILE__)
+require File.expand_path('../support/net_http_access', __FILE__)
 require File.expand_path('../support/test_parameters', __FILE__)
 
 require 'celluloid/autostart'   # for ChangeWatcher specs
@@ -10,6 +11,7 @@ require 'vcr'
 RSpec.configure do |config|
   config.include DatabaseAccess
   config.include ExampleIsolation
+  config.include NetHttpAccess
   config.include TestParameters
 
   config.around do |example|

data/spec/support/net_http_access.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+##
+# Methods to do GET and PUT without any of the extra stuff in Analysand::Http
+# or Analysand::Response.
+module NetHttpAccess
+  def net_http_get(db, doc_id)
+    Net::HTTP.get_response(URI.join(db.uri, doc_id))
+  end
+
+  def net_http_put!(db, doc_id, doc)
+    uri = URI.join(db.uri, doc_id)
+    req = Net::HTTP::Put.new(uri)
+    req.body = doc.to_json
+
+    resp = Net::HTTP.start(uri.hostname, uri.port) do |http|
+      http.request(req)
+    end
+
+    resp.tap { |r| raise unless Net::HTTPSuccess === r }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analysand
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - David Yip
@@ -236,6 +236,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/database_access.rb
 - spec/support/example_isolation.rb
+- spec/support/net_http_access.rb
 - spec/support/test_parameters.rb
 homepage: https://github.com/yipdw/analysand
 licenses: []
@@ -280,4 +281,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/database_access.rb
 - spec/support/example_isolation.rb
+- spec/support/net_http_access.rb
 - spec/support/test_parameters.rb