couchbase 3.0.0.alpha.4-universal-darwin-19 → 3.0.2-universal-darwin-19

data/lib/couchbase/datastructures/couchbase_set.rb

@@ -0,0 +1,128 @@
+#    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/collection"
+require "couchbase/options"
+require "couchbase/errors"
+
+module Couchbase
+  module Datastructures
+    # A {CouchbaseSet} is implements +Enumerable+ interface and backed by {Collection} document (more specifically
+    # a JSON array).
+    #
+    # Note: sets are restricted to containing primitive types only due to server-side comparison restrictions.
+    class CouchbaseSet
+      include Enumerable
+
+      # Create a new List, backed by the document identified by +id+ in +collection+.
+      #
+      # @param [String] id the id of the document to back the set.
+      # @param [Collection] collection the collection through which to interact with the document.
+      # @param [Options::CouchbaseSet] options customization of the datastructure
+      def initialize(id, collection, options = Options::CouchbaseSet.new)
+        @id = id
+        @collection = collection
+        @options = options
+        @cas = 0
+      end
+
+      # Calls the given block once for each element in the set, passing that element as a parameter.
+      #
+      # @yieldparam [Object] item
+      #
+      # @return [CouchbaseSet, Enumerable]
+      def each
+        if block_given?
+          begin
+            result = @collection.get(@id, @options.get_options)
+            current = result.content
+            @cas = result.cas
+          rescue Error::DocumentNotFound
+            current = []
+            @cas = 0
+          end
+          current.each do |entry|
+            yield entry
+          end
+          self
+        else
+          enum_for(:each)
+        end
+      end
+
+      # @return [Integer] returns the number of elements in the set.
+      def length
+        result = @collection.lookup_in(@id, [
+                                         LookupInSpec.count(""),
+                                       ], @options.lookup_in_options)
+        result.content(0)
+      rescue Error::DocumentNotFound
+        0
+      end
+
+      alias size length
+
+      # @return [Boolean] returns true if set is empty
+      def empty?
+        size.zero?
+      end
+
+      # Adds the given value to the set
+      #
+      # @param [Object] obj
+      # @return [CouchbaseSet]
+      def add(obj)
+        begin
+          @collection.mutate_in(@id, [
+                                  MutateInSpec.array_add_unique("", obj),
+                                ], @options.mutate_in_options)
+        rescue Error::PathExists
+          # ignore
+        end
+        self
+      end
+
+      # Removes all elements from the set
+      def clear
+        @collection.remove(@id, @options.remove_options)
+        nil
+      rescue Error::DocumentNotFound
+        nil
+      end
+
+      # Deletes the given object from the set.
+      #
+      # @return [Boolean] true if the value has been removed
+      def delete(obj)
+        result = @collection.get(@id)
+        idx = result.content.index(obj)
+        return false unless idx
+
+        options = Collection::MutateInOptions.new
+        options.cas = result.cas
+        @collection.mutate_in(@id, [
+                                MutateInSpec.remove("[#{idx}]"),
+                              ], options)
+        true
+      rescue Error::CasMismatch
+        retry
+      rescue Error::DocumentNotFound
+        false
+      end
+    end
+
+    # @api private
+    CouchbaseSetOptions = ::Couchbase::Options::CouchbaseSet
+  end
+end

data/lib/couchbase/diagnostics.rb

