talkable.sh

#!/bin/bash
PYTHON="python"
PLIST_BUDDY="/usr/libexec/PlistBuddy"

RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[0;33m'
NOCOLOR='\033[0m'
VERSION_REGEX='^[0-9]+.[0-9]+.[0-9]+$'

SITE_ID=""
API_KEY=""
GETSOCIAL_APP_ID=""
FRAMEWORK_VERSION=""

PROJECT_DIR=""
PROJECT_FILE_PATH=""
PROJECT_NAME=""
TARGET_NAME=""
INFOPLIST_FILE=""

# Helper Functions

verbose() {
  echo -e "${GREEN}Talkable: $1${NOCOLOR}"
}

warn() {
  echo -e "${YELLOW}Talkable Warning: $1${NOCOLOR}"
}

fatal() {
  echo -e "${RED}Talkable Error: $1"
  echo -e "Please refer to http://docs.talkable.com/ios_sdk.html or contact us at support@talkable.com${NOCOLOR}"
  exit 1
}

getPlistValue() {
  $PLIST_BUDDY -c "Print :$2" "$1" 2>/dev/null
}

plistBuddyExec() {
  local plistPath=$1
  cat $2 | while read -r line; do
    $PLIST_BUDDY -c "$line" "$plistPath" 2>/dev/null
  done
}

includes() {
  grep -F -o -q -s "$1"
}

getJSONValue() {
  $PYTHON -c "import sys, json; print json.load(sys.stdin)['$1']"
}

downloadFile() {
  curl -# -o "$1" "$2"
}

downloadAndUnzip() {
  local download_url=$1
  local zip_path=$2
  local unzip_dir=$3
  verbose "downloading zip from $download_url..."
  downloadFile "$zip_path" "$download_url"
  unzip -q "$zip_path" -d "$unzip_dir"
  verbose "downloaded and unzipped to $unzip_dir"
  rm -f "$zip_path"
}

# Actions

downloadTalkableFramework() {
  local framework_download_needed=true
  local framework_current_version
  local download_url

  # check if version was fetched correctly and get download url for that version
  # verify version with regex because it can contain error page HTML
  if [ ! -z "$FRAMEWORK_VERSION" ] && [[ "$FRAMEWORK_VERSION" =~ $VERSION_REGEX ]]; then
    download_url="https://talkable-downloads.s3.amazonaws.com/ios-sdk/talkable_ios_sdk_$FRAMEWORK_VERSION.zip"
  else
    FRAMEWORK_VERSION="1.5.0"
    download_url="https://talkable-downloads.s3.amazonaws.com/ios-sdk/talkable_ios_sdk_1.5.0.zip"
  fi

  # determine if we need to download framework (not downloaded or downloaded version is different)
  if [ -f "$FRAMEWORK_PLIST_PATH" ]; then
    framework_current_version=$(getPlistValue "$FRAMEWORK_PLIST_PATH" "CFBundleVersion")
    if [ -z "$FRAMEWORK_VERSION" ] || [ "$FRAMEWORK_VERSION" = "$framework_current_version" ]; then
      verbose "Current SDK version $framework_current_version satisfies requirement"
      framework_download_needed=false
    else
      verbose "Current SDK version is $framework_current_version, requested version $FRAMEWORK_VERSION"
    fi
  else
    verbose "Downloaded SDK was not found."
  fi

  if $framework_download_needed; then
    rm -rf "$FRAMEWORK_PATH"
    downloadAndUnzip "$download_url" "$PROJECT_DIR/talkable-framework.zip" "$FRAMEWORK_DIR"
  fi
}

downloadGetSocialInstaller() {
  if [ -e "$GETSOCIAL_INSTALLER_DIR/installer.py" ]; then
    verbose "GetSocial installer script already downloaded in $GETSOCIAL_INSTALLER_DIR"
    return 0
  fi

  # check if getsocial installer version was fetched correctly
  [ -z "$GETSOCIAL_VERSION" ] && GETSOCIAL_VERSION=$(curl -s -X GET "$GETSOCIAL_VERSION_URL" | getJSONValue "version")

  if [ -z "$GETSOCIAL_VERSION" ] || [[ ! "$GETSOCIAL_VERSION" =~ $VERSION_REGEX ]]; then
    verbose "Could not fetch latest GetSocial installer version, using v$DEFAULT_GETSOCIAL_VERSION"
    GETSOCIAL_VERSION=$DEFAULT_GETSOCIAL_VERSION
  fi

  #download und unzip GetSocial installer
  GETSOCIAL_INSTALLER_DIR="$PROJECT_DIR/getsocial-installer-script-$GETSOCIAL_VERSION"
  local getsocial_download_url="https://downloads.getsocial.im/ios-installer/releases/ios-installer-$GETSOCIAL_VERSION.zip"

  verbose "Downloading GetSocial installer script..."
  downloadAndUnzip "$getsocial_download_url" "$PROJECT_DIR/getsocial-installer-script.zip" "$GETSOCIAL_INSTALLER_DIR"
}

addTalkableFrameworkToProject() {
  #verify we have all dependencies
  [ ! -f "$FRAMEWORK_PLIST_PATH" ] && fatal "Talkable SDK could not be downloaded"
  [ ! -e "$GETSOCIAL_INSTALLER_DIR/installer.py" ] && fatal "GetSocial installer script could not be downloaded"

  if getPlistValue "$PROJECT_FILE_PATH/project.pbxproj" | includes "$FRAMEWORK_NAME.framework"; then
    verbose "SDK already added to $PROJECT_FILE_PATH"
    return 0
  fi

  PYTHON_SCRIPT="
import sys
if sys.version_info < (3, 0):
	reload(sys)
	sys.setdefaultencoding('utf-8')
sys.path.insert(0, \"$GETSOCIAL_INSTALLER_DIR\")
sys.path.insert(0, \"$GETSOCIAL_INSTALLER_DIR/openstep_parser\")
sys.path.insert(0, \"$GETSOCIAL_INSTALLER_DIR/pbxproj\")
from pbxproj.pbxextensions import *
from pbxproj import XcodeProject
project = XcodeProject.load(\"$PROJECT_FILE_PATH/project.pbxproj\")
added_files = project.add_file(
  \"$FRAMEWORK_PATH\",
  parent=project.get_or_create_group('Frameworks'),
  force=False,
  file_options=FileOptions(weak=False, embed_framework=True))
if len(added_files) > 0: project.save()
"

  #add Talkable SDK to project
  verbose "Adding SDK to XCode Project file: $PROJECT_FILE_PATH"
  $PYTHON -c "$PYTHON_SCRIPT"
  if getPlistValue "$PROJECT_FILE_PATH/project.pbxproj" | includes "$FRAMEWORK_NAME.framework"; then
    verbose "SDK added to $PROJECT_FILE_PATH"
  else
    fatal "SDK could not be added to $PROJECT_FILE_PATH"
  fi
}

configureInfoPlist() {
  local url_scheme_name="tkbl-$SITE_ID"
  local infoplist_full_path="$PROJECT_DIR/$INFOPLIST_FILE"

  if [ "$(getPlistValue "$infoplist_full_path" "$INFOPLIST_KEY_SITE_ID")" != "$SITE_ID" ]; then
    verbose "Adding Talkable Site ID to $infoplist_full_path as $INFOPLIST_KEY_SITE_ID"
    plistBuddyExec "$infoplist_full_path" << EOF
Add :$INFOPLIST_KEY_SITE_ID string $SITE_ID
Set :$INFOPLIST_KEY_SITE_ID $SITE_ID
EOF
  else
    verbose "Talkable Site ID already added to $infoplist_full_path"
  fi

  if [ "$(getPlistValue "$infoplist_full_path" "$INFOPLIST_KEY_API_KEY")" != "$API_KEY" ]; then
    verbose "Adding Talkable API Key $infoplist_full_path as $INFOPLIST_KEY_API_KEY"
    plistBuddyExec "$infoplist_full_path" << EOF
Add :$INFOPLIST_KEY_API_KEY string $API_KEY
Set :$INFOPLIST_KEY_API_KEY $API_KEY
EOF
  else
    verbose "Talkable API Key added to $infoplist_full_path"
  fi

  #add Talkable URL Scheme to info.plist
  if getPlistValue "$infoplist_full_path" "CFBundleURLTypes" | includes "$url_scheme_name"; then
    verbose "URL Scheme $url_scheme_name already exists in $infoplist_full_path"
  else
    verbose "Adding URL scheme $url_scheme_name to $infoplist_full_path"
    plistBuddyExec "$infoplist_full_path" << EOF
Add :CFBundleURLTypes array
Add :CFBundleURLTypes:0 dict
Add :CFBundleURLTypes:0:CFBundleURLName string $FRAMEWORK_BUNDLE_ID
Add :CFBundleURLTypes:0:CFBundleTypeRole string Editor
Add :CFBundleURLTypes:0:CFBundleURLSchemes array
Add :CFBundleURLTypes:0:CFBundleURLSchemes:0 string $url_scheme_name
EOF
  fi

  #add Talkable Query Scheme to info.plist
  if getPlistValue "$infoplist_full_path" "LSApplicationQueriesSchemes" | includes "$url_scheme_name"; then
    verbose "Query Scheme $url_scheme_name already exists in $infoplist_full_path"
  else
    verbose "Adding Query Scheme $url_scheme_name to $infoplist_full_path"
    plistBuddyExec "$infoplist_full_path" << EOF
Add :LSApplicationQueriesSchemes array
Add :LSApplicationQueriesSchemes:0 string $url_scheme_name
EOF
  fi
}

callGetSocialInstaller() {
  [ -z "$GETSOCIAL_APP_ID" ] && verbose "--getsocial-app-id (-g) param not provided. Skipping GetSocial configuration" && return 0
  [ ! -e "$GETSOCIAL_INSTALLER_DIR/installer.py" ] && fatal "GetSocial installer script could not be downloaded"
  $PYTHON "$GETSOCIAL_INSTALLER_DIR/installer.py" --app-id "$GETSOCIAL_APP_ID" $GETSOCIAL_PARAMS --debug true
}

cleanUp() {
  rm -f "$PROJECT_DIR/frameworks.zip"
  rm -rf "$GETSOCIAL_INSTALLER_DIR"
}

# Parse Arguments

while [ "$1" != "" ]; do
  PARAM=$( echo "$1" | awk -F= '{print $1}' )
  VALUE=$( echo "$1" | awk -F= '{print $2}' )
  case $PARAM in
      --site-id | -s)
          SITE_ID=$VALUE
          ;;
      --api-key | -k)
          API_KEY=$VALUE
          ;;
      --version | -v)
          FRAMEWORK_VERSION=$VALUE
          ;;
      --getsocial-app-id | -g)
          GETSOCIAL_APP_ID=$VALUE
          ;;
      *)
          fatal "unknown parameter \"$PARAM\""
          ;;
  esac
  shift
