gitlab_support_readiness 1.0.11 → 1.0.12

data/lib/support_readiness/gitlab/markdown.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Markdown within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Markdown < Readiness::Client
+      ##
+      # Renders text using Markdown
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param text [String] The text to render
+      # @param gfm [Boolean] If this should render as GitLab Flavored Markdown or not
+      # @param project [String] The project slug to use as a template
+      # @return [String]
+      # @see https://docs.gitlab.com/ee/api/markdown.html#render-an-arbitrary-markdown-document GitLab API > Markdown > Render an arbitrary Markdown document
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = ENV.fetch('GL_TOKEN')
+      #   client = Readiness::GitLab::Client.new(config)
+      #   pp Readiness::GitLab::Markdown.convert(client, 'This is a test')
+      #   # => "<p data-sourcepos=\"1:1-1:14\">This is a test</p>"
+      def self.convert(client, text, gfm = false, project = 'gitlab-org/gitlab')
+        response = client.connection.post 'markdown', { text: text, gfm: gfm, project: project }.to_json
+        Oj.load(response.body)['html']
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/merge_requests.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class MergeRequests within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class MergeRequests < Readiness::Client
+      ##
+      # Locates a project merge request within GitLab. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param iid [Integer] The issue ID to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr GitLab API > Merge requests > Get single MR
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   issue = Readiness::GitLab::MergeRequests.find(client, project, 5)
+      #   puts issues.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/merge_requests/5"
+      def self.find(client, project, iid)
+        response = client.connection.get "projects/#{project.id}/merge_requests/#{iid}"
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a project merge request within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param iid [Integer] The issue ID to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr GitLab API > Merge requests > Get single MR
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   issue = Readiness::GitLab::MergeRequests.find!(client, project, 5)
+      #   puts issues.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/merge_requests/5"
+      def self.find!(client, project, iid)
+        response = client.connection.get "projects/#{project.id}/merge_requests/#{iid}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find MR', id: "projects/#{project.id}/merge_requests/#{iid}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Get all comments on a project merge request within GitLab.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param iid [Integer] The IID of the merge request
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/notes.html#list-all-merge-request-notes GitLab API > Notes (comments) > List all merge request notes
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   comments = Readiness::GitLab::MergeRequests.comments(client, project, 123)
+      #   pp comments.first['updated_at']
+      #    # => "2013-10-02T09:56:03Z"
+      def self.comments(client, project, iid)
+        array = []
+        page = 0
+        loop do
+          response = client.connection.get "projects/#{project.id}/merge_requests/#{iid}/notes?per_page=100&page=#{page}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Create a comment on a project merge request within GitLab.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param iid [Integer] The IID of the merge request
+      # @param params [Hash] The parameters to use in creating the comment
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/notes.html#create-new-merge-request-note GitLab API > Notes (comments) > Create new merge request note
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   comment_params = {
+      #     body: 'My name is Jason and I approve this comment',
+      #     internal: true
+      #   }
+      #   comment = Readiness::GitLab::MergeRequests.create_comment(client, project, 123, comment_params)
+      #   pp comment['updated_at']
+      #    # => "2024-09-23T15:42:13Z"
+      def self.create_comment!(client, project, iid, params)
+        response = client.connection.post "projects/#{project.id}/merge_requests/#{iid}/notes", params.to_json
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create MR comment', id: "projects/#{project.id}/merge_requests/#{iid}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/namespaces.rb

@@ -185,6 +185,28 @@ module Readiness
         handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: namespace.id }) unless response.status == 200
         Oj.load(response.body)
       end
+
+      ##
+      # Determines if a given namespace is paid or not
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param namespace [Object] An instance of {Readiness::GitLab::Namespaces}
+      # @return [Boolean]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   namespace = Readiness::GitLab::Namespaces.find!(client, 123)
+      #   pp Readiness::GitLab::Namespaces.is_paid?(client, namespace)
+      #   # => true
+      def self.is_paid?(client, namespace)
+        return true if %w[bronze silver gold premium ultimate].include? namespace.plan
+
+        false
+      end
     end
   end
 end

data/lib/support_readiness/gitlab/projects.rb

@@ -385,7 +385,7 @@ module Readiness
       #   # => "alice_one"
       def self.all_members(client, project, filters = [])
         array = []
-        page = 1
+        page = 0
         loop do
           response = client.connection.get "projects/#{project.id}/members/all?per_page=100&page=#{page}&#{to_param_string(filters)}"
           handle_request_error(0, 'GitLab', response.status) unless response.status == 200
@@ -505,6 +505,41 @@ module Readiness
         handle_request_error(1, 'GitLab', response.status, { action: 'Delete badge', id: project.id }) unless response.status == 200
         true
       end
+
+      ##
+      # Lists all milestones in a project.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/milestones.html#list-project-milestones GitLab API > Projects > Milestones > List project milestones
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   milestones = Readiness::GitLab::Projects.milestones(client, project)
+      #   pp milestones.count
+      #   # => 25
+      def self.milestones(client, project, filters = [])
+        array = []
+        page = 0
+        loop do
+          response = client.connection.get "projects/#{project.id}/milestones?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
     end
   end
 end

data/lib/support_readiness/gitlab/repositories.rb

@@ -262,6 +262,180 @@ module Readiness
         handle_request_error(1, 'GitLab', response.status, { action: 'Update submodule in repo', id: "#{project.id}" }) unless response.status == 200
         Oj.load(response.body)
       end
