gitlab_support_readiness 1.0.11 → 1.0.12

data/lib/support_readiness/google_calendar/events.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleCalendar
+  module GoogleCalendar
+    ##
+    # Defines the class Events within the module {Readiness::GoogleCalendar}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Events < Readiness::Client
+      attr_accessor :attachments, :attendees, :created, :creator, :description, :id, :location, :summary, :updated
+      ##
+      # The time to use for the start of the event. When creating an event, you need to pass a Time/DateTime object for this.
+      # @return [Object] a Time or DateTime object
+      # @example
+      #   require 'support_readiness'
+      #   event = Readiness::GoogleCalendar::Events.new
+      #   event.start = Time.parse('2024-12-18 20:45')
+      # @example
+      #   require 'support_readiness'
+      #   event = Readiness::GoogleCalendar::Events.new
+      #   event.start = DateTime.now
+      attr_accessor :start
+      ##
+      # The time to use for the end of the event. When creating an event, you need to pass a Time/DateTime object for this.
+      # @return [Object] a Time or DateTime object
+      # @example
+      #   require 'support_readiness'
+      #   event = Readiness::GoogleCalendar::Events.new
+      #   event.end = Time.parse('2024-12-18 20:45')
+      # @example
+      #   require 'support_readiness'
+      #   event = Readiness::GoogleCalendar::Events.new
+      #   event.end = DateTime.now
+      attr_accessor :end
+
+      ##
+      # Creates a new {Readiness::GoogleCalendar::Events} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Object] An instance of {Readiness::GoogleCalendar::Events}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::GoogleCalendar::Events.new
+      def initialize(object = {})
+        @attachments = object['attachments']
+        @attendees = object['attendees']
+        @created = object['created']
+        @creator = object['creator']
+        @description = object['description']
+        @end = object['end']
+        @id = object['id']
+        @location = object['location']
+        @start = object['start']
+        @summary = object['summary']
+        @updated = object['updated']
+      end
+
+      ##
+      # Lists all events on a calendar within specified time range
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GoogleCalendar::Client}
+      # @param start_time [Object] A Time or DateTime object
+      # @param end_time [Object] A Time or DateTime object
+      # @param max [Integer] The max number of results per page
+      # @return [Array]
+      # @example
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'test@example.com'
+      #   config.filepath = 'temp.json'
+      #   client = Readiness::GoogleCalendar::Client.new(config)
+      #   events = Readiness::GoogleCalendar::Events.list(client, DateTime.now, (DateTime.now + 5.hours))
+      #   pp events.count
+      #   # => 6
+      def self.list(client, start_time, end_time, max = 1000)
+        items = []
+        page_token = nil
+        loop do
+          response = client.service.list_events(
+            client.calendar_id,
+            max_results: max,
+            single_events: true,
+            order_by: 'startTime',
+            page_token: page_token,
+            time_min: start_time.rfc3339,
+            time_max: end_time.rfc3339
+          )
+          items += response.items
+          break if response.next_page_token.nil?
+
+          page_token = response.next_page_token
+        end
+        items
+      end
+
+      ##
+      # Creates an event on a calendar
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GoogleCalendar::Client}
+      # @param event [Object] An instance of {Readiness::GoogleCalendar::Events}
+      # @return [Object] An instance of {Google::Apis::CalendarV3::Event}
+      # @example
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'test@example.com'
+      #   config.filepath = 'temp.json'
+      #   client = Readiness::GoogleCalendar::Client.new(config)
+      #   event = Readiness::GoogleCalendar::Events.new
+      #   event.description = 'Test from Jason'
+      #   event.end = Time.parse('2024-10-04 11:00')
+      #   event.start = DateTime.parse('2024-10-04 10:00')
+      #   event.summary = 'Jason Test'
+      #   create = Readiness::GoogleCalendar::Events.create!(client, event)
+      #   pp create.id
+      #   # => "um4es01mlbn6nqh3gn25phtlvk"
+      def self.create!(client, event)
+        google_event = to_google_event(event)
+        client.service.insert_event(client.calendar_id, google_event)
+      end
+
+      ##
+      # Deletes an event on a calendar
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GoogleCalendar::Client}
+      # @param event [Object] An instance of {Readiness::GoogleCalendar::Events} or {Google::Apis::CalendarV3::Event}
+      # @return [Boolean]
+      # @example
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'test@example.com'
+      #   config.filepath = 'temp.json'
+      #   client = Readiness::GoogleCalendar::Client.new(config)
+      #   event = Readiness::GoogleCalendar::Events.new
+      #   event.id = 'um4es01mlbn6nqh3gn25phtlvk'
+      #   delete = Readiness::GoogleCalendar::Events.delete!(client, event)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, event)
+        client.service.delete_event(client.calendar_id, event.id)
+        true
+      end
+
+      ##
+      # Converts an instance of {Readiness::GoogleCalendar::Events} to {Google::Apis::CalendarV3::Event}
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param event [Object] An instance of {Readiness::GoogleCalendar::Events}
+      # @return [Object] An instance of {Google::Apis::CalendarV3::Event}
+      def self.to_google_event(event)
+        Google::Apis::CalendarV3::Event.new(
+          description: event.description,
+          end: Google::Apis::CalendarV3::EventDateTime.new(date_time: event.end.rfc3339),
+          location: event.location,
+          start: Google::Apis::CalendarV3::EventDateTime.new(date_time: event.start.rfc3339),
+          summary: event.summary
+        )
+      end
+    end
+  end
+end

data/lib/support_readiness/google_calendar.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleCalendar
+  # @author Jason Colyer
+  # @since 1.0.12
+  module GoogleCalendar
+    require "#{__dir__}/google_calendar/client"
+    require "#{__dir__}/google_calendar/configuration"
+    require "#{__dir__}/google_calendar/events"
+  end
+end

data/lib/support_readiness/mailgun/bounces.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Mailgun
+  module Mailgun
+    ##
+    # Defines the class Bounces within the module {Readiness::Mailgun}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Bounces < Readiness::Client
+      attr_accessor :address, :code, :error, :created_at
+
+      ##
+      # Creates a new {Readiness::Mailgun::Bounces} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Object] An instance of {Readiness::Mailgun::Bounces}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Mailgun::Bounces.new
+      def initialize(object = {})
+        @address = object['address']
+        @code = object['code']
+        @error = object['error']
+        @created_at = object['created_at']
+      end
+
+      ##
+      # Locates a suppression within Mailgun. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Mailgun::Client}
+      # @param email [String] The email to look for
+      # @return [Object] An instance of {Readiness::Mailgun::Bounces}
+      # @see https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Bounces/#tag/Bounces/operation/api.(*BounceController).Get-fm-20 Mailgun API > Bounces > View single bounce event
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Mailgun::Configuration.new
+      #   config.domain = 'test.gitlab.com'
+      #   config.token = 'abc123'
+      #   client = Readiness::Mailgun::Client.new(config)
+      #   bounce = Readiness::Mailgun::Bounces.find(client, 'test@example.com')
+      #   pp bounce.code
+      #   # => "550"
+      def self.find(client, email)
+        response = client.connection.get "#{client.domain}/bounces/#{CGI.escape(email)}"
+        handle_request_error(0, 'Mailgun', response.status,  { action: 'get', id: "#{client.domain}/bounces/#{CGI.escape(email)}" }) unless response.status == 200
+        Bounces.new Oj.load(response.body)
+      end
+
+      ##
+      # Locates a suppression within Mailgun. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Mailgun::Client}
+      # @param email [String] The email to look for
+      # @return [Object] An instance of {Readiness::Mailgun::Bounces}
+      # @see https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Bounces/#tag/Bounces/operation/api.(*BounceController).Get-fm-20 Mailgun API > Bounces > View single bounce event
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Mailgun::Configuration.new
+      #   config.domain = 'test.gitlab.com'
+      #   config.token = 'abc123'
+      #   client = Readiness::Mailgun::Client.new(config)
+      #   bounce = Readiness::Mailgun::Bounces.find!(client, 'test@example.com')
+      #   pp bounce.code
+      #   # => "550"
+      def self.find!(client, email)
+        response = client.connection.get "#{client.domain}/bounces/#{CGI.escape(email)}"
+        handle_request_error(1, 'Mailgun', response.status,  { action: 'get', id: "#{client.domain}/bounces/#{CGI.escape(email)}" }) unless response.status == 200
+        Bounces.new Oj.load(response.body)
+      end
+
+      # Deletes a suppression within Mailgun. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Mailgun::Client}
+      # @param bounce [Object] An instance of {Readiness::Mailgun::Bounces}
+      # @return [Boolean]
+      # @see https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Bounces/#tag/Bounces/operation/api.(*BounceController).Delete-fm-25 Mailgun API > Bounces > Clear a single bounce
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Mailgun::Configuration.new
+      #   config.domain = 'test.gitlab.com'
+      #   config.token = 'abc123'
+      #   client = Readiness::Mailgun::Client.new(config)
+      #   bounce = Readiness::Mailgun::Bounces.find!(client, 'test@example.com')
+      #   pp Readiness::Mailgun::Bounces.delete!(client, bounce)
+      #   # => true
+      def self.delete!(client, bounce)
+        response = client.connection.delete "#{client.domain}/bounces/#{CGI.escape(bounce.address)}"
+        handle_request_error(1, 'Mailgun', response.status,  { action: 'delete', id: "#{client.domain}/bounces/#{CGI.escape(email)}" }) unless response.status == 200
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/mailgun/client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Mailgun
+  module Mailgun
+    ##
+    # Defines the class Client within the module {Readiness::Mailgun}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Client
+      attr_reader :connection, :domain
+
+      ##
+      # Creates a new {Readiness::Mailgun::Client} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param config [Object] An instance of {Readiness::Mailgun::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Mailgun::Configuration.new
+      #   config.token = 'test123abc'
+      #   config.domain = 'test.gitlab.com'
+      #   client = Readiness::Mailgun::Client.new(config)
+      def initialize(config = Readiness::Mailgun::Configuration.new)
+        @connection = generate_connection(config)
+        @domain = config.domain
+      end
+
+      ##
+      # Used to generate the retry options passed to Faraday via faraday-retry
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param config [Object] An instance of {Readiness::Mailgun::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::Mailgun::Configuration}
+      # @return [Object]
+      def generate_connection(config)
+        Faraday.new("https://api:#{config.token}@api.mailgun.net/v3") 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_readiness/mailgun/configuration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Mailgun
+  module Mailgun
+    ##
+    # Defines the class Configuration within the module {Readiness::Mailgun}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Configuration
+      attr_accessor :domain, :token, :retry_options, :retry_max, :retry_interval, :retry_randomness, :retry_backoff, :retry_exceptions
+
+      ##
+      # Creates a new {Readiness::Mailgun::Configuration} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Mailgun::Configuration.new
+      #   config.token = 'test123abc'
+      #   config.domain = 'test.gitlab.com'
+      #   pp config
+      #   # => #<Readiness::Mailgun::Configuration:0x00007f352fdd1420
+      #          @domain="test.gitlab.com"
+      #          @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">
+      def initialize
+        @domain = ''
+        @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/mailgun/emails.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Mailgun
+  module Mailgun
+    ##
+    # Defines the class Emails within the module {Readiness::Mailgun}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Emails < Readiness::Client
+      attr_accessor :bcc, :cc, :from, :html, :subject, :reply_to, :text, :to
+
+      ##
+      # Creates a new {Readiness::Mailgun::Emails} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Object] An instance of {Readiness::Mailgun::Emails}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Mailgun::Emails.new
+      def initialize(object = {})
+        @bcc = object['bcc']
+        @cc = object['cc']
+        @from = object['from']
+        @html = object['html']
+        @subject = object['subject']
+        @reply_to = object['reply_to']
+        @text = object['text']
+        @to = object['to']
+      end
+
+      ##
+      # Sends an email using Mailgun. This will exit on error or if the email values used are invalid
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Mailgun::Client}
+      # @param email [Object] An instance of {Readiness::Mailgun::Emails}
+      # @return [Boolean]
+      # @see https://documentation.mailgun.com/docs/mailgun/api-reference/openapi-final/tag/Bounces/#tag/Bounces/operation/api.(*BounceController).Get-fm-20 Mailgun API > Bounces > View single bounce event
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Mailgun::Configuration.new
+      #   config.domain = 'test.gitlab.com'
+      #   config.token = 'abc123'
+      #   client = Readiness::Mailgun::Client.new(config)
+      #   email = Readiness::Mailgun::Emails.new
+      #   email.from = 'techsupport@gitlab.com'
+      #   email.to = 'jcolyer@gitlab.com'
+      #   email.subject = 'Test from Jason'
+      #   email.html = '<p>This is a test</p>'
+      #   email.text = 'This is a test'
+      #   pp Readiness::Mailgun::Emails.send!(client, email)
+      #   # => true
+      def self.send!(client, email)
+        handle_request_error(1, 'Mailgun', 400, { action: 'Send email', id: email }) unless valid_email?(email)
+        response = client.connection.post "#{client.domain}/messages", to_clean_json(email)
+        handle_request_error(1, 'Mailgun', response.status, { action: 'Send email', id: email }) unless response.status == 200
+        true
+      end
+
+      ##
+      # Determines if all required values are present for an email to be sent.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param email [Object] An instance of {Readiness::Mailgun::Emails}
+      # @return [Boolean]
+      # @example
+      #   require 'support_readiness'
+      #   email = Readiness::Mailgun::Emails.new
+      #   email.from = 'techsupport@gitlab.com'
+      #   email.to = 'jcolyer@gitlab.com'
+      #   email.subject = 'Test from Jason'
+      #   email.html = '<p>This is a test</p>'
+      #   email.text = 'This is a test'
+      #   pp Readiness::Mailgun::Emails.valid_email?(email)
+      #   # => true
+      #   email.subject = nil
+      #   pp Readiness::Mailgun::Emails.valid_email?(email)
+      #   # => false
+      def self.valid_email?(email)
+        return false if email.from.nil?
+        return false if email.to.nil?
+        return false if email.subject.nil?
+        return false if email.html.nil? && email.text.nil?
+
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/mailgun.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module Mailgun
+  # @author Jason Colyer
+  # @since 1.0.12
+  module Mailgun
+    require "#{__dir__}/mailgun/client"
+    require "#{__dir__}/mailgun/configuration"
+    require "#{__dir__}/mailgun/bounces"
+    require "#{__dir__}/mailgun/emails"
+  end
+end

data/lib/support_readiness/pagerduty/escalation_policies.rb

@@ -66,7 +66,7 @@ module Readiness
           array += body['escalation_policies'].map { |e| EscalationPolicies.new(e) }
           break unless body['more']
 
-          offset += 1
+          offset += 100
         end
         array
       end

data/lib/support_readiness/pagerduty/schedules.rb

@@ -10,7 +10,6 @@ module Readiness
     # @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
@@ -69,9 +68,9 @@ module Readiness
           array += body['schedules'].map { |e| Schedules.new(e) }
           break unless body['more']
 
-          offset += 1
+          offset += 100
         end
-        array
+        array.uniq
       end
 
       ##
@@ -218,6 +217,31 @@ module Readiness
         handle_request_error(1, 'Pagerduty', response.status, { action: 'Delete an override', id: schedule.id }) unless [200, 204].include?(response.status)
         true
       end
+
+      ##
+      # Updates a schedule within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param schedule [Object] A {Readiness::Pagerduty::Schedules} instance
+      # @return [Object] A {Readiness::Pagerduty::Schedules} instance
+      # @see https://developer.pagerduty.com/api-reference/7aff39ee95bfc-update-a-schedule Pagerduty API > Schedules > Update 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')
+      #   schedule.name = 'Updated name'
+      #   update = Readiness::Pagerduty::Schedules.update!(client, schedule)
+      #   pp update.name
+      #   # => "Updated name"
+      def self.update!(client, schedule)
+        response = client.connection.put "schedules/#{schedule.id}", to_clean_json_with_key(schedule, 'schedule')
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Update schedule', id: schedule.id, message: Oj.load(response.body)}) unless response.status == 200
+        Schedules.new(Oj.load(response.body)['schedule'])
+      end
     end
   end
 end

data/lib/support_readiness/pagerduty/services.rb

@@ -75,7 +75,7 @@ module Readiness
           array += body['services'].map { |e| Services.new(e) }
           break unless body['more']
 
-          offset += 1
+          offset += 100
         end
         array
       end