analysand 1.0.1

data/spec/analysand/instance_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+require 'analysand/errors'
+require 'analysand/instance'
+require 'uri'
+require 'vcr'
+
+require File.expand_path('../a_session_grantor', __FILE__)
+
+module Analysand
+  describe Instance do
+    describe '#initialize' do
+      it 'requires an absolute URI' do
+        lambda { Instance.new(URI("/abc")) }.should raise_error(InvalidURIError)
+      end
+    end
+
+    let(:instance) { Instance.new(instance_uri) }
+
+    describe '#establish_session' do
+      describe 'given admin credentials' do
+        let(:credentials) { admin_credentials }
+
+        it_should_behave_like 'a session grantor'
+      end
+
+      describe 'given member credentials' do
+        let(:credentials) { member1_credentials }
+
+        it_should_behave_like 'a session grantor'
+      end
+
+      describe 'given incorrect credentials' do
+        it 'returns [nil, response]' do
+          session, resp = instance.establish_session('wrong', 'wrong')
+
+          session.should be_nil
+          resp.code.should == '401'
+        end
+      end
+    end
+
+    describe '#renew_session' do
+      let(:credentials) { admin_credentials }
+
+      before do
+        @session, _ = instance.establish_session(credentials[:username], credentials[:password])
+      end
+
+      describe 'if CouchDB refreshes the session cookie' do
+        around do |example|
+          VCR.use_cassette('get_session_refreshes_cookie') { example.call }
+        end
+
+        it_should_behave_like 'a session grantor' do
+          let(:result) { instance.renew_session(@session) }
+          let(:role_locator) do
+            lambda { |resp| resp['userCtx']['roles'] }
+          end
+        end
+      end
+
+      describe 'if CouchDB does not refresh the session cookie' do
+        around do |example|
+          VCR.use_cassette('get_session_does_not_refresh_cookie') { example.call }
+        end
+
+        it_should_behave_like 'a session grantor' do
+          let(:result) { instance.renew_session(@session) }
+          let(:role_locator) do
+            lambda { |resp| resp['userCtx']['roles'] }
+          end
+        end
+      end
+
+      describe 'given an invalid session' do
+        it 'returns [nil, response]' do
+          session, resp = instance.renew_session({ :token => 'AuthSession=wrong' })
+
+          session.should be_nil
+          resp.code.should == '400'
+        end
+      end
+    end
+  end
+end

data/spec/analysand/response_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+require 'analysand/database'
+require 'analysand/response'
+
+module Analysand
+  describe Response do
+    let(:db) { Database.new(database_uri) }
+
+    describe '#etag' do
+      let(:response) do
+        VCR.use_cassette('head_request_with_etag') do
+          db.head('abc123', admin_credentials)
+        end
+      end
+
+      it 'removes quotes from ETags' do
+        response.etag.should == '1-967a00dff5e02add41819138abb3284d'
+      end
+    end
+  end
+end

data/spec/analysand/view_response_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+require 'analysand/view_response'
+
+module Analysand
+  describe ViewResponse do
+    describe '#docs' do
+      let(:resp_with_docs) do
+        '{"rows": [{"id":"foo","key":"foo","value":{},"doc":{"foo":"bar"}}]}'
+      end
+
+      let(:resp_without_docs) do
+        '{"rows": [{"id":"foo","key":"foo","value":{}}]}'
+      end
+
+      describe 'if the view includes docs' do
+        subject { ViewResponse.new(stub(:body => resp_with_docs)) }
+
+        it 'returns the value of the "doc" key in each row' do
+          subject.docs.should == [{'foo' => 'bar'}]
+        end
+      end
+
+      describe 'if the view does not include docs' do
+        subject { ViewResponse.new(stub(:body => resp_without_docs)) }
+
+        it 'returns []' do
+          subject.docs.should == []
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/get_session_does_not_refresh_cookie.yml

