lita-github-commits 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d3af13c9629ccc9fef8b40294388070a79914b
-  data.tar.gz: be0c36a16d5170e34848a1bdadf798c25c1ce7f0
+  metadata.gz: 02a58dc021b14028fbff6758717f24cf1d732215
+  data.tar.gz: 226039126fb238d5e26f4f3dd437a798e848724e
 SHA512:
-  metadata.gz: 1a529b5a42050646669d629c6e40eb21e9e42af20a7e5366174dac88f8b66e01b1f4bea465bd3057a1936f30d23b568641733231bbaf294b819ab5a865009d9a
-  data.tar.gz: 8925a46036b47e8eef19264384b29939129cc43597d819239f5572a00e651497a77d86a92c96b5b8218d656702b08be39d65dc5697e74b06e283d71df5a20ac7
+  metadata.gz: 58a2748f1011214f1d13a9f400d6c768021c35d0c3856f2173c2e037bc3cecfa797b9c8306fbc4972090f110dbbdf756a1be9a903baa5b0cb9c48fa975106df8
+  data.tar.gz: 567cbfebcebcd971e236743b0833b5bb11d1dec9c6cba33f94649da3335b9c81d0cbdd1be406d5806b049be265037bbe759c8d505a31699fb299d973e617cff0

data/.gitignore

@@ -15,4 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.ruby-version
+.ruby-version
+*.sublime-*
+lita_config.rb

data/.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.2
-script: bundle exec rake
-before_install:
-  - gem update --system
+bundler_args: --binstubs
+script: bundle exec rake --trace
+#before_install:
+#  - gem update --system
 services:
   - redis-server

data/README.md

