octokit.net/Octokit.Reactive/Clients/Enterprise/ObservableEnterpriseAuditLogClient.cs

using Octokit.Models.Request.Enterprise;
using Octokit.Reactive.Internal;
using System;
using System.Collections.Generic;
using System.Reactive.Threading.Tasks;
using System.Threading.Tasks;

namespace Octokit.Reactive
{
    /// <summary>
    /// A client for GitHub's Enterprise Admin Stats API
    /// </summary>
    /// <remarks>
    /// See the <a href="https://developer.github.com/v3/enterprise/admin_stats/">Enterprise Admin Stats API documentation</a> for more information.
    ///</remarks>
    public class ObservableEnterpriseAuditLogClient : IObservableEnterpriseAuditLogClient
    {
        readonly IConnection _connection;

        public ObservableEnterpriseAuditLogClient(IGitHubClient client)
        {
            Ensure.ArgumentNotNull(client, "client");

            _connection = client.Connection;
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries (must be Site Admin user).  Note: Defaults to 100 entries per page (max count).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<AuditLogEvent> GetAll(string enterprise)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));

            return GetAll(enterprise, new AuditLogRequest(), new AuditLogApiOptions());
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries (must be Site Admin user). Note: Defaults to 100 entries per page (max count).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <param name="request">Used to filter and sort the list of issues returned</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<AuditLogEvent> GetAll(string enterprise, AuditLogRequest request)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));
            Ensure.ArgumentNotNull(request, nameof(request));

            return GetAll(enterprise, request, new AuditLogApiOptions());
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries (must be Site Admin user).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <param name="auditLogApiOptions">Options for changing the API response</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<AuditLogEvent> GetAll(string enterprise, AuditLogApiOptions auditLogApiOptions)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));
            Ensure.ArgumentNotNull(auditLogApiOptions, nameof(auditLogApiOptions));

            return GetAll(enterprise, new AuditLogRequest(), auditLogApiOptions);
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries (must be Site Admin user).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <param name="request">Used to filter and sort the list of events returned</param>
        /// <param name="auditLogApiOptions">Options for changing the API response</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<AuditLogEvent> GetAll(string enterprise, AuditLogRequest request, AuditLogApiOptions auditLogApiOptions)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));

            ApiOptionsExtended options = new ApiOptionsExtended()
            {
                PageSize = auditLogApiOptions.PageSize
            };


            return _connection.GetAndFlattenAllPages<AuditLogEvent>(ApiUrls.EnterpriseAuditLog(enterprise), request.ToParametersDictionary(), null, options, GeneratePreProcessFunction(auditLogApiOptions, options));
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries as raw Json (must be Site Admin user). Note: Defaults to 100 entries per page (max count).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<object> GetAllJson(string enterprise)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));

            return GetAllJson(enterprise, new AuditLogRequest(), new AuditLogApiOptions());
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries as raw Json (must be Site Admin user). Note: Defaults to 100 entries per page (max count).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <param name="request">Used to filter and sort the list of events returned</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<object> GetAllJson(string enterprise, AuditLogRequest request)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));

            return GetAllJson(enterprise, request, new AuditLogApiOptions());
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries as raw Json (must be Site Admin user).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <param name="auditLogApiOptions">Options for changing the API response</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<object> GetAllJson(string enterprise, AuditLogApiOptions auditLogApiOptions)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));

            return GetAllJson(enterprise, new AuditLogRequest(), auditLogApiOptions);
        }

        /// <summary>
        /// Gets GitHub Enterprise Audit Log Entries as raw Json (must be Site Admin user).
        /// </summary>
        /// <remarks>
        /// https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/audit-log/#get-the-audit-log-for-an-enterprise
        /// </remarks>
        /// <param name="enterprise">Name of enterprise</param>
        /// <param name="request">Used to filter and sort the list of events returned</param>
        /// <param name="auditLogApiOptions">Options for changing the API response</param>
        /// <returns>The <see cref="AuditLogEvent"/> list.</returns>
        public IObservable<object> GetAllJson(string enterprise, AuditLogRequest request, AuditLogApiOptions auditLogApiOptions)
        {
            Ensure.ArgumentNotNull(enterprise, nameof(enterprise));

            ApiOptionsExtended options = new ApiOptionsExtended()
            {
                PageSize = auditLogApiOptions.PageSize
            };

            return _connection.GetAndFlattenAllPages<AuditLogEvent>(ApiUrls.EnterpriseAuditLog(enterprise), request.ToParametersDictionary(), null, options, GeneratePreProcessFunction(auditLogApiOptions, options));
        }

        private static Func<object, object> GeneratePreProcessFunction(AuditLogApiOptions auditLogApiOptions, ApiOptionsExtended options)
        {
            Func<object, object> preProcessResponseBody = null;
            if (string.IsNullOrEmpty(auditLogApiOptions?.StopWhenFound))
                preProcessResponseBody = (r) =>
                {
                    if (r is string body)
                        r = body.Replace("_document_id", "document_id").Replace("@timestamp", "timestamp");

                    return r;
                };
            else
                preProcessResponseBody = (r) =>
                {
                    if (r is string body)
                    {
                        if (body.Contains(auditLogApiOptions.StopWhenFound))
                            options.IsDone = true;

                        r = body.Replace("_document_id", "document_id").Replace("@timestamp", "timestamp");
                    }
                    return r;
                };

            return preProcessResponseBody;
        }
    }
}