gitlab_support_readiness 1.0.11 → 1.0.13

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

data/lib/support_readiness/pagerduty/users.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Pagerduty
+  module Pagerduty
+    ##
+    # Defines the class Users within the module {Readiness::Pagerduty}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Users < Readiness::Client
+      attr_accessor :avatar_url, :color, :contact_methods, :description, :email, :html_url, :id, :invitation_sent, :job_title, :license, :name, :notification_rules, :role, :self, :summary, :teams, :time_zone, :type
+
+      ##
+      # Creates a new {Readiness::Pagerduty::Users} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Object] An instance of {Readiness::Pagerduty::Users}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Pagerduty::Users.new
+      def initialize(object = {})
+        @avatar_url = object['avatar_url']
+        @color = object['color']
+        @contact_methods = object['contact_methods']
+        @description = object['description']
+        @email = object['email']
+        @html_url = object['html_url']
+        @id = object['id']
+        @invitation_sent = object['invitation_sent']
+        @job_title = object['job_title']
+        @license = object['license']
+        @name = object['name']
+        @notification_rules = object['notification_rules']
+        @role = object['role']
+        @self = object['self']
+        @summary = object['summary']
+        @teams = object['teams']
+        @time_zone = object['time_zone']
+        @type = object['type']
+      end
+
+      ##
+      # Lists users within Pagerduty
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @return [Array]
+      # @see https://developer.pagerduty.com/api-reference/c96e889522dd6-list-users Pagerduty API > Users > List users
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'abc123'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   users = Readiness::Pagerduty::Users.list(client)
+      #   pp users.count
+      #   # => 436
+      def self.list(client)
+        array = []
+        offset = 0
+        loop do
+          response = client.connection.get "users?limit=100&offset=#{offset}"
+          body = Oj.load(response.body)
+          array += body['users'].map { |u| Users.new(u) }
+          break unless body['more']
+
+          offset += 100
+        end
+        array.uniq
+      end
+
+      ##
+      # Shows info of a Pagerduty user. This will not exit on error (except for Auth errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @see https://developer.pagerduty.com/api-reference/2395ca1feb25e-get-a-user Pagerduty API > Users > Get a user
+      # @param uid [String] The user ID to look for
+      # @return [Hash]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'abc123'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   user = Readiness::Pagerduty::Users.find(client, 'ABC123')
+      #   pp user.name
+      #   # => "Alice Example"
+      def self.find(client, uid)
+        response = client.connection.get("users/#{uid}")
+        handle_request_error(0, 'Pagerduty', response.status,  { action: 'get', id: uid }) unless response.status == 200
+        return Users.new(Oj.load(response.body)['user']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Shows info of a Pagerduty user. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param uid [String] The user ID to look for
+      # @return [Object] An instance of {Readiness::Pagerduty::Users}
+      # @see https://developer.pagerduty.com/api-reference/2395ca1feb25e-get-a-user Pagerduty API > Users > Get a user
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'abc123'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   user = Readiness::Pagerduty::Users.find!(client, 'ABC123')
+      #   pp user.name
+      #   # => "Alice Example"
+      def self.find!(client, uid)
+        response = client.connection.get("users/#{uid}")
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Find user', id: uid }) unless response.status == 200
+        Users.new(Oj.load(response.body)['user'])
+      end
+
+      ##
+      # Shows info of a Pagerduty user using their email to find them. This will not exit on error (except Auth errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param email [String] The email to look for
+      # @return [Object] An instance of {Readiness::Pagerduty::Users}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'abc123'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   user = Readiness::Pagerduty::Users.find_by_email(client, 'alice@example.com')
+      #   pp user.name
+      #   # => "Alice Example"
+      def self.find_by_email(client, email)
+        list(client).detect { |u| u.email == email }
+      end
+
+      ##
+      # Shows info of a Pagerduty user using their email to find them. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param email [String] The email to look for
+      # @return [Object] An instance of {Readiness::Pagerduty::Users}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'abc123'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   user = Readiness::Pagerduty::Users.find_by_email!(client, 'alice@example.com')
+      #   pp user.name
+      #   # => "Alice Example"
+      def self.find_by_email!(client, email)
+        response = list(client).detect { |u| u.email == email }
+        handle_request_error(1, 'Pagerduty', 404, { action: 'Find user by email', id: email }) if response.nil?
+
+        response
+      end
+
+      ##
+      # Creates a user within Pagerduty. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Pagerduty::Client}
+      # @param user [Object] An instance of {Readiness::Pagerduty::Users}
+      # @return [Object] An instance of {Readiness::Pagerduty::Users}
+      # @see https://developer.pagerduty.com/api-reference/4cb4fd0f5444a-create-a-user Pagerduty API > Users > Create a user
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Pagerduty::Configuration.new
+      #   config.token = 'abc123'
+      #   client = Readiness::Pagerduty::Client.new(config)
+      #   user = Readiness::Pagerduty::Users.new
+      #   user.name = 'Alice Example'
+      #   user.email = 'alice@example.com'
+      #   user.license = {
+      #     id: 'P1C3FWI',
+      #     type: 'license_reference'
+      #   }
+      #   create = Readiness::Pagerduty::Users.create!(client, user)
+      #   pp create.id
+      #   # => "ABC123"
+      def self.create!(client, user)
+        response = client.connection.post 'users', to_clean_json_with_key(user, 'user')
+        handle_request_error(1, 'Pagerduty', response.status, { action: 'Create user', id: user.email }) unless response.status == 201
+        Users.new(Oj.load(response.body)['user'])
+      end
+    end
+  end
+end

data/lib/support_readiness/pagerduty.rb

@@ -12,5 +12,6 @@ module Readiness
     require "#{__dir__}/pagerduty/escalation_policies"
     require "#{__dir__}/pagerduty/schedules"
     require "#{__dir__}/pagerduty/services"
+    require "#{__dir__}/pagerduty/users"
   end
 end