Show check mark when PRs are approved.

Many teams are now using Github's new review workflow, where you explicitly approve a PR rather than marking it with a +1. This is now supported in their API as a preview function via a specific media type header. This change adds a green check mark for PRs that are approved in this way.
binaryberry · Jan 24, 2017 · 6b31447 · 6b31447
1 parent 3913460
commit 6b31447
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 2 deletions.
diff --git a/lib/github_fetcher.rb b/lib/github_fetcher.rb
@@ -2,6 +2,8 @@
 
 class GithubFetcher
   ORGANISATION ||= ENV['SEAL_ORGANISATION']
+  # TODO: remove media type when review support comes out of preview
+  Octokit.default_media_type = 'application/vnd.github.black-cat-preview+json'
 
   attr_accessor :people
 
@@ -37,6 +39,7 @@ def present_pull_request(pull_request, repo_name)
     pr['repo'] = repo_name
     pr['comments_count'] = count_comments(pull_request, repo_name)
     pr['thumbs_up'] = count_thumbs_up(pull_request, repo_name)
+    pr['approved'] = approved?(pull_request, repo_name)
     pr['updated'] = Date.parse(pull_request.updated_at.to_s)
     pr['labels'] = labels(pull_request, repo_name)
     pr
@@ -63,6 +66,11 @@ def count_thumbs_up(pull_request, repo)
     thumbs_up = comments_string.scan(/:\+1:/).count.to_s
   end
 
+  def approved?(pull_request, repo)
+    reviews = @github.get("repos/#{ORGANISATION}/#{repo}/pulls/#{pull_request.number}/reviews")
+    reviews.any? { |review| review.state == 'APPROVED' }
+  end
+
   def labels(pull_request, repo)
     return [] unless use_labels
     key = "#{ORGANISATION}/#{repo}/#{pull_request.number}".to_sym

diff --git a/lib/message_builder.rb b/lib/message_builder.rb
@@ -95,8 +95,9 @@ def present(pull_request, index)
     days = age_in_days(pr)
     thumbs_up = ''
     thumbs_up = " | #{pr["thumbs_up"].to_i} :+1:" if pr["thumbs_up"].to_i > 0
+    approved = pr["approved"] ? " | :white_check_mark: " : ""
     <<-EOF.gsub(/^\s+/, '')
-    #{index}\) *#{pr["repo"]}* | #{pr["author"]} | updated #{days_plural(days)}#{thumbs_up}
+    #{index}\) *#{pr["repo"]}* | #{pr["author"]} | updated #{days_plural(days)}#{thumbs_up}#{approved}
     #{labels(pr)} <#{pr["link"]}|#{pr["title"]}> - #{pr["comments_count"]}#{comments(pull_request)}
     EOF
   end

diff --git a/spec/github_fetcher_spec.rb b/spec/github_fetcher_spec.rb
@@ -39,6 +39,7 @@
           'repo' => 'whitehall',
           'comments_count' => '1',
           'thumbs_up' => '1',
+          'approved' => false,
           'updated' => Date.parse('2015-07-13 ((2457217j,0s,0n),+0s,2299161j)'),
           'labels' => []
         },
@@ -51,6 +52,7 @@
           'repo' => 'whitehall-rebuild',
           'comments_count' => '5',
           'thumbs_up' => '0',
+          'approved' => true,
           'updated' => Date.parse('2015-07-17 ((2457221j,0s,0n),+0s,2299161j)'),
           'labels' => []
         }
@@ -95,6 +97,14 @@
     ].map { |body| double(Sawyer::Resource, body: body)}
   end
 
+  let(:reviews_2248) do
+    [
+      double(Sawyer::Resource, state: "APPROVED" )
+    ]
+  end
+
+  let(:reviews_2266) { [] }
+
   before do
     expect(Octokit::Client).to receive(:new).and_return(fake_octokit_client)
     expect(fake_octokit_client).to receive_message_chain('user.login')
@@ -106,6 +116,8 @@
 
     allow(fake_octokit_client).to receive(:pull_request).with(whitehall_rebuild_repo_name, 2248).and_return(pull_2248)
     allow(fake_octokit_client).to receive(:pull_request).with(whitehall_repo_name, 2266).and_return(pull_2266)
+    allow(fake_octokit_client).to receive(:get).with(%r"repos/alphagov/[\w-]+/pulls/2248/reviews").and_return(reviews_2248)
+    allow(fake_octokit_client).to receive(:get).with(%r"repos/alphagov/[\w-]+/pulls/2266/reviews").and_return(reviews_2266)
   end
 
   shared_examples_for 'fetching from GitHub' do

diff --git a/spec/message_builder_spec.rb b/spec/message_builder_spec.rb
@@ -14,6 +14,7 @@
         'repo' => 'whitehall',
         'comments_count' => '5',
         'thumbs_up' => '0',
+        'approved' => true,
         'updated' => Date.parse('2015-07-17 ((2457221j, 0s, 0n), +0s, 2299161j)'),
         'labels' => []
       }
@@ -29,6 +30,7 @@
         'repo' => 'whitehall',
         'comments_count' => '1',
         'thumbs_up' => '1',
+        'approved' => false,
         'updated' => Date.parse('2015-07-13 ((2457217j, 0s, 0n), +0s, 2299161j)'),
         'labels' => []
       },
@@ -39,6 +41,7 @@
         'repo' => 'whitehall',
         'comments_count' => '5',
         'thumbs_up' => '0',
+        'approved' => false,
         'updated' => Date.parse('2015-07-17 ((2457221j, 0s, 0n), +0s, 2299161j)'),
         'labels' => []
       }
@@ -58,6 +61,7 @@
           'repo' => 'repo',
           'comments_count' => '0',
           'thumbs_up' => '0',
+          'approved' => false,
           'updated' => Date.today,
           'labels' => [
             { 'name' => 'wip' },
@@ -78,7 +82,7 @@
     let(:pull_requests) { recent_pull_requests }
 
     it 'builds informative message' do
-      expect(message_builder.build).to eq("Hello team! \n\n Here are the pull requests that need to be reviewed today:\n\n1) *whitehall* | tekin | updated yesterday\n<https://github.com/alphagov/whitehall/pull/2248|Remove all Import-related code> - 5 comments\n\nMerry reviewing!")
+      expect(message_builder.build).to eq("Hello team! \n\n Here are the pull requests that need to be reviewed today:\n\n1) *whitehall* | tekin | updated yesterday | :white_check_mark: \n<https://github.com/alphagov/whitehall/pull/2248|Remove all Import-related code> - 5 comments\n\nMerry reviewing!")
     end
 
     it 'has an informative poster mood' do