payping-gitlab-triage 0.1.1

data/lib/gitlab/triage/resource/base.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative '../url_builders/url_builder'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Base
+        attr_reader :resource, :parent
+
+        CONFIDENTIAL_TEXT = '(confidential)'
+
+        def self.define_field(name, &block)
+          define_method(name) do
+            if redact_confidential_attributes?
+              CONFIDENTIAL_TEXT
+            else
+              instance_eval(&block)
+            end
+          end
+        end
+
+        def initialize(
+          resource, parent: nil, network: nil, redact_confidentials: true)
+          @resource = resource
+          @parent = parent
+          @network = network
+          @redact_confidentials = redact_confidentials
+        end
+
+        protected
+
+        def redact_confidential_attributes?
+          parent&.redact_confidential_attributes? ||
+            (@redact_confidentials && resource[:confidential])
+        end
+
+        def network
+          parent&.network || @network
+        end
+
+        private
+
+        def expand_resource!(params: {})
+          resource.merge!(
+            network.query_api_cached(resource_url(params: params)).first)
+        end
+
+        def source_resource
+          @source_resource ||= network.query_api_cached(source_url).first
+        end
+
+        def source_url
+          build_url(options: { resource_type: nil })
+        end
+
+        def url(params = {})
+          build_url(params: params)
+        end
+
+        def resource_id
+          resource[:iid]
+        end
+
+        def resource_url(params: {}, sub_resource_type: nil)
+          build_url(
+            params: params,
+            options: {
+              resource_id: resource_id,
+              sub_resource_type: sub_resource_type
+            }
+          )
+        end
+
+        def build_url(params: {}, options: {})
+          UrlBuilders::UrlBuilder.new(
+            url_opts
+              .merge(options)
+              .merge(params: { per_page: 100 }.merge(params))
+          ).build
+        end
+
+        def url_opts
+          {
+            network_options: network.options,
+            resource_type: self.class.name.demodulize.underscore.pluralize,
+            source: source,
+            source_id: resource[:"#{source.singularize}_id"]
+          }
+        end
+
+        def source
+          if resource[:project_id]
+            'projects'
+          elsif resource[:group_id]
+            'groups'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/branch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'shared/issuable'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Branch < Base
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/context.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'epic'
+require_relative 'issue'
+require_relative 'linked_issue'
+require_relative 'merge_request'
+require_relative 'instance_version'
+require_relative 'branch'
+
+module Gitlab
+  module Triage
+    module Resource
+      module Context
+        EvaluationError = Class.new(RuntimeError)
+
+        def self.build(resource, **options)
+          const_name = (resource[:type] || 'Base')
+            .to_s.singularize.camelcase
+
+          Resource.const_get(const_name).new(resource, **options).extend(self)
+        end
+
+        def eval(ruby)
+          instance_eval <<~RUBY, __FILE__, __LINE__ + 1
+            begin
+              #{ruby}
+            rescue StandardError, ScriptError => e
+              raise EvaluationError.new(e.message)
+            end
+          RUBY
+        rescue EvaluationError => e
+          # This way we could obtain the original backtrace and error
+          # If we just let instance_eval raise an error, the backtrace
+          # won't contain the actual line where it's giving an error.
+          raise e.cause
+        end
+
+        private
+
+        def instance_version
+          @instance_version ||= InstanceVersion.new(parent: self)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/epic.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'shared/issuable'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Epic < Base
+        include Shared::Issuable
+
+        def project_path
+          @project_path ||=
+            request_group(resource[:group_id])[:full_path]
+        end
+        alias_method :group_path, :project_path
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/instance_version.rb