@@ -0,0 +1,181 @@
+#    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.
+
+module Couchbase
+  class DiagnosticsResult
+    class ServiceInfo
+      # @return [String] endpoint unique identifier
+      attr_accessor :id
+
+      # Possible states are:
+      #
+      # :disconnected:: the endpoint is not reachable
+      # :connecting:: currently connecting (includes auth, handshake, etc.)
+      # :connected:: connected and ready
+      # :disconnecting:: disconnecting (after being connected)
+      #
+      # @return [Symbol] state of the endpoint
+      attr_accessor :state
+
+      # @return [String, nil] optional string with additional explanation for the state
+      attr_accessor :details
+
+      # @return [Integer] how long ago the endpoint was active (in microseconds)
+      attr_accessor :last_activity_us
+
+      # @return [String] remote address of the connection
+      attr_accessor :remote
+
+      # @return [String] local address of the connection
+      attr_accessor :local
+
+      # @yieldparam [ServiceInfo] self
+      def initialize
+        yield self if block_given?
+      end
+
+      def to_json(*args)
+        data = {
+          id: @id,
+          state: @state,
+          remote: @remote,
+          local: @local,
+        }
+        data[:details] = @details if @details
+        data[:last_activity_us] = @last_activity_us if @last_activity_us
+        data.to_json(*args)
+      end
+    end
+
+    # @return [String] report id
+    attr_accessor :id
+
+    # @return [String] SDK identifier
+    attr_accessor :sdk
+
+    # Returns information about currently service endpoints, that known to the library at the moment.
+    #
+    # :kv:: Key/Value data service
+    # :query:: N1QL query service
+    # :analytics:: Analtyics service
+    # :search:: Full text search service
+    # :views:: Views service
+    # :mgmt:: Management service
+    #
+    # @return [Hash<Symbol, ServiceInfo>] map service types to info
+    attr_accessor :services
+
+    # @yieldparam [DiagnosticsResult] self
+    def initialize
+      @services = {}
+      yield self if block_given?
+    end
+
+    # @api private
+    # @return [Integer] version
+    attr_accessor :version
+
+    def to_json(*args)
+      {
+        version: @version,
+        id: @id,
+        sdk: @sdk,
+        services: @services,
+      }.to_json(*args)
+    end
+  end
+
+  class PingResult
+    class ServiceInfo
+      # @return [String] endpoint unique identifier
+      attr_accessor :id
+
+      # Possible states are:
+      #
+      # :ok:: endpoint is healthy
+      # :timeout:: endpoint didn't respond in time
+      # :error:: request to endpoint has failed, see {#error} for additional details
+      #
+      # @return [Symbol] state of the endpoint
+      attr_accessor :state
+
+      # @return [String, nil] optional string with additional explanation for the state
+      attr_accessor :error
+
+      # @return [Integer] how long ago the endpoint was active (in microseconds)
+      attr_accessor :latency
+
+      # @return [String] remote address of the connection
+      attr_accessor :remote
+
+      # @return [String] local address of the connection
+      attr_accessor :local
+
+      # @yieldparam [ServiceInfo] self
+      def initialize
+        @error = nil
+        yield self if block_given?
+      end
+
+      def to_json(*args)
+        data = {
+          id: @id,
+          state: @state,
+          remote: @remote,
+          local: @local,
+          latency: @latency,
+        }
+        data[:error] = @error if @error
+        data.to_json(*args)
+      end
+    end
+
+    # @return [String] report id
+    attr_accessor :id
+
+    # @return [String] SDK identifier
+    attr_accessor :sdk
+
+    # Returns information about currently service endpoints, that known to the library at the moment.
+    #
+    # :kv:: Key/Value data service
+    # :query:: N1QL query service
+    # :analytics:: Analtyics service
+    # :search:: Full text search service
+    # :views:: Views service
+    # :mgmt:: Management service
+    #
+    # @return [Hash<Symbol, ServiceInfo>] map service types to info
+    attr_accessor :services
+
+    # @yieldparam [DiagnosticsResult] self
+    def initialize
+      @services = {}
+      yield self if block_given?
+    end
+
+    # @api private
+    # @return [Integer] version
+    attr_accessor :version
+
+    def to_json(*args)
+      {
+        version: @version,
+        id: @id,
+        sdk: @sdk,
+        services: @services,
+      }.to_json(*args)
+    end
+  end
+end

data/lib/couchbase/errors.rb

@@ -14,211 +14,224 @@
 
 module Couchbase
   module Error
+    class CouchbaseError < StandardError
+    end
+
     # Common exceptions
 
-    class RequestCanceled < StandardError
+    class RequestCanceled < CouchbaseError
     end
 
-    class InvalidArgument < StandardError
+    class InvalidArgument < ArgumentError
     end
 
-    class ServiceNotAvailable < StandardError
+    class ServiceNotAvailable < CouchbaseError
     end
 
-    class InternalServerFailure < StandardError
+    class InternalServerFailure < CouchbaseError
     end
 
-    class AuthenticationFailure < StandardError
+    class AuthenticationFailure < CouchbaseError
     end
 
-    class TemporaryFailure < StandardError
+    class TemporaryFailure < CouchbaseError
     end
 
-    class ParsingFailure < StandardError
+    class ParsingFailure < CouchbaseError
     end
 
-    class CasMismatch < StandardError
+    class CasMismatch < CouchbaseError
     end
 
-    class BucketNotFound < StandardError
+    class BucketNotFound < CouchbaseError
     end
 
-    class CollectionNotFound < StandardError
+    class CollectionNotFound < CouchbaseError
     end
 
-    class ScopeNotFound < StandardError
+    class ScopeNotFound < CouchbaseError
     end
 
-    class IndexNotFound < StandardError
+    class IndexNotFound < CouchbaseError
     end
 
-    class IndexExists < StandardError
+    class IndexExists < CouchbaseError
     end
 
-    class EncodingFailure < StandardError
+    class EncodingFailure < CouchbaseError
     end
 
-    class DecodingFailure < StandardError
+    class DecodingFailure < CouchbaseError
     end
 
-    class UnsupportedOperation < StandardError
+    class UnsupportedOperation < CouchbaseError
     end
 
-    class AmbiguousTimeout < StandardError
+    class Timeout < CouchbaseError
     end
 
-    class UnambiguousTimeout < StandardError
+    class AmbiguousTimeout < Timeout
     end
 
-    class FeatureNotAvailable < StandardError
+    class UnambiguousTimeout < Timeout
+    end
+
+    class FeatureNotAvailable < CouchbaseError
     end
 
     # KeyValue exceptions
 
-    class DocumentNotFound < StandardError
+    class DocumentNotFound < CouchbaseError
     end
 
