gitlab_support_readiness 1.0.104 → 1.0.106

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d5b7d43f51bdc395c10efefdfc747d3b0b0b0a1123bb47f79b33bbae74cb3dd
-  data.tar.gz: '09fe6fbc8783de005f806fd9a505a48be1f585c3b74b8b4acc9c683a94466021'
+  metadata.gz: 382bb3f8e93489bd0981ac1314b30102c707b91b5298766c81a3b874873e154a
+  data.tar.gz: b26189e604d605fa8e38a2c121e4c9df4187d5d7f97e6a31ad853b75693dd7cc
 SHA512:
-  metadata.gz: e100ad88dbe3600af08b841f0c6ded08a745abaec90565400872bfa43e24e3acd24217193b641067cc88e75c6f08f0913edb604c95d0445acce294b9551b3fec
-  data.tar.gz: e9149339fdfdb54ca86abf3e33d2badb5b64df2b0c3f573b770023bfa0c8a9138c0ca897aeda44ee78308abf70ee62d6e22f15e8441913ae3bdec1945bab22fd
+  metadata.gz: 531ea2fd66a168979466a8aa574472db8f2931c321f1681f8d8ccf102a71dfc741a2422be260da41b18dc577013bd7b56e040b1fa78534ef932697098a3bbc52
+  data.tar.gz: b3c111629ae14987e2ec82a5f6e64f9cd0f275569e1331879f63e47b593c4ac13a683d0691bc2a2c87f1ed6bf2c5eee478af0938dc9f073656cae9aaead368ee

