Merge pull request #8 from configcat/sdkkey

Sdkkey
configcat · Apr 9, 2020 · 60e0cac · 60e0cac
2 parents 4f81547 + caab1cf
commit 60e0cac
Show file tree

Hide file tree

Showing 16 changed files with 68 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -34,12 +34,12 @@ dotnet add package ConfigCat.Client
 using ConfigCat.Client;
 ```
 
-### 3. Go to <a href="https://app.configcat.com/connect" target="_blank">Connect your application</a> tab to get your *API Key*:
-![API-KEY](https://raw.githubusercontent.com/ConfigCat/.net-sdk/master/media/readme01.png  "API-KEY")
+### 3. Go to <a href="https://app.configcat.com/sdkkey" target="_blank">Connect your application</a> tab to get your *SDK Key*:
+![SDK-KEY](https://raw.githubusercontent.com/ConfigCat/.net-sdk/master/media/readme01.png  "SDK-KEY")
 
 ### 4. Create a **ConfigCat** client instance:
 ```c#
-var client = new ConfigCatClient("#YOUR-API-KEY#");
+var client = new ConfigCatClient("#YOUR-SDK-KEY#");
 ```
 
 > We strongly recommend using the *ConfigCat Client* as a Singleton object in your application.
@@ -84,8 +84,8 @@ var isMyAwesomeFeatureEnabled = client.GetValue(
 ## Polling Modes
 The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at [ConfigCat Docs](https://docs.configcat.com/docs/sdk-reference/csharp/).
 
-## Support
-If you need help how to use this SDK feel free to to contact the ConfigCat Staff on https://configcat.com. We're happy to help.
+## Need help?
+https://configcat.com/support
 
 ## Contributing
 Contributions are welcome.

diff --git a/media/readme01.png b/media/readme01.png
diff --git a/samples/ASP.NETCore/WebApplication/Startup.cs b/samples/ASP.NETCore/WebApplication/Startup.cs
@@ -23,7 +23,7 @@ public void ConfigureServices(IServiceCollection services)
 
             var configCatClient = new ConfigCatClient(new LazyLoadConfiguration
             {
-                ApiKey = Configuration["ConfigCatApiKey"],
+                SdkKey = Configuration["ConfigCatSdkKey"],
                 CacheTimeToLiveSeconds = 120
             });
             configCatClient.LogLevel = LogLevel.Info;

diff --git a/samples/ASP.NETCore/WebApplication/appsettings.json b/samples/ASP.NETCore/WebApplication/appsettings.json
@@ -5,6 +5,6 @@
       "Default": "Warning"
     }
   },
-  "ConfigCatApiKey": "PKDVCLf-Hq-h-kCzMp-L7Q/HhOWfwVtZ0mb30i9wi17GQ"
+  "ConfigCatSdkKey": "PKDVCLf-Hq-h-kCzMp-L7Q/HhOWfwVtZ0mb30i9wi17GQ"
 
 }
diff --git a/samples/ConsoleApp/Program.cs b/samples/ConsoleApp/Program.cs
@@ -7,7 +7,7 @@ class Program
     {
         static void Main(string[] args)
         {
-            // Creating the ConfigCat client instance using the API key
+            // Creating the ConfigCat client instance using the SDK Key
             var client = new ConfigCatClient("PKDVCLf-Hq-h-kCzMp-L7Q/HhOWfwVtZ0mb30i9wi17GQ");
 
             // Setting log level to Info to show detailed feature flag evaluation

diff --git a/samples/FileLoggerSample.cs b/samples/FileLoggerSample.cs
@@ -54,7 +54,7 @@ static void Main(string[] args)
 
             var clientConfiguration = new AutoPollConfiguration
             {
-                ApiKey = "YOUR-API-KEY",
+                SdkKey = "YOUR-SDK-KEY",
                 Logger = new MyFileLogger(filePath, logLevel),
                 PollIntervalSeconds = 5
             };

diff --git a/src/ConfigCat.Client.Tests/BaseUrlTests.cs b/src/ConfigCat.Client.Tests/BaseUrlTests.cs
@@ -6,23 +6,23 @@ namespace ConfigCat.Client.Tests
     [TestClass]
     public class BaseUrlTests
     {
-        private const string APIKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
+        private const string SDKKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
 
         private readonly Uri workingBaseUrl = new Uri("https://cdn.configcat.com");
         private readonly Uri notWorkingBaseUrl = new Uri("https://thiswillnotwork.configcat.com");
 
         [TestMethod]
         public void BaseUrl_Override_AutoPoll_Works()
         {
-            var client = ConfigCatClientBuilder.Initialize(APIKEY)
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithAutoPoll()
                 .WithBaseUrl(workingBaseUrl)
                 .Create();
 
             var actual = client.GetValue("stringDefaultCat", "N/A");
             Assert.AreEqual("Cat", actual);
 
-            client = ConfigCatClientBuilder.Initialize(APIKEY)
+            client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithAutoPoll()
                 .WithBaseUrl(notWorkingBaseUrl)
                 .Create();
@@ -34,15 +34,15 @@ public void BaseUrl_Override_AutoPoll_Works()
         [TestMethod]
         public void BaseUrl_Override_ManualPoll_Works()
         {
-            var client = ConfigCatClientBuilder.Initialize(APIKEY)
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithManualPoll()
                 .WithBaseUrl(workingBaseUrl)
                 .Create();
             client.ForceRefresh();
             var actual = client.GetValue("stringDefaultCat", "N/A");
             Assert.AreEqual("Cat", actual);
 
-            client = ConfigCatClientBuilder.Initialize(APIKEY)
+            client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithManualPoll()
                 .WithBaseUrl(notWorkingBaseUrl)
                 .Create();
@@ -54,15 +54,15 @@ public void BaseUrl_Override_ManualPoll_Works()
         [TestMethod]
         public void BaseUrl_Override_LazyLoad_Works()
         {
-            var client = ConfigCatClientBuilder.Initialize(APIKEY)
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithLazyLoad()
                 .WithBaseUrl(workingBaseUrl)
                 .Create();
 
             var actual = client.GetValue("stringDefaultCat", "N/A");
             Assert.AreEqual("Cat", actual);
 
-            client = ConfigCatClientBuilder.Initialize(APIKEY)
+            client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithLazyLoad()
                 .WithBaseUrl(notWorkingBaseUrl)
                 .Create();

diff --git a/src/ConfigCat.Client.Tests/BasicConfigCatClientIntegrationTests.cs b/src/ConfigCat.Client.Tests/BasicConfigCatClientIntegrationTests.cs
@@ -10,9 +10,9 @@ namespace ConfigCat.Client.Tests
     [TestClass]
     public class BasicConfigCatClientIntegrationTests 
     {
-        private const string APIKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
+        private const string SDKKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
 
-        private static readonly IConfigCatClient client = new ConfigCatClient(APIKEY);
+        private static readonly IConfigCatClient client = new ConfigCatClient(SDKKEY);
 
         private static readonly ILogger consoleLogger = new ConsoleLogger(LogLevel.Debug);
 
@@ -26,7 +26,7 @@ public static void ClassCleanup()
         public void ManualPollGetValue()
         {
             IConfigCatClient manualPollClient = ConfigCatClientBuilder
-                .Initialize(APIKEY)                
+                .Initialize(SDKKEY)                
                 .WithLogger(consoleLogger)
                 .WithManualPoll()
                 .Create();
@@ -40,7 +40,7 @@ public void ManualPollGetValue()
         public void AutoPollGetValue()
         {
             IConfigCatClient client = ConfigCatClientBuilder
-                .Initialize(APIKEY)
+                .Initialize(SDKKEY)
                 .WithLogger(consoleLogger)
                 .WithAutoPoll()
                 .WithMaxInitWaitTimeSeconds(30)
@@ -54,7 +54,7 @@ public void AutoPollGetValue()
         public void LazyLoadGetValue()
         {
             IConfigCatClient client = ConfigCatClientBuilder
-                .Initialize(APIKEY)
+                .Initialize(SDKKEY)
                 .WithLogger(consoleLogger)
                 .WithLazyLoad()
                 .WithCacheTimeToLiveSeconds(30)
@@ -67,7 +67,7 @@ public void LazyLoadGetValue()
         public async Task ManualPollGetValueAsync()
         {
             IConfigCatClient client = ConfigCatClientBuilder
-                .Initialize(APIKEY)
+                .Initialize(SDKKEY)
                 .WithLogger(consoleLogger)
                 .WithManualPoll()
                 .Create();
@@ -81,7 +81,7 @@ public async Task ManualPollGetValueAsync()
         public async Task AutoPollGetValueAsync()
         {
             IConfigCatClient client = ConfigCatClientBuilder
-                .Initialize(APIKEY)
+                .Initialize(SDKKEY)
                 .WithLogger(consoleLogger)
                 .WithAutoPoll()
                 .WithMaxInitWaitTimeSeconds(30)
@@ -95,7 +95,7 @@ public async Task AutoPollGetValueAsync()
         public async Task LazyLoadGetValueAsync()
         {
             IConfigCatClient client = ConfigCatClientBuilder
-                .Initialize(APIKEY)
+                .Initialize(SDKKEY)
                 .WithLogger(consoleLogger)
                 .WithLazyLoad()
                 .WithCacheTimeToLiveSeconds(30)
@@ -108,7 +108,7 @@ public async Task LazyLoadGetValueAsync()
         public void GetAllKeys()
         {
             IConfigCatClient manualPollClient = ConfigCatClientBuilder
-                .Initialize(APIKEY)
+                .Initialize(SDKKEY)
                 .WithLogger(consoleLogger)
                 .WithManualPoll()
                 .Create();

diff --git a/src/ConfigCat.Client.Tests/ConfigCacheTests.cs b/src/ConfigCat.Client.Tests/ConfigCacheTests.cs
@@ -6,7 +6,7 @@ namespace ConfigCat.Client.Tests
     [TestClass]
     public class ConfigCacheTests
     {
-        private const string APIKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
+        private const string SDKKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
 
         [TestMethod]
         public void ConfigCache_Override_AutoPoll_Works()
@@ -20,7 +20,7 @@ public void ConfigCache_Override_AutoPoll_Works()
 
             configCacheMock.Setup(c => c.Get()).Returns(() => cachedConfig);
 
-            var client = ConfigCatClientBuilder.Initialize(APIKEY).WithAutoPoll().WithConfigCache(configCacheMock.Object).Create();
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY).WithAutoPoll().WithConfigCache(configCacheMock.Object).Create();
 
             var actual = client.GetValue("stringDefaultCat", "N/A");
             Assert.AreEqual("Cat", actual);
@@ -41,7 +41,7 @@ public void ConfigCache_Override_ManualPoll_Works()
 
             configCacheMock.Setup(c => c.Get()).Returns(() => cachedConfig);
 
-            var client = ConfigCatClientBuilder.Initialize(APIKEY).WithManualPoll().WithConfigCache(configCacheMock.Object).Create();
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY).WithManualPoll().WithConfigCache(configCacheMock.Object).Create();
 
             configCacheMock.Verify(c => c.Set(It.IsAny<ProjectConfig>()), Times.Never);
             configCacheMock.Verify(c => c.Get(), Times.Never);
@@ -71,7 +71,7 @@ public void ConfigCache_Override_LazyLoad_Works()
 
             configCacheMock.Setup(c => c.Get()).Returns(() => cachedConfig);
 
-            var client = ConfigCatClientBuilder.Initialize(APIKEY).WithLazyLoad().WithConfigCache(configCacheMock.Object).Create();
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY).WithLazyLoad().WithConfigCache(configCacheMock.Object).Create();
 
             var actual = client.GetValue("stringDefaultCat", "N/A");
             Assert.AreEqual("Cat", actual);

diff --git a/src/ConfigCat.Client.Tests/ConfigCatClientTests.cs b/src/ConfigCat.Client.Tests/ConfigCatClientTests.cs
@@ -29,29 +29,29 @@ public void TestInitialize()
 
         [ExpectedException(typeof(ArgumentException))]
         [TestMethod]
-        public void CreateAnInstance_WhenApiKeyIsEmpty_ShouldThrowArgumentNullException()
+        public void CreateAnInstance_WhenSdkKeyIsEmpty_ShouldThrowArgumentNullException()
         {
-            string apiKey = string.Empty;
+            string sdkKey = string.Empty;
 
-            new ConfigCatClient(apiKey);
+            new ConfigCatClient(sdkKey);
         }
 
         [ExpectedException(typeof(ArgumentException))]
         [TestMethod]
-        public void CreateAnInstance_WhenApiKeyIsNull_ShouldThrowArgumentNullException()
+        public void CreateAnInstance_WhenSdkKeyIsNull_ShouldThrowArgumentNullException()
         {
-            string apiKey = null;
+            string sdkKey = null;
 
-            new ConfigCatClient(apiKey);
+            new ConfigCatClient(sdkKey);
         }
 
         [ExpectedException(typeof(ArgumentException))]
         [TestMethod]
-        public void CreateAnInstance_WhenAutoPollConfigurationApiKeyIsNull_ShouldThrowArgumentNullException()
+        public void CreateAnInstance_WhenAutoPollConfigurationSdkKeyIsNull_ShouldThrowArgumentNullException()
         {
             var clientConfiguration = new AutoPollConfiguration
             {
-                ApiKey = null
+                SdkKey = null
             };
 
             new ConfigCatClient(clientConfiguration);
@@ -63,7 +63,7 @@ public void CreateAnInstance_WhenAutoPollConfigurationPollIntervalsZero_ShouldTh
         {
             var clientConfiguration = new AutoPollConfiguration
             {
-                ApiKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf",
+                SdkKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf",
                 PollIntervalSeconds = 0
             };
 
@@ -72,11 +72,11 @@ public void CreateAnInstance_WhenAutoPollConfigurationPollIntervalsZero_ShouldTh
 
         [ExpectedException(typeof(ArgumentException))]
         [TestMethod]
-        public void CreateAnInstance_WhenConfigurationApiKeyIsEmpty_ShouldThrowArgumentNullException()
+        public void CreateAnInstance_WhenConfigurationSdkKeyIsEmpty_ShouldThrowArgumentNullException()
         {
             var clientConfiguration = new AutoPollConfiguration
             {
-                ApiKey = string.Empty
+                SdkKey = string.Empty
             };
 
             new ConfigCatClient(clientConfiguration);
@@ -88,7 +88,7 @@ public void CreateAnInstance_WhenLazyLoadConfigurationTimeToLiveSecondsIsZero_Sh
         {
             var clientConfiguration = new LazyLoadConfiguration
             {
-                ApiKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf",
+                SdkKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf",
                 CacheTimeToLiveSeconds = 0
             };
 
@@ -128,7 +128,7 @@ public void CreateAnInstance_WhenLoggerIsNull_ShouldThrowArgumentNullException()
         {
             var clientConfiguration = new AutoPollConfiguration
             {
-                ApiKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf",
+                SdkKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf",
                 Logger = null
             };
 
@@ -141,24 +141,24 @@ public void CreateAnInstance_WithValidConfiguration_ShouldCreateAnInstance()
         {
             var config = new AutoPollConfiguration
             {
-                ApiKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf"
+                SdkKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf"
             };
 
             new ConfigCatClient(config);
         }
 
         [TestMethod]
-        public void CreateAnInstance_WithApiKey_ShouldCreateAnInstance()
+        public void CreateAnInstance_WithSdkKey_ShouldCreateAnInstance()
         {
-            string apiKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf";
+            string sdkKey = "hsdrTr4sxbHdSgdhHRZds346hdgsS2vfsgf/GsdrTr4sxbHdSgdhHRZds346hdOPsSgvfsgf";
 
-            new ConfigCatClient(apiKey);
+            new ConfigCatClient(sdkKey);
         }
 
         [TestMethod]
         public void CreateConfigurationBuilderInstance_ShouldCreateAnInstance()
         {
-            var builder = ConfigCatClient.Create("APIKEY");
+            var builder = ConfigCatClient.Create("SDKKEY");
 
             Assert.IsNotNull(builder);
         }

diff --git a/src/ConfigCat.Client.Tests/CustomHttpClientHandlerTests.cs b/src/ConfigCat.Client.Tests/CustomHttpClientHandlerTests.cs
@@ -7,7 +7,7 @@ namespace ConfigCat.Client.Tests
     [TestClass]
     public class CustomHttpClientHandlerTests
     {
-        private const string APIKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
+        private const string SDKKEY = "PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A";
         private readonly MyHttpClientHandler httpClientHandler = new MyHttpClientHandler();
 
         [TestInitialize]
@@ -21,7 +21,7 @@ public void AutoPoll_WithHttpClientHandlerOverride_ShouldReturnCatUseCustomImple
         {
             // Arrange
 
-            var client = ConfigCatClientBuilder.Initialize(APIKEY)
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithAutoPoll()
                 .WithHttpClientHandler(httpClientHandler)
                 .Create();
@@ -41,7 +41,7 @@ public void ManualPoll_WithHttpClientHandlerOverride_ShouldReturnCatUseCustomImp
         {
             // Arrange
 
-            var client = ConfigCatClientBuilder.Initialize(APIKEY)
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithManualPoll()
                 .WithHttpClientHandler(httpClientHandler)
                 .Create();
@@ -62,7 +62,7 @@ public void LazyLoad_WithHttpClientHandlerOverride_ShouldReturnCatUseCustomImple
         {
             // Arrange
 
-            var client = ConfigCatClientBuilder.Initialize(APIKEY)
+            var client = ConfigCatClientBuilder.Initialize(SDKKEY)
                 .WithLazyLoad()
                 .WithHttpClientHandler(httpClientHandler)
                 .Create();