branch_io_cli 0.12.10 → 0.13.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f39dd1fd898a98b4de753d97c6c009ac8fd74c0a20b17d6dce8b97bf17ef8c
-  data.tar.gz: a90d8ad9020c0012a9b81e4b98f29aa3e95750e452f1fd8d7aa8f76a62eff2b7
+  metadata.gz: 0e152cd651e5f3b196fe8a21e574e14cfdebfe3d240d8b8d7e7af69a27660b9d
+  data.tar.gz: 161b30c50fb66dda28a6300242dd63bf3ae050234e46293cad3c971ee6185a16
 SHA512:
-  metadata.gz: c00d79ec662ce8baafdfce35ba28f5073c44d3030060e416057f261922f0af4d915f75c716905c30e3b7258c8ee15c16a4cee7376aed184e26812631c07e6e58
-  data.tar.gz: 2e66dd0cb1430763d2c68841cb100caf7375343426ecd35e33b134454f905ffc50f5c6fee31ea507a096fe7e0bf92d647a066a555cd96c9fe05f1859034228ce
+  metadata.gz: bf27462ea52842ef5cd7e8c8d8adf4a4733424479035f57c6260a0cf0915bcf2e7de5e8689350c15991509a542107e6b3dadcb42eb262153051ccbb434edb768
+  data.tar.gz: 34a74447f9229e39f1cedc29d8ba56a387d260a4bde2db4461425a9e3ceb820f619980484c18babe4533b214ea22dec682418cdc83b04beb172c937a0c02af81

data/README.md

@@ -7,6 +7,10 @@ This is a command-line tool to integrate the Branch SDK into mobile app projects
 [![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.
+
 ### Using Fastlane?
 
 See also the [Branch Fastlane plugin](https://github.com/BranchMetrics/fastlane-plugin-branch), which offers
@@ -22,17 +26,6 @@ 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`.
 
-### Experimental: Install using Homebrew
-
-```bash
-brew tap jdee/tap
-brew install branch_io_cli
-```
-
-**Note:** Prerelease versions of the CLI are only available from RubyGems for now.
-
-### Getting help
-
 ```bash
 branch_io -h
 branch_io setup -h
@@ -61,40 +54,18 @@ any Ruby-related environment variables if using the system Ruby.
 
 Add to `~/.bash_profile` or `~/.bashrc`:
 
-##### RubyGems
-
 ```bash
 . `gem which branch_io_cli | sed 's+branch_io_cli.rb$+assets/completions/completion.bash+'`
 ```
 
-##### Homebrew
-
-Source the script from the Cellar, e.g.:
-
-```bash
-br_version=`br -v | awk '{ print $4 }'`
-. /usr/local/Cellar/branch_io_cli/${br_version}/libexec/gems/branch_io_cli-${br_version}/lib/assets/completions/completion.bash
-```
-
 #### Zsh
 
 Add to `~/.zshrc`:
 
-##### RubyGems
-
 ```zsh
 . `gem which branch_io_cli | sed 's+branch_io_cli.rb$+assets/completions/completion.zsh+'`
 ```
 
-##### Homebrew
-
-Source the script from the Cellar, e.g.:
-
-```bash
-br_version=`br -v | awk '{ print $4 }'`
-. /usr/local/Cellar/branch_io_cli/${br_version}/libexec/gems/branch_io_cli-${br_version}/lib/assets/completions/completion.zsh
-```
-
 Currently command-line completion for bash is much more extensive than for zsh.
 
 ## Commands
@@ -189,7 +160,7 @@ See https://github.com/BranchMetrics/branch_io_cli#setup-command for more inform
 |--[no-]add-sdk|Add the Branch framework to the project (default: yes)|BRANCH_ADD_SDK|
 |--[no-]patch-source|Add Branch SDK calls to the AppDelegate (default: yes)|BRANCH_PATCH_SOURCE|
 |--commit [message]|Commit the results to Git if non-blank|BRANCH_COMMIT|
-|--[no-]confirm|Confirm configuration before proceeding (default: yes)|BRANCH_CONFIRM|
+|--[no-]confirm|Enable or disable many prompts (default: yes)|BRANCH_CONFIRM|
 
 
 #### Examples
@@ -239,16 +210,26 @@ branch_io validate [OPTIONS]
 br validate [OPTIONS]
 ```
 
-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.
+This command validates all Branch-related settings for a target in an Xcode project,
+including validation of the apple-app-site-association file from each domain.
+Multiple targets may be validated by running the command multiple times using
+the `--target` option. Test targets are not supported.
+
+For each Branch key present in the Info.plist, it retrieves the settings from Branch's
+system. If the information cannot be retrieved (or if the `branch_key` is not present),
+an error is recorded. If the `--live-key` or `--test-key` option is present,
+the set of all keys used by the target must exactly match the options.
 
-Only app targets are supported for this command. By default, it will validate the first.
-If your project has multiple app targets, specify the `--target` option to validate other
-targets.
+All domains and URI schemes configured for the target must include all domains
+and URI schemes configured for all keys used by the target. Other domains or
+URI schemes may also be present in the project.
+
+This command validates all Universal Link domains configured in an application target
+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.
 
 By default, all build configurations in the project are validated. To validate a different list
 of configurations, including a single configuration, specify the `--configurations` option.
@@ -257,7 +238,7 @@ If `--domains` is specified, the list of Universal Link domains in the Associate
 Domains entitlement must exactly match this list, without regard to order, for all
 configurations under validation. If no `--domains` are provided, validation passes
 if at least one Universal Link domain is configured for each configuration and passes
-validation, and no Universal Link domain is present in anyconfiguration that does not
+validation, and no Universal Link domain is present in any configuration that does not
 pass validation.
 
 All parameters are optional.
@@ -272,10 +253,14 @@ See https://github.com/BranchMetrics/branch_io_cli#validate-command for more inf
 |-h, --help|Prints a list of commands or help for each command||
 |-v, --version|Prints the current version of the CLI||
 |-t, --trace|Prints a stack trace when exceptions are raised||
-|-D, --domains example.com,www.example.com|Comma-separated list of domains to validate (Branch domains or non-Branch domains) (default: [])|BRANCH_DOMAINS|
-|--xcodeproj MyProject.xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|
+|-L, --live-key key_live_xxxx|Branch live key expected in project|BRANCH_LIVE_KEY|
+|-T, --test-key key_test_yyyy|Branch test key expected in project|BRANCH_TEST_KEY|
+|-D, --domains example.com,www.example.com|Comma-separated list of domains expected to be configured in the project (Branch domains or non-Branch domains) (default: [])|BRANCH_DOMAINS|
+|--xcodeproj MyProject.xcodeproj|Path to an Xcode project to validate|BRANCH_XCODEPROJ|
 |--target MyAppTarget|Name of a target to validate in the Xcode project|BRANCH_TARGET|
 |--configurations Debug,Release|Comma-separated list of configurations to validate (default: all)|BRANCH_CONFIGURATIONS|
+|--[no-]universal-links-only|Validate only the Universal Link configuration (default: no)|BRANCH_UNIVERSAL_LINKS_ONLY|
+|--[no-]confirm|Enable or disable many prompts (default: yes)|BRANCH_CONFIRM|
 
 
 
@@ -314,7 +299,7 @@ building.
 |-H, --[no-]header-only|Write a report header to standard output and exit (default: no)|BRANCH_HEADER_ONLY|
 |--[no-]pod-repo-update|Update the local podspec repo before installing (default: yes)|BRANCH_POD_REPO_UPDATE|
 |-o, --out ./report.txt|Report output path (default: ./report.txt)|BRANCH_REPORT_PATH|
-|--[no-]confirm|Confirm before running certain commands (default: yes)|BRANCH_CONFIRM|
+|--[no-]confirm|Enable or disable many prompts (default: yes)|BRANCH_CONFIRM|
 
 
 

data/lib/assets/completions/completion.bash

@@ -17,7 +17,7 @@ _branch_io_complete()
 
     report_opts="--workspace --xcodeproj --scheme --target --configuration --sdk --podfile --cartfile --no-clean -H --header-only --no-pod-repo-update -o --out --no-confirm"
 
-    validate_opts="-D --domains --xcodeproj --target --configurations"
+    validate_opts="-L --live-key -T --test-key -D --domains --xcodeproj --target --configurations --universal-links-only --no-confirm"
 
 
     if [[ ${cur} == -* ]] ; then

data/lib/assets/completions/completion.zsh

@@ -5,7 +5,7 @@ _branch_io_complete() {
   local word opts
   word="$1"
   opts="-h --help -t --trace -v --version"
-  opts="$opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme -s --setting --test-configurations --xcodeproj --target --podfile --cartfile --carthage-command --frameworks --no-pod-repo-update --no-validate --force --no-add-sdk --no-patch-source --commit --no-confirm"
+  opts = "$opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme -s --setting --test-configurations --xcodeproj --target --podfile --cartfile --carthage-command --frameworks --no-pod-repo-update --no-validate --force --no-add-sdk --no-patch-source --commit --no-confirm"
 
   reply=( "${(ps: :)opts}" )
 }

data/lib/assets/templates/completion.zsh.erb

@@ -5,7 +5,7 @@ _branch_io_complete() {
   local word opts
   word="$1"
   opts="-h --help -t --trace -v --version"
-  <%= %(opts="$opts #{options_for_command 'setup'}") %>
+  <%= %(opts = "$opts #{options_for_command 'setup'}") %>
 
   reply=( "${(ps: :)opts}" )
 }

data/lib/assets/templates/validate_description.erb

@@ -1,13 +1,23 @@
-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.
+This command validates all Branch-related settings for a target in an Xcode project,
+including validation of the apple-app-site-association file from each domain.
+Multiple targets may be validated by running the command multiple times using
+the <%= option :target %> option. Test targets are not supported.
 
-Only app targets are supported for this command. By default, it will validate the first.
-If your project has multiple app targets, specify the <%= option :target %> option to validate other
-targets.
+For each Branch key present in the Info.plist, it retrieves the settings from Branch's
+system. If the information cannot be retrieved (or if the `branch_key` is not present),
+an error is recorded. If the <%= option :live_key %> or <%= option :test_key %> option is present,
+the set of all keys used by the target must exactly match the options.
+
+All domains and URI schemes configured for the target must include all domains
+and URI schemes configured for all keys used by the target. Other domains or
+URI schemes may also be present in the project.
+
+This command validates all Universal Link domains configured in an application target
+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.
 
 By default, all build configurations in the project are validated. To validate a different list
 of configurations, including a single configuration, specify the <%= option :configurations %> option.
@@ -16,7 +26,7 @@ If <%= option :domains %> is specified, the list of Universal Link domains in th
 Domains entitlement must exactly match this list, without regard to order, for all
 configurations under validation. If no <%= option :domains %> are provided, validation passes
 if at least one Universal Link domain is configured for each configuration and passes
-validation, and no Universal Link domain is present in anyconfiguration that does not
+validation, and no Universal Link domain is present in any configuration that does not
 pass validation.
 
 All parameters are optional.

data/lib/branch_io_cli.rb

@@ -1,4 +1,5 @@
 require "branch_io_cli/ascii_art"
+require "branch_io_cli/branch_app"
 require "branch_io_cli/cli"
 require "branch_io_cli/command"
 require "branch_io_cli/configuration"

data/lib/branch_io_cli/branch_app.rb

@@ -0,0 +1,70 @@
+require "active_support/core_ext/hash"
+require "json"
+require "branch_io_cli/helper"
+
+module BranchIOCLI
+  class BranchApp
+    class << self
+      def [](key)
+        fetch key
+      end
+
+      def fetch(key, cache: true)
+        @apps ||= {}
+        @apps[key] = new(key) unless cache && @apps[key]
+        @apps[key]
+      end
+    end
+
+    API_ENDPOINT = "https://api.branch.io/v1/app-link-settings/"
+
+    attr_reader :key
+    attr_reader :alternate_short_url_domain
+    attr_reader :android_package_name
+    attr_reader :android_uri_scheme
+    attr_reader :default_short_url_domain
+    attr_reader :ios_bundle_id
+    attr_reader :ios_team_id
+    attr_reader :ios_uri_scheme
+    attr_reader :short_url_domain
+
+    def initialize(key)
+      @key = key
+
+      say "Fetching configuration from Branch Dashboard for #{key}."
+
+      @hash = JSON.parse(Helper::BranchHelper.fetch("#{API_ENDPOINT}#{key}")).symbolize_keys.merge key: key
+
+      say "Done ✅"
+
+      @alternate_short_url_domain = @hash[:alternate_short_url_domain]
+      @android_package_name = @hash[:android_package_name]
+      @android_uri_scheme = @hash[:android_uri_scheme]
+      @default_short_url_domain = @hash[:default_short_url_domain]
+      @ios_bundle_id = @hash[:ios_bundle_id]
+      @ios_team_id = @hash[:ios_team_id]
+      @ios_uri_scheme = @hash[:ios_uri_scheme]
+      @short_url_domain = @hash[:short_url_domain]
+    end
+
+    def domains
+      [alternate_short_url_domain, default_short_url_domain, short_url_domain].compact.uniq
+    end
+
+    def to_hash
+      @hash
+    end
+
+    def to_s
+      # Changes
+      # {:key1=>"value1", :key2=>"value2"}
+      # to
+      # key1="value1" key2="value2"
+      @hash.to_s.sub(/^\{\:/, '').sub(/\}$/, '').gsub(/, \:/, ' ').gsub(/\=\>/, '=')
+    end
+
+    def inspect
+      "#<BranchIOCLI::BranchApp #{self}>"
+    end
+  end
+end

data/lib/branch_io_cli/command/report_command.rb

@@ -37,8 +37,8 @@ module BranchIOCLI
         report.write "#{config.report_configuration}\n"
         report.write "#{report_helper.report_header}\n"
 
-        report_helper.pod_install_if_required report
-        report_helper.carthage_bootstrap_if_required report
+        tool_helper.pod_install_if_required report
+        tool_helper.carthage_bootstrap_if_required report
 
         # run xcodebuild -list
         report.sh(*report_helper.base_xcodebuild_cmd, "-list")
@@ -87,6 +87,10 @@ module BranchIOCLI
       def report_helper
         Helper::ReportHelper
       end
+
+      def tool_helper
+        Helper::ToolHelper
+      end
     end
   end
 end

data/lib/branch_io_cli/command/setup_command.rb

@@ -21,15 +21,7 @@ module BranchIOCLI
           return 1 unless valid || config.force
         end
 
-        # Make sure we can resolve all build settings in a project that uses
-        # CocoaPods.
-        if config.podfile_path && File.exist?(config.podfile_path) && config.pod_install_required?
-          tool_helper.verify_cocoapods
-          say "Installing pods to resolve current build settings"
-          # We haven't modified anything yet. Don't use --repo-update at this stage.
-          # This is unlikely to fail.
-          sh "pod install", chdir: File.dirname(config.podfile_path)
-        end
+        return false unless tool_helper.pod_install_if_required
 
         # Set up Universal Links and Branch key(s)
         update_project_settings

data/lib/branch_io_cli/command/validate_command.rb

@@ -2,10 +2,16 @@ module BranchIOCLI
   module Command
     class ValidateCommand < Command
       def run!
-        valid = true
+        say "\n"
 
         configurations = config.configurations || config.xcodeproj.build_configurations.map(&:name)
 
+        return false unless tool_helper.pod_install_if_required
+
+        valid = project_matches_keys?(configurations)
+        schemes_valid = uri_schemes_valid?(configurations)
+        valid &&= schemes_valid
+
         configurations.each do |configuration|
           message = "Validating #{configuration} configuration"
           say "\n<%= color('#{message}', [BOLD, CYAN]) %>\n\n"
@@ -16,30 +22,89 @@ module BranchIOCLI
             domains_valid = helper.validate_project_domains(config.domains, configuration)
 
             if domains_valid
-              say "Project domains match :domains parameter: ✅"
+              say "Project domains match domains parameter. ✅"
             else
-              say "Project domains do not match specified :domains"
+              say "Project domains do not match specified domains. ❌"
               helper.errors.each { |error| say "  #{error}" }
             end
 
             config_valid &&= domains_valid
           end
 
-          entitlements_valid = helper.validate_team_and_bundle_ids_from_aasa_files [], false, configuration
-          unless entitlements_valid
-            say "Universal Link configuration failed validation for #{configuration} configuration."
-            helper.errors.each { |error| say " #{error}" }
+          if config.target.symbol_type == :application
+            entitlements_valid = helper.validate_team_and_bundle_ids_from_aasa_files [], false, configuration
+            unless entitlements_valid
+              say "Universal Link configuration failed validation for #{configuration} configuration. ❌"
+              helper.errors.each { |error| say " #{error}" }
+            end
+
+            config_valid &&= entitlements_valid
+
+            say "Universal Link configuration passed validation for #{configuration} configuration. ✅" if config_valid
           end
 
-          config_valid &&= entitlements_valid
+          unless config.universal_links_only
+            branch_config_valid = helper.project_valid? configuration
+            unless branch_config_valid
+              say "Branch configuration failed validation for #{configuration} configuration. ❌"
+              helper.errors.each { |error| say " #{error}" }
+            end
 
-          say "Universal Link configuration passed validation for #{configuration} configuration. ✅" if config_valid
+            config_valid &&= branch_config_valid
+
+            say "Branch configuration passed validation for #{configuration} configuration. ✅" if config_valid
+          end
 
           valid &&= config_valid
         end
 
+        unless valid
+          say "\nValidation failed. See errors above marked with ❌."
+          say "Please verify your app configuration at https://dashboard.branch.io."
+          say "If your Dashboard configuration is correct, br setup will fix most errors."
+        end
+
         valid ? 0 : 1
       end
+
+      def project_matches_keys?(configurations)
+        expected_keys = [config.live_key, config.test_key].compact
+        return true if expected_keys.empty?
+
+        # Validate the keys in the project against those passed in by the user.
+        branch_keys = helper.branch_keys_from_project(configurations).sort
+
+        keys_valid = expected_keys == branch_keys
+
+        say "\n"
+        if keys_valid
+          say "Branch keys from project match provided keys. ✅"
+        else
+          say "Branch keys from project do not match provided keys. ❌"
+          say " Expected: #{expected_keys.inspect}"
+          say " Actual: #{branch_keys.inspect}"
+        end
+
+        keys_valid
+      end
+
+      def uri_schemes_valid?(configurations)
+        uri_schemes = helper.branch_apps_from_project(configurations).map(&:ios_uri_scheme).compact.uniq
+        expected = uri_schemes.map { |s| BranchIOCLI::Configuration::Configuration.uri_scheme_without_suffix(s) }.sort
+        return true if expected.empty?
+
+        actual = helper.uri_schemes_from_project(configurations).sort
+        valid = (expected - actual).empty?
+        if valid
+          say "URI schemes from project match schemes from Dashboard. ✅"
+        else
+          say "URI schemes from project do not match schemes from Dashboard. ❌"
+          say " Expected: #{expected.inspect}"
+          say " Actual: #{actual.inspect}"
+        end
+
+        valid
+      end
     end
   end
 end