lita-reviewme 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 314ab18b6586a16c2e317fbfb50ca9e1f3b7c945
-  data.tar.gz: 7fbc8906b146f332eac6e2330999240dccb7948e
+  metadata.gz: 6e3fdda3bc11c48f465520ed585c287264467a1c
+  data.tar.gz: af62cdf96b2d1166cab08a71ac6137682a9479ae
 SHA512:
-  metadata.gz: b1f6090dd447abfbdd171e99e25b65cadadf33c277ecc3ff8f27da70fcf98effd75c2a5474b1de87ed1c6323641d0affdcaa69e4b7f2c43a7579cd532a943b3a
-  data.tar.gz: 74dc37d914c77454f1637dacf758aa3ccd8cd11ffe1235e4b795ff68ca305b4ff290d5e6a2710e8c01bb1de5ee03f0a475c36c05b260c2d1bb6fdbd5783ce829
+  metadata.gz: efd26c673f8006d63fb2487aecc38a2b43493be6db51112eaa412b539d936e0e72188cc4d2ea2ef955ac27e78393f2d2592aee10a9d2b842b78f7af4d6b950c6
+  data.tar.gz: d43e40943e95309b76f69a70256b26b7e89ad5fd42ec0956320ce07c6e4ef20891322a5028fc00b1553ddf6d39ea9f62a4985316a2d48673deddc0b385db657d

data/CHANGELOG.md

@@ -4,6 +4,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.5.0] - 2017-06-28
+
+### Added
+- [#55] [#56] - Integration with Github Reviews
+
+### Changed
+- [#54] - Use `:default` option for configuration defaults.
+
 ## [0.4.0] - 2017-02-10
 
 ### Added
@@ -42,7 +50,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Start versioning gem.
 
-[Unreleased]: https://github.com/iamvery/lita-reviewme/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/iamvery/lita-reviewme/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/iamvery/lita-reviewme/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/iamvery/lita-reviewme/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/iamvery/lita-reviewme/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/iamvery/lita-reviewme/compare/v0.2.0...v0.3.0
@@ -52,3 +61,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 [#41]: https://github.com/iamvery/lita-reviewme/pull/41
 [#36]: https://github.com/iamvery/lita-reviewme/pull/36
+[#54]: https://github.com/iamvery/lita-reviewme/pull/54
+[#55]: https://github.com/iamvery/lita-reviewme/pull/55
+[#56]: https://github.com/iamvery/lita-reviewme/pull/56

data/README.md

@@ -52,6 +52,17 @@ config.handlers.reviewme.github_comment_template = lamda do |reviewer, pull_requ
 end
 ```
 
+Your bot can assign a reviewer by adding a comment to the requested PR (default) or by [requesting a review](https://github.com/blog/2291-introducing-review-requests) (or both).
+
+```
+# your bot's lita_config.rb
+#
+# Note:
+# The following configuration will enable review requests and disable comments
+config.handlers.reviewme.github_request_review = true  # default (false)
+config.handlers.reviewme.github_comment = false        # default (true)
+```
+
 ## Usage
 
 ### See who is in the review rotation.

data/lib/lita-reviewme/github.rb

@@ -0,0 +1,68 @@
+require 'delegate'
+
+module Lita
+  module Reviewme
+    class Github
+      class UnknownOwner < StandardError; end
+      class CannotPostComment < StandardError; end
+
+      extend Forwardable
+
+      attr_reader :config, :repo, :pr_id
+
+      delegate [
+        :github_access_token,
+        :github_comment_template,
+        :github_comment,
+        :github_request_review,
+      ] => :config
+
+      def initialize(config, repo, pr_id)
+        @config = config
+        @repo = repo
+        @pr_id = pr_id
+      end
+
+      def owner
+        pull_request.user.login
+      rescue Octokit::Error
+        raise UnknownOwner
+      end
+
+      def assign(reviewer)
+        request_review(reviewer) if github_request_review
+        add_comment(reviewer) if github_comment
+      rescue Octokit::Error
+        raise CannotPostComment
+      end
+
+      private
+
+      def client
+        @client ||= Octokit::Client.new(access_token: github_access_token)
+      end
+
+      def pull_request
+        @pull_request ||= client.pull_request(repo, pr_id)
+      end
+
+      def request_review(reviewer)
+        options = { accept: 'application/vnd.github.black-cat-preview' }
+
+        client.request_pull_request_review(repo, pr_id, [reviewer], options)
+      end
+
+      def add_comment(reviewer)
+        client.add_comment(repo, pr_id, comment(reviewer))
+      end
+
+      def comment(reviewer)
+        if github_comment_template.respond_to?(:call)
+          github_comment_template.call(reviewer, pull_request)
+        else
+          github_comment_template % { reviewer: "@#{reviewer}" }
+        end
+      end
+    end
+  end
+end

data/lib/lita/handlers/reviewme.rb

@@ -1,13 +1,18 @@
 require 'octokit'
+require 'lita-reviewme/github'
 
 module Lita
   module Handlers
     class Reviewme < Handler
+      InvalidConfig = Class.new(StandardError)
+
       REDIS_LIST = "reviewers"
       DEFAULT_GITHUB_MSG = ":eyes: %{reviewer}"
 
       config :github_access_token
-      config :github_comment_template
+      config :github_comment_template, default: DEFAULT_GITHUB_MSG
+      config :github_request_review, default: false
+      config :github_comment, default: true
 
       route(
         /add (.+) to reviews/i,
@@ -51,7 +56,7 @@ module Lita
 
       route(
         %r{review <?(?<url>(https://)?github.com/(?<repo>.+)/(pull|issues)/(?<id>\d+))>?}i,
-        :comment_on_github,
+        :review_on_github,
         command: true,
         help: { "review https://github.com/user/repo/pull/123" => "adds comment to GH issue requesting review" },
       )
@@ -86,28 +91,23 @@ module Lita
         response.reply(reviewer.to_s)
       end
 
-      def comment_on_github(response, room: get_room(response))
-        repo = response.match_data[:repo]
-        id = response.match_data[:id]
+      def review_on_github(response, room: get_room(response))
+        validate_config
+        github = Lita::Reviewme::Github.new(config, response.match_data[:repo], response.match_data[:id])
 
-        reviewer = next_reviewer(room)
-        begin
-          pull_request = github_client.pull_request(repo, id)
-          owner = pull_request.user.login
-          reviewer = next_reviewer(room) if owner == reviewer
-        rescue Octokit::Error
-          response.reply("Unable to check who issued the pull request. Sorry if you end up being assigned your own PR!")
-        end
-        return response.reply('Sorry, no reviewers found') unless reviewer
-        comment = github_comment(reviewer, pull_request)
-
-        begin
-          github_client.add_comment(repo, id, comment)
+        if reviewer = next_reviewer(room, github.owner)
+          github.assign(reviewer)
           response.reply("#{reviewer} should be on it...")
-        rescue Octokit::Error
-          url = response.match_data[:url]
-          response.reply("I couldn't post a comment. (Are the permissions right?) #{chat_mention(reviewer, url)}")
+        else
+          response.reply('Sorry, no reviewers found')
         end
+      rescue Lita::Reviewme::Github::UnknownOwner
+        response.reply("Unable to check who issued the pull request. Sorry if you end up being assigned your own PR!")
+      rescue Lita::Reviewme::Github::CannotPostComment
+        url = response.match_data[:url]
+        response.reply("I couldn't post a comment or request a reviewer. (Are the permissions right?) #{chat_mention(reviewer, url)}")
+      rescue InvalidConfig => error
+        response.reply(error.message)
       end
 
       def mention_reviewer(response, room: get_room(response))
@@ -118,22 +118,23 @@ module Lita
 
       private
 
-      def next_reviewer(room)
-        ns_redis(room.id).rpoplpush(REDIS_LIST, REDIS_LIST)
+      def validate_config
+        if !config.github_comment and !config.github_request_review
+          raise InvalidConfig, 'I am configured to neither leave a comment nor start a review. Check config.handlers.reviewme in lita_config.rb.'
+        end
       end
 
-      def github_comment(reviewer, pull_request)
-        msg = config.github_comment_template || DEFAULT_GITHUB_MSG
+      def next_reviewer(room, owner = nil)
+        reviewer = ns_redis(room.id).rpoplpush(REDIS_LIST, REDIS_LIST)
+        return unless reviewer
 
-        if msg.respond_to?(:call) # its a proc
-          msg.call(reviewer, pull_request)
-        else
-          msg % { reviewer: "@#{reviewer}" }
+        if reviewer == owner
+          return if ns_redis(room.id).llen(REDIS_LIST) == 1
+
+          reviewer = next_reviewer(room, owner)
         end
-      end
 
-      def github_client
-        @github_client ||= Octokit::Client.new(access_token: config.github_access_token)
+        reviewer
       end
 
       def chat_mention(reviewer, url)

data/lita-reviewme.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-reviewme"
-  spec.version       = "0.4.0"
+  spec.version       = "0.5.0"
   spec.authors       = ["Jay Hayes"]
   spec.email         = ["ur@iamvery.com"]
   spec.description   = %q{A lita handler that helps with code review}

data/spec/lita-reviewme/github_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+describe Lita::Reviewme::Github do
+  let(:repo) { "gh_user/repo" }
+  let(:id) { "123" }
+  let(:user) { OpenStruct.new(login: 'iamvery') }
+  let(:title) { 'PR Title' }
+  let(:pull_request) { OpenStruct.new(user: user, title: title) }
+  let(:github_comment_template) { ":eyes: %{reviewer}" }
+  let(:github_comment) { true }
+  let(:github_request_review) { false }
+
+  let(:config) do
+    OpenStruct.new(
+      github_access_token: 'access-token',
+      github_comment_template: github_comment_template,
+      github_comment: github_comment,
+      github_request_review: github_request_review
+    )
+  end
+
+  before do
+    allow_any_instance_of(Octokit::Client).to receive(:pull_request)
+      .and_return(pull_request)
+  end
+
+  subject { described_class.new(config, repo, id) }
+
+  describe "ownership" do
+    it "comes from the pull request" do
+      expect(subject.owner).to eq('iamvery')
+    end
+
+    describe "unexpected error" do
+      class User
+        def login
+          raise Octokit::Error
+        end
+      end
+
+      let(:user) { User.new }
+
+      it "raises an exception" do
+        expect { subject.owner }.to raise_error(Lita::Reviewme::Github::UnknownOwner)
+      end
+    end
+  end
+
+  describe "assignment" do
+    describe "via review request" do
+      let(:github_comment) { false }
+      let(:github_request_review) { true }
+
+      it "uses the request review api" do
+        expect_any_instance_of(Octokit::Client).to receive(:request_pull_request_review)
+          .with(repo, id, ['iamvery'], { accept: "application/vnd.github.black-cat-preview" })
+
+        subject.assign('iamvery')
+      end
+    end
+
+    describe "via comment api" do
+      describe "with a string" do
+        it "evaluates template" do
+          expect_any_instance_of(Octokit::Client).to receive(:add_comment)
+            .with(repo, id, ":eyes: @iamvery")
+
+          subject.assign('iamvery')
+        end
+      end
+
+      describe "with a proc" do
+        let(:github_comment_template) do
+          lambda do |reviewer, pull_request|
+            "hey @#{reviewer}, this is from a lambda! :tada: #{title}"
+          end
+        end
+
+        it "executes a proc if specified in `config.github_comment_template`" do
+          expected_msg = "hey @iamvery, this is from a lambda! :tada: #{title}"
+
+          expect_any_instance_of(Octokit::Client).to receive(:add_comment)
+            .with(repo, id, expected_msg)
+
+          subject.assign('iamvery')
+        end
+      end
+    end
+  end
+end
+

data/spec/lita/handlers/reviewme_spec.rb

@@ -8,9 +8,9 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
   it { is_expected.to route_command("remove reviewer iamvery").to :remove_reviewer }
   it { is_expected.to route_command("reviewers").to :display_reviewers }
   it { is_expected.to route_command("review me").to :generate_assignment }
-  it { is_expected.to route_command("review https://github.com/user/repo/pull/123").to :comment_on_github }
-  it { is_expected.to route_command("review <https://github.com/user/repo/pull/123>").to :comment_on_github }
-  it { is_expected.to route_command("review https://github.com/user/repo/issues/123").to :comment_on_github }
+  it { is_expected.to route_command("review https://github.com/user/repo/pull/123").to :review_on_github }
+  it { is_expected.to route_command("review <https://github.com/user/repo/pull/123>").to :review_on_github }
+  it { is_expected.to route_command("review https://github.com/user/repo/issues/123").to :review_on_github }
   it { is_expected.to route_command("review https://bitbucket.org/user/repo/pull-requests/123").to :mention_reviewer }
   it { is_expected.to route_command("review <https://bitbucket.org/user/repo/pull-requests/123>").to :mention_reviewer }
 
@@ -52,7 +52,7 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
     end
   end
 
-  describe "#comment_on_github" do
+  describe "#review_on_github" do
     let(:repo) { "gh_user/repo" }
     let(:id) { "123" }
     let(:pr) do
@@ -63,10 +63,12 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
       # Prevent hitting the network for PR info.
       allow_any_instance_of(Octokit::Client).to receive(:pull_request)
         .and_return(pr)
+
+      @default_github_comment_template = subject.config.github_comment_template
     end
 
     after do
-      subject.config.github_comment_template = nil
+      subject.config.github_comment_template = @default_github_comment_template
     end
 
     it "posts comment on github" do
@@ -120,6 +122,16 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
       expect(reply).to eq("iamvery should be on it...")
     end
 
+    it "doesn't get stuck if requester is only reviewer" do
+      expect_any_instance_of(Octokit::Client).to receive(:pull_request)
+        .with(repo, id).and_return(pr)
+
+      send_command("add #{pr.user.login} to reviews")
+      send_command("review https://github.com/#{repo}/pull/#{id}")
+
+      expect(reply).to eq('Sorry, no reviewers found')
+    end
+
     it "skips assigning to the GitHub PR owner" do
       expect_any_instance_of(Octokit::Client).to receive(:pull_request)
         .with(repo, id).and_return(pr)
@@ -144,7 +156,48 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
       send_command("add iamvery to reviews")
       send_command("review #{url}")
 
-      expect(reply).to eq("I couldn't post a comment. (Are the permissions right?) iamvery: :eyes: #{url}")
+      expect(reply).to eq("I couldn't post a comment or request a reviewer. (Are the permissions right?) iamvery: :eyes: #{url}")
+    end
+
+    describe "review requests" do
+      before do
+        subject.config.github_comment = false
+        subject.config.github_request_review = true
+      end
+
+      after do
+        subject.config.github_comment = true
+        subject.config.github_request_review = false
+      end
+
+      it "requests a review if enabled" do
+        expect_any_instance_of(Octokit::Client).to receive(:request_pull_request_review)
+          .with(repo, id, ['iamvery'], { accept: "application/vnd.github.black-cat-preview" })
+
+        send_command("add iamvery to reviews")
+        send_command("review https://github.com/#{repo}/pull/#{id}")
+
+        expect(reply).to eq("iamvery should be on it...")
+      end
+    end
+
+    describe "invalid configuration" do
+      before do
+        subject.config.github_comment = false
+        subject.config.github_request_review = false
+      end
+
+      after do
+        subject.config.github_comment = true
+        subject.config.github_request_review = false
+      end
+
+      it "raises error because bot can't do anything" do
+        send_command("add iamvery to reviews")
+        send_command("review https://github.com/#{repo}/pull/#{id}")
+
+        expect(reply).to eq("I am configured to neither leave a comment nor start a review. Check config.handlers.reviewme in lita_config.rb.")
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-reviewme
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jay Hayes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -115,9 +115,11 @@ files:
 - README.md
 - Rakefile
 - lib/lita-reviewme.rb
+- lib/lita-reviewme/github.rb
 - lib/lita/handlers/reviewme.rb
 - lita-reviewme.gemspec
 - locales/en.yml
+- spec/lita-reviewme/github_spec.rb
 - spec/lita/handlers/reviewme_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/iamvery/lita-reviewme
@@ -141,10 +143,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A lita handler that helps with code review
 test_files:
+- spec/lita-reviewme/github_spec.rb
 - spec/lita/handlers/reviewme_spec.rb
 - spec/spec_helper.rb