Merge pull request #35 from RoushTech/release/0.5.0

v0.5.0

Author: StrangeWill

.gitignore

@@ -4,3 +4,4 @@ src/RollbarDotNet/bin/
 *.lock.json
 test/RollbarDotNet.Tests/bin/
 test/RollbarDotNet.Tests/obj/
+*.user

CHANGELOG.md

@@ -1,20 +1,50 @@
-# v0.3.0
+# 0.5.0
+<sup>Released: TBD</sup>
+
+## Features
+
+- IHttpContextAccessor is no longer assumed to be included as part of `AddIdentity()`, we'll add it.
+- Testing of dependency injection for web platforms (console apps coming soon).
+- Switching to the use of `IOptions<RollbarOptions>` instead of `IConfigurationRoot`.
+- Testing for SendMessage calls.
+- Person record support (thank you mkdabrowski).
+- Exception builder is now injectable.
+
+## Bug Fixes
+
+- Sending a message to Rollbar no longer results in a null reference exception being thrown.
+
+
+# 0.4.0
+<sup>Released: 2016/9/30</sup>
+
+## Features
+
+- Upgrade for .NET Core 1.0 release.
+
+# 0.3.0
 <sup>Released: 2016/6/12</sup>
 
+## Features
+
 - Added support for cookies on request body.
 - Added blacklisting variables by name.
 
-# v0.2.0
+# 0.2.0
 <sup>Released: 2016/6/9</sup>
 
+## Features
+
 - Rollbar message UUID available after error is reported.
 - Removed custom parameters from message body.
 - Documentation for required configuration variables 
 
 
-# v0.1.0
+# 0.1.0
 <sup>Released: 2016/5/31</sup>
 
 Initial release.
 
+## Features
+
 - Ability to send basic logs to Rollbar

Readme.md

@@ -24,14 +24,19 @@ Place the following in your Startup.ConfigureServices section:
 
 ``` csharp
 services.AddRollbarWeb(Configuration);
-services.AddSingleton(Configuration); // Add IConfigurationRoot service.
 ```
 
 There is also one that doesn't load the builders for building out environment information for web servers (this will not attempt to crawl for server/client/request information):
 
 ``` csharp
 services.AddRollbar(Configuration);
-services.AddSingleton(Configuration); // Add IConfigurationRoot service.
+```
+
+Hook up the rollar configuration using the following code:
+
+``` csharp
+services.AddOptions(); // Most apps already are using this, but just in case.
+services.Configure<RollbarOptions>(options => Configuration.GetSection("Rollbar").Bind(options));
 ```
 
 Configure Rollbar from your appSettings.json file like so:
@@ -73,6 +78,34 @@ response.Uuid //Event UUID that can be looked up on the rollbar site.
 var response = await this.Rollbar.SendMessage("Hello World!", RollbarLevels.Message);
 ```
 
+# Calling Without Dependency Injection
+
+Although I *highly recommend* using depdency injection, you can fairly easily configure Rollbar by hand:
+
+``` csharp
+var rollbarOptions = Options.Create(new RollbarOptions
+{
+    AccessToken = "token here",
+    Environment = "development"
+});
+var rollbar = new Rollbar(
+    new IBuilder[] {
+        new ConfigurationBuilder(rollbarOptions),
+        new EnvironmentBuilder(new SystemDateTime()), // SystemDateTime abstracts DateTime for mocking
+        new NotifierBuilder()
+    }
+);
+
+try
+{
+    throw new Exception("Testing");
+}
+catch(Exception exception)
+{
+    await rollbar.SendException(exception); //Err... everything is async, keep that in mind.
+}
+```
+
 # Blacklists
 
 Blacklisting will replace variables with asterisks ("**********") when data is sent to Rollbar.

RollbarDotNet.sln

@@ -1,12 +1,13 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 14
-VisualStudioVersion = 14.0.25123.0
+VisualStudioVersion = 14.0.25420.1
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{FBE55ED6-5E60-41F8-B5C0-7C97D04A1A6C}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{04899B07-3768-4373-9CB8-1A0DBA28C035}"
 	ProjectSection(SolutionItems) = preProject
+		CHANGELOG.md = CHANGELOG.md
 		global.json = global.json
 		LICENSE.txt = LICENSE.txt
 		Readme.md = Readme.md

global.json

@@ -1,6 +1,6 @@
 {
   "projects": [ "src", "test" ],
   "sdk": {
-    "version": "1.0.0-preview2-003121"
+    "version": "1.0.0-preview2-003131"
   }
 }

src/RollbarDotNet/Blacklisters/ConfigurationBlacklister.cs

@@ -8,9 +8,9 @@
 
     public class ConfigurationBlacklister : IBlacklister
     {
-        public ConfigurationBlacklister(IOptions<BlacklistConfiguration> config)
+        public ConfigurationBlacklister(IOptions<RollbarOptions> config)
         {
-            this.Configuration = config?.Value;
+            this.Configuration = config?.Value?.Blacklist;
             this.RegexChecks = new List<Regex>();
             this.StringChecks = new List<string>();
             if (this.Configuration != null)

src/RollbarDotNet/Builder/ConfigurationBuilder.cs

@@ -1,31 +1,32 @@
 namespace RollbarDotNet.Builder
 {
-    using Microsoft.Extensions.Configuration;
+    using Configuration;
+    using Microsoft.Extensions.Options;
     using Payloads;
     using System;
 
     public class ConfigurationBuilder : IBuilder
     {
-        public ConfigurationBuilder(IConfigurationRoot configuration)
+        public ConfigurationBuilder(IOptions<RollbarOptions> configuration)
         {
-            this.Configuration = configuration;
+            this.Configuration = configuration.Value;
         }
 
-        protected IConfigurationRoot Configuration { get; set; }
+        protected RollbarOptions Configuration { get; set; }
 
         public void Execute(Payload payload)
         {
-            payload.AccessToken = this.Configuration["Rollbar:AccessToken"];
-            payload.Data.Environment = this.Configuration["Rollbar:Environment"];
+            payload.AccessToken = this.Configuration.AccessToken;
+            payload.Data.Environment = this.Configuration.Environment;
 
             if(string.IsNullOrEmpty(payload.AccessToken))
             {
-                throw new InvalidOperationException("Configuration variable Rollbar:AccessToken must be set.");
+                throw new InvalidOperationException("Configuration variable for your Rollbar AccessToken must be set (did you include services.Configure<RollbarOptions>?).");
             }
 
             if (string.IsNullOrEmpty(payload.Data.Environment))
             {
-                throw new InvalidOperationException("Configuration variable Rollbar:Environment must be set.");
+                throw new InvalidOperationException("Configuration variable for your Rollbar Environment must be set (did you include services.Configure<RollbarOptions>?).");
             }
         }
     }

src/RollbarDotNet/Builder/ExceptionBuilder.cs

@@ -3,7 +3,7 @@
     using System.Collections.Generic;
     using Payloads;
 
-    public class ExceptionBuilder
+    public class ExceptionBuilder : IExceptionBuilder
     {
         public void Execute(Payload payload, System.Exception exception)
         {

src/RollbarDotNet/Builder/IBuilder.cs

@@ -1,7 +1,6 @@
 namespace RollbarDotNet.Builder
 {
     using Payloads;
-    using System.Threading.Tasks;
 
     public interface IBuilder
     {

src/RollbarDotNet/Builder/IExceptionBuilder.cs

@@ -0,0 +1,9 @@
+namespace RollbarDotNet.Builder
+{
+    using Payloads;
+
+    public interface IExceptionBuilder
+    {
+        void Execute(Payload payload, System.Exception exception);
+    }
+}