feat: Adding helper libraries for organization api and support for bearer token auth and no auth rest calls #751

AsabuHere · 2024-07-22T05:04:14Z

Fixes

A short description of what this PR does.
Adding helper libraries for organization api and support for bearer token auth and no auth rest calls

Checklist

I acknowledge that all my contributions will be made under the project's license
I have made a material change to the repo (functionality, testing, spelling, grammar)
I have read the Contribution Guidelines and my PR follows them
I have titled the PR appropriately
I have updated my branch with the main branch
I have added tests that prove my fix is effective or that my feature works
I have added the necessary documentation about the functionality in the appropriate .md file
I have added inline documentation to the code I modified

If you have questions, please file a support ticket, or create a GitHub Issue in this repository.

sonarcloud · 2024-07-22T05:08:08Z

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)
35.7% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

sbansla · 2024-07-29T09:28:38Z

src/Twilio/Clients/NoAuth/TwilioNoAuthRestClient.cs

+        ///
+        /// <param name="accessToken">access token for requests</param>
+        /// <param name="accountSid">account sid to make requests for</param>
+        /// <param name="region">region to make requests for</param>


Do we need to accessToken and accountSid here ?

No, removed

sbansla · 2024-07-29T11:36:57Z

src/Twilio/Clients/BearerToken/TwilioBearerTokenRestClient.cs

+        /// <param name="region">region to make requests for</param>
+        /// <param name="httpClient">http client used to make the requests</param>
+        /// <param name="edge">edge to make requests for</param>
+        public TwilioBearerTokenRestClient(


comments can be corrected.

sbansla · 2024-07-29T11:38:34Z

src/Twilio/Clients/BearerToken/TwilioBearerTokenRestClient.cs

+        /// <summary>
+        /// Twilio region to make requests to
+        /// </summary>
+        public string Region { get; }


Customer has to set region and Edge for each client, try to check how can we improve, so that customer only need to set Region and Edge only once and it can be re-used for each client.
Note: It should not break exist customer code.

sbansla · 2024-07-29T11:40:30Z

src/Twilio/Clients/BearerToken/TwilioBearerTokenRestClient.cs

+//            var expirationTime = jwtToken.Payload.Exp.HasValue
+//                        ? DateTimeOffset.FromUnixTimeSeconds(jwtToken.Payload.Exp.Value)
+//                        : DateTimeOffset.MinValue;
+//           return expirationTime <= DateTimeOffset.UtcNow;


Make sure that this gives same result, irrespective of system time.
Example: If run on system with IST time zone and if run on different time zone, result should not vary.

this function implementation is bit tricky, tracked as a different ticket in next sprint

sbansla · 2024-07-29T11:42:49Z

src/Twilio/TwilioOrgsTokenAuth.cs

+    /// Default Twilio Client for bearer token authentication
+    /// </summary>
+    public class TwilioOrgsTokenAuthClient
+    {


Name should be consistent 'TwilioOrgsTokenAuthClient'
Either Bearer or Orgs.

named bearer for all classes which is generic for token authentication. This class is named specific to orgs because this fetched the access token passing client id, client secret and grant type.
The classes with name bearer in it can be re used with another client class which fetches token passing some other parameters?

Please suggest if this needs to be renamed to bearer?

sbansla · 2024-07-29T12:35:59Z

src/Twilio/TwilioNoAuth.cs

+                return _restClient;
+            }
+
+            _restClient = new TwilioNoAuthRestClient(region: _region, edge: _edge)


If customer has set region and edge in TwilioOrgsRestClient, then NoAuthClient call should also go to provided region and edge.
In short, customer won't be initialising TwilioNoAuthRestClient.
Also think, do we need TwilioNoAuthRestClient ?
Check this in java as well.

we might be able to use no auth client, but even when customer only wants to do a rest call without auth, he/she should pass username and password. is this fine? if yes we can remove the no auth class

sbansla · 2024-07-29T12:42:59Z

src/Twilio/TwilioNoAuth.cs

+
+            _restClient = new TwilioNoAuthRestClient(region: _region, edge: _edge)
+            {
+                LogLevel = _logLevel


_logLevel is not set in this file.
Make sure _logLevel is fetched from TwilioOrgsTokenAuth

added function to set log level here, should we make these classes dependent on each other? is that design fine?

sbansla · 2024-07-29T12:54:45Z

src/Twilio/Http/BearerToken/SystemNetBearerTokenHttpClient.cs

+            var authBytes = request.AccessToken;
+            httpRequest.Headers.Authorization = new AuthenticationHeaderValue("Bearer", authBytes);
+
+            httpRequest.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));


application/json this should come from API instead of setting it here application/json for all APIs.

for the time being we support only application/json should we add support for all types? please suggest

sbansla · 2024-07-31T04:23:26Z

src/Twilio/Http/BearerToken/SystemNetBearerTokenHttpClient.cs

+                    httpRequest.Content = new StringContent(request.Body, Encoding.UTF8, "application/json");
+
+                else if (Equals(request.ContentType, EnumConstants.ContentTypeEnum.SCIM))
+                    httpRequest.Content = new StringContent(request.Body, Encoding.UTF8, "application/scim");


Check if there is any SCIM type request.

* Adding jwt token expiry check function * Adding jwt token expiry check function * sharing variables between clients * sharing variables between clients

sbansla · 2024-09-03T11:35:06Z

src/Twilio/TwilioNoAuth.cs

+    /// <summary>
+    /// Default Twilio Client
+    /// </summary>
+    public class TwilioNoAuthClient


Discussed over call, Athira will check if we remove this class, what is the downside as we are not taking input from customer.

sbansla · 2024-09-03T11:35:19Z

src/Twilio/TwilioOrgsTokenAuth.cs

+        private static TwilioBearerTokenRestClient _restClient;
+        private static string _logLevel;
+        private static TokenManager _tokenManager;
+        private static ClientProperties clientProperties;


ClientProperties can be removed

sbansla · 2024-09-03T11:36:03Z

src/Twilio/TwilioOrgsTokenAuth.cs

+    {
+        private static string _accessToken;
+        private static string _region;
+        private static string _edge;


private static variables can be access outside of class ? If yes, then either these should be only static or private.

sbansla · 2024-09-03T11:49:25Z

src/Twilio/TwilioOrgsTokenAuth.cs

+        public static void Init(string grantType, string clientId, string clientSecret)
+        {
+            validateCredentials(grantType, clientId, clientSecret);
+            _tokenManager = new OrgsTokenManager(grantType, clientId, clientSecret);


Steps.

Init

Call Orgs API

Init with different client_id and client_secret.

call Orgs API
It should pick new client_id and client_secret

…en manager

sonarcloud · 2024-09-23T08:10:30Z

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)
33.5% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

Changes for orgs api uptake

6f6cd97

sbansla reviewed Jul 29, 2024

View reviewed changes

AsabuHere and others added 6 commits July 31, 2024 08:09

uptake of review comments

5667bec

adding examples for bearer token authentication

a769eac

Update documentation for bearer token auth rest calls

4816bc8

Update README.md

78ac734

Update README.md

388a4c3

Update BearerTokenAuthentication.md

c5b46b4

sbansla reviewed Jul 31, 2024

View reviewed changes

fix: Adding jwt token expiry check function (#754)

ed6f6b2

* Adding jwt token expiry check function * Adding jwt token expiry check function * sharing variables between clients * sharing variables between clients

sbansla reviewed Sep 3, 2024

View reviewed changes

AsabuHere added 8 commits September 3, 2024 18:52

review comments uptake

04e9e31

Renaming TwilioBearerTokenAuthClient to TwilioOrgsTokenAuthClient

692e59d

hardcoding client credentials

3e03444

invalidate rest clients on change of client id, client secret and tok…

b4d23b1

…en manager

Rename Request classes

e72b107

Renaming resourceset

eb6a2bd

renaming http clients

cfa2eb9

adding dependencies

10c9f08

AsabuHere added 4 commits September 23, 2024 12:57

Changes to make previewiam version less

1e5926c

Marking the new feature as Beta

5fda91d

Adding to domain file

0516f4a

Adding to domain file

0e04987

AsabuHere closed this Sep 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adding helper libraries for organization api and support for bearer token auth and no auth rest calls #751

feat: Adding helper libraries for organization api and support for bearer token auth and no auth rest calls #751

AsabuHere commented Jul 22, 2024

sonarcloud bot commented Jul 22, 2024

sbansla Jul 29, 2024

AsabuHere Jul 31, 2024

sbansla Jul 29, 2024

AsabuHere Jul 31, 2024

sbansla Jul 29, 2024 •

edited

Loading

sbansla Jul 29, 2024

AsabuHere Jul 31, 2024

sbansla Jul 29, 2024

AsabuHere Jul 31, 2024

sbansla Jul 29, 2024 •

edited

Loading

AsabuHere Jul 31, 2024

sbansla Jul 29, 2024

AsabuHere Jul 31, 2024

sbansla Jul 29, 2024

AsabuHere Jul 31, 2024

sbansla Jul 31, 2024

sbansla Sep 3, 2024

sbansla Sep 3, 2024

sbansla Sep 3, 2024

sbansla Sep 3, 2024

sonarcloud bot commented Sep 23, 2024

feat: Adding helper libraries for organization api and support for bearer token auth and no auth rest calls #751

feat: Adding helper libraries for organization api and support for bearer token auth and no auth rest calls #751

Conversation

AsabuHere commented Jul 22, 2024

Fixes

Checklist

sonarcloud bot commented Jul 22, 2024

Quality Gate failed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbansla Jul 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbansla Jul 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Sep 23, 2024

Quality Gate failed

sbansla Jul 29, 2024 •

edited

Loading

sbansla Jul 29, 2024 •

edited

Loading