gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/project_access_tokens.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class ProjectAccessTokens within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] access_level Role for the token; possible values: 10 (Guest), 15 (Planner), 20 (Reporter), 30 (Developer), 40 (Maintainer), and 50 (Owner)
+    # @attr [Boolean] active If the token is active or not
+    # @attr [String] created_at The timestamp the token was created at
+    # @attr [String] description The description of the token
+    # @attr [String] expires_at Expiration date of the token in ISO format (YYYY-MM-DD).
+    # @attr [Integer] id The ID of the token
+    # @attr [String] last_used_at The timestamp the token was last used
+    # @attr [String] name The name of the token
+    # @attr [Integer] project_id The ID of the project the token is attached to
+    # @attr [String] revoked If the token is revoked or not
+    # @attr [Array] scopes The scopes of the token
+    # @attr [String] token The token itself (only shows on create and rotate)
+    # @attr [Integer] user_id The user who created the token
+    # @todo Get details on a project access token => https://docs.gitlab.com/api/project_access_tokens/#get-details-on-a-project-access-token
+    class ProjectAccessTokens < SupportOps::GitLab::Base
+      # @!parse
+      #   # Create a project access token
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::ProjectAccessTokens}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#save!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/project_access_tokens/#create-a-project-access-token
+      #   #   GitLab API > Projects > Access tokens > Create a project access token
+      #   # @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
+      #   #
+      #   #   new_project_access_token = SupportOps::GitLab::ProjectAccessTokens.new
+      #   #   new_project_access_token.name = 'Jason Test'
+      #   #   new_project_access_token.expires_at = '2025-05-28'
+      #   #   new_project_access_token.description = 'Jason Test Desc'
+      #   #   new_project_access_token.scopes = ['api']
+      #   #   new_project_access_token.project_id = 123456
+      #   #
+      #   #   new_project_access_token.save!
+      #   #
+      #   #   pp new_project_access_token.token
+      #   #   # => "glpat-abc123"
+      #   def save!; end
+      # @!parse
+      #   # Rotates a project access token
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::ProjectAccessTokens}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#rotate!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/project_access_tokens/#rotate-a-project-access-token
+      #   #   GitLab API > Projects > Access tokens > Rotate a project access token
+      #   # @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
+      #   #
+      #   #   tokens = SupportOps::GitLab::ProjectAccessTokens.list(project_id: 123456)
+      #   #   new_token = tokens.last.rotate!
+      #   #   pp new_token.token
+      #   #   # => "glpat-def456"
+      #   def rotate!; end
+      # @!parse
+      #   # Revokes a project access token
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::ProjectAccessTokens}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#revoke!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/project_access_tokens/#revoke-a-project-access-token
+      #   #   GitLab API > Projects > Access tokens > Revoke a project access token
+      #   # @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
+      #   #
+      #   #   tokens = SupportOps::GitLab::ProjectAccessTokens.list(project_id: 123456)
+      #   #   tokens.last.revoke!
+      #   def revoke!; end
+      define_attributes :access_level, :active, :created_at, :description,
+                        :expires_at, :id, :last_used_at, :name, :project_id,
+                        :revoked, :scopes, :token, :user_id
+      readonly_attributes :active, :created_at, :id, :last_used_at, :project_id,
+                          :revoked, :token, :user_id
+
+      ##
+      # List all project access tokens
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # overload list(key: value)
+      #   @param created_after [String optional] If defined, returns tokens
+      #     created after the specified time
+      #   @param created_before [String optional] If defined, returns tokens
+      #     created before the specified time
+      #   @param expires_after [String optional] If defined, returns tokens that
+      #     expire after the specified time
+      #   @param expires_before [String optional] If defined, returns tokens
+      #     that expire before the specified time
+      #   @param last_used_after [String optional] If defined, returns tokens
+      #     last used after the specified time
+      #   @param last_used_before [String optional] If defined, returns tokens
+      #     last used before the specified time
+      #   @param project_id [Integer required] The ID of the project to use
+      #   @param revoked [Boolean optional] If true, only returns revoked tokens
+      #   @param search [String optional] If defined, returns tokens that
+      #     include the specified value in the name
+      #   @param sort [String optional] If defined, sorts the results by the
+      #     specified value; possible values: created_asc, created_desc,
+      #     expires_asc, expires_desc, last_used_asc, last_used_desc, name_asc,
+      #     name_desc
+      #   @param state [String optional] If defined, returns tokens with the
+      #     specified state; possible values: active and inactive
+      #   @param limit [Integer optional] The limit to the number of users
+      #     returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # #see
+      #   https://docs.gitlab.com/api/project_access_tokens/#list-all-project-access-tokens
+      #   GitLab API > Projects > Access tokens > List all project access tokens
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.example.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   tokens = SupportOps::GitLab::ProjectAccessTokens.list(project_id: 5, limit: 10)
+      #   pp tokens.count
+      #   # => 10
+      #   pp tokens.last.revoked
+      #   # => false
+      def self.list(**args)
+        raise 'You have to provide a project_id' unless args[:project_id]
+
+        args[:created_after] = nil unless args[:created_after]
+        args[:created_before] = nil unless args[:created_before]
+        args[:expires_after] = nil unless args[:expires_after]
+        args[:expires_before] = nil unless args[:expires_before]
+        args[:last_used_after] = nil unless args[:last_used_after]
+        args[:last_used_before] = nil unless args[:last_used_before]
+        args[:revoked] = nil unless args[:revoked]
+        args[:search] = nil unless args[:search]
+        args[:sort] = nil unless args[:sort]
+        args[:state] = nil unless args[:state]
+        args[:limit] = 0 unless args[:limit]
+        params = ''
+        params += "created_after=#{args[:created_after]}&" unless args[:created_after].nil?
+        params += "created_before=#{args[:created_before]}&" unless args[:created_before].nil?
+        params += "expires_after=#{args[:expires_after]}&" unless args[:expires_after].nil?
+        params += "expires_before=#{args[:expires_before]}&" unless args[:expires_before].nil?
+        params += "last_used_after=#{args[:last_used_after]}&" unless args[:last_used_after].nil?
+        params += "last_used_before=#{args[:last_used_before]}&" unless args[:last_used_before].nil?
+        params += "revoked=#{args[:revoked]}&" unless args[:revoked].nil?
+        params += "search=#{args[:search]}&" unless args[:search].nil?
+        params += "sort=#{args[:sort]}&" unless args[:sort].nil?
+        params += "state=#{args[:state]}&" unless args[:state].nil?
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("projects/#{args[:project_id]}/access_tokens?#{params}&page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map { |p| Projects.new(p) }
+          break if args[:limit].to_i.positive? && array.count >= args[:limit].to_i
+          break if body.count < 100
+
+          page += 1
+        end
+        return array if args[:limit].to_i.zero?
+
+        array.first(args[:limit].to_i)
+      end
+
+      private
+
+      ##
+      # @private
+      def create_record
+        url = "projects/#{self.project_id}/access_tokens"
+        response = self.client.connection.post(url, attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Error creating project access token => #{body}" unless response.status == 201
+        body
+      end
+
+      ##
+      # @private
+      def update_record
+        raise 'You cannot update a token, you must create a new one'
+      end
+
+      ##
+      # @private
+      def delete_record
+        raise 'You cannot delete a token, you must revoke it'
+      end
+
+      ##
+      # @private
+      def rotate_record
+        data = { expires_at: self.expires_at }.to_json
+        response = self.client.connection.post("projects/#{self.project_id}/access_tokens/#{self.id}/rotate", data)
+        body = Oj.load(response.body)
+        raise "Failed to rotate project access tokentoken #{self.id} => #{body}" unless response.status == 200
+        body.each do |key, value|
+          self.instance_variable_set("@#{key}", value) if self.respond_to?("#{key}=")
+        end
+        body
+      end
+
+      ##
+      # @private
+      def revoke_record
+        url = "projects/#{self.project_id}/access_tokens/#{self.id}"
+        response = self.client.connection.delete(url)
+        body = Oj.load(response.body)
+        raise "Error revoking project access token token => #{self.body}" unless response.status == 204
+        self.instance_variable_set("@active", false)
+        self.instance_variable_set("@revoked", true)
+        true
+      end
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/project_memberships.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class ProjectMemberships within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] access_level The membership level
+    # @attr [String] avatar_url URL of the user's avatar
+    # @attr [String] created_at The time the membership was created at
+    # @attr [Hash] created_by A hash containing information on who created the membership
+    # @attr [String] email The email of the user
+    # @attr [String] expires_at The timestamp when the membership expires
+    # @attr [Hash] group_saml_identity A hash containing the group's SAML information tied to the membership
+    # @attr [Integer] id The user's ID
+    # @attr [String] name The name of the user
+    # @attr [String] state The state of the membership, can be awaiting or active
+    # @attr [String] username The username of the user
+    # @attr [String] web_url The web URL of theuser
+    class ProjectMemberships < SupportOps::GitLab::Base
+      define_attributes :access_level, :avatar_url, :created_at, :created_by,
+                        :email, :expires_at, :group_saml_identity, :id, :name,
+                        :state, :username, :web_url
+      readonly_attributes :access_level, :avatar_url, :created_at, :created_by,
+                          :email, :expires_at, :group_saml_identity, :id, :name,
+                          :state, :username, :web_url
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/project_webhook_events.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class ProjectWebhookEvents within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Float] execution_duration
+    # @attr [Integer] id
+    # @attr [Hash] request_data
+    # @attr [Hash] request_headers
+    # @attr [Hash] response_body
+    # @attr [Hash] response_headers
+    # @attr [String] response_status
+    # @attr [String] trigger
+    # @attr [String] url
+    # @todo Document attribute meaning
+    class ProjectWebhookEvents < SupportOps::GitLab::Base
+      define_attributes :execution_duration, :id, :request_data,
+                        :request_headers, :response_body, :response_headers,
+                        :response_status, :trigger, :url
+      readonly_attributes :execution_duration, :id, :request_data,
+                          :request_headers, :response_body, :response_headers,
+                          :response_status, :trigger, :url
+
+      private
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/project_webhooks.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class ProjectWebhooks within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] alert_status
+    # @attr [String] branch_filter_strategy Filter push events by branch; possible values are wildcard (default), regex, and all_branches
+    # @attr [Boolean] confidential_issues_events
+    # @attr [Boolean] confidential_note_events
+    # @attr [String] created_at
+    # @attr [Array] custom_headers
+    # @attr [String] custom_webhook_template
+    # @attr [Boolean] deployment_events
+    # @attr [String] description
+    # @attr [String] disabled_until
+    # @attr [Boolean] enable_ssl_verification
+    # @attr [Boolean] feature_flag_events
+    # @attr [Integer] id
+    # @attr [Boolean] issues_events
+    # @attr [Boolean] job_events
+    # @attr [Boolean] merge_requests_events
+    # @attr [String] name
+    # @attr [Boolean] note_events
+    # @attr [Boolean] pipeline_events
+    # @attr [Integer] project_id
+    # @attr [Boolean] push_events
+    # @attr [String] push_events_branch_filter
+    # @attr [Boolean] releases_events
+    # @attr [Boolean] repository_update_events
+    # @attr [Boolean] resource_access_token_events
+    # @attr [Boolean] tag_push_events
+    # @attr [String] token Secret token to validate received payloads; the token isn’t returned in the response (creates/updates only)
+    # @attr [String] url
+    # @attr [Array] url_variables
+    # @attr [Boolean] wiki_page_events
+    # @todo Anything list at https://docs.gitlab.com/api/project_webhooks
+    # @todo Document save!
+    # @todo Document delete!
+    # @todo Document events
+    class ProjectWebhooks < SupportOps::GitLab::Base
+      define_attributes :alert_status, :branch_filter_strategy,
+                        :confidential_issues_events, :confidential_note_events,
+                        :created_at, :custom_headers, :custom_webhook_template,
+                        :deployment_events, :description, :disabled_until,
+                        :enable_ssl_verification, :feature_flag_events, :id,
+                        :issues_events, :job_events, :merge_requests_events,
+                        :name, :note_events, :pipeline_events, :project_id,
+                        :push_events, :push_events_branch_filter,
+                        :releases_events, :repository_update_events,
+                        :resource_access_token_events, :tag_push_events,
+                        :token, :url, :url_variables, :wiki_page_events
+      readonly_attributes :alert_status, :created_at, :disabled_until, :id,
+                          :project_id
+
+      ##
+      # List webhooks for a project
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param project_id [Integer required] The project ID to look in
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/api/project_webhooks/#list-webhooks-for-a-project
+      #   GitLab API > Projects > Webhooks > List webhooks for a project
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.example.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhooks = SupportOps::GitLab::ProjectWebhooks.list(project_id: 123)
+      #   pp webhooks.count
+      #   # => 11
+      #   pp webhooks.last.name
+      #   # => "Aweomse Project Webhook"
+      def self.list(**args)
+        args[:project_id] = nil unless args[:project_id]
+        raise 'You have to provide a project_id' if args[:project_id].nil?
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("projects/#{args[:args[:project_id]]}/hooks?per_page=100&page=#{page}")
+          body = Oj.load(response.body)
+          array += body.map { |w| ProjectWebhooks(w) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Get a project webhook
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/project_webhooks/#get-a-project-webhook
+      #   GitLab API > Projects > Webhooks > Get a project webhook
+      # @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
+      #
+      #   webhook = SupportOps::GitLab::ProjectWebhooks.get(id: 123, project_id: 456)
+      #   pp webhook.name
+      #   # => "Awesome project webhook"
+      def self.get(object)
+        if object.is_a? ProjectWebhooks
+          ProjectWebhooks.new(id: id, project_id: project_id).find
+        elsif object.is_a? Hash
+          ProjectWebhooks.new({ id: object[:id], project_id: object[:project_id] }).find
+        else
+          raise 'You need an id and a project_id attribute'
+        end
+      end
+
+      ##
+      # Get a project webhook
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/project_webhooks/#get-a-project-webhook
+      #   GitLab API > Projects > Webhooks > Get a project webhook
+      # @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
+      #
+      #   webhook = SupportOps::GitLab::ProjectWebhooks.get!(id: 123, project_id: 456)
+      #   pp webhook.name
+      #   # => "Awesome project webhook"
+      def self.get!(object)
+        if object.is_a? ProjectWebhooks
+          ProjectWebhooks.new(id: id, project_id: project_id).find!
+        elsif object.is_a? Hash
+          ProjectWebhooks.new({ id: object[:id], project_id: object[:project_id] }).find!
+        else
+          raise 'You need an id and a project_id attribute'
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = client.connection.get("projects/#{self.project_id}/hooks/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # @private
+      def create_record
+        response = self.client.connection.post("projects/#{self.project_id}/hooks", attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create project webhook => #{body}" if response.status != 201
+        body
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "Failed to update project webhook => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        response = self.client.connection.put("projects/#{self.project_id}/hooks/#{self.id}", attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update project webhook #{self.id} => #{body}" if response.status != 200
+        body
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("projects/#{self.project_id}/hooks/#{self.id}")
+        body = Oj.load(response.body)
+        raise "Failed to delete issue #{self.id} => #{body}" unless response.status == 204
+        true
+      end
+
+      ##
+      # @private
+      def events_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.conneciton.get("projects/#{self.project_id}/hoosk/#{self.id}/events?per_page=100&page=#{page}")
+          body = Oj.load(Response.body)
+          array += body.map { |e| ProjectWebhookEvents.new(e) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+    end
+  end
+end