fastlane-plugin-branch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8305f250691fbd01e191ca2133151dc6ffa22d55
+  data.tar.gz: 953577ba927bb98740c1b41ed282487b5c23c584
+SHA512:
+  metadata.gz: ec225b08a24f31de602203c00c85c6f744d59df021c03f0243b977956f613890b0e69b03a8cd2d9a5fd76d8d06faa46b5e29d540f43ddd33c5e09560b494ee22
+  data.tar.gz: 3403679f0c139b346dcc2482c1d8b6db7de412ba15be91a5e8febfd4fbe2eae2007bef7cdd3e3b0a87f5f168861ad2e86e34ca17fe99599254b75ba71e54ccbd

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jimmy Dee <jgvdthree@gmail.com>
+
+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,165 @@
+# branch plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg?style=flat-square)](https://rubygems.org/gems/fastlane-plugin-branch)
+[![Gem](https://img.shields.io/gem/v/fastlane-plugin-branch.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-branch)
+[![Downloads](https://img.shields.io/gem/dt/fastlane-plugin-branch.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-branch)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/jdee/settings-bundle/blob/master/LICENSE)
+[![CircleCI](https://img.shields.io/circleci/project/github/BranchMetrics/fastlane-plugin-branch.svg)](https://circleci.com/gh/BranchMetrics/fastlane-plugin-branch)
+
+## Preliminary release
+
+This is a preliminary release of this plugin. Please report any problems by opening issues in this repo.
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-branch`, add it to your project by running:
+
+```bash
+fastlane add_plugin branch
+```
+
+## setup_branch action
+
+### Prerequisites
+
+Before using this action, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://dev.branch.io/basic-setup/ for details. To use the `setup_branch` action, you need:
+
+- Branch key(s), either live, test or both
+- Domain name(s) used for Branch links
+- The custom URI scheme for your app, if any (Android only)
+- Location(s) of your Android and/or iOS project(s)
+
+### Usage
+
+This action automatically configures Xcode and Android projects that use the Branch SDK
+for Universal Links, App Links and custom URI handling. It modifies Xcode project settings and entitlements as well as Info.plist and AndroidManifest.xml files.
+
+```ruby
+setup_branch(
+  live_key: "key_live_xxxx",
+  test_key: "key_test_yyyy",
+  app_link_subdomain: "myapp",
+  uri_scheme: "myscheme", # Android only
+  android_project_path: "MyAndroidApp", # MyAndroidApp/src/main/AndroidManifest.xml
+  xcodeproj: "MyIOSApp.xcodeproj"
+)
+```
+
+Use the `:domains` parameter to specify custom domains, including non-Branch domains
+```ruby
+setup_branch(
+  live_key: "key_live_xxxx",
+  domains: %w{example.com www.example.com}
+  xcodeproj: "MyIOSApp.xcodeproj"
+)
+```
+
+Available options:
+
+|Fastfile key|Environment variable|description|type|default value|
+|---|---|---|---|---|
+|:live_key|BRANCH_LIVE_KEY|The Branch live key to use (:live_key or :test_key is required)|string||
+|:test_key|BRANCH_TEST_KEY|The Branch test key to use (:live_key or :test_key is required)|string||
+|:app_link_subdomain|BRANCH_APP_LINK_SUBDOMAIN|An app.link subdomain to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|string||
+|:domains|BRANCH_DOMAINS|A list of domains (custom domains or Branch domains) to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|string array or comma-separated string||
+|:uri_scheme|BRANCH_URI_SCHEME|A URI scheme to add to the manifest (Android only)|string||
+|:android_project_path|BRANCH_ANDROID_PROJECT_PATH|Path to an Android project to use. Equivalent to 'android_manifest_path: "app/src/main/AndroidManifest.xml"`. Overridden by :android_manifest_path (:xcodeproj, :android_project_path or :android_manifest_path is required.)|string||
+|:android_manifest_path|BRANCH_ANDROID_MANIFEST_PATH|Path to an Android manifest to modify. Overrides :android_project_path. (:xcodeproj, :android_project_path or :android_manifest_path is required.)|string||
+|:xcodeproj|BRANCH_XCODEPROJ|Path to a .xcodeproj directory to use. (:xcodeproj, :android_project_path or :android_manifest_path is required.)|string||
+|:activity_name|BRANCH_ACTIVITY_NAME|Name of the Activity to use (Android only; optional)|string||
+|:target|BRANCH_TARGET|Name of the target to use in the Xcode project (iOS only; optional)|string||
+|:update_bundle_and_team_ids|BRANCH_UPDATE_BUNDLE_AND_TEAM_IDS|If true, changes the bundle and team identifiers in the Xcode project to match the AASA file. Mainly useful for sample apps. (iOS only)|boolean|false|
+|:remove_existing_domains|BRANCH_REMOVE_EXISTING_DOMAINS|If true, any domains currently configured in the Xcode project or Android manifest will be removed before adding the domains specified by the arguments. Mainly useful for sample apps.|boolean|false|
+|:force|BRANCH_FORCE_UPDATE|Update project(s) even if Universal Link validation fails|boolean|false|
+|:commit|BRANCH_COMMIT_CHANGES|Set to true to commit changes to Git; set to a string to commit with a custom message|boolean or string|false|
+
+Individually, all parameters are optional, but the following conditions apply:
+
+- :android_manifest_path, :android_project_path or :xcodeproj must be specified.
+- :live_key or :test_key must be specified.
+- :app_link_subdomain or :domains must be specified.
+
+This action also supports an optional Branchfile to specify configuration options.
+See the sample Branchfile at the root of this repo.
+
+## validate_universal_links action (iOS only)
+
+This action validates all Universal Link domains configured in a project without making any modification.
+It validates both Branch and non-Branch domains.
+
+
+```ruby
+validate_universal_links
+```
+
+```ruby
+validate_universal_links(xcodeproj: "MyProject.xcodeproj")
+```
+
+```ruby
+validate_universal_links(xcodeproj: "MyProject.xcodeproj", target: "MyProject")
+```
+
+```ruby
+validate_universal_links(domains: %w{example.com www.example.com})
+```
+
+Available options:
+
+|Fastfile key|Environment variable|description|type|default value|
+|---|---|---|---|---|
+|:xcodeproj|BRANCH_XCODEPROJ|Path to a .xcodeproj directory to use|string||
+|:target|BRANCH_TARGET|Name of the target to use in the Xcode project|string||
+|:domains|BRANCH_DOMAINS|A list of domains (custom domains or Branch domains) that must be present in the project.|string array or comma-separated string||
+
+All parameters are optional. Without any parameters, the action looks for a single .xcodeproj
+folder (with the exception of a Pods project) and reports an error if none or more than one is found.
+It uses the first non-test, non-extension target in that project.
+
+If the :domains parameter is not provided, validation will pass as long as there is at least
+one Universal Link domain configured for the target, and all Universal Link domains pass
+AASA validation. If the the :domains parameter is provided, the Universal Link domains in
+the project must also match the value of this parameter without regard to order.
+
+This action does not use the Branchfile.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. To try it:
+
+```bash
+bundle install
+bundle exec fastlane validate          # The example project needs to be set up. This will fail.
+bundle exec fastlane update            # Also validates the UL configuration.
+bundle exec fastlane update_and_commit # Also commit changes to Git. (git reset --hard HEAD^ to erase the last commit)
+bundle exec fastlane validate          # Now validation will pass.
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+bundle exec rake
+```
+
+To automatically fix many of the styling issues, use
+```
+bundle exec rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/branch.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/branch/version'
+
+module Fastlane
+  module Branch
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Branch.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/branch/actions/setup_branch_action.rb

@@ -0,0 +1,200 @@
+require "rexml/document"
+require "xcodeproj"
+
+module Fastlane
+  module Actions
+    class SetupBranchAction < Action
+      # rubocop: disable Metrics/PerceivedComplexity
+      def self.run(params)
+        # First augment with any defaults from Branchfile, if present
+        params.load_configuration_file("Branchfile")
+
+        helper = Helper::BranchHelper
+
+        keys = helper.keys_from_params params
+        raise "Must specify :live_key or :test_key." if keys.empty?
+
+        domains = helper.domains_from_params params
+        raise "Cannot determine domains to add to project. Specify :app_link_subdomain or :domains." if domains.empty?
+
+        if params[:xcodeproj].nil? and params[:android_project_path].nil? and params[:android_manifest_path].nil?
+          raise ":xcodeproj, :android_manifest_path or :android_project_path is required"
+        end
+
+        UI.message "live key: #{keys[:live]}" unless keys[:live].nil?
+        UI.message "test key: #{keys[:test]}" unless keys[:test].nil?
+        UI.message "domains: #{domains}"
+
+        if params[:xcodeproj]
+          # raises
+          xcodeproj = Xcodeproj::Project.open params[:xcodeproj]
+
+          target = params[:target] # may be nil
+
+          if params[:update_bundle_and_team_ids]
+            helper.update_team_and_bundle_ids_from_aasa_file xcodeproj, target, domains.first
+          elsif helper.validate_team_and_bundle_ids_from_aasa_files xcodeproj, target, domains, params[:remove_existing_domains]
+            UI.message "Universal Link configuration passed validation. ✅"
+          else
+            UI.error "Universal Link configuration failed validation."
+            helper.errors.each { |error| UI.error " #{error}" }
+            return unless params[:force]
+          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, params[:remove_existing_domains]
+          other_action.git_add path: new_path if params[:commit] && new_path
+          xcodeproj.save
+        end
+
+        if params[:android_project_path] || params[:android_manifest_path]
+          # :android_manifest_path overrides :android_project_path
+          manifest_path = params[:android_manifest_path] || "#{params[:android_project_path]}/app/src/main/AndroidManifest.xml"
+          manifest = File.open(manifest_path) { |f| REXML::Document.new f }
+
+          helper.add_keys_to_android_manifest manifest, keys
+          # :activity_name and :uri_scheme may be nil. :remove_existing_domains defaults to false
+          helper.add_intent_filters_to_android_manifest manifest,
+                                                        domains,
+                                                        params[:uri_scheme],
+                                                        params[:activity_name],
+                                                        params[:remove_existing_domains]
+
+          File.open(manifest_path, "w") do |f|
+            manifest.write f, 4
+          end
+
+          helper.add_change File.expand_path(manifest_path, Bundler.root)
+        end
+
+        if params[:commit]
+          message = params[:commit].kind_of?(String) ? params[:commit] : "[Fastlane] Branch SDK integration"
+          other_action.git_commit path: helper.changes.to_a, message: message
+        end
+      rescue => e
+        UI.user_error! "Error in SetupBranchAction: #{e.message}\n#{e.backtrace}"
+      end
+      # rubocop: enable Metrics/PerceivedComplexity
+
+      def self.description
+        "Adds Branch keys, custom URI schemes and domains to iOS and Android projects."
+      end
+
+      def self.authors
+        [
+          "Branch <integrations@branch.io>",
+          "Jimmy Dee <jgvdthree@gmail.com>"
+        ]
+      end
+
+      def self.details
+        "This action automatically configures Xcode and Android projects that use the Branch SDK " \
+          "for Universal Links, App Links and custom URI handling. It modifies Xcode project settings and " \
+          "entitlements as well as Info.plist and AndroidManifest.xml files. It also validates the Universal Link " \
+          "configuration for Xcode projects."
+      end
+
+      def self.example_code
+        [
+          <<-EOF
+            setup_branch live_key: "key_live_xxxx",
+                         test_key: "key_test_yyyy",
+               app_link_subdomain: "myapp",
+                       uri_scheme: "myscheme", # Android only
+             android_project_path: "MyAndroidApp", # MyAndroidApp/src/main/AndroidManifest.xml
+                        xcodeproj: "MyIOSApp.xcodeproj"
+          EOF
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                  env_name: "BRANCH_XCODEPROJ",
+                               description: "Path to an Xcode project to modify",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :android_project_path,
+                                  env_name: "BRANCH_ANDROID_PROJECT_PATH",
+                               description: "Path to an Android project to modify",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :android_manifest_path,
+                                  env_name: "BRANCH_ANDROID_MANIFEST_PATH",
+                               description: "Path to and Android manifest to modify",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :live_key,
+                                  env_name: "BRANCH_LIVE_KEY",
+                               description: "The Branch live key for your app",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :test_key,
+                                  env_name: "BRANCH_TEST_KEY",
+                               description: "The Branch test key for your app",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :domains,
+                                  env_name: "BRANCH_DOMAINS",
+                               description: "Branch (and/or non-Branch) Universal Link/App Link domains to add (comma-separated list or array)",
+                                  optional: true,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :app_link_subdomain,
+                                  env_name: "BRANCH_APP_LINK_SUBDOMAIN",
+                               description: "app.link subdomain",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :uri_scheme,
+                                  env_name: "BRANCH_URI_SCHEME",
+                               description: "Custom URI scheme used with Branch (Android only)",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :activity_name,
+                                  env_name: "BRANCH_ACTIVITY_NAME",
+                               description: "Name of the Activity in the manifest containing Branch intent-filers (Android only)",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :target,
+                                  env_name: "BRANCH_TARGET",
+                               description: "Name of the target in the Xcode project to modify (iOS only)",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :update_bundle_and_team_ids,
+                                  env_name: "BRANCH_UPDATE_BUNDLE_AND_TEAM_IDS",
+                               description: "If set to true, updates the bundle and team identifiers to match the AASA file (iOS only)",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :remove_existing_domains,
+                                  env_name: "BRANCH_REMOVE_EXISTING_DOMAINS",
+                               description: "If set to true, removes any existing domains before adding Branch domains",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :force,
+                                  env_name: "BRANCH_FORCE_UPDATE",
+                               description: "Update project(s) even if Universal Link validation fails",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :commit,
+                                  env_name: "BRANCH_COMMIT_CHANGES",
+                               description: "Set to true to commit changes to Git; set to a string to commit with a custom message",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include? platform
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/branch/actions/validate_universal_links_action.rb

@@ -0,0 +1,121 @@
+require "xcodeproj"
+
+module Fastlane
+  module Actions
+    class ValidateUniversalLinksAction < Action
+      def self.run(params)
+        helper = Fastlane::Helper::BranchHelper
+
+        xcodeproj_path = helper.xcodeproj_path_from_params params
+        # Error reporting is done in the helper.
+        return false if xcodeproj_path.nil?
+
+        # raises
+        xcodeproj = Xcodeproj::Project.open xcodeproj_path
+
+        target = params[:target] # may be nil
+        domains = params[:domains] # may be nil
+
+        valid = true
+
+        unless domains.nil?
+          domains_valid = helper.validate_project_domains(
+            helper.custom_domains_from_params(params),
+            xcodeproj,
+            target
+          )
+
+          if domains_valid
+            UI.message "Project domains match :domains parameter: ✅"
+          else
+            UI.error "Project domains do not match specified :domains"
+            helper.errors.each { |error| UI.error " #{error}" }
+          end
+
+          valid &&= domains_valid
+        end
+
+        configuration_valid = helper.validate_team_and_bundle_ids_from_aasa_files xcodeproj, target
+        unless configuration_valid
+          UI.error "Universal Link configuration failed validation."
+          helper.errors.each { |error| UI.error " #{error}" }
+        end
+
+        valid &&= configuration_valid
+
+        UI.message "Universal Link configuration passed validation. ✅" if valid
+
+        valid
+      rescue => e
+        UI.user_error! "Error in ValidateUniversalLinksAction: #{e.message}\n#{e.backtrace}"
+        false
+      end
+
+      def self.description
+        "Validates Universal Link configuration for an Xcode project."
+      end
+
+      def self.authors
+        [
+          "Branch <integrations@branch.io>",
+          "Jimmy Dee <jgvdthree@gmail.com>"
+        ]
+      end
+
+      def self.details
+        "This action validates all the Universal Link domains found in an Xcode project's entitlements " \
+        "file by ensuring that the development team and bundle identifier combination is found in the " \
+        "domain's apple-app-site-association file."
+      end
+
+      def self.example_code
+        [
+          <<-EOF
+            validate_universal_links
+          EOF,
+          <<-EOF
+            validate_universal_links xcodeproj: "MyProject.xcodeproj"
+          EOF,
+          <<-EOF
+            validate_universal_links xcodeproj: "MyProject.xcodeproj", target: "MyProject"
+          EOF,
+          <<-EOF
+            validate_universal_links domains: %w{example.com www.example.com}
+          EOF
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                  env_name: "BRANCH_XCODEPROJ",
+                               description: "Path to an Xcode project to modify",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :target,
+                                  env_name: "BRANCH_TARGET",
+                               description: "Name of the target in the Xcode project to modify (iOS only)",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :domains,
+                                  env_name: "BRANCH_DOMAINS",
+                               description: "Branch (and/or non-Branch) Universal Link/App Link domains expected to be present in project (comma-separated list or array)",
+                                  optional: true,
+                                 is_string: false)
+        ]
+      end
+
+      def self.return_value
+        "Returns true for a valid configuration, false otherwise."
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/branch/helper/android_helper.rb

@@ -0,0 +1,86 @@
+module Fastlane
+  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/fastlane/plugin/branch/helper/branch_helper.rb

@@ -0,0 +1,25 @@
+require "fastlane/plugin/branch/helper/android_helper"
+require "fastlane/plugin/branch/helper/configuration_helper"
+require "fastlane/plugin/branch/helper/ios_helper"
+
+module Fastlane
+  module Helper
+    UI = FastlaneCore::UI
+
+    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 ConfigurationHelper
+        include IOSHelper
+
+        def add_change(change)
+          @changes ||= Set.new
+          @changes << change.to_s
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/branch/helper/configuration_helper.rb

@@ -0,0 +1,86 @@
+module Fastlane
+  module Helper
+    module ConfigurationHelper
+      def keys_from_params(params)
+        live_key = params[:live_key]
+        test_key = params[:test_key]
+        keys = {}
+        keys[:live] = live_key unless live_key.nil?
+        keys[:test] = test_key unless test_key.nil?
+        keys
+      end
+
+      def xcodeproj_path_from_params(params)
+        return params[:xcodeproj] if params[:xcodeproj]
+
+        # Adapted from commit_version_bump
+        # https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/commit_version_bump.rb#L21
+
+        # This may not be a git project. Search relative to the Gemfile.
+        repo_path = Bundler.root
+
+        all_xcodeproj_paths = Dir[File.expand_path(File.join(repo_path, '**/*.xcodeproj'))]
+        # find an xcodeproj (ignoring the Cocoapods one)
+        xcodeproj_paths = Fastlane::Actions.ignore_cocoapods_path(all_xcodeproj_paths)
+
+        # no projects found: error
+        UI.user_error!('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")
+          UI.user_error!("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 domains_from_params(params)
+        app_link_subdomains = app_link_subdomains_from_params params
+        custom_domains = custom_domains_from_params params
+        (app_link_subdomains + custom_domains).uniq
+      end
+
+      def app_link_subdomains_from_params(params)
+        app_link_subdomain = params[:app_link_subdomain]
+        live_key = params[:live_key]
+        test_key = params[: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 custom_domains_from_params(params)
+        domains = params[:domains]
+        return [] if domains.nil?
+
+        if domains.kind_of? Array
+          domains = domains.map(&:to_s)
+        elsif domains.kind_of? String
+          domains = domains.split(",")
+        else
+          raise ArgumentError, "Unsupported type #{domains.class.name} for :domains key"
+        end
+
+        domains
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/branch/helper/ios_helper.rb

@@ -0,0 +1,331 @@
+require "plist"
+
+module Fastlane
+  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
+          UI.message "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")
+        ]
+
+        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)
+              UI.important "#{uri} cannot result in a redirect. Ignoring."
+              next
+            elsif response.code.to_i != 200
+              # Try the next URI.
+              UI.message "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 return nil 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 [http.peer_cert], cert_store, nil, OpenSSL::PKCS7::NOVERIFY
+              data = signature.data
+            else
+              data = response.body
+            end
+
+            UI.message "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
+    end
+  end
+end

data/lib/fastlane/plugin/branch/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Branch
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-branch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmy Dee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !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: 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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+description: 
+email: jgvdthree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/branch.rb
+- lib/fastlane/plugin/branch/actions/setup_branch_action.rb
+- lib/fastlane/plugin/branch/actions/validate_universal_links_action.rb
+- lib/fastlane/plugin/branch/helper/android_helper.rb
+- lib/fastlane/plugin/branch/helper/branch_helper.rb
+- lib/fastlane/plugin/branch/helper/configuration_helper.rb
+- lib/fastlane/plugin/branch/helper/ios_helper.rb
+- lib/fastlane/plugin/branch/version.rb
+homepage: https://github.com/BranchMetrics/fastlane-plugin-branch
+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.12
+signing_key: 
+specification_version: 4
+summary: Adds Branch keys, custom URI schemes and domains to iOS and Android projects.
+test_files: []
+has_rdoc: