Added a rating field to the BUO (AIS-429). (#773)

Author: E-B-Smith

Branch-SDK/Branch-SDK/BranchUniversalObject.h

@@ -83,6 +83,7 @@ FOUNDATION_EXPORT BranchCondition _Nonnull BranchConditionRefurbished;
 @property (nonatomic, assign)           double          ratingAverage;
 @property (nonatomic, assign)           NSInteger       ratingCount;
 @property (nonatomic, assign)           double          ratingMax;
+@property (nonatomic, assign)           double          rating;
 @property (nonatomic, strong, nullable) NSString        *addressStreet;
 @property (nonatomic, strong, nullable) NSString        *addressCity;
 @property (nonatomic, strong, nullable) NSString        *addressRegion;

Branch-SDK/Branch-SDK/BranchUniversalObject.m

@@ -88,6 +88,7 @@ - (NSDictionary*_Nonnull) dictionary {
     addDouble(ratingAverage,    $rating_average);
     addInteger(ratingCount,     $rating_count);
     addDouble(ratingMax,        $rating_max);
+    addDouble(rating,           $rating);
     addString(addressStreet,    $address_street);
     addString(addressCity,      $address_city);
     addString(addressRegion,    $address_region);
@@ -122,6 +123,7 @@ + (BranchContentMetadata*_Nonnull) contentMetadataWithDictionary:(NSDictionary*_
     addDouble(ratingAverage,    $rating_average);
     addInteger(ratingCount,     $rating_count);
     addDouble(ratingMax,        $rating_max);
+    addDouble(rating,           $rating);
     addString(addressStreet,    $address_street);
     addString(addressCity,      $address_city);
     addString(addressRegion,    $address_region);
@@ -684,6 +686,7 @@ + (BranchUniversalObject*_Nonnull) objectWithDictionary:(NSDictionary*_Null_unsp
         @"$rating_average",
         @"$rating_count",
         @"$rating_max",
+        @"$rating",
         @"$address_street",
         @"$address_city",
         @"$address_region",

Branch-TestBed/Branch-SDK-Tests/Branch-SDK-Tests.strings

@@ -84,6 +84,7 @@ Instance 0x132585f70 is of class 'DumpClass' of class 'NSObject':
     \"$rating_average\": 5,
     \"$rating_count\": 5,
     \"$rating_max\": 7,
+    \"$rating\": 6,
     \"$condition\": \"FAIR\",
     \"$address_street\": \"Street_name1\",
     \"$address_city\": \"city1\",
@@ -158,6 +159,7 @@ Instance 0x132585f70 is of class 'DumpClass' of class 'NSObject':
         \"$rating_average\": 5,
         \"$rating_count\": 5,
         \"$rating_max\": 7,
+        \"$rating\": 6,
         \"$address_street\": \"Street_name1\",
         \"$address_city\": \"city1\",
         \"$address_region\": \"Region1\",

Branch-TestBed/Branch-SDK-Tests/BranchEvent.Test.m

@@ -68,6 +68,7 @@ - (void) testEvent {
     buo.contentMetadata.ratingAverage    = 5;
     buo.contentMetadata.ratingCount      = 5;
     buo.contentMetadata.ratingMax        = 7;
+    buo.contentMetadata.rating           = 6;
     buo.contentMetadata.addressStreet    = @"Street_name1";
     buo.contentMetadata.addressCity      = @"city1";
     buo.contentMetadata.addressRegion    = @"Region1";
@@ -214,6 +215,7 @@ - (void) testUserCompletedAction {
     buo.contentMetadata.ratingAverage    = 5;
     buo.contentMetadata.ratingCount      = 5;
     buo.contentMetadata.ratingMax        = 7;
+    buo.contentMetadata.rating           = 6;
     buo.contentMetadata.addressStreet    = @"Street_name1";
     buo.contentMetadata.addressCity      = @"city1";
     buo.contentMetadata.addressRegion    = @"Region1";

Branch-TestBed/Branch-SDK-Tests/BranchEvent.Test.swift

@@ -44,14 +44,18 @@ class BranchEventTestSwift : BNCTestCase {
         branchUniversalObject.contentMetadata.ratingAverage     = 5;
         branchUniversalObject.contentMetadata.ratingCount       = 5;
         branchUniversalObject.contentMetadata.ratingMax         = 7;
+        branchUniversalObject.contentMetadata.rating            = 6;
         branchUniversalObject.contentMetadata.addressStreet     = "Street_name1"
         branchUniversalObject.contentMetadata.addressCity       = "city1"
         branchUniversalObject.contentMetadata.addressRegion     = "Region1"
         branchUniversalObject.contentMetadata.addressCountry    = "Country1"
         branchUniversalObject.contentMetadata.addressPostalCode = "postal_code"
         branchUniversalObject.contentMetadata.latitude          = 12.07
         branchUniversalObject.contentMetadata.longitude         = -97.5
-        branchUniversalObject.contentMetadata.imageCaptions     = [ "my_img_caption1",  "my_img_caption_2"]
+        branchUniversalObject.contentMetadata.imageCaptions     = [
+            "my_img_caption1",
+            "my_img_caption_2"
+        ]
         branchUniversalObject.contentMetadata.customMetadata    = [
             "Custom_Content_metadata_key1": "Custom_Content_metadata_val1",
             "Custom_Content_metadata_key2": "Custom_Content_metadata_val2"

Branch-TestBed/Branch-SDK-Tests/BranchUniversalObject.Test.m

@@ -45,6 +45,7 @@ - (void) testDeserialize {
     XCTAssertEqual(buo.contentMetadata.ratingAverage,            5);
     XCTAssertEqual(buo.contentMetadata.ratingCount,              5);
     XCTAssertEqual(buo.contentMetadata.ratingMax,                7);
+    XCTAssertEqual(buo.contentMetadata.rating,                   6);
     XCTAssertEqualObjects(buo.contentMetadata.addressStreet,     @"Street_name1");
     XCTAssertEqualObjects(buo.contentMetadata.addressCity,       @"city1");
     XCTAssertEqualObjects(buo.contentMetadata.addressRegion,     @"Region1");
@@ -107,6 +108,7 @@ - (void) testSerialize {
     buo.contentMetadata.ratingAverage =       5;
     buo.contentMetadata.ratingCount =         5;
     buo.contentMetadata.ratingMax =           7;
+    buo.contentMetadata.rating =              6;
     buo.contentMetadata.addressStreet =       @"Street_name1";
     buo.contentMetadata.addressCity =         @"city1";
     buo.contentMetadata.addressRegion =       @"Region1";
@@ -125,11 +127,12 @@ - (void) testSerialize {
     buo.keywords =                       @[@"My_Keyword1", @"My_Keyword2"];
     buo.contentDescription =             @"my_product_description1";
     buo.imageUrl =                       @"https://test_img_url";
-    buo.expirationDate =                 [NSDate dateWithTimeIntervalSince1970:(double)212123232544.0/1000.0];
+    buo.expirationDate =
+        [NSDate dateWithTimeIntervalSince1970:(double)212123232544.0/1000.0];
     buo.publiclyIndex =                  NO;
     buo.locallyIndex =                   YES;
-    buo.creationDate =                   [NSDate dateWithTimeIntervalSince1970:(double)1501869445321.0/1000.0];
-
+    buo.creationDate =
+        [NSDate dateWithTimeIntervalSince1970:(double)1501869445321.0/1000.0];
     NSDictionary *buoDictionary = buo.dictionary;
 
     // Load the JSON:

Branch-TestBed/Branch-TestBed/ViewController.m

@@ -265,6 +265,7 @@ - (IBAction)shareLinkButtonTouchUpInside:(id)sender {
     buo.contentMetadata.ratingAverage    = 5;
     buo.contentMetadata.ratingCount      = 5;
     buo.contentMetadata.ratingMax        = 7;
+    buo.contentMetadata.rating           = 6;
     buo.contentMetadata.addressStreet    = @"Street_name1";
     buo.contentMetadata.addressCity      = @"city1";
     buo.contentMetadata.addressRegion    = @"Region1";
@@ -455,6 +456,7 @@ - (void) sendV2EventWithName:(NSString*)eventName {
     buo.contentMetadata.ratingAverage    = 5;
     buo.contentMetadata.ratingCount      = 5;
     buo.contentMetadata.ratingMax        = 7;
+    buo.contentMetadata.rating           = 6;
     buo.contentMetadata.addressStreet    = @"Street_name1";
     buo.contentMetadata.addressCity      = @"city1";
     buo.contentMetadata.addressRegion    = @"Region1";