Merge branch 'release/0.5.0'

Author: BenFradet

.travis.yml

@@ -1,16 +1,23 @@
 language: scala
 scala:
-   - 2.9.3
-   - 2.10.1
-   - 2.11.5
+   - 2.10.6
+   - 2.11.8
 jdk:
   - oraclejdk7
-  - openjdk6
   - openjdk7
 env:
   global:
-  - secure: kxIeiY9eiOSNOr9yn76bCHL/3/XnxyYT8MSSKcdmrAVcYxN9zohWo9kAXQNPi9mDeQxoVYaIG2EOd01gddjTa/DdVyeij93XDSS31e+HmtfqfF7rDa/r819MOemYwP0lgn2lOHnf5BNu6MQtRUnwXCUz6lUh/hXIYBD4TBQmVl4=
-addons:
-  # Fix OpenJDK builds
-  # https://github.com/travis-ci/travis-ci/issues/5227
-  hostname: short-hostname
+  - secure: M/f/K1H0pZS5rgeoQXroFJlz5t2l8UcP+Bogo2jn3drvrqdPB22Z0MzkorH9diBrtykGZmc3X0A8Y9SQob7YaJ+lD0XbSuwzM9TgAKHLg8CpJQffFpE0xUHybcrcdTnC19iiTI3vovr2nQzlYn31F0X0RXMSDyW0zOIDX9kDGuk=
+  - secure: aEgUK6zpFDbDQNXVsJC9Y3CrvUTrbDci7U6mM/vR2/ksVL4dVMBCJAJsdXWwc12wIlYRNDrtuZ62/R+LbS8O1gjIeyU8hKhc81L8pfyJFOm9BztbN+4XqkPsXS7WqgpqI6lr1TABdHaHPwTCh5kFLtqkCD2NXMmi7uhmScJfVc0=
+  - secure: LPO6f56t82laN2lzNuVuAIQkmkn8wOvmOzeu5ozYn9afJ+GGxjdJJ9TEYOQA5bZFKY/p6o65MemhlidhdMpZu++G1nVVdPoAh+NvEfesQxkQx0lFta6u2l2nKgUnpZL2mW8skM1LGepOyUZFujBAcSH6GHmQN0IP4zGVSrUvMX0=
+  - secure: hDo2jt06gx02utmCMb548NEeTAtIgTg53SYL+rPydhryCZHzQISPHlHB/SDKATlalYU6nP+1zz9gANA1HVgN83BaAzI82CoBcsBvVSAw+MKYMDbdf3yoEpe0DJyzibscu57nb7rvi+Xswse93mib1wkdy4eOXB1L0YwKW6dlxB0=
+  - secure: xtx+EvI6UKAndt1/9pay+YA+6QG8TylETGQemDMGENTp2er/u013CPTZRrJu7znRiQdPamI8hPsy1GRGKt7cCoyFIv5MWtMOodNVcxbhDbl7z3j5mcKIp2RJmv1XaL0nJnltnIJj0P0ohA4BVzpi9jthaj+WzI9O6OIKRyuIvdU=
+script:
+  - sbt test
+deploy:
+  skip_cleanup: true
+  provider: script
+  script: ./.travis/deploy.sh $TRAVIS_TAG
+  on:
+    condition: '"${TRAVIS_SCALA_VERSION}" == "2.11.8" && "${TRAVIS_JDK_VERSION}" == "oraclejdk7"' 
+    tags: true

.travis/deploy.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+tag_version=$1
+
+mkdir ~/.bintray/
+FILE=$HOME/.bintray/.credentials
+cat <<EOF >$FILE
+realm = Bintray API Realm
+host = api.bintray.com
+user = $BINTRAY_SNOWPLOW_MAVEN_USER
+password = $BINTRAY_SNOWPLOW_MAVEN_API_KEY
+EOF
+
+cd $TRAVIS_BUILD_DIR
+pwd
+
+project_version=$(sbt version -Dsbt.log.noformat=true | perl -ne 'print $1 if /(\d+\.\d+\.\d+[^\r\n]*)/')
+if [ "${project_version}" == "${tag_version}" ]; then
+    sbt +publish
+    sbt +bintraySyncMavenCentral
+else
+    echo "Tag version '${tag_version}' doesn't match version in scala project ('${project_version}'). Aborting!"
+    exit 1
+fi

CHANGELOG

@@ -1,3 +1,14 @@
+Version 0.5.0 (2017-01-24)
+--------------------------
+Bump crossScalaVersions to 2.10.6 and 2.11.8 (#102)
+Drop Scala 2.9 support (#105)
+Bump to sbt 0.13.13 (#106)
+Remove scala-util dependency (#101)
+Add CI/CD (#103)
+Add Bintray credentials to .travis.yml (#104)
+Update Open Exchange Rates credentials in .travis.yml (#109)
+Add Sonatype credentials to .travis.yml (#111)
+
 Version 0.4.0 (2016-02-16)
 --------------------------
 Fixed handling of invalid API key (#96)

README.md

@@ -20,18 +20,14 @@ There are three types of accounts supported by OER API, Unlimited, Enterprise an
 
 ### 2.2 Installation
 
-The latest version of Scala Forex is 0.4.0, which is cross-built against Scala 2.9.3, 2.10.x and 2.11.x.
+The latest version of Scala Forex is 0.5.0, which is cross-built against 2.10.x and 2.11.x.
 
 If you're using SBT, add the following lines to your build file:
 
 ```scala
-// Resolvers
-val snowplowRepo = "SnowPlow Repo" at "http://maven.snplow.com/releases/"
-val oldTwitterRepo  = "Twitter Maven Repo" at "http://maven.twttr.com/"
-val newTwitterRepo = "Sonatype" at "https://oss.sonatype.org/content/repositories/releases"
-
-// Dependency
-val scalaForex = "com.snowplowanalytics"  %% "scala-forex"  % "0.4.0"
+libraryDependencies ++= Seq(
+  "com.snowplowanalytics" %% "scala-forex" % "0.5.0"
+)
 ```
 
 Note the double percent (`%%`) between the group and artifactId. That'll ensure you get the right package for your Scala version.
@@ -58,13 +54,13 @@ Case class with defaults:
 
 ```scala
 case class ForexConfig(
-  nowishCacheSize: Int       = 13530, 
+  nowishCacheSize: Int       = 13530,
   nowishSecs: Int            = 300,  
   eodCacheSize: Int          = 405900,  
   getNearestDay: EodRounding = EodRoundDown,
   baseCurrency: String       = "USD"  
-) 
-``` 
+)
+```
 
 To go through each in turn:
 
@@ -76,7 +72,7 @@ To go through each in turn:
 
 4. `getNearestDay` is the rounding configuration for latest eod(at) lookup. The lookup will be performed on the next day if the rounding mode is set to EodRoundUp, and on the previous day if EodRoundDown.
 
-5. `baseCurrency` can be configured to different currencies by the users. 
+5. `baseCurrency` can be configured to different currencies by the users.
 
 For an explanation for the default values please see section **4.4 Explanation of defaults** below.
 
@@ -87,9 +83,9 @@ Case class with defaults:
 ```scala
 case class OerClientConfig(
   appId: String,            
-  accountLevel: AccountType 
+  accountLevel: AccountType
 ) extends ForexClientConfig
-``` 
+```
 
 To go through each in turn:
 
@@ -141,22 +137,22 @@ Lookup the latest EOD (end-of-date) rate prior to your event _(cacheing availabl
 ```scala
 import org.joda.time.{DateTime, DateTimeZone}
 
-// USD => JPY at the end of 12/03/2011 
+// USD => JPY at the end of 12/03/2011
 val fx = Forex(ForexConfig(), OerClientConfig(appId, DeveloperAccount)) // round down to previous day by default
 val tradeDate = new DateTime(2011, 3, 13, 11, 39, 27, 567, DateTimeZone.forID("America/New_York"))
 val usd2yen = fx.rate.to("JPY").at(tradeDate)   // => Right(JPY 82)
 ```
 
-#### 3.2.5 Latest-post EOD rate 
+#### 3.2.5 Latest-post EOD rate
 
 Lookup the latest EOD (end-of-date) rate post to your event _(cacheing available)_:
 
 ```scala
 import org.joda.time.{DateTime, DateTimeZone}
 import com.snowplowanalytics.forex.EodRoundUp
 
-// USD => JPY at the end of 13/03/2011 
-val fx = Forex(ForexConfig(getNearestDay = EodRoundUp), OerClientConfig(appId, DeveloperAccount)) 
+// USD => JPY at the end of 13/03/2011
+val fx = Forex(ForexConfig(getNearestDay = EodRoundUp), OerClientConfig(appId, DeveloperAccount))
 val tradeDate = new DateTime(2011, 3, 13, 11, 39, 27, 567, DateTimeZone.forID("America/New_York"))
 val usd2yen = fx.rate.to("JPY").at(tradeDate)   // => Right(JPY 82)
 ```
@@ -176,7 +172,7 @@ val gbp2jpy = fx.rate.to("JPY").eod(eodDate)   // => Right(JPY 131)
 
 #### 3.2.7 Specific EOD rate without cache
 
-Lookup the EOD rate for a specific date _(no cacheing)_: 
+Lookup the EOD rate for a specific date _(no cacheing)_:
 
 ```scala
 import org.joda.time.DateTime
@@ -198,15 +194,15 @@ Conversion using the live exchange rate _(no cacheing available)_:
 ```scala
 // 9.99 USD => EUR
 val fx = Forex(ForexConfig(), OerClientConfig(appId, DeveloperAccount))
-val priceInEuros = fx.convert(9.99).to("EUR").now 
+val priceInEuros = fx.convert(9.99).to("EUR").now
 ```
 
 #### 3.3.2 Near-live rate
 
 Conversion using a near-live exchange rate with 500 seconds nowishSecs _(cacheing available)_:
 
 ```scala
-// 9.99 GBP => EUR 
+// 9.99 GBP => EUR
 val fx = Forex(ForexConfig(nowishSecs = 500), OerClientConfig(appId, DeveloperAccount))
 val priceInEuros = fx.convert(9.99, "GBP").to("EUR").nowish
 ```
@@ -215,7 +211,7 @@ val priceInEuros = fx.convert(9.99, "GBP").to("EUR").nowish
 
 Note that this will be a live rate conversion if cache is not available.
 Conversion using a live exchange rate with 500 seconds nowishSecs,
-this conversion will be done via HTTP request: 
+this conversion will be done via HTTP request:
 
 ```scala
 
@@ -231,13 +227,13 @@ Conversion using the latest EOD (end-of-date) rate prior to your event _(cachein
 ```scala
 import org.joda.time.{DateTime, DateTimeZone}
 
-// 10000 GBP => JPY at the end of 12/03/2011 
+// 10000 GBP => JPY at the end of 12/03/2011
 val fx = Forex(ForexConfig(), OerClientConfig(appId, DeveloperAccount))
 val tradeDate = new DateTime(2011, 3, 13, 11, 39, 27, 567, DateTimeZone.forID("America/New_York"))
 val tradeInYen = fx.convert(10000, "GBP").to("JPY").at(tradeDate)                   
 ```
 
-#### 3.3.5 Latest-post EOD rate 
+#### 3.3.5 Latest-post EOD rate
 
 Lookup the latest EOD (end-of-date) rate following your event _(cacheing available)_:
 
@@ -246,9 +242,9 @@ import org.joda.time.{DateTime, DateTimeZone}
 import com.snowplowanalytics.forex.EodRoundUp
 
 // 10000 GBP => JPY at the end of 13/03/2011
-val fx = Forex(ForexConfig(getNearestDay = EodRoundUp), OerClientConfig(appId, DeveloperAccount)) 
+val fx = Forex(ForexConfig(getNearestDay = EodRoundUp), OerClientConfig(appId, DeveloperAccount))
 val tradeDate = new DateTime(2011, 3, 13, 11, 39, 27, 567, DateTimeZone.forID("America/New_York"))
-val usd2yen = fx.convert(10000, "GBP").to("JPY").at(tradeDate) 
+val usd2yen = fx.convert(10000, "GBP").to("JPY").at(tradeDate)
 ```
 
 #### 3.3.6 Specific EOD rate
@@ -266,7 +262,7 @@ val tradeInYen = fx.convert(10000).to("JPY").eod(eodDate)
 
 #### 3.3.7 Specific EOD rate without cache
 
-Conversion using the EOD rate for a specific date, _(no cacheing)_: 
+Conversion using the EOD rate for a specific date, _(no cacheing)_:
 
 ```scala
 import org.joda.time.DateTime
@@ -351,7 +347,7 @@ Please note that the LRU cache implementation is **not** thread-safe ([see this
 
 ### 5.4 Explanation of defaults
 
-#### 5.4.1 `nowishCache` = (165 * 164 / 2) = 13530 
+#### 5.4.1 `nowishCache` = (165 * 164 / 2) = 13530
 
 There are 165 currencies provided by the OER API, hence 165 * 164 pairs of currency combinations.
 The key in nowish cache is a tuple of source currency and target currency, and the nowish cache was implemented in a way such that a lookup from CurrencyA to CurrencyB or from CurrencyB to CurrencyA will use the same exchange rate, so we don't need to store both in the caches. Hence there are (165 * 164 / 2) pairs of currencies for nowish cache.
@@ -405,7 +401,7 @@ limitations under the License.
 [travis]: https://travis-ci.org/snowplow/scala-forex
 [travis-image]: https://travis-ci.org/snowplow/scala-forex.png?branch=master
 
-[release-image]: http://img.shields.io/badge/release-0.4.0-blue.svg?style=flat
+[release-image]: http://img.shields.io/badge/release-0.5.0-blue.svg?style=flat
 [releases]: https://github.com/snowplow/scala-forex/releases
 
 [license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat

build.sbt

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2013-2017 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * 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.
+ */
+
+lazy val root = project.in(file("."))
+  .settings(
+    name        := "scala-forex",
+    version     := "0.5.0",
+    description := "High-performance Scala library for performing currency conversions using Open Exchange Rates"
+  )
+  .settings(BuildSettings.buildSettings)
+  .settings(BuildSettings.publishSettings)
+  .settings(
+    libraryDependencies ++= Seq(
+      Dependencies.Libraries.jodaTime,
+      Dependencies.Libraries.jodaConvert,
+      Dependencies.Libraries.jodaMoney,
+      Dependencies.Libraries.jackson,
+      Dependencies.Libraries.collUtil,
+      Dependencies.Libraries.mockito,
+      Dependencies.Libraries.specs2
+    )
+  )

project/BuildSettings.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013-2015 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2013-2017 Snowplow Analytics Ltd. All rights reserved.
  *
  * 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.
@@ -10,36 +10,60 @@
  * "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.
  */
+
+// SBT
 import sbt._
 import Keys._
 
+// Bintray plugin
+import bintray.BintrayPlugin._
+import bintray.BintrayKeys._
+
 object BuildSettings {
 
   // Basic settings for our app
-  lazy val basicSettings = Seq[Setting[_]](
-    organization          :=  "com.snowplowanalytics",
-    version               :=  "0.4.0",
-    description           :=  "High-performance Scala library for performing currency conversions using Open Exchange Rates",
-    scalaVersion          :=  "2.10.1",
-    crossScalaVersions    :=  Seq("2.9.3", "2.10.1", "2.11.5"), 
-    scalacOptions         :=  Seq("-deprecation", "-encoding", "utf8"),
-    resolvers             ++= Dependencies.resolutionRepos
+  lazy val buildSettings = Seq[Setting[_]](
+    organization          := "com.snowplowanalytics",
+    scalaVersion          := "2.11.8",
+    crossScalaVersions    := Seq("2.10.6", "2.11.8"),
+    scalacOptions         := compilerOptions
   )
 
+  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"
+  )
 
   // Publish settings
-  // TODO: update with ivy credentials etc when we start using Nexus
-  lazy val publishSettings = Seq[Setting[_]](
-    // Enables publishing to maven repo
+  lazy val publishSettings = bintraySettings ++ Seq(
     publishMavenStyle := true,
-
-    publishTo <<= version { version =>
-      val basePath = "target/repo/%s".format {
-        if (version.trim.endsWith("SNAPSHOT")) "snapshots/" else "releases/"
-      }
-      Some(Resolver.file("Local Maven repository", file(basePath)) transactional())
-    }
+    publishArtifact := true,
+    publishArtifact in Test := false,
+    licenses += ("Apache-2.0", url("http://www.apache.org/licenses/LICENSE-2.0.html")),
+    bintrayOrganization := Some("snowplow"),
+    bintrayRepository := "snowplow-maven",
+    pomIncludeRepository := { _ => false },
+    homepage := Some(url("http://snowplowanalytics.com")),
+    scmInfo := Some(ScmInfo(url("https://github.com/snowplow/scala-forex"),
+      "scm:[email protected]:snowplow/scala-forex.git")),
+    pomExtra := (
+      <developers>
+        <developer>
+          <name>Snowplow Analytics Ltd</name>
+          <email>support@snowplowanalytics.com</email>
+          <organization>Snowplow Analytics Ltd</organization>
+          <organizationUrl>http://snowplowanalytics.com</organizationUrl>
+        </developer>
+      </developers>)
   )
-
-  lazy val buildSettings = basicSettings ++ publishSettings
 }