Replay #2221: Implement GitHub Actions Secrets API for both Organization and Repository

Octokit.Reactive/Clients/IObservableOrganizationActionsClient.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Octokit.Reactive
+{
+    /// <summary>
+    /// A client for GitHub's Org Actions API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="https://docs.github.com/en/rest/reference/actions"> Actions API documentation</a> for more information.
+    /// </remarks>
+    public interface IObservableOrganizationActionsClient
+    {
+        /// <summary>
+        /// Returns a client to manage organization secrets.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#secrets"> Secrets API documentation</a> for more information.
+        /// </remarks>
+        IObservableOrganizationSecretsClient Secrets { get; }
+    }
+}

Octokit.Reactive/Clients/IObservableOrganizationSecretsClient.cs

@@ -0,0 +1,119 @@
+using System;
+using System.Reactive;
+
+namespace Octokit.Reactive
+{
+    /// <summary>
+    /// A client for GitHub's Organization Secrets API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="https://docs.github.com/en/rest/reference/actions#secrets">Organization Secrets API documentation</a> for more details.
+    /// </remarks>
+    public interface IObservableOrganizationSecretsClient
+    {
+        /// <summary>
+        /// Get the public signing key to encrypt secrets for an organization.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#get-an-organization-public-key">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="SecretsPublicKey"/> instance for the organization public key.</returns>
+        IObservable<SecretsPublicKey> GetPublicKey(string org);
+
+        /// <summary>
+        /// List the secrets for an organization.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#list-organization-secrets">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="OrganizationSecretsCollection"/> instance for the list of organization secrets.</returns>
+        IObservable<OrganizationSecretsCollection> GetAll(string org);
+
+        /// <summary>
+        /// Get a secret from an organization.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#get-an-organization-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="OrganizationSecret"/> instance for the organization secret.</returns>
+        IObservable<OrganizationSecret> Get(string org, string secretName);
+
+        /// <summary>
+        /// Create or update a secret in an organization.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#create-or-update-an-organization-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <param name="upsertSecret">The encrypted value, id of the encryption key, and visibility info to upsert</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="OrganizationSecret"/> instance for the organization secret that was created or updated.</returns>
+        IObservable<OrganizationSecret> CreateOrUpdate(string org, string secretName, UpsertOrganizationSecret upsertSecret);
+
+        /// <summary>
+        /// Delete a secret in an organization.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#delete-an-organization-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<Unit> Delete(string org, string secretName);
+
+        /// <summary>
+        /// Get the list of selected sites that have access to a secret.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#list-selected-repositories-for-an-organization-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<OrganizationSecretRepositoryCollection> GetSelectedRepositoriesForSecret(string org, string secretName);
+
+        /// <summary>
+        /// Set the list of selected sites that have access to a secret.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#set-selected-repositories-for-an-organization-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <param name="repositories">The list of repositories that should have access to view and use the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<Unit> SetSelectedRepositoriesForSecret(string org, string secretName, SelectedRepositoryCollection repositories);
+
+        /// <summary>
+        /// Add a selected site to the visibility list of a secret.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#add-selected-repository-to-an-organization-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <param name="repoId">The id of the repo to add to the visibility list of the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<Unit> AddRepoToOrganizationSecret(string org, string secretName, long repoId);
+
+        /// <summary>
+        /// ARemoved a selected site from the visibility list of a secret.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#remove-selected-repository-from-an-organization-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="org">The name of the organization</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <param name="repoId">The id of the repo to add to the visibility list of the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<Unit> RemoveRepoFromOrganizationSecret(string org, string secretName, long repoId);
+    }
+}

Octokit.Reactive/Clients/IObservableOrganizationsClient.cs

@@ -26,6 +26,11 @@ public interface IObservableOrganizationsClient
         /// </summary>
         IObservableOrganizationOutsideCollaboratorsClient OutsideCollaborator { get; }
 
+        /// <summary>
+        /// Returns a client to manage organization actions.
+        /// </summary>
+        IObservableOrganizationActionsClient Actions { get; }
+
         /// <summary>
         /// Returns the specified organization.
         /// </summary>

Octokit.Reactive/Clients/IObservableRepositoriesClient.cs

@@ -195,6 +195,14 @@ public interface IObservableRepositoriesClient
         /// <returns>A <see cref="IReadOnlyPagedCollection{Repository}"/> of <see cref="Repository"/>.</returns>
         IObservable<Repository> GetAllForOrg(string organization, ApiOptions options);
 
+        /// <summary>
+        /// Access GitHub's Repository Actions API.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions">API documentation</a> for more details.
+        /// </remarks>
+        IObservableRepositoryActionsClient Actions { get; }
+
         /// <summary>
         /// Client for managing branches in a repository.
         /// </summary>

Octokit.Reactive/Clients/IObservableRepositoryActionsClient.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Octokit.Reactive
+{
+    /// <summary>
+    /// A client for GitHub's Repository Actions API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="https://docs.github.com/en/rest/reference/actions">Repository Actions API documentation</a> for more details.
+    /// </remarks>
+    public interface IObservableRepositoryActionsClient
+    {
+        /// <summary>
+        /// Client for GitHub's Repository Actions API
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions">Deployments API documentation</a> for more details
+        /// </remarks>
+        IObservableRepositorySecretsClient Secrets { get; }
+    }
+}

Octokit.Reactive/Clients/IObservableRepositorySecretsClient.cs

@@ -0,0 +1,79 @@
+using System;
+using System.Collections.Generic;
+using System.Reactive;
+using System.Text;
+
+namespace Octokit.Reactive
+{
+    /// <summary>
+    /// A client for GitHub's Repository Secrets API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="http://developer.github.com/v3/actions/secrets/">Repository Secrets API documentation</a> for more details.
+    /// </remarks>
+    public interface IObservableRepositorySecretsClient
+    {
+        /// <summary>
+        /// Get the public signing key to encrypt secrets for a repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#get-a-repository-public-key">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repoName">The owner of the repository</param>
+        /// <param name="owner">The name of the repository</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="SecretsPublicKey"/> instance for the repository public key.</returns>
+        IObservable<SecretsPublicKey> GetPublicKey(string owner, string repoName);
+
+        /// <summary>
+        /// List the secrets for a repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#list-repository-secrets">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repoName">The owner of the repository</param>
+        /// <param name="owner">The name of the repository</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="IEnumerable{RepositorySecret}"/> instance for the list of repository secrets.</returns>
+        IObservable<RepositorySecretsCollection> GetAll(string owner, string repoName);
+
+        /// <summary>
+        /// Get a secret from a repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#get-a-repository-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repoName">The owner of the repository</param>
+        /// <param name="owner">The name of the repository</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="RepositorySecret"/> instance for the repository secret.</returns>
+        IObservable<RepositorySecret> Get(string owner, string repoName, string secretName);
+
+        /// <summary>
+        /// Create or update a secret in a repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#create-or-update-a-repository-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repoName">The owner of the repository</param>
+        /// <param name="owner">The name of the repository</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <param name="upsertSecret">The encrypted value and id of the encryption key</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="RepositorySecret"/> instance for the repository secret that was created or updated.</returns>
+        IObservable<RepositorySecret> CreateOrUpdate(string owner, string repoName, string secretName, UpsertRepositorySecret upsertSecret);
+
+        /// <summary>
+        /// Delete a secret in a repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#delete-a-repository-secret">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="repoName">The owner of the repository</param>
+        /// <param name="owner">The name of the repository</param>
+        /// <param name="secretName">The name of the secret</param>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        IObservable<Unit> Delete(string owner, string repoName, string secretName);
+    }
+}

Octokit.Reactive/Clients/ObservableOrganizationActionsClient.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Octokit.Reactive
+{
+    /// <summary>
+    /// A client for GitHub's Org Actions API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="https://docs.github.com/en/rest/reference/actions"> Actions API documentation</a> for more information.
+    /// </remarks>
+    public class ObservableOrganizationActionsClient : IObservableOrganizationActionsClient
+    {
+        readonly IOrganizationActionsClient _client;
+        readonly IConnection _connection;
+
+        /// <summary>
+        /// Initializes a new Organization API client.
+        /// </summary>
+        /// <param name="client">An <see cref="IGitHubClient" /> used to make the requests</param>
+        public ObservableOrganizationActionsClient(IGitHubClient client)
+        {
+            Ensure.ArgumentNotNull(client, nameof(client));
+
+            Secrets = new ObservableOrganizationSecretsClient(client);
+
+            _client = client.Organization.Actions;
+            _connection = client.Connection;
+        }
+
+        /// <summary>
+        /// Returns a client to manage organization secrets.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://docs.github.com/en/rest/reference/actions#secrets"> Secrets API documentation</a> for more information.
+        /// </remarks>
+        public IObservableOrganizationSecretsClient Secrets { get; private set; }
+    }
+}