Introduce live variable class and getters (#35)

Author: haleybash-optimizely

OptimizelySDKCore/OptimizelySDKCore.xcodeproj/project.pbxproj

@@ -10,6 +10,10 @@
 		242C5560BF8316BF4ECE55C7 /* Pods_OptimizelySDKCoreiOSTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8766E217ECD3BEA353B080F5 /* Pods_OptimizelySDKCoreiOSTests.framework */; };
 		2D5457521DC903410095E286 /* Pods_OptimizelySDKCoreiOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2D5457511DC903410095E286 /* Pods_OptimizelySDKCoreiOS.framework */; };
 		4FFB468BAFC670CF55514638 /* Pods_OptimizelySDKCoreTVOSTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9A3A368275572C29A76DC80A /* Pods_OptimizelySDKCoreTVOSTests.framework */; };
+		5E3C0E701DDF7A290025DB85 /* OPTLYVariable.m in Sources */ = {isa = PBXBuildFile; fileRef = 5ECBBE671DDE6A800028FF6B /* OPTLYVariable.m */; };
+		5E3C0E711DDF7A3C0025DB85 /* OPTLYVariable.h in Headers */ = {isa = PBXBuildFile; fileRef = 5ECBBE661DDE6A800028FF6B /* OPTLYVariable.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		5ECBBE681DDE6A800028FF6B /* OPTLYVariable.h in Headers */ = {isa = PBXBuildFile; fileRef = 5ECBBE661DDE6A800028FF6B /* OPTLYVariable.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		5ECBBE691DDE6A800028FF6B /* OPTLYVariable.m in Sources */ = {isa = PBXBuildFile; fileRef = 5ECBBE671DDE6A800028FF6B /* OPTLYVariable.m */; };
 		701BE1AAFCB6528297D6BCC4 /* Pods_OptimizelySDKCoreTVOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BE0C3BD9DC6186DB98A667C2 /* Pods_OptimizelySDKCoreTVOS.framework */; };
 		73A56DE44E21EDBF3369AA44 /* Pods_OptimizelySDKCoreiOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 8B04E0101E180FAD8C9CA7A6 /* Pods_OptimizelySDKCoreiOS.framework */; };
 		EA064BC71DD3FC8800DF7537 /* OPTLYQueue.h in Headers */ = {isa = PBXBuildFile; fileRef = EA064BC51DD3FC8800DF7537 /* OPTLYQueue.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -230,6 +234,8 @@
 		4AD98EC23436656DED35EBED /* Pods-OptimizelySDKCoreTVOS.beta.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKCoreTVOS.beta.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKCoreTVOS/Pods-OptimizelySDKCoreTVOS.beta.xcconfig"; sourceTree = "<group>"; };
 		51B050141BF2E9277B39EEE8 /* Pods-OptimizelySDKCoreiOSTests.rc.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKCoreiOSTests.rc.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKCoreiOSTests/Pods-OptimizelySDKCoreiOSTests.rc.xcconfig"; sourceTree = "<group>"; };
 		535C603DDFD996B277A0E064 /* Pods-OptimizelySDKCoreiOS.rc.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKCoreiOS.rc.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKCoreiOS/Pods-OptimizelySDKCoreiOS.rc.xcconfig"; sourceTree = "<group>"; };
+		5ECBBE661DDE6A800028FF6B /* OPTLYVariable.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OPTLYVariable.h; sourceTree = "<group>"; };
+		5ECBBE671DDE6A800028FF6B /* OPTLYVariable.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYVariable.m; sourceTree = "<group>"; };
 		8766E217ECD3BEA353B080F5 /* Pods_OptimizelySDKCoreiOSTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelySDKCoreiOSTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		8B04E0101E180FAD8C9CA7A6 /* Pods_OptimizelySDKCoreiOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelySDKCoreiOS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		924C83E5511EF3E43FC015AF /* Pods-OptimizelySDKCoreTVOSTests.rc.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKCoreTVOSTests.rc.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKCoreTVOSTests/Pods-OptimizelySDKCoreTVOSTests.rc.xcconfig"; sourceTree = "<group>"; };
@@ -481,6 +487,8 @@
 				EA2FAA7F1DC6F57100B1D81B /* OPTLYProjectConfig.m */,
 				EA2FAA801DC6F57100B1D81B /* OPTLYTrafficAllocation.h */,
 				EA2FAA811DC6F57100B1D81B /* OPTLYTrafficAllocation.m */,
+				5ECBBE661DDE6A800028FF6B /* OPTLYVariable.h */,
+				5ECBBE671DDE6A800028FF6B /* OPTLYVariable.m */,
 				EA2FAA821DC6F57100B1D81B /* OPTLYVariation.h */,
 				EA2FAA831DC6F57100B1D81B /* OPTLYVariation.m */,
 			);
@@ -653,6 +661,7 @@
 				EA2FAB281DC6F59100B1D81B /* OPTLYBucketer.h in Headers */,
 				EA2FAB201DC6F58800B1D81B /* OPTLYBuilder.h in Headers */,
 				EA2FAB521DC6F5BE00B1D81B /* OPTLYLogger.h in Headers */,
+				5ECBBE681DDE6A800028FF6B /* OPTLYVariable.h in Headers */,
 				EA2FAB581DC6F5BE00B1D81B /* OPTLYLoggerMessages.h in Headers */,
 				EA2FAB181DC6F57200B1D81B /* OPTLYVariation.h in Headers */,
 				EA2FAB821DC6FA7D00B1D81B /* OptimizelySDKCore.h in Headers */,
@@ -698,6 +707,7 @@
 				EA2FAB331DC6F59D00B1D81B /* OPTLYErrorHandler.h in Headers */,
 				EA2FAB211DC6F58800B1D81B /* OPTLYBuilder.h in Headers */,
 				EA2FAB191DC6F57200B1D81B /* OPTLYVariation.h in Headers */,
+				5E3C0E711DDF7A3C0025DB85 /* OPTLYVariable.h in Headers */,
 				EA2FAB531DC6F5BE00B1D81B /* OPTLYLogger.h in Headers */,
 				EA2FAB591DC6F5BE00B1D81B /* OPTLYLoggerMessages.h in Headers */,
 				EA2FAB831DC6FCD300B1D81B /* OptimizelySDKCore.h in Headers */,
@@ -1098,6 +1108,7 @@
 				EA2FAC221DC6FFC600B1D81B /* OPTLYErrorHandlerMessages.m in Sources */,
 				EA2FAC241DC6FFC600B1D81B /* OPTLYEventBuilder.m in Sources */,
 				EA2FAC251DC6FFC600B1D81B /* OPTLYLogger.m in Sources */,
+				5ECBBE691DDE6A800028FF6B /* OPTLYVariable.m in Sources */,
 				EA2FAC261DC6FFC600B1D81B /* OPTLYLoggerMessages.m in Sources */,
 				EA2FAC291DC6FFC600B1D81B /* OPTLYLog.m in Sources */,
 				EA2FAC2A1DC6FFC600B1D81B /* OPTLYValidator.m in Sources */,
@@ -1162,6 +1173,7 @@
 				EA2FABFD1DC6FFA100B1D81B /* OPTLYErrorHandlerMessages.m in Sources */,
 				EA2FABFF1DC6FFA100B1D81B /* OPTLYEventBuilder.m in Sources */,
 				EA2FAC001DC6FFA100B1D81B /* OPTLYLogger.m in Sources */,
+				5E3C0E701DDF7A290025DB85 /* OPTLYVariable.m in Sources */,
 				EA2FAC011DC6FFA100B1D81B /* OPTLYLoggerMessages.m in Sources */,
 				EA2FAC041DC6FFA100B1D81B /* OPTLYLog.m in Sources */,
 				EA2FAC051DC6FFA100B1D81B /* OPTLYValidator.m in Sources */,

