github_workflow 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8271e322b33f74a9d09a2ddb73493a177954b367dfb2b4ead132dbe72874ffad
-  data.tar.gz: ba726efdd702aa7021637ef2d03f9975fbb7e9cbe21ccfe3b825c34fad7fd888
+  metadata.gz: 8e9f6a6dfe205f986f1d69b2a778ca8aaf008833423cbde6e664818d90c7c0e0
+  data.tar.gz: 1f3dce21f39ca0e0ca4cba5ddcafa0c1817b2e0fd4d8e5ef2de82b6abd4a6f21
 SHA512:
-  metadata.gz: e38c3753cab0d496d407c1fa2f9afcd32f8f78c823013ded75d9ca0dfb8418d02ac837dbabc7910c4d73be9a97aecdf60b8cfa5691c5624e863f5dbbe05a61f1
-  data.tar.gz: 3477e960a0b6b08ed0350ca2e7e498ea0262dc95c314ddc0834b87d18dec4c09b366249da6d887746dfba4e6253d7551489503f3ac93991d3f26a08077c4db74
+  metadata.gz: a4b8055a935171f2c1a9e694ada8ca0b78704e4c49f5880745f4c1920023841fcd94d1819a39bdd26bee89b35a1a6c508de49f16538b45bd261dad39b0798d97
+  data.tar.gz: 824bc8e9cfadf38d68a9e6b34d22a715eeaa08c3dc260ce7637aef8e10f7cc89bfa2313992dd8a0619f88c4908207c68268c04551d3867e48c6de354ea0892e4

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+2.7.4

data/README.md

@@ -1,3 +1,13 @@
+# Setup
+
+Install the [GitHub cli](https://cli.github.com/manual/)
+
+`brew install gh`
+
+login to the cli
+
+`gh login`
+
 # Github Workflow
 
 ```
@@ -12,4 +22,5 @@ Commands:
   github_workflow push_and_pr                       # Push branch to origin and convert Issue to Pull Request
   github_workflow start -i, --issue-id=ISSUE_ID     # Create branch named with issue number and issue title
   github_workflow status                            # Check PR CI status
+  github_workflow reviews                           # Print out reviewers list and their PRs count
 ```

data/github_workflow.gemspec

@@ -18,9 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "thor", "~> 1.0.1"
-  spec.add_dependency "faraday", "~> 0.11", "< 2.0"
   spec.add_dependency "terminal-table", "~> 1.5"
-  spec.add_dependency "ruby-trello", "~> 2.1"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "pry"

data/lib/github_workflow/cli.rb

@@ -1,61 +1,22 @@
 require "rubygems"
 require "pry"
-require "faraday"
 require "thor"
 require "open3"
 require "json"
 require "terminal-table"
-require "trello"
+require_relative "gh_cli_client.rb"
 
 module GithubWorkflow
   class Cli < Thor
     PROCEED_TEXT = "Proceed? [y,yes]: ".freeze
 
-    GITHUB_CONFIG = <<~TEXT
-      {
-        "oauth_token":              "TOKEN",
-        "user_and_repo":            "ORG/REPO",
-        "trello_key":               "KEY",
-        "trello_token":             "TOKEN",
-        "trello_board_id":          "BOARD_ID",
-        "trello_platform_board_id": "BOARD_ID"
-      }
-    TEXT
-
     include Thor::Actions
 
-    default_task :trello
-
-    desc "trello", "Create issue from card"
-    method_option :card_number, aliases: "-i", type: :string, required: true
-    def trello
-      ensure_github_config_present
-      init_trello
-      set_trello_card(type: nil)
-      create_issue_from_trello_card
-      stash
-      rebase_main
-      create_branch
-      stash_pop
-    end
-
-    desc "platform", "Create issue from card"
-    method_option :card_number, aliases: "-i", type: :string, required: true
-    def platform
-      ensure_github_config_present
-      init_trello
-      set_trello_card(type: :platform)
-      create_issue_from_trello_card
-      stash
-      rebase_main
-      create_branch
-      stash_pop
-    end
+    default_task :start
 
     desc "start", "Create branch named with issue number and issue title"
     method_option :issue_id, aliases: "-i", type: :string, required: true
     def start
-      ensure_github_config_present
       stash
       rebase_main
       create_branch
@@ -65,7 +26,6 @@ module GithubWorkflow
     desc "create_pr", "Convert Issue to Pull Request"
     method_option :base_branch, aliases: "-b", type: :string
     def create_pr
-      ensure_github_config_present
       ensure_origin_exists
       convert_issue_to_pr
     end
@@ -73,16 +33,14 @@ module GithubWorkflow
     desc "push_and_pr", "Push branch to origin and convert Issue to Pull Request"
     method_option :base_branch, aliases: "-b", type: :string
     def push_and_pr
-      ensure_github_config_present
       push_and_set_upstream
       convert_issue_to_pr
     end
 
     desc "status", "Check PR CI status"
     def status
-      ensure_github_config_present
       ensure_origin_exists
-      response = JSON.parse(github_client.get("repos/#{user_and_repo}/statuses/#{current_branch}").body)
+      response = github_client.get_statuses
 
       if response.empty?
         alert "No statuses yet.  Have you pushed your branch?"
@@ -104,21 +62,20 @@ module GithubWorkflow
 
     desc "info", "Print out issue description"
     def info
-      ensure_github_config_present
-      puts get_issue(issue_number_from_branch)["body"]
+      issue = github_client.get_issue(issue_number_from_branch)
+      puts "#{issue["html_url"]}\n\n"
+      puts "[##{issue["number"]}] #{issue["title"]}\n"
+      puts issue["body"]
     end
 
     desc "open", "Open issue or PR in browser"
     def open
-      ensure_github_config_present
-      response = JSON.parse(github_client.get("repos/#{user_and_repo}/issues/#{issue_number_from_branch}").body)
-      `/usr/bin/open -a "/Applications/Google Chrome.app" '#{response["html_url"]}'`
+      open_url(github_client.get_issue(issue_number_from_branch)["html_url"])
     end
 
     desc "create_and_start", "Create and start issue"
     method_option :name, aliases: "-m", type: :string, required: true
     def create_and_start
-      ensure_github_config_present
       create_issue
     end
 
@@ -147,8 +104,7 @@ module GithubWorkflow
 
     desc "reviews", "Displays count of requested reviews for each user"
     def reviews
-      ensure_github_config_present
-      reviewers = get_prs_list.map { |pr| pr["requested_reviewers"].map { |r| r["login"] } }.flatten
+      reviewers = github_client.get_prs_list.map { |pr| pr["requested_reviewers"].map { |r| r["login"] } }.flatten
       reviewer_counts = reviewers.group_by { |i| i }.map { |k, v| [k, v.count] }
 
       if reviewer_counts.any?
@@ -170,16 +126,8 @@ module GithubWorkflow
     end
 
     no_tasks do
-      def get_issue(id)
-        JSON.parse(github_client.get("repos/#{user_and_repo}/issues/#{id}").body)
-      end
-
-      def get_pr(id)
-        JSON.parse(github_client.get("repos/#{user_and_repo}/pulls/#{id}").body)
-      end
-
-      def get_prs_list
-        JSON.parse(github_client.get("repos/#{user_and_repo}/pulls&per_page=100").body)
+      def open_url(url)
+        `/usr/bin/open -a "/Applications/Google Chrome.app" '#{url}'`
       end
 
       def create_branch
@@ -194,118 +142,21 @@ module GithubWorkflow
         end
       end
 
-      def create_issue_from_trello_card
-        say_info("Creating issue")
-
-        issue_params = {
-          title: trello_card.name,
-          body: issue_body_from_trello_card,
-          assignees: [current_github_username],
-          labels: trello_card.labels.map(&:name)
-        }
-
-        response = JSON.parse(github_client.post("repos/#{user_and_repo}/issues", issue_params.to_json).body)
-
-        @issue_id = response["number"]
-
-        github_client.post("/repos/#{user_and_repo}/issues/#{@issue_id}/comments", { body: trello_card.short_url }.to_json)
-        trello_card.add_attachment response["html_url"]
-      end
-
-      def issue_body_from_trello_card
-        [trello_card.desc, trello_deploy_note, trello_product_review_type, trello_pm].compact.join("\n\n")
-      end
-
-      def trello_pm
-        custom_field = trello_card.custom_field_items.detect { |cfi| cfi.custom_field.name == "PM" }
-
-        if custom_field.present?
-          "**Responsible:** #{custom_field.option_value['text']}"
-        end
-      end
-
-      def trello_deploy_note
-        custom_field = trello_card.custom_field_items.detect { |cfi| cfi.custom_field.name == "Deploy Note" }
-
-        if custom_field.present?
-          "**Deploy Note:** #{custom_field.value['text']}"
-        end
-      end
-
-      def trello_product_review_type
-        custom_field = trello_card.custom_field_items.detect { |cfi| cfi.custom_field.name == "Product Review" }
-
-        if custom_field.present?
-          "**Product Review:** #{custom_field.option_value['text']}"
-        end
-      end
-
-      def current_github_username
-        JSON.parse(github_client.get("user").body)["login"]
-      end
-
-      def set_trello_card(type:)
-        say_info("Fetching trello card")
-
-        trello_board =
-          if type
-            Trello::Board.find(project_config["trello_#{type}_board_id"])
-          else
-            Trello::Board.find(project_config["trello_board_id"])
-          end
-
-        @trello_card = trello_board.find_card(options["card_number"].to_i)
-      end
-
-      def trello_card
-        @trello_card
-      end
-
-      def ensure_github_config_present
-        if project_config.nil? || (JSON.parse(GITHUB_CONFIG).keys - project_config.keys).any?
-          failure("Please add `.github_workflow` file containing:\n#{GITHUB_CONFIG}")
-        end
-      end
-
-      def init_trello
-        Trello.configure do |config|
-          config.developer_public_key = project_config["trello_key"]
-          config.member_token = project_config["trello_token"]
-        end
-      end
-
-      def project_config
-        @project_config ||= JSON.parse(File.read(".github_workflow")) rescue nil
-      end
-
-      def oauth_token
-        project_config["oauth_token"]
-      end
-
-      def user_and_repo
-        project_config["user_and_repo"]
-      end
-
       def push_and_set_upstream
         `git rev-parse --abbrev-ref HEAD | xargs git push origin -u`
       end
 
       def create_issue
-        github_client.post(
-          "repos/#{user_and_repo}/issues",
-          JSON.generate(
-            {
-              title: options[:name]
-            }
-          )
+        github_client.create_issue(
+          title: options[:name]
         ).tap do |response|
-          if response.success?
+          if response["number"]
             pass("Issue created")
-            @issue_id = JSON.parse(response.body)["number"]
+            @issue_id = response["number"]
             start
           else
             alert("An error occurred when creating issue:")
-            alert("#{response.status}: #{JSON.parse(response.body)['message']}")
+            alert("#{response['message']}")
           end
         end
       end
@@ -315,22 +166,17 @@ module GithubWorkflow
       end
 
       def convert_issue_to_pr
-        github_client.post(
-          "repos/#{user_and_repo}/pulls",
-          JSON.generate(
-            {
-              head: current_branch,
-              base: options[:base_branch] || "main",
-              issue: issue_number_from_branch.to_i
-            }
-          )
+        github_client.convert_issue_to_pr(
+          issue_number_from_branch.to_i,
+          head: current_branch,
+          base: options[:base_branch] || "main",
         ).tap do |response|
-          if response.success?
+          if response["url"]
             pass("Issue converted to Pull Request")
-            say_info(JSON.parse(response.body)["url"])
+            say_info(response["html_url"])
           else
             alert("An error occurred when creating PR:")
-            alert("#{response.status}: #{JSON.parse(response.body)['message']}")
+            alert("#{response['message']}")
           end
         end
       end
@@ -348,16 +194,12 @@ module GithubWorkflow
       end
 
       def branch_name_for_issue_number
-        issue = JSON.parse(github_client.get("repos/#{user_and_repo}/issues/#{issue_id}").body)
+        issue = github_client.get_issue(issue_id)
         "#{issue['number']}_#{issue['title'].strip.downcase.gsub(/[^a-zA-Z0-9]/, '_').squeeze("_")}"
       end
 
       def github_client
-        Faraday.new(url: "https://api.github.com") do |faraday|
-          faraday.request   :url_encoded
-          faraday.adapter   Faraday.default_adapter
-          faraday.authorization :Bearer, oauth_token
-        end
+        @gh_client ||= GhCliClient.new
       end
 
       def rebase_main
@@ -392,7 +234,7 @@ module GithubWorkflow
         @merged_pr_branches ||=
           pr_branches.map do |branch|
             id = branch.split("_")[0].to_i
-            merged = !!get_pr(id)["merged"]
+            merged = !!github_client.get_pr(id)["merged"]
             print merged ? "✅ " : "❌ "
             puts " #{branch}"
             merged ? branch : nil
@@ -404,7 +246,7 @@ module GithubWorkflow
       end
 
       def commits_for_range
-        JSON.parse(github_client.get("repos/#{user_and_repo}/compare/#{options[:commit_range]}").body)
+        github_client.commits_for_range(options[:commit_range])
       end
 
       def pull_request_in_commit_range
@@ -414,13 +256,11 @@ module GithubWorkflow
 
         prs = pr_ids.map do |id|
           say_info("Fetching Pull Request ##{id}")
-          pr = github_client.get("repos/#{user_and_repo}/pulls/#{id}")
+          pr = github_client.get_pr(id)
 
-          if pr.status == 404
-            JSON.parse(github_client.get("repos/#{user_and_repo}/issues/#{id}").body)
-          else
-            JSON.parse(pr.body)
-          end
+          next pr if pr["number"]
+
+          github_client.get_issue(id)
         end
       end
 

data/lib/github_workflow/gh_cli_client.rb

@@ -0,0 +1,41 @@
+
+class GhCliClient
+
+  def get_issue(id) 
+    request("'repos/{owner}/{repo}/issues/#{id}'")
+  end
+
+  def get_pr(id) 
+    request("'repos/{owner}/{repo}/pulls/#{id}'")
+  end
+
+  def get_prs_list
+    request("'repos/{owner}/{repo}/pulls?per_page=100'")
+  end
+
+  def create_issue(title:, body: '')
+    request("'repos/{owner}/{repo}/issues'", args: {title: title, body: body})
+  end
+
+  def convert_issue_to_pr(id, head:, base:)
+    request("'repos/{owner}/{repo}/pulls'", args: {issue: id.to_i, head: head, base: base})
+  end
+
+  def commits_for_range(commit_range)
+    # https://docs.github.com/en/rest/commits/commits#compare-two-commits
+    request("'repos/{owner}/{repo}/compare/#{commit_range}'")
+  end
+
+  def get_statuses(branch: '{branch}')
+    request("'repos/{owner}/{repo}/statuses/#{branch}'")
+  end
+
+  protected
+
+  def request(url, args: {})
+    arg_params = args.map{ |k,v| "-F '#{k}'='#{v}'" }.join(' ')
+    response = `gh api #{url} #{arg_params}`
+    parsed = JSON.parse(response)
+    parsed
+  end
+end

data/lib/github_workflow/version.rb

@@ -1,3 +1,3 @@
 module GithubWorkflow
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_workflow
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Liscio
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,26 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -58,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: ruby-trello
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: 
+description:
 email:
 - bliscio@daisybill.com
 executables:
@@ -130,12 +96,13 @@ files:
 - bin/github_workflow
 - github_workflow.gemspec
 - lib/github_workflow/cli.rb
+- lib/github_workflow/gh_cli_client.rb
 - lib/github_workflow/version.rb
 homepage: https://github.com/daisybill/github_workflow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: DaisyBill's internal github workflows
 test_files: []