release/1.0.0

Author: dilyand

.travis.yml

@@ -1,4 +1,5 @@
 language: scala
+dist: trusty
 scala:
 - 2.11.12
 - 2.12.8

CHANGELOG

@@ -1,3 +1,25 @@
+Version 1.0.0 (2019-10-31)
+--------------------------
+Provide a way to create a Parser using cats.Eval (#67)
+Abstract over Parser creation (#72)
+Expose Medium in Referer (#71)
+Do not double decode query string (#73)
+Re-establish the ParseTest suite (#74)
+(Scala) Allow 'android-app' URL scheme (#90)
+Update README to reflect 0.6.0 changes (#88)
+Use sbt-tpolecat (#62)
+Bump version to 1.0.0 (#92)
+Bump cats-core to 1.6.0 (#63)
+Bump cats-effect to 1.2.0 (#64)
+Bump circe to 0.11.1 (#65)
+Bump specs2 to 4.4.1 (#66)
+Bump SBT to 1.2.8 (#68)
+Change Travis distribution to Trusty (#87)
+Fix artifact name in README (#85)
+Fix typo in Parser comment (#86)
+Modify Gitter badge (#58)
+Extend copyright to 2019 (#69)
+
 Version 0.5.0 (2019-01-08)
 --------------------------
 Make the Medium enumeration public (#47)

LICENSE-2.0.txt

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2012-2019 Snowplow Analytics Ltd.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -1,7 +1,7 @@
 # referer-parser Scala library
 
 [![Build Status](https://travis-ci.org/snowplow-referer-parser/scala-referer-parser.svg?branch=develop)](https://travis-ci.org/snowplow-referer-parser/scala-referer-parser)
-[![Join the chat at https://gitter.im/snowplow-referer-parser/referer-parser](https://badges.gitter.im/snowplow-referer-parser/referer-parser.svg)](https://gitter.im/snowplow-referer-parser/referer-parser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Gitter](https://badges.gitter.im/snowplow-referer-parser/scala-referer-parser.svg)](https://gitter.im/snowplow-referer-parser/scala-referer-parser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)
 [![codecov](https://codecov.io/gh/snowplow-referer-parser/scala-referer-parser/branch/develop/graph/badge.svg)](https://codecov.io/gh/snowplow-referer-parser/scala-referer-parser)
 
 This is the Scala implementation of [referer-parser][referer-parser], the library for extracting attribution data from referer _(sic)_ URLs.
@@ -10,12 +10,20 @@ The implementation uses a JSON version of the shared 'database' of known referer
 
 The Scala implementation is a core component of [Snowplow][snowplow], the open-source web-scale analytics platform.
 
+### Installation
+
+You can add the following to your SBT config:
+
+```scala
+val refererParser = "com.snowplowanalytics" %% "scala-referer-parser" % "1.0.0"
+```
+
 ### Usage
 
-All effects within the Scala implementation are wrapped in `Sync` from [cats-effect][cats-effect]. In these examples we use `IO`, but anything that implements `Sync` can be used.
+You can provide wrappers for effects, such as `Sync`, `Eval` or `Id` from [cats-effect][cats-effect]. In the examples below we use `IO`.
 
 ```scala
-import com.snowplowanalytics.refererparser.Parser
+import com.snowplowanalytics.refererparser._
 import cats.effect.IO
 import cats.data.EitherT
 import java.net.URI
@@ -27,14 +35,14 @@ val referersJsonPath = "/opt/referers/referers.json"
 
 // We use EitherT to handle exceptions. The IO routine will short circuit if an exception is returned.
 val io: EitherT[IO, Exception, Unit] = for {
-  // We can instantiate a new Parse instance with Parse.create
-  parser <- EitherT(Parser.create[IO](referersJsonPath))
+  // We can instantiate a new Parser instance with Parser.create
+  parser <- EitherT(CreateParser[IO].create(referersJsonPath))
 
   // Referer is a sealed hierarchy of different referer types
   referer1 <- EitherT.fromOption[IO](parser.parse(refererUrl, pageUrl),
     new Exception("No parseable referer"))
   _ <- EitherT.right(IO { println(referer1) })
-    // => SearchReferer(Google, Some(gateway oracle cards denise linn))
+    // => SearchReferer(SearchMedium,Google,Some(gateway oracle cards denise linn))
 
   // You can provide a list of domains which should be considered internal
   referer2 <- EitherT.fromOption[IO](parser.parse(
@@ -43,8 +51,7 @@ val io: EitherT[IO, Exception, Unit] = for {
       List("www.subdomain1.snowplowanalytics.com", "www.subdomain2.snowplowanalytics.com")
     ), new Exception("No parseable referer"))
   _ <- EitherT.right(IO { println(referer2) })
-    // => InternalReferer
-
+    // => InternalReferer(InternalMedium)
 
   // Various overloads are available for common cases, for instance
   maybeReferer1 = parser.parse("https://www.bing.com/search?q=snowplow")
@@ -60,25 +67,13 @@ More examples can be seen in [ParseTest.scala][parsetest-scala]. See [Parser.sca
 [parsetest-scala]: src/test/scala/com/snowplowanalytics/refererparser/ParseTest.scala
 [parser-scala]: src/main/scala/com/snowplowanalytics/refererparser/Parser.scala
 
-### Installation
-
-Add this to your SBT config:
-
-```scala
-val refererParser = "com.snowplowanalytics" %% "referer-parser" % "0.5.0"
-```
-
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Check out [our contributing guide](CONTRIBUTING.md).
 
 ## Copyright and license
 
-The referer-parser Java/Scala library is copyright 2012-2018 Snowplow Analytics Ltd.
+The referer-parser Java/Scala library is copyright 2012-2019 Snowplow Analytics Ltd.
 
 Licensed under the [Apache License, Version 2.0][license] (the "License");
 you may not use this software except in compliance with the License.

build.sbt

@@ -1,14 +1,29 @@
+/**
+ * Copyright 2012-2019 Snowplow Analytics Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 val root = (project in file(".")).
   enablePlugins(ScalaUnidocPlugin, GhpagesPlugin).
   settings(
-    name          := "scala-referer-parser",
-    organization  := "com.snowplowanalytics",
-    version       := "0.5.0",
-    description   := "Library for extracting marketing attribution data from referer URLs",
-    scalaVersion  := "2.12.8",
+    name := "scala-referer-parser",
+    organization := "com.snowplowanalytics",
+    version := "1.0.0",
+    description := "Library for extracting marketing attribution data from referer URLs",
+    scalaVersion := "2.12.8",
     crossScalaVersions := Seq("2.11.12", "2.12.8"),
-    scalacOptions := BuildSettings.compilerOptions,
-
+    javacOptions := BuildSettings.javaCompilerOptions,
+    scalafmtOnCompile := true,
     libraryDependencies ++= Seq(
       Dependencies.Libraries.catsCore,
       Dependencies.Libraries.circeCore,

project/BuildSettings.scala

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2018 Snowplow Analytics Ltd
+ * Copyright 2012-2019 Snowplow Analytics Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,21 +32,10 @@ import scoverage.ScoverageKeys._
 
 object BuildSettings {
 
-  lazy val compilerOptions = Seq(
-    "-deprecation",
-    "-encoding", "UTF-8",
-    "-feature",
-    "-language:existentials",
-    "-language:higherKinds",
-    "-language:implicitConversions",
-    "-unchecked",
-    "-Yno-adapted-args",
-    "-Ywarn-dead-code",
-    "-Ywarn-numeric-widen",
-    "-Xfuture",
-    "-Xlint",
-    "-Ypartial-unification"
-  )
+  lazy val javaCompilerOptions = Seq(
+    "-source", "1.8",
+    "-target", "1.8"
+)
 
   lazy val publishSettings = bintraySettings ++ Seq(
     publishMavenStyle := true,

project/Dependencies.scala

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2018 Snowplow Analytics Ltd
+ * Copyright 2012-2019 Snowplow Analytics Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,10 +17,10 @@ import sbt._
 
 object Dependencies {
   object V {
-    val catsCore   = "1.5.0"
-    val catsEffect = "1.1.0"
-    val circe      = "0.11.0"
-    val specs2     = "4.3.6"
+    val catsCore   = "1.6.0"
+    val catsEffect = "1.2.0"
+    val circe      = "0.11.1"
+    val specs2     = "4.4.1"
   }
 
   object Libraries {
@@ -29,7 +29,7 @@ object Dependencies {
     val circeCore        = "io.circe"      %% "circe-core"        % V.circe
     val circeGeneric     = "io.circe"      %% "circe-generic"     % V.circe
     val circeParser      = "io.circe"      %% "circe-parser"      % V.circe
-    val specs2Core       = "org.specs2"    %% "specs2-core"       % V.specs2 % "test"
-    val specs2Scalacheck = "org.specs2"    %% "specs2-scalacheck" % V.specs2 % "test"
+    val specs2Core       = "org.specs2"    %% "specs2-core"       % V.specs2 % Test
+    val specs2Scalacheck = "org.specs2"    %% "specs2-scalacheck" % V.specs2 % Test
   }
 }

project/build.properties

@@ -1 +1 @@
-sbt.version=1.2.1
+sbt.version=1.2.8

project/plugins.sbt

@@ -1,6 +1,7 @@
-addSbtPlugin("com.geirsson"      % "sbt-scalafmt"  % "1.5.1")
-addSbtPlugin("com.eed3si9n"      % "sbt-unidoc"    % "0.4.1")
-addSbtPlugin("com.typesafe.sbt"  % "sbt-site"      % "1.3.2")
-addSbtPlugin("com.typesafe.sbt"  % "sbt-ghpages"   % "0.6.2")
-addSbtPlugin("org.scoverage"     % "sbt-scoverage" % "1.5.1")
-addSbtPlugin("org.foundweekends" % "sbt-bintray"   % "0.5.4")
+addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "1.5.1")
+addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.4.1")
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.2")
+addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.2")
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")
+addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.4")
+addSbtPlugin("io.github.davidgregory084" % "sbt-tpolecat" % "0.1.5")

src/main/scala/com/snowplowanalytics/refererparser/CorruptJsonException.scala

@@ -1,5 +1,5 @@
 /**
- * Copyright 2012-2018 Snowplow Analytics Ltd
+ * Copyright 2012-2019 Snowplow Analytics Ltd
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.