@@ -0,0 +1,73 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:5984/_session
+    body:
+      string: name=admin&password=admin
+    headers:
+      Connection:
+      - keep-alive
+      Accept:
+      - "*/*"
+      Keep-Alive:
+      - 30
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 31 Mar 2012 22:35:18 GMT
+      Set-Cookie:
+      - AuthSession=YWRtaW46NEY3Nzg2QTY6WVqDNxuHpu4OPp07rib-n9WQLt8; Version=1; Path=/; HttpOnly
+      Server:
+      - CouchDB/1.3.0a-d0a5bf0-git (Erlang OTP/R14B02)
+      Content-Length:
+      - "56"
+      Content-Type:
+      - text/plain; charset=utf-8
+      Cache-Control:
+      - must-revalidate
+    body:
+      string: |
+        {"ok":true,"name":null,"roles":["_admin","site_admin"]}
+  recorded_at: Sat, 31 Mar 2012 22:35:18 GMT
+- request:
+    method: get
+    uri: http://localhost:5984/_session
+    headers:
+      Cookie:
+      - AuthSession=YWRtaW46NEY3Nzg2QTY6WVqDNxuHpu4OPp07rib-n9WQLt8; Version=1; Path=/; HttpOnly
+      Connection:
+      - keep-alive
+      Accept:
+      - "*/*"
+      Keep-Alive:
+      - 30
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 31 Mar 2012 22:35:18 GMT
+      Server:
+      - CouchDB/1.3.0a-d0a5bf0-git (Erlang OTP/R14B02)
+      Content-Length:
+      - "56"
+      Content-Type:
+      - text/plain; charset=utf-8
+      Cache-Control:
+      - must-revalidate
+    body:
+      string: |
+        {"ok":true,"userCtx":{"name":null,"roles":["_admin","site_admin"]},"info":{"authentication_db":"_users","authentication_handlers":["oauth","cookie","default"]}}
+
+    http_version:
+  recorded_at: Sat, 31 Mar 2012 22:35:18 GMT
+recorded_with: VCR 2.0.1

data/spec/fixtures/vcr_cassettes/get_session_refreshes_cookie.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:5984/_session
+    body:
+      string: name=admin&password=admin
+    headers:
+      Connection:
+      - keep-alive
+      Accept:
+      - "*/*"
+      Keep-Alive:
+      - 30
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 31 Mar 2012 22:35:18 GMT
+      Set-Cookie:
+      - AuthSession=YWRtaW46NEY3Nzg2QTY6WVqDNxuHpu4OPp07rib-n9WQLt8; Version=1; Path=/; HttpOnly
+      Server:
+      - CouchDB/1.3.0a-d0a5bf0-git (Erlang OTP/R14B02)
+      Content-Length:
+      - "56"
+      Content-Type:
+      - text/plain; charset=utf-8
+      Cache-Control:
+      - must-revalidate
+    body:
+      string: |
+        {"ok":true,"name":null,"roles":["_admin","site_admin"]}
+  recorded_at: Sat, 31 Mar 2012 22:35:18 GMT
+- request:
+    method: get
+    uri: http://localhost:5984/_session
+    headers:
+      Cookie:
+      - AuthSession=YWRtaW46NEY3Nzg2QTY6WVqDNxuHpu4OPp07rib-n9WQLt8; Version=1; Path=/; HttpOnly
+      Connection:
+      - keep-alive
+      Accept:
+      - "*/*"
+      Keep-Alive:
+      - 30
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 31 Mar 2012 22:35:18 GMT
+      Set-Cookie:
+      - AuthSession=YWRtaW46NEY3Nzg3RTk6Lj1LSc4dWHBMZoFKm9ZMxq0L3Ec; Version=1; Path=/; HttpOnly
+      Server:
+      - CouchDB/1.3.0a-d0a5bf0-git (Erlang OTP/R14B02)
+      Content-Length:
+      - "56"
+      Content-Type:
+      - text/plain; charset=utf-8
+      Cache-Control:
+      - must-revalidate
+    body:
+      string: |
+        {"ok":true,"userCtx":{"name":null,"roles":["_admin","site_admin"]},"info":{"authentication_db":"_users","authentication_handlers":["oauth","cookie","default"]}}
+
+    http_version:
+  recorded_at: Sat, 31 Mar 2012 22:35:18 GMT
+recorded_with: VCR 2.0.1

