gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/issues.rb

@@ -0,0 +1,606 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Issues within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] add_labels Comma-separated label names to add to an issue; if a label does not already exist, this creates a new project label and assigns it to the issue
+    # @attr [Array] assignee_ids The IDs of the users to assign the issue to
+    # @attr [Array] assignees An array of users assigned to the issue
+    # @attr [Hash] author The author of the issue
+    # @attr [String] closed_at The timestamp the issue was closed at
+    # @attr [Hash] closed_by The user who closed the issue
+    # @attr [Boolean] confidential If the issue is confidential or not
+    # @attr [String] created_at The timestamp of when the issue was created
+    # @attr [String] description The issue's description
+    # @attr [Boolean] discussion_locked If discussion on the issue is locked or not
+    # @attr [String] discussion_to_resolve The ID of a discussion to resolve; this fills out the issue with a default description and mark the discussion as resolved
+    # @attr [Integer] downvotes The number of downvotes the issue has
+    # @attr [String] due_date The due date
+    # @attr [Hash] epic the epic the issue is attached to
+    # @attr [Integer] epic_id The ID of the epic the issue is attached to
+    # @attr [Integer] epic_iid IID of the epic to add the issue to 
+    # @attr [Boolean] has_tasks If the issue has attached tasks or not
+    # @attr [String] health_status The current health status of the issue
+    # @attr [Integer] id The global ID or URL-encoded path of the project
+    # @attr [Integer] iid The internal ID of a project’s issue
+    # @attr [Boolean] imported If the issue was imported or not
+    # @attr [String] imported_from
+    # @attr [String] issue_type The type of issue; either issue, incident, test_case, or task
+    # @attr [Hash] iteration The iteration the issue is in
+    # @attr [Array] labels Comma-separated list of label names
+    # @attr [Hash] _links Various links related to the issue
+    # @attr [Integer] merge_requests_count The number of merge requests attached to the issue4
+    # @attr [Integer] merge_request_to_resolve_discussions_of The IID of a merge request in which to resolve all issues
+    # @attr [Hash] milestone The milestone the issue is attached to
+    # @attr [Integer] milestone_id The ID ofthe milestone the issue is attached to
+    # @attr [Integer] moved_to_id The ID of the new issue the current issue was moved to
+    # @attr [Integer] project_id The ID of the project the issue is within
+    # @attr [String] remove_labels Comma-separated label names to remove from an issue
+    # @attr [Hash] references Reference tags for the issue
+    # @attr [String] severity
+    # @attr [String] state The current state of the issue
+    # @attr [String] state_event The state event of an issue; to close the issue, use close, and to reopen it, use reopen
+    # @attr [Hash] task_completion_status Informaiton on the task status of an issue
+    # @attr [String] task_status A string of the task status of an issue
+    # @attr [Hash] time_stats Information on the time spent on the issue
+    # @attr [String] title The issue title
+    # @attr [Integer] to_project_id The ID of the new project to move the issue to
+    # @attr [String] type The type of issue; either issue, incident, test_case, or task
+    # @attr [String] updated_at The timestamp of when the issue was last updated
+    # @attr [Integer] upvotes The number of upvotes on an issue
+    # @attr [Integer] user_notes_count The number of notes on the issue
+    # @attr [String] web_url The URL of the issue
+    # @attr [Integer] weight The weight of an issue
+    # @attr [Boolean] with_notes Clone the issue with notes
+    # @todo Promote an issue to an epic => https://docs.gitlab.com/api/issues/#promote-an-issue-to-an-epic
+    # @todo Clone an issue => https://docs.gitlab.com/api/issues/#clone-an-issue
+    # @todo Time tracking => https://docs.gitlab.com/api/issues/#time-tracking
+    # @todo List issue state events => https://docs.gitlab.com/api/issues/#list-issue-state-events
+    # @todo Incidents => https://docs.gitlab.com/api/issues/#incidents
+    # @todo Create a to-do item => https://docs.gitlab.com/api/issues/#create-a-to-do-item
+    # @todo List participants in an issue => https://docs.gitlab.com/api/issues/#list-participants-in-an-issue
+    class Issues < SupportOps::GitLab::Base
+      # @!parse
+      #   # Creates/updates an issue
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Issues}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#save!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/issues/#new-issue
+      #   #   GitLab API > Issues > New issue
+      #   # @see
+      #   #   https://docs.gitlab.com/api/issues/#edit-an-issue
+      #   #   GitLab API > Issues > Edit an issue
+      #   # @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_issue = SupportOps::GitLab::Issues.new
+      #   #   new_issue.project_id = 123456
+      #   #   new_issue.title = 'the printer is on fire (again)'
+      #   #   new_issue.description = 'We need to put it out and stop this from happening again'
+      #   #
+      #   #   new_issue.save!
+      #   #   pp new_issue.iid
+      #   #   #=> 13
+      #   #   pp new_issue.title
+      #   #   #=> "the printer is on fire (again)"
+      #   # @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
+      #   #
+      #   #   existing_issue = SupportOps::GitLab::Issues.get!(iid: 13, project_id: 123456)
+      #   #   existing_issue.title = 'The printer has completely burned down'
+      #   #   existing_issue.description = 'Guess we need a new printer now'
+      #   #
+      #   #   existing_issue.save!
+      #   #   pp existing_issue.iid
+      #   #   #=> 13
+      #   #   pp existing_issue.title
+      #   #   #=> "The printer has completely burned down"
+      #   def save!; end
+      # @!parse
+      #   # Deletes an issue
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Issues}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#delete!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/issues/#delete-an-issue
+      #   #   GitLab API > Issues > Delete an issue
+      #   # @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
+      #   #
+      #   #   existing_issue = SupportOps::GitLab::Issues.get!(iid: 13, project_id: 123456)
+      #   #   existing_issue.delete!
+      #   def delete!; end
+      # @!parse
+      #   # Moves an issue
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Issues}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#move!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/issues/#move-an-issue
+      #   #   GitLab API > Issues > Move an issue
+      #   # @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
+      #   #
+      #   #   existing_issue = SupportOps::GitLab::Issues.get!(iid: 13, project_id: 123456)
+      #   #   existing_issue.to_project_id = 789
+      #   #   existing_issue.move!
+      #   #   pp existing_issue.to_project_id
+      #   #   #=> 789
+      #   def move!; end
+      # @!parse
+      #   # Subscribe to an issue
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Issues}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#subscribe!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/issues/#subscribe-to-an-issue
+      #   #   GitLab API > Issues > Subscribe to an issue
+      #   # @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
+      #   #
+      #   #   existing_issue = SupportOps::GitLab::Issues.get!(iid: 13, project_id: 789)
+      #   #   existing_issue.subscribe!
+      #   def subscribe!; end
+      # @!parse
+      #   # Unsubscribe to an issue
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Issues}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#unsubscribe!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/issues/#unsubscribe-to-an-issue
+      #   #   GitLab API > Issues > Unsubscribe to an issue
+      #   # @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
+      #   #
+      #   #   existing_issue = SupportOps::GitLab::Issues.get!(iid: 13, project_id: 789)
+      #   #   existing_issue.unsubscribe!
+      #   def unsubscribe!; end
+      # @!parse
+      #   # List merge requests related to issue
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#merge_requests}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/issues/#list-merge-requests-related-to-issue
+      #   #   GitLab API Issues > List merge requests related to issue
+      #   # @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
+      #   #
+      #   #   existing_issue = SupportOps::GitLab::Issues.get!(iid: 13, project_id: 789)
+      #   #   merge_requests = existing_issue.merge_requests
+      #   #   pp merge_requests.count
+      #   #   # => 4
+      #   def merge_requests; end
+      # @!parse
+      #   # List notes on an issue
+      #   #
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#notes}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/notes/#list-all-issue-notes
+      #   #   GitLab API > Notes (comments) > List all issue notes
+      #   # @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
+      #   #
+      #   #   existing_issue = SupportOps::GitLab::Issues.get!(iid: 13, project_id: 789)
+      #   #   notes = existing_issue.notes
+      #   #   pp notes.count
+      #   #   # => 7
+      #   def notes; end
+      define_attributes :add_labels, :assignee_ids, :assignees, :author,
+                        :closed_at, :closed_by, :confidential, :created_at,
+                        :description, :discussion_locked,
+                        :discussion_to_aresolve, :downvotes, :due_date, :epic,
+                        :epic_id, :epic_iid, :has_tasks, :health_status, :id,
+                        :iid, :imported, :imported_from, :issue_type,
+                        :iteration, :labels, :_links, :merge_requests_count,
+                        :merge_request_to_resolve_discussions_of, :milestone,
+                        :milestone_id, :moved_to_id, :project_id,
+                        :remove_labels, :references, :severity, :state,
+                        :state_event, :task_completion_status, :task_status,
+                        :time_stats, :title, :to_project_id, :type, :updated_at,
+                        :upvotes, :user_notes_count, :web_url, :weight,
+                        :with_notes
+      readonly_attributes :author, :closed_at, :closed_by, :created_at,
+                          :downvotes, :epic, :has_tasks, :id, :iid, :imported,
+                          :imported_from, :iteration, :_links,
+                          :merge_requests_count, :milestone, :moved_to_id,
+                          :project_id, :references, :severity, :state,
+                          :task_completion_status, :task_status, :time_stats,
+                          :type, :updated_at, :upvotes, :user_notes_count,
+                          :web_url
+
+      ##
+      # Lists issues
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param assignee_id [Integer optional] Return issues assigned to the given user id; 'None' returns unassigned issues; 'Any' returns issues with an assignee.
+      #   @param assignee_username [String optional] Return issues assigned to the given username
+      #   @param author_id [Integer optional] Return issues created by the given user id
+      #   @param author_username [String optional] Return issues created by the given username
+      #   @param confidential [Boolean optional] Filter confidential or public issues
+      #   @param created_after [String optional] Return issues created on or after the given time; expected in ISO 8601 format (2019-03-15T08:00:00Z)
+      #   @param created_before [String optional] Return issues created on or before the given time; expected in ISO 8601 format (2019-03-15T08:00:00Z)
+      #   @param due_date [String optional] Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month; accepts: 0 (no due date), any, today, tomorrow, overdue, week, month, next_month_and_previous_two_weeks
+      #   @param epic_id [Integer optional] Return issues associated with the given epic ID; 'None' returns issues that are not associated with an epic; 'Any' returns issues that are associated with an epic
+      #   @param health_status [String optional] Return issues with the specified health_status; 'None' returns issues with no health status assigned, and 'Any' returns issues with a health status assigned
+      #   @param iids [Array optional] Return only the issues having the given iid
+      #   @param issue_type [String optional] Filter to a given type of issue; one of issue, incident, test_case or task
+      #   @param iteration_id [Integer optional] Return issues assigned to the given iteration ID; 'None' returns issues that do not belong to an iteration; 'Any' returns issues that belong to an iteration
+      #   @param iteration_title [String optional] Return issues assigned to the iteration with the given title
+      #   @param labels [String optional] Comma-separated list of label names, issues must have all labels to be returned; 'None' lists all issues with no labels; 'Any' lists all issues with at least one label
+      #   @param milestone [String optional] The milestone title; 'None' lists all issues with no milestone; 'Any' lists all issues that have an assigned milestone
+      #   @param milestone_id [String optional] Returns issues assigned to milestones with a given timebox value (None, Any, Upcoming, and Started); 'None' lists all issues with no milestone; 'Any' lists all issues that have an assigned milestone; 'Upcoming' lists all issues assigned to milestones due in the future; 'Started' lists all issues assigned to open, started milestones
+      #   @param my_reaction_emoji [String optional] Return issues reacted by the authenticated user by the given emoji; 'None returns issues not given a reaction; 'Any' returns issues given at least one reaction
+      #   @param non_archived [Boolean optional] Return issues only from non-archived projects
+      #   @param order_by [String optional] Return issues ordered by created_at, due_date, label_priority, milestone_due, popularity, priority, relative_position, title, updated_at, or weight fields.
+      #   @param project_id [Integer optional] The project to scope the list to (not providing it scopes it to the whole instance)
+      #   @param scope [String optional] Return issues for the given scope: created_by_me, assigned_to_me or all
+      #   @param search [String optional] Search issues against their title and description
+      #   @param sort [String optional] Return issues sorted in asc or desc order
+      #   @param state [String optional] Return all issues or just those that are opened or closed
+      #   @param updated_after [String optional] Return issues updated on or after the given time; expected in ISO 8601 format (2019-03-15T08:00:00Z)
+      #   @param updated_before [String optional] Return issues updated on or before the given time; expected in ISO 8601 format (2019-03-15T08:00:00Z)
+      #   @param weight [Integer optional] Return issues with the specified weight; 'None' returns issues with no weight assigned; 'Any' returns issues with a weight assigned
+      #   @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/issues/#list-issues
+      #   GitLab API > Issues > List issues
+      # @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
+      #
+      #   issues = SupportOps::GitLab::Issues.list(project_id: 123456)
+      #   pp issues.count
+      #   # => 30
+      #   pp issues.last.due_date
+      #   # => "2018-07-31"
+      def self.list(**args)
+        args[:assignee_id] = nil unless args[:assignee_id]
+        args[:assignee_username] = nil unless args[:assignee_username]
+        args[:author_id] = nil unless args[:author_id]
+        args[:author_username] = nil unless args[:author_username]
+        args[:confidential] = nil unless args[:confidential]
+        args[:created_after] = nil unless args[:created_after]
+        args[:created_before] = nil unless args[:created_before]
+        args[:due_date] = nil unless args[:due_date]
+        args[:epic_id] = nil unless args[:epic_id]
+        args[:health_status] = nil unless args[:health_status]
+        args[:iids] = nil unless args[:iids]
+        args[:issue_type] = nil unless args[:issue_type]
+        args[:iteration_id] = nil unless args[:iteration_id]
+        args[:iteration_title] = nil unless args[:iteration_title]
+        args[:labels] = nil unless args[:labels]
+        args[:milestone] = nil unless args[:milestone]
+        args[:milestone_id] = nil unless args[:milestone_id]
+        args[:my_reaction_emoji] = nil unless args[:my_reaction_emoji]
+        args[:non_archived] = nil unless args[:non_archived]
+        args[:order_by] = nil unless args[:order_by]
+        args[:project_id] = nil unless args[:project_id]
+        args[:scope] = nil unless args[:scope]
+        args[:search] = nil unless args[:search]
+        args[:sort] = nil unless args[:sort]
+        args[:state] = nil unless args[:state]
+        args[:updated_after] = nil unless args[:updated_after]
+        args[:updated_before] = nil unless args[:updated_before]
+        args[:weight] = nil unless args[:weight]
+        args[:limit] = 0 unless args[:limit]
+        params = ''
+        params += "assignee_id=#{args[:assignee_id]}&" unless args[:assignee_id].nil?
+        params += "assignee_username=#{args[:assignee_username]}&" unless args[:assignee_username].nil?
+        params += "author_id=#{args[:author_id]}&" unless args[:author_id].nil?
+        params += "author_username=#{args[:author_username]}&" unless args[:author_username].nil?
+        params += "confidential=#{args[:confidential]}&" unless args[:confidential].nil?
+        params += "created_after=#{args[:created_after]}&" unless args[:created_after].nil?
+        params += "created_before=#{args[:created_before]}&" unless args[:created_before].nil?
+        params += "due_date=#{args[:due_date]}&" unless args[:due_date].nil?
+        params += "epic_id=#{args[:epic_id]}&" unless args[:epic_id].nil?
+        params += "health_status=#{args[:health_status]}&" unless args[:health_status].nil?
+        params += "iids=#{args[:iids]}&" unless args[:iids].nil?
+        params += "issue_type=#{args[:issue_type]}&" unless args[:issue_type].nil?
+        params += "iteration_id=#{args[:iteration_id]}&" unless args[:iteration_id].nil?
+        params += "iteration_title=#{args[:iteration_title]}&" unless args[:iteration_title].nil?
+        params += "labels=#{args[:labels]}&" unless args[:labels].nil?
+        params += "milestone=#{args[:milestone]}&" unless args[:milestone].nil?
+        params += "milestone_id=#{args[:milestone_id]}&" unless args[:milestone_id].nil?
+        params += "my_reaction_emoji=#{args[:my_reaction_emoji]}&" unless args[:my_reaction_emoji].nil?
+        params += "non_archived=#{args[:non_archived]}&" unless args[:non_archived].nil?
+        params += "order_by=#{args[:order_by]}&" unless args[:order_by].nil?
+        params += "scope=#{args[:scope]}&" unless args[:scope].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?
+        params += "updated_after=#{args[:updated_after]}&" unless args[:updated_after].nil?
+        params += "updated_before=#{args[:updated_before]}&" unless args[:updated_before].nil?
+        params += "weight=#{args[:weight]}&" unless args[:weight].nil?
+        array = []
+        page = 1
+        base_url = if args[:project_id].nil?
+                     "issues"
+                   else
+                    "projects/#{args[:project_id]}/issues"
+                   end
+        loop do
+          response = client.connection.get("#{base_url}?#{params}&page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map { |i| Issues.new(i) }
+          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
+
+      ##
+      # Locates a specific issue in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/issues/#single-issue
+      #   GitLab API > Issues > Single issue
+      # @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
+      #
+      #   issue = SupportOps::GitLab::Issues.get(987654)
+      #   pp issue.title
+      #   # => "Awesome issue"
+      #   pp issue.id
+      #   # => 28
+      #   pp issue.project_id
+      #   # => 123456
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   issue = SupportOps::GitLab::Issues.get(iid: 28, project_id: 123456)
+      #   pp issue.title
+      #   # => "Awesome issue"
+      #   pp issue.id
+      #   # => 987654
+      def self.get(object)
+        if object.is_a? Issues
+          Issues.new(id: id).find
+        elsif object.is_a? Hash
+          Issues.new({ id: object[:id], iid: object[:iid], project_id: object[:project_id] }).find
+        else
+          Issues.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific issue in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/issues/#single-issue
+      #   GitLab API > Issues > Single issue
+      # @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
+      #
+      #   issue = SupportOps::GitLab::Issues.get!(987654)
+      #   pp issue.title
+      #   # => "Awesome issue"
+      #   pp issue.id
+      #   # => 28
+      #   pp issue.project_id
+      #   # => 123456
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   issue = SupportOps::GitLab::Issues.get!(iid: 28, project_id: 123456)
+      #   pp issue.title
+      #   # => "Awesome issue"
+      #   pp issue.id
+      #   # => 987654
+      def self.get!(object)
+        if object.is_a? Issues
+          Issues.new(id: id).find!
+        elsif object.is_a? Hash
+          Issues.new({ id: object[:id], iid: object[:iid], project_id: object[:project_id] }).find!
+        else
+          Issues.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        raise "Cannot locate issue based off provided info" if self.id.nil? && (self.iid.nil? || self.project_id.nil?)
+        base_url = if self.id.nil?
+                     "projects/#{self.project_id}/issues/#{self.iid}"
+                   else
+                    "issues/#{self.id}"
+                   end
+        response = self.client.connection.get(base_url)
+        return nil if response.status != 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # @private
+      def create_record
+        raise 'Cannot create a issue without a project_id attribute' if self.project_id.nil?
+        data = attributes_for_save
+        data[:confidential] = false if data[:confidential].nil?
+        data.delete(:epic_id) if data[:epic_id].nil?
+        data.delete(:epic_iid) if data[:epic_iid].nil?
+        response = self.client.connection.post("projects/#{self.project_id}/issues", data.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create issue => #{body}" if response.status != 201
+        body
+      end
+
+      ##
+      # @private
+      def update_record
+        raise 'Cannot update a issue without a project_id attribute' if self.project_id.nil?
+        raise "Failed to update issue => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        response = self.client.connection.put("projects/#{self.project_id}/issues/#{self.iid}", attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update issue #{self.id} => #{body}" if response.status != 200
+        body
+      end
+
+      ##
+      # @private
+      def delete_record
+        raise 'Cannot delete a issue without a project_id attribute' if self.project_id.nil?
+        response = self.client.connection.delete("projects/#{self.project_id}/issues/#{self.iid}")
+        body = Oj.load(response.body)
+        raise "Failed to delete issue #{self.id} => #{body}" unless response.status == 204
+        true
+      end
+
+      ##
+      # @private
+      def move_record
+        raise 'You have to provide a to_project_id' if self.to_project_id.nil?
+        data = { to_project_id: self.to_project_id }.to_json
+        response = self.client.connection.post("projects/#{self.project_id}/issues/#{self.iid}/move", data)
+        body = Oj.load(response.body)
+        raise "Failed to move issue #{self.id} to #{self.to_project_id}=> #{body}" unless response.status == 201
+        body.each do |key, value|
+          self.instance_variable_set("@#{key}", value) if self.respond_to?("#{key}=")
+        end
+        body
+      end
+
+      ##
+      # @private
+      def subscribe_record
+        response = self.client.connection.post("projects/#{self.project_id}/issues/#{self.iid}/subscribe")
+        raise "Unable to subscribe to issue #{self.id} => #{body}" unless [201, 304].include? response.status
+        true
+      end
+
+      ##
+      # @private
+      def unsubscribe_record
+        response = self.client.connection.post("projects/#{self.project_id}/issues/#{self.iid}/unsubscribe")
+        raise "Unable to unsubscribe to issue #{self.id} => #{body}" unless [201, 304].include? response.status
+        true
+      end
+
+      ##
+      # @private
+      def merge_requests_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("projects/#{self.project_id}/issues/#{self.iid}/related_merge_requests?per_page=100&page=#{page}")
+          body = Oj.load(response.body)
+          array += body.map { |m| MergeRequests.new(m) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # @private
+      def notes_record
+        Notes.list(type: 'Issue', type_id: self.iid, project_id: self.project_id)
+      end
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/jobs.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Jobs within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Boolean] allow_failure
+    # @attr [Boolean] archived
+    # @attr [Array] artifacts
+    # @attr [String] artifacts_expire_at
+    # @attr [Hash] artifacts_file
+    # @attr [Hash] commit
+    # @attr [String] coverage
+    # @attr [String] created_at
+    # @attr [String] duration
+    # @attr [String] erased_at
+    # @attr [String] failure_reason
+    # @attr [String] finished_at
+    # @attr [Integer] id
+    # @attr [String] name
+    # @attr [Hash] pipeline
+    # @attr [Hash] project
+    # @attr [String] queued_duration
+    # @attr [String] ref
+    # @attr [Hash] runner
+    # @attr [Hash] runner_manager
+    # @attr [String] source
+    # @attr [String] stage
+    # @attr [String] started_at
+    # @attr [String] status
+    # @attr [String] tag
+    # @attr [Array] tag_list
+    # @attr [Hash] user
+    # @attr [String] web_url
+    # @todo Document meaning of attributes
+    # @todo All items listed at https://docs.gitlab.com/api/jobs/#list-project-jobs
+    class Jobs < SupportOps::GitLab::Base
+      define_attributes :allow_failure, :archived, :artifacts,
+                        :artifacts_expire_at, :artifacts_file, :commit,
+                        :coverage, :created_at, :duration, :erased_at,
+                        :failure_reason, :finished_at, :id, :name, :pipeline,
+                        :project, :queued_duration, :ref, :runner,
+                        :runner_manager, :source, :stage, :started_at, :status,
+                        :tag, :tag_list, :user, :web_url
+      readonly_attributes :allow_failure, :archived, :artifacts,
+                          :artifacts_expire_at, :artifacts_file, :commit,
+                          :coverage, :created_at, :duration, :erased_at,
+                          :failure_reason, :finished_at, :id, :name, :pipeline,
+                          :project, :queued_duration, :ref, :runner,
+                          :runner_manager, :source, :stage, :started_at,
+                          :status, :tag, :tag_list, :user, :web_url
+
+      private
+    end
+  end
+end