circleci-cli 1.0.0 → 3.0.0

data/README.md

@@ -1,5 +1,5 @@
 # circleci-cli
-
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
 [![Gem Version](https://badge.fury.io/rb/circleci-cli.svg)](https://badge.fury.io/rb/circleci-cli)
 [![Circle CI](https://circleci.com/gh/unhappychoice/circleci-cli.svg?style=shield)](https://circleci.com/gh/unhappychoice/circleci-cli)
 [![Code Climate](https://codeclimate.com/github/unhappychoice/circleci-cli/badges/gpa.svg)](https://codeclimate.com/github/unhappychoice/circleci-cli)
@@ -12,8 +12,6 @@ circleci-cli is a CLI tool for [Circle CI](https://circleci.com).
 
 ![sample.gif](https://github.com/unhappychoice/circler/raw/master/movie/rec.gif)
 
-Notice: This gem is renamed from `circler` to `circleci-cli` on 2019/09/22
-
 ## Installation
 
 ```sh
@@ -29,19 +27,59 @@ export CIRCLE_CI_TOKEN=your-circle-ci-token
 ## Usage
 ```
 Commands:
-  circleci-cli browse          # open circle ci website
-  circleci-cli build           # show build description
-  circleci-cli builds          # list builds
-  circleci-cli help [COMMAND]  # describe available commands or one specific command
-  circleci-cli projects        # list projects
-  circleci-cli retry           # retry a build
-  circleci-cli version         # show gem version
-  circleci-cli watch           # watch a build in real time
+  circleci-cli browse               # Open CircleCI website
+  circleci-cli build                # Show the build result
+  circleci-cli builds               # List builds
+  circleci-cli cancel               # Cancel a build
+  circleci-cli help [COMMAND]       # Describe available commands or one specific command
+  circleci-cli projects             # List projects
+  circleci-cli retry                # Retry a build
+  circleci-cli version              # Show gem version
+  circleci-cli watch                # Watch builds in real time
 
 Options:
-  -p user_name/project   # specify repository
-  -b branch              # specify branch name
-  -n build_number        # specify build number
+  -p user_name/project              # Specify repository
+                                    # Default to the Git remote of current directory
+
+  -b branch                         # Specify branch name
+                                    # Default to the current Git branch
+
+  -a, --all, --no-all               # Ignore the branch option and stop being filtered by the branch
+                                    # Default to false
+
+  -n build_number                   # Specify build number.
+  -l last                           # Get or retry last failed build.
+  -v verbose                        # Show all the logs if applied to watch command.
+
+  --pretty=true/false, --no-pretty  # Make outputs pretty or not
+                                    # Default to true
+```
+
+### Examples
+
+#### Watch your project
+```
+$ circleci-cli watch
+```
+
+#### Watch your project and show all of the build log
+```
+$ circleci-cli watch -v
+```
+
+#### Show last failed build
+```
+$ circleci-cli build --last
+```
+
+#### Retry last failed build
+```
+$ circleci-cli retry --last
+```
+
+#### Open CircleCI webpage for current project
+```
+$ circleci-cli browse
 ```
 
 ## Contributing
@@ -51,3 +89,25 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/unhapp
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="http://blog.unhappychoice.com"><img src="https://avatars3.githubusercontent.com/u/5608948?v=4" width="100px;" alt=""/><br /><sub><b>Yuji Ueki</b></sub></a><br /><a href="https://github.com/unhappychoice/circleci-cli/commits?author=unhappychoice" title="Code">💻</a></td>
+    <td align="center"><a href="https://mattbrictson.com/"><img src="https://avatars0.githubusercontent.com/u/189693?v=4" width="100px;" alt=""/><br /><sub><b>Matt Brictson</b></sub></a><br /><a href="https://github.com/unhappychoice/circleci-cli/commits?author=mattbrictson" title="Code">💻</a> <a href="https://github.com/unhappychoice/circleci-cli/commits?author=mattbrictson" title="Tests">⚠️</a></td>
+    <td align="center"><a href="http://fzf.me"><img src="https://avatars0.githubusercontent.com/u/1462357?v=4" width="100px;" alt=""/><br /><sub><b>Fletcher Fowler</b></sub></a><br /><a href="https://github.com/unhappychoice/circleci-cli/issues?q=author%3Afzf" title="Bug reports">🐛</a> <a href="#ideas-fzf" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/unhappychoice/circleci-cli/commits?author=fzf" title="Code">💻</a></td>
+    <td align="center"><a href="https://datadoghq.com"><img src="https://avatars3.githubusercontent.com/u/583503?v=4" width="100px;" alt=""/><br /><sub><b>Marco Costa</b></sub></a><br /><a href="#ideas-marcotc" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/unhappychoice/circleci-cli/commits?author=marcotc" title="Code">💻</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/Rakefile

@@ -2,7 +2,15 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'github_changelog_generator/task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'unhappychoice'
+  config.project = 'circleci-cli'
+  config.since_tag = '0.1.0'
+  # config.future_release = '2.2.0'
+end

data/circleci-cli.gemspec

@@ -6,20 +6,20 @@ require 'circleci/cli/version'
 
 def production_dependency(spec)
   spec.add_dependency 'circleci', '~> 2.0.2'
-  spec.add_dependency 'colorize', '~> 0.8.1'
-  spec.add_dependency 'faraday', '>= 0.14', '< 0.16'
+  spec.add_dependency 'faraday', '>= 0.14', '< 1.1'
   spec.add_dependency 'highline', '>= 1.7.8', '< 2.1.0'
-  spec.add_dependency 'launchy', '~> 2.4.3'
+  spec.add_dependency 'launchy', '>= 2.4.3', '< 2.6.0'
   spec.add_dependency 'pusher-client', '~> 0.6.2'
-  spec.add_dependency 'rugged', '>= 0.26', '< 0.29'
+  spec.add_dependency 'rugged', '>= 0.26', '< 1.1'
   spec.add_dependency 'terminal-notifier', '~> 2.0.0'
   spec.add_dependency 'terminal-table', '~> 1.8.0'
-  spec.add_dependency 'thor', '~> 0.20.0'
+  spec.add_dependency 'thor', '>= 0.20', '< 1.1'
 end
 
 def development_dependency(spec)
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'guard-rubocop'
@@ -38,6 +38,7 @@ end
 Gem::Specification.new do |spec|
   spec.name          = 'circleci-cli'
   spec.version       = CircleCI::CLI::VERSION
+  spec.required_ruby_version = '>= 2.5'
   spec.authors       = ['unhappychoice']
   spec.email         = ['unhappychoice@gmail.com']
 

data/lib/circleci/cli.rb

@@ -5,7 +5,6 @@ require 'faraday'
 require 'launchy'
 require 'terminal-table'
 require 'highline/import'
-require 'colorize'
 require 'rugged'
 require 'circleci'
 require 'terminal-notifier'
@@ -18,57 +17,149 @@ require 'circleci/cli/networking'
 
 module CircleCI
   module CLI
-    class Runner < Thor
-      desc 'projects', 'list projects'
-      method_option :format, aliases: 'f', type: :string, banner: 'pretty/simple'
+    class Runner < Thor # rubocop:disable Metrics/ClassLength
+      package_name 'circleci-cli'
+
+      class << self
+        def project
+          repository = Rugged::Repository.new('.')
+          origin = repository.remotes.find { |r| r.name == 'origin' }
+          regexp = %r{(?:git@|https://)github.com(?::|/)([\w_-]+/[.\w_-]+?)(?:\.git)*$}
+          return Regexp.last_match(1) if origin.url =~ regexp
+
+          nil
+        end
+
+        def branch_name
+          repository = Rugged::Repository.new('.')
+          head = repository.head
+
+          return nil unless head.branch?
+
+          head.name.sub(%r{\Arefs/heads/}, '')
+        end
+      end
+
+      desc 'projects', 'List projects'
+      method_option :pretty, type: :boolean, default: true, desc: 'Make output pretty'
       def projects
         Command::ProjectsCommand.run(options)
       end
 
-      desc 'builds', 'list builds'
-      method_option :project, aliases: 'p', type: :string, banner: 'user/project'
-      method_option :branch, aliases: 'b', type: :string, banner: 'some-branch'
-      method_option :format, aliases: 'f', type: :string, banner: 'pretty/simple'
+      desc 'builds', 'List builds'
+      method_option :project,
+                    aliases: 'p',
+                    type: :string,
+                    banner: 'user/project',
+                    default: project,
+                    desc: 'A project you want to get.'
+      method_option :branch,
+                    aliases: 'b',
+                    type: :string,
+                    banner: 'some-branch',
+                    default: branch_name,
+                    desc: 'A branch name you want to filter with.'
+      method_option :all,
+                    aliases: 'a',
+                    type: :boolean,
+                    default: false,
+                    desc: 'Target all the branches. This option overwrites branch option.'
+      method_option :pretty, type: :boolean, banner: 'true/false', default: true, desc: 'Make output pretty.'
       def builds
         Command::BuildsCommand.run(options)
       end
 
-      desc 'build', 'show build description'
-      method_option :project, aliases: 'p', type: :string, banner: 'user/project'
-      method_option :build, aliases: 'n', type: :numeric, banner: 'build-number'
+      desc 'build', 'Show the build result'
+      method_option :project,
+                    aliases: 'p',
+                    type: :string,
+                    banner: 'user/project',
+                    default: project,
+                    desc: 'A project you want to get.'
+      method_option :build, aliases: 'n', type: :numeric, banner: 'build-number', desc: 'Build number you want to get.'
+      method_option :last, aliases: 'l', type: :boolean, default: false, desc: 'Get last failed build.'
+      method_option :pretty, type: :boolean, banner: 'true/false', default: true, desc: 'Make output pretty.'
       def build
         Command::BuildCommand.run(options)
       end
 
-      desc 'browse', 'open circle ci website'
-      method_option :project, aliases: 'p', type: :string, banner: 'user/project'
-      method_option :build, aliases: 'n', type: :numeric, banner: 'build-number'
+      desc 'browse', 'Open CircleCI website'
+      method_option :project,
+                    aliases: 'p',
+                    type: :string,
+                    banner: 'user/project',
+                    default: project,
+                    desc: 'A project you want to get.'
+      method_option :build,
+                    aliases: 'n',
+                    type: :numeric,
+                    banner: 'build-number',
+                    desc: 'Build number you want to browse.'
       def browse
         Command::BrowseCommand.run(options)
       end
 
-      desc 'retry', 'retry a build'
-      method_option :project, aliases: 'p', type: :string, banner: 'user/project'
-      method_option :build, aliases: 'n', type: :numeric, banner: 'build-number'
+      desc 'retry', 'Retry a build'
+      method_option :project,
+                    aliases: 'p',
+                    type: :string,
+                    banner: 'user/project',
+                    default: project,
+                    desc: 'A project you want to get.'
+      method_option :build,
+                    aliases: 'n',
+                    type: :numeric,
+                    banner: 'build-number',
+                    desc: 'Build number you want to retry.'
+      method_option :last, aliases: 'l', type: :boolean, desc: 'Retry last failed build.'
       def retry
         Command::RetryCommand.run(options)
       end
 
-      desc 'cancel', 'cancel a build'
-      method_option :project, aliases: 'p', type: :string, banner: 'user/project'
-      method_option :build, aliases: 'n', type: :numeric, banner: 'build-number'
+      desc 'cancel', 'Cancel a build'
+      method_option :project,
+                    aliases: 'p',
+                    type: :string,
+                    default: project,
+                    desc: 'A project you want to get.'
+      method_option :build,
+                    aliases: 'n',
+                    type: :numeric,
+                    banner: 'build-number',
+                    desc: 'Build number you want to cancel.'
       def cancel
         Command::CancelCommand.run(options)
       end
 
-      desc 'watch', 'watch a build in real time'
-      method_option :project, aliases: 'p', type: :string, banner: 'user/project'
-      method_option :build, aliases: 'n', type: :numeric, banner: 'build-number'
+      desc 'watch', 'Watch builds in real time'
+      method_option :project,
+                    aliases: 'p',
+                    type: :string,
+                    banner: 'user/project',
+                    default: project,
+                    desc: 'A project you want to get.'
+      method_option :branch,
+                    aliases: 'b',
+                    type: :string,
+                    banner: 'some-branch',
+                    default: branch_name,
+                    desc: 'A branch name you want to filter with.'
+      method_option :all,
+                    aliases: 'a',
+                    type: :boolean,
+                    default: false,
+                    desc: 'Target all the branches. This option overwrites branch option.'
+      method_option :user, aliases: 'u', type: :string, banner: 'user'
+      method_option :verbose,
+                    aliases: 'v',
+                    type: :boolean,
+                    default: false,
+                    desc: 'Show all the build logs including successful build steps.'
       def watch
         Command::WatchCommand.run(options)
       end
 
-      desc 'version', 'show gem version'
+      desc 'version', 'Show gem version'
       def version
         say CircleCI::CLI::VERSION
       end

data/lib/circleci/cli/command/base_command.rb

@@ -14,30 +14,23 @@ module CircleCI
           def project_name(options)
             if options.project
               options.project
-            elsif reponame
-              reponame
             else
               say Printer::ProjectPrinter.new(Response::Project.all).to_s
               ask('Input user-name/project-name :')
             end
           end
 
-          def reponame
-            repository = Rugged::Repository.new('.')
-            origin = repository.remotes.find { |r| r.name == 'origin' }
-            regexp = %r{git@github.com(?::|/)([\w_-]+/[\w_-]+)(?:\.git)*}
-            return Regexp.last_match(1) if origin.url =~ regexp
-
-            nil
+          def branch_name(options)
+            if options.all
+              nil
+            else
+              options.branch
+            end
           end
 
           def build_number(options)
             options.build || ask('Input build number')
           end
-
-          def should_be_pretty(options)
-            options['format'] != 'simple'
-          end
         end
       end
     end

data/lib/circleci/cli/command/build_command.rb

@@ -8,9 +8,25 @@ module CircleCI
           def run(options)
             setup_token
             username, reponame = project_name(options).split('/')
+            build =
+              if options.last
+                get_last_build(username, reponame)
+              else
+                get_build(username, reponame, options)
+              end
+            say Printer::StepPrinter.new(build.steps, pretty: options.pretty).to_s
+          end
+
+          private
+
+          def get_build(username, reponame, options)
             number = build_number(options)
-            build = Response::Build.get(username, reponame, number)
-            say Printer::StepPrinter.new(build.steps).to_s
+            Response::Build.get(username, reponame, number)
+          end
+
+          def get_last_build(username, reponame)
+            builds = Response::Build.failed(username, reponame)
+            Response::Build.get(username, reponame, builds.map(&:build_number).max)
           end
         end
       end

data/lib/circleci/cli/command/builds_command.rb

@@ -7,16 +7,16 @@ module CircleCI
         class << self
           def run(options)
             setup_token
-            username, reponame = project_name(options).split('/')
+            project_name = project_name(options)
+            username, reponame = project_name.split('/')
+            branch = branch_name(options)
+            builds = if branch
+                       Response::Build.branch(username, reponame, branch)
+                     else
+                       Response::Build.all(username, reponame)
+                     end
 
-            builds =
-              if options.branch
-                Response::Build.branch(username, reponame, options.branch)
-              else
-                Response::Build.all(username, reponame)
-              end
-
-            say Printer::BuildPrinter.new(builds, pretty: should_be_pretty(options)).to_s
+            say Printer::BuildPrinter.new(builds, project_name, pretty: options.pretty).to_s
           end
         end
       end

data/lib/circleci/cli/command/projects_command.rb

@@ -7,7 +7,7 @@ module CircleCI
         class << self
           def run(options)
             setup_token
-            say Printer::ProjectPrinter.new(Response::Project.all, pretty: should_be_pretty(options)).to_s
+            say Printer::ProjectPrinter.new(Response::Project.all, pretty: options.pretty).to_s
           end
         end
       end

data/lib/circleci/cli/command/retry_command.rb

@@ -8,14 +8,30 @@ module CircleCI
           def run(options)
             setup_token
             username, reponame = project_name(options).split('/')
-            number = build_number(options)
+            number = build_number_for(username, reponame, options)
+
             build = Response::Build.retry(username, reponame, number)
-            if build.username
+
+            if build&.username
               say "build #{username}/#{reponame} #{build.build_number} is triggered"
             else
               say "failed to trigger #{username}/#{reponame} #{number}"
             end
           end
+
+          private
+
+          def build_number_for(username, reponame, options)
+            if options.last
+              get_last_build_number(username, reponame)
+            else
+              build_number(options)
+            end
+          end
+
+          def get_last_build_number(username, reponame)
+            Response::Build.failed(username, reponame).map(&:build_number).max
+          end
         end
       end
     end