gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/repository_files.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class RepositoryFiles within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] blob_id
+    # @attr [String] commit_id
+    # @attr [String] content
+    # @attr [String] content_sha256
+    # @attr [String] encoding
+    # @attr [Boolean] execute_filemode
+    # @attr [String] file_name
+    # @attr [String] file_path
+    # @attr [String] last_commit_id
+    # @attr [String] ref
+    # @attr [Integer] size
+    # @todo Document attribute meaning
+    # @todo Stuff at https://docs.gitlab.com/api/repository_files/
+    class RepositoryFiles < SupportOps::GitLab::Base
+      define_attributes :blob_id, :commit_id, :content, :content_sha256,
+                        :encoding, :execute_filemode, :file_name, :file_path,
+                        :last_commit_id, :ref, :size
+      readonly_attributes :blob_id, :commit_id, :content, :content_sha256,
+                          :encoding, :execute_filemode, :file_name, :file_path,
+                          :last_commit_id, :ref, :size
+
+      ##
+      # Get file from repository
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/repository_files/#get-file-from-repository
+      #   GitLab API > Repository files > Get file from repository
+      # @param project_id [Integer] The project ID to look in (can also use a URL encoded String)
+      # @param path [String] The path to the file in the repository
+      # @param ref [String] The ref to look in (defaults to HEAD, meaning the default branch)
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @return String
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   file = SupportOps::GitLab::RepositoryFiles.get(123456, 'public/hw.txt')
+      #   pp file.file_path
+      #   # => "public/hw.txt"
+      #   pp file.content
+      #   # => "Hello World!"
+      def self.get(project_id, path, ref = 'HEAD')
+        response = client.connection.get("projects/#{project_id}/repository/files/#{ERB::Util.url_encode(path)}?ref=#{ref}")
+        body = Oj.load(response.body)
+        return nil unless response.status == 200
+
+        RepositoryFiles.new(body)
+      end
+
+      ##
+      # Get raw file from repository
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/repository_files/#get-raw-file-from-repository
+      #   GitLab API > Repository files > Get raw file from repository
+      # @param project_id [Integer] The project ID to look in (can also use a URL encoded String)
+      # @param path [String] The path to the file in the repository
+      # @param ref [String] The ref to look in (defaults to HEAD, meaning the default branch)
+      # @param lft [Boolean] Determines if the response should be Git LFS file contents, rather than the pointer (defaults to false)
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @return String
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   content = SupportOps::GitLab::RepositoryFiles.get_raw(123456, 'public/hw.txt')
+      #   pp content
+      #   # => "Hello World!"
+      def self.get_raw(project_id, path, ref = 'HEAD', lfs = false)
+        response = client.connection.get("projects/#{project_id}/repository/files/#{ERB::Util.url_encode(path)}/raw?ref=#{ref}")
+        return nil unless response.status == 200
+
+        response.body
+      end
+
+      private
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/repository_submodules.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class RepositorySubmodules within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] authored_date
+    # @attr [String] author_email
+    # @attr [String] author_name
+    # @attr [String] committed_date
+    # @attr [String] committer_email
+    # @attr [String] committer_name
+    # @attr [String] created_at
+    # @attr [String] id
+    # @attr [String] message
+    # @attr [Array] parent_ids
+    # @attr [String] short_id
+    # @attr [String] status
+    # @attr [String] title
+    # @todo Document attribute meaning
+    class RepositorySubmodules < SupportOps::GitLab::Base
+      define_attributes :authored_date, :author_email, :author_name,
+                        :committed_date, :committer_email, :committer_name,
+                        :created_at, :id, :message, :parent_ids, :short_id,
+                        :status, :title
+      readonly_attributes :authored_date, :author_email, :author_name,
+                          :committed_date, :committer_email, :committer_name,
+                          :created_at, :id, :message, :parent_ids, :short_id,
+                          :status, :title
+
+      ##
+      # Update existing submodule reference in repository
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/repository_submodules/#update-existing-submodule-reference-in-repository
+      #   GitLab API > Repository submodules > Update existing submodule reference in repository
+      # @param project_id [Integer] The ID of the project the submodule is in
+      # @param path [String] The path to the submodule in the project
+      # @param branch [String] The branch to update the submodule in
+      # @param sha [String] The commit SHA to use for the update
+      # @param message [String optional] The commit message to use (defaults to nil, where it would be ignored)
+      # @see SupportOps::GitLab::Configuration Setting up a client
+      # @return String
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   submodule = SupportOps::GitLab::RepositorySubmodules.update!(5, 'lib/modules/example', 'main', '3ddec28ea23acc5caa5d8331a6ecb2a65fc03e88', 'Update submodule reference')
+      #   pp submodule.id
+      #   # => "ed899a2f4b50b4370feeea94676502b42383c746"
+      def self.update!(project_id, path, branch, sha, message = nil)
+        data = {
+          branch: branch,
+          commit_sha: sha
+        }
+        data[:commit_message] = message unless message.nil?
+        response = client.conneciton.put("projects/#{project_id}/repository/submodules/#{ERB::Util.url_encode(path)}", data.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update submodule #{path} => #{body}" unless response.status == 200
+        RepositorySubmodules.new(body)
+      end
+
+      private
+    end
+  end
+end
+

data/lib/support_ops_gitlab/gitlab/ssh_keys.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class SSHKeys within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at Timestamp for when the key was created
+    # @attr [String] expires_at Timestamp when the SSH key should auto-remove
+    # @attr [Integer] id ID value of the key
+    # @attr [String] key Public key value
+    # @attr [String] title Title for key
+    # @attr [String] usage_type Usage scope for the key; possible values: auth, signing, or auth_and_signing; default value: auth_and_signing
+    # @todo Get an SSH key for a user > https://docs.gitlab.com/api/user_keys/#get-an-ssh-key-for-a-user
+    # @todo Add an SSH key for a user > https://docs.gitlab.com/api/user_keys/#add-an-ssh-key-for-a-user
+    # @todo Delete an SSH key for a user > https://docs.gitlab.com/api/user_keys/#delete-an-ssh-key-for-a-user
+    class SSHKeys < SupportOps::GitLab::Base
+      define_attributes :created_at, :expires_at, :id, :key, :title, :usage_type
+      readonly_attributes :created_at, :id
+
+      ##
+      # Lists all SSH keys for a user
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param user_id [Integer optional] The user ID to get SSH keys of (not
+      #     including this does it for the current user)
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/api/user_keys/#list-all-ssh-keys-for-a-user
+      #   GitLab API > SSH and GPG Keys > List all SSH keys for a user
+      # @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
+      #
+      #   keys = SupportOps::GitLab::SSHKeys.list(user_id: 123456)
+      #   pp keys.count
+      #   # => 3
+      #   pp keys.last.usage_type
+      #   # => "auth"
+      def self.list(**args)
+        args[:user_id] = nil unless args[:user_id]
+        url = if args[:user_id].nil?
+                'user/keys'
+              else
+                "users/#{args[:user_id]}/keys"
+              end
+        response = client.connection.get(url)
+        body = Oj.load(response.body)
+        raise "Unable to get SSH keys of user => #{body}" if response.status != 200
+        body.map { |s| SSHKeys.new(s) }
+      end
+
+      private
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/user_emails.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class UserEmails within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] confirmed_at Timestamp of when the email address was confirmed
+    # @attr [String] email The email address
+    # @attr [Integer] id ID of the email address
+    # @attr [Boolean] skip_confirmation Used in creations only, skips sending the confirmation email
+    # @attr [Integer] user_id Used in creations only, specifies the user ID
+    # @todo Get details on an email address => https://docs.gitlab.com/api/user_email_addresses/#get-details-on-an-email-address
+    class UserEmails < SupportOps::GitLab::Base
+      # @!parse
+      #   # Adds an email address to a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Users}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#save!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_email_addresses/#add-an-email-address-for-a-user
+      #   #   GitLab API > User Email Addresses > Add an email address for a user
+      #   # @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_email = SupportOps::GitLab::UserEmails.new
+      #   #   new_email.email = 'test@example.com'
+      #   #   new_email.skip_confirmation = true
+      #   #   new_email.user_id = 123456
+      #   #
+      #   #   new_email.save!
+      #   #
+      #   #   pp new_email.id
+      #   #   # => 9873843
+      # @!parse
+      #   # Deletes a user
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#delete!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/user_email_addresses/#delete-an-email-address-for-a-user
+      #   #   GitLab API > User Email Addresses > Delete an email address for a user
+      #   # @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
+      #   #
+      #   #   emails = SupportOps::GitLab::UserEmails.list
+      #   #   email = emails.last
+      #   #   email.delete!
+      #   def delete!; end
+      define_attributes :confirmed_at, :email, :id, :skip_confirmation, :user_id
+      readonly_attributes :confirmed_at, :id
+
+      ##
+      # Lists all email addresses for a user
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param user_id [Integer optional] The user ID to get emails of (not
+      #     including this does it for the current user)
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/api/user_email_addresses/#list-all-email-addresses-for-a-user
+      #   GitLab API > User Emails > List all email addresses for a user
+      # @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
+      #
+      #   emails = SupportOps::GitLab::UserEmails.list(user_id: 123456)
+      #   pp emails.count
+      #   # => 2
+      #   pp emails.last.email
+      #   # => "email2@example.com"
+      def self.list(**args)
+        args[:user_id] = nil unless args[:user_id]
+        url = if args[:user_id].nil?
+                'user/emails'
+              else
+                "users/#{args[:user_id]}/emails"
+              end
+        response = client.connection.get(url)
+        body = Oj.load(response.body)
+        raise "Unable to get emails of user => #{body}" if response.status != 200
+        body.map { |e| UserEmails.new(e) }
+      end
+
+      private
+
+      ##
+      # @private
+      def create_record
+        data = {
+          email: self.email,
+          skip_confirmation: ( self.skip_confirmation.nil? ? false : self.skip_confirmation )
+        }.to_json
+        url = if self.user_id.nil?
+                'user/emails'
+              else
+                "users/#{self.user_id}/emails"
+              end
+        response = self.client.connection.post(url, data)
+        body = Oj.load(response.body)
+        raise "Failed to add email address => #{body}" if response.status != 201
+        body
+      end
+
+      ##
+      # @private
+      def update_record
+        raise 'You cannot update email addresses like that'
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("user/emails/#{self.id}")
+        body = Oj.load(response.body)
+        raise "No such email to delete #{self.email}" if response.status == 404
+        raise "Failed to delete email #{self.email} => #{body}" if response.status != 204
+        true
+      end
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/user_memberships.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class UserMemberships within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] access_level Access level to the source
+    # @attr [Integer] source_id ID of the source
+    # @attr [String] source_name Name of the source
+    # @attr [String] source_type Membership type (Project or Namespace)
+    class UserMemberships < SupportOps::GitLab::Base
+      define_attributes :access_level, :source_id, :source_name, :source_type
+      readonly_attributes :access_level, :source_id, :source_name, :source_type
+    end
+  end
+end