branch_io_cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ccbe6055b11c7d84271ce19783c90890e6c7b5f
+  data.tar.gz: ac6119e721f6e4c8529a2a01f4fc76fbb97e096e
+SHA512:
+  metadata.gz: f8e945dc2c6db1e08264537075bec5f45f8c562e58a3bc37821ce1ab7c1493021f95b9a89c25d08dfcac6ef7fee7a4f3a0904536967bb6cd961fd17416746f32
+  data.tar.gz: 804615d6d37b159d79e3b801a4d818f62ffebfe45d50c60160253ca7469074c939806a3d64f35a7a7f9dbd9fa69b9b3418b324b7bba8c6802ffc9dd91e56f66e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Branch Metrics, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# branch_io_cli gem
+
+This is a command-line tool to integrate the Branch SDK into mobile app projects. (Currently iOS only.)
+
+[![Gem](https://img.shields.io/gem/v/branch_io_cli.svg?style=flat)](https://rubygems.org/gems/branch_io_cli)
+[![Downloads](https://img.shields.io/gem/dt/branch_io_cli.svg?style=flat)](https://rubygems.org/gems/branch_io_cli)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/BranchMetrics/branch_io_cli/blob/master/LICENSE)
+[![CircleCI](https://img.shields.io/circleci/project/github/BranchMetrics/branch_io_cli.svg)](https://circleci.com/gh/BranchMetrics/branch_io_cli)
+
+## Preliminary release
+
+This is a preliminary release of this gem. Please report any problems by opening issues in this repo.
+
+## Getting started
+
+```bash
+gem install branch_io_cli
+```
+
+Note that this command may require `sudo` access if you are using the system Ruby, i.e. `sudo gem install branch_io_cli`.
+
+```bash
+branch_io -h
+branch_io setup -h
+branch_io validate -h
+```
+
+## Commands
+
+### Setup command
+
+```bash
+branch_io setup
+```
+
+Integrates the Branch SDK into a native app project. This currently supports iOS only.
+It will infer the project location if there is exactly one .xcodeproj anywhere under
+the current directory, excluding any in a Pods or Carthage folder. Otherwise, specify
+the project location using the `--xcodeproj` option.
+
+If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
+configuration file and the dependencies updated to include the Branch framework.
+This behavior may be suppressed using `--no_add_sdk`. If no Podfile or Cartfile
+is found, the SDK dependency must be added manually. This will improve in a future
+release.
+
+By default, all supplied Universal Link domains are validated. If validation passes,
+the setup continues. If validation fails, no further action is taken. Suppress
+validation using `--no_validate` or force changes when validation fails using
+`--force`.
+
+All relevant project settings are modified. The Branch keys are added to the Info.plist,
+along with the `branch_universal_link_domains` key for custom domains (when `--domains`
+is used). All domains are added to the project's Associated Domains entitlements.
+An entitlements file is added if none is found. Optionally, if `--frameworks` is
+specified, this command can add a list of system frameworks to the project (e.g.,
+AdSupport, CoreSpotlight, SafariServices).
+
+A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
+This can be suppressed using `--no_patch_source`.
+
+#### Prerequisites
+
+Before using this action, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/ for details. To use the `setup` command, you need:
+
+- Branch key(s), either live, test or both
+- Domain name(s) used for Branch links
+- Location of your Xcode project
+
+#### Options
+
+|Option|Description|
+|------|-----------|
+|--live_key key_live_xxxx|Branch live key|
+|--test_key key_test_yyyy|Branch test key|
+|--app_link_subdomain myapp|Branch app.link subdomain, e.g. myapp for myapp.app.link|
+|--domains example.com,www.example.com|Comma-separated list of custom domain(s) or non-Branch domain(s)|
+|--xcodeproj MyProject.xcodeproj|Path to an Xcode project to update|
+|--target MyAppTarget|Name of a target to modify in the Xcode project|
+|--podfile /path/to/Podfile|Path to the Podfile for the project|
+|--cartfile /path/to/Cartfile|Path to the Cartfile for the project|
+|--frameworks AdSupport,CoreSpotlight,SafariServices|Comma-separated list of system frameworks to add to the project|
+|--no_pod_repo_update|Skip update of the local podspec repo before installing|
+|--no_validate|Skip validation of Universal Link configuration|
+|--force|Update project even if Universal Link validation fails|
+|--no_add_sdk|Don't add the Branch framework to the project|
+|--no_patch_source|Don't add Branch SDK calls to the AppDelegate|
+|--commit|Commit the results to Git|
+
+All parameters are optional, but either `--live_key` or `--test_key` or both must be specified, as well as
+`--app_link_subdomain` or `--domains` or both.
+
+### Validate command
+
+```bash
+branch_io validate
+```
+
+This command validates all Universal Link domains configured in a project without making any modification.
+It validates both Branch and non-Branch domains. Unlike web-based Universal Link validators,
+this command operates directly on the project. It finds the bundle and
+signing team identifiers in the project as well as the app's Associated Domains.
+It requests the apple-app-site-association file for each domain and validates
+the file against the project's settings.
+
+#### Options
+
+|Option|Description|
+|------|-----------|
+|--domains example.com,www.example.com|Comma-separated list of domains. May include app.link subdomains.|
+|--xcodeproj MyProject.xcodeproj|Path to an Xcode project to update|
+|--target MyAppTarget|Name of a target to modify in the Xcode project|
+
+All parameters are optional. If `--domains` is specified, the list of Universal Link domains in the
+Associated Domains entitlement must exactly match this list, without regard to order. If no `--domains`
+are provided, validation passes if at least one Universal Link domain is configured and passes validation,
+and no Universal Link domain is present that does not pass validation.
+
+#### Return value
+
+If validation passes, this command returns 0. If validation fails, it returns 1.

data/bin/branch_io

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require "branch_io_cli"
+
+BranchIOCLI::CLI.new.run

data/lib/branch_io_cli.rb

@@ -0,0 +1,4 @@
+require "branch_io_cli/cli"
+require "branch_io_cli/command"
+require "branch_io_cli/helper"
+require "branch_io_cli/version"

data/lib/branch_io_cli/cli.rb

@@ -0,0 +1,59 @@
+require "rubygems"
+require "commander"
+
+module BranchIOCLI
+  class CLI
+    include Commander::Methods
+
+    def run
+      program :name, "Branch.io command-line interface"
+      program :version, VERSION
+      program :description, "More to come"
+
+      command :setup do |c|
+        c.syntax = "branch_io setup"
+        c.description = "Set up an iOS project to use the Branch SDK."
+
+        # Required Branch params
+        c.option "--live_key key_live_xxxx", String, "Branch live key"
+        c.option "--test_key key_test_yyyy", String, "Branch test key"
+        c.option "--app_link_subdomain myapp", String, "Branch app.link subdomain, e.g. myapp for myapp.app.link"
+        c.option "--domains example.com,www.example.com", Array, "Comma-separated list of custom domain(s) or non-Branch domain(s)"
+
+        c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project to update"
+        c.option "--target MyAppTarget", String, "Name of a target to modify in the Xcode project"
+        c.option "--podfile /path/to/Podfile", String, "Path to the Podfile for the project"
+        c.option "--cartfile /path/to/Cartfile", String, "Path to the Cartfile for the project"
+        c.option "--frameworks AdSupport,CoreSpotlight,SafariServices", Array, "Comma-separated list of system frameworks to add to the project"
+
+        c.option "--no_pod_repo_update", TrueClass, "Skip update of the local podspec repo before installing"
+        c.option "--no_validate", TrueClass, "Skip validation of Universal Link configuration"
+        c.option "--force", TrueClass, "Update project even if Universal Link validation fails"
+        c.option "--no_add_sdk", TrueClass, "Don't add the Branch framework to the project"
+        c.option "--no_patch_source", TrueClass, "Don't add Branch SDK calls to the AppDelegate"
+        c.option "--commit", TrueClass, "Commit the results to Git"
+
+        c.action do |args, options|
+          Command.setup options
+        end
+      end
+
+      command :validate do |c|
+        c.syntax = "branch_io validate"
+        c.description = "Validate the Universal Link configuration for an Xcode project"
+
+        c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project to update"
+        c.option "--target MyAppTarget", String, "Name of a target to modify in the Xcode project"
+        c.option "--domains example.com,www.example.com", Array, "Comma-separated list of domains to validate (Branch domains or non-Branch domains)"
+
+        c.action do |args, options|
+          valid = Command.validate options
+          exit_code = valid ? 0 : 1
+          exit exit_code
+        end
+      end
+
+      run!
+    end
+  end
+end

data/lib/branch_io_cli/command.rb

@@ -0,0 +1,281 @@
+require "xcodeproj"
+
+module BranchIOCLI
+  class Command
+    class << self
+      def setup(options)
+        @domains = all_domains options
+        @keys = keys options
+
+        if @keys.empty?
+          say "Please specify --live_key or --test_key or both."
+          return
+        end
+
+        if @domains.empty?
+          say "Please specify --app_link_subdomain or --domains or both."
+          return
+        end
+
+        @xcodeproj_path = xcodeproj_path options
+        unless @xcodeproj_path
+          say "Please specify the --xcodeproj option."
+          return
+        end
+
+        # raises
+        xcodeproj = Xcodeproj::Project.open @xcodeproj_path
+
+        update_podfile(options) || update_cartfile(options, xcodeproj)
+
+        target = options.target # may be nil
+
+        if !options.no_validate &&
+           !helper.validate_team_and_bundle_ids_from_aasa_files(xcodeproj, target, @domains)
+          say "Universal Link configuration failed validation."
+          helper.errors.each { |error| say " #{error}" }
+          return unless options.force
+        elsif !options.no_validate
+          say "Universal Link configuration passed validation. ✅"
+        end
+
+        # the following calls can all raise IOError
+        helper.add_keys_to_info_plist xcodeproj, target, @keys
+        helper.add_branch_universal_link_domains_to_info_plist xcodeproj, target, @domains
+        new_path = helper.add_universal_links_to_project xcodeproj, target, @domains, false
+        `git add #{new_path}` if options.commit && new_path
+
+        helper.add_system_frameworks xcodeproj, target, options.frameworks unless options.frameworks.nil? || options.frameworks.empty?
+
+        xcodeproj.save
+
+        patch_source xcodeproj unless options.no_patch_source
+
+        return unless options.commit
+
+        `git commit #{helper.changes.join(" ")} -m '[branch_io_cli] Branch SDK integration'`
+      end
+
+      def validate(options)
+        path = xcodeproj_path options
+        unless path
+          say "Please specify the --xcodeproj option."
+          return
+        end
+
+        # raises
+        xcodeproj = Xcodeproj::Project.open path
+
+        valid = true
+
+        unless options.domains.nil? || options.domains.empty?
+          domains_valid = helper.validate_project_domains(
+            options.domains,
+            xcodeproj,
+            options.target
+          )
+
+          if domains_valid
+            say "Project domains match :domains parameter: ✅"
+          else
+            say "Project domains do not match specified :domains"
+            helper.errors.each { |error| say " #{error}" }
+          end
+
+          valid &&= domains_valid
+        end
+
+        configuration_valid = helper.validate_team_and_bundle_ids_from_aasa_files xcodeproj, options.target
+        unless configuration_valid
+          say "Universal Link configuration failed validation."
+          helper.errors.each { |error| say " #{error}" }
+        end
+
+        valid &&= configuration_valid
+
+        say "Universal Link configuration passed validation. ✅" if valid
+
+        valid
+      end
+
+      def helper
+        BranchIOCLI::Helper::BranchHelper
+      end
+
+      def xcodeproj_path(options)
+        return options.xcodeproj if options.xcodeproj
+
+        repo_path = "."
+
+        all_xcodeproj_paths = Dir[File.expand_path(File.join(repo_path, '**/*.xcodeproj'))]
+        # find an xcodeproj (ignoring the Pods and Carthage folders)
+        # TODO: Improve this filter
+        xcodeproj_paths = all_xcodeproj_paths.reject { |p| p =~ /Pods|Carthage/ }
+
+        # no projects found: error
+        say 'Could not find a .xcodeproj in the current repository\'s working directory.' and return nil if xcodeproj_paths.count == 0
+
+        # too many projects found: error
+        if xcodeproj_paths.count > 1
+          repo_pathname = Pathname.new repo_path
+          relative_projects = xcodeproj_paths.map { |e| Pathname.new(e).relative_path_from(repo_pathname).to_s }.join("\n")
+          say "Found multiple .xcodeproj projects in the current repository's working directory. Please specify your app's main project: \n#{relative_projects}"
+          return nil
+        end
+
+        # one project found: great
+        xcodeproj_paths.first
+      end
+
+      def app_link_subdomains(options)
+        app_link_subdomain = options.app_link_subdomain
+        live_key = options.live_key
+        test_key = options.test_key
+        return [] if live_key.nil? and test_key.nil?
+        return [] if app_link_subdomain.nil?
+
+        domains = []
+        unless live_key.nil?
+          domains += [
+            "#{app_link_subdomain}.app.link",
+            "#{app_link_subdomain}-alternate.app.link"
+          ]
+        end
+        unless test_key.nil?
+          domains += [
+            "#{app_link_subdomain}.test-app.link",
+            "#{app_link_subdomain}-alternate.test-app.link"
+          ]
+        end
+        domains
+      end
+
+      def all_domains(options)
+        app_link_subdomains = app_link_subdomains options
+        custom_domains = options.domains || []
+        (app_link_subdomains + custom_domains).uniq
+      end
+
+      def keys(options)
+        live_key = options.live_key
+        test_key = options.test_key
+        keys = {}
+        keys[:live] = live_key unless live_key.nil?
+        keys[:test] = test_key unless test_key.nil?
+        keys
+      end
+
+      def podfile_path(options)
+        # Disable Podfile update if add_sdk: false is present
+        return nil if options.no_add_sdk
+
+        # Use the :podfile parameter if present
+        if options.podfile
+          raise "--podfile argument must specify a path ending in '/Podfile'" unless options.podfile =~ %r{/Podfile$}
+          podfile_path = File.expand_path options.podfile, "."
+          return podfile_path if File.exist? podfile_path
+          raise "#{podfile_path} not found"
+        end
+
+        # Look in the same directory as the project (typical setup)
+        podfile_path = File.expand_path "../Podfile", @xcodeproj_path
+        return podfile_path if File.exist? podfile_path
+      end
+
+      def cartfile_path(options)
+        # Disable Cartfile update if add_sdk: false is present
+        return nil if options.no_add_sdk
+
+        # Use the :cartfile parameter if present
+        if options.cartfile
+          raise "--cartfile argument must specify a path ending in '/Cartfile'" unless options.cartfile =~ %r{/Cartfile$}
+          cartfile_path = File.expand_path options.cartfile, "."
+          return cartfile_path if File.exist? cartfile_path
+          raise "#{cartfile_path} not found"
+        end
+
+        # Look in the same directory as the project (typical setup)
+        cartfile_path = File.expand_path "../Cartfile", @xcodeproj_path
+        return cartfile_path if File.exist? cartfile_path
+      end
+
+      def update_podfile(options)
+        podfile_path = podfile_path options
+        return false if podfile_path.nil?
+
+        # 1. Patch Podfile. Return if no change (Branch pod already present).
+        return false unless helper.patch_podfile podfile_path
+
+        # 2. pod install
+        # command = "PATH='#{ENV['PATH']}' pod install"
+        command = 'pod install'
+        command += ' --repo-update' unless options.no_pod_repo_update
+
+        Dir.chdir(File.dirname(podfile_path)) do
+          `#{command}`
+        end
+
+        # 3. Add Podfile and Podfile.lock to commit (in case :commit param specified)
+        helper.add_change podfile_path
+        helper.add_change "#{podfile_path}.lock"
+
+        # 4. Check if Pods folder is under SCM
+        pods_folder_path = File.expand_path "../Pods", podfile_path
+        `git ls-files #{pods_folder_path} --error-unmatch > /dev/null 2>&1`
+        return true unless $?.exitstatus == 0
+
+        # 5. If so, add the Pods folder to the commit (in case :commit param specified)
+        helper.add_change pods_folder_path
+        other_action.git_add path: pods_folder_path if options.commit
+        true
+      end
+
+      def update_cartfile(options, project)
+        cartfile_path = cartfile_path options
+        return false if cartfile_path.nil?
+
+        # 1. Patch Cartfile. Return if no change (Branch already present).
+        return false unless helper.patch_cartfile cartfile_path
+
+        # 2. carthage update
+        Dir.chdir(File.dirname(cartfile_path)) do
+          `carthage update`
+        end
+
+        # 3. Add Cartfile and Cartfile.resolved to commit (in case :commit param specified)
+        helper.add_change cartfile_path
+        helper.add_change "#{cartfile_path}.resolved"
+
+        # 4. Add to target depependencies
+        frameworks_group = project['Frameworks']
+        branch_framework = frameworks_group.new_file "Carthage/Build/iOS/Branch.framework"
+        target = helper.target_from_project project, options.target
+        target.frameworks_build_phase.add_file_reference branch_framework
+
+        # 5. Add to copy-frameworks build phase
+        carthage_build_phase = target.build_phases.find do |phase|
+          phase.respond_to?(:shell_script) && phase.shell_script =~ /carthage\s+copy-frameworks/
+        end
+
+        if carthage_build_phase
+          carthage_build_phase.input_paths << "$(SRCROOT)/Carthage/Build/iOS/Branch.framework"
+          carthage_build_phase.output_paths << "$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/Branch.framework"
+        end
+
+        # 6. Check if Carthage folder is under SCM
+        carthage_folder_path = File.expand_path "../Carthage", cartfile_path
+        `git ls-files #{carthage_folder_path} --error-unmatch > /dev/null 2>&1`
+        return true unless $?.exitstatus == 0
+
+        # 7. If so, add the Pods folder to the commit (in case :commit param specified)
+        helper.add_change carthage_folder_path
+        other_action.git_add path: carthage_folder_path if options.commit
+        true
+      end
+
+      def patch_source(xcodeproj)
+        helper.patch_app_delegate_swift(xcodeproj) || helper.patch_app_delegate_objc(xcodeproj)
+      end
+    end
+  end
+end

data/lib/branch_io_cli/helper.rb

@@ -0,0 +1 @@
+require "branch_io_cli/helper/branch_helper"

data/lib/branch_io_cli/helper/android_helper.rb

@@ -0,0 +1,86 @@
+module BranchIOCLI
+  module Helper
+    module AndroidHelper
+      def add_keys_to_android_manifest(manifest, keys)
+        add_metadata_to_manifest manifest, "io.branch.sdk.BranchKey", keys[:live] unless keys[:live].nil?
+        add_metadata_to_manifest manifest, "io.branch.sdk.BranchKey.test", keys[:test] unless keys[:test].nil?
+      end
+
+      # TODO: Work on all XML/AndroidManifest formatting
+
+      def add_metadata_to_manifest(manifest, key, value)
+        element = manifest.elements["//manifest/application/meta-data[@android:name=\"#{key}\"]"]
+        if element.nil?
+          application = manifest.elements["//manifest/application"]
+          application.add_element "meta-data", "android:name" => key, "android:value" => value
+        else
+          element.attributes["android:value"] = value
+        end
+      end
+
+      def add_intent_filters_to_android_manifest(manifest, domains, uri_scheme, activity_name, remove_existing)
+        if activity_name
+          activity = manifest.elements["//manifest/application/activity[@android:name=\"#{activity_name}\""]
+        else
+          activity = find_activity manifest
+        end
+
+        raise "Failed to find an Activity in the Android manifest" if activity.nil?
+
+        if remove_existing
+          remove_existing_domains(activity)
+        end
+
+        add_intent_filter_to_activity activity, domains, uri_scheme
+      end
+
+      def find_activity(manifest)
+        # try to infer the right activity
+        # look for the first singleTask
+        single_task_activity = manifest.elements["//manifest/application/activity[@android:launchMode=\"singleTask\"]"]
+        return single_task_activity if single_task_activity
+
+        # no singleTask activities. Take the first Activity
+        # TODO: Add singleTask?
+        manifest.elements["//manifest/application/activity"]
+      end
+
+      def add_intent_filter_to_activity(activity, domains, uri_scheme)
+        # Add a single intent-filter with autoVerify and a data element for each domain and the optional uri_scheme
+        intent_filter = REXML::Element.new "intent-filter"
+        intent_filter.attributes["android:autoVerify"] = true
+        intent_filter.add_element "action", "android:name" => "android.intent.action.VIEW"
+        intent_filter.add_element "category", "android:name" => "android.intent.category.DEFAULT"
+        intent_filter.add_element "category", "android:name" => "android.intent.category.BROWSABLE"
+        intent_filter.elements << uri_scheme_data_element(uri_scheme) unless uri_scheme.nil?
+        app_link_data_elements(domains).each { |e| intent_filter.elements << e }
+
+        activity.add_element intent_filter
+      end
+
+      def remove_existing_domains(activity)
+        # Find all intent-filters that include a data element with android:scheme
+        # TODO: Can this be done with a single css/at_css call?
+        activity.elements.each("//manifest//intent-filter") do |filter|
+          filter.remove if filter.elements["data[@android:scheme]"]
+        end
+      end
+
+      def app_link_data_elements(domains)
+        domains.map do |domain|
+          element = REXML::Element.new "data"
+          element.attributes["android:scheme"] = "https"
+          element.attributes["android:host"] = domain
+          element
+        end
+      end
+
+      def uri_scheme_data_element(uri_scheme)
+        element = REXML::Element.new "data"
+        element.attributes["android:scheme"] = uri_scheme
+        element.attributes["android:host"] = "open"
+        element
+      end
+    end
+  end
+end

data/lib/branch_io_cli/helper/branch_helper.rb

@@ -0,0 +1,39 @@
+require "branch_io_cli/helper/android_helper"
+require "branch_io_cli/helper/ios_helper"
+require "pattern_patch"
+require "set"
+
+module BranchIOCLI
+  module Helper
+    class BranchHelper
+      class << self
+        attr_accessor :changes # An array of file paths (Strings) that were modified
+        attr_accessor :errors # An array of error messages (Strings) from validation
+
+        include AndroidHelper
+        include IOSHelper
+
+        def add_change(change)
+          @changes ||= Set.new
+          @changes << change.to_s
+        end
+
+        # Shim around PatternPatch for now
+        def apply_patch(options)
+          modified = File.open(options[:files]) do |file|
+            PatternPatch::Utilities.apply_patch file.read,
+                                                options[:regexp],
+                                                options[:text],
+                                                options[:global],
+                                                options[:mode],
+                                                options[:offset] || 0
+          end
+
+          File.open(options[:files], "w") do |file|
+            file.write modified
+          end
+        end
+      end
+    end
+  end
+end

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -0,0 +1,499 @@
+require "json"
+require "net/http"
+require "openssl"
+require "plist"
+
+module BranchIOCLI
+  module Helper
+    module IOSHelper
+      APPLINKS = "applinks"
+      ASSOCIATED_DOMAINS = "com.apple.developer.associated-domains"
+      CODE_SIGN_ENTITLEMENTS = "CODE_SIGN_ENTITLEMENTS"
+      DEVELOPMENT_TEAM = "DEVELOPMENT_TEAM"
+      PRODUCT_BUNDLE_IDENTIFIER = "PRODUCT_BUNDLE_IDENTIFIER"
+      RELEASE_CONFIGURATION = "Release"
+
+      def add_keys_to_info_plist(project, target_name, keys, configuration = RELEASE_CONFIGURATION)
+        update_info_plist_setting project, target_name, configuration do |info_plist|
+          # add/overwrite Branch key(s)
+          if keys.count > 1
+            info_plist["branch_key"] = keys
+          elsif keys[:live]
+            info_plist["branch_key"] = keys[:live]
+          else # no need to validate here, which was done by the action
+            info_plist["branch_key"] = keys[:test]
+          end
+        end
+      end
+
+      def add_branch_universal_link_domains_to_info_plist(project, target_name, domains, configuration = RELEASE_CONFIGURATION)
+        # Add all supplied domains unless all are app.link domains.
+        return if domains.all? { |d| d =~ /app\.link$/ }
+
+        update_info_plist_setting project, target_name, configuration do |info_plist|
+          info_plist["branch_universal_link_domains"] = domains
+        end
+      end
+
+      def update_info_plist_setting(project, target_name, configuration = RELEASE_CONFIGURATION, &b)
+        # raises
+        target = target_from_project project, target_name
+
+        # find the Info.plist paths for this configuration
+        info_plist_path = expanded_build_setting target, "INFOPLIST_FILE", configuration
+
+        raise "Info.plist not found for configuration #{configuration}" if info_plist_path.nil?
+
+        project_parent = File.dirname project.path
+
+        info_plist_path = File.expand_path info_plist_path, project_parent
+
+        # try to open and parse the Info.plist (raises)
+        info_plist = File.open(info_plist_path) { |f| Plist.parse_xml f }
+        raise "Failed to parse #{info_plist_path}" if info_plist.nil?
+
+        yield info_plist
+
+        Plist::Emit.save_plist info_plist, info_plist_path
+        add_change info_plist_path
+      end
+
+      def add_universal_links_to_project(project, target_name, domains, remove_existing, configuration = RELEASE_CONFIGURATION)
+        # raises
+        target = target_from_project project, target_name
+
+        relative_entitlements_path = expanded_build_setting target, CODE_SIGN_ENTITLEMENTS, configuration
+        project_parent = File.dirname project.path
+
+        if relative_entitlements_path.nil?
+          relative_entitlements_path = File.join target.name, "#{target.name}.entitlements"
+          entitlements_path = File.expand_path relative_entitlements_path, project_parent
+
+          # Add CODE_SIGN_ENTITLEMENTS setting to each configuration
+          target.build_configuration_list.set_setting CODE_SIGN_ENTITLEMENTS, relative_entitlements_path
+
+          # Add the file to the project
+          project.new_file relative_entitlements_path
+
+          entitlements = {}
+          current_domains = []
+
+          add_change project.path
+          new_path = entitlements_path
+        else
+          entitlements_path = File.expand_path relative_entitlements_path, project_parent
+          # Raises
+          entitlements = File.open(entitlements_path) { |f| Plist.parse_xml f }
+          raise "Failed to parse entitlements file #{entitlements_path}" if entitlements.nil?
+
+          if remove_existing
+            current_domains = []
+          else
+            current_domains = entitlements[ASSOCIATED_DOMAINS]
+          end
+        end
+
+        current_domains += domains.map { |d| "#{APPLINKS}:#{d}" }
+        all_domains = current_domains.uniq
+
+        entitlements[ASSOCIATED_DOMAINS] = all_domains
+
+        Plist::Emit.save_plist entitlements, entitlements_path
+        add_change entitlements_path
+
+        new_path
+      end
+
+      def team_and_bundle_from_app_id(identifier)
+        team = identifier.sub(/\..+$/, "")
+        bundle = identifier.sub(/^[^.]+\./, "")
+        [team, bundle]
+      end
+
+      def update_team_and_bundle_ids_from_aasa_file(project, target_name, domain)
+        # raises
+        identifiers = app_ids_from_aasa_file domain
+        raise "Multiple appIDs found in AASA file" if identifiers.count > 1
+
+        identifier = identifiers[0]
+        team, bundle = team_and_bundle_from_app_id identifier
+
+        update_team_and_bundle_ids project, target_name, team, bundle
+        add_change project.path.expand_path
+      end
+
+      def validate_team_and_bundle_ids_from_aasa_files(project, target_name, domains = [], remove_existing = false, configuration = RELEASE_CONFIGURATION)
+        @errors = []
+        valid = true
+
+        # Include any domains already in the project.
+        # Raises. Returns a non-nil array of strings.
+        if remove_existing
+          # Don't validate domains to be removed (#16)
+          all_domains = domains
+        else
+          all_domains = (domains + domains_from_project(project, target_name, configuration)).uniq
+        end
+
+        if all_domains.empty?
+          # Cannot get here from SetupBranchAction, since the domains passed in will never be empty.
+          # If called from ValidateUniversalLinksAction, this is a failure, possibly caused by
+          # failure to add applinks:.
+          @errors << "No Universal Link domains in project. Be sure each Universal Link domain is prefixed with applinks:."
+          return false
+        end
+
+        all_domains.each do |domain|
+          domain_valid = validate_team_and_bundle_ids project, target_name, domain, configuration
+          valid &&= domain_valid
+          say "Valid Universal Link configuration for #{domain} ✅" if domain_valid
+        end
+        valid
+      end
+
+      def app_ids_from_aasa_file(domain)
+        data = contents_of_aasa_file domain
+        # errors reported in the method above
+        return nil if data.nil?
+
+        # raises
+        file = JSON.parse data
+
+        applinks = file[APPLINKS]
+        @errors << "[#{domain}] No #{APPLINKS} found in AASA file" and return if applinks.nil?
+
+        details = applinks["details"]
+        @errors << "[#{domain}] No details found for #{APPLINKS} in AASA file" and return if details.nil?
+
+        identifiers = details.map { |d| d["appID"] }.uniq
+        @errors << "[#{domain}] No appID found in AASA file" and return if identifiers.count <= 0
+        identifiers
+      rescue JSON::ParserError => e
+        @errors << "[#{domain}] Failed to parse AASA file: #{e.message}"
+        nil
+      end
+
+      def contents_of_aasa_file(domain)
+        uris = [
+          URI("https://#{domain}/.well-known/apple-app-site-association"),
+          URI("https://#{domain}/apple-app-site-association")
+          # URI("http://#{domain}/.well-known/apple-app-site-association"),
+          # URI("http://#{domain}/apple-app-site-association")
+        ]
+
+        data = nil
+
+        uris.each do |uri|
+          break unless data.nil?
+
+          Net::HTTP.start uri.host, uri.port, use_ssl: uri.scheme == "https" do |http|
+            request = Net::HTTP::Get.new uri
+            response = http.request request
+
+            # Better to use Net::HTTPRedirection and Net::HTTPSuccess here, but
+            # having difficulty with the unit tests.
+            if (300..399).cover?(response.code.to_i)
+              say "#{uri} cannot result in a redirect. Ignoring."
+              next
+            elsif response.code.to_i != 200
+              # Try the next URI.
+              say "Could not retrieve #{uri}: #{response.code} #{response.message}. Ignoring."
+              next
+            end
+
+            content_type = response["Content-type"]
+            @errors << "[#{domain}] AASA Response does not contain a Content-type header" and next if content_type.nil?
+
+            case content_type
+            when %r{application/pkcs7-mime}
+              # Verify/decrypt PKCS7 (non-Branch domains)
+              cert_store = OpenSSL::X509::Store.new
+              signature = OpenSSL::PKCS7.new response.body
+              # raises
+              signature.verify nil, cert_store, nil, OpenSSL::PKCS7::NOVERIFY
+              data = signature.data
+            else
+              @error << "[#{domain}] Unsigned AASA files must be served via HTTPS" and next if uri.scheme == "http"
+              data = response.body
+            end
+
+            say "GET #{uri}: #{response.code} #{response.message} (Content-type:#{content_type}) ✅"
+          end
+        end
+
+        @errors << "[#{domain}] Failed to retrieve AASA file" and return nil if data.nil?
+
+        data
+      rescue IOError, SocketError => e
+        @errors << "[#{domain}] Socket error: #{e.message}"
+        nil
+      rescue OpenSSL::PKCS7::PKCS7Error => e
+        @errors << "[#{domain}] Failed to verify signed AASA file: #{e.message}"
+        nil
+      end
+
+      def validate_team_and_bundle_ids(project, target_name, domain, configuration)
+        # raises
+        target = target_from_project project, target_name
+
+        product_bundle_identifier = expanded_build_setting target, PRODUCT_BUNDLE_IDENTIFIER, configuration
+        development_team = expanded_build_setting target, DEVELOPMENT_TEAM, configuration
+
+        identifiers = app_ids_from_aasa_file domain
+        return false if identifiers.nil?
+
+        app_id = "#{development_team}.#{product_bundle_identifier}"
+        match_found = identifiers.include? app_id
+
+        unless match_found
+          @errors << "[#{domain}] appID mismatch. Project: #{app_id}. AASA: #{identifiers}"
+        end
+
+        match_found
+      end
+
+      def validate_project_domains(expected, project, target, configuration = RELEASE_CONFIGURATION)
+        @errors = []
+        project_domains = domains_from_project project, target, configuration
+        valid = expected.count == project_domains.count
+        if valid
+          sorted = expected.sort
+          project_domains.sort.each_with_index do |domain, index|
+            valid = false and break unless sorted[index] == domain
+          end
+        end
+
+        unless valid
+          @errors << "Project domains do not match :domains parameter"
+          @errors << "Project domains: #{project_domains}"
+          @errors << ":domains parameter: #{expected}"
+        end
+
+        valid
+      end
+
+      def update_team_and_bundle_ids(project, target_name, team, bundle)
+        # raises
+        target = target_from_project project, target_name
+
+        target.build_configuration_list.set_setting PRODUCT_BUNDLE_IDENTIFIER, bundle
+        target.build_configuration_list.set_setting DEVELOPMENT_TEAM, team
+
+        # also update the team in the first test target
+        target = project.targets.find(&:test_target_type?)
+        return if target.nil?
+
+        target.build_configuration_list.set_setting DEVELOPMENT_TEAM, team
+      end
+
+      def target_from_project(project, target_name)
+        if target_name
+          target = project.targets.find { |t| t.name == target_name }
+          raise "Target #{target} not found" if target.nil?
+        else
+          # find the first application target
+          target = project.targets.find { |t| !t.extension_target_type? && !t.test_target_type? }
+          raise "No application target found" if target.nil?
+        end
+        target
+      end
+
+      def domains_from_project(project, target_name, configuration = RELEASE_CONFIGURATION)
+        # Raises. Does not return nil.
+        target = target_from_project project, target_name
+
+        relative_entitlements_path = expanded_build_setting target, CODE_SIGN_ENTITLEMENTS, configuration
+        return [] if relative_entitlements_path.nil?
+
+        project_parent = File.dirname project.path
+        entitlements_path = File.expand_path relative_entitlements_path, project_parent
+
+        # Raises
+        entitlements = File.open(entitlements_path) { |f| Plist.parse_xml f }
+        raise "Failed to parse entitlements file #{entitlements_path}" if entitlements.nil?
+
+        entitlements[ASSOCIATED_DOMAINS].select { |d| d =~ /^applinks:/ }.map { |d| d.sub(/^applinks:/, "") }
+      end
+
+      def expanded_build_setting(target, setting_name, configuration)
+        setting_value = target.resolved_build_setting(setting_name)[configuration]
+        return if setting_value.nil?
+
+        search_position = 0
+        while (matches = /\$\(([^(){}]*)\)|\$\{([^(){}]*)\}/.match(setting_value, search_position))
+          macro_name = matches[1] || matches[2]
+          search_position = setting_value.index(macro_name) - 2
+
+          expanded_macro = macro_name == "SRCROOT" ? "." : expanded_build_setting(target, macro_name, configuration)
+          search_position += macro_name.length + 3 and next if expanded_macro.nil?
+
+          setting_value.gsub!(/\$\(#{macro_name}\)|\$\{#{macro_name}\}/, expanded_macro)
+          search_position += expanded_macro.length
+        end
+        setting_value
+      end
+
+      def add_system_frameworks(project, target_name, frameworks)
+        target = target_from_project project, target_name
+
+        target.add_system_framework frameworks
+      end
+
+      def patch_app_delegate_swift(project)
+        app_delegate_swift = project.files.find { |f| f.path =~ /AppDelegate.swift$/ }
+        return false if app_delegate_swift.nil?
+
+        app_delegate_swift_path = app_delegate_swift.real_path.to_s
+
+        app_delegate = File.open(app_delegate_swift_path, &:read)
+        return false if app_delegate =~ /import\s+Branch/
+
+        say "Patching #{app_delegate_swift_path}"
+
+        apply_patch(
+          files: app_delegate_swift_path,
+          regexp: /^\s*import .*$/,
+          text: "\nimport Branch",
+          mode: :prepend
+        )
+
+        # TODO: This is Swift 3. Support other versions, esp. 4.
+        init_session_text = <<-EOF
+        #if DEBUG
+            Branch.setUseTestBranchKey(true)
+        #endif
+
+        Branch.getInstance().initSession(launchOptions: launchOptions) {
+            universalObject, linkProperties, error in
+
+            // TODO: Route Branch links
+        }
+        EOF
+
+        apply_patch(
+          files: app_delegate_swift_path,
+          regexp: /didFinishLaunchingWithOptions.*?\{[^\n]*\n/m,
+          text: init_session_text,
+          mode: :append
+        )
+
+        unless app_delegate =~ /application:.*continueUserActivity:.*restorationHandler:/
+          # Add the application:continueUserActivity:restorationHandler method if it does not exist
+          continue_user_activity_text = <<-EOF
+
+
+    func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
+      return Branch.getInstance().continue(userActivity)
+    }
+          EOF
+
+          apply_patch(
+            files: app_delegate_swift_path,
+            regexp: /\n\s*\}[^{}]*\Z/m,
+            text: continue_user_activity_text,
+            mode: :prepend
+          )
+        end
+
+        add_change app_delegate_swift_path
+        true
+      end
+
+      def patch_app_delegate_objc(project)
+        app_delegate_objc = project.files.find { |f| f.path =~ /AppDelegate.m$/ }
+        return false if app_delegate_objc.nil?
+
+        app_delegate_objc_path = app_delegate_objc.real_path.to_s
+
+        app_delegate = File.open(app_delegate_objc_path, &:read)
+        return false if app_delegate =~ %r{^\s+#import\s+<Branch/Branch.h>|^\s+@import\s+Branch;}
+
+        say "Patching #{app_delegate_objc_path}"
+
+        apply_patch(
+          files: app_delegate_objc_path,
+          regexp: /^\s+@import|^\s+#import.*$/,
+          text: "\n#import <Branch/Branch.h>",
+          mode: :prepend
+        )
+
+        init_session_text = <<-EOF
+#ifdef DEBUG
+    [Branch setUseTestBranchKey:YES];
+#endif // DEBUG
+
+    [[Branch getInstance] initSessionWithLaunchOptions:launchOptions
+        andRegisterDeepLinkHandlerUsingBranchUniversalObject:^(BranchUniversalObject *universalObject, BranchLinkProperties *linkProperties, NSError *error){
+        // TODO: Route Branch links
+    }];
+        EOF
+
+        apply_patch(
+          files: app_delegate_objc_path,
+          regexp: /didFinishLaunchingWithOptions.*?\{[^\n]*\n/m,
+          text: init_session_text,
+          mode: :append
+        )
+
+        unless app_delegate =~ /application:.*continueUserActivity:.*restorationHandler:/
+          # Add the application:continueUserActivity:restorationHandler method if it does not exist
+          continue_user_activity_text = <<-EOF
+
+
+- (BOOL)application:(UIApplication *)app continueUserActivity:(nonnull NSUserActivity *)userActivity restorationHandler:(nonnull void (^)(NSArray * _Nullable))restorationHandler
+{
+    return [[Branch getInstance] continueUserActivity:userActivity];
+}
+          EOF
+
+          apply_patch(
+            files: app_delegate_objc_path,
+            regexp: /\n\s*@end[^@]*\Z/m,
+            text: continue_user_activity_text,
+            mode: :prepend
+          )
+        end
+
+        add_change app_delegate_objc_path
+        true
+      end
+
+      def patch_podfile(podfile_path)
+        podfile = File.open(podfile_path, &:read)
+
+        # Podfile already contains the Branch pod
+        return false if podfile =~ /pod\s+('Branch'|"Branch")/
+
+        say "Adding pod \"Branch\" to #{podfile_path}"
+
+        # TODO: Improve this patch. Should work in the majority of cases for now.
+        apply_patch(
+          files: podfile_path,
+          regexp: /^(\s*)pod\s*/,
+          text: "\n\\1pod \"Branch\"\n",
+          mode: :prepend
+        )
+
+        true
+      end
+
+      def patch_cartfile(cartfile_path)
+        cartfile = File.open(cartfile_path, &:read)
+
+        # Cartfile already contains the Branch framework
+        return false if cartfile =~ /git.+Branch/
+
+        say "Adding \"Branch\" to #{cartfile_path}"
+
+        apply_patch(
+          files: cartfile_path,
+          regexp: /\z/,
+          text: "git \"https://github.com/BranchMetrics/ios-branch-deep-linking\"\n",
+          mode: :append
+        )
+
+        true
+      end
+    end
+  end
+end

data/lib/branch_io_cli/version.rb

@@ -0,0 +1,3 @@
+module BranchIOCLI
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: branch_io_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Branch
+- Jimmy Dee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pattern_patch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Set up mobile app projects (currently iOS only) to use the Branch SDK
+  without opening Xcode. Validate the Universal Link settings for any project.
+email:
+- integrations@branch.io
+- jgvdthree@gmail.com
+executables:
+- branch_io
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/branch_io
+- lib/branch_io_cli.rb
+- lib/branch_io_cli/cli.rb
+- lib/branch_io_cli/command.rb
+- lib/branch_io_cli/helper.rb
+- lib/branch_io_cli/helper/android_helper.rb
+- lib/branch_io_cli/helper/branch_helper.rb
+- lib/branch_io_cli/helper/ios_helper.rb
+- lib/branch_io_cli/version.rb
+homepage: http://github.com/BranchMetrics/branch_io_cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Branch.io command-line interface for mobile app integration
+test_files: []