omt-cli 1.6.3 → 1.6.4

data/doc/help.md

@@ -0,0 +1,34 @@
+### 相关指令帮助
+
+`fir help` 命令不仅可以运行在 `fir` 主命令上, 还可以运行在相应子命令上查看相关的帮助.
+
+```sh
+$ fir help
+Commands:
+  fir build_apk BUILD_DIR                       # Build Android app (alias: `ba`).
+  fir build_ipa BUILD_DIR [options] [settings]  # Build iOS app (alias: `bi`).
+  fir help                                      # Describe available commands or one specific command (aliases: `h`).
+  fir info APP_FILE_PATH                        # Show iOS/Android app info, support ipa/apk file (aliases: `i`).
+  fir login                                     # Login fir.im (aliases: `l`).
+  fir mapping MAPPING_FILE_PATH                 # Upload app mapping file to BugHD.com (aliases: `m`).
+  fir me                                        # Show current user info if user is logined.
+  fir publish APP_FILE_PATH                     # Publish iOS/Android app to fir.im, support ipa/apk file (aliases: `...
+  fir upgrade                                   # Upgrade fir-cli and quit (aliases: `u`).
+  fir version                                   # Show fir-cli version number and quit (aliases: `v`).
+
+Options:
+  -T, [--token=TOKEN]              # User's API Token at fir.im
+  -L, [--logfile=LOGFILE]          # Path to writable logfile
+  -V, [--verbose], [--no-verbose]  # Show verbose
+                                   # Default: true
+  -q, [--quiet], [--no-quiet]      # Silence commands
+  -h, [--help], [--no-help]        # Show this help message and quit
+```
+#### 全局参数说明
+
+- `alias <short command>` 意味着可以用 alias 别名来代替该指令, 例如 `fir b`
+- `-T` 用户在 fir.im 上的 api_token
+- `-L` 指定 fir-cli 的输出 log, 默认为 STDOUT
+- `-V` Verbose, 默认为输出所有信息( INFO 和 ERROR), 如果设置 `--no-verbose`, 则只输出 ERROR 信息
+- `-q` 静默模式, 默认关闭
+- `-h` 查看相关命令帮助

data/doc/info.md

@@ -0,0 +1,44 @@
+### fir info
+
+`fir info` 命令用于查看当前 ipa/apk 相关信息.
+
+```sh
+$ fir info --help
+Usage:
+  fir info APP_FILE_PATH
+
+Show iOS/Android app info, support ipa/apk file (aliases: `i`).
+```
+
+#### 查看 ipa 相关信息
+
+```sh
+$ fir info ./build_ipa.ipa
+
+I, [2016-03-08T12:28:29.310846 #11961]  INFO -- : Analyzing ipa file......
+I, [2016-03-08T12:28:29.310932 #11961]  INFO -- : ✈ -------------------------------------------- ✈
+I, [2016-03-08T12:28:29.395706 #11961]  INFO -- : type: ios
+I, [2016-03-08T12:28:29.395775 #11961]  INFO -- : identifier: xx.xxx.build-ipa
+I, [2016-03-08T12:28:29.395793 #11961]  INFO -- : name: build_ipa
+I, [2016-03-08T12:28:29.395805 #11961]  INFO -- : display_name: build_ipa
+I, [2016-03-08T12:28:29.395817 #11961]  INFO -- : build: 1
+I, [2016-03-08T12:28:29.395829 #11961]  INFO -- : version: 1.0
+I, [2016-03-08T12:28:29.396007 #11961]  INFO -- : devices: ["fasdfafaf3f4xxxxxxx78aecbc1234567"]
+I, [2016-03-08T12:28:29.396057 #11961]  INFO -- : release_type: adhoc
+I, [2016-03-08T12:28:29.396086 #11961]  INFO -- : distribution_name: iOSTeam Provisioning Profile: xx.xxx.* - xxx xx xxxxxx LLC.
+I, [2016-03-08T12:28:29.396111 #11961]  INFO -- :
+```
+
+#### 查看 apk 相关信息
+
+```sh
+$ fir info ./test_apk.apk
+I, [2016-03-08T12:30:25.241278 #12073]  INFO -- : Analyzing apk file......
+I, [2016-03-08T12:30:25.241363 #12073]  INFO -- : ✈ -------------------------------------------- ✈
+I, [2016-03-08T12:30:25.250430 #12073]  INFO -- : type: android
+I, [2016-03-08T12:30:25.250477 #12073]  INFO -- : identifier: com.xxx.myapplication
+I, [2016-03-08T12:30:25.250496 #12073]  INFO -- : name: My Application
+I, [2016-03-08T12:30:25.250509 #12073]  INFO -- : build: 1
+I, [2016-03-08T12:30:25.250520 #12073]  INFO -- : version: 1.0
+I, [2016-03-08T12:30:25.250532 #12073]  INFO -- :
+```

data/doc/install.md

@@ -0,0 +1,65 @@
+### 安装
+
+fir-cli 使用 Ruby 构建, 无需编译, 只要安装相应 gem 即可.
+
+```sh
+$ ruby -v # > 1.9.3
+$ gem install fir-cli
+```
+
+#### 常见的安装问题
+
+- 使用系统自带的 Ruby 安装, 需确保 ruby-dev 已被正确的安装:
+
+  ```sh
+  $ xcode-select --install        # OS X 系统
+  $ sudo apt-get install ruby-dev # Linux 系统
+  ```
+
+- 出现 `Permission denied` 相关错误:
+
+  在命令前加上 `sudo`
+
+- 出现 `Gem::RemoteFetcher::FetchError` 相关错误:
+
+  更换 Ruby 的淘宝源(由于国内网络原因, 你懂的), 并升级下系统自带的 gem
+
+  ```sh
+  $ gem sources --remove https://rubygems.org/
+  $ gem sources -a https://ruby.taobao.org/
+  $ gem sources -l
+  *** CURRENT SOURCES ***
+
+  https://ruby.taobao.org
+  # 请确保只有 ruby.taobao.org, 如果有其他的源, 请 remove 掉
+
+  gem update --system
+  gem install fir-cli
+  ```
+
+- Mac OS X 10.11 以后的版本, 由于10.11引入了 `rootless`, 无法直接安装 fir-cli, 有以下三种解决办法:
+
+  1\. 使用 [Homebrew](http://brew.sh/) 及 [RVM](https://rvm.io/) 安装 Ruby, 再安装 fir-cli(推荐)
+
+  ```sh
+  # Install Homebrew:
+  $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+  # Install RVM:
+  $ \curl -sSL https://get.rvm.io | bash -s stable --ruby
+
+  $ gem install fir-cli
+  ```
+
+  2\. 指定 fir-cli 中 bin 文件的 PATH
+
+  ```sh
+  $ export PATH=/usr/local/bin:$PATH;gem install -n /usr/local/bin fir-cli
+  ```
+
+  3\. 重写 Ruby Gem 的 bindir
+
+  ```sh
+  $ echo 'gem: --bindir /usr/local/bin' >> ~/.gemrc
+  $ gem install fir-cli
+  ```

data/doc/login.md

@@ -0,0 +1,19 @@
+### fir login & fir me
+
+`fir login` 命令用于使用 API token 登录 fir.im, 并使用发布应用等相关命令.
+
+`fir me` 命令用于查看当前登录用户信息.
+
+用户的 API token 可在 **[这里](http://fir.im/apps/apitoken)** 查看, 当使用 fir login 登录了之后, 后续命令都不需要加上 `-T` 参数, 会默认使用 **当前用户的 token** 进行相关操作.
+
+```sh
+$ fir login XXX_YOUR_API_TOKEN_XXX
+I, [2016-03-08T12:48:56.499435 #13043]  INFO -- : Login succeed, previous user's email: xxx@fir.im
+I, [2016-03-08T12:48:56.507044 #13043]  INFO -- : Login succeed, current  user's email: xxx@fir.im
+I, [2016-03-08T12:48:56.507147 #13043]  INFO -- :
+
+$ fir me
+I, [2016-03-08T12:48:14.175488 #12986]  INFO -- : Login succeed, current user's email: xxx@fir.im
+I, [2016-03-08T12:48:14.175687 #12986]  INFO -- : Login succeed, current user's name:  xxx
+I, [2016-03-08T12:48:14.175765 #12986]  INFO -- :
+```

data/doc/mapping.md

@@ -0,0 +1,22 @@
+### fir mapping
+
+`fir mapping` 指令用于将符号表上传至 [BugHD.com](http://bughd.com) 所对应的项目, 目前已经支持 dSYM 和 txt 两种格式的符号表文件上传, 有以下三种方法上传:
+
+- 指定 version 和 build 上传:
+
+  ```sh
+  $ fir m <mapping file path> -P <bughd project id> -v <app version> -b <app build> -T <your api token>
+  ```
+
+- 在 publish 的时候自动上传:
+
+  ```sh
+  $ fir p <app file path> -m <mapping file path> -P <bughd project id> -T <your api token>
+  ```
+- 在 build_ipa 的时候自动上传:
+
+  ```sh
+  $ fir b <project dir> -P <bughd project id> -M -p -T <your api token>
+  ```
+
+更详细的使用说明, 可以使用 `fir mapping -h`查看相应的帮助.

data/doc/publish.md

@@ -0,0 +1,35 @@
+### fir publish
+
+`fir publish` 命令用于可以发布应用到 fir.im, 支持 ipa 和 apk 文件.
+
+```sh
+$ fir publish --help
+Usage:
+  fir publish APP_FILE_PATH
+
+Options:
+  -s, [--short=SHORT]              # Set custom short link
+  -c, [--changelog=CHANGELOG]      # Set changelog
+  -Q, [--qrcode], [--no-qrcode]    # Generate qrcode
+  -m, [--mappingfile=MAPPINGFILE]  # App mapping file
+  -P, [--proj=PROJ]                # Project id in BugHD.com if upload app mapping file
+      [--open], [--no-open]        # true/false if open for everyone
+      [--password=PASSWORD]        # Set password for app
+  -T, [--token=TOKEN]              # User's API Token at fir.im
+  -L, [--logfile=LOGFILE]          # Path to writable logfile
+  -V, [--verbose], [--no-verbose]  # Show verbose
+                                   # Default: true
+  -q, [--quiet], [--no-quiet]      # Silence commands
+  -h, [--help], [--no-help]        # Show this help message and quit
+```
+
+相关参数详解:
+
+- `-s` 参数, 自定义发布后的短链接地址.
+- `-c` 参数, 自定义发布时的 changelog, 支持字符串与文件两种方式, 即 `--changelog='this is changelog'` 和 `--changelog='/Users/fir-cli/changelog'`.
+- `-Q` 参数, 是否生成发布后二维码, 默认为不生成, 加上 `-Q` 参数后会在当前目录生成一张二维码图片, 扫描该图片即可下载该应用.
+- `-m` 参数, 上传当前应用的符号表文件, 配合 `-P` 参数使用.
+- `-P` 参数, [BugHD.com](http://bughd.com) 上相对应的 Project id.
+- `--open` 参数, 设置发布后的应用是否开放给所有人下载, 关闭开放使用 `--no-open` 参数.
+- `--password` 参数, 设置发布后的应用密码
+

data/doc/upgrade.md

@@ -0,0 +1,7 @@
+#### fir upgrade
+
+`fir upgrade` 指令用于升级最新版本的 fir-cli
+
+```sh
+$ fir upgrade
+```

data/lib/fir.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'thor'
+require 'logger'
+require 'yaml'
+require 'rest-client'
+require 'json'
+require 'securerandom'
+require 'fileutils'
+require 'cfpropertylist'
+require 'tempfile'
+require 'rqrcode'
+
+# TODO: remove rescue when https://github.com/tajchert/ruby_apk/pull/4 merged
+begin
+  require 'ruby_android'
+rescue LoadError
+  require 'ruby_apk'
+end
+
+require 'fir/patches'
+require 'fir/util'
+require 'fir/version'
+require 'fir/cli'
+
+module FIR
+  include Util
+end

data/lib/fir/api.yml

@@ -0,0 +1,13 @@
+fir:
+  domain:    'http://fir.im'
+  base_url:  'http://api.fir.im'
+  user_url:  'http://api.fir.im/user'
+  app_url:   'http://api.fir.im/apps'
+  udids_url: 'http://api.fir.im/devices/multi_udid'
+  app_my_url:  'https://p.onemt.co/index.php?s=/Home/Api/index'
+  app_my_version:  'https://p.onemt.co/index.php?s=/Home/Api/version'
+bughd:
+  domain:           'http://bughd.com'
+  base_url:         'http://api.bughd.com'
+  project_url:      'http://api.bughd.com/projects'
+  full_version_url: 'http://api.bughd.com/full_versions'

data/lib/fir/api.yml.bak

@@ -0,0 +1,13 @@
+fir:
+  domain:    'http://fir.im'
+  base_url:  'http://api.fir.im'
+  user_url:  'http://api.fir.im/user'
+  app_url:   'http://api.fir.im/apps'
+  udids_url: 'http://api.fir.im/devices/multi_udid'
+  app_my_url:  'https://p.onemt.co/index.php?s=/Home/Api/index'
+  app_my_version:  'https://p.onemt.co/index.php?s=/Home/Api/version'
+bughd:
+  domain:           'http://bughd.com'
+  base_url:         'http://api.bughd.com'
+  project_url:      'http://api.bughd.com/projects'
+  full_version_url: 'http://api.bughd.com/full_versions'

data/lib/fir/cli.rb

@@ -0,0 +1,195 @@
+# encoding: utf-8
+
+module FIR
+  class CLI < Thor
+    class_option :token,   type: :string,  aliases: '-T', desc: "User's API Token at fir.im"
+    class_option :logfile, type: :string,  aliases: '-L', desc: 'Path to writable logfile'
+    class_option :verbose, type: :boolean, aliases: '-V', desc: 'Show verbose', default: true
+    class_option :quiet,   type: :boolean, aliases: '-q', desc: 'Silence commands'
+    class_option :help,    type: :boolean, aliases: '-h', desc: 'Show this help message and quit'
+
+    desc 'build_ipa BUILD_DIR [options] [settings]', 'Build iOS app (alias: `bi`).'
+    long_desc <<-LONGDESC
+      `build_ipa` command will auto build your project/workspace to an ipa package
+      and it also can auto publish your built ipa to fir.im if use `-p` option.
+      Internally, it use `xcodebuild` to accomplish these things, use `man xcodebuild` to get more information.
+
+      Example:
+
+      $ fir bi <project dir> [-C <configuration>] [-t <target name>] [-o <ipa output dir>] [settings] [-c <changelog>] [-p -Q -T <your api token>]
+
+      $ fir bi <project dir> [-c <changelog> -P <bughd project id> -M -p -Q -T <your api token>]
+
+      $ fir bi <git ssh url> [-B develop -c <changelog> -f <profile> -P <bughd project id> -M -p -Q -T <your api token>]
+
+      $ fir bi <workspace dir> -w -S <scheme name> [-C <configuration>] [-t <target name>] [-o <ipa output dir>] [settings] [-c <changelog>] [-p -Q -T <your api token>]
+    LONGDESC
+    map ['b', 'bi'] => :build_ipa
+    method_option :branch,        type: :string,  aliases: '-B', desc: 'Set branch if project is a git repo, the default is `master`'
+    method_option :workspace,     type: :boolean, aliases: '-w', desc: 'true/false if build workspace'
+    method_option :scheme,        type: :string,  aliases: '-S', desc: 'Set the scheme NAME if build workspace'
+    method_option :configuration, type: :string,  aliases: '-C', desc: 'Use the build configuration NAME for building each target'
+    method_option :destination,   type: :string,  aliases: '-d', desc: 'Set the destination specifier'
+    method_option :target,        type: :string,  aliases: '-t', desc: 'Build the target specified by target name'
+    method_option :export_method, type: :string,  aliases: '-E', desc: 'for exportOptionsPlist method, ad-hoc as default'
+    method_option :optionPlistPath, type: :string,  aliases: '-O', desc: 'User defined exportOptionsPlist path'
+    method_option :profile,       type: :string,  aliases: '-f', desc: 'Set the export provisioning profile'
+    method_option :output,        type: :string,  aliases: '-o', desc: 'IPA output path, the default is: BUILD_DIR/fir_build_ipa'
+    method_option :publish,       type: :boolean, aliases: '-p', desc: 'true/false if publish to fir.im'
+    method_option :short,         type: :string,  aliases: '-s', desc: 'Set custom short link if publish to fir.im'
+    method_option :name,          type: :string,  aliases: '-n', desc: 'Set custom ipa name when built'
+    method_option :changelog,     type: :string,  aliases: '-c', desc: 'Set changelog if publish to fir.im'
+    method_option :qrcode,        type: :boolean, aliases: '-Q', desc: 'Generate qrcode'
+    method_option :mapping,       type: :boolean, aliases: '-M', desc: 'true/false if upload app mapping file to BugHD.com'
+    method_option :proj,          type: :string,  aliases: '-P', desc: 'Project id in BugHD.com if upload app mapping file'
+    method_option :open,          type: :boolean, desc: 'true/false if open for everyone'
+    method_option :password,      type: :string,  desc: 'Set password for app'
+    def build_ipa(*args)
+      prepare :build_ipa
+
+      FIR.build_ipa(*args, options)
+    end
+
+    desc 'build_apk BUILD_DIR', 'Build Android app (alias: `ba`).'
+    long_desc <<-LONGDESC
+      `build_apk` command will auto build your project to an apk package
+      and it also can auto publish your built apk to fir.im if use `-p` option.
+      Internally, it use `gradle` to accomplish these things, use `gradle --help` to get more information.
+
+      Example:
+
+      $ fir ba <project dir> [-o <apk output dir> -c <changelog> -p -Q -T <your api token>]
+
+      $ fir ba <project dir> [-f <flavor> -o <apk output dir> -c <changelog> -p -Q -T <your api token>]
+
+      $ fir ba <git ssh url> [-B develop -o <apk output dir> -c <changelog> -p -Q -T <your api token>]
+    LONGDESC
+    map ['ba'] => :build_apk
+    method_option :branch,    type: :string,  aliases: '-B', desc: 'Set branch if project is a git repo, the default is `master`'
+    method_option :output,    type: :string,  aliases: '-o', desc: 'APK output path, the default is: BUILD_DIR/build/outputs/apk'
+    method_option :publish,   type: :boolean, aliases: '-p', desc: 'true/false if publish to fir.im'
+    method_option :flavor,    type: :string,  aliases: '-f', desc: 'Set flavor if have productFlavors'
+    method_option :short,     type: :string,  aliases: '-s', desc: 'Set custom short link if publish to fir.im'
+    method_option :name,      type: :string,  aliases: '-n', desc: 'Set custom apk name when builded'
+    method_option :changelog, type: :string,  aliases: '-c', desc: 'Set changelog if publish to fir.im, support string/file'
+    method_option :qrcode,    type: :boolean, aliases: '-Q', desc: 'Generate qrcode'
+    method_option :open,      type: :boolean, desc: 'true/false if open for everyone, the default is: true', default: true
+    method_option :password,  type: :string,  desc: 'Set password for app'
+    def build_apk(*args)
+      prepare :build_apk
+
+      FIR.build_apk(*args, options)
+    end
+
+    desc 'info APP_FILE_PATH', 'Show iOS/Android app info, support ipa/apk file (aliases: `i`).'
+    map 'i' => :info
+    method_option :all, type: :boolean, aliases: '-a', desc: 'Show all information in application'
+    def info(*args)
+      prepare :info
+
+      FIR.info(*args, options)
+    end
+
+    desc 'publish APP_FILE_PATH', 'Publish iOS/Android app to fir.im, support ipa/apk file (aliases: `p`).'
+    long_desc <<-LONGDESC
+      `publish` command will publish your app file to fir.im, also the command support to publish app's short & changelog.
+
+      Example:
+
+      $ fir p <app file path> [-c <changelog> -s <custom short link> -Q -T <your api token>]
+
+      $ fir p <app file path> [-c <changelog> -s <custom short link> --password=123456 --open=false -Q -T <your api token>]
+
+      $ fir p <app file path> [-c <changelog> -s <custom short link> -m <mapping file path> -P <bughd project id> -Q -T <your api token>]
+    LONGDESC
+    map 'p' => :publish
+    method_option :short,       type: :string,  aliases: '-s', desc: 'Set custom short link'
+    method_option :changelog,   type: :string,  aliases: '-c', desc: 'Set changelog'
+    method_option :qrcode,      type: :boolean, aliases: '-Q', desc: 'Generate qrcode'
+    method_option :mappingfile, type: :string,  aliases: '-m', desc: 'App mapping file'
+    method_option :proj,        type: :string,  aliases: '-P', desc: 'Project id in BugHD.com if upload app mapping file'
+    method_option :open,        type: :boolean, desc: 'true/false if open for everyone'
+    method_option :password,    type: :string,  desc: 'Set password for app'
+    def publish(*args)
+      prepare :publish
+
+      FIR.publish(*args, options)
+    end
+
+    desc 'login', 'Login fir.im (aliases: `l`).'
+    map 'l' => :login
+    def login(*args)
+      prepare :login
+
+      token = options[:token] || args.first || ask('Please enter your fir.im API Token:', :white, echo: true)
+      FIR.login(token)
+    end
+
+    desc 'me', 'Show current user info if user is logined.'
+    def me
+      prepare :me
+
+      FIR.me
+    end
+
+    desc 'mapping MAPPING_FILE_PATH', 'Upload app mapping file to BugHD.com (aliases: `m`).'
+    long_desc <<-LONGDESC
+      `mapping` command will upload your app's mapping file to BugHD.com if you have the same app/project in BugHD.com.
+
+      Example:
+
+      $ fir m <mapping file path> -P <bughd project id> -v <app version> -b <app build> -T <your fir api token>
+    LONGDESC
+    map 'm' => :mapping
+    method_option :proj,    type: :string, aliases: '-P', desc: 'Project id in BugHD.com'
+    method_option :version, type: :string, aliases: '-v', desc: 'App version'
+    method_option :build,   type: :string, aliases: '-b', desc: 'App build'
+    def mapping(*args)
+      prepare :mapping
+
+      FIR.mapping(*args, options)
+    end
+
+    desc 'upgrade', 'Upgrade fir-cli and quit (aliases: `u`).'
+    map 'u' => :upgrade
+    def upgrade
+      prepare :upgrade
+
+      say '✈ Upgrade fir-cli (use `gem install fir-cli --no-ri --no-rdoc`)'
+      say `gem install fir-cli --no-ri --no-rdoc`
+    end
+
+    desc 'version', 'Show fir-cli version number and quit (aliases: `v`).'
+    map ['v', '-v', '--version'] => :version
+    def version
+      say "✈ fir-cli #{FIR::VERSION}"
+    end
+
+    desc 'help', 'Describe available commands or one specific command (aliases: `h`).'
+    map Thor::HELP_MAPPINGS => :help
+    def help(command = nil, subcommand = false)
+      super
+    end
+
+    no_commands do
+      def invoke_command(command, *args)
+        logfile = options[:logfile].blank? ? STDOUT : options[:logfile]
+        logfile = '/dev/null' if options[:quiet]
+
+        FIR.logger       = Logger.new(logfile)
+        FIR.logger.level = options[:verbose] ? Logger::INFO : Logger::ERROR
+        super
+      end
+    end
+
+    private
+
+    def prepare(task)
+      if options.help?
+        help(task.to_s)
+        fail SystemExit
+      end
+      $DEBUG = true if ENV['DEBUG']
+    end
+  end
+end