branch_io_cli 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 334a3a4f55aeb27b4a683036fb8c26c576c93e0e
-  data.tar.gz: 74ea173bc48c7eedd4868098612064ec6369a21c
+  metadata.gz: df2700adf827fe4870ef19d9125cedf54970f134
+  data.tar.gz: eb840f83b956602b89b0ec30770bc3fe251c7845
 SHA512:
-  metadata.gz: 49ff44e9f2aa8c44a9df062ce6a650682823c278028aa1ad6be2488d0c6ca603fe8baf60ce8bc23b7c5c316a9339b58d51682a9909e88eb2448c57f02f43f962
-  data.tar.gz: 6efb3a1bf7349f0b8772ef5e6f03e34b5fcd834004eef6799bcbf5de2eb4b4a719fcf3f549fa77304409d528e09ecc300d04475ec839b3bb681452608b04d855
+  metadata.gz: 458c06211c2619714678d29a1986e060dd3437a25b16a50aa4b5500b6c7a9dd95d38e98b577924e6cc3ae6a169b1a82c5aa3c851b775218b9cc2fddb541d98c2
+  data.tar.gz: 6485a940ce0a27f302007d54dfe141fe8b20543b7866e57c8124e2fd892f52dd5bd29d005d01ea1345ebe3d36e81c465dab8cb32d7066b1cbc867988ba1a13b7

data/README.md

@@ -90,6 +90,7 @@ command, respectively, available in your path.
 |--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)|
+|--uri_scheme myurischeme[://]|Custom URI scheme used in the Branch Dashboard for this app|
 |--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|

data/lib/branch_io_cli/cli.rb

@@ -76,6 +76,7 @@ EOF
         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 "--uri_scheme myurischeme[://]", String, "Custom URI scheme used in the Branch Dashboard for this app"
 
         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"

data/lib/branch_io_cli/command.rb

@@ -29,6 +29,8 @@ module BranchIOCLI
         # the following calls can all raise IOError
         helper.add_keys_to_info_plist xcodeproj, target_name, @keys
         helper.add_branch_universal_link_domains_to_info_plist xcodeproj, target_name, @domains if is_app_target
+        helper.ensure_uri_scheme_in_info_plist if is_app_target # does nothing if already present
+
         new_path = helper.add_universal_links_to_project xcodeproj, target_name, @domains, false if is_app_target
         `git add #{new_path}` if options.commit && new_path
 

data/lib/branch_io_cli/helper/configuration_helper.rb

@@ -18,6 +18,7 @@ module BranchIOCLI
         attr_accessor :podfile_path
         attr_accessor :cartfile_path
         attr_accessor :target
+        attr_accessor :uri_scheme
 
         def validate_setup_options(options)
           print_identification "setup"
@@ -28,6 +29,7 @@ module BranchIOCLI
           validate_target options
           validate_keys_from_setup_options options
           validate_all_domains options, !@target.extension_target_type?
+          validate_uri_scheme options
           validate_buildfile_path options, "Podfile"
           validate_buildfile_path options, "Cartfile"
 
@@ -63,6 +65,7 @@ EOF
 <%= color('Live key:', BOLD) %> #{@keys[:live] || '(none)'}
 <%= color('Test key:', BOLD) %> #{@keys[:test] || '(none)'}
 <%= color('Domains:', BOLD) %> #{@all_domains}
+<%= color('URI scheme:', BOLD) %> #{@uri_scheme || '(none)'}
 <%= color('Podfile:', BOLD) %> #{@podfile_path || '(none)'}
 <%= color('Cartfile:', BOLD) %> #{@cartfile_path || '(none)'}
 
@@ -119,6 +122,11 @@ EOF
           end
         end
 
+        def validate_uri_scheme(options)
+          # No validation at the moment. Just strips off any trailing ://
+          @uri_scheme = uri_scheme_without_suffix options.uri_scheme
+        end
+
         # 1. Look for options.xcodeproj.
         # 2. If not specified, look for projects under . (excluding anything in Pods or Carthage folder).
         # 3. If none or more than one found, prompt the user.
@@ -229,6 +237,12 @@ EOF
           custom_domains + app_link_subdomains
         end
 
+        # Removes any trailing :// from the argument and returns a copy
+        def uri_scheme_without_suffix(scheme)
+          return nil if scheme.nil?
+          scheme.sub %r{://$}, ""
+        end
+
         def validate_buildfile_path(options, filename)
           # Disable Podfile/Cartfile update if --no_add_sdk is present
           return if options.no_add_sdk

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -35,6 +35,43 @@ module BranchIOCLI
         end
       end
 
+      def ensure_uri_scheme_in_info_plist
+        uri_scheme = ConfigurationHelper.uri_scheme
+
+        # No URI scheme specified. Do nothing.
+        return if uri_scheme.nil?
+
+        update_info_plist_setting ConfigurationHelper.xcodeproj,
+                                  ConfigurationHelper.target.name,
+                                  RELEASE_CONFIGURATION do |info_plist|
+          url_types = info_plist["CFBundleURLTypes"] || []
+          uri_schemes = url_types.inject([]) { |schemes, t| schemes + t["CFBundleURLSchemes"] }
+
+          if uri_schemes.empty?
+            say "No URI scheme currently defined in project."
+          else
+            say "Existing URI schemes found in project:"
+            uri_schemes.each do |scheme|
+              say " #{scheme}"
+            end
+          end
+
+          # Already present. Don't mess with the identifier.
+          return if uri_schemes.include? uri_scheme
+
+          # Not found. Add. Don't worry about the CFBundleURLName (reverse-DNS identifier)
+          # TODO: Should we prompt here to add or let them change the Dashboard? If there's already
+          # a URI scheme in the app, seems likely they'd want to use it. They may have just made
+          # a typo at the CLI or in the Dashboard.
+          url_types << {
+            "CFBundleURLSchemes" => [uri_scheme]
+          }
+          info_plist["CFBundleURLTypes"] = url_types
+
+          say "Added URI scheme #{uri_scheme} to project."
+        end
+      end
+
       def update_info_plist_setting(project, target_name, configuration = RELEASE_CONFIGURATION, &b)
         # raises
         target = target_from_project project, target_name
@@ -413,6 +450,8 @@ EOF
           )
         end
 
+        patch_open_url_method_swift app_delegate_swift_path
+
         add_change app_delegate_swift_path
         true
       end
@@ -490,10 +529,120 @@ EOF
           )
         end
 
+        patch_open_url_method_objc app_delegate_objc_path
+
         add_change app_delegate_objc_path
         true
       end
 
+      def patch_open_url_method_swift(app_delegate_swift_path)
+        app_delegate_swift = File.open app_delegate_swift_path, &:read
+        if app_delegate_swift =~ /application.*open\s+url.*options/
+          # Has application:openURL:options:
+          open_url_text = <<-EOF
+        // TODO: Adjust your method as you see fit.
+        if Branch.getInstance().application(app, open: url, options: options) {
+            return true
+        }
+
+          EOF
+
+          apply_patch(
+            files: app_delegate_swift_path,
+            regexp: /application.*open\s+url.*options:.*?\{.*?\n/m,
+            text: open_url_text,
+            mode: :append
+          )
+        elsif app_delegate_swift =~ /application.*open\s+url.*sourceApplication/
+          # Has application:openURL:sourceApplication:annotation:
+          # TODO: This method is deprecated.
+          open_url_text = <<-EOF
+        // TODO: Adjust your method as you see fit.
+        if Branch.getInstance().application(application, open: url, sourceApplication: sourceApplication, annotation: annotation) {
+            return true
+        }
+
+          EOF
+
+          apply_patch(
+            files: app_delegate_swift_path,
+            regexp: /application.*open\s+url.*sourceApplication:.*?\{.*?\n/m,
+            text: open_url_text,
+            mode: :append
+          )
+        else
+          # Has neither
+          open_url_text = <<EOF
+
+
+    func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
+        return Branch.getInstance().application(app, open: url, options: options)
+    }
+EOF
+
+          apply_patch(
+            files: app_delegate_swift_path,
+            regexp: /\n\s*\}[^{}]*\Z/m,
+            text: open_url_text,
+            mode: :prepend
+          )
+        end
+      end
+
+      def patch_open_url_method_objc(app_delegate_objc_path)
+        app_delegate_objc = File.open app_delegate_objc_path, &:read
+        if app_delegate_objc =~ /application:.*openURL:.*options/
+          # Has application:openURL:options:
+          open_url_text = <<-EOF
+    // TODO: Adjust your method as you see fit.
+    if ([[Branch getInstance] application:app openURL:url options:options]) {
+        return YES;
+    }
+
+EOF
+
+          apply_patch(
+            files: app_delegate_objc_path,
+            regexp: /application:.*openURL:.*options:.*?\{.*?\n/m,
+            text: open_url_text,
+            mode: :append
+          )
+        elsif app_delegate_objc =~ /application:.*openURL:.*sourceApplication/
+          # Has application:openURL:sourceApplication:annotation:
+          open_url_text = <<-EOF
+    // TODO: Adjust your method as you see fit.
+    if ([[Branch getInstance] application:application openURL:url sourceApplication:sourceApplication annotation:annotation]) {
+        return YES;
+    }
+
+EOF
+
+          apply_patch(
+            files: app_delegate_objc_path,
+            regexp: /application:.*openURL:.*sourceApplication:.*?\{.*?\n/m,
+            text: open_url_text,
+            mode: :append
+          )
+        else
+          # Has neither
+          open_url_text = <<-EOF
+
+
+- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
+{
+    return [[Branch getInstance] application:app openURL:url options:options];
+}
+          EOF
+
+          apply_patch(
+            files: app_delegate_objc_path,
+            regexp: /\n\s*@end[^@]*\Z/m,
+            text: open_url_text,
+            mode: :prepend
+          )
+        end
+      end
+
       def patch_podfile(podfile_path)
         podfile = File.open(podfile_path, &:read)
 

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander