ghamma 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad500d312e1ec3068bcebd224b215cc53cefb71c70ec88f765d3dda38c1605fa
-  data.tar.gz: 26265dd2d7e18b24d6649d535b2546c42ea41404238e15117f65045621da1f31
+  metadata.gz: 374a835681570e0824d2ee192361ed16dbfc11352cc8f8f0f69ad2a0cdaa8f7f
+  data.tar.gz: 702786830164573d586113f1f88b8c5e983e71111c9ce3226274e468a374fb61
 SHA512:
-  metadata.gz: c7cd7a72afe17f051550b28fd8b3de74227d38c1ef02e24a62242d355efcff1bf183103188b365201cec19e2506d1a2c3d6cbfb7c3e288e78abd612d08fc1174
-  data.tar.gz: 3749db0be1011a9998684e5f9d66a1d990a97233e892581655136b576916e3becee978bc17002b3617b2536401339ba0ed4ce6c0d107e5c5a65035f0f3f997af
+  metadata.gz: 3e01904c7804ae9636d06aaad5af029736b8286200f2791851b10bdd11f6552721f7cdb2ab1c4dfe9489bd27ff98374f7d7037a15e0fb04ad22c396429b18361
+  data.tar.gz: f2fb982a98a100f66072fbc80d0c4618f1281de82442dcf59c2b551ade25466303684d7fcbf55cf56eefded0a4d43ad35ce95eb7148764e71b2dc840c08c9b51

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+-
+
+## [0.2.0] - 2023-06-01
+
+- Breaking: Add commands to the CLI: `version`, `list-worklows`, `duration-history`
+
 ## [0.1.1] - 2023-06-01
 
 - Actually make the gem executable

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    ghamma (0.1.1)
+    ghamma (0.2.0)
+      dry-cli
       http
 
 GEM
@@ -12,6 +13,7 @@ GEM
     ast (2.4.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    dry-cli (1.0.0)
     ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)

data/README.md

