analysand 1.0.1 → 1.1.0

data/lib/analysand/version.rb

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

data/lib/analysand/view_streaming/builder.rb

@@ -0,0 +1,142 @@
+require 'analysand/errors'
+require 'json/stream'
+
+module Analysand
+  module ViewStreaming
+    # Private: A wrapper around JSON::Stream::Parser that extracts data from a
+    # CouchDB view document.
+    class Builder
+      attr_reader :offset
+      attr_reader :total_rows
+
+      # Rows constructed by the JSON parser that are ready for
+      # StreamingViewResponse#each.
+      attr_reader :staged_rows
+
+      # JSON::Stream::Parser callback methods.
+      CALLBACK_METHODS = %w(
+        start_object end_object start_array end_array key value
+      )
+
+      # If we find a key in the toplevel view object that isn't one of these,
+      # we raise UnexpectedViewKey.
+      KNOWN_KEYS = %w(
+        total_rows offset rows
+      )
+
+      def initialize
+        @in_rows = false
+        @parser = JSON::Stream::Parser.new
+        @stack = []
+        @staged_rows = []
+
+        CALLBACK_METHODS.each { |name| @parser.send(name, &method(name)) }
+      end
+
+      def <<(data)
+        @parser << data
+      end
+
+      def start_object
+        # We don't need to do anything for the toplevel view object, so just
+        # focus on the objects in rows.
+        if @in_rows
+          @stack.push ObjectNode.new
+        end
+      end
+
+      def end_object
+        if @in_rows
+          # If the stack's empty and we've come to the end of an object, assume
+          # we've exited the rows key.  Trailing keys are handled by
+          # check_toplevel_key_validity.
+          if @stack.empty?
+            @in_rows = false
+          else
+            obj = @stack.pop.to_object
+
+            # If obj was the only thing on the stack and we're processing rows,
+            # then we've completed an object and need to stage it for the
+            # object stream.
+            if @stack.empty?
+              staged_rows << obj
+            else
+              @stack.last << obj
+            end
+          end
+        end
+      end
+
+      def start_array
+        # If we're not in the rows array but "rows" was the last key we've
+        # seen, then we're entering the rows array.  Otherwise, we're building
+        # an array in a row.
+        if !@in_rows && @stack.pop == 'rows'
+          @in_rows = true
+        elsif @in_rows
+          @stack.push []
+        end
+      end
+
+      def end_array
+        if @in_rows
+          obj = @stack.pop
+
+          # If there's nothing on the row stack, it means that we've hit the
+          # end of the rows array.
+          if @stack.empty?
+            @in_rows = false
+          else
+            @stack.last << obj
+          end
+        end
+      end
+
+      def key(k)
+        if !@in_rows
+          check_toplevel_key_validity(k)
+          @stack.push k
+        else
+          @stack.last << k
+        end
+      end
+
+      def value(v)
+        if !@in_rows
+          case @stack.pop
+          when 'total_rows'; @total_rows = v
+          when 'offset'; @offset = v
+          end
+        else
+          @stack.last << v
+        end
+      end
+
+      def check_toplevel_key_validity(k)
+        if !KNOWN_KEYS.include?(k)
+          raise UnexpectedViewKey, "Unexpected key #{k} in top-level view object"
+        end
+      end
+
+      # Simplifies key/value pair construction.
+      class ObjectNode
+        def initialize
+          @obj = {}
+        end
+
+        def to_object
+          @obj
+        end
+
+        def <<(term)
+          if !@key
+            @key = term
+          elsif @key
+            @obj[@key] = term
+            @key = nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/analysand/viewing.rb

@@ -0,0 +1,95 @@
+require 'analysand/errors'
+require 'analysand/streaming_view_response'
+require 'analysand/view_response'
+require 'fiber'
+
+module Analysand
+  module Viewing
+    JSON_VALUE_PARAMETERS = %w(key keys startkey endkey).map(&:to_sym)
+
+    def all_docs(parameters = {}, credentials = nil)
+      view('_all_docs', parameters, credentials)
+    end
+
+    def all_docs!(parameters = {}, credentials = nil)
+      view!('_all_docs', parameters, credentials)
+    end
+
+    def view(view_name, parameters = {}, credentials = nil)
+      stream = parameters.delete(:stream)
+      view_path = expand_view_path(view_name)
+
+      if stream
+        stream_view(view_path, parameters, credentials)
+      else
+        return_view(view_path, parameters, credentials)
+      end
+    end
+
+    def view!(view_name, parameters = {}, credentials = nil)
+      view(view_name, parameters, credentials).tap do |resp|
+        raise ex(CannotAccessView, resp) unless resp.success?
+      end
+    end
+
+    def stream_view(view_path, parameters, credentials)
+      StreamingViewResponse.new do |sresp|
+        do_view_query(view_path, parameters, credentials) do |resp|
+          sresp.http_response = resp
+          Fiber.yield
+          resp.read_body { |data| Fiber.yield(data) }
+        end
+      end
+    end
+
+    def return_view(view_path, parameters, credentials)
+      resp = do_view_query(view_path, parameters, credentials)
+
+      ViewResponse.new resp
+    end
+
+    def do_view_query(view_path, parameters, credentials, &block)
+      use_post = parameters.delete(:post)
+
+      if use_post
+        post_view(view_path, parameters, credentials, block)
+      else
+        get_view(view_path, parameters, credentials, block)
+      end
+    end
+
+    def get_view(view_path, parameters, credentials, block)
+      encode_parameters(parameters)
+      _get(view_path, credentials, parameters, {}, nil, block)
+    end
+
+    def post_view(view_path, parameters, credentials, block)
+      body = {
+        'keys' => parameters.delete(:keys)
+      }.reject { |_, v| v.nil? }
+
+      encode_parameters(parameters)
+
+      _post(view_path, credentials, parameters, json_headers, body.to_json, block)
+    end
+
+    def encode_parameters(parameters)
+      JSON_VALUE_PARAMETERS.each do |p|
+        if parameters.has_key?(p)
+          parameters[p] = parameters[p].to_json
+        end
+      end
+    end
+
+    def expand_view_path(view_name)
+      if view_name.include?('/')
+        design_doc, view_name = view_name.split('/', 2)
+        "_design/#{design_doc}/_view/#{view_name}"
+      else
+        view_name
+      end
+    end
+  end
+end
+
+# vim:ts=2:sw=2:et:tw=78

data/lib/analysand/writing.rb

@@ -0,0 +1,71 @@
+require 'analysand/bulk_response'
+require 'analysand/errors'
+require 'analysand/response'
+
+module Analysand
+  module Writing
+    def put(doc_id, doc, credentials = nil, options = {})
+      query = options
+
+      Response.new _put(doc_id, credentials, options, json_headers, doc.to_json)
+    end
+
+    def put!(doc_id, doc, credentials = nil, options = {})
+      put(doc_id, doc, credentials, options).tap do |resp|
+        raise ex(DocumentNotSaved, resp) unless resp.success?
+      end
+    end
+
+    def ensure_full_commit(credentials = nil, options = {})
+      Response.new _post('_ensure_full_commit', credentials, options, json_headers, {}.to_json)
+    end
+
+    def bulk_docs(docs, credentials = nil, options = {})
+      body = { 'docs' => docs }
+      body['all_or_nothing'] = true if options[:all_or_nothing]
+
+      BulkResponse.new _post('_bulk_docs', credentials, {}, json_headers, body.to_json)
+    end
+
+    def bulk_docs!(docs, credentials = nil, options = {})
+      bulk_docs(docs, credentials, options).tap do |resp|
+        raise ex(BulkOperationFailed, resp) unless resp.success?
+      end
+    end
+
+    def copy(source, destination, credentials = nil)
+      headers = { 'Destination' => destination }
+
+      Response.new _copy(source, credentials, {}, headers, nil)
+    end
+
+    def put_attachment(loc, io, credentials = nil, options = {})
+      query = {}
+      headers = {}
+
+      if options[:rev]
+        query['rev'] = options[:rev]
+      end
+
+      if options[:content_type]
+        headers['Content-Type'] = options[:content_type]
+      end
+
+      Response.new _put(loc, credentials, query, headers, io.read)
+    end
+
+    def delete(doc_id, rev, credentials = nil)
+      headers = { 'If-Match' => rev }
+
+      Response.new _delete(doc_id, credentials, {}, headers, nil)
+    end
+
+    def delete!(doc_id, rev, credentials = nil)
+      delete(doc_id, rev, credentials).tap do |resp|
+        raise ex(DocumentNotDeleted, resp) unless resp.success?
+      end
+    end
+  end
+end
+
+# vim:ts=2:sw=2:et:tw=78

data/spec/analysand/a_response.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+shared_examples_for 'a response' do
+  %w(etag success? code).each do |m|
+    it "responds to ##{m}" do
+      response.should respond_to(m)
+    end
+  end
+
+  describe '#etag' do
+    it 'returns a string' do
+      response.etag.should be_instance_of(String)
+    end
+
+    it 'returns ETags without quotes' do
+      response.etag.should_not include('"')
+    end
+  end
+end

data/spec/analysand/change_watcher_spec.rb

@@ -39,6 +39,24 @@ module Analysand
       drop_databases!
     end
 
+    describe '#connection_ok' do
+      describe 'with a non-public change feed' do
+        before do
+          set_security({ 'names' => [admin_username] })
+        end
+
+        after do
+          clear_security
+        end
+
+        it 'passes credentials' do
+          watcher = TestWatcher.new(db, admin_credentials)
+
+          watcher.connection_ok.should be_true
+        end
+      end
+    end
+
     describe '#changes_feed_uri' do
       let!(:watcher) { TestWatcher.new(db, admin_credentials) }
 

data/spec/analysand/database_spec.rb

@@ -185,6 +185,13 @@ module Analysand
         resp.rows.length.should == 1
       end
 
+      it 'can issue POSTs' do
+        resp = db.view('doc/a_view', :keys => ['abc123', 'abc456'], :post => true)
+
+        resp.code.should == '200'
+        resp.rows.length.should == 2
+      end
+
       it 'passes credentials' do
         security = {
           'members' => {

data/spec/analysand/response_spec.rb

@@ -3,17 +3,21 @@ require 'spec_helper'
 require 'analysand/database'
 require 'analysand/response'
 
+require File.expand_path('../a_response', __FILE__)
+
 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
+    let(:response) do
+      VCR.use_cassette('head_request_with_etag') do
+        db.head('abc123', admin_credentials)
       end
+    end
 
+    it_should_behave_like 'a response'
+
+    describe '#etag' do
       it 'removes quotes from ETags' do
         response.etag.should == '1-967a00dff5e02add41819138abb3284d'
       end

data/spec/analysand/view_response_spec.rb

@@ -1,18 +1,29 @@
 require 'spec_helper'
 
+require 'analysand/database'
 require 'analysand/view_response'
 
+require File.expand_path('../a_response', __FILE__)
+
 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_with_docs) do
+      '{"rows": [{"id":"foo","key":"foo","value":{},"doc":{"foo":"bar"}}]}'
+    end
 
-      let(:resp_without_docs) do
-        '{"rows": [{"id":"foo","key":"foo","value":{}}]}'
+    let(:resp_without_docs) do
+      '{"rows": [{"id":"foo","key":"foo","value":{}}]}'
+    end
+
+    let(:db) { Database.new(database_uri) }
+
+    it_should_behave_like 'a response' do
+      let(:response) do
+        VCR.use_cassette('view') { db.view('doc/a_view') }
       end
+    end
 
+    describe '#docs' do
       describe 'if the view includes docs' do
         subject { ViewResponse.new(stub(:body => resp_with_docs)) }
 

data/spec/analysand/view_streaming/builder_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+require 'analysand/view_streaming/builder'
+
+module Analysand
+  module ViewStreaming
+    describe Builder do
+      let(:builder) { Builder.new }
+
+      it 'recognizes the "total_rows" key' do
+        builder << '{"total_rows":10000}'
+
+        builder.total_rows.should == 10000
+      end
+
+      it 'recognizes the "offset" key' do
+        builder << '{"offset":20}'
+
+        builder.offset.should == 20
+      end
+
+      describe 'for rows' do
+        before do
+          builder << '{"total_rows":10000,"offset":20,"rows":'
+        end
+
+        it 'builds objects' do
+          builder << '[{"id":"foo","key":"bar","value":1}]'
+
+          builder.staged_rows.should == [
+            { 'id' => 'foo', 'key' => 'bar', 'value' => 1 }
+          ]
+        end
+
+        it 'builds objects containing other objects' do
+          builder << '[{"id":"foo","key":"bar","value":{"total_rows":1}}]'
+
+          builder.staged_rows.should == [
+            { 'id' => 'foo',
+              'key' => 'bar',
+              'value' => {
+                 'total_rows' => 1
+               }
+            }
+          ]
+        end
+
+        it 'builds objects containing arrays' do
+          builder << '[{"id":"foo","key":"bar","value":{"things":[1,2,3]}}]'
+
+          builder.staged_rows.should == [
+            { 'id' => 'foo',
+              'key' => 'bar',
+              'value' => {
+                'things' => [1, 2, 3]
+              }
+            }
+          ]
+        end
+      end
+
+      describe 'given unexpected top-level keys' do
+        before do
+          builder << '{"total_rows":10000,"offset":20,"rows":[],'
+        end
+
+        it 'raises Analysand::UnexpectedViewKey' do
+          lambda { builder << '"abc":"def"}' }.should raise_error(Analysand::UnexpectedViewKey)
+        end
+      end
+    end
+  end
+end