Added SentryEvent

- Added SentryEvent class.
- Added Capture() and CaptureAsync() methods on IRavenClient taking SentryEvent.
- Obsoleted the CaptureMessage() and CaptureException() methods and their async counterparts on SentryEvent.
- Refactored all code to using the new SentryEvent class as its main code path.
- Added a couple of tests.

Author: asbjornu

src/app/SharpRaven/Data/IJsonPacketFactory.cs

@@ -34,18 +34,14 @@
 namespace SharpRaven.Data
 {
     /// <summary>
-    /// Factory interface for creating
-    /// <see cref="JsonPacket" />s. To simply adjust the values of a
-    /// packet before it is sent to Sentry, inherit
-    /// <see cref="JsonPacketFactory" /> and override
-    /// its
-    /// <see cref="JsonPacketFactory.OnCreate" /> method.
+    /// Factory interface for creating <see cref="JsonPacket" />s.
+    /// To simply adjust the values of a packet before it is sent to Sentry, inherit
+    /// <see cref="JsonPacketFactory" /> and override its <see cref="JsonPacketFactory.OnCreate" /> method.
     /// </summary>
     public interface IJsonPacketFactory
     {
         /// <summary>
-        /// Creates a new instance of
-        /// <see cref="JsonPacket" /> for the specified
+        /// Creates a new instance of <see cref="JsonPacket" /> for the specified
         /// <paramref name="project" />.
         /// </summary>
         /// <param name="project">The project.</param>
@@ -66,11 +62,8 @@ JsonPacket Create(string project,
 
 
         /// <summary>
-        /// Creates a new instance of
-        /// <see cref="JsonPacket" /> for the specified
-        /// <paramref name="project" />, with the
-        /// given
-        /// <paramref name="exception" />.
+        /// Creates a new instance of <see cref="JsonPacket" /> for the specified
+        /// <paramref name="project" />, with the given <paramref name="exception" />.
         /// </summary>
         /// <param name="project">The project.</param>
         /// <param name="exception">The <see cref="Exception" /> to capture.</param>
@@ -80,11 +73,8 @@ JsonPacket Create(string project,
         /// <param name="fingerprint">The custom fingerprint to annotate the captured <paramref name="message" /> with.</param>
         /// <param name="extra">The extra metadata to send with the captured <paramref name="exception" />.</param>
         /// <returns>
-        /// A new instance of
-        /// <see cref="JsonPacket" /> for the specified
-        /// <paramref name="project" />, with the
-        /// given
-        /// <paramref name="exception" />.
+        /// A new instance of <see cref="JsonPacket" /> for the specified
+        /// <paramref name="project" />, with the given <paramref name="exception" />.
         /// </returns>
         JsonPacket Create(string project,
                           Exception exception,
@@ -93,5 +83,18 @@ JsonPacket Create(string project,
                           IDictionary<string, string> tags = null,
                           string[] fingerprint = null,
                           object extra = null);
+
+
+        /// <summary>
+        /// Creates a new instance of  <see cref="JsonPacket" /> for the specified
+        /// <paramref name="project" />, with the  given <paramref name="event" />.
+        /// </summary>
+        /// <param name="project">The project.</param>
+        /// <param name="event">The event to capture.</param>
+        /// <returns>
+        /// A new instance of <see cref="JsonPacket" /> for the specified
+        /// <paramref name="project" />, with the given <paramref name="event" />.
+        /// </returns>
+        JsonPacket Create(string project, SentryEvent @event);
     }
 }

src/app/SharpRaven/Data/JsonPacket.cs

@@ -2,21 +2,21 @@
 
 // Copyright (c) 2014 The Sentry Team and individual contributors.
 // All rights reserved.
-//
+// 
 // Redistribution and use in source and binary forms, with or without modification, are permitted
 // provided that the following conditions are met:
-//
+// 
 //     1. Redistributions of source code must retain the above copyright notice, this list of
 //        conditions and the following disclaimer.
-//
+// 
 //     2. Redistributions in binary form must reproduce the above copyright notice, this list of
 //        conditions and the following disclaimer in the documentation and/or other materials
 //        provided with the distribution.
-//
+// 
 //     3. Neither the name of the Sentry nor the names of its contributors may be used to
 //        endorse or promote products derived from this software without specific prior written
 //        permission.
-//
+// 
 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 // FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
@@ -55,46 +55,24 @@ public JsonPacket(string project, Exception exception)
             if (exception == null)
                 throw new ArgumentNullException("exception");
 
-            Message = exception.Message;
-
-            if (exception.TargetSite != null)
-            {
-                // ReSharper disable ConditionIsAlwaysTrueOrFalse => not for dynamic types.
-                Culprit = String.Format("{0} in {1}",
-                                        ((exception.TargetSite.ReflectedType == null)
-                                            ? "<dynamic type>"
-                                            : exception.TargetSite.ReflectedType.FullName),
-                                        exception.TargetSite.Name);
-                // ReSharper restore ConditionIsAlwaysTrueOrFalse
-            }
-
-            Exceptions = new List<SentryException>();
+            Initialize(exception);
+        }
 
-            for (Exception currentException = exception;
-                currentException != null;
-                currentException = currentException.InnerException)
-            {
-                SentryException sentryException = new SentryException(currentException)
-                {
-                    Module = currentException.Source,
-                    Type = currentException.GetType().Name,
-                    Value = currentException.Message
-                };
 
-                Exceptions.Add(sentryException);
-            }
+        /// <summary>Initializes a new instance of the <see cref="JsonPacket"/> class.</summary>
+        /// <param name="project">The project.</param>
+        /// <param name="event">The event.</param>
+        public JsonPacket(string project, SentryEvent @event)
+            : this(project)
+        {
+            if (@event == null)
+                throw new ArgumentNullException("event");
 
-            // ReflectionTypeLoadException doesn't contain much useful info in itself, and needs special handling
-            ReflectionTypeLoadException reflectionTypeLoadException = exception as ReflectionTypeLoadException;
-            if (reflectionTypeLoadException != null)
-            {
-                foreach (Exception loaderException in reflectionTypeLoadException.LoaderExceptions)
-                {
-                    SentryException sentryException = new SentryException(loaderException);
+            if (@event.Exception != null)
+                Initialize(@event.Exception);
 
-                    Exceptions.Add(sentryException);
-                }
-            }
+            Message = @event.Message != null ? @event.Message.ToString() : null;
+            MessageObject = @event.Message;
         }
 
 
@@ -156,6 +134,12 @@ private JsonPacket()
         [JsonProperty(PropertyName = "culprit", NullValueHandling = NullValueHandling.Ignore)]
         public string Culprit { get; set; }
 
+        /// <summary>
+        /// Identifies the operating environment (e.g. production).
+        /// </summary>
+        [JsonProperty(PropertyName = "environment", NullValueHandling = NullValueHandling.Ignore)]
+        public string Environment { get; set; }
+
         /// <summary>
         /// Hexadecimal string representing a uuid4 value.
         /// </summary>
@@ -177,6 +161,12 @@ private JsonPacket()
         [JsonProperty(PropertyName = "extra", NullValueHandling = NullValueHandling.Ignore)]
         public object Extra { get; set; }
 
+        /// <summary>
+        /// Gets or sets the fingerprint used for custom grouping
+        /// </summary>
+        [JsonProperty(PropertyName = "fingerprint", NullValueHandling = NullValueHandling.Ignore)]
+        public string[] Fingerprint { get; set; }
+
         /// <summary>
         /// The record severity.
         /// Defaults to error.
@@ -250,18 +240,6 @@ private JsonPacket()
         [JsonProperty(PropertyName = "server_name", NullValueHandling = NullValueHandling.Ignore)]
         public string ServerName { get; set; }
 
-        /// <summary>
-        /// Gets or sets the fingerprint used for custom grouping
-        /// </summary>
-        [JsonProperty(PropertyName = "fingerprint", NullValueHandling = NullValueHandling.Ignore)]
-        public string[] Fingerprint { get; set; }
-
-        /// <summary>
-        /// Identifies the operating environment (e.g. production).
-        /// </summary>
-        [JsonProperty(PropertyName = "environment", NullValueHandling = NullValueHandling.Ignore)]
-        public string Environment { get; set; }
-
         /// <summary>
         /// A map or list of tags for this event.
         /// </summary>
@@ -308,5 +286,50 @@ public override string ToString()
         {
             return JsonConvert.SerializeObject(this);
         }
+
+
+        private void Initialize(Exception exception)
+        {
+            Message = exception.Message;
+
+            if (exception.TargetSite != null)
+            {
+                // ReSharper disable ConditionIsAlwaysTrueOrFalse => not for dynamic types.
+                Culprit = String.Format("{0} in {1}",
+                                        ((exception.TargetSite.ReflectedType == null)
+                                            ? "<dynamic type>"
+                                            : exception.TargetSite.ReflectedType.FullName),
+                                        exception.TargetSite.Name);
+                // ReSharper restore ConditionIsAlwaysTrueOrFalse
+            }
+
+            Exceptions = new List<SentryException>();
+
+            for (Exception currentException = exception;
+                currentException != null;
+                currentException = currentException.InnerException)
+            {
+                SentryException sentryException = new SentryException(currentException)
+                {
+                    Module = currentException.Source,
+                    Type = currentException.GetType().Name,
+                    Value = currentException.Message
+                };
+
+                Exceptions.Add(sentryException);
+            }
+
+            // ReflectionTypeLoadException doesn't contain much useful info in itself, and needs special handling
+            ReflectionTypeLoadException reflectionTypeLoadException = exception as ReflectionTypeLoadException;
+            if (reflectionTypeLoadException != null)
+            {
+                foreach (Exception loaderException in reflectionTypeLoadException.LoaderExceptions)
+                {
+                    SentryException sentryException = new SentryException(loaderException);
+
+                    Exceptions.Add(sentryException);
+                }
+            }
+        }
     }
-}
+}

src/app/SharpRaven/Data/JsonPacketFactory.cs

@@ -120,6 +120,23 @@ public JsonPacket Create(string project,
         }
 
 
+        /// <summary>
+        /// Creates a new instance of  <see cref="JsonPacket" /> for the specified
+        /// <paramref name="project" />, with the  given <paramref name="event" />.
+        /// </summary>
+        /// <param name="project">The project.</param>
+        /// <param name="event">The event to capture.</param>
+        /// <returns>
+        /// A new instance of <see cref="JsonPacket" /> for the specified
+        /// <paramref name="project" />, with the given <paramref name="event" />.
+        /// </returns>
+        public JsonPacket Create(string project, SentryEvent @event)
+        {
+            var json = new JsonPacket(project, @event);
+            return OnCreate(json);
+        }
+
+
         /// <summary>
         /// Called when the <see cref="JsonPacket"/> has been created. Can be overridden to
         /// adjust the values of the <paramref name="jsonPacket"/> before it is sent to Sentry.