Swiftpack.co - configcat/swift-sdk as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by configcat.
configcat/swift-sdk 8.0.1
Swift SDK for ConfigCat. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.
⭐️ 8
🕓 14 weeks ago
iOS macOS watchOS tvOS
.package(url: "https://github.com/configcat/swift-sdk.git", from: "8.0.1")

ConfigCat SDK for Swift

https://configcat.com

ConfigCat SDK for Swift provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Dashboard even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

Build Status Coverage Status CocoaPods Carthage compatible Supported Platforms License

Getting started

1. Install the package

CocoaPods:

Add the following to your Podfile:

target '<YOUR TARGET>' do
pod 'ConfigCat'
end

Then, run the following command to install your dependencies:

pod install

Carthage:

Add the following to your Cartfile:

github "configcat/swift-sdk"

Then, run the carthage update command and then follow the Carthage integration steps to link the framework with your project.

Swift Package Manager:

You can add ConfigCat to an Xcode project by adding it as a package dependency.

https://github.com/configcat/swift-sdk

If you want to use ConfigCat in a SwiftPM project, it's as simple as adding a dependencies clause to your Package.swift:

dependencies: [
  .package(url: "https://github.com/configcat/swift-sdk", from: "8.0.1")
]

2. Go to the ConfigCat Dashboard to get your SDK Key:

SDK-KEY

3. Import the ConfigCat module to your application

import ConfigCat

4. Create a ConfigCat client instance

let client = ConfigCatClient(sdkKey: "#YOUR-SDK-KEY#")

5. Get your setting value

let isMyAwesomeFeatureEnabled = client.getValue(for: "isMyAwesomeFeatureEnabled", defaultValue: false)
if(isMyAwesomeFeatureEnabled) {
    doTheNewThing()
} else {
    doTheOldThing()
}

Or use the async APIs:

client.getValueAsync(for: "isMyAwesomeFeatureEnabled", defaultValue: false, completion: { isMyAwesomeFeatureEnabled in
        if(isMyAwesomeFeatureEnabled) {
            doTheNewThing()
        } else {
            doTheOldThing()
        }
    })

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to the getValue() function.

Read more about Targeting here.

let user = ConfigCatUser(identifier: "#USER-IDENTIFIER#")
let isMyAwesomeFeatureEnabled = client.getValue(for: "isMyAwesomeFeatureEnabled", user: user, defaultValue: false)
if(isMyAwesomeFeatureEnabled) {
    doTheNewThing()
} else {
    doTheOldThing()
}

Sample/Demo app

Sample iOS app

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

Sensitive information handling

The frontend/mobile SDKs are running in your users' browsers/devices. The SDK is downloading a config.json file from ConfigCat's CDN servers. The URL path for this config.json file contains your SDK key, so the SDK key and the content of your config.json file (feature flag keys, feature flag values, targeting rules, % rules) can be visible to your users. This SDK key is read-only, it only allows downloading your config.json file, but nobody can make any changes with it in your ConfigCat account.
Suppose you don't want your SDK key or the content of your config.json file visible to your users. In that case, we recommend you use the SDK only in your backend applications and call a backend endpoint in your frontend/mobile application to evaluate the feature flags for a specific application customer.
Also, we recommend using sensitive targeting comparators in the targeting rules of those feature flags that are used in the frontend/mobile SDKs.

Need help?

https://configcat.com/support

Contributing

Contributions are welcome. For more info please read the Contribution Guideline.

About ConfigCat

GitHub

link
Stars: 8
Last commit: 3 weeks ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

v8.0.1
14 weeks ago
  • Fix the sdkKey in the iOS sample app.
  • Fix targeting and percentage rule handling in getKeyAndValue.
  • Make KeyValue class members public.

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics