gitlab_support_readiness 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0e81abed456cb750b54dcdcef581f933c1b27e906353c1cb12fde4d70d5ccb0
+  data.tar.gz: 367d670acb747d15d574e13850e250c95acb6a99faf43e9f38e0345803845833
+SHA512:
+  metadata.gz: ebaa805e5fec5fd2c9df475e00af09c548fcdeca8d571ffb548e93ef22f8a121672445532ad84d1abfab049e17d78f7ac9b41515d0dce206a5c6f2ceab599eb9
+  data.tar.gz: e710ac16335bf813d780446fdbc7cfc8a95f2b0e62165b62f7e381aa9c09112eef36b7281c03cdf490db93df55119a44225d633daf6fbf9893427697801b936c

data/lib/support_readiness/client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the class Client within the module {Readiness}.
+  #
+  # @author Jason Colyer
+  # @since 1.0.0
+  class Client
+    def self.to_param_string(parms)
+      return '' if parms.count.zero?
+
+      "#{parms.join('&')}"
+    end
+    ##
+    # Converts an Object to a Hash
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param object [Object]
+    # @return [Hash]
+    def self.to_hash(object)
+      Hash[object.instance_variables.map { |name| [name.to_s[1..-1], object.instance_variable_get(name)] }]
+    end
+
+    ##
+    # Converts an Object to a JSON String, removing nil values
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param object [Object]
+    # @return [String]
+    def self.to_clean_json(object)
+      hash = to_hash(object).compact
+      hash.to_json
+    end
+
+    ##
+    # Converts an Object to a JSON String with a leading key, removing nil values
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param object [Object]
+    # @param key [String]
+    # @return [String]
+    def self.to_clean_json_with_key(object, key)
+      hash = { "#{key}": to_hash(object).compact }
+      hash.to_json
+    end
+
+    ##
+    # Handles error occurred from making Faraday requests
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    def self.handle_request_error(type, system, code, params = {})
+      auth_error(system) if code == 401 || code == 403
+      if type == 1
+        bad_request_error(system, params) if code == 400
+        not_found_error(system, params) if code == 404
+        not_processible_error(system, params) if code == 422
+      end
+    end
+
+    ##
+    # Handles 404 Not found errors from making Faraday requests.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param system [String] The system the error occurred on
+    # @param params [Hash] A Hash of information about the request
+    def self.not_found_error(system, params)
+      puts "Action '#{params[:action]}' to ID #{params[:id]} on #{system} returned a 404 error"
+      exit 1
+    end
+
+    ##
+    # Handles authentication errors from making Faraday requests.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param system [String] The system the error occurred on
+    def self.auth_error(system)
+      puts "Unable to authenticate to #{system}. Check your configuration and try again."
+      exit 1
+    end
+
+    def self.bad_request_error(system, params)
+      pp system
+      pp params
+      exit 1
+    end
+
+    ##
+    # Handles Unprocessable Content errors from making Faraday requests.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param system [String] The system the error occurred on
+    # @param params [Hash] A Hash of information about the request
+    def self.not_processible_error(system, params)
+      puts "Unable to '#{params[:action]}' on #{system}, as it returned the message:"
+      pp params[:message]
+      exit 1
+    end
+  end
+end

