branch_io_cli 0.13.0.pre.1 → 0.13.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e152cd651e5f3b196fe8a21e574e14cfdebfe3d240d8b8d7e7af69a27660b9d
-  data.tar.gz: 161b30c50fb66dda28a6300242dd63bf3ae050234e46293cad3c971ee6185a16
+  metadata.gz: 4bbc782e922e498b04f39138c04d0f2ca7ee5c1df7b275b0301765b4f96795dd
+  data.tar.gz: 91eaf176be8ae4ff130714918180f1fb7e6b3cea05d10938ec22b7c6973c58a6
 SHA512:
-  metadata.gz: bf27462ea52842ef5cd7e8c8d8adf4a4733424479035f57c6260a0cf0915bcf2e7de5e8689350c15991509a542107e6b3dadcb42eb262153051ccbb434edb768
-  data.tar.gz: 34a74447f9229e39f1cedc29d8ba56a387d260a4bde2db4461425a9e3ceb820f619980484c18babe4533b214ea22dec682418cdc83b04beb172c937a0c02af81
+  metadata.gz: 797fa7dc2c642e125bca2da9220ef0380310ed3a08c4bcf538c7c33474faa61379eddfbee61cae20e4c2ec1388adfe2a7f4d20089d69992ca99105a7035d49c6
+  data.tar.gz: 7e872acd6813a7d522ffb16af73fe96eac37f6e0cf25a02ac7f5c5a257047a23e21157616ed762ce5af84ad20e4b819399396c498be0bf4ebf6af689f378945e

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Branch Metrics, Inc.
+Copyright (c) 2017-18 Branch Metrics, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,10 +7,6 @@ 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
@@ -20,12 +16,25 @@ the same support via Fastlane.
 
 ## Getting started
 
+To install a prerelease version of `0.13`:
+
 ```bash
-gem install branch_io_cli
+gem install branch_io_cli --pre
 ```
 
 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
@@ -55,7 +64,7 @@ any Ruby-related environment variables if using the system Ruby.
 Add to `~/.bash_profile` or `~/.bashrc`:
 
 ```bash
-. `gem which branch_io_cli | sed 's+branch_io_cli.rb$+assets/completions/completion.bash+'`
+[[ "$(which br)" == "" ]] || . $(br env -cs bash)
 ```
 
 #### Zsh
@@ -63,7 +72,7 @@ Add to `~/.bash_profile` or `~/.bashrc`:
 Add to `~/.zshrc`:
 
 ```zsh
-. `gem which branch_io_cli | sed 's+branch_io_cli.rb$+assets/completions/completion.zsh+'`
+[[ "$(which br)" == "" ]] || . $(br env -cs zsh)
 ```
 
 Currently command-line completion for bash is much more extensive than for zsh.
@@ -263,6 +272,37 @@ See https://github.com/BranchMetrics/branch_io_cli#validate-command for more inf
 |--[no-]confirm|Enable or disable many prompts (default: yes)|BRANCH_CONFIRM|
 
 
+#### Examples
+
+
+##### Ensure project has at least one correctly configured Branch key and domain
+
+```bash
+br validate
+```
+
+
+##### Ensure project is correctly configured for certain Branch keys
+
+```bash
+br validate -L key_live_xxxx -T key_test_yyyy
+```
+
+
+##### Ensure project is correctly configured to use specific domains
+
+```bash
+br validate -D myapp.app.link,myapp-alternate.app.link
+```
+
+
+##### Validate only Universal Link configuration
+
+```bash
+br validate --universal-links-only
+```
+
+
 
 
 
@@ -302,6 +342,71 @@ building.
 |--[no-]confirm|Enable or disable many prompts (default: yes)|BRANCH_CONFIRM|
 
 
+#### Examples
+
+
+##### Show general project information without building
+
+```bash
+br report -H
+```
+
+
+##### Perform a full build and report all errors to report.txt
+
+```bash
+br report
+```
+
+
+##### Don't clean before building
+
+```bash
+br report --no-clean
+```
+
+
+
+
+### Env command
+
+```bash
+branch_io env [OPTIONS]
+br env [OPTIONS]
+```
+
+Output information about CLI environment.
+
+
+#### Options
+
+|Option|Description|Env. var.|
+|------|-----------|---------|
+|-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||
+|-c, --[no-]completion-script|Get the path to the completion script for this shell (default: no)|BRANCH_COMPLETION_SCRIPT|
+|-s, --shell zsh|Specify shell for completion script|SHELL|
+|-V, --[no-]verbose|Generate verbose output (default: no)|BRANCH_VERBOSE|
+
+
+#### Examples
+
+
+##### Show CLI environment
+
+```bash
+br env
+```
+
+
+##### Get completion script for zsh
+
+```bash
+br env -cs zsh
+```
+
+
 
 
 

