couchbase 3.0.0.beta.1 → 3.1.0

data/lib/couchbase/management/query_index_manager.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.
@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class QueryIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -40,6 +40,9 @@ module Couchbase
             index.is_primary = idx[:is_primary]
             index.type = idx[:type]
             index.state = idx[:state]
+            index.bucket = idx[:bucket_id]
+            index.collection = idx[:collection_id]
+            index.scope = idx[:scope_id]
             index.key_space = idx[:keyspace_id]
             index.name_space = idx[:namespace_id]
             index.index_key = idx[:index_key]
@@ -61,10 +64,12 @@ module Couchbase
       # @raise [Error::IndexExists]
       def create_index(bucket_name, index_name, fields, options = CreateIndexOptions.new)
         @backend.query_index_create(bucket_name, index_name, fields, {
-            ignore_if_exists: options.ignore_if_exists,
-            condition: options.condition,
-            deferred: options.deferred,
-            num_replicas: options.num_replicas,
+          ignore_if_exists: options.ignore_if_exists,
+          condition: options.condition,
+          deferred: options.deferred,
+          num_replicas: options.num_replicas,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
       end
 
@@ -79,9 +84,11 @@ module Couchbase
       # @raise [Error::IndexExists]
       def create_primary_index(bucket_name, options = CreatePrimaryIndexOptions.new)
         @backend.query_index_create_primary(bucket_name, {
-            ignore_if_exists: options.ignore_if_exists,
-            deferred: options.deferred,
-            num_replicas: options.num_replicas,
+          ignore_if_exists: options.ignore_if_exists,
+          deferred: options.deferred,
+          num_replicas: options.num_replicas,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
       end
 
@@ -97,7 +104,9 @@ module Couchbase
       # @raise [Error::IndexNotFound]
       def drop_index(bucket_name, index_name, options = DropIndexOptions.new)
         @backend.query_index_drop(bucket_name, index_name, {
-            ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
         true
       end
@@ -113,8 +122,10 @@ module Couchbase
       # @raise [Error::IndexNotFound]
       def drop_primary_index(bucket_name, options = DropPrimaryIndexOptions.new)
         @backend.query_index_drop_primary(bucket_name, {
-            ignore_if_does_not_exist: options.ignore_if_does_not_exist,
-            index_name: options.index_name,
+          ignore_if_does_not_exist: options.ignore_if_does_not_exist,
+          index_name: options.index_name,
+          scope_name: options.scope_name,
+          collection_name: options.collection_name,
         }, options.timeout)
         true
       end
@@ -135,13 +146,15 @@ module Couchbase
       #
       # @param [String] bucket_name name of the bucket
       # @param [Array<String>] index_names names of the indexes to watch
-      # @param [Integer] timeout
+      # @param [Integer, #in_milliseconds] timeout
       # @param [WatchIndexesOptions] options
       #
       # @raise [ArgumentError]
       # @raise [Error::IndexNotFound]
       def watch_indexes(bucket_name, index_names, timeout, options = WatchIndexesOptions.new)
-        @backend.query_index_watch(bucket_name, index_names, timeout, {})
+        @backend.query_index_watch(bucket_name, index_names, timeout, {
+          watch_primary: options.watch_primary,
+        })
       end
 
       class GetAllIndexOptions
@@ -170,6 +183,12 @@ module Couchbase
         # @return [String] condition to apply to the index
         attr_accessor :condition
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [CreateIndexOptions] self
         def initialize
           @ignore_if_exists = false
@@ -193,6 +212,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [CreatePrimaryIndexOptions] self
         def initialize
           @ignore_if_exists = false
@@ -207,6 +232,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [DropIndexOptions] self
         def initialize
           @ignore_if_does_not_exist = false
@@ -224,6 +255,12 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @return [String] the name of the scope
+        attr_accessor :scope_name
+
+        # @return [String] the name of the collection
+        attr_accessor :collection_name
+
         # @yieldparam [DropPrimaryIndexOptions] self
         def initialize
           @ignore_if_does_not_exist = false
@@ -258,7 +295,7 @@ module Couchbase
 
       # @return [Boolean] true if this is a primary index
       attr_accessor :is_primary
-      alias_method :primary?, :is_primary
+      alias primary? is_primary
 
       # @return [:gsi, :view] type of the index
       attr_accessor :type
@@ -266,6 +303,15 @@ module Couchbase
       # @return [Symbol] state
       attr_accessor :state
 
+      # @return [String, nil] the name of the bucket
+      attr_accessor :bucket
+
+      # @return [String, nil] the name of the scope
+      attr_accessor :scope
+
+      # @return [String, nil] the name of the collection
+      attr_accessor :collection
+
       # @return [String] the key space for the index, typically the bucket name.
       attr_accessor :key_space
 
@@ -279,7 +325,6 @@ module Couchbase
       #   instance, it will show the indexed fields in an escaped format (surrounded by backticks).
       attr_accessor :index_key
 
-
       # @return [String] the string representation of the index's condition (the WHERE clause of the index),
       #   or an empty Optional if no condition was set.
       #

data/lib/couchbase/management/search_index_manager.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.
@@ -17,7 +17,7 @@ require "couchbase/errors"
 module Couchbase
   module Management
     class SearchIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -58,17 +58,18 @@ module Couchbase
       # @raise [ArgumentError] if name, type or source_type is empty
       def upsert_index(index_definition, options = UpsertIndexOptions.new)
         @backend.search_index_upsert(
-            {
-                name: index_definition.name,
-                type: index_definition.type,
-                uuid: index_definition.uuid,
-                params: (JSON.generate(index_definition.params) if index_definition.params),
-                source_name: index_definition.source_name,
-                source_type: index_definition.source_type,
-                source_uuid: index_definition.source_uuid,
-                source_params: (JSON.generate(index_definition.source_params) if index_definition.source_params),
-                plan_params: (JSON.generate(index_definition.plan_params) if index_definition.plan_params),
-            }, options.timeout)
+          {
+            name: index_definition.name,
+            type: index_definition.type,
+            uuid: index_definition.uuid,
+            params: (JSON.generate(index_definition.params) if index_definition.params),
+            source_name: index_definition.source_name,
+            source_type: index_definition.source_type,
+            source_uuid: index_definition.source_uuid,
+            source_params: (JSON.generate(index_definition.source_params) if index_definition.source_params),
+            plan_params: (JSON.generate(index_definition.plan_params) if index_definition.plan_params),
+          }, options.timeout
+        )
       end
 
       # Drops the index
@@ -98,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
@@ -234,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
@@ -357,6 +399,8 @@ module Couchbase
 
       # @yieldparam [SearchIndex] self
       def initialize
+        @type = "fulltext-index"
+        @source_type = "couchbase"
         yield self if block_given?
       end
     end

data/lib/couchbase/management/user_manager.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.
@@ -14,10 +14,12 @@
 
 require "couchbase/errors"
 
+require "time"
+
 module Couchbase
   module Management
     class UserManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @param [Couchbase::Backend] backend
       def initialize(backend)
@@ -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 { |entry| extract_user(entry) }
       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 { |entry| extract_group(entry) }
       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,62 @@ 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
 
+        # @yieldparam [GetUserOptions] self
         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
 
+        # @yieldparam [GetAllUsersOptions] self
         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
 
+        # @yieldparam [UpsertUserOptions] self
         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
 
+        # @yieldparam [DropUserOptions] self
         def initialize
-          @domain_name = :local
+          @domain = :local
           yield self if block_given?
         end
       end
@@ -167,6 +217,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetRolesOptions] self
         def initialize
           yield self if block_given?
         end
@@ -176,6 +227,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetGroupOptions] self
         def initialize
           yield self if block_given?
         end
@@ -185,6 +237,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [GetAllGroupsOptions] self
         def initialize
           yield self if block_given?
         end
@@ -194,6 +247,7 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [UpsertGroupOptions] self
         def initialize
           yield self if block_given?
         end
@@ -203,10 +257,70 @@ module Couchbase
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [DropGroupOptions] self
         def initialize
           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,53 +330,60 @@ module Couchbase
       # @return [String]
       attr_accessor :bucket
 
+      # @return [String]
+      attr_accessor :scope
+
+      # @return [String]
+      attr_accessor :collection
+
+      # @yieldparam [Role] self
       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
 
+      # @yieldparam [RoleAndDescription] self
       def initialize
+        super
         yield self if block_given?
       end
     end
 
     class Origin
       # @return [String]
-      attr_reader :type
+      attr_writer :type
 
       # @return [String]
-      attr_reader :name
+      attr_writer :name
 
+      # @yieldparam [Origin] self
       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
 
+      # @yieldparam [RoleAndOrigins] self
       def initialize
+        super
+        @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 +395,53 @@ module Couchbase
       attr_accessor :roles
 
       # @return [String]
-      attr_writer :password
+      attr_accessor :password
 
+      # @yieldparam [User] self
       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
 
+      # @yieldparam [UserAndMetadata] self
       def initialize
+        super
+        @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
 
+      # @yieldparam [Group] self
       def initialize
+        @roles = []
         yield self if block_given?
       end
     end