dpla-analysand 3.0.2

data/lib/analysand/streaming_view_response.rb

@@ -0,0 +1,90 @@
+require 'analysand/response_headers'
+require 'analysand/status_code_predicates'
+require 'analysand/view_streaming/builder'
+require 'fiber'
+
+module Analysand
+  # Public: Controls streaming of view data.
+  #
+  # This class is meant to be used by Analysand::Database#view.  It exports the
+  # same interface as ViewResponse.
+  #
+  # Examples:
+  #
+  #     resp = db.view('view/something', :stream => true)
+  #
+  #     resp.total_rows       # => 1000000
+  #     resp.offset           # => 0
+  #     resp.rows.take(100)   # => first 100 rows
+  class StreamingViewResponse
+    include Enumerable
+    include ResponseHeaders
+    include StatusCodePredicates
+
+    # Internal: The HTTP response.
+    #
+    # This is set by Analysand::Database#stream_view.  The #etag and #code
+    # methods use this for header information.
+    attr_accessor :response
+
+    def initialize
+      @reader = Fiber.new { yield self; "" }
+      @generator = ViewStreaming::Builder.new
+
+      # Analysand::Database#stream_view issues the request.  When the response
+      # arrives, it yields control back here.  Subsequent resumes read the
+      # body.
+      #
+      # We do this to provide the response headers as soon as possible.
+      @reader.resume
+    end
+
+    # Public: Yields documents in the view stream.
+    #
+    # Note that #docs and #rows advance the same stream, so expect to miss half
+    # your rows if you do something like
+    #
+    #     resp.docs.zip(resp.rows)
+    #
+    # If this is a problem for you, let me know and we can work out a solution.
+    def docs
+      to_enum(:get_docs)
+    end
+
+    def get_docs
+      each { |r| yield r['doc'] if r.has_key?('doc') }
+    end
+
+    def total_rows
+      read until @generator.total_rows
+
+      @generator.total_rows
+    end
+
+    def offset
+      read until @generator.offset
+
+      @generator.offset
+    end
+
+    def read
+      @generator << @reader.resume
+    end
+
+    def each
+      return to_enum unless block_given?
+
+      while @reader.alive?
+        read while @reader.alive? && @generator.staged_rows.empty?
+
+        until @generator.staged_rows.empty?
+          yield @generator.staged_rows.shift
+        end
+      end
+    end
+
+    def rows
+      self
+    end
+  end
+end

data/lib/analysand/version.rb

@@ -0,0 +1,3 @@
+module Analysand
+  VERSION = "3.0.2"
+end

data/lib/analysand/view_response.rb

@@ -0,0 +1,24 @@
+require 'analysand/response'
+
+module Analysand
+  ##
+  # A subclass of Response with additional view-specific accessors: total_rows,
+  # offset, and rows.
+  class ViewResponse < Response
+    def total_rows
+      body['total_rows']
+    end
+
+    def offset
+      body['offset']
+    end
+
+    def rows
+      body['rows']
+    end
+
+    def docs
+      rows.map { |r| r['doc'] }.compact
+    end
+  end
+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.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.start_with?('_design') || !view_name.include?('/')
+        view_name
+      else
+        design_doc, view_name = view_name.split('/', 2)
+        "_design/#{design_doc}/_view/#{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 bulk_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/script/setup_database.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../spec/support/test_parameters', __FILE__)
+require 'digest'
+require 'json'
+
+include TestParameters
+
+admin_command = ['curl',
+                 '-X PUT',
+                 %Q{--data-binary '"#{admin_password}"'},
+                 "#{instance_uri}/_config/admins/#{admin_username}"
+].join(' ')
+
+salt = "ff518dabd59b04b527de7c55179059a46ac54976"
+
+member_doc = {
+  "name" => member1_username,
+  "salt" => salt,
+  "password_sha" => Digest::SHA1.hexdigest("#{member1_password}#{salt}"),
+  "type" => "user",
+  "roles" => []
+}
+
+member_command = ['curl',
+                  '-X PUT',
+                  "--data-binary '#{member_doc.to_json}'",
+                  "-u #{admin_username}:#{admin_password}",
+                  "#{instance_uri}/_users/org.couchdb.user:#{member1_username}"
+].join(' ')
+
+db_command = ['curl',
+             '-X PUT',
+             "-u #{admin_username}:#{admin_password}",
+             database_uri.to_s
+].join(' ')
+
+[ admin_command,
+  member_command,
+  db_command
+].each do |cmd|
+  puts cmd
+  system cmd
+  puts
+end