data/lib/support_readiness/gitlab/client.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Client within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Client
+      attr_reader :connection, :upload_connection
+
+      ##
+      # Creates a new {Readiness::GitLab::Client} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param config [Object] An instance of {Readiness::GitLab::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      def initialize(config = Readiness::GitLab::Configuration.new)
+        @connection = generate_connection(config)
+      end
+
+      ##
+      # Used to generate the retry options passed to Faraday via faraday-retry
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param config [Object] An instance of {Readiness::GitLab::Configuration}
+      # @return [Hash]
+      def retry_options(config)
+        {
+          max: config.retry_max,
+          interval: config.retry_interval,
+          interval_randomness: config.retry_randomness,
+          backoff_factor: config.retry_backoff,
+          exceptions: config.retry_exceptions
+        }
+      end
+
+      ##
+      # Used to generate a Faraday connection
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param config [Object] An instance of {Readiness::GitLab::Configuration}
+      # @return [Object]
+      def generate_connection(config)
+        Faraday.new(config.url) do |c|
+          c.request :retry, retry_options(config)
+          c.adapter Faraday.default_adapter
+          c.headers['Content-Type'] = 'application/json'
+          c.headers['Authorization'] = "Bearer #{config.token}"
+        end
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/configuration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Configuration within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Configuration
+      attr_accessor :url, :token, :retry_options, :retry_max, :retry_interval, :retry_randomness, :retry_backoff, :retry_exceptions
+
+      ##
+      # Creates a new {Readiness::GitLab::Configuration} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   pp config
+      #   # => #<Readiness::GitLab::Configuration:0x00007f352fdd1420
+      #          @retry_backoff=2,
+      #          @retry_exceptions=
+      #           [Errno::ETIMEDOUT, "Timeout::Error", Faraday::TimeoutError, Faraday::RetriableResponse, Faraday::ConnectionFailed],
+      #          @retry_interval=1,
+      #          @retry_max=5,
+      #          @retry_randomness=0.5,
+      #          @token="test123abc",
+      #          @url="https://gitlab.com/api/v4">
+
+      def initialize
+        @url = 'https://gitlab.com/api/v4'
+        @token = ''
+        @retry_max = 5
+        @retry_interval = 1
+        @retry_randomness = 0.5
+        @retry_backoff  = 2
+        @retry_exceptions = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/groups.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Groups within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo Anything listed on https://docs.gitlab.com/ee/api/groups.html not currently here
+    class Groups < Readiness::Client
+      attr_accessor :allowed_email_domains_list, :auto_devops_enabled, :avatar_url, :default_branch, :default_branch_protection, :default_branch_protection_defaults, :description, :duo_features_enabled, :emails_disabled, :emails_enabled, :extra_shared_runners_minutes_limit, :full_name, :full_path, :id, :ip_restriction_ranges, :ldap_access, :ldap_cn, :lfs_enabled, :lock_duo_features_enabled, :lock_math_rendering_limits_enabled, :marked_for_deletion_on, :math_rendering_limits_enabled, :membership_lock, :mentions_disabled, :name, :organization_id, :parent_id, :path, :prevent_forking_outside_group, :project_creation_level, :repository_storage, :request_access_enabled, :require_two_factor_authentication, :runners_token, :shared_runners_minutes_limit, :shared_runners_setting, :shared_with_groups, :share_with_group_lock, :subgroup_creation_level, :two_factor_grace_period, :visibility, :web_url, :wiki_access_level
+
+      ##
+      # Creates a new {Readiness::GitLab::Groups} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::GitLab::Groups}
+      # @example
+      #   require 'support_readiness'
+      #   group = Readiness::GitLab::Groups.new
+      def initialize(object = {})
+        @allowed_email_domains_list = object['allowed_email_domains_list']
+        @auto_devops_enabled = object['auto_devops_enabled']
+        @avatar_url = object['avatar_url']
+        @default_branch = object['default_branch']
+        @default_branch_protection = object['default_branch_protection']
+        @default_branch_protection_defaults = object['default_branch_protection_defaults']
+        @description = object['description']
+        @duo_features_enabled = object['duo_features_enabled']
+        @emails_disabled = object['emails_disabled']
+        @emails_enabled = object['emails_enabled']
+        @extra_shared_runners_minutes_limit = object['extra_shared_runners_minutes_limit']
+        @full_name = object['full_name']
+        @full_path = object['full_path']
+        @id = object['id']
+        @ip_restriction_ranges = object['ip_restriction_ranges']
+        @ldap_access = object['ldap_access']
+        @ldap_cn = object['ldap_cn']
+        @lfs_enabled = object['lfs_enabled']
+        @lock_duo_features_enabled = object['lock_duo_features_enabled']
+        @lock_math_rendering_limits_enabled = object['lock_math_rendering_limits_enabled']
+        @marked_for_deletion_on = object['marked_for_deletion_on']
+        @math_rendering_limits_enabled = object['math_rendering_limits_enabled']
+        @membership_lock = object['membership_lock']
+        @mentions_disabled = object['mentions_disabled']
+        @name = object['name']
+        @organization_id = object['organization_id']
+        @parent_id = object['parent_id']
+        @path = object['path']
+        @prevent_forking_outside_group = object['prevent_forking_outside_group']
+        @project_creation_level = object['project_creation_level']
+        @repository_storage = object['repository_storage']
+        @request_access_enabled = object['request_access_enabled']
+        @require_two_factor_authentication = object['require_two_factor_authentication']
+        @runners_token = object['runners_token']
+        @shared_runners_minutes_limit = object['shared_runners_minutes_limit']
+        @shared_runners_setting = object['shared_runners_setting']
+        @shared_with_groups = object['shared_with_groups']
+        @share_with_group_lock = object['share_with_group_lock']
+        @subgroup_creation_level = object['subgroup_creation_level']
+        @two_factor_grace_period = object['two_factor_grace_period']
+        @visibility = object['visibility']
+        @web_url = object['web_url']
+        @wiki_access_level = object['wiki_access_level']
+      end
+
+      ##
+      # Lists projects in a group.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param group [Object] An instance of {Readiness::GitLab::Groups}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/groups.html#list-a-groups-projects GitLab API > GRoups > List a group's projects
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new
+      #   group.id = 1
+      #   projects = Readiness::GitLab::Groups.projects(client, group, ["archived=false", "include_subgroups=true"])
+      #   puts projects.first.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta"
+      def self.projects(client, group, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "groups/#{group.id}/projects?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body.map { |p| Projects.new(p) }
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Lists direct members in a group.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param group [Object] An instance of {Readiness::GitLab::Groups}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project GitLab API > Members > List all members of a group or project
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new
+      #   group.id = 1
+      #   members = Readiness::GitLab::Groups.members(client, group, ["query=jcolyer"])
+      #   puts members.first['username']
+      #   # => "jcolyer-123"
+      def self.members(client, group, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "groups/#{group.id}/members?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Lists all members in a group.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param group [Object] An instance of {Readiness::GitLab::Groups}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project-including-inherited-and-invited-members GitLab API > Members > List all members of a group or project including inherited and invited members
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   group = Readiness::GitLab::Groups.new
+      #   group.id = 1
+      #   members = Readiness::GitLab::Groups.all_members(client, group, ["query=jcolyer"])
+      #   puts members.first['username']
+      #   # => "jcolyer"
+      def self.all_members(client, group, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "groups/#{group.id}/members/all?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+    end
+  end
+end