Java & Scala: add configurable list of domains which should count as "internal" (#18)

Author: fblundun

java-scala/src/main/java/com/snowplowanalytics/refererparser/Parser.java

@@ -26,6 +26,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.HashMap;
+import java.util.Collections;
 
 // SnakeYAML
 import org.yaml.snakeyaml.Yaml;
@@ -107,8 +108,12 @@ public Referer parse(String refererUri, String pageHost) throws URISyntaxExcepti
   }
 
   public Referer parse(URI refererUri, String pageHost) {
+    return parse(refererUri, pageHost, Collections.<String>emptyList());
+  }
+
+  public Referer parse(URI refererUri, String pageHost, List<String> internalDomains) {
     if (refererUri == null) { return null; }
-    return parse(refererUri.getScheme(), refererUri.getHost(), refererUri.getPath(), refererUri.getRawQuery(), pageHost);
+    return parse(refererUri.getScheme(), refererUri.getHost(), refererUri.getPath(), refererUri.getRawQuery(), pageHost, internalDomains);
   }
 
   public Referer parse(URL refererUrl, String pageHost){
@@ -117,6 +122,10 @@ public Referer parse(URL refererUrl, String pageHost){
   }
 
   private Referer parse(String scheme, String host, String path, String query, String pageHost){
+    return parse(scheme, host, path, query, pageHost, Collections.<String>emptyList());
+  }
+
+  private Referer parse(String scheme, String host, String path, String query, String pageHost, List<String> internalDomains){
 
     if (scheme == null || (!scheme.equals("http") && !scheme.equals("https"))) return null;
 
@@ -126,6 +135,10 @@ private Referer parse(String scheme, String host, String path, String query, Str
     // 2. Have an algo for stripping subdomains before checking match
     if (host == null) return null; // Not a valid URL
     if (host.equals(pageHost)) return new Referer(Medium.INTERNAL, null, null);
+    for (String s : internalDomains) {
+      if (s.trim().equals(host))
+        return new Referer(Medium.INTERNAL, null, null);
+    }
 
     // Try to lookup our referer. First check with paths, then without.
     // This is the safest way of handling lookups
@@ -264,4 +277,4 @@ private Map<String,RefererLookup> loadReferers(InputStream referersYaml) throws
 
     return referers;
   }
-}
+}

java-scala/src/main/scala/com/snowplowanalytics/refererparser/scala/Parser.scala

@@ -17,6 +17,7 @@
 package com.snowplowanalytics.refererparser.scala
 
 // Java
+import java.util.{List => JavaList}
 import java.net.{URI, URISyntaxException}
 
 // RefererParser Java impl
@@ -114,14 +115,28 @@ object Parser {
    * either Some Referer, or None.
    */
   def parse(refererUri: URI, pageHost: String): MaybeReferer = {
+    parse(refererUri, pageHost, List[String]())
+}
+
+
+  /**
+   * Parses a `refererUri` URI to return
+   * either Some Referer, or None.
+   */
+  def parse(refererUri: URI, pageHost: String, internalDomains: List[String]): MaybeReferer = {
 
     try {
-      val jrefr = Option(jp.parse(refererUri, pageHost))
+
+      // Convert from a Scala list to a Java list
+      val javaInternalDomains = new java.util.ArrayList[String](internalDomains.size)
+      internalDomains.foreach (javaInternalDomains.add(_))
+
+      val jrefr = Option(jp.parse(refererUri, pageHost, javaInternalDomains))
       jrefr.map(jr =>
         Referer(Medium.fromJava(jr.medium), Option(jr.source), Option(jr.term))
       )
     } catch {
       case use: URISyntaxException => None
     }
   }
-}
+}