OptimizelySDKCore/OptimizelySDKCore/OPTLYDatafileKeys.h

@@ -61,13 +61,19 @@ extern NSString * const OPTLYDatafileKeysTrafficAllocationEndOfRange;
 // Variations
 extern NSString * const OPTLYDatafileKeysVariationId;
 extern NSString * const OPTLYDatafileKeysVariationKey;
+extern NSString * const OPTLYDatafileKeysVariationVariables;
 // Conditions
 extern NSString * const OPTLYDatafileKeysConditionName;
 extern NSString * const OPTLYDatafileKeysConditionType;
 extern NSString * const OPTLYDatafileKeysConditionValue;
 extern NSString * const OPTLYDatafileKeysAndCondition;
 extern NSString * const OPTLYDatafileKeysNotCondition;
 extern NSString * const OPTLYDatafileKeysOrCondition;
+// Live Variables
+extern NSString * const OPTLYDatafileKeysVariableId;
+extern NSString * const OPTLYDatafileKeysVariableKey;
+extern NSString * const OPTLYDatafileKeysVariableType;
+extern NSString * const OPTLYDatafileKeysVariableValue;
 
 @interface OPTLYDatafileKeys : NSObject
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYDatafileKeys.m

@@ -57,13 +57,19 @@
 // Variations
 NSString * const OPTLYDatafileKeysVariationId = @"id";
 NSString * const OPTLYDatafileKeysVariationKey = @"key";
+NSString * const OPTLYDatafileKeysVariationVariables = @"variables";
 // Conditions
 NSString * const OPTLYDatafileKeysConditionName = @"name";
 NSString * const OPTLYDatafileKeysConditionType = @"type";
 NSString * const OPTLYDatafileKeysConditionValue = @"value";
 NSString * const OPTLYDatafileKeysAndCondition = @"and";
 NSString * const OPTLYDatafileKeysNotCondition = @"not";
 NSString * const OPTLYDatafileKeysOrCondition = @"or";
+// Live Variables
+NSString * const OPTLYDatafileKeysVariableId = @"id";
+NSString * const OPTLYDatafileKeysVariableKey = @"key";
+NSString * const OPTLYDatafileKeysVariableType = @"type";
+NSString * const OPTLYDatafileKeysVariableValue = @"value";
 
 @implementation OPTLYDatafileKeys
 @end

OptimizelySDKCore/OptimizelySDKCore/OPTLYErrorHandlerMessages.h

@@ -43,6 +43,7 @@ extern NSString * const OPTLYErrorHandlerMessagesBucketingIdInvalid;
 extern NSString * const OPTLYErrorHandlerMessagesTrafficAllocationUnknown;
 extern NSString * const OPTLYErrorHandlerMessagesEventDispatchFailed;
 extern NSString * const OPTLYErrorHandlerMessagesConfigInvalid;
+extern NSString * const OPTLYErrorHandlerMessagesLiveVariableKeyUnknown;
 
 extern NSString * const OPTLYErrorHandlerMessagesManagerBuilderInvalid;
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYErrorHandlerMessages.m

@@ -42,6 +42,7 @@
 NSString * const OPTLYErrorHandlerMessagesTrafficAllocationUnknown = @"Traffic allocations for %@ does not exist in datafile."; // experiment or group id
 NSString * const OPTLYErrorHandlerMessagesEventDispatchFailed = @"Event %@ failed to dispatch.";
 NSString * const OPTLYErrorHandlerMessagesConfigInvalid = @"Project config is nil or invalid";
+NSString * const OPTLYErrorHandlerMessagesLiveVariableKeyUnknown = @"Live variable key %@ is not in datafile."; // live variable key
 
 // Manager Errors
 NSString *const OPTLYErrorHandlerMessagesManagerBuilderInvalid = @"Provided OPTLYManagerBuilder object is invalid";

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.h

