branch_io_cli 0.12.10 → 0.13.0.pre.1

data/lib/branch_io_cli/configuration/configuration.rb

@@ -79,11 +79,14 @@ module BranchIOCLI
       attr_reader :workspace_path
       attr_reader :pod_repo_update
       attr_reader :sdk
+      attr_reader :keys
+      attr_reader :apps
 
       def initialize(options)
         @options = options
         @pod_repo_update = options.pod_repo_update if self.class.available_options.map(&:name).include?(:pod_repo_update)
         @sdk = "iphonesimulator" # to load Xcode build settings for commands without a --sdk option
+        @confirm = options.confirm
 
         Configuration.current = self
 
@@ -269,6 +272,54 @@ EOF
         end
       end
 
+      def validate_keys(optional: false)
+        @keys = {}
+        @apps = {}
+
+        # 1. Check the options passed in. If nothing (nil) passed, continue.
+        validate_key options.live_key, :live, accept_nil: true
+        validate_key options.test_key, :test, accept_nil: true
+
+        # 2. Did we find a valid key above?
+        while !optional && @keys.empty?
+          # 3. If not, prompt.
+          say "A live key, a test key or both is required."
+          validate_key nil, :live
+          validate_key nil, :test
+        end
+
+        # 4. We have at least one valid key now, unless optional is truthy.
+      end
+
+      def key_valid?(key, type)
+        return false if key.nil?
+        return true if key.empty?
+        unless key =~ /^key_#{type}_.+/
+          say "#{key.inspect} is not a valid #{type} Branch key. It must begin with key_#{type}_."
+          return false
+        end
+
+        # For now: When using --no-validate with the setup command, don't call the Branch API.
+        return true unless respond_to?(:validate) && validate
+
+        begin
+          # Retrieve info from the API
+          app = BranchApp[key]
+          @apps[key] = app
+          true
+        rescue StandardError => e
+          say "Error fetching app for key #{key} from Branch API: #{e.message}"
+          false
+        end
+      end
+
+      def validate_key(key, type, options = {})
+        return if options[:accept_nil] && key.nil?
+        key = ask "Please enter your #{type} Branch key or use --#{type}-key [enter for none]: " until key_valid? key, type
+        @keys[type] = key unless key.empty?
+        instance_variable_set "@#{type}_key", key
+      end
+
       def pod_install_required?
         # If this is set, its existence has been verified.
         return false unless podfile_path
@@ -344,6 +395,10 @@ EOF
         path && path.sub(/\.h$/, '.m')
       end
 
+      def ios_urischemes_from_api(apps = @apps)
+        Set.new apps.map(&:ios_uri_scheme).compact
+      end
+
       # TODO: How many of these can vary by configuration?
 
       def modules_enabled?

data/lib/branch_io_cli/configuration/option.rb

@@ -1,6 +1,17 @@
 module BranchIOCLI
   module Configuration
     class Option
+      def self.global_options
+        [
+          new(
+            name: :confirm,
+            description: "Enable or disable many prompts",
+            default_value: true,
+            skip_confirmation: true
+          )
+        ]
+      end
+
       attr_accessor :name
       attr_accessor :env_name
       attr_accessor :type

data/lib/branch_io_cli/configuration/report_configuration.rb

@@ -12,11 +12,6 @@ module BranchIOCLI
 
       attr_reader :report_path
 
-      def initialize(options)
-        @confirm = options.confirm
-        super
-      end
-
       def validate_options
         @clean = options.clean
         @header_only = options.header_only
@@ -67,6 +62,7 @@ EOF
 <%= color('Xcode project:', BOLD) %> #{xcodeproj_path || '(none)'}
 <%= color('Scheme:', BOLD) %> #{scheme || '(none)'}
 <%= color('Target:', BOLD) %> #{target || '(none)'}
+<%= color('Target type:', BOLD) %> #{target.product_type}
 <%= color('Configuration:', BOLD) %> #{configuration || '(none)'}
 <%= color('SDK:', BOLD) %> #{sdk}
 <%= color('Podfile:', BOLD) %> #{relative_path(podfile_path) || '(none)'}

data/lib/branch_io_cli/configuration/report_options.rb

@@ -77,14 +77,8 @@ module BranchIOCLI
               example: "./report.txt",
               type: String,
               env_name: "BRANCH_REPORT_PATH"
-            ),
-            Option.new(
-              name: :confirm,
-              description: "Confirm before running certain commands",
-              default_value: true,
-              skip_confirmation: true
             )
