No commit message

momentohq · Oct 6, 2022 · 6e91382 · 6e91382
2 parents 1591990 + 5581006
commit 6e91382
Show file tree

Hide file tree

Showing 18 changed files with 98 additions and 221 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -74,7 +74,6 @@ jobs:
           pushd examples
             dotnet build MomentoApplication
             dotnet run --project MomentoApplication
-            dotnet build MomentoApplicationPresignedUrl
           popd
         shell: bash
 

diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ To create a new .NET project and add the Momento client library as a dependency:
 ```bash
 mkdir my-momento-dotnet-project
 cd my-momento-dotnet-project
-dotnet new console 
+dotnet new console
 dotnet add package Momento.Sdk
 ```
 
@@ -47,19 +47,17 @@ Here is a quickstart you can use in your own project:
 ```csharp
 using System;
 using Momento.Sdk;
+using Momento.Sdk.Auth;
 using Momento.Sdk.Config;
 using Momento.Sdk.Responses;
 
-string? MOMENTO_AUTH_TOKEN = Environment.GetEnvironmentVariable("MOMENTO_AUTH_TOKEN");
-if (MOMENTO_AUTH_TOKEN == null) {
-    throw new Exception("Please set your 'MOMENTO_AUTH_TOKEN' environment variable.");
-}
+ICredentialProvider authProvider = new EnvMomentoTokenProvider("MOMENTO_AUTH_TOKEN");
 const string CACHE_NAME = "cache";
 const string KEY = "MyKey";
 const string VALUE = "MyData";
 const uint DEFAULT_TTL_SECONDS = 60;
 
-using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.Latest, MOMENTO_AUTH_TOKEN, DEFAULT_TTL_SECONDS))
+using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.Latest, authProvider, DEFAULT_TTL_SECONDS))
 {
     var createCacheResponse = await client.CreateCacheAsync(CACHE_NAME);
     if (createCacheResponse is CreateCacheResponse.Error createError) {
@@ -86,20 +84,24 @@ using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.La
 
 ```
 
