couchbase 3.0.0 → 3.0.1

data/lib/couchbase/cluster.rb

@@ -69,6 +69,7 @@ module Couchbase
         client_context_id: options.client_context_id,
         max_parallelism: options.max_parallelism,
         readonly: options.readonly,
+        flex_index: options.flex_index,
         scan_wait: options.scan_wait,
         scan_cap: options.scan_cap,
         pipeline_batch: options.pipeline_batch,
@@ -164,6 +165,7 @@ module Couchbase
         limit: options.limit,
         skip: options.skip,
         explain: options.explain,
+        disable_scoring: options.disable_scoring,
         highlight_style: options.highlight_style,
         highlight_fields: options.highlight_fields,
         fields: options.fields,
@@ -280,15 +282,43 @@ module Couchbase
       Management::SearchIndexManager.new(@backend)
     end
 
+    # Closes all connections to services and free allocated resources
+    #
+    # @return [void]
     def disconnect
       @backend.close
     end
 
-    def diagnostics(options = DiagnosticsOptions.new) end
+    # Creates diagnostic report that can be used to determine the health of the network connections.
+    #
+    # It does not proactively perform any I/O against the network
+    #
+    # @return [DiagnosticsResult]
+    def diagnostics(options = DiagnosticsOptions.new)
+      resp = @backend.diagnostics(options.report_id)
+      pp resp
+      DiagnosticsResult.new do |res|
+        res.version = resp[:version]
+        res.id = resp[:id]
+        res.sdk = resp[:sdk]
+        resp[:services].each do |type, svcs|
+          res.services[type] = svcs.map do |svc|
+            DiagnosticsResult::ServiceInfo.new do |info|
+              info.id = svc[:id]
+              info.state = svc[:state]
+              info.last_activity_us = svc[:last_activity_us]
+              info.remote = svc[:remote]
+              info.local = svc[:local]
+            end
+          end
+        end
+      end
+    end
 
     class ClusterOptions
       attr_accessor :authenticator
 
+      # @yieldparam [ClusterOptions] self
       def initialize
         yield self if block_given?
       end
@@ -303,9 +333,89 @@ module Couchbase
       # @return [String] Holds custom report id.
       attr_accessor :report_id
 
+      # @yieldparam [DiagnosticsOptions] self
+      def initialize
+        yield self if block_given?
+      end
+    end
+
+    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 [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[:last_activity_us] = @last_activity_us if defined? @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 = Hash.new
         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
 
     private

data/lib/couchbase/collection_options.rb

@@ -12,6 +12,8 @@
 #  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"
@@ -87,11 +89,13 @@ module Couchbase
     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 [String] The encoded content when loading the document
       # @api private
@@ -106,8 +110,14 @@ module Couchbase
         transcoder.decode(@encoded, @flags)
       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
         yield self if block_given?
       end
 
@@ -117,6 +127,13 @@ module Couchbase
 
       # @return [JsonTranscoder] The default transcoder which should be used
       attr_accessor :transcoder
+
+      # @deprecated Use {#expiry_time}
+      # @return [Integer] the expiration if fetched and present
+      def expiry
+        @expiry
+      end
+      deprecate :expiry, :expiry_time, 2021, 1
     end
 
     class GetAllReplicasOptions < CommonOptions

data/lib/couchbase/errors.rb

@@ -195,6 +195,9 @@ module Couchbase
     class IndexNotReady < CouchbaseError
     end
 
+    class ConsistencyMismatch < CouchbaseError
+    end
+
     # View exceptions
 
     class DesignDocumentNotFound < CouchbaseError

data/lib/couchbase/management/bucket_manager.rb

@@ -14,6 +14,8 @@
 
 require "couchbase/errors"
 
+require "rubygems/deprecate"
+
 module Couchbase
   module Management
     class BucketManager
@@ -196,6 +198,8 @@ module Couchbase
     end
 
     class BucketSettings
+      extend Gem::Deprecate
+
       # @return [String] name of the bucket
       attr_accessor :name
 
@@ -214,8 +218,25 @@ module Couchbase
       # @return [:couchbase, :memcached, :ephemeral] the type of the bucket. Defaults to +:couchbase+
       attr_accessor :bucket_type
 
-      # @return [:full, :value_only] the eviction policy to use
-      attr_accessor :ejection_policy
+      # Eviction policy to use
+      #
+      # :full:: During ejection, only the value will be ejected (key and metadata will remain in memory). Value Ejection
+      #         needs more system memory, but provides better performance than Full Ejection. This value is only valid for
+      #         buckets of type +:couchbase+.
+      #
+      # :value_only:: During ejection, everything (including key, metadata, and value) will be ejected. Full Ejection
+      #               reduces the memory overhead requirement, at the cost of performance. This value is only valid for
+      #               buckets of type +:couchbase+.
+      #
+      # :no_eviction:: Couchbase Server keeps all data until explicitly deleted, but will reject any new data if you
+      #                reach the quota (dedicated memory) you set for your bucket. This value is only valid for buckets
+      #                of type +:ephemeral+.
+      #
+      # :not_recently_used:: When the memory quota is reached, Couchbase Server ejects data that has not been used
+      #                      recently. This value is only valid for buckets of type +:ephemeral+.
+      #
+      # @return [:full, :value_only, :no_eviction, :not_recently_used] the eviction policy to use
+      attr_accessor :eviction_policy
 
       # @return [Integer] value of TTL (expiration) in seconds for new documents created without expiration
       attr_accessor :max_expiry
@@ -232,6 +253,18 @@ module Couchbase
         @healthy
       end
 
+      # @deprecated Use {#eviction_policy} instead
+      def ejection_policy
+        @eviction_policy
+      end
+      deprecate :ejection_policy, :eviction_policy, 2021, 1
+
+      # @deprecated Use {#eviction_policy=} instead
+      def ejection_policy=(val)
+        @eviction_policy = val
+      end
+      deprecate :ejection_policy=, :eviction_policy=, 2021, 1
+
       # @yieldparam [BucketSettings] self
       def initialize
         @bucket_type = :couchbase
@@ -244,7 +277,7 @@ module Couchbase
         @max_expiry = 0
         @compression_mode = :passive
         @conflict_resolution_type = :sequence_number
-        @ejection_policy = :value_only
+        @eviction_policy = :value_only
         yield self if block_given?
       end
     end

data/lib/couchbase/management/search_index_manager.rb

@@ -99,6 +99,37 @@ module Couchbase
         res[:count]
       end
 
+      # Retrieves metrics, timings and counters for a given index
+      #
+      # @api uncommitted
+      #
+      # @param [String] index_name name of the index
+      # @param [GetIndexStatsOptions] options
+      #
+      # @return [Integer]
+      #
+      # @raise [ArgumentError]
+      # @raise [Error::IndexNotFound]
+      def get_index_stats(index_name, options = GetIndexStatsOptions.new)
+        res = @backend.search_index_get_stats(index_name, options.timeout)
+        JSON.parse(res)
+      end
+
+      # Retrieves statistics on search service. Information is provided on documents, partition indexes, mutations,
+      # compactions, queries, and more.
+      #
+      # @api uncommitted
+      #
+      # @param [GetIndexStatsOptions] options
+      #
+      # @return [Integer]
+      #
+      # @raise [ArgumentError]
+      def get_stats(options = GetIndexStatsOptions.new)
+        res = @backend.search_get_stats(options.timeout)
+        JSON.parse(res)
+      end
+
       # Pauses updates and maintenance for the index
       #
       # @param [String] index_name name of the index
@@ -235,7 +266,17 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
-        # @yieldparam [GetIndexedDocumentOptions] self
+        # @yieldparam [GetIndexedDocumentCountOptions] self
+        def initialize
+          yield self if block_given?
+        end
+      end
+
+      class GetIndexStatsOptions
+        # @return [Integer] the time in milliseconds allowed for the operation to complete
+        attr_accessor :timeout
+
+        # @yieldparam [GetStatsOptions] self
         def initialize
           yield self if block_given?
         end

data/lib/couchbase/management/user_manager.rb

@@ -14,6 +14,8 @@
 
 require "couchbase/errors"
 
+require "time"
+
 module Couchbase
   module Management
     class UserManager
@@ -26,22 +28,24 @@ module Couchbase
 
       # Get a user
       #
-      # @param [String] user_name ID of the user
+      # @param [String] username ID of the user
       # @param [GetUserOptions] options
       #
       # @return [UserAndMetadata]
       #
       # @raise [ArgumentError]
       # @raise [Error::UserNotFound]
-      def get_user(user_name, options = GetUserOptions.new)
-        # GET /settings/rbac/users/#{options.domain}/#{user_name}
+      def get_user(username, options = GetUserOptions.new)
+        resp = @backend.user_get(options.domain, username, options.timeout)
+        extract_user(resp)
       end
 
       # Gets all users
       #
       # @return [Array<UserAndMetadata>]
       def get_all_users(options = GetAllUsersOptions.new)
-        # GET /settings/rbac/users/#{options.domain}
+        resp = @backend.user_get_all(options.domain, options.timeout)
+        resp.map(&method(:extract_user))
       end
 
       # Creates or updates a user
@@ -51,15 +55,31 @@ module Couchbase
       #
       # @raise [ArgumentError]
       def upsert_user(user, options = UpsertUserOptions.new)
-        # PUT /settings/rbac/users/#{options.domain}/#{user_name}
+        @backend.user_upsert(
+          options.domain,
+          {
+            username: user.username,
+            display_name: user.display_name,
+            groups: user.groups,
+            password: user.password,
+            roles: user.roles.map do |role|
+                     {
+                       name: role.name,
+                       bucket: role.bucket,
+                       scope: role.scope,
+                       collection: role.collection,
+                     }
+                   end,
+          }, options.timeout
+        )
       end
 
       # Removes a user
       #
-      # @param [String] user_name ID of the user
+      # @param [String] username ID of the user
       # @param [DropUserOptions] options
-      def drop_user(user_name, options = DropUserOptions.new)
-        # DELETE /settings/rbac/users/#{options.domain}/#{user_name}
+      def drop_user(username, options = DropUserOptions.new)
+        @backend.user_drop(options.domain, username, options.timeout)
       end
 
       # Gets all roles supported by the server
@@ -68,7 +88,17 @@ module Couchbase
       #
       # @return [Array<RoleAndDescription>]
       def get_roles(options = GetRolesOptions.new)
-        # GET /settings/rbac/roles
+        resp = @backend.role_get_all(options.timeout)
+        resp.map do |r|
+          RoleAndDescription.new do |role|
+            role.name = r[:name]
+            role.display_name = r[:display_name]
+            role.description = r[:description]
+            role.bucket = r[:bucket]
+            role.scope = r[:scope]
+            role.collection = r[:collection]
+          end
+        end
       end
 
       # Gets a group
@@ -80,7 +110,8 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::GroupNotFound]
       def get_group(group_name, options = GetGroupOptions.new)
