gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/events.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Events within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] action_name
+    # @attr [Hash] author
+    # @attr [Integer] author_id
+    # @attr [String] author_username
+    # @attr [Integer] id
+    # @attr [Boolean] imported
+    # @attr [String] imported_from
+    # @attr [Integer] project_id
+    # @attr [Integer] target_id
+    # @attr [Integer] target_iid
+    # @attr [String] target_title
+    # @attr [String] target_type
+    # @attr [String] title
+    # @todo Document attribute definitions
+    # @todo List all events > https://docs.gitlab.com/api/events/#list-all-events
+    class Events < SupportOps::GitLab::Base
+      define_attributes :action_name, :author, :author_id, :author_username,
+                        :id, :imported, :imported_from, :project_id, :target_id,
+                        :target_iid, :target_title, :target_type, :title
+      readonly_attributes :action_name, :author, :author_id, :author_username,
+                          :id, :imported, :imported_from, :project_id,
+                          :target_id, :target_iid, :target_title, :target_type,
+                          :title
+
+      ##
+      # Get contribution events for a user
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param user_id [Integer or String required] The ID or username of the
+      #     user to get events for
+      #   @param action [String optional] If defined, returns events with the
+      #     specified action type (approved, closed, commented, created,
+      #     destroyed, expired, joined, left, merge, pushed, reopened, updated)
+      #   @param after [String optional] If defined, returns tokens created
+      #     after the specified date (expects ISO 8601 format)
+      #   @param before [String optional] If defined, returns tokens created
+      #     before the specified date (expects ISO 8601 format)
+      #   @param sort [String optional] Direction to sort the results by
+      #     creation date; possible values: asc, desc
+      #   @param target_type [String optional] If defined, returns events with
+      #     the specified target type (epic, issue, merge_request, milestone,
+      #     note, project, snippet, user)
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/api/events/#get-contribution-events-for-a-user
+      #   GitLab API > Events > Get contribution events for a user
+      # @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
+      #
+      #   events = SupportOps::GitLab::Events.list(user_id: 123456)
+      #   pp events.count
+      #   # => 30
+      #   pp events.last.action_name
+      #   # => "closed"
+      def self.list_user(**args)
+        raise 'You have to provide a user_id' if args[:user_id].nil?
+        args[:action] = nil unless args[:action]
+        args[:after] = nil unless args[:after]
+        args[:before] = nil unless args[:before]
+        args[:sort] = nil unless args[:sort]
+        args[:target_type] = nil unless args[:target_type]
+        params = ''
+        params += "action=#{args[:action]}&" unless args[:action].nil?
+        params += "after=#{args[:after]}&" unless args[:after].nil?
+        params += "before=#{args[:before]}&" unless args[:before].nil?
+        params += "sort=#{args[:sort]}&" unless args[:sort].nil?
+        params += "target_type=#{args[:target_type]}&" unless args[:target_type].nil?
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("users/#{args[:user_id]}/events?#{params}&page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map { |e| Events.new(e) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # List all visible events for a project
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param project_id [Integer or String required] The ID or URL-encoded
+      #     path of the project to get events for
+      #   @param action [String optional] If defined, returns events with the
+      #     specified action type (approved, closed, commented, created,
+      #     destroyed, expired, joined, left, merge, pushed, reopened, updated)
+      #   @param after [String optional] If defined, returns tokens created
+      #     after the specified date (expects ISO 8601 format)
+      #   @param before [String optional] If defined, returns tokens created
+      #     before the specified date (expects ISO 8601 format)
+      #   @param sort [String optional] Direction to sort the results by
+      #     creation date; possible values: asc, desc
+      #   @param target_type [String optional] If defined, returns events with
+      #     the specified target type (epic, issue, merge_request, milestone,
+      #     note, project, snippet, user)
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/api/events/#list-all-visible-events-for-a-project
+      #   GitLab API > Events > List all visible events for a project
+      # @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
+      #
+      #   events = SupportOps::GitLab::Events.list(project_id: 123456)
+      #   pp events.count
+      #   # => 48
+      #   pp events.last.action_name
+      #   # => "opened"
+      def self.list_project(**args)
+        raise 'You have to provide a project_id' if args[:project_id].nil?
+        args[:action] = nil unless args[:action]
+        args[:after] = nil unless args[:after]
+        args[:before] = nil unless args[:before]
+        args[:sort] = nil unless args[:sort]
+        args[:target_type] = nil unless args[:target_type]
+        params = ''
+        params += "action=#{args[:action]}&" unless args[:action].nil?
+        params += "after=#{args[:after]}&" unless args[:after].nil?
+        params += "before=#{args[:before]}&" unless args[:before].nil?
+        params += "sort=#{args[:sort]}&" unless args[:sort].nil?
+        params += "target_type=#{args[:target_type]}&" unless args[:target_type].nil?
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("projects/#{args[:project_id]}/events?#{params}&page=#{page}&per_page=100")
+          body = Oj.load(response.body)
+          array += body.map { |e| Events.new(e) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      private
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/gpg_keys.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class GPGKeys within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at Timestamp for when the key was created
+    # @attr [Integer] id ID value of the key
+    # @attr [String] key Public key value
+    # @todo Get an GPG key for a user > https://docs.gitlab.com/api/user_keys/#get-a-gpg-key-for-a-user
+    # @todo Add an GPG key for a user > https://docs.gitlab.com/api/user_keys/#add-a-gpg-key-for-a-user
+    # @todo Delete an GPG key for a user > https://docs.gitlab.com/api/user_keys/#delete-n-gpg-key-for-a-user
+    class GPGKeys < SupportOps::GitLab::Base
+      define_attributes :created_at, :id, :key
+      readonly_attributes :created_at, :id
+
+      ##
+      # Lists all GPG keys for a user
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param user_id [Integer optional] The user ID to get SSH keys of (not
+      #     including this does it for the current user)
+      # @return [Array]
+      # @see
+      #   https://docs.gitlab.com/api/user_keys/#list-all-gpg-keys-for-a-user
+      #   GitLab API > SSH and GPG Keys > List all GPG keys for a user
+      # @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
+      #
+      #   keys = SupportOps::GitLab::GPGKeys.list(user_id: 123456)
+      #   pp keys.count
+      #   # => 3
+      #   pp keys.last.id
+      #   # => 789
+      def self.list(**args)
+        args[:user_id] = nil unless args[:user_id]
+        url = if args[:user_id].nil?
+                'user/gpg_keys'
+              else
+                "users/#{args[:user_id]}/gpg_keys"
+              end
+        response = client.connection.get(url)
+        body = Oj.load(response.body)
+        raise "Unable to get GPG keys of user => #{body}" if response.status != 200
+        body.map { |g| GPGKeys.new(g) }
+      end
+
+      private
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/group_memberships.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class GroupMemberships within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] access_level The membership level
+    # @attr [String] avatar_url URL of the user's avatar
+    # @attr [String] created_at The time the membership was created at
+    # @attr [Hash] created_by A hash containing information on who created the membership
+    # @attr [String] email The email of the user
+    # @attr [String] expires_at The timestamp when the membership expires
+    # @attr [Hash] group_saml_identity A hash containing the group's SAML information tied to the membership
+    # @attr [Integer] id The user's ID
+    # @attr [String] name The name of the user
+    # @attr [String] state The state of the membership, can be awaiting or active
+    # @attr [String] username The username of the user
+    # @attr [String] web_url The web URL of theuser
+    class GroupMemberships < SupportOps::GitLab::Base
+      define_attributes :access_level, :avatar_url, :created_at, :created_by,
+                        :email, :expires_at, :group_saml_identity, :id, :name,
+                        :state, :username, :web_url
+      readonly_attributes :access_level, :avatar_url, :created_at, :created_by,
+                          :email, :expires_at, :group_saml_identity, :id, :name,
+                          :state, :username, :web_url
+    end
+  end
+end