-          ]
+          ] + Option.global_options
         end
       end
     end

data/lib/branch_io_cli/configuration/setup_configuration.rb

@@ -27,11 +27,9 @@ module BranchIOCLI
           "Skip adding the framework to the project." => :skip
         }
 
-      attr_reader :keys
       attr_reader :all_domains
 
       def initialize(options)
-        @confirm = options.confirm
         super
         # Configuration has been validated and logged to the screen.
         confirm_with_user if options.confirm
@@ -52,7 +50,7 @@ module BranchIOCLI
 
         validate_xcodeproj_path
         validate_target
-        validate_keys_from_setup_options options
+        validate_keys
         validate_all_domains options, !target.extension_target_type?
         validate_uri_scheme options
         validate_setting options
@@ -77,6 +75,7 @@ module BranchIOCLI
         message = <<-EOF
 <%= color('Xcode project:', BOLD) %> #{xcodeproj_path}
 <%= color('Target:', BOLD) %> #{target.name}
+<%= color('Target type:', BOLD) %> #{target.product_type}
 <%= color('Live key:', BOLD) %> #{keys[:live] || '(none)'}
 <%= color('Test key:', BOLD) %> #{keys[:test] || '(none)'}
 <%= color('Domains:', BOLD) %> #{all_domains}
@@ -118,39 +117,6 @@ module BranchIOCLI
         say message
       end
 
-      def validate_keys_from_setup_options(options)
-        @keys = {}
-
-        # 1. Check the options passed in. If nothing (nil) passed, continue.
-        validate_key options.live_key, :live, accept_nil: true
-        validate_key options.test_key, :test, accept_nil: true
-
-        # 2. Did we find a valid key above?
-        while @keys.empty?
-          # 3. If not, prompt.
-          say "A live key, a test key or both is required."
-          validate_key nil, :live
-          validate_key nil, :test
-        end
-
-        # 4. We have at least one valid key now.
-      end
-
-      def key_valid?(key, type)
-        return false if key.nil?
-        key.empty? || key =~ /^key_#{type}_/
-      end
-
-      def validate_key(key, type, options = {})
-        return if options[:accept_nil] && key.nil?
-        until key_valid? key, type
-          say "#{key.inspect} is not a valid #{type} Branch key. It must begin with key_#{type}_." if key
-          key = ask "Please enter your #{type} Branch key or use --#{type}-key [enter for none]: "
-        end
-        @keys[type] = key unless key.empty?
-        instance_variable_set "@#{type}_key", key
-      end
-
       def validate_all_domains(options, required = true)
         app_link_roots = app_link_roots_from_domains options.domains
 
@@ -174,6 +140,10 @@ module BranchIOCLI
         end
       end
 
+      def domains_from_api
+        helper.domains @apps
+      end
+
       def validate_uri_scheme(options)
         # No validation at the moment. Just strips off any trailing ://
         uri_scheme = options.uri_scheme

data/lib/branch_io_cli/configuration/setup_options.rb

@@ -139,14 +139,8 @@ module BranchIOCLI
               example: "message",
               argument_optional: true,
               label: "Commit message"
-            ),
-            Option.new(
-              name: :confirm,
-              description: "Confirm configuration before proceeding",
-              default_value: true,
-              skip_confirmation: true
             )
-          ]
+          ] + Option.global_options
         end
       end
     end

data/lib/branch_io_cli/configuration/validate_configuration.rb

@@ -19,6 +19,7 @@ module BranchIOCLI
       def validate_options
         validate_xcodeproj_path
         validate_target
+        validate_keys optional: true
       end
 
       def log
@@ -26,6 +27,9 @@ module BranchIOCLI
         say <<EOF
 <%= color('Xcode project:', BOLD) %> #{xcodeproj_path}
 <%= color('Target:', BOLD) %> #{target.name}
+<%= color('Target type:', BOLD) %> #{target.product_type}
+<%= color('Live key:', BOLD) %> #{keys[:live] || '(none)'}
+<%= color('Test key:', BOLD) %> #{keys[:test] || '(none)'}
 <%= color('Domains:', BOLD) %> #{domains || '(none)'}
 <%= color('Configurations:', BOLD) %> #{(configurations || xcodeproj.build_configurations.map(&:name)).join(',')}
 EOF

data/lib/branch_io_cli/configuration/validate_options.rb

@@ -4,9 +4,23 @@ module BranchIOCLI
       class << self
         def available_options
           [
+            Option.new(
+              name: :live_key,
+              description: "Branch live key expected in project",
+              example: "key_live_xxxx",
+              type: String,
+              aliases: "-L"
+            ),
+            Option.new(
+              name: :test_key,
+              description: "Branch test key expected in project",
+              example: "key_test_yyyy",
+              type: String,
+              aliases: "-T"
+            ),
             Option.new(
               name: :domains,
-              description: "Comma-separated list of domains to validate (Branch domains or non-Branch domains)",
+              description: "Comma-separated list of domains expected to be configured in the project (Branch domains or non-Branch domains)",
               type: Array,
               example: "example.com,www.example.com",
               aliases: "-D",
@@ -14,7 +28,7 @@ module BranchIOCLI
             ),
             Option.new(
               name: :xcodeproj,
-              description: "Path to an Xcode project to update",
+              description: "Path to an Xcode project to validate",
               type: String,
               example: "MyProject.xcodeproj"
             ),
@@ -29,8 +43,13 @@ module BranchIOCLI
               description: "Comma-separated list of configurations to validate (default: all)",
               type: Array,
               example: "Debug,Release"
+            ),
+            Option.new(
+              name: :universal_links_only,
+              description: "Validate only the Universal Link configuration",
+              default_value: false
             )
-          ]
+          ] + Option.global_options
         end
       end
     end

data/lib/branch_io_cli/core_ext/xcodeproj.rb

@@ -73,7 +73,7 @@ module Xcodeproj
           end
 
           # TODO: What is the correct resolution order here? Which overrides which in
-          # Xcode? Or does it matter here?
+          # Xcode?
           if setting_value.nil? && defined?(BranchIOCLI::Configuration::XcodeSettings)
             setting_value = BranchIOCLI::Configuration::XcodeSettings[configuration][setting_name]
           end
@@ -92,6 +92,8 @@ module Xcodeproj
         # @param configuration [String] Name of any valid configuration for this target
         # @return [String] A copy of the original string with all embedded build settings expanded
         def expand_build_settings(string, configuration)
+          return nil if string.nil?
+
           search_position = 0
           string = string.clone
 
@@ -118,13 +120,13 @@ module Xcodeproj
             # Everything else becomes a hyphen, including underscores.
             expanded_macro.gsub!(/[^A-Za-z0-9-]/, '-') if modifier == "rfc1034identifier"
 
-            string.gsub!(/\$\(#{original_macro}\)|\$\{#{original_macro}\}/, expanded_macro)
+            string.gsub!(/\$\(#{original_macro}\)|\$\{#{original_macro}\}|^#{original_macro}/, expanded_macro)
             search_position += expanded_macro.length
           end
 
           # HACK: When matching against an xcconfig, as here, sometimes the macro is just returned
-          # without delimiters as the entire string or as a path component, e.g. TARGET_NAME or
-          # PROJECT_DIR/PROJECT_NAME/BridgingHeader.h.
+          # without delimiters, e.g. TARGET_NAME or PROJECT_DIR/PROJECT_NAME/BridgingHeader.h. We allow
+          # these two patterns for now.
           string = string.split("/").map do |component|
             next component unless component =~ /^[A-Z0-9_]+$/
             expanded_build_setting(component, configuration) || component

data/lib/branch_io_cli/helper/branch_helper.rb

@@ -1,3 +1,4 @@
+require "active_support/core_ext/hash"
 require "branch_io_cli/helper/android_helper"
 require "branch_io_cli/helper/ios_helper"
 require "net/http"
@@ -67,6 +68,13 @@ module BranchIOCLI
             end
           end
         end
+
+        def domains(apps)
+          apps.inject Set.new do |result, k, v|
+            next result unless v
+            result + v.domains
+          end
+        end
       end
     end
   end

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -1,3 +1,4 @@
+require "active_support/core_ext/object"
 require "json"
 require "openssl"
 require "plist"
@@ -110,7 +111,7 @@ module BranchIOCLI
         end
       end
 
-      def update_info_plist_setting(configuration = RELEASE_CONFIGURATION, &b)
+      def info_plist_path(configuration)
         # find the Info.plist paths for this configuration
         info_plist_path = config.target.expanded_build_setting "INFOPLIST_FILE", configuration
 
@@ -118,12 +119,19 @@ module BranchIOCLI
 
         project_parent = File.dirname config.xcodeproj_path
 
-        info_plist_path = File.expand_path info_plist_path, project_parent
+        File.expand_path info_plist_path, project_parent
+      end
 
+      def info_plist(path)
         # 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?
+        info_plist = File.open(path) { |f| Plist.parse_xml f }
+        raise "Failed to parse #{path}" if info_plist.nil?
+        info_plist
+      end
 
+      def update_info_plist_setting(configuration = RELEASE_CONFIGURATION, &b)
+        info_plist_path = info_plist_path(configuration)
+        info_plist = info_plist(info_plist_path)
         yield info_plist
 
         Plist::Emit.save_plist info_plist, info_plist_path
@@ -249,7 +257,14 @@ module BranchIOCLI
         nil
       end
 
+      def reset_aasa_cache
+        @aasa_files = {}
+      end
+
       def contents_of_aasa_file(domain)
+        @aasa_files ||= {}
+        return @aasa_files[domain] if @aasa_files[domain]
+
         uris = [
           URI("https://#{domain}/.well-known/apple-app-site-association"),
           URI("https://#{domain}/apple-app-site-association")
@@ -289,7 +304,7 @@ module BranchIOCLI
               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"
+              @errors << "[#{domain}] Unsigned AASA files must be served via HTTPS" and next if uri.scheme == "http"
               data = response.body
             end
 
@@ -299,6 +314,7 @@ module BranchIOCLI
 
         @errors << "[#{domain}] Failed to retrieve AASA file" and return nil if data.nil?
 
+        @aasa_files[domain] = data
         data
       rescue IOError, SocketError => e
         @errors << "[#{domain}] Socket error: #{e.message}"
@@ -409,6 +425,92 @@ module BranchIOCLI
 
         associated_domains.select { |d| d =~ /^applinks:/ }.map { |d| d.sub(/^applinks:/, "") }
       end
+
+      # Validates Branch-related settings in a project (keys, domains, URI schemes)
+      def project_valid?(configuration)
+        @errors = []
+
+        info_plist_path = info_plist_path(configuration)
+        info_plist = info_plist(info_plist_path).symbolize_keys
+        branch_key = info_plist[:branch_key]
+
+        if branch_key.blank?
+          say "branch_key not found in Info.plist. ❌"
+          return false
+        end
+
+        if branch_key.kind_of?(Hash)
+          branch_keys = branch_key.map { |k, v| v }
+        else
+          branch_keys = [branch_key]
+        end
+
+        branch_keys = branch_keys.map { |key| config.target.expand_build_settings key, configuration }
+
+        valid = true
+
+        # Retrieve app data from Branch API for all keys in the Info.plist
+        apps = branch_keys.map do |key|
+          begin
+            BranchApp[key]
+          rescue StandardError => e
+            # Failed to retrieve a key in the Info.plist from the API.
+            say "[#{key}] #{e.message} ❌"
+            valid = false
+            nil
+          end
+        end.compact.uniq
+
+        # Get domains and URI schemes loaded from API
+        domains_from_api = domains apps
+
+        # Make sure all domains and URI schemes are present in the project.
+        domains = domains_from_project(configuration)
+        missing_domains = domains_from_api - domains
+        unless missing_domains.empty?
+          valid = false
+          missing_domains.each do |domain|
+            say "[#{domain}] Domain from Dashboard missing from #{configuration} configuration. ❌"
+          end
+        end
+
+        valid
+      end
+
+      def branch_keys_from_project(configurations)
+        configurations.map do |c|
+          path = info_plist_path(c)
+          info_plist = info_plist(path).symbolize_keys
+          branch_key = info_plist[:branch_key]
+          if branch_key.blank?
+            say "branch_key not found in Info.plist. ❌"
+            return []
+          end
+
+          if branch_key.kind_of?(Hash)
+            keys = branch_key.values
+          else
+            keys = [branch_key]
+          end
+
+          keys.map { |key| config.target.expand_build_settings key, c }
+        end.compact.flatten.uniq
+      end
+
+      def branch_apps_from_project(configurations)
+        branch_keys_from_project(configurations).map { |key| BranchApp[key] }
+      end
+
+      def uri_schemes_from_project(configurations)
+        schemes = configurations.map do |c|
+          path = info_plist_path(c)
+          info_plist = info_plist(path)
+          url_types = info_plist["CFBundleURLTypes"] || []
+          url_types.map { |t| t["CFBundleURLSchemes"] }
+        end
+
+        schemes.compact.flatten.uniq
+      end
     end
   end
 end