-        # GET /settings/rbac/groups/#{group_name}
+        resp = @backend.group_get(group_name, options.timeout)
+        extract_group(resp)
       end
 
       # Gets all groups
@@ -89,7 +120,8 @@ module Couchbase
       #
       # @return [Array<Group>]
       def get_all_groups(options = GetAllGroupsOptions.new)
-        # GET /settings/rbac/groups
+        resp = @backend.group_get_all(options.timeout)
+        resp.map(&method(:extract_group))
       end
 
       # Creates or updates a group
@@ -100,7 +132,19 @@ module Couchbase
       # @raise [ArgumentError]
       # @raise [Error::GroupNotFound]
       def upsert_group(group, options = UpsertGroupOptions.new)
-        # PUT /settings/rbac/groups/#{group.name}
+        @backend.group_upsert({
+          name: group.name,
+          description: group.description,
+          ldap_group_reference: group.ldap_group_reference,
+          roles: group.roles.map do |role|
+                   {
+                     name: role.name,
+                     bucket: role.bucket,
+                     scope: role.scope,
+                     collection: role.collection,
+                   }
+                 end,
+        }, options.timeout)
       end
 
       # Removes a group
@@ -109,56 +153,58 @@ module Couchbase
       # @param [DropGroupOptions] options
       #
       # @raise [Error::GroupNotFound]
-      def drop_group(group_name, options = DropGroupOptions.new) end
+      def drop_group(group_name, options = DropGroupOptions.new)
+        @backend.group_drop(group_name, options.timeout)
+      end
 
       class GetUserOptions
         # @return [:local, :external] Name of the user's domain. Defaults to +:local+
-        attr_accessor :domain_name
+        attr_accessor :domain
 
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
         def initialize
-          @domain_name = :local
+          @domain = :local
           yield self if block_given?
         end
       end
 
       class GetAllUsersOptions
         # @return [:local, :external] Name of the user's domain. Defaults to +:local+
-        attr_accessor :domain_name
+        attr_accessor :domain
 
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
         def initialize
-          @domain_name = :local
+          @domain = :local
           yield self if block_given?
         end
       end
 
       class UpsertUserOptions
         # @return [:local, :external] Name of the user's domain. Defaults to +:local+
-        attr_accessor :domain_name
+        attr_accessor :domain
 
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
         def initialize
-          @domain_name = :local
+          @domain = :local
           yield self if block_given?
         end
       end
 
       class DropUserOptions
         # @return [:local, :external] Name of the user's domain. Defaults to +:local+
-        attr_accessor :domain_name
+        attr_accessor :domain
 
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
         def initialize
