lita-github 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83ef88d9ef27a589ab808c94f5acbee5c45890f3
-  data.tar.gz: 72f83141ec52828b41e684fce7a60371ef0f1270
+  metadata.gz: 96790f8b19467db1f1534304ce67a2129c90e9e8
+  data.tar.gz: 3b99912b047f352b94457b769967458f7e9b5cd2
 SHA512:
-  metadata.gz: 299cbb26470c5d2d99d3eaaf34bf61b5d5de8e88b6a0b701a24e09d02eb492b4e7db75e3642a729a4a6326f75635c4fe0c933a725ed1dfa1ad3c94c0c5ffca65
-  data.tar.gz: 3ca05325963bcc50abb0f39bb91f54acee4147699b513a3d06d272d4f8ed473b6d4d60292ab6b45877267387239a3c3ccb68b9833b9bba7710eaca892269f394
+  metadata.gz: 1f2e72eb7d50a462147e7266ba607727af6442a8c2aec2b6cdd10fa4b944acd942a33d895a9e8b53694a742eac2dad1f7cc9a3246242458bdea497577a67af15
+  data.tar.gz: b75bc26eeea1a9863fdda9102f5be53a7b2d719c5f2dc5fc117b66fb4f44cb86bbd3c0eff8fedf3186f8ebe79a37ce48eb11124635ec42fea34ca0f5b55ea4f5

data/README.md

@@ -25,9 +25,9 @@ The configuration options will get their own in-depth doc a little further down
 * `config.handlers.github.access_token = ''`
   * Your GitHUb access token (generated from Settings > Security > Personal Applications)
   * This is an administrative utility, so the token will need pretty wide access to leverage this plugin fully
-* `config.handlers.default_org = ''`
+* `config.handlers.github.default_org = ''`
   * Your company may only have one organization, the handler will allow you to type just the repo name (`lita-github`) instead of `PagerDuty/lita-github`.
-* `config.handlers.default_team_slug = ''`
+* `config.handlers.github.default_team_slug = ''`
   * the default team that should be added to a repo based on the slug name:
     * When clicking on a team in your org you can use the URL to get the slug: https://github.com/orgs/<ORG>/teams/[slug]
 
@@ -41,7 +41,22 @@ The command support two prefixes, assuming you have the `robot_alias` set to `!`
 
 Here is the current functionality:
 
+### GitHub Main Handler
+
 * `!gh status`
   * get the current system status for GitHub
 * `!gh version`
   * get the version of handler
+
+### GitHub Repository Handler
+* `!gh repo create PagerDuty/lita-github private:true team:<team_slug>`
+  * This creates a new repository, sets it to private, and adds the team you've specified.
+  * This method can be disabled by setting `config.handlers.github.repo_create_enabled = false` in your configuration file
+* `!gh repo delete PagerDuty/lita-github`
+  * Deletes the repo you specify, requires confirmation before doing so
+  * **Note:** This method is disabled by default, you need to enable it by setting `config.handlers.github.repo_delete_enabled = true` in your configuration file
+
+### Github PR Handler
+* `!gh pr merge #42 PagerDuty/lita-github` or `!shipit #42 PagerDuty/lita-github`
+  * This merges the specified pull request
+  * This method can be disabled by setting `config.handlers.github.pr_merge_enabled = false` in your configuration file

data/lib/lita-github.rb

