Skip to content

Commit

Permalink
Cleaned up currency conversion enrichment (see #370)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fblundun
fblundun committed Mar 2, 2015
1 parent 4f07297 commit d17636d
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 125 deletions.
156 changes: 71 additions & 85 deletions ...wanalytics.snowplow.enrich/common/enrichments/registry/CurrencyConversionEnrichment.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,8 @@ package common
package enrichments
package registry

// This project
import utils.MapTransformer._

// Java
import java.lang.{Integer => JInteger}
import java.math.{BigDecimal => JBigDecimal}
import java.lang.{Byte => JByte}
import java.net.URI
import java.net._
import java.net.UnknownHostException

// Maven Artifact
import org.apache.maven.artifact.versioning.DefaultArtifactVersion
Expand All @@ -38,20 +31,24 @@ import Scalaz._
import org.json4s.JValue

// Iglu
import iglu.client.SchemaKey
import iglu.client.validation.ProcessingMessageMethods._
import iglu.client.{
SchemaKey,
SchemaCriterion
}

// Joda-Money
import org.joda.money.{Money}
import org.joda.time.{DateTime, DateTimeZone}
// Joda-Time
import org.joda.time.DateTime

// Scala-Forex
import com.snowplowanalytics.forex._
import com.snowplowanalytics.forex.oerclient.{OerClientConfig, DeveloperAccount, AccountType, OerResponseError}
import com.snowplowanalytics.forex.oerclient.OerResponseError._
import com.snowplowanalytics.forex.{Forex, ForexConfig}
import com.snowplowanalytics.forex.ForexLookupWhen._
import com.snowplowanalytics.forex.oerclient._
import com.snowplowanalytics.forex.oerclient.{
OerClientConfig,
DeveloperAccount,
OerResponseError
}
import com.snowplowanalytics.forex.{
Forex,
ForexConfig
}

// This project
import common.utils.ConversionUtils
Expand All @@ -63,9 +60,9 @@ import utils.ScalazJson4sUtils
*/
object CurrencyConversionEnrichmentConfig extends ParseableEnrichment {

val supportedSchemaKey = SchemaKey("com.snowplowanalytics.snowplow", "currency_conversion_config", "jsonschema", "1-0-0")
//Creates an CurrencyConversionEnrichment instance from a JValue
val supportedSchema = SchemaCriterion("com.snowplowanalytics.snowplow", "currency_conversion_config", "jsonschema", 1, 0)

// Creates a CurrencyConversionEnrichment instance from a JValue
def parse(config: JValue, schemaKey: SchemaKey): ValidatedNelMessage[CurrencyConversionEnrichment] = {
isParseable(config, schemaKey).flatMap( conf => {
(for {
Expand All @@ -78,78 +75,67 @@ object CurrencyConversionEnrichmentConfig extends ParseableEnrichment {
}
}

// Object and a case object with the same name
/**
* Configuration for a currency_conversion enrichment
*
* @param apiKey OER authentication
* @param baseCurrency Currency to which to convert
* @param rateAt Which exchange rate to use - "EOD_PRIOR" for "end of previous day".
*/
case class CurrencyConversionEnrichment(
apiKey: String,
baseCurrency: String,
baseCurrency: String,
rateAt: String) extends Enrichment {

val version = new DefaultArtifactVersion("0.1.0")

// To provide Validation for org.joda.money.Money variable
def eitherToValidation(input:Either[OerResponseError, Money]): Validation[String, Option[String]]= {
input match {
case Right(l) => (l.getAmount().toPlainString()).some.success
case Left(l) => (s"Open Exchange Rates error, message: ${l.errorMessage}").failure
val fx = Forex(ForexConfig(nowishCacheSize = 0, nowishSecs = 0, eodCacheSize = 0), OerClientConfig(apiKey, DeveloperAccount))

/**
* Attempt to convert if the initial currency and value are both defined
*
* @param inputCurrency Option boxing the initial currency if it is present
* @param value Option boxing the amount to convert
* @return None.success if the inputs were not both defined,
* otherwise Validation[Option[_]] boxing the result of the conversion
*/
private def performConversion(initialCurrency: Option[String], value: Option[Double], tstamp: DateTime): Validation[String, Option[String]] =
(initialCurrency, value) match {
case (Some(ic), Some(v)) => fx.convert(v, ic).to(baseCurrency).at(tstamp) match {
case Left(l) => (s"Open Exchange Rates error, message: ${l.errorMessage}").failure
case Right(s) => (s.getAmount().toPlainString()).some.success
}
case _ => None.success
}
}

def getEitherValidation(fx: Forex, trCurrency: Option[String], trTotal: Option[Double], tstamp: DateTime): Validation[String, Option[String]] = {
trCurrency match {
case Some(trCurr) =>{
trTotal match{
case Some(trC) => {
eitherToValidation(fx.convert(trC, trCurr).to(baseCurrency).at(tstamp))
}
case None => None.success

/**
* Converts currency using Scala Forex
*
* @param trCurrency Initial transaction currency
* @param trTotal Total transaction value
* @param trTax Transaction tax
* @param trShipping Transaction shipping cost
* @param tiCurrency Initial transaction item currency
* @param tiPrice Initial transaction item price
* @param collectorTstamp Collector timestamp
* @return Validation[Tuple] containing all input amounts converted to the base currency
*/
def convertCurrencies(trCurrency: Option[String], trTotal: Option[Double], trTax: Option[Double], trShipping: Option[Double], tiCurrency: Option[String], tiPrice: Option[Double], collectorTstamp: Option[DateTime]): ValidationNel[String, (Option[String], Option[String], Option[String], Option[String])] = {
collectorTstamp match {
case Some(tstamp) => try {
val newCurrencyTr = performConversion(trCurrency, trTotal, tstamp)
val newCurrencyTi = performConversion(tiCurrency, tiPrice, tstamp)
val newTrTax = performConversion(trCurrency, trTax, tstamp)
val newTrShipping = performConversion(trCurrency, trShipping, tstamp)
(newCurrencyTr.toValidationNel |@| newTrTax.toValidationNel |@| newTrShipping.toValidationNel |@| newCurrencyTi.toValidationNel) {
(_, _, _, _)
}
} catch {
case e : NoSuchElementException =>"Base currency [%s] not supported: %s".format(baseCurrency, e).failNel
case f : UnknownHostException => "Could not extract Convert Currencies from OER Service: %s".format(f).failNel
case g => "Unexpected exception converting Currency: %s".format(g).failNel
}
case None => None.success
}
}
/**
* Convert's currency for a given
* set of currency, using
* Scala-Forex.
*
* @param trCurrency The desired
* currency for a given
* amount
* @param trAmounts Contains
* total amount, tax, shipping
* amount's
* @param tiCurrency Trasaction Item
* Currency
* @param tiPrice Trasaction Item
* Price
* @return the converted currency
* in TransacrionAmounts
* format and Ttansaction
* Item Price
*/
def convertCurrencies(trCurrency: Option[String], trTotal: Option[Double], trAmountsTax: Option[Double], trAmountsShipping: Option[Double], tiCurrency: Option[String], tiPrice: Option[Double], collectorTstamp: Option[DateTime]): ValidationNel[String, (Option[String], Option[String], Option[String], Option[String])] = {
val check = Double.NaN
try{
val fx = Forex(ForexConfig( nowishCacheSize = 0, nowishSecs = 0, eodCacheSize= 0), OerClientConfig(apiKey, DeveloperAccount))
collectorTstamp match {
case Some(tstamp) =>{
val newCurrencyTr = getEitherValidation(fx, trCurrency, trTotal, tstamp)
val newCurrencyTi = getEitherValidation(fx, tiCurrency, tiPrice, tstamp)
val newTrAmountsTax = getEitherValidation(fx, trCurrency, trAmountsTax, tstamp)
val newTrAmountsShipping = getEitherValidation(fx, trCurrency, trAmountsShipping, tstamp)
(newCurrencyTr.toValidationNel |@| newTrAmountsTax.toValidationNel |@| newTrAmountsShipping.toValidationNel |@| newCurrencyTi.toValidationNel) {
(_, _, _, _)
}

}
case None => "DateTime Missing".failNel
}
} catch {
case e : NoSuchElementException =>"Provided Currency not supported : %s".format(e).failNel
case f : UnknownHostException => "Could not extract Convert Currencies from OER Service :%s".format(f).failNel
case g => "Exception Converting Currency :%s".format(g).failNel
case None => "Collector timestamp missing".failNel // This should never happen
}

}
}

7 changes: 0 additions & 7 deletions ...h/src/main/scala/com.snowplowanalytics.snowplow.enrich/common/outputs/EnrichedEvent.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,14 +133,9 @@ class EnrichedEvent {
@BeanProperty var tr_total: String = _
@BeanProperty var tr_tax: String = _
@BeanProperty var tr_shipping: String = _
@BeanProperty var tr_currency: String = _
@BeanProperty var tr_city: String = _
@BeanProperty var tr_state: String = _
@BeanProperty var tr_country: String = _
@BeanProperty var tr_total_base: String = _
@BeanProperty var tr_tax_base: String = _
@BeanProperty var tr_shipping_base: String = _
@BeanProperty var currency_base: String = _

// Ecommerce transaction item (from querystring)
@BeanProperty var ti_orderid: String = _
Expand All @@ -149,8 +144,6 @@ class EnrichedEvent {
@BeanProperty var ti_category: String = _
@BeanProperty var ti_price: String = _
@BeanProperty var ti_quantity: String = _
@BeanProperty var ti_currency: String = _
@BeanProperty var ti_price_base: String = _

// Page Pings
@BeanProperty var pp_xoffset_min: JInteger = _
Expand Down
8 changes: 3 additions & 5 deletions ...h/src/main/scala/com.snowplowanalytics.snowplow.enrich/common/utils/ConversionUtils.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -389,8 +389,7 @@ object ConversionUtils {
}

/**
* Convert a String to a String containing a
* Redshift-compatible Double.
* Convert a String to a Double
*
* @param str The String which we hope contains
* a Double
Expand All @@ -399,7 +398,7 @@ object ConversionUtils {
* @return a Scalaz Validation, being either
* a Failure String or a Success Double
*/
def stringToMaybeDouble(field: String,str: String):Validation[String, Option[Double]] = {
def stringToMaybeDouble(field: String, str: String): Validation[String, Option[Double]] = {
try {
if (Option(str).isEmpty || str == "null") { // "null" String check is LEGACY to handle a bug in the JavaScript tracker
None.success
Expand All @@ -410,7 +409,7 @@ object ConversionUtils {
} catch {
case nfe: NumberFormatException =>
"Field [%s]: cannot convert [%s] to Double-like String".format(field, str).fail
}
}
}

/**
Expand Down Expand Up @@ -500,4 +499,3 @@ object ConversionUtils {
else
"Cannot convert byte [%s] to boolean, only 1 or 0.".format(b).fail
}

0 comments on commit d17636d

Please sign in to comment.