couchbase 3.0.0.alpha.2 → 3.0.0

data/ext/third_party/json/Makefile

@@ -0,0 +1,77 @@
+# The Art of C++
+# Copyright (c) 2015-2020 Dr. Colin Hirsch and Daniel Frey
+# Please see LICENSE for license or visit https://github.com/taocpp/json
+
+.SUFFIXES:
+.SECONDARY:
+
+ifeq ($(OS),Windows_NT)
+UNAME_S := $(OS)
+ifeq ($(shell gcc -dumpmachine),mingw32)
+MINGW_CXXFLAGS = -U__STRICT_ANSI__
+endif
+else
+UNAME_S := $(shell uname -s)
+endif
+
+# For Darwin (Mac OS X / macOS) we assume that the default compiler
+# clang++ is used; when $(CXX) is some version of g++, then
+# $(CXXSTD) has to be set to -std=c++17 (or newer) so
+# that -stdlib=libc++ is not automatically added.
+
+ifeq ($(CXXSTD),)
+CXXSTD := -std=c++17
+ifeq ($(UNAME_S),Darwin)
+CXXSTD += -stdlib=libc++
+endif
+endif
+
+# Ensure strict standard compliance and no warnings, can be
+# changed if desired.
+
+CPPFLAGS ?= -pedantic
+CXXFLAGS ?= -Wall -Wextra -Wshadow -Werror -O3 $(MINGW_CXXFLAGS)
+
+CLANG_TIDY ?= clang-tidy
+
+HEADERS := $(filter-out include/tao/json/external/% include/tao/json/internal/endian_win.hpp,$(shell find include -name '*.hpp')) $(filter-out src/test/json/main.hpp,$(shell find src -name '*.hpp'))
+SOURCES := $(shell find src -name '*.cpp')
+DEPENDS := $(SOURCES:%.cpp=build/%.d)
+BINARIES := $(SOURCES:%.cpp=build/%)
+
+UNIT_TESTS := $(filter build/src/test/%,$(BINARIES))
+
+.PHONY: all
+all: compile check
+
+.PHONY: compile
+compile: $(BINARIES)
+
+.PHONY: check
+check: $(UNIT_TESTS)
+	@set -e; for T in $(UNIT_TESTS); do echo $$T; $$T > /dev/null; done
+
+.PHONY: clean
+clean:
+	@rm -rf build/src
+	@find . -name '*~' -delete
+
+build/%.d: %.cpp Makefile
+	@mkdir -p $(@D)
+	$(CXX) $(CXXSTD) -Iinclude $(CPPFLAGS) -MM -MQ $@ $< -o $@
+
+build/%: %.cpp build/%.d
+	$(CXX) $(CXXSTD) -Iinclude $(CPPFLAGS) $(CXXFLAGS) $< -o $@
+
+build/%.clang-tidy: %
+	$(CLANG_TIDY) -extra-arg "-Iinclude" -extra-arg "-std=c++17" -checks=*,-fuchsia-*,-google-runtime-references,-google-runtime-int,-google-readability-todo,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-*-avoid-c-arrays,-*-magic-numbers,-cppcoreguidelines-non-private-member-variables-in-classes,-cppcoreguidelines-macro-usage,-hicpp-no-array-decay,-hicpp-signed-bitwise,-modernize-raw-string-literal,-misc-sizeof-expression,-misc-non-private-member-variables-in-classes,-bugprone-sizeof-expression,-bugprone-exception-escape -warnings-as-errors=* $< 2>/dev/null
+	@mkdir -p $(@D)
+	@touch $@
+
+.PHONY: clang-tidy
+clang-tidy: $(HEADERS:%=build/%.clang-tidy) $(SOURCES:%=build/%.clang-tidy)
+	@echo "All $(words $(HEADERS) $(SOURCES)) clang-tidy tests passed."
+
+ifeq ($(findstring $(MAKECMDGOALS),clean),)
+-include $(DEPENDS)
+endif

data/lib/couchbase.rb