@@ -70,6 +70,8 @@ extern NSString *const OPTLYLoggerMessagesAttributeUnknownForAttributeKey;
 extern NSString *const OPTLYLoggerMessagesAudienceUnknownForAudienceId;
 extern NSString *const OPTLYLoggerMessagesGroupUnknownForGroupId;
 extern NSString *const OPTLYLoggerMessagesEventDispatcherInterval;
+extern NSString *const OPTLYLoggerMessagesVariableUnknownForVariableKey;
+extern NSString *const OPTLYLoggerMessagesNoVariationFoundForExperimentWithLiveVariable;
 
 // ---- debug ----
 extern NSString *const OPTLYLoggerMessagesImpressionDispatching;

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.m

@@ -51,6 +51,7 @@
 NSString *const OPTLYLoggerMessagesNotTrackedDispatchFailed = @"Not tracking event %@ for user %@. Event dispatch failed."; // event key, userId
 NSString *const OPTLYLoggerMessagesExperimentIdUnknown = @"Experiment id for %@ is not in the datafile."; // experiment key
 NSString *const OPTLYLoggerMessagesEventIdUnknown = @"Event id %@ is not in the datafile."; //event key
+NSString *const OPTLYLoggerMessagesNoVariationFoundForExperimentWithLiveVariable = @"Variation not found for user ID: %@ with experiment key: %@ containing live variable: %@.";
 // conversion and tracking event creation errors
 NSString *const OPTLYLoggerMessagesVariationtNameInvalid = @"Variation name is not valid.";
 NSString *const OPTLYLoggerMessagesUserIdInvalid = @"User id is not valid.";
@@ -68,6 +69,7 @@
 NSString *const OPTLYLoggerMessagesAttributeUnknownForAttributeKey = @"Attribute not found for attribute key: %@."; // attribute key
 NSString *const OPTLYLoggerMessagesAudienceUnknownForAudienceId = @"Audience not found for audience id: %@."; // audience id
 NSString *const OPTLYLoggerMessagesGroupUnknownForGroupId = @"Group not found for group id: %@."; // group id
+NSString *const OPTLYLoggerMessagesVariableUnknownForVariableKey = @"Live variable not found for variable key: %@."; // live variable key
 
 NSString *const OPTLYLoggerMessagesEventDispatcherInterval = @"Event dispatcher interval set: %ld";
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYProjectConfig.h

@@ -17,8 +17,8 @@
 #import <Foundation/Foundation.h>
 #import <JSONModel/JSONModelLib.h>
 
-@class OPTLYExperiment, OPTLYGroup, OPTLYEvent, OPTLYAttribute, OPTLYAudience, OPTLYVariation, OPTLYBucketer;
-@protocol OPTLYExperiment, OPTLYEvent, OPTLYAudience, OPTLYAttribute, OPTLYGroup, OPTLYExperiment, OPTLYLogger, OPTLYErrorHandler, OPTLYBucketer;
+@class OPTLYExperiment, OPTLYGroup, OPTLYEvent, OPTLYAttribute, OPTLYAudience, OPTLYVariation, OPTLYVariable, OPTLYBucketer;
+@protocol OPTLYExperiment, OPTLYEvent, OPTLYAudience, OPTLYAttribute, OPTLYGroup, OPTLYVariable, OPTLYLogger, OPTLYErrorHandler, OPTLYBucketer;
 
 /*
     This class represents all the data contained in the project datafile 
@@ -45,6 +45,8 @@
 @property (nonatomic, strong, nonnull) NSArray<OPTLYAttribute> *attributes;
 /// List of group objects
 @property (nonatomic, strong, nonnull) NSArray<OPTLYGroup> *groups;
+/// List of live variable objects
+@property (nonatomic, strong, nonnull) NSArray<OPTLYVariable> *variables;
 
 /// a comprehensive list of experiments that includes experiments being whitelisted (in Groups)
 @property (nonatomic, strong, nullable) NSArray<OPTLYExperiment, Ignore> *allExperiments;
@@ -98,6 +100,11 @@
  */
 - (nullable OPTLYAudience *)getAudienceForId:(nonnull NSString *)audienceId;
 