data/spec/fixtures/vcr_cassettes/head_request_with_etag.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: head
+    uri: http://admin:admin@localhost:5984/analysand_test/abc123
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - 30
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - CouchDB/1.3.0a-d6ab08d-git (Erlang OTP/R15B)
+      Etag:
+      - ! '"1-967a00dff5e02add41819138abb3284d"'
+      Date:
+      - Tue, 22 May 2012 14:21:26 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Content-Length:
+      - '61'
+      Cache-Control:
+      - must-revalidate
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Tue, 22 May 2012 14:21:26 GMT
+recorded_with: VCR 2.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$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/test_parameters', __FILE__)
+
+require 'vcr'
+
+RSpec.configure do |config|
+  config.include DatabaseAccess
+  config.include ExampleIsolation
+  config.include TestParameters
+end
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end

data/spec/support/database_access.rb

@@ -0,0 +1,40 @@
+require 'net/http'
+
+module DatabaseAccess
+  ##
+  # Sets members and admins for the database.
+  #
+  # Assumes #admin_credentials returns a Hash containing the keys :username and
+  # :password, where those keys' values are the username and password of a
+  # CouchDB admin user.
+  def set_security(members, admins = {})
+    doc = {
+      'members' => members,
+      'admins' => admins
+    }
+
+    credentials = admin_credentials
+    uri = instance_uri
+
+    Net::HTTP.start(uri.host, uri.port) do |h|
+      req = Net::HTTP::Put.new("/#{database_name}/_security")
+      req.basic_auth(credentials[:username], credentials[:password])
+      req.body = doc.to_json
+
+      resp = h.request(req)
+
+      unless Net::HTTPSuccess === resp
+        raise "Unable to set security parameters on #{database_name}: response code = #{resp.code}, body = #{resp.body}"
+      end
+    end
+  end
+
+  ##
+  # Resets member and admin lists for the test database to [].
+  def clear_security
+    set_security({ 'users' => [], 'roles' => [] },
+                 { 'users' => [], 'roles' => [] })
+  end
+end
+
+# vim:ts=2:sw=2:et:tw=78

data/spec/support/example_isolation.rb

@@ -0,0 +1,86 @@
+require File.expand_path('../test_parameters', __FILE__)
+
+##
+# CouchDB doesn't implement a commit/rollback scheme like other databases, but
+# it would nevertheless still sometimes be nice to be able to isolate
+# datastore changes made between tests.
+#
+# This module provides methods to drop and create databases, which provides a
+# slow-yet-effective way of achieving said isolation.  Examples:
+#
+#     describe Something do
+#       let(:database_uri) { 'http://localhost:5984' }
+#       let(:database_name) { 'something' }
+#
+#       before do
+#         clean_databases!
+#       end
+#     end
+#
+#     describe AnotherThing do
+#       let(:database_uri) { 'http://localhost:5984' }
+#       let(:database_names) { ['another', 'database'] }
+#
+#       before do
+#         clean_databases!
+#       end
+#     end
+#
+# If both database_name and database_names are specified in the same example
+# group, the latter will have precedence.
+#
+#
+# Clean databases come with a performance cost
+# ============================================
+#
+# Dropping and creating databases has a real performance cost, so it is
+# advised that you only use this when absolutely necessary.  Databases are
+# only cleaned when
+#
+#     clean_databases!
+#
+# is included in an example group's before block.
+module ExampleIsolation
+  def clean_databases!
+    drop_databases!
+    create_databases!
+  end
+
+  def drop_databases!
+    affected_databases.each do |db|
+      uri = instance_uri + "/#{db}"
+      credentials = admin_credentials
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        req = Net::HTTP::Delete.new(uri.path)
+        req.basic_auth(admin_username, admin_password)
+
+        http.request(req)
+      end
+    end
+  end
+
+  def create_databases!
+    affected_databases.each do |db|
+      uri = instance_uri + "/#{db}"
+      credentials = admin_credentials
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        req = Net::HTTP::Put.new(uri.path)
+        req.basic_auth(admin_username, admin_password)
+
+        http.request(req)
+      end
+    end
+  end
+
+  def affected_databases
+    if respond_to?(:database_name)
+      [database_name]
+    elsif respond_to?(:database_names)
+      database_names
+    end.flatten
+  end
+end
+
+# vim:ts=2:sw=2:et:tw=78