gitlab-customer-support-operations_gitlab 1.0.0

data/lib/support_ops_gitlab/gitlab/base.rb

@@ -0,0 +1,552 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Base within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Base
+      class << self
+        def client
+          Configuration.config.client
+        end
+
+        def configure
+          yield Configuration.config
+        end
+
+        def define_attributes(*attrs)
+          @attributes = attrs
+          attrs.each do |attr|
+            attr_accessor attr
+          end
+        end
+
+        def attributes
+          @attributes || []
+        end
+  
+        def readonly_attributes(*attrs)
+          return @readonly_attributes || [] if attrs.empty?
+
+          @readonly_attributes = attrs
+        end
+      end
+  
+      def initialize(attributes = {}, client = nil)
+        @client = client
+        @original_attributes = {}
+        set_attributes(attributes)
+        store_original_attributes
+      end
+
+      def store_original_attributes
+        @original_attributes = {}
+        self.class.attributes.each do |attr|
+          @original_attributes[attr] = instance_variable_get("@#{attr}")
+        end
+      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
+
+      def find
+        ensure_client_present!
+        set_attributes(get_record)
+        store_original_attributes
+        self
+      end
+
+      def find!
+        ensure_client_present!
+        attrs = get_record
+        if attrs == nil
+          raise "Unable to locate #{self.class.name.demodulize.singularize.downcase} '#{self.id}'"
+        end
+        set_attributes(attrs)
+        store_original_attributes
+        self
+      end
+  
+      def save!
+        ensure_client_present!
+        new_data = if id.nil?
+                     create_record
+                   else
+                     update_record
+                   end
+        new_data.each do |key, value|
+          self.instance_variable_set("@#{key}", value) if self.respond_to?("#{key}=")
+        end
+        store_original_attributes
+        self
+      end
+
+      def delete!
+        ensure_client_present!
+        delete_record
+      end
+
+      def hard_delete!
+        ensure_client_present!
+        hard_delete_record
+      end
+
+      def status
+        ensure_client_present!
+        status_record
+      end
+
+      def preferences
+        ensure_client_present!
+        preferences_record
+      end
+
+      def projects
+        ensure_client_present!
+        projects_record
+      end
+
+      def memberships
+        ensure_client_present!
+        memberships_record
+      end
+
+      def ssh_keys
+        ensure_client_present!
+        ssh_keys_record
+      end
+
+      def gpg_keys
+        ensure_client_present!
+        gpg_keys_record
+      end
+
+      def tokens
+        ensure_client_present!
+        tokens_record
+      end
+
+      def pats
+        ensure_client_present!
+        pats_records
+      end
+
+      def impersonations
+        ensure_client_present!
+        impersonations_record
+      end
+
+      def block!
+        ensure_client_present!
+        block_record
+      end
+
+      def unblock!
+        ensure_client_present!
+        unblock_record
+      end
+
+      def ban!
+        ensure_client_present!
+        ban_record
+      end
+
+      def unban!
+        ensure_client_present!
+        unban_record
+      end
+
+      def approve!
+        ensure_client_present!
+        approve_record
+      end
+
+      def reject!
+        ensure_client_present!
+        reject_record
+      end
+
+      def deactivate!
+        re_client_present!
+        deactivate_record
+      end
+
+      def activate!
+        re_client_present!
+        activate_record
+      end
+
+      def emails
+        ensure_client_present!
+        emails_record
+      end
+
+      def support_pin
+        ensure_client_present!
+        support_pin_record
+      end
+
+      def create_support_pin!
+        ensure_client_present!
+        create_support_pin_record
+      end
+
+      def disable_2fa!
+        ensure_client_present!
+        disable_2fa_record
+      end
+
+      def rotate!
+        ensure_client_present!
+        rotate_record
+      end
+
+      def revoke!
+        ensure_client_present!
+        revoke_record
+      end
+
+      def members(**args)
+        ensure_client_present!
+        members_record(**args)
+      end
+
+      def encoded_path
+        encoded_path_record
+      end
+
+      def paid?
+        is_paid_record
+      end
+
+      def badges
+        ensure_client_present!
+        badges_record
+      end
+
+      def issues
+        ensure_client_present!
+        issues_record
+      end
+
+      def merge_requests
+        ensure_client_present!
+        merge_requests_record
+      end
+
+      def move!
+        ensure_client_present!
+        move_record
+      end
+
+      def subscribe!
+        ensure_client_present!
+        subscribe_record
+      end
+
+      def unsubscribe!
+        ensure_client_present!
+        unsubscribe_record
+      end
+
+      def notes
+        ensure_client_present!
+        notes_record
+      end
+
+      def discussions
+        ensure_client_present!
+        discussions_record
+      end
+
+      def pipelines
+        ensure_client_present!
+        pipelines_record
+      end
+
+      def latest_pipeline
+        ensure_client_present!
+        latest_pipeline_record
+      end
+
+      def pipeline_variables
+        ensure_client_present!
+        pipeline_variables_record
+      end
+
+      def jobs
+        ensure_client_present!
+        jobs_record
+      end
+
+      def events
+        ensure_client_present!
+        events_record
+      end
+
+      def webhooks
+        ensure_client_present!
+        webhooks_record
+      end
+
+      def commits
+        ensure_client_present!
+        commits_record
+      end
+
+      def contributors
+        ensure_client_present!
+        contributors_record
+      end
+
+      def client=(new_client)
+        @client = new_client
+      end
+  
+      protected
+  
+      attr_reader :attributes, :original_attributes
+
+      def set_attributes(attributes)
+        return unless attributes
+
+        attrs = attributes.transform_keys(&:to_sym)
+        
+        self.class.attributes.each do |attr|
+          instance_variable_set("@#{attr}", attrs[attr])
+        end
+      end
+
+      def attributes_for_save
+        if send(:id) == nil
+          self.class.attributes
+            .reject { |attr| self.class.readonly_attributes.include?(attr) }
+            .each_with_object({}) do |attr, hash|
+              hash[attr] = send(attr)
+            end
+        else
+          self.class.attributes
+            .reject { |attr| self.class.readonly_attributes.include?(attr) }
+            .each_with_object({}) do |attr, hash|
+              current_value = send(attr)
+              original_value = @original_attributes[attr]
+
+              hash[attr] = current_value if attr == :id
+              if original_value != current_value
+                hash[attr] = current_value
+              end
+            end
+        end
+      end
+
+      def client
+        @client ||= self.class.client
+      end
+  
+      def ensure_client_present!
+        raise 'No client configured. Use SupportOps::GitLab.configure to set up the client.' unless client
+      end
+
+      def get_record(**args)
+        raise NotImplementedError
+      end
+
+      def create_record
+        raise NotImplementedError
+      end
+  
+      def update_record
+        raise NotImplementedError
+      end
+
+      def delete_record
+        raise NotImplementedError
+      end
+
+      def hard_delete_record
+        raise NotImplementedError
+      end
+
+      def status_record
+        raise NotImplementedError
+      end
+
+      def preferences_record
+        raise NotImplementedError
+      end
+
+      def projects_record
+        raise NotImplementedError
+      end
+
+      def memberships_record
+        raise NotImplementedError
+      end
+
+      def ssh_keys_record
+        raise NotImplementedError
+      end
+
+      def gpg_keys_record
+        raise NotImplementedError
+      end
+
+      def tokens_record
+        raise NotImplementedError
+      end
+
+      def pats_records
+        raise NotImplementedError
+      end
+
+      def impersonations_record
+        raise NotImplementedError
+      end
+
+      def block_record
+        raise NotImplementedError
+      end
+
+      def unblock_record
+        raise NotImplementedError
+      end
+
+      def ban_record
+        raise NotImplementedError
+      end
+
+      def unban_record
+        raise NotImplementedError
+      end
+
+      def approve_record
+        raise NotImplementedError
+      end
+
+      def reject_record
+        raise NotImplementedError
+      end
+
+      def deactivate_record
+        raise NotImplementedError
+      end
+
+      def activate_record
+        raise NotImplementedError
+      end
+
+      def emails_record
+        raise NotImplementedError
+      end
+
+      def support_pin_record
+        raise NotImplementedError
+      end
+
+      def create_support_pin_record
+        raise NotImplementedError
+      end
+
+      def disable_2fa_record
+        raise NotImplementedError
+      end
+
+      def rotate_record
+        raise NotImplementedError
+      end
+
+      def revoke_record
+        raise NotImplementedError
+      end
+
+      def members_record
+        raise NotImplementedError
+      end
+
+      def encoded_path_record
+        raise NotImplementedError
+      end
+
+      def is_paid_record
+        raise NotImplementedError
+      end
+
+      def badges_record
+        raise NotImplementedError
+      end
+
+      def issues_record
+        raise NotImplementedError
+      end
+
+      def merge_requests_record
+        raise NotImplementedError
+      end
+
+      def move_record
+        raise NotImplementedError
+      end
+
+      def subscribe_record
+        raise NotImplementedError
+      end
+
+      def unsubscribe_record
+        raise NotImplementedError
+      end
+
+      def notes_record
+        raise NotImplementedError
+      end
+
+      def discussions_record
+        raise NotImplementedError
+      end
+
+      def pipelines_record
+        raise NotImplementedError
+      end
+
+      def latest_pipeline_record
+        raise NotImplementedError
+      end
+
+      def pipeline_variables_record
+        raise NotImplementedError
+      end
+
+      def jobs_record
+        raise NotImplementedError
+      end
+
+      def events_record
+        raise NotImplementedError
+      end
+
+      def webhooks_record
+        raise NotImplementedError
+      end
+
+      def commits_record
+        raise NotImplementedError
+      end
+
+      def contributors_record
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/support_ops_gitlab/gitlab/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Client within the module {SupportOps::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Client
+      class Error < StandardError; end
+      class RequestError < Error; end
+      class ResourceNotFound < Error; end
+
+      attr_reader :connection
+
+      def initialize(config = SupportOps::GitLab::Configuration.new)
+        if config[:token].nil? && config[:job_token].nil?
+          raise 'No authentication token provided'
+        end
+        @connection = generate_connection(config)
+      end
+
+      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
+
+      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'
+          unless config[:token].nil?
+            c.headers['Authorization'] = "Bearer #{config[:token]}"
+          end
+          unless config[:job_token].nil?
+            c.headers['JOB-TOKEN'] = config[:job_token]
+          end
+        end
+      end
+    end
+  end
+end