+
+      ##
+      # Lists a repository's commits.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/commits.html#list-repository-commits GitLab API > Repositories > List repository commits
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   commits = Readiness::GitLab::Repositories.commits(client, project)
+      #   pp commits.first['title']
+      #   # => "Replace sanitize with escape once"
+      def self.commits(client, project, filters)
+        array = []
+        page = 0
+        loop do
+          response = client.connection.get "projects/#{project.id}/repository/commits?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Lists a repository's tags.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/tags.html#list-project-repository-tags GitLab API > Tags > List project repository tags
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tags = Readiness::GitLab::Repositories.tags(client, project)
+      #   pp tags.first['commit']['id']
+      #   # => "2695effb5807a22ff3d138d593fd856244e155e7"
+      def self.tags(client, project, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "projects/#{project.id}/repository/tags?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Locates a repository tag. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag_name [String] The tag to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/tags.html#get-a-single-repository-tag GitLab API > Tags > Get a single project repository tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tag = Readiness::GitLab::Repositories.find_tag(client, project, 'v5.0.0')
+      #   pp tag.['target']
+      #   # => "60a8ff033665e1207714d6670fcd7b65304ec02f"
+      def self.find_tag(client, project, tag_name)
+        response = client.connection.get "projects/#{project.id}/repository/tags/#{tag_name}"
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: "projects/#{project.id}/repository/tags/#{tag_name}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a repository tag. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag_name [String] The tag to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/tags.html#get-a-single-repository-tag GitLab API > Tags > Get a single project repository tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tag = Readiness::GitLab::Repositories.find_tag!(client, project, 'v5.0.0')
+      #   pp tag.['target']
+      #   # => "60a8ff033665e1207714d6670fcd7b65304ec02f"
+      def self.find_tag!(client, project, tag_name)
+        response = client.connection.get("projects/#{project.id}/repository/tags/#{tag_name}")
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find tag', id: "projects/#{project.id}/repository/tags/#{tag_name}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Creates a repository tag. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag [Hash] The Hash to use for the tag creation
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/tags.html#create-a-new-tag GitLab API > Tags > Create a new tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tag = {
+      #     tag_name: 'test',
+      #     ref: 'main'
+      #   }
+      #   create = Readiness::GitLab::Repositories.create_tag!(client, project, tag)
+      #   pp create['target']
+      #   # => "2695effb5807a22ff3d138d593fd856244e155e7"
+      def self.create_tag!(client, project, tag)
+        response = client.connection.post "projects/#{project.id}/repository/tags", tag.to_json
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create tag', id: "projects/#{project.id}/repository/tags" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Deletes a repository tag. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag_name [String] The name of the tag to delete
+      # @return [Boolean]
+      # @see https://docs.gitlab.com/ee/api/tags.html#delete-a-tag GitLab API > Tags > Delete a tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   delete = Readiness::GitLab::Repositories.create_tag!(client, project, 'test')
+      #   pp delete
+      #   # => true
+      def self.delete_tag!(client, project, tag_name)
+        response = client.connection.delete "projects/#{project.id}/repository/tags/#{tag_name}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Delete tag', id: "projects/#{project.id}/repository/tags/#{tag_name}" }) unless response.status == 200
+        true
+      end
     end
   end
 end

data/lib/support_readiness/gitlab/users.rb

@@ -507,6 +507,30 @@ module Readiness
         handle_request_error(0, 'GitLab', response.status) unless response.status == 200
         Oj.load(response.body)
       end
+
+      ##
+      # Determines if a user is the only maintainer on projects they are within
+      #
+      # @author Jason Colyer
+      # @since 1.0.3
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param user [Object] An instance of {Readiness::GitLab::Users}
+      # @return [Boolean]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   user = Readiness::GitLab::Users.find!(client, 5881867)
+      #   pp Readiness::GitLab::Users.only_maintainer?(client, user)
+      #   # => true
+      def self.only_maintainer?(client, user)
+        Users.projects(client, user).each do |p|
+          members = Projects.all_members(client, p)
+          return true if members = members.select { |m| m['access_level'] >= 40 && m['username'] != user.username }.count.zero?
+        end
+        false
+      end
     end
   end
 end

data/lib/support_readiness/gitlab.rb

@@ -11,6 +11,8 @@ module Readiness
     require "#{__dir__}/gitlab/configuration"
     require "#{__dir__}/gitlab/groups"
     require "#{__dir__}/gitlab/issues"
+    require "#{__dir__}/gitlab/markdown"
+    require "#{__dir__}/gitlab/merge_requests"
     require "#{__dir__}/gitlab/namespaces"
     require "#{__dir__}/gitlab/projects"
     require "#{__dir__}/gitlab/repositories"

data/lib/support_readiness/google_calendar/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleCalendar
+  module GoogleCalendar
+    ##
+    # Defines the class Client within the module {Readiness::GoogleCalendar}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Client
+      attr_accessor :calendar_id, :service
+
+      ##
+      # Creates a new {Readiness::GoogleCalendar::Client} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param config [Object] An instance of {Readiness::GoogleCalendar::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleCalendar::Client.new(config)
+      #   pp client.calendar_id
+      #   # => "abc123"
+      def initialize(config = Readiness::GoogleCalendar::Configuration.new)
+        @service = generate_service(config)
+        @calendar_id = config.calendar_id
+      end
+
+      ##
+      # Generates a service connection to Google Calendar
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param config [Object] An instance of {Readiness::GoogleCalendar::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   service = Readiness::GoogleCalendar::Client.generate_service(config)
+      def generate_service(config)
+        authorize = Google::Auth::ServiceAccountCredentials.make_creds(
+          json_key_io: File.open(config.filepath),
+          scope: config.scope
+        )
+        authorize.fetch_access_token!
+        service = Google::Apis::CalendarV3::CalendarService.new
+        service.authorization = authorize
+        service
+      end
+    end
+  end
+end

data/lib/support_readiness/google_calendar/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleCalendar
+  module GoogleCalendar
+    ##
+    # Defines the class Configuration within the module {Readiness::GoogleCalendar}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Configuration
+      attr_accessor :calendar_id, :filepath, :scope
+
+      ##
+      # Creates a new {Readiness::GoogleCalendar::Configuration} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   pp config
+      #   # => #<Readiness::GoogleCalendar::Configuration:0x00007f352fdd1420
+      #          @calendar_id="abc123"
+      #          @filepath="data/config.json"
+      #          @scope="https://www.googleapis.com/auth/calendar">
+      def initialize
+        # /home/jason/dev/gitlab-support-readiness/zendesk-us-government/tickets/round-robin/lib/round_robin
+        @calendar_id = ''
+        @filepath = ''
+        @scope = 'https://www.googleapis.com/auth/calendar'
+      end
+    end
+  end
+end