@@ -4,7 +4,7 @@
 [![Code Climate](https://codeclimate.com/github/webdestroya/lita-github-commits.png)](https://codeclimate.com/github/webdestroya/lita-github-commits)
 [![Coverage Status](https://coveralls.io/repos/webdestroya/lita-github-commits/badge.png)](https://coveralls.io/r/webdestroya/lita-github-commits)
 
-**lita-github-commits** is a handler for [Lita](https://github.com/jimmycuadra/lita) that listens for github commits and posts them in the channel.
+**lita-github-commits** is a handler for [Lita](https://github.com/jimmycuadra/lita) that listens for github commits and posts them in the channel.  You can also ask lita for information about a commit it remembers.
 
 ## Installation
 
@@ -18,16 +18,23 @@ gem "lita-github-commits"
 
 ### Required attributes
 
-* `repos` (Hash) - A map of repositories to allow notifications for and the chat rooms to post them in. The keys should be strings in the format "github_username/repository_name" and the values should be either a string room name or an array of string room names. Default: `{}`.
+* `repos` (Hash) - A map of repositories to allow notifications for and the chat rooms to post them in. The keys should be strings in the format "github_username/repository_name" and the values should be either a string room name or an array of string room names. If you do not wish to have notifications for a particular repository, set it's room array to "".  Default: `{}`.
 
-### Example
+* remember_commits_for (Integer) - Number of days lita will remember information about commits it as heard about.  Setting it to 0 effectively disables the "commit/SHA" command handling.  Default: 0 (no memory)
+
+* github_webhook_secret (String) - Optional secret that github uses to sign the webhook requests with.  Currently the configuration's presence only requires that the requests from GitHub be signed.  Default: nil (no signature required)
+
+### Example Config
 
 ``` ruby
 Lita.configure do |config|
   config.handlers.github_commits.repos = {
     "username/repo1" => "#someroom",
-    "username/repo2" => ["#someroom", "#someotherroom"]
+    "username/repo2" => ["#someroom", "#someotherroom"],
+    "username/muted_repo3" => ""
   }
+  config.handlers.github_commits.remember_commits_for = 7
+  config.handlers.github_commits.github_webhook_secret = "secr3tC0de"
 end
 ```
 
@@ -37,14 +44,22 @@ The output from Lita would look something like:
 
 ```
 [GitHub] Got 3 new commits from Garen Torikian on octokitty/testing on the master branch
-  * Test
-  * This is me testing the windows client.
-  * Rename madame-bovary.txt to words/madame-bovary.txt
+  * 32e3221: Test
+  * adc2112: This is me testing the windows client.
+  * 441ab6c: Rename madame-bovary.txt to words/madame-bovary.txt
 ```
 
 ## Usage
 
-You will need to add a GitHub Webhook url that points to: `http://address.of.lita/github-commits`
+You will need to add a [GitHub Webhook](https://developer.github.com/webhooks/) url that points to: `http://address.of.lita:8080/github-commits`
+
+In any room that Lita is listening, it will look for statements of the following form and provide the details of the commit if it remembers them.  If it doesn't remember the commit (or has heard about it), it will remain silent unless its a direct command.
+```
+... commit/<SHA1>...       - Search for a commit and return the details if found
+
+```
+
+Note that it only searches the commits that it has heard about and remembers so that the bot needs no more access to the repo than a webhook.
 
 ## License
 

data/lib/lita/handlers/github_commits.rb

@@ -1,19 +1,62 @@
 require "lita"
+require 'time'
 
 module Lita
   module Handlers
     class GithubCommits < Handler
+      template_root File.expand_path("../../../../templates", __FILE__)
 
+
+      #todo: change this to lita4 config http://docs.lita.io/releases/4/
+      # config :repos, type: Hash, default: {}
+      # config :remember_commits_for, type: Integer, default: 1
+      # config :github_webhook_secret, type: String, default: nil
+      
       def self.default_config(config)
         config.repos = {}
+        config.remember_commits_for = 1
+        config.github_webhook_secret = nil
       end
 
-      http.post "/github-commits", :receive
+      def self.install_routes()
+        http.post "/github-commits", :receive
+      end
+      install_routes()
+
+      REDIS_KEY_PREFIX = "GH_COMMTIS:"
+      SHA_ABBREV_LENGTH = 7  #note the regex below needs to match this constant
+      def self.install_commands
+        route(/commit\/([a-f0-9]{7,})\s?/i, :check_for_commit, command: false,
+              help: { "...commit/<SHA1>..." => "Displays the details of commit SHA1 if known (requires at least #{SHA_ABBREV_LENGTH} digits of the SHA)."}
+        )
+      end
+      install_commands
+
+      def check_for_commit(response)
+        sha = abbrev_sha(response.match_data[1])
+        if sha.nil? || sha.empty?
+          #this shouldn't match regex
+          response.reply("[GitHub] I need at least #{SHA_ABBREV_LENGTH} characters of the commit SHA") if response.message.command?
+        elsif sha.size <= 6 && response.message.command?
+          #this shouldn't match regex
+          response.reply("[GitHub] Can you be more precise?")
+        elsif  (commit=redis.get(REDIS_KEY_PREFIX + sha))
+          response.reply(render_template("commit_details", commit: parse_payload(commit)))
+        elsif response.message.command?
+          response.reply("[GitHub] Sorry Boss, I can't find that commit")
+        #else
+        #  response.reply("I got nothing to say about #{sha}.")
+        end
+      end
 
       def receive(request, response)
         event_type = request.env['HTTP_X_GITHUB_EVENT'] || 'unknown'
-        if event_type == "push"
-          payload = parse_payload(request.params['payload']) or return
+        Lita.logger.debug("Received GitHub #{event_type} event") rescue ""
+        if !valid_signature(request)
+          response.status = 404
+        elsif event_type == "push"
+          payload = parse_payload(request.body) or return
+          store_commits(payload)
           repo = get_repo(payload)
           notify_rooms(repo, payload)
         elsif event_type == "ping"
@@ -26,10 +69,24 @@ module Lita
 
       private
 
+      def valid_signature(request)
+        #not actually validating yet, just checking for presence of signature
+        #should look something like
+        #payload_body = request.body.read
+        #signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), config.github_webhook_secret, payload_body)
+        #Rack::Utils.secure_compare(signature, request.env['HTTP_X_HUB_SIGNATURE'])
+        if config.github_webhook_secret.nil? || config.github_webhook_secret.empty? || (request.env['HTTP_X_HUB_SIGNATURE'] && !request.env['HTTP_X_HUB_SIGNATURE'].empty?)
+          return true
+        else
+          Lita.logger.debug("Message sender validation failed") rescue ""
+          return false
+        end
+      end
+
       def parse_payload(payload)
         MultiJson.load(payload)
       rescue MultiJson::LoadError => e
-        Lita.logger.error("Could not parse JSON payload from Github: #{e.message}")
+        Lita.logger.warn("Could not parse JSON payload from Github: #{e.message}")
         return
       end
 
@@ -43,6 +100,18 @@ module Lita
         end
       end
 
+      def store_commits(payload)
+        ttl = remember_commits_for*86400
+        return if ttl == 0
+        commits = payload['commits']
+        branch = branch_from_ref(payload['ref'])
+        commits.each do |commit|
+          key = REDIS_KEY_PREFIX + commit['id'][0,SHA_ABBREV_LENGTH]
+          commit[:branch] = branch
+          redis.setex(key,ttl,commit.to_json)
+        end
+      end
+
       def format_message(payload)
         commits = payload['commits']
         branch = branch_from_ref(payload['ref'])
@@ -61,6 +130,10 @@ module Lita
         return
       end
 
+      def abbrev_sha(sha)
+        sha.nil? ? nil : sha[0,SHA_ABBREV_LENGTH]
+      end
+
       def branch_from_ref(ref)
         ref.split('/').last
       end
@@ -76,14 +149,14 @@ module Lita
 
       def commit_messages(commits)
         commits.collect do |commit|
-          "  * #{commit['message']}"
+          "  * #{abbrev_sha(commit['id'])}: #{commit['message']}"
         end
       end
 
       def rooms_for_repo(repo)
         rooms = Lita.config.handlers.github_commits.repos[repo]
 
-        if rooms
+        if rooms && rooms.size > 0 
           Array(rooms)
         else
           Lita.logger.warn "Notification from GitHub Commits for unconfigured project: #{repo}"
@@ -91,11 +164,13 @@ module Lita
         end
       end
 
-
       def get_repo(payload)
         "#{payload['repository']['owner']['name']}/#{payload['repository']['name']}"
       end
-
+      
+      def remember_commits_for
+        Lita.config.handlers.github_commits.remember_commits_for
+      end
     end
 
     Lita.register_handler(GithubCommits)

data/lita-github-commits.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-github-commits"
-  spec.version       = "0.2.0"
-  spec.authors       = ["Mitch Dempsey"]
-  spec.email         = ["mrdempsey@gmail.com"]
+  spec.version       = "0.2.5"
+  spec.authors       = ["Mitch Dempsey", "Steve Jernigan"]
+  spec.email         = ["mrdempsey@gmail.com","steve.jernigan@gmail.com"]
   spec.description   = %q{A Lita handler that will display GitHub commit messages in the channel}
   spec.summary       = %q{A Lita handler that will display GitHub commit messages in the channel}
   spec.homepage      = "https://github.com/webdestroya/lita-github-commits"

data/spec/lita/handlers/github_commits_spec.rb

@@ -23,7 +23,7 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
     context "request with commits" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
-        allow(params).to receive(:[]).with("payload").and_return(valid_payload)
+        allow(request).to receive(:body).and_return(valid_payload)
       end
 
       it "sends a notification message to the applicable rooms" do
@@ -31,12 +31,13 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
           expect(target.room).to eq("#baz")
           expect(message).to eq(<<-RESPONSE.chomp
 [GitHub] Got 3 new commits from Garen Torikian on octokitty/testing on the master branch
-  * Test
-  * This is me testing the windows client.
-  * Rename madame-bovary.txt to words/madame-bovary.txt
+  * c441029: Test
+  * 36c5f22: This is me testing the windows client.
+  * 1481a2d: Rename madame-bovary.txt to words/madame-bovary.txt
                                 RESPONSE
                                )
         end
+        expect(subject.redis).to receive(:setex).exactly(3).times
         subject.receive(request, response)
       end
     end
@@ -44,8 +45,8 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
     context "request with one commit" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
-        allow(params).to receive(:[]).with("payload").and_return(
-          valid_payload_one_commit)
+        Lita.config.handlers.github_commits.remember_commits_for = 1
+        allow(request).to receive(:body).and_return(valid_payload_one_commit)
       end
 
       it "sends a singular commit notification message to the applicable rooms" do
@@ -53,10 +54,58 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
           expect(target.room).to eq("#baz")
           expect(message).to eq(<<-RESPONSE.chomp
 [GitHub] Got 1 new commit from Garen Torikian on octokitty/testing on the master branch
-  * Test
+  * c441029: Test
                                 RESPONSE
                                )
         end
+        expect(subject.redis).to receive(:setex).once
+        subject.receive(request, response)
+      end
+
+      it "stores the message to redis with ttl" do
+        expect(subject.redis).to receive(:setex).once.with(Lita::Handlers::GithubCommits::REDIS_KEY_PREFIX + "c441029",86400,anything)
+        subject.receive(request, response)
+      end
+
+      it { is_expected.to route_command("zzcommit/1234567").to(:check_for_commit) }
+      it { is_expected.to route_command("abf commit/1234567").to(:check_for_commit) }
+      it { is_expected.to route_command("__commit/abcdef1?").to(:check_for_commit) }
+      it { is_expected.to_not route_command("commit/").to(:check_for_commit) }
+      it { is_expected.to_not route_command("commit/123456").to(:check_for_commit) }
+      it { is_expected.to_not route_command("commit/ornottocommit").to(:check_for_commit) }
+
+
+      it "stores the message to redis and can retrieve it from redis" do
+        subject.receive(request, response)
+        expect(subject.redis.ttl(Lita::Handlers::GithubCommits::REDIS_KEY_PREFIX + "c441029")).to be 
+        expect(subject.redis.get(Lita::Handlers::GithubCommits::REDIS_KEY_PREFIX + "c441029")).to eq first_commit.merge({:branch=>"master"}).to_json
+        expect(subject.redis.get(Lita::Handlers::GithubCommits::REDIS_KEY_PREFIX + "c44102")).to be nil
+      end
+    end
+
+    context "request without memory" do
+      before do
+        Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
+        Lita.config.handlers.github_commits.remember_commits_for = 0
+        allow(request).to receive(:body).and_return(valid_payload_one_commit)
+      end
+
+      it "stores does not store the message to redis" do
+        expect(subject.redis).to receive(:setex).never
+        subject.receive(request, response)
+      end
+    end
+
+    context "request with signature" do
+      before do
+        Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
+        Lita.config.handlers.github_commits.remember_commits_for = 1
+        Lita.config.handlers.github_commits.github_webhook_secret = "something"
+        allow(request).to receive(:body).and_return(valid_payload_one_commit)
+      end
+
+      it "stores does not store the message to redis" do
+        expect(subject.redis).to receive(:setex).never
         subject.receive(request, response)
       end
     end
@@ -64,16 +113,16 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
     context "request with commits" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
-        allow(params).to receive(:[]).with("payload").and_return(valid_payload_diff_committer)
+        allow(request).to receive(:body).and_return(valid_payload_diff_committer)
       end
 
       it "sends a notification message to the applicable rooms" do
         expect(robot).to receive(:send_message) do |target, message|
           expect(message).to eq(<<-RESPONSE.chomp
 [GitHub] Got 3 new commits authored by Garen Torikian and committed by Repository Owner on octokitty/testing on the master branch
-  * Test
-  * This is me testing the windows client.
-  * Rename madame-bovary.txt to words/madame-bovary.txt
+  * c441029: Test
+  * 36c5f22: This is me testing the windows client.
+  * 1481a2d: Rename madame-bovary.txt to words/madame-bovary.txt
                                 RESPONSE
                                )
         end
@@ -81,11 +130,42 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
       end
     end
 
+    context "request with commits on a repo with no room" do
+      before do
+        Lita.config.handlers.github_commits.repos["octokitty/testing"] = ""
+        allow(request).to receive(:body).and_return(valid_payload_diff_committer)
+      end
+
+      it "it should not send messages on webhook requests" do
+        expect(robot).not_to receive(:send_message) 
+        subject.receive(request, response)
+      end
+
+      it "it should respond to a previously unseen commit if its a command" do
+        send_command("stuff commit/36c5f2243ed24de5 stuff")
+        expect(replies).to include("[GitHub] Sorry Boss, I can't find that commit")
+      end
+
+      it "it should not respond to a previously unseen commit if its not a command" do
+        send_message("github commit/36c5f2243ed24de5")
+        expect(replies).to eq []
+      end
+
+      it "it should respond to a previously seen commit" do
+        subject.receive(request, response)
+        send_message("do you know about commit/36c5f2243ed24de5?")
+        expect(replies).to include(a_string_starting_with("[GitHub] Commit 36c5f22: This is me testing the windows client.")) 
+        #expect(replies).to include(a_string_starting_with("[GitHub] Commit 36c5f22 committed by Repository Owner on branch master at")) 
+        #expect(replies).to include(a_string_ending_with("Files Modified\n  README.md\n\nMore info https://github.com/octokitty/testing/commit/36c5f2243ed24de58284a96f2a643bed8c028658"))
+      end
+    end
+
 
     context "create payload" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
         allow(params).to receive(:[]).with("payload").and_return(created_payload)
+        allow(request).to receive(:body).and_return(created_payload)
       end
 
       it "sends a notification message to the applicable rooms" do
@@ -101,7 +181,7 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
     context "delete payload" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
-        allow(params).to receive(:[]).with("payload").and_return(deleted_payload)
+        allow(request).to receive(:body).and_return(deleted_payload)
       end
 
       it "sends a notification message to the applicable rooms" do
@@ -117,12 +197,12 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
     context "bad payload" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
-        allow(params).to receive(:[]).with("payload").and_return("yaryary")
+        allow(request).to receive(:body).and_return("yaryary")
       end
 
       it "sends a notification message to the applicable rooms" do
-        expect(Lita.logger).to receive(:error) do |error|
-          expect(error).to include("Could not parse JSON payload from Github")
+        expect(Lita.logger).to receive(:warn) do |warn|
+          expect(warn).to include("Could not parse JSON payload from Github")
         end
         subject.receive(request, response)
       end
@@ -132,7 +212,7 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
     context "ping event" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
-        allow(params).to receive(:[]).with("payload").and_return(ping_payload)
+        allow(request).to receive(:body).and_return(ping_payload)
         allow(request).to receive(:env).and_return({"HTTP_X_GITHUB_EVENT" => "ping"})
       end
 
@@ -146,7 +226,7 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
     context "unknown event" do
       before do
         Lita.config.handlers.github_commits.repos["octokitty/testing"] = "#baz"
-        allow(params).to receive(:[]).with("payload").and_return(ping_payload)
+        allow(request).to receive(:body).and_return(ping_payload)
         allow(request).to receive(:env).and_return({"HTTP_X_GITHUB_EVENT" => "fakefake"})
       end
 
@@ -160,7 +240,7 @@ describe Lita::Handlers::GithubCommits, lita_handler: true do
 
     context "improper config" do
       before do
-        allow(params).to receive(:[]).with("payload").and_return(deleted_payload)
+        allow(request).to receive(:body).and_return(deleted_payload)
       end
 
       it "sends a notification message to the applicable rooms" do

data/spec/lita/handlers/payload.rb

@@ -6,6 +6,11 @@ module Payload
     payload.to_json
   end
 
+  def first_commit
+    payload = MultiJson.load(valid_payload, symbolize_keys: true)
+    payload[:commits].first
+  end
+
   def valid_payload_diff_committer
     payload = MultiJson.load(valid_payload, symbolize_keys: true)
     payload[:commits] = payload[:commits].map do |commit|

data/spec/spec_helper.rb

@@ -9,4 +9,4 @@ SimpleCov.start { add_filter "/spec/" }
 require "lita-github-commits"
 require "lita/rspec"
 
-Lita.version_3_compatibility_mode = true
+Lita.version_3_compatibility_mode = true

data/templates/commit_details.erb

@@ -0,0 +1 @@
+[GitHub] Commit <%= @commit['id'][0,Lita::Handlers::GithubCommits::SHA_ABBREV_LENGTH]%>: <%=@commit['message']%>

data/templates/commit_details.hipchat.erb

@@ -0,0 +1,16 @@
+[GitHub] Commit <%= @commit['id'][0,Lita::Handlers::GithubCommits::SHA_ABBREV_LENGTH]%> committed by <%=@commit['committer'] ? @commit['committer']['name'] : "<unknown>"%> on branch <%=@commit['branch']%> at <%=Time.parse(@commit['timestamp']).getlocal.to_s%> with message
+  '<%=@commit['message']%>'
+<%if !@commit['added'].empty? %>
+Files Added
+  <%=@commit['added'].join("\n  ")%>
+<%end %>
+<%if !@commit['removed'].empty? %>
+Files Removed
+  <%=@commit['removed'].join("\n  ")%>
+<%end %>
+<%if !@commit['modified'].empty? %>
+Files Modified
+  <%=@commit['modified'].join("\n  ")%>
+<%end %>
+
+More info <%=@commit['url']%>

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lita-github-commits
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Mitch Dempsey
+- Steve Jernigan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-24 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -103,6 +104,7 @@ dependencies:
 description: A Lita handler that will display GitHub commit messages in the channel
 email:
 - mrdempsey@gmail.com
+- steve.jernigan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -119,6 +121,8 @@ files:
 - spec/lita/handlers/github_commits_spec.rb
 - spec/lita/handlers/payload.rb
 - spec/spec_helper.rb
+- templates/commit_details.erb
+- templates/commit_details.hipchat.erb
 homepage: https://github.com/webdestroya/lita-github-commits
 licenses:
 - MIT