data/lib/assets/completions/completion.bash

@@ -9,10 +9,12 @@ _branch_io_complete()
     prev="${COMP_WORDS[COMP_CWORD-1]}"
     cmd="${COMP_WORDS[1]}"
 
-    commands="setup report validate"
+    commands="env setup report validate"
     global_opts="-h --help -t --trace -v --version"
 
 
+    env_opts="-c --completion-script -s --shell -V --verbose"
+
     setup_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"
 
     report_opts="--workspace --xcodeproj --scheme --target --configuration --sdk --podfile --cartfile --no-clean -H --header-only --no-pod-repo-update -o --out --no-confirm"
@@ -31,6 +33,9 @@ _branch_io_complete()
         validate)
           opts=$validate_opts
           ;;
+        env)
+          opts=$env_opts
+          ;;
         *)
           opts=$global_opts
           ;;

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.bash.erb

@@ -9,7 +9,7 @@ _branch_io_complete()
     prev="${COMP_WORDS[COMP_CWORD-1]}"
     cmd="${COMP_WORDS[1]}"
 
-    commands="<%= all_commands.join (' ') %>"
+    commands="<%= all_commands.join(' ') %>"
     global_opts="-h --help -t --trace -v --version"
 
 <% all_commands.each do |command| %>
@@ -27,6 +27,9 @@ _branch_io_complete()
         validate)
           opts=$validate_opts
           ;;
+        env)
+          opts=$env_opts
+          ;;
         *)
           opts=$global_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/env_description.erb

@@ -0,0 +1 @@
+Output information about CLI environment.

data/lib/branch_io_cli.rb

@@ -1,9 +1,9 @@
-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"
-require "branch_io_cli/core_ext"
-require "branch_io_cli/format"
-require "branch_io_cli/helper"
-require "branch_io_cli/version"
+require_relative "branch_io_cli/ascii_art"
+require_relative "branch_io_cli/branch_app"
+require_relative "branch_io_cli/cli"
+require_relative "branch_io_cli/command"
+require_relative "branch_io_cli/configuration"
+require_relative "branch_io_cli/core_ext"
+require_relative "branch_io_cli/format"
+require_relative "branch_io_cli/helper"
+require_relative "branch_io_cli/version"

data/lib/branch_io_cli/branch_app.rb

@@ -1,6 +1,7 @@
 require "active_support/core_ext/hash"
 require "json"
-require "branch_io_cli/helper"
+require_relative "helper"
+require "tty/spinner"
 
 module BranchIOCLI
   class BranchApp
@@ -31,11 +32,19 @@ module BranchIOCLI
     def initialize(key)
       @key = key
 
-      say "Fetching configuration from Branch Dashboard for #{key}."
+      spinner = TTY::Spinner.new "[:spinner] Fetching configuration from Branch Dashboard for #{key}.", format: :flip
+      spinner.auto_spin
 
-      @hash = JSON.parse(Helper::BranchHelper.fetch("#{API_ENDPOINT}#{key}")).symbolize_keys.merge key: key
-
-      say "Done ✅"
+      begin
+        @hash = JSON.parse(Helper::BranchHelper.fetch("#{API_ENDPOINT}#{key}", spin: false)).symbolize_keys.merge key: key
+        spinner.success
+        @valid = true
+      rescue StandardError => e
+        spinner.error
+        say e.message
+        @valid = false
+        return
+      end
 
       @alternate_short_url_domain = @hash[:alternate_short_url_domain]
       @android_package_name = @hash[:android_package_name]
@@ -47,6 +56,10 @@ module BranchIOCLI
       @short_url_domain = @hash[:short_url_domain]
     end
 
+    def valid?
+      @valid
+    end
+
     def domains
       [alternate_short_url_domain, default_short_url_domain, short_url_domain].compact.uniq
     end

data/lib/branch_io_cli/cli.rb

@@ -1,6 +1,6 @@
 require "rubygems"
 require "commander"
-require "branch_io_cli/format"
+require_relative "format"
 
 module BranchIOCLI
   class CLI

data/lib/branch_io_cli/command.rb

@@ -1,4 +1,5 @@
-require "branch_io_cli/command/command"
-require "branch_io_cli/command/report_command"
-require "branch_io_cli/command/setup_command"
-require "branch_io_cli/command/validate_command"
+require_relative "command/command"
+require_relative "command/env_command"
+require_relative "command/report_command"
+require_relative "command/setup_command"
+require_relative "command/validate_command"

