add async suffix

sochix · Mar 17, 2016 · 43c9a41 · 43c9a41
1 parent 9f72c7b
commit 43c9a41
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 24 deletions.
diff --git a/HighchartsExportClient.Tests/HighchartsClientTest.cs b/HighchartsExportClient.Tests/HighchartsClientTest.cs
@@ -29,7 +29,7 @@ public async Task GetImageBytesFromOptions_Works()
 				}
 			};
 
-			var res = await client.GetChartImageFromOptions(JsonConvert.SerializeObject(options));
+			var res = await client.GetChartImageFromOptionsAsync(JsonConvert.SerializeObject(options));
 
 			Assert.IsNotNull(res);
 			File.WriteAllBytes("__imageFromBytes_defaultSettings.png", res);
@@ -60,7 +60,7 @@ public async Task GetImageBytesFromOptions_CustomSettings_Works()
 				}
 			};
 
-			var res = await client.GetChartImageFromOptions(JsonConvert.SerializeObject(options));
+			var res = await client.GetChartImageFromOptionsAsync(JsonConvert.SerializeObject(options));
 
 			Assert.IsNotNull(res);
 			File.WriteAllBytes($"__imageFromBytes_customSettings.{settings.ExportImageType}", res);
@@ -83,7 +83,7 @@ public async Task GetImageLinkFromOptions_Works()
 				}
 			};
 
-			var res = await client.GetChartImageLinkFromOptions(JsonConvert.SerializeObject(options));
+			var res = await client.GetChartImageLinkFromOptionsAsync(JsonConvert.SerializeObject(options));
 
 			Assert.IsNotNull(res);
 			Console.WriteLine(res);
