gitlab_support_readiness 1.0.0

data/lib/support_readiness/zendesk/articles.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Articles within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Articles < Readiness::Client
+      attr_accessor :author_id, :body, :comments_disabled, :draft, :id, :label_names, :locale, :name, :permission_group_id, :position, :promoted, :section_id, :title, :user_segment_id
+
+      ##
+      # Creates a new {Readiness::Zendesk::Articles} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::Articles}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Articles.new
+      def initialize(object = {})
+        @author_id = object['author_id']
+        @body = object['body']
+        @comments_disabled = object['comments_disabled']
+        @draft = object['draft']
+        @id = object['id']
+        @label_names = object['label_names']
+        @locale = object['locale']
+        @name = object['name']
+        @permission_group_id = object['permission_group_id']
+        @position = object['position']
+        @promoted = object['promoted']
+        @section_id = object['section_id']
+        @title = object['title']
+        @user_segment_id = object['user_segment_id']
+      end
+
+      ##
+      # Lists articles
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles Zendesk API > Articles > List Articles
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   articles = Readiness::Zendesk::Articles.list(client)
+      #   pp articles.first.id
+      #   # => 35467
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("help_center/articles?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['articles'].map { |a| Articles.new(a) }
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates an article within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param aid [Integer] The article ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#show-article Zendesk API > Articles > Show Article
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   article = Readiness::Zendesk::Articles.find(client, 35467)
+      #   pp article.title
+      #   # => "Article title"
+      def self.find(client, aid)
+        response = client.connection.get("help_center/articles/#{aid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: aid }) unless response.status == 200
+        return Articles.new(Oj.load(response.body)['article']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an article within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param aid [Integer] The article ID to find
+      # @return [Object] An instance of {Readiness::Zendesk::Articles}
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#show-article Zendesk API > Articles > Show Article
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   article = Readiness::Zendesk::Articles.find!(client, 35467)
+      #   pp article.title
+      #   # => "Article title"
+      def self.find!(client, aid)
+        response = client.connection.get("help_center/articles/#{aid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find article', id: aid }) unless response.status == 200
+        Articles.new(Oj.load(response.body)['article'])
+      end
+
+      ##
+      # Creates an article. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param article [Object] An instance of {Readiness::Zendesk::Articles}
+      # @return [Object] An instance of {Readiness::Zendesk::Articles}
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#create-article Zendesk API > Articles > Create Article
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   article = Readiness::Zendesk::Articles.new
+      #   article.title = 'Taking photos in low light'
+      #   artricle.body = 'Use a tripod'
+      #   article.section_id = 123
+      #   article.locale = 'en-us'
+      #   create = Readiness::Zendesk::Articles.create!(client, article)
+      #   pp create.id
+      #   # => 35468
+      def self.create!(client, article)
+        response = client.connection.post "help_center/sections/#{article.section_id}/articles", to_clean_json_with_key(article, 'article')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create article', message: Oj.load(response.body)}) unless response.status == 201
+        Articles.new(Oj.load(response.body)['article'])
+      end
+
+      ##
+      # Updates an article. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param article [Object] An instance of {Readiness::Zendesk::Articles}
+      # @return [Object] An instance of {Readiness::Zendesk::Articles}
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#update-article Zendesk API > Articles > Update Article
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   article = Readiness::Zendesk::Articles.find!(client, 35468)
+      #   artricle.body = 'Use a tripod and low light approved camera'
+      #   update = Readiness::Zendesk::Articles.update!(client, article)
+      #   pp update.body
+      #   # => "Use a tripod and low light approved camera"
+      def self.update!(client, article)
+        response = client.connection.put "help_center/sections/#{article.section_id}/articles", to_clean_json_with_key(article, 'article')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update article', id: article.id, message: Oj.load(response.body)}) unless response.status == 200
+        Articles.new(Oj.load(response.body)['article'])
+      end
+
+      ##
+      # Archives an article. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param article [Object] An instance of {Readiness::Zendesk::Articles}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#archive-article Zendesk API > Articles > Archive Article
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   article = Readiness::Zendesk::Articles.find!(client, 35468)
+      #   archive = Readiness::Zendesk::Articles.archive!(client, article)
+      #   pp archive
+      #   # => true
+      def self.archive!(client, article)
+        response = client.connection.delete "help_center/articles/#{article_id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Archive article', id: article.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/automations.rb

@@ -0,0 +1,304 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Automations within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Automations < Readiness::Client
+      attr_accessor :actions, :active, :conditions, :default, :id, :position, :title
+
+      ##
+      # Creates a new {Readiness::Zendesk::Automations} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::Automations}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Automations.new
+      def initialize(object = {})
+        @actions = object['actions']
+        @active = object['active']
+        @conditions = object['conditions']
+        @default = object['default']
+        @id = object['id']
+        @position = object['position']
+        @title = object['title']
+      end
+
+      ##
+      # Lists automations.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#list-automations Zendesk API > Automations > List Automations
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automations = Readiness::Zendesk::Automations.list(client)
+      #   pp automations.first.id
+      #   # => 25
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("automations?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['automations'].map { |a| Automations.new(a) }
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates an automation within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param aid [Integer] The automation ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#show-automation Zendesk API > Automations > Show Automation
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automation = Readiness::Zendesk::Automations.find(client, 25)
+      #   pp automation.title
+      #   # => "Close and Save"
+      def self.find(client, aid)
+        response = client.connection.get("automations/#{aid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: aid }) unless response.status == 200
+        return Automations.new(Oj.load(response.body)['automation']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an automation within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param aid [Integer] The automation ID to find
+      # @return [Object] An instance of {Readiness::Zendesk::Automations}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#show-automation Zendesk API > Automations > Show Automation
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automation = Readiness::Zendesk::Automations.find!(client, 25)
+      #   pp automation.title
+      #   # => "Close and Save"
+      def self.find!(client, aid)
+        response = client.connection.get("automations/#{aid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find automation', id: aid }) unless response.status == 200
+        Automations.new(Oj.load(response.body)['automation'])
+      end
+
+      ##
+      # Creates an automation. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param automation [Object] An instance of {Readiness::Zendesk::Automations}
+      # @return [Object] An instance of {Readiness::Zendesk::Automations}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#create-automation Zendesk API > Automations > Create Automation
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automation = Readiness::Zendesk::Automations.new
+      #   automation.title = 'Change priority to low for solved tickets'
+      #   automation.conditions = {
+      #     all: [
+      #       {
+      #         field: 'status'
+      #         operator: 'is'
+      #         value: 'solved'
+      #       },
+      #       {
+      #         field: 'priority'
+      #         operator: 'is_not'
+      #         value: 'low'
+      #       }
+      #     ]
+      #     any: []
+      #   }
+      #   automation.actions = [
+      #       {
+      #         field: 'priority'
+      #         value: 'low'
+      #       }
+      #   ]
+      #   created = Readiness::Zendesk::Automations.create!(client, automation)
+      #   pp created.id
+      #   # => 26
+      def self.create!(client, automation)
+        response = client.connection.post 'automations', to_clean_json_with_key(automation, 'automation')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create automation', message: Oj.load(response.body)}) unless response.status == 201
+        Automations.new(Oj.load(response.body)['automation'])
+      end
+
+      ##
+      # Updates an automation. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param automation [Object] An instance of {Readiness::Zendesk::Automations}
+      # @return [Object] An instance of {Readiness::Zendesk::Automations}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#update-automation Zendesk API > Automations > Update Automation
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automation = Readiness::Zendesk::Automations.find!(client, 26)
+      #   automation.title = 'Change priority to medium for solved tickets'
+      #   automation.conditions = {
+      #     all: [
+      #       {
+      #         field: 'status'
+      #         operator: 'is'
+      #         value: 'solved'
+      #       },
+      #       {
+      #         field: 'priority'
+      #         operator: 'is_not'
+      #         value: 'medium'
+      #       }
+      #     ]
+      #     any: []
+      #   }
+      #   automation.actions = [
+      #       {
+      #         field: 'priority'
+      #         value: 'medium'
+      #       }
+      #   ]
+      #   updated = Readiness::Zendesk::Automations.update!(client, automation)
+      #   pp updated.title
+      #   # => "Change priority to medium for solved tickets"
+      def self.update!(client, automation)
+        response = client.connection.put "automations/#{automation.id}", to_clean_json_with_key(automation, 'automation')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update automation', id: automation.id, message: Oj.load(response.body)}) unless response.status == 200
+        Automations.new(Oj.load(response.body)['automation'])
+      end
+
+      ##
+      # Updates multiple automations via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param automations [Array] An array of {Readiness::Zendesk::Automations} instances
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#update-many-automations Zendesk API > Automations > Update Many Automations
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automation1 = Readiness::Zendesk::Automations.find!(client, 1)
+      #   automation2 = Readiness::Zendesk::Automations.find!(client, 2)
+      #   automation3 = Readiness::Zendesk::Automations.find!(client, 3)
+      #   automation1.position = 2
+      #   automation2.position = 3
+      #   automation3.position = 1
+      #   automations = [automation1, automation2, automation3]
+      #   updated = Readiness::Zendesk::Automations.update_many!(client, automation)
+      #   pp updated.first.position
+      #   # => 2
+      def self.update_many(client, automations)
+        data = { automations: automations.map { |t| to_hash(t).compact } }.to_json
+        response = client.connection.put('automations/update_many', data)
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update many automations', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body).map { |a| Automations.new(a) }
+      end
+
+      ##
+      # Deletes an automation. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param automation [Object] An instance of {Readiness::Zendesk::Automations}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#delete-automation Zendesk API > Automations > Delete Automation
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automation = Readiness::Zendesk::Automations.find!(client, 26)
+      #   deleted = Readiness::Zendesk::Automations.delete!(client, automation)
+      #   pp deleted
+      #   # => true
+      def self.delete!(client, automation)
+        response = client.connection.delete "automations/#{automation.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete an automation', id: automation.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Deletes multiple automations via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param aids [Array] An array of automation IDs
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#bulk-delete-automations Zendesk API > Automations > Bulk Delete Automations
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   automation1 = Readiness::Zendesk::Automations.find!(client, 1)
+      #   automation2 = Readiness::Zendesk::Automations.find!(client, 2)
+      #   automation3 = Readiness::Zendesk::Automations.find!(client, 3)
+      #   automations = [automation1, automation2, automation3]
+      #   deleted = Readiness::Zendesk::Automations.delete_many!(client, automation)
+      #   pp deleted
+      #   # => true
+      def self.delete_many!(client, aids)
+        response = client.connection.delete("automations/destroy_many?ids=#{aids.join(',')}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many automations', message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Client within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Client
+      attr_reader :connection, :upload_connection
+
+      ##
+      # Creates a new {Readiness::Zendesk::Client} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param config [Object] An instance of {Readiness::Zendesk::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      def initialize(config = Readiness::Zendesk::Configuration.new)
+        @connection = generate_connection(config)
+        @upload_connection = generate_upload_connection(config)
+      end
+
+      ##
+      # Used to generate the retry options passed to Faraday via faraday-retry
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param config [Object] An instance of {Readiness::Zendesk::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::Zendesk::Configuration}
+      # @return [Object]
+      def generate_connection(config)
+        Faraday.new(config.url) do |c|
+          c.request :retry, retry_options(config)
+          c.adapter Faraday.default_adapter
+          c.headers['Content-Type'] = 'application/json'
+          c.headers['Authorization'] = "Basic " + Base64.encode64("#{config.username}/token:#{config.token}").gsub("\n", '')
+        end
+      end
+
+      ##
+      # Used to generate a Faraday connection for uploads
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param config [Object] An instance of {Readiness::Zendesk::Configuration}
+      # @return [Object]
+      def generate_upload_connection(config)
+        Faraday.new(config.url) do |c|
+          c.request :retry, retry_options(config)
+          c.request :multipart
+          c.request :url_encoded
+          c.adapter Faraday.default_adapter
+          c.headers['Authorization'] = "Basic " + Base64.encode64("#{config.username}/token:#{config.token}").gsub("\n", '')
+        end
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/configuration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Configuration within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Configuration
+      attr_accessor :url, :username, :token, :retry_options, :retry_max, :retry_interval, :retry_randomness, :retry_backoff, :retry_exceptions
+
+      ##
+      # Creates a new {Readiness::Zendesk::Configuration} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   pp config
+      #   # => #<Readiness::Zendesk::Configuration:0x00007f352fdd1420
+      #          @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",
+      #          @url="https://example.zendesk.com/api/v2",
+      #          @username="alice@example.com">
+      def initialize
+        @url = ''
+        @username = ''
+        @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