gitlab_support_readiness 1.0.0

data/lib/support_readiness/pagerduty/escalation_policies.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Pagerduty
+  module Pagerduty
+    ##
+    # Defines the class EscalationPolicies within the module {Readiness::Pagerduty}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo Create an escalation policy
+    # @todo Delete an escalation policy
+    # @todo Update en escalation policy
+    # @todo List audit records for an escalation policy
+    class EscalationPolicies < Readiness::Client
+      attr_accessor :description, :escalation_rules, :html_url, :id, :name, :num_loops, :on_call_handoff_notifications, :self, :services, :summary, :teams, :type
+
+      ##
+      # Creates a new {Readiness::Pagerduty::EscalationPolicies} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Pagerduty::EscalationPolicies}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Pagerduty::EscalationPolicies.new
+      def initialize(object = {})
+        @description = object['description']
+        @escalation_rules = object['escalation_rules']
+        @html_url = object['html_url']
+        @id = object['id']
+        @name = object['name']
+        @num_loops = object['num_loops']
+        @on_call_handoff_notifications = object['on_call_handoff_notifications']
+        @self = object['self']
+        @services = object['services']
+        @summary = object['summary']
+        @teams = object['teams']
+        @type = object['type']
+      end
+
+      ##
+      # Lists escalation policies
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @return [Array]
+      # @see https://developer.pagerduty.com/api-reference/51b21014a4f5a-list-escalation-policies Pagerduty API > Escalation Policies > List escalation poliices
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   policies = Readiness::Pagerduty::EscalationPolicies.list(client)
+      #   pp policies.first.type
+      #   # => "escalation_policy"
+      def self.list(client)
+        array = []
+        offset = 0
+        loop do
+          response = client.connection.get "escalation_policies?limit=100&offset=#{offset}"
+          handle_request_error(0, 'Pagerduty', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['escalation_policies'].map { |e| EscalationPolicies.new(e) }
+          break unless body['more']
+
+          offset += 1
+        end
+        array
+      end
+
+      ##
+      # Locates an escalation policy within Pagerduty. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param pid [String] The escalation policy ID to find
+      # @return [Hash]
+      # @see https://developer.pagerduty.com/api-reference/3db5a206585e1-get-an-escalation-policy Pagerduty API > Escalation Policies > Get an escalation policy
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   policy = Readiness::Pagerduty::EscalationPolicies.find(client, 'PANZZEQ')
+      #   pp policy.name
+      #   # => "Engineering Escalation Policy"
+      def self.find(client, pid)
+        response = client.connection.get("escalation_policies/#{pid}")
+        handle_request_error(0, 'Pagerduty', response.status,  { action: 'get', id: pid }) unless response.status == 200
+        return EscalationPolicies.new(Oj.load(response.body)['escalation_policy']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an escalation policy within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param pid [String] The escalation policy ID to find
+      # @return [Hash]
+      # @see https://developer.pagerduty.com/api-reference/3db5a206585e1-get-an-escalation-policy Pagerduty API > Escalation Policies > Get an escalation policy
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   policy = Readiness::Pagerduty::EscalationPolicies.find!(client, 'PANZZEQ')
+      #   pp policy.name
+      #   # => "Engineering Escalation Policy"
+      def self.find!(client, pid)
+        response = client.connection.get("escalation_policies/#{pid}")
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Find escalation policy', id: pid }) unless response.status == 200
+        EscalationPolicies.new(Oj.load(response.body)['escalation_policy'])
+      end
+    end
+  end
+end

data/lib/support_readiness/pagerduty/schedules.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Pagerduty
+  module Pagerduty
+    ##
+    # Defines the class Schedules within the module {Readiness::Pagerduty}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo Create a schedule
+    # @todo Update a scehdule
+    # @todo List audit records for a schedule
+    # @todo List users on call
+    # @todo Preview a schedule
+    class Schedules < Readiness::Client
+      attr_accessor :description, :escalation_policies, :final_schedule, :html_url, :id, :name, :overrides_subschedule, :schedule_layers, :self, :summary, :teams, :time_zone, :type, :users
+
+      ##
+      # Creates a new {Readiness::Pagerduty::Schedules} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Pagerduty::Schedules}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Pagerduty::Schedules.new
+      def initialize(object = {})
+        @description = object['description']
+        @escalation_policies = object['escalation_policies']
+        @final_schedule = object['final_schedule']
+        @html_url = object['html_url']
+        @id = object['id']
+        @name = object['name']
+        @overrides_subschedule = object['overrides_subschedule']
+        @schedule_layers = object['schedule_layers']
+        @self = object['self']
+        @summary = object['summary']
+        @teams = object['teams']
+        @time_zone = object['time_zone']
+        @type = object['type']
+        @users = object['users']
+      end
+
+      ##
+      # Lists schedules
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @return [Array]
+      # @see https://developer.pagerduty.com/api-reference/846ecf84402bb-list-schedules Pagerduty API > Schedules > List schedules
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   schedules = Readiness::Pagerduty::Schedules.list(client)
+      #   pp schedules.first.name
+      #   # => "Daily Engineering Rotation"
+      def self.list(client)
+        array = []
+        offset = 0
+        loop do
+          response = client.connection.get "schedules?limit=100&offset=#{offset}"
+          handle_request_error(0, 'Pagerduty', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['schedules'].map { |e| Schedules.new(e) }
+          break unless body['more']
+
+          offset += 1
+        end
+        array
+      end
+
+      ##
+      # Locates a schedule within Pagerduty. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param sid [String] The schedule ID to find
+      # @return [Hash]
+      # @see https://developer.pagerduty.com/api-reference/3f03afb2c84a4-get-a-schedule Pagerduty API > Schedules > Get a schedule
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   schedule = Readiness::Pagerduty::Schedules.find(client, 'PI7DH85')
+      #   pp schedule.name
+      #   # => "Daily Engineering Rotation"
+      def self.find(client, sid)
+        response = client.connection.get("schedules/#{sid}")
+        handle_request_error(0, 'Pagerduty', response.status,  { action: 'get', id: sid }) unless response.status == 200
+        return Schedules.new(Oj.load(response.body)['schedule']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a schedule within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param sid [String] The schedule ID to find
+      # @return [Object] A {Readiness::Pagerduty::Schedules} instance
+      # @see https://developer.pagerduty.com/api-reference/3f03afb2c84a4-get-a-schedule Pagerduty API > Schedules > Get a schedule
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   schedule = Readiness::Pagerduty::Schedules.find!(client, 'PI7DH85')
+      #   pp schedule.name
+      #   # => "Daily Engineering Rotation"
+      def self.find!(client, sid)
+        response = client.connection.get("schedules/#{sid}")
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Find schedule', id: sid }) unless response.status == 200
+        Schedules.new(Oj.load(response.body)['schedule'])
+      end
+
+      ##
+      # Lists overrides for a schedule within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param schedule [Object] A {Readiness::Pagerduty::Schedules} instance
+      # @param start_time [Time] The start time to use (must be ISO format)
+      # @param end_time [Time] The end time to use (must be ISO format)
+      # @param editable [Boolean] Only show overrides that can be edited (ones in the future)
+      # @return [Array]
+      # @see https://developer.pagerduty.com/api-reference/cb747199f63a9-list-overrides Pagerduty API > Schedules > List overrides
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   schedule = Readiness::Pagerduty::Schedules.find(client, 'PI7DH85')
+      #   overrides = Readiness::Pagerduty::Schedules.overrides(client, schedule)
+      #   pp overrides.first['user']['summary']
+      #   # => "Aurelio Rice"
+      def self.overrides(client, schedule, start_time = Time.now.utc.iso8601, end_time = (Time.now.utc + 1.hours).iso8601, editable = true)
+        response = client.connection.get "schedules/#{schedule.id}/overrides?editable=#{editable}&since=#{start_time}&until=#{end_time}"
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'List overrides', id: schedule.id }) unless response.status == 201
+        Oj.load(response.body)['overrides']
+      end
+
+      ##
+      # Create overrides on a schedule within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param schedule [Object] A {Readiness::Pagerduty::Schedules} instance
+      # @param list [Array] An array of overrides to create
+      # @return [Array]
+      # @see https://developer.pagerduty.com/api-reference/41d0a7c3c3a01-create-one-or-more-overrides Pagerduty API > Schedules > Create one of more overrides
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   schedule = Readiness::Pagerduty::Schedules.find(client, 'PI7DH85')
+      #   overrides = [
+      #     {
+      #       start: '2012-07-01T00:00:00-04:00',
+      #       end: '2012-07-02T00:00:00-04:00',
+      #       user: {
+      #         id: 'PEYSGVA',
+      #         type: 'user_reference' 
+      #       },
+      #       time_zone: 'UTC'
+      #     },
+      #     {
+      #       start: '2012-07-03T00:00:00-04:00',
+      #       end: '2012-07-04T00:00:00-04:00',
+      #       user: {
+      #         id: 'PEYSGVF',
+      #         type: 'user_reference' 
+      #       },
+      #       time_zone: 'UTC'
+      #     }
+      #   ]
+      #   created_overrides = Readiness::Pagerduty::Schedules.create_overrides(client, schedule, overrides)
+      #   pp created_overrides.map { |c| c['status'] }
+      #   # => [201, 201]
+      def self.create_overrides(client, schedule, list)
+        response = client.connection.post "schedules/#{schedule.id}/overrides", { overrides: list }.to_json
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Create overrides', id: schedule.id }) unless response.status == 201
+        Oj.load(response.body)
+      end
+
+      ##
+      # Delete an override on a schedule within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param schedule [Object] A {Readiness::Pagerduty::Schedules} instance
+      # @param oid [String] An override ID
+      # @return [Boolean]
+      # @see https://developer.pagerduty.com/api-reference/7740a1ba2d8a7-delete-an-override Pagerduty API > Schedules > Delete an override
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   schedule = Readiness::Pagerduty::Schedules.find(client, 'PI7DH85')
+      #   delete = Readiness::Pagerduty::Schedules.delete_override!(client, schedule, 'Q3X6MJ1LUKD6QW')
+      #   pp delete
+      #   # => true
+      def self.delete_override!(client, schedule, oid)
+        response = client.connection.delete "schedules/#{schedule.id}/overrides/#{oid}"
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Delete an override', id: schedule.id }) unless [200, 204].include?(response.status)
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/pagerduty/services.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Pagerduty
+  module Pagerduty
+    ##
+    # Defines the class Services within the module {Readiness::Pagerduty}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo Create a service
+    # @todo Delete a service
+    # @todo Update a service
+    # @todo List audit records for a service
+    # @todo Creat a new integration
+    # @todo Update an existing integration
+    # @todo View an integration
+    class Services < Readiness::Client
+      attr_accessor :acknowledgement_timeout, :alert_creation, :auto_pause_notifications_parameters, :auto_resolve_timeout, :created_at, :escalation_policy, :html_url, :id, :incident_urgency_rule, :integrations, :name, :scheduled_actions, :self, :status, :summary, :support_hours, :teams, :type
+
+      ##
+      # Creates a new {Readiness::Pagerduty::Services} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Pagerduty::Services}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Pagerduty::Services.new
+      def initialize(object = {})
+        @acknowledgement_timeout = object['acknowledgement_timeout']
+        @alert_creation = object['alert_creation']
+        @auto_pause_notifications_parameters = object['auto_pause_notifications_parameters']
+        @auto_resolve_timeout = object['auto_resolve_timeout']
+        @created_at = object['created_at']
+        @escalation_policy = object['escalation_policy']
+        @html_url = object['html_url']
+        @id = object['id']
+        @incident_urgency_rule = object['incident_urgency_rule']
+        @integrations = object['integrations']
+        @name = object['name']
+        @scheduled_actions = object['scheduled_actions']
+        @self = object['self']
+        @status = object['status']
+        @summary = object['summary']
+        @support_hours = object['support_hours']
+        @teams = object['teams']
+        @type = object['type']
+      end
+
+      ##
+      # Lists services
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @return [Array]
+      # @see https://developer.pagerduty.com/api-reference/e960cca205c0f-list-services Pagerduty API > Services > List services
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   services = Readiness::Pagerduty::Services.list(client)
+      #   pp services.first.name
+      #   # => "My Application Service"
+      def self.list(client)
+        array = []
+        offset = 0
+        loop do
+          response = client.connection.get "services?limit=100&offset=#{offset}"
+          handle_request_error(0, 'Pagerduty', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['services'].map { |e| Services.new(e) }
+          break unless body['more']
+
+          offset += 1
+        end
+        array
+      end
+
+      ##
+      # Locates a service within Pagerduty. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param sid [String] The service ID to find
+      # @return [Hash]
+      # @see https://developer.pagerduty.com/api-reference/165ad96a22ffd-get-a-service Pagerduty API > Services > Get a service
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   service = Readiness::Pagerduty::Services.find(client, "PIJ90N7")
+      #   pp service.name
+      #   # => "My Application Service"
+      def self.find(client, sid)
+        response = client.connection.get("services/#{sid}")
+        handle_request_error(0, 'Pagerduty', response.status,  { action: 'get', id: sid }) unless response.status == 200
+        return Services.new(Oj.load(response.body)['service']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a service within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param sid [String] The service ID to find
+      # @return [Object] A {Readiness::Pagerduty::Services} instance
+      # @see https://developer.pagerduty.com/api-reference/165ad96a22ffd-get-a-service Pagerduty API > Services > Get a service
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   service = Readiness::Pagerduty::Services.find!(client, "PIJ90N7")
+      #   pp service.name
+      #   # => "My Application Service"
+      def self.find!(client, sid)
+        response = client.connection.get("services/#{sid}")
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Find service', id: sid }) unless response.status == 200
+        Services.new(Oj.load(response.body)['service'])
+      end
+    end
+  end
+end

data/lib/support_readiness/pagerduty.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module Pagerduty
+  # @author Jason Colyer
+  # @since 1.0.0
+  module Pagerduty
+    require "#{__dir__}/pagerduty/client"
+    require "#{__dir__}/pagerduty/configuration"
+    require "#{__dir__}/pagerduty/escalation_policies"
+    require "#{__dir__}/pagerduty/schedules"
+    require "#{__dir__}/pagerduty/services"
+  end
+end

data/lib/support_readiness/redis.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+    ##
+    # Defines the class Redis within the module {Readiness}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+  class Redis
+    attr_accessor :connection
+
+    ##
+    # Creates a new {Readiness::Redis} instance
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param host [String] The hostname to use in Redis connections
+    # @param port [Integer] The port number to use in Redis connections
+    # @param password [String] The password to use in Redis connections
+    # @example
+    #   require 'support_readiness'
+    #   redis = Readiness::Redis.new('domain.com', 6379, 'p@assw0rd!')
+    def initialize(host, port, password)
+      @connection = generate_client(host, port, password)
+    end
+
+    ##
+    # Returns a Redis connection
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param host [String] The hostname to use in Redis connections
+    # @param port [Integer] The port number to use in Redis connections
+    # @param password [String] The password to use in Redis connections
+    def generate_client(host, port, password)
+      ::Redis.new(host: host,
+                  port: port,
+                  password: password,
+                  ssl: true)
+    end
+
+    ##
+    # Returns the value stored in a Redis key
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param client [Object] A {Readiness::Redis} instance
+    # @param key [String] The Redis key to get the value of
+    # @example
+    #   require 'support_readiness'
+    #   redis = Readiness::Redis.new('domain.com', 6379, 'p@assw0rd!')
+    #   puts Readiness::Redis.get(redis, 'foo')
+    #   # => bar
+    def self.get(client, key)
+      Marshal.load client.connection.get(key)
+    end
+
+    ##
+    # Sets the value stored in a Redis key
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param client [Object] A {Readiness::Redis} instance
+    # @param key [String] The Redis key to set the value of
+    # @param value The value to set within the key
+    # @example
+    #   require 'support_readiness'
+    #   redis = Readiness::Redis.new('domain.com', 6379, 'p@assw0rd!')
+    #   Readiness::Redis.set(redis, 'foo', 'bar2')
+    def self.set(client, key, value)
+      client.connection.set(key, Marhsal.dump(value))
+    end
+
+    ##
+    # Deletes the key and value stored in a Redis
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param client [Object] A {Readiness::Redis} instance
+    # @param key [String] The Redis key to delete
+    # @example
+    #   require 'support_readiness'
+    #   redis = Readiness::Redis.new('domain.com', 6379, 'p@assw0rd!')
+    #   Readiness::Redis.del(redis, 'foo')
+    def self.del(client, key)
+      client.connection.del(key)
+    end
+  end
+end