gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/namespaces.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Namespaces within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] avatar_url The URL to the avatar of a namespace
+    # @attr [Integer] billable_members_count The billable user count of a namespace
+    # @attr [String] end_date
+    # @attr [String] full_path The full path of the namespace
+    # @attr [Integer] id The ID of the namespace
+    # @attr [String] kind The type of namespace, can be group or user
+    # @attr [Integer] max_seats_used The historical max seats used over the last year
+    # @attr [Integer] members_count_with_descendants The count of members include descendents for the namespace
+    # @attr [String] name The name of the namespace
+    # @attr [Integer] parent_id The parent group ID for creating nested namespace
+    # @attr [String] path The path of the namespace
+    # @attr [String] plan The subscription plan currently in use for the namespace
+    # @attr [Integer] projects_count Number of projects in the namespace
+    # @attr [Integer] root_repository_size
+    # @attr [Integer] seats_in_use The billable seats in use
+    # @attr [Boolean] trial If the namespace is using a trial
+    # @attr [String] trial_ends_on Timestamp the trial ends on
+    # @attr [String] web_url The URL of the namespace
+    # @todo List all namespaces => https://docs.gitlab.com/api/namespaces/#list-all-namespaces
+    class Namespaces < SupportOps::GitLab::Base
+      # @!parse
+      #   # Determines if a namespace is on a paid subscription currently
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Namespaces}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#paid?}
+      #   # @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
+      #   #
+      #   #   namespace = SupportOps::GitLab::Namespaces.get!('test')
+      #   #   pp namespace.paid?
+      #   #   # => false
+      define_attributes :avatar_url, :billable_members_count, :end_date,
+                        :full_path, :id, :kind, :max_seats_used,
+                        :members_count_with_descendants, :name, :parent_id,
+                        :path, :plan, :projects_count, :root_repository_size,
+                        :seats_in_use, :trial, :trial_ends_on, :web_url
+      readonly_attributes :avatar_url, :billable_members_count, :end_date,
+                          :full_path, :id, :kind, :max_seats_used,
+                          :members_count_with_descendants, :name, :parent_id,
+                          :path, :plan, :projects_count, :root_repository_size,
+                          :seats_in_use, :trial, :trial_ends_on, :web_url
+
+      ##
+      # Locates a specific namespace in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/namespaces/#get-details-on-a-namespace
+      #   GitLab API > Namespaces > Get details on a namespace
+      # @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
+      #
+      #   namespace = SupportOps::GitLab::Namespaces.get(123456)
+      #   pp namespace.plan
+      #   # => "ultimate"
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   namespace = SupportOps::GitLab::Namespaces.get('jcolyer-is-awesome')
+      #   pp namespace.plan
+      #   # => "ultimate"
+      def self.get(object)
+        if object.is_a? Namespaces
+          Namespaces.new(id: id).find
+        else
+          Namespaces.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific namespace in the GitLab system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/namespaces/#get-details-on-a-namespace
+      #   GitLab API > Namespaces > Get details on a namespace
+      # @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
+      #
+      #   namespace = SupportOps::GitLab::Namespaces.get(123456)
+      #   pp namespace.plan
+      #   # => "ultimate"
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   namespace = SupportOps::GitLab::Namespaces.get('jcolyer-is-awesome')
+      #   pp namespace.plan
+      #   # => "ultimate"
+      def self.get!(object)
+        if object.is_a? Namespaces
+          Namespaces.new(id: id).find!
+        else
+          Namespaces.new(id: object).find!
+        end
+      end
+
+      ##
+      # Verifies if a specified namespace already exists
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/namespaces/#verify-namespace-availability
+      #   GitLab API > Namespaces > Verify namespace availability
+      # @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
+      #
+      #   pp SupportOps::GitLab::Namespaces.exists?('test')
+      #   # => true
+      #   pp SupportOps::GitLab::Namespaces.exists?('testaaaaaaaaaaaa')
+      #   # => false
+      def self.exists?(path)
+        response = client.connection.get("namespaces/#{ERB::Util.url_encode(path)}/exists")
+        body = Oj.load(response.body)
+        body['exists']
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("namespaces/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # @private
+      def is_paid_record
+        %w[bronze silver gold premium ultimate].include? self.plan
+      end
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/notes.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Notes within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Hash] author Information about the author of a note
+    # @attr [String] body The content of a note
+    # @attr [Boolean] confidential If the note is confidential or not
+    # @attr [String] created_at The timestamp of when the note was created
+    # @attr [Integer] id The ID of the note
+    # @attr [Boolean] imported If the note was imported or not
+    # @attr [String] imported_from Where the note was imported from
+    # @attr [Boolean] internal If the note is internal or not
+    # @attr [String] merge_request_diff_head_sha The SHA of the head commit, which ensures the merge request wasn’t updated after the API request was sent
+    # @attr [Integer] noteable_id The ID of the item the note is attached to
+    # @attr [Integer] noteable_iid The IID of the item the note is attached to
+    # @attr [String] noteable_type The type of item the note is attached to
+    # @attr [Integer] project_id The project ID the note is within
+    # @attr [Boolean] resolvable If the note is resolvable or not
+    # @attr [Boolean] system If the note is from the system or not
+    # @attr [String] updated_at The timestamp of when the note was last updated
+    # @todo Get single issue note => https://docs.gitlab.com/api/notes/#get-single-issue-note
+    # @todo Get single snippet note => https://docs.gitlab.com/api/notes/#get-single-snippet-note
+    # @todo Get single merge request note => https://docs.gitlab.com/api/notes/#get-single-merge-request-note
+    # @todo Get single epic note => https://docs.gitlab.com/api/notes/#get-single-epic-note
+    # @todo Get single wiki page note (projects) => https://docs.gitlab.com/api/notes/#get-single-wiki-page-note
+    # @todo Get single wiki page note (groups) => https://docs.gitlab.com/api/notes/#get-single-wiki-page-note-1
+    # @todo Create/update for notes other than Issue and MergeRequest
+    # @todo Document save!
+    # @todo Document delete!
+    class Notes < SupportOps::GitLab::Base
+      define_attributes :author, :body, :confidential, :created_at, :id,
+                        :imported, :imported_from, :internal,
+                        :merge_request_diff_head_sha, :noteable_id,
+                        :noteable_iid, :noteable_type, :project_id, :resolvable,
+                        :system, :updated_at
+      readonly_attributes :author, :created_at, :id, :imported, :imported_from,
+                          :noteable_id, :noteable_iid, :project_id, :resolvable,
+                          :system, :updated_at
+
+      ##
+      def self.base_url(type, type_id, project_id = nil, group_id = nil)
+        return "projects/#{project_id}/issues/#{type_id}/notes" if type == 'Issue'
+        return "projects/#{project_id}/snippets/#{type_id}/notes" if type == 'Snippet'
+        return "projects/#{project_id}/merge_requests/#{type_id}/notes" if type == 'MergeRequest'
+        return "groups/#{group_id}/epics/#{type_id}/notes" if type == 'Epic'
+        return "groups/#{group_id}/epics/#{type_id}/notes" if type == 'Epic'
+        if type == 'WikiPage::Meta'
+          return "projects/#{project_id}/wiki_pages/#{type_id}/notes" if group_id.nil?
+          return "groups/#{project_id}/wiki_pages/#{type_id}/notes" if project_id.nil?
+        end
+        raise "Unable to determine based on type of '#{type}'"
+      end
+
+      ##
+      # Lists notes (comments)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param type [String required] The place to look for the notes, can be
+      #     one of the following: Issue, Snippet, MergeRequest, Epic,
+      #     WikiPage::Meta
+      #   @param group_id [Integer semi-optional] The group ID to look within;
+      #     required when type is Epic, WikiPage::Meta (for project wikis)
+      #   @param project_id [Integer semi-optional] The project ID to look
+      #     within; required when type is Issue, Snippet, MergeRequest,
+      #     WikiPage::Meta (for project wikis)
+      #   @param type_id [Integer required] The ID of the type to look within
+      #   @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/notes/#list-project-issue-notes
+      #   GitLab API > Notes (Comments) > List project issue notes
+      #   https://docs.gitlab.com/api/notes/#list-all-snippet-notes
+      #   GitLab API > Notes (Comments) > List all snippet notes
+      #   https://docs.gitlab.com/api/notes/#list-all-merge-request-notes
+      #   GitLab API > Notes (Comments) > List all merge request notes
+      #   https://docs.gitlab.com/api/notes/#list-all-epic-notes
+      #   GitLab API > Notes (Comments) > List all epic notes
+      #   https://docs.gitlab.com/api/notes/#list-all-project-wiki-notes
+      #   GitLab API > Notes (Comments) > List all project wiki notes
+      #   https://docs.gitlab.com/api/notes/#list-all-group-wiki-notes
+      #   GitLab API > Notes (Comments) > List all group wiki notes
+      # @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
+      #
+      #   xxx = SupportOps::GitLab::Notes.list(xxx)
+      #   pp xxx.count
+      #   # => 30
+      #   pp xxx.last.author['id']
+      #   # => 123
+      def self.list(**args)
+        args[:type] = nil unless args[:type_id]
+        args[:group_id] = nil unless args[:type_id]
+        args[:project_id] = nil unless args[:type_id]
+        args[:type_id] = nil unless args[:type_id]
+        args[:limit] = 0 unless args[:limit]
+        raise 'You must provide a type' if args[:type].nil?
+        raise 'You must provide a type_id' if args[:type_id].nil?
+        raise 'You must provide a project_id' if ['Issue', 'Snippet', 'MergeRequest', 'WikiPage::Meta'].include?(args[:type]) && args[:project_id].nil?
+        raise 'You must provide a group_id' if ['Epic', 'WikiPage::Meta'].include?(args[:type]) && args[:group_id].nil?
+        url = base_url(args[:type], args[:type_id], args[:project_id], args[:group_id])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("#{url}?page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map { |n| Notes.new(n) }
+          break if args[:limit].to_i.positive? && array.count >= args[:limit].to_i
+          break if body.count < 100
+        end
+        return array if args[:limit].to_i.zero?
+        
+        array.first(args[:limit].to_i)
+      end
+
+      private
+
+      ##
+      # @private
+      def create_record
+        raise "This has not been implemented yet for #{self.noteable_type}s" unless %w[Issue MergeRequest].include? self.noteable_type
+        data = {
+          body: self.body
+        }
+        if self.noteable_type == 'Issue'
+          data[:confidential] = self.confidential
+          data[:internal] = self.internal
+          url = base_url(self.noteable_type, self.noteable_iid, self.project_id)
+        elsif self.noteable_type == 'MergeRequest'
+          data[:internal] = self.internal
+          data[:merge_request_diff_head_sha] = self.merge_request_diff_head_sha
+          url = base_url(self.noteable_type, self.noteable_iid, self.project_id)
+        end
+        response = self.client.connection.post(url, data.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create note => #{body}" if response.status != 201
+        body
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "This has not been implemented yet for #{self.noteable_type}s" unless %w[Issue MergeRequest].include? self.noteable_type
+        data = {
+          body: self.body,
+          confidential: self.confidential
+        }
+        url = base_url(self.noteable_type, self.noteable_iid, self.project_id)
+        response = self.client.connection.put(url, data.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update note => #{body}" if response.status != 200
+        body
+      end
+
+      ##
+      # @private
+      def delete_record
+        raise "This has not been implemented yet for #{self.noteable_type}s" unless %w[Issue MergeRequest].include? self.noteable_type
+        url = base_url(self.noteable_type, self.noteable_iid, self.project_id)
+        response = self.client.connection.delete(url)
+        body = Oj.load(response.body)
+        raise "Failed to delete note #{self.id} => #{body}" unless response.status == 204
+        true
+      end
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/pipelines.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Pipelines within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at XXX
+    # @attr [Integer] id The ID of the pipeline
+    # @attr [Integer] iid The integrated ID of the pipeline
+    # @attr [Hash] inputs A hash containing the inputs, as key-value pairs, to use when creating the pipeline
+    # @attr [String] name The name of the pipeline
+    # @attr [Integer] project_id The project the pipeline is on
+    # @attr [String] ref The branch or tag to run the pipeline on
+    # @attr [String] sha The SHA of the pipeline
+    # @attr [String] source The source of the pipeline
+    # @attr [String] status The status of the pipeline
+    # @attr [String] updated_at The timestamp of when the pipeline was last updated
+    # @attr [String] web_url The URL the pipeline is at
+    # @attr [Array] variables An array of hashes containing the variables available in the pipeline
+    # @todo Document pipeline_variables
+    # @todo Get a test report for a pipeline => https://docs.gitlab.com/api/pipelines/#get-a-test-report-for-a-pipeline
+    # @todo Get a test report summary for a pipeline => https://docs.gitlab.com/api/pipelines/#get-a-test-report-summary-for-a-pipeline
+    # @todo Create a new pipeline => https://docs.gitlab.com/api/pipelines/#create-a-new-pipeline
+    # @todo Retry jobs in a pipeline => https://docs.gitlab.com/api/pipelines/#retry-jobs-in-a-pipeline
+    # @todo Cancel all jobs for a pipeline => https://docs.gitlab.com/api/pipelines/#cancel-all-jobs-for-a-pipeline
+    # @todo Delete a pipeline => https://docs.gitlab.com/api/pipelines/#delete-a-pipeline
+    # @todo Update pipeline metadata => https://docs.gitlab.com/api/pipelines/#update-pipeline-metadata
+    # @todo Document latest jobs
+    class Pipelines < SupportOps::GitLab::Base
+      define_attributes :created_at, :id, :iid, :inputs, :name, :project_id,
+                        :ref, :sha, :source, :status, :updated_at, :web_url,
+                        :variables
+      readonly_attributes :created_at, :id, :iid, :project_id, :sha, :source,
+                          :status, :updated_at, :web_url
+
+      ##
+      # Lists project pipelines
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param project_id [Integer required] The project ID to get the
+      #     pipelines from
+      #   @param created_after [String optional] Return pipelines created after
+      #     the specified date; expected in ISO 8601 format
+      #     (2019-03-15T08:00:00Z)
+      #   @param created_before [String optional] Return pipelines created
+      #     before the specified date; expected in ISO 8601 format
+      #     (2019-03-15T08:00:00Z)
+      #   @param name [String optional] Return pipelines with the specified name
+      #   @param order_by [String optional] Order pipelines by id, status, ref,
+      #     updated_at or user_id
+      #   @param ref [String optional] The ref of pipelines
+      #   @param scope [String optional] The scope of pipelines, one of:
+      #     running, pending, finished, branches, tags
+      #   @param sha [String optional] The SHA of pipelines
+      #   @param sort [String optional] Sort pipelines in asc or desc order
+      #   @param source [String optional] The pipeline source
+      #   @param status [String optional] The status of pipelines, one of:
+      #     created, waiting_for_resource, preparing, pending, running, success,
+      #     failed, canceled, skipped, manual, scheduled
+      #   @param updated_after [String optional] Return pipelines updated after
+      #     the specified date; expected in ISO 8601 format
+      #     (2019-03-15T08:00:00Z)
+      #   @param updated_before [String optional] Return pipelines updated
+      #     before the specified date
+      #   @param username [String optional] The username of the user who
+      #     triggered pipelines
+      #   @param yaml_errors [Boolean optional] Returns pipelines with invalid
+      #     configurations
+      #   @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/pipelines/#list-project-pipelines
+      #   GitLab API > Pipelines > List project pipelines
+      # @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
+      #
+      #   pipelines = SupportOps::GitLab::Pipelines.list(project_id: 123456)
+      #   pp pipelines.count
+      #   # => 30
+      #   pp pipelines.last.status
+      #   # => "pending"
+      def self.list(**args)
+        args[:project_id] = nil unless args[:project_id]
+        raise 'You have to provide a project_id' if args[:project_id].nil?
+        args[:created_after] = nil unless args[:created_after]
+        args[:created_before] = nil unless args[:created_before]
+        args[:name] = nil unless args[:name]
+        args[:order_by] = nil unless args[:order_by]
+        args[:ref] = nil unless args[:ref]
+        args[:scope] = nil unless args[:scope]
+        args[:sha] = nil unless args[:sha]
+        args[:sort] = nil unless args[:sort]
+        args[:source] = nil unless args[:source]
+        args[:status] = nil unless args[:status]
+        args[:updated_after] = nil unless args[:updated_after]
+        args[:updated_before] = nil unless args[:updated_before]
+        args[:username] = nil unless args[:username]
+        args[:yaml_errors] = nil unless args[:yaml_errors]
+        args[:limit] = 0 unless args[:limit]
+        params = ''
+        params += "created_after=#{args[:created_after]}&" unless args[:created_after].nil?
+        params += "created_before=#{args[:created_before]}&" unless args[:created_before].nil?
+        params += "name=#{args[:name]}&" unless args[:name].nil?
+        params += "order_by=#{args[:order_by]}&" unless args[:order_by].nil?
+        params += "ref=#{args[:ref]}&" unless args[:ref].nil?
+        params += "scope=#{args[:scope]}&" unless args[:scope].nil?
+        params += "sha=#{args[:sha]}&" unless args[:sha].nil?
+        params += "sort=#{args[:sort]}&" unless args[:sort].nil?
+        params += "source=#{args[:source]}&" unless args[:source].nil?
+        params += "status=#{args[:status]}&" unless args[:status].nil?
+        params += "updated_after=#{args[:updated_after]}&" unless args[:updated_after].nil?
+        params += "updated_before=#{args[:updated_before]}&" unless args[:updated_before].nil?
+        params += "username=#{args[:username]}&" unless args[:username].nil?
+        params += "yaml_errors=#{args[:yaml_errors]}&" unless args[:yaml_errors].nil?
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("projects/#{args[:project_id]}/pipelines?#{params}&page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map { |p| Pipelines.new(p) }
+          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 pipeline in a project
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/pipelines/#get-a-single-pipeline
+      #   GitLab API > Pipelines > Get a single pipeline
+      # @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
+      #
+      #   pipeline = SupportOps::GitLab::Pipelines.get(id: 987654, project_id: 123)
+      #   pp pipeline.name
+      #   # => "Awesome pipeline"
+      #   pp pipeline.id
+      #   # => 987654
+      #   pp pipeline.project_id
+      #   # => 123
+      def self.get(object)
+        if object.is_a? Pipelines
+          Pipelines.new(id: id, project_id: project_id).find
+        elsif object.is_a? Hash
+          Pipelines.new({ id: object[:id], project_id: object[:project_id] }).find
+        else
+          raise 'You need an id and a project_id attribute'
+        end
+      end
+
+      ##
+      # Locates a specific pipeline in a project
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://docs.gitlab.com/api/pipelines/#get-a-single-pipeline
+      #   GitLab API > Pipelines > Get a single pipeline
+      # @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
+      #
+      #   pipeline = SupportOps::GitLab::Pipelines.get!(id: 987654, project_id: 123)
+      #   pp pipeline.name
+      #   # => "Awesome pipeline"
+      #   pp pipeline.id
+      #   # => 987654
+      #   pp pipeline.project_id
+      #   # => 123
+      def self.get!(object)
+        if object.is_a? Pipelines
+          Pipelines.new(id: id, project_id: project_id).find!
+        elsif object.is_a? Hash
+          Pipelines.new({ id: object[:id], project_id: object[:project_id] }).find!
+        else
+          raise 'You need an id and a project_id attribute'
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        raise "Cannot locate pipeline based off provided info" if self.id.nil? || self.project_id.nil?
+        response = self.client.connection.get("projects/#{self.project_id}/pipelines/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # @private
+      def pipeline_variables_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("projects/#{self.project_id}/pipelines/#{self.id}/variables?per_page=100&page=#{page}")
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # @private
+      def jobs_record
+        array = []
+        page = 1
+        loop do
+          response = self.client.connection.get("projects/#{self.project_id}/pipelines/#{self.id}/jobs?per_page=100&page=#{page}")
+          body = Oj.load(response.body)
+          array += body.map { |j| Jobs.new(j) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+    end
+  end
+end