Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/optimizely/objective-c-sdk
Optimizely X Objective-C SDK for iOS and tvOS
https://github.com/optimizely/objective-c-sdk
optimizely-environment-prod optimizely-environment-public optimizely-owner-px
Last synced: about 1 month ago
JSON representation
Optimizely X Objective-C SDK for iOS and tvOS
- Host: GitHub
- URL: https://github.com/optimizely/objective-c-sdk
- Owner: optimizely
- License: apache-2.0
- Created: 2016-09-27T23:32:27.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-14T15:49:41.000Z (over 1 year ago)
- Last Synced: 2024-04-29T22:07:35.867Z (8 months ago)
- Topics: optimizely-environment-prod, optimizely-environment-public, optimizely-owner-px
- Language: Objective-C
- Homepage:
- Size: 450 MB
- Stars: 24
- Watchers: 106
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Objective-C SDK
[](http://www.apache.org/licenses/LICENSE-2.0)
[](https://github.com/carthage/carthage)
[](https://cocoapods.org/pods/OptimizelySDKiOS)
[](https://cocoapods.org/pods/OptimizelySDKTVOS)
This repository houses the Objective-C SDK for use with Optimizely Full Stack and Optimizely Rollouts for Mobile and OTT.
Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/full-stack/docs).
Optimizely Rollouts is free feature flags for development teams. Easily roll out and roll back features in any application without code deploys. Mitigate risk for every feature on your roadmap. Learn more at https://www.optimizely.com/rollouts/, or see the [documentation](https://docs.developers.optimizely.com/rollouts/docs).
## Getting Started
---
**NOTE**
For new and upgrading iOS users, it's recommended to use our new [Swift-SDK](https://github.com/optimizely/swift-sdk) written completely in Swift. The Swift SDK will serve as our primary iOS SDK for new development moving forward. It is functionally compatible with the Objective-C SDK and provides an extended feature set with simplified interfaces.
Existing Objective-C SDK users can look at our [guide document](https://docs.developers.optimizely.com/full-stack/docs/migrate-to-swift-sdk) for migrating into the new Swift SDK.
---
### Using the SDK
See [Install the iOS and tvOS SDKs](https://docs.developers.optimizely.com/full-stack/docs/install-sdk-objective-c) to learn how to set
up an Optimizely X project and start using the SDK.
### Requirements
* iOS 8.0+ / tvOS 9.0+
### Installing the SDK
Please note below that _\_ is used to represent the platform on which you are building your app. Currently, we support ```iOS``` and ```tvOS``` platforms.
**note: if you or another framework are using sqlite, then you should probably add compiler options for thead safe sqlite: SQLITE_THREADSAFE=1
https://www.sqlite.org/threadsafe.html
#### Cocoapod
1. Add the following lines to the _Podfile_:
```use_frameworks!```
```pod 'OptimizelySDK', '~> 3.1.5'```
2. Run the following command:
``` pod install ```
Further installation instructions for Cocoapods: https://guides.cocoapods.org/using/getting-started.html
#### Carthage
1. Add the following lines to the _Cartfile_:
github "optimizely/objective-c-sdk" ~> 3.1.5
2. Run the following command:
```carthage update```
3. Link the frameworks to your project. Go to your project target's **Link Binary With Libraries** and drag over the following from the _Carthage/Build/\_ folder:
OptimizelySDKCore.framework
OptimizelySDKDatafileManager.framework
OptimizelySDKEventDispatcher.framework
OptimizelySDKShared.framework
OptimizelySDKUserProfileService.framework
OptimizelySDK\.framework
4. To ensure that proper bitcode-related files and dSYMs are copied when archiving your app, you will need to install a Carthage build script:
- Add a new **Run Script** phase in your target's **Build Phase**.
- In the script area include:
```/usr/local/bin/carthage copy-frameworks```
- Add the paths to the frameworks to the **Input Files** list:
```$(SRCROOT)/Carthage/Build//OptimizelySDKCore.framework```
```$(SRCROOT)/Carthage/Build//OptimizelySDKDatafileManager.framework```
```$(SRCROOT)/Carthage/Build//OptimizelySDKEventDispatcher.framework```
```$(SRCROOT)/Carthage/Build//OptimizelySDKShared.framework```
```$(SRCROOT)/Carthage/Build//OptimizelySDKUserProfileService.framework```
```$(SRCROOT)/Carthage/Build//OptimizelySDK.framework```
- Add the paths to the copied frameworks to the **Output Files** list:
```$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/OptimizelySDKCore.framework```
```$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/OptimizelySDKDatafileManager.framework```
```$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/OptimizelySDKEventDispatcher.framework```
```$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/OptimizelySDKShared.framework```
```$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/OptimizelySDKUserProfileService.framework```
```$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/OptimizelySDK.framework```
Futher installation instructions for Carthage: https://github.com/Carthage/Carthage
#### Manual Installation
The universal framework can be used in an application without the need for a third-party dependency manager. The universal framework packages up all Optimizely X Mobile modules, which include:
```OptimizelySDKCore```
```OptimizelySDKShared```
```OptimizelySDKDatafileManager```
```OptimizelySDKEventDispatcher```
```OptimizelySDKUserProfileService```
The universal framework for iOS includes builds for the following architectures:
```i386```
```x86_64```
```ARMv7```
```ARMv7s```
```ARM64```
The universal framework for tvOS includes builds for the following architectures:
```x86_64```
```ARM64```
Bitcode is enabled for both the iOS and tvOS universal frameworks.
In order to install the universal framework, follow the steps below:
1. Download the [iOS](./OptimizelySDKUniversal/generated-frameworks/Release-iOS-universal-SDK/OptimizelySDKiOS.framework.zip) or [tvOS](./OptimizelySDKUniversal/generated-frameworks/Release-tvOS-universal-SDK/OptimizelySDKTVOS.framework.zip) framework.
2. Unzip the framework, then drag the framework to your project in Xcode; Xcode should prompt you to select a target. Go to **Build Phases** and make sure that the framework is under the **Link Binary with Libraries** section.
3. Go to the **General** tab and add the framework to the **Embedded Binaries** section. If the **Embedded Binaries** section is not visible, add the framework in the **Copy Files** section (you can add this section in **Build Settings**).
4. The Apple store will reject your app if you have the universal framework installed as it includes simulator binaries. Therefore, a script to strip the extra binaries needs to be run before you upload the app. To do this, go to **Build Phases** and add a **Run Script** section by clicking the ```+``` symbol. Copy and paste the following script (make sure you replace the ```FRAMEWORK_NAME``` with the proper framework name!
):
```
FRAMEWORK="FRAMEWORK_NAME"
FRAMEWORK_EXECUTABLE_PATH="${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/$FRAMEWORK.framework/$FRAMEWORK"
EXTRACTED_ARCHS=()
for ARCH in $ARCHS
do
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"
```
If you choose to build the universal framework yourself, you can do so by running the ```OptimizelySDKiOS-Universal``` or ```OptimizelySDKTVOS-Universal``` schemes. After building these schemes, the frameworks are output in the **OptimizelySDKUniversal/generated-frameworks** folder.
### Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md).
### Credits
First-party code (under OptimizelySDKCore/, OptimizelySDKDatafileManager/, OptimizelySDKEventDispatcher/, OptimizelySDKiOS/, OptimizelySDKShared/, OptimizelySDKTVOS/, OptimizelySDKUniversal/, OptimizelySDKUserProfileService/, ) is copyright Optimizely, Inc. and contributors, licensed under Apache 2.0.
### Additional Code
**FMDB** [https://github.com/ccgus/fmdb](https://github.com/ccgus/fmdb)
License (MIT):: [https://github.com/ccgus/fmdb/blob/master/LICENSE.txt](https://github.com/ccgus/fmdb/blob/master/LICENSE.txt)
Modified: Yes
Distributed: Yes
Distribution: Binary
**SQLITE3** [https://www.sqlite.org/index.html](https://www.sqlite.org/index.html)
License (Public Domain):: [https://www.sqlite.org/copyright.html](https://www.sqlite.org/copyright.html)
Modified: Yes
Distributed: Yes
Distribution: Binary
**JSONModel** [https://github.com/jsonmodel/jsonmodel](https://github.com/jsonmodel/jsonmodel)
License (MIT):: [https://github.com/jsonmodel/jsonmodel/blob/master/LICENSEl](https://github.com/jsonmodel/jsonmodel/blob/master/LICENSE)
Modified: Yes
Distributed: Yes
Distribution: Binary
**murmur3** [https://github.com/PeterScott/murmur3l](https://github.com/PeterScott/murmur3)
License (Public Domain):: [https://github.com/PeterScott/murmur3l](https://github.com/PeterScott/murmur3)
Modified: No
Distributed: Yes
Distribution: Binary