data/lib/support_readiness/gitlab/epics.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Epics within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.105
+    # @todo create! - https://docs.gitlab.com/ee/api/epics.html#new-epic
+    # @todo create_todo_item! - https://docs.gitlab.com/ee/api/epics.html#create-a-to-do-item
+    # @todo update! - https://docs.gitlab.com/ee/api/epics.html#update-epic
+    # @todo delete! - https://docs.gitlab.com/ee/api/epics.html#delete-epic
+    class Epics < Readiness::Client
+      attr_accessor :author, :closed_at, :color, :created_at, :description, :downvotes, :due_date, :due_date_fixed, :due_date_from_inherited_source, :due_date_from_milestones, :due_date_is_fixed, :end_date, :group_id, :id, :iid, :imported, :imported_from, :labels, :_links, :parent_id, :parent_iid, :reference, :references, :start_date, :start_date_fixed, :start_date_from_inherited_source, :start_date_from_milestones, :state, :subscribed, :title, :updated_at, :upvotes, :web_url
+
+      ##
+      # Creates a new {Readiness::GitLab::Epics} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.105
+      # @param object [Object] An instance of {Readiness::GitLab::Epics}
+      # @example
+      #   require 'support_readiness'
+      #   group = Readiness::GitLab::Epics.new
+      def initialize(object = {})
+        @author = object['author']
+        @closed_at = object['closed_at']
+        @color = object['color']
+        @created_at = object['created_at']
+        @description = object['description']
+        @downvotes = object['downvotes']
+        @due_date = object['due_date']
+        @due_date_fixed = object['due_date_fixed']
+        @due_date_from_inherited_source = object['due_date_from_inherited_source']
+        @due_date_from_milestones = object['due_date_from_milestones']
+        @due_date_is_fixed = object['due_date_is_fixed']
+        @end_date = object['end_date']
+        @group_id = object['group_id']
+        @id = object['id']
+        @iid = object['iid']
+        @imported = object['imported']
+        @imported_from = object['imported_from']
+        @labels = object['labels']
+        @_links = object['_links']
+        @parent_id = object['parent_id']
+        @parent_iid = object['parent_iid']
+        @reference = object['reference']
+        @references = object['references']
+        @start_date = object['start_date']
+        @start_date_fixed = object['start_date_fixed']
+        @start_date_from_inherited_source = object['start_date_from_inherited_source']
+        @start_date_from_milestones = object['start_date_from_milestones']
+        @state = object['state']
+        @subscribed = object['subscribed']
+        @title = object['title']
+        @updated_at = object['updated_at']
+        @upvotes = object['upvotes']
+        @web_url = object['web_url']
+      end
+
+      ##
+      # Lists epics in a group.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.105
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param group [Object] An instance of {Readiness::GitLab::Groups}
+      # @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/epics.html#list-epics-for-a-group GitLab API > Epics > List epics for a group
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new
+      #   group.id = 1
+      #   epics = Readiness::GitLab::Epics.list(client, group, ["state=opened", "include_descendant_groups=true"])
+      #   puts epics.first.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-ops/-/epics/22"
+      def self.list(client, group, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "groups/#{group.id}/epics?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.map { |e| Epics.new(e) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Locates an epic within GitLab. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.105
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param group [Object] An instance of {Readiness::GitLab::Groups}
+      # @param iid [Integer] The epic ID to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/epics.html#single-epic GitLab API > Epics > Single epic
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new({ 'id' => 123 })
+      #   epic = Readiness::GitLab::Epics.find(client, group, 5)
+      #   puts epic.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/issues/5"
+      def self.find(client, group, iid)
+        response = client.connection.get "groups/#{group.id}/epics/#{iid}"
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: epic_id }) unless response.status == 200
+        return Epics.new(Oj.load(response.body)) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an epic within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.105
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param group [Object] An instance of {Readiness::GitLab::Groups}
+      # @param iid [Integer] The epic ID to find
+      # @return [Object]
+      # @see https://docs.gitlab.com/ee/api/epics.html#single-epic GitLab API > Epics > Single epic
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new({ 'id' => 123 })
+      #   epic = Readiness::GitLab::Epics.find!(client, group, 5)
+      #   puts epic.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/issues/5"
+      def self.find!(client, group, iid)
+        response = client.connection.get "groups/#{group.id}/epics/#{iid}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find epic', id: iid }) unless response.status == 200
+        Epics.new(Oj.load(response.body))
+      end
+
+      ##
+      # Lists issues within an epic.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.105
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param epic [Object] An instance of {Readiness::GitLab::Epics}
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/epic_issues.html#list-issues-for-an-epic GitLab API > Issues (epic) > List issues for an epic
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new({ 'id' => 1 })
+      #   epic = Readiness::GitLab::Epics.find!(client, group, 5)
+      #   issues = Readiness::GitLab::Epics.issues(client, epic)
+      #   puts issues.count
+      #   # => 45
+      def self.issues(client, epic)
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "groups/#{epic.group_id}/epics/#{epic.iid}/issues?per_page=100&page=#{page}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body.map { |e| Issues.new(e) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Assigns an issue to an epic. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.105
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param epic [Object] An instance of {Readiness::GitLab::Epics}
+      # @param issue [Object] An instance of {Readiness::GitLab::Issues}
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/epic_issues.html#assign-an-issue-to-the-epic GitLab API > Issues (epic) > Assign an issue to the epic
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new({ 'id' => 1 })
+      #   epic = Readiness::GitLab::Epics.find!(client, group, 5)
+      #   project = Readiness::GitLab::Projects.find!(client, 66)
+      #   issue = Readiness::GitLab::Issues.find!(client, project, 23)
+      #   assign = Readiness::GitLab::Epics.assign_issue!(client, epic, issue)
+      #   puts assign['epic']['iid']
+      #   # => 5
+      def self.assign_issue!(client, epic, issue)
+        response = client.connection.post "groups/#{epic.group_id}/epics/#{epic.iid}/issues/#{issue.id}"
+        handle_request_error(1, 'GitLab', response.status, { action: "Assign issue epic #{epic.iid}", id: issue.id }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Removes an issue to an epic. The issue object must be obtained via {Readiness::GitLab::Epics#list}. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.105
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param epic [Object] An instance of {Readiness::GitLab::Epics}
+      # @param issue [Object] An instance of {Readiness::GitLab::Issues}
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/epic_issues.html#remove-an-issue-from-the-epic GitLab API > Issues (epic) > Remove an issue from the epic
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new({ 'id' => 2573624 })
+      #   epic = Readiness::GitLab::Epics.find!(gitlab_client, group, 16)
+      #   issues = Readiness::GitLab::Epics.issues(gitlab_client, epic)
+      #   issue = issues.detect { |i| i.iid == 2491 }
+      #   remove = Readiness::GitLab::Epics.remove_issue!(gitlab_client, epic, issue)
+      #   puts remove['epic']['id']
+      #   # => 2087187
+      def self.remove_issue!(client, epic, issue)
+        return handle_request_error(1, 'GitLab', 400, { action: "No issue provided to remove from epic #{epic.iid}", id: '' }) if issue.nil?
+        return handle_request_error(1, 'GitLab', 400, { action: "Issue is not assigned to epic #{epic.iid}", id: issue.iid }) if issue.epic_issue_id.nil?
+
+        response = client.connection.delete "groups/#{epic.group_id}/epics/#{epic.iid}/issues/#{issue.epic_issue_id}"
+        handle_request_error(1, 'GitLab', response.status, { action: "Remove issue from epic #{epic.iid}", id: issue.iid }) unless response.status == 200
+        Oj.load(response.body)
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/issues.rb

@@ -11,7 +11,7 @@ module Readiness
     # @since 1.0.0
     # @todo Anything listed on https://docs.gitlab.com/ee/api/issues.html not currently here
     class Issues < Readiness::Client
-      attr_accessor :assignee_id, :assignee_ids, :assignees, :author, :blocking_issues_count, :closed_at, :closed_by, :confidential, :created_at, :description, :discussion_locked, :downvotes, :due_date, :epic, :has_tasks, :health_status, :id, :iid, :imported, :imported_from, :issue_type, :iteration, :labels, :_links, :merge_requests_count, :milestone, :moved_to_id, :project_id, :references, :service_desk_reply_to, :severity, :state, :state_event, :task_completion_status, :task_status, :time_stats, :title, :type, :updated_at, :upvotes, :user_notes_count, :web_url, :weight
+      attr_accessor :assignee_id, :assignee_ids, :assignees, :author, :blocking_issues_count, :closed_at, :closed_by, :confidential, :created_at, :description, :discussion_locked, :downvotes, :due_date, :epic, :epic_issue_id, :has_tasks, :health_status, :id, :iid, :imported, :imported_from, :issue_type, :iteration, :labels, :_links, :merge_requests_count, :milestone, :moved_to_id, :project_id, :references, :service_desk_reply_to, :severity, :state, :state_event, :task_completion_status, :task_status, :time_stats, :title, :type, :updated_at, :upvotes, :user_notes_count, :web_url, :weight
 
       ##
       # Creates a new {Readiness::GitLab::Issues} instance
@@ -37,6 +37,7 @@ module Readiness
         @downvotes = object['downvotes']
         @due_date = object['due_date']
         @epic = object['epic']
+        @epic_issue_id = object['epic_issue_id']
         @has_tasks = object['has_tasks']
         @health_status = object['health_status']
         @id = object['id']

data/lib/support_readiness/gitlab.rb

@@ -10,6 +10,7 @@ module Readiness
     require "#{__dir__}/gitlab/client"
     require "#{__dir__}/gitlab/configuration"
     require "#{__dir__}/gitlab/groups"
+    require "#{__dir__}/gitlab/epics"
     require "#{__dir__}/gitlab/issues"
     require "#{__dir__}/gitlab/jobs"
     require "#{__dir__}/gitlab/markdown"

data/lib/support_readiness/redis.rb

@@ -18,11 +18,13 @@ module Readiness
     # @param host [String] The hostname to use in Redis connections
     # @param port [Integer] The port number to use in Redis connections
     # @param password [String] The password to use in Redis connections
+    # @param username [String] The username to use in Redis connections
+    # @param ssl [Boolean] The SSL setting to use in Redis connections
     # @example
     #   require 'support_readiness'
     #   redis = Readiness::Redis.new('domain.com', 6379, 'p@assw0rd!')
-    def initialize(host, port, password)
-      @connection = generate_client(host, port, password)
+    def initialize(host, port, password, username = nil, ssl = true)
+      @connection = generate_client(host, port, password, username, ssl)
     end
 
     ##
@@ -33,11 +35,14 @@ module Readiness
     # @param host [String] The hostname to use in Redis connections
     # @param port [Integer] The port number to use in Redis connections
     # @param password [String] The password to use in Redis connections
-    def generate_client(host, port, password)
+    # @param username [String] The username to use in Redis connections
+    # @param ssl [Boolean] The SSL setting to use in Redis connections
+    def generate_client(host, port, password, username, ssl)
       ::Redis.new(host: host,
+                  username: username,
                   port: port,
                   password: password,
-                  ssl: true)
+                  ssl: ssl)
     end
 
     ##

data/lib/support_readiness/zendesk/search.rb

@@ -72,7 +72,7 @@ module Readiness
       #   config.token = 'test123abc'
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
-      #   search = Readiness::Zendesk::Search.organzations(client, 'salesforce_id:ABCDEFGH0123456*')
+      #   search = Readiness::Zendesk::Search.organizations(client, 'salesforce_id:ABCDEFGH0123456*')
       #   pp search.first.notes
       #   # => "This org is escalated. Please talk to support managers."
       def self.organizations(client, query)
@@ -120,7 +120,7 @@ module Readiness
       #   config.token = 'test123abc'
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
-      #   search = Readiness::Zendesk::Search.searc(client, 'organization', 'salesforce_id:ABCDEFGH0123456*')
+      #   search = Readiness::Zendesk::Search.search(client, 'organization', 'salesforce_id:ABCDEFGH0123456*')
       #   pp search.first.notes
       #   # => "This org is escalated. Please talk to support managers."
       def self.search(client, type, query)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.104
+  version: 1.0.106
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -272,6 +272,7 @@ files:
 - lib/support_readiness/gitlab.rb
 - lib/support_readiness/gitlab/client.rb
 - lib/support_readiness/gitlab/configuration.rb
+- lib/support_readiness/gitlab/epics.rb
 - lib/support_readiness/gitlab/groups.rb
 - lib/support_readiness/gitlab/issues.rb
 - lib/support_readiness/gitlab/jobs.rb