couchbase 3.0.0.alpha.5-x86_64-linux → 3.5.1-x86_64-linux

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,26 @@ 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
+
+      # Changes the password of the currently authenticated user
+      #
+      # @param [ChangePasswordOptions] options
+      #
+      # @raise [ArgumentError]
+      def change_password(new_password, options = ChangePasswordOptions.new)
+        @backend.change_password(new_password, options.timeout)
       end
 
       # Gets a group
@@ -80,7 +119,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 +129,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 +141,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 +162,72 @@ 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 = :local
+          yield self if block_given?
+        end
+      end
 
+      class ChangePasswordOptions
         # @return [Integer] the time in milliseconds allowed for the operation to complete
         attr_accessor :timeout
 
+        # @yieldparam [ChangePasswordOptions] self
         def initialize
-          @domain_name = :local
           yield self if block_given?
         end
       end
@@ -167,6 +236,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 +246,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 +256,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 +266,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 +276,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 +349,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 +414,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 [List<RoleAndOrigins>]
-      attr_reader :effective_roles
+      # @return [Array<RoleAndOrigins>]
+      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

data/lib/couchbase/management/view_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.
@@ -32,7 +32,7 @@ module Couchbase
     # development document or a production document. The type of this argument is [Symbol] with allowed values
     # +:production+ and +:development+.
     class ViewIndexManager
-      alias_method :inspect, :to_s
+      alias inspect to_s
 
       # @return [String] name of the bucket
       attr_accessor :bucket_name
@@ -80,8 +80,14 @@ module Couchbase
       # @return [void]
       def upsert_design_document(document, namespace, options = UpsertDesignDocumentOptions.new)
         @backend.view_index_upsert(@bucket_name, {
-            name: document.name,
-            views: document.views.map { |name, view| {name: name, map: view.map_function, reduce: view.reduce_function} }
+          name: document.name,
+          views: document.views.map do |name, view|
+            {
+              name: name,
+              map: view.map_function,
+              reduce: view.reduce_function,
+            }
+          end,
         }, namespace, options.timeout)
       end
 
@@ -184,11 +190,11 @@ module Couchbase
 
       # @return [String] map function in javascript as String
       attr_accessor :map_function
-      alias_method :map, :map_function
+      alias map map_function
 
       # @return [String] reduce function in javascript as String
       attr_accessor :reduce_function
-      alias_method :reduce, :reduce_function
+      alias reduce reduce_function
 
       # @return [Boolean] true if map function is defined
       def has_map?

data/lib/couchbase/management.rb

@@ -0,0 +1,29 @@
+#  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.
+
+module Couchbase
+  # This namespace includes manager classes to control cluster resources and perform maintenance operations.
+  module Management
+  end
+end
+
+require "couchbase/management/analytics_index_manager"
+require "couchbase/management/bucket_manager"
+require "couchbase/management/collection_manager"
+require "couchbase/management/query_index_manager"
+require "couchbase/management/collection_query_index_manager"
+require "couchbase/management/search_index_manager"
+require "couchbase/management/scope_search_index_manager"
+require "couchbase/management/user_manager"
+require "couchbase/management/view_index_manager"

data/lib/couchbase/mutation_state.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.
@@ -30,6 +30,7 @@ module Couchbase
   end
 
   class MutationState
+    # @return [Array<MutationToken>]
     attr_accessor :tokens
 
     # Create a mutation state from one or more MutationTokens
@@ -46,5 +47,17 @@ module Couchbase
     def add(*mutation_tokens)
       @tokens |= mutation_tokens
     end
+
+    # @api private
+    def to_a
+      @tokens.map do |t|
+        {
+          bucket_name: t.bucket_name,
+          partition_id: t.partition_id,
+          partition_uuid: t.partition_uuid,
+          sequence_number: t.sequence_number,
+        }
+      end
+    end
   end
 end