done

if [ -z "$PROJECT_FILE_PATH" ]; then
  verbose "XCode env variables not found, extracting from xcodebuild"
  eval "$(xcodebuild -showBuildSettings | grep -E 'PROJECT_DIR|PROJECT_FILE_PATH|PROJECT_NAME|TARGET_NAME|INFOPLIST_FILE' | sed -e 's/ = /="/' -e 's/$/"/' -e 's/^[[:space:]]*//' -e 's/^/export /')"
fi

[ -z "$PROJECT_DIR" ] && fatal "PROJECT_DIR env variable must contain path to project folder"
[ -z "$PROJECT_FILE_PATH" ] && fatal "PROJECT_FILE_PATH env variable must contain path to .xcodeproj folder"
[ -z "$PROJECT_NAME" ] && fatal "PROJECT_NAME env variable must contain project name"
[ -z "$TARGET_NAME" ] && fatal "TARGET_NAME env variable must contain target name"
[ -z "$INFOPLIST_FILE" ] && fatal "INFOPLIST_FILE env variable must contain path to project's Info.plist file"

FRAMEWORK_NAME="TalkableSDK"
FRAMEWORK_DIR="$PROJECT_DIR/$FRAMEWORK_NAME"
FRAMEWORK_PATH="$FRAMEWORK_DIR/$FRAMEWORK_NAME.framework"
FRAMEWORK_PLIST_PATH="$FRAMEWORK_PATH/Info.plist"
GETSOCIAL_VERSION_URL="https://downloads.getsocial.im/ios-installer/releases/latest.json"
FRAMEWORK_BUNDLE_ID='com.talkable.ios-sdk'
INFOPLIST_KEY_SITE_ID="$FRAMEWORK_BUNDLE_ID.site_slug"
INFOPLIST_KEY_API_KEY="$FRAMEWORK_BUNDLE_ID.api_key"
GETSOCIAL_INSTALLER_DIR="$(ls -d "$PROJECT_DIR"/getsocial-installer-script-* 2>/dev/null)"
GETSOCIAL_PARAMS="--use-ui false --ignore-cocoapods true --autoregister-push false"

[ -z "$SITE_ID" ] && fatal "--site-id (-s) param is mandatory"
[ -z "$API_KEY" ] && fatal "--api-key (-k) param is mandatory"

verbose "Site ID: $SITE_ID, API Key: $API_KEY, GetSocial App ID: $GETSOCIAL_APP_ID"

# Perform the installation

downloadTalkableFramework
downloadGetSocialInstaller
addTalkableFrameworkToProject
configureInfoPlist
callGetSocialInstaller
cleanUp