-          @domain_name = :local
+          @domain = :local
           yield self if block_given?
         end
       end
@@ -207,6 +253,65 @@ module Couchbase
           yield self if block_given?
         end
       end
+
+      private
+
+      def extract_group(resp)
+        Group.new do |group|
+          group.name = resp[:name]
+          group.description = resp[:description]
+          group.ldap_group_reference = resp[:ldap_group_reference]
+          if resp[:roles]
+            group.roles = resp[:roles].map do |r|
+              Role.new do |role|
+                role.name = r[:name]
+                role.bucket = r[:bucket]
+                role.scope = r[:scope]
+                role.collection = r[:collection]
+              end
+            end
+          end
+        end
+      end
+
+      def extract_user(resp)
+        UserAndMetadata.new do |user|
+          user.domain = resp[:domain]
+          user.username = resp[:username]
+          user.display_name = resp[:display_name]
+          user.groups = resp[:groups]
+          user.external_groups = resp[:external_groups]
+          user.password_changed = Time.parse(resp[:password_changed]) if resp[:password_changed]
+          if resp[:roles]
+            user.roles = resp[:roles].map do |r|
+              Role.new do |role|
+                role.name = r[:name]
+                role.bucket = r[:bucket]
+                role.scope = r[:scope]
+                role.collection = r[:collection]
+              end
+            end
+          end
+          if resp[:effective_roles]
+            user.effective_roles = resp[:effective_roles].map do |r|
+              RoleAndOrigins.new do |role|
+                role.name = r[:name]
+                role.bucket = r[:bucket]
+                role.scope = r[:scope]
+                role.collection = r[:collection]
+                if r[:origins]
+                  role.origins = r[:origins].map do |o|
+                    Origin.new do |origin|
+                      origin.type = o[:type]
+                      origin.name = o[:name]
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
     end
 
     class Role
@@ -216,20 +321,23 @@ module Couchbase
       # @return [String]
       attr_accessor :bucket
 
+      # @return [String]
+      attr_accessor :scope
+
+      # @return [String]
+      attr_accessor :collection
+
       def initialize
         yield self if block_given?
       end
     end
 
-    class RoleAndDescription
-      # @return [Role]
-      attr_reader :role
-
+    class RoleAndDescription < Role
       # @return [String]
-      attr_reader :display_name
+      attr_accessor :display_name
 
       # @return [String]
-      attr_reader :description
+      attr_accessor :description
 
       def initialize
         yield self if block_given?
@@ -238,31 +346,29 @@ module Couchbase
 
     class Origin
       # @return [String]
-      attr_reader :type
+      attr_writer :type
 
       # @return [String]
-      attr_reader :name
+      attr_writer :name
 
       def initialize
         yield self if block_given?
       end
     end
 
-    class RoleAndOrigins
-      # @return [Role]
-      attr_reader :role
-
+    class RoleAndOrigins < Role
       # @return [Array<Origin>]
-      attr_reader :origins
+      attr_writer :origins
 
       def initialize
+        @origins = []
         yield self if block_given?
       end
     end
 
     class User
       # @return [String]
-      attr_accessor :user_name
+      attr_accessor :username
 
       # @return [String]
       attr_accessor :display_name
@@ -274,48 +380,49 @@ module Couchbase
       attr_accessor :roles
 
       # @return [String]
-      attr_writer :password
+      attr_accessor :password
 
       def initialize
+        @groups = []
+        @roles = []
         yield self if block_given?
       end
     end
 
-    class UserAndMetadata
+    class UserAndMetadata < User
       # @return [:local, :external]
-      attr_reader :domain
-
-      # @return [User]
-      attr_reader :user
+      attr_accessor :domain
 
       # @return [Array<RoleAndOrigins>]
-      attr_reader :effective_roles
+      attr_accessor :effective_roles
 
       # @return [Time]
-      attr_reader :password_changed
+      attr_accessor :password_changed
 
       # @return [Array<String>]
-      attr_reader :external_groups
+      attr_accessor :external_groups
 
       def initialize
+        @effective_roles = []
         yield self if block_given?
       end
     end
 
     class Group
       # @return [String]
-      attr_reader :name
+      attr_accessor :name
 
       # @return [String]
-      attr_reader :description
+      attr_accessor :description
 
       # @return [Array<Role>]
-      attr_reader :roles
+      attr_accessor :roles
 
       # @return [String]
-      attr_reader :ldap_group_reference
+      attr_accessor :ldap_group_reference
 
       def initialize
+        @roles = []
         yield self if block_given?
       end
     end