gitlab-customer-support-operations_gitlab 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58b7dc8a1f70df08c86c005e99bf1c927ddda146d3b00ca25e31d56b87818144
+  data.tar.gz: ad3e1f77cc3593abb33bfcab7d84a97d398ca870d70b67a6279b819567336848
+SHA512:
+  metadata.gz: 5ebfb432d9f3e5a397ed0de90353490a426ac70abed7525bb4440ded553041cd5be57315b4330fb864a4d403d4ab2a8237934b2a908b5bffe46edb8c6bf78201
+  data.tar.gz: 7fc196553f5906cbb3b9971cc1f396f915733c9b7eecd921de76b71641dc4fc748bb7d51718effd026c4ff749837f86241389b2b04c471de5cb24c9878b6f1e7

data/lib/support_ops_gitlab/gitlab/badges.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Badges within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] group_id The ID of the group the badge is in
+    # @attr [Integer] id The ID of the badge
+    # @attr [String] image_url URL of the badge image
+    # @attr [String] kind The type of badge it is (project or group)
+    # @attr [String] link_url URL of the badge link
+    # @attr [String] name Name of the badge
+    # @attr [Integer] project_id The ID of the project the badge is in
+    # @attr [String] rendered_image_url The URL of the rendered badge image
+    # @attr [String] rendered_link_url The URL of the rendered badge link
+    # @todo Get a badge of a project > https://docs.gitlab.com/api/project_badges/#get-a-badge-of-a-project
+    # @todo Get a badge of a group > https://docs.gitlab.com/api/group_badges/#get-a-badge-of-a-group
+    # @todo Preview a badge from a project > https://docs.gitlab.com/api/project_badges/#preview-a-badge-from-a-project
+    # @todo Preview a badge from a group > https://docs.gitlab.com/api/group_badges/#preview-a-badge-from-a-group
+    class Badges < SupportOps::GitLab::Base
+      # @!parse
+      #   # Creates/updates a badge
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::GitLab::Badges}
+      #   # @note This is inherited from {SupportOps::GitLab::Base#save!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/project_badges/#add-a-badge-to-a-project
+      #   #   GitLab API > Projects > Badge > Add a badge to a project
+      #   # @see
+      #   #   https://docs.gitlab.com/api/group_badges/#add-a-badge-to-a-group
+      #   #   GitLab API > Groups > Badge > Add a badge to a group
+      #   # @see
+      #   #   https://docs.gitlab.com/api/project_badges/#edit-a-badge-to-a-project
+      #   #   GitLab API > Projects > Badge > Edit a badge to a project
+      #   # @see
+      #   #   https://docs.gitlab.com/api/group_badges/#edit-a-badge-to-a-group
+      #   #   GitLab API > Groups > Badge > Edit a badge to a group
+      #   # @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_badge = SupportOps::GitLab::Badges.new
+      #   #   new_badge.name = 'Awesome Badge'
+      #   #   new_badge.link_url = 'https://google.com'
+      #   #   new_badge.image_url = 'https://img.shields.io/badge/Awesome-Badge-purple'
+      #   #   new_badge.group_id = 1
+      #   #
+      #   #   new_badge.save!
+      #   #
+      #   #   pp new_badge.id
+      #   #   # => 33
+      #   # @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
+      #   #
+      #   #   badges = SupportOps::GitLab::Badges.list(project_id: 123)
+      #   #   badge = badges.last
+      #   #   badge.link_url = 'https://duckduckgo.com/'
+      #   #
+      #   #   badge.save!
+      #   #
+      #   #   pp badge.rendered_link_url
+      #   #   # => "https://duckduckgo.com/"
+      #   def save!; end
+      # @!parse
+      #   # Deletes a badge
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::GitLab::Base#delete!}
+      #   # @see
+      #   #   https://docs.gitlab.com/api/project_badges/#remove-a-badge-from-a-project
+      #   #   GitLab API > Projects > Badges > Remove a badge from a project
+      #   # @see
+      #   #   https://docs.gitlab.com/api/group_badges/#remove-a-badge-from-a-group
+      #   #   GitLab API > Groups > Badges > Remove a badge from a group
+      #   # @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
+      #   #
+      #   #   badges = SupportOps::GitLab::Badges.list(project_id: 123)
+      #   #   badge = badges.last
+      #   #   badge.delete!
+      #   def delete!; end
+      define_attributes :group_id, :id, :image_url, :kind, :link_url, :name,
+                        :project_id, :rendered_image_url, :rendered_link_url
+      readonly_attributes :id, :group_id, :project_id, :rendered_image_url,
+                          :rendered_link_url
+
+      ##
+      # List all badges
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # overload list(key: value)
+      #   @param group_id [Integer semi-optional] The ID of the group to get
+      #     badges from
+      #   @param name [String optional] Name of the badges to return
+      #     (case-sensitive)
+      #   @param project_id [Integer semi-optional] The ID of the project to get
+      #     badges from
+      # @return [Array]
+      # #see
+      #   https://docs.gitlab.com/api/group_badges/#list-all-badges-of-a-group
+      #   GitLab API > Groups > Badges > List all badges of a group
+      # #see
+      #   https://docs.gitlab.com/api/project_badges/#list-all-badges-of-a-project
+      #   GitLab API > Project > Badges > List all badges of a project
+      # @example
+      #   require 'support_ops_gitlab'
+      #
+      #   SupportOps::GitLab::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.example.com/api/v4'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   tokens = SupportOps::GitLab::ProjectAccessTokens.list(project_id: 5, limit: 10)
+      #   pp tokens.count
+      #   # => 10
+      #   pp tokens.last.revoked
+      #   # => false
+      def self.list(**args)
+        args[:group_id] = nil unless args[:group_id]
+        args[:project_id] = nil unless args[:project_id]
+        args[:name] = nil unless args[:name]
+        params = ''
+        params += "name=#{args[:name]}&" unless args[:name].nil?
+        url = if args[:group_id].nil? && !args[:project_id].nil?
+                "projects/#{args[:project_id]}/badges"
+              elsif !args[:group_id].nil? && args[:project_id].nil?
+                "groups/#{args[:group_id]}/badges"
+              else
+                raise 'You have to provide a group_id or a project_id (and you cannot provide both)'
+              end
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("#{url}?#{params}&page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map do |b|
+            if args[:group_id].nil? && !args[:project_id].nil?
+              b['project_id'] = args[:project_id]
+            elsif !args[:group_id].nil? && args[:project_id].nil?
+              b['group_id'] = args[:group_id]
+            else
+              raise 'You have to provide a group_id or a project_id (and you cannot provide both)'
+            end
+            Badges.new(b)
+          end
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      private
+
+      ##
+      # @private
+      def create_record
+        url = if self.group_id.nil? && !self.project_id.nil?
+          "projects/#{self.project_id}/badges"
+        elsif self.group_id.nil? && self.project_id.nil?
+          "groups/#{self.group_id}/badges"
+        else
+          raise 'You have to provide a group_id or a project_id (and you cannot provide both)'
+        end
+        response = self.client.connection.post(url, attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create badge => #{body}" if response.status != 201
+        body
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "Failed to update badge => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        url = if self.group_id.nil? && !self.project_id.nil?
+          "projects/#{self.project_id}/badges/#{self.id}"
+        elsif self.group_id.nil? && self.project_id.nil?
+          "groups/#{self.group_id}/badges/#{self.id}"
+        else
+          raise 'You have to provide a group_id or a project_id (and you cannot provide both)'
+        end
+        response = self.client.connection.put(url, attributes_for_save.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update badge #{self.id} => #{body}" if response.status != 200
+        body
+      end
+
+      ##
+      # @private
+      def delete_record
+        url = if self.group_id.nil? && !self.project_id.nil?
+          "projects/#{self.project_id}/badges/#{self.id}"
+        elsif self.group_id.nil? && self.project_id.nil?
+          "groups/#{self.group_id}/badges/#{self.id}"
+        else
+          raise 'You have to provide a group_id or a project_id (and you cannot provide both)'
+        end
+        response = self.client.connection.delete(url)
+        body = Oj.load(response.body)
+        raise "Failed to delete badge #{self.id} => #{body}" unless response.status == 204
+        true
+      end
+    end
+  end
+end