gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/groups.rb

@@ -0,0 +1,431 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Groups within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Array] allowed_email_domains_list Comma-separated list of email address domains to allow group access
+    # @attr [Boolean] auto_ban_user_on_excessive_projects_download When enabled, users are automatically banned from the group when they download more than the maximum number of unique projects specified by unique_project_download_limit and unique_project_download_limit_interval_in_seconds
+    # @attr [String] avatar_url The URL of the group's avatar
+    # @attr [Boolean] auto_devops_enabled Default to Auto DevOps pipeline for all projects within this group
+    # @attr [String] created_at The timestamp the group was created at
+    # @attr [String] default_branch The default branch name for group’s projects
+    # @attr [Hash] default_branch_protection_defaults Describes the default branch protection defaults. See https://docs.gitlab.com/api/groups/#options-for-default_branch_protection_defaults for more info
+    # @attr [String] description The group’s description
+    # @attr [String] duo_availability Duo availability setting; valid values are: default_on, default_off, never_on
+    # @attr [Boolean] duo_features_enabled Indicates whether GitLab Duo features are enabled for this group
+    # @attr [Boolean] emails_enabled Enable email notifications
+    # @attr [String] enabled_git_access_protocol Enabled protocols for Git access; allowed values are: ssh, http, and all to allow both protocols
+    # @attr [Boolean] experiment_features_enabled Enable experiment features for this group
+    # @attr [Integer] extra_shared_runners_minutes_limit Additional compute minutes for this group
+    # @attr [Integer] file_template_project_id The ID of a project to load custom file templates from
+    # @attr [String] full_name The full name of the group
+    # @attr [String] full_path Full path of group
+    # @attr [Integer] id ID of the group
+    # @attr [String] ip_restriction_ranges Comma-separated list of IP addresses or subnet masks to restrict group access
+    # @attr [Boolean] lfs_enabled Enable/disable Large File Storage (LFS) for the projects in this group
+    # @attr [Boolean] lock_duo_features_enabled Indicates whether the GitLab Duo features enabled setting is enforced for all subgroups
+    # @attr [Boolean] lock_math_rendering_limits_enabled Indicates if math rendering limits are locked for all descendent groups
+    # @attr [String] marked_for_deletion_on The date the group is scheduled to be deleted
+    # @attr [Boolean] math_rendering_limits_enabled Indicates if math rendering limits are used for this group
+    # @attr [Integer] max_artifacts_size The maximum file size in megabytes for individual job artifacts
+    # @attr [Boolean] membership_lock Users cannot be added to projects in this group
+    # @attr [Boolean] mentions_disabled Disable the capability of a group from getting mentioned
+    # @attr [String] name The name of the group
+    # @attr [Integer] organization_id The organization ID for the group
+    # @attr [Integer] parent_id The parent group ID for creating nested group
+    # @attr [String] path The path of the group
+    # @attr [Boolean] prevent_forking_outside_group When enabled, users can not fork projects from this group to external namespaces
+    # @attr [Boolean] prevent_sharing_groups_outside_hierarchy When enabled, top-level group will ensure its subgroups and projects cannot invite other groups outside of the top-level group’s hierarchy
+    # @attr [String] project_creation_level Determine if developers can create projects in the group; can be noone, maintainer, or developer
+    # @attr [String] repository_storage Stroage location of repositories
+    # @attr [Boolean] request_access_enabled Allow users to request member access
+    # @attr [Boolean] require_two_factor_authentication Require all users in this group to set up two-factor authentication
+    # @attr [String] runners_token Token of the group's runner
+    # @attr [Boolean] share_with_group_lock Prevent sharing a project with another group within this group
+    # @attr [Integer] shared_runners_minutes_limit Maximum number of monthly compute minutes for this group; can be nil, 0, or > 0
+    # @attr [Array] shared_with_groups Groups this group has been shared with
+    # @attr [Hash] statistics Group statistics
+    # @attr [String] subgroup_creation_level Allowed to create subgroups; can be owner or maintainer
+    # @attr [Integer] two_factor_grace_period Time before Two-factor authentication is enforced (in hours)
+    # @attr [Integer] unique_project_download_limit Maximum number of unique projects a user can download in the specified time period before they are banned
+    # @attr [Array] unique_project_download_limit_allowlist List of usernames excluded from the unique project download limit
+    # @attr [Array] unique_project_download_limit_alertlist List of user IDs that are emailed when the unique project download limit is exceeded
+    # @attr [Integer] unique_project_download_limit_interval_in_seconds Time period during which a user can download a maximum amount of projects before they are banned
+    # @attr [String] visibility The group’s visibility; can be private, internal, or public
+    # @attr [String] web_url The URL of the group
+    # @attr [String] wiki_access_level The wiki access level; can be disabled, private, or enabled
+    # @todo A lot of things listed at https://docs.gitlab.com/api/groups
+    class Groups < SupportOps::GitLab::Base
+      # @!parse
+      #   # List badges within a group
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#badges}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/group_badges/#list-all-badges-of-a-group
+      #   #   GitLab API > Groups > Badges > List all badgesof a group
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   #   badges = group.badges
+      #   #   pp badges.count
+      #   #   # => 2
+      #   def badges; end
+      # @!parse
+      #   # List projects within a group
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#projects}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/groups/#list-projects
+      #   #   GitLab API > Groups > List projects
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   #   projects = group.projects
+      #   #   pp projects.count
+      #   #   # => 27
+      #   def projects; end
+      # @!parse
+      #   # List milestones within a group
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#milestones}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/group_milestones/#list-group-milestones
+      #   #   GitLab API > Groups > Milestones > List group milestones
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   #   milestones = group.milestones
+      #   #   pp milestones.count
+      #   #   # => 24
+      #   def milestones; end
+      # @!parse
+      #   # List merge requests within a group
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#merge_requests}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/merge_requests/#list-group-merge-requests
+      #   #   GitLab API > Merge requests > List group merge requests
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   #   merge_requests = group.merge_requests
+      #   #   pp merge_requests.count
+      #   #   # => 128
+      #   def merge_requests; end
+      # @!parse
+      #   # List epics within a group
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#epics}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/epics/#list-epics-for-a-group
+      #   #   GitLab API > Epics > List epics for a group
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   #   epics = group.epics
+      #   #   pp epics.count
+      #   #   # => 3
+      #   def epics; end
+      # @!parse
+      #   # List members within a group
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#members}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project
+      #   #   GitLab API > Members > List all members of a group or project
+      #   # @see
+      #   #   https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project-including-inherited-and-invited-members
+      #   #   GitLab API > Members > List all members of a group or project including inherited and invited members
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   #   members = group.members
+      #   #   pp members.count
+      #   #   # => 5
+      #   #   members = group.members(all: true)
+      #   #   pp members.count
+      #   #   # => 15
+      #   def members; end
+      # @!parse
+      #   # Return the encoded path for a group
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#encoded_path}
+      #   # @example
+      #   #   require 'support_ops_gitlab'
+      #   #
+      #   #   SupportOps::GitLab::Configuration.configure do |config|
+      #   #     config.token = ENV.fetch('GL_TOKEN')
+      #   #     config.url = 'https://gitlab.com/api/v4'
+      #   #   end
+      #   #
+      #   #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   #   pp group.encoded_path
+      #   #   # => "test%2Fgroup"
+      #   def encoded_path; end
+      define_attributes :allowed_email_domains_list,
+                        :auto_ban_user_on_excessive_projects_download,
+                        :avatar_url, :auto_devops_enabled, :created_at,
+                        :default_branch, :default_branch_protection_defaults,
+                        :description, :duo_availability, :duo_features_enabled,
+                        :emails_enabled, :enabled_git_access_protocol,
+                        :experiment_features_enabled,
+                        :extra_shared_runners_minutes_limit,
+                        :file_template_project_id, :full_name, :full_path, :id,
+                        :ip_restriction_ranges, :lfs_enabled,
+                        :lock_duo_features_enabled,
+                        :lock_math_rendering_limits_enabled,
+                        :marked_for_deletion_on, :math_rendering_limits_enabled,
+                        :max_artifacts_size, :membership_lock,
+                        :mentions_disabled, :name, :organization_id, :parent_id,
+                        :path, :prevent_forking_outside_group,
+                        :prevent_sharing_groups_outside_hierarchy,
+                        :project_creation_level, :repository_storage,
+                        :request_access_enabled,
+                        :require_two_factor_authentication, :runners_token,
+                        :share_with_group_lock, :shared_runners_minutes_limit,
+                        :shared_with_groups, :statistics,
+                        :subgroup_creation_level, :two_factor_grace_period,
+                        :unique_project_download_limit,
+                        :unique_project_download_limit_allowlist,
+                        :unique_project_download_limit_alertlist,
+                        :unique_project_download_limit_interval_in_seconds,
+                        :visibility, :web_url, :wiki_access_level
+      readonly_attributes :avatar_url, :created_at, :full_name, :id, :parent_id,
+                          :repository_storage, :runners_token,
+                          :shared_with_groups, :statistics, :web_url
+
+      ##
+      # Locates a specific group in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/groups/#get-a-single-group
+      #   GitLab API > Groups > Get a single group
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   group = SupportOps::GitLab::Groups.get(123456)
+      #   pp group.name
+      #   # => "My Awesome Group"
+      def self.get(object)
+        if object.is_a? Groups
+          Groups.new(id: id).find
+        else
+          Groups.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific group in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/groups/#get-a-single-group
+      #   GitLab API > Groups > Get a single group
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   group = SupportOps::GitLab::Groups.get!(123456)
+      #   pp group.name
+      #   # => "My Awesome Group"
+      def self.get!(object)
+        if object.is_a? Groups
+          Groups.new(id: id).find!
+        else
+          Groups.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("groups/#{self.id}?with_projects=false")
+        return nil if response.status != 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # @private
+      def members_record(**args)
+        args[:all] = false unless args[:all]
+        args[:query] = nil unless args[:query]
+        args[:user_ids] = nil unless args[:user_ids]
+        args[:skip_users] = nil unless args[:skip_users]
+        args[:show_seat_info] = nil unless args[:show_seat_info]
+        params = ''
+        params += "query&" unless args[:query].nil?
+        params += "user_ids&" unless args[:user_ids].nil?
+        params += "skip_users&" unless args[:skip_users].nil?
+        params += "show_seat_info&" unless args[:show_seat_info].nil?
+        base_url = if args[:all]
+                     "groups/#{self.id}/members/all"
+                   else
+                    "groups/#{self.id}/members"
+                   end
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("#{base_url}?#{params}&page=#{page}&per_page=100")
+          pp "#{base_url}?#{params}&page=#{page}&per_page=100"
+          body = Oj.load(response.body)
+          array += body.map { |g| GroupMemberships.new(g) }
+          break if body.count < 100
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # @private
+      def encoded_path_record
+        ERB::Util.url_encode(self.full_path)
+      end
+
+      ##
+      # @private
+      def epics_records
+        Epics.list(group_id: self.id)
+      end
+
+      ##
+      # @private
+      def issues_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("groups/#{self.id}/issues?per_page=100&page=#{page}")
+          body = Oj.load(response.body)
+          array += body.map { |i| Issues.new(i) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # @private
+      def milestones_record
+        Milestones.list(group_id: self.id)
+      end
+
+      ##
+      # @private
+      def projects_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("groups/#{self.id}/projects?per_page=100&page=#{page}")
+          body = Oj.load(response.body)
+          array += body.map { |p| Projects.new(p) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # @private
+      def badges_record
+        Badges.list(group_id: self.id)
+      end
+
+      ##
+      # @private
+      def merge_requests_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("groups/#{self.id}/merge_requests?page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map { |m| MergeRequests.new(m) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/invitations.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Invitations within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo Add attributes
+    # @todo Stuff at https://docs.gitlab.com/api/invitations/
+    class Invitations < SupportOps::GitLab::Base
+      define_attributes :id
+      readonly_attributes :id
+
+      ##
+      # Create a membership invitation for a project. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param item_id [Integer] The ID of the project or group
+      # @param type [String]
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param data [Hash] The invite information
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/ee/api/invitations.html#add-a-member-to-a-group-or-project
+      #   GitLab API > Invitations > Add a member to a group or project
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   data = {
+      #     email: 'bob@example.com',
+      #     access_level: 50
+      #   }
+      #   invite = SupportOps::GitLab::Invitations.create!('project', 1234, data)
+      #   pp invite
+      #   # => {"status"=>"success"}
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   data = {
+      #     user_id: 987,
+      #     access_level: 40
+      #   }
+      #   invite = SupportOps::GitLab::Invitations.create!('group', 5678, data)
+      #   pp invite
+      #   # => {"status"=>"success"}
+      def self.create!(item_id, type, data)
+        raise "This only works for a project or group, not a #{type}" unless %w[project group].include? type.downcase.singularize
+        response = client.connection.post("#{type.downcase.pluralize}/#{item_id}/invitations", data.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create invites => #{body}" unless response.status == 200
+        body
+      end
+
+      private
+    end
+  end
+end