gitlab_support_readiness 1.0.11 → 1.0.13

data/lib/support_readiness/gitlab/repositories.rb

@@ -262,6 +262,180 @@ module Readiness
         handle_request_error(1, 'GitLab', response.status, { action: 'Update submodule in repo', id: "#{project.id}" }) unless response.status == 200
         Oj.load(response.body)
       end
+
+      ##
+      # Lists a repository's commits.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/commits.html#list-repository-commits GitLab API > Repositories > List repository commits
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   commits = Readiness::GitLab::Repositories.commits(client, project)
+      #   pp commits.first['title']
+      #   # => "Replace sanitize with escape once"
+      def self.commits(client, project, filters)
+        array = []
+        page = 0
+        loop do
+          response = client.connection.get "projects/#{project.id}/repository/commits?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Lists a repository's tags.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/tags.html#list-project-repository-tags GitLab API > Tags > List project repository tags
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tags = Readiness::GitLab::Repositories.tags(client, project)
+      #   pp tags.first['commit']['id']
+      #   # => "2695effb5807a22ff3d138d593fd856244e155e7"
+      def self.tags(client, project, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "projects/#{project.id}/repository/tags?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Locates a repository tag. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag_name [String] The tag to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/tags.html#get-a-single-repository-tag GitLab API > Tags > Get a single project repository tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tag = Readiness::GitLab::Repositories.find_tag(client, project, 'v5.0.0')
+      #   pp tag.['target']
+      #   # => "60a8ff033665e1207714d6670fcd7b65304ec02f"
+      def self.find_tag(client, project, tag_name)
+        response = client.connection.get "projects/#{project.id}/repository/tags/#{tag_name}"
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: "projects/#{project.id}/repository/tags/#{tag_name}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a repository tag. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag_name [String] The tag to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/tags.html#get-a-single-repository-tag GitLab API > Tags > Get a single project repository tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tag = Readiness::GitLab::Repositories.find_tag!(client, project, 'v5.0.0')
+      #   pp tag.['target']
+      #   # => "60a8ff033665e1207714d6670fcd7b65304ec02f"
+      def self.find_tag!(client, project, tag_name)
+        response = client.connection.get("projects/#{project.id}/repository/tags/#{tag_name}")
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find tag', id: "projects/#{project.id}/repository/tags/#{tag_name}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Creates a repository tag. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag [Hash] The Hash to use for the tag creation
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/tags.html#create-a-new-tag GitLab API > Tags > Create a new tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   tag = {
+      #     tag_name: 'test',
+      #     ref: 'main'
+      #   }
+      #   create = Readiness::GitLab::Repositories.create_tag!(client, project, tag)
+      #   pp create['target']
+      #   # => "2695effb5807a22ff3d138d593fd856244e155e7"
+      def self.create_tag!(client, project, tag)
+        response = client.connection.post "projects/#{project.id}/repository/tags", tag.to_json
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create tag', id: "projects/#{project.id}/repository/tags" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Deletes a repository tag. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param tag_name [String] The name of the tag to delete
+      # @return [Boolean]
+      # @see https://docs.gitlab.com/ee/api/tags.html#delete-a-tag GitLab API > Tags > Delete a tag
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   delete = Readiness::GitLab::Repositories.create_tag!(client, project, 'test')
+      #   pp delete
+      #   # => true
+      def self.delete_tag!(client, project, tag_name)
+        response = client.connection.delete "projects/#{project.id}/repository/tags/#{tag_name}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Delete tag', id: "projects/#{project.id}/repository/tags/#{tag_name}" }) unless response.status == 200
+        true
+      end
     end
   end
 end

data/lib/support_readiness/gitlab/users.rb

@@ -507,6 +507,30 @@ module Readiness
         handle_request_error(0, 'GitLab', response.status) unless response.status == 200
         Oj.load(response.body)
       end
+
+      ##
+      # Determines if a user is the only maintainer on projects they are within
+      #
+      # @author Jason Colyer
+      # @since 1.0.3
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param user [Object] An instance of {Readiness::GitLab::Users}
+      # @return [Boolean]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   user = Readiness::GitLab::Users.find!(client, 5881867)
+      #   pp Readiness::GitLab::Users.only_maintainer?(client, user)
+      #   # => true
+      def self.only_maintainer?(client, user)
+        Users.projects(client, user).each do |p|
+          members = Projects.all_members(client, p)
+          return true if members = members.select { |m| m['access_level'] >= 40 && m['username'] != user.username }.count.zero?
+        end
+        false
+      end
     end
   end
 end

data/lib/support_readiness/gitlab.rb

@@ -11,7 +11,11 @@ module Readiness
     require "#{__dir__}/gitlab/configuration"
     require "#{__dir__}/gitlab/groups"
     require "#{__dir__}/gitlab/issues"
+    require "#{__dir__}/gitlab/jobs"
+    require "#{__dir__}/gitlab/markdown"
+    require "#{__dir__}/gitlab/merge_requests"
     require "#{__dir__}/gitlab/namespaces"
+    require "#{__dir__}/gitlab/pipelines"
     require "#{__dir__}/gitlab/projects"
     require "#{__dir__}/gitlab/repositories"
     require "#{__dir__}/gitlab/users"

data/lib/support_readiness/google_calendar/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleCalendar
+  module GoogleCalendar
+    ##
+    # Defines the class Client within the module {Readiness::GoogleCalendar}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Client
+      attr_accessor :calendar_id, :service
+
+      ##
+      # Creates a new {Readiness::GoogleCalendar::Client} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param config [Object] An instance of {Readiness::GoogleCalendar::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleCalendar::Client.new(config)
+      #   pp client.calendar_id
+      #   # => "abc123"
+      def initialize(config = Readiness::GoogleCalendar::Configuration.new)
+        @service = generate_service(config)
+        @calendar_id = config.calendar_id
+      end
+
+      ##
+      # Generates a service connection to Google Calendar
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param config [Object] An instance of {Readiness::GoogleCalendar::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   service = Readiness::GoogleCalendar::Client.generate_service(config)
+      def generate_service(config)
+        authorize = Google::Auth::ServiceAccountCredentials.make_creds(
+          json_key_io: File.open(config.filepath),
+          scope: config.scope
+        )
+        authorize.fetch_access_token!
+        service = Google::Apis::CalendarV3::CalendarService.new
+        service.authorization = authorize
+        service
+      end
+    end
+  end
+end

data/lib/support_readiness/google_calendar/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleCalendar
+  module GoogleCalendar
+    ##
+    # Defines the class Configuration within the module {Readiness::GoogleCalendar}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class Configuration
+      attr_accessor :calendar_id, :filepath, :scope
+
+      ##
+      # Creates a new {Readiness::GoogleCalendar::Configuration} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleCalendar::Configuration.new
+      #   config.calendar_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   pp config
+      #   # => #<Readiness::GoogleCalendar::Configuration:0x00007f352fdd1420
+      #          @calendar_id="abc123"
+      #          @filepath="data/config.json"
+      #          @scope="https://www.googleapis.com/auth/calendar">
+      def initialize
+        # /home/jason/dev/gitlab-support-readiness/zendesk-us-government/tickets/round-robin/lib/round_robin
+        @calendar_id = ''
+        @filepath = ''
+        @scope = 'https://www.googleapis.com/auth/calendar'
+      end
+    end
+  end
+end

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