@@ -0,0 +1,35 @@
+require_relative 'base'
+
+module Gitlab
+  module Triage
+    module Resource
+      class InstanceVersion < Base
+        def initialize(**options)
+          super({}, **options)
+        end
+
+        def version
+          response[:version]
+        end
+
+        def version_short
+          version[/^\d+\.\d+/]
+        end
+
+        def revision
+          response[:revision]
+        end
+
+        private
+
+        # See https://gitlab.com/api/v4/version
+        def response
+          @response ||=
+            network.query_api_cached(
+              "#{network.options.host_url}/api/#{network.options.api_version}/version")
+              .first
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/issue.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'shared/issuable'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Issue < Base
+        include Shared::Issuable
+
+        DATE_FIELDS = %i[
+          due_date
+        ].freeze
+
+        DATE_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Date.parse(value) if value
+          end
+        end
+
+        def merge_requests_count
+          @merge_requests_count ||= resource.dig(:merge_requests_count)
+        end
+
+        def related_merge_requests
+          @related_merge_requests ||= network.query_api_cached(
+            resource_url(sub_resource_type: 'related_merge_requests'))
+            .map { |merge_request| MergeRequest.new(merge_request, parent: self) }
+        end
+
+        def closed_by
+          @closed_by ||= network.query_api_cached(
+            resource_url(sub_resource_type: 'closed_by'))
+            .map { |merge_request| MergeRequest.new(merge_request, parent: self) }
+        end
+
+        def linked_issues
+          @linked_issues ||= network.query_api_cached(
+            resource_url(sub_resource_type: 'links'))
+            .map { |issue| LinkedIssue.new(issue, parent: self) }
+        end
+
+        def expired?(today = Date.today)
+          due_date && due_date < today
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/label.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'date'
+require 'time'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Label < Base
+        LabelDoesntExistError = Class.new(StandardError)
+
+        FIELDS = %i[
+          id
+          project_id
+          group_id
+          name
+          description
+          color
+          priority
+        ].freeze
+
+        TIME_FIELDS = %i[
+          added_at
+        ].freeze
+
+        FIELDS.each do |field|
+          define_field(field) do
+            resource[field]
+          end
+        end
+
+        TIME_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Time.parse(value) if value
+          end
+        end
+
+        def exist?
+          label = network.query_api_cached(resource_url).first
+          return false unless label
+
+          label[:name] == name
+        end
+
+        private
+
+        def resource_id
+          name
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/label_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'label'
+require 'date'
+require 'time'
+
+module Gitlab
+  module Triage
+    module Resource
+      class LabelEvent < Base
+        FIELDS = %i[
+          id
+          user
+          resource_type
+          resource_id
+          action
+        ].freeze
+
+        TIME_FIELDS = %i[
+          created_at
+        ].freeze
+
+        FIELDS.each do |field|
+          define_field(field) do
+            resource[field]
+          end
+        end
+
+        TIME_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Time.parse(value) if value
+          end
+        end
+
+        def label
+          return unless resource[:label]
+
+          @label ||= Label.new(
+            resource[:label].reverse_merge(added_at: resource[:created_at]),
+            parent: self)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/linked_issue.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'issue'
+
+module Gitlab
+  module Triage
+    module Resource
+      class LinkedIssue < Issue
+        def link_type
+          @link_type ||= resource.dig(:link_type)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/merge_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'shared/issuable'
+
+module Gitlab
+  module Triage
+    module Resource
+      class MergeRequest < Base
+        include Shared::Issuable
+
+        def first_contribution?
+          if resource.key?(:first_contribution)
+            resource[:first_contribution]
+          else
+            expanded = expand_resource!
+            expanded[:first_contribution]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/milestone.rb

@@ -0,0 +1,98 @@
+require_relative 'base'
+require 'date'
+require 'time'
+
+module Gitlab
+  module Triage
+    module Resource
+      class Milestone < Base
+        FIELDS = %i[
+          id
+          iid
+          project_id
+          group_id
+          title
+          description
+          state
+        ].freeze
+
+        DATE_FIELDS = %i[
+          due_date
+          start_date
+        ].freeze
+
+        TIME_FIELDS = %i[
+          updated_at
+          created_at
+        ].freeze
+
+        FIELDS.each do |field|
+          define_field(field) do
+            resource[field]
+          end
+        end
+
+        DATE_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Date.parse(value) if value
+          end
+        end
+
+        TIME_FIELDS.each do |field|
+          define_field(field) do
+            value = resource[field]
+
+            Time.parse(value) if value
+          end
+        end
+
+        def succ
+          index = current_index
+
+          all_active_with_start_date[index.succ] if index
+        end
+
+        def active?
+          state == 'active'
+        end
+
+        def closed?
+          state == 'closed'
+        end
+
+        def started?(today = Date.today)
+          start_date && start_date <= today
+        end
+
+        def expired?(today = Date.today)
+          due_date && due_date < today
+        end
+
+        def in_progress?(today = Date.today)
+          started?(today) && !expired?(today)
+        end
+
+        private
+
+        def current_index
+          all_active_with_start_date
+            .index { |milestone| milestone.id == id }
+        end
+
+        def all_active_with_start_date
+          @all_active_with_start_date ||=
+            all_active.select(&:start_date).sort_by(&:start_date)
+        end
+
+        def all_active
+          @all_active ||=
+            network
+              .query_api_cached(url(state: 'active'))
+              .map { |milestone| self.class.new(milestone, parent: self) }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/resource/shared/issuable.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative '../label'
+require_relative '../label_event'
+require_relative '../milestone'
+
+module Gitlab
+  module Triage
+    module Resource
+      module Shared
+        module Issuable
+          SourceTooDeep = Class.new(RuntimeError)
+          MAX_PARENT_LOOKUP = 10
+
+          def milestone
+            @milestone ||=
+              resource[:milestone] &&
+              Milestone.new(resource[:milestone], parent: self)
+          end
+
+          # This will be more useful when we have:
+          # https://gitlab.com/gitlab-org/gitlab-ce/issues/51011
+          def labels
+            @labels ||= resource[:labels] # an array of label names
+              .map { |label| Label.new({ name: label }, parent: self) }
+          end
+
+          # Make this an alias of `labels` when we have:
+          # https://gitlab.com/gitlab-org/gitlab-ce/issues/51011
+          def labels_with_details
+            # Labels can be deleted thus event.label can be nil
+            @labels_with_details ||= label_events
+              .select { |event| event.action == 'add' && event.label }
+              .map(&:label)
+              .sort_by(&:added_at)
+              .reverse
+              .uniq(&:name)
+              .select { |label| resource[:labels].include?(label.name) }
+          end
+
+          def label_events
+            @label_events ||= query_label_events
+              .map { |label_event| LabelEvent.new(label_event, parent: self) }
+          end
+
+          def labels_chronologically
+            @labels_chronologically ||= labels_with_details.sort_by(&:added_at)
+          end
+
+          def state
+            @state ||= resource.dig(:state)
+          end
+
+          def author
+            @author ||= resource.dig(:author, :username)
+          end
+
+          def project_path
+            @project_path ||=
+              request_project(resource[:project_id])[:path_with_namespace]
+          end
+
+          def full_resource_reference
+            @full_resource_reference ||= resource.dig(:references, :full)
+          end
+
+          def root_id(
+            resource: source_resource,
+            max_levels: MAX_PARENT_LOOKUP)
+            raise SourceTooDeep if max_levels <= 0
+
+            # In projects, the reference to the namespace's parent ID is `namespace.parent_id`
+            # but in groups, the reference is directly in `parent_id`
+            parent_id = resource.dig(:namespace, :parent_id) || resource.dig(:parent_id)
+
+            if parent_id
+              root_id(
+                resource: request_group(parent_id),
+                max_levels: max_levels - 1)
+            else
+              resource.dig(:namespace, :id) || resource[:id]
+            end
+          end
+
+          private
+
+          def query_label_events
+            network.query_api_cached(
+              resource_url(sub_resource_type: 'resource_label_events'))
+          end
+
+          def request_project(project_id)
+            network.query_api_cached(project_url(project_id)).first
+          end
+
+          def request_group(group_id)
+            network.query_api_cached(group_url(group_id)).first
+          end
+
+          def group_url(group_id)
+            Gitlab::Triage::UrlBuilders::UrlBuilder.new(
+              network_options: network.options,
+              source: 'groups',
+              source_id: group_id
+            ).build
+          end
+
+          def project_url(project_id)
+            Gitlab::Triage::UrlBuilders::UrlBuilder.new(
+              network_options: network.options,
+              source: 'projects',
+              source_id: project_id
+            ).build
+          end
+        end
+      end
+    end
+  end
+end