+/**
+ * Get a variable for a given live variable key.
+ */
+- (nullable OPTLYVariable *)getVariableForVariableKey:(nonnull NSString *)variableKey;
+
 /**
  * Get variation for experiment and user ID with user attributes.
  */

OptimizelySDKCore/OptimizelySDKCore/OPTLYProjectConfig.m

@@ -26,6 +26,7 @@
 #import "OPTLYLogger.h"
 #import "OPTLYProjectConfig.h"
 #import "OPTLYValidator.h"
+#import "OPTLYVariable.h"
 
 NSString * const kClientEngine             = @"objective-c-sdk-core";
 
@@ -39,6 +40,7 @@ @interface OPTLYProjectConfig()
 @property (nonatomic, strong) NSDictionary<NSString *, NSString *><Ignore> *experimentKeyToExperimentIdMap;
 @property (nonatomic, strong) NSDictionary<NSString *, OPTLYGroup *><Ignore> *groupIdToGroupMap;
 @property (nonatomic, strong) NSDictionary<NSString *, OPTLYAttribute *><Ignore> *attributeKeyToAttributeMap;
+@property (nonatomic, strong) NSDictionary<NSString *, OPTLYVariable *><Ignore> *variableKeyToVariableMap;
 
 @end
 
@@ -185,6 +187,15 @@ - (OPTLYGroup *)getGroupForGroupId:(NSString *)groupId {
     return group;
 }
 
+- (OPTLYVariable *)getVariableForVariableKey:(NSString *)variableKey {
+    OPTLYVariable *variable = self.variableKeyToVariableMap[variableKey];
+    if (!variable) {
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesVariableUnknownForVariableKey, variableKey];
+        [self.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+    }
+    return variable;
+}
+
 #pragma mark -- Property Getters --
 
 - (NSArray *)allExperiments
@@ -261,6 +272,13 @@ - (NSDictionary *)eventKeyToEventMap {
     return _groupIdToGroupMap;
 }
 
+- (NSDictionary<NSString *, OPTLYVariable *> *)variableKeyToVariableMap {
+    if (!_variableKeyToVariableMap) {
+        _variableKeyToVariableMap = [self generateVariableKeyToVariableMap];
+    }
+    return _variableKeyToVariableMap;
+}
+
 #pragma mark -- Generate Mappings --
 
 - (NSDictionary *)generateAudienceIdToAudienceMap
@@ -342,6 +360,14 @@ - (NSDictionary *)generateAttributeToKeyMap
     return [NSDictionary dictionaryWithDictionary:map];
 }
 
+- (NSDictionary<NSString *, OPTLYVariable *> *)generateVariableKeyToVariableMap {
+    NSMutableDictionary *map = [[NSMutableDictionary alloc] init];
+    for (OPTLYVariable *variable in self.variables) {
+        map[variable.variableKey] = variable;
+    }
+    return [NSDictionary dictionaryWithDictionary:map];
+}
+
 # pragma mark - Helper Methods
 
 - (OPTLYVariation *)getVariationForExperiment:(NSString *)experimentKey

OptimizelySDKCore/OptimizelySDKCore/OPTLYVariable.h

@@ -0,0 +1,38 @@
+/****************************************************************************
+ * Copyright 2016, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+
+#import <Foundation/Foundation.h>
+#import <JSONModel/JSONModelLib.h>
+
+/**
+ * This class is a representation of an Optimizely live variable.
+ */
+
+@protocol OPTLYVariable
+@end
+
+@interface OPTLYVariable : JSONModel
+
+/// The variable's ID.
+@property (nonatomic, strong) NSString *variableId;
+/// The variable's Key.
+@property (nonatomic, strong) NSString *variableKey;
+/// The variable's type.
+@property (nonatomic, strong) NSString *type;
+/// The variable's default value.
+@property (nonatomic, strong) NSString *value;
+
+@end