lita-gerrit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03892ea9cf8863f344836f19e638f7ae7a091821
+  data.tar.gz: dd388d3257cdbeab80e960b2aace43fb199bba88
+SHA512:
+  metadata.gz: bbb6b6115f5e70481ec70b1029fe77c20413232d7d4d2041a70314c4f4b08d5a0224f982f1c043d8cef3965b1076e644c8df518afd00ec290e2ef63a9529bad8
+  data.tar.gz: 63501906c688043f9f0e7e9e241b2f26bd031f0ba178779e6e033a64c5d37960c35ff1adc8bfe4c0dbaca7c3d0701e0bd10571f25206b245f7dc14b933e7f88f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Jonathan Amiez
+
+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,59 @@
+# lita-gerrit
+
+[![Build Status](https://travis-ci.org/josqu4red/lita-gerrit.png?branch=master)](https://travis-ci.org/josqu4red/lita-gerrit)
+[![Coverage Status](https://coveralls.io/repos/josqu4red/lita-gerrit/badge.png)](https://coveralls.io/r/josqu4red/lita-gerrit)
+
+**lita-gerrit** is a handler for [Lita](https://github.com/jimmycuadra/lita) that allows interaction with Gerrit code review tool.
+
+It allows to fetch Gerrit changes details from the chat and listens for hook events on HTTP interface.
+
+It depends on HTTParty because Gerrit uses HTTP digest authentication, which is not supported by Lita's built-in HTTP client, Faraday.
+
+## Installation
+
+Add lita-gerrit to your Lita instance's Gemfile:
+
+```ruby
+gem "lita-gerrit"
+```
+
+## Configuration
+
+* `url` (String) - Gerrit service URL
+* `username` (String) - Username for REST API
+* `password` (String) - Password for REST API
+
+### Example
+
+```ruby
+Lita.configure do |config|
+  config.handlers.gerrit.url = "https://gerrit.example.com"
+  config.handlers.gerrit.username = "foo"
+  config.handlers.gerrit.password = "bar"
+end
+```
+
+## Usage
+
+### Chat functions
+
+```
+lita > gerrit 42
+gerrit: Display debug informations with correct log level by John Doe in chef. http://gerrit.example.com/42
+(gerrit: <commit message> by <author> in <project>. <url>)
+```
+
+### HTTP endpoints
+
+lita-gerrit listens for events triggered by Gerrit hooks. An example hook is provided in [contrib](https://github.com/josqu4red/lita-gerrit/tree/master/contrib) directory.
+
+Currently only these hooks are implemented:
+ * patchset_created
+ * comment_added
+ * change_merged
+
+See list of supported hooks in [Gerrit doc](https://gerrit-review.googlesource.com/Documentation/config-hooks.html)
+
+## 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/contrib/lita-gerrit-hook

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+#
+## Lita gerrit handler
+#
+# Usage:
+#
+#  Symlink this script to Gerrit hook folder ($GERRIT_HOME/hooks/<hook_name>)
+#  Where <hook_name> is one of the list https://gerrit-review.googlesource.com/Documentation/config-hooks.html#_supported_hooks
+#
+#  e.g  ln -s lita-gerrit-hook $GERRIT_HOME/hooks/patchset-created to enable that hook
+#
+
+require "rubygems"
+require "net/http"
+require "getoptlong"
+
+lita_url = "http://localhost:8080/gerrit/hooks"
+lita_room = "#my_chan"
+
+args = [
+  "CRVW", "VRID",
+  "abandoner", "author", "branch", "change", "change-url", "changer",
+  "cla-id", "comment", "commit", "is-draft", "new-topic", "newrev",
+  "old-topic", "oldrev", "patchset", "project", "reason", "refname",
+  "restorer", "reviewer", "submitter", "topic", "uploader", "user-id"
+]
+
+opts = GetoptLong.new(*args.map{ |arg| [ "--#{arg}", GetoptLong::REQUIRED_ARGUMENT] })
+
+options = {
+  "room" => lita_room,
+  "action" => File.basename($0)
+}
+
+opts.each do |opt, arg|
+  key = opt.gsub(/^--/, "")
+  options[key] = URI.encode(arg)
+end
+
+request = Net::HTTP.post_form(URI.parse(lita_url), options)

data/lib/lita-gerrit.rb

@@ -0,0 +1 @@
+require "lita/handlers/gerrit"

data/lib/lita/handlers/gerrit.rb

@@ -0,0 +1,103 @@
+require "lita"
+require "httparty"
+
+module Lita
+  module Handlers
+    class Gerrit < Handler
+
+      def self.default_config(config)
+        config.url = "https://gerrit.example.com"
+        config.username = "foo"
+        config.password = "bar"
+        config.default_room = nil
+      end
+
+      #
+      # Fetch details of a given patchset
+      #
+
+      route /gerrit\s+(\d+)/, :change_details, help: { "gerrit <change #>" => "Displays details of a gerrit change" }
+
+      def change_details(response)
+        change_id = response.matches.flatten.first
+        change_uri = URI.join(Lita.config.handlers.gerrit.url, "/a/changes/", change_id)
+        change_link = URI.join(Lita.config.handlers.gerrit.url, change_id)
+
+        http_resp = HTTParty.get(change_uri, :digest_auth => {
+          username: Lita.config.handlers.gerrit.username,
+          password: Lita.config.handlers.gerrit.password
+        })
+
+        case http_resp.code
+        when 200
+          change = MultiJson.load(http_resp.body.lines.to_a[1..-1].join)
+          message = "gerrit: #{change["subject"]} by #{change["owner"]["name"]} in #{change["project"]}. #{change_link}"
+        when 404
+          message = "Change ##{change_id} does not exist"
+        else
+          raise "Failed to fetch #{change_uri} (#{http_resp.code})"
+        end
+
+        response.reply(message)
+      rescue Exception => e
+        response.reply("Error: #{e.message}")
+      end
+
+      #
+      # Notify the creation/comment/merge/etc. of a Gerrit patchset
+      #
+
+      http.post "/gerrit/hooks", :hook
+
+      def hook(request, response)
+        if request.params.has_key?("action")
+          action = request.params["action"].gsub("-", "_").to_sym
+
+          unless respond_to?(action, true)
+            raise "Action #{action} is not supported by Gerrit handler"
+          end
+        else
+          raise "Action must be defined in hook's parameters"
+        end
+
+        if request.params.has_key?("room")
+          room = request.params["room"]
+        elsif Lita.config.handlers.gerrit.default_room
+          room = Lita.config.handlers.gerrit.default_room
+        else
+          raise "Room must be defined. Either fix your hook or specify a default room ('config.handlers.gerrit.default_room')"
+        end
+
+        # build message from action and params
+        message = send(action, request.params)
+        target = Source.new(room: room)
+
+        robot.send_message(target, message)
+      rescue Exception => e
+        Lita.logger.error(e.message)
+      end
+
+      private
+
+      # List of supported hooks
+      # (https://gerrit-review.googlesource.com/Documentation/config-hooks.html#_supported_hooks)
+
+      def patchset_created(params)
+        message = "gerrit: patchset %s has been uploaded by %s in %s. %s"
+        message % [params["patchset"], params["uploader"], params["project"], params["change-url"]]
+      end
+
+      def comment_added(params)
+        message = "gerrit(%s): %s commented %s (V:%s/CR:%s)"
+        message % [params["project"], params["author"], params["change-url"], params["verified"], params["reviewed"]]
+      end
+
+      def change_merged(params)
+        message = "gerrit: Merge of %s by %s in %s"
+        message % [params["change-url"], params["submitted"], params["project"]]
+      end
+    end
+
+    Lita.register_handler(Gerrit)
+  end
+end

data/lita-gerrit.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-gerrit"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jonathan Amiez"]
+  spec.email         = ["jonathan.amiez@gmail.com"]
+  spec.description   = "Gerrit API client and hook events handler"
+  spec.summary       = "Retrieve change status from chat and display events"
+  spec.homepage      = "https://github.com/josqu4red/lita-gerrit"
+  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.0"
+  spec.add_runtime_dependency "httparty", "~> 0.13.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0.beta2"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/spec/lita/handlers/gerrit_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+describe Lita::Handlers::Gerrit, lita_handler: true do
+
+  before do
+    Lita.configure do |config|
+      config.handlers.gerrit.url = "https://gerrit.example.com"
+      config.handlers.gerrit.username = "foo"
+      config.handlers.gerrit.password = "bar"
+    end
+  end
+
+  it { routes("get me gerrit 123, please").to(:change_details) }
+  it { doesnt_route("gerrit foo").to(:change_details) }
+
+  it { routes_http(:post, "/gerrit/hooks").to(:hook) }
+
+  describe "#change_details" do
+    let(:response) do
+      double("HTTParty::Response")
+    end
+
+    before do
+      allow(HTTParty).to receive(:get).and_return(response)
+    end
+
+    it "replies with the title and URL for the issue" do
+      allow(response).to receive(:code).and_return(200)
+
+      allow(response).to receive(:body).and_return(<<-JSON.chomp
+)]}'
+{
+  "kind": "gerritcodereview#change",
+  "id": "chef~master~Ib0b61ed3eebb8e22596a8401bf976949d798826a",
+  "project": "chef",
+  "branch": "master",
+  "topic": "beanstalk",
+  "change_id": "Ib0b61ed3eebb8e22596a8401bf976949d798826a",
+  "subject": "haproxy : migrate beanstalk frontend",
+  "status": "MERGED",
+  "created": "2014-03-14 12:42:15.320000000",
+  "updated": "2014-03-17 10:32:21.311000000",
+  "_sortkey": "002bcd180000096b",
+  "_number": 42,
+  "owner": {
+    "name": "John Doe"
+  }
+}
+JSON
+      )
+
+      send_command("gerrit 42")
+
+      expect(replies.last).to eq("gerrit: haproxy : migrate beanstalk frontend by John Doe in chef. https://gerrit.example.com/42")
+    end
+
+    it "replies that the issue doesn't exist" do
+      allow(response).to receive(:code).and_return(404)
+
+      send_command("gerrit 42")
+
+      expect(replies.last).to eq("Change #42 does not exist")
+    end
+
+    it "replies with an exception message" do
+      allow(response).to receive(:code).and_return(500)
+
+      send_command("gerrit 42")
+
+      expect(replies.last).to match("Error: Failed to fetch https://gerrit.example.com/a/changes/42 (500)")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter "/spec/" }
+
+require "lita-gerrit"
+require "lita/rspec"

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: lita-gerrit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Amiez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !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: 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.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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'
+description: Gerrit API client and hook events handler
+email:
+- jonathan.amiez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- contrib/lita-gerrit-hook
+- lib/lita-gerrit.rb
+- lib/lita/handlers/gerrit.rb
+- lita-gerrit.gemspec
+- spec/lita/handlers/gerrit_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/josqu4red/lita-gerrit
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Retrieve change status from chat and display events
+test_files:
+- spec/lita/handlers/gerrit_spec.rb
+- spec/spec_helper.rb