-    class DocumentIrretrievable < StandardError
+    class DocumentIrretrievable < CouchbaseError
     end
 
-    class DocumentLocked < StandardError
+    class DocumentLocked < CouchbaseError
     end
 
-    class ValueTooLarge < StandardError
+    class ValueTooLarge < CouchbaseError
     end
 
-    class DocumentExists < StandardError
+    class DocumentExists < CouchbaseError
     end
 
-    class DurabilityLevelNotAvailable < StandardError
+    class DurabilityLevelNotAvailable < CouchbaseError
     end
 
-    class DurabilityImpossible < StandardError
+    class DurabilityImpossible < CouchbaseError
     end
 
-    class DurabilityAmbiguous < StandardError
+    class DurabilityAmbiguous < CouchbaseError
     end
 
-    class DurableWriteInProgress < StandardError
+    class DurableWriteInProgress < CouchbaseError
     end
 
-    class DurableWriteReCommitInProgress < StandardError
+    class DurableWriteReCommitInProgress < CouchbaseError
     end
 
-    class PathNotFound < StandardError
+    class PathNotFound < CouchbaseError
     end
 
-    class PathMismatch < StandardError
+    class PathMismatch < CouchbaseError
     end
 
-    class PathInvalid < StandardError
+    class PathInvalid < CouchbaseError
     end
 
-    class PathTooDeep < StandardError
+    class PathTooDeep < CouchbaseError
     end
 
-    class PathTooBig < StandardError
+    class PathTooBig < CouchbaseError
     end
 
-    class ValueTooDeep < StandardError
+    class ValueTooDeep < CouchbaseError
     end
 
-    class ValueInvalid < StandardError
+    class ValueInvalid < CouchbaseError
     end
 
-    class DocumentNotJson < StandardError
+    class DocumentNotJson < CouchbaseError
     end
 
-    class NumberTooBig < StandardError
+    class NumberTooBig < CouchbaseError
     end
 
-    class DeltaInvalid < StandardError
+    class DeltaInvalid < CouchbaseError
     end
 
-    class PathExists < StandardError
+    class PathExists < CouchbaseError
     end
 
-    class XattrUnknownMacro < StandardError
+    class XattrUnknownMacro < CouchbaseError
     end
 
-    class XattrInvalidKeyCombo < StandardError
+    class XattrInvalidKeyCombo < CouchbaseError
     end
 
-    class XattrUnknownVirtualAttribute < StandardError
+    class XattrUnknownVirtualAttribute < CouchbaseError
     end
 
-    class XattrCannotModifyVirtualAttribute < StandardError
+    class XattrCannotModifyVirtualAttribute < CouchbaseError
     end
 
     # Query exceptions
 
-    class PlanningFailure < StandardError
+    class PlanningFailure < CouchbaseError
     end
 
-    class IndexFailure < StandardError
+    class IndexFailure < CouchbaseError
     end
 
-    class PreparedStatementFailure < StandardError
+    class PreparedStatementFailure < CouchbaseError
     end
 
-
     # Analytics exceptions
 
-    class CompilationFailure < StandardError
+    class CompilationFailure < CouchbaseError
     end
 
-    class JobQueueFull < StandardError
+    class JobQueueFull < CouchbaseError
     end
 
-    class DatasetNotFound < StandardError
+    class DatasetNotFound < CouchbaseError
     end
 
-    class DatasetExists < StandardError
+    class DatasetExists < CouchbaseError
     end
 
-    class DataverseExists < StandardError
+    class DataverseExists < CouchbaseError
     end
 
-    class DataverseNotFound < StandardError
+    class DataverseNotFound < CouchbaseError
+    end
+
+    class LinkNotFound < CouchbaseError
+    end
+
+    # Search exceptions
+
+    class IndexNotReady < CouchbaseError
     end
 
-    class LinkNotFound < StandardError
+    class ConsistencyMismatch < CouchbaseError
     end
 
     # View exceptions
 
-    class DesignDocumentNotFound < StandardError
+    class DesignDocumentNotFound < CouchbaseError
     end
 
-    class ViewNotFound < StandardError
+    class ViewNotFound < CouchbaseError
     end
 
     # Management exceptions
 
-    class CollectionExists < StandardError
+    class CollectionExists < CouchbaseError
     end
 
-    class ScopeExists < StandardError
+    class ScopeExists < CouchbaseError
     end
 
-    class UserExists < StandardError
+    class UserExists < CouchbaseError
     end
 
-    class BucketExists < StandardError
+    class BucketExists < CouchbaseError
     end
 
-    class BucketNotFlushable < StandardError
+    class BucketNotFlushable < CouchbaseError
     end
 
-    class GroupNotFound < StandardError
+    class GroupNotFound < CouchbaseError
     end
 
-    class UserNotFound < StandardError
+    class UserNotFound < CouchbaseError
     end
 
     # Library-specific exceptions
 
-    class BackendError < StandardError
+    class BackendError < CouchbaseError
     end
   end
-end
+end