@@ -13,17 +13,43 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+### Authentication
+
+The Github workflows API requires an authenticated user, even for public repos.
+To use this tool, you will need a
+[Github API Token](https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api#authenticating-with-a-personal-access-token)
+with at least `read` access to the repo you want to look at.
+
+Once you have that, make it available.
+
+```
+$ export GH_TOKEN="YOUR_API_TOKEN"
+```
+
+Then fetch the list of available workflows for the repo. The name will be necessary in the next step.
+
+```
+$ ghamma list-workflows tony-rowan ghamma
+Found 1 workflows
+Ruby
+```
+
+Then fetch a CSV of the durations of the latest workflow runs.
+
+```
+$ ghamma duration-history tony-rowan ghamma Ruby
+Date,Duration
+2023-06-01T15:44:49Z,21000
+2023-06-01T15:37:21Z,17000
+2023-06-01T15:35:16Z,23000
+2023-06-01T15:31:33Z,19000
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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 the created tag, 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/tony-rowan/ghamma. This project is

data/exe/ghamma

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'ghamma'
+require "ghamma"
 
-Ghamma::Cli.new.print_workflow_duration_metrics
+Dry::CLI.new(Ghamma::CLI).call

data/lib/ghamma/cli.rb

@@ -1,80 +1,60 @@
 require "csv"
+require "dry/cli"
 require "http"
 
-module Ghamma
-  class Cli
-
-    BASE_URL = "https://api.github.com".freeze
-    OWNER = ARGV[0].freeze
-    REPOSITORY = ARGV[1].freeze
+require_relative "./github_api_client"
+require_relative "./version"
 
-    def api_url(resource)
-      "#{BASE_URL}#{resource}"
-    end
+module Ghamma
+  module CLI
+    extend Dry::CLI::Registry
 
-    def get(resource, params = {})
-      response = HTTP
-        .auth("Bearer #{ENV["GH_TOKEN"]}")
-        .get(api_url(resource), params: params)
-        .body
-      JSON.parse(response)
-    end
+    class Version < Dry::CLI::Command
+      desc "Print version"
 
-    def fetch_workflows
-      response = get "/repos/#{OWNER}/#{REPOSITORY}/actions/workflows"
-      response["workflows"].map { |json| {id: json["id"], name: json["name"]} }.tap do |workflows|
-        puts "Found #{workflows.size} workflows"
+      def call(*)
+        puts VERSION
       end
     end
 
-    def fetch_workflows_with_runs
-      fetch_workflows.map do |workflow|
-        response = get "/repos/#{OWNER}/#{REPOSITORY}/actions/workflows/#{workflow[:id]}/runs",
-          {per_page: 100, status: "success", exclude_pull_requests: true, created: ">2023-05-01"}
-        puts "Fetched runs for #{workflow[:name]}"
+    class ListWorkflows < Dry::CLI::Command
+      desc "List workflows on the given repo"
 
-        next if response["total_count"].zero?
+      argument :owner, required: true
+      argument :repo, required: true
 
-        {
-          id: workflow[:id],
-          name: workflow[:name],
-          runs: response["workflow_runs"].map { |json| {id: json["id"], date: json["created_at"]} }
-        }
-      end.compact
+      def call(owner:, repo:)
+        workflows = GithubApiClient.new(owner: owner, repo: repo, token: ENV["GH_TOKEN"]).fetch_workflows
+        puts "Found #{workflows.size} workflows"
+        workflows.each { |workflow| puts workflow[:name] }
+        puts
+      end
     end
 
-    def fetch_workflow_duration_metrics
-      fetch_workflows_with_runs.map do |workflow|
-        runs_with_timing = workflow[:runs].map do |workflow_run|
-          response = get "/repos/#{OWNER}/#{REPOSITORY}/actions/runs/#{workflow_run[:id]}/timing"
+    class DurationHistory < Dry::CLI::Command
+      desc "List the duration of each successful workflow run"
 
-          {
-            duration: response["run_duration_ms"],
-            date: workflow_run[:date]
-          }
-        end
+      argument :owner, required: true
+      argument :repo, required: true
+      argument :workflow, required: true
 
-        puts "Fetched timings for #{workflow[:name]}"
+      def call(owner:, repo:, workflow:)
+        durations = GithubApiClient.new(owner: owner, repo: repo, token: ENV["GH_TOKEN"]).fetch_workflow_duration_history(workflow)
 
-        {
-          name: workflow[:name],
-          runs: runs_with_timing
-        }
-      end
-    end
-
-    def print_workflow_duration_metrics
-      fetch_workflow_duration_metrics.each do |workflow_metrics|
-        puts workflow_metrics[:name]
-        metrics_table = CSV.generate do |csv|
+        durations_output = CSV.generate do |csv|
           csv << ["Date", "Duration"]
-          workflow_metrics[:runs].each do |metric_datum|
-            csv << [metric_datum[:date], metric_datum[:duration]]
+          durations.each do |duration|
+            csv << duration
           end
         end
-        puts metrics_table
+
+        puts durations_output
         puts
       end
     end
+
+    register "version", Version, aliases: ["v", "-v", "--version"]
+    register "list-workflows", ListWorkflows
+    register "duration-history", DurationHistory
   end
 end

data/lib/ghamma/github_api_client.rb

@@ -0,0 +1,54 @@
+require "http"
+
+module Ghamma
+  class GithubApiClient
+    BASE_URL = "https://api.github.com".freeze
+
+    def initialize(owner:, repo:, token:)
+      @repo_base_url = "#{BASE_URL}/repos/#{owner}/#{repo}"
+      @authorization_header = "Bearer #{token}"
+    end
+
+    def fetch_workflows
+      get("/workflows")
+        .fetch("workflows")
+        .map do |workflow_json|
+          workflow_json.transform_keys(&:to_sym).slice(:id, :name)
+        end
+    end
+
+    def fetch_workflow_duration_history(workflow_name)
+      workflow_id = get("/workflows").fetch("workflows")
+        .find { |workflow| workflow["name"] == workflow_name }
+        &.fetch("id", nil)
+
+      if workflow_id.nil?
+        raise "Could not find workflow with name #{workflow_name}"
+      end
+
+      workflow_runs = get(
+        "/workflows/#{workflow_id}}/runs",
+        {per_page: 100, status: "success", exclude_pull_requests: true}
+      ).fetch("workflow_runs")
+      .map do |workflow_run|
+        run_timing = get("/runs/#{workflow_run["id"]}/timing")
+
+        [
+          workflow_run["created_at"],
+          run_timing["run_duration_ms"]
+        ]
+      end
+    end
+
+    private
+
+    attr_reader :repo_base_url, :authorization_header
+
+    def get(resource, params = {})
+      HTTP
+        .auth(authorization_header)
+        .get("#{repo_base_url}/actions#{resource}", params: params)
+        .parse
+    end
+  end
+end

data/lib/ghamma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ghamma
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghamma
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Rowan
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  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: http
   requirement: !ruby/object:Gem::Requirement
@@ -85,6 +99,7 @@ files:
 - exe/ghamma
 - lib/ghamma.rb
 - lib/ghamma/cli.rb
+- lib/ghamma/github_api_client.rb
 - lib/ghamma/version.rb
 - sig/ghamma.rbs
 homepage: https://github.com/tony-rowan/ghamma