data/lib/branch_io_cli/command/command.rb

@@ -49,6 +49,10 @@ module BranchIOCLI
       def tool_helper
         Helper::ToolHelper
       end
+
+      def env
+        Configuration::Environment
+      end
     end
   end
 end

data/lib/branch_io_cli/command/env_command.rb

@@ -0,0 +1,22 @@
+module BranchIOCLI
+  module Command
+    class EnvCommand < Command
+      def run!
+        if config.show_all?
+          say "\n" unless config.quiet
+          say "<%= color('CLI version:', BOLD) %> #{VERSION}"
+          say env.ruby_header(include_load_path: true)
+        else
+          script_path = env.completion_script
+          if script_path.nil?
+            say "Completion script not available for #{env.shell}"
+            return 1
+          end
+          puts script_path
+        end
+
+        0
+      end
+    end
+  end
+end

data/lib/branch_io_cli/command/report_command.rb

@@ -18,6 +18,8 @@ module BranchIOCLI
         end
 
         if config.header_only
+          say "\n"
+          say env.ruby_header
           say report_helper.report_header
           return 0
         end
@@ -35,6 +37,13 @@ module BranchIOCLI
       def write_report(report)
         report.write "Branch.io Xcode build report v #{VERSION} #{Time.now}\n\n"
         report.write "#{config.report_configuration}\n"
+
+        if report == STDOUT
+          say env.ruby_header
+        else
+          report.write env.ruby_header(terminal: false, include_load_path: true)
+        end
+
         report.write "#{report_helper.report_header}\n"
 
         tool_helper.pod_install_if_required report

data/lib/branch_io_cli/command/setup_command.rb

@@ -1,4 +1,4 @@
-require "branch_io_cli/helper"
+require_relative "../helper"
 
 module BranchIOCLI
   module Command
@@ -139,7 +139,7 @@ module BranchIOCLI
 
         case choice
         when /^Stash/
-          sh "git stash -q"
+          sh %w(git stash -q)
         when /^Commit/
           message = ask "Please enter a commit message: "
           sh "git", "commit", "-aqm", message

data/lib/branch_io_cli/configuration.rb

@@ -1,10 +1,13 @@
-require "branch_io_cli/configuration/configuration"
-require "branch_io_cli/configuration/option"
-require "branch_io_cli/configuration/option_wrapper"
-require "branch_io_cli/configuration/report_configuration"
-require "branch_io_cli/configuration/report_options"
-require "branch_io_cli/configuration/setup_configuration"
-require "branch_io_cli/configuration/setup_options"
-require "branch_io_cli/configuration/validate_configuration"
-require "branch_io_cli/configuration/validate_options"
-require "branch_io_cli/configuration/xcode_settings"
+require_relative "configuration/configuration"
+require_relative "configuration/env_configuration"
+require_relative "configuration/env_options"
+require_relative "configuration/environment"
+require_relative "configuration/option"
+require_relative "configuration/option_wrapper"
+require_relative "configuration/report_configuration"
+require_relative "configuration/report_options"
+require_relative "configuration/setup_configuration"
+require_relative "configuration/setup_options"
+require_relative "configuration/validate_configuration"
+require_relative "configuration/validate_options"
+require_relative "configuration/xcode_settings"

data/lib/branch_io_cli/configuration/configuration.rb

@@ -81,6 +81,7 @@ module BranchIOCLI
       attr_reader :sdk
       attr_reader :keys
       attr_reader :apps
+      attr_reader :quiet
 
       def initialize(options)
         @options = options
@@ -90,10 +91,13 @@ module BranchIOCLI
 
         Configuration.current = self
 
-        say "\n"
-        print_identification
-        say ASCII_ART
-        say "\n"
+        unless quiet
+          say "\n"
+          print_identification
+          say ASCII_ART
+          say "\n"
+        end
+
         validate_options
         log
       end
@@ -103,6 +107,8 @@ module BranchIOCLI
       end
 
       def log
+        return if quiet
+
         say <<EOF
 <%= color('Configuration:', [CYAN, BOLD, UNDERLINE]) %>
 
@@ -300,7 +306,7 @@ EOF
         end
 
         # For now: When using --no-validate with the setup command, don't call the Branch API.
-        return true unless respond_to?(:validate) && validate
+        return true unless self.class.available_options.map(&:name).include?(:validate) && validate
 
         begin
           # Retrieve info from the API