Skip to content
Segment integration for the Leanplum SDK on iOS.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Example
LeanplumSegment.xcworkspace
Pod/Classes
.gitignore
LICENSE
LeanplumSegment.podspec
README.md
_Pods.xcodeproj
bump_version.sh

README.md

Leanplum Segment Integration for iOS

Leanplum SDK integration for the Segment iOS SDK.

Installation

To install the Leanplum Segment integration, simply add this line to your CocoaPods Podfile:

pod 'LeanplumSegment', '~> 1.1.3'

That's it! Now you can use the Segment SDK and also the advanced features of the Leanplum SDK.

Usage

Import the LeanplumSegment integration:

#import <LeanplumSegment/SEGLeanplumIntegrationFactory.h>

Add the following lines to your AppDelegate:

NSString *const SEGMENT_WRITE_KEY = @" ... ";
SEGAnalyticsConfiguration *config =
    [SEGAnalyticsConfiguration configurationWithWriteKey:SEGMENT_WRITE_KEY];
[config use:[SEGLeanplumIntegrationFactory instance]];
[SEGAnalytics setupWithConfiguration:config];

Now you can use Segment as you are used to, e.g.:

[[SEGAnalytics sharedAnalytics] track:@" ... "];

Note: There is no need to explicitly call Leanplum.start, as it is called within the LeanplumIntegration.

In addition to that you can also use the advanced features of Leanplum. Once the Leanplum SDK is successfully registered, Segement posts a NSNotification, hence register to it:

- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[...]
  [[NSNotificationCenter defaultCenter]
      addObserver:self
         selector:@selector(segmentIntegrationDidStart)
             name:SEGAnalyticsIntegrationDidStart
           object:LPLeanplumSegmentKey];
}

- (void)segmentIntegrationDidStart {
  [Leanplum onVariablesChanged:^{
      [...]
  }];
}

Example

We have included a sample application.

  1. Install CocoaPods in Example Project: cd Example && pod install
  2. To run the sample app open LeanplumSegment.xcworkspace
  3. Choose & run target LeanplumSegment_Example

Tests

We have included unit tests for the integration.

  1. To run the unit tests open LeanplumSegment.xcworkspace
  2. Choose & test target LeanplumSegment_Tests

Install Specific Version of SDK's

By default this integration pulls in the latest versions of the Leanplum SDK and the Segment SDK. If you rather want to use a specific version, simply specify the required versions in your podfile directly.

pod 'Analytics', '3.0.1'
pod 'Leanplum-iOS-SDK', '1.2.23'

Deploy to CocoaPods

  1. Checkout a new release branch from develop:
git flow release start "NEW_VERSION"
  1. Run the bump version script:
./bump_version.sh OLD_VERSION NEW_VERSION
  1. Run the unit tests within the Example project.
  2. Validate Library:
pod lib lint --use-libraries --verbose
pod spec lint --use-libraries --verbose
  1. Finish release:
git flow release finish "NEW_VERSION"
git push
git checkout master
git push
  1. Publish to CocoaPods (Caution, once published cannot be undone!)
pod trunk push --use-libraries

License

See LICENSE file.

You can’t perform that action at this time.