-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
520 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,85 @@ | ||
| # ZoomNet | ||
| # ZoomNet | ||
|
|
||
| [](http://jericho.mit-license.org/) | ||
| [](https://github.com/dotnet/sourcelink) | ||
|
|
||
| [](https://ci.appveyor.com/project/Jericho/zoomnet) | ||
| [](https://ci.appveyor.com/project/jericho/zoomnet/build/tests) | ||
| [](https://coveralls.io/github/Jericho/ZoomNet?branch=master) | ||
| [](https://www.codefactor.io/repository/github/jericho/zoomnet) | ||
|
|
||
| | Release Notes| NuGet (stable) | MyGet (prerelease) | | ||
| |--------------|----------------|--------------------| | ||
| | [](https://github.com/Jericho/ZoomNet/releases) | [](https://www.nuget.org/packages/ZoomNet/) | [](http://myget.org/gallery/jericho) | | ||
|
|
||
|
|
||
| ## About | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| The easiest way to include ZoomNet in your C# project is by adding the nuget package to your project: | ||
|
|
||
| ``` | ||
| PM> Install-Package ZoomNet | ||
| ``` | ||
|
|
||
| ## .NET framework suport | ||
|
|
||
| StrongGrid supports the `4.6.1` .NET framework as well as any framework supporting `.NET Standard 2.0` (which includes `.NET 4.7.2`, `.NET 4.8`, `.NET Core 2.x`, `.NET Core 3.x`,` ASP.NET Core 2.x` and `ASP.NET Core 3.x`). | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ### Connection Information | ||
| Before you start using the ZoomNet client, you must decide how you are going to connect to the Zoom API. ZoomNet supports two distinct ways of connecting to Zoom: JWT and OAuth. | ||
|
|
||
| #### Connection using JWT | ||
| This is the simplest way to connect to the Zoom API. Zoom expects you to use a key and a secret to generate a JSON object with a signed payload and to provide this JSON object with every API request. The good news is that ZoomNet takes care of the intricacies of generating this JSON object: you simply provide the key and the secret and ZommNet takes care of the rest. Super easy! | ||
|
|
||
| As the Zoom documentation mentions, this is perfect `if you’re looking to build an app that provides server-to-server interaction with Zoom APIs`. | ||
|
|
||
| Here is an except from the Zoom documentation that explains [how to get your API key and secret](https://marketplace.zoom.us/docs/guides/auth/jwt#key-secret): | ||
|
|
||
| > JWT apps provide an API Key and Secret required to authenticate with JWT. To access the API Key and Secret, Create a JWT App on the Marketplace. After providing basic information about your app, locate your API Key and Secret in the App Credentials page. | ||
| When you have the API key and secret, you can instantiate a 'connection info' object like so: | ||
| ```csharp | ||
| var apiKey = "... your API key ..."; | ||
| var apiSecret = "... your API secret ..."; | ||
| var connectionInfo = new JwtConnectionInfo(apiKey, apiSecret); | ||
| ``` | ||
|
|
||
| #### Connection using OAuth | ||
| Using OAuth is much more complicated than using JWT but at the same time, it is more flexible because you can define which permissions your app requires. When a user installs your app, they are presented with the list of permission your app requires and the are given the opportunity to accept. | ||
|
|
||
| The Zoom documentation has a document about [how to create an OAuth app](https://marketplace.zoom.us/docs/guides/build/oauth-app) and another document about the [OAuth autorization flow](https://marketplace.zoom.us/docs/guides/auth/oauth) but I personnality was very confused by the later document so here is a brief step-by-step summary: | ||
| - you create an OAuth app, define which permissions your app requires and publish the app in the Zoom marketplace. | ||
| - user installs your app. During installation, user is presentd with a screen listing the permissons your app requires. User must click `accept`. | ||
| - Zoom generates a "authorization code". This code can be used only once to generate the first access token and refresh token. I CAN'T STRESS THIS ENOUGH: the autorization code can be used only one time. This was the confusing part to me: somehow I didn't understand that this code could be used only one time and I was attempting to use it repeatedly. Zoom would accept the code one time and would reject it subsequently, which lead to many hours of frustration while trying to figure out why the code was sometimes rejected. | ||
| - The access token is valid for 60 minutes and must therefore be "refreshed" periodically. | ||
|
|
||
| ZoomNet takes care of generating the access token and refresh token but it's your responsability to store these generated values. | ||
|
|
||
| ```csharp | ||
| var clientId = "... your client ID ..."; | ||
| var clientSecret = "... your client secret ..."; | ||
| var refreshToken = "... the refresh token previously issued by Zoom ..."; | ||
| var accessToken = "... the access token previously issued by Zoom ..."; | ||
| var connectionInfo = new OAuthConnectionInfo(clientId, clientSecret, refreshToken, accessToken, | ||
| (newRefreshToken, newAccessToken) => | ||
| { | ||
| /* | ||
| Save the new refresh token and the access token to | ||
| a safe place so you can provide it the next time | ||
| you need to instantiate an OAuthConnectionInfo | ||
| */ | ||
| }); | ||
| ``` | ||
|
|
||
| ### Client | ||
|
|
||
| You declare your client variable like so: | ||
| ```csharp | ||
| var zoomClient = new ZoomClient(connectionInfo); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| using Moq; | ||
| using System; | ||
| using ZoomNet.Utilities; | ||
|
|
||
| namespace ZoomNet.UnitTests | ||
| { | ||
| internal class MockSystemClock : Mock<ISystemClock> | ||
| { | ||
| public MockSystemClock(DateTime currentDateTime) : | ||
| this(currentDateTime.Year, currentDateTime.Month, currentDateTime.Day, currentDateTime.Hour, currentDateTime.Minute, currentDateTime.Second, currentDateTime.Millisecond) | ||
| { } | ||
|
|
||
| public MockSystemClock(int year, int month, int day, int hour, int minute, int second, int millisecond) : | ||
| base(MockBehavior.Strict) | ||
| { | ||
| SetupGet(m => m.Now).Returns(new DateTime(year, month, day, hour, minute, second, millisecond, DateTimeKind.Utc)); | ||
| SetupGet(m => m.UtcNow).Returns(new DateTime(year, month, day, hour, minute, second, millisecond, DateTimeKind.Utc)); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| using Microsoft.Extensions.Logging; | ||
| using Pathoschild.Http.Client; | ||
| using Pathoschild.Http.Client.Extensibility; | ||
| using RichardSzalay.MockHttp; | ||
| using System; | ||
| using System.Linq; | ||
| using ZoomNet.Utilities; | ||
|
|
||
| namespace ZoomNet.UnitTests | ||
| { | ||
| public static class Utils | ||
| { | ||
| private const string ZOOM_V2_BASE_URI = "https://api.zoom.us/v2"; | ||
|
|
||
| public static Pathoschild.Http.Client.IClient GetFluentClient(MockHttpMessageHandler httpMessageHandler) | ||
| { | ||
| var httpClient = httpMessageHandler.ToHttpClient(); | ||
| var client = new FluentClient(new Uri(ZOOM_V2_BASE_URI), httpClient); | ||
| client.SetRequestCoordinator(new ZoomRetryCoordinator(new Http429RetryStrategy(), null)); | ||
| client.Filters.Remove<DefaultErrorFilter>(); | ||
| client.Filters.Add(new DiagnosticHandler(LogLevel.Debug, LogLevel.Error)); | ||
| client.Filters.Add(new ZoomErrorHandler()); | ||
|
|
||
| return client; | ||
| } | ||
|
|
||
| public static string GetZoomApiUri(params object[] resources) | ||
| { | ||
| return resources.Aggregate(ZOOM_V2_BASE_URI, (current, path) => $"{current.TrimEnd('/')}/{path.ToString().TrimStart('/')}"); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| using Shouldly; | ||
| using System; | ||
| using System.Net; | ||
| using Xunit; | ||
|
|
||
| namespace ZoomNet.UnitTests | ||
| { | ||
| public class ZoomClientTests | ||
| { | ||
| private const string API_KEY = "my_api_key"; | ||
| private const string API_SECRET = "my_api_secret"; | ||
|
|
||
| [Fact] | ||
| public void Version_is_not_empty() | ||
| { | ||
| // Arrange | ||
|
|
||
| // Act | ||
| var result = ZoomClient.Version; | ||
|
|
||
| // Assert | ||
| result.ShouldNotBeNullOrEmpty(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void Dispose() | ||
| { | ||
| // Arrange | ||
| var connectionInfo = new JwtConnectionInfo(API_KEY, API_SECRET); | ||
| var client = new ZoomClient(connectionInfo, (IWebProxy)null); | ||
|
|
||
| // Act | ||
| client.Dispose(); | ||
|
|
||
| // Assert | ||
| // Nothing to assert. We just want to confirm that 'Dispose' did not throw any exception | ||
| } | ||
|
|
||
| [Fact] | ||
| public void Throws_if_apikey_is_null() | ||
| { | ||
| Should.Throw<ArgumentNullException>(() => new ZoomClient(new JwtConnectionInfo(null, API_SECRET))); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.