lita-github 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0349ebd1948d263860af6b90c1a24447a6408aea
-  data.tar.gz: a4e1279c91922ce93c18519701a91dca1f2ce76e
+  metadata.gz: 2012ebdeed7b0904f7d65cb1d1da4fe0988a031b
+  data.tar.gz: f8f82d62bd1e38ab05156f65b8ec159ae265b98b
 SHA512:
-  metadata.gz: 19e4723298203e74eb221818523164fa6e54d7e2c4d92bbf6474c1f7cbb8c7751c2c457f2752780957bebbd28a3c221445477140363775dedd6210b71912f504
-  data.tar.gz: 2d3b335bfa654197c4118bdd77b1d91e596e62b6701936dac401b692dab8ef5f8f79bc0c106d1c2be25d97a73cfdc938e6c603573dbfcb532763cd3dd8cb4504
+  metadata.gz: 9c74417471b025d45253f622a97e054e1cfa49a0fabbf55879c9b14b45d9293b414407e62c1d357d40a16a66817616831143d725665e9a720ba8472775d8dae5
+  data.tar.gz: bfba8e8cb4ea94d8b6164c5489bcb3d4624be502f28b2a8a1a357ce6289f7b3559da6567647685ac6b592dec74d1a73d505cb4002b1313716a3100e27f78afe3

data/lib/lita-github.rb

@@ -25,3 +25,4 @@ require 'lita/handlers/github'
 require 'lita/handlers/github_repo'
 require 'lita/handlers/github_pr'
 require 'lita/handlers/github_org'
+require 'lita/handlers/github_issues'

data/lib/lita-github/general.rb

@@ -21,31 +21,37 @@ module LitaGithub
   #
   # @author Tim Heckman <tim@pagerduty.com>
   module General
-    # Parse the options in the command using the standard option regex
+    # Convert the value of parameter 1 to an Integer if it looks like it should be one
     #
     # @author Tim Heckman <tim@pagerduty.com>
-    # @param cmd [String] the full command line provided to Lita
-    # @return [Hash] the key:value pairs that were in the command string
-    def opts_parse(cmd)
-      o = {}
-      cmd.scan(LitaGithub::R::OPT_REGEX).flatten.each do |opt|
-        k, v = opt.strip.split(':')
-        k = k.to_sym
-        o[k] = v unless o.key?(k)
-      end
-      o
+    # @param value [String] the value to see if it should be an Integer
+    # @return [Integer] if the String <tt>value</tt> looks like an Integer (<tt>/^\d+$/</tt>), return it as one
+    # @return [String] if the String <tt>value</tt> is not an Integer, return as is
+    def to_i_if_numeric(value)
+      /^\d+$/.match(value) ? value.to_i : value
     end
 
-    # Parse the options in the command using the extended option regex
+    # For use when parsing options using <tt>opt_parse()</tt>, this method converts the key to a downcased symbol
+    # for use within the option Hash.
+    #
+    # @author Tim Heckman <tim@pagerduty.com>
+    # @param k [String] the key
+    # @param v [Any] the value
+    # @return [Array] the first element is <tt>key</tt> as a downcased symbol, the second is <tt>v</tt> with no changes
+    def symbolize_opt_key(k, v)
+      [k.downcase.to_sym, v]
+    end
+
+    # Parse the options in the command using the option regex
     #
     # @author Tim Heckman <tim@pagerduty.com>
     # @param cmd [String] the full command line provided to Lita
     # @return [Hash] the key:value pairs that were in the command string
-    def e_opts_parse(cmd)
+    def opts_parse(cmd)
       o = {}
-      cmd.scan(LitaGithub::R::E_OPT_REGEX).flatten.each do |opt|
-        k, v = opt.strip.split(':')
-        k = k.to_sym
+      cmd.scan(LitaGithub::R::OPT_REGEX).flatten.each do |opt|
+        k, v = symbolize_opt_key(*opt.strip.split(':'))
+        next if o.key?(k)
 
         # if it looks like we're using the extended option (first character is a " or '):
         #   slice off the first and last character of the string
@@ -53,7 +59,7 @@ module LitaGithub
         #   do nothing
         v = v.slice!(1, (v.length - 2)) if %w(' ").include?(v.slice(0))
 
-        o[k] = v unless o.key?(k)
+        o[k] = to_i_if_numeric(v)
       end
       o
     end

data/lib/lita-github/r.rb

@@ -22,13 +22,9 @@ module LitaGithub
     # command alias regex (!gh or !github for example)
     A_REG     ||= '(?:gh|github)\s+?'
 
-    # option regex, letting you scan the command string of things like:
-    # key1:value key2:value, etc.
-    OPT_REGEX ||= /((?:\s+?[a-zA-Z0-9_]+?):(?:[a-zA-Z0-9_]+))/
-
-    # extended option regex, letting you scan the string for things like:
+    # option regex, letting you scan the string for things like:
     #  key1:value key2:"value2" key3:'a better value'
-    E_OPT_REGEX ||= /((?:\s+?[a-zA-Z0-9_]+?):(?:(?:".+?")|(?:'.+?')|(?:[a-zA-Z0-9_]+)))/
+    OPT_REGEX ||= /((?:\s+?[a-zA-Z0-9_]+?):(?:(?:".+?")|(?:'.+?')|(?:[a-zA-Z0-9_]+)))/
 
     # regex matcher for: Org/repo
     REPO_REGEX = '(?:(?<org>[a-zA-Z0-9_\-]+)(?:\s+?)?\/)?(?:\s+?)?(?<repo>[a-zA-Z0-9_\-]+)'

data/lib/lita-github/version.rb

@@ -21,8 +21,8 @@
 # @author Tim Heckman <tim@pagerduty.com>
 module LitaGithub
   # lita-github version
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 
   # lita-github version split amongst different revisions
-  MAJ, MIN, REV = VERSION.split('.').map(&:to_i)
+  MAJOR_VERSION, MINOR_VERSION, REVISION = VERSION.split('.').map(&:to_i)
 end

data/lib/lita/handlers/github.rb

@@ -68,8 +68,9 @@ module Lita
       def self.default_config(config)
         # when setting default configuration values please remember one thing:
         # secure and safe by default
-        config.default_team_slug    = nil
-        config.repo_private_default = true
+        config.default_team_slug          = nil
+        config.repo_private_default       = true
+        config.org_team_add_allowed_perms = %w(pull)
 
         ####
         # Method Filters
@@ -92,7 +93,9 @@ module Lita
         # Lita::Handlers::GithubOrg
         config.org_team_add_enabled       = false
         config.org_team_rm_enabled        = false
-        config.org_team_add_allowed_perms = %w(pull)
+        config.org_user_add_enabled       = false
+        config.org_user_rm_enabled        = false
+        config.org_eject_user_enabled     = false
       end
 
       def status(response)

data/lib/lita/handlers/github_issues.rb

@@ -0,0 +1,110 @@
+# -*- 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/general'
+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
+    # GitHub Issues Lita Handler
+    class GithubIssues < Handler
+      include LitaGithub::General # Github handler common-use methods
+      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
+
+      # issue states
+      LI_STATES = %w(open closed all)
+      # issue states
+      LI_SM     = %w(created updated comments)
+      # sort direction
+      LI_DIR    = %w(asc desc)
+
+      route(
+        /#{LitaGithub::R::A_REG}(?:issues|repo\s+?issues)\s+?#{LitaGithub::R::REPO_REGEX}/,
+        :issues_list,
+        command: true,
+        help: {
+          'gh issues PagerDuty/lita-github' => 'list the issues on a repo',
+          'gh issues PagerDuty/lita-github state:closed sort:updated sort:desc' => 'just showing some option usage'
+        }
+      )
+
+      # This is the handler for listing issues on a repository
+      # @author Tim Heckman <tim@pagerduty.com>
+      def issues_list(response)
+        full_name = rpo(*repo_match(response.match_data))
+        opts = opts_parse(response.message.body)
+
+        oops = validate_list_opts(opts)
+
+        return response.reply(oops) unless oops.empty?
+
+        return response.reply(t('repo_not_found', repo: full_name)) unless repo?(full_name)
+
+        # get the issues that are not pull requests
+        begin
+          issues = octo.list_issues(full_name, opts).reject { |i| i.key?(:pull_request) }
+        rescue Octokit::UnprocessableEntity => e
+          return response.reply(t('issues_list.invalid_opts', m: e.message))
+        rescue StandardError => e
+          return response.reply(t('boom', m: e.message))
+        end
+
+        if issues.empty?
+          reply = t('issues_list.none', r: full_name)
+        else
+          reply = t('issues_list.header', n: issues.length, r: full_name)
+          issues.each { |i| reply << t('issues_list.item',  i.to_h.merge(u: i[:user][:login], r: full_name)) }
+        end
+
+        response.reply(reply)
+      end
+
+      private
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      #
+      # Validate the command options
+      #
+      # @param opts [Hash] the key:value pairs from the command
+      # @return [String] the response to reply with if there was a validation failure
+      def validate_list_opts(opts)
+        resp = ''
+        resp << t('issues_list.val_states') if opts.key?(:state) && !LI_STATES.include?(opts[:state])
+        resp << t('issues_list.val_sort') if opts.key?(:sort) && !LI_SM.include?(opts[:sort])
+        resp << t('issues_list.val_direction') if opts.key?(:direction) && !LI_DIR.include?(opts[:direction])
+        resp = "Invalid option(s):\n#{resp}" unless resp.empty?
+        resp
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+    end
+
+    Lita.register_handler(GithubIssues)
+  end
+end

data/lib/lita/handlers/github_org.rb

@@ -68,6 +68,42 @@ module Lita
         }
       )
 
+      # rubocop:disable Metrics/LineLength
+      route(
+        /#{LitaGithub::R::A_REG}org\s+?user\s+?add(?<org>\s+?[a-zA-Z0-9_\-]+)?(?<team>\s?[a-zA-Z0-9_\-]+)\s+?(?<username>[a-zA-Z0-9_\-]+)/,
+        :org_user_add,
+        command: true,
+        # confirmation: { allow_self: false },
+        help: {
+          'gh org user add PagerDuty everyone theckman' => 'add the user theckman to the PagerDuty/everyone team -- this requires confirmation from another user. NOTE: This will add the member to the organization if they are not already!!',
+          'gh org user add PagerDuty 42 theckman' => "same as above, except with the team's ID instead of the slug"
+        }
+      )
+
+      route(
+        /#{LitaGithub::R::A_REG}org\s+?user\s+?rm(?<org>\s+?[a-zA-Z0-9_\-]+)?(?<team>\s?[a-zA-Z0-9_\-]+)\s+?(?<username>[a-zA-Z0-9_\-]+)/,
+        :org_user_rm,
+        comamnd: true,
+        # confirmation: { allow_self: false },
+        help: {
+          'gh org team rm PagerDuty everyone theckman' => 'remove the user theckman from the PagerDuty/everyone team, if this is their last team will remove them from the org. Requires confirmation from another user.',
+          'gh org team rm PagerDuty 42 theckman' => "same as above, except with the team's ID instead of the slug"
+        }
+      )
+      # rubocop:enable Metrics/LineLength
+
+      route(
+        /#{LitaGithub::R::A_REG}org\s+?eject(?<org>\s+?[a-zA-Z0-9_\-]+)?(?<username>\s+?[a-zA-Z0-9_\-]+)/,
+        :org_eject_user,
+        command: true,
+        # confirmation: { allow_self: false },
+        help: {
+          'gh org eject PagerDuty theckman' => 'forcibly removes the user from all groups in the organization -- ' \
+                                               'this is meant for someone leaving the organization. Requires ' \
+                                               'confirmation from another user.'
+        }
+      )
+
       def org_teams_list(response)
         md = response.match_data
         org = md[:org].nil? ? config.default_org : organization(md[:org].strip)
@@ -93,7 +129,7 @@ module Lita
       def org_team_add(response)
         return response.reply(t('method_disabled')) if func_disabled?(__method__)
 
-        opts = e_opts_parse(response.message.body)
+        opts = opts_parse(response.message.body)
         vo = validate_team_add_opts(opts)
         return response.reply(vo[:msg]) unless vo[:success]
 
@@ -131,6 +167,101 @@ module Lita
         end
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def org_user_add(response)
+        return response.reply(t('method_disabled')) if func_disabled?(__method__)
+
+        md = response.match_data
+        org, team, username = [organization(md['org'].strip), md['team'].strip, md['username']]
+
+        begin
+          user_id = octo.user(username)[:id]
+        rescue Octokit::NotFound
+          return response.reply(t('user_not_found', n: username))
+        end
+
+        return response.reply(t('nope')) if octo.user[:id] == user_id
+
+        begin
+          team_obj = octo.team(team_id(team, org))
+        rescue Octokit::NotFound
+          return response.reply(t('team_not_found', team: team))
+        end
+
+        begin
+          resp = octo.add_team_membership(team_obj[:id], username)
+        rescue StandardError => e
+          return response.reply(t('boom', m: e.message))
+        end
+
+        if resp
+          response.reply(t('org_user_add.added', u: username, o: org, t: team_obj[:name], s: team_obj[:slug]))
+        else
+          response.reply(t('org_user_add.failed', t: team_obj[:name]))
+        end
+      end
+
+      def org_user_rm(response)
+        return response.reply(t('method_disabled')) if func_disabled?(__method__)
+        md = response.match_data
+        org, team, username = [organization(md['org'].strip), md['team'].strip, md['username']]
+
+        begin
+          user_id = octo.user(username)[:id]
+        rescue Octokit::NotFound
+          return response.reply(t('user_not_found', n: username))
+        end
+
+        return response.reply(t('nope')) if octo.user[:id] == user_id
+
+        begin
+          team = octo.team(team_id(team, org))
+        rescue Octokit::NotFound
+          return response.reply(t('team_not_found', team: team))
+        end
+
+        begin
+          resp = octo.remove_team_member(team[:id], username)
+        rescue StandardError => e
+          return response.reply(t('boom', m: e.message))
+        end
+
+        if resp
+          response.reply(t('org_user_rm.removed', u: username, o: org, t: team[:name], s: team[:slug]))
+        else
+          response.reply(t('org_user_rm.failed'), t: team[:name])
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def org_eject_user(response)
+        return response.reply(t('method_disabled')) if func_disabled?(__method__)
+        md = response.match_data
+        org, username = [organization(md['org'].strip), md['username'].strip]
+
+        begin
+          user_id = octo.user(username)[:id]
+        rescue Octokit::NotFound
+          return response.reply(t('user_not_found', n: username))
+        end
+
+        return response.reply(t('nope')) if octo.user[:id] == user_id
+
+        begin
+          resp = octo.remove_organization_member(org, username)
+        rescue StandardError => e
+          return response.reply(t('boom', m: e.message))
+        end
+
+        if resp
+          response.reply(t('org_eject_user.ejected', user: username, org: org))
+        else
+          response.reply(t('org_eject_user.failed'))
+        end
+      end
+
       private
 
       def validate_team_add_opts(opts)

data/lib/lita/handlers/github_pr.rb

@@ -216,7 +216,7 @@ module Lita
       end
 
       def list_line(pr, full_name)
-        t('pr_info.header', build_pr_header!({}, pr).merge(repo: full_name))
+        t('pr_info.header_long', build_pr_header!({}, pr).merge(repo: full_name, u: pr[:user][:login]))
       end
     end
 

data/locales/en.yml

@@ -17,7 +17,7 @@ en:
           company: "Company: %{c}\n"
           location: "Located: %{l}\n"
           account_info: "GitHub Admin: %{site_admin}, Repos: %{public_repos}, Gists: %{public_gists}\n"
-          user_info: "Following: %{following}, Followers: %{followers}, Created: %{created_at}"
+          user_info: "Following: %{following}, Followers: %{followers}, Joined: %{created_at}"
       github_repo:
         method_disabled: "Sorry, this function has either been disabled or not enabled in the config"
         not_found: "That repo (%{org}/%{repo}) was not found"
@@ -55,7 +55,8 @@ en:
         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_info:
-          header: "%{repo} #%{number}: %{title} :: %{url}\n"
+          header: "%{repo} #%{number}: '%{title}' :: %{url}\n"
+          header_long: "%{repo} #%{number}: '%{title}' opened by %{u} :: %{url}\n"
           status: "Opened By: %{user} | State: %{state_str} | Build: %{build_status}"
           merged: " | Merged By: %{merged_by}\n"
           mergeable: " | Mergeable: %{mergeable}\n"
@@ -71,6 +72,9 @@ en:
         method_disabled: "Sorry, this function has either been disabled or not enabled in the config"
         org_not_found: "The organization '%{org}' was not found. Does my user have ownership perms?"
         team_not_found: "Unable to match any teams based on: %{team}"
+        user_not_found: "Unable to find the GitHub user %{n}"
+        nope: "No...\n\nಠ_ಠ"
+        boom: "I had a problem :( ... %{m}"
         org_teams_list:
           header: "Showing %{num_teams} team(s) for %{org}:\n"
           team: "Name: %{name}, Slug: %{slug}, ID: %{id}, Perms: %{permission}\n"
@@ -82,3 +86,23 @@ en:
         org_team_rm:
           pass: "The '%{name}' team was deleted. Its ID was %{id}"
           fail: "Something went wrong trying to delete the '%{name}' team. Is Github having issues?"
+        org_eject_user:
+          ejected: "Ejected %{user} out of %{org}"
+          failed: "Failed to eject the user from the organization for an unknown reason"
+        org_user_rm:
+          removed: "%{u} has been removed from the '%{o}/%{t}' (%{s}) team"
+          failed: "Failed to remove the user from the '%{t}' team for some unknown reason"
+        org_user_add:
+          added: "%{u} has been added to the '%{o}/%{t}' (%{s}) team"
+          failed: "Failed to add the user to the '%{t}' team for some unknown reason"
+      github_issues:
+        repo_not_found: "That repo (%{repo}) was not found"
+        boom: "I had a problem :( ... %{m}"
+        issues_list:
+          none: "There are no open issues for %{r}"
+          header: "Showing %{n} issue(s) for %{r}\n"
+          item: "%{r} #%{number}: '%{title}' opened by %{u} :: %{html_url}\n"
+          val_states: "Issues can be one of the following states: 'open', 'closed', or 'all'\n"
+          val_sort: "Issues can be sorted by one of the following: 'created', 'updated', 'comments'\n"
+          val_direction: "Issues can be ordered either 'asc' (ascending) or 'desc' (descending)\n"
+          invalid_opts: "An invalid option was provided, here's the error from Octokit:\n%{m}"