Merge pull request #478 from Iterable/MOB-2921-trackpurchase-api

[MOB-2921] update commerceitem to allow optional fields

Author: roninopf

swift-sdk/CommerceItem.swift

@@ -4,49 +4,101 @@
 
 import UIKit
 
-/**
- `CommerceItem` represents a product. These are used by the commerce API; see [IterableAPI trackPurchase:items:dataFields:]
- */
+/// `CommerceItem` represents a product
+/// - SeeAlso: IterableAPI.track(purchase withTotal: items:)
 @objcMembers public class CommerceItem: NSObject {
-    /** id of this product */
+    /// id of this product
     public var id: String
 
-    /** name of this product */
+    /// name of this product
     public var name: String
 
-    /** price of this product */
+    /// price of this product
     public var price: NSNumber
 
-    /** quantity of this product */
+    /// quantity of this product
     public var quantity: UInt
 
-    /**
-     Creates a `CommerceItem` with the specified properties
-     
-     - parameters:
-     - id:          id of the product
-     - name:        name of the product
-     - price:       price of the product
-     - quantity:    quantity of the product
-     
-     - returns: an instance of `CommerceItem` with the specified properties
-     */
-    public init(id: String, name: String, price: NSNumber, quantity: UInt) {
+    /// SKU of this product
+    public var sku: String?
+    
+    /// description of the product
+    /// the class field is named `itemDescription` to avoid iOS namespace (`description`)
+    public var itemDescription: String?
+    
+    /// URL of the product
+    public var url: String?
+    
+    /// URL of the product's image
+    public var imageUrl: String?
+    
+    /// categories this product belongs to
+    /// each category is a breadcrumb in list form
+    public var categories: [String]?
+    
+    /// Creates a `CommerceItem` with the specified properties
+    ///
+    /// - Parameters:
+    ///     - id: id of the product
+    ///     - name: name of the product
+    ///     - price: price of the product
+    ///     - quantity: quantity of the product
+    ///     - sku: SKU of the eproduct
+    ///     - description: description of the product
+    ///     - url: URL of the product
+    ///     - imageUrl: URL of the product's image
+    ///     - categories: categories this product belongs to
+    ///
+    /// - returns: an instance of `CommerceItem` with the specified properties
+    public init(id: String,
+                name: String,
+                price: NSNumber,
+                quantity: UInt,
+                sku: String? = nil,
+                description: String? = nil,
+                url: String? = nil,
+                imageUrl: String? = nil,
+                categories: [String]? = nil) {
         self.id = id
         self.name = name
         self.price = price
         self.quantity = quantity
+        self.sku = sku
+        self.itemDescription = description
+        self.url = url
+        self.imageUrl = imageUrl
+        self.categories = categories
     }
 
-    /**
-     A Dictionary respresentation of this item
-     
-     - returns: An NSDictionary representing this item
-     */
+    /// A `Dictionary` representation of this item
+    ///
+    /// - returns: An `Dictionary` representing this item
     public func toDictionary() -> [AnyHashable: Any] {
-        ["id": id,
-         "name": name,
-         "price": price,
-         "quantity": quantity]
+        var dictionary: [AnyHashable: Any] = [JsonKey.CommerceItem.id: id,
+                                              JsonKey.CommerceItem.name: name,
+                                              JsonKey.CommerceItem.price: price,
+                                              JsonKey.CommerceItem.quantity: quantity]
+        
+        if let sku = sku {
+            dictionary[JsonKey.CommerceItem.sku] = sku
+        }
+        
+        if let description = itemDescription {
+            dictionary[JsonKey.CommerceItem.description] = description
+        }
+        
+        if let url = url {
+            dictionary[JsonKey.CommerceItem.url] = url
+        }
+        
+        if let imageUrl = imageUrl {
+            dictionary[JsonKey.CommerceItem.imageUrl] = imageUrl
+        }
+        
+        if let categories = categories {
+            dictionary[JsonKey.CommerceItem.categories] = categories
+        }
+        
+        return dictionary
     }
 }

swift-sdk/Constants.swift

@@ -159,6 +159,18 @@ enum JsonKey {
         static let user = "user"
     }
 
+    enum CommerceItem {
+        static let id = "id"
+        static let name = "name"
+        static let price = "price"
+        static let quantity = "quantity"
+        static let sku = "sku"
+        static let description = "description"
+        static let imageUrl = "imageUrl"
+        static let url = "url"
+        static let categories = "categories"
+    }
+    
     enum Device {
         static let localizedModel = "localizedModel"
         static let vendorId = "identifierForVendor"

swift-sdk/Internal/RequestCreator.swift

@@ -89,12 +89,8 @@ struct RequestCreator {
             ITBError("Both email and userId are nil")
             return .failure(IterableError.general(description: "Both email and userId are nil"))
         }
-
-        var itemsToSerialize = [[AnyHashable: Any]]()
 
-        for item in items {
-            itemsToSerialize.append(item.toDictionary())
-        }
+        let itemsToSerialize = items.map { $0.toDictionary() }
 
         var apiUserDict = [AnyHashable: Any]()
 

tests/unit-tests/CommerceItemTests.swift

@@ -7,7 +7,7 @@ import XCTest
 @testable import IterableSDK
 
 class CommerceItemTests: XCTestCase {
-    func testToDictionary() {
+    func testToDictionaryWithRequiredFields() {
         let commerceItemDictionary = CommerceItem(id: "commerceItemId", name: "commerceItemName", price: 6, quantity: 9000).toDictionary()
 
         let expected: [AnyHashable: Any] = ["id": "commerceItemId",
@@ -17,4 +17,30 @@ class CommerceItemTests: XCTestCase {
 
         XCTAssertEqual(NSDictionary(dictionary: commerceItemDictionary), NSDictionary(dictionary: expected))
     }
+    
+    func testToDictionaryWithAllFields() {
+        let itemDictionary = CommerceItem(id: "THINKTANK",
+                                          name: "Tachikoma",
+                                          price: 7.62,
+                                          quantity: 9,
+                                          sku: "kusanagi",
+                                          description: "spider type multi leg/multi ped combat vehicle equipped with AI",
+                                          url: "stand-alone-complex",
+                                          imageUrl: "laughing-man",
+                                          categories: ["section 9",
+                                                       "personnel transport"]).toDictionary()
+        
+        let expected: [AnyHashable: Any] = ["id": "THINKTANK",
+                                            "name": "Tachikoma",
+                                            "price": 7.62,
+                                            "quantity": 9,
+                                            "sku": "kusanagi",
+                                            "description": "spider type multi leg/multi ped combat vehicle equipped with AI",
+                                            "url": "stand-alone-complex",
+                                            "imageUrl": "laughing-man",
+                                            "categories": ["section 9",
+                                                           "personnel transport"]]
+        
+        XCTAssertEqual(NSDictionary(dictionary: itemDictionary), NSDictionary(dictionary: expected))
+    }
 }