+Note that the above code requires an environment variable named MOMENTO_AUTH_TOKEN which must
+be set to a valid [Momento authentication token](https://docs.momentohq.com/docs/getting-started#obtain-an-auth-token).
+
 ### Error Handling
 
-Error cases in Momento are surfaced to developers as part of the return values of the method calls, as opposed
-to by throwing exceptions.  This makes them more visible, and allows your IDE to be more helpful in ensuring that
-you've handled the ones you care about.  (For more on our philosophy about this, see our blog post on why
-[Exceptions are bugs](https://www.gomomento.com/blog/exceptions-are-bugs).  And send us any feedback you have!)
+Error that occur in calls to SimpleCacheClient methods are surfaced to developers as part of the return values of
+the calls, as opposed to by throwing exceptions.  This makes them more visible, and allows your IDE to be more
+helpful in ensuring that you've handled the ones you care about.  (For more on our philosophy about this, see our
+blog post on why [Exceptions are bugs](https://www.gomomento.com/blog/exceptions-are-bugs).  And send us any
+feedback you have!)
 
-The preferred way of interpreting the return values from the Momento .NET methods is using [Pattern matching](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching).  Here's a quick example:
+The preferred way of interpreting the return values from SimpleCacheClient methods is using [Pattern matching](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching).  Here's a quick example:
 
 ```csharp
 CacheGetResponse getResponse = await client.GetAsync(CACHE_NAME, KEY);
 if (getResponse is CacheGetResponse.Hit hitResponse)
 {
-    Console.WriteLine($"\nLookedup value: {hitResponse.String()}, Stored value: {VALUE}");
+    Console.WriteLine($"\nLooked up value: {hitResponse.ValueString}, Stored value: {VALUE}");
 } else {
       // you can handle other cases via pattern matching in `else if` blocks, or a default case
       // via the `else` block.  For each return value your IDE should be able to give you code
@@ -124,6 +126,9 @@ if (getResponse is CacheGetResponse.Error errorResponse)
 }
 ```
 
+Note that, outside of SimpleCacheClient responses, exceptions can occur and should be handled as usual. For example, trying to instantiate a SimpleCacheClient with an invalid authentication token will result in an
+IllegalArgumentException being thrown.
+
 ### Tuning
 
 Momento client-libraries provide pre-built configuration bundles out-of-the-box.  We want to do the hard work of

diff --git a/README.template.md b/README.template.md
@@ -18,7 +18,7 @@ To create a new .NET project and add the Momento client library as a dependency:
 ```bash
 mkdir my-momento-dotnet-project
 cd my-momento-dotnet-project
-dotnet new console 
+dotnet new console
 dotnet add package Momento.Sdk
 ```
 
@@ -32,20 +32,24 @@ Here is a quickstart you can use in your own project:
 {{ usageExampleCode }}
 ```
 
+Note that the above code requires an environment variable named MOMENTO_AUTH_TOKEN which must
+be set to a valid [Momento authentication token](https://docs.momentohq.com/docs/getting-started#obtain-an-auth-token).
+
 ### Error Handling
 
-Error cases in Momento are surfaced to developers as part of the return values of the method calls, as opposed
-to by throwing exceptions.  This makes them more visible, and allows your IDE to be more helpful in ensuring that
-you've handled the ones you care about.  (For more on our philosophy about this, see our blog post on why
-[Exceptions are bugs](https://www.gomomento.com/blog/exceptions-are-bugs).  And send us any feedback you have!)
+Error that occur in calls to SimpleCacheClient methods are surfaced to developers as part of the return values of
+the calls, as opposed to by throwing exceptions.  This makes them more visible, and allows your IDE to be more
+helpful in ensuring that you've handled the ones you care about.  (For more on our philosophy about this, see our
+blog post on why [Exceptions are bugs](https://www.gomomento.com/blog/exceptions-are-bugs).  And send us any
+feedback you have!)
 
-The preferred way of interpreting the return values from the Momento .NET methods is using [Pattern matching](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching).  Here's a quick example:
+The preferred way of interpreting the return values from SimpleCacheClient methods is using [Pattern matching](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/functional/pattern-matching).  Here's a quick example:
 
 ```csharp
 CacheGetResponse getResponse = await client.GetAsync(CACHE_NAME, KEY);
 if (getResponse is CacheGetResponse.Hit hitResponse)
 {
-    Console.WriteLine($"\nLookedup value: {hitResponse.String()}, Stored value: {VALUE}");
+    Console.WriteLine($"\nLooked up value: {hitResponse.ValueString}, Stored value: {VALUE}");
 } else {
       // you can handle other cases via pattern matching in `else if` blocks, or a default case
       // via the `else` block.  For each return value your IDE should be able to give you code
@@ -70,6 +74,9 @@ if (getResponse is CacheGetResponse.Error errorResponse)
 }
 ```
 
+Note that, outside of SimpleCacheClient responses, exceptions can occur and should be handled as usual. For example, trying to instantiate a SimpleCacheClient with an invalid authentication token will result in an
+IllegalArgumentException being thrown.
+
 ### Tuning
 
 Momento client-libraries provide pre-built configuration bundles out-of-the-box.  We want to do the hard work of

diff --git a/examples/MomentoApplication/MomentoApplication.csproj b/examples/MomentoApplication/MomentoApplication.csproj
@@ -9,7 +9,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Momento.Sdk" Version="0.32.1" />
+    <PackageReference Include="Momento.Sdk" Version="0.33.0" />
   </ItemGroup>
   <ItemGroup>
     <None Remove="Microsoft.Extensions.Logging.Console" />

diff --git a/examples/MomentoApplication/Program.cs b/examples/MomentoApplication/Program.cs
@@ -2,20 +2,18 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using Momento.Sdk;
+using Momento.Sdk.Auth;
 using Momento.Sdk.Config;
 using Momento.Sdk.Exceptions;
 using Momento.Sdk.Responses;
 
-string? MOMENTO_AUTH_TOKEN = Environment.GetEnvironmentVariable("MOMENTO_AUTH_TOKEN");
-if (MOMENTO_AUTH_TOKEN == null) {
-    throw new System.Exception("Please set your 'MOMENTO_AUTH_TOKEN' environment variable.");
-}
+ICredentialProvider authProvider = new EnvMomentoTokenProvider("MOMENTO_AUTH_TOKEN");
 const string CACHE_NAME = "momento-example";
 const string KEY = "MyKey";
 const string VALUE = "MyData";
 const uint DEFAULT_TTL_SECONDS = 60;
 
-using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.Latest, MOMENTO_AUTH_TOKEN, DEFAULT_TTL_SECONDS))
+using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.Latest, authProvider, DEFAULT_TTL_SECONDS))
 {
     Console.WriteLine($"Creating cache {CACHE_NAME}");
     var createCacheResponse = await client.CreateCacheAsync(CACHE_NAME);

diff --git a/examples/MomentoApplicationPresignedUrl/MomentoApplicationPresignedUrl.csproj b/examples/MomentoApplicationPresignedUrl/MomentoApplicationPresignedUrl.csproj
diff --git a/examples/MomentoApplicationPresignedUrl/Program.cs b/examples/MomentoApplicationPresignedUrl/Program.cs
diff --git a/examples/MomentoApplicationPresignedUrlNet45/Program.cs b/examples/MomentoApplicationPresignedUrlNet45/Program.cs
diff --git a/examples/MomentoApplicationPresignedUrlNet45/README.md b/examples/MomentoApplicationPresignedUrlNet45/README.md
diff --git a/examples/MomentoUsage/MomentoUsage.csproj b/examples/MomentoUsage/MomentoUsage.csproj
@@ -11,6 +11,6 @@
     <None Remove="Momento.Sdk" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Momento.Sdk" Version="0.32.1" />
+    <PackageReference Include="Momento.Sdk" Version="0.33.0" />
   </ItemGroup>
 </Project>
diff --git a/examples/MomentoUsage/Program.cs b/examples/MomentoUsage/Program.cs
@@ -1,18 +1,16 @@
 using System;
 using Momento.Sdk;
+using Momento.Sdk.Auth;
 using Momento.Sdk.Config;
 using Momento.Sdk.Responses;
 
-string? MOMENTO_AUTH_TOKEN = Environment.GetEnvironmentVariable("MOMENTO_AUTH_TOKEN");
-if (MOMENTO_AUTH_TOKEN == null) {
-    throw new Exception("Please set your 'MOMENTO_AUTH_TOKEN' environment variable.");
-}
+ICredentialProvider authProvider = new EnvMomentoTokenProvider("MOMENTO_AUTH_TOKEN");
 const string CACHE_NAME = "cache";
 const string KEY = "MyKey";
 const string VALUE = "MyData";
 const uint DEFAULT_TTL_SECONDS = 60;
 
-using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.Latest, MOMENTO_AUTH_TOKEN, DEFAULT_TTL_SECONDS))
+using (SimpleCacheClient client = new SimpleCacheClient(Configurations.Laptop.Latest, authProvider, DEFAULT_TTL_SECONDS))
 {
     var createCacheResponse = await client.CreateCacheAsync(CACHE_NAME);
     if (createCacheResponse is CreateCacheResponse.Error createError) {