lita-reviewme 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e8fff96ac7d5fbaceabb93d02c1f59fae42d91b
+  data.tar.gz: b1ede2cbc19443b492720d950eeb8db4911c9087
+SHA512:
+  metadata.gz: d8a4740bf51e05899730caa0aad8fe7d3d5da6ee02ac353d795a7824ebe9973038292704aaf2b77629b40ef68a57bedc05a075cc1ef1f6890c2a441992d83d86
+  data.tar.gz: cd51dd3f83e9f96ff2c11baa6dbd33747ca85a5b191226abca74d9b6c74cbffd9b9684116c2277670ec03ab6bcaf4e0dcd4e351a51bcce7c882868bed540212f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+dump.rdb
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Jay Hayes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# lita-reviewme
+[![Build Status](https://travis-ci.org/iamvery/lita-reviewme.svg?branch=master)](https://travis-ci.org/iamvery/lita-reviewme)
+
+A [lita](https://www.lita.io/) handler that helps with [code review](http://en.wikipedia.org/wiki/Code_review)
+without getting in the way.
+
+The handler rotates, in order, through a list of names to provider a "reviewer"
+for some unit of work.
+
+## Installation
+
+Add lita-reviewme to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-reviewme", github: "iamvery/lita-reviewme"
+```
+
+## Configuration
+
+Environment variable needed for Github integration:
+
+```
+ENV["GITHUB_WOLFBRAIN_ACCESS_TOKEN"]
+```
+
+## Usage
+
+### See who is in the review rotation.
+
+> **Jay H.** Nerdbot: reviewers
+>
+> **Nerdbot** iamvery, zacstewart, ...
+
+### Add a name to the review rotation
+
+> **Jay H.** Nerdbot: add kyfast to reviews
+>
+> **Nerdbot** added kyfast to reviews
+
+### Remove a name from the review rotation
+
+> **Jay H.** Nerdbot: remove kyfast from reviews
+>
+> **Nerdbot** removed kyfast from reviews
+
+### Fetch the next reviewer
+
+> **Jay H.** Nerdbot: review me
+>
+> **Nerdbot** iamvery
+
+### Comment on a Github pull request or issue
+This will post a comment mentioning the next reviewer on the referenced Github
+pull request or issue. In order for this to work, @wolfbrain must have access
+to the repository.
+
+> **Jay H.** Nerdbot: review https://github.com/iamvery/lita-reviewme/issues/7
+>
+> **Nerdbot** iamvery should be on it...
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-reviewme.rb

@@ -0,0 +1,7 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/reviewme"

data/lib/lita/handlers/reviewme.rb

@@ -0,0 +1,130 @@
+require 'octokit'
+
+module Lita
+  module Handlers
+    class Reviewme < Handler
+      REDIS_LIST = "reviewers"
+
+      route(
+        /add (.+) to reviews/i,
+        :add_reviewer,
+        command: true,
+      )
+
+      route(
+        /add reviewer (.+)/i,
+        :add_reviewer,
+        command: true,
+        help: { "add reviewer iamvery" => "adds iamvery to the reviewer rotation" },
+      )
+
+      route(
+        /remove (.+) from reviews/i,
+        :remove_reviewer,
+        command: true,
+      )
+
+      route(
+        /remove reviewer (.+)/i,
+        :remove_reviewer,
+        command: true,
+        help: { "remove reviewer iamvery" => "removes iamvery from the reviewer rotation" },
+      )
+
+      route(
+        /reviewers/i,
+        :display_reviewers,
+        command: true,
+        help: { "reviewers" => "display list of reviewers" },
+      )
+
+      route(
+        /review me/i,
+        :generate_assignment,
+        command: true,
+        help: { "review me" => "responds with the next reviewer" },
+      )
+
+      route(
+        %r{review <?(?<url>(https://)?github.com/(?<repo>.+)/(pull|issues)/(?<id>\d+))>?}i,
+        :comment_on_github,
+        command: true,
+        help: { "review https://github.com/user/repo/pull/123" => "adds comment to GH issue requesting review" },
+      )
+
+      route(
+        %r{review <?(https?://(?!github.com).*)>?}i,
+        :mention_reviewer,
+        command: true,
+        help: { "review http://some-non-github-url.com" => "requests review of the given URL in chat" }
+      )
+
+      def add_reviewer(response)
+        reviewer = response.matches.flatten.first
+        redis.lpush(REDIS_LIST, reviewer)
+        response.reply("added #{reviewer} to reviews")
+      end
+
+      def remove_reviewer(response)
+        reviewer = response.matches.flatten.first
+        redis.lrem(REDIS_LIST, 0, reviewer)
+        response.reply("removed #{reviewer} from reviews")
+      end
+
+      def display_reviewers(response)
+        reviewers = redis.lrange(REDIS_LIST, 0, -1)
+        response.reply_privately(reviewers.join(', '))
+      end
+
+      def generate_assignment(response)
+        reviewer = next_reviewer
+        response.reply(reviewer.to_s)
+      end
+
+      def comment_on_github(response)
+        repo = response.match_data[:repo]
+        id = response.match_data[:id]
+        reviewer = next_reviewer
+        comment = github_comment(reviewer)
+
+        begin
+          github_client.add_comment(repo, id, comment)
+          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)}")
+        end
+      end
+
+      def mention_reviewer(response)
+        url = response.matches.flatten.first
+        reviewer = next_reviewer
+        response.reply(chat_mention(reviewer, url))
+      end
+
+      private
+
+      def next_reviewer
+        redis.rpoplpush(REDIS_LIST, REDIS_LIST)
+      end
+
+      def github_comment(reviewer)
+        ":eyes: @#{reviewer}"
+      end
+
+      def github_client
+        @github_client ||= Octokit::Client.new(access_token: github_access_token)
+      end
+
+      def github_access_token
+        ENV['GITHUB_WOLFBRAIN_ACCESS_TOKEN']
+      end
+
+      def chat_mention(reviewer, url)
+        "#{reviewer}: :eyes: #{url}"
+      end
+    end
+
+    Lita.register_handler(Reviewme)
+  end
+end

data/lita-reviewme.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-reviewme"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jay Hayes"]
+  spec.email         = ["ur@iamvery.com"]
+  spec.description   = %q{A lita handler that helps with code review}
+  spec.summary       = %q{A lita handler that helps with code review}
+  spec.homepage      = "https://github.com/iamvery/lita-reviewme"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 3.1"
+  spec.add_runtime_dependency "octokit", "~> 3.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      reviewme:

data/spec/lita/handlers/reviewme_spec.rb

@@ -0,0 +1,98 @@
+require "spec_helper"
+
+describe Lita::Handlers::Reviewme, lita_handler: true do
+  it { is_expected.to route_command("add iamvery to reviews").to :add_reviewer }
+  it { is_expected.to route_command("add reviewer iamvery").to :add_reviewer }
+  it { is_expected.to route_command("remove iamvery from reviews").to :remove_reviewer }
+  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://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 }
+
+  let(:reply) { replies.last }
+
+  describe "#add_reviewer" do
+    it "adds a name to the list" do
+      send_command("add iamvery to reviews")
+
+      expect(reply).to eq("added iamvery to reviews")
+    end
+  end
+
+  describe "#remove_reviewer" do
+    it "removes a name from the list" do
+      send_command("remove iamvery from reviews")
+
+      expect(reply).to eq("removed iamvery from reviews")
+    end
+  end
+
+  describe "#generate_assignment" do
+    it "responds with the next reviewer's name" do
+      send_command("add iamvery to reviews")
+      send_command("review me")
+
+      expect(reply).to eq("iamvery")
+    end
+
+    it "rotates the response each time" do
+      send_command("add iamvery to reviews")
+      send_command("add zacstewart to reviews")
+
+      send_command("review me")
+      expect(replies.last).to eq("iamvery")
+
+      send_command("review me")
+      expect(replies.last).to eq("zacstewart")
+    end
+  end
+
+  describe "#comment_on_github" do
+    it "posts comment on github" do
+      repo = "gh_user/repo"
+      id = "123"
+
+      expect_any_instance_of(Octokit::Client).to receive(:add_comment)
+        .with(repo, id, ":eyes: @iamvery")
+
+      send_command("add iamvery to reviews")
+      send_command("review https://github.com/#{repo}/pull/#{id}")
+
+      expect(replies.last).to eq("iamvery should be on it...")
+    end
+
+    it "handles errors gracefully" do
+      expect_any_instance_of(Octokit::Client).to receive(:add_comment)
+        .and_raise(Octokit::Error)
+
+      url = "https://github.com/iamvery/lita-reviewme/pull/5"
+
+      send_command("add iamvery to reviews")
+      send_command("review #{url}")
+
+      expect(replies.last).to eq("I couldn't post a comment. (Are the permissions right?) iamvery: :eyes: #{url}")
+    end
+  end
+
+  describe "#display_reviewers" do
+    it "responds with list of reviewers" do
+      send_command("add iamvery to reviews")
+      send_command("add zacstewart to reviews")
+      send_command("reviewers")
+
+      expect(reply).to eq("zacstewart, iamvery")
+    end
+  end
+
+  describe "#mention_reviewer" do
+    it "mentions a reviewer in chat with the given URL" do
+      send_command("add iamvery to reviews")
+      send_command("review https://bitbucket.org/user/repo/pull-requests/123")
+      expect(replies.last).to eq("iamvery: :eyes: https://bitbucket.org/user/repo/pull-requests/123")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "fakeredis/rspec"
+require "lita-reviewme"
+require "lita/rspec"
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: lita-reviewme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jay Hayes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A lita handler that helps with code review
+email:
+- ur@iamvery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-reviewme.rb
+- lib/lita/handlers/reviewme.rb
+- lita-reviewme.gemspec
+- locales/en.yml
+- spec/lita/handlers/reviewme_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iamvery/lita-reviewme
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A lita handler that helps with code review
+test_files:
+- spec/lita/handlers/reviewme_spec.rb
+- spec/spec_helper.rb