circle_status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5856b0a4973bcc0931a8427560e13110f1bf9b5b
+  data.tar.gz: 8787b5faa65f53aeca87a796329acdf56aa35ef7
+SHA512:
+  metadata.gz: 93890105a9be66b7cd38b3ff43c97144b1900bd8bd6b07180fe4468e75ca721a48d3c7672259c6f79fa43d5c98ad48e7bbbe8f1cc38e4449f393d1a8f45a1b57
+  data.tar.gz: 0d9cd00e6295b4c1a55c1d71c86788750eb17e051745c5b5425ab09c0b3ea954d6fec73c8abd111ce1f6f9681a8062771569dcb68ef560479c941eadf798def1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in circle_status.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,59 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+# Add files and commands to this file, like the example:
+#   watch(%r{file/path}) { `command(s)` }
+#
+guard :shell do
+  watch(/bin\/circle-status/) {|m| build_and_run }
+  watch(/\.rb$/) {|m| build_and_run }
+end
+
+def build_and_run
+  `rake install && circle-status`
+end

data/README.md

@@ -0,0 +1,51 @@
+# circle_status
+
+This gem is a CLI tool to fetch your Circle CI server's build status report for your current git repo/branch. It was built because Circle CI's user interface lacks a way to easily get a simple list of test failure files, for use when debugging a failing spec locally.
+
+The output looks like this:
+
+![](https://raw.githubusercontent.com/jakeonrails/circle_status/master/screenshot.png)
+
+## Installation
+
+```sh
+gem install circle_status
+```
+
+## Connecting to your Circle CI account
+
+The circle_status tool requires a Circle API token. It can be found or created here: https://circleci.com/account/api
+
+Put the token in your `.bashrc` or `.zshrc` file, like this:
+
+`export CIRCLE_CI_TOKEN="your token here"`
+
+## Usage
+
+Navigate to a git repository that is hooked up to Circle CI and type:
+
+`circle-status`
+
+You should see something like the following:
+
+![](https://raw.githubusercontent.com/jakeonrails/circle_status/master/screenshot.png)
+
+## How it works
+
+`circle-status` looks at the origin remote of your Git repo and parses out the Github Username and the Project/Repo name from the remote URL. It works with both the SSH URL and the HTTPS URL. Then it uses the API token stored in the environment variable CIRCLE_CI_TOKEN to connect to that project's Circle CI builds list, for the currently checked out branch in Git.
+
+## Todo:
+
+ - Improve the feedback when `circle-status` can't connect to the Circle API
+ - allow for CLI flags/options to control the git username, repo, and branch
+ - allow for more detailed information about specs, including the failure message and a few lines of stacktrace
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/circle_status.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/circle-status

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'circle_status'
+
+CircleStatus::Script.new.run

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "circle_status"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle_status.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'circle_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'circle_status'
+  spec.version       = CircleStatus::VERSION
+  spec.authors       = ['Jake Moffatt']
+  spec.email         = ['jakeonrails@gmail.com']
+  spec.license       = 'The MIT License (MIT)'
+
+  spec.summary       = %q{A CLI tool to report your Circle CI build status.}
+  spec.description   = %q{A CLI tool to report your Circle CI build status.}
+  spec.homepage      = %q{https://github.com/jakeonrails/circle_status}
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['circle-status']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-shell'
+  spec.add_development_dependency 'pry-byebug'
+
+  spec.add_dependency 'circleci'
+  spec.add_dependency 'git'
+  spec.add_dependency 'awesome_print'
+end

data/lib/circle_status.rb

@@ -0,0 +1,10 @@
+require 'circle_status/version'
+require 'circle_status/script'
+
+require 'circleci'
+require 'git'
+require 'awesome_print'
+
+module CircleStatus
+  class ProjectError < StandardError; end
+end

data/lib/circle_status/script.rb

@@ -0,0 +1,100 @@
+module CircleStatus
+  class Script
+    def run
+      config
+
+      puts "Status: #{latest_build_status.upcase.white}"
+      puts "Successes: #{successes.size.to_s.green}"
+      puts "Failures: #{failures.size.to_s.red}"
+      puts "Failing specs: #{failing_files.join(' ').red}"
+      puts "Details: #{latest_build_url}"
+      puts
+      puts "Pending builds: #{pending_builds.size}"
+      pending_builds.map do |pending|
+        puts " - #{pending['status']}: #{pending['build_url']}"
+      end
+    rescue ProjectError => e
+      puts "Circle Status failure: #{e.message}"
+    end
+
+    def config
+      token = ENV.fetch('CIRCLE_CI_TOKEN')
+      raise ProjectError, 'no CIRCLE_CI_TOKEN ENV var' if token.nil?
+      CircleCi.configure do |config|
+        config.token = token
+      end
+    end
+
+    def builds
+      @builds ||= begin
+        builds = CircleCi::Project.recent_builds_branch(user_name, repo_name, branch).body
+        fail ProjectError, 'no builds for this repository' if builds.empty?
+        builds
+      end
+    end
+
+    def latest_build
+      @latest_build ||= begin
+        build = builds.find { |build| %w(failed success).include?(build['status']) }
+        fail ProjectError, 'no builds for this branch yet' if build.nil?
+        build
+      end
+    end
+
+    def pending_builds
+      @builds.select { |build| build['outcome'].nil? }
+    end
+
+    def latest_build_status
+      latest_build['status']
+    end
+
+    def latest_build_url
+      latest_build['build_url']
+    end
+
+    def tests
+      @tests ||= CircleCi::Build.tests(user_name, repo_name, latest_build['build_num']).body
+    end
+
+    def successes
+      @sucesses ||= split_tests.first
+    end
+
+    def failures
+      @failures ||= split_tests.last
+    end
+
+    def split_tests
+      @split_tests ||= tests['tests'].partition { |test| test['result'] != 'failure' }
+    end
+
+    def failing_files
+      @failing_files ||= failures.map { |test| test['file'] }.uniq.sort
+    end
+
+    def user_name
+      remote_url[/github.com[\/:](?<user>.+)?\//, :user]
+    end
+
+    def repo_name
+      remote_url[/.+\/(?<repo>.+).git/, :repo]
+    end
+
+    def remote_url
+      origin_remote.url
+    end
+
+    def origin_remote
+      @origin_remote ||= git.remotes.find { |r| r.name == 'origin' }
+    end
+
+    def branch
+      git.current_branch
+    end
+
+    def git
+      @git ||= Git.open(Dir.pwd)
+    end
+  end
+end

data/lib/circle_status/version.rb

@@ -0,0 +1,3 @@
+module CircleStatus
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: circle_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jake Moffatt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: guard
+  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: guard-rspec
+  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: guard-shell
+  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-byebug
+  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: circleci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A CLI tool to report your Circle CI build status.
+email:
+- jakeonrails@gmail.com
+executables:
+- circle-status
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/circle-status
+- bin/console
+- bin/setup
+- circle_status.gemspec
+- lib/circle_status.rb
+- lib/circle_status/script.rb
+- lib/circle_status/version.rb
+- screenshot.png
+homepage: https://github.com/jakeonrails/circle_status
+licenses:
+- The MIT License (MIT)
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A CLI tool to report your Circle CI build status.
+test_files: []