@@ -94,7 +94,7 @@ public async Task GetImageLinkFromSvg_Works()
 		{
 			var client = new HighchartsClient(_highchartsServer);
 
-			var res = await client.GetChartImageLinkFromSvg(_svg);
+			var res = await client.GetChartImageLinkFromSvgAsync(_svg);
 
 			Assert.IsNotNull(res);
 			Console.WriteLine(res);
@@ -105,7 +105,7 @@ public async Task GetImageBytesFromSvg_Works()
 		{
 			var client = new HighchartsClient(_highchartsServer);
 
-			var res = await client.GetChartImageFromSvg(_svg);
+			var res = await client.GetChartImageFromSvgAsync(_svg);
 
 			Assert.IsNotNull(res);
 			File.WriteAllBytes("__imageFromSvg_defaultSettings.png", res);

diff --git a/HighchartsExportClient/HighchartsClient.cs b/HighchartsExportClient/HighchartsClient.cs
@@ -6,10 +6,10 @@ namespace HighchartsExportClient
 {
 	public interface IHighchartsClient
 	{
-		Task<byte[]> GetChartImageFromOptions(string options);
-		Task<byte[]> GetChartImageFromSvg(string svg);
-		Task<string> GetChartImageLinkFromOptions(string options);
-		Task<string> GetChartImageLinkFromSvg(string svg);
+		Task<byte[]> GetChartImageFromOptionsAsync(string options);
+		Task<byte[]> GetChartImageFromSvgAsync(string svg);
+		Task<string> GetChartImageLinkFromOptionsAsync(string options);
+		Task<string> GetChartImageLinkFromSvgAsync(string svg);
 	}
 
 	public class HighchartsSetting
@@ -105,23 +105,23 @@ private async Task<HttpResponseMessage> MakeRequest(Dictionary<string, string> s
 			};
 		}
 
-		public async Task<byte[]> GetChartImageFromOptions(string options)
+		public async Task<byte[]> GetChartImageFromOptionsAsync(string options)
 		{
 			var request = GetRequestSettings(options, getLink: false, isSvg: false);
 			var response = await MakeRequest(request);
 
 			return await response.Content.ReadAsByteArrayAsync();
 		}
 
-		public async Task<byte[]> GetChartImageFromSvg(string svg)
+		public async Task<byte[]> GetChartImageFromSvgAsync(string svg)
 		{
 			var request = GetRequestSettings(svg, getLink: false, isSvg: true);
 			var response = await MakeRequest(request);
 
 			return await response.Content.ReadAsByteArrayAsync();
 		}
 
-		public async Task<string> GetChartImageLinkFromOptions(string options)
+		public async Task<string> GetChartImageLinkFromOptionsAsync(string options)
 		{
 			var request = GetRequestSettings(options, getLink: true, isSvg: false);
 
@@ -131,7 +131,7 @@ public async Task<string> GetChartImageLinkFromOptions(string options)
 			return $"{_settings.ServerAddress}{filePath}";
 		}
 
-		public async Task<string> GetChartImageLinkFromSvg(string svg)
+		public async Task<string> GetChartImageLinkFromSvgAsync(string svg)
 		{
 			var request = GetRequestSettings(svg, getLink: true, isSvg: true);
 

diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ PM > Install-Package highcharts-export-client
 
 * In development, you can use default highcharts server [http://export.highcharts.com/](http://export.highcharts.com/).
 
-* In production, library needs a server with installed [highcharts-export-server](link). Basic installation steps described [here](http://www.highcharts.com/docs/export-module/setting-up-the-server) & [here](http://withr.me/set-up-highcharts-export-server-on-ubuntu-server-12-dot-04-step-by-step/).
+* In production, library needs a server with installed [highcharts-export-server](http://www.highcharts.com/docs/export-module/setting-up-the-server). Basic installation steps described [here](http://www.highcharts.com/docs/export-module/setting-up-the-server) & [here](http://withr.me/set-up-highcharts-export-server-on-ubuntu-server-12-dot-04-step-by-step/).
 
 #Usage
 ##Draw chart from Highchart Options
@@ -47,16 +47,16 @@ Options is a highchart options.
 		}
 	};
 
-	var res = await client.GetChartImageFromOptions(JsonConvert.SerializeObject(options));
-	
-	File.WriteAllBytes("image.png", res);
+	var res = await client.GetChartImageFromOptionsAsync(JsonConvert.SerializeObject(options));
+
+	File.WriteAllBytes("__imageFromBytes_defaultSettings.png", res);
 ```
 
 ##Draw chart from SVG
 
 To draw a chart from SVG file, use this method:
 ```
-	var res = await client.GetChartImageFromSvg(_svg);
+	var res = await client.GetChartImageFromSvgAsync(_svg);
 ```
 
 ##Chart settings
@@ -66,9 +66,9 @@ Full settings description see on [highcharts-export-server page](http://www.high
 ```
 	var settings = new HighchartsSetting
 	{
-		ExportImageType = "jpg", // possible png, pdf, jpg 
-		ScaleFactor = 4, 
-		ImageWidth = 1500, // max 1600 px
+		ExportImageType = "jpg",
+		ScaleFactor = 4,
+		ImageWidth = 1500,
 		ServerAddress = _highchartsServer
 	};
 
@@ -80,7 +80,7 @@ You can use library in async mode. In this mode, each call will return a link to
 Image will be stored on the server for 15 minutes. See full documentation on [highcharts-export-server](http://www.highcharts.com/docs/export-module/export-module-overview).
 
 ```
-	var res = await client.GetChartImageLinkFromOptions(JsonConvert.SerializeObject(options));
+	var res = await client.GetChartImageLinkFromOptionsAsync(JsonConvert.SerializeObject(options));
 ```
 
 #License

diff --git a/appveyor.yml b/appveyor.yml
@@ -6,8 +6,7 @@ nuget:
 before_build:
 - cmd: nuget restore .\HighchartsExportClient\HighchartsExportClient.sln
 build:
-  publish_nuget: true
-  publish_nuget_symbols: true
+  publish_nuget: true  
   include_nuget_references: true
   verbosity: minimal
 deploy: