fix: adding ability to send revenue currency (#262)

Author: izaaz

Examples/AmplitudeSwiftUIExample/AmplitudeSwiftUIExample/ContentView.swift

@@ -83,6 +83,7 @@ struct ContentView: View {
                             revenue.price = price
                             revenue.quantity = quantity
                             revenue.productId = productId
+                            revenue.currency = "CAD"
                             Amplitude.testInstance.revenue(revenue: revenue)
                         }) {
                             Text("Send Revenue Event")

Sources/Amplitude/Events/BaseEvent.swift

@@ -54,6 +54,7 @@ open class BaseEvent: EventOptions, Codable {
         case quantity
         case productId = "product_id"
         case revenueType = "revenue_type"
+        case currency = "currency"
         case partnerId = "partner_id"
     }
 
@@ -92,6 +93,7 @@ open class BaseEvent: EventOptions, Codable {
         quantity: Int? = nil,
         productId: String? = nil,
         revenueType: String? = nil,
+        currency: String? = nil,
         extra: [String: Any]? = nil,
         callback: EventCallback? = nil,
         partnerId: String? = nil,
@@ -141,6 +143,7 @@ open class BaseEvent: EventOptions, Codable {
             quantity: quantity,
             productId: productId,
             revenueType: revenueType,
+            currency: currency,
             extra: extra,
             callback: callback,
             partnerId: partnerId
@@ -193,6 +196,7 @@ open class BaseEvent: EventOptions, Codable {
         quantity = try values.decodeIfPresent(Int.self, forKey: .quantity)
         productId = try values.decodeIfPresent(String.self, forKey: .productId)
         revenueType = try values.decodeIfPresent(String.self, forKey: .revenueType)
+        currency = try values.decodeIfPresent(String.self, forKey: .currency)
         partnerId = try values.decodeIfPresent(String.self, forKey: .partnerId)
     }
 
@@ -237,6 +241,7 @@ open class BaseEvent: EventOptions, Codable {
         try container.encode(quantity, forKey: .quantity)
         try container.encode(productId, forKey: .productId)
         try container.encode(revenueType, forKey: .revenueType)
+        try container.encode(currency, forKey: .currency)
         try container.encode(partnerId, forKey: .partnerId)
     }
 }

Sources/Amplitude/Events/EventOptions.swift

@@ -42,6 +42,7 @@ open class EventOptions {
     public var quantity: Int?
     public var productId: String?
     public var revenueType: String?
+    public var currency: String?
     public var extra: [String: Any]?
     public var callback: EventCallback?
     public var partnerId: String?
@@ -82,6 +83,7 @@ open class EventOptions {
         quantity: Int? = nil,
         productId: String? = nil,
         revenueType: String? = nil,
+        currency: String? = nil,
         extra: [String: Any]? = nil,
         callback: EventCallback? = nil,
         partnerId: String? = nil,
@@ -121,6 +123,7 @@ open class EventOptions {
         self.quantity = quantity
         self.productId = productId
         self.revenueType = revenueType
+        self.currency = currency
         self.extra = extra
         self.callback = callback
         self.partnerId = partnerId
@@ -162,6 +165,7 @@ open class EventOptions {
         quantity = eventOptions.quantity ?? quantity
         productId = eventOptions.productId ?? productId
         revenueType = eventOptions.revenueType ?? revenueType
+        currency = eventOptions.currency ?? currency
         extra = eventOptions.extra ?? extra
         callback = eventOptions.callback ?? callback
         partnerId = eventOptions.partnerId ?? partnerId

Sources/Amplitude/Events/Revenue.swift

@@ -13,6 +13,7 @@ public class Revenue {
         case REVENUE_QUANTITY = "$quantity"
         case REVENUE_PRICE = "$price"
         case REVENUE_TYPE = "$revenueType"
+        case REVENUE_CURRENCY = "$currency"
         case REVENUE_RECEIPT = "$receipt"
         case REVENUE_RECEIPT_SIG = "$receiptSig"
         case REVENUE = "$revenue"
@@ -70,6 +71,8 @@ public class Revenue {
 
     public var revenueType: String?
 
+    public var currency: String?
+
     public var receipt: String?
 
     public var receiptSig: String?
@@ -100,6 +103,9 @@ public class Revenue {
         if revenueType != nil {
             eventProperties[Property.REVENUE_TYPE.rawValue] = revenueType
         }
+        if currency != nil {
+            eventProperties[Property.REVENUE_CURRENCY.rawValue] = currency
+        }
         if receipt != nil {
             eventProperties[Property.REVENUE_RECEIPT.rawValue] = receipt
         }

Sources/Amplitude/ObjC/ObjCEventOptions.swift

@@ -352,6 +352,16 @@ public class ObjCEventOptions: NSObject {
         }
     }
 
+    @objc
+    public var currency: String? {
+        get {
+            options.currency
+        }
+        set(value) {
+            options.currency = value
+        }
+    }
+
     @objc
     public var extra: ObjCProperties {
         ObjCProperties(getter: { key in

Sources/Amplitude/ObjC/ObjCRevenue.swift

@@ -54,6 +54,16 @@ public class ObjCRevenue: NSObject {
         }
     }
 
+    @objc
+    public var currency: String? {
+        get {
+            instance.currency
+        }
+        set(value) {
+            instance.currency = value
+        }
+    }
+
     @objc
     public var receipt: String? {
         get {

Tests/AmplitudeTests/Events/RevenueTests.swift

@@ -91,6 +91,7 @@ final class RevenueTests: XCTestCase {
         revenue.quantity = 100
         revenue.price = 50.5
         revenue.revenueType = "test-type"
+        revenue.currency = "USD"
         revenue.receipt = "test-receipt"
         revenue.receiptSig = "test-receipt-sig"
         revenue.revenue = 5050
@@ -124,6 +125,10 @@ final class RevenueTests: XCTestCase {
             revenueEvent.eventProperties?[Revenue.Property.REVENUE.rawValue] as! Double,
             5050
         )
+        XCTAssertEqual(
+            revenueEvent.eventProperties?[Revenue.Property.REVENUE_CURRENCY.rawValue] as! String,
+            "USD"
+        )
     }
 }
 // swiftlint:enable force_cast