Merge pull request #4 from jahunt1/graylog

Graylog Provider

Author: jahunt1

.idea/gradle.xml

@@ -8,8 +8,8 @@ android {
 	defaultConfig {
 		minSdkVersion rootProject.ext.minSdkVersion
 		targetSdkVersion rootProject.ext.targetSdkVersion
-		versionCode rootProject.ext.versionCode
-		versionName rootProject.ext.versionName
+		versionCode = 1
+		versionName = rootProject.version ? rootProject.version : "unspecified"
 	}
 	buildTypes {
 		release {
@@ -37,7 +37,7 @@ task sourcesJar(type: Jar) {
 }
 
 task javadoc(type: Javadoc) {
-	failOnError  false
+	failOnError false
 	source = android.sourceSets.main.java.sourceFiles
 	classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
 }

analyticskit/build.gradle

@@ -19,21 +19,27 @@
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 
-import java.util.HashMap;
+import java.io.Serializable;
+import java.util.LinkedHashMap;
+import java.util.Map;
 
 /**
  * Defines information that is needed to distribute the event to the registered analytics providers.
+ *
  * @author John Hunt on 3/5/16.
  */
-public class AnalyticsEvent
+public class AnalyticsEvent implements Serializable
 {
+	private static final long serialVersionUID = 8237206047809063471L;
+
 	final String name;
-	HashMap<String, Object> attributes;
-	boolean timed;
+	Map<String, Object> attributes;
+	boolean             timed;
 	int priorityLevel = 0;
 
 	/**
-	 * Instantiates a new {@code AnalyticsEvent} object
+	 * Instantiates a new {@code AnalyticsEvent} object.
+	 *
 	 * @param name the name of the event
 	 */
 	public AnalyticsEvent(@NonNull String name)
@@ -44,7 +50,7 @@ public AnalyticsEvent(@NonNull String name)
 	}
 
 	/**
-	 * Access the event name
+	 * Access the event name.
 	 *
 	 * @return the name of the custom event
 	 */
@@ -55,7 +61,7 @@ public String name()
 	}
 
 	/**
-	 * Adds an attribute to the event
+	 * Adds an attribute to the event.
 	 *
 	 * @param attributeName the name of the attribute (should be unique)
 	 * @param value         the {@link Object} to associate with the name given
@@ -67,7 +73,7 @@ public AnalyticsEvent putAttribute(@NonNull String attributeName, @NonNull Objec
 		// guard clause - make sure the dictionary is initialized
 		if (this.attributes == null)
 		{
-			this.attributes = new HashMap<>();
+			this.attributes = new LinkedHashMap<>();
 		}
 
 		this.attributes.put(attributeName, value);
@@ -76,6 +82,7 @@ public AnalyticsEvent putAttribute(@NonNull String attributeName, @NonNull Objec
 
 	/**
 	 * Gets the priority of this event.
+	 *
 	 * @return the priority of the event. Returns {@code 0} when {@link #setPriority(int)} has not been called.
 	 */
 	public int getPriority()
@@ -87,6 +94,7 @@ public int getPriority()
 	 * Sets the priority of the event. The event defaults to {@code 0} when this method is not called.
 	 * <p/>
 	 * <b>Note:</b> It is up to the developer to define what priority scheme to use (if any).
+	 *
 	 * @param priorityLevel the priority the event should use
 	 * @return the {@link AnalyticsEvent} instance (for builder-style convenience)
 	 */
@@ -97,19 +105,20 @@ public AnalyticsEvent setPriority(int priorityLevel)
 	}
 
 	/**
-	 * Access the attributes of this event
+	 * Access the attributes of this event.
 	 *
 	 * @return A non-empty map of attributes set on this event.
 	 * Returns {@code null} if no attributes have been added to the event.
 	 */
 	@Nullable
-	public HashMap<String, Object> getAttributes()
+	public Map<String, Object> getAttributes()
 	{
 		return this.attributes;
 	}
 
 	/**
-	 * Access a single attribute of this event
+	 * Access a single attribute of this event.
+	 *
 	 * @param name the name the of the attribute to retrieve
 	 * @return the value associated with the given attribute name.
 	 * Returns {@code null} if the attribute has not been set.
@@ -121,7 +130,8 @@ public Object getAttribute(@NonNull String name)
 	}
 
 	/**
-	 * Indicates if this event is a timed event
+	 * Indicates if this event is a timed event.
+	 *
 	 * @return {@code true} if the event has been set to be a timed event. Returns {@code false} otherwise.
 	 */
 	public boolean isTimed()
@@ -130,7 +140,8 @@ public boolean isTimed()
 	}
 
 	/**
-	 * Sets whether this event should capture timing
+	 * Sets whether this event should capture timing.
+	 *
 	 * @param timed {@code true} to set the event to track the time
 	 * @return the {@link AnalyticsEvent} instance
 	 */
@@ -157,4 +168,54 @@ public AnalyticsEvent send()
 		return this;
 	}
 
+	@Override
+	public boolean equals(Object other)
+	{
+		if (this == other)
+		{
+			return true;
+		}
+		if (other == null || getClass() != other.getClass())
+		{
+			return false;
+		}
+
+		AnalyticsEvent that = (AnalyticsEvent) other;
+
+		if (timed != that.timed)
+		{
+			return false;
+		}
+		if (priorityLevel != that.priorityLevel)
+		{
+			return false;
+		}
+		if (name != null ? !name.equals(that.name) : that.name != null)
+		{
+			return false;
+		}
+		return attributes != null ? attributes.equals(that.attributes) : that.attributes == null;
+
+	}
+
+	@Override
+	public int hashCode()
+	{
+		int result = name != null ? name.hashCode() : 0;
+		result = 31 * result + (attributes != null ? attributes.hashCode() : 0);
+		result = 31 * result + (timed ? 1 : 0);
+		result = 31 * result + priorityLevel;
+		return result;
+	}
+
+	@Override
+	public String toString()
+	{
+		return "AnalyticsEvent{" +
+				"name='" + name + '\'' +
+				", attributes=" + attributes +
+				", timed=" + timed +
+				", priorityLevel=" + priorityLevel +
+				'}';
+	}
 }

analyticskit/src/main/java/com/busybusy/analyticskit_android/AnalyticsEvent.java

@@ -29,7 +29,7 @@
 public class AnalyticsKit
 {
 	private static AnalyticsKit singletonInstance = null;
-	HashSet<AnalyticsKitProvider> providers;
+	HashSet<AnalyticsKitProvider>   providers;
 	HashMap<String, AnalyticsEvent> timedEvents;
 
 	private AnalyticsKit()
@@ -38,7 +38,8 @@ private AnalyticsKit()
 	}
 
 	/**
-	 * Returns the AnalyticsKit singleton
+	 * Returns the AnalyticsKit singleton.
+	 *
 	 * @return the singleton instance
 	 */
 	public static AnalyticsKit getInstance()
@@ -60,7 +61,8 @@ public static AnalyticsKit getInstance()
 	}
 
 	/**
-	 * Registers an {@code AnalyticsKitProvider} instance to receive future events
+	 * Registers an {@code AnalyticsKitProvider} instance to receive future events.
+	 *
 	 * @param provider the {@code AnalyticsKitProvider} to notify on future calls to {@link AnalyticsKit#logEvent(AnalyticsEvent)}.
 	 * @return the {@code AnalyticsKit} instance so multiple calls to {@code registerProvider(AnalyticsKitProvider)} can be chained.
 	 */
@@ -72,6 +74,7 @@ public AnalyticsKit registerProvider(@NonNull AnalyticsKitProvider provider)
 
 	/**
 	 * Sends the given event to all registered analytics providers (OR just to select providers if the event has been set to restrict the providers).
+	 *
 	 * @param event the event to capture with analytics tools
 	 */
 	public void logEvent(AnalyticsEvent event) throws IllegalStateException
@@ -108,7 +111,8 @@ public void logEvent(AnalyticsEvent event) throws IllegalStateException
 	}
 
 	/**
-	 * Marks the end of a timed event
+	 * Marks the end of a timed event.
+	 *
 	 * @param eventName the unique name of the event that has finished
 	 */
 	public void endTimedEvent(@NonNull String eventName) throws IllegalStateException
@@ -150,7 +154,8 @@ public void endTimedEvent(@NonNull String eventName) throws IllegalStateExceptio
 	}
 
 	/**
-	 * Marks the end of a timed event
+	 * Marks the end of a timed event.
+	 *
 	 * @param event the event that has finished
 	 */
 	public void endTimedEvent(@NonNull AnalyticsEvent event)

analyticskit/src/main/java/com/busybusy/analyticskit_android/AnalyticsKit.java

@@ -20,7 +20,7 @@
 
 /**
  * Defines the interface for provider plugins to be used with AnalyticsKit-Android.
- *
+ * <p>
  * Note: in your provider implementation, make sure the underlying provider SDK calls are
  * executed asynchronously. Otherwise, you will have network operations running on the main thread.
  *
@@ -29,20 +29,23 @@
 public interface AnalyticsKitProvider
 {
 	/**
-	 * Returns the filter used to restrict events by priority
+	 * Returns the filter used to restrict events by priority.
+	 *
 	 * @return the {@link PriorityFilter} instance the provider is using to determine if an event of a given priority should be logged
 	 */
 	@NonNull
 	PriorityFilter getPriorityFilter();
 
 	/**
-	 * Sends the event using provider-specific code
+	 * Sends the event using provider-specific code.
+	 *
 	 * @param event an instantiated event
 	 */
 	void sendEvent(@NonNull AnalyticsEvent event);
 
 	/**
-	 * End the timed event
+	 * End the timed event.
+	 *
 	 * @param timedEvent the event which has finished
 	 */
 	void endTimedEvent(@NonNull AnalyticsEvent timedEvent);
@@ -55,8 +58,9 @@ interface PriorityFilter
 	{
 		/**
 		 * Determines if a provider should log an event with a given priority
+		 *
 		 * @param priorityLevel the priority value from an {@link AnalyticsEvent} object
-		 *                       (Generally {@link AnalyticsEvent#getPriority()})
+		 *                      (Generally {@link AnalyticsEvent#getPriority()})
 		 * @return {@code true} if the event should be logged by the provider.
 		 * Returns {@code false} otherwise.
 		 */

analyticskit/src/main/java/com/busybusy/analyticskit_android/AnalyticsKitProvider.java

@@ -20,14 +20,16 @@
 
 /**
  * Defines information that is needed to distribute a "Content View" event to the registered analytics providers.
+ *
  * @author John Hunt on 3/16/16.
  */
 public class ContentViewEvent extends AnalyticsEvent
 {
-	public final static String CONTENT_NAME = "contentName";
+	public static final String CONTENT_NAME = "contentName";
 
 	/**
 	 * Instantiates a new {@code ContentViewEvent} object.
+	 *
 	 * @param contentName The name/title of the content that is viewed
 	 */
 	public ContentViewEvent(@NonNull String contentName)