octocheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf3fdff5823507d50863f9222ac43ed5bde3a73c
+  data.tar.gz: bad327462b3bb0200876409fa706130c17e770ac
+SHA512:
+  metadata.gz: 754f6f7db2d24c504ed08af9a967f880035cc0b8dab0087944e50b501c3da3229bd785f9a6722319af6822f3498dd9ad3d51c34d158cbd73fc5dc83f584ef89d
+  data.tar.gz: dd39442972c9e03b1780d6bd67be456d4d4471a7469161acdf6dea330896c1a745430860a02c7cfe04100a67febca800dc79031040555eacb74fe2e21ec8328a

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in octocheck.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    octocheck (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  octocheck!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.4

data/README.md

@@ -0,0 +1,88 @@
+# Octocheck
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/octocheck`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'octocheck'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octocheck
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/octocheck.
+See github status checks in your terminal.
+(https://help.github.com/en/articles/about-status-checks)
+
+octocheck --branch myBranchName --project my_repo_name
+
+[Options]
+
+-b, --branch: defaults to current repo's branch
+-p, --project: defaults to repo directory name
+-o, --org: the Github org that owns the repo (see CONFIGURATION below)
+-r, --revision: defaults to latest revision on current branch
+-t, --token: your github API token (see CONFIGURATION below)
+
+[CONFIGURATION]:
+
+You can specify your github org and token in a configuration file so
+that you don't need to configure them each time.
+
+Put a json formatted file at ~/.config/octocheck/config.json with the
+following data:
+
+  {
+    "token": "< github token value >",
+    "org": "< github org name >"
+  }
+
+[ORG]:
+
+Unfortunately when accessing status checks for a repo, the repo's
+organization must be specified. :(  The organization can be found in
+the repo's url:
+
+https://github.com/ORGNAME/repo_name
+
+[TOKEN]:
+
+In order to read Github checks, you need to configure (or pass as an
+argument) a token with rights to "repo" permissions:
+
+1. Visit https://github.com/settings/tokens/new
+2. Generate a new token
+3. Grant the `repo` permission (leave all others unchecked)
+4. Paste the token in the configuration file as specified in CONFIGURATION.
+
+Unfortunately full `repo` access is needed in order to access Github
+status checks. Hopefully they change that soon.
+
+[OUTPUT]
+
+Checks are listed in the order they are received. There is some basic
+colorization applied based on the status names. When using Iterm2, the
+status names are links to the check target. Other terminals have the
+link appended to the output.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "octocheck"
+
+# 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(__FILE__)

data/bin/setup

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

data/exe/octocheck

@@ -0,0 +1,154 @@
+#! /usr/bin/env ruby
+
+lib_dir = File.expand_path(File.join(__dir__, '../lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require "optparse"
+require "json"
+require "octocheck/cli"
+
+HELP = <<~TXT
+  See github status checks in your terminal.
+  (https://help.github.com/en/articles/about-status-checks)
+
+  octocheck --branch myBranchName --project my_repo_name
+
+  [Options]
+
+  -b, --branch: defaults to current repo's branch
+  -p, --project: defaults to repo directory name
+  -o, --org: the Github org that owns the repo (see CONFIGURATION below)
+  -r, --revision: defaults to latest revision on current branch
+  -t, --token: your github API token (see CONFIGURATION below)
+
+  [CONFIGURATION]:
+
+  You can specify your github org and token in a configuration file so
+  that you don't need to configure them each time.
+
+  Put a json formatted file at ~/.config/octocheck/config.json with the
+  following data:
+
+    {
+      "token": "< github token value >",
+      "org": "< github org name >"
+    }
+
+  [ORG]:
+
+  Unfortunately when accessing status checks for a repo, the repo's
+  organization must be specified. :(  The organization can be found in
+  the repo's url:
+
+  https://github.com/ORGNAME/repo_name
+
+  [TOKEN]:
+
+  In order to read Github checks, you need to configure (or pass as an
+  argument) a token with rights to "repo" permissions:
+
+  1. Visit https://github.com/settings/tokens/new
+  2. Generate a new token
+  3. Grant the `repo` permission (leave all others unchecked)
+  4. Paste the token in the configuration file as specified in CONFIGURATION.
+
+  Unfortunately full `repo` access is needed in order to access Github
+  status checks. Hopefully they change that soon.
+
+  [OUTPUT]
+
+  Checks are listed in the order they are received. There is some basic
+  colorization applied based on the status names. When using Iterm2, the
+  status names are links to the check target. Other terminals have the
+  link appended to the output.
+TXT
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: octocheck [options]"
+
+  opts.on("-b BRANCH", "--branch BRANCH", "git branch (defaults to current repo branch)") do |b|
+    options[:branch] = b
+  end
+
+  opts.on("-p REPONAME", "--reponame REPONAME", "The reponame (defaults to repo directory)") do |p|
+    options[:reponame] = p
+  end
+
+  opts.on("-o ORG", "--org ORG", "The github organization name") do |o|
+    options[:org] = o
+  end
+
+  opts.on("-t TOKEN", "--token TOKEN", "The github access token") do |t|
+    options[:token] = t
+  end
+
+  opts.on("-r REVISION", "--revision REVISION", "The git revision to look for (defaults to revision of latest test run)") do |r|
+    options[:revision] = r
+
+    if !r.match(/\h{40}/)
+      warn("#{r} is not a full/valid git revision")
+      exit(1)
+    end
+  end
+
+  opts.on("-h", "--help", "See help") do
+    puts HELP
+    exit(0)
+  end
+
+end.parse!
+
+if ARGV.any?
+  puts HELP
+  exit(1)
+end
+
+if !options[:branch]
+  options[:branch] = `git rev-parse --abbrev-ref @`.chomp
+  if $? != 0
+    warn "Could not identify branch. Please specify one"
+    exit(1)
+  end
+end
+
+root_dir = nil
+
+if !options[:reponame]
+  root_dir ||=
+    File.basename(
+      `git rev-parse --show-toplevel`
+      .chomp
+      .tap { raise "detecting root dir failed" unless $?==0}
+    )
+
+  options[:reponame] = root_dir
+end
+
+config_file = File.expand_path("~/.config/octocheck/config.json")
+config = File.exist?(config_file) && JSON.parse(File.read(config_file))
+
+if !options[:org] && config
+  options[:org] = config["org"]
+end
+
+if !options[:org]
+  warn "Org not specified in command nor in config file. See --help for info."
+  exit(1)
+end
+
+if !options[:token] && config
+  options[:token] = config["token"]
+end
+
+if !options[:token]
+  warn "Token not specified in command nor in config file. See --help for info."
+  exit(1)
+end
+
+Octocheck::CLI.call(
+  token: options[:token],
+  branch: options[:branch],
+  repo: options[:reponame],
+  org: options[:org]
+)

data/lib/octocheck.rb

@@ -0,0 +1,5 @@
+require "octocheck/version"
+
+module Octocheck
+  # Your code goes here...
+end

data/lib/octocheck/api.rb

@@ -0,0 +1,81 @@
+require "uri"
+require "net/http"
+require "json"
+
+module Octocheck
+  class Api
+    attr_accessor :org, :branch, :repo, :token
+    def initialize(org:, branch:, repo:, token:)
+      @org = org
+      @branch = branch
+      @repo = repo
+      @token = token
+    end
+
+    def statuses
+      get("repos/#{org}/#{repo}/commits/#{branch}/statuses")
+        .map {|j|
+          {
+            name: j["context"],
+            state: j["state"].downcase,
+            url: j["target_url"]
+          }
+        }
+        .uniq {|j| j[:name]}
+    end
+
+    def check_runs
+      get("repos/#{org}/#{repo}/commits/#{branch}/check-runs")
+        .fetch("check_runs")
+        .map { |cr|
+          {
+            name: cr["name"],
+            state: cr["status"].downcase,
+            url: cr["details_url"],
+            details: check_run_details(cr["output"]["summary"])
+          }
+        }
+    end
+
+    private
+
+    def check_run_details(text)
+      text
+        .split("\n")
+        .map { |r|
+          structure = r.match(/\[(?<name>.+)\]\((?<url>.+\)) - (?<state>.*)$/)
+
+          if structure
+            {
+              name: structure[:name],
+              state: structure[:state].downcase,
+              url: structure[:url]
+            }
+          else
+            nil
+          end
+        }.compact
+    end
+
+    def get(path)
+      url = File.join("https://api.github.com", path)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      headers.each do |k, v|
+        request[k] = v
+      end
+      http.use_ssl = true
+      response = http.request(request)
+      raise "request failure:\n\n#{response.body}" unless response.code == "200"
+      JSON.parse(response.body)
+    end
+
+    def headers
+      {
+        "Authorization" => "Token #{token}",
+        "Accept" => "application/vnd.github.antiope-preview+json"
+      }
+    end
+  end
+end

data/lib/octocheck/cli.rb

@@ -0,0 +1,35 @@
+require "octocheck/api"
+require "octocheck/summary"
+require "octocheck/formatters/iterm2"
+require "octocheck/formatters/simple"
+
+module Octocheck
+  class CLI
+    def self.call(org:, branch:, repo:, token:)
+      api = Api.new(
+        org: org,
+        branch: branch,
+        repo: repo,
+        token: token
+      )
+
+      summary = Summary.new(
+        api: api
+      )
+
+      using_iterm2 = (
+        ENV["TERM_PROGRAM"] == "iTerm.app" &&
+        ENV.fetch("TERM_PROGRAM_VERSION", "").match(/3.[23456789].[123456789]/)
+      )
+
+      formatter =
+        if using_iterm2
+          Formatters::Iterm2
+        else
+          Formatters::Simple
+        end
+
+      formatter.new($stdout).format(summary)
+    end
+  end
+end

data/lib/octocheck/formatters/color.rb

@@ -0,0 +1,31 @@
+module Octocheck
+  module Formatters
+    module Color
+      CODES = {
+        red: 31,
+        green: 32,
+        yellow: 33,
+        blue: 34,
+        pink: 35,
+      }.freeze
+
+      CODES.each do |color, code|
+        define_method(color) do |string|
+          colorize_code(string, code)
+        end
+      end
+
+      def colorize(string, color_name)
+        return string unless CODES.key?(color_name)
+        colorize_code(string, CODES[color_name])
+      end
+
+      private
+
+      # colorization
+      def colorize_code(string, color_code)
+        "\e[#{color_code}m#{string}\e[0m"
+      end
+    end
+  end
+end

data/lib/octocheck/formatters/iterm2.rb

@@ -0,0 +1,58 @@
+require "octocheck/formatters/color"
+
+module Octocheck
+  module Formatters
+    class Iterm2
+      GREEN_REGEX = /success|pass|completed|done/
+      RED_REGEX = /fail|error/
+      BLUE_REGEX = /progress|running/
+
+      include Color
+      attr_reader :io
+      def initialize(io)
+        @io = io
+      end
+
+      def format(summary)
+        cols = []
+        summary.statuses.each do |status|
+          cols << [
+            linkify(status.fetch(:state), status.fetch(:url)),
+            status.fetch(:name)
+          ].join(" ")
+        end
+
+        summary.check_runs.each do |run|
+          cols << [
+            linkify(run.fetch(:state), run.fetch(:url)),
+            run.fetch(:name)
+          ].join(" ")
+
+          run.fetch(:details).each do |detail|
+            cols << [
+              linkify(detail.fetch(:state), detail.fetch(:url)),
+              detail.fetch(:name)
+            ].join(" ")
+          end
+        end
+
+        io.puts(cols.join("\n"))
+      end
+
+      def linkify(text, url)
+        colorized_text =
+          if text.match(GREEN_REGEX)
+            green(text)
+          elsif text.match(RED_REGEX)
+            red(text)
+          elsif text.match(BLUE_REGEX)
+            blue(text)
+          else
+            yellow(text)
+          end
+
+        "\e]8;;#{url}\a#{colorized_text}\e]8;;\a"
+      end
+    end
+  end
+end

data/lib/octocheck/formatters/simple.rb

@@ -0,0 +1,58 @@
+require "octocheck/formatters/color"
+
+module Octocheck
+  module Formatters
+    class Simple
+      GREEN_REGEX = /success|pass|completed|done/
+      RED_REGEX = /fail|error/
+      BLUE_REGEX = /progress|running/
+
+      include Color
+      attr_reader :io
+      def initialize(io)
+        @io = io
+      end
+
+      def format(summary)
+        cols = []
+        summary.statuses.each do |status|
+          cols << [
+            colorize(status.fetch(:state)),
+            status.fetch(:name),
+            status.fetch(:url)
+          ].join(" ")
+        end
+
+        summary.check_runs.each do |run|
+          cols << [
+            colorize(run.fetch(:state)),
+            run.fetch(:name),
+            run.fetch(:url)
+          ].join(" ")
+
+          run.fetch(:details).each do |detail|
+            cols << [
+              colorize(detail.fetch(:state)),
+              detail.fetch(:name),
+              detail.fetch(:url)
+            ].join(" ")
+          end
+        end
+
+        io.puts(cols.join("\n"))
+      end
+
+      def colorize(text)
+        if text.match(GREEN_REGEX)
+          green(text)
+        elsif text.match(RED_REGEX)
+          red(text)
+        elsif text.match(BLUE_REGEX)
+          blue(text)
+        else
+          yellow(text)
+        end
+      end
+    end
+  end
+end

data/lib/octocheck/summary.rb

@@ -0,0 +1,16 @@
+module Octocheck
+  class Summary
+    attr_accessor :api
+    def initialize(api:)
+      @api = api
+    end
+
+    def check_runs
+      @check_runs ||= api.check_runs
+    end
+
+    def statuses
+      @statuses ||= api.statuses
+    end
+  end
+end

data/lib/octocheck/version.rb

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

data/octocheck.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "octocheck/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "octocheck"
+  spec.version       = Octocheck::VERSION
+  spec.authors       = ["Pete Kinnecom"]
+  spec.email         = ["git@k7u7.com"]
+
+  spec.summary       = "See github checks in your terminal"
+  spec.homepage      = "https://github.com/petekinnecom/octocheck"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: octocheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pete Kinnecom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- git@k7u7.com
+executables:
+- octocheck
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/octocheck
+- lib/octocheck.rb
+- lib/octocheck/api.rb
+- lib/octocheck/cli.rb
+- lib/octocheck/formatters/color.rb
+- lib/octocheck/formatters/iterm2.rb
+- lib/octocheck/formatters/simple.rb
+- lib/octocheck/summary.rb
+- lib/octocheck/version.rb
+- octocheck.gemspec
+homepage: https://github.com/petekinnecom/octocheck
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: See github checks in your terminal
+test_files: []