@@ -15,4 +15,3 @@
 require "couchbase/version"
 require "couchbase/libcouchbase"
 require "couchbase/cluster"
-

data/lib/couchbase/analytics_options.rb

@@ -0,0 +1,177 @@
+#    Copyright 2020 Couchbase, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require 'couchbase/json_transcoder'
+
+module Couchbase
+  class Cluster
+    class AnalyticsOptions
+      # @return [Integer] Timeout in milliseconds
+      attr_accessor :timeout
+
+      # @return [String] Provides a custom client context ID for this query
+      attr_accessor :client_context_id
+
+      # @return [:not_bounded, :request_plus] specifies level of consistency for the query
+      attr_accessor :scan_consistency
+
+      # @return [Boolean] Allows explicitly marking a query as being readonly and not mutating any documents on the server side.
+      attr_accessor :readonly
+
+      # @return [Boolean] Allows to give certain requests higher priority than others
+      attr_accessor :priority
+
+      # @return [JsonTranscoder] transcoder to use on rows
+      attr_accessor :transcoder
+
+      # @api private
+      # @return [Hash<String => #to_json>]
+      attr_reader :raw_parameters
+
+      # @yieldparam [AnalyticsOptions] self
+      def initialize
+        @transcoder = JsonTranscoder.new
+        @raw_parameters = {}
+        @positional_parameters = nil
+        @named_parameters = nil
+        @scan_consistency = nil
+        yield self if block_given?
+      end
+
+      # Sets positional parameters for the query
+      #
+      # @param [Array] positional the list of parameters that have to be substituted in the statement
+      def positional_parameters(positional)
+        @positional_parameters = positional
+        @named_parameters = nil
+      end
+
+      # @api private
+      # @return [Array<String>, nil]
+      def export_positional_parameters
+        @positional_parameters&.map { |p| JSON.dump(p) }
+      end
+
+      # Sets named parameters for the query
+      #
+      # @param [Hash] named the key/value map of the parameters to substitute in the statement
+      def named_parameters(named)
+        @named_parameters = named
+        @positional_parameters = nil
+      end
+
+      # Allows providing custom JSON key/value pairs for advanced usage
+      #
+      # @param [String] key the parameter name (key of the JSON property)
+      # @param [Object] value the parameter value (value of the JSON property)
+      def raw(key, value)
+        @raw_parameters[key] = JSON.generate(value)
+      end
+
+      # @api private
+      # @return [Hash<String => String>, nil]
+      def export_named_parameters
+        @named_parameters&.each_with_object({}) { |(n, v), o| o[n.to_s] = JSON.dump(v) }
+      end
+    end
+
+    class AnalyticsWarning
+      # @return [Integer]
+      attr_accessor :code
+
+      # @return [String]
+      attr_accessor :message
+
+      # @param [Integer] code
+      # @param [String] message
+      def initialize(code, message)
+        @code = code
+        @message = message
+      end
+    end
+
+    class AnalyticsMetrics
+      # @return [Integer] duration in milliseconds
+      attr_accessor :elapsed_time
+
+      # @return [Integer] duration in milliseconds
+      attr_accessor :execution_time
+
+      # @return [Integer]
+      attr_accessor :result_count
+
+      # @return [Integer]
+      attr_accessor :result_size
+
+      # @return [Integer]
+      attr_accessor :error_count
+
+      # @return [Integer]
+      attr_accessor :processed_objects
+
+      # @return [Integer]
+      attr_accessor :warning_count
+
+      # @yieldparam [AnalyticsMetrics] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class AnalyticsMetaData
+      # @return [String]
+      attr_accessor :request_id
+
+      # @return [String]
+      attr_accessor :client_context_id
+
+      # @return [:running, :success, :errors, :completed, :stopped, :timeout, :closed, :fatal, :aborted, :unknown]
+      attr_accessor :status
+
+      # @return [Hash] returns the signature as returned by the query engine which is then decoded as JSON object
+      attr_accessor :signature
+
+      # @return [Array<AnalyticsWarning>]
+      attr_accessor :warnings
+
+      # @return [AnalyticsMetrics]
+      attr_accessor :metrics
+
+      # @yieldparam [AnalyticsMetaData] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    class AnalyticsResult
+      # @return [AnalyticsMetaData]
+      attr_accessor :meta_data
+
+      attr_accessor :transcoder
+
+      # Returns all rows converted using a transcoder
+      #
+      # @return [Array]
+      def rows(transcoder = self.transcoder)
+        @rows.lazy.map { |row| transcoder.decode(row, 0) }
+      end
+
+      # @yieldparam [AnalyticsResult] self
+      def initialize
+        @transcoder = JsonTranscoder.new
+        yield self if block_given?
+      end
+    end
+  end
+end

data/lib/couchbase/authenticator.rb

@@ -13,6 +13,7 @@
 #  limitations under the License.
 
 module Couchbase
+  # Authenticator for username/password credentials
   class PasswordAuthenticator
     attr_accessor :username
     attr_accessor :password
@@ -22,4 +23,17 @@ module Couchbase
       @password = password
     end
   end
+
+  # Authenticator for TLS client certificate
+  #
+  # @see https://docs.couchbase.com/server/current/manage/manage-security/configure-client-certificates.html
+  class CertificateAuthenticator
+    attr_accessor :certificate_path
+    attr_accessor :key_path
+
+    def initialize(certificate_path, key_path)
+      @certificate_path = certificate_path
+      @key_path = key_path
+    end
+  end
 end

data/lib/couchbase/binary_collection.rb

@@ -16,7 +16,7 @@ require "couchbase/binary_collection_options"
 
 module Couchbase
   class BinaryCollection
-    alias_method :inspect, :to_s
+    alias inspect to_s
 
     # @param [Couchbase::Collection] collection parent collection
     def initialize(collection)
@@ -49,12 +49,14 @@ module Couchbase
     #
     # @return [CounterResult]
     def increment(id, options = IncrementOptions.new)
-      resp = @backend.document_increment(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id, {
-          delta: options.delta,
-          initial_value: options.initial,
-          expiration: options.expiration,
-          durability_level: options.durability_level,
-      })
+      resp = @backend.document_increment(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id,
+                                         options.timeout,
+                                         {
+                                           delta: options.delta,
+                                           initial_value: options.initial,
+                                           expiry: options.expiry,
+                                           durability_level: options.durability_level,
+                                         })
       CounterResult.new do |res|
         res.cas = resp[:cas]
         res.content = resp[:content]
@@ -69,12 +71,14 @@ module Couchbase
     #
     # @return [CounterResult]
     def decrement(id, options = DecrementOptions.new)
-      resp = @backend.document_decrement(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id, {
-          delta: options.delta,
-          initial_value: options.initial,
-          expiration: options.expiration,
-          durability_level: options.durability_level,
-      })
+      resp = @backend.document_decrement(@collection.bucket_name, "#{@collection.scope_name}.#{@collection.name}", id,
+                                         options.timeout,
+                                         {
+                                           delta: options.delta,
+                                           initial_value: options.initial,
+                                           expiry: options.expiry,
+                                           durability_level: options.durability_level,
+                                         })
       CounterResult.new do |res|
         res.cas = resp[:cas]
         res.content = resp[:content]

data/lib/couchbase/binary_collection_options.rb

@@ -20,7 +20,9 @@ module Couchbase
       # @return [Integer] The default CAS used (0 means no CAS in this context)
       attr_accessor :cas
 
+      # @yieldparam [AppendOptions] self
       def initialize
+        super
         yield self if block_given?
       end
     end
@@ -29,7 +31,9 @@ module Couchbase
       # @return [Integer] The default CAS used (0 means no CAS in this context)
       attr_accessor :cas
 
+      # @yieldparam [PrependOptions] self
       def initialize
+        super
         yield self if block_given?
       end
     end
@@ -42,20 +46,21 @@ module Couchbase
       attr_accessor :initial
 
       # @return [Integer] if set, holds the expiration for the operation
-      attr_accessor :expiration
+      attr_accessor :expiry
 
       # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
       attr_accessor :durability_level
 
+      # @yieldparam [IncrementOptions] self
       def initialize
+        super
         @delta = 1
         yield self if block_given?
       end
 
       def delta=(value)
-        if delta < 0
-          raise ArgumentError, "the delta cannot be less than 0"
-        end
+        raise ArgumentError, "the delta cannot be less than 0" if delta.negative?
+
         @delta = value
       end
     end
@@ -68,20 +73,21 @@ module Couchbase
       attr_accessor :initial
 
       # @return [Integer] if set, holds the expiration for the operation
-      attr_accessor :expiration
+      attr_accessor :expiry
 
       # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
       attr_accessor :durability_level
 
+      # @yieldparam [DecrementOptions] self
       def initialize
+        super
         @delta = 1
         yield self if block_given?
       end
 
       def delta=(value)
-        if delta < 0
-          raise ArgumentError, "the delta cannot be less than 0"
-        end
+        raise ArgumentError, "the delta cannot be less than 0" if delta.negative?
+
         @delta = value
       end
     end

data/lib/couchbase/bucket.rb

@@ -14,14 +14,19 @@
 
 require "couchbase/scope"
 require "couchbase/management/collection_manager"
+require "couchbase/management/view_index_manager"
+require "couchbase/view_options"
 
 module Couchbase
   class Bucket
-    alias_method :inspect, :to_s
+    # @return [String] name of the bucket
+    attr_reader :name
+
+    alias inspect to_s
 
     # @param [Couchbase::Backend] backend
     def initialize(backend, name)
-      backend.open_bucket(name)
+      backend.open_bucket(name, true)
       @backend = backend
       @name = name
     end
@@ -55,7 +60,49 @@ module Couchbase
     #
     # @return [Collection]
     def default_collection
-      default_scope.default_collection
+      Collection.new(@backend, @name, :_default, :_default)
+    end
+
+    # Performs query to view index.
+    #
+    # @param [String] design_document_name name of the design document
+    # @param [String] view_name name of the view to query
+    # @param [ViewOptions] options
+    #
+    # @return [ViewResult]
+    def view_query(design_document_name, view_name, options = ViewOptions.new)
+      resp = @backend.document_view(@name, design_document_name, view_name, options.namespace, {
+        timeout: options.timeout,
+        scan_consistency: options.scan_consistency,
+        skip: options.skip,
+        limit: options.limit,
+        start_key: (JSON.generate(options.start_key) unless options.start_key.nil?),
+        end_key: (JSON.generate(options.end_key) unless options.end_key.nil?),
+        start_key_doc_id: options.start_key_doc_id,
+        end_key_doc_id: options.end_key_doc_id,
+        inclusive_end: options.inclusive_end,
+        group: options.group,
+        group_level: options.group_level,
+        key: (JSON.generate(options.key) unless options.key.nil?),
+        keys: options.keys&.map { |key| JSON.generate(key) },
+        order: options.order,
+        reduce: options.reduce,
+        on_error: options.on_error,
+        debug: options.debug,
+      })
+      ViewResult.new do |res|
+        res.meta_data = ViewMetaData.new do |meta|
+          meta.total_rows = resp[:meta][:total_rows]
+          meta.debug_info = resp[:meta][:debug_info]
+        end
+        res.rows = resp[:rows].map do |entry|
+          ViewRow.new do |row|
+            row.id = entry[:id] if entry.key?(:id)
+            row.key = JSON.parse(entry[:key])
+            row.value = JSON.parse(entry[:value])
+          end
+        end
+      end
     end
 
     # @return [Management::CollectionManager]
@@ -63,6 +110,11 @@ module Couchbase
       Management::CollectionManager.new(@backend, @name)
     end
 
+    # @return [Management::ViewIndexManager]
+    def view_indexes
+      Management::ViewIndexManager.new(@backend, @name)
+    end
+
     # Performs application-level ping requests against services in the couchbase cluster
     #
     # @return [PingResult]