Skip to content
This repository has been archived by the owner on Apr 22, 2024. It is now read-only.

Latest commit

 

History

History
44 lines (25 loc) · 2.92 KB

README.md

File metadata and controls

44 lines (25 loc) · 2.92 KB
Raw

mParticle - Iterable Firehose Integration

This library integrates mParticle with Iterable, using mParticle's Java SDK over Amazon's Lambda platform. This code is responsible for mapping mParticle events to Iterable events.

The extension is composed of two modules:

  • iterable-extension - houses the lambda function that will be executed by AWS on reception of a data request from mParticle.
  • iterable-java-sdk - classes modeling Iterable data-structures, and a Retrofit-based interface to their API.

Development Workflow

  1. Create a feature branch off of master
    • Name it the associated JIRA ticket number (ex. PIR-125)
  2. If applicable, update the tests to properly test your new feature
    • See IerableExtensionTest.java

Deployment

  1. When ready, merge your code to the develop branch.

    • Code on develop deploys to a single lambda function: mparticle_to_sqs_test.
    • Requests are routed from mParticle to the mparticle_to_sqs_test function if the output source belongs to the Iterable - Test Default Group in mParticle.

  2. If develop is working properly, submit a PR to master. The master branch is deployed to the lamda functions listed in the gradle.yml file.

Testing

Both modules have a set of unit tests which can all be run at once by invoking:

./gradlew test

To assist in testing, the integration-assistant tool can be used to test staging and production version of the firehose.

Building

Run the following to generate iterable-extension.zip in the iterable-extension/build/distributions directory:

./gradlew build

License

Apache License 2.0