@@ -23,3 +23,4 @@ Lita.load_locales Dir[File.expand_path(
 require 'lita-github/version'
 require 'lita/handlers/github'
 require 'lita/handlers/github_repo'
+require 'lita/handlers/github_pr'

data/lib/lita-github/version.rb

@@ -16,6 +16,6 @@
 
 # Administer your Hub of Gits with Lita!
 module LitaGithub
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   MAJ, MIN, REV = VERSION.split('.').map(&:to_i)
 end

data/lib/lita/handlers/github.rb

@@ -50,8 +50,18 @@ module Lita
       def self.default_config(config)
         # when setting default configuration values please remember one thing:
         # secure and safe by default
-        config.repo_delete_enabled = false
         config.repo_private_default = true
+
+        ####
+        # Method Filters
+        ####
+
+        # Lita::Handlers::GithubRepo
+        config.repo_create_enabled = true
+        config.repo_delete_enabled = false
+
+        # Lita::Handlers::GithubPR
+        config.pr_merge_enabled = true
       end
 
       def gh_status(response)

data/lib/lita/handlers/github_pr.rb

@@ -0,0 +1,96 @@
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2014 PagerDuty, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'lita-github/r'
+require 'lita-github/config'
+require 'lita-github/octo'
+require 'lita-github/org'
+require 'lita-github/repo'
+require 'lita-github/filters'
+
+module Lita
+  # Lita handler
+  module Handlers
+    # Handler class for GitHub PR management
+    class GithubPR < Handler
+      include LitaGithub::R       # Github handler common-use regex constants
+      include LitaGithub::Config  # Github handler Lita configuration methods
+      include LitaGithub::Octo    # Github handler common-use Octokit methods
+      include LitaGithub::Org     # Github handler common-use Organization methods
+      include LitaGithub::Repo    # Github handler common-use Repository methods
+      include LitaGithub::Filters # Github handler common-use method filters
+
+      on :loaded, :setup_octo # from LitaGithub::Octo
+
+      route(
+        /(?:#{LitaGithub::R::A_REG}(?:pr merge|shipit)|shipit)\s+?#(?<pr>\d+?)\s+?#{LitaGithub::R::REPO_REGEX}/,
+        :pr_merge, command: true, confirmation: true,
+        help: {
+          'gh shipit #42 PagerDuty/lita-github' => 'ship it!',
+          'gh pr merge #42 PagerDuty/lita-github' => 'ship it!',
+          'shipit #42 PagerDuty/lita-github' => 'ship it!'
+        }
+      )
+
+      def pr_merge(response)
+        return response.reply(t('method_disabled')) if func_disabled?(__method__)
+        org, repo, pr = pr_match(response)
+
+        begin
+          pr_obj = octo.pull_request(rpo(org, repo), pr)
+        rescue Octokit::NotFound
+          return response.reply(t('not_found', pr: pr, org: org, repo: repo))
+        end
+
+        branch = pr_obj[:head][:ref]
+        title = pr_obj[:title]
+        commit = "Merge pull request ##{pr} from #{org}/#{branch}\n\n#{title}"
+
+        status = merge_pr(org, repo, pr, commit)
+
+        if !defined?(status) || status.nil?
+          response.reply(t('exception'))
+        elsif status[:merged]
+          response.reply(t('pr_merge.pass', pr: pr, org: org, branch: branch, title: title))
+        else
+          url = "https://github.com/#{org}/#{repo}/pull/#{pr}"
+          response.reply(t('pr_merge.fail', pr: pr, title: title, url: url, msg: status[:message]))
+        end
+      end
+
+      private
+
+      def pr_match(response)
+        md = response.match_data
+        [organization(md['org']), md['repo'], md['pr']]
+      end
+
+      def merge_pr(org, repo, pr, commit)
+        status = nil
+        # rubocop:disable Lint/HandleExceptions
+        begin
+          status = octo.merge_pull_request(rpo(org, repo), pr, commit)
+        rescue StandardError
+          # no-op
+        end
+        # rubocop:enable Lint/HandleExceptions
+        status
+      end
+    end
+
+    Lita.register_handler(GithubPR)
+  end
+end

data/lib/lita/handlers/github_repo.rb

@@ -64,6 +64,8 @@ module Lita
       )
 
       def repo_create(response)
+        return response.reply(t('method_disabled')) if func_disabled?(__method__)
+
         org, repo = repo_match(response)
 
         if repo?(rpo(org, repo))

data/locales/en.yml

@@ -7,7 +7,7 @@ en:
           minor: "GitHub is reporting minor issues (status:yellow)! Last message:\n%{created_on} :: %{body}"
           major: "GitHub is reporting major issues (status:red)! Last message:\n%{created_on} :: %{body}"
       github_repo:
-        method_disabled: "Sorry, this function has been disabled in the config"
+        method_disabled: "Sorry, this function has either been disabled or not enabled in the config"
         repo_create:
           pass: "Created %{org}/%{repo}: %{repo_url}"
           fail: "Unable to create %{org}/%{repo}"
@@ -19,6 +19,9 @@ en:
         repo_info:
           reply: "%{repo} (private:%{private}) :: %{url}\nDesc: %{description}\nIssues: %{issues_count} PRs: %{pr_count}"
       github_pr:
-        repo_merge:
+        method_disabled: "Sorry, this function has either been disabled or not enabled in the config"
+        exception: "An unexpected exception was hit during the GitHub API operation. Please make sure all arguments are proper and try again, or try checking the GitHub status (gh status)"
+        not_found: "Pull request #%{pr} on %{org}/%{repo} not found"
+        pr_merge:
           pass: "Merged pull request #%{pr} from %{org}/%{branch}\n%{title}"
-          fail: "Failed trying to merge PR #%{pr} (%{title}) :: %{url}"
+          fail: "Failed trying to merge PR #%{pr} (%{title}) :: %{url}\nMessage: %{msg}"

data/spec/unit/lita/handlers/github_pr_spec.rb

@@ -0,0 +1,134 @@
+# -*- coding: UTF-8 -*-
+
+require 'spec_helper'
+
+describe Lita::Handlers::GithubPR, lita_handler: true do
+  it { routes_command('gh shipit #42 GrapeDuty/lita-test').to(:pr_merge) }
+  it { routes_command('gh pr merge #42 GrapeDuty/lita-test').to(:pr_merge) }
+  it { routes_command('shipit #42 GrapeDuty/lita-test').to(:pr_merge) }
+
+  let(:github_pr) { Lita::Handlers::GithubPR.new('robot') }
+  let(:github_org) { 'GrapeDuty' }
+  let(:github_repo) { 'lita-test' }
+  let(:disabled_reply) { 'Sorry, this function has either been disabled or not enabled in the config' }
+
+  describe '.pr_match' do
+    it 'should return the content of the match data' do
+      mock_md = { 'org' => github_org, 'repo' => github_repo, 'pr' => 42 }
+      mock_resp = double('Lita::Response', match_data: mock_md)
+      expect(github_pr.send(:pr_match, mock_resp)).to eql [github_org, github_repo, 42]
+    end
+  end
+
+  describe '.merge_pr' do
+    before do
+      @merge_status = { sha: 'abc456', merged: true, message: 'Pull Request successfully merged' }
+      @octo_obj = double('Octokit::Client', merge_pull_request: @merge_status)
+      allow(github_pr).to receive(:octo).and_return(@octo_obj)
+    end
+
+    context 'when all goes well' do
+      it 'should return the response from trying to merge' do
+        expect(github_pr.send(:merge_pr, github_org, github_repo, '42', 'test commit'))
+          .to eql @merge_status
+      end
+    end
+
+    context 'when we hit an exception' do
+      before do
+        @merge_status = { sha: 'abc456', merged: false, message: '*BOOM*' }
+        @octo_obj = double('Octokit::Client')
+        allow(@octo_obj).to receive(:merge_pull_request).and_raise(StandardError.new)
+        allow(github_pr).to receive(:octo).and_return(@octo_obj)
+      end
+
+      it 'should return nil' do
+        expect(github_pr.send(:merge_pr, github_org, github_repo, 42, 'test commit'))
+          .to be_nil
+      end
+    end
+  end
+
+  describe '.pr_merge' do
+    before do
+      @cfg_obj = double('Lita::Configuration', pr_merge_enabled: true)
+      @pr_obj =  { head: { ref: 'fix-some-bugs' }, title: 'fix bug' }
+      @merge_status = { sha: 'abc456', merged: true, message: 'Pull Request successfully merged' }
+      @octo_obj = double('Octokit::Client', pull_request: @pr_obj)
+      allow(github_pr).to receive(:octo).and_return(@octo_obj)
+      allow(github_pr).to receive(:func_disabled?).and_return(false)
+      allow(github_pr).to receive(:config).and_return(@cfg_obj)
+      allow(github_pr).to receive(:merge_pr).and_return(@merge_status)
+    end
+
+    context 'when command disabled' do
+      before do
+        allow(github_pr).to receive(:func_disabled?).and_return(true)
+      end
+
+      it 'should no-op and say such if the command is disabled' do
+        send_command("shipit #42 #{github_org}/#{github_repo}")
+        expect(replies.last).to eql disabled_reply
+      end
+    end
+
+    context 'when repo not found' do
+      before do
+        allow(@octo_obj).to receive(:pull_request).and_raise(Octokit::NotFound.new)
+      end
+
+      it 'should reply indicating it was invalid' do
+        send_command("shipit #42 #{github_org}/#{github_repo}")
+        expect(replies.last).to eql 'Pull request #42 on GrapeDuty/lita-test not found'
+      end
+    end
+
+    context 'when merging should succeed' do
+      it 'should set the right commit message' do
+        expect(github_pr).to receive(:merge_pr).with(
+          'GrapeDuty', 'lita-test', '42', "Merge pull request #42 from GrapeDuty/fix-some-bugs\n\nfix bug"
+        )
+        send_command('shipit #42 GrapeDuty/lita-test')
+      end
+
+      it 'should confirm merging of PR' do
+        send_command("shipit #42 #{github_org}/#{github_repo}")
+        expect(replies.last)
+          .to eql "Merged pull request #42 from GrapeDuty/fix-some-bugs\nfix bug"
+      end
+    end
+
+    context 'when merging bombs' do
+      before do
+        @merge_status = { sha: 'abc456', merged: false, message: '*BOOM*' }
+        allow(github_pr).to receive(:merge_pr).and_return(@merge_status)
+      end
+
+      it 'should confirm the failure' do
+        send_command("shipit #42 #{github_org}/#{github_repo}")
+        expect(replies.last)
+          .to eql(
+            "Failed trying to merge PR #42 (fix bug) :: https://github.com/GrapeDuty/lita-test/pull/42\n"\
+              'Message: *BOOM*'
+          )
+      end
+    end
+
+    context 'when the API request explodes' do
+      before do
+        @merge_status = { sha: 'abc456', merged: false, message: '*BOOM*' }
+        @octo_obj = double('Octokit::Client', pull_request: @pr_obj)
+        allow(github_pr).to receive(:merge_pr).and_return(nil)
+      end
+
+      it 'should confirm the failure' do
+        send_command("shipit #42 #{github_org}/#{github_repo}")
+        expect(replies.last)
+          .to eql(
+            'An unexpected exception was hit during the GitHub API operation. Please make sure all ' \
+              'arguments are proper and try again, or try checking the GitHub status (gh status)'
+          )
+      end
+    end
+  end
+end

data/spec/unit/lita/handlers/github_repo_spec.rb

@@ -34,7 +34,7 @@ describe Lita::Handlers::GithubRepo, lita_handler: true do
 
   let(:github_repo) { Lita::Handlers::GithubRepo.new('robot') }
   let(:github_org) { 'GrapeDuty' }
-  let(:disabled_reply) { 'Sorry, this function has been disabled in the config' }
+  let(:disabled_reply) { 'Sorry, this function has either been disabled or not enabled in the config' }
 
   ####
   # Helper Methods
@@ -295,11 +295,23 @@ describe Lita::Handlers::GithubRepo, lita_handler: true do
   describe '.repo_create' do
     before do
       @opts = { private: true, team_id: 42, organization: github_org }
+      allow(github_repo).to receive(:func_disabled?).and_return(false)
       allow(github_repo).to receive(:repo?).with("#{github_org}/lita-test").and_return(false)
       allow(github_repo).to receive(:extrapolate_create_opts).and_return(@opts)
       allow(github_repo).to receive(:create_repo).and_return('hello from PAX prime!')
     end
 
+    context 'when command disabled' do
+      before do
+        allow(github_repo).to receive(:func_disabled?).and_return(true)
+      end
+
+      it 'should no-op and say such if the command is disabled' do
+        send_command("gh repo create #{github_org}/lita-test")
+        expect(replies.last).to eql disabled_reply
+      end
+    end
+
     context 'when repo already exists' do
       before do
         allow(github_repo).to receive(:repo?).with("#{github_org}/lita-test").and_return(true)

data/spec/unit/lita/handlers/github_spec.rb

@@ -24,12 +24,20 @@ describe Lita::Handlers::Github, lita_handler: true do
   it { routes_command('gh version').to(:gh_version) }
 
   describe '#default_config' do
-    it 'should disable repo_delete by default' do
+    it 'should set repos to private by default' do
+      expect(Lita.config.handlers.github.repo_private_default).to be_truthy
+    end
+
+    it 'should enable Lita::Handlers::GithubRepo.repo_create by default' do
+      expect(Lita.config.handlers.github.repo_create_enabled).to be_truthy
+    end
+
+    it 'should disable Lita::Handlers::GithubRepo.repo_delete by default' do
       expect(Lita.config.handlers.github.repo_delete_enabled).to be_falsey
     end
 
-    it 'should set repos to private by default' do
-      expect(Lita.config.handlers.github.repo_private_default).to be_truthy
+    it 'should enable Lita::Handlers::GithubPR.pr_merge by default' do
+      expect(Lita.config.handlers.github.pr_merge_enabled).to be_truthy
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-github
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tim Heckman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,6 +166,7 @@ files:
 - lib/lita-github/repo.rb
 - lib/lita-github/version.rb
 - lib/lita/handlers/github.rb
+- lib/lita/handlers/github_pr.rb
 - lib/lita/handlers/github_repo.rb
 - lita-github.gemspec
 - locales/en.yml
@@ -177,6 +178,7 @@ files:
 - spec/unit/lita-github/r_spec.rb
 - spec/unit/lita-github/repo_spec.rb
 - spec/unit/lita-github/version_spec.rb
+- spec/unit/lita/handlers/github_pr_spec.rb
 - spec/unit/lita/handlers/github_repo_spec.rb
 - spec/unit/lita/handlers/github_spec.rb
 homepage: https://github.com/PagerDuty/lita-github
@@ -213,5 +215,6 @@ test_files:
 - spec/unit/lita-github/r_spec.rb
 - spec/unit/lita-github/repo_spec.rb
 - spec/unit/lita-github/version_spec.rb
+- spec/unit/lita/handlers/github_pr_spec.rb
 - spec/unit/lita/handlers/github_repo_spec.rb
 - spec/unit/lita/handlers/github_spec.rb