branch_io_cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ccbe6055b11c7d84271ce19783c90890e6c7b5f
-  data.tar.gz: ac6119e721f6e4c8529a2a01f4fc76fbb97e096e
+  metadata.gz: 78fa18c46004f307435a9372ca7d86f870188b4b
+  data.tar.gz: be9a50a0308af7b2f6b1525d686915dc44b8da91
 SHA512:
-  metadata.gz: f8e945dc2c6db1e08264537075bec5f45f8c562e58a3bc37821ce1ab7c1493021f95b9a89c25d08dfcac6ef7fee7a4f3a0904536967bb6cd961fd17416746f32
-  data.tar.gz: 804615d6d37b159d79e3b801a4d818f62ffebfe45d50c60160253ca7469074c939806a3d64f35a7a7f9dbd9fa69b9b3418b324b7bba8c6802ffc9dd91e56f66e
+  metadata.gz: b19c8b3558ae9c7d08574bc71ac2c71bdd6300ba9d38fa79aa39700de9540537f3a30c51a283abf4b8e84706d79787fbbb1001f57c30efbcc3bea2fe69ecfa92
+  data.tar.gz: 2d7605b8ffabd835c76ff53652f54f4397f3471220eeff601f9dff77e9569bed777c3ef8b485674ec7cf8dc5fe708054afb5003686437cc84558ad745793bc1c

data/README.md

@@ -61,7 +61,7 @@ This can be suppressed using `--no_patch_source`.
 
 #### Prerequisites
 
-Before using this action, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/ for details. To use the `setup` command, you need:
+Before using this command, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/ for details. To use the `setup` command, you need:
 
 - Branch key(s), either live, test or both
 - Domain name(s) used for Branch links
@@ -87,8 +87,9 @@ Before using this action, make sure to set up your app in the [Branch Dashboard]
 |--no_patch_source|Don't add Branch SDK calls to the AppDelegate|
 |--commit|Commit the results to Git|
 
-All parameters are optional, but either `--live_key` or `--test_key` or both must be specified, as well as
-`--app_link_subdomain` or `--domains` or both.
+All parameters are optional. A live key or test key, or both is required, as well as at least one domain.
+Specify --live_key, --test_key or both and --app_link_subdomain, --domains or both. If these are not
+specified, this command will prompt you for this information.
 
 ### Validate command
 

data/lib/branch_io_cli/cli.rb

@@ -11,7 +11,7 @@ module BranchIOCLI
       program :description, "More to come"
 
       command :setup do |c|
-        c.syntax = "branch_io setup"
+        c.syntax = "branch_io setup [OPTIONS]"
         c.description = "Set up an iOS project to use the Branch SDK."
 
         # Required Branch params
@@ -39,8 +39,8 @@ module BranchIOCLI
       end
 
       command :validate do |c|
-        c.syntax = "branch_io validate"
-        c.description = "Validate the Universal Link configuration for an Xcode project"
+        c.syntax = "branch_io validate [OPTIONS]"
+        c.description = "Validate the Universal Link configuration for an Xcode project."
 
         c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project to update"
         c.option "--target MyAppTarget", String, "Name of a target to modify in the Xcode project"

data/lib/branch_io_cli/command.rb

@@ -4,27 +4,12 @@ module BranchIOCLI
   class Command
     class << self
       def setup(options)
-        @domains = all_domains options
-        @keys = keys options
+        options = Helper::ConfigurationHelper.validate_setup_options options
 
-        if @keys.empty?
-          say "Please specify --live_key or --test_key or both."
-          return
-        end
-
-        if @domains.empty?
-          say "Please specify --app_link_subdomain or --domains or both."
-          return
-        end
-
-        @xcodeproj_path = xcodeproj_path options
-        unless @xcodeproj_path
-          say "Please specify the --xcodeproj option."
-          return
-        end
-
-        # raises
-        xcodeproj = Xcodeproj::Project.open @xcodeproj_path
+        @keys = Helper::ConfigurationHelper.keys
+        @domains = Helper::ConfigurationHelper.all_domains
+        @xcodeproj_path = options.xcodeproj
+        xcodeproj = Helper::ConfigurationHelper.xcodeproj
 
         update_podfile(options) || update_cartfile(options, xcodeproj)
 
@@ -57,14 +42,10 @@ module BranchIOCLI
       end
 
       def validate(options)
-        path = xcodeproj_path options
-        unless path
-          say "Please specify the --xcodeproj option."
-          return
-        end
+        options = Helper::ConfigurationHelper.validate_validation_options options
 
         # raises
-        xcodeproj = Xcodeproj::Project.open path
+        xcodeproj = Helper::ConfigurationHelper.xcodeproj
 
         valid = true
 
@@ -102,69 +83,6 @@ module BranchIOCLI
         BranchIOCLI::Helper::BranchHelper
       end
 
-      def xcodeproj_path(options)
-        return options.xcodeproj if options.xcodeproj
-
-        repo_path = "."
-
-        all_xcodeproj_paths = Dir[File.expand_path(File.join(repo_path, '**/*.xcodeproj'))]
-        # find an xcodeproj (ignoring the Pods and Carthage folders)
-        # TODO: Improve this filter
-        xcodeproj_paths = all_xcodeproj_paths.reject { |p| p =~ /Pods|Carthage/ }
-
-        # no projects found: error
-        say 'Could not find a .xcodeproj in the current repository\'s working directory.' and return nil if xcodeproj_paths.count == 0
-
-        # too many projects found: error
-        if xcodeproj_paths.count > 1
-          repo_pathname = Pathname.new repo_path
-          relative_projects = xcodeproj_paths.map { |e| Pathname.new(e).relative_path_from(repo_pathname).to_s }.join("\n")
-          say "Found multiple .xcodeproj projects in the current repository's working directory. Please specify your app's main project: \n#{relative_projects}"
-          return nil
-        end
-
-        # one project found: great
-        xcodeproj_paths.first
-      end
-
-      def app_link_subdomains(options)
-        app_link_subdomain = options.app_link_subdomain
-        live_key = options.live_key
-        test_key = options.test_key
-        return [] if live_key.nil? and test_key.nil?
-        return [] if app_link_subdomain.nil?
-
-        domains = []
-        unless live_key.nil?
-          domains += [
-            "#{app_link_subdomain}.app.link",
-            "#{app_link_subdomain}-alternate.app.link"
-          ]
-        end
-        unless test_key.nil?
-          domains += [
-            "#{app_link_subdomain}.test-app.link",
-            "#{app_link_subdomain}-alternate.test-app.link"
-          ]
-        end
-        domains
-      end
-
-      def all_domains(options)
-        app_link_subdomains = app_link_subdomains options
-        custom_domains = options.domains || []
-        (app_link_subdomains + custom_domains).uniq
-      end
-
-      def keys(options)
-        live_key = options.live_key
-        test_key = options.test_key
-        keys = {}
-        keys[:live] = live_key unless live_key.nil?
-        keys[:test] = test_key unless test_key.nil?
-        keys
-      end
-
       def podfile_path(options)
         # Disable Podfile update if add_sdk: false is present
         return nil if options.no_add_sdk

data/lib/branch_io_cli/helper.rb

@@ -1 +1,2 @@
 require "branch_io_cli/helper/branch_helper"
+require "branch_io_cli/helper/configuration_helper"

data/lib/branch_io_cli/helper/configuration_helper.rb

@@ -0,0 +1,102 @@
+require "xcodeproj"
+
+module BranchIOCLI
+  module Helper
+    class ConfigurationHelper
+      class << self
+        attr_accessor :xcodeproj
+        attr_accessor :keys
+        attr_accessor :all_domains
+
+        def validate_setup_options(options)
+          options.xcodeproj = xcodeproj_path options
+          validate_keys_from_setup_options options
+          validate_all_domains options
+          options
+        end
+
+        def validate_validation_options(options)
+          options.xcodeproj = xcodeproj_path options
+          options
+        end
+
+        def validate_keys_from_setup_options(options)
+          live_key = options.live_key
+          test_key = options.test_key
+          @keys = {}
+          @keys[:live] = live_key unless live_key.nil?
+          @keys[:test] = test_key unless test_key.nil?
+
+          while @keys.empty?
+            say "A live key, a test key or both is required."
+            live_key = ask "Please enter your live Branch key or use --live_key [enter for none]: "
+            test_key = ask "Please enter your test Branch key or use --test_key [enter for none]: "
+
+            @keys[:live] = live_key unless live_key == ""
+            @keys[:test] = test_key unless test_key == ""
+          end
+        end
+
+        def validate_all_domains(options)
+          app_link_subdomains = app_link_subdomains options
+          custom_domains = options.domains || []
+          @all_domains = (app_link_subdomains + custom_domains).uniq
+
+          while @all_domains.empty?
+            @all_domains = ask "Please enter domains as a comma-separated list: ", ->(str) { str.split "," }
+          end
+        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.
+        def xcodeproj_path(options)
+          if options.xcodeproj
+            path = options.xcodeproj
+          else
+            all_xcodeproj_paths = Dir[File.expand_path(File.join(".", "**/*.xcodeproj"))]
+            # find an xcodeproj (ignoring the Pods and Carthage folders)
+            # TODO: Improve this filter
+            xcodeproj_paths = all_xcodeproj_paths.reject { |p| p =~ /Pods|Carthage/ }
+
+            path = xcodeproj_paths.first if xcodeproj_paths.count == 1
+          end
+
+          loop do
+            path = ask "Please enter the path to your Xcode project or use --xcodeproj: " if path.nil?
+            # TODO: Allow the user to choose if xcodeproj_paths.count > 0
+            begin
+              @xcodeproj = Xcodeproj::Project.open path
+              return path
+            rescue StandardError => e
+              say e.message
+            end
+          end
+        end
+
+        def app_link_subdomains(options)
+          app_link_subdomain = options.app_link_subdomain
+          live_key = options.live_key
+          test_key = options.test_key
+          return [] if live_key.nil? and test_key.nil?
+          return [] if app_link_subdomain.nil?
+
+          domains = []
+          unless live_key.nil?
+            domains += [
+              "#{app_link_subdomain}.app.link",
+              "#{app_link_subdomain}-alternate.app.link"
+            ]
+          end
+          unless test_key.nil?
+            domains += [
+              "#{app_link_subdomain}.test-app.link",
+              "#{app_link_subdomain}-alternate.test-app.link"
+            ]
+          end
+          domains
+        end
+      end
+    end
+  end
+end

data/lib/branch_io_cli/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-14 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -184,6 +198,7 @@ files:
 - lib/branch_io_cli/helper.rb
 - lib/branch_io_cli/helper/android_helper.rb
 - lib/branch_io_cli/helper/branch_helper.rb
+- lib/branch_io_cli/helper/configuration_helper.rb
 - lib/branch_io_cli/helper/ios_helper.rb
 - lib/branch_io_cli/version.rb
 homepage: http://github.com/BranchMetrics/branch_io_cli