analysand 1.1.0 → 2.0.0

data/lib/analysand/response.rb

@@ -1,3 +1,5 @@
+require 'analysand/response_headers'
+require 'analysand/status_code_predicates'
 require 'forwardable'
 require 'json/ext'
 
@@ -6,12 +8,14 @@ module Analysand
   # The response object is a wrapper around Net::HTTPResponse that provides a
   # few amenities:
   #
-  # 1. A #success? method.  It returns true if the response code is between
-  #    (200..299) and false otherwise.
-  # 2. Automatic JSON deserialization of all response bodies.
-  # 3. Delegates the [] property accessor to the body.
+  # 1. A #success? method, which checks if 200 <= response code <= 299.
+  # 2. A #conflict method, which checks if response code == 409.
+  # 3. Automatic JSON deserialization of all response bodies.
+  # 4. Delegates the [] property accessor to the body.
   class Response
     extend Forwardable
+    include ResponseHeaders
+    include StatusCodePredicates
 
     attr_reader :response
     attr_reader :body
@@ -25,20 +29,6 @@ module Analysand
         @body = JSON.parse(@response.body)
       end
     end
-
-    def etag
-      response.get_fields('ETag').first.gsub('"', '')
-    end
-
-    def success?
-      c = code.to_i
-
-      c >= 200 && c <= 299
-    end
-
-    def code
-      response.code
-    end
   end
 end
 

data/lib/analysand/response_headers.rb

@@ -0,0 +1,18 @@
+module Analysand
+  module ResponseHeaders
+    def etag
+      response.get_fields('ETag').first.gsub('"', '')
+    end
+
+    def cookies
+      response.get_fields('Set-Cookie')
+    end
+
+    def session_cookie
+      return unless (cs = cookies)
+
+      cs.detect { |c| c =~ /^(AuthSession=[^;]+)/i }
+      $1
+    end
+  end
+end

data/lib/analysand/session_response.rb

@@ -0,0 +1,16 @@
+require 'analysand/response'
+
+module Analysand
+  # Public: Wraps the response from GET /_session.
+  #
+  # GET /_session can be a bit surprising.  A 200 OK response from _session
+  # indicates that the session cookie was well-formed; it doesn't indicate that
+  # the session is _valid_.
+  #
+  # Hence, this class adds a #valid? predicate.
+  class SessionResponse < Response
+    def valid?
+      (uc = body['userCtx']) && uc['name']
+    end
+  end
+end

data/lib/analysand/status_code_predicates.rb

@@ -0,0 +1,17 @@
+module Analysand
+  module StatusCodePredicates
+    def code
+      response.code
+    end
+
+    def success?
+      c = code.to_i
+
+      c >= 200 && c <= 299
+    end
+
+    def conflict?
+      code.to_i == 409
+    end
+  end
+end

data/lib/analysand/streaming_view_response.rb

@@ -1,3 +1,5 @@
+require 'analysand/response_headers'
+require 'analysand/status_code_predicates'
 require 'analysand/view_streaming/builder'
 require 'fiber'
 
@@ -16,12 +18,14 @@ module Analysand
   #     resp.rows.take(100)   # => first 100 rows
   class StreamingViewResponse
     include Enumerable
+    include ResponseHeaders
+    include StatusCodePredicates
 
-    # Private: The HTTP response.
+    # Internal: The HTTP response.
     #
     # This is set by Analysand::Database#stream_view.  The #etag and #code
     # methods use this for header information.
-    attr_accessor :http_response
+    attr_accessor :response
 
     def initialize
       @reader = Fiber.new { yield self; "" }
@@ -35,10 +39,6 @@ module Analysand
       @reader.resume
     end
 
-    def etag
-      http_response.get_fields('ETag').first.gsub('"', '')
-    end
-
     # Public: Yields documents in the view stream.
     #
     # Note that #docs and #rows advance the same stream, so expect to miss half
@@ -55,16 +55,6 @@ module Analysand
       each { |r| yield r['doc'] if r.has_key?('doc') }
     end
 
-    def code
-      http_response.code
-    end
-
-    def success?
-      c = code.to_i
-
-      c >= 200 && c <= 299
-    end
-
     def total_rows
       read until @generator.total_rows
 

data/lib/analysand/version.rb

@@ -1,3 +1,3 @@
 module Analysand
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/lib/analysand/viewing.rb

@@ -35,7 +35,7 @@ module Analysand
     def stream_view(view_path, parameters, credentials)
       StreamingViewResponse.new do |sresp|
         do_view_query(view_path, parameters, credentials) do |resp|
-          sresp.http_response = resp
+          sresp.response = resp
           Fiber.yield
           resp.read_body { |data| Fiber.yield(data) }
         end
@@ -82,11 +82,11 @@ module Analysand
     end
 
     def expand_view_path(view_name)
-      if view_name.include?('/')
+      if view_name.start_with?('_design') || !view_name.include?('/')
+        view_name
+      else
         design_doc, view_name = view_name.split('/', 2)
         "_design/#{design_doc}/_view/#{view_name}"
-      else
-        view_name
       end
     end
   end

data/spec/analysand/a_response.rb

@@ -1,12 +1,34 @@
 require 'spec_helper'
 
 shared_examples_for 'a response' do
-  %w(etag success? code).each do |m|
+  %w(etag success? conflict? code cookies session_cookie).each do |m|
     it "responds to ##{m}" do
       response.should respond_to(m)
     end
   end
 
+  describe '#conflict?' do
+    describe 'if response code is 409' do
+      before do
+        response.stub!(:code => '409')
+      end
+
+      it 'returns true' do
+        response.should be_conflict
+      end
+    end
+
+    describe 'if response code is 200' do
+      before do
+        response.stub!(:code => '200')
+      end
+
+      it 'returns false' do
+        response.should_not be_conflict
+      end
+    end
+  end
+
   describe '#etag' do
     it 'returns a string' do
       response.etag.should be_instance_of(String)
@@ -16,4 +38,26 @@ shared_examples_for 'a response' do
       response.etag.should_not include('"')
     end
   end
+
+  describe '#session_cookie' do
+    describe 'with an AuthSession cookie' do
+      let(:cookie) do
+        'AuthSession=foobar; Version=1; Expires=Wed, 14 Nov 2012 16:32:04 GMT; Max-Age=600; Path=/; HttpOnly'
+      end
+
+      before do
+        response.stub!(:cookies => [cookie])
+      end
+
+      it 'returns the AuthSession cookie' do
+        response.session_cookie.should == 'AuthSession=foobar'
+      end
+    end
+
+    describe 'without an AuthSession cookie' do
+      it 'returns nil' do
+        response.session_cookie.should be_nil
+      end
+    end
+  end
 end

data/spec/analysand/a_session_grantor.rb

@@ -30,7 +30,7 @@ shared_examples_for 'a session grantor' do
     end
 
     it 'has the user roles' do
-      @session[:roles].should == role_locator[JSON.parse(@resp.body)]
+      @session[:roles].should == role_locator[@resp.body]
     end
 
     it 'has a session token' do

data/spec/analysand/database_spec.rb

@@ -13,6 +13,14 @@ module Analysand
       it 'requires an absolute URI' do
         lambda { Database.new(URI("/abc")) }.should raise_error(InvalidURIError)
       end
+
+      it 'accepts URIs as strings' do
+        uri = 'http://localhost:5984/foo/'
+
+        db = Database.new(uri)
+
+        db.uri.should == URI(uri)
+      end
     end
 
     describe '.create!' do
@@ -150,6 +158,12 @@ module Analysand
         resp.rows.should == resp.body['rows']
       end
 
+      it 'works with the full document name' do
+        resp = db.view('_design/doc/_view/a_view')
+
+        resp.code.should == '200'
+      end
+
       it 'passes through view parameters' do
         resp = db.view('doc/a_view', :skip => 1)
 

data/spec/analysand/instance_spec.rb

@@ -13,72 +13,139 @@ module Analysand
       it 'requires an absolute URI' do
         lambda { Instance.new(URI("/abc")) }.should raise_error(InvalidURIError)
       end
+
+      it 'accepts URIs as strings' do
+        uri = 'http://localhost:5984/'
+
+        db = Instance.new(uri)
+
+        db.uri.should == URI(uri)
+      end
     end
 
     let(:instance) { Instance.new(instance_uri) }
 
-    describe '#establish_session' do
-      describe 'given admin credentials' do
-        let(:credentials) { admin_credentials }
+    describe '#post_session' do
+      describe 'with valid credentials' do
+        let(:resp) { instance.post_session(member1_username, member1_password) }
+
+        it 'returns success' do
+          resp.should be_success
+        end
 
-        it_should_behave_like 'a session grantor'
+        it 'returns a session cookie in the response' do
+          resp.session_cookie.should_not be_empty
+        end
       end
 
-      describe 'given member credentials' do
-        let(:credentials) { member1_credentials }
+      it 'supports hash credentials' do
+        resp = instance.post_session(member1_credentials)
 
-        it_should_behave_like 'a session grantor'
+        resp.should be_success
       end
 
-      describe 'given incorrect credentials' do
-        it 'returns [nil, response]' do
-          session, resp = instance.establish_session('wrong', 'wrong')
+      describe 'with invalid credentials' do
+        let(:resp) { instance.post_session(member1_username, 'wrong') }
 
-          session.should be_nil
-          resp.code.should == '401'
+        it 'does not return success' do
+          resp.should_not be_success
         end
       end
     end
 
-    describe '#renew_session' do
-      let(:credentials) { admin_credentials }
+    describe '#test_session' do
+      describe 'with a valid cookie' do
+        let(:resp) { instance.post_session(member1_username, member1_password) }
+        let(:cookie) { resp.session_cookie }
 
-      before do
-        @session, _ = instance.establish_session(credentials[:username], credentials[:password])
+        it 'returns success' do
+          resp = instance.get_session(cookie)
+
+          resp.should be_success
+        end
+
+        it 'returns valid' do
+          resp = instance.get_session(cookie)
+
+          resp.should be_valid
+        end
       end
 
-      describe 'if CouchDB refreshes the session cookie' do
-        around do |example|
-          VCR.use_cassette('get_session_refreshes_cookie') { example.call }
+      describe 'with an invalid cookie' do
+        let(:cookie) { 'AuthSession=YWRtaW46NTBBNDkwRUE6npTfHKz68y5q1FX4pWiB-Lzk5mQ' }
+
+        it 'returns success' do
+          resp = instance.get_session(cookie)
+
+          resp.should be_success
         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
+        it 'does not return valid' do
+          resp = instance.get_session(cookie)
+
+          resp.should_not be_valid
         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 }
+      describe 'with a malformed cookie' do
+        let(:cookie) { 'AuthSession=wrong' }
+
+        it 'does not return success' do
+          resp = instance.get_session(cookie)
+
+          resp.should_not be_success
         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
+        it 'does not return valid' do
+          resp = instance.get_session(cookie)
+
+          resp.should_not be_valid
         end
       end
+    end
+
+    describe '#get_config' do
+      let(:credentials) { admin_credentials }
+
+      it 'retrieves a configuration option' do
+        VCR.use_cassette('get_config') do
+          instance.get_config('stats/rate', admin_credentials).value.should == '"1000"'
+        end
+      end
+
+      it 'retrieves many configuration options' do
+        VCR.use_cassette('get_many_config') do
+          instance.get_config('stats', admin_credentials).value.should == {
+            'rate' => '1000',
+            'samples' => '[0, 60, 300, 900]'
+          }
+        end
+      end
+    end
+
+    describe '#set_config!' do
+      it 'raises ConfigurationNotSaved on non-success' do
+        VCR.use_cassette('unauthorized_set_config') do
+          lambda { instance.set_config!('stats/rate', 1000) }.should raise_error(ConfigurationNotSaved)
+        end
+      end
+    end
 
-      describe 'given an invalid session' do
-        it 'returns [nil, response]' do
-          session, resp = instance.renew_session({ :token => 'AuthSession=wrong' })
+    describe '#set_config' do
+      let(:credentials) { admin_credentials }
+
+      it 'sets a configuration option' do
+        VCR.use_cassette('set_config') do
+          instance.set_config('stats/rate', 1200, admin_credentials)
+          instance.get_config('stats/rate', admin_credentials).value.should == '"1200"'
+        end
+      end
 
-          session.should be_nil
-          resp.code.should == '400'
+      it 'accepts values from get_config' do
+        VCR.use_cassette('reload_config') do
+          samples = instance.get_config('stats/samples', admin_credentials).value
+          instance.set_config('stats/samples', samples, admin_credentials)
+          instance.get_config('stats/samples', admin_credentials).value.should == samples
         end
       end
     end