-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added ability to disable user-agent-utils enrichment (closes #792)
Added ability to disable user-agent-utils enrichment (closes #792) Added ability to disable user-agent-utils enrichment (closes #792) Added ability to disable user-agent-utils enrichment (closes #792) Added ability to disable user-agent-utils enrichment (closes #792) Added ability to disable user-agent-utils enrichment (closes #792) Added ability to disable user-agent-utils enrichment (closes #792) Added ability to disable user-agent-utils enrichment (closes #792) Added ability to disable user-agent-utils enrichment (closes #792)
- Loading branch information
Showing
7 changed files
with
224 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
...wplowanalytics.snowplow.enrich/common/enrichments/registry/UserAgentUtilsEnrichment.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| /*Copyright <Notice> | ||
| * | ||
| * This program is licensed to you under the Apache License Version 2.0, | ||
| * and you may not use this file except in compliance with the Apache License Version 2.0. | ||
| * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the Apache License Version 2.0 is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. | ||
| */ | ||
| package com.snowplowanalytics | ||
| package snowplow | ||
| package enrich | ||
| package common | ||
| package enrichments | ||
| package registry | ||
|
|
||
| // Maven Artifact | ||
| import org.apache.maven.artifact.versioning.DefaultArtifactVersion | ||
|
|
||
| // Scalaz | ||
| import scalaz._ | ||
| import Scalaz._ | ||
|
|
||
| // UserAgentUtils | ||
| import eu.bitwalker.useragentutils._ | ||
|
|
||
| // json4s | ||
| import org.json4s.JValue | ||
|
|
||
| // Iglu | ||
| import iglu.client.SchemaKey | ||
| import iglu.client.validation.ProcessingMessageMethods._ | ||
|
|
||
| // This project | ||
| import utils.ScalazJson4sUtils | ||
|
|
||
| object UserAgentUtilsEnrichmentConfig extends ParseableEnrichment { | ||
|
|
||
| val supportedSchemaKey = SchemaKey("com.snowplowanalytics.snowplow", "user_agent_utils_config", "jsonschema", "1-0-0") | ||
|
|
||
| //Creates an UserAgentUtilsEnrichment instance from a JValue | ||
| def parse(config: JValue, schemaKey: SchemaKey): ValidatedNelMessage[UserAgentUtilsEnrichment.type] = | ||
| isParseable(config, schemaKey).map(_ => UserAgentUtilsEnrichment) | ||
| } | ||
|
|
||
| /** | ||
| * Case class to wrap everything we | ||
| * can extract from the useragent | ||
| * using UserAgentUtils. | ||
| * | ||
| * Not to be declared inside a class Object | ||
| * http://stackoverflow.com/questions/17270003/why-are-classes-inside-scala-package-objects-dispreferred | ||
| */ | ||
| case class ClientAttributes( | ||
| // Browser | ||
| browserName: String, | ||
| browserFamily: String, | ||
| browserVersion: Option[String], | ||
| browserType: String, | ||
| browserRenderEngine: String, | ||
| // OS the browser is running on | ||
| osName: String, | ||
| osFamily: String, | ||
| osManufacturer: String, | ||
| // Hardware the OS is running on | ||
| deviceType: String, | ||
| deviceIsMobile: Boolean) | ||
|
|
||
| // Object and a case object with the same name | ||
|
|
||
| case object UserAgentUtilsEnrichment extends Enrichment { | ||
|
|
||
| val version = new DefaultArtifactVersion("0.1.0") | ||
|
|
||
| /** | ||
| * Extracts the client attributes | ||
| * from a useragent string, using | ||
| * UserAgentUtils. | ||
| * | ||
| * TODO: rewrite this when we swap | ||
| * out UserAgentUtils for ua-parser | ||
| * | ||
| * @param useragent The useragent | ||
| * String to extract from. | ||
| * Should be encoded (i.e. | ||
| * not previously decoded). | ||
| * @return the ClientAttributes or | ||
| * the message of the | ||
| * exception, boxed in a | ||
| * Scalaz Validation | ||
| */ | ||
| def extractClientAttributes(useragent: String): Validation[String, ClientAttributes] = { | ||
|
|
||
| try { | ||
| val ua = UserAgent.parseUserAgentString(useragent) | ||
| val b = ua.getBrowser | ||
| val v = Option(ua.getBrowserVersion) | ||
| val os = ua.getOperatingSystem | ||
| ClientAttributes( | ||
| browserName = b.getName, | ||
| browserFamily = b.getGroup.getName, | ||
| browserVersion = v map { _.getVersion }, | ||
| browserType = b.getBrowserType.getName, | ||
| browserRenderEngine = b.getRenderingEngine.toString, | ||
| osName = os.getName, | ||
| osFamily = os.getGroup.getName, | ||
| osManufacturer = os.getManufacturer.getName, | ||
| deviceType = os.getDeviceType.getName, | ||
| deviceIsMobile = os.isMobileDevice).success | ||
| } catch { | ||
| case e => "Exception parsing useragent [%s]: [%s]".format(useragent, e.getMessage).fail | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.