couchbase 3.0.0.beta.1 → 3.1.0

data/lib/couchbase/collection_options.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -12,83 +12,30 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+require "rubygems/deprecate"
+
 require "couchbase/json_transcoder"
-require "couchbase/common_options"
 require "couchbase/subdoc"
 require "couchbase/mutation_state"
 
 module Couchbase
   class Collection
-    class GetOptions < CommonOptions
-      # @return [Boolean] if the expiration should also fetched with get
-      attr_accessor :with_expiry
-
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetOptions] self
-      def initialize
-        @transcoder = JsonTranscoder.new
-        @preserve_array_indexes = false
-        @with_expiry = nil
-        @projections = nil
-        yield self if block_given?
-      end
-
-      # Allows to specify a custom list paths to fetch from the document instead of the whole.
-      #
-      # Note that a maximum of 16 individual paths can be projected at a time due to a server limitation. If you need
-      # more than that, think about fetching less-generic paths or the full document straight away.
-      #
-      # @param [String, Array<String>] paths a path that should be loaded if present.
-      def project(*paths)
-        @projections ||= []
-        @projections |= paths.flatten # union with current projections
-      end
-
-      # @api private
-      # @return [Boolean] whether to use sparse arrays (default false)
-      attr_accessor :preserve_array_indexes
-
-      # @api private
-      # @return [Array<String>] list of paths to project
-      attr_accessor :projections
-
-      # @api private
-      # @return [Boolean]
-      def need_projected_get?
-        @with_expiry || !@projections.nil?
-      end
-    end
-
-    class GetAndLockOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetAndLockOptions] self
-      def initialize
-        @transcoder = JsonTranscoder.new
-        yield self if block_given?
-      end
-    end
-
-    class GetAndTouchOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetAndTouchOptions] self
-      def initialize
-        @transcoder = JsonTranscoder.new
-        yield self if block_given?
-      end
-    end
-
     class GetResult
+      extend Gem::Deprecate
+
       # @return [Integer] holds the CAS value of the fetched document
       attr_accessor :cas
 
       # @return [Integer] the expiration if fetched and present
-      attr_accessor :expiry
+      attr_writer :expiry
+
+      # @return [Error::CouchbaseError, nil] error associated with the result, or nil (used in {Collection#get_multi})
+      attr_accessor :error
+
+      # @return [Boolean] true if error was not associated with the result (useful for multi-operations)
+      def success?
+        !error
+      end
 
       # @return [String] The encoded content when loading the document
       # @api private
@@ -100,11 +47,18 @@ module Couchbase
       #
       # @return [Object]
       def content(transcoder = self.transcoder)
-        transcoder.decode(@encoded, @flags)
+        transcoder ? transcoder.decode(@encoded, @flags) : @encoded
+      end
+
+      # @return [Time] time when the document will expire
+      def expiry_time
+        Time.at(@expiry) if @expiry
       end
 
       # @yieldparam [GetResult] self
       def initialize
+        @expiry = nil
+        @error = nil
         yield self if block_given?
       end
 
@@ -114,39 +68,19 @@ module Couchbase
 
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
-    end
-
-    class GetAllReplicasOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
 
-      # @yieldparam [GetAllReplicasOptions] self
-      def initialize
-        yield self if block_given?
-      end
-    end
-
-    class GetAnyReplicaOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetAnyReplicaOptions] self
-      def initialize
-        yield self if block_given?
+      # @deprecated Use {#expiry_time}
+      # @return [Integer] the expiration if fetched and present
+      def expiry # rubocop:disable Style/TrivialAccessors will be removed in next major release
+        @expiry
       end
+      deprecate :expiry, :expiry_time, 2021, 1
     end
 
     class GetReplicaResult < GetResult
       # @return [Boolean] true if this result came from a replica
       attr_accessor :is_replica
-      alias_method :replica?, :is_replica
-    end
-
-    class ExistsOptions < CommonOptions
-      # @yieldparam [ExistsOptions] self
-      def initialize
-        yield self if block_given?
-      end
+      alias replica? is_replica
     end
 
     class ExistsResult
@@ -172,77 +106,6 @@ module Couchbase
       attr_accessor :partition_id
     end
 
-    class RemoveOptions < CommonOptions
-      # @return [Integer] Specifies a CAS value that will be taken into account on the server side for optimistic concurrency
-      attr_accessor :cas
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [RemoveOptions]
-      def initialize
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
-    class InsertOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # @return [Proc] transcoder used for encoding
-      attr_accessor :transcoder
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [InsertOptions]
-      def initialize
-        @transcoder = JsonTranscoder.new
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
-    class UpsertOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # @return [JsonTranscoder] transcoder used for encoding
-      attr_accessor :transcoder
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [UpsertOptions]
-      def initialize
-        @transcoder = JsonTranscoder.new
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
-    class ReplaceOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # @return [JsonTranscoder] transcoder used for encoding
-      attr_accessor :transcoder
-
-      # @return [Integer] Specifies a CAS value that will be taken into account on the server side for optimistic concurrency
-      attr_accessor :cas
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [ReplaceOptions]
-      def initialize
-        @transcoder = JsonTranscoder.new
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
     class MutationResult
       # @return [Integer] holds the CAS value of the document after the mutation
       attr_accessor :cas
@@ -250,36 +113,18 @@ module Couchbase
       # @return [MutationToken] if returned, holds the mutation token of the document after the mutation
       attr_accessor :mutation_token
 
-      # @yieldparam [MutationResult] self
-      def initialize
-        yield self if block_given?
-      end
-    end
-
-    class TouchOptions < CommonOptions
-      # @yieldparam [TouchOptions] self
-      def initialize
-        yield self if block_given?
-      end
-    end
+      # @return [Error::CouchbaseError, nil] error or nil (used in multi-operations like {Collection#upsert_multi},
+      #   {Collection#remove_multi})
+      attr_accessor :error
 
-    class UnlockOptions < CommonOptions
-      # @yieldparam [UnlockOptions] self
-      def initialize
-        yield self if block_given?
+      # @return [Boolean] true if error was not associated with the result (useful for multi-operations)
+      def success?
+        !error
       end
-    end
-
-    class LookupInOptions < CommonOptions
-      # @return [Boolean] For internal use only: allows access to deleted documents that are in 'tombstone' form
-      attr_accessor :access_deleted
-
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
 
-      # @yieldparam [LookupInOptions] self
+      # @yieldparam [MutationResult] self
       def initialize
-        @transcoder = JsonTranscoder.new
+        @error = nil
         yield self if block_given?
       end
     end
@@ -311,59 +156,35 @@ module Couchbase
 
       # @yieldparam [LookupInResult] self
       def initialize
+        @deleted = false
         yield self if block_given?
       end
 
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
 
-      private
-
-      def get_field_at_index(index)
-        if index >= 0 && index < encoded.size
-          field = encoded[index]
-          raise field.error unless field.success?
-          field
-        else
-          raise Error::PathInvalid, "Index is out of bounds: #{index}"
-        end
-      end
-    end
-
-    class MutateInOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # Describes how the outer document store semantics on subdoc should act
+      # @api private
       #
-      # * +:replace+: replace the document, fail if it does not exist. This is the default
-      # * +:upsert+: replace the document or create if it does not exist
-      # * +:insert+: create the document, fail if it exists
+      # @see MutateInOptions#create_as_deleted
       #
-      # @return [:replace, :upsert, :insert]
-      attr_accessor :store_semantics
+      # @return [Boolean] true if the document is a tombstone (created in deleted state)
+      def deleted?
+        @deleted
+      end
 
-      # @return [Integer] Specifies a CAS value that will be taken into account on the server side for optimistic concurrency
-      attr_accessor :cas
+      # @api private
+      attr_accessor :deleted
 
-      # @return [Boolean] For internal use only: allows access to deleted documents that are in 'tombstone' form
-      attr_accessor :access_deleted
+      private
 
-      # @return [Boolean] For internal use only: allows creating documents in 'tombstone' form
-      attr_accessor :create_as_deleted
+      def get_field_at_index(index)
+        raise Error::PathInvalid, "Index is out of bounds: #{index}" unless index >= 0 && index < encoded.size
 
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
+        field = encoded[index]
+        raise field.error unless field.success?
 
-      # @yieldparam [MutateInOptions]
-      def initialize
-        @durability_level = :none
-        @store_semantics = :replace
-        @transcoder = JsonTranscoder.new
-        yield self if block_given?
+        field
       end
-
-      attr_accessor :transcoder
     end
 
     class MutateInResult < MutationResult
@@ -383,6 +204,7 @@ module Couchbase
 
       # @yieldparam [MutateInResult] self
       def initialize
+        super
         yield self if block_given?
       end
 
@@ -393,7 +215,7 @@ module Couchbase
 
       # @api private
       def first_error
-        encoded[first_error_index].error
+        encoded[first_error_index].error unless success?
       end
 
       # @return [Array<SubDocumentField>] holds the encoded subdocument responses
@@ -407,16 +229,27 @@ module Couchbase
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
 
+      # @api private
+      #
+      # @see MutateInOptions#create_as_deleted
+      #
+      # @return [Boolean] true if the document is a tombstone (created in deleted state)
+      def deleted?
+        @deleted
+      end
+
+      # @api private
+      attr_accessor :deleted
+
       private
 
       def get_field_at_index(index)
-        if index >= 0 && index < encoded.size
-          field = encoded[index]
-          raise field.error unless field.success?
-          field
-        else
-          raise Error::PathInvalid, "Index is out of bounds: #{index}"
-        end
+        raise Error::PathInvalid, "Index is out of bounds: #{index}" unless index >= 0 && index < encoded.size
+
+        field = encoded[index]
+        raise field.error unless field.success?
+
+        field
       end
     end
 
@@ -458,7 +291,8 @@ module Couchbase
       #
       # [+:success+] Indicates a successful response in general.
       # [+:path_not_found+] The provided path does not exist in the document
-      # [+:path_mismatch+] One of path components treats a non-dictionary as a dictionary, or a non-array as an array, or value the path points to is not a number
+      # [+:path_mismatch+] One of path components treats a non-dictionary as a dictionary, or a non-array as an array, or value the path
+      #   points to is not a number
       # [+:path_invalid+] The path's syntax was incorrect
       # [+:path_too_big+] The path provided is too large: either the string is too long, or it contains too many components
       # [+:value_cannot_insert+] The value provided will invalidate the JSON if inserted

data/lib/couchbase/configuration.rb

@@ -0,0 +1,57 @@
+#  Copyright 2020-2021 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 "yaml"
+require "erb"
+
+module Couchbase
+  class Configuration
+    attr_accessor :connection_string
+    attr_accessor :username
+    attr_accessor :password
+
+    def initialize
+      @connection_string = "couchbase://localhost"
+    end
+
+    def load!(path, environment = default_environment_name)
+      settings = load_yaml(path, environment)
+      load_configuration(settings)
+    end
+
+    private
+
+    def load_configuration(settings)
+      configuration = settings.with_indifferent_access
+      @connection_string = configuration[:connection_string]
+      @username = configuration[:username]
+      @password = configuration[:password]
+    end
+
+    def load_yaml(path, environment)
+      file_content = ERB.new(File.read(path)).result
+      YAML.safe_load(file_content, aliases: :default)[environment]
+    end
+
+    def default_environment_name
+      if defined?(::Rails)
+        ::Rails.env
+      elsif defined?(::Sinatra)
+        ::Sinatra::Base.environment.to_s
+      else
+        ENV["RACK_ENV"] || ENV["COUCHBASE_ENV"] or raise ::Couchbase::Error::NoEnvironment
+      end
+    end
+  end
+end