octocheck 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf3fdff5823507d50863f9222ac43ed5bde3a73c
-  data.tar.gz: bad327462b3bb0200876409fa706130c17e770ac
+  metadata.gz: 8bd35dfaeee268f1d3daf61cc078347ff1e431c9
+  data.tar.gz: ef74400a142c4722381274a76e558b58496cf41b
 SHA512:
-  metadata.gz: 754f6f7db2d24c504ed08af9a967f880035cc0b8dab0087944e50b501c3da3229bd785f9a6722319af6822f3498dd9ad3d51c34d158cbd73fc5dc83f584ef89d
-  data.tar.gz: dd39442972c9e03b1780d6bd67be456d4d4471a7469161acdf6dea330896c1a745430860a02c7cfe04100a67febca800dc79031040555eacb74fe2e21ec8328a
+  metadata.gz: 51fe6549ea9540916697ac3df1976a1200b053825b143e041f656c1cebbc0e0036831f4bcf83a476a6870172eeead016cdd13ff9ee01caf475fa1f3b57c0a22a
+  data.tar.gz: fc7426aec7e22337e978f83d3ab95a11a5ce0eeea9d5e185dfe6c826ea6441db010ceec8f6955cfa1a8e53adea8e54c822a1b5328287dbc5ebb14196539b402d

data/README.md

@@ -1,52 +1,33 @@
-# Octocheck
+See github status checks in your terminal. (https://help.github.com/en/articles/about-status-checks)
 
-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'
 ```
+$ 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).
+success     ci-check-1  https://example.com/ci-check-1
+in_progress ci-check-2  https://example.com/ci-check-2
+failed      ci-check-3  https://example.com/ci-check-3
+```
 
-## Contributing
+### Installation
 
-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)
+Requires ruby > 2.1.0
 
-octocheck --branch myBranchName --project my_repo_name
+```
+gem install octocheck
+```
 
-[Options]
+### 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]:
+### CONFIGURATION
 
 You can specify your github org and token in a configuration file so
 that you don't need to configure them each time.
@@ -54,12 +35,14 @@ that you don't need to configure them each time.
 Put a json formatted file at ~/.config/octocheck/config.json with the
 following data:
 
+```json
   {
     "token": "< github token value >",
     "org": "< github org name >"
   }
+```
 
-[ORG]:
+### ORG
 
 Unfortunately when accessing status checks for a repo, the repo's
 organization must be specified. :(  The organization can be found in
@@ -67,7 +50,7 @@ the repo's url:
 
 https://github.com/ORGNAME/repo_name
 
-[TOKEN]:
+### TOKEN
 
 In order to read Github checks, you need to configure (or pass as an
 argument) a token with rights to "repo" permissions:
@@ -80,7 +63,7 @@ argument) a token with rights to "repo" permissions:
 Unfortunately full `repo` access is needed in order to access Github
 status checks. Hopefully they change that soon.
 
-[OUTPUT]
+### 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

data/lib/octocheck/api.rb

@@ -18,7 +18,7 @@ module Octocheck
           {
             name: j["context"],
             state: j["state"].downcase,
-            url: j["target_url"]
+            target_url: j["target_url"]
           }
         }
         .uniq {|j| j[:name]}
@@ -31,7 +31,8 @@ module Octocheck
           {
             name: cr["name"],
             state: cr["status"].downcase,
-            url: cr["details_url"],
+            github_url: "https://github.com/#{org}/#{repo}/runs/#{cr["id"]}",
+            target_url: cr["details_url"],
             details: check_run_details(cr["output"]["summary"])
           }
         }
@@ -49,7 +50,7 @@ module Octocheck
             {
               name: structure[:name],
               state: structure[:state].downcase,
-              url: structure[:url]
+              target_url: structure[:url]
             }
           else
             nil

data/lib/octocheck/formatters/iterm2.rb

@@ -14,29 +14,50 @@ module Octocheck
       end
 
       def format(summary)
+        counts = {}
         cols = []
         summary.statuses.each do |status|
+          counts[status.fetch(:state)] = (counts[status.fetch(:state)] || 0) + 1
+
           cols << [
-            linkify(status.fetch(:state), status.fetch(:url)),
+            linkify(status.fetch(:state), status.fetch(:target_url)),
             status.fetch(:name)
           ].join(" ")
         end
 
         summary.check_runs.each do |run|
+          counts[run.fetch(:state)] = (counts[run.fetch(:state)] || 0) + 1
+
           cols << [
-            linkify(run.fetch(:state), run.fetch(:url)),
+            linkify(run.fetch(:state), run.fetch(:target_url)),
             run.fetch(:name)
           ].join(" ")
 
           run.fetch(:details).each do |detail|
+            counts[detail.fetch(:state)] = (counts[detail.fetch(:state)] || 0) + 1
+
             cols << [
-              linkify(detail.fetch(:state), detail.fetch(:url)),
+              linkify(detail.fetch(:state), detail.fetch(:target_url)),
               detail.fetch(:name)
             ].join(" ")
           end
         end
 
         io.puts(cols.join("\n"))
+
+        state_summaries =
+          counts
+            .sort
+            .map {|state, count| "#{count} #{state}"}
+            .join(", ")
+
+        link_summaries =
+          summary
+            .check_runs
+            .map {|cr| cr.fetch(:github_url) }
+            .join("\n")
+
+        io.puts(["", state_summaries, link_summaries].join("\n"))
       end
 
       def linkify(text, url)

data/lib/octocheck/formatters/simple.rb

@@ -14,32 +14,54 @@ module Octocheck
       end
 
       def format(summary)
+        counts = {}
         cols = []
         summary.statuses.each do |status|
+          counts[status.fetch(:state)] = (counts[status.fetch(:state)] || 0) + 1
+
           cols << [
             colorize(status.fetch(:state)),
             status.fetch(:name),
-            status.fetch(:url)
+            status.fetch(:target_url)
           ].join(" ")
         end
 
         summary.check_runs.each do |run|
+          counts[run.fetch(:state)] = (counts[run.fetch(:state)] || 0) + 1
+
           cols << [
             colorize(run.fetch(:state)),
             run.fetch(:name),
-            run.fetch(:url)
+            run.fetch(:target_url)
           ].join(" ")
 
           run.fetch(:details).each do |detail|
+            counts[detail.fetch(:state)] = (counts[detail.fetch(:state)] || 0) + 1
+
             cols << [
               colorize(detail.fetch(:state)),
               detail.fetch(:name),
-              detail.fetch(:url)
+              detail.fetch(:target_url)
             ].join(" ")
           end
         end
 
         io.puts(cols.join("\n"))
+
+        state_summaries =
+          counts
+            .sort
+            .map {|state, count| "#{count} #{state}"}
+            .join(", ")
+
+        link_summaries =
+          summary
+            .check_runs
+            .map {|cr| cr.fetch(:github_url) }
+            .join("\n")
+
+        io.puts(["", state_summaries, link_summaries].join("\n"))
+
       end
 
       def colorize(text)

data/lib/octocheck/summary.rb

@@ -12,5 +12,9 @@ module Octocheck
     def statuses
       @statuses ||= api.statuses
     end
+
+    def summary_pages
+      @summary_pages ||= api.summary_pages
+    end
   end
 end

data/lib/octocheck/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octocheck
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pete Kinnecom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler