gitlab-customer-support-operations_slack 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 197f06808537284ce01293feb93a28b2b87a3793a47aa33085972230d099a5c5
+  data.tar.gz: 7c4c638d220665f180c54667b391430062636bd6db50f979f90d6ee579110ee0
+SHA512:
+  metadata.gz: c0689cc4b6364cdbbd2f993bb298effc8216b1484e7268ac2ac3ac885751d8722d4863b2f4e92bded29be157600aa76487b94fc7239af2ccbf81e6af91b48e72
+  data.tar.gz: 211680f8bef17a53b8dee7231b2957e8d7ab660ec9fdd5bebd64db558823ef60a673dccbf8e79d82ee2de65b03e536121030bea67fa3a6dc2e298b3920f7af16

data/lib/support_ops_slack/slack/base.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Slack
+  module Slack
+    ##
+    # Defines the class Base within the module {SupportOps::Slack}.
+    #
+    # @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
+  
+      def save!
+        ensure_client_present!
+        create_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(:url) == 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 == :url
+              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::Slack.configure to set up the client.' unless client
+      end
+
+      def create_record
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/support_ops_slack/slack/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Slack
+  module Slack
+    ##
+    # Defines the class Client within the module {SupportOps::Slack}.
+    #
+    # @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::Slack::Configuration.new)
+        @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'
+        end
+      end
+    end
+  end
+end

data/lib/support_ops_slack/slack/configuration.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Slack
+  module Slack
+    ##
+    # Defines the module Configuration within the module {SupportOps::Slack}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    module Configuration
+      ##
+      # Setup a Slack client configuration
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload configure(key: value)
+      #   @param retry_backoff [Integer] See {Config#retry_backoff}
+      #   @param retry_exceptions [Array] See {Config#retry_exceptions}
+      #   @param retry_interval [Integer] See {Config#retry_interval}
+      #   @param retry_max [Integer] See {Config#retry_max}
+      #   @param retry_randomness [Integer] See {Config#retry_randomness}
+      #   @param url [String] See {Config#url}
+      # @example
+      #   require 'support_ops_slack'
+      #
+      #   SupportOps::Slack::Configuration.configure do |config|
+      #     config.url = ENV.fetch('SLACK_URL')
+      #   end
+      def self.configure
+        yield config
+      end
+
+      def self.config
+        @config ||= Config.new
+      end
+
+      def self.reset!
+        @config = Config.new
+      end
+
+      ##
+      # Defined the class Config within the module {SupportOps::Slack::Configuration}
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @attr [Integer] retry_backoff  multiplier applied to the retry_interval after each retry attempt, causing exponential backoff. Defaults to 2
+      # @attr [Array] retry_exceptions Specifies which types of exceptions or errors should trigger the retry mechanism.
+      # @attr [Integer] retry_interval The base time interval (typically in seconds or milliseconds) between retry attempts. Defaults to 1
+      # @attr [Integer] retry_max The maximum number of retry attempts that will be made when an operation fails. Defaults to 5
+      # @attr [Float] retry_randomness Adds a random element to the retry interval to prevent "thundering herd" problems where many systems retry simultaneously. Defaults to 0.5
+      # @attr [String] url The URL to use
+      class Config
+        attr_accessor :url, :retry_max, :retry_interval, :retry_randomness,
+                      :retry_backoff, :retry_exceptions,
+
+        def initialize
+          @retry_backoff = 2
+          @retry_exceptions = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+          @retry_interval = 1
+          @retry_max = 5
+          @retry_randomness = 0.5
+        end
+
+        def client
+          @client ||= Client.new(
+            retry_max: retry_max,
+            retry_interval: retry_interval,
+            retry_randomness: retry_randomness,
+            retry_backoff: retry_backoff,
+            retry_exceptions: retry_exceptions,
+            url: url
+          )
+        end
+      end
+    end
+  end
+end

data/lib/support_ops_slack/slack/messages.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Slack
+  module Slack
+    ##
+    # Defines the class Messages within the module {SupportOps::Slack}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] text The text to send
+    class Messages < SupportOps::Slack::Base
+      # @!parse
+      #   # Create a Message (i.e. post a message)
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @note This is inherited from {SupportOps::Slack::Base#save!}
+      #   # @example
+      #   #   require 'support_ops_slack'
+      #   #
+      #   #   SupportOps::Slack::Configuration.configure do |config|
+      #   #     config.url = ENV.fetch('SLACK_URL')
+      #   #   end
+      #   #
+      #   #   new_message = SupportOps::Slack::Messages.new
+      #   #   new_message.text = 'This is a test'
+      #   #   new_message.save!
+      #   def save!; end
+      define_attributes :text
+      readonly_attributes :text
+
+      private
+
+      ##
+      # @private
+      def create_record
+        data = { text: self.text }.to_json
+        response = client.connection.post('', data)
+        raise "Unable to create message => #{response.body}" unless response.status == 200
+        true
+      end
+    end
+  end
+end

data/lib/support_ops_slack/slack.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  ##
+  # Defines the module Slack within the module {SupportOps}.
+  #
+  # @author Jason Colyer
+  # @since 1.0.0
+  module Slack
+    # This one should always be first
+    require "#{__dir__}/slack/base"
+    # Order does not matter here
+    require "#{__dir__}/slack/client"
+    require "#{__dir__}/slack/configuration"
+    require "#{__dir__}/slack/messages"
+  end
+end

data/lib/support_ops_slack.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+$VERBOSE = nil
+
+##
+# Defines the module SupportOps
+# @author Jason Colyer
+# @since 1.0.0
+module SupportOps; end
+
+require 'active_support'
+require 'active_support/time'
+require 'base64'
+require 'cgi'
+require 'digest'
+require 'erb'
+require 'faraday'
+require 'faraday/multipart'
+require 'faraday/retry'
+require 'json'
+require 'oj'
+require 'restforce'
+require 'yaml'
+
+# This one should always be first
+
+# Order does not matter here
+require "#{__dir__}/support_ops_slack/slack"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-customer-support-operations_slack
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jason Colyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+description: Slack gem of GitLab Customer Support Operations
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/support_ops_slack.rb
+- lib/support_ops_slack/slack.rb
+- lib/support_ops_slack/slack/base.rb
+- lib/support_ops_slack/slack/client.rb
+- lib/support_ops_slack/slack/configuration.rb
+- lib/support_ops_slack/slack/messages.rb
+homepage: https://gitlab.com/reyloc/gitlab-customer-support-operations_slack
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://gitlab.com/reyloc/gitlab-customer-support-operations_slack/-/issues
+  documentation_uri: https://reyloc.gitlab.io/gitlab-customer-support-operations_slack/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key: 
+specification_version: 4
+summary: GitLab Customer Support Operations > Slack
+test_files: []